Class: Ansible::Ruby::Modules::Vmware_category

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

Overview

This module can be used to create / delete / update VMware categories. 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

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

#category_cardinality ⇒ :multiple, ...

Returns The category cardinality.,This parameter is ignored, when updating existing category.

Returns:

  • (:multiple, :single, nil) —

    The category cardinality.,This parameter is ignored, when updating existing category.



22
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_category.rb', line 22

attribute :category_cardinality

#category_description ⇒ String?

Returns The category 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).

Returns:

  • (String, nil) —

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



18
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_category.rb', line 18

attribute :category_description

#category_name ⇒ String

Returns The name of category to manage.

Returns:

  • (String) —

    The name of category to manage.



14
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_category.rb', line 14

attribute :category_name

#new_category_name ⇒ String?

Returns The new name for an existing category.,This value is used while updating an existing category.

Returns:

  • (String, nil) —

    The new name for an existing category.,This value is used while updating an existing category.



26
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_category.rb', line 26

attribute :new_category_name

#state ⇒ :present, ...

Returns The state of category.,If set to C(present) and category does not exists, then category is created.,If set to C(present) and category exists, then category is updated.,If set to C(absent) and category exists, then category is deleted.,If set to C(absent) and category does not exists, no action is taken.,Process of updating category only allows name, description change.

Returns:

  • (:present, :absent, nil) —

    The state of category.,If set to C(present) and category does not exists, then category is created.,If set to C(present) and category exists, then category is updated.,If set to C(absent) and category exists, then category is deleted.,If set to C(absent) and category does not exists, no action is taken.,Process of updating category only allows name, description change.



30
 
# File 'lib/ansible/ruby/modules/generated/cloud/vmware/vmware_category.rb', line 30

attribute :state