MP_CANCELOVERRIDEPATH(3MPAPI) Common Multipath Management Library Functions


NAME


MP_CancelOverridePath - cancel a path override

SYNOPSIS


cc [ flag... ] file... -lMPAPI [ library... ]
#include <mpapi.h>

MP_STATUS MP_CancelOverridePath(MP_OID logicalUnitOid);


PARAMETERS


logicalUnitOid
An object ID that has type MP_MULTIPATH_LOGICAL_UNIT.


DESCRIPTION


The MP_CancelOverridePath() function cancels a path override and re-
enables load balancing.


Calling this function is valid only if the field canOverridePaths in data
structure MP_PLUGIN_PROPERTIES is true.


The previous load balance configuration and preferences in effect before
the path was overridden are restored.

RETURN VALUES


MP_STATUS_INVALID_OBJECT_TYPE

The logicalUnitOid parameter 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 parameter has a type subfield other than
MP_MULTIPATH_LOGICAL_UNIT.


MP_STATUS_OBJECT_NOT_FOUND

The logicalUnitOid owner ID or object sequence number is invalid.


MP_STATUS_SUCCESS

The operation is successful.


MP_STATUS_UNSUPPORTED

The API is not supported.


ATTRIBUTES


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


+--------------------+---------------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+---------------------------+
|Interface Stability | Standard: ANSI INCITS 412 |
| | Multipath Management API |
+--------------------+---------------------------+
|MT-Level | Safe |
+--------------------+---------------------------+

SEE ALSO


libMPAPI(3LIB), MP_SetOverridePath(3MPAPI), attributes(5)


Multipath Management API Version 1.0


February 15, 2006 MP_CANCELOVERRIDEPATH(3MPAPI)