Invoke-TppCertificateRenewal

SYNOPSIS

Renew a certificate

SYNTAX

ByObject

Invoke-TppCertificateRenewal -InputObject <TppObject> [-TppSession <TppSession>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

ByPath

Invoke-TppCertificateRenewal -Path <String> [-TppSession <TppSession>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Requests renewal for an existing certificate. This call marks a certificate for immediate renewal. The certificate must not be in error, already being processed, or configured for Monitoring in order for it be renewable. You must have Write access to the certificate object being renewed.

EXAMPLES

EXAMPLE 1

Invoke-TppCertificateRenewal -Path '\VED\Policy\My folder\app.mycompany.com'

PARAMETERS

-InputObject

TppObject which represents a unique object

Type: TppObject
Parameter Sets: ByObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Path

Path to the certificate to remove

Type: String
Parameter Sets: ByPath
Aliases: DN, CertificateDN

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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: Named
Default value: $Script:TppSession
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 or Path

OUTPUTS

PSCustomObject with the following properties:

Path - Certificate path

Success - A value of true indicates that the renewal request was successfully submitted and

granted.

Error - Indicates any errors that occurred. Not returned when successful

NOTES

http://venafitppps.readthedocs.io/en/latest/functions/Invoke-TppCertificateRenewal/

https://github.com/gdbarron/VenafiTppPS/blob/main/VenafiTppPS/Code/Public/Invoke-TppCertificateRenewal.ps1

https://docs.venafi.com/Docs/20.4SDK/TopNav/Content/SDK/WebSDK/r-SDK-POST-Certificates-renew.php?tocpath=Web%20SDK%7CCertificates%20programming%20interface%7C_____16