Go to main content

man pages section 3: Extended Library Functions, Volume 2

Exit Print View

Updated: Thursday, June 13, 2019
 
 

IMA_SetStatisticsCollection (3IMA)

Name

IMA_SetStatisticsCollection - Enables or disables statistics collection for a PHBA's physical network ports, for a target, or for a target's logical units

Synopsis

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

IMA_STATUS IMA_SetStatisticsCollection(
      /* in */     IMA_OID oid,
      /* in */     IMA_BOOL enableStatisticsCollection
);

Parameters

oid

The object ID of the physical host bus adapter (PHBA) , target, or logical unit whose statistics collection setting is being modified.

enableStatisticsCollection

Set to the value, IMA_TRUE if statistics collection is being enabled for the specified object.

Set to the value, IMA_FALSE if statistics collection is being disabled for the specified object.

Description

The IMA_SetStatisticsCollection() API enables or disables statistics collection for a PHBA's physical network ports, for a target, or for a target's logical units.

Return Values

IMA_STATUS_REBOOT_NECESSARY

Returned if a reboot is necessary before the setting of statistics collection takes effect

IMA_ERROR_NOT_SUPPORTED

Returned if the oid argument does not support enabling or disabling of statistics collection

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 PHBA or target object

IMA_ERROR_OBJECT_NOT_FOUND

Returned if the oid argument does not specify a PHBA 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_GetDeviceStatistics(3IMA), IMA_GetStatisticsProperties(3IMA), IMA_GetTargetErrorStatistics(3IMA)