More validate module fixes (#39097)

* Fix type bool DOCUMENTATION issues
2026-05-07 22:02:50 +00:00 · 2018-04-24 18:05:50 +01:00
parent b533ebe20d
commit 7c4b91844d
118 changed files with 187 additions and 398 deletions
--- a/lib/ansible/modules/cloud/amazon/aws_application_scaling_policy.py
+++ b/lib/ansible/modules/cloud/amazon/aws_application_scaling_policy.py
@@ -70,7 +70,7 @@ options:
        description: Whether or not to override values of minimum and/or maximum tasks if it's already set.
        required: no
        default: no
-        choices: [ 'yes', 'no' ]
+        type: bool
        version_added: "2.6"
 extends_documentation_fragment:
    - aws
--- a/lib/ansible/modules/cloud/amazon/aws_direct_connect_connection.py
+++ b/lib/ansible/modules/cloud/amazon/aws_direct_connect_connection.py
@@ -57,6 +57,7 @@ options:
    description:
      - To modify bandwidth or location the connection will need to be deleted and recreated.
        By default this will not happen - this option must be set to True.
+    type: bool
 """

 EXAMPLES = """
--- a/lib/ansible/modules/cloud/amazon/cloudfront_distribution.py
+++ b/lib/ansible/modules/cloud/amazon/cloudfront_distribution.py
@@ -67,7 +67,7 @@ options:
          specified. If no tags are specified, it removes all existing tags for the distribution. When I(purge_tags=no), existing tags are kept and I(tags)
          are added, if specified.
      default: 'no'
-      choices: ['yes', 'no']
+      type: bool

    alias:
      description:
@@ -85,7 +85,7 @@ options:
        - Specifies whether existing aliases will be removed before adding new aliases. When I(purge_aliases=yes), existing aliases are removed and I(aliases)
          are added.
      default: 'no'
-      choices: ['yes', 'no']
+      type: bool

    default_root_object:
      description:
@@ -245,7 +245,7 @@ options:
      description:
        - A boolean value that specifies whether the distribution is enabled or disabled.
      default: 'yes'
-      choices: ['yes', 'no']
+      type: bool

    viewer_certificate:
      description:
@@ -280,13 +280,13 @@ options:
    ipv6_enabled:
      description:
        - Determines whether IPv6 support is enabled or not.
-      choices: ['yes', 'no']
+      type: bool
      default: 'no'

    wait:
      description:
        - Specifies whether the module waits until the distribution has completed processing the creation or update.
-      choices: ['yes', 'no']
+      type: bool
      default: 'no'

    wait_timeout:
--- a/lib/ansible/modules/cloud/amazon/ec2_ami.py
+++ b/lib/ansible/modules/cloud/amazon/ec2_ami.py
@@ -44,7 +44,7 @@ options:
    description:
      - Wait for the AMI to be in state 'available' before returning.
    default: "no"
-    choices: [ "yes", "no" ]
+    type: bool
  wait_timeout:
    description:
      - How long before wait gives up, in seconds.
@@ -62,7 +62,7 @@ options:
      - Flag indicating that the bundling process should not attempt to shutdown the instance before bundling. If this flag is True, the
        responsibility of maintaining file system integrity is left to the owner of the instance.
    default: no
-    choices: [ "yes", "no" ]
+    type: bool
  image_id:
    description:
      - Image ID to be deregistered.
@@ -77,7 +77,7 @@ options:
    description:
      - Delete snapshots when deregistering the AMI.
    default: "no"
-    choices: [ "yes", "no" ]
+    type: bool
  tags:
    description:
      - A dictionary of tags to add to the new image; '{"key":"value"}' and '{"key":"value","key":"value"}'
--- a/lib/ansible/modules/cloud/amazon/ec2_ami_facts.py
+++ b/lib/ansible/modules/cloud/amazon/ec2_ami_facts.py
@@ -39,7 +39,7 @@ options:
    description:
      - Describe attributes (like launchPermission) of the images found.
    default: no
-    choices: ["yes", "no"]
+    type: bool

 extends_documentation_fragment:
    - aws
--- a/lib/ansible/modules/cloud/amazon/ec2_eni.py
+++ b/lib/ansible/modules/cloud/amazon/ec2_eni.py
@@ -64,6 +64,7 @@ options:
        won't change
    default: 'yes'
    version_added: 2.2
+    type: bool
  force_detach:
    description:
      - Force detachment of the interface. This applies either when explicitly detaching the interface by setting instance_id
--- a/lib/ansible/modules/cloud/amazon/ec2_group.py
+++ b/lib/ansible/modules/cloud/amazon/ec2_group.py
@@ -100,7 +100,7 @@ options:
        tags will not be modified.
    required: false
    default: yes
-    choices: [ 'yes', 'no' ]
+    type: bool

 extends_documentation_fragment:
    - aws
--- a/lib/ansible/modules/cloud/amazon/ec2_snapshot.py
+++ b/lib/ansible/modules/cloud/amazon/ec2_snapshot.py
@@ -43,7 +43,7 @@ options:
  wait:
    description:
      - wait for the snapshot to be ready
-    choices: ['yes', 'no']
+    type: bool
    required: false
    default: yes
    version_added: "1.5.1"
--- a/lib/ansible/modules/cloud/amazon/ec2_vpc_endpoint.py
+++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_endpoint.py
@@ -62,7 +62,7 @@ options:
        behaviour from AWS.
    required: false
    default: no
-    choices: ["yes", "no"]
+    type: bool
  wait_timeout:
    description:
      - Used in conjunction with wait. Number of seconds to wait for status.
--- a/lib/ansible/modules/cloud/amazon/ec2_vpc_net.py
+++ b/lib/ansible/modules/cloud/amazon/ec2_vpc_net.py
@@ -35,7 +35,7 @@ options:
    description:
      - Remove CIDRs that are associated with the VPC and are not specified in C(cidr_block).
    default: no
-    choices: [ 'yes', 'no' ]
+    type: bool
    version_added: '2.5'
  tenancy:
    description:
@@ -46,12 +46,12 @@ options:
    description:
      - Whether to enable AWS DNS support.
    default: yes
-    choices: [ 'yes', 'no' ]
+    type: bool
  dns_hostnames:
    description:
      - Whether to enable AWS hostname support.
    default: yes
-    choices: [ 'yes', 'no' ]
+    type: bool
  dhcp_opts_id:
    description:
      - the id of the DHCP options to use for this vpc
--- a/lib/ansible/modules/cloud/amazon/ecs_service_facts.py
+++ b/lib/ansible/modules/cloud/amazon/ecs_service_facts.py
@@ -27,13 +27,13 @@ options:
            - Set this to true if you want detailed information about the services.
        required: false
        default: 'false'
-        choices: ['true', 'false']
+        type: bool
    events:
        description:
            - Whether to return ECS service events. Only has an effect if C(details) is true.
        required: false
        default: 'true'
-        choices: ['true', 'false']
+        type: bool
        version_added: "2.6"
    cluster:
        description:
--- a/lib/ansible/modules/cloud/amazon/elb_application_lb.py
+++ b/lib/ansible/modules/cloud/amazon/elb_application_lb.py
@@ -32,7 +32,7 @@ options:
    description:
      - "Whether or not to enable access logs. When true, I(access_logs_s3_bucket) must be set."
    required: false
-    choices: [ 'yes', 'no' ]
+    type: bool
  access_logs_s3_bucket:
    description:
      - The name of the S3 bucket for the access logs. This attribute is required if access logs in Amazon S3 are enabled. The bucket must exist in the same
@@ -47,7 +47,7 @@ options:
      - Indicates whether deletion protection for the ELB is enabled.
    required: false
    default: no
-    choices: [ 'yes', 'no' ]
+    type: bool
  idle_timeout:
    description:
      - The number of seconds to wait before an idle connection is closed.
@@ -68,14 +68,14 @@ options:
      - If yes, existing listeners will be purged from the ELB to match exactly what is defined by I(listeners) parameter. If the I(listeners) parameter is
        not set then listeners will not be modified
    default: yes
-    choices: [ 'yes', 'no' ]
+    type: bool
  purge_tags:
    description:
      - If yes, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. If the I(tags) parameter is not set then
        tags will not be modified.
    required: false
    default: yes
-    choices: [ 'yes', 'no' ]
+    type: bool
  subnets:
    description:
      - A list of the IDs of the subnets to attach to the load balancer. You can specify only one subnet per Availability Zone. You must specify subnets from
--- a/lib/ansible/modules/cloud/amazon/elb_target.py
+++ b/lib/ansible/modules/cloud/amazon/elb_target.py
@@ -19,7 +19,7 @@ options:
    description:
      - The default behaviour for targets that are unused is to leave them registered. If instead you would like to remove them
        set I(deregister_unused) to yes.
-    choices: [ 'yes', 'no' ]
+    type: bool
  target_az:
    description:
      - An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified
--- a/lib/ansible/modules/cloud/amazon/elb_target_group.py
+++ b/lib/ansible/modules/cloud/amazon/elb_target_group.py
@@ -78,7 +78,7 @@ options:
        tags will not be modified.
    required: false
    default: yes
-    choices: [ 'yes', 'no' ]
+    type: bool
  state:
    description:
      - Create or destroy the target group.
@@ -87,7 +87,7 @@ options:
  stickiness_enabled:
    description:
      - Indicates whether sticky sessions are enabled.
-    choices: [ 'yes', 'no' ]
+    type: bool
  stickiness_lb_cookie_duration:
    description:
      - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load
--- a/lib/ansible/modules/cloud/centurylink/clc_aa_policy.py
+++ b/lib/ansible/modules/cloud/centurylink/clc_aa_policy.py
@@ -38,7 +38,7 @@ options:
      - Whether to wait for the tasks to finish before returning.
    default: True
    required: False
-    choices: [True, False]
+    type: bool
 requirements:
    - python = 2.7
    - requests >= 2.5.0
--- a/lib/ansible/modules/cloud/centurylink/clc_blueprint_package.py
+++ b/lib/ansible/modules/cloud/centurylink/clc_blueprint_package.py
@@ -41,7 +41,7 @@ options:
  wait:
    description:
      - Whether to wait for the tasks to finish before returning.
-    choices: [ True, False ]
+    type: bool
    default: True
    required: False
 requirements:
--- a/lib/ansible/modules/cloud/centurylink/clc_firewall_policy.py
+++ b/lib/ansible/modules/cloud/centurylink/clc_firewall_policy.py
@@ -59,7 +59,7 @@ options:
  enabled:
    description:
      - Whether the firewall policy is enabled or disabled
-    type: bool
+    choices: [True, False]
    default: 'yes'
 requirements:
    - python = 2.7
--- a/lib/ansible/modules/cloud/centurylink/clc_group.py
+++ b/lib/ansible/modules/cloud/centurylink/clc_group.py
@@ -45,7 +45,7 @@ options:
  wait:
    description:
      - Whether to wait for the tasks to finish before returning.
-    choices: [ True, False ]
+    type: bool
    default: True
    required: False
 requirements:
--- a/lib/ansible/modules/cloud/centurylink/clc_server_snapshot.py
+++ b/lib/ansible/modules/cloud/centurylink/clc_server_snapshot.py
@@ -39,7 +39,7 @@ options:
      - Whether to wait for the provisioning tasks to finish before returning.
    default: True
    required: False
-    choices: [True, False]
+    type: bool
 requirements:
    - python = 2.7
    - requests >= 2.5.0
--- a/lib/ansible/modules/cloud/cloudstack/cs_network_offering.py
+++ b/lib/ansible/modules/cloud/cloudstack/cs_network_offering.py
@@ -50,7 +50,7 @@ options:
  conserve_mode:
    description:
      - Whether the network offering has IP conserve mode enabled.
-    choices: [ yes, no ]
+    type: bool
  details:
    description:
      - Network offering details in key/value pairs.
@@ -69,7 +69,7 @@ options:
      - If true keepalive will be turned on in the loadbalancer.
      - At the time of writing this has only an effect on haproxy.
      - the mode http and httpclose options are unset in the haproxy conf file.
-    choices: [ yes, no ]
+    type: bool
  max_connections:
    description:
      - Maximum number of concurrent connections supported by the network offering.
@@ -92,11 +92,11 @@ options:
    description:
      - Wheter the network offering supports specifying IP ranges.
      - Defaulted to C(no) by the API if not specified.
-    choices: [ yes, no ]
+    type: bool
  specify_vlan:
    description:
      - Whether the network offering supports vlans or not.
-    choices: [ yes, no ]
+    type: bool
 extends_documentation_fragment: cloudstack
 '''

--- a/lib/ansible/modules/cloud/cloudstack/cs_service_offering.py
+++ b/lib/ansible/modules/cloud/cloudstack/cs_service_offering.py
@@ -36,7 +36,7 @@ options:
  limit_cpu_usage:
    description:
      - Restrict the CPU usage to committed service offering.
-    choices: [ yes, no ]
+    type: bool
  deployment_planner:
    description:
      - The deployment planner heuristics used to deploy a VM of this offering.
@@ -77,13 +77,13 @@ options:
  is_system:
    description:
      - Whether it is a system VM offering or not.
-    choices: [ yes, no ]
+    type: bool
    default: no
  is_volatile:
    description:
      - Whether the virtual machine needs to be volatile or not.
      - Every reboot of VM the root disk is detached then destroyed and a fresh root disk is created and attached to VM.
-    choices: [ yes, no ]
+    type: bool
    default: no
  memory:
    description:
@@ -99,7 +99,7 @@ options:
  offer_ha:
    description:
      - Whether HA is set for the service offering.
-    choices: [ yes, no ]
+    type: bool
    default: no
  provisioning_type:
    description:
--- a/lib/ansible/modules/cloud/cloudstack/cs_vpn_customer_gateway.py
+++ b/lib/ansible/modules/cloud/cloudstack/cs_vpn_customer_gateway.py
@@ -59,12 +59,12 @@ options:
    description:
      - Enable Dead Peer Detection.
      - Disabled per default by the API on creation if not set.
-    choices: [ yes, no ]
+    type: bool
  force_encap:
    description:
      - Force encapsulation for NAT traversal.
      - Disabled per default by the API on creation if not set.
-    choices: [ yes, no ]
+    type: bool
  state:
    description:
      - State of the VPN customer gateway.
--- a/lib/ansible/modules/cloud/misc/virt_net.py
+++ b/lib/ansible/modules/cloud/misc/virt_net.py
@@ -49,7 +49,7 @@ options:
              Modify was added in version 2.1
    autostart:
        required: false
-        choices: ["yes", "no"]
+        type: bool
        description:
            - Specify if a given network should be started automatically on system boot.
    uri:
--- a/lib/ansible/modules/cloud/misc/virt_pool.py
+++ b/lib/ansible/modules/cloud/misc/virt_pool.py
@@ -49,7 +49,7 @@ options:
              See examples.
    autostart:
        required: false
-        choices: ["yes", "no"]
+        type: bool
        description:
            - Specify if a given storage pool should be started automatically on system boot.
    uri:
--- a/lib/ansible/modules/cloud/oneandone/oneandone_firewall_policy.py
+++ b/lib/ansible/modules/cloud/oneandone/oneandone_firewall_policy.py
@@ -87,7 +87,7 @@ options:
      - wait for the instance to be in state 'running' before returning
    required: false
    default: "yes"
-    choices: [ "yes", "no" ]
+    type: bool
  wait_timeout:
    description:
      - how long before wait gives up, in seconds
--- a/lib/ansible/modules/cloud/oneandone/oneandone_load_balancer.py
+++ b/lib/ansible/modules/cloud/oneandone/oneandone_load_balancer.py
@@ -122,7 +122,7 @@ options:
      - wait for the instance to be in state 'running' before returning
    required: false
    default: "yes"
-    choices: [ "yes", "no" ]
+    type: bool
  wait_timeout:
    description:
      - how long before wait gives up, in seconds
--- a/lib/ansible/modules/cloud/oneandone/oneandone_monitoring_policy.py
+++ b/lib/ansible/modules/cloud/oneandone/oneandone_monitoring_policy.py
@@ -168,7 +168,7 @@ options:
      - wait for the instance to be in state 'running' before returning
    required: false
    default: "yes"
-    choices: [ "yes", "no" ]
+    type: bool
  wait_timeout:
    description:
      - how long before wait gives up, in seconds
--- a/lib/ansible/modules/cloud/oneandone/oneandone_private_network.py
+++ b/lib/ansible/modules/cloud/oneandone/oneandone_private_network.py
@@ -76,7 +76,7 @@ options:
      - wait for the instance to be in state 'running' before returning
    required: false
    default: "yes"
-    choices: [ "yes", "no" ]
+    type: bool
  wait_timeout:
    description:
      - how long before wait gives up, in seconds
--- a/lib/ansible/modules/cloud/oneandone/oneandone_public_ip.py
+++ b/lib/ansible/modules/cloud/oneandone/oneandone_public_ip.py
@@ -68,7 +68,7 @@ options:
      - wait for the instance to be in state 'running' before returning
    required: false
    default: "yes"
-    choices: [ "yes", "no" ]
+    type: bool
  wait_timeout:
    description:
      - how long before wait gives up, in seconds
--- a/lib/ansible/modules/cloud/profitbricks/profitbricks_datacenter.py
+++ b/lib/ansible/modules/cloud/profitbricks/profitbricks_datacenter.py
@@ -47,7 +47,7 @@ options:
      - wait for the datacenter to be created before returning
    required: false
    default: "yes"
-    choices: [ "yes", "no" ]
+    type: bool
  wait_timeout:
    description:
      - how long before wait gives up, in seconds
--- a/lib/ansible/modules/cloud/profitbricks/profitbricks_nic.py
+++ b/lib/ansible/modules/cloud/profitbricks/profitbricks_nic.py
@@ -48,7 +48,7 @@ options:
      - wait for the operation to complete before returning
    required: false
    default: "yes"
-    choices: [ "yes", "no" ]
+    type: bool
  wait_timeout:
    description:
      - how long before wait gives up, in seconds
--- a/lib/ansible/modules/cloud/profitbricks/profitbricks_volume.py
+++ b/lib/ansible/modules/cloud/profitbricks/profitbricks_volume.py
@@ -73,7 +73,7 @@ options:
    description:
      - Whether or not to increment a single number in the name for created virtual machines.
    default: yes
-    choices: ["yes", "no"]
+    type: bool
  instance_ids:
    description:
      - list of instance ids, currently only used when state='absent' to remove instances.
@@ -91,7 +91,7 @@ options:
      - wait for the datacenter to be created before returning
    required: false
    default: "yes"
-    choices: [ "yes", "no" ]
+    type: bool
  wait_timeout:
    description:
      - how long before wait gives up, in seconds
--- a/lib/ansible/modules/cloud/profitbricks/profitbricks_volume_attachments.py
+++ b/lib/ansible/modules/cloud/profitbricks/profitbricks_volume_attachments.py
@@ -44,7 +44,7 @@ options:
      - wait for the operation to complete before returning
    required: false
    default: "yes"
-    choices: [ "yes", "no" ]
+    type: bool
  wait_timeout:
    description:
      - how long before wait gives up, in seconds
--- a/lib/ansible/modules/cloud/rackspace/rax_clb_nodes.py
+++ b/lib/ansible/modules/cloud/rackspace/rax_clb_nodes.py
@@ -62,9 +62,7 @@ options:
  wait:
    required: false
    default: "no"
-    choices:
-      - "yes"
-      - "no"
+    type: bool
    description:
      - Wait for the load balancer to become active before returning
  wait_timeout:
--- a/lib/ansible/modules/cloud/rackspace/rax_files.py
+++ b/lib/ansible/modules/cloud/rackspace/rax_files.py
@@ -24,9 +24,7 @@ options:
    description:
      - Optionally clear existing metadata when applying metadata to existing containers.
        Selecting this option is only appropriate when setting type=meta
-    choices:
-      - "yes"
-      - "no"
+    type: bool
    default: "no"
  container:
    description:
--- a/lib/ansible/modules/cloud/rackspace/rax_mon_alarm.py
+++ b/lib/ansible/modules/cloud/rackspace/rax_mon_alarm.py
@@ -60,7 +60,7 @@ options:
    description:
    - If yes, create this alarm, but leave it in an inactive state. Defaults to
      no.
-    choices: [ "yes", "no" ]
+    type: bool
  metadata:
    description:
    - Arbitrary key/value pairs to accompany the alarm. Must be a hash of String
--- a/lib/ansible/modules/cloud/rackspace/rax_mon_check.py
+++ b/lib/ansible/modules/cloud/rackspace/rax_mon_check.py
@@ -88,7 +88,7 @@ options:
  disabled:
    description:
    - If "yes", ensure the check is created, but don't actually use it yet.
-    choices: [ "yes", "no" ]
+    type: bool
  metadata:
    description:
    - Hash of arbitrary key-value pairs to accompany this check if it fires.
--- a/lib/ansible/modules/cloud/smartos/imgadm.py
+++ b/lib/ansible/modules/cloud/smartos/imgadm.py
@@ -24,7 +24,7 @@ author: Jasper Lievisse Adriaanse (@jasperla)
 options:
    force:
        required: false
-        choices: [ yes, no ]
+        type: bool
        description:
          - Force a given operation (where supported by imgadm(1M)).
    pool:
--- a/lib/ansible/modules/cloud/vultr/vr_user.py
+++ b/lib/ansible/modules/cloud/vultr/vr_user.py
@@ -36,12 +36,12 @@ options:
    description:
      - Password will only be changed with enforcement.
    default: no
-    choices: [ yes, no ]
+    type: bool
  api_enabled:
    description:
      - Whether the API is enabled or not.
    default: yes
-    choices: [ yes, no ]
+    type: bool
  acls:
    description:
      - List of ACLs this users should have, see U(https://www.vultr.com/api/#user_user_list).