initial add of junos_command module
This adds a new module, junos_command that can be used for sending commands to Juniper JUNOS based devices. The junos_command module is implemented over a cli transport
This commit is contained in:
Peter Sprygada
parent
38d6c1cd36
commit
8c46a08379
1 changed files with 269 additions and 0 deletions
269
network/junos/junos_command.py
Normal file
269
network/junos/junos_command.py
Normal file
|
|
@ -0,0 +1,269 @@
|
|||
#!/usr/bin/python
|
||||
#
|
||||
# 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/>.
|
||||
#
|
||||
|
||||
DOCUMENTATION = """
|
||||
---
|
||||
module: junos_command
|
||||
version_added: "2.1"
|
||||
author: "Peter sprygada (@privateip)"
|
||||
short_description: Execute arbitrary commands on Juniper JUNOS devices
|
||||
description:
|
||||
- Netork devices running Juniper JUNOS can execute a variety of commands
|
||||
to display both configuration and state data. This module will take
|
||||
an ordered set of commands and execute them in JUNOS and return the
|
||||
command results. It also supports adding conditionals the
|
||||
argument set to force the module to meet a set of criteria before
|
||||
proceeding.
|
||||
extends_documentation_fragment: junos
|
||||
options:
|
||||
commands:
|
||||
description:
|
||||
- The commands to send to the remote JUNOS device over the
|
||||
configured provider. The resulting output from the command
|
||||
is returned. If the I(waitfor) argument is provided, the
|
||||
module is not returned until the condition is satisfied or
|
||||
the number of retires as expired.
|
||||
required: true
|
||||
waitfor:
|
||||
description:
|
||||
- Specifies what to evaluate from the output of the command
|
||||
and what conditionals to apply. This argument will cause
|
||||
the task to wait for a particular conditional to be true
|
||||
before moving forward. If the conditional is not true
|
||||
by the configured retries, the task fails. See examples.
|
||||
required: false
|
||||
default: null
|
||||
retries:
|
||||
description:
|
||||
- Specifies the number of retries a command should by tried
|
||||
before it is considered failed. The command is run on the
|
||||
target device every retry and evaluated against the waitfor
|
||||
conditionals
|
||||
required: false
|
||||
default: 10
|
||||
interval:
|
||||
description:
|
||||
- Configures the interval in seconds to wait between retries
|
||||
of the command. If the command does not pass the specified
|
||||
conditional, the interval indicates how to long to wait before
|
||||
trying the command again.
|
||||
required: false
|
||||
default: 1
|
||||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
# the required set of connection arguments have been purposely left off
|
||||
# the examples for brevity
|
||||
|
||||
- name: run a set of commands
|
||||
junos_command:
|
||||
commands: ['show version', 'show ip route']
|
||||
|
||||
- name: run a command with a conditional applied to the second command
|
||||
junos_command:
|
||||
commands:
|
||||
- show version
|
||||
- show interfaces fxp0 | display json
|
||||
waitfor:
|
||||
- "result[1].interface-information[0].physical-interface[0].name[0].data
|
||||
eq fxp0"
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
stdout:
|
||||
description: The output from the commands read from the device
|
||||
returned: always
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
|
||||
stdout_lines:
|
||||
description: The output read from the device split into lines
|
||||
returned: always
|
||||
type: list
|
||||
sample: [['...', '...'], ['...', '...']]
|
||||
|
||||
failed_conditionals:
|
||||
description: the conditionals that failed
|
||||
retured: failed
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
"""
|
||||
|
||||
import time
|
||||
import shlex
|
||||
import re
|
||||
import json
|
||||
import itertools
|
||||
|
||||
INDEX_RE = re.compile(r'(\[\d+\])')
|
||||
|
||||
class Conditional(object):
|
||||
|
||||
OPERATORS = {
|
||||
'eq': ['eq', '=='],
|
||||
'neq': ['neq', 'ne', '!='],
|
||||
'gt': ['gt', '>'],
|
||||
'ge': ['ge', '>='],
|
||||
'lt': ['lt', '<'],
|
||||
'le': ['le', '<='],
|
||||
'contains': ['contains', 'in']
|
||||
}
|
||||
|
||||
def __init__(self, conditional):
|
||||
self.raw = conditional
|
||||
|
||||
key, op, val = shlex.split(conditional)
|
||||
self.key = key
|
||||
self.func = self.func(op)
|
||||
self.value = self._cast_value(val)
|
||||
|
||||
def __call__(self, data):
|
||||
try:
|
||||
value = self.get_value(dict(result=data))
|
||||
return self.func(value)
|
||||
except Exception:
|
||||
raise
|
||||
|
||||
def _cast_value(self, value):
|
||||
if value in BOOLEANS_TRUE:
|
||||
return True
|
||||
elif value in BOOLEANS_FALSE:
|
||||
return False
|
||||
elif re.match(r'^\d+\.d+$', value):
|
||||
return float(value)
|
||||
elif re.match(r'^\d+$', value):
|
||||
return int(value)
|
||||
else:
|
||||
return unicode(value)
|
||||
|
||||
def func(self, oper):
|
||||
for func, operators in self.OPERATORS.items():
|
||||
if oper in operators:
|
||||
return getattr(self, func)
|
||||
raise AttributeError('unknown operator: %s' % oper)
|
||||
|
||||
def get_value(self, result):
|
||||
for key in self.key.split('.'):
|
||||
match = re.match(r'^(.+)\[(\d+)\]', key)
|
||||
if match:
|
||||
key, index = match.groups()
|
||||
result = result[key][int(index)]
|
||||
else:
|
||||
result = result.get(key)
|
||||
return result
|
||||
|
||||
def number(self, value):
|
||||
if '.' in str(value):
|
||||
return float(value)
|
||||
else:
|
||||
return int(value)
|
||||
|
||||
def eq(self, value):
|
||||
return value == self.value
|
||||
|
||||
def neq(self, value):
|
||||
return value != self.value
|
||||
|
||||
def gt(self, value):
|
||||
return self.number(value) > self.value
|
||||
|
||||
def ge(self, value):
|
||||
return self.number(value) >= self.value
|
||||
|
||||
def lt(self, value):
|
||||
return self.number(value) < self.value
|
||||
|
||||
def le(self, value):
|
||||
return self.number(value) <= self.value
|
||||
|
||||
def contains(self, value):
|
||||
return self.value in value
|
||||
|
||||
def parse_response(module, responses):
|
||||
commands = module.params['commands']
|
||||
result = dict(stdout_json=list(), stdout=list(), stdout_lines=list())
|
||||
for cmd, resp in itertools.izip(commands, responses):
|
||||
result['stdout'].append(resp)
|
||||
if cmd.endswith('json'):
|
||||
result['stdout_json'].append(module.jsonify(resp))
|
||||
else:
|
||||
result['stdout_lines'].append(resp.split('\n'))
|
||||
return result
|
||||
|
||||
def main():
|
||||
spec = dict(
|
||||
commands=dict(type='list'),
|
||||
waitfor=dict(type='list'),
|
||||
retries=dict(default=10, type='int'),
|
||||
interval=dict(default=1, type='int')
|
||||
)
|
||||
|
||||
module = get_module(argument_spec=spec,
|
||||
supports_check_mode=True)
|
||||
|
||||
|
||||
commands = module.params['commands']
|
||||
|
||||
retries = module.params['retries']
|
||||
interval = module.params['interval']
|
||||
|
||||
try:
|
||||
queue = set()
|
||||
for entry in (module.params['waitfor'] or list()):
|
||||
queue.add(Conditional(entry))
|
||||
except AttributeError, exc:
|
||||
module.fail_json(msg=exc.message)
|
||||
|
||||
result = dict(changed=False, stdout=list(), stdout_lines=list())
|
||||
|
||||
while retries > 0:
|
||||
try:
|
||||
response = module.execute(commands)
|
||||
except ShellError:
|
||||
module.fail_json(msg='failed to run commands')
|
||||
|
||||
values = list()
|
||||
for index, cmd in enumerate(commands):
|
||||
if cmd.endswith('json'):
|
||||
values.append(module.from_json(response[index]))
|
||||
else:
|
||||
values.append(response[index])
|
||||
|
||||
for item in list(queue):
|
||||
if item(values):
|
||||
queue.remove(item)
|
||||
|
||||
if not queue:
|
||||
break
|
||||
|
||||
time.sleep(interval)
|
||||
retries -= 1
|
||||
else:
|
||||
failed_conditions = [item.raw for item in queue]
|
||||
module.fail_json(msg='timeout waiting for value', failed_conditions=failed_conditions)
|
||||
|
||||
result.update(parse_response(module, response))
|
||||
return module.exit_json(**result)
|
||||
|
||||
|
||||
from ansible.module_utils.basic import *
|
||||
from ansible.module_utils.shell import *
|
||||
from ansible.module_utils.junos import *
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
|
||||
Loading…
Reference in a new issue