mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-24 05:40:23 -07:00
Bulk spelling improvement to modules-core (#5225)
* Correct spelling mistakes * Correct more spelling issues * merge conflict * Revert typo in parms
This commit is contained in:
parent
a4077537e0
commit
25b6492d37
91 changed files with 908 additions and 148 deletions
|
@ -100,7 +100,7 @@ options:
|
|||
If you worry about portability, only the sha1 algorithm is available
|
||||
on all platforms and python versions. The third party hashlib
|
||||
library can be installed for access to additional algorithms.
|
||||
Additionaly, if a checksum is passed to this parameter, and the file exist under
|
||||
Additionally, if a checksum is passed to this parameter, and the file exist under
|
||||
the C(dest) location, the destination_checksum would be calculated, and if
|
||||
checksum equals destination_checksum, the file download would be skipped
|
||||
(unless C(force) is true). '
|
||||
|
@ -237,7 +237,7 @@ def url_get(module, url, dest, use_proxy, last_mod_time, force, timeout=10, head
|
|||
if os.path.exists(tmp_dest):
|
||||
module.fail_json(msg="%s is a file but should be a directory." % tmp_dest)
|
||||
else:
|
||||
module.fail_json(msg="%s directoy does not exist." % tmp_dest)
|
||||
module.fail_json(msg="%s directory does not exist." % tmp_dest)
|
||||
|
||||
fd, tempname = tempfile.mkstemp(dir=tmp_dest)
|
||||
else:
|
||||
|
|
|
@ -66,7 +66,7 @@ options:
|
|||
body:
|
||||
description:
|
||||
- The body of the http request/response to the web service. If C(body_format) is set
|
||||
to 'json' it will take an already formated JSON string or convert a data structure
|
||||
to 'json' it will take an already formatted JSON string or convert a data structure
|
||||
into JSON.
|
||||
required: false
|
||||
default: null
|
||||
|
@ -383,7 +383,7 @@ def main():
|
|||
dict_headers = module.params['headers']
|
||||
|
||||
if body_format == 'json':
|
||||
# Encode the body unless its a string, then assume it is preformatted JSON
|
||||
# Encode the body unless its a string, then assume it is pre-formatted JSON
|
||||
if not isinstance(body, basestring):
|
||||
body = json.dumps(body)
|
||||
dict_headers['Content-Type'] = 'application/json'
|
||||
|
|
|
@ -154,7 +154,7 @@ cl_bond: name=bond1 slaves="swp1s0 swp2s0" clag_id=1
|
|||
notify: reload networking
|
||||
|
||||
# define cl_bond once in tasks file
|
||||
# then write inteface config in variables file
|
||||
# then write interface config in variables file
|
||||
# with just the options you want.
|
||||
cl_bond:
|
||||
name: "{{ item.key }}"
|
||||
|
|
|
@ -109,7 +109,7 @@ cl_bridge: name=bridge ports='swp1-12' vlan_aware='yes' vids='1-100'
|
|||
notify: reload networking
|
||||
|
||||
# define cl_bridge once in tasks file
|
||||
# then write inteface config in variables file
|
||||
# then write interface config in variables file
|
||||
# with just the options you want.
|
||||
cl_bridge:
|
||||
name: "{{ item.key }}"
|
||||
|
|
|
@ -131,7 +131,7 @@ cl_interface: name=bond0.100 alias_name='my bond' ipv4=10.1.1.1/24
|
|||
notify: reload networking
|
||||
|
||||
# define cl_interfaces once in tasks
|
||||
# then write intefaces in variables file
|
||||
# then write interfaces in variables file
|
||||
# with just the options you want.
|
||||
cl_interface:
|
||||
name: "{{ item.key }}"
|
||||
|
|
|
@ -73,7 +73,7 @@ def read_current_int_dir(module):
|
|||
module.custom_currentportlist = os.listdir(module.params.get('location'))
|
||||
|
||||
|
||||
# take the allowed list and conver it to into a list
|
||||
# take the allowed list and convert it to into a list
|
||||
# of ports.
|
||||
def convert_allowed_list_to_port_range(module):
|
||||
allowedlist = module.params.get('allowed')
|
||||
|
|
|
@ -123,7 +123,7 @@ options:
|
|||
choices: ['yes', 'no']
|
||||
config:
|
||||
description:
|
||||
- The C(config) argument allows the playbook desginer to supply
|
||||
- The C(config) argument allows the playbook designer to supply
|
||||
the base configuration to be used to validate configuration
|
||||
changes necessary. If this argument is provided, the module
|
||||
will not download the running-config from the remote node.
|
||||
|
|
|
@ -36,10 +36,10 @@ options:
|
|||
gather_subset:
|
||||
description:
|
||||
- When supplied, this argument will restrict the facts collected
|
||||
to a given subset. Possible values for this argument inlcude
|
||||
to a given subset. Possible values for this argument include
|
||||
all, hardware, config, and interfaces. Can specify a list of
|
||||
values to include a larger subset. Values can also be used
|
||||
with an initial M(!) to specify that a specific subset should
|
||||
with an initial C(M(!)) to specify that a specific subset should
|
||||
not be collected.
|
||||
required: false
|
||||
default: '!config'
|
||||
|
|
|
@ -38,7 +38,7 @@ options:
|
|||
description:
|
||||
- List of commands to send to the remote dellos6 device over the
|
||||
configured provider. The resulting output from the command
|
||||
is returned. If the I(waitfor) argument is provided, the
|
||||
is returned. If the I(wait_for) argument is provided, the
|
||||
module is not returned until the condition is satisfied or
|
||||
the number of I(retries) as expired.
|
||||
required: true
|
||||
|
@ -56,7 +56,7 @@ options:
|
|||
- Specifies the number of retries a command should be tried
|
||||
before it is considered failed. The command is run on the
|
||||
target device every retry and evaluated against the
|
||||
I(waitfor) conditions.
|
||||
I(wait_for) conditions.
|
||||
required: false
|
||||
default: 10
|
||||
interval:
|
||||
|
@ -80,7 +80,7 @@ vars:
|
|||
transport: cli
|
||||
|
||||
tasks:
|
||||
- name: run show verion on remote devices
|
||||
- name: run show version on remote devices
|
||||
dellos6_command:
|
||||
commands: show version
|
||||
provider "{{ cli }}"
|
||||
|
|
|
@ -36,10 +36,10 @@ options:
|
|||
gather_subset:
|
||||
description:
|
||||
- When supplied, this argument will restrict the facts collected
|
||||
to a given subset. Possible values for this argument inlcude
|
||||
to a given subset. Possible values for this argument include
|
||||
all, hardware, config, and interfaces. Can specify a list of
|
||||
values to include a larger subset. Values can also be used
|
||||
with an initial M(!) to specify that a specific subset should
|
||||
with an initial C(M(!)) to specify that a specific subset should
|
||||
not be collected.
|
||||
required: false
|
||||
default: '!config'
|
||||
|
|
|
@ -39,7 +39,7 @@ options:
|
|||
to a given subset. Possible values for this argument include
|
||||
all, hardware, config, and interfaces. Can specify a list of
|
||||
values to include a larger subset. Values can also be used
|
||||
with an initial M(!) to specify that a specific subset should
|
||||
with an initial C(M(!)) to specify that a specific subset should
|
||||
not be collected.
|
||||
required: false
|
||||
default: '!config'
|
||||
|
|
|
@ -19,7 +19,7 @@ DOCUMENTATION = """
|
|||
---
|
||||
module: eos_template
|
||||
version_added: "2.1"
|
||||
author: "Peter sprygada (@privateip)"
|
||||
author: "Peter Sprygada (@privateip)"
|
||||
short_description: Manage Arista EOS device configurations
|
||||
description:
|
||||
- Manages network device configurations over SSH or eAPI. This module
|
||||
|
@ -112,7 +112,7 @@ updates:
|
|||
|
||||
responses:
|
||||
description: The set of responses from issuing the commands on the device
|
||||
retured: when not check_mode
|
||||
returned: when not check_mode
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
"""
|
||||
|
|
|
@ -88,7 +88,7 @@ vars:
|
|||
password: admin
|
||||
transport: cli
|
||||
|
||||
- name: run show verion on remote devices
|
||||
- name: run show version on remote devices
|
||||
eos_command:
|
||||
commands: show version
|
||||
provider: "{{ cli }}"
|
||||
|
@ -106,7 +106,7 @@ vars:
|
|||
- show interfaces
|
||||
provider: "{{ cli }}"
|
||||
|
||||
- name: run multiple commands and evalute the output
|
||||
- name: run multiple commands and evaluate the output
|
||||
eos_command:
|
||||
commands:
|
||||
- show version
|
||||
|
@ -139,7 +139,7 @@ stdout_lines:
|
|||
|
||||
failed_conditions:
|
||||
description: the conditionals that failed
|
||||
retured: failed
|
||||
returned: failed
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
"""
|
||||
|
|
|
@ -103,7 +103,7 @@ ansible_net_fqdn:
|
|||
|
||||
# hardware
|
||||
ansible_net_filesystems:
|
||||
description: All file system names availabe on the device
|
||||
description: All file system names available on the device
|
||||
returned: when hardware is configured
|
||||
type: list
|
||||
ansible_net_memfree_mb:
|
||||
|
|
|
@ -94,7 +94,7 @@ EXAMPLES = """
|
|||
src: config.j2
|
||||
force: yes
|
||||
|
||||
- name: provide the base configuration for comparision
|
||||
- name: provide the base configuration for comparison
|
||||
ios_template:
|
||||
host: hostname
|
||||
username: foo
|
||||
|
|
|
@ -35,7 +35,7 @@ options:
|
|||
to a given subset. Possible values for this argument include
|
||||
all, hardware, config, and interfaces. Can specify a list of
|
||||
values to include a larger subset. Values can also be used
|
||||
with an initial M(!) to specify that a specific subset should
|
||||
with an initial C(M(!)) to specify that a specific subset should
|
||||
not be collected.
|
||||
required: false
|
||||
default: '!config'
|
||||
|
@ -87,7 +87,7 @@ ansible_net_image:
|
|||
|
||||
# hardware
|
||||
ansible_net_filesystems:
|
||||
description: All file system names availabe on the device
|
||||
description: All file system names available on the device
|
||||
returned: when hardware is configured
|
||||
type: list
|
||||
ansible_net_memfree_mb:
|
||||
|
|
|
@ -19,7 +19,7 @@ DOCUMENTATION = """
|
|||
---
|
||||
module: iosxr_template
|
||||
version_added: "2.1"
|
||||
author: "Peter sprygada (@privateip)"
|
||||
author: "Peter Sprygada (@privateip)"
|
||||
short_description: Manage Cisco IOSXR device configurations over SSH
|
||||
description:
|
||||
- Manages network device configurations over SSH. This module
|
||||
|
@ -97,7 +97,7 @@ updates:
|
|||
|
||||
responses:
|
||||
description: The set of responses from issuing the commands on the device
|
||||
retured: when not check_mode
|
||||
returned: when not check_mode
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
"""
|
||||
|
|
|
@ -79,7 +79,7 @@ ansible_net_image:
|
|||
|
||||
# hardware
|
||||
ansible_net_filesystems:
|
||||
description: All file system names availabe on the device
|
||||
description: All file system names available on the device
|
||||
returned: when hardware is configured
|
||||
type: list
|
||||
ansible_net_memfree_mb:
|
||||
|
|
|
@ -148,7 +148,7 @@ stdout_lines:
|
|||
|
||||
failed_conditionals:
|
||||
description: the conditionals that failed
|
||||
retured: failed
|
||||
returned: failed
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
"""
|
||||
|
|
|
@ -45,7 +45,7 @@ options:
|
|||
format of the configuration file. Devices support three
|
||||
configuration file formats. By default, the configuration
|
||||
from the device is returned as text. The other options include
|
||||
set and xml. If the xml option is choosen, the configuration file
|
||||
set and xml. If the xml option is chosen, the configuration file
|
||||
is returned as both xml and json.
|
||||
required: false
|
||||
default: text
|
||||
|
@ -81,7 +81,7 @@ EXAMPLES = """
|
|||
|
||||
RETURN = """
|
||||
ansible_facts:
|
||||
descrption: Returns the facts collect from the device
|
||||
description: Returns the facts collect from the device
|
||||
returned: always
|
||||
type: dict
|
||||
"""
|
||||
|
|
|
@ -97,7 +97,7 @@ options:
|
|||
1 and 255 or 0 to unset.
|
||||
pn_bgp_options:
|
||||
description:
|
||||
- Specify other BGP options as a whitespaces separted string within
|
||||
- Specify other BGP options as a whitespaces separated string within
|
||||
single quotes ''.
|
||||
pn_rip_redistribute:
|
||||
description:
|
||||
|
|
|
@ -32,7 +32,7 @@ description:
|
|||
- Execute vrouter-interface-add, vrouter-interface-remove,
|
||||
vrouter-interface-modify command.
|
||||
- You configure interfaces to vRouter services on a fabric, cluster,
|
||||
standalone switch or virtula network(VNET).
|
||||
standalone switch or virtual network(VNET).
|
||||
options:
|
||||
pn_cliusername:
|
||||
description:
|
||||
|
|
|
@ -90,7 +90,7 @@ EXAMPLES = """
|
|||
src: config.j2
|
||||
force: yes
|
||||
|
||||
- name: provide the base configuration for comparision
|
||||
- name: provide the base configuration for comparison
|
||||
nxos_template:
|
||||
src: candidate_config.txt
|
||||
config: current_config.txt
|
||||
|
@ -105,7 +105,7 @@ updates:
|
|||
|
||||
responses:
|
||||
description: The set of responses from issuing the commands on the device
|
||||
retured: when not check_mode
|
||||
returned: when not check_mode
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
"""
|
||||
|
|
|
@ -38,8 +38,8 @@ notes:
|
|||
there is any difference, what is in Ansible will be pushed (configured
|
||||
options will be overridden). This is to improve security, but at the
|
||||
same time remember an ACE is removed, then re-added, so if there is a
|
||||
change, the new ACE will be exacty what params you are sending to the
|
||||
module.
|
||||
change, the new ACE will be exactly what parameters you are sending to
|
||||
the module.
|
||||
options:
|
||||
seq:
|
||||
description:
|
||||
|
|
|
@ -1460,7 +1460,7 @@ def main():
|
|||
if module.params['vrf'] != 'default':
|
||||
for param, inserted_value in module.params.iteritems():
|
||||
if param in GLOBAL_PARAMS and inserted_value:
|
||||
module.fail_json(msg='Global params can be modifed only'
|
||||
module.fail_json(msg='Global params can be modified only'
|
||||
' under "default" VRF.',
|
||||
vrf=module.params['vrf'],
|
||||
global_param=param)
|
||||
|
|
|
@ -50,7 +50,7 @@ options:
|
|||
required: true
|
||||
afi:
|
||||
description:
|
||||
- Address Family Identifie.
|
||||
- Address Family Identifier.
|
||||
required: true
|
||||
choices: ['ipv4','ipv6', 'vpnv4', 'vpnv6', 'l2vpn']
|
||||
safi:
|
||||
|
|
|
@ -93,7 +93,7 @@ vars:
|
|||
password: admin
|
||||
transport: cli
|
||||
|
||||
- name: run show verion on remote devices
|
||||
- name: run show version on remote devices
|
||||
nxos_command:
|
||||
commands: show version
|
||||
provider: "{{ cli }}"
|
||||
|
@ -111,7 +111,7 @@ vars:
|
|||
- show interfaces
|
||||
provider: "{{ cli }}"
|
||||
|
||||
- name: run multiple commands and evalute the output
|
||||
- name: run multiple commands and evaluate the output
|
||||
nxos_command:
|
||||
commands:
|
||||
- show version
|
||||
|
@ -144,7 +144,7 @@ stdout_lines:
|
|||
|
||||
failed_conditions:
|
||||
description: the conditionals that failed
|
||||
retured: failed
|
||||
returned: failed
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
"""
|
||||
|
|
|
@ -27,8 +27,8 @@ description:
|
|||
author: Gabriele Gerbino (@GGabriele)
|
||||
extends_documentation_fragment: nxos
|
||||
notes:
|
||||
- default, where supported, restores params default value
|
||||
- RD override is not permitted. You should set it to the defalt values
|
||||
- default, where supported, restores params default value.
|
||||
- RD override is not permitted. You should set it to the default values
|
||||
first and then reconfigure it.
|
||||
- route_target_both, route_target_import and route_target_export valid
|
||||
values are a list of extended communities, (i.e. ['1.2.3.4:5', '33:55'])
|
||||
|
|
|
@ -100,7 +100,7 @@ ansible_net_image:
|
|||
|
||||
# hardware
|
||||
ansible_net_filesystems:
|
||||
description: All file system names availabe on the device
|
||||
description: All file system names available on the device
|
||||
returned: when hardware is configured
|
||||
type: list
|
||||
ansible_net_memfree_mb:
|
||||
|
|
|
@ -60,7 +60,7 @@ EXAMPLES = '''
|
|||
|
||||
RETURN = '''
|
||||
transfer_status:
|
||||
description: Whether a file was transfered. "No Transfer" or "Sent".
|
||||
description: Whether a file was transferred. "No Transfer" or "Sent".
|
||||
returned: success
|
||||
type: string
|
||||
sample: 'Sent'
|
||||
|
|
|
@ -39,7 +39,7 @@ options:
|
|||
default: null
|
||||
mode:
|
||||
description:
|
||||
- Configure the profile as Maintenance or Normale mode.
|
||||
- Configure the profile as Maintenance or Normal mode.
|
||||
required: true
|
||||
choices: ['maintenance', 'normal']
|
||||
state:
|
||||
|
@ -376,4 +376,4 @@ def main():
|
|||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
main()
|
||||
|
|
|
@ -36,7 +36,7 @@ notes:
|
|||
- You must know if your platform supports taking a kickstart image as a
|
||||
parameter. If supplied but not supported, errors may occur.
|
||||
- This module attempts to install the software immediately,
|
||||
wich may trigger a reboot.
|
||||
which may trigger a reboot.
|
||||
- In check mode, the module tells you if the current boot images are set
|
||||
to the desired images.
|
||||
author:
|
||||
|
@ -364,7 +364,7 @@ def set_boot_options(module, image_name, kickstart=None):
|
|||
Args:
|
||||
The main system image file name.
|
||||
Keyword Args: many implementors may choose
|
||||
to supply a kickstart parameter to specicify a kickstart image.
|
||||
to supply a kickstart parameter to specify a kickstart image.
|
||||
"""
|
||||
commands = ['terminal dont-ask']
|
||||
if kickstart is None:
|
||||
|
@ -413,4 +413,4 @@ def main():
|
|||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
main()
|
||||
|
|
|
@ -28,7 +28,7 @@ extends_documentation_fragment: nxos
|
|||
author:
|
||||
- Jason Edelman (@jedelman8)
|
||||
notes:
|
||||
- If C(state=absent), the moudle will attempt to remove the given key configuration.
|
||||
- If C(state=absent), the module will attempt to remove the given key configuration.
|
||||
If a matching key configuration isn't found on the device, the module will fail.
|
||||
- If C(state=absent) and C(authentication=on), authentication will be turned off.
|
||||
- If C(state=absent) and C(authentication=off), authentication will be turned on.
|
||||
|
@ -59,7 +59,7 @@ options:
|
|||
choices: ['true', 'false']
|
||||
authentication:
|
||||
description:
|
||||
- Turns NTP authenication on or off.
|
||||
- Turns NTP authentication on or off.
|
||||
required: false
|
||||
default: null
|
||||
choices: ['on', 'off']
|
||||
|
@ -96,7 +96,7 @@ existing:
|
|||
type: dict
|
||||
sample: {"authentication": "off", "trusted_key": "false"}
|
||||
end_state:
|
||||
description: k/v pairs of ntp autherntication after module execution
|
||||
description: k/v pairs of ntp authentication after module execution
|
||||
returned: always
|
||||
type: dict
|
||||
sample: {"authentication": "off", "key_id": "32",
|
||||
|
|
|
@ -277,7 +277,7 @@ def main():
|
|||
|
||||
sandbox=dict(aliases=['enable_sandbox'], default=False, type='bool'),
|
||||
|
||||
# Only allow configuration of NXAPI using cli transpsort
|
||||
# Only allow configuration of NXAPI using cli transport
|
||||
transport=dict(required=True, choices=['cli']),
|
||||
|
||||
config=dict(),
|
||||
|
|
|
@ -867,7 +867,7 @@ def main():
|
|||
remote_exists = remote_file_exists(module, pkg, file_system=file_system)
|
||||
|
||||
if not remote_exists:
|
||||
module.fail_json(msg="The requested package does't exist "
|
||||
module.fail_json(msg="The requested package doesn't exist "
|
||||
"on the device")
|
||||
|
||||
commands = get_commands(module, pkg, file_system)
|
||||
|
|
|
@ -29,7 +29,7 @@ extends_documentation_fragment: nxos
|
|||
author:
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- C(transpot=cli) may cause timeout errors.
|
||||
- C(transport=cli) may cause timeout errors.
|
||||
- The C(element_key1) and C(element_key2) parameter specify the tags used
|
||||
to distinguish among row entries. In most cases, only the element_key1
|
||||
parameter needs to specified to be able to distinguish among row entries.
|
||||
|
|
|
@ -473,7 +473,7 @@ def main():
|
|||
|
||||
if privacy and encrypt:
|
||||
if not pwd and authentication:
|
||||
module.fail_json(msg='pwd and authentication must be proviced '
|
||||
module.fail_json(msg='pwd and authentication must be provided '
|
||||
'when using privacy and encrypt')
|
||||
|
||||
if group and group not in get_snmp_groups(module):
|
||||
|
|
|
@ -487,7 +487,7 @@ def get_switchport_config_commands(interface, existing, proposed, module):
|
|||
def is_switchport_default(existing):
|
||||
"""Determines if switchport has a default config based on mode
|
||||
Args:
|
||||
existing (dict): existing switcport configuration from Ansible mod
|
||||
existing (dict): existing switchport configuration from Ansible mod
|
||||
Returns:
|
||||
boolean: True if switchport has OOB Layer 2 config, i.e.
|
||||
vlan 1 and trunk all and mode is access
|
||||
|
|
|
@ -28,7 +28,7 @@ extends_documentation_fragment: nxos
|
|||
author:
|
||||
- Jason Edelman (@jedelman8)
|
||||
notes:
|
||||
- When C(state=absent), it unconfigures existing setings C(msg_time) and set it
|
||||
- When C(state=absent), it unconfigures existing settings C(msg_time) and set it
|
||||
to its default value of 15. It is cleaner to always use C(state=present).
|
||||
- Module will fail if the udld feature has not been previously enabled.
|
||||
options:
|
||||
|
|
|
@ -363,6 +363,7 @@ def get_udld_interface(module, interface):
|
|||
table = body['TABLE_interface']['ROW_interface']
|
||||
|
||||
status = str(table.get('mib-port-status', None))
|
||||
# Note: 'mib-aggresive-mode' is NOT a typo
|
||||
agg = str(table.get('mib-aggresive-mode', 'disabled'))
|
||||
|
||||
if agg == 'enabled':
|
||||
|
|
|
@ -46,7 +46,7 @@ options:
|
|||
default: null
|
||||
peer_link:
|
||||
description:
|
||||
- Set to true/false for peer link config on assoicated portchannel
|
||||
- Set to true/false for peer link config on associated portchannel.
|
||||
required: false
|
||||
default: null
|
||||
state:
|
||||
|
|
|
@ -29,7 +29,7 @@ notes:
|
|||
- VTP feature must be active on the device to use this module.
|
||||
- This module is used to manage only VTP domain names.
|
||||
- VTP domain names are case-sensible.
|
||||
- If it's never been configured before, VTP version is setted to 1 by default.
|
||||
- If it's never been configured before, VTP version is set to 1 by default.
|
||||
Otherwise, it leaves the previous configured version untouched.
|
||||
Use M(nxos_vtp_version) to change it.
|
||||
- Use this in combination with M(nxos_vtp_password) and M(nxos_vtp_version)
|
||||
|
|
|
@ -77,6 +77,26 @@ options:
|
|||
required: false
|
||||
default: present
|
||||
choices: ['present','absent']
|
||||
include_defaults:
|
||||
description:
|
||||
- Specify to use or not the complete running configuration
|
||||
for module operations.
|
||||
required: false
|
||||
default: true
|
||||
choices: ['true','true']
|
||||
config:
|
||||
description:
|
||||
- Configuration string to be used for module operations. If not
|
||||
specified, the module will use the current running configuration.
|
||||
required: false
|
||||
default: null
|
||||
save:
|
||||
description:
|
||||
- Specify to save the running configuration after
|
||||
module operations.
|
||||
required: false
|
||||
default: false
|
||||
choices: ['true','false']
|
||||
'''
|
||||
EXAMPLES = '''
|
||||
- nxos_vxlan_vtep_vni:
|
||||
|
|
|
@ -87,11 +87,11 @@ EXAMPLES = """
|
|||
RETURN = """
|
||||
updates:
|
||||
description: The list of configuration updates to be merged
|
||||
retured: always
|
||||
returned: always
|
||||
type: dict
|
||||
sample: {obj, obj}
|
||||
responses:
|
||||
desription: returns the responses when configuring using cli
|
||||
description: returns the responses when configuring using cli
|
||||
returned: when transport == cli
|
||||
type: list
|
||||
sample: [...]
|
||||
|
|
|
@ -20,7 +20,7 @@ DOCUMENTATION = """
|
|||
---
|
||||
module: ops_command
|
||||
version_added: "2.1"
|
||||
author: "Peter sprygada (@privateip)"
|
||||
author: "Peter Sprygada (@privateip)"
|
||||
short_description: Run arbitrary commands on OpenSwitch devices.
|
||||
description:
|
||||
- Sends arbitrary commands to an OpenSwitch node and returns the results
|
||||
|
@ -33,7 +33,7 @@ options:
|
|||
description:
|
||||
- List of commands to send to the remote ops device over the
|
||||
configured provider. The resulting output from the command
|
||||
is returned. If the I(waitfor) argument is provided, the
|
||||
is returned. If the I(wait_for) argument is provided, the
|
||||
module is not returned until the condition is satisfied or
|
||||
the number of retires as expired.
|
||||
required: true
|
||||
|
@ -65,7 +65,7 @@ options:
|
|||
- Specifies the number of retries a command should by tried
|
||||
before it is considered failed. The command is run on the
|
||||
target device every retry and evaluated against the
|
||||
I(waitfor) conditions.
|
||||
I(wait_for) conditions.
|
||||
required: false
|
||||
default: 10
|
||||
interval:
|
||||
|
@ -122,7 +122,7 @@ stdout_lines:
|
|||
|
||||
failed_conditions:
|
||||
description: the conditionals that failed
|
||||
retured: failed
|
||||
returned: failed
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
"""
|
||||
|
|
|
@ -117,7 +117,7 @@ stdout_lines:
|
|||
sample: [['...', '...'], ['...'], ['...']]
|
||||
failed_conditions:
|
||||
description: The conditionals that failed
|
||||
retured: failed
|
||||
returned: failed
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
warnings:
|
||||
|
|
|
@ -35,7 +35,7 @@ options:
|
|||
to a given subset. Possible values for this argument include
|
||||
all, hardware, config, and interfaces. Can specify a list of
|
||||
values to include a larger subset. Values can also be used
|
||||
with an initial M(!) to specify that a specific subset should
|
||||
with an initial C(M(!)) to specify that a specific subset should
|
||||
not be collected.
|
||||
required: false
|
||||
default: "!config"
|
||||
|
@ -70,7 +70,7 @@ ansible_net_config:
|
|||
returned: when config is configured
|
||||
type: str
|
||||
ansible_net_commits:
|
||||
descrption: The set of available configuration revisions
|
||||
description: The set of available configuration revisions
|
||||
returned: when present
|
||||
type: list
|
||||
ansible_net_hostname:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue