Get-TppCustomField

SYNOPSIS

Get custom field details

SYNTAX

Get-TppCustomField [-Class] <String> [[-TppSession] <TppSession>] [<CommonParameters>]

DESCRIPTION

Get details about custom fields for either certificates or devices

EXAMPLES

EXAMPLE 1

Get-TppCustomField -Class 'X509 Certificate'

Get custom fields for certificates

PARAMETERS

-Class

Class to get details on. Value can be either Device or X509 Certificate

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TppSession

Session object created from New-TppSession method. The value defaults to the script session object $TppSession.

Type: TppSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: $Script:TppSession
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 TppSession

http://venafitppps.readthedocs.io/en/latest/functions/Get-TppCustomField/

https://docs.venafi.com/Docs/20.4SDK/TopNav/Content/SDK/WebSDK/r-SDK-POST-Metadata-GetItemsForClass.php?tocpath=Web%20SDK%7CMetadata%20custom%20fields%20programming%20interface%7C_____10