API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference

Create a new Authentication Server Group profile by unique name

Auth Server Group profile.

Path Params
string
required
length ≤ 9999

The name of the Server Group.For CX, maximum length is 32 characters.

Query Params
string

LOCAL - To create local objects. SHARED - To create shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be created. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be created. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

server-groupbody object

assignment-rules
object

Assign the client a user role, VLAN ID or VLAN name based on attributes. For GW and AP, the attributes is returned for the client by the authentication server and this API is applicable for
auth server group. For AP, this API is also applicable WLAN profile and if this API works in WLAN profile, the attributes can be returned for the client by the authentication server or other
attributes such as mac-address, dhcp-option, AP-Name, etc. Rules are ordered: the first rule that matches the configured condition is applied. VLAN IDs and VLAN names cannot be listed together.
This feature is only applicable for AP and GW.

attribute-profile
object
int64
0 to 4294967295

number of servers

string
length between 1 and 256

Description of the Server Group.

boolean
Defaults to false

When this option is configured, an authentication failure with the first server in the group causes the device to attempt authentication
with the next server in the list. The device attempts authentication with each server in the ordered list until either there is a successful
authentication or the list of servers in the group is exhausted.

boolean
Defaults to false

Enable load-balancing of authentication requests among different servers in a server group.

string
enum

Load balance algorithm.

Show Details
LORLeast-Outstanding-Requests algorithm.
Allowed:
string
length between 1 and 80

The name of the Server Group.For CX, maximum length is 32 characters.

servers
array of objects
length ≤ 2147483647

Configure the servers in the server group in a specific order based on their position within the group.

servers
string
enum

Auth Server Group Type. CX supports server group types RADIUS and TACACS and configuring this parameter is mandatory while creating a Server Group.

Show Details
LDAPLDAP Server.
LOCALLocal Internal Server for GW.
RADIUSRADIUS Server.
RADSECRadSec Server.
RFC3576Dynamic authorization Server.
TACACSTACACS Server.
WINDOWSWindows Server.
XMLAPIXML API Server.
Responses

Language
Credentials
OAuth2
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json