aam authentication server radius¶
RADIUS Authentication Server
radius Specification¶
Type
Configuration Resource
Element Name
radius
Element URI
/axapi/v3/aam/authentication/server/radius
Element Attributes
radius_attributes
Statistics Data URI
/axapi/v3/aam/authentication/server/radius/stats
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/aam/authentication/server/radius | ||
Get Object | GET | /axapi/v3/aam/authentication/server/radius | ||
Modify Object | POST | /axapi/v3/aam/authentication/server/radius | ||
Replace Object | PUT | /axapi/v3/aam/authentication/server/radius | ||
Delete Object | DELETE | /axapi/v3/aam/authentication/server/radius |
radius attributes¶
instance-list
Type: List
Refernce Object: /axapi/v3/aam/authentication/server/radius/instance/{name}
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
instance-list¶
Specification
Type
list
Block object keys
accounting-port
Description Specify the RADIUS server’s accounting port, default is 1813
Type: number
Range: 1-65534
Default: 1813
acct-port-hm
Description Specify accounting port health check method
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: acct-port-hm and acct-port-hm-disable are mutually exclusive
Refernce Object: /axapi/v3/health/monitor
acct-port-hm-disable
Description Disable configured accounting port health check configuration
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: acct-port-hm-disable and acct-port-hm are mutually exclusive
auth-type
Description ‘pap’: PAP authentication. Default; ‘mschapv2’: MS-CHAPv2 authentication; ‘mschapv2-pap’: Use MS-CHAPv2 first. If server doesn’t support it, try PAP;
Type: string
Supported Values: pap, mschapv2, mschapv2-pap
encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)
health-check
Description Check server’s health status
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: health-check and health-check-disable are mutually exclusive
health-check-disable
Description Disable configured health check configuration
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: health-check-disable and health-check are mutually exclusive
health-check-string
Description Health monitor name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Refernce Object: /axapi/v3/health/monitor
host
Description: host is a JSON Block. Please see below for instance-list_host
Type: Object
interval
Description Specify the interval time for resend the request (second), default is 3 seconds (The interval time(second), default is 3 seconds)
Type: number
Range: 1-1024
Default: 3
name
Description Specify RADIUS authentication server name
Type: string
Format: string-rlx
Maximum Length: 63 characters
Maximum Length: 1 characters
port
Description Specify the RADIUS server’s authentication port, default is 1812
Type: number
Range: 1-65534
Default: 1812
port-hm
Description Check port’s health status
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Mutual Exclusion: port-hm and port-hm-disable are mutually exclusive
Refernce Object: /axapi/v3/health/monitor
port-hm-disable
Description Disable configured port health check configuration
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: port-hm-disable and port-hm are mutually exclusive
retry
Description Specify the retry number for resend the request, default is 5 (The retry number, default is 5)
Type: number
Range: 1-32
Default: 5
secret
Description Specify the RADIUS server’s secret
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
secret-string
Description The RADIUS server’s secret
Type: string
Format: password
Maximum Length: 128 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
instance-list_host¶
Specification
Type
object
hostip
Description Server’s hostname(Length 1-31) or IP address
Type: string
Format: host
Maximum Length: 31 characters
Maximum Length: 1 characters
Mutual Exclusion: hostip and hostipv6 are mutually exclusive
hostipv6
Description Server’s IPV6 address
Type: string
Format: ipv6-address
Mutual Exclusion: hostipv6 and hostip are mutually exclusive
stats data¶
Counter |
Size |
Description |
|
|---|---|---|---|
authorize_failure |
8 |
Total Authorization Failure |
|
accounting-request-sent |
8 |
Accounting-Request Sent |
|
other_error |
8 |
Total Other Error |
|
response-success |
8 |
Total Success Response |
|
job-start-error |
8 |
Total Job Start Error |
|
request |
8 |
Total Request |
|
response-timeout |
8 |
Total Timeout Response |
|
accounting-success |
8 |
Accounting Success |
|
accounting-failure |
8 |
Accounting Failure |
|
response-other |
8 |
Total Other Response |
|
request-normal |
8 |
Total Normal Request |
|
response-failure |
8 |
Total Failure Response |
|
authen_success |
8 |
Total Authentication Success |
|
access_challenge |
8 |
Total Access-Challenge Message Receive |
|
request-dropped |
8 |
Total Dropped Request |
|
authen_failure |
8 |
Total Authentication Failure |
|
timeout_error |
8 |
Total Timeout |
|
authorize_success |
8 |
Total Authorization Success |
|
response-error |
8 |
Total Error Response |
|
polling-control-error |
8 |
Total Polling Control Error |