dellemc_networking.os10.os10_command (1.0.2) — module

Install collection

Install with ansible-galaxy collection install dellemc_networking.os10:==1.0.2

Add to requirements.yml

  collections:
    - name: dellemc_networking.os10
      version: 1.0.2

Description

Sends arbitrary commands to a Dell EMC OS10 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(os10_config) to configure Dell EMC OS10 devices.

Inputs

    
match:
    choices:
    - all
    - any
    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.
    type: str
    version_added: '2.5'
    version_added_collection: dellemc_networking.os10

retries:
    default: 10
    description:
    - 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 I(wait_for) conditions.
    type: int

commands:
    description:
    - List of commands to send to the remote OS10 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
    type: list

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.
    type: int

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      host:
        description:
        - 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.
        required: true
        type: str
      password:
        description:
        - Password to authenticate the SSH session to the remote device. If the value
          is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD)
          will be used instead.
        type: str
      port:
        default: 22
        description:
        - Specifies the port to use when building the connection to the remote device.
        type: int
      ssh_keyfile:
        description:
        - Path to an ssh key used to authenticate the SSH session to the remote device.  If
          the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE)
          will be used instead.
        type: path
      timeout:
        default: 10
        description:
        - Specifies idle timeout (in seconds) for the connection. Useful if the console
          freezes before continuing. For example when saving configurations.
        type: int
      username:
        description:
        - User to authenticate the SSH session to the remote device. If the value is not
          specified in the task, the value of environment variable C(ANSIBLE_NET_USERNAME)
          will be used instead.
        type: str
    type: dict

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 I(retries), the task fails. See examples.
    type: list
    version_added: '2.2'
    version_added_collection: dellemc_networking.os10

Outputs

failed_conditions:
  description: The list of conditionals that have failed
  returned: failed
  sample:
  - '...'
  - '...'
  type: list
stdout:
  description: The set of responses from the commands
  returned: always apart from low level errors (such as action plugin)
  sample:
  - '...'
  - '...'
  type: list
stdout_lines:
  description: The value of stdout split into a list
  returned: always apart from low level errors (such as action plugin)
  sample:
  - - '...'
    - '...'
  - - '...'
  - - '...'
  type: list
warnings:
  description: The list of warnings (if any) generated by module based on arguments
  returned: always
  sample:
  - '...'
  - '...'
  type: list