Class: Ansible::Ruby::Modules::Exos_command
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Exos_command
- Defined in:
- lib/ansible/ruby/modules/generated/network/exos/exos_command.rb
Overview
Sends arbitrary commands to an Extreme EXOS 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 configuration commands. Please use M(exos_config) to configure EXOS devices.
Instance Method Summary collapse
-
#commands ⇒ Array<String>, String
List of commands to send to the remote EXOS device over the configured provider.
-
#interval ⇒ Integer?
Configures the interval in seconds to wait between retries of the command.
-
#match ⇒ :any, ...
The I(match) argument is used in conjunction with the I(wait_for) argument to specify the match policy.
-
#retries ⇒ Integer?
Specifies the number of retries a command should by tried before it is considered failed.
-
#wait_for ⇒ Array<String>, ...
List of conditions to evaluate against the output of the command.
Methods inherited from Base
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 List of commands to send to the remote EXOS 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.
13 |
# File 'lib/ansible/ruby/modules/generated/network/exos/exos_command.rb', line 13 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.
29 |
# File 'lib/ansible/ruby/modules/generated/network/exos/exos_command.rb', line 29 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.
21 |
# File 'lib/ansible/ruby/modules/generated/network/exos/exos_command.rb', line 21 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.
25 |
# File 'lib/ansible/ruby/modules/generated/network/exos/exos_command.rb', line 25 attribute :retries |
#wait_for ⇒ Array<String>, ...
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.
17 |
# File 'lib/ansible/ruby/modules/generated/network/exos/exos_command.rb', line 17 attribute :wait_for |