community / community.vmware / 4.2.0 / module / vmware_custom_attribute Manage custom attributes definitions | "added in version" 3.2.0 of community.vmware" Authors: Mario Lenz (@mariolenz)community.vmware.vmware_custom_attribute (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 and remove custom attributes definitions for various vSphere objects.
- 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
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: - Manage definition of custom attributes. - If set to V(present) and definition not present, then custom attribute definition is created. - If set to V(present) and definition is present, then no action taken. - If set to V(absent) and definition is present, then custom attribute definition is removed. - If set to V(absent) and definition is absent, then no action taken. 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_type: choices: - Cluster - Datacenter - Datastore - DistributedVirtualPortgroup - DistributedVirtualSwitch - Folder - Global - 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_attribute: description: - Name of the custom attribute. required: true type: str