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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Vmware_guest_powerstate

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

• #folder ⇒ String^?

  Destination folder, absolute or relative path to find an existing guest or create the new guest.,The folder should include the datacenter.

• #force ⇒ Symbol^?

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

• #name ⇒ String^?

  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).

• #name_match ⇒ :first, ...

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

• #scheduled_at ⇒ String^?

  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.

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

  Set the state of the virtual machine.

• #state_change_timeout ⇒ Integer^?

  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.

• #uuid ⇒ Object^?

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

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

#folder ⇒ String^?

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

attribute :folder

#force ⇒ Symbol^?

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

attribute :force

#name ⇒ String^?

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

attribute :name

#name_match ⇒ :first, ...

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

attribute :name_match

#scheduled_at ⇒ String^?

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

attribute :scheduled_at

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

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

attribute :state

#state_change_timeout ⇒ Integer^?

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

attribute :state_change_timeout

#uuid ⇒ Object^?

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

attribute :uuid