Commands For Ipfix

12.4 Commands for IPFIX

12.4.1 cache

Command: cache {entries <entries> | timeout {active <active-time> | inactive <inactive-time>} | type {normal | tcp-end detect}}
no cache {entries | timeout {active | inactive} | type}
Function: Configure the record number, the output record method, aging time, and active time saved in the cache. The no command deletes the configuration.
Parameters:

  • <entries>: maximum record number which can be saved. Use one of the following 4 value options:
    • item1: cache max record number 512 entries.
    • item2: cache max record number 1024 entries.
    • item3: cache max record number 2048 entries.
    • item4: cache max record number 4096 entries.
  • <active-time>: the active flow timeout. Use one of the following 4 value options:
    • time1: set minimum active time to 1 minute.
    • time2: set minimum active time to 10 minutes.
    • time3: set minimum active time to 60 minute.
    • time4: set minimum active time to 300 minute.
  • <inactive-time>: the inactive flow timeout. Use one of the following 4 value options:
    • time1: set aging time to 1 seconds.
    • time2: set aging time to 60 seconds.
    • time3: set aging time to 120 seconds.
    • time4: set aging time to 320 seconds.

Command mode: IPFIX Monitor Configuration Mode
Default: <entries> is 2048. <active-time> is 1 minute. <inactive-time> is 60s. cache type is normal.
Usage guide: When configuring the cache under monitor mode, the monitor should not be applied to any ports. If the monitor is applied by the port, then cancel the application from the port. The parameter value set <entries> should be big enough to avoid losing records when the cache is full.
There are two kinds of output record times: timeout active and timeout inactive; they can be configured at the same time. Timeout active <active-time> sets the active time of the record. When the corresponding time reaches an active record, it will be exported. Timeout inactive <inactive-time> sets the aging time of the record. When a list entry does not update in the configured time, the packet information will be exported.
Cache configures the output method of the records. Two methods are optional. Using cache type ?normal?, the list entries of the cache process the aging output according to the time value of timeout active and timeout inactive. When a list entry is aged, it will be deleted from cache and exported to the collector by exporter. Using cache type ?tcp-end detect,? the list entries of the cache process the aging output and check the end tag of TCP packets according to the time value of timeout active and timeout inactive. When the port receives the end tag of TCP, it will export the records of the cache.
Example: Set the max record number of cache as 1024 which corresponds to the monitor. When the active time of the records exceeds 1 minute, then export the records.

active500EM(config)#ipfix monitor my-ipfix-monitor
active500EM(config-ipfix-monitor)#cache entries item2
active500EM(config-ipfix-monitor)#cache timeout active time1
active500EM(config-ipfix-monitor)#cache type normal

Set the max record number of cache to 512 which corresponds to the monitor, then export the records.

active500EM(config)#ipfix monitor my-ipfix-monitor
active500EM(config-ipfix-monitor)#cache entries item1
active500EM(config-ipfix-monitor)#cache timeout inactive time1

 

12.4.2 clear ipfix statistic exporter

Command: clear ipfix statistic exporter <exporter-name>
Function: Clear the flow record statistic information of the specified exporter.
Parameter:

  • <exporter-name>: name of the exporter. The range cannot exceed the character string which is 32 bytes.

Command mode: Admin Mode
Default: None.
Usage guide: Clear the flow record statistic information of the specified exporter.
Example: Clear the flow record statistic information of the specified exporter.

active500EM#clear ipfix statistic exporter export-to-server

 

12.4.3 clear ipfix statistic interface ethernet

Command: clear ipfix statistic interface ethernet <IFNAME>
Function: Clear the flow record statistic information of the specified port.
Parameters:

  • <IFNAME>: port name where the IPFIX statistic information will be cleared.

Command mode: Admin Mode
Default: None.
Usage guide: Clear the flow record statistic information of the specified port.
Example: Clear the flow record statistic information of the specified port.

active500EM#clear ipfix statistic interface ethernet 1/0/1

 

12.4.4 collect counter

Command: collect counter {bytes | packets}
no collect counter {bytes | packets}
Function: Configure the number of bytes or packets of a flow as a non-keyword field. The no command deletes the configuration
Parameters:

  • bytes: selects bytes as the number of flows in a non-keyword field.
  • packets: selects packets as the number of flows in a non-keyword field.

Command mode: IPFIX Record Configuration Mode
Default: None.
Usage guide: The non-keyword field provides extra information, but is not used to match and create new flows. If more than one option is selected, this command can be configured many times.
Example: Configure the number of bytes for the flows as a non-keyword field.

