usr/src/man/man3stmf/stmfRemoveFromHostGroup.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 STMFREMOVEFROMHOSTGROUP 3STMF "Jun 9, 2008"
   7 .SH NAME
   8 stmfRemoveFromHostGroup \- remove an initiator port from an host group
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lstmf\fR [ \fIlibrary\fR... ]
  13 #include <libstmf.h>
  14
  15 \fBint\fR \fBstmfRemoveFromHostGroup\fR(\fBstmfGroupName *\fR\fIhostGroupName\fR
  16      \fBstmfDevid *\fR\fIinitiatorPortName\fR);
  17 .fi
  18
  19 .SH PARAMETERS
  20 .sp
  21 .ne 2
  22 .na
  23 \fB\fIhostGroupName\fR\fR
  24 .ad
  25 .RS 21n
  26 The name of the host group from which the specified \fIhostGroupName\fR is
  27 being removed.
  28 .RE
  29
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIinitiatorPortName\fR\fR
  34 .ad
  35 .RS 21n
  36 The device identifier of the initiator port to remove from the specified host
  37 group.
  38 .RE
  39
  40 .SH DESCRIPTION
  41 .sp
  42 .LP
  43 The \fBstmfRemoveFromHostGroup()\fR function removes an initiator port from an
  44 host group.
  45 .SH RETURN VALUES
  46 .sp
  47 .LP
  48 The following values are returned:
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fBSTMF_ERROR_GROUP_NOT_FOUND\fR\fR
  53 .ad
  54 .sp .6
  55 .RS 4n
  56 The specified \fIhostGroupName\fR was not found in the system.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fBSTMF_ERROR_MEMBER_NOT_FOUND\fR\fR
  63 .ad
  64 .sp .6
  65 .RS 4n
  66 The specified \fIinitiatorPortName\fR was not found in the system.
  67 .RE
  68
  69 .sp
  70 .ne 2
  71 .na
  72 \fB\fBSTMF_STATUS_SUCCESS\fR\fR
  73 .ad
  74 .sp .6
  75 .RS 4n
  76 The API call was successful.
  77 .RE
  78
  79 .SH ATTRIBUTES
  80 .sp
  81 .LP
  82 See \fBattributes\fR(5) for descriptions of the following attributes:
  83 .sp
  84
  85 .sp
  86 .TS
  87 box;
  88 c | c
  89 l | l .
  90 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  91 _
  92 Interface Stability     Committed
  93 _
  94 MT-Level        Safe
  95 .TE
  96
  97 .SH SEE ALSO
  98 .sp
  99 .LP
 100 \fBlibstmf\fR(3LIB), \fBattributes\fR(5)