CIM211 Class Declaration
CIM_IKESAEndpoint

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

Class Hierarchy

CIM_IKESAEndpoint --> CIM_SecurityAssociationEndpoint --> CIM_ProtocolEndpoint --> CIM_ServiceAccessPoint --> CIM_EnabledLogicalElement --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_SecurityAssociationEndpoint
NAMECIM_IKESAEndpoint

Class Qualifiers

Class CIM_IKESAEndpoint Qualifiers
NameTypeValueFrom Class
Versionstring2.8.0 CIM_IKESAEndpoint
DescriptionstringIKESAEndpoint is created in the first phase of SA negotiation and protects the key negotiation traffic. This endpoint is only created when IKE is the key exchange protocol. Other protocols and their endpoints will be defined in a future release. CIM_IKESAEndpoint
DescriptionstringSecurityAssociationEndpoint (SAEndpoint) represents the endpoint of a secure connection. This is typically an IP connection, although the model allows more flexibility than just IP. The SecurityAssociationEndpoint is tied to an IPProtocolEndpoint (or possibly other endpoint) using the LogicalIdentity association. Note that an endpoint is defined at both ends of the connection. CIM_SecurityAssociationEndpoint
DescriptionstringA communication point from which data can be sent or received. ProtocolEndpoints link system or computer interfaces to LogicalNetworks. CIM_ProtocolEndpoint
DescriptionstringCIM_ServiceAccessPoint represents the ability to utilize or invoke a Service. Access points represent that a Service is made available for other entities to use. CIM_ServiceAccessPoint
DescriptionstringThis class extends LogicalElement to abstract the concept of an element that is enabled and disabled, such as a LogicalDevice or a ServiceAccessPoint. CIM_EnabledLogicalElement
DescriptionstringCIM_LogicalElement is a base class for all the components of a System that represent abstract system components, such as Files, Processes, or LogicalDevices. CIM_LogicalElement
DescriptionstringCIM_ManagedSystemElement is the base class for the System Element hierarchy. Any distinguishable component of a System is a candidate for inclusion in this class. Examples of system components include: - software components such as application servers, databases, and applications - operating system components such as files, processes, and threads - device components such as disk drives, controllers, processors, and printers - physical components such as chips and cards. CIM_ManagedSystemElement
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
InitiatorCookieuint64 Description CIM_IKESAEndpoint
ResponderCookieuint64 Description CIM_IKESAEndpoint
CipherAlgorithmuint16 Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_IKESAEndpoint
OtherCipherAlgorithmstring Description
ModelCorrespondence
CIM_IKESAEndpoint
HashAlgorithmuint16 Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_IKESAEndpoint
OtherHashAlgorithmstring Description
ModelCorrespondence
CIM_IKESAEndpoint
AuthenticationMethoduint16 Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_IKESAEndpoint
OtherAuthenticationMethodstring Description
ModelCorrespondence
CIM_IKESAEndpoint
GroupIduint16 Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_IKESAEndpoint
VendorIDstring Description
ModelCorrespondence
CIM_IKESAEndpoint
InstallDatedatetime Override
Description
MappingStrings
CIM_SecurityAssociationEndpoint
LifetimeSecondsuint640 Description
Units
CIM_SecurityAssociationEndpoint
RefreshThresholdSecondsPercentageuint8 Write
Description
Units
MinValue
MaxValue
CIM_SecurityAssociationEndpoint
IdleDurationSecondsuint640 Description
Units
CIM_SecurityAssociationEndpoint
LifetimeKilobytesuint640 Description
Units
CIM_SecurityAssociationEndpoint
RefreshThresholdKbytesPercentageuint8 Write
Description
Units
MinValue
MaxValue
CIM_SecurityAssociationEndpoint
PacketLoggingActiveboolean Write
Description
CIM_SecurityAssociationEndpoint
Descriptionstring Override
MappingStrings
Description
CIM_ProtocolEndpoint
OperationalStatusuint16[] Override
MappingStrings
Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_ProtocolEndpoint
EnabledStateuint16 Override
MappingStrings
Description
ValueMap
Values
ModelCorrespondence
CIM_ProtocolEndpoint
TimeOfLastStateChangedatetime Override
MappingStrings
Description
CIM_ProtocolEndpoint
Namestring Description
MaxLen
Key
Override
CIM_ProtocolEndpoint
NameFormatstring Description
MaxLen
CIM_ProtocolEndpoint
ProtocolTypeuint16 Deprecated
Description
ValueMap
Values
ModelCorrespondence
CIM_ProtocolEndpoint
ProtocolIFTypeuint16 Description
ValueMap
Values
MappingStrings
ModelCorrespondence
CIM_ProtocolEndpoint
OtherTypeDescriptionstring Description
MaxLen
ModelCorrespondence
CIM_ProtocolEndpoint
BroadcastResetSupportedboolean Experimental
Description
MappingStrings
ModelCorrespondence
CIM_ProtocolEndpoint
SystemCreationClassNamestring Key
Propagated
Description
MaxLen
CIM_ServiceAccessPoint
SystemNamestring Key
Propagated
Description
MaxLen
CIM_ServiceAccessPoint
CreationClassNamestring Key
Description
MaxLen
CIM_ServiceAccessPoint
OtherEnabledStatestring Description
ModelCorrespondence
CIM_EnabledLogicalElement
RequestedStateuint1612 Description
ValueMap
Values
ModelCorrespondence
CIM_EnabledLogicalElement
EnabledDefaultuint162 Write
Description
ValueMap
Values
CIM_EnabledLogicalElement
StatusDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
Statusstring Deprecated
Description
ValueMap
MaxLen
CIM_ManagedSystemElement
HealthStateuint16 Description
ValueMap
Values
CIM_ManagedSystemElement
Captionstring Description
MaxLen
CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property InitiatorCookie Qualifiers
NameTypeValueFrom Class
DescriptionstringIdentifier of the IKE phase 1 negotiation initiator. Combined with the ResponderCookie, this value, in string form, may be used to construct the value of the key field ’ Name ’ , inherited from ServiceAccessPoint. CIM_IKESAEndpoint

Property ResponderCookie Qualifiers
NameTypeValueFrom Class
DescriptionstringIdentifier of the IKE phase 1 negotiation responder. Combined with the InitiatorCookie, this value, in string form, may be used to construct the value of the key field ’ Name ’ , inherited from ServiceAccessPoint. CIM_IKESAEndpoint

Property CipherAlgorithm Qualifiers
NameTypeValueFrom Class
DescriptionstringCipherAlgorithm is an enumeration that specifies the encryption algorithm used by the IKESAEndpoint. The list of algorithms was generated from Appendix A of RFC2409. Note that the enumeration is different than the RFC list, since the values of Unknown and Other are taken into account. CIM_IKESAEndpoint
ValueMapstring
[See below.]
CIM_IKESAEndpoint
ValuesstringUnknown
Other
DES
IDEA
Blowfish
RC5
3DES
CAST
DMTF/IANA Reserved
Vendor Reserved
CIM_IKESAEndpoint
MappingStringsstringRFC2409.IETF|Appendix A CIM_IKESAEndpoint
ModelCorrespondencestringCIM_IKESAEndpoint.OtherCipherAlgorithm CIM_IKESAEndpoint

NameValue
0Unknown
1Other
2DES
3IDEA
4Blowfish
5RC5
63DES
7CAST
8..65000DMTF/IANA Reserved
65001..65535Vendor Reserved
Property OtherCipherAlgorithm Qualifiers
NameTypeValueFrom Class
DescriptionstringDescription of the encryption algorithm when the value 1 ( " Other " ) is specified for the property, CipherAlgorithm. CIM_IKESAEndpoint
ModelCorrespondencestringCIM_IKESAEndpoint.CipherAlgorithm CIM_IKESAEndpoint

Property HashAlgorithm Qualifiers
NameTypeValueFrom Class
DescriptionstringHashAlgorithm is an enumeration that specifies the hash function used by the IKESAEndpoint. The list of algorithms was generated from Appendix A of RFC2409. Note that the enumeration is different than the RFC list, since the values of Unknown and Other are taken into account. CIM_IKESAEndpoint
ValueMapstring
[See below.]
CIM_IKESAEndpoint
ValuesstringUnknown
Other
MD5
SHA-1
Tiger
DMTF/IANA Reserved
Vendor Reserved
CIM_IKESAEndpoint
MappingStringsstringRFC2409.IETF|Appendix A CIM_IKESAEndpoint
ModelCorrespondencestringCIM_IKESAEndpoint.OtherHashAlgorithm CIM_IKESAEndpoint

NameValue
0Unknown
1Other
2MD5
3SHA-1
4Tiger
5..65000DMTF/IANA Reserved
65001..65535Vendor Reserved
Property OtherHashAlgorithm Qualifiers
NameTypeValueFrom Class
DescriptionstringDescription of the hash function when the value 1 ( " Other " ) is specified for the property, HashAlgorithm. CIM_IKESAEndpoint
ModelCorrespondencestringCIM_IKESAEndpoint.HashAlgorithm CIM_IKESAEndpoint

Property AuthenticationMethod Qualifiers
NameTypeValueFrom Class
DescriptionstringAuthenticationMethod is an enumeration that specifies the operation of the IKESAEndpoint. The list of methods was generated from Appendix A of RFC2409. Note that the enumeration is different than the RFC list, since the values of Unknown and Other are taken into account. CIM_IKESAEndpoint
ValueMapstring
[See below.]
CIM_IKESAEndpoint
ValuesstringUnknown
Other
Pre-shared Key
DSS Signatures
RSA Signatures
Encryption with RSA
Revised Encryption with RSA
DMTF/IANA Reserved
Vendor Reserved
CIM_IKESAEndpoint
MappingStringsstringRFC2409.IETF|Appendix A CIM_IKESAEndpoint
ModelCorrespondencestringCIM_IKESAEndpoint.OtherAuthenticationMethod CIM_IKESAEndpoint

NameValue
0Unknown
1Other
2Pre-shared Key
3DSS Signatures
4RSA Signatures
5Encryption with RSA
6Revised Encryption with RSA
7..65000DMTF/IANA Reserved
65001..65535Vendor Reserved
Property OtherAuthenticationMethod Qualifiers
NameTypeValueFrom Class
DescriptionstringDescription of the method when the value 1 ( " Other " ) is specified for the property, AuthenticationMethod. CIM_IKESAEndpoint
ModelCorrespondencestringCIM_IKESAEndpoint.AuthenticationMethod CIM_IKESAEndpoint

Property GroupId Qualifiers
NameTypeValueFrom Class
DescriptionstringGroupId specifies the key exchange group ID. If the GroupID number is from the vendor-specific range (32768-65535), the VendorID qualifies the group number. Well-known group identifiers from RFC2412, Appendix E, are: Group 1= ’ 768 bit prime ’ , Group 2= ’ 1024 bit prime ’ , Group 3= ’ Elliptic Curve Group with 155 bit field element ’ , Group 4= ’ Large Elliptic Curve Group with 185 bit field element ’ , and Group 5= ’ 1536 bit prime ’ . CIM_IKESAEndpoint
ValueMapstring
[See below.]
CIM_IKESAEndpoint
ValuesstringNo Group/Non-Diffie-Hellman Exchange
DH-768 bit prime
DH-1024 bit prime
EC2N-155 bit field element
EC2N-185 bit field element
DH-1536 bit prime
Standard Group - Reserved
Vendor Reserved
CIM_IKESAEndpoint
MappingStringsstringRFC2412.IETF|Appendix E CIM_IKESAEndpoint
ModelCorrespondencestringCIM_IKESAEndpoint.VendorID CIM_IKESAEndpoint

NameValue
0No Group/Non-Diffie-Hellman Exchange
1DH-768 bit prime
2DH-1024 bit prime
3EC2N-155 bit field element
4EC2N-185 bit field element
5DH-1536 bit prime
..Standard Group - Reserved
0x8000..Vendor Reserved
Property VendorID Qualifiers
NameTypeValueFrom Class
DescriptionstringVendorID identifies the vendor when the value of GroupID is in the vendor-specific range, 32768 to 65535. CIM_IKESAEndpoint
ModelCorrespondencestringCIM_IKESAEndpoint.GroupId CIM_IKESAEndpoint