active500EM(config)#ipfix record app-traffic-analysis
active500EM(config-ipfix-record)#collect counter bytes

 

12.4.5 collect timestamp sys-uptime

Command: collect timestamp sys-uptime {first | last}
no collect timestamp sys-uptime {first | last}
Function: Configure the arrival time as a non-keyword field for the first or last packet of the flow. The no command deletes the configuration.
Parameters:

  • first: indicates the arrival time of the first packet as a non-keyword field in the flow.
  • last: indicates the arrival time of the last packet as a non-keyword field in the flow.

Command mode: IPFIX Record Configuration Mode
Default: None.
Usage guide: The non-keyword field provides the extra information, but it is not used to match and create new flows. If more than one option is selected, this command can be configured many times.
Example: Configure the arrival time of the first packet as the non-keyword field in the flow.

active500EM(config)#ipfix record app-traffic-analysis
active500EM(config-ipfix-record)#collect timestamp sys-uptime first

 

12.4.6 deal

Command: deal {non-discard | discard | all}
no deal
Function: Configure monitoring of the discarded packets which are tagged. The no command restores to default.
Parameters:

  • non-discard: indicates that only the discarded packets which are not tagged will be monitored.
  • discard: indicates only the discarded packets which are tagged will be monitored.
  • all: indicates all packets will be monitored.

Command mode: IPFIX Monitor Configuration Mode
Default: Only monitor the discarded packet which is not tagged.
Usage guide: When configuring the deal under the monitor mode, ensure that the monitor is not currently applied to any ports. If the monitor is applied, cancel the application from the port.
Example: Monitor all packets.

active500EM(config)#ipfix monitor my-ipfix-monitor
active500EM(config-ipfix-monitor)#deal all

 

12.4.7 debug ipfix

Command: debug ipfix {monitor | exporter}
no debug ipfix {monitor | exporter}
Function: Open or close the application debug switch for IPFIX.
Parameters:

  • monitor: indicates the debug information that will print when flow records need to exported.
  • exporter: indicates the debug information will print after the flow records export.

Command mode: Admin Mode
Default: None.
Usage guide: Open or close the application debug switch for IPFIX.
Example: Open the debug switch of the monitor.

active500EM#debug ipfix monitor

 

12.4.8 description

Command: description <string>
no description
Function: Configure the description for monitor, export, record, and sampler. The no command deletes the configuration.
Parameters:

  • <string>: character string. The length cannot exceed 128 characters.

Command mode: IPFIX Monitor Configuration Mode, IPFIX Exporter Configuration Mode, IPFIX Record Configuration Mode, and IPFIX Sampler Configuration Mode
Default: None.
Usage guide: Configure the description for monitor, export, record, and sampler.
Example: Monitor all input packets, join the description information as shown below.

active500EM(config)#ipfix monitor my-ipfix-monitor
active500EM(config-ipfix-monitor)#description used for monitoring all packets received

 

12.4.9 exporter

Command: exporter <name>
no exporter <name>
Function: Define the flow record output rules of the monitor by configuring an exporter. The no command deletes the rules.
Parameters:

  • <name>: exporter name. The range cannot exceed the character string of 32 bytes.

Command mode: IPFIX Monitor Configuration Mode
Default: None.
Usage guide: Use IPFIX exporter to configure the output parameters before the exporter of the monitor is configured. Multiple exporters can be configured for a monitor to export the flow record information to multiple devices. At present, one monitor can configure 3 exporters at most.
Example: Configure the exporter as export-to-server for the monitor.

active500EM(config)#ipfix monitor my-ipfix-monitor
active500EM(config-ipfix-monitor)#exporter export-to-server

 

12.4.10 ipfix apply monitor

Command: ipfix apply monitor <monitor-name> [sampler <sampler-name>] {input | output}
no ipfix apply monitor <monitor-name> [sampler <sampler-name>] {input | output}
Function: Apply the IPFIX monitor function to the port. The no command disables the function.
Parameters:

  • monitor <monitor-name>: identifies the name of the monitor that needs to be applied to the port. The range cannot exceed the character string of 32 bytes.
  • sampler <sampler-name>: identifies the name of the sampler which needs to be applied to the port. The range cannot exceed the character string of 32 bytes.
  • input: selects monitoring the ingress direction of the port.
  • output: selects monitoring the egress direction of the port.

