archive
/
ansible
mirror of https://github.com/ansible/ansible.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Net mod ios (#16426)

Browse Source 
* Update IOS with new NetworkModule

* Remove redundant EOS code

* `authorize` can get rolled into NetCli

* Fix up IOS to where EOS is.

* Update IOSXR for NetworkModule

* collections is unnecessary
pull/16636/head
Nathaniel Case 8 years ago committed by GitHub
parent 9a6b8ab271
commit 72204ddd3e
4 changed files with 100 additions and 292 deletions
Show Stats Download Patch File Download Diff File

16
lib/ansible/module_utils/eos.py
Unescape Escape View File

@ -20,20 +20,16 @@
import re import re
from ansible.module_utils.basic import json, get_exception, AnsibleModule 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.network import add_argument, register_transport, to_list
from ansible.module_utils.netcfg import NetworkConfig from ansible.module_utils.netcfg import NetworkConfig
from ansible.module_utils.urls import fetch_url, url_argument_spec 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'] EAPI_FORMATS = ['json', 'text']
add_argument('use_ssl', dict(default=True, type='bool')) add_argument('use_ssl', dict(default=True, type='bool'))
add_argument('validate_certs', dict(default=True, type='bool')) add_argument('validate_certs', dict(default=True, type='bool'))
ModuleStub = AnsibleModule
def argument_spec(): def argument_spec():
return dict( return dict(
# config options # config options
@ -204,7 +200,7 @@ class Eapi(EosConfigMixin):
def __init__(self): def __init__(self):
self.url = None 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.url_args.fail_json = self._error
self.enable = None self.enable = None
self.default_output = 'json' self.default_output = 'json'
@ -343,17 +339,11 @@ class Cli(NetCli, EosConfigMixin):
re.compile(r"[^\r\n]\/bin\/(?:ba)?sh") re.compile(r"[^\r\n]\/bin\/(?:ba)?sh")
] ]
def __init__(self): NET_PASSWD_RE = re.compile(r"[\r\n]?password: $", re.I)
super(Cli, self).__init__()
def connect(self, params, **kwargs): def connect(self, params, **kwargs):
super(Cli, self).connect(params, kickstart=True, **kwargs) super(Cli, self).connect(params, kickstart=True, **kwargs)
self.shell.send('terminal length 0') 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 ### ### implementation of network.Cli ###

202
lib/ansible/module_utils/ios.py
Unescape Escape View File

@ -19,163 +19,61 @@
import re import re
from ansible.module_utils.basic import AnsibleModule, env_fallback, get_exception from ansible.module_utils.network import Command, NetCli, NetworkError, get_module
from ansible.module_utils.shell import Shell, ShellError, Command, HAS_PARAMIKO from ansible.module_utils.network import register_transport, to_list
from ansible.module_utils.netcfg import parse
class Cli(NetCli):
NET_PASSWD_RE = re.compile(r"[\r\n]?password: $", re.I) CLI_PROMPTS_RE = [
re.compile(r"[\r\n]?[\w+\-\.:\/\[\]]+(?:\([^\)]+\)){,3}(?:>|#) ?$"),
NET_COMMON_ARGS = dict( re.compile(r"\[\w+\@[\w\-\.]+(?: [^\]])\] ?[>#\$] ?$")
host=dict(required=True), ]
port=dict(default=22, type='int'),
username=dict(fallback=(env_fallback, ['ANSIBLE_NET_USERNAME'])), CLI_ERRORS_RE = [
password=dict(no_log=True, fallback=(env_fallback, ['ANSIBLE_NET_PASSWORD'])), re.compile(r"% ?Error"),
ssh_keyfile=dict(fallback=(env_fallback, ['ANSIBLE_NET_SSH_KEYFILE']), type='path'), re.compile(r"% ?Bad secret"),
authorize=dict(default=False, fallback=(env_fallback, ['ANSIBLE_NET_AUTHORIZE']), type='bool'), re.compile(r"invalid input", re.I),
auth_pass=dict(no_log=True, fallback=(env_fallback, ['ANSIBLE_NET_AUTH_PASS'])), re.compile(r"(?:incomplete|ambiguous) command", re.I),
provider=dict(), re.compile(r"connection timed out", re.I),
timeout=dict(default=10, type='int') re.compile(r"[^\r\n]+ not found", re.I),
) re.compile(r"'[^']' +returned error code: ?\d+"),
]
CLI_PROMPTS_RE = [
re.compile(r"[\r\n]?[\w+\-\.:\/\[\]]+(?:\([^\)]+\)){,3}(?:>|#) ?$"), NET_PASSWD_RE = re.compile(r"[\r\n]?password: $", re.I)
re.compile(r"\[\w+\@[\w\-\.]+(?: [^\]])\] ?[>#\$] ?$")
] def connect(self, params, **kwargs):
super(Cli, self).connect(params, kickstart=False, **kwargs)
CLI_ERRORS_RE = [ self.shell.send('terminal length 0')
re.compile(r"% ?Error"),
re.compile(r"% ?Bad secret"), ### implementation of network.Cli ###
re.compile(r"invalid input", re.I),
re.compile(r"(?:incomplete|ambiguous) command", re.I), def configure(self, commands, **kwargs):
re.compile(r"connection timed out", re.I), cmds = ['configure terminal']
re.compile(r"[^\r\n]+ not found", re.I), cmds.extend(to_list(commands))
re.compile(r"'[^']' +returned error code: ?\d+"), cmds.append('end')
]
responses = self.execute(cmds)
return responses[1:-1]
def to_list(val):
if isinstance(val, (list, tuple)): def get_config(self, params, **kwargs):
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):
cmd = 'show running-config' cmd = 'show running-config'
if self.params.get('include_defaults'): if params.get('include_defaults'):
cmd += ' all' cmd += ' all'
return self.execute(cmd)[0] return self.execute(cmd)[0]
def load_config(self, commands, commit=False, **kwargs):
raise NotImplementedError
def get_module(**kwargs): def replace_config(self, commands, **kwargs):
"""Return instance of NetworkModule raise NotImplementedError
"""
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) def commit_config(self, **kwargs):
raise NotImplementedError
if not HAS_PARAMIKO: def abort_config(self, **kwargs):
module.fail_json(msg='paramiko is required but does not appear to be installed') 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)

