man/man3mpapi/MP_DisablePath.3mpapi

         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_DISABLEPATH 3MPAPI "Feb 15, 2006"
 NAME
MP_DisablePath - disable a path
 SYNOPSIS

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

MP_STATUS MP_DisablePath(MP_OID oid);


 PARAMETERS
oid

The object ID of the path.


 DESCRIPTION

The MP_DisablePath() function disables a path. This API might cause
failover in a logical unit with asymmetric access.

This API sets the disabled field of structure
MP_PATH_LOGICAL_UNIT_PROPERTIES to true.
 RETURN VALUES
MP_STATUS_INVALID_OBJECT_TYPE

The oid 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_OBJECT_NOT_FOUND

The oid parameter owner ID or object sequence number is invalid.


MP_STATUS_INVALID_PARAMETER

The oid parameter does not have a type subfield of
MP_OBJECT_TYPE_PATH_LU.


MP_STATUS_UNSUPPORTED

The API is not supported.


MP_STATUS_TRY_AGAIN

The path cannot be disabled at this time.


MP_STATUS_NOT_PERMITTED

Disabling this path causes the logical unit to become unavailable. The plugin
that administers the path might return this value or allow the last path to be
disabled.


MP_STATUS_SUCCESS

The operation is successful.


 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_EnablePath (3MPAPI),  attributes (7)
Multipath Management API Version 1.0