community / community.vmware / 4.2.0 / module / vmware_custom_attribute_manager Manage custom attributes from VMware for the given vSphere object | "added in version" 3.2.0 of community.vmware" Authors: Mario Lenz (@mariolenz)community.vmware.vmware_custom_attribute_manager (4.2.0) — module
Install with ansible-galaxy collection install community.vmware:==4.2.0
collections: - name: community.vmware version: 4.2.0
This module can be used to add, remove and update custom attributes for the given vSphere object.
- 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
port: default: 443 description: - The port number of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT) will be used instead. type: int state: choices: - present - absent default: present description: - If set to V(present), the custom attribute is set to the given value. - If set to V(absent), the custom attribute is cleared. The given value is ignored in this case. type: str hostname: description: - 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 E(VMWARE_HOST) will be used instead. type: str password: aliases: - pass - pwd description: - The password of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD) will be used instead. type: str username: aliases: - admin - user description: - The username of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_USER) will be used instead. type: str proxy_host: description: - 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 E(VMWARE_PROXY_HOST) will be used instead. required: false type: str proxy_port: description: - 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 E(VMWARE_PROXY_PORT) will be used instead. required: false type: int object_name: description: - Name of the vSphere object to work with. required: true type: str object_type: choices: - Cluster - Datacenter - Datastore - DistributedVirtualPortgroup - DistributedVirtualSwitch - Folder - HostSystem - ResourcePool - VirtualMachine description: - Type of the object the custom attribute is associated with. required: true type: str validate_certs: default: true description: - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS) will be used instead. type: bool custom_attributes: description: - 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 O(state=absent). elements: dict required: true suboptions: name: description: - Name of the attribute. required: true type: str value: default: '' description: - Value of the attribute. type: str type: list