.. _visibility_packet_capture_object_templates_fw_service_group_tmpl:
visibility packet-capture object-templates fw-service-group-tmpl
================================================================
Configure template for fw.service-group
fw-service-group-tmpl Specification
-----------------------------------
===================================== ================================================================================================================
**Parameter** **Value**
===================================== ================================================================================================================
**Type** *Collection*
**Object Key(s)** *name*
**Collection Name** :ref:`3965_fw-service-group-tmpl_list`
**Collection URI** /axapi/v3/visibility/packet-capture/object-templates/fw-service-group-tmpl
**Element Name** fw-service-group-tmpl
**Element URI** /axapi/v3/visibility/packet-capture/object-templates/fw-service-group-tmpl/{name}
**Element Attributes** fw-service-group-tmpl_attributes
**Partition Visibility** shared
**Schema** :download:`fw-service-group-tmpl schema <visibility-packet-capture-object-templates-fw-service-group-tmpl/visibility-packet-capture-object-templates-fw-service-group-tmpl.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/visibility/packet-capture/object-templates/fw-service-group-tmpl
.. raw:: html
</td><td valign = 'top'>
:ref:`3965_fw-service-group-tmpl_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/visibility_packet_capture_object_templates_fw_service_group_tmpl_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/visibility/packet-capture/object-templates/fw-service-group-tmpl
.. raw:: html
</td><td valign = 'top'>
:ref:`3965_fw-service-group-tmpl_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/visibility/packet-capture/object-templates/fw-service-group-tmpl/{name}
.. raw:: html
</td><td valign = 'top'>
:ref:`3965_fw-service-group-tmpl_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/visibility_packet_capture_object_templates_fw_service_group_tmpl_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/visibility/packet-capture/object-templates/fw-service-group-tmpl
.. raw:: html
</td><td valign = 'top'>
:ref:`3965_fw-service-group-tmpl_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/visibility/packet-capture/object-templates/fw-service-group-tmpl/{name}
.. raw:: html
</td><td valign = 'top'>
:ref:`3965_fw-service-group-tmpl_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/visibility/packet-capture/object-templates/fw-service-group-tmpl/{name}
.. raw:: html
</td><td valign = 'top'>
:ref:`3965_fw-service-group-tmpl_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/visibility/packet-capture/object-templates/fw-service-group-tmpl
.. raw:: html
</td><td valign = 'top'>
:ref:`3965_fw-service-group-tmpl_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/visibility/packet-capture/object-templates/fw-service-group-tmpl/{name}
.. raw:: html
</td><td valign = 'top'>
:ref:`3965_fw-service-group-tmpl_attributes`
.. raw:: html
</td><td></td></tr>
.. raw:: html
</table>
.. _3965_fw-service-group-tmpl_list:
fw-service-group-tmpl-list
--------------------------
fw-service-group-tmpl-list is **JSON List** of :ref:`3965_fw-service-group-tmpl_attributes`
fw-service-group-tmpl-list : [
{ :ref:`3965_fw-service-group-tmpl_attributes` },
{ :ref:`3965_fw-service-group-tmpl_attributes` },
...
]
.. _3965_fw-service-group-tmpl_attributes:
fw-service-group-tmpl attributes
--------------------------------
**capture-config**
**Description** Specify name of the capture-config to use with this template
**Type:** string
**Format:** string-rlx
**Maximum Length:** 127 characters
**Maximum Length:** 1 characters
**Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/capture-config <visibility_packet_capture_capture_config>`
**name**
**Description** Packet Capture Template Name
**Type:** string
**Format:** string-rlx
**Maximum Length:** 127 characters
**Maximum Length:** 1 characters
**trigger-stats-inc**
**Description:** trigger-stats-inc is a **JSON Block**. Please see below for :ref:`3965_trigger-stats-inc`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/fw-service-group-tmpl/{name}/trigger-stats-inc <visibility_packet_capture_object_templates_fw_service_group_tmpl>`
**trigger-stats-rate**
**Description:** trigger-stats-rate is a **JSON Block**. Please see below for :ref:`3965_trigger-stats-rate`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/fw-service-group-tmpl/{name}/trigger-stats-rate <visibility_packet_capture_object_templates_fw_service_group_tmpl>`
**trigger-stats-severity**
**Description:** trigger-stats-severity is a **JSON Block**. Please see below for :ref:`3965_trigger-stats-severity`
**Type:** Object
**Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/fw-service-group-tmpl/{name}/trigger-stats-severity <visibility_packet_capture_object_templates_fw_service_group_tmpl>`
**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
.. _3965_trigger-stats-severity:
trigger-stats-severity
^^^^^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**drop**
**Description** Enable packet capture on all drop counters (Default disabled)
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**drop-alert**
**Description** Enable packet capture on all alert drop counters (Default disabled)
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**drop-critical**
**Description** Enable packet capture on all critical drop counters (Default disabled)
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**drop-warning**
**Description** Enable packet capture on all warning drop counters (Default disabled)
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**error**
**Description** Enable packet capture on all error counters (Default disabled)
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**error-alert**
**Description** Enable packet capture on all alert error counters (Default disabled)
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**error-critical**
**Description** Enable packet capture on all critical error counters (Default disabled)
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**error-warning**
**Description** Enable packet capture on all warning error counters (Default disabled)
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
.. _3965_trigger-stats-inc:
trigger-stats-inc
^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**server_selection_fail_reset**
**Description** Enable automatic packet-capture for Service selection fail reset
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters
.. _3965_trigger-stats-rate:
trigger-stats-rate
^^^^^^^^^^^^^^^^^^
=============================== ===================================================
**Specification** **Value**
=============================== ===================================================
**Type** *object*
=============================== ===================================================
**duration**
**Description** Time in seconds to look for the anomaly, default is 60
**Type:** number
**Range:** 1-250
**Default:** 60
**server_selection_fail_reset**
**Description** Enable automatic packet-capture for Service selection fail reset
**Type:** boolean
**Supported Values:** true, false, 1, 0
**Default:** 0
**threshold-exceeded-by**
**Description** Set the threshold to the number of times greater than the previous duration to start the capture, default is 5
**Type:** number
**Range:** 0-100
**Default:** 5
**uuid**
**Description** uuid of the object
**Type:** string
**Maximum Length:** 64 characters
**Maximum Length:** 1 characters