Go to main content

man pages section 3: Extended Library Functions, Volume 4

Exit Print View

Updated: Thursday, June 13, 2019
 
 

stmfGetStmfProp(3STMF)

Name

stmfGetStmfProp - retrieve default stmf properties for luns and targets

Synopsis

cc [ flag... ] file... –lstmf [ library... ]
#include <libstmf.h>

int stmfGetStmfProp(uint8_t propType, char *propVal, size_t *propLen);

Parameters

propType

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 the hold the returned property value, propLen will contain the required size of the buffer and STMF_ERROR_INVALID_ARG will be returned.

Description

This function gets the default properties for the specified property type. All property values are expressed in human-readable form. The propType argument can be one of the following values:

STMF_DEFAULT_LU_STATE

Retrieve the current default state for luns. The default value is “online”.

STMF_DEFAULT_TARGET_PORT_STATE

Retrieve the current default state for target ports. the default value is “online”.

STMF_LU_IMPORT_NO_ACTIVE_ON_STANDBY

Retrieve the current setting of whether LUNs should be set to Active in a call to stmfImportLu(3STMF). The default value is “false”.

STMF_LU_PROP_VID

8 characters representing the vendor ID assignment. The STMF_LU_PROP_VID will be used to provide backwards compatibility for clients that are dependent on this being a very specific format. The value set using STMF_LU_PROP_VID in stmfSetStmfProp() will override any settings that have been applied through STMF_LU_PROP_VID in stmfSetLuProp(). Setting STMF_LU_PROP_VID as NULL can unset this property. For more information, see the stmfSetStmfProp(3STMF) and stmfSetLuProp(3STMF) man pages.

STMF_LU_PROP_PID

16 characters representing the product ID assignment. The STMF_LU_PROP_PID will be used to provide backwards compatibility for clients that are dependent on this being a very specific format. The value set using STMF_LU_PROP_PID in stmfSetStmfProp() will override any settings that have been applied through STMF_LU_PROP_PID in stmfSetLuProp(). Setting STMF_LU_PROP_PID as NULL can unset this property. For more information, see the stmfSetStmfProp(3STMF) and stmfSetLuProp(3STMF) man pages.

Return Values

The following values are returned:

STMF_STATUS_SUCCESS

The API call was successful.

STMF_ERROR_INVALID_ARG

Either the propType or propVal argument is invalid.

STMF_ERROR_NOT_FOUND

The specified propType was not found in the system.

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Safe

See Also

libstmf(3LIB), stmfSetStmfProp(3STMF), attributes(7)