aam authentication relay kerberos

Kerberos Authentication Relay

kerberos Specification

Type Configuration Resource
Element Name kerberos
Element URI /axapi/v3/aam/authentication/relay/kerberos
Element Attributes kerberos_attributes
Statistics Data URI /axapi/v3/aam/authentication/relay/kerberos/stats
Schema kerberos schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/aam/authentication/relay/kerberos

kerberos Attributes

Get Object

GET

/axapi/v3/aam/authentication/relay/kerberos

kerberos Attributes

Modify Object

POST

/axapi/v3/aam/authentication/relay/kerberos

kerberos Attributes

Replace Object

PUT

/axapi/v3/aam/authentication/relay/kerberos

kerberos Attributes

Delete Object

DELETE

/axapi/v3/aam/authentication/relay/kerberos

kerberos Attributes

Get Stats

GET

/axapi/v3/aam/authentication/relay/kerberos/stats

stats data

kerberos Attributes

instance-list

Description: instance-list is a JSON List . Please see below for instance-list

Type: List

Reference Object: /axapi/v3/aam/authentication/relay/kerberos/instance/{name}

sampling-enable

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

Type: List

uuid

Description: uuid of the object

Type: string

sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘request-send’: Total Request Send; ‘response-get’: Total Response Get; ‘timeout-error’: Total Timeout; ‘other-error’: Total Other Error; ‘request-normal’: Total Normal Request; ‘request-dropped’: Total Dropped Request; ‘response-success’: Total Success Response; ‘response-failure’: Total Failure Response; ‘response-error’: Total Error Response; ‘response-timeout’: Total Timeout Response; ‘response-other’: Total Other Response; ‘job-start-error’: Total Job Start Error; ‘polling-control-error’: Total Polling Control Error;

Type: string

Supported Values: all, request-send, response-get, timeout-error, other-error, request-normal, request-dropped, response-success, response-failure, response-error, response-timeout, response-other, job-start-error, polling-control-error

instance-list

Specification
Type list
Block object keys

encrypted

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

kerberos-account

Description: Specify the kerberos account name

Type: string

Format: string-rlx

kerberos-kdc

Description: Specify the kerberos kdc ip or host name

Type: string

Mutual Exclusion: kerberos-kdc and kerberos-kdc-service-group are mutually exclusive

kerberos-kdc-service-group

Description: Specify an authentication service group as multiple KDCs

Type: string

Format: string-rlx

Mutual Exclusion: kerberos-kdc-service-group and kerberos-kdc are mutually exclusive

Reference Object: /axapi/v3/aam/authentication/service-group

kerberos-realm

Description: Specify the kerberos realm

Type: string

name

Description: Specify Kerberos authentication relay name

Type: string

password

Description: Specify password of Kerberos password

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

port

Description: Specify The KDC port, default is 88

Type: number

Range: 1-65535

Default: 88

sampling-enable

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

Type: List

secret-string

Description: The kerberos client password

Type: string

Format: password

timeout

Description: Specify timeout for kerberos transport, default is 10 seconds (The timeout, default is 10 seconds)

Type: number

Range: 1-255

Default: 10

uuid

Description: uuid of the object

Type: string

instance-list.sampling-enable

Specification
Type list
Block object keys

counters1

Description: ‘all’: all; ‘request-send’: Request Send; ‘response-receive’: Response Receive; ‘current-requests-of-user’: Current Pending Requests of User; ‘tickets’: Tickets;

Type: string

Supported Values: all, request-send, response-receive, current-requests-of-user, tickets

stats data

Counter Size Description
request-send 8 Total Request Send
request-normal 8 Total Normal Request
timeout-error 8 Total Timeout
response-timeout 8 Total Timeout Response
response-other 8 Total Other Response
response-failure 8 Total Failure Response
polling-control-error 8 Total Polling Control Error
other-error 8 Total Other Error
request-dropped 8 Total Dropped Request
response-get 8 Total Response Get
response-success 8 Total Success Response
job-start-error 8 Total Job Start Error
response-error 8 Total Error Response