mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-08 14:22:46 +00:00
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
This commit is contained in:
@@ -35,68 +35,53 @@ options:
|
||||
required: true
|
||||
port:
|
||||
description: Service port. Required for C(type=SRV)
|
||||
required: false
|
||||
default: null
|
||||
priority:
|
||||
description: Record priority. Required for C(type=MX) and C(type=SRV)
|
||||
required: false
|
||||
default: "1"
|
||||
proto:
|
||||
description: Service protocol. Required for C(type=SRV). Common values are tcp and udp. (Before Ansible 2.6 only tcp and udp were available).
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- Service protocol. Required for C(type=SRV).
|
||||
- Common values are tcp and udp.
|
||||
- Before Ansible 2.6 only tcp and udp were available.
|
||||
proxied:
|
||||
description: Proxy through cloudflare network or just use DNS
|
||||
required: false
|
||||
default: no
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.3"
|
||||
record:
|
||||
description:
|
||||
- Record to add. Required if C(state=present). Default is C(@) (e.g. the zone name)
|
||||
required: false
|
||||
default: "@"
|
||||
aliases: [ "name" ]
|
||||
service:
|
||||
description: Record service. Required for C(type=SRV)
|
||||
required: false
|
||||
default: null
|
||||
solo:
|
||||
description:
|
||||
- Whether the record should be the only one for that record type and record name. Only use with C(state=present)
|
||||
- This will delete all other records with the same record name and type.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- Whether the record(s) should exist or not
|
||||
required: false
|
||||
choices: [ 'present', 'absent' ]
|
||||
default: present
|
||||
timeout:
|
||||
description:
|
||||
- Timeout for Cloudflare API calls
|
||||
required: false
|
||||
default: 30
|
||||
ttl:
|
||||
description:
|
||||
- The TTL to give the new record. Must be between 120 and 2,147,483,647 seconds, or 1 for automatic.
|
||||
required: false
|
||||
default: 1 (automatic)
|
||||
type:
|
||||
description:
|
||||
- The type of DNS record to create. Required if C(state=present)
|
||||
required: false
|
||||
choices: [ 'A', 'AAAA', 'CNAME', 'TXT', 'SRV', 'MX', 'NS', 'SPF' ]
|
||||
default: null
|
||||
value:
|
||||
description:
|
||||
- The record value. Required for C(state=present)
|
||||
required: false
|
||||
default: null
|
||||
aliases: [ "content" ]
|
||||
weight:
|
||||
description: Service weight. Required for C(type=SRV)
|
||||
required: false
|
||||
default: "1"
|
||||
zone:
|
||||
description:
|
||||
|
||||
@@ -24,73 +24,52 @@ options:
|
||||
- >
|
||||
Account email. If omitted, the env variables DNSIMPLE_EMAIL and DNSIMPLE_API_TOKEN will be looked for.
|
||||
If those aren't found, a C(.dnsimple) file will be looked for, see: U(https://github.com/mikemaccana/dnsimple-python#getting-started)
|
||||
required: false
|
||||
default: null
|
||||
|
||||
account_api_token:
|
||||
description:
|
||||
- Account API token. See I(account_email) for info.
|
||||
required: false
|
||||
default: null
|
||||
|
||||
domain:
|
||||
description:
|
||||
- Domain to work with. Can be the domain name (e.g. "mydomain.com") or the numeric ID of the domain in DNSimple. If omitted, a list of domains
|
||||
will be returned.
|
||||
- If domain is present but the domain doesn't exist, it will be created.
|
||||
required: false
|
||||
default: null
|
||||
|
||||
record:
|
||||
description:
|
||||
- Record to add, if blank a record for the domain will be created, supports the wildcard (*)
|
||||
required: false
|
||||
default: null
|
||||
|
||||
record_ids:
|
||||
description:
|
||||
- List of records to ensure they either exist or don't exist
|
||||
required: false
|
||||
default: null
|
||||
|
||||
type:
|
||||
description:
|
||||
- The type of DNS record to create
|
||||
required: false
|
||||
choices: [ 'A', 'ALIAS', 'CNAME', 'MX', 'SPF', 'URL', 'TXT', 'NS', 'SRV', 'NAPTR', 'PTR', 'AAAA', 'SSHFP', 'HINFO', 'POOL' ]
|
||||
default: null
|
||||
|
||||
ttl:
|
||||
description:
|
||||
- The TTL to give the new record
|
||||
required: false
|
||||
default: 3600 (one hour)
|
||||
|
||||
value:
|
||||
description:
|
||||
- Record value
|
||||
- "Must be specified when trying to ensure a record exists"
|
||||
required: false
|
||||
default: null
|
||||
|
||||
priority:
|
||||
description:
|
||||
- Record priority
|
||||
required: false
|
||||
default: null
|
||||
|
||||
state:
|
||||
description:
|
||||
- whether the record should exist or not
|
||||
required: false
|
||||
choices: [ 'present', 'absent' ]
|
||||
default: null
|
||||
|
||||
solo:
|
||||
description:
|
||||
- Whether the record should be the only one for that record type and record name. Only use with state=present on a record
|
||||
required: false
|
||||
default: null
|
||||
|
||||
requirements: [ dnsimple ]
|
||||
author: "Alex Coomans (@drcapulet)"
|
||||
|
||||
@@ -25,34 +25,27 @@ options:
|
||||
description:
|
||||
- Account API Key.
|
||||
required: true
|
||||
default: null
|
||||
|
||||
account_secret:
|
||||
description:
|
||||
- Account Secret Key.
|
||||
required: true
|
||||
default: null
|
||||
|
||||
domain:
|
||||
description:
|
||||
- Domain to work with. Can be the domain name (e.g. "mydomain.com") or the numeric ID of the domain in DNS Made Easy (e.g. "839989") for faster
|
||||
resolution
|
||||
required: true
|
||||
default: null
|
||||
|
||||
record_name:
|
||||
description:
|
||||
- Record name to get/create/delete/update. If record_name is not specified; all records for the domain will be returned in "result" regardless
|
||||
of the state argument.
|
||||
required: false
|
||||
default: null
|
||||
|
||||
record_type:
|
||||
description:
|
||||
- Record type.
|
||||
required: false
|
||||
choices: [ 'A', 'AAAA', 'CNAME', 'ANAME', 'HTTPRED', 'MX', 'NS', 'PTR', 'SRV', 'TXT' ]
|
||||
default: null
|
||||
|
||||
record_value:
|
||||
description:
|
||||
@@ -62,13 +55,10 @@ options:
|
||||
- >
|
||||
If record_value is not specified; no changes will be made and the record will be returned in 'result'
|
||||
(in other words, this module can be used to fetch a record's current id, type, and ttl)
|
||||
required: false
|
||||
default: null
|
||||
|
||||
record_ttl:
|
||||
description:
|
||||
- record's "Time to live". Number of seconds the record remains cached in DNS servers.
|
||||
required: false
|
||||
default: 1800
|
||||
|
||||
state:
|
||||
@@ -76,23 +66,20 @@ options:
|
||||
- whether the record should exist or not
|
||||
required: true
|
||||
choices: [ 'present', 'absent' ]
|
||||
default: null
|
||||
|
||||
validate_certs:
|
||||
description:
|
||||
- If C(no), SSL certificates will not be validated. This should only be used
|
||||
on personally controlled sites using self-signed certificates.
|
||||
required: false
|
||||
type: bool
|
||||
default: 'yes'
|
||||
choices: ['yes', 'no']
|
||||
version_added: 1.5.1
|
||||
|
||||
monitor:
|
||||
description:
|
||||
- If C(yes), add or change the monitor. This is applicable only for A records.
|
||||
required: true
|
||||
type: bool
|
||||
default: 'no'
|
||||
choices: ['yes', 'no']
|
||||
version_added: 2.4
|
||||
|
||||
systemDescription:
|
||||
@@ -143,68 +130,58 @@ options:
|
||||
httpFqdn:
|
||||
description:
|
||||
- The fully qualified domain name used by the monitor.
|
||||
required: false
|
||||
version_added: 2.4
|
||||
|
||||
httpFile:
|
||||
description:
|
||||
- The file at the Fqdn that the monitor queries for HTTP or HTTPS.
|
||||
required: false
|
||||
version_added: 2.4
|
||||
|
||||
httpQueryString:
|
||||
description:
|
||||
- The string in the httpFile that the monitor queries for HTTP or HTTPS.
|
||||
required: False
|
||||
version_added: 2.4
|
||||
|
||||
failover:
|
||||
description:
|
||||
- If C(yes), add or change the failover. This is applicable only for A records.
|
||||
required: true
|
||||
type: bool
|
||||
default: 'no'
|
||||
choices: ['yes', 'no']
|
||||
version_added: 2.4
|
||||
|
||||
autoFailover:
|
||||
description:
|
||||
- If true, fallback to the primary IP address is manual after a failover.
|
||||
- If false, fallback to the primary IP address is automatic after a failover.
|
||||
required: true
|
||||
type: bool
|
||||
default: 'no'
|
||||
choices: ['yes', 'no']
|
||||
version_added: 2.4
|
||||
|
||||
ip1:
|
||||
description:
|
||||
- Primary IP address for the failover.
|
||||
- Required if adding or changing the monitor or failover.
|
||||
required: false
|
||||
version_added: 2.4
|
||||
|
||||
ip2:
|
||||
description:
|
||||
- Secondary IP address for the failover.
|
||||
- Required if adding or changing the failover.
|
||||
required: false
|
||||
version_added: 2.4
|
||||
|
||||
ip3:
|
||||
description:
|
||||
- Tertiary IP address for the failover.
|
||||
required: false
|
||||
version_added: 2.4
|
||||
|
||||
ip4:
|
||||
description:
|
||||
- Quaternary IP address for the failover.
|
||||
required: false
|
||||
version_added: 2.4
|
||||
|
||||
ip5:
|
||||
description:
|
||||
- Quinary IP address for the failover.
|
||||
required: false
|
||||
version_added: 2.4
|
||||
|
||||
notes:
|
||||
|
||||
@@ -33,7 +33,6 @@ options:
|
||||
backend:
|
||||
description:
|
||||
- Name of the HAProxy backend pool.
|
||||
required: false
|
||||
default: auto-detected
|
||||
drain:
|
||||
description:
|
||||
@@ -41,25 +40,22 @@ options:
|
||||
determined by wait_interval and wait_retries is reached. Continue only
|
||||
after the status changes to 'MAINT'. This overrides the
|
||||
shutdown_sessions option.
|
||||
default: false
|
||||
version_added: "2.4"
|
||||
host:
|
||||
description:
|
||||
- Name of the backend host to change.
|
||||
required: true
|
||||
default: null
|
||||
shutdown_sessions:
|
||||
description:
|
||||
- When disabling a server, immediately terminate all the sessions attached
|
||||
to the specified server. This can be used to terminate long-running
|
||||
sessions after a server is put into maintenance mode. Overridden by the
|
||||
drain option.
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
socket:
|
||||
description:
|
||||
- Path to the HAProxy socket file.
|
||||
required: false
|
||||
default: /var/run/haproxy.sock
|
||||
state:
|
||||
description:
|
||||
@@ -67,31 +63,28 @@ options:
|
||||
- Note that C(drain) state was added in version 2.4. It is supported only by HAProxy version 1.5 or later,
|
||||
if used on versions < 1.5, it will be ignored.
|
||||
required: true
|
||||
default: null
|
||||
choices: [ "enabled", "disabled", "drain" ]
|
||||
fail_on_not_found:
|
||||
description:
|
||||
- Fail whenever trying to enable/disable a backend host that does not exist
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.2"
|
||||
wait:
|
||||
description:
|
||||
- Wait until the server reports a status of 'UP' when `state=enabled`,
|
||||
status of 'MAINT' when `state=disabled` or status of 'DRAIN' when `state=drain`
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
version_added: "2.0"
|
||||
wait_interval:
|
||||
description:
|
||||
- Number of seconds to wait between retries.
|
||||
required: false
|
||||
default: 5
|
||||
version_added: "2.0"
|
||||
wait_retries:
|
||||
description:
|
||||
- Number of times to check for status after changing the state.
|
||||
required: false
|
||||
default: 25
|
||||
version_added: "2.0"
|
||||
weight:
|
||||
@@ -100,8 +93,6 @@ options:
|
||||
the new weight will be relative to the initially configured weight.
|
||||
Relative weights are only permitted between 0 and 100% and absolute
|
||||
weights are permitted between 0 and 256.
|
||||
required: false
|
||||
default: null
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
|
||||
@@ -43,42 +43,33 @@ requirements:
|
||||
- python-ldap
|
||||
options:
|
||||
bind_dn:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- A DN to bind with. If this is omitted, we'll try a SASL bind with
|
||||
the EXTERNAL mechanism. If this is blank, we'll use an anonymous
|
||||
bind.
|
||||
bind_pw:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- The password to use with I(bind_dn).
|
||||
dn:
|
||||
required: true
|
||||
description:
|
||||
- The DN of the entry to modify.
|
||||
name:
|
||||
required: true
|
||||
name:
|
||||
description:
|
||||
- The name of the attribute to modify.
|
||||
required: true
|
||||
server_uri:
|
||||
required: false
|
||||
default: ldapi:///
|
||||
description:
|
||||
- A URI to the LDAP server. The default value lets the underlying
|
||||
LDAP client library look for a UNIX domain socket in its default
|
||||
location.
|
||||
default: ldapi:///
|
||||
start_tls:
|
||||
required: false
|
||||
choices: ['yes', 'no']
|
||||
default: 'no'
|
||||
description:
|
||||
- If true, we'll use the START_TLS LDAP extension.
|
||||
type: bool
|
||||
default: 'no'
|
||||
state:
|
||||
required: false
|
||||
choices: [present, absent, exact]
|
||||
default: present
|
||||
description:
|
||||
- The state of the attribute values. If C(present), all given
|
||||
values will be added if they're missing. If C(absent), all given
|
||||
@@ -86,19 +77,20 @@ options:
|
||||
will be forced to exactly those provided and no others. If
|
||||
I(state=exact) and I(value) is empty, all values for this
|
||||
attribute will be removed.
|
||||
choices: [present, absent, exact]
|
||||
default: present
|
||||
values:
|
||||
required: true
|
||||
description:
|
||||
- The value(s) to add or remove. This can be a string or a list of
|
||||
strings. The complex argument format is required in order to pass
|
||||
a list of strings (see examples).
|
||||
required: true
|
||||
validate_certs:
|
||||
required: false
|
||||
choices: ['yes', 'no']
|
||||
default: 'yes'
|
||||
description:
|
||||
- If C(no), SSL certificates will not be validated. This should only be
|
||||
used on sites using self-signed certificates.
|
||||
type: bool
|
||||
default: 'yes'
|
||||
version_added: "2.4"
|
||||
"""
|
||||
|
||||
|
||||
@@ -37,68 +37,54 @@ requirements:
|
||||
- python-ldap
|
||||
options:
|
||||
bind_dn:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- A DN to bind with. If this is omitted, we'll try a SASL bind with
|
||||
the EXTERNAL mechanism. If this is blank, we'll use an anonymous
|
||||
bind.
|
||||
bind_pw:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- The password to use with I(bind_dn).
|
||||
dn:
|
||||
required: true
|
||||
description:
|
||||
- The DN of the entry to add or remove.
|
||||
required: true
|
||||
attributes:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- If I(state=present), attributes necessary to create an entry. Existing
|
||||
entries are never modified. To assert specific attribute values on an
|
||||
existing entry, use M(ldap_attr) module instead.
|
||||
objectClass:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- If I(state=present), value or list of values to use when creating
|
||||
the entry. It can either be a string or an actual list of
|
||||
strings.
|
||||
params:
|
||||
required: false
|
||||
default: null
|
||||
description:
|
||||
- List of options which allows to overwrite any of the task or the
|
||||
I(attributes) options. To remove an option, set the value of the option
|
||||
to C(null).
|
||||
server_uri:
|
||||
required: false
|
||||
default: ldapi:///
|
||||
description:
|
||||
- A URI to the LDAP server. The default value lets the underlying
|
||||
LDAP client library look for a UNIX domain socket in its default
|
||||
location.
|
||||
default: ldapi:///
|
||||
start_tls:
|
||||
required: false
|
||||
choices: ['yes', 'no']
|
||||
default: 'no'
|
||||
description:
|
||||
- If true, we'll use the START_TLS LDAP extension.
|
||||
type: bool
|
||||
default: 'no'
|
||||
state:
|
||||
required: false
|
||||
choices: [present, absent]
|
||||
default: present
|
||||
description:
|
||||
- The target state of the entry.
|
||||
choices: [present, absent]
|
||||
default: present
|
||||
validate_certs:
|
||||
required: false
|
||||
choices: ['yes', 'no']
|
||||
default: 'yes'
|
||||
description:
|
||||
- If C(no), SSL certificates will not be validated. This should only be
|
||||
used on sites using self-signed certificates.
|
||||
type: bool
|
||||
default: 'yes'
|
||||
version_added: "2.4"
|
||||
"""
|
||||
|
||||
|
||||
@@ -29,7 +29,6 @@ options:
|
||||
- Specifies the fully qualified hostname to add or remove from
|
||||
the system
|
||||
required: true
|
||||
default: null
|
||||
view:
|
||||
description:
|
||||
- Sets the DNS view to associate this host record with. The DNS
|
||||
@@ -42,8 +41,6 @@ options:
|
||||
description:
|
||||
- Configures the IPv4 addresses for this host record. This argument
|
||||
accepts a list of values (see suboptions)
|
||||
required: false
|
||||
default: null
|
||||
aliases:
|
||||
- ipv4
|
||||
suboptions:
|
||||
@@ -51,19 +48,15 @@ options:
|
||||
description:
|
||||
- Configures the IPv4 address for the host record
|
||||
required: true
|
||||
default: null
|
||||
aliases:
|
||||
- address
|
||||
mac:
|
||||
description:
|
||||
- Configures the hardware MAC address for the host record
|
||||
required: false
|
||||
ipv6addrs:
|
||||
description:
|
||||
- Configures the IPv6 addresses for the host record. This argument
|
||||
accepts a list of values (see options)
|
||||
required: false
|
||||
default: null
|
||||
aliases:
|
||||
- ipv6
|
||||
suboptions:
|
||||
@@ -71,33 +64,27 @@ options:
|
||||
description:
|
||||
- Configures the IPv6 address for the host record
|
||||
required: true
|
||||
default: null
|
||||
aliases:
|
||||
- address
|
||||
ttl:
|
||||
description:
|
||||
- Configures the TTL to be associated with this host record
|
||||
required: false
|
||||
default: null
|
||||
extattrs:
|
||||
description:
|
||||
- Allows for the configuration of Extensible Attributes on the
|
||||
instance of the object. This argument accepts a set of key / value
|
||||
pairs for configuration.
|
||||
required: false
|
||||
comment:
|
||||
description:
|
||||
- Configures a text string comment to be associated with the instance
|
||||
of this object. The provided text string will be configured on the
|
||||
object instance.
|
||||
required: false
|
||||
state:
|
||||
description:
|
||||
- Configures the intended state of the instance of the object on
|
||||
the NIOS server. When this value is set to C(present), the object
|
||||
is configured on the device and when this value is set to C(absent)
|
||||
the value is removed (if necessary) from the device.
|
||||
required: false
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
|
||||
@@ -29,7 +29,6 @@ options:
|
||||
- Specifies the network to add or remove from the system. The value
|
||||
should use CIDR notation.
|
||||
required: true
|
||||
default: null
|
||||
aliases:
|
||||
- name
|
||||
- cidr
|
||||
@@ -45,55 +44,42 @@ options:
|
||||
the configured network instance. This argument accepts a list
|
||||
of values (see suboptions). When configuring suboptions at
|
||||
least one of C(name) or C(num) must be specified.
|
||||
required: false
|
||||
default: null
|
||||
suboptions:
|
||||
name:
|
||||
description:
|
||||
- The name of the DHCP option to configure
|
||||
required: false
|
||||
default: null
|
||||
num:
|
||||
description:
|
||||
- The number of the DHCP option to configure
|
||||
required: false
|
||||
value:
|
||||
description:
|
||||
- The value of the DHCP option specified by C(name)
|
||||
required: true
|
||||
default: null
|
||||
use_option:
|
||||
description:
|
||||
- Only applies to a subset of options (see NIOS API documentation)
|
||||
required: false
|
||||
type: bool
|
||||
default: true
|
||||
default: 'yes'
|
||||
vendor_class:
|
||||
description:
|
||||
- The name of the space this DHCP option is associated to
|
||||
required: false
|
||||
default: DHCP
|
||||
extattrs:
|
||||
description:
|
||||
- Allows for the configuration of Extensible Attributes on the
|
||||
instance of the object. This argument accepts a set of key / value
|
||||
pairs for configuration.
|
||||
required: false
|
||||
default: null
|
||||
comment:
|
||||
description:
|
||||
- Configures a text string comment to be associated with the instance
|
||||
of this object. The provided text string will be configured on the
|
||||
object instance.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- Configures the intended state of the instance of the object on
|
||||
the NIOS server. When this value is set to C(present), the object
|
||||
is configured on the device and when this value is set to C(absent)
|
||||
the value is removed (if necessary) from the device.
|
||||
required: false
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
|
||||
@@ -36,22 +36,17 @@ options:
|
||||
- Allows for the configuration of Extensible Attributes on the
|
||||
instance of the object. This argument accepts a set of key / value
|
||||
pairs for configuration.
|
||||
required: false
|
||||
default: null
|
||||
comment:
|
||||
description:
|
||||
- Configures a text string comment to be associated with the instance
|
||||
of this object. The provided text string will be configured on the
|
||||
object instance.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
description:
|
||||
- Configures the intended state of the instance of the object on
|
||||
the NIOS server. When this value is set to C(present), the object
|
||||
is configured on the device and when this value is set to C(absent)
|
||||
the value is removed (if necessary) from the device.
|
||||
required: false
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
|
||||
@@ -29,7 +29,6 @@ options:
|
||||
- Specifies the qualified domain name to either add or remove from
|
||||
the NIOS instance based on the configured C(state) value.
|
||||
required: true
|
||||
default: null
|
||||
aliases:
|
||||
- name
|
||||
view:
|
||||
@@ -44,17 +43,14 @@ options:
|
||||
grid_primary:
|
||||
description:
|
||||
- Configures the grid primary servers for this zone.
|
||||
required: false
|
||||
suboptions:
|
||||
name:
|
||||
description:
|
||||
- The name of the grid primary server
|
||||
required: true
|
||||
default: null
|
||||
grid_secondaries:
|
||||
description:
|
||||
- Configures the grid secondary servers for this zone.
|
||||
required: false
|
||||
suboptions:
|
||||
name:
|
||||
description:
|
||||
@@ -65,20 +61,17 @@ options:
|
||||
- Allows for the configuration of Extensible Attributes on the
|
||||
instance of the object. This argument accepts a set of key / value
|
||||
pairs for configuration.
|
||||
required: false
|
||||
comment:
|
||||
description:
|
||||
- Configures a text string comment to be associated with the instance
|
||||
of this object. The provided text string will be configured on the
|
||||
object instance.
|
||||
required: false
|
||||
state:
|
||||
description:
|
||||
- Configures the intended state of the instance of the object on
|
||||
the NIOS server. When this value is set to C(present), the object
|
||||
is configured on the device and when this value is set to C(absent)
|
||||
the value is removed (if necessary) from the device.
|
||||
required: false
|
||||
default: present
|
||||
choices:
|
||||
- present
|
||||
|
||||
@@ -28,204 +28,150 @@ description:
|
||||
- "On Ubuntu and Debian like systems, install dependencies as 'apt-get install -y libnm-glib-dev'"
|
||||
options:
|
||||
state:
|
||||
required: True
|
||||
choices: [ present, absent ]
|
||||
description:
|
||||
- Whether the device should exist or not, taking action if the state is different from what is stated.
|
||||
required: True
|
||||
choices: [ present, absent ]
|
||||
autoconnect:
|
||||
required: False
|
||||
default: "yes"
|
||||
type: bool
|
||||
description:
|
||||
- Whether the connection should start on boot.
|
||||
- Whether the connection profile can be automatically activated
|
||||
type: bool
|
||||
default: 'yes'
|
||||
conn_name:
|
||||
required: True
|
||||
description:
|
||||
- 'Where conn_name will be the name used to call the connection. when not provided a default name is generated: <type>[-<ifname>][-<num>]'
|
||||
required: True
|
||||
ifname:
|
||||
required: False
|
||||
default: conn_name
|
||||
description:
|
||||
- Where IFNAME will be the what we call the interface name.
|
||||
- interface to bind the connection to. The connection will only be applicable to this interface name.
|
||||
- A special value of "*" can be used for interface-independent connections.
|
||||
- The ifname argument is mandatory for all connection types except bond, team, bridge and vlan.
|
||||
default: conn_name
|
||||
type:
|
||||
required: False
|
||||
choices: [ ethernet, team, team-slave, bond, bond-slave, bridge, bridge-slave, vlan, generic ]
|
||||
description:
|
||||
- This is the type of device or network connection that you wish to create or modify.
|
||||
- "type C(generic) is added in version 2.5."
|
||||
choices: [ ethernet, team, team-slave, bond, bond-slave, bridge, bridge-slave, vlan, generic ]
|
||||
mode:
|
||||
required: False
|
||||
choices: [ "balance-rr", "active-backup", "balance-xor", "broadcast", "802.3ad", "balance-tlb", "balance-alb" ]
|
||||
default: balence-rr
|
||||
description:
|
||||
- This is the type of device or network connection that you wish to create for a bond, team or bridge.
|
||||
choices: [ "balance-rr", "active-backup", "balance-xor", "broadcast", "802.3ad", "balance-tlb", "balance-alb" ]
|
||||
default: balence-rr
|
||||
master:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- master <master (ifname, or connection UUID or conn_name) of bridge, team, bond master connection profile.
|
||||
ip4:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- 'The IPv4 address to this interface using this format ie: "192.0.2.24/24"'
|
||||
gw4:
|
||||
required: False
|
||||
description:
|
||||
- 'The IPv4 gateway for this interface using this format ie: "192.0.2.1"'
|
||||
dns4:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- 'A list of upto 3 dns servers, ipv4 format e.g. To add two IPv4 DNS server addresses: "192.0.2.53 198.51.100.53"'
|
||||
dns4_search:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- 'A list of DNS search domains.'
|
||||
version_added: 2.5
|
||||
ip6:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- 'The IPv6 address to this interface using this format ie: "abbe::cafe"'
|
||||
gw6:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- 'The IPv6 gateway for this interface using this format ie: "2001:db8::1"'
|
||||
dns6:
|
||||
required: False
|
||||
description:
|
||||
- 'A list of upto 3 dns servers, ipv6 format e.g. To add two IPv6 DNS server addresses: "2001:4860:4860::8888 2001:4860:4860::8844"'
|
||||
dns6_search:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- 'A list of DNS search domains.'
|
||||
version_added: 2.5
|
||||
mtu:
|
||||
required: False
|
||||
default: 1500
|
||||
description:
|
||||
- The connection MTU, e.g. 9000. This can't be applied when creating the interface and is done once the interface has been created.
|
||||
- Can be used when modifying Team, VLAN, Ethernet (Future plans to implement wifi, pppoe, infiniband)
|
||||
default: 1500
|
||||
dhcp_client_id:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- DHCP Client Identifier sent to the DHCP server.
|
||||
version_added: "2.5"
|
||||
primary:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with bond and is the primary interface name (for "active-backup" mode), this is the usually the 'ifname'
|
||||
miimon:
|
||||
required: False
|
||||
default: 100
|
||||
description:
|
||||
- This is only used with bond - miimon
|
||||
default: 100
|
||||
downdelay:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with bond - downdelay
|
||||
updelay:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with bond - updelay
|
||||
arp_interval:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with bond - ARP interval
|
||||
arp_ip_target:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with bond - ARP IP target
|
||||
stp:
|
||||
type: bool
|
||||
default: None
|
||||
description:
|
||||
- This is only used with bridge and controls whether Spanning Tree Protocol (STP) is enabled for this bridge
|
||||
type: bool
|
||||
priority:
|
||||
required: False
|
||||
default: 128
|
||||
description:
|
||||
- This is only used with 'bridge' - sets STP priority
|
||||
default: 128
|
||||
forwarddelay:
|
||||
required: False
|
||||
default: 15
|
||||
description:
|
||||
- This is only used with bridge - [forward-delay <2-30>] STP forwarding delay, in seconds
|
||||
default: 15
|
||||
hellotime:
|
||||
required: False
|
||||
default: 2
|
||||
description:
|
||||
- This is only used with bridge - [hello-time <1-10>] STP hello time, in seconds
|
||||
default: 2
|
||||
maxage:
|
||||
required: False
|
||||
default: 20
|
||||
description:
|
||||
- This is only used with bridge - [max-age <6-42>] STP maximum message age, in seconds
|
||||
default: 20
|
||||
ageingtime:
|
||||
required: False
|
||||
default: 300
|
||||
description:
|
||||
- This is only used with bridge - [ageing-time <0-1000000>] the Ethernet MAC address aging time, in seconds
|
||||
default: 300
|
||||
mac:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- >
|
||||
This is only used with bridge - MAC address of the bridge
|
||||
(note: this requires a recent kernel feature, originally introduced in 3.15 upstream kernel)
|
||||
slavepriority:
|
||||
required: False
|
||||
default: 32
|
||||
description:
|
||||
- This is only used with 'bridge-slave' - [<0-63>] - STP priority of this slave
|
||||
default: 32
|
||||
path_cost:
|
||||
required: False
|
||||
default: 100
|
||||
description:
|
||||
- This is only used with 'bridge-slave' - [<1-65535>] - STP port cost for destinations via this slave
|
||||
default: 100
|
||||
hairpin:
|
||||
required: False
|
||||
default: yes
|
||||
description:
|
||||
- This is only used with 'bridge-slave' - 'hairpin mode' for the slave, which allows frames to be sent back out through the slave the
|
||||
frame was received on.
|
||||
type: bool
|
||||
default: 'yes'
|
||||
vlanid:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with VLAN - VLAN ID in range <0-4095>
|
||||
vlandev:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with VLAN - parent device this VLAN is on, can use ifname
|
||||
flags:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with VLAN - flags
|
||||
ingress:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with VLAN - VLAN ingress priority mapping
|
||||
egress:
|
||||
required: False
|
||||
default: None
|
||||
description:
|
||||
- This is only used with VLAN - VLAN egress priority mapping
|
||||
|
||||
|
||||
@@ -75,7 +75,6 @@ options:
|
||||
value:
|
||||
description:
|
||||
- Sets the record value.
|
||||
default: None
|
||||
|
||||
'''
|
||||
|
||||
|
||||
@@ -36,7 +36,6 @@ options:
|
||||
name:
|
||||
description:
|
||||
- Sets the host lease hostname (mandatory if state=present).
|
||||
default: None
|
||||
host:
|
||||
description:
|
||||
- Sets OMAPI server host to interact with.
|
||||
@@ -60,18 +59,15 @@ options:
|
||||
ip:
|
||||
description:
|
||||
- Sets the lease host IP address.
|
||||
required: false
|
||||
default: None
|
||||
statements:
|
||||
description:
|
||||
- Attach a list of OMAPI DHCP statements with host lease (without ending semicolon).
|
||||
required: false
|
||||
default: []
|
||||
ddns:
|
||||
description:
|
||||
- Enable dynamic DNS updates for this host.
|
||||
required: false
|
||||
default: false
|
||||
type: bool
|
||||
default: 'no'
|
||||
|
||||
'''
|
||||
EXAMPLES = '''
|
||||
|
||||
Reference in New Issue
Block a user