Class CIM_VTLStatisticalDataService
extends CIM_Service

The CIM_VTLStatisticalDataService class provides Historical Resource Usage Service. This class has set of functions to collect historical values for Front-end port performance, Physical disk usage, Logical backup data, Overall system compression ratio, Deduplication efficiency and Replication traffic. All the functions returns graph object Data point history of specified resource.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_VTLStatisticalDataService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringThe CIM_VTLStatisticalDataService class provides Historical Resource Usage Service. This class has set of functions to collect historical values for Front-end port performance, Physical disk usage, Logical backup data, Overall system compression ratio, Deduplication efficiency and Replication traffic. All the functions returns graph object Data point history of specified resource.
UMLPackagePathstringCIM::Device::StorageStatistics
Versionstring2.45.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

GetPhysicalCapacityUsage (uint16)

Method Qualifiers (GetPhysicalCapacityUsage)

NameData TypeValue
DescriptionstringGetPhysicalCapacityUsage Provides capacity on a per storage pool and virtual library basis. If the primordial pool is used, data is returned for all pools. If the VLS Computer System is used, capacity is returned for the entire appliance. At least one of StartTime, EndTime, and Duration must be specified. - If all three are specified, then Duration is ignored. - StartTime shall not be higher than EndTime. - No time may be set in the future. - If two of the three are specified, then the third is calculated. - If only StartTime or Duration is specified, then EndTime will be set to the current time. - If only EndTime is specified, then StartTime will be set to the time the earliest data is available.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Statistics Format Not Supported, Method Reserved, Method Parameters Checked - Job Started

Method Parameters (GetPhysicalCapacityUsage)

NameTypeQualifiers
NameData TypeValue
DataFormatuint16
DescriptionstringSpecifies the format of the 'Data' output parameter
ValueMapstring2
ValuesstringCSV
Durationuint64
DescriptionstringSpecifies the duration in seconds to generate statistical data. If only Duration is specified, then EndTime will be set to current time.
EndTimedatetime
DescriptionstringSpecifies the end time up to which the statistical data will be generated. Current time will be assumed whenever EndTime is specified null. If only EndTime is specified, then StartTime will be set to the earliest time that data is available.
StartTimedatetime
DescriptionstringSpecifies the start time for when the data is required. If only StartTime is specified, then EndTime shall be set to current time.
Data REF CIM_VTLStatisticalData
DescriptionstringGraph Object
Inbooleanfalse
Outbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (null if synchronous call)
Inbooleanfalse
Outbooleantrue
Library REF CIM_ComputerSystem
DescriptionstringReference to a VTL or the VLS
Pool REF CIM_StoragePool
DescriptionstringReference to the storage pool, concrete or primordial

GetLogicalCapacityUsage (uint16)

Method Qualifiers (GetLogicalCapacityUsage)

NameData TypeValue
DescriptionstringGetLogicalCapacityUsage Provides logical capacity usage for the entire VLS appliance or a specific VTL depending on the ComputerSystem reference passed in. At least one of StartTime, EndTime, and Duration must be specified. - If all three are specified, then Duration is ignored. - StartTime shall not be higher than EndTime. - No time may be set in the future. - If two of the three are specified, then the third is calculated. - If only StartTime or Duration is specified, then EndTime will be set to the current time. - If only EndTime is specified, then StartTime will be set to the time the earliest data is available.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Statistics Format Not Supported, Method Reserved, Method Parameters Checked - Job Started

Method Parameters (GetLogicalCapacityUsage)

NameTypeQualifiers
NameData TypeValue
DataFormatuint16
DescriptionstringSpecifies the format of the 'Data' output parameter
ValueMapstring2
ValuesstringCSV
Durationuint64
DescriptionstringSpecifies the duration in seconds to generate statistical data. If only Duration is specified, then EndTime will be set to current time.
EndTimedatetime
DescriptionstringSpecifies the end time up to which the statistical data will be generated. Current time will be assumed whenever EndTime is specified null. If only EndTime is specified, then StartTime will be set to the earliest time that data is available.
StartTimedatetime
DescriptionstringSpecifies the start time for when the data is required. If only StartTime is specified, then EndTime shall be set to current time.
Data REF CIM_VTLStatisticalData
DescriptionstringGraph Object
Inbooleanfalse
Outbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (null if synchronous call)
Inbooleanfalse
Outbooleantrue
Library REF CIM_ComputerSystem
DescriptionstringReference to a VTL or the VLS

