91f35363a2
This commit adds a new shared module for working with Cisco IOS XR devices over CLI (SSH). It also provides a documentation fragement for the commmon arguments provided by the iosxr module.
122 lines
3.3 KiB
Python
122 lines
3.3 KiB
Python
#
|
|
# (c) 2015 Peter Sprygada, <psprygada@ansible.com>
|
|
#
|
|
# 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/>.
|
|
#
|
|
|
|
NET_PASSWD_RE = re.compile(r"[\r\n]?password: $", re.I)
|
|
|
|
NET_COMMON_ARGS = dict(
|
|
host=dict(required=True),
|
|
port=dict(default=22, type='int'),
|
|
username=dict(required=True),
|
|
password=dict(no_log=True)
|
|
)
|
|
|
|
def to_list(val):
|
|
if isinstance(val, (list, tuple)):
|
|
return list(val)
|
|
elif val is not None:
|
|
return [val]
|
|
else:
|
|
return list()
|
|
|
|
class Cli(object):
|
|
|
|
def __init__(self, module):
|
|
self.module = module
|
|
self.shell = None
|
|
|
|
def connect(self, **kwargs):
|
|
host = self.module.params['host']
|
|
port = self.module.params['port'] or 22
|
|
|
|
username = self.module.params['username']
|
|
password = self.module.params['password']
|
|
|
|
self.shell = Shell()
|
|
self.shell.open(host, port=port, username=username, password=password)
|
|
|
|
def send(self, commands):
|
|
return self.shell.send(commands)
|
|
|
|
class IosxrModule(AnsibleModule):
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super(IosxrModule, self).__init__(*args, **kwargs)
|
|
self.connection = None
|
|
self._config = None
|
|
|
|
@property
|
|
def config(self):
|
|
if not self._config:
|
|
self._config = self.get_config()
|
|
return self._config
|
|
|
|
def connect(self):
|
|
try:
|
|
self.connection = Cli(self)
|
|
self.connection.connect()
|
|
self.execute('terminal length 0')
|
|
except Exception, exc:
|
|
self.fail_json(msg=exc.message)
|
|
|
|
def configure(self, commands):
|
|
commands = to_list(commands)
|
|
commands.insert(0, 'configure terminal')
|
|
commands.append('commit')
|
|
responses = self.execute(commands)
|
|
responses.pop(0)
|
|
responses.pop()
|
|
return responses
|
|
|
|
def execute(self, commands, **kwargs):
|
|
return self.connection.send(commands)
|
|
|
|
def disconnect(self):
|
|
self.connection.close()
|
|
|
|
def parse_config(self, cfg):
|
|
return parse(cfg, indent=1)
|
|
|
|
def get_config(self):
|
|
return self.execute('show running-config')[0]
|
|
|
|
def get_module(**kwargs):
|
|
"""Return instance of IosxrModule
|
|
"""
|
|
|
|
argument_spec = NET_COMMON_ARGS.copy()
|
|
if kwargs.get('argument_spec'):
|
|
argument_spec.update(kwargs['argument_spec'])
|
|
kwargs['argument_spec'] = argument_spec
|
|
kwargs['check_invalid_arguments'] = False
|
|
|
|
module = IosxrModule(**kwargs)
|
|
|
|
if not HAS_PARAMIKO:
|
|
module.fail_json(msg='paramiko is required but does not appear to be installed')
|
|
|
|
# copy in values from local action.
|
|
params = json_dict_unicode_to_bytes(json.loads(MODULE_COMPLEX_ARGS))
|
|
for key, value in params.iteritems():
|
|
module.params[key] = value
|
|
|
|
module.connect()
|
|
|
|
return module
|
|
|