'\" te
.\" Copyright (c) 2006, Sun Microsystems, Inc.  All Rights Reserved.
.\" 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.
.\" 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.
.\" 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]
.TH Sun_MP_SendScsiCmd 3MPAPI "12 Dec 2006" "SunOS 5.11" "Common Multipath Management Library Functions"
.SH NAME
Sun_MP_SendScsiCmd \- send a SCSI command to a logical unit
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR\&.\|.\|. ] \fIfile\fR\&.\|.\|. \fB-lMPAPI\fR [ \fIlibrary\fR\&.\|.\|. ] 
#include <mpapi.h>
#include <mpapi_sun.h>

\fBMP_STATUS\fR \fBMP_SendScsiCmd\fR(\fBMP_OID\fR \fIoid\fR, \fBstruct uscsi_cmd *\fR\fIcmd\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fIoid\fR\fR
.ad
.RS 7n
.rt  
The object ID of the logical unit path.
.RE

.sp
.ne 2
.mk
.na
\fB\fIcmd\fR\fR
.ad
.RS 7n
.rt  
A \fBuscsi_cmd\fR structure. See \fBuscsi\fR(7I).
.RE

.SH DESCRIPTION
.sp
.LP
The \fBSun_MP_SendScsiCmd()\fR function sends a SCSI command on a specific path
to a logical unit. This function is applicable only to an OID whose
\fBMP_PLUGIN_PROPERTIES\fR \fIdriverVendor\fR, as defined by the Multipath
Management API, is equal to "Sun Microsystems". See
\fBMP_GetPluginProperties\fR(3MPAPI) and \fIMultipath Management API Version
1.0\fR.
.SH RETURN VALUES
.sp
.ne 2
.mk
.na
\fB\fBMP_STATUS_INVALID_PARAMETER\fR\fR
.ad
.sp .6
.RS 4n
The \fIpProps\fR is null or specifies a memory area  to  which data  cannot  be
written, or the \fIoid\fR has a type subfield other than
\fBMP_OBJECT_TYPE_PLUGIN.\fR
.RE

.sp
.ne 2
.mk
.na
\fB\fBMP_STATUS_INVALID_OBJECT_TYPE\fR\fR
.ad
.sp .6
.RS 4n
The \fIoid\fR does not specify any valid object type. This  is most  likely  to
happen if an uninitialized object ID is passed to the API.
.RE

.sp
.ne 2
.mk
.na
\fB\fBMP_STATUS_OBJECT_NOT_FOUND\fR\fR
.ad
.sp .6
.RS 4n
The \fIoid\fR owner ID or object sequence number is invalid.
.RE

.sp
.ne 2
.mk
.na
\fB\fBMP_STATUS_SUCCESS\fR\fR
.ad
.sp .6
.RS 4n
The operation is successful.
.RE

.SH WARNINGS
.sp
.LP
The \fBuscsi\fR command is very powerful but somewhat dangerous. See the
WARNINGS section on \fBattributes\fR(5) before using this interface.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelSafe
.TE

.SH SEE ALSO
.sp
.LP
\fBlibMPAPI\fR(3LIB), \fBMP_GetPluginProperties\fR(3MPAPI),
\fBattributes\fR(5), \fBuscsi\fR(7I)
.sp
.LP
\fIMultipath Management API Version 1.0\fR