usr/src/man/man3fcoe/FCOE_CreatePort.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_CREATEPORT 3FCOE "Apr 1, 2009"
   7 .SH NAME
   8 FCOE_CreatePort \- create 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_CreatePort\fR(\fBconst char *\fR\fImacLinkName\fR, \fBint\fR \fIportType\fR,
  16      \fBstruct fcoe_port_wwn\fR \fIpwwn\fR, \fBstruct fcoe_port_wwn\fR \fInwwn\fR,
  17      \fBint\fR \fIpromiscuous\fR);
  18 .fi
  19
  20 .SH PARAMETERS
  21 .sp
  22 .ne 2
  23 .na
  24 \fB\fImacLinkName\fR\fR
  25 .ad
  26 .RS 15n
  27 The name of the MAC link on which to create the FCoE port.
  28 .RE
  29
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIportType\fR\fR
  34 .ad
  35 .RS 15n
  36 This parameter should always be \fBFCOE_PORTTYPE_TARGET\fR.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fIpwwn\fR\fR
  43 .ad
  44 .RS 15n
  45 The Port WorldWideName to be used for the FCoE port. Fill the structure with
  46 zeros to let the \fBfcoe\fR driver generate a valid Port WWN from the MAC
  47 address of the underlying NIC hardware.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fInwwn\fR\fR
  54 .ad
  55 .RS 15n
  56 The Node WorldWideName to be used for the FCoE port. Fill the structure with
  57 zeros to let the \fBfcoe\fR driver generate a valid Node WWN from the MAC
  58 address of the underlying NIC hardware.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fIpromiscuous\fR\fR
  65 .ad
  66 .RS 15n
  67 A non-zero value to enable promiscuous mode on the underlying NIC hardware. A
  68 value of 0 indicates use of the multiple unicast address feature of the
  69 underlying NIC hardware.
  70 .RE
  71
  72 .SH DESCRIPTION
  73 .sp
  74 .LP
  75 The \fBFCOE_CreatePort()\fR function creates an FCoE port over the specified
  76 MAC link.
  77 .SH RETURN VALUES
  78 .sp
  79 .LP
  80 The following values are returned:
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fBFCOE_STATUS_ERROR_BUSY\fR\fR
  85 .ad
  86 .sp .6
  87 .RS 4n
  88 The \fBfcoe\fR driver is busy and cannot complete the operation.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBFCOE_STATUS_ERROR_ALREADY\fR\fR
  95 .ad
  96 .sp .6
  97 .RS 4n
  98 An existing FCoE port was found over the specified MAC link.
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBFCOE_STATUS_ERROR_OPEN_DEV\fR\fR
 105 .ad
 106 .sp .6
 107 .RS 4n
 108 Failed to open \fBfcoe\fR device.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBFCOE_STATUS_ERROR_WWN_SAME\fR\fR
 115 .ad
 116 .sp .6
 117 .RS 4n
 118 The specified Port WWN is same as the specified Node WWN.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fBFCOE_STATUS_ERROR_MAC_LEN\fR\fR
 125 .ad
 126 .sp .6
 127 .RS 4n
 128 MAC link name exceeds the maximum length.
 129 .RE
 130
 131 .sp
 132 .ne 2
 133 .na
 134 \fB\fBFCOE_STATUS_ERROR_PWWN_CONFLICTED\fR\fR
 135 .ad
 136 .sp .6
 137 .RS 4n
 138 The specified Port WWN is already in use.
 139 .RE
 140
 141 .sp
 142 .ne 2
 143 .na
 144 \fB\fBFCOE_STATUS_ERROR_NWWN_CONFLICTED\fR\fR
 145 .ad
 146 .sp .6
 147 .RS 4n
 148 The specified Node WWN is already in use.
 149 .RE
 150
 151 .sp
 152 .ne 2
 153 .na
 154 \fB\fBFCOE_STATUS_ERROR_NEED_JUMBO_FRAME\fR\fR
 155 .ad
 156 .sp .6
 157 .RS 4n
 158 The MTU size of the specified MAC link needs to be increased to 2500 or above.
 159 .RE
 160
 161 .sp
 162 .ne 2
 163 .na
 164 \fB\fBFCOE_STATUS_ERROR_OPEN_MAC\fR\fR
 165 .ad
 166 .sp .6
 167 .RS 4n
 168 Failed to open the specified MAC link.
 169 .RE
 170
 171 .sp
 172 .ne 2
 173 .na
 174 \fB\fBFCOE_STATUS_ERROR_CREATE_PORT\fR\fR
 175 .ad
 176 .sp .6
 177 .RS 4n
 178 Failed to create FCoE port on the specified MAC link.
 179 .RE
 180
 181 .sp
 182 .ne 2
 183 .na
 184 \fB\fBFCOE_STATUS_OK\fR\fR
 185 .ad
 186 .sp .6
 187 .RS 4n
 188 The API call was successful.
 189 .RE
 190
 191 .SH ATTRIBUTES
 192 .sp
 193 .LP
 194 See \fBattributes\fR(5) for descriptions of the following attributes:
 195 .sp
 196
 197 .sp
 198 .TS
 199 box;
 200 c | c
 201 l | l .
 202 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 203 _
 204 Interface Stability     Committed
 205 _
 206 MT-Level        Safe
 207 .TE
 208
 209 .SH SEE ALSO
 210 .sp
 211 .LP
 212 \fBlibfcoe\fR(3LIB), \fBattributes\fR(5)