CIM_IPProtocolEndpoint class
A ProtocolEndpoint that is dedicated to running IP.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[Abstract, Version("2.8.0"), UMLPackagePath("CIM::Network::ProtocolEndpoints")]
class CIM_IPProtocolEndpoint : CIM_ProtocolEndpoint
{
string Caption;
string ElementName;
datetime InstallDate;
string StatusDescriptions[];
string Status;
uint16 HealthState;
string OtherEnabledState;
uint16 RequestedState = 12;
uint16 EnabledDefault = 2;
string SystemCreationClassName;
string SystemName;
string CreationClassName;
datetime TimeOfLastStateChange;
uint16 EnabledState;
uint16 OperationalStatus[];
string Description;
string Name;
string NameFormat;
uint16 ProtocolType;
string OtherTypeDescription;
string IPv4Address;
string IPv6Address;
string Address;
string SubnetMask;
uint8 PrefixLength;
uint16 AddressType;
uint16 IPVersionSupport;
uint16 ProtocolIFType = 4096;
};
Members
The CIM_IPProtocolEndpoint class has these types of members:
Methods
The CIM_IPProtocolEndpoint class has these methods.
| Method | Description |
|---|---|
| RequestStateChange | Requests 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. This method is inherited from CIM_EnabledLogicalElement. |
Properties
The CIM_IPProtocolEndpoint class has these properties.
-
Address
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_IPProtocolEndpoint.IPv4Address", "CIM_IPProtocolEndpoint.IPv6Address")
The IP address that this ProtocolEndpoint represents, formatted according to the appropriate convention as defined in the AddressType property of this class (e.g., 171.79.6.40). This single property is deprecated to replace it by specific IPv4 and v6 addresses.
-
-
AddressType
-
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: Deprecated ("No value")
An enumeration that describes the format of the Address property. It is deprecated since it is not needed, as the class contains both IPv4 and v6 addresses).
-
-
Unknown (0)
-
IPv4 (1)
-
IPv6 (2)
Caption
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
The Caption property is a short textual description (one- line string) of the object.
This property is inherited from CIM_ManagedElement.
CreationClassName
CreationClassName 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.
This property is inherited from CIM_ServiceAccessPoint.
Description
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIB.IETF|IF-MIB.ifDescr")
TBD
This property is inherited from CIM_ProtocolEndpoint.
ElementName
-
Data type: string
-
Access type: Read-only
Contains a 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.
This property is inherited from CIM_ManagedElement.
EnabledDefault
-
Data type: uint16
-
Access type: Read/write
An 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).
This property is inherited from CIM_EnabledLogicalElement.
Enabled (2)
Disabled (3)
Not Applicable (5)
Enabled but Offline (6)
No Default (7)
Quiesce (9)
DMTF Reserved
Vendor Reserved
EnabledState
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIB.IETF|IF-MIB.ifAdminStatus")
TBD
This property is inherited from CIM_ProtocolEndpoint.
HealthState
-
Data type: uint16
-
Access type: Read-only
Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its sub-components.
This property is inherited from CIM_ManagedSystemElement.
The following values have been defined:
Unknown (0)
The implementation cannot report on HealthState at this time.
OK (5)
The element is fully functional and is operating within normal operational parameters and without error.
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
Minor failure (15)
All functionality is available but some might be degraded.
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.
Critical failure (25)
The element is non-functional and recovery might not be possible.
Non-recoverable error (30)
The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost.
DMTF Reserved
DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.
InstallDate
-
Data type: datetime
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")
Indicates when the object was installed. The lack of a value does not indicate that the object is not installed.
This property is inherited from CIM_ManagedSystemElement.
IPv4Address
-
Data type: string
-
Access type: Read-only
The IPv4 address that this ProtocolEndpoint represents.
IPv6Address
-
Data type: string
-
Access type: Read-only
The IPv6 address that this ProtocolEndpoint represents.
IPVersionSupport
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ProtocolEndpoint.ProtocolIFType")
This property explicitly defines support for different versions of the IP protocol, for this Endpoint. It is deprecated since the ProtocolIFType also provides this functionality by describing an endpoint as IPv4 only (value=4096), IPv6 only (value=4097), or IPv4/v6 (value=4098).
Unknown (0)
IPv4 Only (1)
IPv6 Only (2)
Both IPv4 and IPv6 (3)
Name
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (256)
A 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.
This property is inherited from CIM_ProtocolEndpoint.
NameFormat
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (256)
NameFormat 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.
This property is inherited from CIM_ProtocolEndpoint.
OperationalStatus
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIB.IETF|IF-MIB.ifOperStatus")
TBD
This property is inherited from CIM_ProtocolEndpoint.
OtherEnabledState
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
A 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.
This property is inherited from CIM_EnabledLogicalElement.
OtherTypeDescription
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64), ModelCorrespondence ("CIM_ProtocolEndpoint.ProtocolType", "CIM_ProtocolEndpoint.ProtocolIFType")
A 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.
This property is inherited from CIM_ProtocolEndpoint.
PrefixLength
-
Data type: uint8
-
Access type: Read-only
The prefix length for the IPv6 address of this Protocol Endpoint, if one is defined.
ProtocolIFType
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: Override ("ProtocolIFType")
ProtocolIFType's enumeration is limited to IP-related and reserved values for this subclass of ProtocolEndpoint.
Other (1)
IANA Reserved
IPv4 (4096)
IPv6 (4097)
IPv4/v6 (4098)
DMTF Reserved
Vendor Reserved
ProtocolType
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ProtocolEndpoint.ProtocolIFType"), ModelCorrespondence ("CIM_ProtocolEndpoint.OtherTypeDescription")
Note: 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.
This property is inherited from CIM_ProtocolEndpoint.
Unknown (0)
Other (1)
IPv4 (2)
IPv6 (3)
IPX (4)
AppleTalk (5)
DECnet (6)
SNA (7)
CONP (8)
CLNP (9)
VINES (10)
XNS (11)
ATM (12)
Frame Relay (13)
Ethernet (14)
TokenRing (15)
FDDI (16)
Infiniband (17)
Fibre Channel (18)
ISDN BRI Endpoint (19)
ISDN B Channel Endpoint (20)
ISDN D Channel Endpoint (21)
IPv4/v6 (22)
BGP (23)
OSPF (24)
MPLS (25)
UDP (26)
TCP (27)
RequestedState
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
RequestedState 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. Offline (6) indicates that the element has been requested to transition to the Enabled but Offline EnabledState. 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.
This property is inherited from CIM_EnabledLogicalElement.
Enabled (2)
Disabled (3)
Shut Down (4)
No Change (5)
Offline (6)
Test (7)
Deferred (8)
Quiesce (9)
Reboot (10)
Reset (11)
Not Applicable (12)
DMTF Reserved
Vendor Reserved
Status
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)
Contains a string indicating the primary status of the object.
Note
This property is deprecated and replaced by the OperationalStatus property. If you choose to use the Status property for backward compatibility it should be secondary to the OperationalStatus property.
This property is inherited from CIM_ManagedSystemElement.
("OK")
("Error")
("Degraded")
("Unknown")
("Pred Fail")
("Starting")
("Stopping")
("Service")
("Stressed")
("NonRecover")
("No Contact")
("Lost Comm")
("Stopped")
StatusDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")
Contains strings describing the corresponding values in the OperationalStatus array. For example, if an element in OperationalStatus contains the value Stopping, then the element at the same array index in this property may contain an explanation as to why an object is being stopped.
This property is inherited from CIM_ManagedSystemElement.
SubnetMask
-
Data type: string
-
Access type: Read-only
The mask for the IPv4 address of this ProtocolEndpoint, if one is defined.
SystemCreationClassName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)
The CreationClassName of the scoping System.
This property is inherited from CIM_ServiceAccessPoint.
SystemName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)
The Name of the scoping System.
This property is inherited from CIM_ServiceAccessPoint.
TimeOfLastStateChange
-
Data type: datetime
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIB.IETF|IF-MIB.ifLastChange")
TBD
This property is inherited from CIM_ProtocolEndpoint.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 R2 |
| Namespace |
Root\CIMv2\Storage\iScsiTarget |
| MOF |
|
| DLL |
|