Command mode: Port Mode
Default: By default, disable the monitor on the port
Usage guide: Use the “ipfix monitor” command and “ipfix sampler” command to configure the related parameters before monitor and sampler are applied to the port. After the sampling rule is applied, the IPFX device can only record the packets which are sampled by the sampler. For each port, both the ingress and egress direction can configure one IPFIX monitor.
Example: Set the IPFIX function of the ingress direction for the port.

active500EM(config)#interface ethernet 1/0/2
active500EM(config-if-ethernet1/0/2)#ipfix monitor my-ipfix-monitor sampler SAMPLER-1 input

 

12.4.11 ipfix exporter

Command: ipfix exporter <name>
no ipfix exporter <name>
Function: Create a new exporter, or modify an existing exporter, then enter IPFIX Exporter Configuration Mode. The no command saves the configuration and exits IPFIX Exporter Configuration Mode.
Parameters:

  • <name>: exporter name. The range cannot exceed the character string of 32 bytes.

Command mode: Global Mode
Default: None.
Usage guide: The system can configure 512 exporters at most. An exporter only configures an IPv4 source/destination address or an IPv6 source/destination address. If the exporter is modified, ensure that the exporter is not currently in use by the monitor applied to the port. If deleting the exporter, ensure that the exporter is not currently being used by any monitor. The latest configuration will overwrite the previous configuration.
Example: Create the exporter.

active500EM(config)#ipfix exporter export-to-server
active500EM(config-ipfix-exporter)#

 

12.4.12 ipfix monitor

Command: ipfix monitor <name>
no ipfix monitor <name>
Function: Create a new monitor or modify an existing monitor, then enter IPFIX Monitor Configuration Mode. The no command saves the configuration and exits IPFIX Monitor Configuration Mode.
Parameters:

  • <name>: monitor name. The range cannot exceed the character string of 32 bytes.

Command mode: Global Mode
Default: None.
Usage guide: This mode can configure the exporter, cache, and record. The system supports 512 IPFIX monitors at most. If deleting or modifying the monitor, ensure that the monitor is not applied to the port. Otherwise, the no form of this command will delete the monitor from the port.
Example: Create the monitor.

active500EM(config)#ipfix monitor my-ipfix-monitor
active500EM(config-ipfix-monitor)#

 

12.4.13 ipfix record

Command: ipfix record <name>
no ipfix record <name>
Function: Create a new record or modify an existing record, then enter IPFIX Record Configuration Mode. The no command saves the configuration and exits IPFIX Record Configuration Mode.
Parameter:

  • <name>: record name. The range cannot exceed the character string of 32 bytes.

Command mode: Global Mode
Default: None.
Usage guide: The flow matching keyword is configured under this mode. The system supports 512 IPFIX records at most. If modifying the record, ensure that the record is not currently used by the monitor applied to the port. If deleting the record, ensure that the record is not used by any monitor. The flow keyword command and the non-keyword command can be configured many times in this mode.
Example: Create the record.

active500EM(config)#ipfix record app-traffic-analysis
active500EM(config-ipfix-record)#

 

12.4.14 ipfix sampler

Command: ipfix sampler <name>
no ipfix sampler <name>
Function: Create a new sampler or modify an existing sampler, then enter IPFIX Sampler Configuration Mode. The no command saves the configuration and exits IPFIX Sampler Configuration Mode.
Parameter:

  • <name>: sampler name. The range cannot exceed the character string of 32 bytes.

Command mode: Global Mode
Default: None.
Usage guide: Use the sampling function to reduce the number of the packets which are monitored by the device. After enabling the sampler, the packets are processed by the device that is the original 1/N in order to reduce the load of the device. The port applies the IPFIX monitor and sampler to monitor the sampling packets. The system supports 512 IPFIX samplers at most. If modifying or deleting the sampler, ensure that the sampler is not used by the monitor applied to the port. Otherwise, the ?no ipfix apply? command will delete it from the port.
Example: Create the sampler.

active500EM(config)#ipfix sampler SAMPLER-1
active500EM(config-ipfix-sampler)#

 

12.4.15 ipv4 destination

Command: ipv4 destination <ipv4-address> [source <ipv4-address>] no ipv4 destination
Function: Configure the destination and source IPv4 addresses which are exported by the flow records. The no command disables exports.
Parameter:

  • <ipv4-address>: destination and source IPv4 address exported by the flow records.

