netflow template

IPFIX Custom Template

template Specification

   
Type Collection
Object Key(s) name
Collection Name template-list
Collection URI /axapi/v3/netflow/template
Element Name template
Element URI /axapi/v3/netflow/template/{name}
Element Attributes template_attributes
Schema template schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/netflow/template

template attributes

Create List

POST

/axapi/v3/netflow/template

template attributes

Get Object

GET

/axapi/v3/netflow/template/{name}

template attributes

Get List

GET

/axapi/v3/netflow/template

template-list

Modify Object

POST

/axapi/v3/netflow/template/{name}

template attributes

Replace Object

PUT

/axapi/v3/netflow/template/{name}

template attributes

Replace List

PUT

/axapi/v3/netflow/template

template-list

Delete Object

DELETE

/axapi/v3/netflow/template/{name}

template attributes

template-list

template-list is JSON List of template attributes

template-list : [

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

information-element-blk

Specification  
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); ‘dest-ipv4-address’: IPv4 destination address in the IP packet header (ID: 12); ‘source-ipv6-address’: IPv6 source address in the IP packet header (ID: 27); ‘dest-ipv6-address’: IPv6 destination address in the IP packet header (ID:28); ‘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); ‘radius-imsi’: Radius Attribute IMSI (ID: 455); ‘radius-msisdn’: Radius Attribute MSISDN (ID: 456); ‘radius-imei’: Radius 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); ‘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); ‘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);

Type: string

Supported Values: fwd-tuple-vnp-id, rev-tuple-vnp-id, source-ipv4-address, dest-ipv4-address, source-ipv6-address, dest-ipv6-address, 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, radius-imsi, radius-msisdn, radius-imei, radius-custom1, radius-custom2, radius-custom3, flow-start-msec, flow-duration-msec, flow-duration-msec-64, nat-event, fw-event, fw-deny-reset-event, cgn-flow-direction, fw-dest-fqdn, flow-end-reason, event-time-msec