You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.network.cnos_command – Run arbitrary commands on Lenovo CNOS devices

Note

This plugin is part of the community.network collection (version 3.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.cnos_command.

Synopsis

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

Parameters

Parameter	Comments
commands string / required	List of commands to send to the remote device. The resulting output from the command is returned. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retires is expired.
interval string	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
match string	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. Choices: any all ← (default)
retries string	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 wait_for conditions. Default: 10
wait_for string	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.

Examples

---
- name: Test contains operator
  community.network.cnos_command:
    commands:
      - show version
      - show system memory
    wait_for:
      - "result[0] contains 'Lenovo'"
      - "result[1] contains 'MemFree'"
  register: result

- ansible.builtin.assert:
    that:
      - "result.changed == false"
      - "result.stdout is defined"

- name: Get output for single command
  community.network.cnos_command:
    commands: ['show version']
  register: result

- ansible.builtin.assert:
    that:
      - "result.changed == false"
      - "result.stdout is defined"

- name: Get output for multiple commands
  community.network.cnos_command:
    commands:
      - show version
      - show interface information
  register: result

- ansible.builtin.assert:
    that:
      - "result.changed == false"
      - "result.stdout is defined"
      - "result.stdout | length == 2"

Return Values

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

Key	Description
failed_conditions list / elements=string	the conditionals that failed Returned: failed Sample: [“…”, “…”]
stdout list / elements=string	the set of responses from the commands Returned: always Sample: [“…”, “…”]
stdout_lines list / elements=string	The value of stdout split into a list Returned: always Sample: [[“…”, “…”], [“…”], [“…”]]

Authors

• Anil Kumar Muraleedharan (@amuraleedhar)