man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: July 2014
 
 

FCOE_GetPortProp(3FCOE)

Name

FCOE_GetPortProp - get an FCoE port property

Synopsis

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


FCOE_STATUS FCOE_GetPortProp(
FCOE_PORT_HANDLE handle, FCOE_UINT32
 prop, FCOE_INT8 *
propVal FCOE_UINT32 *propLen);

Parameters

handle

An FCoE port handle previously allocated by FCOE_GetPortHandle(3FCOE) with FCOE_RT_PORT_PROPERTY resource type.

prop

A property type value. See DESCRIPTION for valid values.

propVal

A property value.

propLen

The length of the specified property value. If propLen was of an insufficient size to hold the returned property value, propLen will contain the required size of the buffer and FCOE_STATUS_ERROR_INVAL_ARG will be returned.

Description

The FCOE_GetPortProp() function get a property value of an FCoE port that has been created. All property values are expressed in human-readable form. Boolean properties are expressed in case insensitive form of true or false. Properties that are represented by ASCII hexadecimal contain no leading characters to indicate a base hexadecimal representation (that is, no leading "0x"). The prop argument can be one of the following values:

FCOE_PP_PWWN

ASCII hexadecimal string of 16 characters representing the Port World Wide Name for the FCoE port.

FCOE_PP_PORT_MODE

Port Mode for the FCoE port, set to either "initiator" or "target".

FCOE_PP_PORT_FCID

Up to 6 hexadecimal ASCII characters representing the unique FCID for the FCoE port.

FCOE_PP_MAC_VLAN_ID

Up to 4 hexadecimal ASCII characters representing the VLAN ID.

FCOE_PP_MAC_LINK_NAME

Up to 32 characters representing the datalink name of a network device in use by the FCoE port.

FCOE_PP_MAC_MTU_SIZE

Up to 8 hexadecimal ASCII characters representing the maximum transmission unit size of the datalink for the FCoE port.

FCOE_PP_MAC_FACTORY_ADDR

16 hexadecimal ASCII characters representing the factory MAC address for the FCoE port.

FCOE_PP_MAC_CURRENT_ADDR

16 hexadecimal ASCII characters representing the current MAC address for the FCoE port.

FCOE_PP_MAC_PROMISCUOUS

A boolean property value for the promiscuous mode, set to either true or false.

FCOE_PP_PORT_STATE

ASCII characters representing the port state for the FCoE port, set to either Online or Offline.

FCOE_PP_FIP_MODE

A boolean property value representing if FIP (FCoE Initialization Protocol) is used before FCoE traffic starts, set to either true or false.

FCOE_PP_OFFLOAD_TXCRC

A boolean property value representing if FCoE TX CRC hardware offload feature is turned on, set to either true or false.

FCOE_PP_OFFLOAD_RXCRC

A boolean property value representing if FCoE RX CRC hardware offload feature is turned on, set to either true or false.

FCOE_PP_OFFLOAD_LSO

A boolean property value representing if FCoE Large Send Offload feature is turned on, set to either true or false.

FCOE_PP_OFFLOAD_LRO

A boolean property value representing if FCoE Large Receive Offload feature is turned on, set to either true or false.

FCOE_PP_OFFLOAD_LSO_MAX_SIZE

Up to 8 hexadecimal ASCII characters representing the maximum LSO size for the FCoE port if LSO is enabled.

FCOE_PP_OFFLOAD_LRO_MAX_SIZE

Up to 8 hexadecimal ASCII characters representing the maximum LRO size for the FCoE port if LRO is enabled.

Return Values

The following values are returned:

FCOE_STATUS_ERROR_INVAL_ARG

The value specified for handle, propVal, or propLen was not valid.

FCOE_STATUS_OK

The API call was successful.

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Safe

See Also

libfcoe(3LIB) , attributes (5), FCOE_GetPortHandle(3FCOE)