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.15.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.
Requirements
The below requirements are needed on the host that executes this module.
- PyVmomi
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
attributes list / elements=dictionary | Default: [] | 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 state is set to absent . | |
name string / required | Name of the attribute. | ||
value string | Default: "" | Value of the attribute. | |
esxi_hostname string / required | Name of the ESXi host to work with. This is a required parameter | ||
hostname string | 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 VMWARE_HOST will be used instead.Environment variable support added in Ansible 2.6. | ||
password string | The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.Environment variable support added in Ansible 2.6. aliases: pass, pwd | ||
port integer | Default: 443 | The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.Environment variable support added in Ansible 2.6. | |
proxy_host string | 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 VMWARE_PROXY_HOST will be used instead.This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 | ||
proxy_port integer | 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 VMWARE_PROXY_PORT will be used instead. | ||
state string |
| The action to take. If set to present , then custom attribute is added or updated.If set to absent , then custom attribute is removed. | |
username string | The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.Environment variable support added in Ansible 2.6. aliases: admin, user | ||
validate_certs boolean |
| 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.Environment variable support added in Ansible 2.6. If set to true , please make sure Python >= 2.7.9 is installed on the given machine. |
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 | Returned | Description |
---|---|---|
custom_attributes dictionary | changed | metadata about the ESXi host attributes 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)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_host_custom_attributes_module.html