Skip to content

Invoke-NSUnsetAAARADIUSParams

SYNOPSIS

Clears one or more NetScaler aaaradiusparams resource properties.

SYNTAX

Invoke-NSUnsetAAARADIUSParams [-AccountIng] [-Authentication] [-Authservretry] [-AuthTimeout]
 [-Callingstationid] [-DefaultAuthenticationGroup] [-IpattributeType] [-Ipvendorid] [-MessageAuthenticator]
 [-Passencoding] [-PwdattributeType] [-Pwdvendorid] [-RadattributeType] [-RadGroupSeparator] [-RadGroupSprefix]
 [-Radnasid] [-RadnaSIP] [-Radvendorid] [-ServerIp] [-ServerPort] [-TunnelendpointClientIp]
 [[-Session] <PSObject>] [-IgnoreNotFound] [-ReturnNullOnNotFound] [-ThrowOnWarning] [-PassThru] [-WhatIf]
 [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for RADIUS parameter resource.

EXAMPLES

EXAMPLE 1

Invoke-NSUnsetAAARADIUSParams -AccountIng ON -PassThru

EXAMPLE 2

Invoke-NSUnsetAAARADIUSParams -AccountIng ON -WhatIf

PARAMETERS

-AccountIng

Configure the RADIUS server state to accept or refuse accounting messages. Possible values = ON, OFF

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Authentication

Configure the RADIUS server state to accept or refuse authentication messages. Default value: ON Possible values = ON, OFF

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Authservretry

Number of retry by the Citrix ADC before getting response from the RADIUS server. Default value: 3 Minimum value = 1 Maximum value = 10

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-AuthTimeout

Maximum number of seconds that the Citrix ADC waits for a response from the RADIUS server. Default value: 3 Minimum value = 1

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Callingstationid

Send Calling-Station-ID of the client to the RADIUS server. IP Address of the client is sent as its Calling-Station-ID. Default value: DISABLED Possible values = ENABLED, DISABLED

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-DefaultAuthenticationGroup

This is the default group that is chosen when the authentication succeeds in addition to extracted groups. Maximum length = 64

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-IpattributeType

IP attribute type in the RADIUS response. Minimum value = 1

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Ipvendorid

Vendor ID attribute in the RADIUS response. If the attribute is not vendor-encoded, it is set to 0.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-MessageAuthenticator

Control whether the Message-Authenticator attribute is included in a RADIUS Access-Request packet. Default value: ON Possible values = ON, OFF

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Passencoding

Enable password encoding in RADIUS packets that the Citrix ADC sends to the RADIUS server. Default value: mschapv2 Possible values = pap, chap, mschapv1, mschapv2

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-PwdattributeType

Attribute type of the Vendor ID in the RADIUS response. Minimum value = 1

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Pwdvendorid

Vendor ID of the password in the RADIUS response. Used to extract the user password. Minimum value = 1

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-RadattributeType

Attribute type for RADIUS group extraction. Minimum value = 1

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-RadGroupSeparator

Group separator string that delimits group names within a RADIUS attribute for RADIUS group extraction.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-RadGroupSprefix

Prefix string that precedes group names within a RADIUS attribute for RADIUS group extraction.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Radnasid

Send the Network Access Server ID (NASID) for your Citrix ADC to the RADIUS server as the nasid part of the Radius protocol.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-RadnaSIP

Send the Citrix ADC IP (NSIP) address to the RADIUS server as the Network Access Server IP (NASIP) part of the Radius protocol. Possible values = ENABLED, DISABLED

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Radvendorid

Vendor ID for RADIUS group extraction. Minimum value = 1

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ServerIp

IP address of your RADIUS server. Minimum length = 1

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ServerPort

Port number on which the RADIUS server listens for connections. Default value: 1812 Minimum value = 1

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-TunnelendpointClientIp

Send Tunnel Endpoint Client IP address to the RADIUS server. Default value: DISABLED Possible values = ENABLED, DISABLED

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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