vyos_command – Run one or more commands on VyOS devices — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# vyos_command – Run one or more commands on VyOS devices

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- The command module allows running one or more commands on remote devices running VyOS. This module can also be introspected to validate key parameters before returning successfully. If the conditional statements are not met in the wait period, the task fails.
- Certain `show` commands in VyOS produce many lines of output and use a custom pager that can cause this module to hang. If the value of the environment variable `ANSIBLE_VYOS_TERMINAL_LENGTH` is not set, the default number of 10000 is used.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
commands - / required |  | The ordered set of commands to execute on the remote device running VyOS. The output from the command execution is returned to the playbook. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retries has been exceeded.
interval - | Default: 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.
match - | Choices: any all ← | The match argument is used in conjunction with the wait_for argument to specify the match policy. Valid values are `all` or `any`. If the value is set to `all` then all conditionals in the wait_for must be satisfied. If the value is set to `any` then only one of the values must be satisfied.
provider dictionary |  | Deprecated Starting with Ansible 2.5 we recommend using `connection: network_cli`. For more information please see the Network Guide. A dict object containing connection details.
| host string / required |  | 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.
| password string |  | 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 `ANSIBLE_NET_PASSWORD` will be used instead.
| port integer | Default: 22 | Specifies the port to use when building the connection to the remote device.
| ssh_keyfile path |  | 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 `ANSIBLE_NET_SSH_KEYFILE` will be used instead.
| timeout integer | Default: 10 | 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.
| username string |  | 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 `ANSIBLE_NET_USERNAME` will be used instead.
retries - | Default: 10 | Specifies the number of retries a command should be tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditionals.
wait_for - |  | 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. aliases: waitfor

## Notes

Note

- Tested against VyOS 1.1.8 (helium).
- Running `show system boot-messages all` will cause the module to hang since VyOS is using a custom pager setting to display the output of that command.
- If a command sent to the device requires answering a prompt, it is possible to pass a dict containing command, answer and prompt. See examples.
- This module works with connection `network_cli`. See the VyOS OS Platform Options.
- For more information on using Ansible to manage network devices see the Ansible Network Guide

## Examples

    tasks:
      - name: show configuration on ethernet devices eth0 and eth1
        vyos_command:
          commands:
            - show interfaces ethernet {{ item }}
        with_items:
          - eth0
          - eth1

      - 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'"

      - name: run command that requires answering a prompt
        vyos_command:
          commands:
            - command: 'rollback 1'
              prompt: 'Proceed with reboot? [confirm][y]'
              answer: y

## Return Values

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

Key | Returned | Description
--- | --- | ---
failed_conditions list | failed | The list of conditionals that have failed Sample: ['...', '...']
stdout list | always apart from low level errors (such as action plugin) | The set of responses from the commands Sample: ['...', '...']
stdout_lines list | always | The value of stdout split into a list Sample: [['...', '...'], ['...'], ['...']]
warnings list | always | The list of warnings (if any) generated by module based on arguments Sample: ['...', '...']

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]

### Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

### Authors

- Nathaniel Case (@Qalthos)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.