.. _aam_authentication_service_group:

aam authentication service-group
================================

Authentication service group


service-group Specification
---------------------------

	===================================== ================================================================================
	===================================== ================================================================================
	 **Type**                              *Collection*

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`517_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

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

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

	 **Schema**                             :download:`service-group schema <aam-authentication-service-group/aam-authentication-service-group.txt>`
	===================================== ================================================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`517_service-group_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create List



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`517_service-group_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`517_service-group_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get List



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`517_service-group_list`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`517_service-group_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`517_service-group_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace List



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`517_service-group_list`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


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



.. raw:: html

   </td><td valign = 'top'>


:ref:`517_service-group_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _517_service-group_list:

service-group-list
------------------


    service-group-list is **JSON List** of :ref:`517_service-group_attributes` 

        service-group-list : [

             { :ref:`517_service-group_attributes` },

             { :ref:`517_service-group_attributes` },

             ...

         ]

.. _517_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

        **Refernce Object:** :doc:`/axapi/v3/health/monitor <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:** :doc:`/axapi/v3/aam/authentication/service-group/{name}/member/{name}+{port} <aam_authentication_service_group>`

    **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

.. _517_member-list:

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:** :doc:`/axapi/v3/aam/authentication/server/ldap <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

.. _517_stats_data:

stats data
----------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - service_resp_2xx
      - 8
      - Service Group response 2xx count

   *  - 
      - service_unhealthy_host
      - 8
      - Service Group unhealthy host count

   *  - 
      - service_curr_conn_overflow
      - 8
      - Current connection counter overflow count

   *  - 
      - service_req_count
      - 8
      - Service Group request count

   *  - 
      - service_healthy_host
      - 8
      - Service Group healthy host count

   *  - 
      - service_resp_count
      - 8
      - Service Group response count

   *  - 
      - service_resp_3xx
      - 8
      - Service Group response 3xx count

   *  - 
      - server_selection_fail_drop
      - 8
      - Drops due to Service selection failure

   *  - 
      - service_resp_4xx
      - 8
      - Service Group response 4xx count

   *  - 
      - server_selection_fail_reset
      - 8
      - Resets sent out for Service selection failure

   *  - 
      - service_peak_conn
      - 8
      - Peak connection count for the Service Group

   *  - 
      - service_resp_5xx
      - 8
      - Service Group response 5xx count

.. _517_oper_data:

operational data
----------------
.. list-table::
   :widths: 10 20 30 80
   :header-rows: 2
   :stub-columns: 1

   *  - 
      - Counter
      - Size
      - Description

   *  - 
      - 
      - 
      - 

   *  - 
      - pri_affinity_priority
      - number
      - pri_affinity_priority

   *  - 
      - stateless_type
      - number
      - stateless_type

   *  - 
      - servers_down
      - number
      - servers_down

   *  - 
      - servers_total
      - number
      - servers_total

   *  - 
      - servers_disable
      - number
      - servers_disable

   *  - 
      - stateless_state
      - number
      - stateless_state

   *  - 
      - filter
      - enum
      -  Output contains one of the following values: - sgm-sort-config

   *  - 
      - stateless_current_rate
      - number
      - stateless_current_rate

   *  - 
      - state
      - enum
      -  Output contains one of the following values: - All Up, Functional Up, Down, Disb, Unkn

   *  - 
      - sgm-list
      - 
      - sgm-list

   *  - 
      - servers_up
      - number
      - servers_up

   *  - 
      - stateless_current_usage
      - number
      - stateless_current_usage

   *  - 
      - hm_dsr_enable_all_vip
      - number
      - hm_dsr_enable_all_vip