< Back
Get-VsphereCustomAttribute
Post
NAME Get-VsphereCustomAttribute
SYNOPSIS
Retrieves VM or Host custom attributes.
SYNTAX
Get-VsphereCustomAttribute -VsphereObjectId <String[]> -Connection <Hashtable> [<CommonParameters>]
Get-VsphereCustomAttribute -InputObject <PSObject[]> -Connection <Hashtable> [<CommonParameters>]
DESCRIPTION
Retrieves VM or Host custom attributes.
PARAMETERS
-VsphereObjectId <String[]>
ID (managed object reference) of the VM or host for which custom attributes are to be retrieved.
Required? true
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Connection <Hashtable>
Specifies connection information to the vCenter server. For example:
@{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license
key>;SkipCertificateValidation=$false}
Required? true
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSObject[]>
Object representing the VM or host for which custom attributes are to be retrieved. Use Get-VsphereObject to
retrieve input object.
Required? true
Position? named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Management.Automation.PSObject[]
OUTPUTS
System.Management.Automation.PSObject
Attribute Key - Unique custom attribute identifier.
Attribute Name - Name of the custom attribute.
Attribute Type - Custom attribute type. Can be Global, Host or VM
Attribute Value - Custom attribute value.
RELATED LINKS
SYNOPSIS
Retrieves VM or Host custom attributes.
SYNTAX
Get-VsphereCustomAttribute -VsphereObjectId <String[]> -Connection <Hashtable> [<CommonParameters>]
Get-VsphereCustomAttribute -InputObject <PSObject[]> -Connection <Hashtable> [<CommonParameters>]
DESCRIPTION
Retrieves VM or Host custom attributes.
PARAMETERS
-VsphereObjectId <String[]>
ID (managed object reference) of the VM or host for which custom attributes are to be retrieved.
Required? true
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Connection <Hashtable>
Specifies connection information to the vCenter server. For example:
@{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license
key>;SkipCertificateValidation=$false}
Required? true
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <PSObject[]>
Object representing the VM or host for which custom attributes are to be retrieved. Use Get-VsphereObject to
retrieve input object.
Required? true
Position? named
Default value
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Management.Automation.PSObject[]
OUTPUTS
System.Management.Automation.PSObject
Attribute Key - Unique custom attribute identifier.
Attribute Name - Name of the custom attribute.
Attribute Type - Custom attribute type. Can be Global, Host or VM
Attribute Value - Custom attribute value.
RELATED LINKS