Product Documentation

authenticationradiusaction

Sep 01, 2016

Configuration for RADIUS action resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Name for the RADIUS action.
Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters. Cannot be changed after the RADIUS action is added.
Minimum length = 1
serverip
<String>
Read-write
IP address assigned to the RADIUS server.
Minimum length = 1
servername
<String>
Read-write
RADIUS server name as a FQDN. Mutually exclusive with RADIUS IP address.
Minimum length = 1
serverport
<Integer>
Read-write
Port number on which the RADIUS server listens for connections.
Minimum value = 1
authtimeout
<Double>
Read-write
Number of seconds the NetScaler appliance waits for a response from the RADIUS server.
Default value: 3
Minimum value = 1
radkey
<String>
Read-write
Key shared between the RADIUS server and the NetScaler appliance.
Required to allow the NetScaler appliance to communicate with the RADIUS server.
Minimum length = 1
radnasip
<String>
Read-write
If enabled, the NetScaler appliance 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.
Possible values = ENABLED, DISABLED
radnasid
<String>
Read-write
If configured, this string is sent to the RADIUS server as the Network Access Server ID (NASID).
radvendorid
<Double>
Read-write
RADIUS vendor ID attribute, used for RADIUS group extraction.
Minimum value = 1
radattributetype
<Double>
Read-write
RADIUS attribute type, used for RADIUS group extraction.
Minimum value = 1
radgroupsprefix
<String>
Read-write
RADIUS groups prefix string.
This groups prefix precedes the group names within a RADIUS attribute for RADIUS group extraction.
radgroupseparator
<String>
Read-write
RADIUS group separator string
The group separator delimits group names within a RADIUS attribute for RADIUS group extraction.
passencoding
<String>
Read-write
Encoding type for passwords in RADIUS packets that the NetScaler appliance sends to the RADIUS server.
Default value: pap
Possible values = pap, chap, mschapv1, mschapv2
ipvendorid
<Double>
Read-write
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
<Double>
Read-write
Remote IP address attribute type in a RADIUS response.
Minimum value = 1
accounting
<String>
Read-write
Whether the RADIUS server is currently accepting accounting messages.
Possible values = ON, OFF
pwdvendorid
<Double>
Read-write
Vendor ID of the attribute, in the RADIUS response, used to extract the user password.
Minimum value = 1
pwdattributetype
<Double>
Read-write
Vendor-specific password attribute type in a RADIUS response.
Minimum value = 1
defaultauthenticationgroup
<String>
Read-write
This is the default group that is chosen when the authentication succeeds in addition to extracted groups.
callingstationid
<String>
Read-write
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
authservretry
<Double>
Read-write
Number of retry by the NetScaler appliance before getting response from the RADIUS server.
Default value: 3
Minimum value = 1
Maximum value = 10
ipaddress
<String>
Read-only
IP address.
success
<Double>
Read-only
.
failure
<Double>
Read-only
.
__count
<Double>
Read-only
count parameter

Operations (click to see Properties)

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER:<username>

    X-NITRO-PASS:<password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

URL: http://<netscaler-ip-address>/nitro/v1/config/authenticationradiusaction

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"authenticationradiusaction":{
      "name":<String_value>,
      "serverip":<String_value>,
      "servername":<String_value>,
      "serverport":<Integer_value>,
      "authtimeout":<Double_value>,
      "radkey":<String_value>,
      "radnasip":<String_value>,
      "radnasid":<String_value>,
      "radvendorid":<Double_value>,
      "radattributetype":<Double_value>,
      "radgroupsprefix":<String_value>,
      "radgroupseparator":<String_value>,
      "passencoding":<String_value>,
      "ipvendorid":<Double_value>,
      "ipattributetype":<Double_value>,
      "accounting":<String_value>,
      "pwdvendorid":<Double_value>,
      "pwdattributetype":<Double_value>,
      "defaultauthenticationgroup":<String_value>,
      "callingstationid":<String_value>,
      "authservretry":<Double_value>
}}

Response:

HTTP Status Code on Success: 201 Created
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http://<netscaler-ip-address>/nitro/v1/config/authenticationradiusaction/name_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

update

