mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-05-28 03:49:09 -07:00
vyos_command 2.3 (#18994)
* Peter's new module_utils/vyos * Update vyos_command * Restore `set terminal length $ANSIBLE_VYOS_TERMINAL_LENGTH` in vyos * vyos_command tests * Remove provider mentions from vyos_command * Extend get_config to take (and cache) various `show configuration` commands
This commit is contained in:
Nathaniel Case
GitHub
parent
cfed617dba
commit
b3662fdad1
5 changed files with 348 additions and 91 deletions
|
|
@ -16,15 +16,17 @@
|
|||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
#
|
||||
|
||||
ANSIBLE_METADATA = {'status': ['preview'],
|
||||
'supported_by': 'community',
|
||||
'version': '1.0'}
|
||||
ANSIBLE_METADATA = {
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community',
|
||||
'version': '1.0',
|
||||
}
|
||||
|
||||
DOCUMENTATION = """
|
||||
---
|
||||
module: vyos_command
|
||||
version_added: "2.2"
|
||||
author: "Peter Sprygada (@privateip)"
|
||||
author: "Nathaniel Case (@qalthos)"
|
||||
short_description: Run one or more commands on VyOS devices
|
||||
description:
|
||||
- The command module allows running one or more commands on remote
|
||||
|
|
@ -36,7 +38,6 @@ description:
|
|||
use a custom pager that can cause this module to hang. If the
|
||||
value of the environment variable C(ANSIBLE_VYOS_TERMINAL_LENGTH)
|
||||
is not set, the default number of 10000 is used.
|
||||
extends_documentation_fragment: vyos
|
||||
options:
|
||||
commands:
|
||||
description:
|
||||
|
|
@ -70,7 +71,7 @@ options:
|
|||
retries:
|
||||
description:
|
||||
- Specifies the number of retries a command should be tried
|
||||
before it is considered failed. The command is run on the
|
||||
before it is considered failed. The command is run on the
|
||||
target device every retry and evaluated against the I(wait_for)
|
||||
conditionals.
|
||||
required: false
|
||||
|
|
@ -78,8 +79,8 @@ options:
|
|||
interval:
|
||||
description:
|
||||
- Configures the interval in seconds to wait between I(retries)
|
||||
of the command. If the command does not pass the specified
|
||||
conditional, the interval indicates how to long to wait before
|
||||
of the command. If the command does not pass the specified
|
||||
conditions, the interval indicates how long to wait before
|
||||
trying the command again.
|
||||
required: false
|
||||
default: 1
|
||||
|
|
@ -90,30 +91,22 @@ notes:
|
|||
"""
|
||||
|
||||
EXAMPLES = """
|
||||
# Note: examples below use the following provider dict to handle
|
||||
# transport and authentication to the node.
|
||||
vars:
|
||||
cli:
|
||||
host: "{{ inventory_hostname }}"
|
||||
username: vyos
|
||||
password: vyos
|
||||
transport: cli
|
||||
tasks:
|
||||
- name: show configuration on ethernet devices eth0 and eth1
|
||||
vyos_command:
|
||||
commands:
|
||||
- show interfaces ethernet {{ item }}
|
||||
with_items:
|
||||
- eth0
|
||||
- eth1
|
||||
|
||||
- vyos_command:
|
||||
commands:
|
||||
- show interfaces ethernet {{ item }}
|
||||
provider: "{{ cli }}"
|
||||
with_items:
|
||||
- eth0
|
||||
- eth1
|
||||
|
||||
- vyos_command:
|
||||
commands:
|
||||
- show version
|
||||
- show hardware cpu
|
||||
wait_for:
|
||||
- "result[0] contains 'VyOS 1.1.7'"
|
||||
provider: "{{ cli }}"
|
||||
- name: run multiple commands and check if version output contains specific version string
|
||||
vyos_command:
|
||||
commands:
|
||||
- show version
|
||||
- show hardware cpu
|
||||
wait_for:
|
||||
- "result[0] contains 'VyOS 1.1.7'"
|
||||
"""
|
||||
|
||||
RETURN = """
|
||||
|
|
@ -128,7 +121,7 @@ stdout_lines:
|
|||
type: list
|
||||
sample: [['...', '...'], ['...'], ['...']]
|
||||
failed_conditions:
|
||||
description: The conditionals that failed
|
||||
description: The conditionals that have failed
|
||||
returned: failed
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
|
|
@ -137,33 +130,61 @@ warnings:
|
|||
returned: always
|
||||
type: list
|
||||
sample: ['...', '...']
|
||||
start:
|
||||
description: The time the job started
|
||||
returned: always
|
||||
type: str
|
||||
sample: "2016-11-16 10:38:15.126146"
|
||||
end:
|
||||
description: The time the job ended
|
||||
returned: always
|
||||
type: str
|
||||
sample: "2016-11-16 10:38:25.595612"
|
||||
delta:
|
||||
description: The time elapsed to perform all operations
|
||||
returned: always
|
||||
type: str
|
||||
sample: "0:00:10.469466"
|
||||
"""
|
||||
import ansible.module_utils.vyos
|
||||
from ansible.module_utils.basic import get_exception
|
||||
from ansible.module_utils.netcli import CommandRunner
|
||||
from ansible.module_utils.netcli import AddCommandError, FailedConditionsError
|
||||
from ansible.module_utils.network import NetworkModule, NetworkError
|
||||
import time
|
||||
|
||||
from ansible.module_utils.local import LocalAnsibleModule
|
||||
from ansible.module_utils.netcli import Conditional
|
||||
from ansible.module_utils.network_common import ComplexList
|
||||
from ansible.module_utils.six import string_types
|
||||
from ansible.module_utils.vyos2 import run_commands
|
||||
|
||||
VALID_KEYS = ['command', 'output', 'prompt', 'response']
|
||||
|
||||
|
||||
def to_lines(stdout):
|
||||
for item in stdout:
|
||||
if isinstance(item, string_types):
|
||||
item = str(item).split('\n')
|
||||
yield item
|
||||
|
||||
def parse_commands(module):
|
||||
for cmd in module.params['commands']:
|
||||
if isinstance(cmd, string_types):
|
||||
cmd = dict(command=cmd, output=None)
|
||||
elif 'command' not in cmd:
|
||||
module.fail_json(msg='command keyword argument is required')
|
||||
elif cmd.get('output') not in [None, 'text']:
|
||||
module.fail_json(msg='invalid output specified for command')
|
||||
elif not set(cmd.keys()).issubset(VALID_KEYS):
|
||||
module.fail_json(msg='unknown keyword specified')
|
||||
yield cmd
|
||||
|
||||
def parse_commands(module, warnings):
|
||||
command = ComplexList(dict(
|
||||
command=dict(key=True),
|
||||
prompt=dict(),
|
||||
response=dict(),
|
||||
))
|
||||
commands = command(module.params['commands'])
|
||||
|
||||
for index, cmd in enumerate(commands):
|
||||
if module.check_mode and not cmd['command'].startswith('show'):
|
||||
warnings.append('only show commands are supported when using '
|
||||
'check mode, not executing `%s`' % cmd['command'])
|
||||
else:
|
||||
if cmd['command'].startswith('conf'):
|
||||
module.fail_json(msg='vyos_command does not support running '
|
||||
'config mode commands. Please use '
|
||||
'vyos_config instead')
|
||||
commands[index] = module.jsonify(cmd)
|
||||
|
||||
return commands
|
||||
|
||||
|
||||
def main():
|
||||
spec = dict(
|
||||
|
|
@ -177,63 +198,48 @@ def main():
|
|||
interval=dict(default=1, type='int')
|
||||
)
|
||||
|
||||
module = NetworkModule(argument_spec=spec,
|
||||
connect_on_load=False,
|
||||
supports_check_mode=True)
|
||||
module = LocalAnsibleModule(argument_spec=spec, supports_check_mode=True)
|
||||
|
||||
commands = list(parse_commands(module))
|
||||
conditionals = module.params['wait_for'] or list()
|
||||
|
||||
warnings = list()
|
||||
commands = parse_commands(module, warnings)
|
||||
|
||||
runner = CommandRunner(module)
|
||||
wait_for = module.params['wait_for'] or list()
|
||||
conditionals = [Conditional(c) for c in wait_for]
|
||||
|
||||
for cmd in commands:
|
||||
if module.check_mode and not cmd['command'].startswith('show'):
|
||||
warnings.append('only show commands are supported when using '
|
||||
'check mode, not executing `%s`' % cmd['command'])
|
||||
else:
|
||||
if cmd['command'].startswith('conf'):
|
||||
module.fail_json(msg='vyos_command does not support running '
|
||||
'config mode commands. Please use '
|
||||
'vyos_config instead')
|
||||
try:
|
||||
runner.add_command(**cmd)
|
||||
except AddCommandError:
|
||||
exc = get_exception()
|
||||
warnings.append('duplicate command detected: %s' % cmd)
|
||||
retries = module.params['retries']
|
||||
interval = module.params['interval']
|
||||
match = module.params['match']
|
||||
|
||||
for item in conditionals:
|
||||
runner.add_conditional(item)
|
||||
for _ in range(retries):
|
||||
responses = run_commands(module, commands)
|
||||
|
||||
runner.retries = module.params['retries']
|
||||
runner.interval = module.params['interval']
|
||||
runner.match = module.params['match']
|
||||
for item in conditionals:
|
||||
if item(responses):
|
||||
if match == 'any':
|
||||
conditionals = list()
|
||||
break
|
||||
conditionals.remove(item)
|
||||
|
||||
try:
|
||||
runner.run()
|
||||
except FailedConditionsError:
|
||||
exc = get_exception()
|
||||
module.fail_json(msg=str(exc), failed_conditions=exc.failed_conditions)
|
||||
except NetworkError:
|
||||
exc = get_exception()
|
||||
module.fail_json(msg=str(exc))
|
||||
if not conditionals:
|
||||
break
|
||||
|
||||
result = dict(changed=False, stdout=list())
|
||||
time.sleep(interval)
|
||||
|
||||
for cmd in commands:
|
||||
try:
|
||||
output = runner.get_command(cmd['command'])
|
||||
except ValueError:
|
||||
output = 'command not executed due to check_mode, see warnings'
|
||||
result['stdout'].append(output)
|
||||
if conditionals:
|
||||
failed_conditions = [item.raw for item in conditionals]
|
||||
msg = 'One or more conditional statements have not been satisfied'
|
||||
module.fail_json(msg=msg, falied_conditions=failed_conditions)
|
||||
|
||||
result['warnings'] = warnings
|
||||
result['stdout_lines'] = list(to_lines(result['stdout']))
|
||||
result = {
|
||||
'changed': False,
|
||||
'stdout': responses,
|
||||
'warnings': warnings,
|
||||
'stdout_lines': list(to_lines(responses)),
|
||||
}
|
||||
|
||||
module.exit_json(**result)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue