CIM211 Class Declaration
CIM_TCPEndpointStatistics

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_TCPEndpointStatistics --> CIM_ProtocolEndpointStatistics --> CIM_StatisticalData --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_ProtocolEndpointStatistics
NAMECIM_TCPEndpointStatistics

Class Qualifiers

Class CIM_TCPEndpointStatistics Qualifiers
NameTypeValueFrom Class
Experimentalbooleantrue CIM_TCPEndpointStatistics
Versionstring2.8.1000 CIM_TCPEndpointStatistics
DescriptionstringTCPEndpointStatistics is the statistics for the TCP Protocol Endpoint. CIM_TCPEndpointStatistics
DescriptionstringProtocolEndpointStatistics is the statistics class for the Protocol Endpoint. CIM_ProtocolEndpointStatistics
DescriptionstringCIM_StatisticalData is a root class for any arbitrary collection of statistical data and/or metrics applicable to one or more ManagedElements. These statistics MUST represent the most recent observations and MUST NOT be provided if irrelevant or stale. Note that this class uses a simplified naming/identity algorithm as compared to CIM_StatisticalInformation. CIM_StatisticalData
DescriptionstringManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement

Properties

Properties
NameTypeValueQualifiersClassOrigin
ReceivedSegmentsInErroruint32 Description
Counter
MappingStrings
CIM_TCPEndpointStatistics
SentResetSegmentsuint32 Description
Counter
MappingStrings
CIM_TCPEndpointStatistics
ReceivedPDUsuint32 Description
Counter
CIM_ProtocolEndpointStatistics
ReceivedPDUHeaderErrorsuint32 Description
Counter
CIM_ProtocolEndpointStatistics
ReceivedPDUAddressErrorsuint32 Description
Counter
CIM_ProtocolEndpointStatistics
SentPDUsuint32 Description
Counter
CIM_ProtocolEndpointStatistics
InstanceIDstring Key
Description
CIM_StatisticalData
ElementNamestring Required
Override
Description
CIM_StatisticalData
StartStatisticTimedatetime Description CIM_StatisticalData
StatisticTimedatetime Description CIM_StatisticalData
SampleIntervaldatetime00000000000000.000000:000 Description CIM_StatisticalData
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement

Property Qualifiers

Property ReceivedSegmentsInError Qualifiers
NameTypeValueFrom Class
DescriptionstringThe total number of segments received in error (e.g., bad TCP checksums). CIM_TCPEndpointStatistics
Counterbooleantrue CIM_TCPEndpointStatistics
MappingStringsstringMIB.IETF|TCP-MIB.tcpInErrs CIM_TCPEndpointStatistics

Property SentResetSegments Qualifiers
NameTypeValueFrom Class
DescriptionstringThe number of TCP segments sent containing the RST flag. CIM_TCPEndpointStatistics
Counterbooleantrue CIM_TCPEndpointStatistics
MappingStringsstringMIB.IETF|TCP-MIB.tcpOutRsts CIM_TCPEndpointStatistics

Property ReceivedPDUs Qualifiers
NameTypeValueFrom Class
DescriptionstringThe total number of input PDUs (Protocol Data Unit) received from interfaces, including those received in error. CIM_ProtocolEndpointStatistics
Counterbooleantrue CIM_ProtocolEndpointStatistics

Property ReceivedPDUHeaderErrors Qualifiers
NameTypeValueFrom Class
DescriptionstringThe number of input PDUs (Protocol Data Unit) discarded due to errors in their headers. CIM_ProtocolEndpointStatistics
Counterbooleantrue CIM_ProtocolEndpointStatistics

Property ReceivedPDUAddressErrors Qualifiers
NameTypeValueFrom Class
DescriptionstringThe number of input PDUs (Protocol Data Unit) discarded because the address in their header was not a valid address to be received at this entity. CIM_ProtocolEndpointStatistics
Counterbooleantrue CIM_ProtocolEndpointStatistics

Property SentPDUs Qualifiers
NameTypeValueFrom Class
DescriptionstringThe total number of PDUs (Protocol Data Unit) sent to interfaces for transmission. CIM_ProtocolEndpointStatistics
Counterbooleantrue CIM_ProtocolEndpointStatistics

Property InstanceID Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_StatisticalData
DescriptionstringWithin the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following ’ preferred ’ algorithm: < OrgID > : < LocalID > Where < OrgID > and < LocalID > are separated by a colon ’ : ’ , and where < OrgID > MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This is similar to the < Schema Name > _ < Class Name > structure of Schema class names.) In addition, to ensure uniqueness < OrgID > MUST NOT contain a colon ( ’ : ’ ). When using this algorithm, the first colon to appear in InstanceID MUST appear between < OrgID > and < LocalID > . < LocalID > is chosen by the business entity and SHOULD not be re-used to identify different underlying (real-world) elements. If the above ’ preferred ’ algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance ’ s NameSpace. For DMTF defined instances, the ’ preferred ’ algorithm MUST be used with the < OrgID > set to ’ CIM ’ . CIM_StatisticalData

Property ElementName Qualifiers
NameTypeValueFrom Class
Requiredbooleantrue CIM_StatisticalData
OverridestringElementName CIM_StatisticalData
DescriptionstringThe user friendly name for this instance of StatisticalData. In addition, the user friendly name can be used as a index property for a search of query. (Note: Name does not have to be unique within a namespace.) CIM_StatisticalData

Property StartStatisticTime Qualifiers
NameTypeValueFrom Class
DescriptionstringThe time, relative to managed element where the statistic was collected, when the first measurement was taken. If the statistic is reset, the StartStatisticTime is the time when the reset was performed. CIM_StatisticalData

Property StatisticTime Qualifiers
NameTypeValueFrom Class
DescriptionstringThe time the most recent measurement was taken, relative to the managed element where the statistic was collected. CIM_StatisticalData

Property SampleInterval Qualifiers
NameTypeValueFrom Class
DescriptionstringSome statistics are sampled at consistent time intervals. This property provides the sample interval so that client applications can determine the minimum time that new statistics should be pulled. If the statistics are not sampled at consistent time intervals, this property must be set to a zero time interval. CIM_StatisticalData

Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement
MaxLenuint3264 CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object. CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. CIM_ManagedElement

Methods

NameTypeValueQualifiersParametersClassOrigin
ResetSelectedStatsuint32 Description SelectedStatisticsCIM_StatisticalData

Method Qualifiers

Method ResetSelectedStats Qualifiers
NameTypeValueFrom Class
DescriptionstringMethod to reset one or more of the instance ’ s statistics. The method takes one parameter as input - an array of strings indicating which statistics to reset. If all the statistics in the instance should be reset, the first element of the array MUST be set to " All " or " ALL " . If one or more individual statistics should be reset, the corresponding property names are entered into the elements of the array. The method returns 0 if successful, 1 if not supported, and any other value if an error occurred. A method is specified so that the StatisticalInformation ’ s provider/ instrumentation, which calculates the statistics, can reset its internal processing, counters, etc. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are ’ translated ’ may also be specified in the subclass as a Values array qualifier. CIM_StatisticalData

Parameters

Method ResetSelectedStats Parameters
NameTypeQualifiers
SelectedStatisticsstringIN
Description

Parameter Qualifiers

Parameter SelectedStatistics Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_StatisticalData
DescriptionstringArray of strings indicating which statistics to reset. CIM_StatisticalData

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_ElementStatisticalDataCIM_StatisticalDataStats
CIM_RelatedStatisticalDataCIM_StatisticalDataStats
CIM_RelatedStatisticalDataCIM_StatisticalDataRelatedStats
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement