usr/src/man/man3mpapi/MP_SetLogicalUnitLoadBalanceType.3mpapi

   1 '\" te
   2 .\" Copyright (c) 2004-2006 Storage Networking Industry Association. All Rights Reserved.
   3 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH MP_SETLOGICALUNITLOADBALANCETYPE 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_SetLogicalUnitLoadBalanceType \- set a load balancing policy
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
  14 #include <mpapi.h>
  15
  16 \fBMP_STATUS\fR \fBMP_SetLogicalUnitLoadBalanceType\fR(\fBMP_OID\fR \fIlogicalUnitoid\fR,
  17      \fBMP_LOAD_BALANCE_TYPE\fR  \fIloadBalance\fR);
  18 .fi
  19
  20 .SH PARAMETERS
  21 .sp
  22 .ne 2
  23 .na
  24 \fB\fIlogicalUnitOid\fR\fR
  25 .ad
  26 .RS 18n
  27 The object ID of the multipath logical unit.
  28 .RE
  29
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIloadBalance\fR\fR
  34 .ad
  35 .RS 18n
  36 The desired load balance policy for the specified logical unit.
  37 .RE
  38
  39 .SH DESCRIPTION
  40 .sp
  41 .LP
  42 The \fBMP_SetLogicalUnitLoadBalanceType()\fR function sets the multipath
  43 logical unit's load balancing policy. The value must correspond to one of the
  44 supported values in
  45 \fBMP_PLUGIN_PROPERTIES.SupportedLogicalUnitLoadBalanceTypes\fR.
  46 .SH RETURN VALUES
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  51 .ad
  52 .sp .6
  53 .RS 4n
  54 The \fIlogicalUnitOid\fR does not specify any valid object type. This is most
  55 likely to happen if an uninitialized object ID is passed to the API.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  62 .ad
  63 .sp .6
  64 .RS 4n
  65 The \fIloadBalance\fR is invalid or \fIlogicalUnitOid\fR has a type subfield
  66 other than \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR.
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
  73 .ad
  74 .sp .6
  75 .RS 4n
  76 The \fIlogicalUnitOid\fR owner ID or object sequence number is invalid.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBMP_STATUS_SUCCESS\fR\fR
  83 .ad
  84 .sp .6
  85 .RS 4n
  86 The operation is successful.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fBMP_STATUS_FAILED\fR\fR
  93 .ad
  94 .sp .6
  95 .RS 4n
  96 The specified \fIloadBalance\fR type cannot be handled by the plugin. One
  97 possible reason for this is a request to set \fBMP_LOAD_BALANCE_TYPE_PRODUCT\fR
  98 when the specified logical unit has no corresponding
  99 \fBMP_DEVICE_PRODUCT_PROPERTIES\fR instance (i.e., the plugin does not have a
 100 product-specific load balance algorithm for the LU product).
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fB\fBMP_STATUS_UNSUPPORTED\fR\fR
 107 .ad
 108 .sp .6
 109 .RS 4n
 110 The implementation does not support the API.
 111 .RE
 112
 113 .SH ATTRIBUTES
 114 .sp
 115 .LP
 116 See \fBattributes\fR(5) for descriptions of the following attributes:
 117 .sp
 118
 119 .sp
 120 .TS
 121 box;
 122 c | c
 123 l | l .
 124 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 125 _
 126 Interface Stability     T{
 127 Standard: ANSI INCITS 412 Multipath Management API
 128 T}
 129 _
 130 MT-Level        Safe
 131 .TE
 132
 133 .SH SEE ALSO
 134 .sp
 135 .LP
 136 \fBlibMPAPI\fR(3LIB), \fBattributes\fR(5)
 137 .sp
 138 .LP
 139 \fIMultipath Management API Version 1.0\fR