authenticationradiusaction
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.<br>Minimum length = 1 |
| serverip | <String> | Read-write | IP address assigned to the RADIUS server.<br>Minimum length = 1 |
| servername | <String> | Read-write | RADIUS server name as a FQDN. Mutually exclusive with RADIUS IP address.<br>Minimum length = 1 |
| serverport | <Integer> | Read-write | Port number on which the RADIUS server listens for connections.<br>Minimum value = 1 |
| authtimeout | <Double> | Read-write | Number of seconds the NetScaler appliance waits for a response from the RADIUS server.<br>Default value: 3<br>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.<br>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.<br>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.<br>Minimum value = 1 |
| radattributetype | <Double> | Read-write | RADIUS attribute type, used for RADIUS group extraction.<br>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.<br>Default value: pap<br>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.<br>Minimum value = 1 |
| accounting | <String> | Read-write | Whether the RADIUS server is currently accepting accounting messages.<br>Possible values = ON, OFF |
| pwdvendorid | <Double> | Read-write | Vendor ID of the attribute, in the RADIUS response, used to extract the user password.<br>Minimum value = 1 |
| pwdattributetype | <Double> | Read-write | Vendor-specific password attribute type in a RADIUS response.<br>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.<br>Default value: DISABLED<br>Possible values = ENABLED, DISABLED |
| 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)
ADD | DELETE | UPDATE | UNSET | GET (ALL) | GET | COUNT
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>
Note:
Mandatory parameters are marked in red and placeholder content is marked in <green>.
add
URL: http://<NSIP>/nitro/v1/config/
HTTP Method: POST
Request Payload:
object={
"params":{
"warning":<String_value>,
"onerror":<String_value>
},
"sessionid":"##sessionid",
"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>,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
delete
URL: http://<NSIP>/nitro/v1/config/authenticationradiusaction/name_value<String>
Query-parameters:
warning
http://<NS_IP>/nitro/v1/config/authenticationradiusaction/name_value<String>?warning=yes
Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a
HTTP Method: DELETE
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
update
URL: http://<NSIP>/nitro/v1/config/
HTTP Method: PUT
Request Payload:
{
"params": {
"warning":<String_value>,
"onerror":<String_value>"
},
sessionid":"##sessionid",
"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>,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
unset
URL: http://<NSIP>/nitro/v1/config/
HTTP Method: POST
Request Payload:
object={
"params":{
"warning":<String_value>,
"onerror":<String_value>,
"action":"unset"
},
"sessionid":"##sessionid",
"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,
}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity":
get (all)
URL: http://<NSIP>/nitro/v1/config/authenticationradiusaction
Query-parameters:
filter
http://<NSIP>/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://<NS_IP>/nitro/v1/config/authenticationradiusaction?view=summary
Use this query-parameter to get the summary output of authenticationradiusaction resources configured on NetScaler.
pagesize=#no;pageno=#no
http://<NS_IP>/nitro/v1/config/authenticationradiusaction?pagesize=#no;pageno=#no
Use this query-parameter to get the authenticationradiusaction resources in chunks.
warning
http://<NS_IP>/nitro/v1/config/authenticationradiusaction?warning=yes
Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a
HTTP Method: GET
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": <String_value>, "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>
}]}
get
URL: http://<NS_IP>/nitro/v1/config/authenticationradiusaction/name_value<String>
HTTP Method: GET
Response Payload:
{ "errorcode": 0, "message": "Done", "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>
}]}
count
URL: http://<NS_IP>/nitro/v1/config/authenticationradiusaction?count=yes
HTTP Method: GET
Response Payload:
{ "errorcode": 0, "message": "Done",authenticationradiusaction: [ { "__count": "#no"} ] }