system radius server

Configure system as a RADIUS server

server Specification

   
Type Configuration Resource
Element Name server
Element URI /axapi/v3/system/radius/server
Element Attributes server_attributes
Statistics Data URI /axapi/v3/system/radius/server/stats
Operational Data URI /axapi/v3/system/radius/server/oper
Schema server schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/system/radius/server

server attributes

Get Object

GET

/axapi/v3/system/radius/server

server attributes

Modify Object

POST

/axapi/v3/system/radius/server

server attributes

Replace Object

PUT

/axapi/v3/system/radius/server

server attributes

Delete Object

DELETE

/axapi/v3/system/radius/server

server attributes

server attributes

accounting-interim-update

Description ‘ignore’: Ignore (default); ‘append-entry’: Append the AVPs to existing entry; ‘replace-entry’: Replace the AVPs of existing entry;

Type: string

Supported Values: ignore, append-entry, replace-entry

Default: ignore

accounting-on

Description ‘ignore’: Ignore (default); ‘delete-entries-using-attribute’: Delete entries matching attribute in RADIUS Table;

Type: string

Supported Values: ignore, delete-entries-using-attribute

Default: ignore

accounting-start

Description ‘ignore’: Ignore; ‘append-entry’: Append the AVPs to existing entry (default); ‘replace-entry’: Replace the AVPs of existing entry;

Type: string

Supported Values: ignore, append-entry, replace-entry

Default: append-entry

accounting-stop

Description ‘ignore’: Ignore; ‘delete-entry’: Delete the entry (default); ‘delete-entry-and-sessions’: Delete the entry and data sessions associated(CGN only);

Type: string

Supported Values: ignore, delete-entry, delete-entry-and-sessions

Default: delete-entry

attribute

Type: List

attribute-name

Description ‘msisdn’: Clear using MSISDN; ‘imei’: Clear using IMEI; ‘imsi’: Clear using IMSI; ‘custom1’: Clear using CUSTOM1 attribute configured; ‘custom2’: Clear using CUSTOM2 attribute configured; ‘custom3’: Clear using CUSTOM3 attribute configured;

Type: string

Supported Values: msisdn, imei, imsi, custom1, custom2, custom3

Mutual Exclusion: attribute-name and custom-attribute-name are mutually exclusive

disable-reply

Description Toggle option for RADIUS reply packet(Default: Accounting response will be sent)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

encrypted

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

listen-port

Description Configure the listen port of RADIUS server (default 1813) (Port number)

Type: number

Range: 1024-65535

Default: 1813

remote

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

Type: Object

secret

Description Configure shared secret

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

secret-string

Description The RADIUS secret

Type: string

Format: password

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vrid

Description Join a VRRP-A failover group

Type: number

Range: 1-31

remote

Specification  
Type object

ip-list

Type: List

remote_ip-list

Specification  
Type list
Block object keys  

ip-list-encrypted

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

ip-list-name

Description IP-list name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

ip-list-secret

Description Configure shared secret

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ip-list-secret-string

Description The RADIUS secret

Type: string

Format: password

Maximum Length: 127 characters

Maximum Length: 1 characters

attribute

Specification  
Type list
Block object keys  

attribute-value

Description ‘inside-ipv6-prefix’: Framed IPv6 Prefix; ‘inside-ip’: Inside IP address; ‘inside-ipv6’: Inside IPv6 address; ‘imei’: International Mobile Equipment Identity (IMEI); ‘imsi’: International Mobile Subscriber Identity (IMSI); ‘msisdn’: Mobile Subscriber Integrated Services Digital Network-Number (MSISDN); ‘custom1’: Customized attribute 1; ‘custom2’: Customized attribute 2; ‘custom3’: Customized attribute 3;

Type: string

Supported Values: inside-ipv6-prefix, inside-ip, inside-ipv6, imei, imsi, msisdn, custom1, custom2, custom3

custom-number

Description RADIUS attribute number

Type: number

Range: 1-255

custom-vendor

Description RADIUS vendor attribute information (RADIUS vendor ID)

Type: number

Range: 1-65535

name

Description Customized attribute name

Type: string

Maximum Length: 15 characters

Maximum Length: 1 characters

number

Description RADIUS attribute number

Type: number

Range: 1-255

prefix-length

Description ‘32’: Prefix length 32; ‘48’: Prefix length 48; ‘64’: Prefix length 64; ‘80’: Prefix length 80; ‘96’: Prefix length 96; ‘112’: Prefix length 112;

Type: string

Supported Values: 32, 48, 64, 80, 96, 112

prefix-number

Description RADIUS attribute number

Type: number

Range: 1-255

prefix-vendor

Description RADIUS vendor attribute information (RADIUS vendor ID)

Type: number

Range: 1-65535

value

Description ‘hexadecimal’: Type of attribute value is hexadecimal;

Type: string

Supported Values: hexadecimal

vendor

Description RADIUS vendor attribute information (RADIUS vendor ID)

Type: number

Range: 1-65535

stats data

  Counter Size Description
       
  secret-not-configured-dropped 8 RADIUS Secret Not Configured Dropped
  radius-request-dropped 8 RADIUS Request Dropped (Malformed Packet)
  imsi-received 8 IMSI Received
  invalid-key 8 Radius Request has Invalid Key Field
  request-bad-secret-dropped 8 RADIUS Request Bad Secret Dropped
  ha-standby-dropped 8 HA Standby Dropped
  custom-received 8 Custom attribute Received
  imei-received 8 IMEI Received
  request-no-key-vap-dropped 8 RADIUS Request No Key Attribute Dropped
  radius-table-full 8 RADIUS Request Dropped (Table Full)
  msisdn-received 8 MSISDN Received
  request-malformed-dropped 8 RADIUS Request Malformed Dropped
  request-ignored 8 RADIUS Request Ignored
  ipv6-prefix-length-mismatch 8 Framed IPV6 Prefix Length Mismatch
  radius-request-received 8 RADIUS Request Received

operational data

  Counter Size Description
       
  radius-table-entries-list   radius-table-entries-list
  custom-attr-value string custom-attr-value
  starts-with flag starts-with
  custom-attr-name string custom-attr-name
  case-insensitive flag case-insensitive
  total-entries number total-entries