170
lib/ansible/module_utils/iosxr.py
Unescape Escape View File

@ -19,144 +19,60 @@
import re import re
from ansible.module_utils.basic import AnsibleModule, env_fallback, get_exception from ansible.module_utils.network import Command, NetCli, NetworkError, get_module
from ansible.module_utils.shell import Shell, ShellError, HAS_PARAMIKO from ansible.module_utils.network import register_transport, to_list
from ansible.module_utils.netcfg import parse
NET_PASSWD_RE = re.compile(r"[\r\n]?password: $", re.I) class Cli(NetCli):
CLI_PROMPTS_RE = [
re.compile(r"[\r\n]?[\w+\-\.:\/\[\]]+(?:\([^\)]+\)){,3}(?:>|#) ?$"),
re.compile(r"\[\w+\@[\w\-\.]+(?: [^\]])\] ?[>#\$] ?$")
]
NET_COMMON_ARGS = dict( CLI_ERRORS_RE = [
host=dict(required=True), re.compile(r"% ?Error"),
port=dict(default=22, type='int'), re.compile(r"% ?Bad secret"),
username=dict(fallback=(env_fallback, ['ANSIBLE_NET_USERNAME'])), re.compile(r"invalid input", re.I),
password=dict(no_log=True, fallback=(env_fallback, ['ANSIBLE_NET_PASSWORD'])), re.compile(r"(?:incomplete|ambiguous) command", re.I),
ssh_keyfile=dict(fallback=(env_fallback, ['ANSIBLE_NET_SSH_KEYFILE']), type='path'), re.compile(r"connection timed out", re.I),
provider=dict() re.compile(r"[^\r\n]+ not found", re.I),
) re.compile(r"'[^']' +returned error code: ?\d+"),
]
CLI_PROMPTS_RE = [ NET_PASSWD_RE = re.compile(r"[\r\n]?password: $", re.I)
re.compile(r"[\r\n]?[\w+\-\.:\/\[\]]+(?:\([^\)]+\)){,3}(?:>|#) ?$"),
re.compile(r"\[\w+\@[\w\-\.]+(?: [^\]])\] ?[>#\$] ?$")
]
CLI_ERRORS_RE = [ def connect(self, params, **kwargs):
re.compile(r"% ?Error"), super(Cli, self).connect(params, kickstart=False, **kwargs)
re.compile(r"% ?Bad secret"), self.shell.send('terminal length 0')
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+"),
]
### implementation of network.Cli ###
def to_list(val): def configure(self, commands, **kwargs):
if isinstance(val, (list, tuple)): cmds = ['configure']
return list(val) cmds.extend(to_list(commands))
elif val is not None: cmds.append('end')
return [val]
else:
return list()
responses = self.execute(cmds)
return responses[1:-1]
class Cli(object): def get_config(self, params, **kwargs):
return self.run_commands('show running-config')[0]
def __init__(self, module): def load_config(self, commands, commit=False, **kwargs):
self.module = module raise NotImplementedError
self.shell = None
def connect(self, **kwargs): def replace_config(self, commands, **kwargs):
host = self.module.params['host'] raise NotImplementedError
port = self.module.params['port'] or 22
username = self.module.params['username'] def commit_config(self, **kwargs):
password = self.module.params['password'] command = 'commit'
key_filename = self.module.params['ssh_keyfile'] self.run_commands([command])
try: def abort_config(self, **kwargs):
self.shell = Shell(kickstart=False, prompts_re=CLI_PROMPTS_RE, errors_re=CLI_ERRORS_RE) command = 'abort'
self.shell.open(host, port=port, username=username, password=password, key_filename=key_filename) self.run_commands([command])
except ShellError:
e = get_exception()
msg = 'failed to connect to %s:%s - %s' % (host, port, str(e))
self.module.fail_json(msg=msg)
def send(self, commands): def run_commands(self, commands):
try: cmds = to_list(commands)
return self.shell.send(commands) responses = self.execute(cmds)
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')
self._connected = True
def configure(self, commands):
commands = to_list(commands)
commands.insert(0, 'configure terminal')
commands.append('commit')
responses = self.execute(commands)
responses.pop(0)
responses.pop()
return responses return responses
Cli = register_transport('cli', default=True)(Cli)
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):
return self.execute('show running-config')[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)
if not HAS_PARAMIKO:
module.fail_json(msg='paramiko is required but does not appear to be installed')
return module

4
lib/ansible/module_utils/network.py
Unescape Escape View File

@ -237,6 +237,10 @@ class NetCli(object):
self._connected = False self._connected = False
self.shell.close() self.shell.close()
def authorize(self, params, **kwargs):
passwd = params['auth_pass']
self.execute(Command('enable', prompt=self.NET_PASSWD_RE, response=passwd))
def execute(self, commands, **kwargs): def execute(self, commands, **kwargs):
try: try:
return self.shell.send(commands) return self.shell.send(commands)

Write Preview
Loading…
Cancel
Save