community.vmware.vmware_custom_attribute module – Manage custom attributes definitions
Note
This module is part of the community.vmware collection (version 4.8.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_custom_attribute
.
New in community.vmware 3.2.0
Synopsis
This module can be used to add and remove custom attributes definitions for various vSphere objects.
Parameters
Parameter |
Comments |
---|---|
Name of the custom attribute. |
|
The hostname or IP address of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Type of the object the custom attribute is associated with. Choices:
|
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Default: |
|
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 |
|
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 |
|
Manage definition of custom attributes. If set to If set to If set to If set to Choices:
|
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.
Examples
- name: Add VM Custom Attribute Definition
community.vmware.vmware_custom_attribute:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
state: present
object_type: VirtualMachine
custom_attribute: custom_attr_def_1
delegate_to: localhost
register: defs
- name: Remove VM Custom Attribute Definition
community.vmware.vmware_custom_attribute:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
state: absent
object_type: VirtualMachine
custom_attribute: custom_attr_def_1
delegate_to: localhost
register: defs