Get-VdcCustomField¶
SYNOPSIS¶
Get custom field details
SYNTAX¶
Get-VdcCustomField [-Class] <String> [[-VenafiSession] <PSObject>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION¶
Get details about custom fields
EXAMPLES¶
EXAMPLE 1¶
PARAMETERS¶
-Class¶
Class to get details on
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-VenafiSession¶
Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TLSPDC token can also be provided. If providing a TLSPDC token, an environment variable named VDC_SERVER must also be set.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction¶
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS¶
None¶
OUTPUTS¶
Query returns a PSCustomObject with the following properties:¶
Items¶
AllowedValues¶
Classes¶
ConfigAttribute¶
DN¶
DefaultValues¶
Guid¶
Label¶
Mandatory¶
Name¶
Policyable¶
RenderHidden¶
RenderReadOnly¶
Single¶
Type¶
Locked¶
Result¶
NOTES¶
All custom fields are retrieved upon inital connect to the server and a property of VenafiSession
RELATED LINKS¶
http://VenafiPS.readthedocs.io/en/latest/functions/Get-VdcCustomField/