ansible.builtin.cnos_command (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: get output for single command
  cnos_command:
    commands: ['show version']
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: get output for multiple commands
  cnos_command:
    commands:
      - show version
      - show interface information
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
match:
    choices:
    - any
    - all
    default: all
    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.
    version_added: '2.6'
    version_added_collection: ansible.builtin

retries:
    default: 10
    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.
    version_added: '2.6'
    version_added_collection: ansible.builtin

commands:
    description:
    - List of commands to send to the remote device. 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 is expired.
    required: true
    version_added: '2.6'
    version_added_collection: ansible.builtin

interval:
    default: 1
    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.
    version_added: '2.6'
    version_added_collection: ansible.builtin

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.
    version_added: '2.6'
    version_added_collection: ansible.builtin

Outputs

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