Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

MP_SetPluginLoadBalanceType(3MPAPI)

Name

MP_SetPluginLoadBalanceType - set the plugin default load balance policy

Synopsis

cc [ flag… ] file–lMPAPI [ library… ]
#include <mpapi.h>

MP_STATUS MP_SetPluginLoadBalanceType(MP_OID oid,
     MP_LOAD_BALANCE_TYPE loadBalance);

Parameters

oid

The object ID of the plugin.

loadBalance

The desired default load balance policy for the specified plugin.

Description

The MP_SetPluginLoadBalanceType() function sets the default load balance policy for the plugin. The value must correspond to one of the supported values in MP_PLUGIN_PROPERTIES.SupportedPluginLoadBalanceTypes.

Return Values

MP_STATUS_INVALID_OBJECT_TYPE

The oid 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 when the oid has a type subfield other than MP_OBJECT_TYPE_PLUGIN.

MP_STATUS_OBJECT_NOT_FOUND

The oid ownerID or sequence number is invalid.

MP_STATUS_SUCCESS

The operation is successful.

MP_STATUS_FAILED

The specified loadBalance type cannot be handled by the plugin.

MP_STATUS_UNSUPPORTED

The implementation does not support the API.

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