Go to main content

man pages section 3: Extended Library Functions, Volume 4

Exit Print View

Updated: Thursday, June 13, 2019
 
 

stmfSetStmfProp(3STMF)

Name

stmfSetStmfProp - set default stmf properties for luns and targets

Synopsis

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

int stmfSetStmfProp(uint8_t propType, char *propVal);

Parameters

propType

a property type value. See DESCRIPTION for valid values.

propVal

a property value

Description

This function sets 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

Set the default state for luns. The new setting will only take effect after a service enable/restart on the stmf service. Valid propVal values are “online” or “offline”.

STMF_DEFAULT_TARGET_PORT_STATE

Sets the default state for target ports The new setting will only take effect after a service enable/restart on the stmf service. Valid propVal values are “online” or “offline”.

STMF_LU_IMPORT_NO_ACTIVE_ON_STANDBY

Sets the property to indicate whether LUNs should be set to Active in a call to stmfImportLu(3STMF). Valid propVal values are “true” or “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 stmfGetStmfProp(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 stmfGetStmfProp(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

The propType argument is invalid.

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Safe

See Also

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