Class: Ansible::Ruby::Modules::Enos_command

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/enos/enos_command.rb

Overview

Sends arbitrary commands to an ENOS node and returns the results read from the device. The C(enos_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.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#commands ⇒ Object

Returns List of commands to send to the remote 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 retires as expired.

Returns:

  • (Object) —

    List of commands to send to the remote 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 retires as expired.



12
 
# File 'lib/ansible/ruby/modules/generated/network/enos/enos_command.rb', line 12

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 conditions, the interval indicates how 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 conditions, the interval indicates how long to wait before trying the command again.



27
 
# File 'lib/ansible/ruby/modules/generated/network/enos/enos_command.rb', line 27

attribute :interval

#match ⇒ :any, ...

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

Returns:

  • (:any, :all, nil) —

    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.



19
 
# File 'lib/ansible/ruby/modules/generated/network/enos/enos_command.rb', line 19

attribute :match

#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 I(wait_for) conditions.

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 I(wait_for) conditions.



23
 
# File 'lib/ansible/ruby/modules/generated/network/enos/enos_command.rb', line 23

attribute :retries

#wait_for ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



16
 
# File 'lib/ansible/ruby/modules/generated/network/enos/enos_command.rb', line 16

attribute :wait_for