Command mode: IPFIX Exporter Configuration Mode
Default: The source address is the IPv4 address of the layer 3 interface and includes the output port.
Usage guide: Configure the destination and source IPv4 addresses which are exported by the flow records.
Example: Set the flow records to be exported to 172.16.1.1.

active500EM(config)#ipfix exporter export-to-server
active500EM(config-ipfix-exporter)#ipv4 destination 172.16.1.1

 

12.4.16 ipv6 destination

Command: ipv6 destination <ipv6-address> [source <ipv6-address>] no ipv6 destination
Function: Configure the destination and source IPv6 addresses which are exported by the flow records. The no command disables the export.
Parameters:

  • <ipv6-address>: destination and source IPv6 address exported by the flow records and is the global unicast address.

Command mode: IPFIX Exporter Configuration Mode
Default: The source address is the IPv6 address of the layer 3 interface and includes the output port.
Usage guide: Configure the destination and source IPv6 addresses which are exported by the flow records.
Example: Set the flow records to be exported to 2001::1, the source address of the output packets as 2001::2.

active500EM(config)#ipfix exporter export-to-server
active500EM(config-ipfix-exporter)#ipv6 destination 2001::1 source 2001::2

 

Command: match datalink ether-type
no match datalink ether-type
Function: Configures the ether-type value as the keyword. The no command deletes the configuration.
Parameters: None.
Command mode: IPFIX Record Configuration Mode
Default: None.
Usage guide: Use this keyword to match the monitor packets. This command is the keyword option (L2-KEY) of the non-IP packets. If select ipv4 command and select ipv6 commands are not configured, all packets will use this keyword to process the match. If select ipv4 command is configured, then IPv4 packets use IPv4 keywords to match, and other packets use this keyword to match. If select ipv6 command is configured, the IPv6 packets use IPv6 keywords to match, and other packets use this keyword to match. If the “select ipv4” command and “select ipv6” command are configured, then IPv4 packets use IPv4 keywords to match, IPv6 packets use IPv6 keywords to match, and non-IP packets use this keyword to match.
Example: Configure ethernet type as the match keyword.

active500EM(config)#ipfix record app-traffic-analysis
active500EM(config-ipfix-record)#match datalink ether-type

 

Command: match datalink mac {destination-address | source-address}
no match datalink mac {destination-address | source-address}
Function: Configures the MAC address as the keyword. If more than one option is selected, then this command can be configured many times. The no command deletes the configuration.
Parameters:

  • destination-address: destination MAC address that matches the packets.
  • source-address: source MAC address that matches the packets.

Command mode: IPFIX Record Configuration Mode
Default: None.
Usage guide: Use this keyword to match the monitor packets. This command is the keyword option (L2-KEY) of the non-IP packets. If the “select ipv4” command and “select ipv6”?command are not configured, all packets use this keyword to process the match. If the “select ipv4” command is configured, then IPv4 packets use IPv4 keywords to match, and other packets use this keyword to match. If the “select ipv6 command” is configured, the IPv6 packets use IPv6 keywords to match, and other packets use keyword to match. If the “select ipv4” command and “select ipv6” command are configured, then IPv4 packets use IPv4 keywords to match, IPv6 packets use IPv6 keywords to match, and non-IP packets use this keyword to match.
Example: Configure the destination MAC address as the match keyword.

active500EM(config)#ipfix record app-traffic-analysis
active500EM(config-ipfix-record)#match datalink mac destination-address

 

Command: match datalink vlan {id | priority}
no match datalink vlan {id | priority}
Function: Configure the VLAN ID or VLAN priority as the keyword. If more than one option is selected, this command can be configured many times. The no command deletes the configuration.
Parameters:

  • vlan id: identifies the VLAN ID that matches the packets.
  • priority: identifies the VLAN priority that matches the packets.

Command mode: IPFIX Record Configuration Mode
Default: None.
Usage guide: Use this keyword to match the monitor packet. This command is the keyword option (L2-KEY) of the non-IP packets. If the “select ipv4” command and “select ipv6” command are not configured, all packets use this keyword to match. If the “select ipv4” command is configured, then IPv4 packets use IPv4 keywords to match, and other packets use this keyword to match. If the “select ipv6″ command is configured, the IPv6 packets use IPv6 keywords to match, and other packets use this keyword to match. If the?”select ipv4” command and “select ipv6” command are configured, then IPv4 packets use IPv4 keywords to match, IPv6 packets use IPv6 keywords to match, and non-IP packets use this keyword to match.
Example: Configure vlan id as the match keyword.

active500EM(config)#ipfix record app-traffic-analysis
active500EM(config-ipfix-record)#match datalink vlan id

 

12.4.20 match ip

Command: match ip {protocol | tos | destination-port | source-port}
no match ip {protocol | tos | destination-port | source-port}
Function: Configure the head field of the IP packets as the keyword. If more than one option is selected, this command can be configured many times. The no command deletes the configuration.
Parameters:

  • protocol: matches IPv4 packets to the protocol field and the IPv6 packets to the next-header field.
  • tos: matches the tos field of the packets.
  • destination-port: matches the destination port ID field of the packets.
  • source-port: matches the source port ID field of the packets.

Command mode: IPFIX Record Configuration Mode
Default: None.
Usage guide: This command is the keyword option (IP-KEY) of the IP packets. If the?”select ipv4″ command is configured, then the keyword is configured by this command to validate the IPv4 packets. If the “select ipv6” command?is configured, then the keyword is configured by this command to validate the IPv6 packets.
Example: Configure the protocol as the match keyword.

active500EM(config)#ipfix record app-traffic-analysis
active500EM(config-ipfix-record)#match ip protocol

 

12.4.21 match ipv4-mask

Command: match ipv4-mask destination <mask-length> source <mask-length>
no match ipv4-mask
Function: Configure the IPv4 source and destination address, or the address mask, as the keyword. The no command deletes the configuration.
Parameters:

  • <mask-length>: mask length with a range of 0 to 32m and 0 indicating the address is not matched. Destination matches the IPv4 destination address of the packets.
  • source: matches the IPv4 source address of the packets.

Command mode: IPFIX Record Configuration Mode
Default: None.
Usage guide: This command is the keyword option (IPv4-KEY) of the IPv4 packets. If “select ipv4” is configured, the keyword configured by this command will validate the IPv4 packets. If not, the IPv4 packets will be invalidated.
Example: Configure the 24 bits mask of IPv4 destination address as the match keyword, and do not match the source address.

active500EM(config)#ipfix record app-traffic-analysis
active500EM(config-ipfix-record)#match ipv4-mask destination 24 source 0

 

12.4.22 match ipv6 flow-label

Command: match ipv6 flow-label
no match ipv6 flow-label
Function: Configure the IPv6 flow-label field as the keyword.
Parameters: None.
Command mode: IPFIX Record Configuration Mode
Default: None.
Usage guide: This command is the keyword option (IPv6-KEY) of the IPv6 packets. If “select ipv6” is configured, the keyword is configured by this command and will validate the IPv6 packets. If not, the IPV6 packets will be invalidated.
Example: Configure the flow-label field as the match keyword.

active500EM(config)#ipfix record app-traffic-analysis
active500EM(config-ipfix-record)#match ipv6 flow-label

 

12.4.23 match ipv6-prefix

Command: match ipv6-prefix destination <prefix-length> source <prefix-length>
no match ipv6-prefix
Function: Configure the IPv6 source and destination address, or the address mask, as the keyword. The no command deletes the configuration.
Parameters:

  • <prefix-length>: prefix length ranging from 0 to 128 with 0 indicating the address is not matched.
  • destination: matches the IPv6 destination address of the packets.
  • source: matches the IPv6 source address of the packets.

Command mode: IPFIX Record Configuration Mode
Default: None.
Usage guide: IPv6 packets use this keyword to match. This command is the keyword option (IPv6-KEY) of the IPv6 packets. If “select ipv6” is configured, the keyword configured by this command will validate the IPv6 packets. If not, the IPv6 packets will be invalidated.
Example: Configure the 64 bits prefix of IPv6 destination address and the 63 bits prefix of the IPv6 source address as the match keywords.

active500EM(config)#ipfix record app-traffic-analysis
active500EM(config-ipfix-record)#match ipv6-prefix destination 64 source 63

 

12.4.24 rate

Command: rate <number>
no rate
Function: Sets the packet interval of the sampling. The no command restores to default.
Parameters:

  • <number>: indicates the sampling interval as 1/N (does not distinguish the type of the packets). The valid configuration range is from 2 to 8191.

Command mode: IPFIX Sampler Configuration Mode
Default: Sample all packets.
Usage guide: Sets the packet interval of the sampling.
Example: Set the sampling interval as 1/0/3.

active500EM(config)#ipfix sampler SAMPLER-1
active500EM(config-ipfix-sampler)#rate 3

 

12.4.25 record

