aam authentication relay kerberos

Kerberos Authentication Relay

kerberos Specification

Parameter	Value
Type	Configuration Resource
Element Name	kerberos
Element URI	/axapi/v3/aam/authentication/relay/kerberos
Element Attributes	kerberos_attributes
Partition Visibility	shared
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

kerberos attributes

instance-list

Type: List

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

sampling-enable

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

sampling-enable

Specification	Value
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	Value
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

Maximum Length: 127 characters

Maximum Length: 1 characters

kerberos-kdc

Description Specify the kerberos kdc ip or host name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

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

Maximum Length: 127 characters

Maximum Length: 1 characters

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

Maximum Length: 63 characters

Maximum Length: 1 characters

name

Description Specify Kerberos authentication relay name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

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

Type: List

secret-string

Description The kerberos client password

Type: string

Format: password

Maximum Length: 63 characters

Maximum Length: 1 characters

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

Maximum Length: 64 characters

Maximum Length: 1 characters

instance-list_sampling-enable

Specification	Value
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