Invoke ADCAddSslcertkey - j81blog/J81.ADCToolkit GitHub Wiki
Add SSL configuration Object.
Invoke-ADCAddSslcertkey [-Certkey] <String> [-Cert] <String> [[-Key] <String>] [[-Password] <Boolean>]
[[-Fipskey] <String>] [[-Hsmkey] <String>] [[-Inform] <String>] [[-Passplain] <String>]
[[-Expirymonitor] <String>] [[-Notificationperiod] <Double>] [[-Bundle] <String>] [-PassThru] [-WhatIf]
[-Confirm] [<CommonParameters>]
Configuration for certificate key resource.
Invoke-ADCAddSslcertkey -certkey <string> -cert <string>
An example how to add sslcertkey configuration Object(s).
Name for the certificate and private-key pair. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the certificate-key pair is created.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseName of and, optionally, path to the X509 certificate file that is used to form the certificate-key pair. The certificate file should be present on the appliance's hard-disk drive or solid-state drive. Storing a certificate in any location other than the default might cause inconsistency in a high availability setup. /nsconfig/ssl/ is the default path.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseName of and, optionally, path to the private-key file that is used to form the certificate-key pair. The certificate file should be present on the appliance's hard-disk drive or solid-state drive. Storing a certificate in any location other than the default might cause inconsistency in a high availability setup. /nsconfig/ssl/ is the default path.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePassphrase that was used to encrypt the private-key. Use this option to load encrypted private-keys in PEM format.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseName of the FIPS key that was created inside the Hardware Security Module (HSM) of a FIPS appliance, or a key that was imported into the HSM.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseName of the HSM key that was created in the External Hardware Security Module (HSM) of a FIPS appliance.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseInput format of the certificate and the private-key files. The three formats supported by the appliance are: PEM - Privacy Enhanced Mail DER - Distinguished Encoding Rule PFX - Personal Information Exchange. Possible values = DER, PEM, PFX
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: PEM
Accept pipeline input: False
Accept wildcard characters: FalsePass phrase used to encrypt the private-key. Required when adding an encrypted private-key in PEM format.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIssue an alert when the certificate is about to expire. Possible values = ENABLED, DISABLED
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseTime, in number of days, before certificate expiration, at which to generate an alert that the certificate is about to expire.
Type: Double
Parameter Sets: (All)
Aliases:
Required: False
Position: 11
Default value: 0
Accept pipeline input: False
Accept wildcard characters: FalseParse the certificate chain as a single file after linking the server certificate to its issuer's certificate within the file. Possible values = YES, NO
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 12
Default value: NO
Accept pipeline input: False
Accept wildcard characters: FalseReturn details about the created sslcertkey item.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseShows 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: FalsePrompts 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: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
File Name : Invoke-ADCAddSslcertkey Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/ssl/sslcertkey/ Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.