Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

IMA_GetMutualLocalAuthParms (3IMA)

Name

IMA_GetMutualLocalAuthParms - Gets the parameters for the authentication method specified for a specified object ID for purposes of mutual authentication

Synopsis

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

IMA_STATUS IMA_GetMutualLocalAuthParms(
 /* in */      IMA_OID oid,
 /* in */      IMA_AUTHMETHOD method,
 /* out */     IMA_TARGET_AUTHPARMS *pParms,
);

Parameters

oid

The object ID of the target, static target or discovery address whose authentication parameters are to be retrieved.

method

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

pParms

A pointer to an IMA_TARGET_AUTHPARMS data structure. On successful return this data structure contains the mutual authentication parameters for the specified authentication method on the specified object ID.

Description

The IMA_GetMutualLocalAuthParms() API gets the parameters for the authentication method specified for a specified object ID for purposes of mutual authentication.

Return Values

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 oid argument does not specify a valid object type

IMA_ERROR_INCORRECT_OBJECT_TYPE

Returned if the oid argument does not specify a target, static target or discovery address

IMA_ERROR_NOT_SUPPORTED

Returned if the logical host bus adapter (LHBA) associated with the target does not support setting authentication parameters for a target

IMA_ERROR_OBJECT_NOT_FOUND

Returned if the oid argument does not specify a 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_SetMutualLocalAuthParms(3IMA)