1 System Administration Commands                       if_mpadm(1M)
   2 
   3 
   4 
   5 NAME
   6      if_mpadm - change operational status of interfaces within  a
   7      multipathing group
   8 
   9 SYNOPSIS
  10      /usr/sbin/if_mpadm -d interface_name
  11 
  12 
  13      /usr/sbin/if_mpadm -r interface_name
  14 
  15 
  16 DESCRIPTION
  17      Use the if_mpadm utility to change the operational status of
  18      interfaces that are part of an IP multipathing group. If the
  19      interface is operational, you can use if_mpadm -d to  detach
  20      or  off-line  the  interface. If the interface is off-lined,
  21      use if_mpadm -r to revert it to its original state.
  22 
  23 
  24      When a network interface is off-lined,  all  network  access
  25      fails  over  to a different interface in the IP multipathing
  26      group. Any addresses that do not failover are brought  down.
  27      Network  access  includes  unicast, broadcast, and multicast
  28      for IPv4 and unicast  and  multicast  for  IPv6.   Addresses
  29      marked  with IFF_NOFAILOVER do not failover. They are marked
  30      down. After an interface is off-lined, the system  will  not
  31      use  the  interface for any outbound or inbound traffic, and
  32      the interface can be safely removed from the system  without
  33      any loss of network access.
  34 
  35 
  36      The if_mpadm utility can be applied only to interfaces  that
  37      are part of an IP multipathing group.
  38 
  39 OPTIONS
  40      The if_mpadm utility supports the following options:
  41 
  42      -d interface_name    Detach or off-line the interface speci-
  43                           fied by     interface_name.
  44 
  45 
  46      -r interface_name     Reattach or undo the  previous  detach
  47                           or  off-line operation on the interface
  48                           specified by interface_name. Unless the
  49                           -d  option  was  used to detach or off-
  50                           line the interface,  this  option  will
  51                           fail.
  52 
  53 
  54 EXAMPLES
  55      Example 1 Detaching an Interface
  56 
  57 
  58 
  59 
  60 SunOS 5.11           Last change: 3 Sep 2002                    1
  61 
  62 
  63 
  64 
  65 
  66 
  67 System Administration Commands                       if_mpadm(1M)
  68 
  69 
  70 
  71      Use the following command to off-line or detach  the  inter-
  72      face.  All  network  access will failover from hme0 to other
  73      interfaces in the same IP multipathing group.  If  no  other
  74      interfaces are in the same group, the operation will fail.
  75 
  76 
  77        example% if_mpadm -d hme0
  78 
  79 
  80 
  81      Example 2 Reattaching an Off-line Interface
  82 
  83 
  84      Use the following command to undo  the  previous  operation.
  85      Network access will failback to hme0.
  86 
  87 
  88        example% if_mpdadm -r hme0
  89 
  90 
  91 
  92 ATTRIBUTES
  93      See attributes(5) for descriptions of the  following  attri-
  94      butes:
  95 
  96 
  97 
  98      ____________________________________________________________
  99     |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
 100     |_____________________________|_____________________________|
 101     | Availability                | SUNWcsu                     |
 102     |_____________________________|_____________________________|
 103     | Interface Stability         | Unstable                    |
 104     |_____________________________|_____________________________|
 105 
 106 
 107 SEE ALSO
 108      ifconfig(1M), in.mpathd(1M), attributes(5)
 109 
 110 DIAGNOSTICS
 111      off-line failed as there is no  other  functional  interface
 112      available  in  the  multipathing  group for failing over the
 113      network access.
 114          Description:
 115 
 116 
 117          This message means that other interfaces  in  the  group
 118          are  failed  over already or the multipathing configura-
 119          tion was not suitable for completing a failover.
 120 
 121 
 122 
 123 
 124 
 125 
 126 SunOS 5.11           Last change: 3 Sep 2002                    2
 127 
 128 
 129 
 130 
 131 
 132 
 133 System Administration Commands                       if_mpadm(1M)
 134 
 135 
 136 
 137      off-line cannot be undone because multipathing configuration
 138      is not consistent across all the interfaces in the group.
 139          Description:
 140 
 141 
 142          This message means that some interfaces in the  IP  mul-
 143          tipathing  group  are  not  configured consistently with
 144          other interfaces in the group, for example, one  of  the
 145          interfaces  in the group does not have an IFF_NOFAILOVER
 146          address.
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
 163 
 164 
 165 
 166 
 167 
 168 
 169 
 170 
 171 
 172 
 173 
 174 
 175 
 176 
 177 
 178 
 179 
 180 
 181 
 182 
 183 
 184 
 185 
 186 
 187 
 188 
 189 
 190 
 191 
 192 SunOS 5.11           Last change: 3 Sep 2002                    3
 193 
 194 
 195