Class: Ansible::Ruby::Modules::Ipmi_power

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

Overview

Use this module for power management

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

#name ⇒ String

Returns Hostname or ip address of the BMC.

Returns:

  • (String) —

    Hostname or ip address of the BMC.



12
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ipmi/ipmi_power.rb', line 12

attribute :name

#password ⇒ String

Returns Password to connect to the BMC.

Returns:

  • (String) —

    Password to connect to the BMC.



24
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ipmi/ipmi_power.rb', line 24

attribute :password

#port ⇒ Integer?

Returns Remote RMCP port.

Returns:

  • (Integer, nil) —

    Remote RMCP port.



16
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ipmi/ipmi_power.rb', line 16

attribute :port

#state ⇒ :"on -- Request system turn on", ...

Returns Whether to ensure that the machine in desired state.

Returns:

  • (:"on -- Request system turn on", :"off -- Request system turn off without waiting for OS to shutdown", :"shutdown -- Have system request OS proper shutdown", :"reset -- Request system reset without waiting for OS", :"boot -- If system is off, then 'on', else 'reset'") —

    Whether to ensure that the machine in desired state.



28
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ipmi/ipmi_power.rb', line 28

attribute :state

#timeout ⇒ Integer?

Returns Maximum number of seconds before interrupt request.

Returns:

  • (Integer, nil) —

    Maximum number of seconds before interrupt request.



32
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ipmi/ipmi_power.rb', line 32

attribute :timeout

#user ⇒ String

Returns Username to use to connect to the BMC.

Returns:

  • (String) —

    Username to use to connect to the BMC.



20
 
# File 'lib/ansible/ruby/modules/generated/remote_management/ipmi/ipmi_power.rb', line 20

attribute :user