dellemc.os10.os10_command – Run commands on devices running Dell EMC SmartFabric OS10  Note This plugin is part of the dellemc.os10 collection (version 1.1.1). 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 dellemc.os10. To use it in a playbook, specify: dellemc.os10.os10_command.   Synopsis Parameters Notes Examples Return Values  Synopsis  Sends arbitrary commands to a OS10 device 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 dellemc.os10.os10_config to configure OS10 devices.   Note This module has a corresponding action plugin.  Parameters   Parameter Choices/Defaults Comments    commands  list / elements=string / required      List of commands to send to the remote OS10 device over the configured provider. 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 retries has expired.     interval  integer    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  string    
Choices: 
all ← any    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      A dict object containing connection details.      auth_pass  string      Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTH_PASS will be used instead.      authorize  boolean    
Choices: 
no ← yes    Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTHORIZE will be used instead.      host  string      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      Password to authenticate the SSH session to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.      port  integer      Specifies the port to use when building the connection to the remote device.      ssh_keyfile  path      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 ANSIBLE_NET_SSH_KEYFILE will be used instead.      timeout  integer      Specifies idle timeout (in seconds) for the connection. Useful if the console freezes before continuing. For example when saving configurations.      username  string      User to authenticate the SSH session to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.     retries  integer    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 conditions.     wait_for  list / elements=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.     Notes  Note  For more information on using Ansible to manage Dell EMC Network devices see https://www.ansible.com/ansible-dell-networking.   Examples tasks:
  - name: run show version on remote devices
    os10_command:
      commands: show version

  - name: run show version and check to see if output contains OS10
    os10_command:
      commands: show version
      wait_for: result[0] contains OS10

  - name: run multiple commands on remote nodes
    os10_command:
      commands:
        - show version
        - show interface

  - name: run multiple commands and evaluate the output
    os10_command:
      commands:
        - show version
        - show interface
      wait_for:
        - result[0] contains OS10
        - result[1] contains Ethernet
 Return Values Common return values are documented here, the following are the fields unique to this module:   Key Returned Description    failed_conditions  list / elements=string   failed  The list of conditionals that have failed  Sample: ['...', '...']     stdout  list / elements=string   always apart from low level errors (such as action plugin)  The set of responses from the commands  Sample: ['...', '...']     stdout_lines  list / elements=string   always apart from low level errors (such as action plugin)  The value of stdout split into a list  Sample: [['...', '...'], ['...'], ['...']]     warnings  list / elements=string   always  The list of warnings (if any) generated by module based on arguments  Sample: ['...', '...']     Authors  Senthil Kumar Ganesan (@skg-net) 

    © 2012–2018 Michael DeHaan
{'path': 'public/docs/ansible/collections/dellemc/os10/os10_command_module.html', 'source': 'DevDocs.IO'}