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

Direct Known Subclasses

Class Qualifiers

Name	Data Type	Value
Description	string	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.
Experimental	boolean	true
UMLPackagePath	string	CIM::Device::StorageStatistics
Version	string	2.29.0

Class Properties

Inherited Properties

Name	Data Type	Class Origin
Caption	string	CIM_ManagedElement
CommunicationStatus	uint16	CIM_ManagedSystemElement
CreationClassName	string	CIM_Service
Description	string	CIM_ManagedElement
DetailedStatus	uint16	CIM_ManagedSystemElement
ElementName	string	CIM_ManagedElement
EnabledDefault	uint16	CIM_EnabledLogicalElement
EnabledState	uint16	CIM_EnabledLogicalElement
Generation	uint64	CIM_ManagedElement
HealthState	uint16	CIM_ManagedSystemElement
InstallDate	datetime	CIM_ManagedSystemElement
InstanceID	string	CIM_ManagedElement
Name	string	CIM_Service
OperatingStatus	uint16	CIM_ManagedSystemElement
OtherEnabledState	string	CIM_EnabledLogicalElement
PrimaryOwnerContact	string	CIM_Service
PrimaryOwnerName	string	CIM_Service
PrimaryStatus	uint16	CIM_ManagedSystemElement
RequestedState	uint16	CIM_EnabledLogicalElement
Started	boolean	CIM_Service
StartMode	string	CIM_Service
Status	string	CIM_ManagedSystemElement
SystemCreationClassName	string	CIM_Service
SystemName	string	CIM_Service
TimeOfLastStateChange	datetime	CIM_EnabledLogicalElement
TransitioningToState	uint16	CIM_EnabledLogicalElement
AvailableRequestedStates	uint16[]	CIM_EnabledLogicalElement
OperationalStatus	uint16[]	CIM_ManagedSystemElement
StatusDescriptions	string[]	CIM_ManagedSystemElement

Class Methods

Local Class Methods

GetPhysicalCapacityUsage (uint16)

Method Qualifiers (GetPhysicalCapacityUsage)

Name	Data Type	Value
Description	string	GetPhysicalCapacityUsage 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.
ValueMap	string	0, 1, 2, 3, 4, 5, 6, .., 4096
Values	string	Job 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)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
DataFormat	uint16
		Description	string	Specifies the format of the 'Data' output parameter
		In	boolean	true
		ValueMap	string	2
		Values	string	CSV
Duration	uint64
		Description	string	Specifies the duration in seconds to generate statistical data. If only Duration is specified, then EndTime will be set to current time.
		In	boolean	true
EndTime	datetime
		Description	string	Specifies 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.
		In	boolean	true
StartTime	datetime
		Description	string	Specifies the start time for when the data is required. If only StartTime is specified, then EndTime shall be set to current time.
		In	boolean	true
Data	REF CIM_VTLStatisticalData
		Description	string	Graph Object
		In	boolean	false
		Out	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (null if synchronous call)
		In	boolean	false
		Out	boolean	true
Library	REF CIM_ComputerSystem
		Description	string	Reference to a VTL or the VLS
		In	boolean	true
Pool	REF CIM_StoragePool
		Description	string	Reference to the storage pool, concrete or primordial
		In	boolean	true

GetLogicalCapacityUsage (uint16)

Method Qualifiers (GetLogicalCapacityUsage)

Name	Data Type	Value
Description	string	GetLogicalCapacityUsage 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.
ValueMap	string	0, 1, 2, 3, 4, 5, 6, .., 4096
Values	string	Job 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)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
DataFormat	uint16
		Description	string	Specifies the format of the 'Data' output parameter
		In	boolean	true
		ValueMap	string	2
		Values	string	CSV
Duration	uint64
		Description	string	Specifies the duration in seconds to generate statistical data. If only Duration is specified, then EndTime will be set to current time.
		In	boolean	true
EndTime	datetime
		Description	string	Specifies 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.
		In	boolean	true
StartTime	datetime
		Description	string	Specifies the start time for when the data is required. If only StartTime is specified, then EndTime shall be set to current time.
		In	boolean	true
Data	REF CIM_VTLStatisticalData
		Description	string	Graph Object
		In	boolean	false
		Out	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (null if synchronous call)
		In	boolean	false
		Out	boolean	true
Library	REF CIM_ComputerSystem
		Description	string	Reference to a VTL or the VLS
		In	boolean	true

GetSystemRatio (uint16)

Method Qualifiers (GetSystemRatio)

