.. _aam_authentication_service_group_oper:

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

Operational Status for the object service-group


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

	===================================== =====================================================================================
	 **Parameter**                         **Value** 

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

	 **Collection Name**                   :ref:`104_service-group_list`

	 **Collection URI**                    /axapi/v3/aam/authentication/service-group/{name}

	                                       

	 **Element Name**                      service-group

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

	 **Element Attributes**                service-group_attributes

	 **Partition Visibility**              None

	 **Schema**                             :download:`service-group schema <aam-authentication-service-group-oper/aam-authentication-service-group-oper.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/{name}



.. raw:: html

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


:ref:`104_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/{name}



.. raw:: html

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


:ref:`104_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}/oper



.. raw:: html

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


:ref:`104_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/{name}



.. raw:: html

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


:ref:`104_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}/oper



.. raw:: html

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


:ref:`104_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}/oper



.. raw:: html

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


:ref:`104_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/{name}



.. raw:: html

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


:ref:`104_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}/oper



.. raw:: html

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


:ref:`104_service-group_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _104_service-group_list:

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


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

        service-group-list : [

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

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

             ...

         ]

.. _104_service-group_attributes:

service-group attributes
------------------------

    **member-list**

        **Type:** List

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

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`104_oper` 

        **Type:** Object

.. _104_oper:

oper
^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **filter**

        **Description** 

        **Type:** string

        **Supported Values:** sgm-sort-config

    **hm_dsr_enable_all_vip**

        **Description** 

        **Type:** number

    **pri_affinity_priority**

        **Description** 

        **Type:** number

    **servers_disable**

        **Description** 

        **Type:** number

    **servers_down**

        **Description** 

        **Type:** number

    **servers_total**

        **Description** 

        **Type:** number

    **servers_up**

        **Description** 

        **Type:** number

    **sgm-list**

        **Type:** List

    **state**

        **Description** 

        **Type:** string

        **Supported Values:** All Up, Functional Up, Down, Disb, Unkn

    **stateless_current_rate**

        **Description** 

        **Type:** number

    **stateless_current_usage**

        **Description** 

        **Type:** number

    **stateless_state**

        **Description** 

        **Type:** number

    **stateless_type**

        **Description** 

        **Type:** number

.. _104_oper_sgm-list:

oper_sgm-list
^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **sgm-name**

        **Description** 

        **Type:** string

    **sgm-port**

        **Description** 

        **Type:** number

.. _104_member-list:

member-list
^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **name**

        **Description** Member name

        **Type:** string

        **Format:** comp-string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **oper**

        **Description:** oper is a **JSON Block**.  Please see below for :ref:`104_member-list_oper` 

        **Type:** Object

    **port**

        **Description** Port number

        **Type:** number

        **Range:** 1-65534

        **Default:** 65534

.. _104_member-list_oper:

member-list_oper
^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **alt-list**

        **Type:** List

    **drs-list**

        **Type:** List

    **hm-index**

        **Description** 

        **Type:** number

    **hm-key**

        **Description** 

        **Type:** number

    **state**

        **Description** 

        **Type:** string

        **Supported Values:** UP, DOWN, MAINTENANCE, DIS-UP, DIS-DOWN, DIS-MAINTENANCE

.. _104_member-list_oper_alt-list:

member-list_oper_alt-list
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **alt-curr-conn**

        **Description** 

        **Type:** number

    **alt-fwd-pkts**

        **Description** 

        **Type:** number

    **alt-name**

        **Description** 

        **Type:** string

    **alt-peak-conn**

        **Description** 

        **Type:** number

    **alt-port**

        **Description** 

        **Type:** number

    **alt-rev-pkts**

        **Description** 

        **Type:** number

    **alt-state**

        **Description** 

        **Type:** string

    **alt-total-conn**

        **Description** 

        **Type:** number

.. _104_member-list_oper_drs-list:

member-list_oper_drs-list
^^^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

	=============================== ===================================================

    **drs-curr-conn**

        **Description** 

        **Type:** number

    **drs-curr-req**

        **Description** 

        **Type:** number

    **drs-frsp-time**

        **Description** 

        **Type:** number

    **drs-fwd-bts**

        **Description** 

        **Type:** number

    **drs-fwd-pkts**

        **Description** 

        **Type:** number

    **drs-hm-index**

        **Description** 

        **Type:** number

    **drs-hm-key**

        **Description** 

        **Type:** number

    **drs-name**

        **Description** 

        **Type:** string

    **drs-peak-conn**

        **Description** 

        **Type:** number

    **drs-pers-conn**

        **Description** 

        **Type:** number

    **drs-port**

        **Description** 

        **Type:** number

    **drs-priority**

        **Description** 

        **Type:** number

    **drs-rev-bts**

        **Description** 

        **Type:** number

    **drs-rev-pkts**

        **Description** 

        **Type:** number

    **drs-rsp-time**

        **Description** 

        **Type:** number

    **drs-srsp-time**

        **Description** 

        **Type:** number

    **drs-state**

        **Description** 

        **Type:** string

    **drs-total-conn**

        **Description** 

        **Type:** number

    **drs-total-req**

        **Description** 

        **Type:** number

    **drs-total-req-succ**

        **Description** 

        **Type:** number