share/man/man3stmf/stmfOfflineTarget.3stmf

   1 '\" te
   2 .\" Copyright (c) 2008, 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 STMFOFFLINETARGET 3STMF "Jun 9, 2008"
   7 .SH NAME
   8 stmfOfflineTarget \- take offline a target port that is currently in the online
   9 state
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
  14 #include <libstmf.h>
  15
  16 \fBint\fR \fBstmfOfflineTarget\fR(\fBstmfDevid *\fR\fItarget\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fItarget\fR\fR
  24 .ad
  25 .RS 10n
  26 The identifier of the target port to offline.
  27 .RE
  28
  29 .SH DESCRIPTION
  30 .sp
  31 .LP
  32 The \fBstmfOfflineTarget()\fR function takes offline a target port that is
  33 currently in the online state. Once in the offline state, the target port will
  34 no longer be capable of servicing requests in the system.
  35 .sp
  36 .LP
  37 This API call can be used to take offline a target port device for servicing.
  38 Once the target port is offline, it will no longer be available to any entities
  39 outside of the SCSI Target Mode Framework. Any initiator ports that currently
  40 have sessions established by the offlined target port will be logged out.
  41 .SH RETURN VALUES
  42 .sp
  43 .LP
  44 The following values are returned:
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBSTMF_ERROR_BUSY\fR\fR
  49 .ad
  50 .RS 23n
  51 The device is currently busy.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  58 .ad
  59 .RS 23n
  60 The API call was successful.
  61 .RE
  62
  63 .SH ATTRIBUTES
  64 .sp
  65 .LP
  66 See \fBattributes\fR(5) for descriptions of the following attributes:
  67 .sp
  68
  69 .sp
  70 .TS
  71 box;
  72 c | c
  73 l | l .
  74 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  75 _
  76 Interface Stability     Committed
  77 _
  78 MT-Level        Safe
  79 .TE
  80
  81 .SH SEE ALSO
  82 .sp
  83 .LP
  84 \fBlibstmf\fR(3LIB), \fBattributes\fR(5)