Class: Ansible::Ruby::Modules::Imc_rest

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/remote_management/imc/imc_rest.rb

Overview

Provides direct access to the Cisco IMC REST API. Perform any configuration changes and actions that the Cisco IMC supports. More information about the IMC REST API is available from U(www.cisco.com/c/en/us/td/docs/unified_computing/ucs/c/sw/api/3_0/b_Cisco_IMC_api_301.html)

Instance Method Summary

• #content ⇒ String^?

  When used instead of C(path), sets the content of the API requests directly.,This may be convenient to template simple requests, for anything complex use the M(template) module.,You can collate multiple IMC XML fragments and they will be processed sequentially in a single stream, the Cisco IMC output is subsequently merged.,Parameter C(content) is mutual exclusive with parameter C(path).

• #hostname ⇒ String

  IP Address or hostname of Cisco IMC, resolvable by Ansible control host.

• #password ⇒ String^?

  The password to use for authentication.

• #path ⇒ Object^?

  Name of the absolute path of the filename that includes the body of the http request being sent to the Cisco IMC REST API.,Parameter C(path) is mutual exclusive with parameter C(content).

• #protocol ⇒ :http, ...

  Connection protocol to use.

• #timeout ⇒ Integer^?

  The socket level timeout in seconds.,This is the time that every single connection (every fragment) can spend.

• #username ⇒ String^?

  Username used to login to the switch.

• #validate_certs ⇒ :yes, ...

  If C(no), SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates.

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

#content ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/remote_management/imc/imc_rest.rb', line 29

attribute :content

#hostname ⇒ String

# File 'lib/ansible/ruby/modules/generated/remote_management/imc/imc_rest.rb', line 14

attribute :hostname

#password ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/remote_management/imc/imc_rest.rb', line 22

attribute :password

#path ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/remote_management/imc/imc_rest.rb', line 26

attribute :path

#protocol ⇒ :http, ...

# File 'lib/ansible/ruby/modules/generated/remote_management/imc/imc_rest.rb', line 33

attribute :protocol

#timeout ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/remote_management/imc/imc_rest.rb', line 37

attribute :timeout

#username ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/remote_management/imc/imc_rest.rb', line 18

attribute :username

#validate_certs ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/remote_management/imc/imc_rest.rb', line 41

attribute :validate_certs