Class: Ansible::Ruby::Modules::Vmware_guest_tools_wait

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

Overview

This module can be used to wait for VMware tools to become available on the given VM and return facts.

Instance Method Summary collapse

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

#folderString?

Returns Destination folder, absolute or relative path to find an existing guest.,This is required only, if multiple VMs with same C(name) is found.,The folder should include the datacenter. ESX’s datacenter is C(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.

Returns:

  • (String, nil)

    Destination folder, absolute or relative path to find an existing guest.,This is required only, if multiple VMs with same C(name) is found.,The folder should include the datacenter. ESX’s datacenter is C(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



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

attribute :folder

#nameString?

Returns Name of the VM for which to wait until the tools become available.,This is required if uuid is not supplied.

Returns:

  • (String, nil)

    Name of the VM for which to wait until the tools become available.,This is required if uuid is not supplied.



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

attribute :name

#name_match:first, ...

Returns If multiple VMs match the name, use the first or last found.

Returns:

  • (:first, :last, nil)

    If multiple VMs match the name, use the first or last found.



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

attribute :name_match

#uuidString?

Returns UUID of the VM for which to wait until the tools become available, if known. This is VMware’s unique identifier.,This is required, if C(name) is not supplied.

Returns:

  • (String, nil)

    UUID of the VM for which to wait until the tools become available, if known. This is VMware’s unique identifier.,This is required, if C(name) is not supplied.



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

attribute :uuid