Class: Ansible::Ruby::Modules::Bigip_command

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Bigip_command

Defined in:

lib/ansible/ruby/modules/generated/network/f5/bigip_command.rb

Overview

Sends an arbitrary command to an BIG-IP node 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 is B(not) idempotent, nor will it ever be. It is intended as a stop-gap measure to satisfy automation requirements until such a time as a real module has been developed to configure in the way you need. If you are using this module, you should probably also be filing an issue to have a B(real) module created for your needs.

Instance Method Summary

• #chdir ⇒ String^?

  Change into this directory before running the command.

• #commands ⇒ Array<String>, String

  The commands to send to the remote BIG-IP 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.

• #transport ⇒ :rest, :cli

  Configures the transport connection to use when connecting to the remote device.

• #wait_for ⇒ Array<String>, ...

  Specifies what to evaluate from the output of the command and what conditionals to apply.

• #warn ⇒ Boolean^?

  Whether the module should raise warnings related to command idempotency or not.,Note that the F5 Ansible developers specifically leave this on to make you aware that your usage of this module may be better served by official F5 Ansible modules.

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

#chdir ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_command.rb', line 42

attribute :chdir

#commands ⇒ Array<String>, String

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_command.rb', line 14

attribute :commands

#interval ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_command.rb', line 30

attribute :interval

#match ⇒ :any, ...

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_command.rb', line 22

attribute :match

#retries ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_command.rb', line 26

attribute :retries

#transport ⇒ :rest, :cli

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_command.rb', line 34

attribute :transport

#wait_for ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_command.rb', line 18

attribute :wait_for

#warn ⇒ Boolean^?

# File 'lib/ansible/ruby/modules/generated/network/f5/bigip_command.rb', line 38

attribute :warn