GetSystemRatio (uint16)

Method Qualifiers (GetSystemRatio)

NameData TypeValue
DescriptionstringGetSystemRatio Provides an historic of the compression ratio for the entire VLS appliance or a specific VTL depending on on the ComputerSystem reference passed in. At least one of StartTime, EndTime, and Duration must be specified. - If all three are specified, then Duration is ignored. - StartTime shall not be higher than EndTime. - No time may be set in the future. - If two of the three are specified, then the third is calculated. - If only StartTime or Duration is specified, then EndTime will be set to the current time. - If only EndTime is specified, then StartTime will be set to the time the earliest data is available.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Statistics Format Not Supported, Method Reserved, Method Parameters Checked - Job Started

Method Parameters (GetSystemRatio)

NameTypeQualifiers
NameData TypeValue
DataFormatuint16
DescriptionstringSpecifies the format of the 'Data' output parameter
ValueMapstring2
ValuesstringCSV
Durationuint64
DescriptionstringSpecifies the duration in seconds to generate statistical data. If only Duration is specified, then EndTime will be set to current time.
EndTimedatetime
DescriptionstringSpecifies the end time up to which the statistical data will be generated. Current time will be assumed whenever EndTime is specified null. If only EndTime is specified, then StartTime will be set to the earliest time that data is available.
StartTimedatetime
DescriptionstringSpecifies the start time for when the data is required. If only StartTime is specified, then EndTime shall be set to current time.
Data REF CIM_VTLStatisticalData
DescriptionstringGraph Object
Inbooleanfalse
Outbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (null if synchronous call)
Inbooleanfalse
Outbooleantrue
Library REF CIM_ComputerSystem
DescriptionstringReference to a VTL or the VLS

GetDeduplicationRatio (uint16)

Method Qualifiers (GetDeduplicationRatio)

NameData TypeValue
DescriptionstringGetDeduplicationRatio(CIM_ComputerSystem REF): Provides an historicof the deduplication ratio for the entire VLS appliance or a specificVTL depending on on the ComputerSystem reference passed in. At least one of StartTime, EndTime, and Duration must be specified. - If all three are specified, then Duration is ignored. - StartTime shall not be higher than EndTime. - No time may be set in the future. - If two of the three are specified, then the third is calculated. - If only StartTime or Duration is specified, then EndTime will be set to the current time. - If only EndTime is specified, then StartTime will be set to the time the earliest data is available.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Statistics Format Not Supported, Method Reserved, Method Parameters Checked - Job Started

Method Parameters (GetDeduplicationRatio)

NameTypeQualifiers
NameData TypeValue
DataFormatuint16
DescriptionstringSpecifies the format of the 'Data' output parameter
ValueMapstring2
ValuesstringCSV
Durationuint64
DescriptionstringSpecifies the duration in seconds to generate statistical data. If only Duration is specified, then EndTime will be set to current time.
EndTimedatetime
DescriptionstringSpecifies the end time up to which the statistical data will be generated. Current time will be assumed whenever EndTime is specified null. If only EndTime is specified, then StartTime will be set to the earliest time that data is available.
StartTimedatetime
DescriptionstringSpecifies the start time for when the data is required. If only StartTime is specified, then EndTime shall be set to current time.
Data REF CIM_VTLStatisticalData
DescriptionstringGraph Object
Inbooleanfalse
Outbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (null if synchronous call)
Inbooleanfalse
Outbooleantrue
Library REF CIM_ComputerSystem
DescriptionstringReference to a VTL or the VLS

GetReplicationThroughput (uint16)

Method Qualifiers (GetReplicationThroughput)

NameData TypeValue
DescriptionstringGetReplicationThroughput provides a historic ofthe incoming or outgoing replication throughput in MB/s. At least one of StartTime, EndTime, and Duration must be specified. - If all three are specified, then Duration is ignored. - StartTime shall not be higher than EndTime. - No time may be set in the future. - If two of the three are specified, then the third is calculated. - If only StartTime or Duration is specified, then EndTime will be set to the current time. - If only EndTime is specified, then StartTime will be set to the time the earliest data is available.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Statistics Format Not Supported, Method Reserved, Method Parameters Checked - Job Started

