community / community.vmware / 1.18.2 / module / vmware_guest_custom_attribute_defs Manage custom attributes definitions for virtual machine from VMware Authors: Jimmy Conner (@cigamit), Abhijeet Kasurde (@Akasurde)community.vmware.vmware_guest_custom_attribute_defs (1.18.2) — module
Install with ansible-galaxy collection install community.vmware:==1.18.2
collections: - name: community.vmware version: 1.18.2
This module can be used to add and remove custom attributes definitions for the given virtual machine from VMware.
- name: Add VMware Attribute Definition community.vmware.vmware_guest_custom_attribute_defs: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" state: present attribute_key: custom_attr_def_1 delegate_to: localhost register: defs
- name: Remove VMware Attribute Definition community.vmware.vmware_guest_custom_attribute_defs: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" state: absent attribute_key: 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 C(VMWARE_PORT) will be used instead. - Environment variable support added in Ansible 2.6. type: int state: choices: - present - absent default: present description: - Manage definition of custom attributes. - If set to C(present) and definition not present, then custom attribute definition is created. - If set to C(present) and definition is present, then no action taken. - If set to C(absent) and definition is present, then custom attribute definition is removed. - If set to C(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 C(VMWARE_HOST) will be used instead. - Environment variable support added in Ansible 2.6. 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 C(VMWARE_PASSWORD) will be used instead. - Environment variable support added in Ansible 2.6. 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 C(VMWARE_USER) will be used instead. - Environment variable support added in Ansible 2.6. 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 C(VMWARE_PROXY_HOST) will be used instead. - This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 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 C(VMWARE_PROXY_PORT) will be used instead. required: false type: int attribute_key: description: - Name of the custom attribute definition. - This is required parameter, if C(state) is set to C(present) or C(absent). required: false type: str validate_certs: default: true description: - Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) will be used instead. - Environment variable support added in Ansible 2.6. - If set to C(true), please make sure Python >= 2.7.9 is installed on the given machine. type: bool
custom_attribute_defs: description: list of all current attribute definitions returned: always sample: - sample_5 - sample_4 type: list