Citrix

Produktdokumentation



Ganzes Dokument herunterladen

radius_servers

Oct. 21, 2015

Configuration of RADIUS server. This NITRO resource is applicable for CloudBridge 400, 800, 1000, 2000, 2000WS, 3000, 4000, and 5000 platforms only.

Properties

Name Data Type Read-Only? Description
port
<String>
No

RADIUS server port

ipattributetype
<String>
No

The attribute type of the remote IP address attribute in a RADIUS response.

nasid
<String>
No

NAS ID.

passencoding
<String>
No

Enable password encoding in RADIUS packets send to the RADIUS server.

pwdvendorid
<String>
No

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

accounting
<String>
No

Enable accounting in the radius server.

Possible values = [true, false]

ipaddress
<String>
No

RADIUS server IP address.

groupsprefix
<String>
No

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

ipvendorid
<String>
No

The vendor ID of the attribute in the RADIUS response which denotes the intranet IP.

groupseparator
<String>
No

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

vendorid
<String>
No

Vendor ID for RADIUS group extraction.

name
<String>
No

Name of RADIUS server.

enablenasip
<String>
No

Enable NAS IP extraction.

Possible values = [true, false]

attributetype
<String>
No

Attribute type for RADIUS group extraction.

defaultauthenticationgroup
<String>
No

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

pwdattributetype
<String>
No

The attribute type of the password attribute in a RADIUS response.

authtimeout
<String>
No

The maximum number of seconds the system will wait for a response from the RADIUS server.

key
<String>
No

Key of radius server.

Operations

Note:

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

ADD

Use this operation to add a RADIUS server

HTTP Method: POST

URL: https://<cb_ip_address>/cb/nitro/v1/config/radius_servers

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Content-Type: application/vnd.com.citrix.cloudbridge.radius_servers+json

Request Payload: JSON

{"radius_servers":{
"port": <string_value>,
"ipattributetype": <string_value>,
"nasid": <string_value>,
"passencoding": <string_value>,
"pwdvendorid": <string_value>,
"accounting": <string_value>,
"ipaddress": <string_value>,
"groupsprefix": <string_value>,
"ipvendorid": <string_value>,
"groupseparator": <string_value>,
"vendorid": <string_value>,
"name": <string_value>,
"enablenasip": <string_value>,
"attributetype": <string_value>,
"defaultauthenticationgroup": <string_value>,
"pwdattributetype": <string_value>,
"authtimeout": <string_value>,
"key": <string_value>
}}

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.radius_servers+json

Response Payload: JSON

{"radius_servers":{
"port": <string_value>,
"ipattributetype": <string_value>,
"nasid": <string_value>,
"passencoding": <string_value>,
"pwdvendorid": <string_value>,
"accounting": <string_value>,
"ipaddress": <string_value>,
"groupsprefix": <string_value>,
"ipvendorid": <string_value>,
"groupseparator": <string_value>,
"vendorid": <string_value>,
"name": <string_value>,
"enablenasip": <string_value>,
"attributetype": <string_value>,
"defaultauthenticationgroup": <string_value>,
"pwdattributetype": <string_value>,
"authtimeout": <string_value>,
"key": <string_value>
}}

DELETE

Use this operation to delete a RADIUS server

HTTP Method: DELETE

URL: https://<cb_ip_address>/cb/nitro/v1/config/radius_servers/<name>

Request Headers:

Authorization: Basic <base64 encoded(username:password)>

Response Payload: EMPTY

GET (ALL)

Use this operation to get RADIUS configuration details

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/radius_servers

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Accept: application/vnd.com.citrix.cloudbridge.radius_servers_list+json

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.radius_servers_list+json

Response Payload: JSON

{"radius_servers": [{
"port": <string_value>,
"ipattributetype": <string_value>,
"nasid": <string_value>,
"passencoding": <string_value>,
"pwdvendorid": <string_value>,
"accounting": <string_value>,
"ipaddress": <string_value>,
"groupsprefix": <string_value>,
"ipvendorid": <string_value>,
"groupseparator": <string_value>,
"vendorid": <string_value>,
"name": <string_value>,
"enablenasip": <string_value>,
"attributetype": <string_value>,
"defaultauthenticationgroup": <string_value>,
"pwdattributetype": <string_value>,
"authtimeout": <string_value>,
"key": <string_value>
}, ...]}

GET

Use this operation to get RADIUS configuration details

HTTP Method: GET

URL: https://<cb_ip_address>/cb/nitro/v1/config/radius_servers/<name>

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Accept: application/vnd.com.citrix.cloudbridge.radius_servers+json

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.radius_servers+json

Response Payload: JSON

{"radius_servers":{
"port": <string_value>,
"ipattributetype": <string_value>,
"nasid": <string_value>,
"passencoding": <string_value>,
"pwdvendorid": <string_value>,
"accounting": <string_value>,
"ipaddress": <string_value>,
"groupsprefix": <string_value>,
"ipvendorid": <string_value>,
"groupseparator": <string_value>,
"vendorid": <string_value>,
"name": <string_value>,
"enablenasip": <string_value>,
"attributetype": <string_value>,
"defaultauthenticationgroup": <string_value>,
"pwdattributetype": <string_value>,
"authtimeout": <string_value>,
"key": <string_value>
}}

MODIFY

Use this operation to modify RADIUS configuration

HTTP Method: PUT

URL: https://<cb_ip_address>/cb/nitro/v1/config/radius_servers/<name>

Request Headers:

Authorization: Basic <base64 encoded(username:password)>
Content-Type: application/vnd.com.citrix.cloudbridge.radius_servers+json

Request Payload: JSON

{"radius_servers":{
"port": <string_value>,
"ipattributetype": <string_value>,
"nasid": <string_value>,
"passencoding": <string_value>,
"pwdvendorid": <string_value>,
"accounting": <string_value>,
"ipaddress": <string_value>,
"groupsprefix": <string_value>,
"ipvendorid": <string_value>,
"groupseparator": <string_value>,
"vendorid": <string_value>,
"name": <string_value>,
"enablenasip": <string_value>,
"attributetype": <string_value>,
"defaultauthenticationgroup": <string_value>,
"pwdattributetype": <string_value>,
"authtimeout": <string_value>,
"key": <string_value>
}}

Response Headers:

Content-Type: application/vnd.com.citrix.cloudbridge.radius_servers+json

Response Payload: JSON

{"radius_servers":{
"port": <string_value>,
"ipattributetype": <string_value>,
"nasid": <string_value>,
"passencoding": <string_value>,
"pwdvendorid": <string_value>,
"accounting": <string_value>,
"ipaddress": <string_value>,
"groupsprefix": <string_value>,
"ipvendorid": <string_value>,
"groupseparator": <string_value>,
"vendorid": <string_value>,
"name": <string_value>,
"enablenasip": <string_value>,
"attributetype": <string_value>,
"defaultauthenticationgroup": <string_value>,
"pwdattributetype": <string_value>,
"authtimeout": <string_value>,
"key": <string_value>
}}
Back to Top