URL: http://<netscaler-ip-address>/nitro/v1/config/authenticationradiusaction

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"authenticationradiusaction":{
      "name":<String_value>,
      "serverip":<String_value>,
      "servername":<String_value>,
      "serverport":<Integer_value>,
      "authtimeout":<Double_value>,
      "radkey":<String_value>,
      "radnasip":<String_value>,
      "radnasid":<String_value>,
      "radvendorid":<Double_value>,
      "radattributetype":<Double_value>,
      "radgroupsprefix":<String_value>,
      "radgroupseparator":<String_value>,
      "passencoding":<String_value>,
      "ipvendorid":<Double_value>,
      "ipattributetype":<Double_value>,
      "accounting":<String_value>,
      "pwdvendorid":<Double_value>,
      "pwdattributetype":<Double_value>,
      "defaultauthenticationgroup":<String_value>,
      "callingstationid":<String_value>,
      "authservretry":<Double_value>
}}

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http://<netscaler-ip-address>/nitro/v1/config/authenticationradiusaction?action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Content-Type:application/json

Request Payload:

{"authenticationradiusaction":{
      "name":<String_value>,
      "serverport":true,
      "authtimeout":true,
      "radnasip":true,
      "radnasid":true,
      "radvendorid":true,
      "radattributetype":true,
      "radgroupsprefix":true,
      "radgroupseparator":true,
      "passencoding":true,
      "ipvendorid":true,
      "ipattributetype":true,
      "accounting":true,
      "pwdvendorid":true,
      "pwdattributetype":true,
      "defaultauthenticationgroup":true,
      "callingstationid":true,
      "authservretry":true
}}

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/config/authenticationradiusaction

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/authenticationradiusaction?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<netscaler-ip-address>/nitro/v1/config/authenticationradiusaction?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of authenticationradiusaction resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<netscaler-ip-address>/nitro/v1/config/authenticationradiusaction?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<netscaler-ip-address>/nitro/v1/config/authenticationradiusaction?pagesize=#no&pageno=#no

Use this query-parameter to get the authenticationradiusaction resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "authenticationradiusaction": [ {
      "name":<String_value>,
      "serverip":<String_value>,
      "servername":<String_value>,
      "serverport":<Integer_value>,
      "authtimeout":<Double_value>,
      "radkey":<String_value>,
      "radnasip":<String_value>,
      "ipaddress":<String_value>,
      "radnasid":<String_value>,
      "radvendorid":<Double_value>,
      "radattributetype":<Double_value>,
      "radgroupsprefix":<String_value>,
      "radgroupseparator":<String_value>,
      "passencoding":<String_value>,
      "ipvendorid":<Double_value>,
      "ipattributetype":<Double_value>,
      "accounting":<String_value>,
      "success":<Double_value>,
      "failure":<Double_value>,
      "pwdvendorid":<Double_value>,
      "pwdattributetype":<Double_value>,
      "defaultauthenticationgroup":<String_value>,
      "callingstationid":<String_value>,
      "authservretry":<Double_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/config/authenticationradiusaction/name_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/authenticationradiusaction/name_value<String>?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http://<netscaler-ip-address>/nitro/v1/config/authenticationradiusaction/name_value<String>?view=summary

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "authenticationradiusaction": [ {
      "name":<String_value>,
      "serverip":<String_value>,
      "servername":<String_value>,
      "serverport":<Integer_value>,
      "authtimeout":<Double_value>,
      "radkey":<String_value>,
      "radnasip":<String_value>,
      "ipaddress":<String_value>,
      "radnasid":<String_value>,
      "radvendorid":<Double_value>,
      "radattributetype":<Double_value>,
      "radgroupsprefix":<String_value>,
      "radgroupseparator":<String_value>,
      "passencoding":<String_value>,
      "ipvendorid":<Double_value>,
      "ipattributetype":<Double_value>,
      "accounting":<String_value>,
      "success":<Double_value>,
      "failure":<Double_value>,
      "pwdvendorid":<Double_value>,
      "pwdattributetype":<Double_value>,
      "defaultauthenticationgroup":<String_value>,
      "callingstationid":<String_value>,
      "authservretry":<Double_value>
}]}

count

URL: http://<netscaler-ip-address>/nitro/v1/config/authenticationradiusaction?count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Accept:application/json

Response:

HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "authenticationradiusaction": [ { "__count": "#no"} ] }