Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

IMA_SetDefaultTime2Retain (3IMA)

Name

IMA_SetDefaultTime2Retain - Sets the DefaultTime2Retain iSCSI login parameter value for the specified LHBA or target

Synopsis

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

IMA_STATUS IMA_SetDefaultTime2Retain(
     /* in */     IMA_OID oid,
     /* in */     IMA_UINT defaultTime2Retain
);

Parameters

oid

The object ID of the logical host bus adapter (LHBA) or target whose DefaultTime2Retain value is being set

defaultTime2Retain

The new value for the defaultTime2Retain argument for the specified LHBA or target

Description

The IMA_SetDefaultTime2Retain() API sets the defaultTime2Retain iSCSI login parameter value for the specified LHBA or target

Return Values

IMA_ERROR_NOT_SUPPORTED

Returned if the LHBA does not support setting the defaultTime2Retain value

IMA_STATUS_REBOOT_NECESSARY

Returned if a reboot is necessary before the setting of the defaultTime2Retain value actually takes effect

IMA_ERROR_INVALID_PARAMETER

Returned if the defaultTime2Retain value 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_GetDefaultTime2RetainProperties(3IMA)