.. _fw_service_group:
fw service-group
================
Service Group
service-group Specification
---------------------------
===================================== ================================================================
**Parameter** **Value**
===================================== ================================================================
**Type** *Collection*
**Object Key(s)** *name*
**Collection Name** :ref:`1669_service-group_list`
**Collection URI** /axapi/v3/fw/service-group
**Element Name** service-group
**Element URI** /axapi/v3/fw/service-group/{name}
**Element Attributes** service-group_attributes
**Partition Visibility** shared
**Statistics Data URI** /axapi/v3/fw/service-group/{name}/stats
**Operational Data URI** /axapi/v3/fw/service-group/{name}/oper
**Schema** :download:`service-group schema <fw-service-group/fw-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/fw/service-group
.. raw:: html
</td><td valign = 'top'>
:ref:`1669_service-group_attributes`
.. raw:: html
</td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>
.. raw:: html
<tr><td colspan=5 style='padding: 0 % 0 %;' valign = 'top'><div id='post_div' style='display:none'>
.. include:: ../artifacts/fw_service_group_POST.txt
:literal:
.. raw:: html
</div></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/fw/service-group
.. raw:: html
</td><td valign = 'top'>
:ref:`1669_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/fw/service-group/{name}
.. raw:: html
</td><td valign = 'top'>
:ref:`1669_service-group_attributes`
.. raw:: html
</td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>
.. raw:: html
<tr><td colspan=5 style='padding: 0 % 0 %;' valign = 'top'><div id='get_div' style='display:none'>
.. include:: ../artifacts/fw_service_group_GET.txt
:literal:
.. raw:: html
</div></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/fw/service-group
.. raw:: html
</td><td valign = 'top'>
:ref:`1669_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/fw/service-group/{name}
.. raw:: html
</td><td valign = 'top'>
:ref:`1669_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/fw/service-group/{name}
.. raw:: html
</td><td valign = 'top'>
:ref:`1669_service-group_attributes`
.. raw:: html
</td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>
.. raw:: html
<tr><td colspan=5 style='padding: 0 % 0 %;' valign = 'top'><div id='put_div' style='display:none'>
.. include:: ../artifacts/fw_service_group_PUT.txt
:literal:
.. raw:: html
</div></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/fw/service-group
.. raw:: html
</td><td valign = 'top'>
:ref:`1669_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/fw/service-group/{name}
.. raw:: html
</td><td valign = 'top'>
:ref:`1669_service-group_attributes`
.. raw:: html
</td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>
.. raw:: html
<tr><td colspan=5 style='padding: 0 % 0 %;' valign = 'top'><div id='delete_div' style='display:none'>
.. include:: ../artifacts/fw_service_group_DELETE.txt
:literal:
.. raw:: html
</div></td></tr>
.. raw:: html
</table>
.. _1669_service-group_list:
service-group-list
------------------
service-group-list is **JSON List** of :ref:`1669_service-group_attributes`
service-group-list : [
{ :ref:`1669_service-group_attributes` },
{ :ref:`1669_service-group_attributes` },
...
]
.. _1669_service-group_attributes:
service-group attributes
------------------------
**health-check**
**Description** Health Check (Monitor Name)
**Type:** string
**Maximum Length:** 63 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/health/monitor <health_monitor>`
**member-list**
**Type:** List
**Reference Object:** :doc:`/axapi/v3/fw/service-group/{name}/member/{name}+{port} <fw_service_group>`
**name**
**Description** FW Service 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:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/fw-service-group-tmpl <visibility_packet_capture_object_templates_fw_service_group_tmpl>`
**protocol**
**Description** 'tcp': TCP LB service; 'udp': UDP LB service;
**Type:** string
**Supported Values:** tcp, udp
**sampling-enable**
**Type:** List
**traffic-replication-mirror-ip-repl**
**Description** Replaces IP with server-IP
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**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
.. _1669_sampling-enable:
sampling-enable
^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**counters1**
**Description** 'all': all; 'server_selection_fail_drop': Service selection fail drop; 'server_selection_fail_reset': Service selection fail reset; 'service_peak_conn': Service peak connection;
**Type:** string
**Supported Values:** all, server_selection_fail_drop, server_selection_fail_reset, service_peak_conn
.. _1669_member-list:
member-list
^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**name**
**Description** Member name
**Type:** string
**Format:** comp-string
**Maximum Length:** 127 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/fw/server <fw_server>`
**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:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/fw-service-group-mem-tmpl <visibility_packet_capture_object_templates_fw_service_group_mem_tmpl>`
**port**
**Description** Port number
**Type:** number
**Range:** 1-65534
**Reference Object:** :doc:`/axapi/v3/fw/server/port <fw_server_port>`
**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
.. _1669_member-list_sampling-enable:
member-list_sampling-enable
^^^^^^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *list*
**Block object keys**
=============================== ===================================================
**counters1**
**Description** 'all': all; 'curr_conn': Current connections; 'total_fwd_bytes': Total forward bytes; 'total_fwd_pkts': Total forward packets; 'total_rev_bytes': Total reverse bytes; 'total_rev_pkts': Total reverse packets; 'total_conn': Total 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 success; '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, curr_conn, 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