.. _netflow_template:

netflow template
================

IPFIX Custom Template


template Specification
----------------------

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

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

	 **Object Key(s)**                     *name*

	 **Collection Name**                   :ref:`1564_template_list`

	 **Collection URI**                    /axapi/v3/netflow/template

	                                       

	 **Element Name**                      template

	 **Element URI**                       /axapi/v3/netflow/template/{name}

	 **Element Attributes**                template_attributes

	 **Partition Visibility**              shared

	 **Schema**                             :download:`template schema <netflow-template/netflow-template.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/netflow/template



.. raw:: html

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


:ref:`1564_template_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/netflow/template



.. raw:: html

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


:ref:`1564_template_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/netflow/template/{name}



.. raw:: html

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


:ref:`1564_template_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/netflow/template



.. raw:: html

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


:ref:`1564_template_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/netflow/template/{name}



.. raw:: html

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


:ref:`1564_template_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/netflow/template/{name}



.. raw:: html

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


:ref:`1564_template_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/netflow/template



.. raw:: html

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


:ref:`1564_template_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/netflow/template/{name}



.. raw:: html

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


:ref:`1564_template_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _1564_template_list:

template-list
-------------


    template-list is **JSON List** of :ref:`1564_template_attributes` 

        template-list : [

             { :ref:`1564_template_attributes` },

             { :ref:`1564_template_attributes` },

             ...

         ]

.. _1564_template_attributes:

template attributes
-------------------

    **information-element-blk**

        **Type:** List

    **ipfix-template-id**

        **Description** Custom IPFIX Template ID

        **Type:** number

        **Range:** 2001-3000

    **name**

        **Description** IPFIX CUSTOM Template Name

        **Type:** string

        **Format:** string-rlx

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

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

.. _1564_information-element-blk:

information-element-blk
^^^^^^^^^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *list*

	 **Block object keys**             

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

    **information-element**

        **Description** 'fwd-tuple-vnp-id': Session forward tuple partition id (ID: 33028); 'rev-tuple-vnp-id': Session reverse tuple partition id (ID: 33029); 'source-ipv4-address': IPv4 source address in the IP packet header (ID: 8); 'source-ipv4-prefix-len': Prefix length for IPv4 source address(ID: 9); 'dest-ipv4-address': IPv4 destination address in the IP packet header (ID: 12); 'dest-ipv4-prefix-len': Prefix length for IPv4 dest address(ID: 13); 'source-ipv6-address': IPv6 source address in the IP packet header (ID: 27); 'source-ipv6-prefix-len': Prefix length for IPv6 source address(ID:29); 'dest-ipv6-address': IPv6 destination address in the IP packet header (ID:28); 'dest-ipv6-prefix-len': Prefix length for IPv6 dest address (ID:30); 'post-nat-source-ipv4-address': IPv4 natted source address (ID: 225); 'post-nat-dest-ipv4-address': IPv4 natted destination address(ID: 226); 'post-nat-source-ipv6-address': IPv6 natted source address (ID: 281); 'post-nat-dest-ipv6-address': IPv6 natted destination address (ID: 282); 'source-port': Source port identifier in the transport header (ID: 7); 'dest-port': Destination port identifier in the transport header (ID: 11); 'post-nat-source-port': L4 natted source port(ID: 227); 'post-nat-dest-port': L4 natted destination port (ID: 228); 'fwd-tuple-type': Session forward tuple type (ID: 33024); 'rev-tuple-type': Session reverse tuple type (ID: 33025); 'ip-proto': Value of the protocol number in the IP packet header (ID: 4); 'flow-direction': Flow direction: 0:inbound(To an outside interface)/1:outbound(To an inside interface) (ID: 61); 'tcp-control-bits': Cumulative of all the TCP flags seen for this flow (ID: 6); 'fwd-bytes': Incoming bytes associated with an IP Flow (ID: 1); 'fwd-packets': Incoming packets associated with an IP Flow (ID: 2); 'rev-bytes': Delta bytes in reverse direction of bidirectional flow record (ID: 32769); 'rev-packets': Delta packets in reverse direction of bidirectional flow record (ID: 32770); 'in-port': Incoming interface port (ID: 10); 'out-port': Outcoming interface port (ID: 14); 'in-interface': Incoming interface name e.g. ethernet 0 (ID: 82); 'out-interface': Outcoming interface name e.g. ethernet 0 (ID: 32850); 'port-range-start': Port number identifying the start of a range of ports (ID: 361); 'port-range-end': Port number identifying the end of a range of ports (ID: 362); 'port-range-step-size': Step size in a port range (ID: 363); 'port-range-num-ports': Number of ports in a port range (ID: 364); 'rule-name': Rule Name (ID: 33034); 'rule-set-name': Rule-Set Name (ID: 33035); 'fw-source-zone': Firewall Source Zone Name (ID: 33036); 'fw-dest-zone': Firewall Dest Zone Name (ID: 33037); 'application-id': Application ID (ID: 95); 'application-name': Application Name (ID: 96); 'imsi': Subscriber Attribute IMSI (ID: 455); 'msisdn': Subscriber Attribute MSISDN (ID: 456); 'imei': Subscriber Attribute IMEI (ID: 33030); 'radius-custom1': Radius Attribute Custom 1 (ID: 33031); 'radius-custom2': Radius Attribute Custom 2(ID: 33032); 'radius-custom3': Radius Attribute Custom 3 (ID:33033); 'radius-custom4': Radius Attribute Custom 4 (ID: 33067); 'radius-custom5': Radius Attribute Custom 5(ID: 33068); 'radius-custom6': Radius Attribute Custom 6 (ID:33069); 'flow-start-msec': The absolute timestamp of the first packet of the flow (ID: 152); 'flow-duration-msec': Difference in time between the first observed packet of this flow and the last observed packet of this flow (4 bytes) (ID: 161); 'flow-duration-msec-64': Difference in time between the first observed packet of this flow and the last observed packet of this flow (8 bytes) (ID: 33039); 'flow-end-msec': The absolute timestamp of the last packet of the flow (ID: 153); 'nat-event': Indicates a NAT event (ID: 230); 'fw-event': Indicates a FW session event(ID: 233); 'fw-deny-reset-event': Indicates a FW deny/reset event (ID: 33038); 'cgn-flow-direction': Flow direction: 0:inbound(To an outside interface)/1:outbound(To an inside interface)/2:hairpin(From an inside interface to an inside interface) (ID: 33040); 'fw-dest-fqdn': Firewall matched fqdn(ID: 33041); 'flow-end-reason': A10 flow end reason(ID: 33042); 'gtp-deny-reason': Indicates a GTP deny event (ID: 33043); 'gtp-apn': Indicates GTP APN (ID: 33044); 'gtp-steid': Indicates GTP Source TEID (ID: 33045); 'gtp-dteid': Indicates GTP Destination TEID (ID: 33046); 'gtp-selection-mode': Indicates GTP Selection Mode (ID: 33047); 'gtp-mcc': Indicates the MCC of the Serving Network (ID: 33048); 'gtp-mnc': Indicates the MNC of the serving network (ID: 33049); 'gtp-rat-type': Indicates the RAT Type received in the GTP Control packet (ID: 33050); 'gtp-pdn-pdp-type': Indicates the PDN/PDP Type in the GTP Control Packet (ID: 33051); 'gtp-uli': Indicates the User Location Information (ID: 33052); 'gtp-enduser-v4-addr': Indicates the Subscriber IPv4 Address (ID: 33053); 'gtp-enduser-v6-addr': Indicates the Subscriber IPv6 Address (ID: 33054); 'gtp-bearer-id-or-nsapi': Indicates the EPS Bearer ID or NSAPI of the Subscriber (ID: 33055); 'gtp-qci': Indicates the QoS Profile or Traffic Class of the subscriber (ID: 33056); 'gtp-info-event-ind': Indicates a GTP Info event(ID: 33057); 'gtp-restarted-node-ipv4': Restarted S5 Node IPV4 Address(ID: 33058); 'gtp-restarted-node-ipv6': Restarted S5 Node IPV6 Address(ID: 33059); 'gtp-c-tunnels-removed-with-node-restart': Indicates GTP-C tunnels removed by Node restart (ID: 33060); 'radius-imsi': Subscriber Attribute IMSI (Deprecated Field) (ID: 455); 'radius-msisdn': Subscriber Attribute MSISDN (Deprecated Field) (ID: 456); 'radius-imei': Subscriber Attribute IMEI (Deprecated Field) (ID: 33030); 'event-time-msec': The absolute time in milliseconds of an event observation(ID: 323); 'security-event-type': Type of security event(ID: 33063); 'limit-exceeded-count': Limit exceeded count for FW concurrent session(ID: 33062); 'rate-limit-key': Rate Limit Key(ID: 33064); 'rate-limit-type': Rate Limit Type(ID: 33065); 'rate-limit-drop-count': Rate Limit Drop Count(ID: 33066); 

        **Type:** string

        **Supported Values:** fwd-tuple-vnp-id, rev-tuple-vnp-id, source-ipv4-address, source-ipv4-prefix-len, dest-ipv4-address, dest-ipv4-prefix-len, source-ipv6-address, source-ipv6-prefix-len, dest-ipv6-address, dest-ipv6-prefix-len, post-nat-source-ipv4-address, post-nat-dest-ipv4-address, post-nat-source-ipv6-address, post-nat-dest-ipv6-address, source-port, dest-port, post-nat-source-port, post-nat-dest-port, fwd-tuple-type, rev-tuple-type, ip-proto, flow-direction, tcp-control-bits, fwd-bytes, fwd-packets, rev-bytes, rev-packets, in-port, out-port, in-interface, out-interface, port-range-start, port-range-end, port-range-step-size, port-range-num-ports, rule-name, rule-set-name, fw-source-zone, fw-dest-zone, application-id, application-name, application-category-name, application-subcategory-name, imsi, msisdn, imei, radius-custom1, radius-custom2, radius-custom3, radius-custom4, radius-custom5, radius-custom6, flow-start-msec, flow-duration-msec, flow-duration-msec-64, flow-end-msec, nat-event, fw-event, fw-deny-reset-event, cgn-flow-direction, fw-dest-fqdn, flow-end-reason, gtp-deny-reason, gtp-apn, gtp-steid, gtp-dteid, gtp-selection-mode, gtp-mcc, gtp-mnc, gtp-rat-type, gtp-pdn-pdp-type, gtp-uli, gtp-enduser-v4-addr, gtp-enduser-v6-addr, gtp-bearer-id-or-nsapi, gtp-qci, gtp-info-event-ind, gtp-restarted-node-ipv4, gtp-restarted-node-ipv6, gtp-c-tunnels-removed-with-node-restart, radius-imsi, radius-msisdn, radius-imei, event-time-msec, security-event-type, limit-exceeded-count, rate-limit-key, rate-limit-type, rate-limit-drop-count