200 lines
6.9 KiB
Python
200 lines
6.9 KiB
Python
# 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.
|
|
#
|
|
# (c) 2016 Red Hat Inc.
|
|
#
|
|
# 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.module_utils.network.common.utils import to_list
|
|
from ansible.module_utils.connection import Connection, ConnectionError
|
|
|
|
_DEVICE_CONFIGS = {}
|
|
|
|
ios_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')
|
|
}
|
|
ios_argument_spec = {
|
|
'provider': dict(type='dict', options=ios_provider_spec),
|
|
}
|
|
|
|
ios_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(fallback=(env_fallback, ['ANSIBLE_NET_AUTHORIZE']), type='bool'),
|
|
'auth_pass': dict(removed_in_version=2.9, no_log=True),
|
|
'timeout': dict(removed_in_version=2.9, type='int')
|
|
}
|
|
ios_argument_spec.update(ios_top_spec)
|
|
|
|
|
|
def get_provider_argspec():
|
|
return ios_provider_spec
|
|
|
|
|
|
def get_connection(module):
|
|
if hasattr(module, '_ios_connection'):
|
|
return module._ios_connection
|
|
|
|
capabilities = get_capabilities(module)
|
|
network_api = capabilities.get('network_api')
|
|
if network_api == 'cliconf':
|
|
module._ios_connection = Connection(module._socket_path)
|
|
else:
|
|
module.fail_json(msg='Invalid connection type %s' % network_api)
|
|
|
|
return module._ios_connection
|
|
|
|
|
|
def get_capabilities(module):
|
|
if hasattr(module, '_ios_capabilities'):
|
|
return module._ios_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._ios_capabilities = json.loads(capabilities)
|
|
return module._ios_capabilities
|
|
|
|
|
|
def check_args(module, warnings):
|
|
pass
|
|
|
|
|
|
def get_defaults_flag(module):
|
|
connection = get_connection(module)
|
|
try:
|
|
out = connection.get_defaults_flag()
|
|
except ConnectionError as exc:
|
|
module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
|
|
return to_text(out, errors='surrogate_then_replace').strip()
|
|
|
|
|
|
def get_config(module, flags=None):
|
|
flags = to_list(flags)
|
|
|
|
section_filter = False
|
|
if flags and 'section' in flags[-1]:
|
|
section_filter = True
|
|
|
|
flag_str = ' '.join(flags)
|
|
|
|
try:
|
|
return _DEVICE_CONFIGS[flag_str]
|
|
except KeyError:
|
|
connection = get_connection(module)
|
|
try:
|
|
out = connection.get_config(flags=flags)
|
|
except ConnectionError as exc:
|
|
if section_filter:
|
|
# Some ios devices don't understand `| section foo`
|
|
out = get_config(module, flags=flags[:-1])
|
|
else:
|
|
module.fail_json(msg=to_text(exc, errors='surrogate_then_replace'))
|
|
cfg = to_text(out, errors='surrogate_then_replace').strip()
|
|
_DEVICE_CONFIGS[flag_str] = cfg
|
|
return cfg
|
|
|
|
|
|
def run_commands(module, commands, check_rc=True, return_timestamps=False):
|
|
connection = get_connection(module)
|
|
try:
|
|
return connection.run_commands(commands=commands, check_rc=check_rc, return_timestamps=return_timestamps)
|
|
except ConnectionError as exc:
|
|
module.fail_json(msg=to_text(exc))
|
|
|
|
|
|
def load_config(module, commands):
|
|
connection = get_connection(module)
|
|
|
|
try:
|
|
resp = connection.edit_config(commands)
|
|
return resp.get('response')
|
|
except ConnectionError as exc:
|
|
module.fail_json(msg=to_text(exc))
|
|
|
|
|
|
def normalize_interface(name):
|
|
"""Return the normalized interface name
|
|
"""
|
|
if not name:
|
|
return
|
|
|
|
def _get_number(name):
|
|
digits = ''
|
|
for char in name:
|
|
if char.isdigit() or char in '/.':
|
|
digits += char
|
|
return digits
|
|
|
|
if name.lower().startswith('gi'):
|
|
if_type = 'GigabitEthernet'
|
|
elif name.lower().startswith('te'):
|
|
if_type = 'TenGigabitEthernet'
|
|
elif name.lower().startswith('fa'):
|
|
if_type = 'FastEthernet'
|
|
elif name.lower().startswith('fo'):
|
|
if_type = 'FortyGigabitEthernet'
|
|
elif name.lower().startswith('et'):
|
|
if_type = 'Ethernet'
|
|
elif name.lower().startswith('vl'):
|
|
if_type = 'Vlan'
|
|
elif name.lower().startswith('lo'):
|
|
if_type = 'loopback'
|
|
elif name.lower().startswith('po'):
|
|
if_type = 'port-channel'
|
|
elif name.lower().startswith('nv'):
|
|
if_type = 'nve'
|
|
elif name.lower().startswith('twe'):
|
|
if_type = 'TwentyFiveGigE'
|
|
elif name.lower().startswith('hu'):
|
|
if_type = 'HundredGigE'
|
|
else:
|
|
if_type = None
|
|
|
|
number_list = name.split(' ')
|
|
if len(number_list) == 2:
|
|
if_number = number_list[-1].strip()
|
|
else:
|
|
if_number = _get_number(name)
|
|
|
|
if if_type:
|
|
proper_interface = if_type + if_number
|
|
else:
|
|
proper_interface = name
|
|
|
|
return proper_interface
|