Merge pull request #17188 from Qalthos/asa_module

Update module_utils/asa.py with NetworkModule
This commit is contained in:
Peter Sprygada 2016-08-24 13:04:40 -04:00 committed by GitHub
commit 8f79ea9b1d
2 changed files with 58 additions and 149 deletions

View file

@ -19,176 +19,70 @@
# #
import re import re
from ansible.module_utils.basic import AnsibleModule, env_fallback, get_exception
from ansible.module_utils.shell import Shell, ShellError, Command, HAS_PARAMIKO
from ansible.module_utils.netcfg import parse
NET_PASSWD_RE = re.compile(r"[\r\n]?password: $", re.I) from ansible.module_utils.network import add_argument, register_transport, to_list
from ansible.module_utils.shell import CliBase
NET_COMMON_ARGS = dict( # temporary fix until modules are update. to be removed before 2.2 final
host=dict(required=True), from ansible.module_utils.network import get_module
port=dict(default=22, type='int'),
show_command=dict(default='show running-config', choices=['show running-config', 'more system:running-config']),
username=dict(fallback=(env_fallback, ['ANSIBLE_NET_USERNAME'])),
password=dict(no_log=True, fallback=(env_fallback, ['ANSIBLE_NET_PASSWORD'])),
ssh_keyfile=dict(fallback=(env_fallback, ['ANSIBLE_NET_SSH_KEYFILE']), type='path'),
authorize=dict(default=False, fallback=(env_fallback, ['ANSIBLE_NET_AUTHORIZE']), type='bool'),
auth_pass=dict(no_log=True, fallback=(env_fallback, ['ANSIBLE_NET_AUTH_PASS'])),
context=dict(required=False),
provider=dict(),
timeout=dict(default=10, type='int')
)
CLI_PROMPTS_RE = [ add_argument('show_command', dict(default='show running-config', choices=['show running-config', 'more system:running-config']))
re.compile(r"[\r\n]?[\w+\-\.:\/\[\]]+(?:\([^\)]+\)){,3}(?:>|#) ?$"), add_argument('context', dict(required=False))
re.compile(r"\[\w+\@[\w\-\.]+(?: [^\]])\] ?[>#\$] ?$")
]
CLI_ERRORS_RE = [
re.compile(r"% ?Error"),
re.compile(r"% ?Bad secret"),
re.compile(r"invalid input", re.I),
re.compile(r"is not valid", 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+"),
]
def to_list(val): class Cli(CliBase):
if isinstance(val, (list, tuple)): CLI_PROMPTS_RE = [
return list(val) re.compile(r"[\r\n]?[\w+\-\.:\/\[\]]+(?:\([^\)]+\)){,3}(?:>|#) ?$"),
elif val is not None: re.compile(r"\[\w+\@[\w\-\.]+(?: [^\]])\] ?[>#\$] ?$")
return [val] ]
else:
return list()
CLI_ERRORS_RE = [
re.compile(r"% ?Error"),
re.compile(r"% ?Bad secret"),
re.compile(r"invalid input", re.I),
re.compile(r"is not valid", 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+"),
]
class Cli(object): NET_PASSWD_RE = re.compile(r"[\r\n]?password: $", re.I)
def __init__(self, module): def __init__(self, *args, **kwargs):
self.module = module super(Cli, self).__init__(*args, **kwargs)
self.shell = None self.filter = None
def connect(self, **kwargs): def connect(self, params, **kwargs):
host = self.module.params['host'] super(Cli, self).connect(params, kickstart=False, **kwargs)
port = self.module.params['port'] or 22 self.execute('no terminal pager')
username = self.module.params['username'] if params['context']:
password = self.module.params['password'] self.change_context(params, **kwargs)
key_filename = self.module.params['ssh_keyfile']
timeout = self.module.params['timeout']
try: def change_context(self, params, **kwargs):
self.shell = Shell(kickstart=False, prompts_re=CLI_PROMPTS_RE, context = params['context']
errors_re=CLI_ERRORS_RE)
self.shell.open(host, port=port, username=username, password=password, key_filename=key_filename, timeout=timeout)
except ShellError:
e = get_exception()
msg = 'failed to connect to %s:%s - %s' % (host, port, str(e))
self.module.fail_json(msg=msg)
def change_context(self):
context = self.module.params['command']
if context == 'system': if context == 'system':
command = 'changeto system' command = 'changeto system'
else: else:
command = 'changeto context %s' % context command = 'changeto context %s' % context
self.send(Command(command)) self.execute(command)
def authorize(self): ### Config methods ###
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
self._connected = False
self.filter = None
@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):
super(NetworkModule, self)._load_params()
provider = self.params.get('provider') or dict()
for key, value in provider.items():
if key in NET_COMMON_ARGS.keys():
if self.params.get(key) is None and value is not None:
self.params[key] = value
def connect(self):
self.connection = Cli(self)
self.connection.connect()
if self.params['authorize']:
self.connection.authorize()
self.connection.send('no terminal pager')
if self.params['context']:
if self.params['context'] == 'system':
self.connection.send('changeto system')
else:
self.connection.send('changeto context %s' % self.params['context'])
self._connected = True
def configure(self, commands): def configure(self, commands):
commands = to_list(commands) cmds = ['configure terminal']
commands.insert(0, 'configure terminal') cmds.extend(to_list(commands))
responses = self.execute(commands) responses = self.execute(cmds)
responses.pop(0) return responses[1:]
return responses
def execute(self, commands, **kwargs): def get_config(self, params, **kwargs):
if not self.connected:
self.connect()
return self.connection.send(commands, **kwargs)
def disconnect(self):
self.connection.close()
self._connected = False
def parse_config(self, cfg):
return parse(cfg, indent=1)
def get_config(self):
if self.filter: if self.filter:
cmd = 'show running-config %s ' % self.filter cmd = 'show running-config %s ' % self.filter
else: else:
cmd = self.params['show_command'] cmd = params['show_command']
if self.params.get('include_defaults'): if params.get('include_defaults'):
cmd += ' all' cmd += ' all'
return self.execute(cmd)[0] return self.execute(cmd)
Cli = register_transport('cli', default=True)(Cli)
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')
return module

View file

@ -231,6 +231,8 @@ class CliBase(object):
def authorize(self, params, **kwargs): def authorize(self, params, **kwargs):
pass pass
### Command methods ###
def execute(self, commands, **kwargs): def execute(self, commands, **kwargs):
try: try:
return self.shell.send(commands) return self.shell.send(commands)
@ -238,3 +240,16 @@ class CliBase(object):
exc = get_exception() exc = get_exception()
raise NetworkError(exc.message, commands=commands) raise NetworkError(exc.message, commands=commands)
def run_commands(self, commands, **kwargs):
return self.execute(to_list(commands))
### Config methods ###
def load_config(self, commands, **kwargs):
raise NotImplementedError
def replace_config(self, commands, **kwargs):
raise NotImplementedError
def save_config(self):
raise NotImplementedError