VMware GetVmCustomAttributes

VMware GetVmCustomAttributes

Certified
Enterprise Edition

Read custom attributes from a vCenter VM

Reads the customValue property from a named VM and cross-references it with the CustomFieldsManager field definitions to return a map of attribute name to value. Returns an empty map when no custom attributes are set on the VM.

yaml
type: io.kestra.plugin.ee.vmware.vcenter.GetVmCustomAttributes

Read custom attributes from a VM

yaml
id: get_vm_custom_attributes
namespace: company.team

tasks:
  - id: get_attrs
    type: io.kestra.plugin.ee.vmware.vcenter.GetVmCustomAttributes
    server: "vcenter.mycompany.com"
    username: "{{ secret('VMWARE_VCENTER_USERNAME') }}"
    password: "{{ secret('VMWARE_VCENTER_PASSWORD') }}"
    vmName: "my-vm"
Properties

Password

Server hostname or IP

FQDN or IP of the vCenter or ESXi endpoint (no scheme or port).

Username

e.g. Administrator@vsphere.local for vCenter or root for ESXi.

VM name

Name of the VM whose custom attributes will be read.

Reference (ref) of the pluginDefaults to apply to this task.

Default443

Server port

Defaults to 443.

Trust store path

Optional path to a PKCS12 trust store containing the CA certificate(s) used to validate the vCenter/ESXi server's TLS certificate. If omitted (or if the path does not exist), the JVM's default trust store (system CA certificates) is used instead. Certificate validation is always enforced; this plugin never disables TLS certificate validation.