Command: record {<name> | default-set [ipv4] | [ipv6] | [l2] | [ipv4-ipv6] | [ipv4-l2] | [ipv6-l2]}
no record
Function: Define the flow keyword of the monitor packets by configuring a record. The no command deletes the record.
Parameters:

  • <name>: record name. The range cannot exceed the character string of 32 bytes. The record must exist. The record default-set sets basic flow keywords for the packets of each type, including L2 for L2 packets, IPv4 keywords for IPv4 packets, and IPv6 keywords for IPv6 packets.
  • record default-set ipv4: sets IPv4 keywords, including Port, Source IP Address, Destination IP Address, Protocol, Tos, L4 Source Port, and L4 Destination Port.
  • record default-set ipv6: sets IPv6 keywords, including Port, Source IPv6 Address, Destination IPv6 Address, Next Header, Tos, L4 Source Port, L4 Destination Port, and IPv6 Flow Label.
  • record default-set l2: sets the basic flow keywords of L2 and also includes Port, Source MAC Address, Destination MAC Address, VLAN ID, VLAN Priority, Ether Type.
  • record default-set ipv4-ipv6: sets IPv4 and IPv6 keywords.
  • record default-set ipv4-l2: sets IPv4 and L2 keywords.
  • record default-set ipv6-l2: sets IPv6 and L2 keywords.

Command mode: IPFIX Monitor Configuration Mode
Default: None
Usage guide: Each monitor has only one corresponding record, but a record can be applied to multiple monitors. When deleting or modifying a record, ensure the monitor is not applied to any ports.
Example: The monitor packets use the basic flow keywords to monitor.

active500EM(config)#ipfix monitor my-ipfix-monitor
active500EM(config-ipfix-monitor)#record default-set

The monitor packets use the basic flow keywords of IPv4 to monitor.

active500EM(config)#ipfix monitor my-ipfix-monitor
active500EM(config-ipfix-monitor)#record default-set ipv4

The monitor packets use the basic flow keywords of IPv4 and IPv6 to monitor.

active500EM(config)#ipfix monitor my-ipfix-monitor
active500EM(config-ipfix-monitor)#record default-set ipv4-ipv6

The monitor packets use the named record app-traffic-analysis to monitor.

active500EM(config)#ipfix monitor my-ipfix-monitor
active500EM(config-ipfix-monitor)#record app-traffic-analysis

 

12.4.26 select

Command: select {ipv4 | ipv6}
no select {ipv4 | ipv6}
Function: Select the type of the match keyword for the flow records. The no command removes the selection.
Parameters:

  • ipv4: selects IPv4 keywords.
  • ipv6: selects IPv6 keywords.

Command mode: IPFIX Record Configuration Mode
Default: None.
Usage guide: This command uses IPv4 and IPv6 keywords to configure the matching of flow records. If more than one option is selected, this command can be configured many times. After this command is configured, the configuration of match ip/match ipv4-mask/match ipv6-mask command takes effect.
Example: Configure the packets to match IPv4 and IPv6 keywords.

active500EM(config)#ipfix record app-traffic-analysis
active500EM(config-ipfix-record)#select ipv4
active500EM(config-ipfix-record)#select ipv6

 

12.4.27 set packet-type

Command: set packet-type {ipv4 | ipv6 | l2}
no set packet-type {ipv4 | ipv6 | l2}
Function: Configure the monitoring packet type. The no command restores to default.
Parameters:

  • ipv4: indicates IPv4 packets.
  • ipv6: indicates IPv6 packets.
  • l2: indicates non-IP packets.

Command mode: IPFIX Monitor Configuration Mode
Default: The port does not monitor any packets.
Usage guide: This command configures the type of packets monitored by the ports. If more than one option is selected, this command can be configured many times. The port only monitors the packets that conform to the selected type, or types, and does not process the packets of other types. It needs to associate with a select ipv4 | ipv6 command.
Example: Set the port to only monitor IPv4 and non-IP packets.

active500EM(config)#ipfix monitor my-ipfix-monitor
active500EM(config-ipfix-monitor)#set packet-type ipv4
active500EM(config-ipfix-monitor)#set packet-type l2

 

12.4.28 show ipfix exporter

Command: show ipfix exporter [<exporter-name>] Function: Show the output configuration information of IPFIX in the switch.
Parameters:

  • <exporter-name>: name of the exporter that needs to show the configuration information. The length cannot exceed 32 characters. If <exporter-name> is not provided, then all exporter information will be shown.