Property InstallDate Qualifiers
NameTypeValueFrom Class
OverridestringInstallDate CIM_SecurityAssociationEndpoint
DescriptionstringInstallDate records when the SA (and its endpoint) was created. CIM_SecurityAssociationEndpoint
MappingStringsstringMIF.DMTF|ComponentID|001.5 CIM_SecurityAssociationEndpoint

Property LifetimeSeconds Qualifiers
NameTypeValueFrom Class
DescriptionstringLifetimeSeconds specifies the maximum time that the SA will be considered valid after it has been created. A value of zero indicates that the default of 8 hours be used. A non-zero value indicates the seconds lifetime. CIM_SecurityAssociationEndpoint
UnitsstringSeconds CIM_SecurityAssociationEndpoint

Property RefreshThresholdSecondsPercentage Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_SecurityAssociationEndpoint
DescriptionstringRefreshThresholdSecondsPercentage is the lifetime percentage after which a new SA should be acquired, before the existing SA expires. A random period may be added to a calculated threshold to reduce network thrashing. CIM_SecurityAssociationEndpoint
UnitsstringPercent CIM_SecurityAssociationEndpoint
MinValuesint640 CIM_SecurityAssociationEndpoint
MaxValuesint64100 CIM_SecurityAssociationEndpoint

Property IdleDurationSeconds Qualifiers
NameTypeValueFrom Class
DescriptionstringIdleDurationSeconds specifies how long the SA can be idle before it is deleted. The default value, 0, indicates that there is no idle timeout period. CIM_SecurityAssociationEndpoint
UnitsstringSeconds CIM_SecurityAssociationEndpoint

Property LifetimeKilobytes Qualifiers
NameTypeValueFrom Class
DescriptionstringLifetimeKilobytes specifies the maximum number of kilobytes of data traffic to be protected by the SA. A value of zero (the default) indicates that there should be no maximum kilobyte lifetime. A non-zero value specifies the desired kilobyte lifetime. The SA is deleted when the LifetimeKilobyte value is exceeded. CIM_SecurityAssociationEndpoint
UnitsstringKiloBytes CIM_SecurityAssociationEndpoint

Property RefreshThresholdKbytesPercentage Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_SecurityAssociationEndpoint
DescriptionstringRefreshThresholdKbytesPercentage is the lifetime percentage of kilobytes processed, at which a new SA should be acquired. A random value may be added to the calculated threshold to reduce network thrashing. CIM_SecurityAssociationEndpoint
UnitsstringPercent CIM_SecurityAssociationEndpoint
MinValuesint640 CIM_SecurityAssociationEndpoint
MaxValuesint64100 CIM_SecurityAssociationEndpoint

Property PacketLoggingActive Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_SecurityAssociationEndpoint
DescriptionstringPacketLoggingActive causes a log to be kept of traffic processed by the SAEndpoint. CIM_SecurityAssociationEndpoint

Property Description Qualifiers
NameTypeValueFrom Class
OverridestringDescription CIM_ProtocolEndpoint
MappingStringsstringMIB.IETF|IF-MIB.ifDescr CIM_ProtocolEndpoint
DescriptionstringThe Description property provides a textual description of the object. CIM_ProtocolEndpoint

Property OperationalStatus Qualifiers
NameTypeValueFrom Class
OverridestringOperationalStatus CIM_ProtocolEndpoint
MappingStringsstringMIB.IETF|IF-MIB.ifOperStatus CIM_ProtocolEndpoint
DescriptionstringIndicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration ’ s values are self-explanatory. However, a few are not and are described here in more detail. " Stressed " indicates that the element is functioning, but needs attention. Examples of " Stressed " states are overload, overheated, and so on. " Predictive Failure " indicates that an element is functioning nominally but predicting a failure in the near future. " In Service " describes an element being configured, maintained, cleaned, or otherwise administered. " No Contact " indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. " Lost Communication " indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. " Stopped " and " Aborted " are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated. " Dormant " indicates that the element is inactive or quiesced. " Supporting Entity in Error " indicates that this element might be " OK " but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower-layer networking problems. " Completed " indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error). " Power Mode " indicates that the element has additional power model information contained in the Associated PowerManagementService association. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today ’ s environment to the future. This change was not made earlier because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or instrumentation provide both the Status and OperationalStatus properties. Further, the first value of OperationalStatus should contain the primary status for the element. When instrumented, Status (because it is single-valued) should also provide the primary status of the element. CIM_ProtocolEndpoint
ValueMapstring
[See below.]
CIM_ProtocolEndpoint
ValuesstringUnknown
Other
OK
Degraded
Stressed
Predictive Failure
Error
Non-Recoverable Error
Starting
Stopping
Stopped
In Service
No Contact
Lost Communication
Aborted
Dormant
Supporting Entity in Error
Completed
Power Mode
DMTF Reserved
Vendor Reserved
CIM_ProtocolEndpoint
ArrayTypestringIndexed CIM_ProtocolEndpoint
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptions CIM_ProtocolEndpoint

NameValue
0Unknown
1Other
2OK
3Degraded
4Stressed
5Predictive Failure
6Error
7Non-Recoverable Error
8Starting
9Stopping
10Stopped
11In Service
12No Contact
13Lost Communication
14Aborted
15Dormant
16Supporting Entity in Error
17Completed
18Power Mode
..DMTF Reserved
0x8000..Vendor Reserved
Property EnabledState Qualifiers
NameTypeValueFrom Class
OverridestringEnabledState CIM_ProtocolEndpoint
MappingStringsstringMIB.IETF|IF-MIB.ifAdminStatus CIM_ProtocolEndpoint
DescriptionstringEnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states: Enabled (2) indicates that the element is or could be executing commands, will process any queued commands, and queues new requests. Disabled (3) indicates that the element will not execute commands and will drop any new requests. Shutting Down (4) indicates that the element is in the process of going to a Disabled state. Not Applicable (5) indicates the element does not support being enabled or disabled. Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests. Test (7) indicates that the element is in a test state. Deferred (8) indicates that the element might be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The behavior of the element is similar to the Enabled state, but it processes only a restricted set of commands. All other requests are queued. Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued. CIM_ProtocolEndpoint
ValueMapstring
[See below.]
CIM_ProtocolEndpoint
ValuesstringUnknown
Other
Enabled
Disabled
Shutting Down
Not Applicable
Enabled but Offline
In Test
Deferred
Quiesce
Starting
DMTF Reserved
Vendor Reserved
CIM_ProtocolEndpoint
ModelCorrespondencestringCIM_EnabledLogicalElement.OtherEnabledState CIM_ProtocolEndpoint

