community.vmware.vmware_host_custom_attributes – Manage custom attributes from VMware for the given ESXi host
Note
This plugin is part of the community.vmware collection (version 1.17.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_host_custom_attributes
.
New in version 1.11.0: of community.vmware
Synopsis
This module can be used to add, remove and update custom attributes for the given ESXi host.
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 Default: [] |
|
Name of the attribute. |
|
Value of the attribute. Default: “” |
|
Name of the ESXi host to work with. This is a required parameter |
|
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 Environment variable support added in Ansible 2.6. |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. Default: 443 |
|
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 This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 |
|
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 |
|
The action to take. 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 Environment variable support added in Ansible 2.6. |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to Choices:
|
Notes
Note
Tested on vSphere 6.7
All modules requires API write access and hence is not supported on a free ESXi license.
Examples
- name: Add ESXi host custom attributes
community.vmware.vmware_host_custom_attributes:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
esxi_hostname: host1
state: present
attributes:
- name: MyAttribute
value: MyValue
delegate_to: localhost
register: attributes
- name: Remove ESXi host Attribute
community.vmware.vmware_host_custom_attributes:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
esxi_hostname: host1
state: absent
attributes:
- name: MyAttribute
delegate_to: localhost
register: attributes
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
metadata about the ESXi host attributes Returned: changed Sample: {“mycustom”: “my_custom_value”, “mycustom_2”: “my_custom_value_2”, “sample_1”: “sample_1_value”, “sample_2”: “sample_2_value”, “sample_3”: “sample_3_value”} |
Authors
Hunter Christain (@exp-hc)