Content-type: text/html Man page of MP_CancelOverridePath

MP_CancelOverridePath

Section: Common Multipath Management Library Functions (3MPAPI)
Updated: 15 Feb 2006
Index Return to Main Contents
 

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 TYPEATTRIBUTE VALUE
Interface Stability Standard: ANSI INCITS 412 Multipath Management API
MT-LevelSafe

 

SEE ALSO

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

Multipath Management API Version 1.0


 

Index

NAME
SYNOPSIS
PARAMETERS
DESCRIPTION
RETURN VALUES
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:39:52 GMT, October 02, 2010