Class: Ansible::Ruby::Modules::Edgeos_command

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

Overview

This command module allows running one or more commands on a remote device running EdgeOS, such as the Ubiquiti EdgeRouter. This module does not support running commands in configuration mode. Certain C(show) commands in EdgeOS produce many lines of output and use a custom pager that can cause this module to hang. If the value of the environment variable C(ANSIBLE_EDGEOS_TERMINAL_LENGTH) is not set, the default number of 10000 is used. This is a network module and requires C(connection: network_cli) in order to work properly. For more information please see the L(Network Guide,../network/getting_started/index.html).

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 ⇒ String

Returns The commands or ordered set of commands that should be run against the remote device. The output of the command is returned to the playbook. If the C(wait_for) argument is provided, the module is not returned until the condition is met or the number of retries is exceeded.

Returns:

  • (String) —

    The commands or ordered set of commands that should be run against the remote device. The output of the command is returned to the playbook. If the C(wait_for) argument is provided, the module is not returned until the condition is met or the number of retries is exceeded.



16
 
# File 'lib/ansible/ruby/modules/generated/network/edgeos/edgeos_command.rb', line 16

attribute :commands

#interval ⇒ Integer?

Returns The number of seconds to wait between C(retries) of the command.

Returns:

  • (Integer, nil) —

    The number of seconds to wait between C(retries) of the command.



31
 
# File 'lib/ansible/ruby/modules/generated/network/edgeos/edgeos_command.rb', line 31

attribute :interval

#match ⇒ :any, ...

Returns Used in conjunction with C(wait_for) to create match policy. If set to C(all), then all conditions in C(wait_for) must be met. If set to C(any), then only one condition must match.

Returns:

  • (:any, :all, nil) —

    Used in conjunction with C(wait_for) to create match policy. If set to C(all), then all conditions in C(wait_for) must be met. If set to C(any), then only one condition must match.



23
 
# File 'lib/ansible/ruby/modules/generated/network/edgeos/edgeos_command.rb', line 23

attribute :match

#retries ⇒ Integer?

Returns Number of times a command should be tried before it is considered failed. The command is run on the target device and evaluated against the C(wait_for) conditionals.

Returns:

  • (Integer, nil) —

    Number of times a command should be tried before it is considered failed. The command is run on the target device and evaluated against the C(wait_for) conditionals.



27
 
# File 'lib/ansible/ruby/modules/generated/network/edgeos/edgeos_command.rb', line 27

attribute :retries

#wait_for ⇒ Object?

Returns Causes the task to wait for a specific condition to be met before moving forward. If the condition is not met before the specified number of retries is exceeded, the task will fail.

Returns:

  • (Object, nil) —

    Causes the task to wait for a specific condition to be met before moving forward. If the condition is not met before the specified number of retries is exceeded, the task will fail.



20
 
# File 'lib/ansible/ruby/modules/generated/network/edgeos/edgeos_command.rb', line 20

attribute :wait_for