mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 12:50:22 -07:00
Fix more docs vs argspec (#36048)
This commit is contained in:
parent
404f9260d9
commit
17c0d3eae0
7 changed files with 88 additions and 157 deletions
|
@ -46,6 +46,10 @@ options:
|
|||
- State of the link aggregation group.
|
||||
default: present
|
||||
choices: ['present', 'absent']
|
||||
purge:
|
||||
description:
|
||||
- Purge links not defined in the I(aggregate) parameter.
|
||||
default: no
|
||||
extends_documentation_fragment: eos
|
||||
"""
|
||||
|
||||
|
|
|
@ -42,6 +42,10 @@ options:
|
|||
- State of the link aggregation group.
|
||||
default: present
|
||||
choices: ['present', 'absent']
|
||||
purge:
|
||||
description:
|
||||
- Purge links not defined in the I(aggregate) parameter.
|
||||
default: no
|
||||
extends_documentation_fragment: ios
|
||||
"""
|
||||
|
||||
|
|
|
@ -44,7 +44,7 @@ options:
|
|||
Cisco IOS device. The list entries can either be the username
|
||||
or a hash of username and properties. This argument is mutually
|
||||
exclusive with the C(name) argument.
|
||||
aliases: ['users']
|
||||
aliases: ['users', 'collection']
|
||||
name:
|
||||
description:
|
||||
- The username to be configured on the Cisco IOS device.
|
||||
|
|
|
@ -39,6 +39,7 @@ options:
|
|||
- netconf vrf name
|
||||
required: false
|
||||
default: default
|
||||
aliases: ['vrf']
|
||||
state:
|
||||
description:
|
||||
- Specifies the state of the C(iosxr_netconf) resource on
|
||||
|
|
|
@ -42,12 +42,13 @@ options:
|
|||
domain_name:
|
||||
description:
|
||||
- The new domain name to apply to the device.
|
||||
name_server:
|
||||
name_servers:
|
||||
description:
|
||||
- A list of name servers to use with the device. Mutually exclusive with
|
||||
I(domain_search)
|
||||
required: false
|
||||
default: null
|
||||
aliases: ['name_server']
|
||||
domain_search:
|
||||
description:
|
||||
- A list of domain names to search. Mutually exclusive with
|
||||
|
@ -81,7 +82,7 @@ EXAMPLES = """
|
|||
|
||||
- name: configure name servers
|
||||
vyos_system:
|
||||
name_server:
|
||||
name_servers
|
||||
- 8.8.8.8
|
||||
- 8.8.4.4
|
||||
|
||||
|
|
|
@ -22,85 +22,84 @@ class ModuleDocFragment(object):
|
|||
# Standard files documentation fragment
|
||||
DOCUMENTATION = """
|
||||
options:
|
||||
host:
|
||||
description:
|
||||
- Specifies the DNS host name or address for connecting to the remote
|
||||
device over the specified transport. The value of host is used as
|
||||
the destination address for the transport.
|
||||
required: true
|
||||
port:
|
||||
description:
|
||||
- Specifies the port to use when building the connection to the remote
|
||||
device. This value applies to either I(cli) or I(nxapi). The port
|
||||
value will default to the appropriate transport common port if
|
||||
none is provided in the task. (cli=22, http=80, https=443).
|
||||
required: false
|
||||
default: 0 (use common port)
|
||||
username:
|
||||
description:
|
||||
- Configures the username to use to authenticate the connection to
|
||||
the remote device. This value is used to authenticate
|
||||
either the CLI login or the nxapi authentication depending on which
|
||||
transport is used. If the value is not specified in the task, the
|
||||
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
|
||||
required: false
|
||||
password:
|
||||
description:
|
||||
- Specifies the password to use to authenticate the connection to
|
||||
the remote device. This is a common argument used for either I(cli)
|
||||
or I(nxapi) transports. If the value is not specified in the task, the
|
||||
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
|
||||
required: false
|
||||
default: null
|
||||
timeout:
|
||||
description:
|
||||
- Specifies the timeout in seconds for communicating with the network device
|
||||
for either connecting or sending commands. If the timeout is
|
||||
exceeded before the operation is completed, the module will error.
|
||||
NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).
|
||||
require: false
|
||||
default: 10
|
||||
version_added: 2.3
|
||||
ssh_keyfile:
|
||||
description:
|
||||
- Specifies the SSH key to use to authenticate the connection to
|
||||
the remote device. This argument is only used for the I(cli)
|
||||
transport. If the value is not specified in the task, the
|
||||
value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
|
||||
required: false
|
||||
transport:
|
||||
description:
|
||||
- Configures the transport connection to use when connecting to the
|
||||
remote device. The transport argument supports connectivity to the
|
||||
device over cli (ssh) or nxapi.
|
||||
required: true
|
||||
default: cli
|
||||
use_ssl:
|
||||
description:
|
||||
- Configures the I(transport) to use SSL if set to true only when the
|
||||
C(transport=nxapi), otherwise this value is ignored.
|
||||
required: false
|
||||
default: no
|
||||
choices: ['yes', 'no']
|
||||
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. If the transport
|
||||
argument is not nxapi, this value is ignored.
|
||||
choices: ['yes', 'no']
|
||||
provider:
|
||||
description:
|
||||
- Convenience method that allows all I(nxos) arguments to be passed as
|
||||
a dict object. All constraints (required, choices, etc) must be
|
||||
met either by individual arguments or values in this dict.
|
||||
required: false
|
||||
- A dict object containing connection details.
|
||||
default: null
|
||||
use_proxy:
|
||||
description:
|
||||
- If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored.
|
||||
default: 'yes'
|
||||
choices: ['yes', 'no']
|
||||
version_added: "2.5"
|
||||
suboptions:
|
||||
host:
|
||||
description:
|
||||
- Specifies the DNS host name or address for connecting to the remote
|
||||
device over the specified transport. The value of host is used as
|
||||
the destination address for the transport.
|
||||
required: true
|
||||
port:
|
||||
description:
|
||||
- Specifies the port to use when building the connection to the remote
|
||||
device. This value applies to either I(cli) or I(nxapi). The port
|
||||
value will default to the appropriate transport common port if
|
||||
none is provided in the task. (cli=22, http=80, https=443).
|
||||
required: false
|
||||
default: 0 (use common port)
|
||||
username:
|
||||
description:
|
||||
- Configures the username to use to authenticate the connection to
|
||||
the remote device. This value is used to authenticate
|
||||
either the CLI login or the nxapi authentication depending on which
|
||||
transport is used. If the value is not specified in the task, the
|
||||
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
|
||||
required: false
|
||||
password:
|
||||
description:
|
||||
- Specifies the password to use to authenticate the connection to
|
||||
the remote device. This is a common argument used for either I(cli)
|
||||
or I(nxapi) transports. If the value is not specified in the task, the
|
||||
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
|
||||
required: false
|
||||
default: null
|
||||
timeout:
|
||||
description:
|
||||
- Specifies the timeout in seconds for communicating with the network device
|
||||
for either connecting or sending commands. If the timeout is
|
||||
exceeded before the operation is completed, the module will error.
|
||||
NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).
|
||||
require: false
|
||||
default: 10
|
||||
version_added: 2.3
|
||||
ssh_keyfile:
|
||||
description:
|
||||
- Specifies the SSH key to use to authenticate the connection to
|
||||
the remote device. This argument is only used for the I(cli)
|
||||
transport. If the value is not specified in the task, the
|
||||
value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead.
|
||||
required: false
|
||||
transport:
|
||||
description:
|
||||
- Configures the transport connection to use when connecting to the
|
||||
remote device. The transport argument supports connectivity to the
|
||||
device over cli (ssh) or nxapi.
|
||||
required: true
|
||||
default: cli
|
||||
use_ssl:
|
||||
description:
|
||||
- Configures the I(transport) to use SSL if set to true only when the
|
||||
C(transport=nxapi), otherwise this value is ignored.
|
||||
required: false
|
||||
default: no
|
||||
choices: ['yes', 'no']
|
||||
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. If the transport
|
||||
argument is not nxapi, this value is ignored.
|
||||
choices: ['yes', 'no']
|
||||
default: null
|
||||
use_proxy:
|
||||
description:
|
||||
- If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored.
|
||||
default: 'yes'
|
||||
choices: ['yes', 'no']
|
||||
version_added: "2.5"
|
||||
|
||||
notes:
|
||||
- For more information on using Ansible to manage Cisco devices see U(https://www.ansible.com/ansible-cisco).
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue