Print this page
Clearview IPMP manpages
| Split |
Close |
| Expand all |
| Collapse all |
--- old/./in.mpathd.1m.txt
+++ new/./in.mpathd.1m.txt
1 1 System Administration Commands in.mpathd(1M)
2 2
3 3
4 4
5 5 NAME
6 - in.mpathd - daemon for network adapter (NIC) failure detec-
7 - tion, recovery, automatic failover and failback
6 + in.mpathd - IP multipathing daemon
8 7
9 8 SYNOPSIS
10 9 /usr/lib/inet/in.mpathd
11 10
12 11
13 12 DESCRIPTION
14 - The in.mpathd daemon performs Network Interface Card (NIC)
15 - failure and repair detection. In the event of a NIC failure,
16 - it causes IP network access from the failed NIC to failover
17 - to a standby NIC, if available, or to any another opera-
18 - tional NIC that has been configured as part of the same net-
19 - work multipathing group. Once the failed NIC is repaired,
20 - all network access is restored to the repaired NIC.
21 13
14 + The *in.mpathd* daemon performs failure and repair detection
15 + for IP interfaces that have been placed into an IPMP group
16 + (or optionally, for all IP interfaces on the system). It
17 + also controls which IP interfaces in an IPMP group are
18 + "active" (being used by the system to send or receive IP
19 + data traffic) in a manner which is consistent with the
20 + administrator's configured policy.
22 21
23 - The in.mpathd daemon can detect NIC failure and repair
24 - through two methods: by monitoring the IFF_RUNNING flag for
25 - each NIC (link-based failure detection), and by sending and
26 - receiving ICMP echo requests and replies on each NIC
27 - (probe-based failure detection). Link-based failure detec-
28 - tion requires no explicit configuration and thus is always
29 - enabled (provided the NIC driver supports the feature);
30 - probe-based failure detection must be enabled through the
31 - configuration of one or more test addresses (described
32 - below), but has the benefit of testing the entire NIC send
33 - and receive path.
34 22
23 + The *in.mpathd* daemon can detect IP interface failure and
24 + repair through two methods: by monitoring the *IFF_RUNNING*
25 + flag for each IP interface (link-based failure detection),
26 + and by sending and receiving ICMP probes on each IP
27 + interface (probe-based failure detection). Link-based
28 + failure detection is instantaneous and is always enabled
29 + (provided the network driver supports the feature);
30 + probe-based failure detection must be enabled through the
31 + configuration of one or more test addresses (described
32 + below), but tests the entire IP interface send and receive
33 + path. The *ipmpstat(1M)* utility can be used to check which
34 + failure detection methods are enabled.
35 35
36 +
36 37 If only link-based failure detection is enabled, then the
37 38 health of the interface is determined solely from the state
38 39 of the IFF_RUNNING flag. Otherwise, the interface is con-
39 40 sidered failed if either of the two methods indicate a
40 41 failure, and repaired once both methods indicate the failure
41 42 has been corrected. Not all interfaces in a group need to be
42 43 configured with the same failure detection methods.
43 44
44 45
45 - As mentioned above, in order to perform probe-based failure
46 - detection in.mpathd needs a special test address on each NIC
47 - for the purpose of sending and receiving probes on the NIC.
48 - Use the ifconfig command -failover option to configure these
49 - test addresses. See ifconfig(1M). The test address must
50 - belong to a subnet that is known to the hosts and routers on
51 - the link.
46 + As mentioned above, to perform probe-based failure detection
47 + *in.mpathd* requires a test address on each IP interface for
48 + the purpose of sending and receiving probes. Each address
49 + must be marked *NOFAILOVER* (see *ifconfig(1M)*) and
50 + *in.mpathd* will be limited to probing targets on the same
51 + subnet. Each address may be configured statically or
52 + acquired via DHCP. To find targets, *in.mpathd* first
53 + consults the routing table for routes on the same subnet,
54 + and uses the specified next-hop. If no routes match, it
55 + sends all-hosts ICMP probes and selects a subset of the
56 + systems that respond. Thus, for probe-based failure
57 + detection to operate, there must be at least one neighbor on
58 + each subnet that responds to ICMP echo request probes. The
59 + *ipmpstat(1M)* utility can be used to display both the
60 + current probe target information and the status of sent
61 + probes.
62 +
52 63
64 + Both IPv4 and IPv6 are supported. If an IP interface is
65 + plumbed for IPv4 and an IPv4 test address is configured then
66 + *in.mpathd* will start sending ICMPv4 probes over that IP
67 + interface. Similarly, if an IP interface is plumbed for
68 + IPv6 and an IPv6 test address is configured then *in.mpathd*
69 + will start sending ICMPv6 probes over that IP interface.
70 + However, note that *in.mpathd* will ignore IPv6 test
71 + addresses that are not link-local. If both IPv4 and IPv6
72 + are plumbed, it is sufficient to configure only one of the
73 + two, that is, either an IPv4 test address or an IPv6 test
74 + address. If both IPv4 and IPv6 test addresses are
75 + configured, *in.pathd* probes using both ICMPv4 and ICMPv6.
53 76
54 - The in.mpathd daemon can detect NIC failure and repair by
55 - two methods, by sending and receiving ICMP echo requests and
56 - replies on each NIC, and by monitoring the IFF_RUNNING flag
57 77
78 + As mentioned above, *in.mpathd* also controls which IP
79 + interfaces in an IPMP group are "active" (used by the system
80 + to send and receive IP data traffic). Specifically,
81 + *in.mpathd* tracks the administrative configuration of each
82 + IPMP group and attempts to keep the number of active IP
83 + interfaces in each group consistent with that configuration.
84 + Therefore, if an active IP interface fails, *in.mpathd* will
85 + activate an *INACTIVE* interface in the group, provided one
86 + exists (it will prefer *INACTIVE* interfaces that are also
87 + marked *STANDBY*). Likewise, if an IP interface repairs and
88 + the resulting repair leaves the IPMP group with more active
89 + interfaces than the administrative configuration specifies,
90 + *in.mpathd* will deactivate one of the interfaces
91 + (preferably one marked *STANDBY*), except when the
92 + *FAILBACK* variable is used, as described below. Similar
93 + adjustments will be made by *in.mpathd* when offlining IP
94 + interfaces (for instance, in response to *if_mpadm(1M)*).
58 95
59 96
60 -SunOS 5.11 Last change: 8 Sep 2006 1
61 -
62 -
63 -
64 -
65 -
66 -
67 -System Administration Commands in.mpathd(1M)
68 -
69 -
70 -
71 - for each NIC. The link state on some models of NIC is indi-
72 - cated by the IFF_RUNNING flag, allowing for faster failure
73 - detection when the link goes down. The in.mpathd daemon con-
74 - siders a NIC to have failed if either of the above two
75 - methods indicates failure. A NIC is considered to be
76 - repaired only if both methods indicate the NIC is repaired.
77 -
78 -
79 - The in.mpathd daemon sends the ICMP echo request probes to
80 - on-link routers. If no routers are available, it sends the
81 - probes to neighboring hosts. Thus, for network failure
82 - detection and repair, there must be at least one neighbor on
83 - each link that responds to ICMP echo request probes.
84 -
85 -
86 - in.mpathd works on both IPv4 and IPv6. If IPv4 is plumbed on
87 - a NIC, an IPv4 test address is configured on theNIC, and the
88 - NIC is configured as part of a network multipathing group,
89 - then in.mpathd will start sending ICMP probes on the NIC
90 - using IPv4.
91 -
92 -
93 - In the case of IPv6, the link-local address must be config-
94 - ured as the test address. The in.mpathd daemon will not
95 - accept a non-link-local address as a test address. If the
96 - NIC is part of a multipathing group, and the test address
97 - has been configured, then in.mpathd will probe the NIC for
98 - failures using IPv6.
99 -
100 -
101 - Even if both the IPv4 and IPv6 protocol streams are plumbed,
102 - it is sufficient to configure only one of the two, that is,
103 - either an IPv4 test address or an IPv6 test address on a
104 - NIC. If only an IPv4 test address is configured, it probes
105 - using only ICMPv4. If only an IPv6 test address is config-
106 - ured, it probes using only ICMPv6. If both type test
107 - addresses are configured, it probes using both ICMPv4 and
108 - ICMPv6.
109 -
110 -
111 97 The in.mpathd daemon accesses three variable values in
112 98 /etc/default/mpathd: FAILURE_DETECTION_TIME, FAILBACK and
113 99 TRACK_INTERFACES_ONLY_WITH_GROUPS.
114 100
115 101
116 - The FAILURE_DETECTION_TIME variable specifies the NIC
117 - failure detection time for the ICMP echo request probe
118 - method of detecting NIC failure. The shorter the failure
119 - detection time, the greater the volume of probe traffic. The
120 - default value of FAILURE_DETECTION_TIME is 10 seconds. This
121 - means that NIC failure will be detected by in.mpathd within
122 - 10 seconds. NIC failures detected by the IFF_RUNNING flag
102 + The *FAILURE_DETECTION_TIME* variable specifies the
103 + probe-based failure detection time. The shorter the failure
104 + detection time, the more probe traffic. The default value
105 + of *FAILURE_DETECTION_TIME* is 10 seconds. This means that
106 + IP interface failure will be detected by *in.mpathd* within
107 + 10 seconds. The IP interface repair detection time is
108 + always twice the value of *FAILURE_DETECTION_TIME*. Note
109 + that failures and repairs detected by link-based failure
110 + detection are acted on immediately, though *in.mpathd* may
111 + ignore link state changes if it suspects that the link state
112 + is flapping due to defective hardware; see DIAGNOSTICS.
123 113
124 114
115 + By default, *in.mpathd* limits failure and repair detection
116 + to IP interfaces that are configured as part of a named IPMP
117 + group. Setting *TRACK_INTERFACES_ONLY_WITH_GROUPS* to *no*
118 + enables failure and repair detection on all IP interfaces,
119 + even if they are not part of a named IPMP group. IP
120 + interfaces that are tracked but not part of a named IPMP
121 + group are considered to be part of the "anonymous" IPMP
122 + group. In addition to having no name, this IPMP group is
123 + special in that its IP interfaces are not equivalent and
124 + thus cannot take over for one another in the event of an IP
125 + interface failure. That is, the anonymous IPMP group can
126 + only be used for failure and repair detection, and provides
127 + no high-availability or load-spreading.
125 128
126 -SunOS 5.11 Last change: 8 Sep 2006 2
127 129
130 + As described above, when *in.mpathd* detects that an IP
131 + interface has repaired, it activates it so that it will
132 + again be used to send and receive IP data traffic. However,
133 + if *FAILBACK* is set to *no*, then the IP interface will
134 + only be activated if no other active IP interfaces in the
135 + group remain. However, the interface may subsequently be
136 + activated if another IP interface in the group fails.
128 137
129 -
130 -
131 -
132 -
133 -System Administration Commands in.mpathd(1M)
134 -
135 -
136 -
137 - being cleared are acted on as soon as the in.mpathd daemon
138 - notices the change in the flag. The NIC repair detection
139 - time cannot be configured; however, it is defined as double
140 - the value of FAILURE_DETECTION_TIME.
141 -
142 -
143 - By default, in.mpathd does failure detection only on NICs
144 - that are configured as part of a multipathing group. You can
145 - set TRACK_INTERFACES_ONLY_WITH_GROUPS to no to enable
146 - failure detection by in.mpathd on all NICs, even if they are
147 - not part of a multipathing group. However, in.mpathd cannot
148 - do failover from a failed NIC if it is not part of a mul-
149 - tipathing group.
150 -
151 -
152 - The in.mpathd daemon will restore network traffic back to
153 - the previously failed NIC, after it has detected a NIC
154 - repair. To disable this, set the value of FAILBACK to no in
155 - /etc/default/mpathd.
156 -
157 138 FILES
158 139 /etc/default/mpathd Contains default values used by the
159 140 in.mpathd daemon.
160 141
161 142
162 143 ATTRIBUTES
163 144 See attributes(5) for descriptions of the following attri-
164 145 butes:
165 146
166 147
167 148
168 149 ____________________________________________________________
169 150 | ATTRIBUTE TYPE | ATTRIBUTE VALUE |
170 151 |_____________________________|_____________________________|
171 152 | Availability | SUNWcsr |
172 153 |_____________________________|_____________________________|
173 154
174 155
175 156 SEE ALSO
176 - ifconfig(1M), attributes(5), icmp(7P), icmp6(7P),
157 + ifconfig(1M), ipmpstat(1M), if_mpadm(1M), icmp(7P), icmp6(7P)
177 158
178 159
179 160 DIAGNOSTICS
180 - Test address address is not unique; disabling probe based
181 - failure detection on interface_name
161 + IP interface *interface_name* has a hardware address which
162 + is not unique in group *group_name*; offlining
182 163 Description:
183 164
165 + For probe-based failure detection, load-spreading, and
166 + other code IPMP features to work properly, each IP
167 + interface in an IPMP group must have a unique hardware
168 + address. If this requirement is not met, *in.mpathd*
169 + will automatically offline all but one of the IP
170 + interfaces with duplicate hardware addresses.
184 171
185 - For in.mpathd to perform probe-based failure detection,
186 - each test address in the group must be unique. Since the
187 - IPv6 test address is a link-local address derived from
188 - the MAC address, each IP interface in the group must
172 + IP interface *interface_name* now has a unique hardware
173 + address in group *group_name*; onlining
174 + Description:
189 175
176 + The previously-detected duplicate hardware address is
177 + now unique, and therefore *in.mpathd* has brought
178 + *interface_name* back online.
190 179
191 180
181 + Test address *address* is not unique in group; disabling
182 + probe-based failure detection on *interface_name*
183 + Description:
184 +
185 +
186 + For in.mpathd to perform probe-based failure detection,
187 + each test address in the group must be unique.
188 +
189 +
192 190 SunOS 5.11 Last change: 8 Sep 2006 3
193 191
194 192
195 193
196 194
197 195
198 196
199 197 System Administration Commands in.mpathd(1M)
200 198
201 199
202 200
203 - have a unique MAC address.
201 + No test address configured on interface *interface_name*;
202 + disabling probe-based failure detection on it
203 + Description:
204 204
205 205
206 + For *in.mpathd* to perform probe-based failure detection
207 + on an IP interface, it must be configured with a test
208 + address: IPv4, IPv6, or both.
206 209
210 +
207 211 NIC interface_name of group group_name is not plumbed for
208 212 IPv[4|6] and may affect failover capability
209 213 Description:
210 214
211 215
212 216 All NICs in a multipathing group must be homogeneously
213 217 plumbed. For example, if a NIC is plumbed for IPv4, then
214 218 all NICs in the group must be plumbed for IPv4. The
215 - streams modules pushed on all NICs must be identical.
219 + STREAMS modules pushed on all NICs must also be identical.
216 220
217 221
218 -
219 - No test address configured on interface interface_name disa-
220 - bling probe-based failure detection on it
221 - Description:
222 -
223 -
224 - In order for in.mpathd to perform probe-based failure
225 - detection on a NIC, it must be configured with a test
226 - address: IPv4, IPv6, or both.
227 -
228 -
229 -
230 222 The link has come up on interface_name more than 2 times in
231 - the last minute; disabling failback until it stabilizes.
223 + the last minute; disabling repair until it stabilizes.
232 224 Description:
233 225
234 226
235 - In order to prevent interfaces with intermittent
236 - hardware, such as a bad cable, from causing repeated
237 - failovers and failbacks, in.mpathd does not failback to
238 - interfaces with frequently fluctuating link states.
227 + To limit the impact of interfaces with intermittent
228 + hardware (such as a bad cable), *in.mpathd* will not
229 + consider an IP interface with a frequently changing link
230 + state as repaired until the link state stabilizes.
239 231
240 232
241 233
242 - Invalid failure detection time assuming default 10000
234 + Invalid failure detection time of *time*, assuming default
235 + of 10000 ms
243 236 Description:
244 237
245 238
246 239 An invalid value was encountered for
247 240 FAILURE_DETECTION_TIME in the /etc/default/mpathd file.
248 241
249 242
250 243
251 - Too small failure detection time of time assuming minimum
252 - 100
244 + Too small failure detection time of *time*, assuming minimum
245 + of 100 ms
253 246 Description:
254 247
255 248
256 249
257 250
258 251 SunOS 5.11 Last change: 8 Sep 2006 4
259 252
260 253
261 254
262 255
263 256
264 257
265 258 System Administration Commands in.mpathd(1M)
266 259
267 260
268 261
269 262 The minimum value that can be specified for
270 263 FAILURE_DETECTION_TIME is currently 100 milliseconds.
271 264
272 265
273 266
274 267 Invalid value for FAILBACK value
275 268 Description:
276 269
277 270
278 271 Valid values for the boolean variable FAILBACK are yes
279 272 or no.
280 273
281 274
282 275
283 276 Invalid value for TRACK_INTERFACES_ONLY_WITH_GROUPS value
284 277 Description:
285 278
286 279
287 280 Valid values for the boolean variable
288 281 TRACK_INTERFACES_ONLY_WITH_GROUPS are yes or no.
289 282
290 283
291 284
292 285 Cannot meet requested failure detection time of time ms on
293 286 (inet[6] interface_name) new failure detection time for
294 287 group group_name is time ms
295 288 Description:
296 289
297 290
298 291 The round trip time for ICMP probes is higher than
299 292 necessary to maintain the current failure detection
300 293 time. The network is probably congested or the probe
301 294 targets are loaded. in.mpathd automatically increases
302 295 the failure detection time to whatever it can achieve
303 296 under these conditions.
304 297
305 298
306 299
307 300 Improved failure detection time time ms on (inet[6]
|
↓ open down ↓ |
45 lines elided |
↑ open up ↑ |
308 301 interface_name) for group group_name
309 302 Description:
310 303
311 304
312 305 The round trip time for ICMP probes has now decreased
313 306 and in.mpathd has lowered the failure detection time
314 307 correspondingly.
315 308
316 309
317 310
318 - NIC failure detected on interface_name
311 + IP interface failure detected on interface_name
319 312 Description:
320 313
321 314
322 315
323 316
324 317 SunOS 5.11 Last change: 8 Sep 2006 5
325 318
326 319
327 320
328 321
329 322
330 323
331 324 System Administration Commands in.mpathd(1M)
332 325
333 326
334 327
335 - in.mpathd has detected NIC failure on interface_name,
336 - and has set the IFF_FAILED flag on NIC interface_name.
328 + *in.mpathd* has detected a failure on *interface_name*,
329 + and has set the *IFF_FAILED* flag on *interface_name*,
330 + ensuring that it will not be used for IP data traffic.
337 331
338 332
339 -
340 - Successfully failed over from NIC interface_name1 to NIC
341 - interface_name2
333 + IP interface repair detected on *interface_name*
342 334 Description:
343 335
344 336
345 - in.mpathd has caused the network traffic to failover
346 - from NIC interface_name1 to NIC interface_name2, which
347 - is part of the multipathing group.
337 + *in.mpathd* has detected a repair on *interface_name*,
338 + and has cleared the *IFF_FAILED* flag. Depending on the
339 + administrative configuration, the *interface_name* may
340 + again be used for IP data traffic.
348 341
349 342
350 -
351 - NIC repair detected on interface_name
352 - Description:
353 -
354 -
355 - in.mpathd has detected that NIC interface_name is
356 - repaired and operational. If the IFF_FAILED flag on the
357 - NIC was previously set, it will be reset.
358 -
359 -
360 -
361 - Successfully failed back to NIC interface_name
362 - Description:
363 -
364 -
365 - in.mpathd has restored network traffic back to NIC
366 - interface_name, which is now repaired and operational.
367 -
368 -
369 -
370 343 The link has gone down on interface_name
371 344 Description:
372 345
373 346
374 - in.mpathd has detected that the IFF_RUNNING flag for NIC
375 - interface_name has been cleared, indicating the link has
376 - gone down.
347 + *in.mpathd* has detected that the *IFF_RUNNING* flag for
348 + *interface_name* has been cleared, indicating the link
349 + has gone down.
377 350
378 351
379 352
380 353 The link has come up on interface_name
381 354 Description:
382 355
383 356
384 - in.mpathd has detected that the IFF_RUNNING flag for NIC
385 - interface_name has been set, indicating the link has
357 + *in.mpathd* has detected that the *IFF_RUNNING* flag for
358 + *interface_name* has been set, indicating the link has
386 359 come up.
387 360
388 361
389 362
390 363 SunOS 5.11 Last change: 8 Sep 2006 6
391 364
392 365
393 366
394 367
395 368
396 369
397 370 System Administration Commands in.mpathd(1M)
398 371
399 372
400 373
401 374
402 375
403 376
404 377
405 378
406 379
407 380
408 381
409 382
410 383
411 384
412 385
413 386
414 387
415 388
416 389
417 390
418 391
419 392
420 393
421 394
422 395
423 396
424 397
425 398
426 399
427 400
428 401
429 402
430 403
431 404
432 405
433 406
434 407
435 408
436 409
437 410
438 411
439 412
440 413
441 414
442 415
443 416
444 417
445 418
446 419
447 420
448 421
449 422
450 423
451 424
452 425
453 426 SunOS 5.11 Last change: 8 Sep 2006 7
454 427
455 428
456 429
457 430
458 431
459 432
|
↓ open down ↓ |
64 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX