usr/src/man/man3fcoe/FCOE_DeletePort.3fcoe

   1 '\" te
   2 .\" Copyright (c) 2009, 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  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
   5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH FCOE_DELETEPORT 3FCOE "Apr 1, 2009"
   7 .SH NAME
   8 FCOE_DeletePort \- delete an FCoE port
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... -lfcoe [ \fIlibrary\fR... ]
  13 #include <libfcoe.h>
  14
  15 \fBint\fR \fBFCOE_DeletePort\fR(\fBconst char *\fR\fImacLinkName\fR);
  16 .fi
  17
  18 .SH PARAMETERS
  19 .sp
  20 .ne 2
  21 .na
  22 \fB\fImacLinkName\fR\fR
  23 .ad
  24 .RS 15n
  25 The name of the MAC link from which to delete the FCoE port.
  26 .RE
  27
  28 .SH DESCRIPTION
  29 .sp
  30 .LP
  31 The \fBFCOE_DeletePort()\fR function deletes an FCoE port from the specified
  32 MAC link.
  33 .SH RETURN VALUES
  34 .sp
  35 .LP
  36 The following values are returned:
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fBFCOE_STATUS_ERROR_BUSY\fR\fR
  41 .ad
  42 .sp .6
  43 .RS 4n
  44 The \fBfcoe\fR driver is busy and cannot complete the operation.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fBFCOE_STATUS_ERROR_MAC_LEN\fR\fR
  51 .ad
  52 .sp .6
  53 .RS 4n
  54 The MAC link name exceeds the maximum length.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBFCOE_STATUS_MAC_NOT_FOUND\fR\fR
  61 .ad
  62 .sp .6
  63 .RS 4n
  64 The FCoE port was not found on the specified MAC link.
  65 .RE
  66
  67 .sp
  68 .ne 2
  69 .na
  70 \fB\fBFCOE_STATUS_OK\fR\fR
  71 .ad
  72 .sp .6
  73 .RS 4n
  74 The API call was successful.
  75 .RE
  76
  77 .SH ATTRIBUTES
  78 .sp
  79 .LP
  80 See \fBattributes\fR(5) for descriptions of the following attributes:
  81 .sp
  82
  83 .sp
  84 .TS
  85 box;
  86 c | c
  87 l | l .
  88 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  89 _
  90 Interface Stability     Committed
  91 _
  92 MT-Level        Safe
  93 .TE
  94
  95 .SH SEE ALSO
  96 .sp
  97 .LP
  98 \fBlibfcoe\fR(3LIB), \fBattributes\fR(5)