Go to main content

man pages section 3: Extended Library Functions, Volume 4

Exit Print View

Updated: Thursday, June 13, 2019
 
 

stmfLuStandby(3STMF)

Name

stmfLuStandby - set the access state of a logical unit to standby mode

Synopsis

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

int stmfSetAluaState(stmfGuid *luGuid);

Parameters

luGuid

a pointer to an stmfGuid structure containing the guid of the logical unit to set to standby

Description

The stmfLuStandby() function sets the access state of a logical unit to standby mode. When successfully set, a standby logical unit switches its asymmetric logical unit access state to a one of “Transition to Standby” (see stmfGetLuProp(3STMF). Once moved to this state, the backing store for the logical unit will be released by the logical unit provider (sbd for disk devices). To move a logical unit out of “Standby” or the “Transition to Standby” state, stmfImportLu(3STMF) or the import-lu subcommand of stmfadm(8) must be executed on the logical unit. On a successful logical unit import, the access state of the logical unit will move to “Active” in addition to sending a message to its peer that will complete the peer's transition to “Standby”. For more information on this state transition, see STMF_LU_IMPORT_NO_ACTIVE_ON_STANDBY in stmfSetStmfProp(3STMF). The current access state for the logical unit can be retrieved using stmfGetLuProp() where the property type is STMF_LU_PROP_ACCESS_STATE.

Return Values

The following values are returned:

STMF_ERROR_NOT_FOUND

The guid does not exist.

STMF_STATUS_SUCCESS

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

libstmf(3LIB), stmfGetLuProp(3STMF), stmfImportLu(3STMF), attributes(7), stmfadm(8)