Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update module_utils/asa.py with NetworkModule #17188

Merged
merged 3 commits into from
Aug 24, 2016
+64 −155
Merged

Update module_utils/asa.py with NetworkModule #17188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f4a6fa1
Rewrite asa.py for NetworkModule
Qalthos Aug 22, 2016
a35296a
Common CliBase run_commands implementation
Qalthos Aug 22, 2016
f5ff3e3
Remove abort_config and commit_config
Qalthos Aug 23, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
204 changes: 49 additions & 155 deletions lib/ansible/module_utils/asa.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,176 +19,70 @@
#

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)

NET_COMMON_ARGS = dict(
host=dict(required=True),
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 = [
re.compile(r"[\r\n]?[\w+\-\.:\/\[\]]+(?:\([^\)]+\)){,3}(?:>|#) ?$"),
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):
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']
key_filename = self.module.params['ssh_keyfile']
timeout = self.module.params['timeout']

try:
self.shell = Shell(kickstart=False, prompts_re=CLI_PROMPTS_RE,
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':
command = 'changeto system'
else:
command = 'changeto context %s' % context

self.send(Command(command))
from ansible.module_utils.network import add_argument, register_transport, to_list
from ansible.module_utils.shell import CliBase

# temporary fix until modules are update. to be removed before 2.2 final
from ansible.module_utils.network import get_module

def authorize(self):
passwd = self.module.params['auth_pass']
self.send(Command('enable', prompt=NET_PASSWD_RE, response=passwd))
add_argument('show_command', dict(default='show running-config', choices=['show running-config', 'more system:running-config']))
add_argument('context', dict(required=False))

def send(self, commands):
return self.shell.send(commands)

class Cli(CliBase):
CLI_PROMPTS_RE = [
re.compile(r"[\r\n]?[\w+\-\.:\/\[\]]+(?:\([^\)]+\)){,3}(?:>|#) ?$"),
re.compile(r"\[\w+\@[\w\-\.]+(?: [^\]])\] ?[>#\$] ?$")
]

class NetworkModule(AnsibleModule):
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+"),
]

NET_PASSWD_RE = re.compile(r"[\r\n]?password: $", re.I)

def __init__(self, *args, **kwargs):
super(NetworkModule, self).__init__(*args, **kwargs)
self.connection = None
self._config = None
self._connected = False
super(Cli, self).__init__(*args, **kwargs)
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 connect(self, params, **kwargs):
super(Cli, self).connect(params, kickstart=False, **kwargs)
self.execute('no terminal pager')

def configure(self, commands):
commands = to_list(commands)
commands.insert(0, 'configure terminal')
responses = self.execute(commands)
responses.pop(0)
return responses
if params['context']:
self.change_context(params, **kwargs)

def change_context(self, params, **kwargs):
context = params['context']
if context == 'system':
command = 'changeto system'
else:
command = 'changeto context %s' % context

def execute(self, commands, **kwargs):
if not self.connected:
self.connect()
return self.connection.send(commands, **kwargs)
self.execute(command)

def disconnect(self):
self.connection.close()
self._connected = False
### Config methods ###

def parse_config(self, cfg):
return parse(cfg, indent=1)
def configure(self, commands):
cmds = ['configure terminal']
cmds.extend(to_list(commands))
responses = self.execute(cmds)
return responses[1:]

def get_config(self):
def get_config(self, params, **kwargs):
if self.filter:
cmd = 'show running-config %s ' % self.filter
else:
cmd = self.params['show_command']
if self.params.get('include_defaults'):
cmd = params['show_command']
if 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')

return module
return self.execute(cmd)
Cli = register_transport('cli', default=True)(Cli)
15 changes: 15 additions & 0 deletions lib/ansible/module_utils/shell.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,10 +231,25 @@ def disconnect(self, **kwargs):
def authorize(self, params, **kwargs):
pass

### Command methods ###

def execute(self, commands, **kwargs):
try:
return self.shell.send(commands)
except ShellError:
exc = get_exception()
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