Class: Ansible::Ruby::Modules::Vmware_maintenancemode

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

Overview

This module can be used for placing a ESXi host into maintenance mode. Support for VSAN compliant maintenance mode when selected.

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

#esxi_hostname ⇒ String

Returns Name of the host as defined in vCenter.

Returns:

  • (String) —

    Name of the host as defined in vCenter.



13
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_maintenancemode.rb', line 13

attribute :esxi_hostname

#evacuate ⇒ Symbol?

Returns If set to C(True), evacuate all powered off VMs.

Returns:

  • (Symbol, nil) —

    If set to C(True), evacuate all powered off VMs.



21
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_maintenancemode.rb', line 21

attribute :evacuate

#state ⇒ :present, ...

Returns Enter or exit maintenance mode.

Returns:

  • (:present, :absent, nil) —

    Enter or exit maintenance mode.



29
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_maintenancemode.rb', line 29

attribute :state

#timeout ⇒ Integer?

Returns Specify a timeout for the operation.

Returns:

  • (Integer, nil) —

    Specify a timeout for the operation.



25
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_maintenancemode.rb', line 25

attribute :timeout

#vsan ⇒ :ensureObjectAccessibility, ...

Returns Specify which VSAN compliant mode to enter.

Returns:

  • (:ensureObjectAccessibility, :evacuateAllData, :noAction, nil) —

    Specify which VSAN compliant mode to enter.



17
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_maintenancemode.rb', line 17

attribute :vsan