Class: Ansible::Ruby::Modules::Vmware_tag
- Inherits:
-
Base
- Object
- Ansible::Ruby::Models::Base
- Base
- Ansible::Ruby::Modules::Vmware_tag
- Defined in:
- lib/ansible/ruby/modules/generated/cloud/vmware/vmware_tag.rb
Overview
This module can be used to create / delete / update VMware tags. Tag feature is introduced in vSphere 6 version, so this module is not supported in the earlier versions of vSphere. All variables and VMware object names are case sensitive.
Instance Method Summary collapse
-
#category_id ⇒ String?
The unique ID generated by vCenter should be used to.,User can get this unique ID from facts module.
-
#state ⇒ :present, ...
The state of tag.,If set to C(present) and tag does not exists, then tag is created.,If set to C(present) and tag exists, then tag is updated.,If set to C(absent) and tag exists, then tag is deleted.,If set to C(absent) and tag does not exists, no action is taken.
-
#tag_description ⇒ String?
The tag description.,This is required only if C(state) is set to C(present).,This parameter is ignored, when C(state) is set to C(absent).,Process of updating tag only allows description change.
-
#tag_name ⇒ String
The name of tag to manage.
Methods inherited from Base
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
#category_id ⇒ String?
Returns The unique ID generated by vCenter should be used to.,User can get this unique ID from facts module.
22 |
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_tag.rb', line 22 attribute :category_id |
#state ⇒ :present, ...
Returns The state of tag.,If set to C(present) and tag does not exists, then tag is created.,If set to C(present) and tag exists, then tag is updated.,If set to C(absent) and tag exists, then tag is deleted.,If set to C(absent) and tag does not exists, no action is taken.
26 |
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_tag.rb', line 26 attribute :state |
#tag_description ⇒ String?
Returns The tag description.,This is required only if C(state) is set to C(present).,This parameter is ignored, when C(state) is set to C(absent).,Process of updating tag only allows description change.
18 |
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_tag.rb', line 18 attribute :tag_description |
#tag_name ⇒ String
Returns The name of tag to manage.
14 |
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_tag.rb', line 14 attribute :tag_name |