NameValue
0Unknown
1Other
2Enabled
3Disabled
4Shutting Down
5Not Applicable
6Enabled but Offline
7In Test
8Deferred
9Quiesce
10Starting
11..32767DMTF Reserved
32768..65535Vendor Reserved
Property TimeOfLastStateChange Qualifiers
NameTypeValueFrom Class
OverridestringTimeOfLastStateChange CIM_ProtocolEndpoint
MappingStringsstringMIB.IETF|IF-MIB.ifLastChange CIM_ProtocolEndpoint
DescriptionstringThe date or time when the EnabledState of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated. CIM_ProtocolEndpoint

Property Name Qualifiers
NameTypeValueFrom Class
DescriptionstringA string that identifies this ProtocolEndpoint with either a port or an interface on a device. To ensure uniqueness, the Name property should be prepended or appended with information from the Type or OtherTypeDescription properties. The method selected is described in the NameFormat property of this class. CIM_ProtocolEndpoint
MaxLenuint32256 CIM_ProtocolEndpoint
Keybooleantrue CIM_ProtocolEndpoint
OverridestringName CIM_ProtocolEndpoint

Property NameFormat Qualifiers
NameTypeValueFrom Class
DescriptionstringNameFormat contains the naming heuristic that is selected to ensure that the value of the Name property is unique. For example, you might choose to prepend the name of the port or interface with the Type of ProtocolEndpoint (for example, IPv4) of this instance followed by an underscore. CIM_ProtocolEndpoint
MaxLenuint32256 CIM_ProtocolEndpoint

Property ProtocolType Qualifiers
NameTypeValueFrom Class
DescriptionstringNote: This property is deprecated in lieu of the ProtocolIFType enumeration. This deprecation was done to have better alignment between the IF-MIB of the IETF and this CIM class. Deprecated description: ProtocolType is an enumeration that provides information to categorize and classify different instances of this class. For most instances, information in this enumeration and the definition of the subclass overlap. However, there are several cases where a specific subclass of ProtocolEndpoint is not required (for example, there is no Fibre Channel subclass of ProtocolEndpoint). Therefore, this property is needed to define the type of Endpoint. CIM_ProtocolEndpoint
ValueMapstring
[See below.]
CIM_ProtocolEndpoint
ValuesstringUnknown
Other
IPv4
IPv6
IPX
AppleTalk
DECnet
SNA
CONP
CLNP
VINES
XNS
ATM
Frame Relay
Ethernet
TokenRing
FDDI
Infiniband
Fibre Channel
ISDN BRI Endpoint
ISDN B Channel Endpoint
ISDN D Channel Endpoint
IPv4/v6
BGP
OSPF
MPLS
UDP
TCP
CIM_ProtocolEndpoint
ModelCorrespondencestringCIM_ProtocolEndpoint.OtherTypeDescription CIM_ProtocolEndpoint

