API Reference Pages

Defines, Structures, Typedefs, Functions. More...

Files
file	clPMApi.h
	Header file of PM API prototypes and structures.
file	clPMErrors.h
	Header file of PM library related error codes.

Classes
struct	ClPMAttrDataT
	This is used to pass PM and PM reset attributes information to the Primary OI. More...
struct	ClPMCallbacksT
	This stores address of the PM callback functions implemented by Primary OI. More...
struct	ClPMObjectDataT
	This is used to pass the PM object's values to the Primary OI. More...

Typedefs
typedef ClPMAttrDataT *	ClPMAttrDataPtrT
	Pointer type for ClPMAttrDataT.
typedef ClPMObjectDataT *	ClPMObjectDataPtrT
	Pointer type for ClPMObjectDataPtrT.
typedef ClRcT(*	ClPMObjectReadCallbackT )(CL_IN ClHandleT txnHandle, CL_INOUT ClPMObjectDataPtrT pObjectData)
	Callback used to read the value of PM attributes.
typedef ClRcT(*	ClPMObjectResetCallbackT )(CL_IN ClHandleT txnHandle, CL_INOUT ClPMObjectDataPtrT pObjectData)
	Callback used to reset the value of PM attributes.

Functions
ClRcT	clPMStart (ClCorMOIdListPtrT pMoIdList)
	Starts the PM operation on the list of MO Ids passed.
ClRcT	clPMStop (ClCorMOIdListPtrT pMoIdList)
	Stops the PM operation on the list of MO Ids passed.

Detailed Description

Defines, Structures, Typedefs, Functions.

Typedef Documentation

typedef ClRcT(* ClPMObjectReadCallbackT)(CL_IN ClHandleT txnHandle, CL_INOUT ClPMObjectDataPtrT pObjectData)

Callback used to read the value of PM attributes.

Header File:

clPMApi.h

Parameters

txnHandle	: The unique Transaction Handle for the READ operation.
pObjectData	: This contains the PM attributes info and user is supposed to fill in the values.

Return values

CL_OK

The callback function successfully executed.

Description:

This callback function is used read the value of PM attributes from the Primary OI when READ operation is performed on the PM attributes from north-bound. The user is supposed to walk the attributes in pObjectData and fill in the values.

Library File:

ClPMClient

See Also

ClPMObjectResetCallbackT

typedef ClRcT(* ClPMObjectResetCallbackT)(CL_IN ClHandleT txnHandle, CL_INOUT ClPMObjectDataPtrT pObjectData)

Callback used to reset the value of PM attributes.

Header File:

clPMApi.h

Parameters

txnHandle	: The unique Transaction Handle for the RESET operation.
pObjectData	: This contains the PM reset attribute's info and the reset value passed from north-bound.

Return values

CL_OK

The callback function successfully executed.

Description:

This callback function is used to reset the value of PM attributes. This will be called when the PM reset attribute is SET from north-bound. The user is supposed to reset all its local cache PM values upon receiving this callback.

Library File:

ClPMClient

See Also

ClPMObjectReadCallbackT

Function Documentation

ClRcT clPMStart

(

ClCorMOIdListPtrT

pMoIdList

)

Starts the PM operation on the list of MO Ids passed.

Header File:

clPMApi.h

Parameters

pMoIdList

: List of MoIds on which PM operation has to be started.

Return values

CL_OK	The API executed successfully.
CL_ERR_NO_MEM	Memory allocation failed.
CL_ERR_INVALID_HANDLE	PM library is not initialized successfully.

Description:

This API is used start the PM operation on the list MOs specified in pMoIdList. The PM operation includes fetching the PM attributes values from the Primary OI in the periodic interval configured, update the value of cached PM attributes into COR, check the value of the attribute for threshold crossing and raise/clear the alarm configured for that threshold limit.

Library File:

ClPMClient

See Also

clPMStop

ClRcT clPMStop

(

ClCorMOIdListPtrT

pMoIdList

)

Stops the PM operation on the list of MO Ids passed.

Header File:

clPMApi.h

Parameters

pMoIdList

: List of MoIds on which PM operation has to be stopped.

Return values

CL_OK	The API executed successfully.
CL_ERR_NO_MEM	Memory allocation failed.
CL_ERR_INVALID_HANDLE	PM library is not initialized successfully.
CL_ERR_NOT_EXIST	PM library is not initialized successfully.
CL_ERR_NULL_POINTER	PM MoId list is empty, the library is not initialized successfully or the specified moId(s) are not in the PM operation list.

Description:

This API is used to stop the PM operation on the list of MO Ids passed.

Library File:

ClPMClient

See Also

clPMStart