diff --git a/modules/network-observability-netobserv-cli-reference.adoc b/modules/network-observability-netobserv-cli-reference.adoc index 75fbae7094cc..6512ea7e36c8 100644 --- a/modules/network-observability-netobserv-cli-reference.adoc +++ b/modules/network-observability-netobserv-cli-reference.adoc @@ -4,7 +4,7 @@ [id="network-observability-netobserv-cli-reference_{context}"] = Network Observability CLI usage -You can use the Network Observability CLI (`oc netobserv`) to pass command-line arguments to capture flows data, packets data, and metrics for further analysis and enable features supported by the Network Observability Operator. +You can use the Network Observability CLI (`oc netobserv`) to pass command line arguments to capture flows data, packets data, and metrics for further analysis and enable features supported by the Network Observability Operator. [id="cli-syntax_{context}"] == Syntax @@ -55,44 +55,44 @@ $ oc netobserv flows [] [] [cols="1,1,1",options="header"] |=== | Option | Description | Default -|--enable_all| enable all eBPF features | false -|--enable_dns| enable DNS tracking | false -|--enable_ipsec| enable IPsec tracking | false -|--enable_network_events| enable network events monitoring | false -|--enable_pkt_translation| enable packet translation | false -|--enable_pkt_drop| enable packet drop | false -|--enable_rtt| enable RTT tracking | false -|--enable_udn_mapping| enable User Defined Network mapping | false -|--get-subnets| get subnets information | false -|--sampling| value that determines the ratio of packets being sampled | 1 -|--background| run in background | false -|--copy| copy the output files locally | prompt -|--log-level| components logs | info -|--max-time| maximum capture time | 5m -|--max-bytes| maximum capture bytes | 50000000 = 50MB -|--action| filter action | Accept -|--cidr| filter CIDR | 0.0.0.0/0 -|--direction| filter direction | – -|--dport| filter destination port | – -|--dport_range| filter destination port range | – -|--dports| filter on either of two destination ports | – -|--drops| filter flows with only dropped packets | false -|--icmp_code| filter ICMP code | – -|--icmp_type| filter ICMP type | – -|--node-selector| capture on specific nodes | – -|--peer_ip| filter peer IP | – -|--peer_cidr| filter peer CIDR | – -|--port_range| filter port range | – -|--port| filter port | – -|--ports| filter on either of two ports | – -|--protocol| filter protocol | – -|--query| filter flows by using a custom query | – -|--sport_range| filter source port range | – -|--sport| filter source port | – -|--sports| filter on either of two source ports | – -|--tcp_flags| filter TCP flags | – -|--interfaces| list of interfaces to monitor, comma separated | – -|--exclude_interfaces| list of interfaces to exclude, comma separated | lo +|--enable_all| enable all eBPF features | false +|--enable_dns| enable DNS tracking | false +|--enable_ipsec| enable IPsec tracking | false +|--enable_network_events| enable network events monitoring | false +|--enable_pkt_translation| enable packet translation | false +|--enable_pkt_drop| enable packet drop | false +|--enable_rtt| enable RTT tracking | false +|--enable_udn_mapping| enable User Defined Network mapping | false +|--get-subnets| get subnets information | false +|--sampling| packets sampling interval | 1 +|--background| run in background | false +|--copy| copy the output files locally | prompt +|--log-level| components logs | info +|--max-time| maximum capture time | 5m +|--max-bytes| maximum capture bytes | 50000000 = 50MB +|--action| filter action | Accept +|--cidr| filter CIDR | 0.0.0.0/0 +|--direction| filter direction | - +|--dport| filter destination port | - +|--dport_range| filter destination port range | - +|--dports| filter on either of two destination ports | - +|--drops| filter flows with only dropped packets | false +|--icmp_code| filter ICMP code | - +|--icmp_type| filter ICMP type | - +|--node-selector| capture on specific nodes | - +|--peer_ip| filter peer IP | - +|--peer_cidr| filter peer CIDR | - +|--port_range| filter port range | - +|--port| filter port | - +|--ports| filter on either of two ports | - +|--protocol| filter protocol | - +|--query| filter flows using a custom query | - +|--sport_range| filter source port range | - +|--sport| filter source port | - +|--sports| filter on either of two source ports | - +|--tcp_flags| filter TCP flags | - +|--interfaces| list of interfaces to monitor, comma separated | - +|--exclude_interfaces| list of interfaces to exclude, comma separated | lo |=== .Example running flows capture on TCP protocol and port 49051 with PacketDrop and RTT features enabled: @@ -113,32 +113,32 @@ $ oc netobserv packets [