mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
008395eda2
this fixes a bug in nxos shared module to not immediately send a \n when the connection is made. this commit also localizes the prompt handling to the nxos module
263 lines
7.9 KiB
Python
263 lines
7.9 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(type='int'),
|
|
username=dict(required=True),
|
|
password=dict(no_log=True),
|
|
transport=dict(default='cli', choices=['cli', 'nxapi']),
|
|
use_ssl=dict(default=False, type='bool'),
|
|
validate_certs=dict(default=True, type='bool'),
|
|
provider=dict(type='dict')
|
|
)
|
|
|
|
NXAPI_COMMAND_TYPES = ['cli_show', 'cli_show_ascii', 'cli_conf', 'bash']
|
|
|
|
NXAPI_ENCODINGS = ['json', 'xml']
|
|
|
|
CLI_PROMPTS_RE = [
|
|
re.compile(r'[\r\n]?[a-zA-Z]{1}[a-zA-Z0-9-]*[>|#|%](?:\s*)$'),
|
|
re.compile(r'[\r\n]?[a-zA-Z]{1}[a-zA-Z0-9-]*\(.+\)#(?:\s*)$')
|
|
]
|
|
|
|
CLI_ERRORS_RE = [
|
|
re.compile(r"% ?Error"),
|
|
re.compile(r"^% \w+", re.M),
|
|
re.compile(r"% ?Bad secret"),
|
|
re.compile(r"invalid input", re.I),
|
|
re.compile(r"(?:incomplete|ambiguous) command", re.I),
|
|
re.compile(r"connection timed out", re.I),
|
|
re.compile(r"[^\r\n]+ not found", re.I),
|
|
re.compile(r"'[^']' +returned error code: ?\d+"),
|
|
re.compile(r"syntax error"),
|
|
re.compile(r"unknown command")
|
|
]
|
|
|
|
def to_list(val):
|
|
if isinstance(val, (list, tuple)):
|
|
return list(val)
|
|
elif val is not None:
|
|
return [val]
|
|
else:
|
|
return list()
|
|
|
|
class Nxapi(object):
|
|
|
|
def __init__(self, module):
|
|
self.module = module
|
|
|
|
# sets the module_utils/urls.py req parameters
|
|
self.module.params['url_username'] = module.params['username']
|
|
self.module.params['url_password'] = module.params['password']
|
|
|
|
self.url = None
|
|
self._nxapi_auth = None
|
|
|
|
def _get_body(self, commands, command_type, encoding, version='1.2', chunk='0', sid=None):
|
|
"""Encodes a NXAPI JSON request message
|
|
"""
|
|
if isinstance(commands, (list, set, tuple)):
|
|
commands = ' ;'.join(commands)
|
|
|
|
if encoding not in NXAPI_ENCODINGS:
|
|
msg = 'invalid encoding, received %s, exceped one of %s' % \
|
|
(encoding, ','.join(NXAPI_ENCODINGS))
|
|
self.module_fail_json(msg=msg)
|
|
|
|
msg = {
|
|
'version': version,
|
|
'type': command_type,
|
|
'chunk': chunk,
|
|
'sid': sid,
|
|
'input': commands,
|
|
'output_format': encoding
|
|
}
|
|
return dict(ins_api=msg)
|
|
|
|
def connect(self):
|
|
host = self.module.params['host']
|
|
port = self.module.params['port']
|
|
|
|
if self.module.params['use_ssl']:
|
|
proto = 'https'
|
|
if not port:
|
|
port = 443
|
|
else:
|
|
proto = 'http'
|
|
if not port:
|
|
port = 80
|
|
|
|
self.url = '%s://%s:%s/ins' % (proto, host, port)
|
|
|
|
def send(self, commands, command_type='cli_show_ascii', encoding='json'):
|
|
"""Send commands to the device.
|
|
"""
|
|
clist = to_list(commands)
|
|
|
|
if command_type not in NXAPI_COMMAND_TYPES:
|
|
msg = 'invalid command_type, received %s, exceped one of %s' % \
|
|
(command_type, ','.join(NXAPI_COMMAND_TYPES))
|
|
self.module_fail_json(msg=msg)
|
|
|
|
debug = dict()
|
|
|
|
data = self._get_body(clist, command_type, encoding)
|
|
data = self.module.jsonify(data)
|
|
|
|
headers = {'Content-Type': 'application/json'}
|
|
if self._nxapi_auth:
|
|
headers['Cookie'] = self._nxapi_auth
|
|
|
|
response, headers = fetch_url(self.module, self.url, data=data,
|
|
headers=headers, method='POST')
|
|
|
|
self._nxapi_auth = headers.get('set-cookie')
|
|
|
|
if headers['status'] != 200:
|
|
self.module.fail_json(**headers)
|
|
|
|
response = self.module.from_json(response.read())
|
|
result = list()
|
|
|
|
output = response['ins_api']['outputs']['output']
|
|
for item in to_list(output):
|
|
if item['code'] != '200':
|
|
self.module.fail_json(**item)
|
|
else:
|
|
result.append(item['body'])
|
|
|
|
return result
|
|
|
|
|
|
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']
|
|
|
|
try:
|
|
self.shell = Shell(prompts_re=CLI_PROMPTS_RE, errors_re=CLI_ERRORS_RE,
|
|
kickstart=False)
|
|
self.shell.open(host, port=port, username=username, password=password)
|
|
except Exception, exc:
|
|
msg = 'failed to connect to %s:%s - %s' % (host, port, str(exc))
|
|
self.module.fail_json(msg=msg)
|
|
|
|
def send(self, commands, encoding='text'):
|
|
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
|
|
self._connected = False
|
|
|
|
@property
|
|
def connected(self):
|
|
return self._connected
|
|
|
|
@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():
|
|
if not params.get(key) and value is not None:
|
|
params[key] = value
|
|
return params
|
|
|
|
def connect(self):
|
|
if self.params['transport'] == 'nxapi':
|
|
self.connection = Nxapi(self)
|
|
else:
|
|
self.connection = Cli(self)
|
|
|
|
self.connection.connect()
|
|
|
|
if self.params['transport'] == 'cli':
|
|
self.connection.send('terminal length 0')
|
|
|
|
self._connected = True
|
|
|
|
|
|
def configure_cli(self, commands):
|
|
commands = to_list(commands)
|
|
commands.insert(0, 'configure')
|
|
responses = self.execute(commands)
|
|
responses.pop(0)
|
|
return responses
|
|
|
|
def configure(self, commands):
|
|
commands = to_list(commands)
|
|
if self.params['transport'] == 'cli':
|
|
return self.configure_cli(commands)
|
|
else:
|
|
return self.execute(commands, command_type='cli_conf')
|
|
|
|
def execute(self, commands, **kwargs):
|
|
if not self.connected:
|
|
self.connect()
|
|
return self.connection.send(commands, **kwargs)
|
|
|
|
def disconnect(self):
|
|
self.connection.close()
|
|
|
|
def parse_config(self, cfg):
|
|
return parse(cfg, indent=2)
|
|
|
|
def get_config(self):
|
|
cmd = 'show running-config'
|
|
if self.params.get('include_defaults'):
|
|
cmd += ' all'
|
|
response = self.execute(cmd)
|
|
return response[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 module.params['transport'] == 'cli' and not HAS_PARAMIKO:
|
|
module.fail_json(msg='paramiko is required but does not appear to be installed')
|
|
|
|
return module
|