aam authentication service-group¶
Authentication service group
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 schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/aam/authentication/service-group | ||
Create List | POST | /axapi/v3/aam/authentication/service-group | ||
Get Object | GET | /axapi/v3/aam/authentication/service-group/{name} | ||
Get List | GET | /axapi/v3/aam/authentication/service-group | ||
Modify Object | POST | /axapi/v3/aam/authentication/service-group/{name} | ||
Replace Object | PUT | /axapi/v3/aam/authentication/service-group/{name} | ||
Replace List | PUT | /axapi/v3/aam/authentication/service-group | ||
Delete Object | DELETE | /axapi/v3/aam/authentication/service-group/{name} | ||
service-group-list¶
service-group-list is JSON List of service-group attributes
service-group-list : [
]
service-group attributes¶
health-check
Description Health Check (Monitor Name)
Type: string
Maximum Length: 31 characters
Maximum Length: 1 characters
Mutual Exclusion: health-check and health-check-disable are mutually exclusive
Refernce Object: /axapi/v3/health/monitor
health-check-disable
Description Disable health check
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
Mutual Exclusion: health-check-disable and health-check are mutually exclusive
lb-method
Description ‘round-robin’: Round robin on server level;
Type: string
Supported Values: round-robin
member-list
Type: List
Refernce Object: /axapi/v3/aam/authentication/service-group/{name}/member/{name}+{port}
name
Description Specify AAM service group name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
protocol
Description ‘tcp’: TCP AAM service; ‘udp’: UDP AAM service;
Type: string
Supported Values: tcp, udp
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
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
Maximum Length: 63 characters
Maximum Length: 1 characters
Refernce 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
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters