Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

MP_SetPathWeight(3MPAPI)

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(7) for descriptions of the following attributes:

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

See Also

libMPAPI(3LIB), attributes(7)

Multipath Management API Version 1.0