Class: Ansible::Ruby::Modules::Vmware_host_powerstate

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_powerstate.rb

Overview

This module can be used to manage power states of host systems in given vCenter infrastructure. User can set power state to ‘power-down-to-standby’, ‘power-up-from-standby’, ‘shutdown-host’ and ‘reboot-host’. State ‘reboot-host’, ‘shutdown-host’ and ‘power-down-to-standby’ are not supported by all the host systems.

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

#cluster_name ⇒ String?

Returns Name of the cluster from which all host systems will be used.,This is required parameter if C(esxi_hostname) is not specified.

Returns:

  • (String, nil) —

    Name of the cluster from which all host systems will be used.,This is required parameter if C(esxi_hostname) is not specified.



22
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_powerstate.rb', line 22

attribute :cluster_name

#esxi_hostname ⇒ String?

Returns Name of the host system to work with.,This is required parameter if C(cluster_name) is not specified.

Returns:

  • (String, nil) —

    Name of the host system to work with.,This is required parameter if C(cluster_name) is not specified.



18
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_powerstate.rb', line 18

attribute :esxi_hostname

#force ⇒ Symbol?

Returns This parameter specify if the host should be proceeding with user defined powerstate regardless of whether it is in maintenance mode.,If C(state) set to C(reboot-host) and C(force) as C(true), then host system is rebooted regardless of whether it is in maintenance mode.,If C(state) set to C(shutdown-host) and C(force) as C(true), then host system is shutdown regardless of whether it is in maintenance mode.,If C(state) set to C(power-down-to-standby) and C(force) to C(true), then all powered off VMs will evacuated.,Not applicable if C(state) set to C(power-up-from-standby).

Returns:

  • (Symbol, nil) —

    This parameter specify if the host should be proceeding with user defined powerstate regardless of whether it is in maintenance mode.,If C(state) set to C(reboot-host) and C(force) as C(true), then host system is rebooted regardless of whether it is in maintenance mode.,If C(state) set to C(shutdown-host) and C(force) as C(true), then host system is shutdown regardless of whether it is in maintenance mode.,If C(state) set to C(power-down-to-standby) and C(force) to C(true), then all powered off VMs will evacuated.,Not applicable if C(state) set to C(power-up-from-standby).



26
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_powerstate.rb', line 26

attribute :force

#state ⇒ :"power-down-to-standby", ...

Returns Set the state of the host system.

Returns:

  • (:"power-down-to-standby", :"power-up-from-standby", :"shutdown-host", :"reboot-host", nil) —

    Set the state of the host system.



14
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_powerstate.rb', line 14

attribute :state

#timeout ⇒ Integer?

Returns This parameter defines timeout for C(state) set to C(power-down-to-standby) or C(power-up-from-standby).,Ignored if C(state) set to C(reboot-host) or C(shutdown-host).,This parameter is defined in seconds.

Returns:

  • (Integer, nil) —

    This parameter defines timeout for C(state) set to C(power-down-to-standby) or C(power-up-from-standby).,Ignored if C(state) set to C(reboot-host) or C(shutdown-host).,This parameter is defined in seconds.



30
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_host_powerstate.rb', line 30

attribute :timeout