Clean up module documentation (#36909)

* Clean up module documentation

This PR includes:
- Removal of `default: None` (and variations)
- Removal of `required: false`
- Fixing booleans and `type: bool` where required

* Fix remaining (new) validation issues

lib/ansible/modules/cloud/openstack/os_flavor_facts.py

@@ -35,8 +35,6 @@ options:
    name:
      description:
        - A flavor name. Cannot be used with I(ram) or I(vcpus) or I(ephemeral).
-     required: false
-     default: None
    ram:
      description:
        - "A string used for filtering flavors based on the amount of RAM
@@ -51,31 +49,28 @@ options:
          prefix the amount of RAM with one of these acceptable range values:
          '<', '>', '<=', '>='. These values represent less than, greater than,
          less than or equal to, and greater than or equal to, respectively."
-     required: false
-     default: false
+     type: bool
+     default: 'no'
    vcpus:
      description:
        - A string used for filtering flavors based on the number of virtual
          CPUs desired. Format is the same as the I(ram) parameter.
-     required: false
-     default: false
+     type: bool
+     default: 'no'
    limit:
      description:
        - Limits the number of flavors returned. All matching flavors are
          returned by default.
-     required: false
-     default: None
    ephemeral:
      description:
        - A string used for filtering flavors based on the amount of ephemeral
          storage. Format is the same as the I(ram) parameter
-     required: false
-     default: false
+     type: bool
+     default: 'no'
      version_added: "2.3"
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 extends_documentation_fragment: openstack
 '''
 

lib/ansible/modules/cloud/openstack/os_floating_ip.py

@@ -30,39 +30,34 @@ options:
    network:
      description:
         - The name or ID of a neutron external network or a nova pool name.
-     required: false
    floating_ip_address:
      description:
         - A floating IP address to attach or to detach. Required only if I(state)
           is absent. When I(state) is present can be used to specify a IP address
           to attach.
-     required: false
    reuse:
      description:
         - When I(state) is present, and I(floating_ip_address) is not present,
           this parameter can be used to specify whether we should try to reuse
           a floating IP address already allocated to the project.
-     required: false
-     default: false
+     type: bool
+     default: 'no'
    fixed_address:
      description:
         - To which fixed IP of server the floating IP address should be
           attached to.
-     required: false
    nat_destination:
      description:
         - The name or id of a neutron private network that the fixed IP to
           attach floating IP is on
-     required: false
-     default: None
      aliases: ["fixed_network", "internal_network"]
      version_added: "2.3"
    wait:
      description:
         - When attaching a floating IP address, specify whether we should
           wait for it to appear as attached.
-     required: false
-     default: false
+     type: bool
+     default: 'no'
    timeout:
      description:
         - Time to wait for an IP address to appear as attached. See wait.
@@ -72,19 +67,17 @@ options:
      description:
        - Should the resource be present or absent.
      choices: [present, absent]
-     required: false
      default: present
    purge:
      description:
         - When I(state) is absent, indicates whether or not to delete the floating
           IP completely, or only detach it from the server. Default is to detach only.
-     required: false
-     default: false
+     type: bool
+     default: 'no'
      version_added: "2.1"
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 requirements: ["shade"]
 '''
 

lib/ansible/modules/cloud/openstack/os_group.py

@@ -29,13 +29,9 @@ options:
    description:
      description:
         - Group description
-     required: false
-     default: None
    domain_id:
      description:
         - Domain id to create the group in if the cloud supports domains.
-     required: false
-     default: None
      version_added: "2.3"
    state:
      description:
@@ -45,7 +41,6 @@ options:
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 requirements:
     - "python >= 2.6"
     - "shade"

lib/ansible/modules/cloud/openstack/os_image.py

@@ -29,68 +29,48 @@ options:
      description:
         - Name that has to be given to the image
      required: true
-     default: None
    id:
      version_added: "2.4"
      description:
         - The Id of the image
-     required: false
-     default: None
    checksum:
      version_added: "2.5"
      description:
         - The checksum of the image
-     required: false
-     default: None
    disk_format:
      description:
         - The format of the disk that is getting uploaded
-     required: false
      default: qcow2
    container_format:
      description:
         - The format of the container
-     required: false
      default: bare
    owner:
      description:
         - The owner of the image
-     required: false
-     default: None
    min_disk:
      description:
         - The minimum disk space (in GB) required to boot this image
-     required: false
-     default: None
    min_ram:
      description:
         - The minimum ram (in MB) required to boot this image
-     required: false
-     default: None
    is_public:
      description:
         - Whether the image can be accessed publicly. Note that publicizing an image requires admin role by default.
-     required: false
+     type: bool
      default: 'yes'
    filename:
      description:
         - The path to the file which has to be uploaded
-     required: false
-     default: None
    ramdisk:
      description:
         - The name of an existing ramdisk image that will be associated with this image
-     required: false
-     default: None
    kernel:
      description:
         - The name of an existing kernel image that will be associated with this image
-     required: false
-     default: None
    properties:
      description:
         - Additional properties to be associated with this image
-     required: false
      default: {}
    state:
      description:
@@ -100,7 +80,6 @@ options:
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 requirements: ["shade"]
 '''
 

lib/ansible/modules/cloud/openstack/os_ironic.py

@@ -33,30 +33,21 @@ options:
         - globally unique identifier (UUID) to be given to the resource. Will
           be auto-generated if not specified, and name is specified.
         - Definition of a UUID will always take precedence to a name value.
-      required: false
-      default: None
     name:
       description:
         - unique name identifier to be given to the resource.
-      required: false
-      default: None
     driver:
       description:
         - The name of the Ironic Driver to use with this node.
       required: true
-      default: None
     chassis_uuid:
       description:
         - Associate the node with a pre-defined chassis.
-      required: false
-      default: None
     ironic_url:
       description:
         - If noauth mode is utilized, this is required to be set to the
           endpoint URL for the Ironic API.  Use with "auth" and "auth_type"
           settings set to None.
-      required: false
-      default: None
     driver_info:
       description:
         - Information for this server's driver. Will vary based on which
@@ -109,12 +100,11 @@ options:
           field.  As of Kilo, by default, passwords are always masked to API
           requests, which means the logic as a result always attempts to
           re-assert the password field.
-      required: false
-      default: false
+      type: bool
+      default: 'no'
     availability_zone:
       description:
         - Ignored. Present for backwards compatibility
-      required: false
 
 requirements: ["shade", "jsonpatch"]
 '''

lib/ansible/modules/cloud/openstack/os_ironic_inspect.py

@@ -28,33 +28,23 @@ options:
     mac:
       description:
         - unique mac address that is used to attempt to identify the host.
-      required: false
-      default: None
     uuid:
       description:
         - globally unique identifier (UUID) to identify the host.
-      required: false
-      default: None
     name:
       description:
         - unique name identifier to identify the host in Ironic.
-      required: false
-      default: None
     ironic_url:
       description:
         - If noauth mode is utilized, this is required to be set to the endpoint URL for the Ironic API.
           Use with "auth" and "auth_type" settings set to None.
-      required: false
-      default: None
     timeout:
       description:
         - A timeout in seconds to tell the role to wait for the node to complete introspection if wait is set to True.
-      required: false
       default: 1200
     availability_zone:
       description:
         - Ignored. Present for backwards compatibility
-      required: false
 
 requirements: ["shade"]
 '''

lib/ansible/modules/cloud/openstack/os_ironic_node.py

@@ -33,26 +33,20 @@ options:
        - Indicates if the resource should be deployed. Allows for deployment
          logic to be disengaged and control of the node power or maintenance
          state to be changed.
-      choices: ['true', 'false']
-      default: true
+      type: bool
+      default: 'yes'
     uuid:
       description:
         - globally unique identifier (UUID) to be given to the resource.
-      required: false
-      default: None
     ironic_url:
       description:
         - If noauth mode is utilized, this is required to be set to the
           endpoint URL for the Ironic API.  Use with "auth" and "auth_type"
           settings set to None.
-      required: false
-      default: None
     config_drive:
       description:
         - A configdrive file or HTTP(S) URL that will be passed along to the
           node.
-      required: false
-      default: None
     instance_info:
       description:
         - Definition of the instance information which is used to deploy
@@ -79,20 +73,18 @@ options:
       description:
         - A setting to allow the direct control if a node is in
           maintenance mode.
-      required: false
-      default: false
+      type: bool
+      default: 'no'
     maintenance_reason:
       description:
         - A string expression regarding the reason a node is in a
           maintenance mode.
-      required: false
-      default: None
     wait:
       description:
         - A boolean value instructing the module to wait for node
           activation or deactivation to complete before returning.
-      required: false
-      default: False
+      type: bool
+      default: 'no'
       version_added: "2.1"
     timeout:
       description:
@@ -102,7 +94,6 @@ options:
     availability_zone:
       description:
         - Ignored. Present for backwards compatibility
-      required: false
 '''
 
 EXAMPLES = '''

lib/ansible/modules/cloud/openstack/os_keypair.py

@@ -28,19 +28,14 @@ options:
     description:
       - Name that has to be given to the key pair
     required: true
-    default: None
   public_key:
     description:
       - The public key that would be uploaded to nova and injected into VMs
         upon creation.
-    required: false
-    default: None
   public_key_file:
     description:
       - Path to local file containing ssh public key. Mutually exclusive
         with public_key.
-    required: false
-    default: None
   state:
     description:
       - Should the resource be present or absent.
@@ -49,8 +44,6 @@ options:
   availability_zone:
     description:
       - Ignored. Present for backwards compatibility
-    required: false
-requirements: []
 '''
 
 EXAMPLES = '''

lib/ansible/modules/cloud/openstack/os_keystone_domain.py

@@ -32,13 +32,11 @@ options:
    description:
      description:
         - Description of the domain
-     required: false
-     default: None
    enabled:
      description:
         - Is the domain enabled
-     required: false
-     default: True
+     type: bool
+     default: 'yes'
    state:
      description:
        - Should the resource be present or absent.
@@ -47,7 +45,6 @@ options:
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 requirements:
     - "python >= 2.6"
     - "shade"

lib/ansible/modules/cloud/openstack/os_keystone_domain_facts.py

@@ -27,17 +27,13 @@ options:
    name:
      description:
         - Name or ID of the domain
-     required: false
    filters:
      description:
         - A dictionary of meta data to use for further filtering.  Elements of
           this dictionary may be additional dictionaries.
-     required: false
-     default: None
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 '''
 
 EXAMPLES = '''

lib/ansible/modules/cloud/openstack/os_keystone_service.py

@@ -30,13 +30,11 @@ options:
    description:
      description:
         - Description of the service
-     required: false
-     default: None
    enabled:
      description:
         - Is the service enabled
-     required: false
-     default: True
+     type: bool
+     default: 'yes'
    service_type:
      description:
         - The type of service
@@ -49,7 +47,6 @@ options:
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 requirements:
     - "python >= 2.6"
     - "shade"

lib/ansible/modules/cloud/openstack/os_network.py

@@ -30,35 +30,30 @@ options:
    shared:
      description:
         - Whether this network is shared or not.
-     required: false
-     default: false
+     type: bool
+     default: 'no'
    admin_state_up:
      description:
         - Whether the state should be marked as up or down.
-     required: false
-     default: true
+     type: bool
+     default: 'yes'
    external:
      description:
         - Whether this network is externally accessible.
-     required: false
-     default: false
+     type: bool
+     default: 'no'
    state:
      description:
         - Indicate desired state of the resource.
      choices: ['present', 'absent']
-     required: false
      default: present
    provider_physical_network:
      description:
         - The physical network where this network object is implemented.
-     required: false
-     default: None
      version_added: "2.1"
    provider_network_type:
      description:
         - The type of physical network that maps to this network resource.
-     required: false
-     default: None
      version_added: "2.1"
    provider_segmentation_id:
      description:
@@ -66,19 +61,14 @@ options:
           attribute defines the segmentation model. For example, if the
           I(network_type) value is vlan, this ID is a vlan identifier. If
           the I(network_type) value is gre, this ID is a gre key.
-     required: false
-     default: None
      version_added: "2.1"
    project:
      description:
         - Project name or ID containing the network (name admin-only)
-     required: false
-     default: None
      version_added: "2.1"
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 requirements: ["shade"]
 '''
 

lib/ansible/modules/cloud/openstack/os_nova_flavor.py

@@ -28,7 +28,6 @@ options:
           then I(ram), I(vcpus), and I(disk) are all required. There are no
           default values for those parameters.
      choices: ['present', 'absent']
-     required: false
      default: present
    name:
      description:
@@ -37,53 +36,40 @@ options:
    ram:
      description:
         - Amount of memory, in MB.
-     required: false
-     default: null
    vcpus:
      description:
         - Number of virtual CPUs.
-     required: false
-     default: null
    disk:
      description:
         - Size of local disk, in GB.
-     required: false
-     default: null
    ephemeral:
      description:
         - Ephemeral space size, in GB.
-     required: false
      default: 0
    swap:
      description:
         - Swap space size, in MB.
-     required: false
      default: 0
    rxtx_factor:
      description:
         - RX/TX factor.
-     required: false
      default: 1.0
    is_public:
      description:
         - Make flavor accessible to the public.
-     required: false
-     default: true
+     type: bool
+     default: 'yes'
    flavorid:
      description:
         - ID for the flavor. This is optional as a unique UUID will be
           assigned if a value is not specified.
-     required: false
      default: "auto"
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
    extra_specs:
      description:
         - Metadata dictionary
-     required: false
-     default: None
      version_added: "2.3"
 requirements: ["shade"]
 '''

lib/ansible/modules/cloud/openstack/os_nova_host_aggregate.py

@@ -28,16 +28,10 @@ options:
     required: true
   metadata:
     description: Metadata dict.
-    required: false
-    default: None
   availability_zone:
     description: Availability zone to create aggregate into.
-    required: false
-    default: None
   hosts:
     description: List of hosts to set for an aggregate.
-    required: false
-    default: None
   state:
     description: Should the resource be present or absent.
     choices: [present, absent]

lib/ansible/modules/cloud/openstack/os_port.py

@@ -30,35 +30,24 @@ options:
    name:
      description:
         - Name that has to be given to the port.
-     required: false
-     default: None
    fixed_ips:
      description:
         - Desired IP and/or subnet for this port.  Subnet is referenced by
           subnet_id and IP is referenced by ip_address.
-     required: false
-     default: None
    admin_state_up:
      description:
         - Sets admin state.
-     required: false
-     default: None
    mac_address:
      description:
         - MAC address of this port.
-     required: false
-     default: None
    security_groups:
      description:
         - Security group(s) ID(s) or name(s) associated with the port (comma
           separated string or YAML list)
-     required: false
-     default: None
    no_security_groups:
      description:
         - Do not associate a security group with this port.
-     required: false
-     default: False
+     default: 'no'
    allowed_address_pairs:
      description:
         - "Allowed address pairs list.  Allowed address pairs are supported with
@@ -67,8 +56,6 @@ options:
                   - ip_address: 10.1.0.12
                     mac_address: ab:cd:ef:12:34:56
                   - ip_address: ..."
-     required: false
-     default: None
    extra_dhcp_opts:
      description:
         - "Extra dhcp options to be assigned to this port.  Extra options are
@@ -77,18 +64,12 @@ options:
                   - opt_name: opt name1
                     opt_value: value1
                   - opt_name: ..."
-     required: false
-     default: None
    device_owner:
      description:
         - The ID of the entity that uses this port.
-     required: false
-     default: None
    device_id:
      description:
         - Device ID of device using this port.
-     required: false
-     default: None
    state:
      description:
        - Should the resource be present or absent.
@@ -97,7 +78,6 @@ options:
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 '''
 
 EXAMPLES = '''

lib/ansible/modules/cloud/openstack/os_port_facts.py

@@ -28,20 +28,15 @@ options:
     port:
         description:
             - Unique name or ID of a port.
-        required: false
-        default: null
     filters:
         description:
             - A dictionary of meta data to use for further filtering. Elements
               of this dictionary will be matched against the returned port
               dictionaries. Matching is currently limited to strings within
               the port dictionary, or strings within nested dictionaries.
-        required: false
-        default: null
     availability_zone:
       description:
         - Ignored. Present for backwards compatibility
-      required: false
 extends_documentation_fragment: openstack
 '''
 

lib/ansible/modules/cloud/openstack/os_project.py

@@ -32,20 +32,16 @@ options:
    description:
      description:
         - Description for the project
-     required: false
-     default: None
    domain_id:
      description:
         - Domain id to create the project in if the cloud supports domains.
           The domain_id parameter requires shade >= 1.8.0
-     required: false
-     default: None
      aliases: ['domain']
    enabled:
      description:
         - Is the project enabled
-     required: false
-     default: True
+     type: bool
+     default: 'yes'
    state:
      description:
        - Should the resource be present or absent.
@@ -54,7 +50,6 @@ options:
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 requirements:
     - "python >= 2.6"
     - "shade"

lib/ansible/modules/cloud/openstack/os_project_facts.py

@@ -31,18 +31,13 @@ options:
    domain:
      description:
         - Name or ID of the domain containing the project if the cloud supports domains
-     required: false
-     default: None
    filters:
      description:
         - A dictionary of meta data to use for further filtering.  Elements of
           this dictionary may be additional dictionaries.
-     required: false
-     default: None
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 '''
 
 EXAMPLES = '''

lib/ansible/modules/cloud/openstack/os_quota.py

@@ -30,144 +30,78 @@ options:
     state:
         description:
             - A value of present sets the quota and a value of absent resets the quota to system defaults.
-        required: False
         default: present
     backup_gigabytes:
-        required: False
-        default: None
         description: Maximum size of backups in GB's.
     backups:
-        required: False
-        default: None
         description: Maximum number of backups allowed.
     cores:
-        required: False
-        default: None
         description: Maximum number of CPU's per project.
     fixed_ips:
-        required: False
-        default: None
         description: Number of fixed IP's to allow.
     floating_ips:
-        required: False
-        default: None
         description: Number of floating IP's to allow in Compute.
         aliases: ['compute_floating_ips']
     floatingip:
-        required: False
-        default: None
         description: Number of floating IP's to allow in Network.
         aliases: ['network_floating_ips']
     gigabytes:
-        required: False
-        default: None
         description: Maximum volume storage allowed for project.
     gigabytes_lvm:
-        required: False
-        default: None
         description: Maximum size in GB's of individual lvm volumes.
     injected_file_size:
-        required: False
-        default: None
         description: Maximum file size in bytes.
     injected_files:
-        required: False
-        default: None
         description: Number of injected files to allow.
     injected_path_size:
-        required: False
-        default: None
         description: Maximum path size.
     instances:
-        required: False
-        default: None
         description: Maximum number of instances allowed.
     key_pairs:
-        required: False
-        default: None
         description: Number of key pairs to allow.
     loadbalancer:
-        required: False
-        default: None
         description: Number of load balancers to allow.
         version_added: "2.4"
     network:
-        required: False
-        default: None
         description: Number of networks to allow.
     per_volume_gigabytes:
-        required: False
-        default: None
         description: Maximum size in GB's of individual volumes.
     pool:
-        required: False
-        default: None
         description: Number of load balancer pools to allow.
         version_added: "2.4"
     port:
-        required: False
-        default: None
         description: Number of Network ports to allow, this needs to be greater than the instances limit.
     properties:
-        required: False
-        default: None
         description: Number of properties to allow.
     ram:
-        required: False
-        default: None
         description: Maximum amount of ram in MB to allow.
     rbac_policy:
-        required: False
-        default: None
         description: Number of policies to allow.
     router:
-        required: False
-        default: None
         description: Number of routers to allow.
     security_group_rule:
-        required: False
-        default: None
         description: Number of rules per security group to allow.
     security_group:
-        required: False
-        default: None
         description: Number of security groups to allow.
     server_group_members:
-        required: False
-        default: None
         description: Number of server group members to allow.
     server_groups:
-        required: False
-        default: None
         description: Number of server groups to allow.
     snapshots:
-        required: False
-        default: None
         description: Number of snapshots to allow.
     snapshots_lvm:
-        required: False
-        default: None
         description: Number of LVM snapshots to allow.
     subnet:
-        required: False
-        default: None
         description: Number of subnets to allow.
     subnetpool:
-        required: False
-        default: None
         description: Number of subnet pools to allow.
     volumes:
-        required: False
-        default: None
         description: Number of volumes to allow.
     volumes_lvm:
-        required: False
-        default: None
         description: Number of LVM volumes to allow.
     availability_zone:
       description:
         - Ignored. Present for backwards compatibility
-      required: false
 
 
 requirements:

lib/ansible/modules/cloud/openstack/os_recordset.py

@@ -42,13 +42,9 @@ options:
    description:
      description:
         - Description of the recordset
-     required: false
-     default: None
    ttl:
      description:
         -  TTL (Time To Live) value in seconds
-     required: false
-     default: None
    state:
      description:
        - Should the resource be present or absent.
@@ -57,7 +53,6 @@ options:
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 requirements:
     - "python >= 2.6"
     - "shade"

lib/ansible/modules/cloud/openstack/os_router.py

@@ -36,24 +36,20 @@ options:
    admin_state_up:
      description:
         - Desired admin state of the created or existing router.
-     required: false
-     default: true
+     type: bool
+     default: 'yes'
    enable_snat:
      description:
         - Enable Source NAT (SNAT) attribute.
-     required: false
-     default: true
+     type: bool
+     default: 'yes'
    network:
      description:
         - Unique name or ID of the external gateway network.
         - required I(interfaces) or I(enable_snat) are provided.
-     required: false
-     default: None
    project:
      description:
         - Unique name or ID of the project.
-     required: false
-     default: None
      version_added: "2.2"
    external_fixed_ips:
      description:
@@ -61,8 +57,6 @@ options:
           is a dictionary with the subnet name or ID (subnet) and the IP
           address to assign on the subnet (ip). If no IP is specified,
           one is automatically assigned from that subnet.
-     required: false
-     default: None
    interfaces:
      description:
         - List of subnets to attach to the router internal interface. Default
@@ -75,13 +69,9 @@ options:
           User defined portip is often required when a multiple router need
           to be connected to a single subnet for which the default gateway has
           been already used.
-
-     required: false
-     default: None
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 requirements: ["shade"]
 '''
 

lib/ansible/modules/cloud/openstack/os_security_group.py

@@ -31,8 +31,6 @@ options:
    description:
      description:
         - Long description of the purpose of the security group
-     required: false
-     default: None
    state:
      description:
        - Should the resource be present or absent.
@@ -41,7 +39,6 @@ options:
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 '''
 
 EXAMPLES = '''

lib/ansible/modules/cloud/openstack/os_security_group_rule.py

@@ -31,26 +31,19 @@ options:
       description:
         - IP protocols TCP UDP ICMP 112 (VRRP)
       choices: ['tcp', 'udp', 'icmp', '112', None]
-      default: None
    port_range_min:
       description:
         - Starting port
-      required: false
-      default: None
    port_range_max:
       description:
         - Ending port
-      required: false
-      default: None
    remote_ip_prefix:
       description:
         - Source IP address(es) in CIDR notation (exclusive with remote_group)
-      required: false
    remote_group:
       description:
         - Name or ID of the Security group to link (exclusive with
           remote_ip_prefix)
-      required: false
    ethertype:
       description:
         - Must be IPv4 or IPv6, and addresses represented in CIDR must
@@ -71,7 +64,6 @@ options:
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 requirements: ["shade"]
 '''
 

lib/ansible/modules/cloud/openstack/os_server.py

@@ -43,13 +43,11 @@ options:
      description:
         - The name or id of the flavor in which the new instance has to be
           created. Mutually exclusive with flavor_ram
-     required: false
      default: 1
    flavor_ram:
      description:
         - The minimum amount of ram in MB that the flavor in which the new
           instance has to be created must have. Mutually exclusive with flavor.
-     required: false
      default: 1
    flavor_include:
      description:
@@ -60,21 +58,15 @@ options:
    key_name:
      description:
         - The key pair name to be used when creating a instance
-     required: false
-     default: None
    security_groups:
      description:
         - Names of the security groups to which the instance should be
           added. This may be a YAML list or a comma separated string.
-     required: false
-     default: None
    network:
      description:
         - Name or ID of a network to attach this instance to. A simpler
           version of the nics parameter, only one of network or nics should
           be supplied.
-     required: false
-     default: None
    nics:
      description:
         - A list of networks to which the instance's interface should
@@ -83,58 +75,47 @@ options:
         - 'Also this accepts a string containing a list of (net/port)-(id/name)
           Eg: nics: "net-id=uuid-1,port-name=myport"
           Only one of network or nics should be supplied.'
-     required: false
-     default: None
    auto_ip:
      description:
         - Ensure instance has public ip however the cloud wants to do that
-     required: false
+     type: bool
      default: 'yes'
      aliases: ['auto_floating_ip', 'public_ip']
    floating_ips:
      description:
         - list of valid floating IPs that pre-exist to assign to this node
-     required: false
-     default: None
    floating_ip_pools:
      description:
         - Name of floating IP pool from which to choose a floating IP
-     required: false
-     default: None
    meta:
      description:
         - 'A list of key value pairs that should be provided as a metadata to
           the new instance or a string containing a list of key-value pairs.
           Eg:  meta: "key1=value1,key2=value2"'
-     required: false
-     default: None
    wait:
      description:
         - If the module should wait for the instance to be created.
-     required: false
+     type: bool
      default: 'yes'
    timeout:
      description:
         - The amount of time the module should wait for the instance to get
           into active state.
-     required: false
      default: 180
    config_drive:
      description:
         - Whether to boot the server with config drive enabled
-     required: false
+     type: bool
      default: 'no'
    userdata:
      description:
         - Opaque blob of data which is made available to the instance
-     required: false
-     default: None
    boot_from_volume:
      description:
         - Should the instance boot from a persistent volume created based on
           the image given. Mututally exclusive with boot_volume.
-     required: false
-     default: false
+     type: bool
+     default: 'no'
    volume_size:
      description:
         - The size of the volume to create in GB if booting from volume based
@@ -143,23 +124,19 @@ options:
      description:
         - Volume name or id to use as the volume to boot from. Implies
           boot_from_volume. Mutually exclusive with image and boot_from_volume.
-     required: false
-     default: None
      aliases: ['root_volume']
    terminate_volume:
      description:
-        - If true, delete volume when deleting instance (if booted from volume)
-     default: false
+        - If C(yes), delete volume when deleting instance (if booted from volume)
+     type: bool
+     default: 'no'
    volumes:
      description:
        - A list of preexisting volumes names or ids to attach to the instance
-     required: false
      default: []
    scheduler_hints:
      description:
         - Arbitrary key/value pairs to the scheduler for custom use
-     required: false
-     default: None
      version_added: "2.1"
    state:
      description:
@@ -170,8 +147,8 @@ options:
      description:
        - When I(state) is absent and this option is true, any floating IP
          associated with the instance will be deleted along with the instance.
-     required: false
-     default: false
+     type: bool
+     default: 'no'
      version_added: "2.2"
    reuse_ips:
      description:
@@ -182,13 +159,12 @@ options:
          concurrent server creation, it is highly recommended to set this to
          false and to delete the floating ip associated with a server when
          the server is deleted using I(delete_fip).
-     required: false
-     default: true
+     type: bool
+     default: 'yes'
      version_added: "2.2"
    availability_zone:
      description:
        - Availability zone in which to create the server.
-     required: false
 requirements:
     - "python >= 2.6"
     - "shade"

lib/ansible/modules/cloud/openstack/os_server_action.py

@@ -32,13 +32,12 @@ options:
    wait:
      description:
         - If the module should wait for the instance action to be performed.
-     required: false
+     type: bool
      default: 'yes'
    timeout:
      description:
         - The amount of time the module should wait for the instance to perform
           the requested action.
-     required: false
      default: 180
    action:
      description:
@@ -50,12 +49,10 @@ options:
    image:
      description:
        - Image the server should be rebuilt with
-     default: null
      version_added: "2.3"
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 requirements:
     - "python >= 2.6"
     - "shade"

lib/ansible/modules/cloud/openstack/os_server_facts.py

@@ -31,18 +31,15 @@ options:
      description:
        - restrict results to servers with names or UUID matching
          this glob expression (e.g., <web*>).
-     required: false
-     default: None
    detailed:
      description:
         - when true, return additional detail about servers at the expense
           of additional API calls.
-     required: false
-     default: false
+     type: bool
+     default: 'no'
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 extends_documentation_fragment: openstack
 '''
 

lib/ansible/modules/cloud/openstack/os_server_volume.py

@@ -40,12 +40,9 @@ options:
    device:
      description:
       - Device you want to attach. Defaults to auto finding a device name.
-     required: false
-     default: None
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 requirements:
     - "python >= 2.6"
     - "shade"

lib/ansible/modules/cloud/openstack/os_stack.py

@@ -28,7 +28,6 @@ options:
       description:
         - Indicate desired state of the resource
       choices: ['present', 'absent']
-      required: false
       default: present
     name:
       description:
@@ -37,38 +36,28 @@ options:
     tag:
       description:
         - Tag for the stack that should be created, name could be char and digit, no space
-      required: false
-      default: None
       version_added: "2.5"
     template:
       description:
         - Path of the template file to use for the stack creation
-      required: false
-      default: None
     environment:
       description:
         - List of environment files that should be used for the stack creation
-      required: false
-      default: None
     parameters:
       description:
         - Dictionary of parameters for the stack creation
-      required: false
-      default: None
     rollback:
       description:
         - Rollback stack creation
-      required: false
-      default: false
+      type: bool
+      default: 'yes'
     timeout:
       description:
         - Maximum number of seconds to wait for the stack creation
-      required: false
       default: 3600
     availability_zone:
       description:
         - Ignored. Present for backwards compatibility
-      required: false
 requirements:
     - "python >= 2.6"
     - "shade"

lib/ansible/modules/cloud/openstack/os_subnet.py

@@ -27,13 +27,11 @@ options:
      description:
         - Indicate desired state of the resource
      choices: ['present', 'absent']
-     required: false
      default: present
    network_name:
      description:
         - Name of the network to which the subnet should be attached
         - Required when I(state) is 'present'
-     required: false
    name:
      description:
        - The name of the subnet that should be created. Although Neutron
@@ -45,78 +43,58 @@ options:
         - The CIDR representation of the subnet that should be assigned to
           the subnet. Required when I(state) is 'present' and a subnetpool
           is not specified.
-     required: false
-     default: None
    ip_version:
      description:
         - The IP version of the subnet 4 or 6
-     required: false
      default: 4
    enable_dhcp:
      description:
         - Whether DHCP should be enabled for this subnet.
-     required: false
-     default: true
+     type: bool
+     default: 'yes'
    gateway_ip:
      description:
         - The ip that would be assigned to the gateway for this subnet
-     required: false
-     default: None
    no_gateway_ip:
      description:
         - The gateway IP would not be assigned for this subnet
-     required: false
-     default: false
+     type: bool
+     default: 'no'
      version_added: "2.2"
    dns_nameservers:
      description:
         - List of DNS nameservers for this subnet.
-     required: false
-     default: None
    allocation_pool_start:
      description:
         - From the subnet pool the starting address from which the IP should
           be allocated.
-     required: false
-     default: None
    allocation_pool_end:
      description:
         - From the subnet pool the last IP that should be assigned to the
           virtual machines.
-     required: false
-     default: None
    host_routes:
      description:
         - A list of host route dictionaries for the subnet.
-     required: false
-     default: None
    ipv6_ra_mode:
      description:
         - IPv6 router advertisement mode
      choices: ['dhcpv6-stateful', 'dhcpv6-stateless', 'slaac']
-     required: false
-     default: None
    ipv6_address_mode:
      description:
         - IPv6 address mode
      choices: ['dhcpv6-stateful', 'dhcpv6-stateless', 'slaac']
-     required: false
-     default: None
    use_default_subnetpool:
      description:
         - Use the default subnetpool for I(ip_version) to obtain a CIDR.
-     required: false
-     default: false
+     type: bool
+     default: 'no'
    project:
      description:
         - Project name or ID containing the subnet (name admin-only)
-     required: false
-     default: None
      version_added: "2.1"
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 requirements:
     - "python >= 2.6"
     - "shade"

lib/ansible/modules/cloud/openstack/os_user.py

@@ -32,10 +32,7 @@ options:
    password:
      description:
         - Password for the user
-     required: false
-     default: None
    update_password:
-     required: false
      default: always
      choices: ['always', 'on_create']
      version_added: "2.3"
@@ -45,8 +42,6 @@ options:
    email:
      description:
         - Email address for the user
-     required: false
-     default: None
    description:
      description:
         - Description about the user
@@ -54,18 +49,14 @@ options:
    default_project:
      description:
         - Project name or ID that the user should be associated with by default
-     required: false
-     default: None
    domain:
      description:
         - Domain to create the user in if the cloud supports domains
-     required: false
-     default: None
    enabled:
      description:
         - Is the user enabled
-     required: false
-     default: True
+     type: bool
+     default: 'yes'
    state:
      description:
        - Should the resource be present or absent.
@@ -74,7 +65,6 @@ options:
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 requirements:
     - "python >= 2.6"
     - "shade"

lib/ansible/modules/cloud/openstack/os_user_facts.py

@@ -31,18 +31,13 @@ options:
    domain:
      description:
         - Name or ID of the domain containing the user if the cloud supports domains
-     required: false
-     default: None
    filters:
      description:
         - A dictionary of meta data to use for further filtering.  Elements of
           this dictionary may be additional dictionaries.
-     required: false
-     default: None
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 '''
 
 EXAMPLES = '''

lib/ansible/modules/cloud/openstack/os_user_role.py

@@ -30,27 +30,19 @@ options:
      description:
         - Name or ID for the user. If I(user) is not specified, then
           I(group) is required. Both may not be specified.
-     required: false
-     default: null
    group:
      description:
         - Name or ID for the group. Valid only with keystone version 3.
           If I(group) is not specified, then I(user) is required. Both
           may not be specified.
-     required: false
-     default: null
    project:
      description:
         - Name or ID of the project to scope the role association to.
           If you are using keystone version 2, then this value is required.
-     required: false
-     default: null
    domain:
      description:
         - ID of the domain to scope the role association to. Valid only with
           keystone version 3, and required if I(project) is not specified.
-     required: false
-     default: null
    state:
      description:
        - Should the roles be present or absent on the user.
@@ -59,7 +51,6 @@ options:
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 requirements:
     - "python >= 2.6"
     - "shade"

lib/ansible/modules/cloud/openstack/os_volume.py

@@ -26,8 +26,6 @@ options:
      description:
         - Size of volume in GB. This parameter is required when the
           I(state) parameter is 'present'.
-     required: false
-     default: None
    display_name:
      description:
         - Name of volume
@@ -35,28 +33,18 @@ options:
    display_description:
      description:
        - String describing the volume
-     required: false
-     default: None
    volume_type:
      description:
        - Volume type for volume
-     required: false
-     default: None
    image:
      description:
        - Image name or id for boot from volume
-     required: false
-     default: None
    snapshot_id:
      description:
        - Volume snapshot id to create from
-     required: false
-     default: None
    volume:
      description:
        - Volume name or id to create from
-     required: false
-     default: None
      version_added: "2.3"
    state:
      description:
@@ -66,12 +54,9 @@ options:
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
    scheduler_hints:
      description:
        - Scheduler hints passed to volume API in form of dict
-     required: false
-     default: None
      version_added: "2.4"
 requirements:
      - "python >= 2.6"

lib/ansible/modules/cloud/openstack/os_zone.py

@@ -31,26 +31,18 @@ options:
      description:
         - Zone type
      choices: [primary, secondary]
-     default: None
    email:
      description:
         - Email of the zone owner (only applies if zone_type is primary)
-     required: false
    description:
      description:
         - Zone description
-     required: false
-     default: None
    ttl:
      description:
         -  TTL (Time To Live) value in seconds
-     required: false
-     default: None
    masters:
      description:
         - Master nameservers (only applies if zone_type is secondary)
-     required: false
-     default: None
    state:
      description:
        - Should the resource be present or absent.
@@ -59,7 +51,6 @@ options:
    availability_zone:
      description:
        - Ignored. Present for backwards compatibility
-     required: false
 requirements:
     - "python >= 2.6"
     - "shade"