aam authentication relay kerberos instance¶

Kerberos Authentication Relay

instance Specification¶

Parameter Value

Type Collection

Object Key(s) name

Collection Name instance-list

Collection URI /axapi/v3/aam/authentication/relay/kerberos/instance

Element Name instance

Element URI /axapi/v3/aam/authentication/relay/kerberos/instance/{name}

Element Attributes instance_attributes

Partition Visibility shared

Statistics Data URI /axapi/v3/aam/authentication/relay/kerberos/instance/{name}/stats

Operational Data URI /axapi/v3/aam/authentication/relay/kerberos/instance/{name}/oper

Schema instance schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/aam/authentication/relay/kerberos/instance	instance attributes
Create List	POST	/axapi/v3/aam/authentication/relay/kerberos/instance	instance attributes
Get Object	GET	/axapi/v3/aam/authentication/relay/kerberos/instance/{name}	instance attributes
Get List	GET	/axapi/v3/aam/authentication/relay/kerberos/instance	instance-list
Modify Object	POST	/axapi/v3/aam/authentication/relay/kerberos/instance/{name}	instance attributes
Replace Object	PUT	/axapi/v3/aam/authentication/relay/kerberos/instance/{name}	instance attributes
Replace List	PUT	/axapi/v3/aam/authentication/relay/kerberos/instance	instance-list
Delete Object	DELETE	/axapi/v3/aam/authentication/relay/kerberos/instance/{name}	instance attributes

instance-list¶

instance-list is JSON List of instance attributes

instance-list : [

{ instance attributes },

{ instance attributes },

…

]

instance attributes¶

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

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