xref: /illumos-gate/usr/src/man/man3mpapi/MP_CancelOverridePath.3mpapi (revision 6dde88b51419b99fe0aab8e56184c693945826b8)
te
Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved.
Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
MP_CANCELOVERRIDEPATH 3MPAPI "Feb 15, 2006"
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(7) 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 (7)

Multipath Management API Version 1.0