aam authentication server radius instance

Configure an authentication-server instance for a RADIUS server.

instance Specification

Type Collection
Object Key(s) name
Collection Name instance-list
Collection URI /axapi/v3/aam/authentication/server/radius/instance/
Element Name instance
Element URI /axapi/v3/aam/authentication/server/radius/instance/{name}
Element Attributes instance_attributes
Statistics Data URI /axapi/v3/aam/authentication/server/radius/instance/{name}/stats
Schema instance schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/aam/authentication/server/radius/instance/

instance Attributes

Create List

POST

/axapi/v3/aam/authentication/server/radius/instance/

instance Attributes

Get Object

GET

/axapi/v3/aam/authentication/server/radius/instance/{name}

instance Attributes

Get List

GET

/axapi/v3/aam/authentication/server/radius/instance/

instance-list

Modify Object

POST

/axapi/v3/aam/authentication/server/radius/instance/{name}

instance Attributes

Replace Object

PUT

/axapi/v3/aam/authentication/server/radius/instance/{name}

instance Attributes

Replace List

PUT

/axapi/v3/aam/authentication/server/radius/instance/

instance-list

Delete Object

DELETE

/axapi/v3/aam/authentication/server/radius/instance/{name}

instance Attributes

Get Stats

GET

/axapi/v3/aam/authentication/server/radius/instance/{name}/stats

stats data

instance-list

instance-list is JSON List of instance Attributes

instance-list : [

instance Attributes

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

Mutual Exclusion: acct-port-hm and acct-port-hm-disable are mutually exclusive

Reference 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

encrypted

Description: Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)

health-check

Description: Enable the server’s health check status. health-check and health-check-disable are mutually exclusive, so you will only configure one or the other.

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 the configured health check configuration. health-check and health-check-disable are mutually exclusive, so you will only configure one or the other.

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: Specify the name of an existing health check monitor. For use with health-check .

Type: string

Reference Object: /axapi/v3/health/monitor

host

Description: host is a JSON Block . Please see below for host

Type: Object

interval

Description: Maximum number of seconds the ACOS device will wait for a reply to a request before resending the request.

Type: number

Range: 1-1024

Default: 3

name

Description: Specify the RADIUS authentication server name.

Type: string

Format: string-rlx

Required: Yes

port

Description: Protocol port on which the server listens for RADIUS traffic.

Type: number

Range: 1-65534

Default: 1812

port-hm

Description: Check port’s health status

Type: string

Mutual Exclusion: port-hm and port-hm-disable are mutually exclusive

Reference 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: Maximum number of times ACOS will send the same request before giving up.

Type: number

Range: 1-32

Default: 5

sampling-enable

Description: sampling-enable is a JSON List . Please see below for sampling-enable

Type: List

secret

Description: Enable the use of an admin secret password.

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

secret-string

Description: Password required by the RADIUS server for authentication requests.

Type: string

Format: password

uuid

Description: uuid of the object

Type: string

host

Specification
Type object

hostip

Description: Hostname or IPv4 address of the RADIUS server.

Type: string

Format: host

Mutual Exclusion: hostip and hostipv6 are mutually exclusive

hostipv6

Description: IPv6 address of the RADIUS server.

Type: string

Format: ipv6-address

Mutual Exclusion: hostipv6 and hostip are mutually exclusive

sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘authen_success’: Authentication Success; ‘authen_failure’: Authentication Failure; ‘authorize_success’: Authorization Success; ‘authorize_failure’: Authorization Failure; ‘access_challenge’: Access-Challenge Message Receive; ‘timeout_error’: Timeout; ‘other_error’: Other Error; ‘request’: Request; ‘accounting-request-sent’: Accounting-Request Sent; ‘accounting-success’: Accounting Success; ‘accounting-failure’: Accounting Failure;

Type: string

Supported Values: all, authen_success, authen_failure, authorize_success, authorize_failure, access_challenge, timeout_error, other_error, request, accounting-request-sent, accounting-success, accounting-failure

stats data

Counter Size Description
authorize_failure 8 Authorization Failure
accounting-request-sent 8 Accounting-Request Sent
other_error 8 Other Error
request 8 Request
accounting-success 8 Accounting Success
accounting-failure 8 Accounting Failure
authen_success 8 Authentication Success
access_challenge 8 Access-Challenge Message Receive
authen_failure 8 Authentication Failure
timeout_error 8 Timeout
authorize_success 8 Authorization Success