VMware GetVmCustomAttributes
CertifiedEnterprise EditionRead custom attributes from a vCenter VM
VMware GetVmCustomAttributes
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.
type: io.kestra.plugin.ee.vmware.vcenter.GetVmCustomAttributesExamples
Read custom attributes from a VM
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 *string
Password
server *string
Server hostname or IP
FQDN or IP of the vCenter or ESXi endpoint (no scheme or port).
username *string
Username
e.g. Administrator@vsphere.local for vCenter or root for ESXi.
vmName *string
VM name
Name of the VM whose custom attributes will be read.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150port integerstring
443Server port
Defaults to 443.
trustStorePath string
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.
