More validate module fixes (#39097)

* Fix type bool DOCUMENTATION issues
2025-07-22 12:50:22 -07:00 · 2018-04-24 18:05:50 +01:00 · 2018-04-24 18:05:50 +01:00 · 7c4b91844d
commit 7c4b91844d
parent b533ebe20d
118 changed files with 187 additions and 398 deletions
--- a/lib/ansible/modules/network/aos/_aos_device.py
+++ b/lib/ansible/modules/network/aos/_aos_device.py
@ -65,7 +65,7 @@ options:
      - The approve argument instruct the module to convert a device in quarantine
        mode into approved mode.
    default: "no"
-    choices: [ "yes", "no" ]
+    type: bool
  location:
    description:
      - When approving a device using the I(approve) argument, it's possible
--- a/lib/ansible/modules/network/bigswitch/bcf_switch.py
+++ b/lib/ansible/modules/network/bigswitch/bcf_switch.py
@ -52,7 +52,7 @@ options:
        on personally controlled devices using self-signed certificates.
    required: false
    default: true
-    choices: [true, false]
+    type: bool
  access_token:
    description:
     - Big Cloud Fabric access token. If this isn't set then the environment variable C(BIGSWITCH_ACCESS_TOKEN) is used.
--- a/lib/ansible/modules/network/bigswitch/bigmon_chain.py
+++ b/lib/ansible/modules/network/bigswitch/bigmon_chain.py
@ -42,7 +42,7 @@ options:
        on personally controlled devices using self-signed certificates.
    required: false
    default: true
-    choices: [true, false]
+    type: bool
  access_token:
    description:
     - Bigmon access token. If this isn't set, the environment variable C(BIGSWITCH_ACCESS_TOKEN) is used.
--- a/lib/ansible/modules/network/bigswitch/bigmon_policy.py
+++ b/lib/ansible/modules/network/bigswitch/bigmon_policy.py
@ -67,7 +67,7 @@ options:
       on personally controlled devices using self-signed certificates.
    required: false
    default: true
-    choices: [true, false]
+    type: bool
  access_token:
    description:
     - Bigmon access token. If this isn't set, the environment variable C(BIGSWITCH_ACCESS_TOKEN) is used.
--- a/lib/ansible/modules/network/f5/bigip_asm_policy.py
+++ b/lib/ansible/modules/network/f5/bigip_asm_policy.py
@ -26,9 +26,7 @@ options:
        deactivate existing active policy. Generally should be C(yes) only in cases where
        you want to activate new or existing policy.
    default: no
-    choices:
-      - yes
-      - no
+    type: bool
  name:
    description:
      - The ASM policy to manage or create.
--- a/lib/ansible/modules/network/f5/bigip_configsync_action.py
+++ b/lib/ansible/modules/network/f5/bigip_configsync_action.py
@ -32,26 +32,20 @@ options:
        device to other members of the device group. In this case, the device
        will do a "push" to all the other devices in the group. This option
        is mutually exclusive with the C(sync_group_to_device) option.
-    choices:
-      - yes
-      - no
+    type: bool
  sync_most_recent_to_device:
    description:
      - Specifies that the system synchronizes configuration data from the
        device with the most recent configuration. In this case, the device
        will do a "pull" from the most recently updated device. This option
        is mutually exclusive with the C(sync_device_to_group) options.
-    choices:
-      - yes
-      - no
+    type: bool
  overwrite_config:
    description:
      - Indicates that the sync operation overwrites the configuration on
        the target.
    default: no
-    choices:
-      - yes
-      - no
+    type: bool
 notes:
  - Requires the objectpath Python package on the host. This is as easy as
    C(pip install objectpath).
--- a/lib/ansible/modules/network/f5/bigip_device_connectivity.py
+++ b/lib/ansible/modules/network/f5/bigip_device_connectivity.py
@ -50,9 +50,7 @@ options:
        C(multicast_interface), C(multicast_address) and C(multicast_port) are
        the defaults specified in each option's description. When C(no), ensures
        that Failover Multicast configuration is disabled.
-    choices:
-      - yes
-      - no
+    type: bool
  multicast_interface:
    description:
      - Interface over which the system sends multicast messages associated
--- a/lib/ansible/modules/network/f5/bigip_pool_member.py
+++ b/lib/ansible/modules/network/f5/bigip_pool_member.py
@ -91,11 +91,9 @@ options:
    description:
      - When state is absent and the pool member is no longer referenced
        in other pools, the default behavior removes the unused node
-        o bject. Setting this to 'yes' disables this behavior.
+        object. Setting this to 'yes' disables this behavior.
    default: no
-    choices:
-      - yes
-      - no
+    type: bool
    version_added: 2.1
  priority_group:
    description:
--- a/lib/ansible/modules/network/fortios/fortios_ipv4_policy.py
+++ b/lib/ansible/modules/network/fortios/fortios_ipv4_policy.py
@ -53,7 +53,7 @@ options:
    description:
      - Negate source address param.
    default: false
-    choices: ["true", "false"]
+    type: bool
  dst_addr:
    description:
      - Specifies destination address (or group) object name(s). Required when I(state=present).
@ -61,7 +61,7 @@ options:
    description:
      - Negate destination address param.
    default: false
-    choices: ["true", "false"]
+    type: bool
  policy_action:
    description:
      - Specifies accept or deny action policy. Required when I(state=present).
@ -76,7 +76,7 @@ options:
    description:
      - Negate policy service(s) defined in service value.
    default: false
-    choices: ["true", "false"]
+    type: bool
  schedule:
    description:
      - defines policy schedule.
@ -85,12 +85,12 @@ options:
    description:
      - Enable or disable Nat.
    default: false
-    choices: ["true", "false"]
+    type: bool
  fixedport:
    description:
      - Use fixed port for nat.
    default: false
-    choices: ["true", "false"]
+    type: bool
  poolname:
    description:
      - Specifies NAT pool name.
@ -117,7 +117,7 @@ options:
    description:
      - Logs beginning of session as well.
    default: false
-    choices: ["true", "false"]
+    type: bool
  comment:
    description:
      - free text to describe policy.
--- a/lib/ansible/modules/network/illumos/dladm_etherstub.py
+++ b/lib/ansible/modules/network/illumos/dladm_etherstub.py
@ -32,7 +32,7 @@ options:
              do not persist across reboots.
        required: false
        default: false
-        choices: [ "true", "false" ]
+        type: bool
    state:
        description:
            - Create or delete Solaris/illumos etherstub.
--- a/lib/ansible/modules/network/illumos/dladm_vnic.py
+++ b/lib/ansible/modules/network/illumos/dladm_vnic.py
@ -37,7 +37,7 @@ options:
              do not persist across reboots.
        required: false
        default: false
-        choices: [ "true", "false" ]
+        type: bool
    mac:
        description:
            - Sets the VNIC's MAC address. Must be valid unicast MAC address.
--- a/lib/ansible/modules/network/illumos/flowadm.py
+++ b/lib/ansible/modules/network/illumos/flowadm.py
@ -75,7 +75,7 @@ options:
              flows do not persist across reboots.
        required: false
        default: false
-        choices: [ "true", "false" ]
+        type: bool
    state:
        description:
            - Create/delete/enable/disable an IP address on the network interface.
--- a/lib/ansible/modules/network/illumos/ipadm_if.py
+++ b/lib/ansible/modules/network/illumos/ipadm_if.py
@ -33,7 +33,7 @@ options:
              interfaces do not persist across reboots.
        required: false
        default: false
-        choices: [ "true", "false" ]
+        type: bool
    state:
        description:
            - Create or delete Solaris/illumos IP interfaces.
--- a/lib/ansible/modules/network/illumos/ipadm_prop.py
+++ b/lib/ansible/modules/network/illumos/ipadm_prop.py
@ -40,7 +40,7 @@ options:
              property values do not persist across reboots.
        required: false
        default: false
-        choices: [ "true", "false" ]
+        type: bool
    state:
        description:
            - Set or reset the property value.
--- a/lib/ansible/modules/network/junos/junos_interface.py
+++ b/lib/ansible/modules/network/junos/junos_interface.py
@ -83,7 +83,7 @@ options:
    description:
      - Specifies whether or not the configuration is active or deactivated
    default: True
-    choices: [True, False]
+    type: bool
 requirements:
  - ncclient (>=v0.5.2)
 notes:
--- a/lib/ansible/modules/network/junos/junos_l2_interface.py
+++ b/lib/ansible/modules/network/junos/junos_l2_interface.py
@ -62,7 +62,7 @@ options:
    description:
      - Specifies whether or not the configuration is active or deactivated
    default: True
-    choices: [True, False]
+    type: bool
 requirements:
  - ncclient (>=v0.5.2)
 notes:
--- a/lib/ansible/modules/network/junos/junos_l3_interface.py
+++ b/lib/ansible/modules/network/junos/junos_l3_interface.py
@ -47,7 +47,7 @@ options:
    description:
      - Specifies whether or not the configuration is active or deactivated
    default: True
-    choices: [True, False]
+    type: bool
 requirements:
  - ncclient (>=v0.5.2)
 notes:
--- a/lib/ansible/modules/network/junos/junos_linkagg.py
+++ b/lib/ansible/modules/network/junos/junos_linkagg.py
@ -62,7 +62,7 @@ options:
    description:
      - Specifies whether or not the configuration is active or deactivated
    default: True
-    choices: [True, False]
+    type: bool
 requirements:
  - ncclient (>=v0.5.2)
 notes:
--- a/lib/ansible/modules/network/junos/junos_lldp.py
+++ b/lib/ansible/modules/network/junos/junos_lldp.py
@ -49,7 +49,7 @@ options:
    description:
      - Specifies whether or not the configuration is active or deactivated
    default: True
-    choices: [True, False]
+    type: bool
 requirements:
  - ncclient (>=v0.5.2)
 notes:
--- a/lib/ansible/modules/network/junos/junos_lldp_interface.py
+++ b/lib/ansible/modules/network/junos/junos_lldp_interface.py
@ -38,7 +38,7 @@ options:
    description:
      - Specifies whether or not the configuration is active or deactivated
    default: True
-    choices: [True, False]
+    type: bool
 requirements:
  - ncclient (>=v0.5.2)
 notes:
--- a/lib/ansible/modules/network/junos/junos_logging.py
+++ b/lib/ansible/modules/network/junos/junos_logging.py
@ -49,7 +49,7 @@ options:
    description:
      - Specifies whether or not the configuration is active or deactivated
    default: True
-    choices: [True, False]
+    type: bool
  rotate_frequency:
    description:
      - Rotate log frequency in minutes, this is applicable if value
--- a/lib/ansible/modules/network/junos/junos_static_route.py
+++ b/lib/ansible/modules/network/junos/junos_static_route.py
@ -54,7 +54,7 @@ options:
    description:
      - Specifies whether or not the configuration is active or deactivated
    default: True
-    choices: [True, False]
+    type: bool
 requirements:
  - ncclient (>=v0.5.2)
 notes:
--- a/lib/ansible/modules/network/junos/junos_system.py
+++ b/lib/ansible/modules/network/junos/junos_system.py
@ -59,7 +59,7 @@ options:
    description:
      - Specifies whether or not the configuration is active or deactivated
    default: True
-    choices: [True, False]
+    type: bool
 requirements:
  - ncclient (>=v0.5.2)
 notes:
--- a/lib/ansible/modules/network/junos/junos_vlan.py
+++ b/lib/ansible/modules/network/junos/junos_vlan.py
@ -48,7 +48,7 @@ options:
    description:
      - Specifies whether or not the configuration is active or deactivated
    default: True
-    choices: [True, False]
+    type: bool
 requirements:
  - ncclient (>=v0.5.2)
 notes:
--- a/lib/ansible/modules/network/junos/junos_vrf.py
+++ b/lib/ansible/modules/network/junos/junos_vrf.py
@ -54,6 +54,7 @@ options:
      - Causes JUNOS to allocate a VPN label per VRF rather than per VPN FEC.
        This allows for forwarding of traffic to directly connected subnets, COS
        Egress filtering etc.
+    type: bool
  aggregate:
    description:
      - The set of VRF definition objects to be configured on the remote
@ -73,7 +74,7 @@ options:
    description:
      - Specifies whether or not the configuration is active or deactivated
    default: True
-    choices: [True, False]
+    type: bool
 requirements:
  - ncclient (>=v0.5.2)
 notes:
--- a/lib/ansible/modules/network/nxos/nxos_evpn_global.py
+++ b/lib/ansible/modules/network/nxos/nxos_evpn_global.py
@ -36,7 +36,7 @@ options:
    description:
      - EVPN control plane.
    required: true
-    choices: ['true', 'false']
+    type: bool
 '''

 EXAMPLES = '''
--- a/lib/ansible/modules/network/nxos/nxos_nxapi.py
+++ b/lib/ansible/modules/network/nxos/nxos_nxapi.py
@ -51,7 +51,7 @@ options:
        argument to False.
    required: false
    default: yes
-    choices: ['yes', 'no']
+    type: bool
    aliases: ['enable_http']
  https_port:
    description:
@ -70,7 +70,7 @@ options:
        argument to True.
    required: false
    default: no
-    choices: ['yes', 'no']
+    type: bool
    aliases: ['enable_https']
  sandbox:
    description:
@ -82,7 +82,7 @@ options:
        sandbox URL is unavailable. This is supported on NX-OS 7K series.
    required: false
    default: no
-    choices: ['yes', 'no']
+    type: bool
    aliases: ['enable_sandbox']
  state:
    description:
--- a/lib/ansible/modules/network/onyx/onyx_config.py
+++ b/lib/ansible/modules/network/onyx/onyx_config.py
@ -87,7 +87,7 @@ options:
        folder in the playbook root directory.  If the directory does not
        exist, it is created.
    default: no
-    choices: ['yes', 'no']
+    type: bool
  config:
    description:
      - The C(config) argument allows the playbook designer to supply
@ -100,7 +100,7 @@ options:
        config to the startup-config at the conclusion of the module
        running.  If check mode is specified, this argument is ignored.
    default: no
-    choices: ['yes', 'no']
+    type: bool
 """

 EXAMPLES = """