Go to main content

man pages section 3: Extended Library Functions, Volume 4

Exit Print View

Updated: Thursday, June 13, 2019
 
 

stmfSetAluaState(3STMF)

Name

stmfSetAluaState - set the Asymmetric Logical Unit Access State (ALUA) mode for STMF

Synopsis

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

int stmfSetAluaState(boolean_t alua_enabled, uint32_t node);

Parameters

alua_enabled

B_TRUE when enabling ALUA mode; B_FALSE when disabling ALUA mode.

node

Must be the value 0 or 1.

Description

The stmfSetAluaState() function sets the Asymmetric Logical Unit Access State (ALUA) mode for STMF. When alua_enabled is set to B_FALSE, node is ignored; otherwise, node must be set to 0 or 1. The node setting must be different for each node in a paired configuration. This function should be called only after the STMF proxy door service has been initialized (see stmfInitProxyDoor(3STMF)). When the ALUA state is enabled, all STMF logical units will be registered on the peer node as standby logical units. The standby logical units can then be exported to any SCSI initiator using the existing mechanisms in STMF, stmfAddViewEntry(3STMF) or the add-view subcommand of stmfadm(8). If ALUA mode is already enabled, it is valid to call this interface again with enabled set to B_TRUE. This action would result in a re-initialization of the ALUA mode and can be used during recovery of a failed peer node.

Return Values

The following values are returned:

STMF_ERROR_INVALID_ARG

Either alua_enabled or node was incorrectly set.

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), stmfInitProxyDoor(3STMF), stmfAddViewEntry(3STMF), attributes(7), stmfadm(8)