Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

MP_AssignLogicalUnitToTPG(3MPAPI)

Name

MP_AssignLogicalUnitToTPG - assign a multipath logical unit to a target port group

Synopsis

cc [ flag… ] file–lMPAPI [ library… ]
#include <mpapi.h>

MP_STATUS MP_AssignLogicalUnitToTPG(MP_OID tpgOid, MP_OID luOid);

Parameters

tpgOid

An object ID that has type MP_TARGET_PORT_GROUP. The target port group currently in active access state that the administrator would like the LU assigned to.

luOid

An object ID that has type MP_MULTIPATH_LOGICAL_UNIT.

Description

The MP_AssignLogicalUnitToTPG() function assigns a multipath logical unit to a target port group.

Calling this function is valid only if the field supportsLuAssignment in the data structure TARGET_PORT_GROUP_PROPERTIES is true. This capability is not defined in SCSI standards. In some cases, devices support this capability through non-SCSI interfaces (such as SMI-S or SNMP). This method is only used when devices support this capability through vendor-specific means.

At any given time, each LU will typically be associated with two target port groups, one in active state and one in standby state. The result of this API will be that the LU associations change to a different pair of target port groups. The caller should specify the object ID of the desired target port group in active access state.

Return Values

MP_STATUS_INVALID_OBJECT_TYPE

The tpgOid or luOid parameter does not specify any valid object type. This is most likely to happen if an uninitialized object ID is passed to the API.

MP_STATUS_INVALID_PARAMETER

The tpgOid parameter has a type subfield other than MP_OBJECT_TYPE_TARGET_PORT_GROUP or luOid has a type subfield other than MP_OBJECT_TYPE_MULTIPATH_LU .

MP_STATUS_OBJECT_NOT_FOUND

The tpgOid or luOid owner ID or object sequence number is invalid.

MP_STATUS_UNSUPPORTED

The API is not supported.

MP_STATUS_SUCCESS

The operation is successful.

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Safe
Standard
ANSI INCITS 412 Multipath Management API

See Also

libMPAPI(3LIB), MP_GetAssociatedTPGOidList(3MPAPI), MP_GetMPLuOidListFromTPG(3MPAPI), attributes(7)