166 lines
6.3 KiB
Python
166 lines
6.3 KiB
Python
#
|
|
# (c) 2015 Peter Sprygada, <psprygada@ansible.com>
|
|
# (c) 2017 Red Hat, Inc
|
|
#
|
|
# Copyright (c) 2016 Dell Inc.
|
|
#
|
|
# This code is part of Ansible, but is an independent component.
|
|
# This particular file snippet, and this file snippet only, is BSD licensed.
|
|
# Modules you write using this snippet, which is embedded dynamically by Ansible
|
|
# still belong to the author of the module, and may assign their own license
|
|
# to the complete work.
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without modification,
|
|
# are permitted provided that the following conditions are met:
|
|
#
|
|
# * Redistributions of source code must retain the above copyright
|
|
# notice, this list of conditions and the following disclaimer.
|
|
# * Redistributions in binary form must reproduce the above copyright notice,
|
|
# this list of conditions and the following disclaimer in the documentation
|
|
# and/or other materials provided with the distribution.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
|
|
# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
#
|
|
import json
|
|
|
|
from ansible.module_utils._text import to_text
|
|
from ansible.module_utils.basic import env_fallback
|
|
from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.utils import to_list, ComplexList
|
|
from ansible.module_utils.connection import Connection, ConnectionError, exec_command
|
|
from ansible_collections.ansible.netcommon.plugins.module_utils.network.common.config import NetworkConfig, ConfigLine
|
|
|
|
_DEVICE_CONFIGS = {}
|
|
|
|
WARNING_PROMPTS_RE = [
|
|
r"[\r\n]?\[confirm yes/no\]:\s?$",
|
|
r"[\r\n]?\[y/n\]:\s?$",
|
|
r"[\r\n]?\[yes/no\]:\s?$"
|
|
]
|
|
|
|
dellos9_provider_spec = {
|
|
'host': dict(),
|
|
'port': dict(type='int'),
|
|
'username': dict(fallback=(env_fallback, ['ANSIBLE_NET_USERNAME'])),
|
|
'password': dict(fallback=(env_fallback, ['ANSIBLE_NET_PASSWORD']), no_log=True),
|
|
'ssh_keyfile': dict(fallback=(env_fallback, ['ANSIBLE_NET_SSH_KEYFILE']), type='path'),
|
|
'authorize': dict(fallback=(env_fallback, ['ANSIBLE_NET_AUTHORIZE']), type='bool'),
|
|
'auth_pass': dict(fallback=(env_fallback, ['ANSIBLE_NET_AUTH_PASS']), no_log=True),
|
|
'timeout': dict(type='int'),
|
|
}
|
|
dellos9_argument_spec = {
|
|
'provider': dict(type='dict', options=dellos9_provider_spec),
|
|
}
|
|
dellos9_top_spec = {
|
|
'host': dict(removed_in_version=2.9),
|
|
'port': dict(removed_in_version=2.9, type='int'),
|
|
'username': dict(removed_in_version=2.9),
|
|
'password': dict(removed_in_version=2.9, no_log=True),
|
|
'ssh_keyfile': dict(removed_in_version=2.9, type='path'),
|
|
'authorize': dict(removed_in_version=2.9, type='bool'),
|
|
'auth_pass': dict(removed_in_version=2.9, no_log=True),
|
|
'timeout': dict(removed_in_version=2.9, type='int'),
|
|
}
|
|
dellos9_argument_spec.update(dellos9_top_spec)
|
|
|
|
|
|
def get_provider_argspec():
|
|
return dellos9_provider_spec
|
|
|
|
|
|
def get_connection(module):
|
|
if hasattr(module, '_dellos9_connection'):
|
|
return module._dellos9_connection
|
|
|
|
capabilities = get_capabilities(module)
|
|
network_api = capabilities.get('network_api')
|
|
if network_api == 'cliconf':
|
|
module._dellos9_connection = Connection(module._socket_path)
|
|
else:
|
|
module.fail_json(msg='Invalid connection type %s' % network_api)
|
|
|
|
return module._dellos9_connection
|
|
|
|
|
|
def get_capabilities(module):
|
|
if hasattr(module, '_dellos9_capabilities'):
|
|
return module._dellos9_capabilities
|
|
try:
|
|
capabilities = Connection(module._socket_path).get_capabilities()
|
|
except ConnectionError as exc:
|
|
module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
|
|
module._dellos9_capabilities = json.loads(capabilities)
|
|
return module._dellos9_capabilities
|
|
|
|
|
|
def check_args(module, warnings):
|
|
pass
|
|
|
|
|
|
def get_config(module, flags=None):
|
|
flags = [] if flags is None else flags
|
|
|
|
cmd = 'show running-config '
|
|
cmd += ' '.join(flags)
|
|
cmd = cmd.strip()
|
|
|
|
try:
|
|
return _DEVICE_CONFIGS[cmd]
|
|
except KeyError:
|
|
rc, out, err = exec_command(module, cmd)
|
|
if rc != 0:
|
|
module.fail_json(msg='unable to retrieve current config', stderr=to_text(err, errors='surrogate_or_strict'))
|
|
cfg = to_text(out, errors='surrogate_or_strict').strip()
|
|
_DEVICE_CONFIGS[cmd] = cfg
|
|
return cfg
|
|
|
|
|
|
def run_commands(module, commands, check_rc=True):
|
|
connection = get_connection(module)
|
|
try:
|
|
return connection.run_commands(commands=commands, check_rc=check_rc)
|
|
except ConnectionError as exc:
|
|
module.fail_json(msg=to_text(exc))
|
|
|
|
|
|
def load_config(module, commands):
|
|
rc, out, err = exec_command(module, 'configure terminal')
|
|
if rc != 0:
|
|
module.fail_json(msg='unable to enter configuration mode', err=to_text(err, errors='surrogate_or_strict'))
|
|
|
|
for command in to_list(commands):
|
|
if command == 'end':
|
|
continue
|
|
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)
|
|
|
|
exec_command(module, 'end')
|
|
|
|
|
|
def get_sublevel_config(running_config, module):
|
|
contents = list()
|
|
current_config_contents = list()
|
|
running_config = NetworkConfig(contents=running_config, indent=1)
|
|
obj = running_config.get_object(module.params['parents'])
|
|
if obj:
|
|
contents = obj.children
|
|
contents[:0] = module.params['parents']
|
|
|
|
indent = 0
|
|
for c in contents:
|
|
if isinstance(c, str):
|
|
current_config_contents.append(c.rjust(len(c) + indent, ' '))
|
|
if isinstance(c, ConfigLine):
|
|
current_config_contents.append(c.raw)
|
|
indent = 1
|
|
sublevel_config = '\n'.join(current_config_contents)
|
|
|
|
return sublevel_config
|