xref: /illumos-gate/usr/src/man/man3fcoe/FCOE_CreatePort.3fcoe (revision 1edba515a3484e0f74b638b203d462b3112ac84d)
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]
FCOE_CREATEPORT 3FCOE "Apr 1, 2009"
NAME
FCOE_CreatePort - create an FCoE port
SYNOPSIS

cc [ flag... ] file... -lfcoe [ library... ]
#include <libfcoe.h>

int FCOE_CreatePort(const char *macLinkName, int portType,
 struct fcoe_port_wwn pwwn, struct fcoe_port_wwn nwwn,
 int promiscuous);
PARAMETERS
macLinkName

The name of the MAC link on which to create the FCoE port.

portType

This parameter should always be FCOE_PORTTYPE_TARGET.

pwwn

The Port WorldWideName to be used for the FCoE port. Fill the structure with zeros to let the fcoe driver generate a valid Port WWN from the MAC address of the underlying NIC hardware.

nwwn

The Node WorldWideName to be used for the FCoE port. Fill the structure with zeros to let the fcoe driver generate a valid Node WWN from the MAC address of the underlying NIC hardware.

promiscuous

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.

DESCRIPTION

The FCOE_CreatePort() function creates an FCoE port over the specified MAC link.

RETURN VALUES

The following values are returned: FCOE_STATUS_ERROR_BUSY

The fcoe driver is busy and cannot complete the operation.

FCOE_STATUS_ERROR_ALREADY

An existing FCoE port was found over the specified MAC link.

FCOE_STATUS_ERROR_OPEN_DEV

Failed to open fcoe device.

FCOE_STATUS_ERROR_WWN_SAME

The specified Port WWN is same as the specified Node WWN.

FCOE_STATUS_ERROR_MAC_LEN

MAC link name exceeds the maximum length.

FCOE_STATUS_ERROR_PWWN_CONFLICTED

The specified Port WWN is already in use.

FCOE_STATUS_ERROR_NWWN_CONFLICTED

The specified Node WWN is already in use.

FCOE_STATUS_ERROR_NEED_JUMBO_FRAME

The MTU size of the specified MAC link needs to be increased to 2500 or above.

FCOE_STATUS_ERROR_OPEN_MAC

Failed to open the specified MAC link.

FCOE_STATUS_ERROR_CREATE_PORT

Failed to create FCoE port on the specified MAC link.

FCOE_STATUS_OK

The API call was successful.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Committed
MT-Level Safe
SEE ALSO

libfcoe (3LIB), attributes (7)