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