aam authentication service-group

Configure an authentication service group for multiple authentication servers. Can be used to create a group of multiple KDCs for a Kerberos relay.

service-group Specification

Type Collection
Object Key(s) name
Collection Name service-group-list
Collection URI /axapi/v3/aam/authentication/service-group/
Element Name service-group
Element URI /axapi/v3/aam/authentication/service-group/{name}
Element Attributes service-group_attributes
Schema service-group schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/aam/authentication/service-group/

service-group Attributes

Create List

POST

/axapi/v3/aam/authentication/service-group/

service-group Attributes

Get Object

GET

/axapi/v3/aam/authentication/service-group/{name}

service-group Attributes

Get List

GET

/axapi/v3/aam/authentication/service-group/

service-group-list

Modify Object

POST

/axapi/v3/aam/authentication/service-group/{name}

service-group Attributes

Replace Object

PUT

/axapi/v3/aam/authentication/service-group/{name}

service-group Attributes

Replace List

PUT

/axapi/v3/aam/authentication/service-group/

service-group-list

Delete Object

DELETE

/axapi/v3/aam/authentication/service-group/{name}

service-group Attributes

service-group-list

service-group-list is JSON List of service-group Attributes

service-group-list : [

service-group Attributes

health-check

Description: Specify an existing health monitor. health-check and health-check-disable are mutually exclusive, so you will only configure one or the other.

Type: string

Mutual Exclusion: health-check and health-check-disable are mutually exclusive

Reference Object: /axapi/v3/health/monitor

health-check-disable

Description: Disables a 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

lb-method

Description: Specifies load balancing method between servers in the service group. The supported method is currently round-robin .

Type: string

Supported Values: round-robin

member-list

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

Type: List

Reference Object: /axapi/v3/aam/authentication/service-group/{name}/member/{name}+{port}

name

Description: Specify an AAM service group name.

Type: string

Format: string-rlx

Required: Yes

protocol

Description: Specify the protocol for the service group.
  • tcp : TCP AAM service.
  • udp : UDP AAM service.

Type: string

Supported Values: tcp, udp

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string

member-list

Specification
Type list
Block object keys

member-priority

Description: Priority of Port in the Group

Type: number

Range: 1-16

member-state

Description: ‘enable’: Enable member service port; ‘disable’: Disable member service port;

Type: string

Supported Values: enable, disable

Default: enable

name

Description: Member name

Type: string

Format: comp-string

Required: Yes

Reference Object: /axapi/v3/aam/authentication/server/ldap

port

Description: Port number

Type: number

Range: 1-65534

Default: 65534

user-tag

Description: Customized tag

Type: string

Format: string-rlx

uuid

Description: uuid of the object

Type: string