Method Parameters (GetReplicationThroughput)

NameTypeQualifiers
NameData TypeValue
DataDirectionuint16
DescriptionstringIndicates incoming or outgoing traffic
ValueMapstring0, 1, .., 32768..65535
ValuesstringIn Traffic, Out Traffic, DMTF Reserved, Vendor Specific
DataFormatuint16
DescriptionstringSpecifies the format of the 'Data' output parameter
ValueMapstring2
ValuesstringCSV
Durationuint64
DescriptionstringSpecifies the duration in seconds to generate statistical data. If only Duration is specified, then EndTime will be set to current time.
EndTimedatetime
DescriptionstringSpecifies the end time up to which the statistical data will be generated. Current time will be assumed whenever EndTime is specified null. If only EndTime is specified, then StartTime will be set to the earliest time that data is available.
StartTimedatetime
DescriptionstringSpecifies the start time for when the data is required. If only StartTime is specified, then EndTime shall be set to current time.
Data REF CIM_VTLStatisticalData
DescriptionstringGraph Object
Inbooleanfalse
Outbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (null if synchronous call)
Inbooleanfalse
Outbooleantrue
Library REF CIM_ComputerSystem
DescriptionstringReference to a VTL or the VLS

GetReplicationRatio (uint16)

Method Qualifiers (GetReplicationRatio)

NameData TypeValue
DescriptionstringGetReplicationRatio provides a historic of the deduplication ratio over the replication link. At least one of StartTime, EndTime, and Duration must be specified. - If all three are specified, then Duration is ignored. - StartTime shall not be higher than EndTime. - No time may be set in the future. - If two of the three are specified, then the third is calculated. - If only StartTime or Duration is specified, then EndTime will be set to the current time. - If only EndTime is specified, then StartTime will be set to the time the earliest data is available.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Statistics Format Not Supported, Method Reserved, Method Parameters Checked - Job Started

Method Parameters (GetReplicationRatio)

NameTypeQualifiers
NameData TypeValue
DataFormatuint16
DescriptionstringSpecifies the format of the 'Data' output parameter
ValueMapstring2
ValuesstringCSV
Durationuint64
DescriptionstringSpecifies the duration in seconds to generate statistical data. If only Duration is specified, then EndTime will be set to current time.
EndTimedatetime
DescriptionstringSpecifies the end time up to which the statistical data will be generated. Current time will be assumed whenever EndTime is specified null. If only EndTime is specified, then StartTime will be set to the earliest time that data is available.
StartTimedatetime
DescriptionstringSpecifies the start time for when the data is required. If only StartTime is specified, then EndTime shall be set to current time.
Data REF CIM_VTLStatisticalData
DescriptionstringGraph Object
Inbooleanfalse
Outbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (null if synchronous call)
Inbooleanfalse
Outbooleantrue
Library REF CIM_ComputerSystem
DescriptionstringReference to a VTL or the VLS

GetPerformanceStatisticsReadWriteIO (uint16)

Method Qualifiers (GetPerformanceStatisticsReadWriteIO)

NameData TypeValue
DescriptionstringGetPerformanceStatisticsReadWriteIO gives the front-end port performance. At least one of StartTime, EndTime, and Duration must be specified. - If all three are specified, then Duration is ignored. - StartTime shall not be higher than EndTime. - No time may be set in the future. - If two of the three are specified, then the third is calculated. - If only StartTime or Duration is specified, then EndTime will be set to the current time. - If only EndTime is specified, then StartTime will be set to the time the earliest data is available.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Statistics Format Not Supported, Method Reserved, Method Parameters Checked - Job Started

Method Parameters (GetPerformanceStatisticsReadWriteIO)

