man/man3mpapi/MP_SetPathWeight.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_SetPathWeight 3MPAPI "15 Feb 2006" "SunOS 5.11" "Common Multipath Management Library Functions"
 NAME
MP_SetPathWeight - set the weight of a path
 SYNOPSIS

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

MP_STATUS MP_SetPathWeight(MP_OID pathOid, MP_UINT32 weight);


 PARAMETERS

pathOid

The object ID of the path logical unit.


weight

A weight that will be assigned to the path logical unit.


 DESCRIPTION

The MP_SetPathWeight() function sets the weight to be assigned to a
particular path.
 RETURN VALUES

MP_STATUS_INVALID_OBJECT_TYPE

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

The pathOid ownerID or object sequence number is invalid.


MP_STATUS_INVALID_PARAMETER

The pathOid has a type subfield other than MP_OBJECT_TYPE_PATH_LU,
or when the weight parameter is greater than the plugin's maximum weight
property.


MP_STATUS_SUCCESS

The operation is successful.


MP_STATUS_FAILED

The operation failed.


MP_STATUS_UNSUPPORTED

The driver does not support setting path weight.


 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), attributes(5)

Multipath Management API Version 1.0

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability
Standard: ANSI INCITS 412 Multipath Management API

MT-Level	Safe