MP_SetOverridePatCommonPMultipath Management LibraryMP_SetOverridePath(3MPAPI)NAMEMP_SetOverridePath - manually override a logical unit path
SYNOPSIS
cc [ flag... ] file... -lMPAPI [ library... ]
#include <mpapi.h>
MP_STATUS MP_SetOverridePath(MP_OID logicalUnitOid,
MP_OID pathOid);
PARAMETERS
logicalUnitOid The object ID of the multipath logical unit.
pathOid The object ID of the path logical unit.
DESCRIPTION
The MP_SetOverridePath() function is used to manually override the path
for a logical unit. The path is exclusively used to access the logical
unit until cleared. Use MP_CancelOverride to clear the override.
This API allows the administrator to disable the dri ver's load balance
algorithm and force all I/O operations to a specific path. The existing
path weight configuration is maintained. If the administrator undoes
the override (by calling MP_CancelOverridePath), the driver starts load
balancing based on the weights of available paths (and target port
group access state for asymmetric devices).
If the multipath logical unit is part of a target with asymmetrical
access, executing this command could cause failover.
RETURN VALUES
MP_STATUS_INVALID_OBJECT_TYPE
The logicalUnitOid or pathOid does not specify any valid object
type. This is most likely to happen if an uninitialized object ID
is passed to the API.
MP_STATUS_INVALID_PARAMETER
The logicalUnitOid has a type subfield other than
MP_OBJECT_TYPE_MULTIPATH_LU, or if pathOid has an object type other
than MP_OBJECT_TYPE_PATH_LU.
MP_STATUS_OBJECT_NOT_FOUND
The logicalUnitOid, pathOid owner ID, or object sequence number is
invalid.
MP_STATUS_SUCCESS
The operation is successful.
MP_STATUS_UNSUPPORTED
The implementation does not support the API.
MP_STATUS_PATH_NONOPERATIONAL
The driver cannot communicate through selected path
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
┌─────────────────────────────┬─────────────────────────────────────────┐
│ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
├─────────────────────────────┼─────────────────────────────────────────┤
│Interface Stability │Committed │
├─────────────────────────────┼─────────────────────────────────────────┤
│MT-Level │Safe │
├─────────────────────────────┼─────────────────────────────────────────┤
│Standard │ANSI INCITS 412 Multipath Management API │
└─────────────────────────────┴─────────────────────────────────────────┘
SEE ALSOlibMPAPI(3LIB), attributes(5)
Multipath Management API Version 1.0
SunOS 5.11 15 Feb 2006 MP_SetOverridePath(3MPAPI)