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

Net mod ios #16426

Merged
merged 6 commits into from
Jul 7, 2016
Merged

Net mod ios #16426

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4656bd4
Update IOS with new NetworkModule
Qalthos May 3, 2016
094e9f5
Remove redundant EOS code
Qalthos Jun 23, 2016
5adca6d
`authorize` can get rolled into NetCli
Qalthos Jun 23, 2016
04025bd
Fix up IOS to where EOS is.
Qalthos Jun 23, 2016
ba975cd
Update IOSXR for NetworkModule
Qalthos May 3, 2016
c38389c
collections is unnecessary
Qalthos Jul 6, 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
16 changes: 3 additions & 13 deletions lib/ansible/module_utils/eos.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,16 @@
import re

from ansible.module_utils.basic import json, get_exception, AnsibleModule
from ansible.module_utils.network import NetCli, NetworkError, get_module, Command
from ansible.module_utils.network import Command, NetCli, NetworkError, get_module
from ansible.module_utils.network import add_argument, register_transport, to_list
from ansible.module_utils.netcfg import NetworkConfig
from ansible.module_utils.urls import fetch_url, url_argument_spec

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

EAPI_FORMATS = ['json', 'text']

add_argument('use_ssl', dict(default=True, type='bool'))
add_argument('validate_certs', dict(default=True, type='bool'))

ModuleStub = AnsibleModule

def argument_spec():
return dict(
# config options
Expand Down Expand Up @@ -204,7 +200,7 @@ class Eapi(EosConfigMixin):

def __init__(self):
self.url = None
self.url_args = ModuleStub(url_argument_spec())
self.url_args = AnsibleModule(url_argument_spec())
self.url_args.fail_json = self._error
self.enable = None
self.default_output = 'json'
Expand Down Expand Up @@ -343,17 +339,11 @@ class Cli(NetCli, EosConfigMixin):
re.compile(r"[^\r\n]\/bin\/(?:ba)?sh")
]

def __init__(self):
super(Cli, self).__init__()
NET_PASSWD_RE = re.compile(r"[\r\n]?password: $", re.I)

def connect(self, params, **kwargs):
super(Cli, self).connect(params, kickstart=True, **kwargs)
self.shell.send('terminal length 0')
self._connected = True

def authorize(self, params, **kwargs):
passwd = params['auth_pass']
self.execute(Command('enable', prompt=NET_PASSWD_RE, response=passwd))

### implementation of network.Cli ###

Expand Down
202 changes: 50 additions & 152 deletions lib/ansible/module_utils/ios.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,163 +19,61 @@

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'),
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'])),
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"(?: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']

allow_agent = (key_filename is not None) or (key_filename is None and password is None)

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,
allow_agent=allow_agent, 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 authorize(self):
passwd = self.module.params['auth_pass']
self.send(Command('enable', prompt=NET_PASSWD_RE, response=passwd))

def send(self, commands):
try:
return self.shell.send(commands)
except ShellError:
e = get_exception()
self.module.fail_json(msg=e.message, commands=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):
super(NetworkModule, self)._load_params()
provider = self.params.get('provider') or dict()
for key, value in provider.items():
if key in NET_COMMON_ARGS:
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()
self.connection.send('terminal length 0')

if self.params['authorize']:
self.connection.authorize()

self._connected = True

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):
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):
from ansible.module_utils.network import Command, NetCli, NetworkError, get_module
from ansible.module_utils.network import register_transport, to_list

class Cli(NetCli):
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"(?: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 connect(self, params, **kwargs):
super(Cli, self).connect(params, kickstart=False, **kwargs)
self.shell.send('terminal length 0')

### implementation of network.Cli ###

def configure(self, commands, **kwargs):
cmds = ['configure terminal']
cmds.extend(to_list(commands))
cmds.append('end')

responses = self.execute(cmds)
return responses[1:-1]

def get_config(self, params, **kwargs):
cmd = 'show running-config'
if self.params.get('include_defaults'):
if params.get('include_defaults'):
cmd += ' all'
return self.execute(cmd)[0]

def load_config(self, commands, commit=False, **kwargs):
raise NotImplementedError

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
def replace_config(self, commands, **kwargs):
raise NotImplementedError

module = NetworkModule(**kwargs)
def commit_config(self, **kwargs):
raise NotImplementedError

if not HAS_PARAMIKO:
module.fail_json(msg='paramiko is required but does not appear to be installed')
def abort_config(self, **kwargs):
raise NotImplementedError

return module
def run_commands(self, commands):
cmds = to_list(commands)
responses = self.execute(cmds)
return responses
Cli = register_transport('cli', default=True)(Cli)