Class: Ansible::Ruby::Modules::Nxos_command

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/core/network/nxos/nxos_command.rb

Overview

Sends an aribtrary command to an NXOS node and returns the results read from the device. The M(nxos_command) modulule 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.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#commands ⇒ Array<String>, String

Returns The commands to send to the remote NXOS device over the configured provider. The resulting output from the command is returned. If the I(waitfor) argument is provided, the module is not returned until the condition is satisfied or the number of retires as expired.

Returns:

  • (Array<String>, String) —

    The commands to send to the remote NXOS device over the configured provider. The resulting output from the command is returned. If the I(waitfor) argument is provided, the module is not returned until the condition is satisfied or the number of retires as expired.



11
 
# File 'lib/ansible/ruby/modules/generated/core/network/nxos/nxos_command.rb', line 11

attribute :commands

#interval ⇒ Integer?

Returns Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again.

Returns:

  • (Integer, nil) —

    Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditional, the interval indicates how to long to wait before trying the command again.



23
 
# File 'lib/ansible/ruby/modules/generated/core/network/nxos/nxos_command.rb', line 23

attribute :interval

#retries ⇒ Integer?

Returns 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 waitfor conditionals.

Returns:

  • (Integer, nil) —

    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 waitfor conditionals



19
 
# File 'lib/ansible/ruby/modules/generated/core/network/nxos/nxos_command.rb', line 19

attribute :retries

#waitfor ⇒ Array<String>, ...

Returns 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.

Returns:

  • (Array<String>, String, nil) —

    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.



15
 
# File 'lib/ansible/ruby/modules/generated/core/network/nxos/nxos_command.rb', line 15

attribute :waitfor