aam authentication service-group¶

Authentication service group

service-group Specification¶

Parameter Value

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

Partition Visibility shared

Statistics Data URI /axapi/v3/aam/authentication/service-group/{name}/stats

Operational Data URI /axapi/v3/aam/authentication/service-group/{name}/oper

Schema service-group schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/aam/authentication/service-group	service-group attributes
POST /axapi/v3/aam/authentication/service-group/ Payload: { "service-group": { "protocol": "tcp", "name": "a", "user-tag": "a" } }
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 /axapi/v3/aam/authentication/service-group/a Reponse: { "service-group": { "name": "a", "protocol": "tcp", "health-check-disable": 0, "uuid": "9c5fd49e-4f5b-11ee-bde4-3768133b9b1a", "user-tag": "a", "a10-url": "/axapi/v3/aam/authentication/service-group/a" } }
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
PUT /axapi/v3/aam/authentication/service-group/a Payload: { "service-group": { "protocol": "tcp", "name": "a", "user-tag": "abcd" } }
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
DELETE /axapi/v3/aam/authentication/service-group/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

service-group-list¶

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

service-group-list : [

{ service-group attributes },

{ service-group attributes },

…

]

service-group attributes¶

health-check

Description Health Check (Monitor Name)

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

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

Reference 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

Reference 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

packet-capture-template

Description Name of the packet capture template to be bind with this object

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/visibility/packet-capture/object-templates/aam-auth-service-group-tmpl

protocol

Description ‘tcp’: TCP AAM service; ‘udp’: UDP AAM service;

Type: string

Supported Values: tcp, udp

sampling-enable

Type: List

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

sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘server_selection_fail_drop’: Drops due to Service selection failure; ‘server_selection_fail_reset’: Resets sent out for Service selection failure; ‘service_peak_conn’: Peak connection count for the Service Group; ‘service_healthy_host’: Service Group healthy host count; ‘service_unhealthy_host’: Service Group unhealthy host count; ‘service_req_count’: Service Group request count; ‘service_resp_count’: Service Group response count; ‘service_resp_2xx’: Service Group response 2xx count; ‘service_resp_3xx’: Service Group response 3xx count; ‘service_resp_4xx’: Service Group response 4xx count; ‘service_resp_5xx’: Service Group response 5xx count; ‘service_curr_conn_overflow’: Current connection counter overflow count;

Type: string

Supported Values: all, server_selection_fail_drop, server_selection_fail_reset, service_peak_conn, service_healthy_host, service_unhealthy_host, service_req_count, service_resp_count, service_resp_2xx, service_resp_3xx, service_resp_4xx, service_resp_5xx, service_curr_conn_overflow

member-list¶

Specification Value

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

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

packet-capture-template

Description Name of the packet capture template to be bind with this object

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/visibility/packet-capture/object-templates/aam-auth-service-group-mem-tmpl

port

Description Port number

Type: number

Range: 1-65534

Default: 65534

sampling-enable

Type: List

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_sampling-enable¶

Specification Value

Type list

Block object keys

counters1

Description ‘all’: all; ‘total_fwd_bytes’: Bytes processed in forward direction; ‘total_fwd_pkts’: Packets processed in forward direction; ‘total_rev_bytes’: Bytes processed in reverse direction; ‘total_rev_pkts’: Packets processed in reverse direction; ‘total_conn’: Total established connections; ‘total_rev_pkts_inspected’: Total reverse packets inspected; ‘total_rev_pkts_inspected_status_code_2xx’: Total reverse packets inspected status code 2xx; ‘total_rev_pkts_inspected_status_code_non_5xx’: Total reverse packets inspected status code non 5xx; ‘curr_req’: Current requests; ‘total_req’: Total requests; ‘total_req_succ’: Total requests successful; ‘peak_conn’: some help string; ‘response_time’: Response time; ‘fastest_rsp_time’: Fastest response time; ‘slowest_rsp_time’: Slowest response time; ‘curr_ssl_conn’: Current SSL connections; ‘total_ssl_conn’: Total SSL connections; ‘curr_conn_overflow’: Current connection counter overflow count;

Type: string

Supported Values: all, total_fwd_bytes, total_fwd_pkts, total_rev_bytes, total_rev_pkts, total_conn, total_rev_pkts_inspected, total_rev_pkts_inspected_status_code_2xx, total_rev_pkts_inspected_status_code_non_5xx, curr_req, total_req, total_req_succ, peak_conn, response_time, fastest_rsp_time, slowest_rsp_time, curr_ssl_conn, total_ssl_conn, curr_conn_overflow