Command mode: Admin Mode
Default: None.
Usage guide: Show the output configuration information of IPFIX in the switch.
Example: Show the output configuration information of IPFIX in the switch.

active500EM#show ipfix exporter export-to-server
IPFIX Exporter export-to-server?
 Description: User defined
 No. of monitor users: 1
 No. of port users: 1
 Transport Configuration:
 Destination IPv4/IPv6 address: 172.16.1.1
 Source IPv4/IPv6 address: 172.16.6.2
 Transport Protocol: UDP
 Destination Port: 9995
 Refresh rate: 120 seconds
Displayed Information Explanation
IPFIX Exporter The exporter name
Description The description information of the exporter
No. of monitor users: 1 The monitor number that uses this output
No. of port users The port number that uses this output
Destination IPv4/IPv6 address Export the destination IPv4/IPv6 address of the IPFIX message
Source IPv4/IPv6 address Export the source IPv4/IPv6 address of the IPFIX message
Transport Protocol Transport protocol of the IPFIX message
Destination Port Destination port ID of the IPFIX message
Refresh rate The retransmit frequency of the template

 

12.4.29 show ipfix interface ethernet

Command: show ipfix interface ethernet <IFNAME>
Function: Show the IPFIX configuration information of the port.
Parameters:

  • <IFNAME>: port name that will show the IPFIX configuration information.

Command mode: Admin Mode
Default: None.
Usage guide: Show the IPFIX configuration information of the port.
Example: Show the IPFIX configuration information of the port.

