Invoke ADCUpdateAaaradiusparams - j81blog/J81.ADCToolkit GitHub Wiki

Invoke-ADCUpdateAaaradiusparams

SYNOPSIS

Update AAA configuration Object.

SYNTAX

Invoke-ADCUpdateAaaradiusparams [[-Serverip] <String>] [[-Serverport] <Int32>] [[-Authtimeout] <Double>]
 [-Radkey] <String> [[-Radnasip] <String>] [[-Radnasid] <String>] [[-Radvendorid] <Double>]
 [[-Radattributetype] <Double>] [[-Radgroupsprefix] <String>] [[-Radgroupseparator] <String>]
 [[-Passencoding] <String>] [[-Ipvendorid] <Double>] [[-Ipattributetype] <Double>] [[-Accounting] <String>]
 [[-Pwdvendorid] <Double>] [[-Pwdattributetype] <Double>] [[-Defaultauthenticationgroup] <String>]
 [[-Callingstationid] <String>] [[-Authservretry] <Double>] [[-Authentication] <String>]
 [[-Tunnelendpointclientip] <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for RADIUS parameter resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUpdateAaaradiusparams -radkey <string>

An example how to update aaaradiusparams configuration Object(s).

PARAMETERS

-Serverip

IP address of your RADIUS server.

Type: String
Parameter Sets: (All)
Aliases:

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

-Serverport

Port number on which the RADIUS server listens for connections.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: 0
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.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Radkey

The key shared between the RADIUS server and clients. Required for allowing the Citrix ADC to communicate with the RADIUS server.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 5
Default value: None
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: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
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: String
Parameter Sets: (All)
Aliases:

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

-Radvendorid

Vendor ID for RADIUS group extraction.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Radattributetype

Attribute type for RADIUS group extraction.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Radgroupsprefix

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: None
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: String
Parameter Sets: (All)
Aliases:

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

-Passencoding

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
Default value: None
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: Double
Parameter Sets: (All)
Aliases:

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

-Ipattributetype

IP attribute type in the RADIUS response.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Accounting

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

Type: String
Parameter Sets: (All)
Aliases:

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

-Pwdvendorid

Vendor ID of the password in the RADIUS response. Used to extract the user password.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Pwdattributetype

Attribute type of the Vendor ID in the RADIUS response.

Type: Double
Parameter Sets: (All)
Aliases:

Required: False
Position: 17
Default value: 0
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.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 18
Default value: None
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. Possible values = ENABLED, DISABLED

Type: String
Parameter Sets: (All)
Aliases:

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

-Authservretry

Number of retry by the Citrix ADC before getting response from the RADIUS server.

Type: Double
Parameter Sets: (All)
Aliases:

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

-Authentication

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

Type: String
Parameter Sets: (All)
Aliases:

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

-Tunnelendpointclientip

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

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 22
Default value: None
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-ADCUpdateAaaradiusparams Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/aaa/aaaradiusparams/ 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** ⚠️