mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-27 23:21:22 -07:00
Ansible 2.5 feature support for dellos9 (#34880)
* Add ansible-2.5 support for dellos9 * Fix ansible-test issues and update copyright * fix ansible-test errors in dellos9_config * fix izip attribute error in python3 * fix python3 dict.keys() issue * Remove waitfor aliases in dellos9_command
This commit is contained in:
Dhivyap
John R Barker
parent
9f84a12adf
commit
19ff2f4e8c
23 changed files with 2356 additions and 155 deletions
|
|
@ -20,7 +20,7 @@ author: "Dhivya P (@dhivyap)"
|
|||
short_description: Run commands on remote devices running Dell OS9
|
||||
description:
|
||||
- Sends arbitrary commands to a Dell OS9 node and returns the results
|
||||
read from the device. This module includes an
|
||||
read from the device. This module includes an
|
||||
argument that will cause the module to wait for a specific condition
|
||||
before returning or timing out if the condition is not met.
|
||||
- This module does not support running commands in configuration mode.
|
||||
|
|
@ -44,6 +44,19 @@ options:
|
|||
See examples.
|
||||
required: false
|
||||
default: null
|
||||
version_added: "2.2"
|
||||
match:
|
||||
description:
|
||||
- The I(match) argument is used in conjunction with the
|
||||
I(wait_for) argument to specify the match policy. Valid
|
||||
values are C(all) or C(any). If the value is set to C(all)
|
||||
then all conditionals in the wait_for must be satisfied. If
|
||||
the value is set to C(any) then only one of the values must be
|
||||
satisfied.
|
||||
required: false
|
||||
default: all
|
||||
choices: ['any', 'all']
|
||||
version_added: "2.5"
|
||||
retries:
|
||||
description:
|
||||
- Specifies the number of retries a command should be tried
|
||||
|
|
@ -72,33 +85,21 @@ notes:
|
|||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
# Note: examples below use the following provider dict to handle
|
||||
# transport and authentication to the node.
|
||||
vars:
|
||||
cli:
|
||||
host: "{{ inventory_hostname }}"
|
||||
username: admin
|
||||
password: admin
|
||||
transport: cli
|
||||
|
||||
tasks:
|
||||
- name: run show version on remote devices
|
||||
dellos9_command:
|
||||
commands: show version
|
||||
provider: "{{ cli }}"
|
||||
|
||||
- name: run show version and check to see if output contains OS9
|
||||
dellos9_command:
|
||||
commands: show version
|
||||
wait_for: result[0] contains OS9
|
||||
provider: "{{ cli }}"
|
||||
|
||||
- name: run multiple commands on remote nodes
|
||||
dellos9_command:
|
||||
commands:
|
||||
- show version
|
||||
- show interfaces
|
||||
provider: "{{ cli }}"
|
||||
|
||||
- name: run multiple commands and evaluate the output
|
||||
dellos9_command:
|
||||
|
|
@ -108,7 +109,6 @@ tasks:
|
|||
wait_for:
|
||||
- result[0] contains OS9
|
||||
- result[1] contains Loopback
|
||||
provider: "{{ cli }}"
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
|
|
@ -225,11 +225,11 @@ def main():
|
|||
msg = 'One or more conditional statements have not be satisfied'
|
||||
module.fail_json(msg=msg, failed_conditions=failed_conditions)
|
||||
|
||||
result = {
|
||||
result.update({
|
||||
'changed': False,
|
||||
'stdout': responses,
|
||||
'stdout_lines': list(to_lines(responses))
|
||||
}
|
||||
})
|
||||
|
||||
module.exit_json(**result)
|
||||
|
||||
|
|
|
|||
|
|
@ -30,15 +30,17 @@ options:
|
|||
description:
|
||||
- The ordered set of commands that should be configured in the
|
||||
section. The commands must be the exact same commands as found
|
||||
in the device running-config. Note the configuration
|
||||
command syntax as the device config parser automatically modifies some commands. This argument is mutually exclusive with I(src).
|
||||
in the device running-config. Be sure to note the configuration
|
||||
command syntax as some commands are automatically modified by the
|
||||
device config parser. This argument is mutually exclusive with I(src).
|
||||
required: false
|
||||
default: null
|
||||
aliases: ['commands']
|
||||
parents:
|
||||
description:
|
||||
- The ordered set of parents that uniquely identify the section
|
||||
the commands should be checked against. If you omit the parents argument, the commands are checked against the set of top
|
||||
the commands should be checked against. If the parents argument
|
||||
is omitted, the commands are checked against the set of top
|
||||
level or global commands.
|
||||
required: false
|
||||
default: null
|
||||
|
|
@ -47,14 +49,15 @@ options:
|
|||
- Specifies the source path to the file that contains the configuration
|
||||
or configuration template to load. The path to the source file can
|
||||
either be the full path on the Ansible control host or a relative
|
||||
path from the playbook or role root directory. This argument is mutually
|
||||
exclusive with I(lines), I(parents).
|
||||
path from the playbook or role root directory. This argument is
|
||||
mutually exclusive with I(lines).
|
||||
required: false
|
||||
default: null
|
||||
before:
|
||||
description:
|
||||
- The ordered set of commands to push on to the command stack if
|
||||
a change needs to be made. The playbook designer can use this opportunity to perform configuration commands prior to pushing
|
||||
a change needs to be made. This allows the playbook designer
|
||||
the opportunity to perform configuration commands prior to pushing
|
||||
any changes without affecting how the set of commands are matched
|
||||
against the system.
|
||||
required: false
|
||||
|
|
@ -62,19 +65,20 @@ options:
|
|||
after:
|
||||
description:
|
||||
- The ordered set of commands to append to the end of the command
|
||||
stack if a change needs to be made. As with I(before), this
|
||||
the playbook designer can append a set of commands to be
|
||||
stack if a change needs to be made. Just like with I(before) this
|
||||
allows the playbook designer to append a set of commands to be
|
||||
executed after the command set.
|
||||
required: false
|
||||
default: null
|
||||
match:
|
||||
description:
|
||||
- Instructs the module on the way to perform the matching of
|
||||
the set of commands against the current device config. If you set
|
||||
match to I(line), commands match line by line. If you set
|
||||
match to I(strict), command lines match by position. If you set match to I(exact), command lines
|
||||
must be an equal match. Finally, if you set match to I(none), the
|
||||
module does not attempt to compare the source configuration with
|
||||
the set of commands against the current device config. If
|
||||
match is set to I(line), commands are matched line by line. If
|
||||
match is set to I(strict), command lines are matched with respect
|
||||
to position. If match is set to I(exact), command lines
|
||||
must be an equal match. Finally, if match is set to I(none), the
|
||||
module will not attempt to compare the source configuration with
|
||||
the running configuration on the remote device.
|
||||
required: false
|
||||
default: line
|
||||
|
|
@ -82,10 +86,10 @@ options:
|
|||
replace:
|
||||
description:
|
||||
- Instructs the module on the way to perform the configuration
|
||||
on the device. If you set the replace argument to I(line), then
|
||||
the modified lines push to the device in configuration
|
||||
mode. If you set the replace argument to I(block), then the entire
|
||||
command block pushes to the device in configuration mode if any
|
||||
on the device. If the replace argument is set to I(line) then
|
||||
the modified lines are pushed to the device in configuration
|
||||
mode. If the replace argument is set to I(block) then the entire
|
||||
command block is pushed to the device in configuration mode if any
|
||||
line is not correct.
|
||||
required: false
|
||||
default: line
|
||||
|
|
@ -112,29 +116,32 @@ options:
|
|||
choices: ['yes', 'no']
|
||||
config:
|
||||
description:
|
||||
- The playbook designer can use the C(config) argument to supply
|
||||
the base configuration to be used to validate necessary configuration
|
||||
changes. If you specify this argument, the module
|
||||
does not download the running-config from the remote node.
|
||||
- The module, by default, will connect to the remote device and
|
||||
retrieve the current running-config to use as a base for comparing
|
||||
against the contents of source. There are times when it is not
|
||||
desirable to have the task get the current running-config for
|
||||
every task in a playbook. The I(config) argument allows the
|
||||
implementer to pass in the configuration to use as the base
|
||||
config for comparison.
|
||||
required: false
|
||||
default: null
|
||||
backup:
|
||||
description:
|
||||
- This argument causes the module to create a full backup of
|
||||
- This argument will cause the module to create a full backup of
|
||||
the current C(running-config) from the remote device before any
|
||||
changes are made. The backup file is written to the C(backup)
|
||||
folder in the playbook root directory. If the directory does not
|
||||
exist, it is created.
|
||||
required: false
|
||||
default: no
|
||||
choices: ['yes', 'no']
|
||||
|
||||
type: bool
|
||||
notes:
|
||||
- This module requires Dell OS9 version 9.10.0.1P13 or above.
|
||||
|
||||
- This module requires to increase the ssh connection rate limit.
|
||||
Use the following command I(ip ssh connection-rate-limit 60)
|
||||
to configure the same. This can also be done with the M(dellos9_config) module.
|
||||
to configure the same. This can also be done with the
|
||||
M(dellos9_config) module.
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
|
|
@ -152,7 +159,6 @@ EXAMPLES = """
|
|||
parents: ['ip access-list extended test']
|
||||
before: ['no ip access-list extended test']
|
||||
match: exact
|
||||
provider: "{{ cli }}"
|
||||
|
||||
- dellos9_config:
|
||||
lines:
|
||||
|
|
@ -163,30 +169,25 @@ EXAMPLES = """
|
|||
parents: ['ip access-list extended test']
|
||||
before: ['no ip access-list extended test']
|
||||
replace: block
|
||||
provider: "{{ cli }}"
|
||||
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
updates:
|
||||
description: The set of commands that will be pushed to the remote device.
|
||||
returned: Always.
|
||||
returned: always
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
|
||||
responses:
|
||||
description: The set of responses from issuing the commands on the device.
|
||||
returned: When not check_mode.
|
||||
sample: ['hostname foo', 'router bgp 1', 'bgp router-id 1.1.1.1']
|
||||
commands:
|
||||
description: The set of commands that will be pushed to the remote device
|
||||
returned: always
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
|
||||
sample: ['hostname foo', 'router bgp 1', 'bgp router-id 1.1.1.1']
|
||||
saved:
|
||||
description: Returns whether the configuration is saved to the startup
|
||||
configuration or not.
|
||||
returned: When not check_mode.
|
||||
type: bool
|
||||
sample: True
|
||||
|
||||
backup_path:
|
||||
description: The full path to the backup file
|
||||
returned: when backup is yes
|
||||
|
|
@ -207,10 +208,23 @@ def get_candidate(module):
|
|||
candidate.load(module.params['src'])
|
||||
elif module.params['lines']:
|
||||
parents = module.params['parents'] or list()
|
||||
candidate.add(module.params['lines'], parents=parents)
|
||||
commands = module.params['lines'][0]
|
||||
if (isinstance(commands, dict)) and (isinstance(commands['command'], list)):
|
||||
candidate.add(commands['command'], parents=parents)
|
||||
elif (isinstance(commands, dict)) and (isinstance(commands['command'], str)):
|
||||
candidate.add([commands['command']], parents=parents)
|
||||
else:
|
||||
candidate.add(module.params['lines'], parents=parents)
|
||||
return candidate
|
||||
|
||||
|
||||
def get_running_config(module):
|
||||
contents = module.params['config']
|
||||
if not contents:
|
||||
contents = get_config(module)
|
||||
return contents
|
||||
|
||||
|
||||
def main():
|
||||
|
||||
argument_spec = dict(
|
||||
|
|
@ -236,7 +250,6 @@ def main():
|
|||
|
||||
mutually_exclusive = [('lines', 'src'),
|
||||
('parents', 'src')]
|
||||
|
||||
module = AnsibleModule(argument_spec=argument_spec,
|
||||
mutually_exclusive=mutually_exclusive,
|
||||
supports_check_mode=True)
|
||||
|
|
@ -253,48 +266,62 @@ def main():
|
|||
|
||||
candidate = get_candidate(module)
|
||||
|
||||
if match != 'none':
|
||||
config = get_config(module)
|
||||
if parents:
|
||||
contents = get_sublevel_config(config, module)
|
||||
config = NetworkConfig(contents=contents, indent=1)
|
||||
else:
|
||||
config = NetworkConfig(contents=config, indent=1)
|
||||
configobjs = candidate.difference(config, match=match, replace=replace)
|
||||
|
||||
else:
|
||||
configobjs = candidate.items
|
||||
|
||||
if module.params['backup']:
|
||||
if not module.check_mode:
|
||||
result['__backup__'] = get_config(module)
|
||||
|
||||
commands = list()
|
||||
|
||||
if configobjs:
|
||||
commands = dumps(configobjs, 'commands')
|
||||
commands = commands.split('\n')
|
||||
if any((module.params['lines'], module.params['src'])):
|
||||
if match != 'none':
|
||||
config = get_running_config(module)
|
||||
if parents:
|
||||
contents = get_sublevel_config(config, module)
|
||||
config = NetworkConfig(contents=contents, indent=1)
|
||||
else:
|
||||
config = NetworkConfig(contents=config, indent=1)
|
||||
configobjs = candidate.difference(config, match=match, replace=replace)
|
||||
else:
|
||||
configobjs = candidate.items
|
||||
|
||||
if module.params['before']:
|
||||
commands[:0] = module.params['before']
|
||||
if configobjs:
|
||||
commands = dumps(configobjs, 'commands')
|
||||
if ((isinstance(module.params['lines'], list)) and
|
||||
(isinstance(module.params['lines'][0], dict)) and
|
||||
['prompt', 'answer'].issubset(module.params['lines'][0])):
|
||||
|
||||
if module.params['after']:
|
||||
commands.extend(module.params['after'])
|
||||
cmd = {'command': commands,
|
||||
'prompt': module.params['lines'][0]['prompt'],
|
||||
'answer': module.params['lines'][0]['answer']}
|
||||
commands = [module.jsonify(cmd)]
|
||||
else:
|
||||
commands = commands.split('\n')
|
||||
|
||||
if not module.check_mode and module.params['update'] == 'merge':
|
||||
load_config(module, commands)
|
||||
if module.params['before']:
|
||||
commands[:0] = module.params['before']
|
||||
|
||||
if module.params['save']:
|
||||
cmd = {'command': 'copy runing-config startup-config', 'prompt': WARNING_PROMPTS_RE, 'answer': 'yes'}
|
||||
run_commands(module, [cmd])
|
||||
result['saved'] = True
|
||||
if module.params['after']:
|
||||
commands.extend(module.params['after'])
|
||||
|
||||
if not module.check_mode and module.params['update'] == 'merge':
|
||||
load_config(module, commands)
|
||||
|
||||
result['changed'] = True
|
||||
result['commands'] = commands
|
||||
result['updates'] = commands
|
||||
|
||||
if module.params['save']:
|
||||
result['changed'] = True
|
||||
|
||||
result['updates'] = commands
|
||||
if not module.check_mode:
|
||||
cmd = {'command': 'copy running-config startup-config',
|
||||
'prompt': r'\[confirm yes/no\]:\s?$', 'answer': 'yes'}
|
||||
run_commands(module, [cmd])
|
||||
result['saved'] = True
|
||||
else:
|
||||
module.warn('Skipping command `copy running-config startup-config`'
|
||||
'due to check_mode. Configuration not copied to '
|
||||
'non-volatile storage')
|
||||
|
||||
module.exit_json(**result)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
|
|
|
|||
|
|
@ -23,17 +23,17 @@ description:
|
|||
- Collects a base set of device facts from a remote device that
|
||||
is running OS9. This module prepends all of the
|
||||
base network fact keys with C(ansible_net_<fact>). The facts
|
||||
module always collects a base set of facts from the device
|
||||
module will always collect a base set of facts from the device
|
||||
and can enable or disable collection of additional facts.
|
||||
extends_documentation_fragment: dellos9
|
||||
options:
|
||||
gather_subset:
|
||||
description:
|
||||
- When supplied, this argument restricts the facts collected
|
||||
- When supplied, this argument will restrict the facts collected
|
||||
to a given subset. Possible values for this argument include
|
||||
all, hardware, config, and interfaces. You can specify a list of
|
||||
values to include a larger subset. You can also use values
|
||||
with an initial M(!) to specify that a specific subset should
|
||||
all, hardware, config, and interfaces. Can specify a list of
|
||||
values to include a larger subset. Values can also be used
|
||||
with an initial C(M(!)) to specify that a specific subset should
|
||||
not be collected.
|
||||
required: false
|
||||
default: '!config'
|
||||
|
|
@ -63,72 +63,75 @@ EXAMPLES = """
|
|||
|
||||
RETURN = """
|
||||
ansible_net_gather_subset:
|
||||
description: The list of fact subsets collected from the device.
|
||||
returned: Always.
|
||||
description: The list of fact subsets collected from the device
|
||||
returned: always
|
||||
type: list
|
||||
|
||||
# default
|
||||
ansible_net_model:
|
||||
description: The model name returned from the device.
|
||||
returned: Always.
|
||||
description: The model name returned from the device
|
||||
returned: always
|
||||
type: str
|
||||
ansible_net_serialnum:
|
||||
description: The serial number of the remote device.
|
||||
returned: Always.
|
||||
description: The serial number of the remote device
|
||||
returned: always
|
||||
type: str
|
||||
ansible_net_version:
|
||||
description: The operating system version running on the remote device.
|
||||
returned: Always.
|
||||
description: The operating system version running on the remote device
|
||||
returned: always
|
||||
type: str
|
||||
ansible_net_hostname:
|
||||
description: The configured hostname of the device.
|
||||
returned: Always.
|
||||
description: The configured hostname of the device
|
||||
returned: always
|
||||
type: string
|
||||
ansible_net_image:
|
||||
description: The image file the device is running.
|
||||
returned: Always.
|
||||
description: The image file the device is running
|
||||
returned: always
|
||||
type: string
|
||||
|
||||
# hardware
|
||||
ansible_net_filesystems:
|
||||
description: All file system names available on the device.
|
||||
returned: When hardware is configured.
|
||||
description: All file system names available on the device
|
||||
returned: when hardware is configured
|
||||
type: list
|
||||
ansible_net_memfree_mb:
|
||||
description: The available free memory on the remote device in MB.
|
||||
returned: When hardware is configured.
|
||||
description: The available free memory on the remote device in Mb
|
||||
returned: when hardware is configured
|
||||
type: int
|
||||
ansible_net_memtotal_mb:
|
||||
description: The total memory on the remote device in MB.
|
||||
returned: When hardware is configured.
|
||||
description: The total memory on the remote device in Mb
|
||||
returned: when hardware is configured
|
||||
type: int
|
||||
|
||||
# config
|
||||
ansible_net_config:
|
||||
description: The current active config from the device.
|
||||
returned: When config is configured.
|
||||
description: The current active config from the device
|
||||
returned: when config is configured
|
||||
type: str
|
||||
|
||||
# interfaces
|
||||
ansible_net_all_ipv4_addresses:
|
||||
description: All IPv4 addresses configured on the device.
|
||||
returned: When interfaces is configured.
|
||||
description: All IPv4 addresses configured on the device
|
||||
returned: when interfaces is configured
|
||||
type: list
|
||||
ansible_net_all_ipv6_addresses:
|
||||
description: All IPv6 addresses configured on the device.
|
||||
returned: When interfaces is configured.
|
||||
description: All IPv6 addresses configured on the device
|
||||
returned: when interfaces is configured
|
||||
type: list
|
||||
ansible_net_interfaces:
|
||||
description: A hash of all interfaces running on the system.
|
||||
returned: When interfaces is configured.
|
||||
description: A hash of all interfaces running on the system
|
||||
returned: when interfaces is configured
|
||||
type: dict
|
||||
ansible_net_neighbors:
|
||||
description: The list of LLDP neighbors from the remote device
|
||||
returned: When interfaces is configured.
|
||||
returned: when interfaces is configured
|
||||
type: dict
|
||||
"""
|
||||
import re
|
||||
import itertools
|
||||
try:
|
||||
from itertools import izip
|
||||
except ImportError:
|
||||
izip = zip
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.network.dellos9.dellos9 import run_commands
|
||||
|
|
@ -316,7 +319,7 @@ class Interfaces(FactsBase):
|
|||
self.facts['interfaces'][key]['ipv6'] = list()
|
||||
addresses = re.findall(r'\s+(.+), subnet', value, re.M)
|
||||
subnets = re.findall(r', subnet is (\S+)', value, re.M)
|
||||
for addr, subnet in itertools.izip(addresses, subnets):
|
||||
for addr, subnet in izip(addresses, subnets):
|
||||
ipv6 = dict(address=addr.strip(), subnet=subnet.strip())
|
||||
self.add_ip_address(addr.strip(), 'ipv6')
|
||||
self.facts['interfaces'][key]['ipv6'].append(ipv6)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue