Hallo, dies ist ein Test.

PWD: /www/data-lst1/unixsoft/unixsoft/kaempfer/.public_html

Running in File Mode
Relative path: ././../../../../../../usr/man/man3ima/IMA_LuReportLuns.3ima
Real path: /usr/share/man/man3ima/IMA_LuReportLuns.3ima
Zurück

'\" te
.\" Copyright (c) 2016, 2020, Oracle and/or its affiliates.
.TH IMA_LuReportLuns 3IMA "26 July 2016" "Oracle Solaris 11.4" "iSCSI Management API"
.SH NAME
IMA_LuReportLuns \- Gets the SCSI REPORT LUNS data for the specified logical unit
.SH SYNOPSIS

.LP
.nf
cc [ flag... ] file... -lima [ library... ]
#include <ima.h>

IMA_STATUS IMA_LuReportLuns(
    /* in */      IMA_OID deviceOid,
    /* in */      IMA_BOOL sendToWellKnownLu,
    /* in */      IMA_BYTE selectReport,
    /* out */     IMA_BYTE *pOutputBuffer,
    /* in, out */ IMA_UINT *pOutputBufferLength,
    /* out */     IMA_BYTE *pSenseBuffer,
    /* in, out */ IMA_UINT *pSenseBufferLength
);
.fi
.SH PARAMETERS

.sp
.ne 2
.mk
.na
\fB\fIdeviceOid\fR\fR
.ad
.br
.sp .6
.RS 4n
The object ID of the target or logical unit (LU) whose \fBSCSI REPORT LUNS\fR data is retrieved. If the object ID identifies a target, then the \fBREPORT LUNS\fR command will be sent to either \fBLUN 0\fR, or to the \fBwell known REPORT LUNS\fR LUN of the target, depending upon the value of the \fIwellKnownLun\fR argument.
.RE

.sp
.ne 2
.mk
.na
\fB\fIsendToWellKnownLu\fR\fR
.ad
.br
.sp .6
.RS 4n
If the \fIoid\fR argument specifies a target, then the \fIsendToWellKnownLu\fR argument indicates whether the \fBREPORT LUNS\fR command is sent to the \fBwell known REPORT LUNS\fR LU, or to the LU at \fBLUN 0\fR.
.sp
.RS +4
.TP
.ie t \(bu
.el o
If the \fIoid\fR argument specifies a target, and the \fIsendToWellKnownLu\fR argument has the value, \fBIMA_TRUE\fR, then the \fBREPORT LUNS\fR command will be sent to the \fBwell known REPORT LUNS\fR LU of the target.

.RE
.RS +4
.TP
.ie t \(bu
.el o
If the \fIoid\fR argument specifies a target and the \fIsendToWellKnownLu\fR argument has the value, \fBIMA_FALSE\fR, then the \fBREPORT LUNS\fR command will be sent to \fBLUN 0\fR of the target.

.RE
.RS +4
.TP
.ie t \(bu
.el o
If the \fIoid\fR argument specifies an LU, then the \fBREPORT LUNS\fR command is sent to the specified LU, and the value of the \fIsendToWellKnownLu\fR argument is ignored.

.RE
See section 9 of ANSI INCITS 408-2005 for more information regarding well known LUs.
.RE

.sp
.ne 2
.mk
.na
\fB\fIselectReport\fR\fR
.ad
.br
.sp .6
.RS 4n
The select report value as defined for the \fBREPORT LUNS\fR command. See the T10 document ANSI INCITS 408-2005 or your device's SCSI interface documentation for more information on the values this field can contain. 
.RE

.sp
.ne 2
.mk
.na
\fB\fIpOutputBuffer\fR\fR
.ad
.br
.sp .6
.RS 4n
A pointer to the memory location, that, on successful completion contains the data returned by the logical unit.
.RE

.sp
.ne 2
.mk
.na
\fB\fIpOutputBufferLength\fR\fR
.ad
.br
.sp .6
.RS 4n
A pointer to the output buffer length. On entry to the function, this argument points to a variable containing the maximum length, in bytes, of the \fIpOutputBuffer\fR argument. If returned successfully, the \fIpOutputBufferLength\fR argument contains the number of bytes that were actually returned in the \fIpOutputBuffer\fR argument. In case of failure, this value remains the same as on entry.
.RE

.sp
.ne 2
.mk
.na
\fB\fIpSenseBuffer\fR\fR
.ad
.br
.sp .6
.RS 4n
A pointer to a memory location, that, if the \fBREPORT LUNS\fR command fails with a \fBCHECK CONDITION\fR status, contains the sense data received from the logical unit. If the \fIpSenseBuffer\fR argument is \fBNULL\fR, then no sense data is transferred to the client if the \fBREPORT LUNS\fR command fails with a \fBCHECK CONDITION\fR status.
.RE

.sp
.ne 2
.mk
.na
\fB\fIpSenseBufferLength\fR\fR
.ad
.br
.sp .6
.RS 4n
A pointer to the sense buffer length. On entry to the function, this argument points to a variable containing the maximum length, in bytes, of the \fIpSenseBuffer\fR argument. If the API returns the value, \fBIMA_ERROR_SCSI_STATUS_CHECK_CONDITION\fR, then, on exit this argument contains the number of sense data bytes returned in the \fIpSenseBuffer\fR argument. If the \fIpSenseBuffer\fR argument is \fBNULL\fR, then the value of the \fIpSenseBufferLength\fR argument is 0. If any other value is returned by the API, then, on exit this value remains the same as on entry.
.RE

.SH DESCRIPTION
.sp
.LP
The \fBIMA_LuReportLuns()\fR API gets the \fBSCSI REPORT LUNS\fR data for the specified logical unit.
.SH RETURN VALUES

.sp
.ne 2
.mk
.na
\fB\fBIMA_ERROR_NOT_SUPPORTED\fR\fR
.ad
.br
.sp .6
.RS 4n
Returned if the \fIdeviceOid\fR argument specifies a target, and the \fIsendToWellKnownLu\fR argument has the value, \fBIMA_TRUE\fR, and sending the \fBREPORT LUNS\fR command to the \fBwell known REPORT LUNS\fR LUN is not supported.
.RE

.sp
.ne 2
.mk
.na
\fB\fBIMA_ERROR_INVALID_PARAMETER\fR\fR
.ad
.br
.sp .6
.RS 4n
.RS +4
.TP
.ie t \(bu
.el o
Returned if the \fIpOutputBuffer\fR argument is \fBNULL\fR, or specifies a memory area to which the \fIpOutputBufferLength\fR argument bytes cannot be written.

.RE
.RS +4
.TP
.ie t \(bu
.el o
Returned if the \fIpOutputBufferLength\fR argument is \fBNULL\fR, or specifies a memory which cannot be written.

.RE
.RS +4
.TP
.ie t \(bu
.el o
Returned if the \fIpOutputBufferLength\fR argument is 0.

.RE
.RS +4
.TP
.ie t \(bu
.el o
Returned if the \fIpSenseBufferLength\fR argument is greater than zero and the \fIpSenseBuffer\fR argument specifies a memory area to which the \fIpSenseBufferLength\fR argument bytes cannot be written.

.RE
.RS +4
.TP
.ie t \(bu
.el o
Returned if the \fIsendToWellKnownLu\fR argument has a value other than the value, \fBIMA_TRUE\fR and the value, \fBIMA_FALSE\fR.

.RE
.RE

.sp
.ne 2
.mk
.na
\fB\fBIMA_ERROR_INVALID_OBJECT_TYPE\fR\fR
.ad
.br
.sp .6
.RS 4n
Returned if the \fIdeviceOid\fR argument does not specify a valid object type.
.RE

.sp
.ne 2
.mk
.na
\fB\fBIMA_ERROR_INCORRECT_OBJECT_TYPE\fR\fR
.ad
.br
.sp .6
.RS 4n
Returned if the \fIdeviceOid\fR argument does not specify an LU object.
.RE

.sp
.ne 2
.mk
.na
\fB\fBIMA_ERROR_OBJECT_NOT_FOUND\fR\fR
.ad
.br
.sp .6
.RS 4n
Returned if the \fIdeviceOid\fR argumentdoes not specify an LU known to the system.
.RE

.sp
.ne 2
.mk
.na
\fB\fBIMA_ERROR_SCSI_STATUS_CHECK_CONDITION\fR\fR
.ad
.br
.sp .6
.RS 4n
Returned if the SCSI \fBREPORT LUNS\fR command fails with a \fBCHECK CONDITION\fR status. If this value is returned, then if the \fIpSenseBuffer\fR argument is not \fBNULL\fR, it contains the sense data returned by the logical unit.
.RE

.sp
.ne 2
.mk
.na
\fB\fBIMA_ERROR_TARGET_TIMEOUT\fR\fR
.ad
.br
.sp .6
.RS 4n
Returned if the target associated with the specified LU failed to respond to an iSCSI login request from an initiator.
.RE

.sp
.ne 2
.mk
.na
\fB\fBIMA_ERROR_LOGIN_REJECTED\fR\fR
.ad
.br
.sp .6
.RS 4n
Returned if the target associated with the specified LU rejected an iSCSI login request from an initiator.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp
.TS
tab(
) box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPE
ATTRIBUTE VALUE
_
Availability
\fBsystem/library/storage/snia-ima\fR
_
Interface Stability
Volatile
_
MT-Level
Safe
.TE
.sp
.SH SEE ALSO
.sp
.LP
\fBlibima\fR(3LIB), \fBattributes\fR(7), \fBIMA_LuInquiry\fR(3IMA), \fBIMA_LuReadCapacity\fR(3IMA)