Name	Data Type	Value
Description	string	GetSystemRatio 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.
ValueMap	string	0, 1, 2, 3, 4, 5, 6, .., 4096
Values	string	Job 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)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
DataFormat	uint16
		Description	string	Specifies the format of the 'Data' output parameter
		In	boolean	true
		ValueMap	string	2
		Values	string	CSV
Duration	uint64
		Description	string	Specifies the duration in seconds to generate statistical data. If only Duration is specified, then EndTime will be set to current time.
		In	boolean	true
EndTime	datetime
		Description	string	Specifies 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.
		In	boolean	true
StartTime	datetime
		Description	string	Specifies the start time for when the data is required. If only StartTime is specified, then EndTime shall be set to current time.
		In	boolean	true
Data	REF CIM_VTLStatisticalData
		Description	string	Graph Object
		In	boolean	false
		Out	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (null if synchronous call)
		In	boolean	false
		Out	boolean	true
Library	REF CIM_ComputerSystem
		Description	string	Reference to a VTL or the VLS
		In	boolean	true

GetDeduplicationRatio (uint16)

Method Qualifiers (GetDeduplicationRatio)

Name	Data Type	Value
Description	string	GetDeduplicationRatio(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.
ValueMap	string	0, 1, 2, 3, 4, 5, 6, .., 4096
Values	string	Job 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)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
DataFormat	uint16
		Description	string	Specifies the format of the 'Data' output parameter
		In	boolean	true
		ValueMap	string	2
		Values	string	CSV
Duration	uint64
		Description	string	Specifies the duration in seconds to generate statistical data. If only Duration is specified, then EndTime will be set to current time.
		In	boolean	true
EndTime	datetime
		Description	string	Specifies 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.
		In	boolean	true
StartTime	datetime
		Description	string	Specifies the start time for when the data is required. If only StartTime is specified, then EndTime shall be set to current time.
		In	boolean	true
Data	REF CIM_VTLStatisticalData
		Description	string	Graph Object
		In	boolean	false
		Out	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (null if synchronous call)
		In	boolean	false
		Out	boolean	true
Library	REF CIM_ComputerSystem
		Description	string	Reference to a VTL or the VLS
		In	boolean	true

GetReplicationThroughput (uint16)

Method Qualifiers (GetReplicationThroughput)

Name	Data Type	Value
Description	string	GetReplicationThroughput 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.
ValueMap	string	0, 1, 2, 3, 4, 5, 6, .., 4096
Values	string	Job 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)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
DataDirection	uint16
		Description	string	Indicates incoming or outgoing traffic
		In	boolean	true
		ValueMap	string	0, 1, .., 32768..65535
		Values	string	In Traffic, Out Traffic, DMTF Reserved, Vendor Specific
DataFormat	uint16
		Description	string	Specifies the format of the 'Data' output parameter
		In	boolean	true
		ValueMap	string	2
		Values	string	CSV
Duration	uint64
		Description	string	Specifies the duration in seconds to generate statistical data. If only Duration is specified, then EndTime will be set to current time.
		In	boolean	true
EndTime	datetime
		Description	string	Specifies 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.
		In	boolean	true
StartTime	datetime
		Description	string	Specifies the start time for when the data is required. If only StartTime is specified, then EndTime shall be set to current time.
		In	boolean	true
Data	REF CIM_VTLStatisticalData
		Description	string	Graph Object
		In	boolean	false
		Out	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (null if synchronous call)
		In	boolean	false
		Out	boolean	true
Library	REF CIM_ComputerSystem
		Description	string	Reference to a VTL or the VLS
		In	boolean	true

GetReplicationRatio (uint16)

Method Qualifiers (GetReplicationRatio)

Name	Data Type	Value
Description	string	GetReplicationRatio 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.
ValueMap	string	0, 1, 2, 3, 4, 5, 6, .., 4096
Values	string	Job 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)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
DataFormat	uint16
		Description	string	Specifies the format of the 'Data' output parameter
		In	boolean	true
		ValueMap	string	2
		Values	string	CSV
Duration	uint64
		Description	string	Specifies the duration in seconds to generate statistical data. If only Duration is specified, then EndTime will be set to current time.
		In	boolean	true
EndTime	datetime
		Description	string	Specifies 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.
		In	boolean	true
StartTime	datetime
		Description	string	Specifies the start time for when the data is required. If only StartTime is specified, then EndTime shall be set to current time.
		In	boolean	true
