Documentation

ops_command - Run arbitrary commands on OpenSwitch devices.

New in version 2.1.

Synopsis

Sends arbitrary commands to an OpenSwitch node and returns the results read from the device. The ops_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

parameter required default choices comments
commands
yes
    List of commands to send to the remote ops device over the configured provider. The resulting output from the command is returned. If the waitfor argument is provided, the module is not returned until the condition is satisfied or the number of retires as expired.
    host
    yes
      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. Note this argument does not affect the SSH argument.
      interval
      no 1
        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.
        password
        no
          Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or rest transports. Note this argument does not affect the SSH transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
          port
          no 0 (use common port)
            Specifies the port to use when buiding the connection to the remote device. This value applies to either cli or I(). The port value will default to the approriate transport common port if none is provided in the task. (cli=22, http=80, https=443). Note this argument does not affect the SSH transport.
            provider
            no
              Convience method that allows all openswitch arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
              retries
              no 10
                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 conditions.
                ssh_keyfile
                no
                  Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
                  transport
                  yes ssh
                  • ssh
                  • cli
                  • rest
                  Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over ssh, cli or REST.
                  use_ssl
                  no True
                  • yes
                  • no
                  Configures the transport to use SSL if set to true only when the transport argument is configured as rest. If the transport argument is not rest, this value is ignored
                  username
                  no
                    Configures the usename to use to authenticate the connection to the remote device. The value of username is used to authenticate either the CLI login or the eAPI authentication depending on which transport is used. Note this argument does not affect the SSH transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
                    waitfor
                    no
                      List of conditions to evaluate against the output of the command. The task will wait for a 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.

                      Examples

                      - ops_command:
                          commands:
                            - show version
                        register: output
                      
                      - ops_command:
                          commands:
                            - show version
                          waitfor:
                            - "result[0] contains OpenSwitch"
                      
                      - ops_command:
                        commands:
                          - show version
                          - show interfaces
                      

                      Return Values

                      Common return values are documented here Common Return Values, the following are the fields unique to this module:

                      name description returned type sample
                      stdout_lines The value of stdout split into a list always list [['...', '...'], ['...'], ['...']]
                      stdout the set of responses from the commands always list ['...', '...']
                      failed_conditions the conditionals that failed list ['...', '...']


                      This is a Core Module

                      For more information on what this means please read Core Modules

                      For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.