Skip to content
Jong Hun Han edited this page Dec 12, 2016 · 6 revisions

OSNT SUME Command-Line-Interface.

OSNT SUME has three commands to execute monitor, generator and timestamp capture in the CLI mode. The commands are generator_cli.py, monitor_cli.py, and packet_timestamp_capture.py. They are placed in the directory util/app/gui.

##1. OSNT SUME monitor_cli.py

usage: monitor_cli.py [-h] [--load_filter LOAD_FILTER] [--cut_size CUT_SIZE]
                      [--clear CLEAR]

optional arguments:
  -h, --help            show this help message and exit
  --load_filter LOAD_FILTER   OSNT monitor load a rule of filter. eg. --load_filter <filter file name>
  --cut_size CUT_SIZE   OSNT monitor packet cutter size in byte. --cut_size <byte size>
  --clear CLEAR   OSNT monitor clear stats and time. --clear <any value>

##2. OSNT SUME generator_cli.py

usage: generator_cli.py [-h] [--nf0_pcap NF0_PCAP] [--nf1_pcap NF1_PCAP]
                        [--nf2_pcap NF2_PCAP] [--nf3_pcap NF3_PCAP]
                        [--nf0_replay NF0_REPLAY] [--nf1_replay NF1_REPLAY]
                        [--nf2_replay NF2_REPLAY] [--nf3_replay NF3_REPLAY]
                        [--nf0_ipg NF0_IPG] [--nf1_ipg NF1_IPG]
                        [--nf2_ipg NF2_IPG] [--nf3_ipg NF3_IPG]
                        [--nf0_tx_ts_pos NF0_TX_TS_POS]
                        [--nf1_tx_ts_pos NF1_TX_TS_POS]
                        [--nf2_tx_ts_pos NF2_TX_TS_POS]
                        [--nf3_tx_ts_pos NF3_TX_TS_POS]
                        [--nf0_rx_ts_pos NF0_RX_TS_POS]
                        [--nf1_rx_ts_pos NF1_RX_TS_POS]
                        [--nf2_rx_ts_pos NF2_RX_TS_POS]
                        [--nf3_rx_ts_pos NF3_RX_TS_POS] [--clear CLEAR]

optional arguments:
  -h, --help            show this help message and exit
  --nf0_pcap NF0_PCAP   OSNT load a pcap file into nf0. eg. --nf0_pcap <pcap file name>
  --nf1_pcap NF1_PCAP   OSNT load a pcap file into nf1. eg. --nf1_pcap <pcap file name>
  --nf2_pcap NF2_PCAP   OSNT load a pcap file into nf2. eg. --nf2_pcap <pcap file name>
  --nf3_pcap NF3_PCAP   OSNT load a pcap file into nf3. eg. --nf3_pcap <pcap file name>
  --nf0_replay NF0_REPLAY   OSNT nf0 run packet replay. eg. --nf0_replay <replay number>
  --nf1_replay NF1_REPLAY   OSNT nf1 run packet replay. eg. --nf1_replay <replay number>
  --nf2_replay NF2_REPLAY   OSNT nf2 run packet replay. eg. --nf2_replay <replay number>
  --nf3_replay NF3_REPLAY   OSNT nf3 run packet replay. eg. --nf3_replay <replay number>
  --nf0_ipg NF0_IPG   OSNT nf0 IPG setting in nsec. eg. --nf0_ipg <number>
  --nf1_ipg NF1_IPG   OSNT nf1 IPG setting in nsec. eg. --nf1_ipg <number>
  --nf2_ipg NF2_IPG   OSNT nf2 IPG setting in nsec. eg. --nf2_ipg <number>
  --nf3_ipg NF3_IPG   OSNT nf3 IPG setting in nsec. eg. --nf3_ipg <number>>
  --nf0_tx_ts_pos NF0_TX_TS_POS   OSNT nf0 tx timestamp position( > 0) setting. eg. --nf0_tx_ts_pos <number>
  --nf1_tx_ts_pos NF1_TX_TS_POS   OSNT nf1 tx timestamp position( > 0) setting. eg. --nf1_tx_ts_pos <number>
  --nf2_tx_ts_pos NF2_TX_TS_POS   OSNT nf2 tx timestamp position( > 0) setting. eg. --nf2_tx_ts_pos <number>
  --nf3_tx_ts_pos NF3_TX_TS_POS   OSNT nf3 tx timestamp position( > 0) setting. eg. --nf3_tx_ts_pos <number>
  --nf0_rx_ts_pos NF0_RX_TS_POS   OSNT nf0 rx timestamp position( > 0) setting. eg. --nf0_rx_ts_pos <number>
  --nf1_rx_ts_pos NF1_RX_TS_POS   OSNT nf1 rx timestamp position( > 0) setting. eg. --nf1_rx_ts_pos <number>
  --nf2_rx_ts_pos NF2_RX_TS_POS   OSNT nf2 rx timestamp position( > 0) setting. eg. --nf2_rx_ts_pos <number>
  --nf3_rx_ts_pos NF3_RX_TS_POS   OSNT nf3 rx timestamp position( > 0) setting. eg. --nf3_rx_ts_pos <number>
  --clear CLEAR   OSNT stop generator and clear setting.

##3. OSNT SUME packet_timestamp_capture.py

usage: packet_timestamp_capture.py [-h] [--tx_ts_pos TX_TS_POS]
                                   [--rx_ts_pos RX_TS_POS]
                                   [--sample_no SAMPLE_NO]
                                   [--file_name FILE_NAME] [--if_name IF_NAME]
                                   [--verbose VERBOSE]

optional arguments:
  -h, --help            show this help message and exit
  --tx_ts_pos TX_TS_POS   Tx timestamp position in packet (Number).
  --rx_ts_pos RX_TS_POS   Rx timestamp position in packet (Number).
  --sample_no SAMPLE_NO   Number of packet for timestamp capturing (Number).
  --file_name FILE_NAME   File name to store the results. Default <test.dat>
  --if_name IF_NAME   Network interface name, nf0-nf3
  --verbose VERBOSE   --Show rx and tx timestamp values - On (Default: Off).