active500EM#show ipfix interface ethernet 1/0/1
Interface Ethernet1/0/1
monitor: my-flow-monitor
monitor direction: output
traffic(ip): sampler SAMPLER-2
Displayed Information Explanation
Interface Ethernet The port name
monitor The monitor name applied by the port
monitor direction The monitor direction of the packets
traffic(ip) The sampling configuration of the ports (when the sampling is not configured, then it is shown as ON?

 

12.4.30 show ipfix monitor

Command: show ipfix monitor [<monitor-name>] Function: Show the IPFIX monitor information of the switch.
Parameters:

  • <monitor-name>: name of the monitor that needs to show the configuration information. The length cannot exceed 32 characters. If <monitor-name> is not provided, all monitor information will be shown.

Command mode: Admin Mode
Default: None.
Usage guide: Show the IPFIX monitor information of the switch.
Example: Show the IPFIX monitor information of the switch.

active500EM#show ipfix monitor my-ipfix-monitor
IPFIX Monitor my-ipfix-monitor:
Description: User defined
 No. of port users: 1
IPFIX record: app-traffic-analysis
IPFIX exporter count?1
IPFIX exporter: export-to-server
Cache:
 Type: normal
 Inactive Timeout: 60 seconds
 Active Timeout: 10 minutes
 Size: 4096 entries
Deal type: non-discard
Packet type: IPv4
Displayed Information Explanation
IPFIX Monitor The monitor name
Description The description information of the monitor
No. of port users T he port number that uses this monitor
IPFIX record The flow keyword configuration of the monitor
IPFIX exporter count The exporter count of the monitor
IPFIX exporter The exporter name used by the monitor
Type Type of output method
Inactive Timeout The aging time
Active Timeout The active time
Size The max record number which can be saved
Deal type Type of the packets (non-discard/discard)
Packet type Type of the packets (IPv4/IPv6/L2)

 

12.4.31 show ipfix record

Command: show ipfix record [<record-name>] Function: Show the IPFIX record information of the switch.
Parameter:

  • <record-name>: name of the record that needs to show the configuration information. The length cannot exceed 32 characters. If <record-name> is not provided, all record information will be shown.

Command mode: Admin Mode
Default: None.
Usage guide: Show the IPFIX record information of the switch.
Example: Show the IPFIX record information of the switch.

active500EM#show ipfix record app-traffic-analysis
IPFIX record app-traffic-analysis:
 Description: This ipfix record tracks application usage
 No. of monitor users: 1
 No. of port users: 1
Fields:
 select ipv4
 match ipv4-mask destination 24 source 0
 match ip source-port
 match ip destination-port
 collect counter packets
 collect counter bytes
Displayed Information Explanation
IPFIX record The record name
Description The description information of the record
No. of monitor users: 1 The monitor number that uses this record
No. of port users: 1 The port number that uses this record
Fields The keyword configured by the record
select ipv4 Use IPv4 keyword to match
match ipv4 destination mask 24 Use the destination IP address as the match keyword, the address mask as 24
match ip source-port Use the source port of the transport layer protocol as the match keyword
match ip destination-port Use the destination port of the transport layer protocol as the match keyword
collect counter packets Use the non-keyword packets
collect counter bytes Use the non-keyword bytes

 

12.4.32 show ipfix sampler

Command: show ipfix sampler [<sampler-name>] Function: Show the IPFIX sampling information of the switch.
Parameter:

  • <sampler-name>: name of the sampler that needs to show the configuration information. The length cannot exceed 32 characters. If <sampler-name> is not provided, all sampler information will be shown.

Command mode: Admin Mode
Default: None.
Usage guide: Show the IPFIX sampling information of the switch.
Example: Show the IPFIX sampling information of the switch.

active500EM#show ipfix sampler SAMPLER-1
Sampler SAMPLER-1:
Description: User defined
No. of port users: 1
Rate: 1 out of 3
Displayed Information Explanation
Sampler The sampler name
Description The description information of the sampler
No. of port users: 1 The port number that uses this sampling
Rate The sampling configuration

 

12.4.33 show ipfix statistic exporter

Command: show ipfix statistic exporter [<exporter-name>] Function: Show the statistic value of the flow records which are exported by the specified exporter.
Parameters:

  • <exporter-name>: exporter name. The length cannot exceed the character string of 32 bytes.

Command mode: Admin Mode
Default: None.
Usage guide: Show the statistic value of the flow records which are exported by the specified exporter.
Example: Show the statistic value of the flow records which are exported by the specified exporter.

active500EM#show ipfix statistic exporter export-to-server
IPFIX Exporter export-to-server:
 Total packets: 100
 Success packets: 95
 Fail packets: 5
Displayed Information Explanation
IPFIX Exporter The exporter name
Total The total of IPFIX information which is exported
Success The IPFIX information that is successful.
Fail The IPFIX information that fails

 

12.4.34 show ipfix statistic interface ethernet

Command: show ipfix statistic interface ethernet <IFNAME>
Function: Shows the number of the flow records which are monitored on the specific port for IPFIX.
Parameter:

  • <IFNAME>: name which will show the flow record information.

Command mode: Admin Mode
Default: None.
Usage guide: Shows the number of flow records which are monitored on the specific port for IPFIX.
Example: Shows the number of the flow records which are monitored on the specific port for IPFIX.

active500EM#show ipfix statistic interface ethernet 1/0/1
Interface Ethernet1/0/1
Number of record sent: 100
Number of record stored: 120
Displayed Information Explanation
Interface Ethernet The port name
Number of record sent The number of the flow records which are processed by the CPU
Number of record stored The number of the flow records which are stored by the hardware

 

12.4.35 transport

Command: transport {udp | tcp | sctp} [destination-port <port>] no transport
Function: Configure the protocol and the destination port ID which is used to transport records. At present, only the UDP protocol is supported. The no command deletes the configuration.
Parameters:

  • udp, tcp, and sctp: configure the protocol which is used to transport records.
  • destination-port <port>: port ID used to transport record. The valid range is from 4000 to 65535.

Command mode: IPFIX Exporter Configuration Mode
Default: The default uses the UDP protocol. The default destination port ID is 4739.
Usage guide: Configure the protocol and the destination port ID which is used to transport records.
Example: Set the UPD protocol which is used to transport records and set the destination port?ID as 9998.

active500EM(config)#ipfix exporter export-to-server
active500EM(config-ipfix-exporter)#transport udp destination-port 9998

 

12.4.36 udp template

Command: udp template {timeout-rate <seconds> | refresh-rate <packets>}
no udp template
Function: Configure the retransmit interval of the template. The no command restores to default.
Parameters:

  • <seconds>: sets the retransmit frequency of the template in seconds with a valid range of 1 to 86400s.
  • <packets>: set the retransmit frequency of the template in packet numbers with a valid range of 1 to 1000.

Command mode: IPFIX Exporter Configuration Mode
Default: 120s.
Usage guide: Two methods are optional for the retransmit mode of the template. One method uses time as the unit, and the other uses the packet number as the unit. After this command is configured, the template information will retransmit according to the configuration so the flow records can be analyzed by the transceiver. The options for this command are mutually exclusive.
Example: Set the packet number as the unit for the re-transmit frequency of the template, 20 packets re-transmit once.

active500EM(config)#ipfix monitor my-ipfix-exporter
active500EM(config-ipfix-exporter)#udp template refresh-rate 20

 


Return to Controller Wired CLI Table of Contents