.. _visibility_packet_capture_object_templates_imap_vport_tmpl: visibility packet-capture object-templates imap-vport-tmpl ========================================================== Configure template for counter.imap_vport imap-vport-tmpl Specification ----------------------------- ===================================== ========================================================================================================== **Parameter** **Value** ===================================== ========================================================================================================== **Type** *Collection* **Object Key(s)** *name* **Collection Name** :ref:`3969_imap-vport-tmpl_list` **Collection URI** /axapi/v3/visibility/packet-capture/object-templates/imap-vport-tmpl **Element Name** imap-vport-tmpl **Element URI** /axapi/v3/visibility/packet-capture/object-templates/imap-vport-tmpl/{name} **Element Attributes** imap-vport-tmpl_attributes **Partition Visibility** shared **Schema** :download:`imap-vport-tmpl schema ` ===================================== ========================================================================================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Create Object .. raw:: html POST .. raw:: html /axapi/v3/visibility/packet-capture/object-templates/imap-vport-tmpl .. raw:: html :ref:`3969_imap-vport-tmpl_attributes` .. raw:: html
Create List .. raw:: html POST .. raw:: html /axapi/v3/visibility/packet-capture/object-templates/imap-vport-tmpl .. raw:: html :ref:`3969_imap-vport-tmpl_attributes` .. raw:: html
Get Object .. raw:: html GET .. raw:: html /axapi/v3/visibility/packet-capture/object-templates/imap-vport-tmpl/{name} .. raw:: html :ref:`3969_imap-vport-tmpl_attributes` .. raw:: html
Get List .. raw:: html GET .. raw:: html /axapi/v3/visibility/packet-capture/object-templates/imap-vport-tmpl .. raw:: html :ref:`3969_imap-vport-tmpl_list` .. raw:: html
Modify Object .. raw:: html POST .. raw:: html /axapi/v3/visibility/packet-capture/object-templates/imap-vport-tmpl/{name} .. raw:: html :ref:`3969_imap-vport-tmpl_attributes` .. raw:: html
Replace Object .. raw:: html PUT .. raw:: html /axapi/v3/visibility/packet-capture/object-templates/imap-vport-tmpl/{name} .. raw:: html :ref:`3969_imap-vport-tmpl_attributes` .. raw:: html
Replace List .. raw:: html PUT .. raw:: html /axapi/v3/visibility/packet-capture/object-templates/imap-vport-tmpl .. raw:: html :ref:`3969_imap-vport-tmpl_list` .. raw:: html
Delete Object .. raw:: html DELETE .. raw:: html /axapi/v3/visibility/packet-capture/object-templates/imap-vport-tmpl/{name} .. raw:: html :ref:`3969_imap-vport-tmpl_attributes` .. raw:: html
.. _3969_imap-vport-tmpl_list: imap-vport-tmpl-list -------------------- imap-vport-tmpl-list is **JSON List** of :ref:`3969_imap-vport-tmpl_attributes` imap-vport-tmpl-list : [ { :ref:`3969_imap-vport-tmpl_attributes` }, { :ref:`3969_imap-vport-tmpl_attributes` }, ... ] .. _3969_imap-vport-tmpl_attributes: imap-vport-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 ` **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:`3969_trigger-stats-inc` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/imap-vport-tmpl/{name}/trigger-stats-inc ` **trigger-stats-rate** **Description:** trigger-stats-rate is a **JSON Block**. Please see below for :ref:`3969_trigger-stats-rate` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/imap-vport-tmpl/{name}/trigger-stats-rate ` **trigger-stats-severity** **Description:** trigger-stats-severity is a **JSON Block**. Please see below for :ref:`3969_trigger-stats-severity` **Type:** Object **Reference Object:** :doc:`/axapi/v3/visibility/packet-capture/object-templates/imap-vport-tmpl/{name}/trigger-stats-severity ` **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 .. _3969_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 .. _3969_trigger-stats-inc: trigger-stats-inc ^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **auth_unsupported** **Description** Enable automatic packet-capture for Unsupported auth **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bad_sequence** **Description** Enable automatic packet-capture for Bad Sequence **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **cant_find_epsv** **Description** Enable automatic packet-capture for cant find epsv **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **cant_find_pasv** **Description** Enable automatic packet-capture for cant find pasv **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **cl_est_err** **Description** Enable automatic packet-capture for Client EST state erro **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **cl_request_err** **Description** Enable automatic packet-capture for Client RQ state error **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **data_send_fail** **Description** Enable automatic packet-capture for data send fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **data_server_conn_fail** **Description** Enable automatic packet-capture for data svr conn fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **insert_tuple_fail** **Description** Enable automatic packet-capture for Serv Sel insert tuple fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **invalid_start_line** **Description** Enable automatic packet-capture for invalid start line **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **line_too_long** **Description** Enable automatic packet-capture for line too long **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **no_route** **Description** Enable automatic packet-capture for no route failure **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **rsv_persist_conn_fail** **Description** Enable automatic packet-capture for Serv Sel Persist fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ser_connecting_err** **Description** Enable automatic packet-capture for Serv CTNG state error **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server_response_err** **Description** Enable automatic packet-capture for Serv RESP state error **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **smp_create_fail** **Description** Enable automatic packet-capture for smp create fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **smp_v4_fail** **Description** Enable automatic packet-capture for Serv Sel SMPv4 fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **smp_v6_fail** **Description** Enable automatic packet-capture for Serv Sel SMPv6 fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **snat_fail** **Description** Enable automatic packet-capture for source nat failure **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **svrsel_fail** **Description** Enable automatic packet-capture for Server selection failure **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **unsupported_pbsz_value** **Description** Enable automatic packet-capture for Unsupported PBSZ **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **unsupported_prot_value** **Description** Enable automatic packet-capture for Unsupported PROT **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 .. _3969_trigger-stats-rate: trigger-stats-rate ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **auth_unsupported** **Description** Enable automatic packet-capture for Unsupported auth **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **bad_sequence** **Description** Enable automatic packet-capture for Bad Sequence **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **cant_find_epsv** **Description** Enable automatic packet-capture for cant find epsv **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **cant_find_pasv** **Description** Enable automatic packet-capture for cant find pasv **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **cl_est_err** **Description** Enable automatic packet-capture for Client EST state erro **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **cl_request_err** **Description** Enable automatic packet-capture for Client RQ state error **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **data_send_fail** **Description** Enable automatic packet-capture for data send fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **data_server_conn_fail** **Description** Enable automatic packet-capture for data svr conn fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **duration** **Description** Time in seconds to look for the anomaly, default is 60 **Type:** number **Range:** 1-250 **Default:** 60 **insert_tuple_fail** **Description** Enable automatic packet-capture for Serv Sel insert tuple fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **invalid_start_line** **Description** Enable automatic packet-capture for invalid start line **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **line_too_long** **Description** Enable automatic packet-capture for line too long **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **no_route** **Description** Enable automatic packet-capture for no route failure **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **rsv_persist_conn_fail** **Description** Enable automatic packet-capture for Serv Sel Persist fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **ser_connecting_err** **Description** Enable automatic packet-capture for Serv CTNG state error **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **server_response_err** **Description** Enable automatic packet-capture for Serv RESP state error **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **smp_create_fail** **Description** Enable automatic packet-capture for smp create fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **smp_v4_fail** **Description** Enable automatic packet-capture for Serv Sel SMPv4 fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **smp_v6_fail** **Description** Enable automatic packet-capture for Serv Sel SMPv6 fail **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **snat_fail** **Description** Enable automatic packet-capture for source nat failure **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **svrsel_fail** **Description** Enable automatic packet-capture for Server selection failure **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 **unsupported_pbsz_value** **Description** Enable automatic packet-capture for Unsupported PBSZ **Type:** boolean **Supported Values:** true, false, 1, 0 **Default:** 0 **unsupported_prot_value** **Description** Enable automatic packet-capture for Unsupported PROT **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