diff --git a/commands/netobserv b/commands/netobserv index 70250e18..dcdb9bfc 100755 --- a/commands/netobserv +++ b/commands/netobserv @@ -71,13 +71,13 @@ case "$1" in echo echo "Syntax: netobserv [flows|packets|cleanup] [options]" echo - echo "options:" + echo "commands:" echo " flows Capture flows information. You can specify an optional interface name as filter such as 'netobserv flows br-ex'." echo " Options:" flows_usage echo " packets Capture packets information in pcap format." - packets_usage echo " Options:" + packets_usage echo " cleanup Remove netobserv components." echo " version Print software version." echo diff --git a/docs/netobserv_cli.adoc b/docs/netobserv_cli.adoc index 36a4fc67..95a314b2 100644 --- a/docs/netobserv_cli.adoc +++ b/docs/netobserv_cli.adoc @@ -22,7 +22,7 @@ $ oc netobserv [] [] [] <1> | flows | Capture flows information. For subcommands, see the "Flow capture subcommands" table. | packets -| Capture packets from a specific protocol or port pair, such as netobserv packets --filter=tcp,80. For more information about packet capture, see the "Packet capture subcommand" table. +| Capture packets data. For subcommands, see the "Packet capture subcommand" table. | cleanup | Remove the Network Observability CLI components. | version @@ -41,32 +41,33 @@ $ oc netobserv flows [] [] [cols="1,1,1",options="header"] |=== | Option | Description | Default -|--enable_pktdrop| enable packet drop | false -|--enable_dns| enable DNS tracking | false -|--enable_rtt| enable RTT tracking | false -|--enable_filter| enable flow filter | false -|--log-level| components logs | info -|--max-time| maximum capture time | 5m -|--max-bytes| maximum capture bytes | 50000000 = 50MB -|--copy| copy the output files locally | prompt -|--direction| flow filter direction | n/a -|--cidr| flow filter CIDR | 0.0.0.0/0 -|--protocol| flow filter protocol | n/a -|--sport| flow filter source port | n/a -|--dport| flow filter destination port | n/a -|--port| flow filter port | n/a -|--sport_range| flow filter source port range | n/a -|--dport_range| flow filter destination port range | n/a -|--port_range| flow filter port range | n/a -|--tcp_flags| flow filter TCP flags | n/a -|--icmp_type| ICMP type | n/a -|--icmp_code| ICMP code | n/a -|--peer_ip| peer IP | n/a -|--action| flow filter action | Accept -|--interfaces| interfaces to monitor | n/a +|--enable_pktdrop| enable packet drop | false +|--enable_dns| enable DNS tracking | false +|--enable_rtt| enable RTT tracking | false +|--enable_network_events| enable Network events monitoring | false +|--enable_filter| enable flow filter | false +|--log-level| components logs | info +|--max-time| maximum capture time | 5m +|--max-bytes| maximum capture bytes | 50000000 = 50MB +|--copy| copy the output files locally | prompt +|--direction| filter direction | n/a +|--cidr| filter CIDR | 0.0.0.0/0 +|--protocol| filter protocol | n/a +|--sport| filter source port | n/a +|--dport| filter destination port | n/a +|--port| filter port | n/a +|--sport_range| filter source port range | n/a +|--dport_range| filter destination port range | n/a +|--port_range| filter port range | n/a +|--tcp_flags| filter TCP flags | n/a +|--action| filter action | Accept +|--icmp_type| filter ICMP type | n/a +|--icmp_code| filter ICMP code | n/a +|--peer_ip| filter peer IP | n/a +|--interfaces| interfaces to monitor | n/a |=== -.Example running flow capture with options: +.Example running flow capture on TCP protocol and port 49051 with PacketDrop and RTT features enabled: [source,terminal] ---- $ oc netobserv flows --enable_pktdrop=true --enable_rtt=true --enable_filter=true --action=Accept --cidr=0.0.0.0/0 --protocol=TCP --port=49051 @@ -82,27 +83,27 @@ $ oc netobserv packets [