NameValue
0Unknown
1Other
2IPv4
3IPv6
4IPX
5AppleTalk
6DECnet
7SNA
8CONP
9CLNP
10VINES
11XNS
12ATM
13Frame Relay
14Ethernet
15TokenRing
16FDDI
17Infiniband
18Fibre Channel
19ISDN BRI Endpoint
20ISDN B Channel Endpoint
21ISDN D Channel Endpoint
22IPv4/v6
23BGP
24OSPF
25MPLS
26UDP
27TCP
Property ProtocolIFType Qualifiers
NameTypeValueFrom Class
DescriptionstringProtocolIFType is an enumeration that is synchronized with the IANA ifType MIB. The ifType MIB is maintained at the URL, http://www.iana.org/assignments/ianaiftype-mib. Also, additional values defined by the DMTF are included. The property is used to categorize and classify instances of the ProtocolEndpoint class. Note that if the ProtocolIFType is set to 1 (Other), then the type information should be provided in the OtherTypeDescription string property. CIM_ProtocolEndpoint
ValueMapstring
[See below.]
CIM_ProtocolEndpoint
ValuesstringUnknown
Other
Regular 1822
HDH 1822
DDN X.25
RFC877 X.25
Ethernet CSMA/CD
ISO 802.3 CSMA/CD
ISO 802.4 Token Bus
ISO 802.5 Token Ring
ISO 802.6 MAN
StarLAN
Proteon 10Mbit
Proteon 80Mbit
HyperChannel
FDDI
LAP-B
SDLC
DS1
E1
Basic ISDN
Primary ISDN
Proprietary Point-to-Point Serial
PPP
Software Loopback
EON
Ethernet 3Mbit
NSIP
SLIP
Ultra
DS3
SIP
Frame Relay
RS-232
Parallel
ARCNet
ARCNet Plus
ATM
MIO X.25
SONET
X.25 PLE
ISO 802.211c
LocalTalk
SMDS DXI
Frame Relay Service
V.35
HSSI
HIPPI
Modem
AAL5
SONET Path
SONET VT
SMDS ICIP
Proprietary Virtual/Internal
Proprietary Multiplexor
IEEE 802.12
Fibre Channel
HIPPI Interface
Frame Relay Interconnect
ATM Emulated LAN for 802.3
ATM Emulated LAN for 802.5
ATM Emulated Circuit
Fast Ethernet (100BaseT)
ISDN
V.11
V.36
G703 at 64K
G703 at 2Mb
QLLC
Fast Ethernet 100BaseFX
Channel
IEEE 802.11
IBM 260/370 OEMI Channel
ESCON
Data Link Switching
ISDN S/T Interface
ISDN U Interface
LAP-D
IP Switch
Remote Source Route Bridging
ATM Logical
DS0
DS0 Bundle
BSC
Async
Combat Net Radio
ISO 802.5r DTR
Ext Pos Loc Report System
AppleTalk Remote Access Protocol
Proprietary Connectionless
ITU X.29 Host PAD
ITU X.3 Terminal PAD
Frame Relay MPI
ITU X.213
ADSL
RADSL
SDSL
VDSL
ISO 802.5 CRFP
Myrinet
Voice Receive and Transmit
Voice Foreign Exchange Office
Voice Foreign Exchange Service
Voice Encapsulation
Voice over IP
ATM DXI
ATM FUNI
ATM IMA
PPP Multilink Bundle
IP over CDLC
IP over CLAW
Stack to Stack
Virtual IP Address
MPC
IP over ATM
ISO 802.5j Fibre Token Ring
TDLC
Gigabit Ethernet
HDLC
LAP-F
V.37
X.25 MLP
X.25 Hunt Group
Transp HDLC
Interleave Channel
FAST Channel
IP (for APPN HPR in IP Networks)
CATV MAC Layer
CATV Downstream
CATV Upstream
Avalon 12MPP Switch
Tunnel
Coffee
Circuit Emulation Service
ATM SubInterface
Layer 2 VLAN using 802.1Q
Layer 3 VLAN using IP
Layer 3 VLAN using IPX
Digital Power Line
Multimedia Mail over IP
DTM
DCN
IP Forwarding
MSDSL
IEEE 1394
IF-GSN/HIPPI-6400
DVB-RCC MAC Layer
DVB-RCC Downstream
DVB-RCC Upstream
ATM Virtual
MPLS Tunnel
SRP
Voice over ATM
Voice over Frame Relay
ISDL
Composite Link
SS7 Signaling Link
Proprietary P2P Wireless
Frame Forward
RFC1483 Multiprotocol over ATM
USB
IEEE 802.3ad Link Aggregate
BGP Policy Accounting
FRF .16 Multilink FR
H.323 Gatekeeper
H.323 Proxy
MPLS
Multi-Frequency Signaling Link
HDSL-2
S-HDSL
DS1 Facility Data Link
Packet over SONET/SDH
DVB-ASI Input
DVB-ASI Output
Power Line
Non Facility Associated Signaling
TR008
GR303 RDT
GR303 IDT
ISUP
Proprietary Wireless MAC Layer
Proprietary Wireless Downstream
Proprietary Wireless Upstream
HIPERLAN Type 2
Proprietary Broadband Wireless Access Point to Mulipoint
SONET Overhead Channel
Digital Wrapper Overhead Channel
ATM Adaptation Layer 2
Radio MAC
ATM Radio
Inter Machine Trunk
MVL DSL
Long Read DSL
Frame Relay DLCI Endpoint
ATM VCI Endpoint
Optical Channel
Optical Transport
Proprietary ATM
Voice over Cable
Infiniband
TE Link
Q.2931
Virtual Trunk Group
SIP Trunk Group
SIP Signaling
CATV Upstream Channel
Econet
FSAN 155Mb PON
FSAN 622Mb PON
Transparent Bridge
Line Group
Voice E & M Feature Group
Voice FGD EANA
Voice DID
MPEG Transport
6To4
GTP
Paradyne EtherLoop 1
Paradyne EtherLoop 2
Optical Channel Group
HomePNA
GFP
ciscoISLvlan
actelisMetaLOOP
Fcip
IANA Reserved
IPv4
IPv6
IPv4/v6
IPX
DECnet
SNA
CONP
CLNP
VINES
XNS
ISDN B Channel Endpoint
ISDN D Channel Endpoint
BGP
OSPF
UDP
TCP
802.11a
802.11b
802.11g
802.11h
NFS
CIFS
DAFS
WebDAV
HTTP
FTP
NDMP
DMTF Reserved
Vendor Reserved
CIM_ProtocolEndpoint
MappingStringsstringMIB.IETF|IF-MIB.ifType CIM_ProtocolEndpoint
ModelCorrespondencestringCIM_ProtocolEndpoint.OtherTypeDescription CIM_ProtocolEndpoint

NameValue
0Unknown
1Other
2Regular 1822
3HDH 1822
4DDN X.25
5RFC877 X.25
6Ethernet CSMA/CD
7ISO 802.3 CSMA/CD
8ISO 802.4 Token Bus
9ISO 802.5 Token Ring
10ISO 802.6 MAN
11StarLAN
12Proteon 10Mbit
13Proteon 80Mbit
14HyperChannel
15FDDI
16LAP-B
17SDLC
18DS1
19E1
20Basic ISDN
21Primary ISDN
22Proprietary Point-to-Point Serial
23PPP
24Software Loopback
25EON
26Ethernet 3Mbit
27NSIP
28SLIP
29Ultra
30DS3
31SIP
32Frame Relay
33RS-232
34Parallel
35ARCNet
36ARCNet Plus
37ATM
38MIO X.25
39SONET
40X.25 PLE
41ISO 802.211c
42LocalTalk
43SMDS DXI
44Frame Relay Service
45V.35
46HSSI
47HIPPI
48Modem
49AAL5
50SONET Path
51SONET VT
52SMDS ICIP
53Proprietary Virtual/Internal
54Proprietary Multiplexor
55IEEE 802.12
56Fibre Channel
57HIPPI Interface
58Frame Relay Interconnect
59ATM Emulated LAN for 802.3
60ATM Emulated LAN for 802.5
61ATM Emulated Circuit
62Fast Ethernet (100BaseT)
63ISDN
64V.11
65V.36
66G703 at 64K
67G703 at 2Mb
68QLLC
69Fast Ethernet 100BaseFX
70Channel
71IEEE 802.11
72IBM 260/370 OEMI Channel
73ESCON
74Data Link Switching
75ISDN S/T Interface
76ISDN U Interface
77LAP-D
78IP Switch
79Remote Source Route Bridging
80ATM Logical
81DS0
82DS0 Bundle
83BSC
84Async
85Combat Net Radio
86ISO 802.5r DTR
87Ext Pos Loc Report System
88AppleTalk Remote Access Protocol
89Proprietary Connectionless
90ITU X.29 Host PAD
91ITU X.3 Terminal PAD
92Frame Relay MPI
93ITU X.213
94ADSL
95RADSL
96SDSL
97VDSL
98ISO 802.5 CRFP
99Myrinet
100Voice Receive and Transmit
101Voice Foreign Exchange Office
102Voice Foreign Exchange Service
103Voice Encapsulation
104Voice over IP
105ATM DXI
106ATM FUNI
107ATM IMA
108PPP Multilink Bundle
109IP over CDLC
110IP over CLAW
111Stack to Stack
112Virtual IP Address
113MPC
114IP over ATM
115ISO 802.5j Fibre Token Ring
116TDLC
117Gigabit Ethernet
118HDLC
119LAP-F
120V.37
121X.25 MLP
122X.25 Hunt Group
123Transp HDLC
124Interleave Channel
125FAST Channel
126IP (for APPN HPR in IP Networks)
127CATV MAC Layer
128CATV Downstream
129CATV Upstream
130Avalon 12MPP Switch
131Tunnel
132Coffee
133Circuit Emulation Service
134ATM SubInterface
135Layer 2 VLAN using 802.1Q
136Layer 3 VLAN using IP
137Layer 3 VLAN using IPX
138Digital Power Line
139Multimedia Mail over IP
140DTM
141DCN
142IP Forwarding
143MSDSL
144IEEE 1394
145IF-GSN/HIPPI-6400
146DVB-RCC MAC Layer
147DVB-RCC Downstream
148DVB-RCC Upstream
149ATM Virtual
150MPLS Tunnel
151SRP
152Voice over ATM
153Voice over Frame Relay
154ISDL
155Composite Link
156SS7 Signaling Link
157Proprietary P2P Wireless
158Frame Forward
159RFC1483 Multiprotocol over ATM
160USB
161IEEE 802.3ad Link Aggregate
162BGP Policy Accounting
163FRF .16 Multilink FR
164H.323 Gatekeeper
165H.323 Proxy
166MPLS
167Multi-Frequency Signaling Link
168HDSL-2
169S-HDSL
170DS1 Facility Data Link
171Packet over SONET/SDH
172DVB-ASI Input
173DVB-ASI Output
174Power Line
175Non Facility Associated Signaling
176TR008
177GR303 RDT
178GR303 IDT
179ISUP
180Proprietary Wireless MAC Layer
181Proprietary Wireless Downstream
182Proprietary Wireless Upstream
183HIPERLAN Type 2
184Proprietary Broadband Wireless Access Point to Mulipoint
185SONET Overhead Channel
186Digital Wrapper Overhead Channel
187ATM Adaptation Layer 2
188Radio MAC
189ATM Radio
190Inter Machine Trunk
191MVL DSL
192Long Read DSL
193Frame Relay DLCI Endpoint
194ATM VCI Endpoint
195Optical Channel
196Optical Transport
197Proprietary ATM
198Voice over Cable
199Infiniband
200TE Link
201Q.2931
202Virtual Trunk Group
203SIP Trunk Group
204SIP Signaling
205CATV Upstream Channel
206Econet
207FSAN 155Mb PON
208FSAN 622Mb PON
209Transparent Bridge
210Line Group
211Voice E
212Voice FGD EANA
213Voice DID
214MPEG Transport
2156To4
216GTP
217Paradyne EtherLoop 1
218Paradyne EtherLoop 2
219Optical Channel Group
220HomePNA
221GFP
222ciscoISLvlan
223actelisMetaLOOP
224Fcip
225..4095IANA Reserved
4096IPv4
4097IPv6
4098IPv4/v6
4099IPX
4100DECnet
4101SNA
4102CONP
4103CLNP
4104VINES
4105XNS
4106ISDN B Channel Endpoint
4107ISDN D Channel Endpoint
4108BGP
4109OSPF
4110UDP
4111TCP
4112802.11a
4113802.11b
4114802.11g
4115802.11h
4200NFS
4201CIFS
4202DAFS
4203WebDAV
4204HTTP
4205FTP
4300NDMP
4301..32767DMTF Reserved
32768..Vendor Reserved
Property OtherTypeDescription Qualifiers
NameTypeValueFrom Class
DescriptionstringA string that describes the type of ProtocolEndpoint when the Type property of this class (or any of its subclasses) is set to 1 (Other). This property should be set to null when the Type property is any value other than 1. CIM_ProtocolEndpoint
MaxLenuint3264 CIM_ProtocolEndpoint
ModelCorrespondencestringCIM_ProtocolEndpoint.ProtocolType
CIM_ProtocolEndpoint.ProtocolIFType
CIM_ProtocolEndpoint

Property BroadcastResetSupported Qualifiers
NameTypeValueFrom Class
DescriptionstringA boolean indicating whether the instrumentation supports the BroadcastReset method. CIM_ProtocolEndpoint
MappingStringsstringFC-SWAPI.INCITS-T11|SWAPI_PORT_CONFIG_CAPS_T.PortForceLipSupported CIM_ProtocolEndpoint
ModelCorrespondencestringCIM_ProtocolEndpoint.BroadcastReset CIM_ProtocolEndpoint

Property SystemCreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_ServiceAccessPoint
PropagatedstringCIM_System.CreationClassName CIM_ServiceAccessPoint
DescriptionstringThe CreationClassName of the scoping System. CIM_ServiceAccessPoint
MaxLenuint32256 CIM_ServiceAccessPoint

Property SystemName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_ServiceAccessPoint
PropagatedstringCIM_System.Name CIM_ServiceAccessPoint
DescriptionstringThe Name of the scoping System. CIM_ServiceAccessPoint
MaxLenuint32256 CIM_ServiceAccessPoint

Property CreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_ServiceAccessPoint
DescriptionstringCreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified. CIM_ServiceAccessPoint
MaxLenuint32256 CIM_ServiceAccessPoint

Property Name Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_ServiceAccessPoint
OverridestringName CIM_ServiceAccessPoint
DescriptionstringThe Name property uniquely identifies the ServiceAccessPoint and provides an indication of the functionality that is managed. This functionality is described in more detail in the Description property of the object. CIM_ServiceAccessPoint
MaxLenuint32256 CIM_ServiceAccessPoint

Property EnabledState Qualifiers
NameTypeValueFrom Class
DescriptionstringEnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states: Enabled (2) indicates that the element is or could be executing commands, will process any queued commands, and queues new requests. Disabled (3) indicates that the element will not execute commands and will drop any new requests. Shutting Down (4) indicates that the element is in the process of going to a Disabled state. Not Applicable (5) indicates the element does not support being enabled or disabled. Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests. Test (7) indicates that the element is in a test state. Deferred (8) indicates that the element might be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The behavior of the element is similar to the Enabled state, but it processes only a restricted set of commands. All other requests are queued. Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringUnknown
Other
Enabled
Disabled
Shutting Down
Not Applicable
Enabled but Offline
In Test
Deferred
Quiesce
Starting
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.OtherEnabledState CIM_EnabledLogicalElement

