saltext.vmware.modules.tag#

saltext.vmware.modules.tag.create(tag_name, category_id, description='')[source]#

Create a new tag.

tag_name: Name of tag.
category_id: (string) Category ID of type: com.vmware.cis.tagging.Tag.
description: (optional) Description for the tag being created.

saltext.vmware.modules.tag.get(tag_id)[source]#

Returns info on given tag.

tag_id: (string) Tag ID of type: com.vmware.cis.tagging.Tag.

saltext.vmware.modules.tag.update(tag_id, tag_name=None, description=None)[source]#

Updates give tag.

tag_id: (string) Tag ID of type: com.vmware.cis.tagging.Tag.
tag_name: Name of tag.
description: (optional) Description for the tag being created.

saltext.vmware.modules.tag.delete(tag_id)[source]#

Delete given tag.

tag_id: (string) Tag ID of type: com.vmware.cis.tagging.Tag.

saltext.vmware.modules.tag.list_()[source]#: Lists IDs for all the tags on a given vCenter.

saltext.vmware.modules.tag.list_category()[source]#: Lists IDs for all the categories on a given vCenter.

saltext.vmware.modules.tag.get_category(category_id)[source]#

Returns info on given category.

category_id: (string) Category ID of type: com.vmware.cis.tagging.Category.

saltext.vmware.modules.tag.create_category(category_name, associable_types, cardinality, description='')[source]#

Create a new category.

category_name: The display name of the category.
associable_types: (list) Object types to which this category’s tags can be attached.
cardinality: The CategoryModel.Cardinality enumerated type defines the number of tags in a category that can be assigned to an object. SINGLE, MULTIPLE
description: (optional) The description of the category.

saltext.vmware.modules.tag.update_category(category_id, category_name=None, associable_types=None, cardinality=None, description='')[source]#

Update a new category.

category_id: The identifier of the category to be updated. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.
category_name: The display name of the category.
associable_types: (list) Object types to which this categorys tags can be attached.
cardinality: The CategoryModel.Cardinality enumerated type defines the number of tags in a category that can be assigned to an object. SINGLE, MULTIPLE
description: (optional) The description of the category.

saltext.vmware.modules.tag.delete_category(category_id)[source]#

Delete given category.

category_id: The identifier of category to be deleted. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.