PowerCLI Reference



This cmdlet retrieves custom attributes.


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

Related Commands

Online Version

Detailed Description

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


NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specifies the names of the custom attributes you want to retrieve.falseFalse
TargetTypeCustomAttributeTargetType[]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.falseFalse
GlobalSwitchParameterIndicates that only global custom attributes are retrieved. A global custom attribute can be applied both to hosts and virtual machines.falseFalse
IdString[]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.
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no 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.falseFalse

Return Type

Zero or more CustomAttribute objects



-------------------------- 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.

Copyright © VMware, Inc. All rights reserved.