Data	REF CIM_VTLStatisticalData
		Description	string	Graph Object
		In	boolean	false
		Out	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (null if synchronous call)
		In	boolean	false
		Out	boolean	true
Library	REF CIM_ComputerSystem
		Description	string	Reference to a VTL or the VLS
		In	boolean	true

GetPerformanceStatisticsReadWriteIO (uint16)

Method Qualifiers (GetPerformanceStatisticsReadWriteIO)

Name	Data Type	Value
Description	string	GetPerformanceStatisticsReadWriteIO 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.
ValueMap	string	0, 1, 2, 3, 4, 5, 6, .., 4096
Values	string	Job 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)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
DataFormat	uint16
		Description	string	Specifies the format of the 'Data' output parameter
		In	boolean	true
		ValueMap	string	2
		Values	string	CSV
Duration	uint64
		Description	string	Specifies the duration in seconds to generate statistical data. If only Duration is specified, then EndTime will be set to current time.
		In	boolean	true
EndTime	datetime
		Description	string	Specifies 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.
		In	boolean	true
StartTime	datetime
		Description	string	Specifies the start time for when the data is required. If only StartTime is specified, then EndTime shall be set to current time.
		In	boolean	true
Data	REF CIM_VTLStatisticalData
		Description	string	Graph Object
		In	boolean	false
		Out	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (null if synchronous call)
		In	boolean	false
		Out	boolean	true
Library	REF CIM_ComputerSystem
		Description	string	Reference to a VTL or the VLS
		In	boolean	true
tapeDrive	REF CIM_TapeDrive
		Description	string	Reference to the Tape Drive for which the performance data is requested,if null performance stastics for the Virtual Library will be returned
		IN	boolean	true

GetFCPortStatisticsSRR (uint16)

Method Qualifiers (GetFCPortStatisticsSRR)

Name	Data Type	Value
Description	string	GetFCPortStatisticsSRR 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.
ValueMap	string	0, 1, 2, 3, 4, 5, 6, .., 4096
Values	string	Job 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)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
DataFormat	uint16
		Description	string	Specifies the format of the 'Data' output parameter
		In	boolean	true
		ValueMap	string	2
		Values	string	CSV
Duration	uint64
		Description	string	Specifies the duration in seconds to generate statistical data. If only Duration is specified, then EndTime will be set to current time.
		In	boolean	true
EndTime	datetime
		Description	string	Specifies 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.
		In	boolean	true
StartTime	datetime
		Description	string	Specifies the start time for when the data is required. If only StartTime is specified, then EndTime shall be set to current time.
		In	boolean	true
Data	REF CIM_VTLStatisticalData
		Description	string	Graph Object
		In	boolean	false
		Out	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (null if synchronous call)
		In	boolean	false
		Out	boolean	true
port	REF CIM_LogicalPort
		Description	string	Port for which the Aborts metric is requested
		IN	boolean	true

GetFCPortStatisticsAborts (uint16)

Method Qualifiers (GetFCPortStatisticsAborts)

Name	Data Type	Value
Description	string	GetFCPortStatisticsAborts 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.
ValueMap	string	0, 1, 2, 3, 4, 5, 6, .., 4096
Values	string	Job 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)

Name	Type	Qualifiers
Name	Type	Name	Data Type	Value
DataFormat	uint16
		Description	string	Specifies the format of the 'Data' output parameter
		In	boolean	true
		ValueMap	string	2
		Values	string	CSV
Duration	uint64
		Description	string	Specifies the duration in seconds to generate statistical data. If only Duration is specified, then EndTime will be set to current time.
		In	boolean	true
EndTime	datetime
		Description	string	Specifies 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.
		In	boolean	true
StartTime	datetime
		Description	string	Specifies the start time for when the data is required. If only StartTime is specified, then EndTime shall be set to current time.
		In	boolean	true
Data	REF CIM_VTLStatisticalData
		Description	string	Graph Object
		In	boolean	false
		Out	boolean	true
Job	REF CIM_ConcreteJob
		Description	string	Reference to the job (null if synchronous call)
		In	boolean	false
		Out	boolean	true
port	REF CIM_LogicalPort
		Description	string	Port for which the Aborts metric is requested
		IN	boolean	true

Inherited Class Methods

Name	Return Type	Class Origin
ChangeAffectedElementsAssignedSequence	uint32	CIM_Service
RequestStateChange	uint32	CIM_EnabledLogicalElement
StartService	uint32	CIM_Service
StopService	uint32	CIM_Service

Class CIM_VTLStatisticalDataServiceextends CIM_Service

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