mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
9cba1a7c69
New argument `provider` added to the ios shared module that provides the ability to pass all of the common ios arguments as a dict. This commit includes some minor bugfixes and refactoring of names. It also includes udpates to the ios documentation fragment for the new argument
134 lines
3.8 KiB
Python
134 lines
3.8 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),
|
|
authorize=dict(default=False, type='bool'),
|
|
auth_pass=dict(no_log=True),
|
|
provider=dict()
|
|
)
|
|
|
|
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 authorize(self):
|
|
passwd = self.module.params['auth_pass']
|
|
self.send(Command('enable', prompt=NET_PASSWD_RE, response=passwd))
|
|
|
|
def send(self, commands):
|
|
return self.shell.send(commands)
|
|
|
|
class NetworkModule(AnsibleModule):
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super(NetworkModule, 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 _load_params(self):
|
|
params = super(NetworkModule, self)._load_params()
|
|
provider = params.get('provider') or dict()
|
|
for key, value in provider.items():
|
|
if key in NET_COMMON_ARGS.keys():
|
|
params[key] = value
|
|
return params
|
|
|
|
def connect(self):
|
|
try:
|
|
self.connection = Cli(self)
|
|
self.connection.connect()
|
|
self.execute('terminal length 0')
|
|
|
|
if self.params['authorize']:
|
|
self.connection.authorize()
|
|
|
|
except Exception, exc:
|
|
self.fail_json(msg=exc.message)
|
|
|
|
def configure(self, commands):
|
|
commands = to_list(commands)
|
|
commands.insert(0, 'configure terminal')
|
|
responses = self.execute(commands)
|
|
responses.pop(0)
|
|
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):
|
|
cmd = 'show running-config'
|
|
if self.params.get('include_defaults'):
|
|
cmd += ' all'
|
|
return self.execute(cmd)[0]
|
|
|
|
def get_module(**kwargs):
|
|
"""Return instance of NetworkModule
|
|
"""
|
|
argument_spec = NET_COMMON_ARGS.copy()
|
|
if kwargs.get('argument_spec'):
|
|
argument_spec.update(kwargs['argument_spec'])
|
|
kwargs['argument_spec'] = argument_spec
|
|
|
|
module = NetworkModule(**kwargs)
|
|
|
|
# HAS_PARAMIKO is set by module_utils/shell.py
|
|
if not HAS_PARAMIKO:
|
|
module.fail_json(msg='paramiko is required but does not appear to be installed')
|
|
|
|
module.connect()
|
|
return module
|
|
|