New in version 2.7.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
category_cardinality |
| The category cardinality. This parameter is ignored, when updating existing category. |
category_description | Default: | The category description. This is required only if state is set to present .This parameter is ignored, when state is set to absent . |
category_name required | The name of category to manage. | |
hostname | The hostname or IP address of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead. | |
new_category_name | The new name for an existing category. This value is used while updating an existing category. | |
password | The password of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.aliases: pass, pwd | |
protocol |
| The connection to protocol. |
state |
| The state of category. If set to present and category does not exists, then category is created.If set to present and category exists, then category is updated.If set to absent and category exists, then category is deleted.If set to absent and category does not exists, no action is taken.Process of updating category only allows name, description change. |
username | The username of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.aliases: user, admin | |
validate_certs bool |
| Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead. |
Note
- 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
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
category_results dict | on success | dictionary of category metadata Sample: {'msg': 'Category NewCat_0001 updated.', 'category_id': 'urn:vmomi:InventoryServiceCategory:d7120bda-9fa5-4f92-9d71-aa1acff2e5a8:GLOBAL'} |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/vmware_category_module.html