Add-TppEngineFolder¶
SYNOPSIS¶
Add policy folder assignments to a TPP processing engine
SYNTAX¶
Add-TppEngineFolder [-EnginePath] <String> [-FolderPath] <String[]> [[-VenafiSession] <PSObject>] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION¶
Add one or more policy folder assignments to a TPP processing engine.
EXAMPLES¶
EXAMPLE 1¶
Add-TppEngineFolder -EnginePath '\VED\Engines\MYVENAFI01' -FolderPath '\VED\Policy\Certificates\Web Team'
Add processing engine MYVENAFI01 to the policy folders '\VED\Policy\Certificates\Web Team'.
EXAMPLE 2¶
Add-TppEngineFolder -EnginePath '\VED\Engines\MYVENAFI01' -FolderPath @('\VED\Policy\Certificates\Web Team','\VED\Policy\Certificates\Database Team')
Add processing engine MYVENAFI01 to the policy folders '\VED\Policy\Certificates\Web Team' and '\VED\Policy\Certificates\Database Team'.
EXAMPLE 3¶
$EngineObjects | Add-TppEngineFolder -FolderPath @('\VED\Policy\Certificates\Web Team','\VED\Policy\Certificates\Database Team') -Confirm:$false
Add one or more processing engines via the pipeline to multiple policy folders. Suppress the confirmation prompt.
PARAMETERS¶
-EnginePath¶
The full DN path to a TPP processing engine.
Type: String
Parameter Sets: (All)
Aliases: EngineDN, Engine, Path
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-FolderPath¶
The full DN path to one or more policy folders (string array).
Type: String[]
Parameter Sets: (All)
Aliases: FolderDN, Folder
Required: True
Position: 2
Default value: None
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 TPP token can also provided, but this requires an environment variable TPP_SERVER to be set.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: $script:VenafiSession
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf¶
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm¶
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
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¶
EnginePath or EngineObject, FolderPath[]¶
OUTPUTS¶
None¶
NOTES¶
RELATED LINKS¶
http://VenafiPS.readthedocs.io/en/latest/functions/Add-TppEngineFolder/
https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Add-TppEngineFolder.ps1