1 System Administration Commands                       if_mpadm(1M)
   2 
   3 
   4 
   5 NAME
   6      if_mpadm - administer interfaces in an IP multipathing group
   7 
   8 SYNOPSIS
   9      if_mpadm -d | -r ifname
  10 
  11 DESCRIPTION
  12      The *if_mpadm*   utility administers IP  interfaces that are
  13      part   of  an  IP multipathing   (IPMP)  group.   Currently,
  14      administration  is limited  to  offlining  IP interfaces and
  15      undoing previous offline operations.
  16 
  17      When  an IP interface is  taken offline, all IP data traffic
  18      that was flowing over the  IP interface is moved to  another
  19      IP interface  in the IPMP group.  In  addition,  all *UP* IP
  20      addresses  hosted  on the   IP interface  are  brought down,
  21      causing    *in.mpathd(1M)*  to  stop   probe-based   failure
  22      detection on  the IP interface.   As a result, an offline IP
  23      interface will  not be used  for any inbound or  outbound IP
  24      traffic.  Only IP interfaces that  are in an IPMP group  may
  25      be brought   offline.  If  the  IP  interface is   the  last
  26      functioning  interface    in  the  IPMP  group, the  offline
  27      operation will fail.
  28     
  29      When an offline operation is undone, any IP addresses hosted
  30      on that IP interface are brought *UP* and will be considered
  31      by *in.mpathd*   for probe-based   failure   detection.   In
  32      addition, provided the IP interface is otherwise active (see
  33      *in.mpathd(1M)*), it will again  be used to send and receive
  34      IP  data  traffic for the  IPMP   group.  Note that  not all
  35      offline operations can be undone.  For instance, *in.mpathd*
  36      may have  offlined  an  IP interface  because  its  hardware
  37      address was not    unique   within its   IPMP  group.    The
  38      *ipmpstat*  utility  can  be used to    determine why an  IP
  39      interface is offline,    identify which IP interfaces  in  a
  40      group are  being used for  inbound and  outbound IP traffic,
  41      and more; see *ipmpstat(1M)*.
  42 
  43 OPTIONS
  44      The *if_mpadm* utility supports the following options:
  45 
  46      -d ifname            Offline the  IP interface  specified by
  47                           *ifname*.   If  *ifname* is  not in  an
  48                           IPMP group,  or the offline would cause
  49                           the   IPMP   group    to  lose  network
  50                           connectivity, the operation will fail.
  51 
  52      -r ifname            Undo  a  previous  offline   of the  IP
  53                           interface   specified by *ifname*.   If
  54                           *ifname* is  not offline, the operation
  55                           will fail.
  56 
  57 
  58 EXAMPLES
  59      Example 1 Offlining an IP Interface
  60 
  61      The  following   command  offlines IP  interface   *under0*,
  62      causing any  IP packets  that  were being sent  and received
  63      through  it  to be handled  by  another IP  interface in its
  64      group.
  65 
  66        example% if_mpadm -d under0
  67 
  68 
  69      Example 2 Undoing a Previous Offline Operation
  70 
  71 
  72      Use the following  command to  undo the previous  operation:
  73 
  74 
  75        example% if_mpadm -r under0
  76 
  77 
  78 
  79 ATTRIBUTES
  80      See attributes(5) for descriptions of the  following  attri-
  81      butes:
  82 
  83 
  84 
  85      ____________________________________________________________
  86     |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
  87     |_____________________________|_____________________________|
  88     | Availability                | SUNWcsu                     |
  89     |_____________________________|_____________________________|
  90     | Interface Stability         | Unstable                    |
  91     |_____________________________|_____________________________|
  92 
  93 
  94 SEE ALSO
  95      ifconfig(1M), in.mpathd(1M), attributes(5)
  96 
  97 DIAGNOSTICS
  98      cannot offline: no other functioning interfaces are in its
  99      IPMP group.
 100 
 101          Description:
 102 
 103          This message means that offlining the IP interface would
 104          leave the IPMP group without network connectivity.
 105 
 106     cannot offline: not a physical interface or not in an IPMP
 107     group
 108 
 109          Description:
 110 
 111           This means that the  IP interface is not an  underlying
 112           interface in  an IPMP  group,   and  therefore is   not
 113           eligible to be offlined.