Skip to content

Invoke-NSAddSSLEchconfig

SYNOPSIS

Creates a NetScaler sslechconfig resource.

SYNTAX

Invoke-NSAddSSLEchconfig -EchCipher <String> -Echconfigid <Int32> [-EchconfigName] <String>
 -EchpublicName <String> -HpkeKeyName <String> [-Version <Int32>] [-Session <PSObject>] [-IgnoreNotFound]
 [-ReturnNullOnNotFound] [-ThrowOnWarning] [-PassThru] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for ech config resource.

EXAMPLES

EXAMPLE 1

Invoke-NSAddSSLEchconfig -EchconfigName 'example' -EchCipher AES128-GCM-HKDFSHA256 -Echconfigid 1 -EchpublicName 'example' -HpkeKeyName 'example' -PassThru

EXAMPLE 2

Invoke-NSAddSSLEchconfig -EchconfigName 'example' -EchCipher AES128-GCM-HKDFSHA256 -Echconfigid 1 -EchpublicName 'example' -HpkeKeyName 'example' -WhatIf

PARAMETERS

-EchCipher

The supported cipher suite that encrypts the client Hello Message. Possible values = AES128-GCM-HKDFSHA256, AES128-GCM-HKDFSHA384, AES128-GCM-HKDFSHA512, AES256-GCM-HKDFSHA256, AES256-GCM-HKDFSHA384, AES256-GCM-HKDFSHA512, CHACHA20-POLY1305-HKDFSHA256, CHACHA20-POLY1305-HKDFSHA384, CHACHA20-POLY1305-HKDFSHA512

Type: String
Parameter Sets: (All)
Aliases:

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

-Echconfigid

The config id of the ech config. Minimum value = 0 Maximum value = 255

Type: Int32
Parameter Sets: (All)
Aliases:

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

-EchconfigName

The ECH config name configured. Minimum length = 1

Type: String
Parameter Sets: (All)
Aliases:

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

-EchpublicName

The public name of ech config means FQDN or any string. Minimum length = 1

Type: String
Parameter Sets: (All)
Aliases:

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

-HpkeKeyName

The name of the configured HPKE key. Minimum length = 1

Type: String
Parameter Sets: (All)
Aliases:

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

-Version

The version of ECH for which this configuration is used. Default value: 65037

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Session

The NetScaler session. If omitted, the current default session is used.

Type: PSObject
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: (Get-NSSession)
Accept pipeline input: False
Accept wildcard characters: False

-IgnoreNotFound

Returns null instead of throwing for known NITRO not-found responses.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ReturnNullOnNotFound

Returns null instead of throwing for known NITRO not-found responses.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ThrowOnWarning

Treats NITRO warning responses as terminating errors.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-PassThru

Returns the updated resource after the operation completes.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

System.Management.Automation.PSCustomObject

NOTES

Generated from NetScaler NITRO API metadata. Generated: 2026-06-01 21:28 Supported metadata versions: 13.1, 14.1.