usr/src/man/man3mpapi/MP_AssignLogicalUnitToTPG.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_ASSIGNLOGICALUNITTOTPG 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_AssignLogicalUnitToTPG \- assign a multipath logical unit to a target port
  10 group
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
  15 #include <mpapi.h>
  16
  17 \fBMP_STATUS\fR \fBMP_AssignLogicalUnitToTPG\fR(\fBMP_OID\fR \fItpgOid\fR, \fBMP_OID\fR \fIluOid\fR);
  18 .fi
  19
  20 .SH PARAMETERS
  21 .sp
  22 .ne 2
  23 .na
  24 \fB\fItpgOid\fR\fR
  25 .ad
  26 .RS 10n
  27 An object ID that has type \fBMP_TARGET_PORT_GROUP\fR. The target port group
  28 currently in active access state that the administrator would like the LU
  29 assigned to.
  30 .RE
  31
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fIluOid\fR\fR
  36 .ad
  37 .RS 10n
  38 An object ID that has type \fBMP_MULTIPATH_LOGICAL_UNIT\fR.
  39 .RE
  40
  41 .SH DESCRIPTION
  42 .sp
  43 .LP
  44 The \fBMP_AssignLogicalUnitToTPG()\fR function assigns a multipath logical unit
  45 to a target port group.
  46 .sp
  47 .LP
  48 Calling this function is valid only if the field \fBsupportsLuAssignment\fR in
  49 the data structure \fBTARGET_PORT_GROUP_PROPERTIES\fR is true. This capability
  50 is not defined in SCSI standards. In some cases, devices support this
  51 capability through non-SCSI interfaces (such as SMI-S or SNMP). This method is
  52 only used when devices support this capability through vendor-specific means.
  53 .sp
  54 .LP
  55 At any given time, each LU will typically be associated with two target port
  56 groups, one in active state and one in standby state. The result of this API
  57 will be that the LU associations change to a different pair of target port
  58 groups. The caller should specify the object ID of the desired target port
  59 group in active access state.
  60 .SH RETURN VALUES
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  65 .ad
  66 .sp .6
  67 .RS 4n
  68 The \fItpgOid\fR or \fIluOid\fR parameter does not specify any valid object
  69 type. This is most likely to happen if an uninitialized object ID is passed to
  70 the API.
  71 .RE
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  77 .ad
  78 .sp .6
  79 .RS 4n
  80 The \fItpgOid\fR parameter has a type subfield other than
  81 \fBMP_OBJECT_TYPE_TARGET_PORT_GROUP\fR or \fIluOid\fR has a type subfield other
  82 than \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
  89 .ad
  90 .sp .6
  91 .RS 4n
  92 The \fItpgOid\fR or \fIluOid\fR owner ID or object sequence number is invalid.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fBMP_STATUS_UNSUPPORTED\fR\fR
  99 .ad
 100 .sp .6
 101 .RS 4n
 102 The API is not supported.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBMP_STATUS_SUCCESS\fR\fR
 109 .ad
 110 .sp .6
 111 .RS 4n
 112 The operation is successful.
 113 .RE
 114
 115 .SH ATTRIBUTES
 116 .sp
 117 .LP
 118 See \fBattributes\fR(5) for descriptions of the following attributes:
 119 .sp
 120
 121 .sp
 122 .TS
 123 box;
 124 c | c
 125 l | l .
 126 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 127 _
 128 Interface Stability     T{
 129 Standard: ANSI INCITS 412 Multipath Management API
 130 T}
 131 _
 132 MT-Level        Safe
 133 .TE
 134
 135 .SH SEE ALSO
 136 .sp
 137 .LP
 138 \fBlibMPAPI\fR(3LIB), \fBMP_GetAssociatedTPGOidList\fR(3MPAPI),
 139 \fBMP_GetMPLuOidListFromTPG\fR(3MPAPI), \fBattributes\fR(5)