1ipmpstat(1M) System Administration Commands ipmpstat(1M)
2
6 ipmpstat - display IPMP subsystem status
7
9 ipmpstat [-n] [-o field[,...] [-P]] -a|-g|-i|-p|-t
10
13 The ipmpstat command concisely displays information about the IPMP sub‐
14 system. It supports five different output modes, each of which provides
15 a different view of the IPMP subsystem (address, group, interface,
16 probe, and target), described below. At most one output mode may be
17 specified per invocation, and the displayed information is guaranteed
18 to be self-consistent. It also provides a parseable output format which
19 may be used by scripts to examine the state of the IPMP subsystem. Only
20 basic privileges are needed to invoke ipmpstat, with the exception of
21 probe mode which requires all privileges.
22
24 The following options are supported:
25 -a
27 Display IPMP data address information ("address" output mode).
29 -g
32 Display IPMP group information ("group" output mode).
34 -i
37 Display IP interface information ("interface" output mode).
39 -n
42 Display IP addresses numerically, rather than attempting to resolve
44 them to hostnames. This option may be used in any output mode.
45 -o field[,...]
48 Display only the specified output fields, in order. The list of
50 field names is case-insensitive and comma-separated. The field
51 names that are supported depend on the selected output mode,
52 described below. The special field name all may be used to display
53 all fields for a given output mode.
54 -p
57 Display IPMP probe information ("probe" output mode).
59 -t
62 Display IPMP target information ("target" output mode).
64 -P
67 Display using a machine-parseable format, described below. If this
69 option is specified, an explicit list of fields must be specified
70 using the -o option.
71
74 The ipmpstat utility supports the output modes listed below. Note that
75 these modes map to some of the options described above.
76 Address Mode
78 Address mode displays the state of all IPMP data addresses on the
80 system. The following output fields are supported:
81 ADDRESS
83 The hostname (or IP address) associated with the information.
85 Note that because duplicate down addresses may exist, the
86 address must be taken together with the GROUP to form a unique
87 identity. For a given IPMP group, if duplicate addresses exist,
88 at most one will be displayed, and an up address will always
89 take precedence.
90 STATE
93 The state of the address. Either up if the address is IFF_UP
95 (see ifconfig(1M)), or down if the address is not IFF_UP.
96 GROUP
99 The IPMP IP interface hosting the address.
101 INBOUND
104 The underlying IP interface that will receive packets for this
106 address. This may change in response to external events such as
107 IP interface failure. If this field is empty, then the system
108 will not accept IP packets sent to this address (for example,
109 because the address is down or because there are no active IP
110 interfaces left in the IPMP group).
111 OUTBOUND
114 The underlying IP interfaces that will send packets using this
116 source address. This may change in response to external events
117 such as IP interface failure. If this field is empty, then the
118 system will not send packets with this address as a source (for
119 example, because the address is down or because there are no
120 active IP interfaces left in the IPMP group).
121 If -o is not specified, all output fields are displayed.
123 Group Mode
126 Group mode displays the state of all IPMP groups on the system. The
128 following output fields are supported:
129 GROUP
131 The IPMP IP interface name associated with the information. For
133 the anonymous group (see in.mpathd(1M)), this field will be
134 empty.
135 GROUPNAME
138 The IPMP group name. For the anonymous group, this field will
140 be empty.
141 STATE
144 The state of the group:
146 ok All interfaces in the group are usable.
148 degraded Some (but not all) interfaces in the group are
151 usable.
152 failed No interfaces in the group are usable.
155 FDT
159 The probe-based failure detection time. If probe-based failure
161 detection is disabled, this field will be empty.
162 INTERFACES
165 The list of underlying IP interfaces in the group. The list is
167 divided into three parts:
168 1. Active interfaces are listed first and not enclosed
170 in any brackets or parenthesis. Active interfaces
171 are those being used by the system to send or
172 receive data traffic.
173 2. INACTIVE interfaces are listed next and enclosed in
175 parenthesis. INACTIVE interfaces are those that are
176 functioning, but not being used according to admin‐
177 istrative policy.
178 3. Unusable interfaces are listed last and enclosed in
180 brackets. Unusable interfaces are those that cannot
181 be used at all in their present configuration (for
182 example, FAILED or OFFLINE).
183 If -o is not specified, all output fields are displayed.
185 Interface Mode
188 Interface mode displays the state of all IP interfaces that are
190 tracked by in.mpathd on the system. The following output fields are
191 supported:
192 INTERFACE
194 The IP interface name associated with the information.
196 ACTIVE
199 Either yes or no, depending on whether the IP interface is
201 being used by the system for IP data traffic.
202 GROUP
205 The IPMP IP interface associated with the IP interface. For IP
207 interfaces in the anonymous group (see in.mpathd(1M)), this
208 field will be empty.
209 FLAGS
212 Assorted information about the IP interface:
214 i Unusable due to being INACTIVE.
216 s Marked STANDBY.
219 m Nominated to send/receive IPv4 multicast for its IPMP
222 group.
223 b Nominated to send/receive IPv4 broadcast for its IPMP
226 group.
227 M Nominated to send/receive IPv6 multicast for its IPMP
230 group.
231 d Unusable due to being down.
234 h Unusable due to being brought OFFLINE by in.mpathd because
237 of a duplicate hardware address.
238 LINK
242 The state of link-based failure detection:
244 up
246 The link is up.
248 down
251 The link is down.
253 unknown
256 The network driver does not report link state changes.
258 PROBE
262 The state of probe-based failure detection:
264 ok
266 Probes detect no problems.
268 failed
271 Probes detect failure.
273 unknown
276 Probes cannot be sent since no suitable probe targets are
278 known.
279 disabled
282 Probes have been disabled because a unique IP test address
284 has not been configured.
285 STATE
289 The overall state of the interface:
291 ok
293 The interface is online and functioning properly based on
295 the configured failure detection methods.
296 failed
299 The interface is online but has a link state of down or a
301 probe state of failed.
302 offline
305 The interface is offline.
307 unknown
310 The interface is online but may or may not be functioning
312 because the configured failure detection methods are in
313 unknown states.
314 If -o is not specified, all output fields are displayed.
317 Probe Mode
320 Probe mode displays information about the probes being sent by
322 in.mpathd. Unlike other output modes, this mode runs until explic‐
323 itly terminated using Ctrl-C. The following output fields are sup‐
324 ported:
325 TIME
327 The time the probe was sent, relative to when ipmpstat was
329 started. If the probe was sent prior to starting ipmpstat, the
330 time will be negative.
331 PROBE
334 An identifier representing the probe. The identifier will start
336 at zero and will monotonically increment for each probe sent by
337 in.mpathd over a given interface. To enable more detailed anal‐
338 ysis by packet monitoring tools, this identifier matches the
339 icmp_seq field of the ICMP probe packet.
340 INTERFACE
343 The IP interface the probe was sent on.
345 TARGET
348 The hostname (or IP address) of the target the probe was sent
350 to.
351 NETRTT
354 The network round-trip-time for the probe. This is the time
356 between when the IP module sends the probe and when the IP mod‐
357 ule receives the acknowledgment. If in.mpathd has concluded
358 that the probe has been lost, this field will be empty.
359 RTT
362 The total round-trip-time for the probe. This is the time
364 between when in.mpathd starts executing the code to send the
365 probe, and when it completes processing the ack. If in.mpathd
366 has concluded that the probe has been lost, this field will be
367 empty. Spikes in the total round-trip time that are not present
368 in the network round-trip time indicate that the local system
369 itself is overloaded.
370 RTTAVG
373 The average round-trip-time to TARGET over INTERFACE. This aids
375 identification of slow targets. If there is insufficient data
376 to calculate the average, this field will be empty.
377 RTTDEV
380 The standard deviation for the round-trip-time to TARGET over
382 INTERFACE. This aids identification of jittery targets. If
383 there is insufficient data to calculate the standard deviation,
384 this field will be empty.
385 If -o is not specified, all fields except for RTTAVG and RTTDEV are
387 displayed.
388 Target Mode
391 Target mode displays IPMP probe target information. The following
393 output fields are supported:
394 INTERFACE
396 The IP interface name associated with the information.
398 MODE
401 The probe target discovery mode:
403 routes Probe targets found by means of the routing table.
405 multicast Probe targets found by means of multicast ICMP
408 probes.
409 disabled Probe-based failure detection is disabled.
412 TESTADDR
416 The hostname (or IP address) that will be used for sending and
418 receiving probes. If a unique test address has not been config‐
419 ured, this field will be empty. Note that if an IP interface is
420 configured with both IPv4 and IPv6 test addresses, probe target
421 information will be displayed separately for each test address.
422 TARGETS
425 A space-separated list of probe target hostnames (or IP
427 addresses), in firing order. If no probe targets could be
428 found, this field will be empty.
429 If -o is not specified, all output fields are displayed.
431
434 By default, ipmpstat uses a human-friendly tabular format for its out‐
435 put modes, where each row contains one or more fields of information
436 about a given object, which is in turn uniquely identified by one or
437 more of those fields. In this format, a header identifying the fields
438 is displayed above the table (and after each screenful of information),
439 fields are separated by whitespace, empty fields are represented by --
440 (double hyphens), and other visual aids are used. If the value for a
441 field cannot be determined, its value will be displayed as "?" and a
442 diagnostic message will be output to standard error.
443 Machine-parseable format also uses a tabular format, but is designed to
446 be efficient to programmatically parse. Specifically, machine-parseable
447 format differs from human-friendly format in the following ways:
448 o No headers are displayed.
450 o Fields with empty values yield no output, rather than show‐
452 ing --.
453 o Fields are separated by a single colon (:), rather than
455 variable amounts of whitespace.
456 o If multiple fields are requested, and a literal : or a back‐
458 slash (\) occur in a field's value, they are escaped by pre‐
459 fixing them with \.
460
462 Example 1 Obtaining Failure Detection Time of a Specific Interface
463 The following code uses the machine-parseable output format to create a
466 ksh function that outputs the failure detection time of a given IPMP IP
467 interface:
468 getfdt() {
471 ipmpstat -gP -o group,fdt | while IFS=: read group fdt; do
472 [[ "$group" = "$1" ]] && { echo "$fdt"; return; }
473 done
474 }
475
479 See attributes(5) for descriptions of the following attributes:
480 /usr/sbin/ipmpstat:
483 ┌─────────────────────────────┬─────────────────────────────┐
488 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
489 ├─────────────────────────────┼─────────────────────────────┤
490 │Availability │SUNWcsu │
491 ├─────────────────────────────┼─────────────────────────────┤
492 │Interface Stability │Committed │
493 ├─────────────────────────────┼─────────────────────────────┤
494 │Machine-Parseable Format │Committed │
495 ├─────────────────────────────┼─────────────────────────────┤
496 │Human-Friendly Format │Not-an-Interface │
497 └─────────────────────────────┴─────────────────────────────┘
498 /sbin/ipmpstat is not a Committed interface.
501
503 if_mpadm(1M), ifconfig(1M), in.mpathd(1M), attributes(5)
504SunOS 5.11 10 Feb 2009 ipmpstat(1M)