community / community.vmware / 4.2.0 / module / vmware_category Manage VMware categories Authors: Abhijeet Kasurde (@Akasurde)community.vmware.vmware_category (4.2.0) — module
Install with ansible-galaxy collection install community.vmware:==4.2.0
collections: - name: community.vmware version: 4.2.0
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.
- name: Create a category community.vmware.vmware_category: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" category_name: Sample_Cat_0001 category_description: Sample Description category_cardinality: 'multiple' state: present
- name: Rename category community.vmware.vmware_category: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" category_name: Sample_Category_0001 new_category_name: Sample_Category_0002 state: present
- name: Update category description community.vmware.vmware_category: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" category_name: Sample_Category_0001 category_description: Some fancy description state: present
- name: Delete category community.vmware.vmware_category: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" category_name: Sample_Category_0002 state: absent
- name: Create category with 2 associable object types community.vmware.vmware_category: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' category_name: 'Sample_Category_0003' category_description: 'sample description' associable_object_types: - Datastore - Cluster state: present
port: default: 443 description: - The port number of the vSphere vCenter. - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT) will be used instead. type: int state: choices: - present - absent default: present description: - The state of category. - If set to V(present) and category does not exists, then category is created. - If set to V(present) and category exists, then category is updated. - If set to V(absent) and category exists, then category is deleted. - If set to V(absent) and category does not exists, no action is taken. - Process of updating category only allows name, description change. type: str hostname: description: - The hostname or IP address of the vSphere vCenter server. - If the value is not specified in the task, the value of environment variable E(VMWARE_HOST) will be used instead. type: str password: aliases: - pass - pwd description: - The password of the vSphere vCenter server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD) will be used instead. type: str protocol: choices: - http - https default: https description: - The connection to protocol. type: str username: aliases: - admin - user description: - The username of the vSphere vCenter server. - If the value is not specified in the task, the value of environment variable E(VMWARE_USER) will be used instead. type: str proxy_host: description: - Address of a proxy that will receive all HTTPS requests and relay them. - The format is a hostname or a IP. - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_HOST) will be used instead. required: false type: str proxy_port: description: - Port of the HTTP proxy that will receive all HTTPS requests and relay them. - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_PORT) will be used instead. required: false type: int category_name: description: - The name of category to manage. required: true type: str validate_certs: default: true description: - Allows connection when SSL certificates are not valid. - Set to V(false) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS) will be used instead. type: bool new_category_name: description: - The new name for an existing category. - This value is used while updating an existing category. type: str category_cardinality: choices: - multiple - single default: multiple description: - The category cardinality. - This parameter is ignored, when updating existing category. - V(single) means an object can only be assigned one of the tags in this category. For example, if a O(category_name=Operating System), then different tags of this category would be "Windows", "Linux", and so on. In this case a VM object can be assigned only one of these tags and hence the cardinality of the associated category here is V(single). - V(multiple) means an object can be assigned several of the tags in this category. For example, if a O(category_name=Server), then different tags of this category would be "AppServer", "DatabaseServer" and so on. In this case a VM object can be assigned more than one of the above tags and hence the cardinality of the associated category here is V(multiple). type: str category_description: default: '' description: - The category description. - This is required if O(state=present). - This parameter is ignored when O(state=absent). type: str associable_object_types: choices: - All objects - Cluster - Content Library - Datacenter - Datastore - Datastore Cluster - Distributed Port Group - Distributed Switch - Folder - Host - Library item - Network - Host Network - Opaque Network - Resource Pool - vApp - Virtual Machine description: - List of object types that can be associated with the given category. elements: str type: list
category_results: description: dictionary of category metadata returned: on success sample: category_id: urn:vmomi:InventoryServiceCategory:d7120bda-9fa5-4f92-9d71-aa1acff2e5a8:GLOBAL msg: Category NewCat_0001 updated. type: dict