From fa0e13e1a28d2a1f1653db6767e74bc37acc4a28 Mon Sep 17 00:00:00 2001 From: omnom62 <75066712+omnom62@users.noreply.github.com> Date: Tue, 4 Aug 2026 19:46:02 +1000 Subject: T6890: use boolean in documentation (#491) * T6890: use boolean in documentation * T6890: use booleans in documentation --- plugins/modules/vyos_config.py | 21 +++++++++++++-------- plugins/modules/vyos_user.py | 2 +- plugins/modules/vyos_vrf.py | 4 ++-- 3 files changed, 16 insertions(+), 11 deletions(-) (limited to 'plugins') diff --git a/plugins/modules/vyos_config.py b/plugins/modules/vyos_config.py index 2407ce01..666bb629 100644 --- a/plugins/modules/vyos_config.py +++ b/plugins/modules/vyos_config.py @@ -76,7 +76,7 @@ options: the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created. type: bool - default: no + default: false comment: description: - Allows a commit description to be specified to be included when the configuration @@ -116,14 +116,14 @@ options: description: - The C(save) argument controls whether or not changes made to the active configuration are saved to disk. This is independent of committing the config. When set - to True, the active configuration is saved. + to C(true), the active configuration is saved. type: bool - default: no + default: false backup_options: description: - This is a dict object containing configurable options related to backup file - path. The value of this option is read only when C(backup) is set to I(yes), - if C(backup) is set to I(no) this option will be silently ignored. + path. The value of this option is read only when C(backup) is set to C(true), + if C(backup) is set to C(false) this option will be silently ignored. suboptions: filename: description: @@ -247,7 +247,9 @@ from ansible_collections.vyos.vyos.plugins.module_utils.network.vyos.vyos import DEFAULT_COMMENT = "configured by vyos_config" -PASSWORD_NEEDLE = re.compile(r"set system login user \S+ authentication (encrypted|plaintext)-password") +PASSWORD_NEEDLE = re.compile( + r"set system login user \S+ authentication (encrypted|plaintext)-password", +) def get_candidate(module): @@ -388,13 +390,16 @@ def main(): lines=dict(type="list", elements="str"), match=dict(default="line", choices=["line", "none"]), comment=dict(default=DEFAULT_COMMENT), - confirm=dict(choices=["automatic", "manual", "none"], default='none'), + confirm=dict(choices=["automatic", "manual", "none"], default="none"), confirm_timeout=dict(type="int", default=10), config=dict(), backup=dict(type="bool", default=False), backup_options=dict(type="dict", options=backup_spec), save=dict(type="bool", default=False), - allow_password_change=dict(default="plaintext", choices=["all", "encrypted", "plaintext", "none"]) + allow_password_change=dict( + default="plaintext", + choices=["all", "encrypted", "plaintext", "none"], + ), ) mutually_exclusive = [("lines", "src")] diff --git a/plugins/modules/vyos_user.py b/plugins/modules/vyos_user.py index e47f5a05..0c79ce30 100644 --- a/plugins/modules/vyos_user.py +++ b/plugins/modules/vyos_user.py @@ -55,7 +55,7 @@ options: description: - The username to be configured on the VyOS device. This argument accepts a string value and is mutually exclusive with the C(aggregate) argument. - required: True + required: true type: str full_name: description: diff --git a/plugins/modules/vyos_vrf.py b/plugins/modules/vyos_vrf.py index 395a152b..d0d4fe88 100644 --- a/plugins/modules/vyos_vrf.py +++ b/plugins/modules/vyos_vrf.py @@ -66,11 +66,11 @@ options: type: str choices: ['ipv4', 'ipv6'] disable_forwarding: - default: False + default: false description: Disable forwarding for this address family type: bool nht_no_resolve_via_default: - default: False + default: false description: Disable next-hop resolution via default route type: bool route_maps: -- cgit v1.2.3