1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Fix non-matching defaults. (#5452) (#5454)

(cherry picked from commit f84a9bf932)
This commit is contained in:
Felix Fontein 2022-11-01 20:09:31 +01:00 committed by GitHub
parent 2754d86ac5
commit d119905bd5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
73 changed files with 130 additions and 21 deletions

View file

@ -42,6 +42,7 @@ options:
- The path on which InfluxDB server is accessible
- Only available when using python-influxdb >= 5.1.0
type: str
default: ''
version_added: '0.2.0'
validate_certs:
description:
@ -79,4 +80,5 @@ options:
description:
- HTTP(S) proxy to use for Requests to connect to InfluxDB server.
type: dict
default: {}
'''

View file

@ -22,6 +22,7 @@ options:
description:
- The password to use with I(bind_dn).
type: str
default: ''
dn:
required: true
description:

View file

@ -16,6 +16,7 @@ options:
- Is needed for some modules
type: dict
required: false
default: {}
utm_host:
description:
- The REST Endpoint of the Sophos UTM.

View file

@ -60,6 +60,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'''

View file

@ -44,6 +44,7 @@ options:
description:
- A description of the VLAN.
type: str
default: ''
network_domain:
description:
- The Id or name of the target network domain.
@ -53,11 +54,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.

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -36,6 +36,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

View file

@ -43,6 +43,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

View file

@ -43,11 +43,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:
@ -64,6 +66,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:

View file

@ -53,6 +53,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.

View file

@ -34,6 +34,7 @@ options:
- The name of the serverless framework project stage to deploy to.
- This uses the serverless framework default "dev".
type: str
default: ''
functions:
description:
- A list of specific functions to deploy.
@ -41,12 +42,12 @@ options:
- Deprecated parameter, it will be removed in community.general 5.0.0.
type: list
elements: 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.

View file

@ -89,6 +89,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

View file

@ -59,6 +59,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.
@ -66,12 +67,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.
@ -79,12 +82,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

View file

@ -97,6 +97,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
@ -109,12 +110,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.
@ -122,12 +125,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

View file

@ -73,6 +73,7 @@ options:
and value is used to advise when the value is exceeded.
type: list
elements: dict
default: []
suboptions:
cpu:
description:
@ -99,6 +100,7 @@ options:
- Array of ports that will be monitoring.
type: list
elements: dict
default: []
suboptions:
protocol:
description:
@ -123,6 +125,7 @@ options:
- Array of processes that will be monitoring.
type: list
elements: dict
default: []
suboptions:
process:
description:
@ -139,48 +142,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

View file

@ -73,11 +73,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

View file

@ -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:

View file

@ -37,6 +37,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.
@ -73,6 +74,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.

View file

@ -49,7 +49,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.
@ -80,7 +80,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.

View file

@ -36,6 +36,7 @@ options:
same play)."
required: false
type: str
default: ''
password:
description:
- Password which match to account to which specified C(email) belong.
@ -43,6 +44,7 @@ options:
same play)."
required: false
type: str
default: ''
cache:
description: >
In case if single play use blocks management module few times it is
@ -57,7 +59,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

View file

@ -81,17 +81,20 @@ options:
default: 'no'
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:
@ -123,6 +126,7 @@ options:
- keypair
meta:
type: dict
default: {}
description:
- A hash of metadata to associate with the instance
name:

View file

@ -25,6 +25,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:

View file

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

View file

@ -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:

View file

@ -39,6 +39,7 @@ options:
Requires an integer, specifying expiration in seconds
meta:
type: dict
default: {}
description:
- A hash of items to set as metadata values on an uploaded file or folder
method:

View file

@ -29,6 +29,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)"

View file

@ -86,6 +86,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
@ -97,6 +98,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.

View file

@ -37,6 +37,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
@ -44,6 +45,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

View file

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

View file

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

View file

@ -142,6 +142,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.

View file

@ -502,6 +502,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

View file

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

View file

@ -44,11 +44,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:

View file

@ -168,6 +168,7 @@ options:
description:
- List of telephone numbers.
type: list
default: []
postcode:
description:
- Postal code of users business address.
@ -199,11 +200,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').

View file

@ -26,10 +26,12 @@ options:
description:
- The username used to authenticate with
type: str
default: ''
login_password:
description:
- The password used to authenticate with
type: str
default: ''
login_host:
description:
- Host running the database

View file

@ -39,6 +39,7 @@ options:
- The namespace C(prefix:uri) mapping for the XPath expression.
- Needs to be a C(dict), not a C(list) of items.
type: dict
default: {}
state:
description:
- Set or remove an xpath selection (node(s), attribute(s)).

View file

@ -85,7 +85,6 @@ options:
description:
- The secret key for your subdomain.
- Only required for initial sign in.
default: {}
required: False
cli_path:
type: path

View file

@ -52,14 +52,12 @@ options:
elements: str
description:
- List of handlers to notify when the check fails
default: []
subscribers:
type: list
elements: str
description:
- List of subscribers/channels this check should run for
- See sensu_subscribers to subscribe a machine to a channel
default: []
interval:
type: int
description:
@ -91,7 +89,6 @@ options:
elements: str
description:
- Other checks this check depends on, if dependencies fail handling of this check will be disabled
default: []
metric:
description:
- Whether the check is a metric
@ -137,7 +134,6 @@ options:
description:
- A hash/dictionary of custom parameters for mixing to the configuration.
- You can't rewrite others module parameters using this
default: {}
source:
type: str
description:

View file

@ -61,6 +61,7 @@ options:
type: str
description:
- The prefix to add to the metric.
default: ''
value:
type: int
required: true

View file

@ -126,7 +126,6 @@ options:
description:
- Name or id of the contact list that the monitor will notify.
- The default C('') means the Account Owner.
default: ''
type: str
httpFqdn:

View file

@ -41,27 +41,22 @@ options:
description:
- Network ID.
type: str
default: ''
ip_address:
description:
- IP Address for a reservation or a release.
type: str
default: ''
network_address:
description:
- Network address with CIDR format (e.g., 192.168.310.0).
type: str
default: ''
network_size:
description:
- Network bitmask (e.g. 255.255.255.220) or CIDR format (e.g., /26).
type: str
default: ''
network_name:
description:
- The name of a network.
type: str
default: ''
network_location:
description:
- The parent network id for a given network.

View file

@ -36,6 +36,7 @@ options:
entries are never modified. To assert specific attribute values on an
existing entry, use M(community.general.ldap_attrs) module instead.
type: dict
default: {}
objectClass:
description:
- If I(state=present), value or list of values to use when creating

View file

@ -48,12 +48,14 @@ options:
- This is a list, which may contain address and phrase portions.
type: list
elements: str
default: []
bcc:
description:
- The email-address(es) the mail is being 'blind' copied to.
- This is a list, which may contain address and phrase portions.
type: list
elements: str
default: []
subject:
description:
- The subject of the email being sent.

View file

@ -30,6 +30,7 @@ options:
type: str
description:
- Composer arguments like required package, version and so on.
default: ''
executable:
type: path
description:

View file

@ -50,6 +50,7 @@ options:
type: str
description:
- The maven classifier coordinate
default: ''
extension:
type: str
description:

View file

@ -46,6 +46,7 @@ options:
- "remove"
- "checksum"
- "removal-of-dependent-packages"
default: ""
type: str
update_cache:
description:

View file

@ -72,7 +72,7 @@ options:
extra_args:
description:
- Additional option to pass to pacman when enforcing C(state).
default:
default: ''
type: str
update_cache:
@ -91,7 +91,7 @@ options:
update_cache_extra_args:
description:
- Additional option to pass to pacman when enforcing C(update_cache).
default:
default: ''
type: str
upgrade:
@ -104,7 +104,7 @@ options:
upgrade_extra_args:
description:
- Additional option to pass to pacman when enforcing C(upgrade).
default:
default: ''
type: str
notes:

View file

@ -151,7 +151,6 @@ options:
When some attribute is not listed in the new list of attributes, the existing
attribute will be removed from C(syspurpose.json) file. Unknown attributes are ignored.
type: dict
default: {}
suboptions:
usage:
description: Syspurpose attribute usage

View file

@ -75,6 +75,7 @@ options:
- especially useful for SCM and rsync grimoires
- makes sense only in pair with C(update_cache)
type: int
default: 0
'''

View file

@ -68,6 +68,7 @@ options:
- The list of media types appropriate for the image.
type: list
elements: str
default: []
image_url:
description:
- The URL of the image to insert or eject.

View file

@ -79,7 +79,7 @@ options:
- ' - C(vms_allocated) (int): use null to remove the quota.'
- ' - C(templates_allocated) (int): use null to remove the quota.'
required: false
default: null
default: {}
'''
EXAMPLES = '''

View file

@ -115,6 +115,7 @@ options:
description:
- Properties of account service to update.
type: dict
default: {}
version_added: '0.2.0'
resource_id:
required: false
@ -140,6 +141,7 @@ options:
- List of target resource URIs to apply the update to.
type: list
elements: str
default: []
version_added: '0.2.0'
update_creds:
required: false
@ -171,6 +173,7 @@ options:
- List of media types appropriate for the image.
type: list
elements: str
default: []
image_url:
required: false
description:

View file

@ -71,6 +71,7 @@ options:
description:
- Setting dict of manager services to update.
type: dict
default: {}
version_added: '0.2.0'
resource_id:
required: false
@ -90,6 +91,7 @@ options:
description:
- Setting dict of EthernetInterface on OOB controller.
type: dict
default: {}
version_added: '0.2.0'
strip_etag_quotes:
description:
@ -105,6 +107,7 @@ options:
description:
- Setting dict of HostInterface on OOB controller.
type: dict
default: {}
version_added: '4.1.0'
hostinterface_id:
required: false

View file

@ -73,12 +73,14 @@ options:
- Rack to be used in host creation.
- Required if I(state) is C(present) and host does not yet exist.
type: int
default: 0
rank:
description:
- Rank to be used in host creation.
- In Stacki terminology, the rank is the position of the machine in a rack.
- Required if I(state) is C(present) and host does not yet exist.
type: int
default: 0
network:
description:
- Network to be configured in the host.

View file

@ -54,6 +54,7 @@ options:
- Branch name of wildcard to trigger hook on push events
type: str
version_added: '0.2.0'
default: ''
issues_events:
description:
- Trigger hook on issues events.

View file

@ -37,6 +37,7 @@ options:
- A dictionary of zfs properties to be set.
- See the zfs(8) man page for more information.
type: dict
default: {}
notes:
- C(check_mode) is supported, but in certain situations it may report a task
as changed that will not be reported as changed when C(check_mode) is disabled.

View file

@ -51,6 +51,7 @@ options:
description:
- Specifies recursion depth.
type: int
default: 0
'''
EXAMPLES = '''

View file

@ -61,11 +61,13 @@ options:
description:
- Free-form options to be passed to the mklv command.
type: str
default: ''
pvs:
description:
- A list of physical volumes e.g. C(hdisk1,hdisk2).
type: list
elements: str
default: []
'''
EXAMPLES = r'''

View file

@ -55,7 +55,6 @@ options:
description:
- Password for importing from PKCS12 keystore.
type: str
default: ''
pkcs12_alias:
description:
- Alias in the PKCS12 keystore.

View file

@ -41,6 +41,7 @@ options:
description:
- Additional options to pass to C(pvcreate) when creating the volume group.
type: str
default: ''
pvresize:
description:
- If C(yes), resize the physical volume to the maximum available size.
@ -51,6 +52,7 @@ options:
description:
- Additional options to pass to C(vgcreate) when creating the volume group.
type: str
default: ''
state:
description:
- Control if the volume group exists.

View file

@ -37,6 +37,7 @@ options:
description:
- Name of the SELinux policy store to use.
type: str
default: ''
notes:
- Requires a recent version of SELinux and C(policycoreutils-python) (EL 6 or newer).
requirements: [ policycoreutils-python ]

View file

@ -160,6 +160,7 @@ options:
and the JIRA REST API for the structure required for various fields.
- When passed to comment, the data structure is merged at the first level since community.general 4.6.0. Useful to add JIRA properties for example.
- Note that JIRA may not allow changing field values on specific transitions or states.
default: {}
jql:
required: false

View file

@ -32,10 +32,12 @@ options:
- List of adirectory group strings.
type: list
elements: str
default: []
adirectory_groups_sids:
description:
- Dictionary of group sids.
type: dict
default: {}
backend_match:
description:
- The backend for the group.
@ -67,18 +69,22 @@ options:
- List of edirectory group strings.
type: list
elements: str
default: []
ipsec_dn:
description:
- The ipsec dn string.
type: str
default: ''
ldap_attribute:
description:
- The ldap attribute to check against.
type: str
default: ''
ldap_attribute_value:
description:
- The ldap attribute value to check against.
type: str
default: ''
members:
description:
- A list of user ref names (aaa/user).

View file

@ -41,6 +41,7 @@ options:
type: str
description:
- An optional comment to add to the dns host object
default: ''
hostname:
type: str
description:
@ -49,6 +50,7 @@ options:
type: str
description:
- The reference name of the interface to use. If not provided the default interface will be used
default: ''
resolved:
description:
- whether the hostname's ipv4 address is already resolved or not

View file

@ -41,6 +41,7 @@ options:
type: str
description:
- An optional comment to add to the object
default: ''
resolved:
type: bool
description:

View file

@ -46,6 +46,7 @@ options:
type: str
description:
- The reference name of the auth profile
default: ''
backend:
type: list
elements: str
@ -56,10 +57,12 @@ options:
type: str
description:
- The path of the backend
default: ''
comment:
type: str
description:
- The optional comment string
default: ''
denied_networks:
type: list
elements: str