man pages section 3: Extended Library Functions, Volume 2

IMA_SetMaxBurstLength (3IMA)

Name

IMA_SetMaxBurstLength - Sets the MaxBurstLength iSCSI login parameter of a specified LHBA or target

Synopsis

cc [ flag... ] file... -lima [ library... ]
#include <ima.h>

IMA_STATUS IMA_SetMaxBurstLength(
     /* in */     IMA_OID oid,
     /* in */     IMA_UINT maxBurstLength
);

Parameters

oid

The object ID of the logical host bus adapter (LHBA) or target whose maxBurstLength argument value is to be set

maxBurstLength

The value for the new MaxBurstLength iSCSI login parameter for the LHBA or target

Description

The IMA_SetMaxBurstLength() API sets the MaxBurstLength iSCSI login parameter of a specified LHBA or target.

Return Values

IMA_ERROR_NOT_SUPPORTED

Returned if the LHBA does not support setting the maxBurstLength argument

IMA_STATUS_REBOOT_NECESSARY

Returned if a reboot is necessary before the setting of the maxBurstLength argument takes effect

IMA_ERROR_INVALID_PARAMETER

Returned if the maxBurstLength argument is out of range for the LHBA

IMA_ERROR_INVALID_OBJECT_TYPE

Returned if the oid argument does not specify a valid object type

IMA_ERROR_INCORRECT_OBJECT_TYPE

Returned if the oid argument does not specify an LHBA or target object

IMA_ERROR_OBJECT_NOT_FOUND

Returned if the oid argument does not specify an LHBA or target known to the system

Attributes

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

ATTRIBUTE TYPE ATTRIBUTE VALUE Availability system/library/storage/snia-ima Interface Stability Volatile MT-Level Safe

See Also

libima(3LIB), attributes(7), IMA_GetMaxBurstLengthProperties(3IMA)