Class: Ansible::Ruby::Modules::Vmware_guest_custom_attributes

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

Overview

This module can be used to add, remove and update custom attributes for the given 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

#attributes ⇒ Object?

Returns A list of name and value of custom attributes that needs to be manage.,Value of custom attribute is not required and will be ignored, if C(state) is set to C(absent).

Returns:

  • (Object, nil) —

    A list of name and value of custom attributes that needs to be manage.,Value of custom attribute is not required and will be ignored, if C(state) is set to C(absent).



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

attribute :attributes

#datacenter ⇒ Object

Returns Datacenter name where the virtual machine is located in.

Returns:

  • (Object) —

    Datacenter name where the virtual machine is located in.



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

attribute :datacenter

#folder ⇒ Object?

Returns Absolute path to find an existing guest.,This is required parameter, if C(name) is supplied and multiple virtual machines with same name are found.

Returns:

  • (Object, nil) —

    Absolute path to find an existing guest.,This is required parameter, if C(name) is supplied and multiple virtual machines with same name are found.



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

attribute :folder

#name ⇒ Object

Returns Name of the virtual machine to work with.

Returns:

  • (Object) —

    Name of the virtual machine to work with.



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

attribute :name

#state ⇒ :present, ...

Returns The action to take.,If set to C(present), then custom attribute is added or updated.,If set to C(absent), then custom attribute is removed.

Returns:

  • (:present, :absent, nil) —

    The action to take.,If set to C(present), then custom attribute is added or updated.,If set to C(absent), then custom attribute is removed.



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

attribute :state

#uuid ⇒ String?

Returns UUID of the virtual machine to manage if known. This is VMware’s unique identifier.,This is required parameter, if C(name) is not supplied.

Returns:

  • (String, nil) —

    UUID of the virtual machine to manage if known. This is VMware’s unique identifier.,This is required parameter, if C(name) is not supplied.



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

attribute :uuid