usr/src/man/man3mpapi/MP_SetTPGAccess.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_SETTPGACCESS 3MPAPI "Feb 15, 2006"
   8 .SH NAME
   9 MP_SetTPGAccess \- set a target port group access state
  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_SetTPGAccess\fR(\fBMP_OID\fR \fIluOid\fR, \fBMP_UINT32\fR \fIcount\fR,
  17      \fBMP_TPG_STATE_PAIR\fR \fI*pTpgStateList\fR);
  18 .fi
  19
  20 .SH PARAMETERS
  21 .sp
  22 .ne 2
  23 .na
  24 \fB\fIluOid\fR\fR
  25 .ad
  26 .RS 17n
  27 An object ID that has type \fBMP_MULTIPATH_LOGICAL_UNIT\fR.
  28 .RE
  29
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIcount\fR\fR
  34 .ad
  35 .RS 17n
  36 The number of valid items in the \fIpTpgStateList\fR.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fIpTpgStateList\fR\fR
  43 .ad
  44 .RS 17n
  45 A pointer to an array of data structure \fBMP_TPG_STATE_PAIR\fR. This array
  46 must contain the same number of elements as \fIcount\fR.
  47 .RE
  48
  49 .SH DESCRIPTION
  50 .sp
  51 .LP
  52 The \fBMP_SetTPGAccess()\fR function sets the access state for a list of target
  53 port groups. This allows a client to force a failover or failback to a desired
  54 set of target port groups. This is only valid for devices that support explicit
  55 access state manipulation (i.e., the field \fIexplicitFailover\fR of data
  56 structure \fBMP_TARGET_PORT_GROUP_PROPERTIES\fR must be true).
  57 .sp
  58 .LP
  59 This API provides the information needed to set up a  \fBSCSI SET TARGET PORT
  60 GROUPS\fR command.
  61 .sp
  62 .LP
  63 The plugin should not implement this API by directly calling the \fBSCSI SET
  64 TARGET PORT GROUPS\fR command. The plugin should use the MP drivers API (for
  65 example, \fBioctl\fR) if available.
  66 .sp
  67 .LP
  68 There are two reasons why this API is restricted to devices supporting explicit
  69 failover commands. Without an explicit command, the behavior of failback tends
  70 to be device-specific.
  71 .sp
  72 .LP
  73 When the caller is finished using the list it must free the memory used by the
  74 list by calling         \fBMP_FreeOidList\fR.
  75 .SH RETURN VALUES
  76 .sp
  77 .ne 2
  78 .na
  79 \fB\fBMP_STATUS_ACCESS_STATE_INVALID\fR\fR
  80 .ad
  81 .sp .6
  82 .RS 4n
  83 The target device returns a status indicating the caller is attempting to
  84 establish an illegal combination of access states.
  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 underlying interface failed the command for some reason other than
  95 \fBMP_STATUS_ACCESS_STATE_INVALID\fR.
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
 102 .ad
 103 .sp .6
 104 .RS 4n
 105 The \fIluOid\fR does not specify any valid object type. This is most likely to
 106 happen if an uninitialized object ID is passed to the API.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
 113 .ad
 114 .sp .6
 115 .RS 4n
 116 The \fIluOid\fR owner ID or object sequence number is invalid.
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
 123 .ad
 124 .sp .6
 125 .RS 4n
 126 The \fIpTpgStateList\fR is null, or when one of the TPGs referenced in the list
 127 is not associated with the specified MP logical unit, or the \fIluOid\fR has a
 128 type subfield other than \fBMP_OBJECT_TYPE_MULTIPATH_LU\fR.
 129 .RE
 130
 131 .sp
 132 .ne 2
 133 .na
 134 \fB\fBMP_STATUS_SUCCESS\fR\fR
 135 .ad
 136 .sp .6
 137 .RS 4n
 138 The operation is successful.
 139 .RE
 140
 141 .sp
 142 .ne 2
 143 .na
 144 \fB\fBMP_STATUS_UNSUPPORTED\fR\fR
 145 .ad
 146 .sp .6
 147 .RS 4n
 148 The API is not supported.
 149 .RE
 150
 151 .SH ATTRIBUTES
 152 .sp
 153 .LP
 154 See \fBattributes\fR(5) for descriptions of the following attributes:
 155 .sp
 156
 157 .sp
 158 .TS
 159 box;
 160 c | c
 161 l | l .
 162 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 163 _
 164 Interface Stability     T{
 165 Standard: ANSI INCITS 412 Multipath Management API
 166 T}
 167 _
 168 MT-Level        Safe
 169 .TE
 170
 171 .SH SEE ALSO
 172 .sp
 173 .LP
 174 \fBlibMPAPI\fR(3LIB), \fBattributes\fR(5)
 175 .sp
 176 .LP
 177 \fIMultipath Management API Version 1.0\fR