if_mpadm(1m) [opensolaris man page]

if_mpadm(1M)						  System Administration Commands					      if_mpadm(1M)

NAME

       if_mpadm - administer interfaces in an IP multipathing group

SYNOPSIS

       if_mpadm -d | -r ifname

DESCRIPTION

       The  if_mpadm  utility  administers IP interfaces that are part of an IP Multipathing (IPMP) group. Currently, administration is limited to
       offlining IP interfaces and undoing previous offline operations.

       When an IP interface is taken offline, all IP data traffic that was flowing over the IP interface is moved to another IP interface  in  the
       IPMP group. In addition, all UP IP addresses hosted on the IP interface are brought down, causing in.mpathd(1M) to stop probe-based failure
       detection on the IP interface. As a result, an offline IP interface will not be used for any inbound or outbound IP traffic. Only IP inter-
       faces  that  are in an IPMP group may be brought offline. If the IP interface is the last functioning interface in the IPMP group, the off-
       line operation will fail.

       When an offline operation is undone, any IP addresses hosted on that IP interface are brought UP and will be considered	by  in.mpathd  for
       probe-based  failure  detection.  In  addition, provided the IP interface is otherwise active (see in.mpathd(1M)), it will again be used to
       send and receive IP data traffic for the IPMP group. Note that not all offline operations can be undone. For instance, in.mpathd  may  have
       offlined  an  IP interface because its hardware address was not unique within its IPMP group. The ipmpstat utility can be used to determine
       why an IP interface is offline, identify which IP interfaces in a group are being used for inbound and outbound IP traffic, and	more;  see
       ipmpstat(1M).

OPTIONS

       The if_mpadm utility supports the following options:

       -d ifname    Offline  the IP interface specified by ifname. If ifname is not in an IPMP group, or the offline would cause the IPMP group to
		    lose network connectivity, the operation will fail.

       -r ifname    Undo a previous offline of the IP interface specified by ifname. If ifname is not offline, the operation will fail.

EXAMPLES

       Example 1 Offlining an IP Interface

       The following command offlines the IP interface under0, causing any IP packets that were being sent and received through it to  be  handled
       by another IP interface in its group.

	 example% if_mpadm -d under0

       Example 2 Undoing a Previous Offline Operation

       Use the following command to undo the operation in the previous example:

	 example% if_mpdadm -r under0

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWcsu			   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Unstable			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       ifconfig(1M), in.mpathd(1M), ipmpstat(1M), attributes(5)

DIAGNOSTICS

       cannot offline: no other functioning interfaces are in its IPMP group.
	   Description:

	   This message means that offlining the IP interface would leave the IPMP group without network connectivity.

       cannot offline: not a physical interface or not in an IPMP group
	   Description:

	   This means that the IP interface is not an underlying interface in an IPMP group, and therefore is not eligible to be offlined.

SunOS 5.11							    5 Jan 2009							      if_mpadm(1M)

if_mpadm(1M)                                              System Administration Commands                                              if_mpadm(1M)

NAME

       if_mpadm - change operational status of interfaces within a multipathing group

SYNOPSIS

       /usr/sbin/if_mpadm -d interface_name

       /usr/sbin/if_mpadm -r interface_name

DESCRIPTION

       Use  the  if_mpadm  utility  to  change the operational status of interfaces that are part of an IP multipathing group. If the interface is
       operational, you can use if_mpadm -d to detach or off-line the interface. If the interface is off-lined, use if_mpadm -r to  revert  it  to
       its original state.

       When  a  network interface is off-lined, all network access fails over to a different interface in the IP multipathing group. Any addresses
       that do not failover are brought down. Network access includes unicast, broadcast, and multicast for IPv4 and  unicast  and  multicast  for
       IPv6.  Addresses marked with IFF_NOFAILOVER do not failover. They are marked down. After an interface is off-lined, the system will not use
       the interface for any outbound or inbound traffic, and the interface can be safely removed from the system  without  any  loss  of  network
       access.

       The if_mpadm utility can be applied only to interfaces that are part of an IP multipathing group.

OPTIONS

       The if_mpadm utility supports the following options:

       -d interface_name       Detach or off-line the interface specified by     interface_name.

       -r interface_name        Reattach  or  undo  the previous detach or off-line operation on the interface specified by interface_name. Unless
                               the -d option was used to detach or off-line the interface, this option will fail.

EXAMPLES

       Example 1: Detaching an Interface

       Use the following command to off-line or detach the interface. All network access will failover from hme0 to other interfaces in  the  same
       IP multipathing group. If no other interfaces are in the same group, the operation will fail.

       example% if_mpadm -d hme0

       Example 2: Reattaching an Off-line Interface

       Use the following command to undo the previous operation. Network access will failback to hme0.

       example% if_mpdadm -r hme0

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE         |      ATTRIBUTE VALUE        |
       +-----------------------------+-----------------------------+
       |Availability                 |SUNWcsu                      |
       +-----------------------------+-----------------------------+
       |Interface Stability          |Unstable                     |
       +-----------------------------+-----------------------------+

SEE ALSO

       ifconfig(1M), in.mpathd(1M), attributes(5)

DIAGNOSTICS

       off-line failed as there is no other functional interface available in the multipathing group for failing over the network access.

         This message means that other interfaces in the group are failed over already or the multipathing configuration was not suitable for com-
         pleting a failover.

       off-line cannot be undone because multipathing configuration is not consistent across all the interfaces in the group.

         This message means that some interfaces in the IP multipathing group are not configured consistently with other interfaces in the  group,
         for example, one of the interfaces in the group does not have an IFF_NOFAILOVER address.

SunOS 5.10                                                          3 Sep 2002                                                        if_mpadm(1M)