man pages section 3: Extended Library Functions, Volume 2

IMA_GetInitiatorAuthParms (3IMA)

Name

IMA_GetInitiatorAuthParms - Gets the parameters for the authentication method specified on a specified LHBA

Synopsis

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

IMA_STATUS IMA_GetInitiatorAuthParms(
 /* in */      IMA_OID lhbaOid,
 /* in */      IMA_AUTHMETHOD method,
 /* out */     IMA_INITIATOR_AUTHPARMS *pParms
);

Parameters

lhbaOid

The object ID of the LHBA (logical host bus adapter) whose authentication parameters are to be retrieved.

method

The authentication method of the LHBA whose authentication parameters are to be retrieved.

pParms

A pointer to an IMA_INITIATOR_AUTHPARMS data structure. If returned successfully, this structure contains the initiator authentication parameters for the specified authentication method on the specified LHBA.

Description

The IMA_GetInitiatorAuthParms() API gets the parameters for the authentication method specified on a specified LHBA.

Return Values

IMA_ERROR_NOT_SUPPORTED

Returned if the retrieval of authentication parameters is not supported by the specified LHBA, in which case, it is likely that the LHBA does not support any authentication methods

IMA_ERROR_INVALID_PARAMETER

• Returned if the method argument does not specify a valid or supported authentication method

• Returned if the method argument has the value, IMA_AUTHMETHOD_NONE

• Returned if the pParms argument is NULL, or specifies a memory area to which data cannot be written

IMA_ERROR_INVALID_OBJECT_TYPE

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

IMA_ERROR_INCORRECT_OBJECT_TYPE

Returned if the lhbaOid argument does not specify an LHBA

IMA_ERROR_OBJECT_NOT_FOUND

Returned if the lhbaOid argument does not specify an LHBA 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_SetInitiatorAuthParms(3IMA)