man/man3mpapi/MP_SetLogicalUnitLoadBalanceType.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_SETLOGICALUNITLOADBALANCETYPE 3MPAPI "June 13, 2021"
 NAME
MP_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
logical unit's load balancing policy. The value must correspond to one of the
supported values in
MP_PLUGIN_PROPERTIES.SupportedLogicalUnitLoadBalanceTypes.
 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_BALANCE_TYPE_PRODUCT
when the specified logical unit has no corresponding
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
Standard: ANSI INCITS 412 Multipath Management API
MT-Level Safe


 SEE ALSO
libMPAPI(3LIB), attributes(5)

Multipath Management API Version 1.0