Class: Ansible::Ruby::Modules::Redfish_command

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/remote_management/redfish/redfish_command.rb

Overview

Builds Redfish URIs locally and sends them to remote OOB controllers to perform an action. Manages OOB controller ex. reboot, log management. Manages OOB controller users ex. add, remove, update. Manages system power ex. on, off, graceful and forced reboot.

Instance Method Summary collapse

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

#baseuri ⇒ String

Returns Base URI of OOB controller.

Returns:

  • (String) —

    Base URI of OOB controller



23
 
# File 'lib/ansible/ruby/modules/generated/remote_management/redfish/redfish_command.rb', line 23

attribute :baseuri

#bootdevice ⇒ String?

Returns bootdevice when setting boot configuration.

Returns:

  • (String, nil) —

    bootdevice when setting boot configuration



51
 
# File 'lib/ansible/ruby/modules/generated/remote_management/redfish/redfish_command.rb', line 51

attribute :bootdevice

#category ⇒ String

Returns Category to execute on OOB controller.

Returns:

  • (String) —

    Category to execute on OOB controller



15
 
# File 'lib/ansible/ruby/modules/generated/remote_management/redfish/redfish_command.rb', line 15

attribute :category

#command ⇒ Array<String>, String

Returns List of commands to execute on OOB controller.

Returns:

  • (Array<String>, String) —

    List of commands to execute on OOB controller



19
 
# File 'lib/ansible/ruby/modules/generated/remote_management/redfish/redfish_command.rb', line 19

attribute :command

#password ⇒ String

Returns Password for authentication with OOB controller.

Returns:

  • (String) —

    Password for authentication with OOB controller



31
 
# File 'lib/ansible/ruby/modules/generated/remote_management/redfish/redfish_command.rb', line 31

attribute :password

#user ⇒ String

Returns User for authentication with OOB controller.

Returns:

  • (String) —

    User for authentication with OOB controller



27
 
# File 'lib/ansible/ruby/modules/generated/remote_management/redfish/redfish_command.rb', line 27

attribute :user

#userid ⇒ String?

Returns ID of user to add/delete/modify.

Returns:

  • (String, nil) —

    ID of user to add/delete/modify



35
 
# File 'lib/ansible/ruby/modules/generated/remote_management/redfish/redfish_command.rb', line 35

attribute :userid

#username ⇒ String?

Returns name of user to add/delete/modify.

Returns:

  • (String, nil) —

    name of user to add/delete/modify



39
 
# File 'lib/ansible/ruby/modules/generated/remote_management/redfish/redfish_command.rb', line 39

attribute :username

#userpswd ⇒ String?

Returns password of user to add/delete/modify.

Returns:

  • (String, nil) —

    password of user to add/delete/modify



43
 
# File 'lib/ansible/ruby/modules/generated/remote_management/redfish/redfish_command.rb', line 43

attribute :userpswd

#userrole ⇒ String?

Returns role of user to add/delete/modify.

Returns:

  • (String, nil) —

    role of user to add/delete/modify



47
 
# File 'lib/ansible/ruby/modules/generated/remote_management/redfish/redfish_command.rb', line 47

attribute :userrole