share/man/man3mpapi/MP_SetPathWeight.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_SETPATHWEIGHT 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_SetPathWeight \- set the weight of a path
  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_SetPathWeight\fR(\fBMP_OID\fR \fIpathOid\fR, \fBMP_UINT32\fR \fIweight\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fIpathOid\fR\fR
  24 .ad
  25 .RS 11n
  26 The object ID of the path logical unit.
  27 .RE
  28
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIweight\fR\fR
  33 .ad
  34 .RS 11n
  35 A weight that will be assigned to the path logical unit.
  36 .RE
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 The \fBMP_SetPathWeight()\fR function sets the weight to be assigned to a
  42 particular path.
  43 .SH RETURN VALUES
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  48 .ad
  49 .sp .6
  50 .RS 4n
  51 The \fIpathOid\fR does not specify any valid object type. This is most likely
  52 to happen if an uninitialized object ID is passed to the API.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
  59 .ad
  60 .sp .6
  61 .RS 4n
  62 The \fIpathOid\fR ownerID or object sequence number is invalid.
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  69 .ad
  70 .sp .6
  71 .RS 4n
  72 The \fIpathOid\fR has a type subfield other than \fBMP_OBJECT_TYPE_PATH_LU\fR,
  73 or when the weight parameter is greater than the plugin's maximum weight
  74 property.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBMP_STATUS_SUCCESS\fR\fR
  81 .ad
  82 .sp .6
  83 .RS 4n
  84 The operation is successful.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBMP_STATUS_FAILED\fR\fR
  91 .ad
  92 .sp .6
  93 .RS 4n
  94 The operation failed.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fB\fBMP_STATUS_UNSUPPORTED\fR\fR
 101 .ad
 102 .sp .6
 103 .RS 4n
 104 The driver does not support setting path weight.
 105 .RE
 106
 107 .SH ATTRIBUTES
 108 .sp
 109 .LP
 110 See \fBattributes\fR(5) for descriptions of the following attributes:
 111 .sp
 112
 113 .sp
 114 .TS
 115 box;
 116 c | c
 117 l | l .
 118 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 119 _
 120 Interface Stability     T{
 121 Standard: ANSI INCITS 412 Multipath Management API
 122 T}
 123 _
 124 MT-Level        Safe
 125 .TE
 126
 127 .SH SEE ALSO
 128 .sp
 129 .LP
 130 \fBlibMPAPI\fR(3LIB), \fBattributes\fR(5)
 131 .sp
 132 .LP
 133 \fIMultipath Management API Version 1.0\fR