community.vmware.vmware_custom_attribute_manager module – Manage custom attributes from VMware for the given vSphere object
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_manager
.
New in community.vmware 3.2.0
Synopsis
This module can be used to add, remove and update custom attributes for the given vSphere object.
Parameters
Parameter |
Comments |
---|---|
A list of name and value of custom attributes that needs to be manage. Value of custom attribute is not required and will be ignored if |
|
Name of the attribute. |
|
Value of the attribute. Default: |
|
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 |
|
Name of the vSphere object to work with. |
|
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 |
|
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 virtual machine custom attributes
community.vmware.vmware_custom_attribute_manager:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
object_name: vm1
object_type: VirtualMachine
state: present
custom_attributes:
- name: MyAttribute
value: MyValue
delegate_to: localhost
- name: Add multiple virtual machine custom attributes
community.vmware.vmware_custom_attribute_manager:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
object_name: vm1
object_type: VirtualMachine
state: present
custom_attributes:
- name: MyAttribute
value: MyValue
- name: MyAttribute2
value: MyValue2
delegate_to: localhost
- name: Remove virtual machine Attribute
community.vmware.vmware_custom_attribute_manager:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
object_name: vm1
object_type: VirtualMachine
state: absent
custom_attributes:
- name: MyAttribute
delegate_to: localhost
register: attributes