Current File : //usr/man/man3fcoe/FCOE_CreatePort.3fcoe

'\" te
.\" Copyright (c) 2008, 2013, Oracle and/or its affiliates. All rights reserved. 
.TH FCOE_CreatePort 3FCOE "1 Apr 2009" "SunOS 5.11" "FCoE Port Management Library Functions"
.SH NAME
FCOE_CreatePort \- create an FCoE port
.SH SYNOPSIS
.LP
.nf
cc [ \fIflag\fR... ] \fIfile\fR... -lfcoe [ \fIlibrary\fR... ]
#include <libfcoe.h>
.fi

.LP
.nf
\fBFCOE_STATUS\fR \fBFCOE_CreatePort\fR(\fBconst FCOE_UINT8 *\fR\fImacLinkName\fR, \fBFCOE_UINT8\fR \fIportType\fR, 
\fBFCOE_PORT_WWN\fR \fIpwwn\fR, \fBFCOE_PORT_WWN\fR \fInwwn\fR, \fBFCOE_UINT8\fR \fIpromiscuous\fR);
.fi

.SH PARAMETERS
.sp
.ne 2
.mk
.na
\fB\fImacLinkName\fR\fR
.ad
.RS 15n
.rt  
The name of the MAC link on which to create the FCoE port.
.RE

.sp
.ne 2
.mk
.na
\fB\fIportType\fR\fR
.ad
.RS 15n
.rt  
This parameter should always be \fBFCOE_PORTTYPE_INITIATOR\fR or \fBFCOE_PORTTYPE_TARGET\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fIpwwn\fR\fR
.ad
.RS 15n
.rt  
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
.mk
.na
\fB\fInwwn\fR\fR
.ad
.RS 15n
.rt  
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
.mk
.na
\fB\fIpromiscuous\fR\fR
.ad
.RS 15n
.rt  
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
.mk
.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
.mk
.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
.mk
.na
\fB\fBFCOE_STATUS_ERROR_OPEN_DEV\fR\fR
.ad
.sp .6
.RS 4n
Failed to open \fBfcoe\fR device.
.RE

.sp
.ne 2
.mk
.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
.mk
.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
.mk
.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
.mk
.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
.mk
.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
.mk
.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
.mk
.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
.mk
.na
\fB\fBFCOE_STATUS_ERROR_GET_LINKINFO\fR\fR
.ad
.sp .6
.RS 4n
Failed to get link information by \fBmacLinkName\fR.
.RE

.sp
.ne 2
.mk
.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
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityCommitted
_
MT-LevelSafe
.TE

.SH SEE ALSO
.sp
.LP
\fBlibfcoe\fR(3LIB), \fBattributes\fR(5)