internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-07 13:52:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added support for new Ansible Infra (network_cli plugin, cliconf, module utils cleanup and test) for dellos10 Support t (#34915)

Browse Source 
* Support for network_cli plugin and tests

* Fixed ansible-test * issues

* Fixed Pylint warning

* Fixed the sanity test errors

* Fix YAMLlinter issue - removed blank spaces

* Fixed Python 3 failures

* Fixed the PEP8 issue

* Fix sanity --test validate-modules

* Reverted the changes to the doc fragments
This commit is contained in:
Senthil Kumar Ganesan
2018-01-25 04:37:27 -08:00
committed by John R Barker
parent 1f544ed6cc
commit 2f46f8f944
51 changed files with 22371 additions and 160 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
lib/ansible/module_utils/network/dellos10/dellos10.py
View File

@@ -124,8 +124,7 @@ def load_config(module, commands):
for command in to_list(commands):
if command == 'end':
continue
cmd = {'command': command, 'prompt': WARNING_PROMPTS_RE, 'answer': 'yes'}
rc, out, err = exec_command(module, module.jsonify(cmd))
rc, out, err = exec_command(module, command)
if rc != 0:
module.fail_json(msg=to_text(err, errors='surrogate_or_strict'), command=command, rc=rc)

35
lib/ansible/modules/network/dellos10/dellos10_command.py
View File

@@ -45,9 +45,22 @@ 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 by tried
- 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(wait_for) conditions.
@@ -64,33 +77,21 @@ 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
dellos10_command:
commands: show version
provider: "{{ cli }}"
- name: run show version and check to see if output contains OS10
dellos10_command:
commands: show version
wait_for: result[0] contains OS10
provider: "{{ cli }}"
- name: run multiple commands on remote nodes
dellos10_command:
commands:
- show version
- show interface
provider: "{{ cli }}"
- name: run multiple commands and evaluate the output
dellos10_command:
@@ -100,7 +101,6 @@ tasks:
wait_for:
- result[0] contains OS10
- result[1] contains Ethernet
provider: "{{ cli }}"
"""
RETURN = """
@@ -109,19 +109,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 +217,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)

171
lib/ansible/modules/network/dellos10/dellos10_config.py
View File