NameValue
0Unknown
1Other
2Enabled
3Disabled
4Shutting Down
5Not Applicable
6Enabled but Offline
7In Test
8Deferred
9Quiesce
10Starting
11..32767DMTF Reserved
32768..65535Vendor Reserved
Property OtherEnabledState Qualifiers
NameTypeValueFrom Class
DescriptionstringA string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ( " Other " ). This property must be set to null when EnabledState is any value other than 1. CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement

Property RequestedState Qualifiers
NameTypeValueFrom Class
DescriptionstringRequestedState is an integer enumeration that indicates the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Note that when EnabledState is set to 5 ( " Not Applicable " ), then this property has no meaning. By default, the RequestedState of the element is 5 ( " No Change " ). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration. It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are " Reboot " (10) and " Reset " (11). Reboot refers to doing a " Shut Down " and then moving to an " Enabled " state. Reset indicates that the element is first " Disabled " and then " Enabled " . The distinction between requesting " Shut Down " and " Disabled " should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code. A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ( " Not Applicable " ) is used. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Shut Down
No Change
Offline
Test
Deferred
Quiesce
Reboot
Reset
Not Applicable
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement

NameValue
2Enabled
3Disabled
4Shut Down
5No Change
6Offline
7Test
8Deferred
9Quiesce
10Reboot
11Reset
12Not Applicable
..DMTF Reserved
32768..65535Vendor Reserved
Property EnabledDefault Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_EnabledLogicalElement
DescriptionstringAn enumerated value indicating an administrator ’ s default or startup configuration for the Enabled State of an element. By default, the element is " Enabled " (value=2). CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Not Applicable
Enabled but Offline
No Default
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement

NameValue
2Enabled
3Disabled
5Not Applicable
6Enabled but Offline
7No Default
8..32767DMTF Reserved
32768..65535Vendor Reserved
Property TimeOfLastStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringThe date or time when the EnabledState of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated. CIM_EnabledLogicalElement

Property InstallDate Qualifiers
NameTypeValueFrom Class
DescriptionstringA datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed. CIM_ManagedSystemElement
MappingStringsstringMIF.DMTF|ComponentID|001.5 CIM_ManagedSystemElement

Property Name Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property. CIM_ManagedSystemElement
MaxLenuint321024 CIM_ManagedSystemElement

Property OperationalStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration ’ s values are self-explanatory. However, a few are not and are described here in more detail. " Stressed " indicates that the element is functioning, but needs attention. Examples of " Stressed " states are overload, overheated, and so on. " Predictive Failure " indicates that an element is functioning nominally but predicting a failure in the near future. " In Service " describes an element being configured, maintained, cleaned, or otherwise administered. " No Contact " indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. " Lost Communication " indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. " Stopped " and " Aborted " are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated. " Dormant " indicates that the element is inactive or quiesced. " Supporting Entity in Error " indicates that this element might be " OK " but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower-layer networking problems. " Completed " indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error). " Power Mode " indicates that the element has additional power model information contained in the Associated PowerManagementService association. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today ’ s environment to the future. This change was not made earlier because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or instrumentation provide both the Status and OperationalStatus properties. Further, the first value of OperationalStatus should contain the primary status for the element. When instrumented, Status (because it is single-valued) should also provide the primary status of the element. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
Other
OK
Degraded
Stressed
Predictive Failure
Error
Non-Recoverable Error
Starting
Stopping
Stopped
In Service
No Contact
Lost Communication
Aborted
Dormant
Supporting Entity in Error
Completed
Power Mode
DMTF Reserved
Vendor Reserved
CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptions CIM_ManagedSystemElement

NameValue
0Unknown
1Other
2OK
3Degraded
4Stressed
5Predictive Failure
6Error
7Non-Recoverable Error
8Starting
9Stopping
10Stopped
11In Service
12No Contact
13Lost Communication
14Aborted
15Dormant
16Supporting Entity in Error
17Completed
18Power Mode
..DMTF Reserved
0x8000..Vendor Reserved
Property StatusDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringStrings describing the various OperationalStatus array values. For example, if " Stopping " is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus. CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatus CIM_ManagedSystemElement

Property Status Qualifiers
NameTypeValueFrom Class
DescriptionstringA string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
MaxLenuint3210 CIM_ManagedSystemElement

NameValue
OK[none]
Error[none]
Degraded[none]
Unknown[none]
Pred Fail[none]
Starting[none]
Stopping[none]
Service[none]
Stressed[none]
NonRecover[none]
No Contact[none]
Lost Comm[none]
Stopped[none]
Property HealthState Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined: " Non-recoverable Error " (30) - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost. " Critical Failure " (25) - The element is non-functional and recovery might not be possible. " Major Failure " (20) - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working. " Minor Failure " (15) - All functionality is available but some might be degraded. " Degraded/Warning " (10) - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors. " OK " (5) - The element is fully functional and is operating within normal operational parameters and without error. " Unknown " (0) - The implementation cannot report on HealthState at this time. DMTF has reserved the unused portion of the continuum for additional HealthStates in the future. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
OK
Degraded/Warning
Minor failure
Major failure
Critical failure
Non-recoverable error
DMTF Reserved
CIM_ManagedSystemElement

NameValue
0Unknown
5OK
10Degraded/Warning
15Minor failure
20Major failure
25Critical failure
30Non-recoverable error
..DMTF Reserved
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
BroadcastResetuint32 Experimental
Description
ValueMap
Values
ModelCorrespondence
 CIM_ProtocolEndpoint
RequestStateChangeuint32 Description
ValueMap
Values
ModelCorrespondence
RequestedState
TimeoutPeriod
CIM_EnabledLogicalElement

Method Qualifiers

Method BroadcastReset Qualifiers
NameTypeValueFrom Class
DescriptionstringSend a broadcast reset. A broadcast reset is a request that peers perform a reset. Examples include a parallel SCSI Bus Reset and a Fibre Channel LIP. CIM_ProtocolEndpoint
ValueMapstring
[See below.]
CIM_ProtocolEndpoint
ValuesstringSuccess
Not_Supported
Unspecified Error
Timeout
Failed
DMTF_Reserved
Method_Reserved
Vendor_Reserved
CIM_ProtocolEndpoint
ModelCorrespondencestringCIM_ProtocolEndpoint.BroadcastResetSupported CIM_ProtocolEndpoint

Method RequestStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringRequests that the state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringCompleted with No Error
Not Supported
Unknown or Unspecified Error
Cannot complete within Timeout Period
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Job Started
Invalid State Transition
Use of Timeout Parameter Not Supported
Busy
Method Reserved
Vendor Specific
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement

Parameters

Method RequestStateChange Parameters
NameTypeQualifiers
RequestedStateuint16IN
Description
ValueMap
Values
ModelCorrespondence
TimeoutPerioddatetimeIN
Description

Parameter Qualifiers

Parameter RequestedState Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_EnabledLogicalElement
DescriptionstringThe state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ( ’ Completed with No Error ’ ), 3 ( ’ Timeout ’ ), or 4096 (0x1000) ( ’ Job Started ’ ). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Shut Down
Offline
Test
Defer
Quiesce
Reboot
Reset
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement

Parameter TimeoutPeriod Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_EnabledLogicalElement
DescriptionstringA timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of ’ Use Of Timeout Parameter Not Supported ’ must be returned. CIM_EnabledLogicalElement

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_FilterOfSecurityAssociationCIM_SecurityAssociationEndpointDependent
CIM_Phase1SAUsedForPhase2CIM_SecurityAssociationEndpointAntecedent
CIM_RuleThatGeneratedSACIM_SecurityAssociationEndpointDependent
CIM_TrapSourceForSNMPServiceCIM_ProtocolEndpointAntecedent
CIM_CalculatesAmongCIM_ProtocolEndpointAntecedent
CIM_EgressConditioningServiceOnEndpointCIM_ProtocolEndpointAntecedent
CIM_ForwardsAmongCIM_ProtocolEndpointAntecedent
CIM_NATServiceRunningOnEndpointCIM_ProtocolEndpointAntecedent
CIM_IngressConditioningServiceOnEndpointCIM_ProtocolEndpointAntecedent
CIM_PortImplementsEndpointCIM_ProtocolEndpointDependent
CIM_RouteUsesEndpointCIM_ProtocolEndpointAntecedent
CIM_BindsToCIM_ProtocolEndpointAntecedent
CIM_ProvidesEndpointCIM_ProtocolEndpointDependent
CIM_ConditioningServiceOnEndpointCIM_ProtocolEndpointAntecedent
CIM_SWRPEPAspectCIM_ProtocolEndpointSystemElement
CIM_EndpointIdentityCIM_ProtocolEndpointSystemElement
CIM_EndpointIdentityCIM_ProtocolEndpointSameElement
CIM_InLogicalNetworkCIM_ProtocolEndpointMember
CIM_HostedAccessPointCIM_ServiceAccessPointDependent
CIM_ServiceSAPDependencyCIM_ServiceAccessPointAntecedent
CIM_SoftwareElementSAPImplementationCIM_ServiceAccessPointDependent
CIM_SoftwareFeatureSAPImplementationCIM_ServiceAccessPointDependent
CIM_DeviceSAPImplementationCIM_ServiceAccessPointDependent
CIM_EndpointOfNetworkPipeCIM_ServiceAccessPointAntecedent
CIM_SAPSAPDependencyCIM_ServiceAccessPointAntecedent
CIM_SAPSAPDependencyCIM_ServiceAccessPointDependent
CIM_ActiveConnectionCIM_ServiceAccessPointAntecedent
CIM_ActiveConnectionCIM_ServiceAccessPointDependent
CIM_BindsToCIM_ServiceAccessPointDependent
CIM_BindsToLANEndpointCIM_ServiceAccessPointDependent
CIM_ServiceAccessBySAPCIM_ServiceAccessPointDependent
CIM_SAPStatisticsCIM_ServiceAccessPointElement
CIM_SAPAvailableForElementCIM_ServiceAccessPointAvailableSAP
CIM_ManagementSAPCIM_ServiceAccessPointAvailableSAP
CIM_ReplicaPoolForStorageCIM_EnabledLogicalElementAntecedent
CIM_RemoteAccessAvailableToElementCIM_EnabledLogicalElementDependent
CIM_LogicalElementPerformsUoWCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementAntecedent
CIM_ImportedShareRootCIM_LogicalElementDependent
CIM_LogicalElementUnitOfWorkDefCIM_LogicalElementAntecedent
CIM_SharedElementRootCIM_LogicalElementAntecedent
CIM_OperationLogCIM_LogicalElementDependent
CIM_AllocatedFromStoragePoolCIM_LogicalElementDependent
CIM_ResidesOnExtentCIM_LogicalElementDependent
CIM_AssociatedMemoryCIM_LogicalElementDependent
CIM_AttachedElementCIM_LogicalElementSystemElement
CIM_AttachedElementCIM_LogicalElementSameElement
CIM_MountedElementCIM_LogicalElementSystemElement
CIM_MountedElementCIM_LogicalElementSameElement
CIM_ImportedShareCIM_LogicalElementSystemElement
CIM_ImportedShareCIM_LogicalElementSameElement
CIM_SharedElementCIM_LogicalElementSystemElement
CIM_RedundancyComponentCIM_ManagedSystemElementPartComponent
CIM_SystemComponentCIM_ManagedSystemElementPartComponent
CIM_UseOfLogCIM_ManagedSystemElementDependent
CIM_DiagnosticTestForMSECIM_ManagedSystemElementDependent
CIM_CollectedMSEsCIM_ManagedSystemElementMember
CIM_DiagnosticResultForMSECIM_ManagedSystemElementSystemElement
CIM_ElementConfigurationCIM_ManagedSystemElementElement
CIM_ElementSettingCIM_ManagedSystemElementElement
CIM_ActsAsSpareCIM_ManagedSystemElementSpare
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