MP_SetLogicalUnitCommonlMultipath3ManaMP_SetLogicalUnitLoadBalanceType(3MPAPI)NAMEMP_SetLogicalUnitLoadBalanceType - set a load balancing policy
SYNOPSIS
cc [ flag... ] file... -lMPAPI [ library... ]
#include <mpapi.h>
MP_STATUS MP_SetLogicalUnitLoadBalanceType(MP_OID logicalUnitoid,
MP_LOAD_BALANCE_TYPE loadBalance);
PARAMETERS
logicalUnitOid The object ID of the multipath logical unit.
loadBalance The desired load balance policy for the specified
logical unit.
DESCRIPTION
The MP_SetLogicalUnitLoadBalanceType() function sets the multipath log‐
ical unit's load balancing policy. The value must correspond to one of
the supported values in MP_PLUGIN_PROPERTIES.SupportedLogicalUnitLoad‐
BalanceTypes.
RETURN VALUES
MP_STATUS_INVALID_OBJECT_TYPE
The logicalUnitOid 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 loadBalance is invalid or logicalUnitOid has a type subfield
other than MP_OBJECT_TYPE_MULTIPATH_LU.
MP_STATUS_OBJECT_NOT_FOUND
The logicalUnitOid owner ID or object sequence number is invalid.
MP_STATUS_SUCCESS
The operation is successful.
MP_STATUS_FAILED
The specified loadBalance type cannot be handled by the plugin. One
possible reason for this is a request to set MP_LOAD_BAL‐
ANCE_TYPE_PRODUCT when the specified logical unit has no corre‐
sponding MP_DEVICE_PRODUCT_PROPERTIES instance (i.e., the plugin
does not have a product-specific load balance algorithm for the LU
product).
MP_STATUS_UNSUPPORTED
The implementation does not support the API.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
┌─────────────────────────────┬─────────────────────────────────────────┐
│ ATTRIBUTE TYPE │ ATTRIBUTE VALUE │
├─────────────────────────────┼─────────────────────────────────────────┤
│Interface Stability │Committed │
├─────────────────────────────┼─────────────────────────────────────────┤
│MT-Level │Safe │
├─────────────────────────────┼─────────────────────────────────────────┤
│Standard │ANSI INCITS 412 Multipath Management API │
└─────────────────────────────┴─────────────────────────────────────────┘
SEE ALSOlibMPAPI(3LIB), attributes(5)
Multipath Management API Version 1.0
SunOS 5.11 15 FMP_SetLogicalUnitLoadBalanceType(3MPAPI)