$ oc netobserv [<command>] [<feature_option>] [<command_options>] (1)
The Network Observability CLI (oc netobserv
) has most features and filtering options that are available for the Network Observability Operator. You can pass command line arguments to enable features or filtering options.
The Network Observability CLI (oc netobserv
) is a CLI tool for capturing flow data and packet data for further analysis.
oc netobserv
syntax$ oc netobserv [<command>] [<feature_option>] [<command_options>] (1)
1 | Feature options can only be used with the oc netobserv flows command. They cannot be used with the oc netobserv packets command. |
Command | Description |
---|---|
|
Capture flows information. For subcommands, see the "Flow capture subcommands" table. |
|
Capture packets from a specific protocol or port pair, such as |
|
Remove the Network Observability CLI components. |
|
Print the software version. |
|
Show help. |
The Network Observability enrichment to display zone, node, owner and resource names including optional features about packet drops, DNS latencies and Round-trip time can only be enabled when capturing flows. These do not appear in packet capture pcap output file.
$ oc netobserv flows [<enrichment_options>] [<subcommands>]
Option | Description | Possible values | Default |
---|---|---|---|
|
Enable packet drop. |
|
|
|
Enable round trip time. |
|
|
|
Enable DNS tracking. |
|
|
|
Show help. |
- |
- |
|
Interfaces to match on the flow. For example, |
|
- |
Flow capture has mandatory commands as well as additional options, such as enabling extra features about packet drops, DNS latencies, Round-trip time, and filtering.
oc netobserv flows
syntax$ oc netobserv flows [<feature_option>] [<command_options>]
Option | Description | Possible values | Mandatory | Default |
---|---|---|---|---|
|
Enable flow filter. |
|
Yes |
|
|
Action to apply on the flow. |
|
Yes |
|
|
CIDR to match on the flow. |
|
Yes |
|
|
Protocol to match on the flow |
|
No |
- |
|
Direction to match on the flow |
|
No |
- |
|
Destination port to match on the flow. |
|
no |
- |
|
Source port to match on the flow. |
|
No |
- |
|
Port to match on the flow. |
|
No |
- |
|
Source port range to match on the flow. |
|
No |
- |
|
Destination port range to match on the flow. |
|
No |
- |
|
Port range to match on the flow. |
|
No |
- |
|
ICMP type to match on the flow. |
|
No |
- |
|
ICMP code to match on the flow. |
|
No |
- |
|
Peer IP to match on the flow. |
|
No |
- |
You can filter on port and protocol for packet capture data.
oc netobserv packets
syntax$ oc netobserv packets [<option>]
Option |
Description |
Mandatory |
Default |
|
Capture packets from a specific protocol and port pair. Use a comma as delimiter. For example, |
Yes |
- |