radius_server
Configuration for Radius Server configuration resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| auth_timeout | <Integer> | Read-write | The maximum number of seconds the system will wait for a response from the Radius server. Maximum value = |
| group_separator | <String> | Read-write | Group separator string that delimits group names within a RADIUS attribute for RADIUS group extraction. Maximum length = 7 |
| pass_encoding | <String> | Read-write | Enable password encoding in RADIUS packets send to the RADIUS server. |
| enable_nas_ip | <Boolean> | Read-write | Enable NAS IP extraction. |
| radius_key | <String> | Read-write | Key of radius server. Minimum length = 4 Maximum length = 32 |
| default_authentication_group | <String> | Read-write | This is the default group that is chosen when the authentication succeeds in addition to extracted groups. Maximum length = 64 |
| ip_vendor_id | <Integer> | Read-write | The vendor ID of the attribute in the RADIUS response which denotes the intranet IP. Maximum value = |
| id | <String> | Read-write | Id is system generated key for all the radius servers. |
| ip_address | <String> | Read-write | IP Address of radius server. Minimum length = 1 Maximum length = 64 |
| ip_attribute_type | <Integer> | Read-write | The attribute type of the remote IP address attribute in a RADIUS response. Maximum value = |
| attribute_type | <Integer> | Read-write | Attribute type for RADIUS group extraction. Maximum value = |
| nas_id | <String> | Read-write | NAS ID. Maximum length = 128 |
| vendor_id | <Integer> | Read-write | Vendor ID for RADIUS group extraction. Maximum value = |
| name | <String> | Read-write | Name of radius server. Minimum length = 1 Maximum length = 128 |
| port | <Integer> | Read-write | Port number of radius server. Minimum value = 1 Maximum value = |
| groups_prefix | <String> | Read-write | Prefix string that precedes group names within a RADIUS attribute for RADIUS group extraction. Maximum length = 31 |
| pwd_vendor_id | <Integer> | Read-write | Vendor ID of the password in the RADIUS response. Used to extract the user password. Maximum value = |
| pwd_attribute_type | <Integer> | Read-write | The attribute type of the password attribute in a RADIUS response.. Maximum value = |
| accounting | <Boolean> | Read-write | Enable accounting in the radius server. |
| address_type | <Integer> | Read-only | Configuration Type. Values: 0: IPv4, 1: IPv6, -1: Hostname. |
Operations
(click to see Properties)
ADD| DELETE| GET (ALL)| GET| UPDATE
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: https://<MGMT-IP>/nitro/v1/config/radius_server?onerror=<String_value>
HTTP Method: null
Request Payload:
{radius_server: {
<b>"radius_key":<String_value></b>,
<b>"ip_address":<String_value></b>,
<b>"name":<String_value></b>,
"auth_timeout":<Integer_value>,
"group_separator":<String_value>,
"pass_encoding":<String_value>,
"enable_nas_ip":<Boolean_value>,
"default_authentication_group":<String_value>,
"id":<String_value>,
"ip_attribute_type":<Integer_value>,
"pwd_vendor_id":<Integer_value>,
"groups_prefix":<String_value>,
"port":<Integer_value>,
"pwd_attribute_type":<Integer_value>,
"accounting":<Boolean_value>,
"ip_vendor_id":<Integer_value>,
"attribute_type":<Integer_value>,
"nas_id":<String_value>,
"vendor_id":<Integer_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "radius_server":[{
"auth_timeout":<Integer_value>,
"group_separator":<String_value>,
"pass_encoding":<String_value>,
"enable_nas_ip":<Boolean_value>,
"radius_key":<String_value>,
"default_authentication_group":<String_value>,
"ip_vendor_id":<Integer_value>,
"id":<String_value>,
"ip_address":<String_value>,
"ip_attribute_type":<Integer_value>,
"attribute_type":<Integer_value>,
"nas_id":<String_value>,
"vendor_id":<Integer_value>,
"name":<String_value>,
"port":<Integer_value>,
"groups_prefix":<String_value>,
"pwd_vendor_id":<Integer_value>,
"pwd_attribute_type":<Integer_value>,
"accounting":<Boolean_value>,
"address_type":<Integer_value>}]}
delete
URL: https://<MGMT-IP>/nitro/v1/config/radius_server/id_value<String>
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }
get (all)
URL: https://<MGMT-IP>/nitro/v1/config/radius_server
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "radius_server":[{
"auth_timeout":<Integer_value>,
"group_separator":<String_value>,
"pass_encoding":<String_value>,
"enable_nas_ip":<Boolean_value>,
"radius_key":<String_value>,
"default_authentication_group":<String_value>,
"ip_vendor_id":<Integer_value>,
"id":<String_value>,
"ip_address":<String_value>,
"ip_attribute_type":<Integer_value>,
"attribute_type":<Integer_value>,
"nas_id":<String_value>,
"vendor_id":<Integer_value>,
"name":<String_value>,
"port":<Integer_value>,
"groups_prefix":<String_value>,
"pwd_vendor_id":<Integer_value>,
"pwd_attribute_type":<Integer_value>,
"accounting":<Boolean_value>,
"address_type":<Integer_value>}]}
get
URL: https://<MGMT-IP>/nitro/v1/config/radius_server/id_value<String>
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "radius_server":[{
"auth_timeout":<Integer_value>,
"group_separator":<String_value>,
"pass_encoding":<String_value>,
"enable_nas_ip":<Boolean_value>,
"radius_key":<String_value>,
"default_authentication_group":<String_value>,
"ip_vendor_id":<Integer_value>,
"id":<String_value>,
"ip_address":<String_value>,
"ip_attribute_type":<Integer_value>,
"attribute_type":<Integer_value>,
"nas_id":<String_value>,
"vendor_id":<Integer_value>,
"name":<String_value>,
"port":<Integer_value>,
"groups_prefix":<String_value>,
"pwd_vendor_id":<Integer_value>,
"pwd_attribute_type":<Integer_value>,
"accounting":<Boolean_value>,
"address_type":<Integer_value>}]}
update
URL: https://<MGMT-IP>/nitro/v1/config/radius_server/id_value<String>
HTTP Method: null
Request Payload:
{radius_server:{
<b>"id":<String_value></b>,
<b>"ip_address":<String_value></b>,
<b>"name":<String_value></b>,
"auth_timeout":<Integer_value>,
"group_separator":<String_value>,
"pass_encoding":<String_value>,
"enable_nas_ip":<Boolean_value>,
"default_authentication_group":<String_value>,
"ip_attribute_type":<Integer_value>,
"pwd_vendor_id":<Integer_value>,
"groups_prefix":<String_value>,
"port":<Integer_value>,
"pwd_attribute_type":<Integer_value>,
"accounting":<Boolean_value>,
"radius_key":<String_value>,
"ip_vendor_id":<Integer_value>,
"attribute_type":<Integer_value>,
"nas_id":<String_value>,
"vendor_id":<Integer_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "radius_server":[{
"auth_timeout":<Integer_value>,
"group_separator":<String_value>,
"pass_encoding":<String_value>,
"enable_nas_ip":<Boolean_value>,
"radius_key":<String_value>,
"default_authentication_group":<String_value>,
"ip_vendor_id":<Integer_value>,
"id":<String_value>,
"ip_address":<String_value>,
"ip_attribute_type":<Integer_value>,
"attribute_type":<Integer_value>,
"nas_id":<String_value>,
"vendor_id":<Integer_value>,
"name":<String_value>,
"port":<Integer_value>,
"groups_prefix":<String_value>,
"pwd_vendor_id":<Integer_value>,
"pwd_attribute_type":<Integer_value>,
"accounting":<Boolean_value>,
"address_type":<Integer_value>}]}