usr/src/man/man1m/if_mpadm.1m

   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 IF_MPADM 1M "Jan 5, 2009"
   7 .SH NAME
   8 if_mpadm \- administer interfaces in an IP multipathing group
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBif_mpadm\fR \fB-d\fR | \fB-r\fR \fIifname\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBif_mpadm\fR utility administers IP interfaces that are part of an IP
  19 Multipathing (IPMP) group. Currently, administration is limited to offlining IP
  20 interfaces and undoing previous offline operations.
  21 .sp
  22 .LP
  23 When an IP interface is taken offline, all IP data traffic that was flowing
  24 over the IP interface is moved to another IP interface in the IPMP group. In
  25 addition, all \fBUP\fR IP addresses hosted on the IP interface are brought
  26 down, causing \fBin.mpathd\fR(1M) to stop probe-based failure detection on the
  27 IP interface. As a result, an offline IP interface will not be used for any
  28 inbound or outbound IP traffic. Only IP interfaces that are in an IPMP group
  29 may be brought offline. If the IP interface is the last functioning interface
  30 in the IPMP group, the offline operation will fail.
  31 .sp
  32 .LP
  33 When an offline operation is undone, any IP addresses hosted on that IP
  34 interface are brought \fBUP\fR and will be considered by \fBin.mpathd\fR for
  35 probe-based failure detection. In addition, provided the IP interface is
  36 otherwise active (see \fBin.mpathd\fR(1M)), it will again be used to send and
  37 receive IP data traffic for the IPMP group. Note that not all offline
  38 operations can be undone. For instance, \fBin.mpathd\fR may have offlined an IP
  39 interface because its hardware address was not unique within its IPMP group.
  40 The \fBipmpstat\fR utility can be used to determine why an IP interface is
  41 offline, identify which IP interfaces in a group are being used for inbound and
  42 outbound IP traffic, and more; see \fBipmpstat\fR(1M).
  43 .SH OPTIONS
  44 .sp
  45 .LP
  46 The \fBif_mpadm\fR utility supports the following options:
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fB-d\fR \fIifname\fR\fR
  51 .ad
  52 .RS 13n
  53 Offline the IP interface specified by \fIifname\fR. If \fIifname\fR is not in
  54 an IPMP group, or the offline would cause the IPMP group to lose network
  55 connectivity, the operation will fail.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fB-r\fR \fIifname\fR\fR
  62 .ad
  63 .RS 13n
  64 Undo a previous offline of the IP interface specified by \fIifname\fR. If
  65 \fIifname\fR is not offline, the operation will fail.
  66 .RE
  67
  68 .SH EXAMPLES
  69 .LP
  70 \fBExample 1 \fROfflining an IP Interface
  71 .sp
  72 .LP
  73 The following command offlines the IP interface \fBunder0\fR, causing any IP
  74 packets that were being sent and received through it to be handled by another
  75 IP interface in its group.
  76
  77 .sp
  78 .in +2
  79 .nf
  80 example% \fBif_mpadm -d under0\fR
  81 .fi
  82 .in -2
  83 .sp
  84
  85 .LP
  86 \fBExample 2 \fRUndoing a Previous Offline Operation
  87 .sp
  88 .LP
  89 Use the following command to undo the operation in the previous example:
  90
  91 .sp
  92 .in +2
  93 .nf
  94 example% \fBif_mpdadm -r under0\fR
  95 .fi
  96 .in -2
  97 .sp
  98
  99 .SH ATTRIBUTES
 100 .sp
 101 .LP
 102 See \fBattributes\fR(5) for descriptions of the following attributes:
 103 .sp
 104
 105 .sp
 106 .TS
 107 box;
 108 c | c
 109 l | l .
 110 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 111 _
 112 Interface Stability     Unstable
 113 .TE
 114
 115 .SH SEE ALSO
 116 .sp
 117 .LP
 118 \fBifconfig\fR(1M), \fBin.mpathd\fR(1M), \fBipmpstat\fR(1M),
 119 \fBattributes\fR(5)
 120 .SH DIAGNOSTICS
 121 .sp
 122 .LP
 123 cannot offline: no other functioning interfaces are in its IPMP group.
 124 .RS +4
 125 \fBDescription: \fR
 126 .sp
 127 .LP
 128 This message means that offlining the IP interface would leave the IPMP group
 129 without network connectivity.
 130 .RE
 131
 132 .sp
 133 .LP
 134 cannot offline: not a physical interface or not in an IPMP group
 135 .RS +4
 136 \fBDescription: \fR
 137 .sp
 138 .LP
 139 This means that the IP interface is not an underlying interface in an IPMP
 140 group, and therefore is not eligible to be offlined.
 141 .RE
 142