1MP_SetOverridePathC(o3mMmPoAnPIM)ultipath Management LibraryMFPu_nScettiOovnesrridePath(3MPAPI)
2
3
4
6 MP_SetOverridePath - manually override a logical unit path
7
9 cc [ flag... ] file... -lMPAPI [ library... ]
10 #include <mpapi.h>
11
12 MP_STATUS MP_SetOverridePath(MP_OID logicalUnitOid,
13 MP_OID pathOid);
14
15
17 logicalUnitOid The object ID of the multipath logical unit.
18
19
20 pathOid The object ID of the path logical unit.
21
22
24 The MP_SetOverridePath() function is used to manually override the path
25 for a logical unit. The path is exclusively used to access the logical
26 unit until cleared. Use MP_CancelOverride to clear the override.
27
28
29 This API allows the administrator to disable the dri ver's load balance
30 algorithm and force all I/O operations to a specific path. The existing
31 path weight configuration is maintained. If the administrator undoes
32 the override (by calling MP_CancelOverridePath), the driver starts load
33 balancing based on the weights of available paths (and target port
34 group access state for asymmetric devices).
35
36
37 If the multipath logical unit is part of a target with asymmetrical
38 access, executing this command could cause failover.
39
41 MP_STATUS_INVALID_OBJECT_TYPE
42
43 The logicalUnitOid or pathOid does not specify any valid object
44 type. This is most likely to happen if an uninitialized object ID
45 is passed to the API.
46
47
48 MP_STATUS_INVALID_PARAMETER
49
50 The logicalUnitOid has a type subfield other than
51 MP_OBJECT_TYPE_MULTIPATH_LU, or if pathOid has an object type other
52 than MP_OBJECT_TYPE_PATH_LU.
53
54
55 MP_STATUS_OBJECT_NOT_FOUND
56
57 The logicalUnitOid, pathOid owner ID, or object sequence number is
58 invalid.
59
60
61 MP_STATUS_SUCCESS
62
63 The operation is successful.
64
65
66 MP_STATUS_UNSUPPORTED
67
68 The implementation does not support the API.
69
70
71 MP_STATUS_PATH_NONOPERATIONAL
72
73 The driver cannot communicate through selected path
74
75
77 See attributes(5) for descriptions of the following attributes:
78
79
80
81
82 ┌─────────────────────────────┬─────────────────────────────┐
83 │ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
84 ├─────────────────────────────┼─────────────────────────────┤
85 │Interface Stability │Standard: ANSI INCITS 412 │
86 │ │Multipath Management API │
87 ├─────────────────────────────┼─────────────────────────────┤
88 │MT-Level │Safe │
89 └─────────────────────────────┴─────────────────────────────┘
90
92 libMPAPI(3LIB), attributes(5)
93
94
95 Multipath Management API Version 1.0
96
97
98
99SunOS 5.11 15 Feb 2006 MP_SetOverridePath(3MPAPI)