Get-VdcEngineFolder¶
SYNOPSIS¶
Get TLSPDC folder/engine assignments
SYNTAX¶
ID (Default)¶
Get-VdcEngineFolder [-ID] <String> [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
All¶
Get-VdcEngineFolder [-All] [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION¶
When the input is a policy folder, retrieves an array of assigned TLSPDC processing engines. When the input is a TLSPDC engine, retrieves an array of assigned policy folders. If there are no matching assignments, nothing will be returned.
EXAMPLES¶
EXAMPLE 1¶
Get-VdcEngineFolder -Path '\VED\Engines\MYVENSERVER'
Get an array of policy folders assigned to the TLSPDC processing engine 'MYVENSERVER'.
EXAMPLE 2¶
Get-VdcEngineFolder -Path '\VED\Policy\Certificates\Web Team'
Get an array of TLSPDC processing engines assigned to the policy folder '\VED\Policy\Certificates\Web Team'.
EXAMPLE 3¶
[guid]'866e1d59-d5d2-482a-b9e6-7bb657e0f416' | Get-VdcEngineFolder
When the GUID is assigned to a TLSPDC processing engine, returns an array of assigned policy folders. When the GUID is assigned to a policy folder, returns an array of assigned TLSPDC processing engines. Otherwise nothing will be returned.
PARAMETERS¶
-ID¶
The full DN path or Guid to a TLSPDC processing engine or policy folder.
Type: String
Parameter Sets: ID
Aliases: EngineGuid, Guid, EnginePath, Path
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-All¶
Get all engine/folder assignments
Type: SwitchParameter
Parameter Sets: All
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
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, but this requires an environment variable VDC_SERVER to be set.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
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¶
ID¶
OUTPUTS¶
PSCustomObject¶
NOTES¶
RELATED LINKS¶
http://VenafiPS.readthedocs.io/en/latest/functions/Get-VdcEngineFolder/
https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Get-VdcEngineFolder.ps1