@@ -31,15 +31,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
@@ -48,15 +50,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 argument
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
@@ -64,20 +66,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 argument 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 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
@@ -85,10 +87,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
@@ -97,9 +99,9 @@ options:
description:
- The I(update) argument controls how the configuration statements
are processed on the remote device. Valid choices for the I(update)
argument are I(merge) and I(check). When you set the argument to
argument are I(merge) and I(check). When you set this argument to
I(merge), the configuration changes merge with the current
device running configuration. When you set the argument to I(check),
device running configuration. When you set this argument to I(check)
the configuration updates are determined but not actually configured
on the remote device.
required: false
@@ -109,34 +111,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 = """
- dellos10_config:
lines: ['hostname {{ inventory_hostname }}']
provider: "{{ cli }}"
- dellos10_config:
lines:
@@ -148,7 +152,6 @@ EXAMPLES = """
parents: ['ip access-list test']
before: ['no ip access-list test']
match: exact
provider: "{{ cli }}"
- dellos10_config:
lines:
@@ -159,23 +162,19 @@ 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: ['...', '...']
responses:
description: The set of responses from issuing the commands on the device.
returned: When not check_mode.
sample: ['hostname foo', 'router bgp 1', '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', 'router-id 1.1.1.1']
saved:
description: Returns whether the configuration is saved to the startup
configuration or not.
@@ -202,10 +201,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(
@@ -229,8 +241,7 @@ def main():
argument_spec.update(dellos10_argument_spec)
mutually_exclusive = [('lines', 'src'),
('parents', 'src')]
mutually_exclusive = [('lines', 'src')]
module = AnsibleModule(argument_spec=argument_spec,
mutually_exclusive=mutually_exclusive,
@@ -246,46 +257,62 @@ def main():
result = dict(changed=False, saved=False, warnings=warnings)
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()
candidate = get_candidate(module)
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 = {r'command': 'copy running-config startup-config',
r'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)

57
lib/ansible/modules/network/dellos10/dellos10_facts.py
View File

@@ -23,16 +23,17 @@ description:
- Collects a base set of device facts from a remote device that
is running OS10. 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: dellos10
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'
@@ -56,8 +57,8 @@ 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
@@ -66,58 +67,58 @@ ansible_net_name:
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_servicetag:
description: The service tag number of the remote device.
returned: Always.
returned: always
type: str
ansible_net_model:
description: The model name returned from the device.
returned: Always.
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: str
# hardware
ansible_net_cpu_arch:
description: CPU Architecture of the remote device.
returned: When hardware is configured.
returned: when hardware is configured
type: str
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.
description: The list of LLDP neighbors from the remote device
returned: when interfaces is configured
type: dict
"""
@@ -212,7 +213,7 @@ class Hardware(FactsBase):
COMMANDS = [
'show version | display-xml',
'show processes node-id 1 | grep "Mem:"'
'show processes node-id 1 | grep Mem:'
]
def populate(self):

69
lib/ansible/plugins/action/dellos10.py
View File

@@ -1,7 +1,7 @@
#
# (c) 2016 Red Hat Inc.
#
# Copyright (c) 2017 Dell Inc.
# (c) 2017 Dell EMC.
#
# This file is part of Ansible
#
@@ -28,8 +28,8 @@ from ansible import constants as C
from ansible.module_utils._text import to_text
from ansible.module_utils.connection import Connection
from ansible.plugins.action.normal import ActionModule as _ActionModule
from ansible.module_utils.network.dellos10.dellos10 import dellos10_provider_spec
from ansible.module_utils.network.common.utils import load_provider
from ansible.module_utils.network.dellos10.dellos10 import dellos10_provider_spec
try:
from __main__ import display
@@ -41,40 +41,45 @@ except ImportError:
class ActionModule(_ActionModule):
def run(self, tmp=None, task_vars=None):
socket_path = None
if self._play_context.connection != 'local':
return dict(
failed=True,
msg='invalid connection specified, expected connection=local, '
'got %s' % self._play_context.connection
)
if self._play_context.connection == 'network_cli':
provider = self._task.args.get('provider', {})
if any(provider.values()):
display.warning('provider is unnecessary when using network_cli and will be ignored')
elif self._play_context.connection == 'local':
provider = load_provider(dellos10_provider_spec, self._task.args)
pc = copy.deepcopy(self._play_context)
pc.connection = 'network_cli'
pc.network_os = 'dellos10'
pc.remote_addr = provider['host'] or self._play_context.remote_addr
pc.port = int(provider['port'] or self._play_context.port or 22)
pc.remote_user = provider['username'] or self._play_context.connection_user
pc.password = provider['password'] or self._play_context.password
pc.private_key_file = provider['ssh_keyfile'] or self._play_context.private_key_file
pc.timeout = int(provider['timeout'] or C.PERSISTENT_COMMAND_TIMEOUT)
pc.become = provider['authorize'] or False
if pc.become:
pc.become_method = 'enable'
pc.become_pass = provider['auth_pass']
provider = load_provider(dellos10_provider_spec, self._task.args)
display.vvv('using connection plugin %s' % pc.connection, pc.remote_addr)
connection = self._shared_loader_obj.connection_loader.get('persistent', pc, sys.stdin)
pc = copy.deepcopy(self._play_context)
pc.connection = 'network_cli'
pc.network_os = 'dellos10'
pc.remote_addr = provider['host'] or self._play_context.remote_addr
pc.port = int(provider['port'] or self._play_context.port or 22)
pc.remote_user = provider['username'] or self._play_context.connection_user
pc.password = provider['password'] or self._play_context.password
pc.private_key_file = provider['ssh_keyfile'] or self._play_context.private_key_file
pc.timeout = int(provider['timeout'] or C.PERSISTENT_COMMAND_TIMEOUT)
pc.become = provider['authorize'] or False
pc.become_pass = provider['auth_pass']
socket_path = connection.run()
display.vvvv('socket_path: %s' % socket_path, pc.remote_addr)
if not socket_path:
return {'failed': True,
'msg': 'unable to open shell. Please see: ' +
'https://docs.ansible.com/ansible/network_debug_troubleshooting.html#unable-to-open-shell'}
display.vvv('using connection plugin %s (was local)' % pc.connection, pc.remote_addr)
connection = self._shared_loader_obj.connection_loader.get('persistent', pc, sys.stdin)
socket_path = connection.run()
display.vvvv('socket_path: %s' % socket_path, pc.remote_addr)
if not socket_path:
return {'failed': True,
'msg': 'unable to open shell. Please see: ' +
'https://docs.ansible.com/ansible/network_debug_troubleshooting.html#unable-to-open-shell'}
task_vars['ansible_socket'] = socket_path
# make sure we are in the right cli context which should be
# enable mode and not config module
if socket_path is None:
socket_path = self._connection.socket_path
conn = Connection(socket_path)
out = conn.get_prompt()
while to_text(out, errors='surrogate_then_replace').strip().endswith(')#'):
@@ -82,11 +87,5 @@ class ActionModule(_ActionModule):
conn.send_command('exit')
out = conn.get_prompt()
task_vars['ansible_socket'] = socket_path
if self._play_context.become_method == 'enable':
self._play_context.become = False
self._play_context.become_method = None
result = super(ActionModule, self).run(tmp, task_vars)
return result

82
lib/ansible/plugins/cliconf/dellos10.py Normal file
View File

@@ -0,0 +1,82 @@
#
# (c) 2017 Red Hat Inc.
#
# (c) 2017 Dell EMC.
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
#
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
import re
import json
from itertools import chain
from ansible.module_utils._text import to_bytes, to_text
from ansible.module_utils.network.common.utils import to_list
from ansible.plugins.cliconf import CliconfBase, enable_mode
class Cliconf(CliconfBase):
def get_device_info(self):
device_info = {}
device_info['network_os'] = 'dellos10'
reply = self.get(b'show version')
data = to_text(reply, errors='surrogate_or_strict').strip()
match = re.search(r'OS Version (\S+)', data)
if match:
device_info['network_os_version'] = match.group(1)
match = re.search(r'System Type (\S+)', data, re.M)
if match:
device_info['network_os_model'] = match.group(1)
reply = self.get(b'show running-configuration | grep hostname')
data = to_text(reply, errors='surrogate_or_strict').strip()
match = re.search(r'^hostname (.+)', data, re.M)
if match:
device_info['network_os_hostname'] = match.group(1)
return device_info
@enable_mode
def get_config(self, source='running'):
if source not in ('running', 'startup'):
return self.invalid_params("fetching configuration from %s is not supported" % source)
if source == 'running':
cmd = b'show running-config all'
else:
cmd = b'show startup-config'
return self.send_command(cmd)
@enable_mode
def edit_config(self, command):
for cmd in chain(['configure terminal'], to_list(command), ['end']):
self.send_command(to_bytes(cmd))
def get(self, command, prompt=None, answer=None, sendonly=False):
return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly)
def get_capabilities(self):
result = {}
result['rpc'] = self.get_base_rpc()
result['network_api'] = 'cliconf'
result['device_info'] = self.get_device_info()
return json.dumps(result)