opensolaris man page for stmfofflinelogicalunit

stmfOfflineLogicalUnit(3STMF)			   SCSI Target Mode Framework Library Functions 		     stmfOfflineLogicalUnit(3STMF)

NAME
       stmfOfflineLogicalUnit - take offline a logical unit that is currently in the online state

SYNOPSIS
       cc [ flag... ] file... -lstmf [ library... ]
       #include <libstmf.h>

       int stmfOfflineLogicalUnit(stmfGuid *logicalUnit);

PARAMETERS
       logicalUnit    The identifier of the logical unit to offline.

DESCRIPTION
       The  stmfOfflineLogicalUnit()  function	takes offline a logical unit that is currently in the online state. Once in the offline state, the
       logical unit will no longer be capable of servicing requests in the system.

       This API call can be used to take offline a logical unit for servicing. Once the logical unit is offline, an initiator port  that  attempts
       to  issue any SCSI commands to the offlined logical unit will receive a check condition. For purposes of the REPORT LUNS command, the logi-
       cal unit will no longer appear in the logical unit inventory for any initiator ports to which it is currently mapped by one  or	more  view
       entries.

RETURN VALUES
       The following values are returned:

       STMF_ERROR_BUSY	      The device is currently busy.

       STMF_STATUS_SUCCESS    The API call was successful.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Committed 		   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       libstmf(3LIB), attributes(5)

SunOS 5.11							    9 Jun 2008					     stmfOfflineLogicalUnit(3STMF)