Invoke-SIAHttpsRelayCertificateRotation

SYNOPSIS

Rotate a SIA HTTPS relay certificate

SYNTAX

Invoke-SIAHttpsRelayCertificateRotation [-https_relay_id] <String>
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Initiates certificate rotation for an HTTPS relay. The relay must be active, in available mode, and support certificate rotation.

EXAMPLES

Example 1

Invoke-SIAHttpsRelayCertificateRotation -https_relay_id 1234-abcd

Queues a certificate rotation job for the specified HTTPS relay.

PARAMETERS

-https_relay_id

The unique identifier of the HTTPS relay.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
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

-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

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

System.String

OUTPUTS

System.Object

NOTES

Requires the DpaAdmin role.

RELATED LINKS