Start SdnMuxCertificateRotation

Start-SdnMuxCertificateRotation

SYNOPSIS

Performs a certificate rotation operation for the Load Balancer Muxes.

SYNTAX

GenerateCertificate (Default)

Start-SdnMuxCertificateRotation -NetworkController <String> -Credential <PSCredential>
 [-NcRestCredential <PSCredential>] [-NcRestCertificate <X509Certificate>] [-GenerateCertificate]
 -CertPassword <SecureString> [-NotAfter <DateTime>] [-Force] [<CommonParameters>]

CertConfig

Start-SdnMuxCertificateRotation -NetworkController <String> -Credential <PSCredential>
 [-NcRestCredential <PSCredential>] [-NcRestCertificate <X509Certificate>] -CertRotateConfig <Hashtable>
 [-Force] [<CommonParameters>]

Pfx

Start-SdnMuxCertificateRotation -NetworkController <String> -Credential <PSCredential>
 [-NcRestCredential <PSCredential>] [-NcRestCertificate <X509Certificate>] -CertPath <String>
 -CertPassword <SecureString> [-Force] [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

Example 1

PS C:\> {{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-NetworkController

{{ Fill NetworkController Description }}

Type: String
Parameter Sets: (All)
Aliases:

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

-Credential

Specifies a user account that has permission to perform this action on the Load Balancer Mux and Network Controller nodes. The default is the current user.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-NcRestCredential

Specifies a user account that has permission to perform this action against the Network Controller REST API. The default is the current user.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: [System.Management.Automation.PSCredential]::Empty
Accept pipeline input: False
Accept wildcard characters: False

-NcRestCertificate

Specifies the client certificate that is used for a secure web request to Network Controller REST API. Enter a variable that contains a certificate or a command or expression that gets the certificate.

Type: X509Certificate
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CertPath

Path directory where certificate(s) .pfx files are located for use with certificate rotation.

Type: String
Parameter Sets: Pfx
Aliases:

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

-GenerateCertificate

Switch to determine if certificate rotate function should generate self-signed certificates.

Type: SwitchParameter
Parameter Sets: GenerateCertificate
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-CertPassword

SecureString password for accessing the .pfx files, or if using -GenerateCertificate, what the .pfx files will be encrypted with.

Type: SecureString
Parameter Sets: GenerateCertificate, Pfx
Aliases:

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

-NotAfter

Expiration date when using -GenerateCertificate. If ommited, defaults to 3 years.

Type: DateTime
Parameter Sets: GenerateCertificate
Aliases:

Required: False
Position: Named
Default value: (Get-Date).AddYears(3)
Accept pipeline input: False
Accept wildcard characters: False

-CertRotateConfig

The Config generated by New-SdnCertificateRotationConfig to include appropriate certificate thumbprints for mux nodes.

Type: Hashtable
Parameter Sets: CertConfig
Aliases:

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

-Force

Switch to force the rotation without being prompted, when Service Fabric is unhealthy.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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

OUTPUTS

NOTES

RELATED LINKS