Diagnostics Capture

The tellabs capture feature allows capture of packets into a wireshark readable file on BOLT. The capture function consists of two actions and one status attribute. The capture start action will start the capture and define the filter criteria for the capture. The capture stop function will stop the capture and write out the file to disk. The file, once written out, is available by default in /usr/bob/sftp/capture and can be retrieved from the board using sftp and logging in using a user BOLT CLI login.

Diagnostics Capture Attributes

Attribute	Values	Description
Start		Action to start a tcpdump capture in wireshark pcap format.
Input		Container for action parameters
Filename	<string>	The filename ot save the pcap file into.
Net-interface	<string> of form Netx where is the uplink number.	A parameter used when performing a capture on uplink net interfaces. Exclusive of nni-interface, or pon-interface options.
Nni-interface	<string> of form QSFP1-2-x or SFP1-1-x	When capturing on a single nni port, this option is used. Excludes use of net-interface or pon-interface options.
Pon-interface	<string> of form MDS1-1-x where x is the PON port number from 1..16	When capturing traffic on a PON port, this option is used. Excludes use of the net-interface or nni-interface options..
Vlan	Vlanid or any	The VLAN to capture on.
Dir	Ingress \| egress \| both	Ingress \| egress \| both
Options	<string>	A string containing options to be passed to tcpdump to allow further filtering of the packets. Standard tcpdump syntax is supported.

Command Path – tolt>diagnostics>capture>start>
Module – tolt
Container – diagnostics
Command – capture
Action – start – Action to start a tcpdump capture in wireshark pcap format
Container – Input – Container for action parameters
Types –
- Filename – The filename ot save the pcap file into.
  - <string>
- Net-interface – A parameter used when performing a capture on uplink net interfaces. Exclusive of nni-interface, or pon-interface options.
  - <string> of form Netx where is the uplink number.
- Nni-interface – When capturing on a single nni port, this option is used. Excludes use of net-interface or pon-interface options.
  - <string> of form QSFP1-2-x or SFP1-1-x
- Pon-interface – When capturing traffic on a PON port, this option is used. Excludes use of the net-interface or nni-interface options.
  - <string> of form MDS1-1-x where x is the PON port number from 1..16
- Vlan – The VLAN to capture on.
  - Vlanid or any
- Dir – Ingress, egress, or both. that the IP address is a valid IP address will exclude all Multicast Address, all FFs or all zeroes. IP is checked in all ARP requests and responses. Should typically be enabled.
  - Ingress | egress | both
- Options – A string containing options to be passed to tcpdump to allow further filtering of the packets. Standard tcpdump syntax is supported.
  - <string>

Diagnostics Capture Start Example

Command Path – tolt>diagnostics>capture>start>
Module – tolt
Container – diagnostics
Command – capture
Action – start
Types – Example Parameters
- dir both
- filename test1.pcap
- net-interface NET1
- vlan any

From the MDS1-ESUA# command line, input tolt diagnostics capture start dir both filename test1.pcap net-interface NET1 vlan any, and press Enter. Output similar to the following is displayed:

MDS1-ESUA# tolt diagnostics capture start dir both filename test1.pcap 
net-interface NET1 vlan any <enter>
action-success true
MDS1-ESUA#  
System message at 2025-01-01 06:07:41..
Commit performed by admin via tcp using tcpdump_action. 
MDS1-ESUA# _

Diagnostics Capture Stop Example

Command Path – tolt>diagnostics>capture>stop>
Module – tolt
Container – diagnostics
Command – capture
Action – stop

From the MDS1-ESUA# command line, input tolt diagnostics capture stop, and press Enter. Output similar to the following is displayed:

MDS1-ESUA# tolt diagnostics capture stop <enter>
action-success true
MDS1-ESUA#  
System message at 2025-01-01 06:07:41..
Commit performed by admin via tcp using tcpdump_action. 
MDS1-ESUA# _

The file will now be present on the disk of the OLT and can be pulled off the OLT using sftp tools such as winscp. Login with your normal login to the OLT and go to /usr/bob/sftp/capture to see the files.

Diagnostics Capture Status

The diagnostics capture status command can be used to see whether a capture is currently running.

Command Path – tolt>diagnostics>capture>start>
Module – tolt
Container – diagnostics
Command – capture
Action – start
Types – Example Parameters
- dir both
- filename test1.pcap
- net-interface NET1
- vlan any

From the MDS1-ESUA# command line, input tolt diagnostics capture start dir both filename test1.pcap
net-interface NET1 vlan any, and press Enter. Output similar to the following is displayed:
MDS1-ESUA# tolt diagnostics capture start dir both filename test1.pcap net-interface NET1 vlan any <enter> action-success true MDS1-ESUA#_

From the MDS1-ESUA# command line, input show tolt diagnostics capture status, and press Enter.
From the MDS1-ESUA# command line, input tolt diagnostics capture stop, and press Enter.

From the MDS1-ESUA# command line, input show tolt diagnostics capture status, and press Enter. Output similar to the following is displayed:

MDS1-ESUA# show tolt diagnostics capture status <enter>
tolt diagnostics capture status running
MDS1-ESUA# tolt diagnostics capture stop <enter>
action-success true 
MDS1-ESUA# show tolt diagnostics capture status <enter>
tolt diagnostics capture status stopped 
MDS1-ESUA# _