NameTypeQualifiers
NameData TypeValue
DataFormatuint16
DescriptionstringSpecifies the format of the 'Data' output parameter
ValueMapstring2
ValuesstringCSV
Durationuint64
DescriptionstringSpecifies the duration in seconds to generate statistical data. If only Duration is specified, then EndTime will be set to current time.
EndTimedatetime
DescriptionstringSpecifies the end time up to which the statistical data will be generated. Current time will be assumed whenever EndTime is specified null. If only EndTime is specified, then StartTime will be set to the earliest time that data is available.
StartTimedatetime
DescriptionstringSpecifies the start time for when the data is required. If only StartTime is specified, then EndTime shall be set to current time.
Data REF CIM_VTLStatisticalData
DescriptionstringGraph Object
Inbooleanfalse
Outbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (null if synchronous call)
Inbooleanfalse
Outbooleantrue
Library REF CIM_ComputerSystem
DescriptionstringReference to a VTL or the VLS
tapeDrive REF CIM_TapeDrive
DescriptionstringReference to the Tape Drive for which the performance data is requested,if null performance stastics for the Virtual Library will be returned

GetFCPortStatisticsSRR (uint16)

Method Qualifiers (GetFCPortStatisticsSRR)

NameData TypeValue
DescriptionstringGetFCPortStatisticsSRR provides the Sequence RetransmissionRequest performance statistics of a FC Port in a VLS. At least one of StartTime, EndTime, and Duration must be specified. - If all three are specified, then Duration is ignored. - StartTime shall not be higher than EndTime. - No time may be set in the future. - If two of the three are specified, then the third is calculated. - If only StartTime or Duration is specified, then EndTime will be set to the current time. - If only EndTime is specified, then StartTime will be set to the time the earliest data is available.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Statistics Format Not Supported, Method Reserved, Method Parameters Checked - Job Started

Method Parameters (GetFCPortStatisticsSRR)

NameTypeQualifiers
NameData TypeValue
DataFormatuint16
DescriptionstringSpecifies the format of the 'Data' output parameter
ValueMapstring2
ValuesstringCSV
Durationuint64
DescriptionstringSpecifies the duration in seconds to generate statistical data. If only Duration is specified, then EndTime will be set to current time.
EndTimedatetime
DescriptionstringSpecifies the end time up to which the statistical data will be generated. Current time will be assumed whenever EndTime is specified null. If only EndTime is specified, then StartTime will be set to the earliest time that data is available.
StartTimedatetime
DescriptionstringSpecifies the start time for when the data is required. If only StartTime is specified, then EndTime shall be set to current time.
Data REF CIM_VTLStatisticalData
DescriptionstringGraph Object
Inbooleanfalse
Outbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (null if synchronous call)
Inbooleanfalse
Outbooleantrue
port REF CIM_LogicalPort
DescriptionstringPort for which the Aborts metric is requested

GetFCPortStatisticsAborts (uint16)

Method Qualifiers (GetFCPortStatisticsAborts)

NameData TypeValue
DescriptionstringGetFCPortStatisticsAborts provides the abort statistics of a FC Port in a VLS. At least one of StartTime, EndTime, and Duration must be specified. - If all three are specified, then Duration is ignored. - StartTime shall not be higher than EndTime. - No time may be set in the future. - If two of the three are specified, then the third is calculated. - If only StartTime or Duration is specified, then EndTime will be set to the current time. - If only EndTime is specified, then StartTime will be set to the time the earliest data is available.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Statistics Format Not Supported, Method Reserved, Method Parameters Checked - Job Started

Method Parameters (GetFCPortStatisticsAborts)

NameTypeQualifiers
NameData TypeValue
DataFormatuint16
DescriptionstringSpecifies the format of the 'Data' output parameter
ValueMapstring2
ValuesstringCSV
Durationuint64
DescriptionstringSpecifies the duration in seconds to generate statistical data. If only Duration is specified, then EndTime will be set to current time.
EndTimedatetime
DescriptionstringSpecifies the end time up to which the statistical data will be generated. Current time will be assumed whenever EndTime is specified null. If only EndTime is specified, then StartTime will be set to the earliest time that data is available.
StartTimedatetime
DescriptionstringSpecifies the start time for when the data is required. If only StartTime is specified, then EndTime shall be set to current time.
Data REF CIM_VTLStatisticalData
DescriptionstringGraph Object
Inbooleanfalse
Outbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (null if synchronous call)
Inbooleanfalse
Outbooleantrue
port REF CIM_LogicalPort
DescriptionstringPort for which the Aborts metric is requested

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service