Class: Ansible::Ruby::Modules::Vmware_guest_facts

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

Overview

Gather facts about a single VM on a VMware ESX cluster

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

#datacenter ⇒ String

Returns Destination datacenter for the deploy operation.

Returns:

  • (String) —

    Destination datacenter for the deploy operation



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

attribute :datacenter

#folder ⇒ String?

Returns Destination folder, absolute or relative path to find an existing guest.,This is required if name is supplied.,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.,This is required if name is supplied.,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



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_facts.rb', line 23

attribute :folder

#name ⇒ Object?

Returns Name of the VM to work with,This is required if UUID is not supplied.

Returns:

  • (Object, nil) —

    Name of the VM to work with,This is required if UUID is not supplied.



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

attribute :name

#name_match ⇒ :first, ...

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

Returns:

  • (:first, :last, nil) —

    If multiple VMs matching the name, use the first or last found



15
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_facts.rb', line 15

attribute :name_match

#uuid ⇒ String?

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

Returns:

  • (String, nil) —

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



19
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_guest_facts.rb', line 19

attribute :uuid