1OPING(8) liboping OPING(8)
2
3
4
6 oping - send ICMP ECHO_REQUEST to network hosts
7
9 oping [-4 | -6] [-c count] [-i interval] host [host [host ...]]
10
11 oping [-4 | -6] [-c count] [-i interval] -f filename
12
13 noping [-4 | -6] [-c count] [-i interval] host [host [host ...]]
14
15 noping [-4 | -6] [-c count] [-i interval] -f filename
16
18 oping uses ICMPv4 or ICMPv6 ECHO_REQUEST packets to measure a hosts
19 reachability and the network latency. In contrast to the original
20 ping(8) utility oping can send ICMP packets to multiple hosts in
21 parallel and wait for all ECHO_RESPONSE packets to arrive. In contrast
22 to the fping utility (URL is listed in "SEE ALSO") oping can use both,
23 IPv4 and IPv6 transparently and side by side.
24
25 noping is an ncurses-based front-end to liboping which displays ping
26 statistics online and highlights aberrant round-trip times if the
27 terminal supports colors.
28
30 -4 Force the use of IPv4.
31
32 -6 Force the use of IPv6.
33
34 -c count
35 Send (and receive) count ICMP packets, then stop and exit.
36
37 -i interval
38 Send one ICMP packet (per host) each interval seconds. This can be
39 a floating-point number to specify sub-second precision.
40
41 -w timeout
42 Specifies the time to wait for an "ECHO REPLY" packet before giving
43 up, in seconds. This can be a floating point number for sub-second
44 precision. Defaults to 1.0 seconds.
45
46 -t ttl
47 Set the IP Time to Live to ttl. This must be a number between (and
48 including) 1 and 255. If omitted, the value 64 is used.
49
50 -I address
51 Set the source address to use. You may either specify an IP number
52 or a hostname. You cannot pass the interface name, as you can with
53 GNU's ping(8) - use the -D option for that purpose.
54
55 -D interface name
56 Set the outgoing network device to use.
57
58 -f filename
59 Instead of specifying hostnames on the command line, read them from
60 filename. If filename is -, read from "STDIN".
61
62 If oping is installed with the SetUID-bit, it will set the
63 effective UID to the real UID before opening the file. In the
64 special (but common) case that oping is owned by the super-user
65 (UID 0), this means that privileges are temporarily dropped before
66 opening the file, in order to prevent users from reading arbitrary
67 files on the system.
68
69 If your system doesn't provide saved set-user IDs (this was an
70 optional feature before POSIX 2001), the behavior is different
71 because it is not possible to temporarily drop privileges. The
72 alternative behavior is: If the real user ID (as returned by
73 getuid(2)) and the effective user ID (as returned by geteuid(2))
74 differ, the only argument allowed for this option is "-" (i.e.
75 standard input).
76
77 -O filename
78 Write measurements in Comma Separated Values (CSV) format to
79 filename. This option writes three columns per row: wall clock
80 time in (fractional) seconds since epoch, hostname and the round
81 trip time in milliseconds.
82
83 -Q qos
84 Specify the Quality of Service (QoS) for outgoing packets. This is
85 a somewhat tricky option, since the meaning of the bits in the IPv4
86 header has been revised several times.
87
88 The currently recommended method is Differentiated Services which
89 is used in IPv6 headers as well. There are shortcuts for various
90 predefined per-hop behaviors (PHBs):
91
92 be Selects the Best Effort behavior. This is the default behavior.
93
94 ef Selects the Expedited Forwarding (EF) per-hop behavior, as
95 defined in RFC 3246. This PHB is characterised by low delay,
96 low loss and low jitter, i.e. high priority traffic.
97
98 va Selects the Voice Admitted (VA) per-hop behavior, as defined in
99 RFC 5865. This traffic class is meant for Voice over IP (VoIP)
100 traffic which uses Call Admission Control (CAC) for reserving
101 network capacity.
102
103 afcp
104 Selects one of 12 differentiated services code points (DSCPs),
105 which are organized in four classes with three priorities each.
106 Therefore, c must be a number between 1 through 4 and p must be
107 a number between 1 through 3, for example "af13", "af22" and
108 "af41". In each class, the lower priority number takes
109 precedence over the higher priority number.
110
111 csn Selects one of the eight Class Selector PHBs. n is a number
112 between 0 through 7. The class selectors have been defined to
113 be compatible to the Precedence field in the IPv4 header as
114 defined in RFC 791. Please note that "cs0" is synonymous to
115 "be".
116
117 The old definition of the same bits in the IPv4 header was as Type
118 of Service (ToS) field, specified in RFC 1349. It defined four
119 possible values which have appropriate aliases. Please note that
120 this use of the bits is deprecated and the meaning is limited to
121 IPv4!
122
123 lowdelay
124 Minimize delay
125
126 throughput
127 Maximize throughput
128
129 reliability
130 Maximize reliability
131
132 mincost
133 Minimize monetary cost
134
135 Alternatively, you can also specify the byte manually. You can use
136 either a decimal number (0-255), a hexadecimal number (0x00-0xff)
137 or an octal number (00-0377) using the usual "0x" and "0" prefixes
138 for hexadecimal and octal respectively.
139
140 The printed lines will contain information about the QoS field of
141 received packets if either a non-standard QoS setting was used on
142 outgoing packets or if the QoS byte of incoming packets is not
143 zero. In other words, the QoS information is omitted if both, the
144 outgoing and the incoming QoS bytes are zero. The received byte is
145 always interpreted as Differentiated Services Code Point (DSCP) and
146 Explicit Congestion Notification (ECN), even if the deprecated Type
147 of Service (ToS) aliases were used to specify the bits of outgoing
148 packets.
149
150 -m mark
151 Linux only Sets the mark (an integer number) on outgoing packets.
152 This can be used by iptables(8) and other networking infrastructure
153 for filtering and routing.
154
155 -u|-U
156 noping only -u forces UTF-8 output, -U disables UTF-8 output. If
157 neither is given, the codeset is automatically determined from the
158 locale.
159
160 -g none|prettyping|boxplot|histogram
161 noping only Selects the graph to display.
162
163 none
164 Do not show a graph.
165
166 prettyping
167 Show a graph with time on the x-axis, the y-axis shows the
168 round-trip time. This is the default graph.
169
170 If your terminal supports unicode and colors, they are used to
171 improve the precision of the data shown: a green box is drawn
172 for round-trip times up to one third of the configured timeout,
173 the height representing the RTT. Longer RTTs will start to fill
174 the box yellow (with a green background) and then red (with a
175 yellow background). Lost packages are drawn as a bold red
176 explamation mark.
177
178 boxplot
179 Show a box plot where the x-axis, i.e. the width of the window,
180 is the round-trip time. The entire width of the window it the
181 ping interval, set with the -i option.
182
183 The box is sized so it contains 50% of the replies. The
184 vertical line shows the median. The whiskers are sized to
185 contain 95% of the replies -- 2.5% below the whiskers and 2.5%
186 above.
187
188 |----------[#####|##########]--------------------------------------------|
189 ^ ^ ^ ^ ^
190 2.5% 25% 50% 75% 97.5%
191
192 histogram
193 Show a histrogram of the round-trip times. The width of the
194 window is taken as round-trip time from 0ms on the left to the
195 interval (the -i option, default 1000ms) on the right.
196
197 The height of the graph is scaled so that the most-used buckets
198 vertically fills the line. The buckets are colored green up to
199 and including the 80th percentile, yellow up to and including
200 the 95th percentile and red for the remainder.
201
202 -b Audible bell. Print a ASCII BEL character (\a or 0x07) when a
203 packet is received before the timeout occurs. This can be useful in
204 order to monitory hosts' connectivity without looking physically at
205 the console, for example to trace network cables (start audible
206 beep, disconnect cable N: if beep stops, the cable was in use) or
207 to tell when a host returns from a reboot.
208
209 This relies on the terminal bell to be functional. To enable the
210 terminal bell, use the following instructions.
211
212 · the visual bell is disabled in your terminal emulator, with the
213 +vb commandline flag or the following in your .Xresources:
214
215 XTerm*visualBell: false
216
217 · the PC speaker module is loaded in your kernel:
218
219 modprobe pcspkr
220
221 · X11 has the terminal bell enabled:
222
223 xset b on; xset b 100
224
225 · and finally, if you are using PulseAudio, that the
226 module-x11-bell module is loaded with a pre-loaded sample
227 defined in your pulseaudio configuration:
228
229 load-sample-lazy x11-bell /usr/share/sounds/freedesktop/stereo/complete.oga
230 load-module module-x11-bell sample=x11-bell
231
232 -P percent
233 Configures the latency percentile to report. percent must be a
234 number between zero and 100, exclusively in both cases. In general,
235 defaults to 95. If -c is given and a number less than 20, this
236 would be the same as the maximum. In this case the default is
237 chosen so that it excludes the maximum, e.g. if -c 5 is given, the
238 default is 80. The calculated percentile is based on the last 900
239 packets (15 minutes with the default interval).
240
241 -Z percent
242 If any hosts have a drop rate higher than percent, where percent is
243 a number between zero and 100 inclusively, exit with a non-zero
244 exit status. Since it is not possible to have a higher drop rate
245 than 100%, passing this limit will effectively disable the feature
246 (the default). Setting the option to zero means that the exit
247 status will only be zero if all replies for all hosts have been
248 received.
249
250 The exit status will indicate the number of hosts with more than
251 percent packets lost, up to a number of 255 failing hosts.
252
254 If supported by the terminal, noping will highlight the round-trip
255 times (RTT) using the colors green, yellow and red. Green signals RTTs
256 that are in the "expected" range, yellow marks moderately unusual times
257 and times that differ a lot from the expected value are printed in red.
258
259 The information used to categorize round-trip times is the percentile.
260 RTTs in the 80th percentile are considered to be "normal" and are
261 printed in green. RTTs within the 95th percentile are considered
262 "moderately unusual" and are printed in yellow. RTTs above that are
263 considered to be "unusual" and are printed in red.
264
266 When running noping, the type of graph being displayed can be changed
267 by using the g key. A new host can be added at any time with the a
268 key.
269
271 ping(8), <http://fping.org/>, liboping(3)
272
274 oping and noping are licensed under the GPL 2. No other version of the
275 license is applicable.
276
278 liboping is written by Florian "octo" Forster <ff at octo.it>. Its
279 homepage can be found at <http://noping.cc/>.
280
281 Copyright (c) 2006-2017 by Florian "octo" Forster.
282
283
284
2851.10.0 2017-05-11 OPING(8)