�
�Udac @` s� d d l m Z m Z m Z e Z i d d 6d g d 6d d 6Z d Z d Z d
Z d d l
Z
d d l m Z d d
l
m Z d d l m Z d d l m Z d d l m Z m Z m Z d � Z d � Z d � Z e d k r� e � n d S( i ( t absolute_importt divisiont print_functions 1.1t metadata_versiont previewt statust certifiedt supported_bys�
---
module: sros_command
version_added: "2.2"
author: "Peter Sprygada (@privateip)"
short_description: Run commands on remote devices running Nokia SR OS
description:
- Sends arbitrary commands to an SR OS node and returns the results
read from the device. This 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.
- This module does not support running commands in configuration mode.
Please use M(sros_config) to configure SR OS devices.
extends_documentation_fragment: sros
options:
commands:
description:
- List of commands to send to the remote SR OS 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 retries has expired.
required: true
wait_for:
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.
aliases: ['waitfor']
match:
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:
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:
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
s�
# Note: examples below use the following provider dict to handle
# transport and authentication to the node.
---
vars:
cli:
host: "{{ inventory_hostname }}"
username: admin
password: admin
transport: cli
---
tasks:
- name: run show version on remote devices
sros_command:
commands: show version
provider: "{{ cli }}"
- name: run show version and check to see if output contains sros
sros_command:
commands: show version
wait_for: result[0] contains sros
provider: "{{ cli }}"
- name: run multiple commands on remote nodes
sros_command:
commands:
- show version
- show port detail
provider: "{{ cli }}"
- name: run multiple commands and evaluate the output
sros_command:
commands:
- show version
- show port detail
wait_for:
- result[0] contains TiMOS-B-14.0.R4
provider: "{{ cli }}"
s�
stdout:
description: The set of responses from the commands
returned: always apart from low level errors (such as action plugin)
type: list
sample: ['...', '...']
stdout_lines:
description: The value of stdout split into a list
returned: always apart from low level errors (such as action plugin)
type: list
sample: [['...', '...'], ['...'], ['...']]
failed_conditions:
description: The list of conditionals that have failed
returned: failed
type: list
sample: ['...', '...']
N( t
AnsibleModule( t Conditional( t ComplexList( t string_types( t run_commandst sros_argument_spect
check_argsc c` sA x: | D]2 } t | t � r4 t | � j d � } n | Vq Wd S( Ns
( t
isinstanceR t strt split( t stdoutt item( ( sM /usr/lib/python2.7/site-packages/ansible/modules/network/sros/sros_command.pyt to_lines� s
c C` s� t t d t d t � d t � d t � � | � } | | j d � } xu t | � D]g \ } } | j r� | d j d � r� | j d | d � qS | d j d � rS | j d d
� qS qS W| S( Nt commandt keyt promptt answert commandst showsJ only show commands are supported when using check mode, not executing `%s`t conft msgs[ sros_command does not support running config mode commands. Please use sros_config instead( R
t dictt Truet paramst enumeratet
check_modet
startswitht appendt fail_json( t modulet warningsR R t indexR ( ( sM /usr/lib/python2.7/site-packages/ansible/modules/network/sros/sros_command.pyt parse_commands� s c C` s= t d t d d d t � d t d d d d g � d t d d
d d
d g � d
t d d d d � d t d d d d � � } | j t � t d | d t � } i t d 6} t � } t | | � t | | � } | | d <| j d p� t � } g | D] } t
| � ^ q� } | j d
} | j d } | j d }
x� | d k r�t | | � } xI t | � D]; } | | � r`|
d k r�t � } Pn | j | � q`q`W| s�Pn t
j | � | d 8} q8W| rg | D] } | j ^ q�}
d } | j d | d |
� n i t d 6| d 6t t | � � d 6} | j | � d S( s* main entry point for module execution
R t typet listt requiredt wait_fort aliasest waitfort matcht defaultt allt choicest anyt retriesi
t intt intervali t
argument_spect supports_check_modet changedR&