Print this page
Clearview IPMP manpages
| Split |
Close |
| Expand all |
| Collapse all |
--- old/./if_mpadm.txt
+++ new/./if_mpadm.txt
1 1 System Administration Commands if_mpadm(1M)
2 2
3 3
4 4
5 5 NAME
6 - if_mpadm - change operational status of interfaces within a
7 - multipathing group
6 + if_mpadm - administer interfaces in an IP multipathing group
8 7
9 8 SYNOPSIS
10 - /usr/sbin/if_mpadm -d interface_name
9 + if_mpadm -d | -r ifname
11 10
12 -
13 - /usr/sbin/if_mpadm -r interface_name
14 -
15 -
16 11 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.
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.
22 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)*.
23 42
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 43 OPTIONS
40 - The if_mpadm utility supports the following options:
44 + The *if_mpadm* utility supports the following options:
41 45
42 - -d interface_name Detach or off-line the interface speci-
43 - fied by interface_name.
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.
44 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.
45 56
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 57
53 -
54 58 EXAMPLES
55 - Example 1 Detaching an Interface
59 + Example 1 Offlining an IP Interface
56 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.
57 65
66 + example% if_mpadm -d under0
58 67
59 68
60 -SunOS 5.11 Last change: 3 Sep 2002 1
69 + Example 2 Undoing a Previous Offline Operation
61 70
62 71
72 + Use the following command to undo the previous operation:
63 73
64 74
75 + example% if_mpadm -r under0
65 76
66 77
67 -System Administration Commands if_mpadm(1M)
68 78
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 79 ATTRIBUTES
93 80 See attributes(5) for descriptions of the following attri-
94 81 butes:
95 82
96 83
97 84
98 85 ____________________________________________________________
99 86 | ATTRIBUTE TYPE | ATTRIBUTE VALUE |
100 87 |_____________________________|_____________________________|
101 88 | Availability | SUNWcsu |
102 89 |_____________________________|_____________________________|
103 90 | Interface Stability | Unstable |
104 91 |_____________________________|_____________________________|
105 92
106 93
107 94 SEE ALSO
108 95 ifconfig(1M), in.mpathd(1M), attributes(5)
109 96
110 97 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.
98 + cannot offline: no other functioning interfaces are in its
99 + IPMP group.
100 +
114 101 Description:
115 102
103 + This message means that offlining the IP interface would
104 + leave the IPMP group without network connectivity.
116 105
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.
106 + cannot offline: not a physical interface or not in an IPMP
107 + group
120 108
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 109 Description:
140 110
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 -
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.
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX