.. _slb_service_group_member:

slb service-group member
========================

Service Group Member


member Specification
--------------------

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

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

	 **Object Key(s)**                     *name, port*

	 **Collection Name**                   :ref:`2883_member_list`

	 **Collection URI**                    /axapi/v3/slb/service-group/{name}/member

	                                       

	 **Element Name**                      member

	 **Element URI**                       /axapi/v3/slb/service-group/{name}/member/{name}+{port}

	 **Element Attributes**                member_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/slb/service-group/{name}/member/{name}+{port}/stats

	 **Operational Data URI**              /axapi/v3/slb/service-group/{name}/member/{name}+{port}/oper

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



.. raw:: html

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


:ref:`2883_member_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/slb/service-group/{name}/member



.. raw:: html

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


:ref:`2883_member_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/slb/service-group/{name}/member/{name}+{port}



.. raw:: html

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


:ref:`2883_member_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/slb/service-group/{name}/member



.. raw:: html

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


:ref:`2883_member_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/slb/service-group/{name}/member/{name}+{port}



.. raw:: html

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


:ref:`2883_member_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/slb/service-group/{name}/member/{name}+{port}



.. raw:: html

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


:ref:`2883_member_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/slb/service-group/{name}/member



.. raw:: html

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


:ref:`2883_member_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/slb/service-group/{name}/member/{name}+{port}



.. raw:: html

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


:ref:`2883_member_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _2883_member_list:

member-list
-----------


    member-list is **JSON List** of :ref:`2883_member_attributes` 

        member-list : [

             { :ref:`2883_member_attributes` },

             { :ref:`2883_member_attributes` },

             ...

         ]

.. _2883_member_attributes:

member attributes
-----------------

    **fqdn-name**

        **Description** Server hostname - Not applicable if real server is already defined

        **Type:** string

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **host**

        **Description** IP Address - Not applicable if real server is already defined

        **Type:** string

        **Format:** ipv4-address

    **member-priority**

        **Description** Priority of Port in the Group (Priority of Port in the Group, default is 1)

        **Type:** number

        **Range:** 1-16

        **Default:** 1

    **member-state**

        **Description** 'enable': Enable member service port; 'disable': Disable member service port; 'disable-with-health-check': disable member service port, but health check work; 

        **Type:** string

        **Supported Values:** enable, disable, disable-with-health-check

        **Default:** enable

    **member-stats-data-disable**

        **Description** Disable statistical data collection

        **Type:** boolean

        **Supported Values:** true, false, 1, 0

        **Default:** 0

    **member-template**

        **Description** Real server port template (Real server port template name)

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/template/port <slb_template_port>`

    **name**

        **Description** Member name

        **Type:** string

        **Format:** comp-string

        **Maximum Length:** 127 characters

        **Maximum Length:** 1 characters

        **Reference Object:** :doc:`/axapi/v3/slb/server <slb_server>`

    **port**

        **Description** Port number

        **Type:** number

        **Range:** 0-65534

        **Default:** 65534

        **Reference Object:** :doc:`/axapi/v3/slb/server/port <slb_server_port>`

    **resolve-as**

        **Description** 'resolve-to-ipv4': Use A Query only to resolve FQDN; 'resolve-to-ipv6': Use AAAA Query only to resolve FQDN; 'resolve-to-ipv4-and-ipv6': Use A as well as AAAA Query to resolve FQDN; 

        **Type:** string

        **Supported Values:** resolve-to-ipv4, resolve-to-ipv6, resolve-to-ipv4-and-ipv6

        **Default:** resolve-to-ipv4

    **sampling-enable**

        **Type:** List

    **server-ipv6-addr**

        **Description** IPV6 Address - Not applicable if real server is already defined

        **Type:** string

        **Format:** ipv6-address

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

.. _2883_sampling-enable:

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': Peak connections; '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; 'state_flaps': State flaps 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, state_flaps