community.vmware.vmware_object_custom_attributes_info module – Gather custom attributes of an object

Note

This module is part of the community.vmware collection (version 4.8.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_object_custom_attributes_info.

Synopsis

  • This module can be gathered custom attributes of an object.

Parameters

Parameter

Comments

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.

moid

string

Managed Object ID of the instance to get if known, this is a unique identifier only within a single vCenter instance.

This is required if object_name is not supplied.

object_name

aliases: name

string

Name of the object to work with.

object_type

string / required

Type of an object to work with.

Choices:

  • "Datacenter"

  • "Cluster"

  • "HostSystem"

  • "ResourcePool"

  • "Folder"

  • "VirtualMachine"

  • "DistributedVirtualSwitch"

  • "DistributedVirtualPortgroup"

  • "Datastore"

password

aliases: pass, pwd

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.

port

integer

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.

Default: 443

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.

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.

username

aliases: admin, user

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.

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.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Supports check_mode.

  • All modules requires API write access and hence is not supported on a free ESXi license.

  • All variables and VMware object names are case sensitive.

Examples

- name: Gather custom attributes of a virtual machine
  community.vmware.vmware_object_custom_attributes_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    object_type: VirtualMachine
    object_name: "{{ object_name }}"
  register: vm_attributes

- name: Gather custom attributes of a virtual machine with moid
  community.vmware.vmware_object_custom_attributes_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    object_type: VirtualMachine
    moid: "{{ moid }}"
  register: vm_attributes

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

custom_attributes

list / elements=string

list of custom attributes of an object.

Returned: always

Sample: ["[\n    {\n        \"attribute\": \"example01\"", "\n        \"key\": 132", "\n        \"type\": \"VirtualMachine\"", "\n        \"value\": \"10\"\n    }", "\n    {\n        \"attribute\": \"example02\"", "\n        \"key\": 131", "\n        \"type\": \"VirtualMachine\"", "\n        \"value\": \"20\"\n    }", "\n    {\n        \"attribute\": \"example03\"", "\n        \"key\": 130", "\n        \"type\": \"VirtualMachine\"", "\n        \"value\": null\n    }\n]"]

Authors

  • sky-joker (@sky-joker)