| blob | d8e7cf7e2ee564c37f71863c8dfb773a98c3e0e5 |
1 '\" te
2 .\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH IPMPSTAT 8 "April 9, 2016"
7 .SH NAME
8 ipmpstat \- display IPMP subsystem status
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBipmpstat\fR [\fB-n\fR] [\fB-o\fR \fIfield\fR[,...] [\fB-P\fR]] \fB-a\fR|\fB-g\fR|\fB-i\fR|\fB-p\fR|\fB-t\fR
13 .fi
15 .SH DESCRIPTION
16 .LP
17 The \fBipmpstat\fR command concisely displays information about the IPMP
18 subsystem. It supports five different output modes, each of which provides a
19 different view of the IPMP subsystem (address, group, interface, probe, and
20 target), described below. At most one output mode may be specified per
21 invocation, and the displayed information is guaranteed to be self-consistent.
22 It also provides a parsable output format which may be used by scripts to
23 examine the state of the IPMP subsystem. Only basic privileges are needed to
24 invoke \fBipmpstat\fR, with the exception of probe mode which requires all
25 privileges.
26 .SH OPTIONS
27 .LP
28 The following options are supported:
29 .sp
30 .ne 2
31 .na
32 \fB\fB-a\fR\fR
33 .ad
34 .sp .6
35 .RS 4n
36 Display IPMP data address information ("address" output mode).
37 .RE
39 .sp
40 .ne 2
41 .na
42 \fB\fB-g\fR\fR
43 .ad
44 .sp .6
45 .RS 4n
46 Display IPMP group information ("group" output mode).
47 .RE
49 .sp
50 .ne 2
51 .na
52 \fB\fB-i\fR\fR
53 .ad
54 .sp .6
55 .RS 4n
56 Display IP interface information ("interface" output mode).
57 .RE
59 .sp
60 .ne 2
61 .na
62 \fB\fB-n\fR\fR
63 .ad
64 .sp .6
65 .RS 4n
66 Display IP addresses numerically, rather than attempting to resolve them to
67 hostnames. This option may be used in any output mode.
68 .RE
70 .sp
71 .ne 2
72 .na
73 \fB\fB-o\fR \fIfield\fR[,...]\fR
74 .ad
75 .sp .6
76 .RS 4n
77 Display only the specified output fields, in order. The list of field names is
78 case-insensitive and comma-separated. The field names that are supported depend
79 on the selected output mode, described below. The special field name \fBall\fR
80 may be used to display all fields for a given output mode.
81 .RE
83 .sp
84 .ne 2
85 .na
86 \fB\fB-p\fR\fR
87 .ad
88 .sp .6
89 .RS 4n
90 Display IPMP probe information ("probe" output mode).
91 .RE
93 .sp
94 .ne 2
95 .na
96 \fB\fB-t\fR\fR
97 .ad
98 .sp .6
99 .RS 4n
100 Display IPMP target information ("target" output mode).
101 .RE
103 .sp
104 .ne 2
105 .na
106 \fB\fB-P\fR\fR
107 .ad
108 .sp .6
109 .RS 4n
110 Display using a machine-parsable format, described below. If this option is
111 specified, an explicit list of fields must be specified using the \fB-o\fR
112 option.
113 .RE
115 .SH OUTPUT MODES
116 .LP
117 The \fBipmpstat\fR utility supports the output modes listed below. Note that
118 these modes map to some of the options described above.
119 .sp
120 .ne 2
121 .na
122 \fBAddress Mode\fR
123 .ad
124 .sp .6
125 .RS 4n
126 Address mode displays the state of all IPMP data addresses on the system. The
127 following output fields are supported:
128 .sp
129 .ne 2
130 .na
131 \fB\fBADDRESS\fR\fR
132 .ad
133 .sp .6
134 .RS 4n
135 The hostname (or IP address) associated with the information. Note that because
136 duplicate down addresses may exist, the address must be taken together with the
137 \fBGROUP\fR to form a unique identity. For a given IPMP group, if duplicate
138 addresses exist, at most one will be displayed, and an up address will always
139 take precedence.
140 .RE
142 .sp
143 .ne 2
144 .na
145 \fB\fBSTATE\fR\fR
146 .ad
147 .sp .6
148 .RS 4n
149 The state of the address. Either \fBup\fR if the address is \fBIFF_UP\fR (see
150 \fBifconfig\fR(8)), or \fBdown\fR if the address is not \fBIFF_UP\fR.
151 .RE
153 .sp
154 .ne 2
155 .na
156 \fB\fBGROUP\fR\fR
157 .ad
158 .sp .6
159 .RS 4n
160 The IPMP IP interface hosting the address.
161 .RE
163 .sp
164 .ne 2
165 .na
166 \fB\fBINBOUND\fR\fR
167 .ad
168 .sp .6
169 .RS 4n
170 The underlying IP interface that will receive packets for this address. This
171 may change in response to external events such as IP interface failure. If this
172 field is empty, then the system will not accept IP packets sent to this address
173 (for example, because the address is down or because there are no active IP
174 interfaces left in the IPMP group).
175 .RE
177 .sp
178 .ne 2
179 .na
180 \fB\fBOUTBOUND\fR\fR
181 .ad
182 .sp .6
183 .RS 4n
184 The underlying IP interfaces that will send packets using this source address.
185 This may change in response to external events such as IP interface failure. If
186 this field is empty, then the system will not send packets with this address as
187 a source (for example, because the address is down or because there are no
188 active IP interfaces left in the IPMP group).
189 .RE
191 If \fB-o\fR is not specified, all output fields are displayed.
192 .RE
194 .sp
195 .ne 2
196 .na
197 \fBGroup Mode\fR
198 .ad
199 .sp .6
200 .RS 4n
201 Group mode displays the state of all IPMP groups on the system. The following
202 output fields are supported:
203 .sp
204 .ne 2
205 .na
206 \fB\fBGROUP\fR\fR
207 .ad
208 .sp .6
209 .RS 4n
210 The IPMP IP interface name associated with the information. For the anonymous
211 group (see \fBin.mpathd\fR(8)), this field will be empty.
212 .RE
214 .sp
215 .ne 2
216 .na
217 \fB\fBGROUPNAME\fR\fR
218 .ad
219 .sp .6
220 .RS 4n
221 The IPMP group name. For the anonymous group, this field will be empty.
222 .RE
224 .sp
225 .ne 2
226 .na
227 \fB\fBSTATE\fR\fR
228 .ad
229 .sp .6
230 .RS 4n
231 The state of the group:
232 .sp
233 .ne 2
234 .na
235 \fB\fBok\fR\fR
236 .ad
237 .RS 12n
238 All interfaces in the group are usable.
239 .RE
241 .sp
242 .ne 2
243 .na
244 \fB\fBdegraded\fR\fR
245 .ad
246 .RS 12n
247 Some (but not all) interfaces in the group are usable.
248 .RE
250 .sp
251 .ne 2
252 .na
253 \fB\fBfailed\fR\fR
254 .ad
255 .RS 12n
256 No interfaces in the group are usable.
257 .RE
259 .RE
261 .sp
262 .ne 2
263 .na
264 \fB\fBFDT\fR\fR
265 .ad
266 .sp .6
267 .RS 4n
268 The probe-based failure detection time. If probe-based failure detection is
269 disabled, this field will be empty.
270 .RE
272 .sp
273 .ne 2
274 .na
275 \fB\fBINTERFACES\fR\fR
276 .ad
277 .sp .6
278 .RS 4n
279 The list of underlying IP interfaces in the group. The list is divided into
280 three parts:
281 .RS +4
282 .TP
283 1.
284 Active interfaces are listed first and not enclosed in any brackets or
285 parenthesis. Active interfaces are those being used by the system to send or
286 receive data traffic.
287 .RE
288 .RS +4
289 .TP
290 2.
291 \fBINACTIVE\fR interfaces are listed next and enclosed in parenthesis.
292 \fBINACTIVE\fR interfaces are those that are functioning, but not being used
293 according to administrative policy.
294 .RE
295 .RS +4
296 .TP
297 3.
298 Unusable interfaces are listed last and enclosed in brackets. Unusable
299 interfaces are those that cannot be used at all in their present configuration
300 (for example, \fBFAILED\fR or \fBOFFLINE\fR).
301 .RE
302 .RE
304 If \fB-o\fR is not specified, all output fields are displayed.
305 .RE
307 .sp
308 .ne 2
309 .na
310 \fBInterface Mode\fR
311 .ad
312 .sp .6
313 .RS 4n
314 Interface mode displays the state of all IP interfaces that are tracked by
315 \fBin.mpathd\fR on the system. The following output fields are supported:
316 .sp
317 .ne 2
318 .na
319 \fB\fBINTERFACE\fR\fR
320 .ad
321 .sp .6
322 .RS 4n
323 The IP interface name associated with the information.
324 .RE
326 .sp
327 .ne 2
328 .na
329 \fB\fBACTIVE\fR\fR
330 .ad
331 .sp .6
332 .RS 4n
333 Either \fByes\fR or \fBno\fR, depending on whether the IP interface is being
334 used by the system for IP data traffic.
335 .RE
337 .sp
338 .ne 2
339 .na
340 \fB\fBGROUP\fR\fR
341 .ad
342 .sp .6
343 .RS 4n
344 The IPMP IP interface associated with the IP interface. For IP interfaces in
345 the anonymous group (see \fBin.mpathd\fR(8)), this field will be empty.
346 .RE
348 .sp
349 .ne 2
350 .na
351 \fB\fBFLAGS\fR\fR
352 .ad
353 .sp .6
354 .RS 4n
355 Assorted information about the IP interface:
356 .sp
357 .ne 2
358 .na
359 \fB\fBi\fR\fR
360 .ad
361 .RS 5n
362 Unusable due to being \fBINACTIVE\fR.
363 .RE
365 .sp
366 .ne 2
367 .na
368 \fB\fBs\fR\fR
369 .ad
370 .RS 5n
371 Marked \fBSTANDBY\fR.
372 .RE
374 .sp
375 .ne 2
376 .na
377 \fB\fBm\fR\fR
378 .ad
379 .RS 5n
380 Nominated to send/receive IPv4 multicast for its IPMP group.
381 .RE
383 .sp
384 .ne 2
385 .na
386 \fB\fBb\fR\fR
387 .ad
388 .RS 5n
389 Nominated to send/receive IPv4 broadcast for its IPMP group.
390 .RE
392 .sp
393 .ne 2
394 .na
395 \fB\fBM\fR\fR
396 .ad
397 .RS 5n
398 Nominated to send/receive IPv6 multicast for its IPMP group.
399 .RE
401 .sp
402 .ne 2
403 .na
404 \fB\fBd\fR\fR
405 .ad
406 .RS 5n
407 Unusable due to being \fBdown\fR.
408 .RE
410 .sp
411 .ne 2
412 .na
413 \fB\fBh\fR\fR
414 .ad
415 .RS 5n
416 Unusable due to being brought \fBOFFLINE\fR by \fBin.mpathd\fR because of a
417 duplicate hardware address.
418 .RE
420 .RE
422 .sp
423 .ne 2
424 .na
425 \fB\fBLINK\fR\fR
426 .ad
427 .sp .6
428 .RS 4n
429 The state of link-based failure detection:
430 .sp
431 .ne 2
432 .na
433 \fB\fBup\fR\fR
434 .ad
435 .sp .6
436 .RS 4n
437 The link is up.
438 .RE
440 .sp
441 .ne 2
442 .na
443 \fB\fBdown\fR\fR
444 .ad
445 .sp .6
446 .RS 4n
447 The link is down.
448 .RE
450 .sp
451 .ne 2
452 .na
453 \fB\fBunknown\fR\fR
454 .ad
455 .sp .6
456 .RS 4n
457 The network driver does not report link state changes.
458 .RE
460 .RE
462 .sp
463 .ne 2
464 .na
465 \fB\fBPROBE\fR\fR
466 .ad
467 .sp .6
468 .RS 4n
469 The state of probe-based failure detection:
470 .sp
471 .ne 2
472 .na
473 \fB\fBok\fR\fR
474 .ad
475 .sp .6
476 .RS 4n
477 Probes detect no problems.
478 .RE
480 .sp
481 .ne 2
482 .na
483 \fB\fBfailed\fR\fR
484 .ad
485 .sp .6
486 .RS 4n
487 Probes detect failure.
488 .RE
490 .sp
491 .ne 2
492 .na
493 \fB\fBunknown\fR\fR
494 .ad
495 .sp .6
496 .RS 4n
497 Probes cannot be sent since no suitable probe targets are known.
498 .RE
500 .sp
501 .ne 2
502 .na
503 \fB\fBdisabled\fR\fR
504 .ad
505 .sp .6
506 .RS 4n
507 Probes have been disabled because a unique IP test address has not been
508 configured.
509 .RE
511 .RE
513 .sp
514 .ne 2
515 .na
516 \fB\fBSTATE\fR\fR
517 .ad
518 .sp .6
519 .RS 4n
520 The overall state of the interface:
521 .sp
522 .ne 2
523 .na
524 \fB\fBok\fR\fR
525 .ad
526 .sp .6
527 .RS 4n
528 The interface is online and functioning properly based on the configured
529 failure detection methods.
530 .RE
532 .sp
533 .ne 2
534 .na
535 \fB\fBfailed\fR\fR
536 .ad
537 .sp .6
538 .RS 4n
539 The interface is online but has a link state of \fBdown\fR or a probe state of
540 \fBfailed\fR.
541 .RE
543 .sp
544 .ne 2
545 .na
546 \fB\fBoffline\fR\fR
547 .ad
548 .sp .6
549 .RS 4n
550 The interface is offline.
551 .RE
553 .sp
554 .ne 2
555 .na
556 \fB\fBunknown\fR\fR
557 .ad
558 .sp .6
559 .RS 4n
560 The interface is online but may or may not be functioning because the
561 configured failure detection methods are in \fBunknown\fR states.
562 .RE
564 .RE
566 If \fB-o\fR is not specified, all output fields are displayed.
567 .RE
569 .sp
570 .ne 2
571 .na
572 \fBProbe Mode\fR
573 .ad
574 .sp .6
575 .RS 4n
576 Probe mode displays information about the probes being sent by \fBin.mpathd\fR.
577 Unlike other output modes, this mode runs until explicitly terminated using
578 \fBCtrl-C\fR. The following output fields are supported:
579 .sp
580 .ne 2
581 .na
582 \fB\fBTIME\fR\fR
583 .ad
584 .sp .6
585 .RS 4n
586 The time the probe was sent, relative to when \fBipmpstat\fR was started. If
587 the probe was sent prior to starting \fBipmpstat\fR, the time will be negative.
588 .RE
590 .sp
591 .ne 2
592 .na
593 \fB\fBPROBE\fR\fR
594 .ad
595 .sp .6
596 .RS 4n
597 An identifier representing the probe. The identifier will start at zero and
598 will monotonically increment for each probe sent by \fBin.mpathd\fR over a
599 given interface. To enable more detailed analysis by packet monitoring tools,
600 this identifier matches the \fBicmp_seq\fR field of the ICMP probe packet.
601 .RE
603 .sp
604 .ne 2
605 .na
606 \fB\fBINTERFACE\fR\fR
607 .ad
608 .sp .6
609 .RS 4n
610 The IP interface the probe was sent on.
611 .RE
613 .sp
614 .ne 2
615 .na
616 \fB\fBTARGET\fR\fR
617 .ad
618 .sp .6
619 .RS 4n
620 The hostname (or IP address) of the target the probe was sent to.
621 .RE
623 .sp
624 .ne 2
625 .na
626 \fB\fBNETRTT\fR\fR
627 .ad
628 .sp .6
629 .RS 4n
630 The network round-trip-time for the probe. This is the time between when the IP
631 module sends the probe and when the IP module receives the acknowledgment. If
632 \fBin.mpathd\fR has concluded that the probe has been lost, this field will be
633 empty.
634 .RE
636 .sp
637 .ne 2
638 .na
639 \fB\fBRTT\fR\fR
640 .ad
641 .sp .6
642 .RS 4n
643 The total round-trip-time for the probe. This is the time between when
644 \fBin.mpathd\fR starts executing the code to send the probe, and when it
645 completes processing the \fBack\fR. If \fBin.mpathd\fR has concluded that the
646 probe has been lost, this field will be empty. Spikes in the total round-trip
647 time that are not present in the network round-trip time indicate that the
648 local system itself is overloaded.
649 .RE
651 .sp
652 .ne 2
653 .na
654 \fB\fBRTTAVG\fR\fR
655 .ad
656 .sp .6
657 .RS 4n
658 The average round-trip-time to \fBTARGET\fR over \fBINTERFACE\fR. This aids
659 identification of slow targets. If there is insufficient data to calculate the
660 average, this field will be empty.
661 .RE
663 .sp
664 .ne 2
665 .na
666 \fB\fBRTTDEV\fR\fR
667 .ad
668 .sp .6
669 .RS 4n
670 The standard deviation for the round-trip-time to \fBTARGET\fR over
671 \fBINTERFACE\fR. This aids identification of jittery targets. If there is
672 insufficient data to calculate the standard deviation, this field will be
673 empty.
674 .RE
676 If \fB-o\fR is not specified, all fields except for \fBRTTAVG\fR and
677 \fBRTTDEV\fR are displayed.
678 .RE
680 .sp
681 .ne 2
682 .na
683 \fBTarget Mode\fR
684 .ad
685 .sp .6
686 .RS 4n
687 Target mode displays IPMP probe target information. The following output fields
688 are supported:
689 .sp
690 .ne 2
691 .na
692 \fB\fBINTERFACE\fR\fR
693 .ad
694 .sp .6
695 .RS 4n
696 The IP interface name associated with the information.
697 .RE
699 .sp
700 .ne 2
701 .na
702 \fB\fBMODE\fR\fR
703 .ad
704 .sp .6
705 .RS 4n
706 The probe target discovery mode:
707 .sp
708 .ne 2
709 .na
710 \fB\fBroutes\fR\fR
711 .ad
712 .RS 13n
713 Probe targets found by means of the routing table.
714 .RE
716 .sp
717 .ne 2
718 .na
719 \fB\fBmulticast\fR\fR
720 .ad
721 .RS 13n
722 Probe targets found by means of multicast ICMP probes.
723 .RE
725 .sp
726 .ne 2
727 .na
728 \fB\fBdisabled\fR\fR
729 .ad
730 .RS 13n
731 Probe-based failure detection is disabled.
732 .RE
734 .RE
736 .sp
737 .ne 2
738 .na
739 \fB\fBTESTADDR\fR\fR
740 .ad
741 .sp .6
742 .RS 4n
743 The hostname (or IP address) that will be used for sending and receiving
744 probes. If a unique test address has not been configured, this field will be
745 empty. Note that if an IP interface is configured with both IPv4 and IPv6 test
746 addresses, probe target information will be displayed separately for each test
747 address.
748 .RE
750 .sp
751 .ne 2
752 .na
753 \fB\fBTARGETS\fR\fR
754 .ad
755 .sp .6
756 .RS 4n
757 A space-separated list of probe target hostnames (or IP addresses), in firing
758 order. If no probe targets could be found, this field will be empty.
759 .RE
761 If \fB-o\fR is not specified, all output fields are displayed.
762 .RE
764 .SH OUTPUT FORMAT
765 .LP
766 By default, \fBipmpstat\fR uses a human-friendly tabular format for its output
767 modes, where each row contains one or more fields of information about a given
768 object, which is in turn uniquely identified by one or more of those fields. In
769 this format, a header identifying the fields is displayed above the table (and
770 after each screenful of information), fields are separated by whitespace, empty
771 fields are represented by \fB--\fR (double hyphens), and other visual aids are
772 used. If the value for a field cannot be determined, its value will be
773 displayed as "\fB?\fR" and a diagnostic message will be output to standard
774 error.
775 .sp
776 .LP
777 Machine-parsable format also uses a tabular format, but is designed to be
778 efficient to programmatically parse. Specifically, machine-parsable format
779 differs from human-friendly format in the following ways:
780 .RS +4
781 .TP
782 .ie t \(bu
783 .el o
784 No headers are displayed.
785 .RE
786 .RS +4
787 .TP
788 .ie t \(bu
789 .el o
790 Fields with empty values yield no output, rather than showing \fB--\fR.
791 .RE
792 .RS +4
793 .TP
794 .ie t \(bu
795 .el o
796 Fields are separated by a single colon (\fB:\fR), rather than variable amounts
797 of whitespace.
798 .RE
799 .RS +4
800 .TP
801 .ie t \(bu
802 .el o
803 If multiple fields are requested, and a literal \fB:\fR or a backslash
804 (\fB\e\fR) occur in a field's value, they are escaped by prefixing them with
805 \fB\e\fR\&.
806 .RE
807 .SH EXAMPLES
808 .LP
809 \fBExample 1 \fRObtaining Failure Detection Time of a Specific Interface
810 .sp
811 .LP
812 The following code uses the machine-parsable output format to create a
813 \fBksh\fR function that outputs the failure detection time of a given IPMP IP
814 interface:
816 .sp
817 .in +2
818 .nf
819 getfdt() {
820 ipmpstat -gP -o group,fdt | while IFS=: read group fdt; do
821 [[ "$group" = "$1" ]] && { echo "$fdt"; return; }
822 done
823 }
824 .fi
825 .in -2
826 .sp
828 .SH ATTRIBUTES
829 .LP
830 See \fBattributes\fR(5) for descriptions of the following attributes:
831 .sp
832 .LP
833 \fB/usr/sbin/ipmpstat\fR:
834 .sp
836 .sp
837 .TS
838 box;
839 c | c
840 l | l .
841 ATTRIBUTE TYPE ATTRIBUTE VALUE
842 _
843 Interface Stability Committed
844 _
845 Machine-Parsable Format Committed
846 _
847 Human-Friendly Format Not-an-Interface
848 .TE
850 .sp
851 .LP
852 \fB/sbin/ipmpstat\fR is not a Committed interface.
853 .SH SEE ALSO
854 .LP
855 \fBif_mpadm\fR(8), \fBifconfig\fR(8), \fBin.mpathd\fR(8),
856 \fBattributes\fR(5)