xref: /illumos-gate/usr/src/man/man3mpapi/Sun_MP_SendScsiCmd.3mpapi (revision ceab728f83b0af9260d2d3fb69014f3781af2101)
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]
SUN_MP_SENDSCSICMD 3MPAPI "June 13, 2021"
NAME
Sun_MP_SendScsiCmd - send a SCSI command to a logical unit
SYNOPSIS
cc [ flag.\|.\|. ] file.\|.\|. -lMPAPI [ library.\|.\|. ]
#include <mpapi.h>
#include <mpapi-sun.h>

MP_STATUS MP_SendScsiCmd(MP_OID oid, struct uscsi_cmd *cmd);
PARAMETERS
oid

The object ID of the logical unit path.

cmd

A uscsi_cmd structure. See uscsi(7I).

DESCRIPTION
The Sun_MP_SendScsiCmd() function sends a SCSI command on a specific path to a logical unit. This function is applicable only to an OID whose MP_PLUGIN_PROPERTIES driverVendor, as defined by the Multipath Management API, is equal to "Sun Microsystems". See MP_GetPluginProperties(3MPAPI) and Multipath Management API Version 1.0.
RETURN VALUES
MP_STATUS_INVALID_PARAMETER

The pProps is null or specifies a memory area to which data cannot be written, or the oid has a type subfield other than MP_OBJECT_TYPE_PLUGIN.

MP_STATUS_INVALID_OBJECT_TYPE

The oid does not specify any valid object type. This is most likely to happen if an uninitialized object ID is passed to the API.

MP_STATUS_OBJECT_NOT_FOUND

The oid owner ID or object sequence number is invalid.

MP_STATUS_SUCCESS

The operation is successful.

WARNINGS
The uscsi command is very powerful but somewhat dangerous. See the WARNINGS section of uscsi(7I) before using this interface.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level Safe
SEE ALSO
libMPAPI(3LIB), MP_GetPluginProperties(3MPAPI), attributes(5), uscsi(7I)

Multipath Management API Version 1.0