ansible / ansible.builtin / v2.9.3 / module / vmware_category Manage VMware categories | "added in version" 2.7 of ansible.builtin" Authors: Abhijeet Kasurde (@Akasurde) preview | supported by communityansible.builtin.vmware_category (v2.9.3) — module
pip
Install with pip install ansible==2.9.3
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 vmware_category: hostname: "{{ vcenter_server }}" username: "{{ vcenter_user }}" password: "{{ vcenter_pass }}" category_name: Sample_Cat_0001 category_description: Sample Description category_cardinality: 'multiple' state: present
- name: Rename category vmware_category: hostname: "{{ vcenter_server }}" username: "{{ vcenter_user }}" password: "{{ vcenter_pass }}" category_name: Sample_Category_0001 new_category_name: Sample_Category_0002 state: present
- name: Update category description vmware_category: hostname: "{{ vcenter_server }}" username: "{{ vcenter_user }}" password: "{{ vcenter_pass }}" category_name: Sample_Category_0001 category_description: Some fancy description state: present
- name: Delete category vmware_category: hostname: "{{ vcenter_server }}" username: "{{ vcenter_user }}" password: "{{ vcenter_pass }}" category_name: Sample_Category_0002 state: absent
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 C(VMWARE_PORT) will be used instead. type: int state: choices: - present - absent default: present description: - 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. 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 C(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 C(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 C(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 C(VMWARE_PROXY_HOST) will be used instead. required: false type: str version_added: 1.12.0 version_added_collection: community.vmware 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 C(VMWARE_PROXY_PORT) will be used instead. required: false type: int version_added: 1.12.0 version_added_collection: community.vmware 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 C(False) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable C(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. type: str category_description: default: '' description: - 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). type: str
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