Fix non-matching defaults in docs (#5446) (#5451)

* Allow to pass options as lookup options.

* Adjust tests.

* Fix non-matching defaults.

(cherry picked from commit a978bff2c7)

Co-authored-by: Felix Fontein <felix@fontein.de>

plugins/modules/cloud/atomic/atomic_container.py

@@ -61,6 +61,7 @@ options:
             - The values specified here will be used at installation time as --set arguments for atomic install.
         type: list
         elements: str
+        default: []
 '''
 
 EXAMPLES = r'''

plugins/modules/cloud/dimensiondata/dimensiondata_vlan.py

@@ -31,6 +31,7 @@ options:
     description:
       - A description of the VLAN.
     type: str
+    default: ''
   network_domain:
     description:
       - The Id or name of the target network domain.
@@ -40,11 +41,13 @@ options:
     description:
         - The base address for the VLAN's IPv4 network (e.g. 192.168.1.0).
     type: str
+    default: ''
   private_ipv4_prefix_size:
     description:
         - The size of the IPv4 address space, e.g 24.
         - Required, if C(private_ipv4_base_address) is specified.
     type: int
+    default: 0
   state:
     description:
       - The desired state for the target VLAN.

plugins/modules/cloud/huawei/hwc_ecs_instance.py

@@ -33,6 +33,7 @@ options:
         description:
             - The timeouts for each operations.
         type: dict
+        default: {}
         suboptions:
             create:
                 description:

plugins/modules/cloud/huawei/hwc_evs_disk.py

@@ -33,6 +33,7 @@ options:
         description:
             - The timeouts for each operations.
         type: dict
+        default: {}
         suboptions:
             create:
                 description:

plugins/modules/cloud/huawei/hwc_network_vpc.py

@@ -33,6 +33,7 @@ options:
         description:
             - The timeouts for each operations.
         type: dict
+        default: {}
         suboptions:
             create:
                 description:

plugins/modules/cloud/huawei/hwc_vpc_eip.py

@@ -33,6 +33,7 @@ options:
         description:
             - The timeouts for each operations.
         type: dict
+        default: {}
         suboptions:
             create:
                 description:

plugins/modules/cloud/huawei/hwc_vpc_peering_connect.py

@@ -34,6 +34,7 @@ options:
         description:
             - The timeouts for each operations.
         type: dict
+        default: {}
         suboptions:
             create:
                 description:

plugins/modules/cloud/huawei/hwc_vpc_port.py

@@ -33,6 +33,7 @@ options:
         description:
             - The timeouts for each operations.
         type: dict
+        default: {}
         suboptions:
             create:
                 description:

plugins/modules/cloud/huawei/hwc_vpc_subnet.py

@@ -33,6 +33,7 @@ options:
         description:
             - The timeouts for each operations.
         type: dict
+        default: {}
         suboptions:
             create:
                 description:

plugins/modules/cloud/linode/linode.py

@@ -37,6 +37,7 @@ options:
     description:
      - Add the instance to a Display Group in Linode Manager.
     type: str
+    default: ''
   linode_id:
     description:
      - Unique ID of a linode server. This value is read-only in the sense that

plugins/modules/cloud/memset/memset_zone.py

@@ -44,6 +44,7 @@ options:
             - The default TTL for all records created in the zone. This must be a
               valid int from U(https://www.memset.com/apidocs/methods_dns.html#dns.zone_create).
         type: int
+        default: 0
         choices: [ 0, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 43200, 86400 ]
     force:
         required: false

plugins/modules/cloud/memset/memset_zone_record.py

@@ -44,11 +44,13 @@ options:
         description:
             - C(SRV) and C(TXT) record priority, in the range 0 > 999 (inclusive).
         type: int
+        default: 0
     record:
         required: false
         description:
             - The subdomain to create.
         type: str
+        default: ''
     type:
         required: true
         description:
@@ -65,6 +67,7 @@ options:
         description:
             - The record's TTL in seconds (will inherit zone's TTL if not explicitly set). This must be a
               valid int from U(https://www.memset.com/apidocs/methods_dns.html#dns.zone_record_create).
+        default: 0
         choices: [ 0, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 43200, 86400 ]
         type: int
     zone:

plugins/modules/cloud/misc/rhevm.py

@@ -54,6 +54,7 @@ options:
         description:
             - The RHEV/oVirt cluster in which you want you VM to start.
         type: str
+        default: ''
     datacenter:
         description:
             - The RHEV/oVirt datacenter in which you want you VM to start.

plugins/modules/cloud/misc/serverless.py

@@ -35,11 +35,13 @@ options:
       - The name of the serverless framework project stage to deploy to.
       - This uses the serverless framework default "dev".
     type: str
+    default: ''
   region:
     description:
       - AWS region to deploy the service to.
       - This parameter defaults to C(us-east-1).
     type: str
+    default: ''
   deploy:
     description:
       - Whether or not to deploy artifacts after building them.

plugins/modules/cloud/misc/terraform.py

@@ -105,6 +105,7 @@ options:
         resources selected here will also auto-include any dependencies.
     type: list
     elements: str
+    default: []
   lock:
     description:
       - Enable statefile locking, if you use a service that accepts locks (such

plugins/modules/cloud/oneandone/oneandone_firewall_policy.py

@@ -48,6 +48,7 @@ options:
         (port_from, port_to, and source)
     type: list
     elements: dict
+    default: []
   add_server_ips:
     description:
       - A list of server identifiers (id or name) to be assigned to a firewall policy.
@@ -55,12 +56,14 @@ options:
     type: list
     elements: str
     required: false
+    default: []
   remove_server_ips:
     description:
       - A list of server IP ids to be unassigned from a firewall policy. Used in combination with update state.
     type: list
     elements: str
     required: false
+    default: []
   add_rules:
     description:
       - A list of rules that will be added to an existing firewall policy.
@@ -68,12 +71,14 @@ options:
     type: list
     elements: dict
     required: false
+    default: []
   remove_rules:
     description:
       - A list of rule ids that will be removed from an existing firewall policy. Used in combination with update state.
     type: list
     elements: str
     required: false
+    default: []
   description:
     description:
       - Firewall policy description. maxLength=256

plugins/modules/cloud/oneandone/oneandone_load_balancer.py

@@ -86,6 +86,7 @@ options:
         port_balancer, and port_server parameters, in addition to source parameter, which is optional.
     type: list
     elements: dict
+    default: []
   description:
     description:
       - Description of the load balancer. maxLength=256
@@ -98,12 +99,14 @@ options:
     type: list
     elements: str
     required: false
+    default: []
   remove_server_ips:
     description:
       - A list of server IP ids to be unassigned from a load balancer. Used in combination with update state.
     type: list
     elements: str
     required: false
+    default: []
   add_rules:
     description:
       - A list of rules that will be added to an existing load balancer.
@@ -111,12 +114,14 @@ options:
     type: list
     elements: dict
     required: false
+    default: []
   remove_rules:
     description:
       - A list of rule ids that will be removed from an existing load balancer. Used in combination with update state.
     type: list
     elements: str
     required: false
+    default: []
   wait:
     description:
       - wait for the instance to be in state 'running' before returning

plugins/modules/cloud/oneandone/oneandone_monitoring_policy.py

@@ -62,6 +62,7 @@ options:
         and value is used to advise when the value is exceeded.
     type: list
     elements: dict
+    default: []
     suboptions:
       cpu:
         description:
@@ -88,6 +89,7 @@ options:
       - Array of ports that will be monitoring.
     type: list
     elements: dict
+    default: []
     suboptions:
       protocol:
         description:
@@ -112,6 +114,7 @@ options:
       - Array of processes that will be monitoring.
     type: list
     elements: dict
+    default: []
     suboptions:
       process:
         description:
@@ -128,48 +131,56 @@ options:
     type: list
     elements: dict
     required: false
+    default: []
   add_processes:
     description:
       - Processes to add to the monitoring policy.
     type: list
     elements: dict
     required: false
+    default: []
   add_servers:
     description:
       - Servers to add to the monitoring policy.
     type: list
     elements: str
     required: false
+    default: []
   remove_ports:
     description:
       - Ports to remove from the monitoring policy.
     type: list
     elements: str
     required: false
+    default: []
   remove_processes:
     description:
       - Processes to remove from the monitoring policy.
     type: list
     elements: str
     required: false
+    default: []
   remove_servers:
     description:
       - Servers to remove from the monitoring policy.
     type: list
     elements: str
     required: false
+    default: []
   update_ports:
     description:
       - Ports to be updated on the monitoring policy.
     type: list
     elements: dict
     required: false
+    default: []
   update_processes:
     description:
       - Processes to be updated on the monitoring policy.
     type: list
     elements: dict
     required: false
+    default: []
   wait:
     description:
       - wait for the instance to be in state 'running' before returning

plugins/modules/cloud/oneandone/oneandone_private_network.py

@@ -62,11 +62,13 @@ options:
       - List of server identifiers (name or id) to be added to the private network.
     type: list
     elements: str
+    default: []
   remove_members:
     description:
       - List of server identifiers (name or id) to be removed from the private network.
     type: list
     elements: str
+    default: []
   wait:
     description:
       - wait for the instance to be in state 'running' before returning

plugins/modules/cloud/packet/packet_device.py

@@ -136,6 +136,7 @@ options:
       - URL of custom iPXE script for provisioning.
       - More about custom iPXE for Packet devices at U(https://help.packet.net/technical/infrastructure/custom-ipxe).
     type: str
+    default: ''
 
   always_pxe:
     description:

plugins/modules/cloud/profitbricks/profitbricks.py

@@ -38,6 +38,7 @@ options:
       - Public SSH keys allowing access to the virtual machine.
     type: list
     elements: str
+    default: []
   datacenter:
     description:
       - The datacenter to provision this virtual machine.
@@ -74,6 +75,7 @@ options:
       - list of instance ids, currently only used when state='absent' to remove instances.
     type: list
     elements: str
+    default: []
   count:
     description:
       - The number of virtual machines to create.

plugins/modules/cloud/profitbricks/profitbricks_volume.py

@@ -50,7 +50,7 @@ options:
       - Public SSH keys allowing access to the virtual machine.
     type: list
     elements: str
-    required: false
+    default: []
   disk_type:
     description:
       - The disk type of the volume.
@@ -81,7 +81,7 @@ options:
       - list of instance ids, currently only used when state='absent' to remove instances.
     type: list
     elements: str
-    required: false
+    default: []
   subscription_user:
     description:
       - The ProfitBricks username. Overrides the PB_SUBSCRIPTION_ID environment variable.

plugins/modules/cloud/pubnub/pubnub_blocks.py

@@ -37,6 +37,7 @@ options:
       same play)."
     required: false
     type: str
+    default: ''
   password:
     description:
       - Password which match to account to which specified C(email) belong.
@@ -44,6 +45,7 @@ options:
       same play)."
     required: false
     type: str
+    default: ''
   cache:
     description: >
        In case if single play use blocks management module few times it is
@@ -58,7 +60,7 @@ options:
       manage blocks."
       - "User's account will be used if value not set or empty."
     type: str
-    required: false
+    default: ''
   application:
     description:
       - "Name of target PubNub application for which blocks configuration on

plugins/modules/cloud/rackspace/rax.py

@@ -82,17 +82,20 @@ options:
     default: false
   extra_client_args:
     type: dict
+    default: {}
     description:
       - A hash of key/value pairs to be used when creating the cloudservers
         client. This is considered an advanced option, use it wisely and
         with caution.
   extra_create_args:
     type: dict
+    default: {}
     description:
       - A hash of key/value pairs to be used when creating a new server.
         This is considered an advanced option, use it wisely and with caution.
   files:
     type: dict
+    default: {}
     description:
       - Files to insert into the instance. remotefilename:localcontent
   flavor:
@@ -124,6 +127,7 @@ options:
       - keypair
   meta:
     type: dict
+    default: {}
     description:
       - A hash of metadata to associate with the instance
   name:

plugins/modules/cloud/rackspace/rax_cbs.py

@@ -26,6 +26,7 @@ options:
         C(name). This option requires C(pyrax>=1.9.3).
   meta:
     type: dict
+    default: {}
     description:
       - A hash of metadata to associate with the volume.
   name:

plugins/modules/cloud/rackspace/rax_clb.py

@@ -28,6 +28,7 @@ options:
     default: LEAST_CONNECTIONS
   meta:
     type: dict
+    default: {}
     description:
       - A hash of metadata to associate with the instance
   name:

plugins/modules/cloud/rackspace/rax_files.py

@@ -27,6 +27,7 @@ options:
       - The container to use for container or metadata operations.
   meta:
     type: dict
+    default: {}
     description:
       - A hash of items to set as metadata values on a container
   private:

plugins/modules/cloud/rackspace/rax_files_objects.py

@@ -38,6 +38,7 @@ options:
       - Used to set an expiration in seconds on an uploaded file or folder.
   meta:
     type: dict
+    default: {}
     description:
       - Items to set as metadata values on an uploaded file or folder.
   method:

plugins/modules/cloud/rackspace/rax_meta.py

@@ -30,6 +30,7 @@ options:
       - Server name to modify metadata for
   meta:
     type: dict
+    default: {}
     description:
       - A hash of metadata to associate with the instance
 author: "Matt Martz (@sivel)"

plugins/modules/cloud/rackspace/rax_mon_check.py

@@ -87,6 +87,7 @@ options:
       I(ip_addresses) hash to resolve an IP address to target.
   details:
     type: dict
+    default: {}
     description:
     - Additional details specific to the check type. Must be a hash of strings
       between 1 and 255 characters long, or an array or object containing 0 to
@@ -98,6 +99,7 @@ options:
     default: false
   metadata:
     type: dict
+    default: {}
     description:
     - Hash of arbitrary key-value pairs to accompany this check if it fires.
       Keys and values must be strings between 1 and 255 characters long.

plugins/modules/cloud/rackspace/rax_mon_entity.py

@@ -38,6 +38,7 @@ options:
       bound. Necessary to collect C(agent.) rax_mon_checks against this entity.
   named_ip_addresses:
     type: dict
+    default: {}
     description:
     - Hash of IP addresses that may be referenced by name by rax_mon_checks
       added to this entity. Must be a dictionary of with keys that are names
@@ -45,6 +46,7 @@ options:
       addresses.
   metadata:
     type: dict
+    default: {}
     description:
     - Hash of arbitrary C(name), C(value) pairs that are passed to associated
       rax_mon_alarms. Names and values must all be between 1 and 255 characters

plugins/modules/cloud/rackspace/rax_scaling_group.py

@@ -37,6 +37,7 @@ options:
       - manual
   files:
     type: dict
+    default: {}
     description:
       - 'Files to insert into the instance. Hash of C(remotepath: localpath)'
   flavor:
@@ -66,6 +67,7 @@ options:
     required: true
   meta:
     type: dict
+    default: {}
     description:
       - A hash of metadata to associate with the instance
   min_entities:

plugins/modules/cloud/scaleway/scaleway_container_registry.py

@@ -60,6 +60,7 @@ options:
     description:
       - Description of the container registry.
     type: str
+    default: ''
 
   privacy_policy:
     type: str

plugins/modules/cloud/scaleway/scaleway_lb.py

@@ -66,6 +66,7 @@ options:
   tags:
     type: list
     elements: str
+    default: []
     description:
     - List of tags to apply to the load-balancer
 

plugins/modules/cloud/softlayer/sl_vm.py

@@ -143,6 +143,7 @@ options:
       - List of ssh keys by their Id to be assigned to a virtual instance.
     type: list
     elements: str
+    default: []
   post_uri:
     description:
       - URL of a post provisioning script to be loaded and executed on virtual instance.

plugins/modules/cloud/spotinst/spotinst_aws_elastigroup.py

@@ -503,6 +503,12 @@ options:
         Only works if wait_for_instances is True.
     type: int
 
+  do_not_update:
+    description:
+      - TODO document.
+    type: list
+    default: []
+
 '''
 EXAMPLES = '''
 # Basic configuration YAML example

plugins/modules/cloud/univention/udm_dns_zone.py

@@ -43,11 +43,13 @@ options:
     nameserver:
         type: list
         elements: str
+        default: []
         description:
             - List of appropriate name servers. Required if I(state=present).
     interfaces:
         type: list
         elements: str
+        default: []
         description:
             - List of interface IP addresses, on which the server should
               response this zone. Required if I(state=present).

plugins/modules/cloud/univention/udm_group.py

@@ -45,11 +45,13 @@ options:
             - define the whole ldap position of the group, e.g.
               C(cn=g123m-1A,cn=classes,cn=schueler,cn=groups,ou=schule,dc=example,dc=com).
         type: str
+        default: ''
     ou:
         required: false
         description:
             - LDAP OU, e.g. school for LDAP OU C(ou=school,dc=example,dc=com).
         type: str
+        default: ''
     subpath:
         required: false
         description:

plugins/modules/cloud/univention/udm_user.py

@@ -169,6 +169,7 @@ options:
         description:
             - List of telephone numbers.
         type: list
+        default: []
     postcode:
         description:
             - Postal code of users business address.
@@ -200,11 +201,13 @@ options:
                join."
         aliases: [ sambaPrivileges ]
         type: list
+        default: []
     samba_user_workstations:
         description:
             - Allow the authentication only on this Microsoft Windows host.
         aliases: [ sambaUserWorkstations ]
         type: list
+        default: []
     sambahome:
         description:
             - Windows home path, e.g. C('\\$FQDN\$USERNAME').