mirror of
https://github.com/thegeeklab/ansible-later.git
synced 2024-07-06 09:00:58 +02:00
272 lines
8.3 KiB
Python
272 lines
8.3 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
#
|
|
# (C) 2017 Red Hat Inc.
|
|
# Copyright (C) 2017 Lenovo.
|
|
#
|
|
# GNU General Public License v3.0+
|
|
#
|
|
# This program 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.
|
|
#
|
|
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
#
|
|
# Module to execute CNOS Commands on Lenovo Switches.
|
|
# Lenovo Networking
|
|
#
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'}
|
|
|
|
|
|
DOCUMENTATION = """
|
|
---
|
|
module: cnos_command
|
|
version_added: "2.6"
|
|
author: "Anil Kumar Muraleedharan (@amuraleedhar)"
|
|
short_description: Run arbitrary commands on Lenovo CNOS devices
|
|
description:
|
|
- Sends arbitrary commands to an CNOS node and returns the results
|
|
read from the device. The C(cnos_command) module includes an
|
|
argument that will cause the module to wait for a specific condition
|
|
before returning or timing out if the condition is not met.
|
|
options:
|
|
provider:
|
|
version_added: "2.6"
|
|
description:
|
|
- A dict object containing connection details.
|
|
suboptions:
|
|
host:
|
|
description:
|
|
- Specifies the DNS host name or address for connecting to the remote
|
|
device over the specified transport. The value of host is used as
|
|
the destination address for the transport.
|
|
required: true
|
|
port:
|
|
description:
|
|
- Specifies the port to use when building the connection to the remote device.
|
|
default: 22
|
|
username:
|
|
description:
|
|
- Configures the username to use to authenticate the connection to
|
|
the remote device. This value is used to authenticate
|
|
the SSH session. If the value is not specified in the task, the
|
|
value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead.
|
|
password:
|
|
description:
|
|
- Specifies the password to use to authenticate the connection to
|
|
the remote device. This value is used to authenticate
|
|
the SSH session. If the value is not specified in the task, the
|
|
value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead.
|
|
timeout:
|
|
description:
|
|
- Specifies the timeout in seconds for communicating with the network device
|
|
for either connecting or sending commands. If the timeout is
|
|
exceeded before the operation is completed, the module will error.
|
|
default: 10
|
|
ssh_keyfile:
|
|
description:
|
|
- Specifies the SSH key to use to authenticate the connection to
|
|
the remote device. This value is the path to the
|
|
key used to authenticate the SSH session. If the value is not specified
|
|
in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
|
|
will be used instead.
|
|
commands:
|
|
version_added: "2.6"
|
|
description:
|
|
- List of commands to send to the remote device over the
|
|
configured provider. The resulting output from the command
|
|
is returned. If the I(wait_for) argument is provided, the
|
|
module is not returned until the condition is satisfied or
|
|
the number of retires as expired.
|
|
required: true
|
|
wait_for:
|
|
version_added: "2.6"
|
|
description:
|
|
- List of conditions to evaluate against the output of the
|
|
command. The task will wait for each condition to be true
|
|
before moving forward. If the conditional is not true
|
|
within the configured number of retries, the task fails.
|
|
See examples.
|
|
match:
|
|
version_added: "2.6"
|
|
description:
|
|
- The I(match) argument is used in conjunction with the
|
|
I(wait_for) argument to specify the match policy. Valid
|
|
values are C(all) or C(any). If the value is set to C(all)
|
|
then all conditionals in the wait_for must be satisfied. If
|
|
the value is set to C(any) then only one of the values must be
|
|
satisfied.
|
|
default: all
|
|
choices: ['any', 'all']
|
|
retries:
|
|
version_added: "2.6"
|
|
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
|
|
I(wait_for) conditions.
|
|
default: 10
|
|
interval:
|
|
version_added: "2.6"
|
|
description:
|
|
- Configures the interval in seconds to wait between retries
|
|
of the command. If the command does not pass the specified
|
|
conditions, the interval indicates how long to wait before
|
|
trying the command again.
|
|
default: 1
|
|
"""
|
|
|
|
EXAMPLES = """
|
|
# Note: examples below use the following provider dict to handle
|
|
# transport and authentication to the node.
|
|
---
|
|
vars:
|
|
cli:
|
|
host: "{{ inventory_hostname }}"
|
|
port: 22
|
|
username: admin
|
|
password: admin
|
|
timeout: 30
|
|
|
|
---
|
|
- name: test contains operator
|
|
cnos_command:
|
|
commands:
|
|
- show version
|
|
- show system memory
|
|
wait_for:
|
|
- "result[0] contains 'Lenovo'"
|
|
- "result[1] contains 'MemFree'"
|
|
provider: "{{ cli }}"
|
|
register: result
|
|
|
|
- assert:
|
|
that:
|
|
- "result.changed == false"
|
|
- "result.stdout is defined"
|
|
|
|
- name: get output for single command
|
|
cnos_command:
|
|
commands: ['show version']
|
|
provider: "{{ cli }}"
|
|
register: result
|
|
|
|
- assert:
|
|
that:
|
|
- "result.changed == false"
|
|
- "result.stdout is defined"
|
|
|
|
- name: get output for multiple commands
|
|
cnos_command:
|
|
commands:
|
|
- show version
|
|
- show interface information
|
|
provider: "{{ cli }}"
|
|
register: result
|
|
|
|
- assert:
|
|
that:
|
|
- "result.changed == false"
|
|
- "result.stdout is defined"
|
|
- "result.stdout | length == 2"
|
|
"""
|
|
|
|
RETURN = """
|
|
stdout:
|
|
description: the set of responses from the commands
|
|
returned: always
|
|
type: list
|
|
sample: ['...', '...']
|
|
stdout_lines:
|
|
description: The value of stdout split into a list
|
|
returned: always
|
|
type: list
|
|
sample: [['...', '...'], ['...'], ['...']]
|
|
failed_conditions:
|
|
description: the conditionals that failed
|
|
returned: failed
|
|
type: list
|
|
sample: ['...', '...']
|
|
"""
|
|
|
|
import time
|
|
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
from ansible.module_utils.network.cnos.cnos import run_commands, check_args
|
|
from ansible.module_utils.network.cnos.cnos import cnos_argument_spec
|
|
from ansible.module_utils.network.common.parsing import Conditional
|
|
from ansible.module_utils.six import string_types
|
|
|
|
|
|
def to_lines(stdout):
|
|
for item in stdout:
|
|
if isinstance(item, string_types):
|
|
item = str(item).split('\n')
|
|
yield item
|
|
|
|
|
|
def main():
|
|
spec = dict(
|
|
# { command: <str>, prompt: <str>, response: <str> }
|
|
commands=dict(type='list', required=True),
|
|
|
|
wait_for=dict(type='list'),
|
|
match=dict(default='all', choices=['all', 'any']),
|
|
|
|
retries=dict(default=10, type='int'),
|
|
interval=dict(default=1, type='int')
|
|
)
|
|
|
|
spec.update(cnos_argument_spec)
|
|
|
|
module = AnsibleModule(argument_spec=spec, supports_check_mode=True)
|
|
result = {'changed': False}
|
|
|
|
wait_for = module.params['wait_for'] or list()
|
|
conditionals = [Conditional(c) for c in wait_for]
|
|
|
|
commands = module.params['commands']
|
|
retries = module.params['retries']
|
|
interval = module.params['interval']
|
|
match = module.params['match']
|
|
|
|
while retries > 0:
|
|
responses = run_commands(module, commands)
|
|
|
|
for item in list(conditionals):
|
|
if item(responses):
|
|
if match == 'any':
|
|
conditionals = list()
|
|
break
|
|
conditionals.remove(item)
|
|
|
|
if not conditionals:
|
|
break
|
|
|
|
time.sleep(interval)
|
|
retries -= 1
|
|
|
|
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, failed_conditions=failed_conditions)
|
|
|
|
result.update({
|
|
'changed': False,
|
|
'stdout': responses,
|
|
'stdout_lines': list(to_lines(responses))
|
|
})
|
|
|
|
module.exit_json(**result)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|