mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-24 22:00:22 -07:00
2.5 Plugin Environment support and Testcases for dellos6 modules (#34890)
* Dellos6_2.5_support * cleanup * Fix pep8 * fix waitfor * fix_facts * fix_assert
This commit is contained in:
abirami-n
John R Barker
parent
2018a61489
commit
775118aae2
24 changed files with 1017 additions and 147 deletions
|
|
@ -12,7 +12,6 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = """
|
||||
---
|
||||
module: dellos6_command
|
||||
|
|
@ -34,7 +33,7 @@ options:
|
|||
configured provider. The resulting output from the command
|
||||
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.
|
||||
the number of retries has expired.
|
||||
required: true
|
||||
wait_for:
|
||||
description:
|
||||
|
|
@ -45,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
|
||||
|
|
@ -64,43 +76,30 @@ options:
|
|||
"""
|
||||
|
||||
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
|
||||
dellos6_command:
|
||||
commands: show version
|
||||
provider: "{{ cli }}"
|
||||
- name: run show version on remote devices
|
||||
dellos6_command:
|
||||
commands: show version
|
||||
|
||||
- name: run show version and check to see if output contains Dell
|
||||
dellos6_command:
|
||||
commands: show version
|
||||
wait_for: result[0] contains Dell
|
||||
provider: "{{ cli }}"
|
||||
- name: run show version and check to see if output contains Dell
|
||||
dellos6_command:
|
||||
commands: show version
|
||||
wait_for: result[0] contains Dell
|
||||
|
||||
- name: run multiple commands on remote nodes
|
||||
dellos6_command:
|
||||
commands:
|
||||
- show version
|
||||
- show interfaces
|
||||
provider: "{{ cli }}"
|
||||
- name: run multiple commands on remote nodes
|
||||
dellos6_command:
|
||||
commands:
|
||||
- show version
|
||||
- show interfaces
|
||||
|
||||
- name: run multiple commands and evaluate the output
|
||||
dellos6_command:
|
||||
commands:
|
||||
- show version
|
||||
- show interfaces
|
||||
wait_for:
|
||||
- result[0] contains Dell
|
||||
- result[1] contains Access
|
||||
provider: "{{ cli }}"
|
||||
- name: run multiple commands and evaluate the output
|
||||
dellos6_command:
|
||||
commands:
|
||||
- show version
|
||||
- show interfaces
|
||||
wait_for:
|
||||
- result[0] contains Dell
|
||||
- result[1] contains Access
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
|
|
@ -109,19 +108,16 @@ stdout:
|
|||
returned: always apart from low level errors (such as action plugin)
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
|
||||
stdout_lines:
|
||||
description: The value of stdout split into a list
|
||||
returned: always apart from low level errors (such as action plugin)
|
||||
type: list
|
||||
sample: [['...', '...'], ['...'], ['...']]
|
||||
|
||||
failed_conditions:
|
||||
description: The list of conditionals that have failed
|
||||
returned: failed
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
|
||||
warnings:
|
||||
description: The list of warnings (if any) generated by module based on arguments
|
||||
returned: always
|
||||
|
|
@ -220,11 +216,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)
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,6 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = """
|
||||
---
|
||||
module: dellos6_config
|
||||
|
|
@ -30,15 +29,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,8 +48,8 @@ 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:
|
||||
|
|
@ -63,19 +64,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), the playbook designer can use this to 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 matched by respect
|
||||
to 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
|
||||
|
|
@ -83,9 +85,9 @@ 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
|
||||
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 you set the replace argument to I(block) then the entire
|
||||
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
|
||||
|
|
@ -107,34 +109,36 @@ options:
|
|||
description:
|
||||
- The C(save) argument instructs the module to save the running-
|
||||
config to the startup-config at the conclusion of the module
|
||||
running. If you specify check mode, this argument is ignored.
|
||||
running. If check mode is specified, this argument is ignored.
|
||||
required: false
|
||||
default: no
|
||||
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
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
- dellos6_config:
|
||||
lines: ['hostname {{ inventory_hostname }}']
|
||||
provider: "{{ cli }}"
|
||||
|
||||
- dellos6_config:
|
||||
lines:
|
||||
|
|
@ -146,7 +150,6 @@ EXAMPLES = """
|
|||
parents: ['ip access-list test']
|
||||
before: ['no ip access-list test']
|
||||
match: exact
|
||||
provider: "{{ cli }}"
|
||||
|
||||
- dellos6_config:
|
||||
lines:
|
||||
|
|
@ -157,22 +160,21 @@ EXAMPLES = """
|
|||
parents: ['ip access-list test']
|
||||
before: ['no ip access-list test']
|
||||
replace: block
|
||||
provider: "{{ cli }}"
|
||||
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
updates:
|
||||
description: The set of commands pushed to the remote device.
|
||||
returned: Always.
|
||||
description: The set of commands that will be pushed to the remote device.
|
||||
returned: always
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
sample: ['interface Te1/0/1', 'no shutdown', 'exit']
|
||||
|
||||
responses:
|
||||
description: The set of responses from issuing the commands on the device.
|
||||
returned: When not check_mode.
|
||||
commands:
|
||||
description: The set of commands that will be pushed to the remote device
|
||||
returned: always
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
sample: ['interface Te1/0/1', 'no shutdown', 'exit']
|
||||
|
||||
saved:
|
||||
description: Returns whether the configuration is saved to the startup
|
||||
|
|
@ -185,7 +187,7 @@ backup_path:
|
|||
description: The full path to the backup file
|
||||
returned: when backup is yes
|
||||
type: string
|
||||
sample: /playbooks/ansible/backup/dellos6_config.2016-07-16@22:28:34
|
||||
sample: /playbooks/ansible/backup/dellos6_config.2017-07-16@22:28:34
|
||||
"""
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.network.dellos6.dellos6 import get_config, get_sublevel_config, Dellos6NetworkConfig
|
||||
|
|
@ -201,10 +203,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(
|
||||
|
|
@ -227,7 +242,6 @@ def main():
|
|||
)
|
||||
|
||||
argument_spec.update(dellos6_argument_spec)
|
||||
|
||||
mutually_exclusive = [('lines', 'src'),
|
||||
('parents', 'src')]
|
||||
|
||||
|
|
@ -245,42 +259,59 @@ def main():
|
|||
result = dict(changed=False, saved=False, warnings=warnings)
|
||||
|
||||
candidate = get_candidate(module)
|
||||
if match != 'none':
|
||||
config = get_config(module)
|
||||
config = Dellos6NetworkConfig(contents=config, indent=0)
|
||||
if parents:
|
||||
config = get_sublevel_config(config, module)
|
||||
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)
|
||||
config = Dellos6NetworkConfig(contents=config, indent=0)
|
||||
if parents:
|
||||
config = get_sublevel_config(config, module)
|
||||
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])):
|
||||
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 module.params['after']:
|
||||
commands.extend(module.params['after'])
|
||||
if module.params['before']:
|
||||
commands[:0] = module.params['before']
|
||||
|
||||
if not module.check_mode and module.params['update'] == 'merge':
|
||||
load_config(module, commands)
|
||||
if module.params['after']:
|
||||
commands.extend(module.params['after'])
|
||||
|
||||
if module.params['save']:
|
||||
cmd = {'command': 'copy runing-config startup-config', 'prompt': WARNING_PROMPTS_RE, 'answer': 'yes'}
|
||||
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
|
||||
if not module.check_mode:
|
||||
cmd = {'command': 'copy running-config startup-config',
|
||||
'prompt': r'\(y/n\)$', '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')
|
||||
|
||||
result['changed'] = True
|
||||
|
||||
result['updates'] = commands
|
||||
module.exit_json(**result)
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -23,16 +23,17 @@ description:
|
|||
- Collects a base set of device facts from a remote device that
|
||||
is running OS6. 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: dellos6
|
||||
options:
|
||||
gather_subset:
|
||||
description:
|
||||
- When specified, 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'
|
||||
|
|
@ -57,29 +58,29 @@ EXAMPLES = """
|
|||
RETURN = """
|
||||
ansible_net_gather_subset:
|
||||
description: The list of fact subsets collected from the device.
|
||||
returned: Always.
|
||||
returned: always.
|
||||
type: list
|
||||
|
||||
# default
|
||||
ansible_net_model:
|
||||
description: The model name returned from the device.
|
||||
returned: Always.
|
||||
returned: always.
|
||||
type: str
|
||||
ansible_net_serialnum:
|
||||
description: The serial number of the remote device.
|
||||
returned: Always.
|
||||
returned: always.
|
||||
type: str
|
||||
ansible_net_version:
|
||||
description: The operating system version running on the remote device.
|
||||
returned: Always.
|
||||
returned: always.
|
||||
type: str
|
||||
ansible_net_hostname:
|
||||
description: The configured hostname of the device.
|
||||
returned: Always.
|
||||
returned: always.
|
||||
type: string
|
||||
ansible_net_image:
|
||||
description: The image file that the device is running.
|
||||
returned: Always
|
||||
returned: always
|
||||
type: string
|
||||
|
||||
# hardware
|
||||
|
|
@ -147,7 +148,7 @@ class Default(FactsBase):
|
|||
self.facts['serialnum'] = self.parse_serialnum(data)
|
||||
self.facts['model'] = self.parse_model(data)
|
||||
self.facts['image'] = self.parse_image(data)
|
||||
hdata = self.responses[0]
|
||||
hdata = self.responses[1]
|
||||
self.facts['hostname'] = self.parse_hostname(hdata)
|
||||
|
||||
def parse_version(self, data):
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue