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)

This commit is contained in:
Felix Fontein 2022-11-01 19:25:51 +01:00 committed by GitHub
parent 5f4e593116
commit f84a9bf932
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
75 changed files with 134 additions and 20 deletions

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -44,11 +44,13 @@ options:
description: description:
- C(SRV) and C(TXT) record priority, in the range 0 > 999 (inclusive). - C(SRV) and C(TXT) record priority, in the range 0 > 999 (inclusive).
type: int type: int
default: 0
record: record:
required: false required: false
description: description:
- The subdomain to create. - The subdomain to create.
type: str type: str
default: ''
type: type:
required: true required: true
description: description:
@ -65,6 +67,7 @@ options:
description: description:
- The record's TTL in seconds (will inherit zone's TTL if not explicitly set). This must be a - 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). 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 ] choices: [ 0, 300, 600, 900, 1800, 3600, 7200, 10800, 21600, 43200, 86400 ]
type: int type: int
zone: zone:

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -62,11 +62,13 @@ options:
- List of server identifiers (name or id) to be added to the private network. - List of server identifiers (name or id) to be added to the private network.
type: list type: list
elements: str elements: str
default: []
remove_members: remove_members:
description: description:
- List of server identifiers (name or id) to be removed from the private network. - List of server identifiers (name or id) to be removed from the private network.
type: list type: list
elements: str elements: str
default: []
wait: wait:
description: description:
- wait for the instance to be in state 'running' before returning - 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. - URL of custom iPXE script for provisioning.
- More about custom iPXE for Packet devices at U(https://help.packet.net/technical/infrastructure/custom-ipxe). - More about custom iPXE for Packet devices at U(https://help.packet.net/technical/infrastructure/custom-ipxe).
type: str type: str
default: ''
always_pxe: always_pxe:
description: description:

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -40,6 +40,7 @@ options:
type: list type: list
required: false required: false
elements: str elements: str
default: []
add_files: add_files:
description: description:
- Allows to add and replace files in the ISO file. - Allows to add and replace files in the ISO file.
@ -47,6 +48,7 @@ options:
type: list type: list
required: false required: false
elements: dict elements: dict
default: []
suboptions: suboptions:
src_file: src_file:
description: description:

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -73,7 +73,7 @@ options:
extra_args: extra_args:
description: description:
- Additional option to pass to pacman when enforcing C(state). - Additional option to pass to pacman when enforcing C(state).
default: default: ''
type: str type: str
update_cache: update_cache:
@ -89,7 +89,7 @@ options:
update_cache_extra_args: update_cache_extra_args:
description: description:
- Additional option to pass to pacman when enforcing C(update_cache). - Additional option to pass to pacman when enforcing C(update_cache).
default: default: ''
type: str type: str
upgrade: upgrade:
@ -102,7 +102,7 @@ options:
upgrade_extra_args: upgrade_extra_args:
description: description:
- Additional option to pass to pacman when enforcing C(upgrade). - Additional option to pass to pacman when enforcing C(upgrade).
default: default: ''
type: str type: str
reason: reason:

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -72,6 +72,7 @@ options:
description: description:
- Setting dict of manager services to update. - Setting dict of manager services to update.
type: dict type: dict
default: {}
version_added: '0.2.0' version_added: '0.2.0'
resource_id: resource_id:
required: false required: false
@ -91,6 +92,7 @@ options:
description: description:
- Setting dict of EthernetInterface on OOB controller. - Setting dict of EthernetInterface on OOB controller.
type: dict type: dict
default: {}
version_added: '0.2.0' version_added: '0.2.0'
strip_etag_quotes: strip_etag_quotes:
description: description:
@ -106,6 +108,7 @@ options:
description: description:
- Setting dict of HostInterface on OOB controller. - Setting dict of HostInterface on OOB controller.
type: dict type: dict
default: {}
version_added: '4.1.0' version_added: '4.1.0'
hostinterface_id: hostinterface_id:
required: false required: false
@ -118,6 +121,7 @@ options:
description: description:
- Setting dict of Sessions. - Setting dict of Sessions.
type: dict type: dict
default: {}
version_added: '5.7.0' version_added: '5.7.0'
author: "Jose Delarosa (@jose-delarosa)" author: "Jose Delarosa (@jose-delarosa)"

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -161,6 +161,7 @@ options:
and the JIRA REST API for the structure required for various fields. 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. - 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. - Note that JIRA may not allow changing field values on specific transitions or states.
default: {}
jql: jql:
required: false required: false

View file

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

View file

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

View file

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

View file

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