Class: Ansible::Ruby::Modules::Vmware_guest_powerstate

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

Overview

Power on / Power off / Restart a virtual machine.

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

#folder ⇒ String?

Returns Destination folder, absolute or relative path to find an existing guest or create the new guest.,The folder should include the datacenter. ESX’s datacenter is ha-datacenter,Examples:, folder: /ha-datacenter/vm, folder: ha-datacenter/vm, folder: /datacenter1/vm, folder: datacenter1/vm, folder: /datacenter1/vm/folder1, folder: datacenter1/vm/folder1, folder: /folder1/datacenter1/vm, folder: folder1/datacenter1/vm, folder: /folder1/datacenter1/vm/folder2, folder: vm/folder2, folder: folder2.

Returns:

  • (String, nil) —

    Destination folder, absolute or relative path to find an existing guest or create the new guest.,The folder should include the datacenter. ESX’s datacenter is ha-datacenter,Examples:, folder: /ha-datacenter/vm, folder: ha-datacenter/vm, folder: /datacenter1/vm, folder: datacenter1/vm, folder: /datacenter1/vm/folder1, folder: datacenter1/vm/folder1, folder: /folder1/datacenter1/vm, folder: folder1/datacenter1/vm, folder: /folder1/datacenter1/vm/folder2, folder: vm/folder2, folder: folder2



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_powerstate.rb', line 27

attribute :folder

#force ⇒ Symbol?

Returns Ignore warnings and complete the actions.,This parameter is useful while forcing virtual machine state.

Returns:

  • (Symbol, nil) —

    Ignore warnings and complete the actions.,This parameter is useful while forcing virtual machine state.



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_powerstate.rb', line 35

attribute :force

#name ⇒ String?

Returns Name of the virtual machine to work with.,Virtual machine names in vCenter are not necessarily unique, which may be problematic, see C(name_match).

Returns:

  • (String, nil) —

    Name of the virtual machine to work with.,Virtual machine names in vCenter are not necessarily unique, which may be problematic, see C(name_match).



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_powerstate.rb', line 16

attribute :name

#name_match ⇒ :first, ...

Returns If multiple virtual machines matching the name, use the first or last found.

Returns:

  • (:first, :last, nil) —

    If multiple virtual machines matching the name, use the first or last found.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_powerstate.rb', line 20

attribute :name_match

#scheduled_at ⇒ String?

Returns Date and time in string format at which specificed task needs to be performed.,The required format for date and time - ‘dd/mm/yyyy hh:mm’.,Scheduling task requires vCenter server. A standalone ESXi server does not support this option.

Returns:

  • (String, nil) —

    Date and time in string format at which specificed task needs to be performed.,The required format for date and time - ‘dd/mm/yyyy hh:mm’.,Scheduling task requires vCenter server. A standalone ESXi server does not support this option.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_powerstate.rb', line 31

attribute :scheduled_at

#state ⇒ :"powered-off", ...

Returns Set the state of the virtual machine.

Returns:

  • (:"powered-off", :"powered-on", :"reboot-guest", :restarted, :"shutdown-guest", :suspended, :present, nil) —

    Set the state of the virtual machine.



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_powerstate.rb', line 12

attribute :state

#state_change_timeout ⇒ Integer?

Returns If the C(state) is set to C(shutdown-guest), by default the module will return immediately after sending the shutdown signal.,If this argument is set to a positive integer, the module will instead wait for the VM to reach the poweredoff state.,The value sets a timeout in seconds for the module to wait for the state change.

Returns:

  • (Integer, nil) —

    If the C(state) is set to C(shutdown-guest), by default the module will return immediately after sending the shutdown signal.,If this argument is set to a positive integer, the module will instead wait for the VM to reach the poweredoff state.,The value sets a timeout in seconds for the module to wait for the state change.



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_powerstate.rb', line 39

attribute :state_change_timeout

#uuid ⇒ Object?

Returns UUID of the instance to manage if known, this is VMware’s unique identifier.,This is required if name is not supplied.

Returns:

  • (Object, nil) —

    UUID of the instance to manage if known, this is VMware’s unique identifier.,This is required if name is not supplied.



24
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_powerstate.rb', line 24

attribute :uuid