Add-TppCertificateAssociation¶
SYNOPSIS¶
Add certificate association
SYNTAX¶
AddByObject¶
Add-TppCertificateAssociation -InputObject <TppObject> [-ApplicationPath <String[]>] [-PushCertificate]
[-VenafiSession <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>]
AddByPath¶
Add-TppCertificateAssociation -CertificatePath <String> [-ApplicationPath <String[]>] [-PushCertificate]
[-VenafiSession <PSObject>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION¶
Associates one or more Application objects to an existing certificate. Optionally, you can push the certificate once the association is complete.
EXAMPLES¶
EXAMPLE 1¶
Add-TppCertificateAssociation -CertificatePath '\ved\policy\my cert' -ApplicationPath '\ved\policy\my capi'
Add a single application object association
EXAMPLE 2¶
Add-TppCertificateAssociation -Path '\ved\policy\my cert' -ApplicationPath '\ved\policy\my capi' -PushCertificate
Add the association and push the certificate
PARAMETERS¶
-InputObject¶
TppObject which represents a certificate
Type: TppObject
Parameter Sets: AddByObject
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-CertificatePath¶
Path to the certificate. Required if InputObject not provided.
Type: String
Parameter Sets: AddByPath
Aliases: DN, CertificateDN
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-ApplicationPath¶
List of application object paths to associate
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PushCertificate¶
Push the certificate after associating it to the Application objects. This will only be successful if the certificate management type is Provisioning and is not disabled, in error, or a push is already in process.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: ProvisionCertificate
Required: False
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 TPP token or VaaS key can also provided. If providing a TPP token, an environment variable named TPP_SERVER must also be set.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
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¶
InputObject, Path¶
OUTPUTS¶
None¶
NOTES¶
You must have: - Write permission to the Certificate object. - Write or Associate and Delete permission to Application objects that are associated with the certificate
RELATED LINKS¶
http://VenafiPS.readthedocs.io/en/latest/functions/Add-TppCertificateAssociation/
https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Add-TppCertificateAssociation.ps1