Invoke ADCCreateSslrsakey - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCCreateSslrsakey

SYNOPSIS

Create SSL configuration Object.

SYNTAX

Invoke-ADCCreateSslrsakey [-Keyfile] <String> [-Bits] <Double> [[-Exponent] <String>] [[-Keyform] <String>]
 [[-Des] <Boolean>] [[-Des3] <Boolean>] [[-Aes256] <Boolean>] [[-Password] <String>] [[-Pkcs8] <Boolean>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for RSA key resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCCreateSslrsakey -keyfile <string> -bits <double>

An example how to create sslrsakey configuration Object(s).

PARAMETERS

-Keyfile

Name for and, optionally, path to the RSA key file. /nsconfig/ssl/ is the default path.

Type: String
Parameter Sets: (All)
Aliases:

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

-Bits

Size, in bits, of the RSA key.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Exponent

Public exponent for the RSA key. The exponent is part of the cipher algorithm and is required for creating the RSA key. Possible values = 3, F4

Type: String
Parameter Sets: (All)
Aliases:

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

-Keyform

Format in which the RSA key file is stored on the appliance. Possible values = DER, PEM

Type: String
Parameter Sets: (All)
Aliases:

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

-Des

Encrypt the generated RSA key by using the DES algorithm. On the command line, you are prompted to enter the pass phrase (password) that is used to encrypt the key.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Des3

Encrypt the generated RSA key by using the Triple-DES algorithm. On the command line, you are prompted to enter the pass phrase (password) that is used to encrypt the key.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Aes256

Encrypt the generated RSA key by using the AES algorithm.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Password

Pass phrase to use for encryption if DES or DES3 option is selected.

Type: String
Parameter Sets: (All)
Aliases:

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

-Pkcs8

Create the private key in PKCS#8 format.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

OUTPUTS

NOTES

File Name : Invoke-ADCCreateSslrsakey Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/ssl/sslrsakey/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.

RELATED LINKS

https://blog.j81.nl

⚠️ **GitHub.com Fallback** ⚠️