getauthenticationradiusactionResult Structure Definition

The getauthenticationradiusactionResult structure defines the return type for getauthenticationradiusaction API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

authenticationradiusactionList

List of authenticationradiusactions


authenticationradiusaction Structure Definition

The authenticationradiusaction structure defines the actual return type values for getauthenticationradiusaction API.

Syntax



Members

name

Name of the RADIUS profile.

serverip

IP address assigned to the RADIUS server.

servername

RADIUS server name as a FQDN. Mutually exclusive with RADIUS IP address.

serverport

Port number on which the RADIUS server listens for connections.

authtimeout

Number of seconds the Citrix ADC waits for a response from the RADIUS server.

radkey

Key shared between the RADIUS server and the Citrix ADC. Required to allow the Citrix ADC to communicate with the RADIUS server.

radnasip

If enabled, the Citrix ADC IP address (NSIP) is sent to the RADIUS server as the Network Access Server IP (NASIP) address. The RADIUS protocol defines the meaning and use of the NASIP address.

ipaddress

IP address.

radnasid

If configured, this string is sent to the RADIUS server as the Network Access Server ID (NASID).

radvendorid

RADIUS vendor ID attribute, used for RADIUS group extraction.

radattributetype

RADIUS attribute type, used for RADIUS group extraction.

radgroupsprefix

RADIUS groups prefix string. This groups prefix precedes the group names within a RADIUS attribute for RADIUS group extraction.

radgroupseparator

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

passencoding

Encoding type for passwords in RADIUS packets that the Citrix ADC sends to the RADIUS server.

ipvendorid

Vendor ID of the intranet IP attribute in the RADIUS response. NOTE: A value of 0 indicates that the attribute is not vendor encoded.

ipattributetype

Remote IP address attribute type in a RADIUS response.

accounting

Whether the RADIUS server is currently accepting accounting messages.

success


failure


pwdvendorid

Vendor ID of the attribute, in the RADIUS response, used to extract the user password.

pwdattributetype

Vendor-specific password attribute type in a RADIUS response.

defaultauthenticationgroup

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

callingstationid

Send Calling-Station-ID of the client to the RADIUS server. IP Address of the client is sent as its Calling-Station-ID.

authservretry

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

authentication

Configure the RADIUS server state to accept or refuse authentication messages.

tunnelendpointclientip

Send Tunnel Endpoint Client IP address to the RADIUS server.

transport

Transport mode to RADIUS server.

targetlbvserver

If transport mode is TLS, specify the name of LB vserver to associate. The LB vserver needs to be of type TCP and service associated needs to be SSL_TCP

messageauthenticator

Control whether the Message-Authenticator attribute is included in a RADIUS Access-Request packet.

_nextgenapiresource


See Also