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

   1 '\" te
   2 .\" Copyright (c) 2006, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH SUN_MP_SENDSCSICMD 3MPAPI "Dec 12, 2006"
   7 .SH NAME
   8 Sun_MP_SendScsiCmd \- send a SCSI command to a logical unit
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ]
  13 #include <mpapi.h>
  14 #include <mpapi_sun.h>
  15
  16 \fBMP_STATUS\fR \fBMP_SendScsiCmd\fR(\fBMP_OID\fR \fIoid\fR, \fBstruct uscsi_cmd *\fR\fIcmd\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fIoid\fR\fR
  24 .ad
  25 .RS 7n
  26 The object ID of the logical unit path.
  27 .RE
  28
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIcmd\fR\fR
  33 .ad
  34 .RS 7n
  35 A \fBuscsi_cmd\fR structure. See \fBuscsi\fR(7I).
  36 .RE
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 The \fBSun_MP_SendScsiCmd()\fR function sends a SCSI command on a specific path
  42 to a logical unit. This function is applicable only to an OID whose
  43 \fBMP_PLUGIN_PROPERTIES\fR \fIdriverVendor\fR, as defined by the Multipath
  44 Management API, is equal to "Sun Microsystems". See
  45 \fBMP_GetPluginProperties\fR(3MPAPI) and \fIMultipath Management API Version
  46 1.0\fR.
  47 .SH RETURN VALUES
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
  52 .ad
  53 .sp .6
  54 .RS 4n
  55 The \fIpProps\fR is null or specifies a memory area  to  which data  cannot  be
  56 written, or the \fIoid\fR has a type subfield other than
  57 \fBMP_OBJECT_TYPE_PLUGIN.\fR
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
  64 .ad
  65 .sp .6
  66 .RS 4n
  67 The \fIoid\fR does not specify any valid object type. This  is most  likely  to
  68 happen if an uninitialized object ID is passed to the API.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
  75 .ad
  76 .sp .6
  77 .RS 4n
  78 The \fIoid\fR owner ID or object sequence number is invalid.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBMP_STATUS_SUCCESS\fR\fR
  85 .ad
  86 .sp .6
  87 .RS 4n
  88 The operation is successful.
  89 .RE
  90
  91 .SH WARNINGS
  92 .sp
  93 .LP
  94 The \fBuscsi\fR command is very powerful but somewhat dangerous. See the
  95 WARNINGS section on \fBattributes\fR(5) before using this interface.
  96 .SH ATTRIBUTES
  97 .sp
  98 .LP
  99 See \fBattributes\fR(5) for descriptions of the following attributes:
 100 .sp
 101
 102 .sp
 103 .TS
 104 box;
 105 c | c
 106 l | l .
 107 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 108 _
 109 Interface Stability     Committed
 110 _
 111 MT-Level        Safe
 112 .TE
 113
 114 .SH SEE ALSO
 115 .sp
 116 .LP
 117 \fBlibMPAPI\fR(3LIB), \fBMP_GetPluginProperties\fR(3MPAPI),
 118 \fBattributes\fR(5), \fBuscsi\fR(7I)
 119 .sp
 120 .LP
 121 \fIMultipath Management API Version 1.0\fR