Get-CustomAttribute Command | Vmware PowerCLI Reference


This cmdlet retrieves custom attributes. A custom attribute is a user-defined description field of one or more vSphere objects.


[ [-TargetType ] < CustomAttributeTargetType[] > ]
[-Global ]
[-Id < String[] > ]
[-Name < String[] > ]
[-Server < VIServer[] > ]


Required Parameter Name Type Position Features Description
optional TargetType CustomAttributeTargetType[] 1
Specifies a target type to filter the custom attributes by the type of objects to which they can be applied. The valid values are VirtualMachine, ResourcePool, Folder, VMHost, Cluster, Datacenter, and $null. If the value is $null, the custom attribute is global and applies to all target types.
optional Global SwitchParameter named
Indicates that only global custom attributes are retrieved. A global custom attribute can be applied both to hosts and virtual machines.
optional Id String[] named
  • wildcards
Specifies the IDs of the custom attributes you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.
optional Name String[] named
  • wildcards
Specifies the names of the custom attributes you want to retrieve.
optional Server VIServer[] named
  • wildcards
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.




Example 1

Get-CustomAttribute -Global

Retrieves all global custom attributes.

Example 2

Get-CustomAttribute -TargetType "VirtualMachine", "VMHost"

Retrieves all custom attributes of type VirtualMachine and VMHost.

Example 3

Get-CustomAttribute -Name "Creation*" -Global

Retrieves only global custom attributes that match the specified name pattern.

Related Commands


This cmdlet retrieves custom attributes.

This cmdlet creates a new custom attribute.

This cmdlet removes custom attributes.

This cmdlet renames a custom attribute.