Edit

Share via

MSFT_NetIPAddress class

  • Article

The representation of IPv4 address and IPv6 address.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[UMLPackagePath("CIM::Network::ProtocolEndpoints"), ClassVersion("1.0.0"), dynamic, provider("nettcpip"), AMENDMENT]
class MSFT_NetIPAddress : CIM_IPProtocolEndpoint
{
  string   InstanceID;
  string   Caption;
  string   ElementName;
  datetime InstallDate;
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  uint16   TransitioningToState = 12;
  uint16   AvailableRequestedStates[];
  string   SystemCreationClassName;
  string   SystemName;
  string   CreationClassName;
  string   Description;
  string   Name;
  uint16   OperationalStatus[];
  uint16   EnabledState;
  datetime TimeOfLastStateChange;
  string   NameFormat;
  uint16   ProtocolType;
  string   OtherTypeDescription;
  uint16   ProtocolIFType = 4096;
  string   IPv4Address;
  string   IPv6Address;
  string   Address;
  string   SubnetMask;
  uint8    PrefixLength;
  uint16   AddressType;
  uint16   IPVersionSupport;
  uint16   AddressOrigin = 0;
  uint32   InterfaceIndex;
  string   InterfaceAlias;
  string   IPAddress;
  uint16   AddressFamily;
  uint8    Type;
  uint8    Store;
  uint16   PrefixOrigin;
  uint16   SuffixOrigin;
  uint16   AddressState;
  datetime ValidLifetime;
  datetime PreferredLifetime;
  boolean  SkipAsSource;
};

Members

The MSFT_NetIPAddress class has these types of members:

Methods

The MSFT_NetIPAddress class has these methods.

Method Description
Create Creates the IP address.
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 enabled state and requested state of the element will be the same. Invoking the RequestChangeState 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 CIM_ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, CIM_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 MSFT_NetIPAddress 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 protocol endpoint 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.

This property is inherited from CIM_IPProtocolEndpoint.

AddressFamily

Data type: uint16

Access type: Read-only

Indicates whether the address family for this IP address is v4 or v6.

Value Meaning
IPv4
2
 The address family is IPv4
IPv6
23
 The address family is IPv6

AddressOrigin

Data type: uint16

Access type: Read-only

Identifies the method by which the IP Address, Subnet Mask, and Gateway were assigned to the IPProtocolEndpoint.

This property is inherited from CIM_IPProtocolEndpoint.

Value Meaning
Unknown
0
Other
1
Not Applicable
2
Static
3
 The values were assigned manually.
DHCP
4
 The values were assigned utilizing the Dynamic Host Configuration Protocol. See RFC 2131 and related.
BOOTP
5
 The values were assigned utilizing BOOTP. See RFC 951 and related.
IPv4 Link Local
6
 The values were assigned using the IPv4 Link Local protocol. See RFC 3927.
DHCPv6
7
 The values were assigned using DHCPv6. See RFC 3315.
IPv6AutoConfig
8
 The values were assigned using the IPv6 AutoConfig Protocol. See RFC 4862.
DMTF Reserved
9 32767
Vendor Reserved
32768 65535

AddressState

Data type: uint16

Access type: Read-only

Address lifetime state.

Invalid (0)

Tentative (1)

Duplicate (2)

Deprecated (3)

Preferred (4)

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).

This property is inherited from CIM_IPProtocolEndpoint.

Unknown (0)

IPv4 (1)

IPv6 (2)

AvailableRequestedStates

Data type: uint16 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.RequestStateChange", "CIM_EnabledLogicalElementCapabilities.RequestedStatesSupported")

AvailableRequestedStates indicates the possible values for the RequestedState parameter of the method RequestStateChange, used to initiate a state change. The values listed shall be a subset of the values contained in the RequestedStatesSupported property of the associated instance of CIM_EnabledLogicalElementCapabilities where the values selected are a function of the current state of the CIM_EnabledLogicalElement. This property may be non-null if an implementation is able to advertise the set of possible values as a function of the current state. This property shall be null if an implementation is unable to determine the set of possible values as a function of the current state.

This property is inherited from CIM_EnabledLogicalElement.

Enabled (2)

Disabled (3)

Shut Down (4)

Offline (6)

Test (7)

Defer (8)

Quiesce (9)

Reboot (10)

Reset (11)

DMTF Reserved (12 65535)

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

Contains a short textual description of the object.

This property is inherited from CIM_ManagedElement.

CommunicationStatus

Data type: uint16

Access type: Read-only

Indicates the ability of the instrumentation to communicate with this element. A NULL value indicates that instrumentation does not support this property.

This property is inherited from CIM_ManagedSystemElement.

Values Meaning
Unknown
0
 Indicates that the instrumentation cannot report on the CommunicationStatus property at this time.
Not Available
1
 Indicates that the instrumentation is capable of reporting this property, but intentionally does not for this element.
Communication OK
2
 Indicates only that communication is established with the element.
Lost Communication
3
 Indicates that the element has been contacted in the past, but is currently unreachable.
No Contact
4
 Indicates that the instrumentation has contact information for this element, but has never been able to communicate with it.
DMTF Reserved
5 32767
 Reserved.
Vendor Reserved
32768 = value
Reserved.

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: key, MaxLen (256)

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

The Description property provides a textual description of the object.

This property is inherited from CIM_ProtocolEndpoint.

DetailedStatus

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.PrimaryStatus", "CIM_ManagedSystemElement.HealthState")

Indicates additional status details that complement the PrimaryStatus property. A NULL value indicates that the instrumentation does not support this property.

This property is inherited from CIM_ManagedSystemElement.

Values Meaning
Not Available
0
 Indicates that the instrumentation is capable of reporting this property, but intentionally does not report it for this element.
No Additional Information
1
 Indicates that no details have to be added to the PrimaryStatus property, for example when the PrimaryStatus is set to OK.
Stressed
2
 Indicates that the element functions, but requires attention. Overload and overheated are examples of Stressed states.
Predictive Failure
3
 Indicates that an element functions nominally, but predicts a failure in the near future.
Non-Recoverable Error
4
 Indicates that this element is in an error condition that requires human intervention.
Supporting Entity in Error
5
 Indicates that an element on which this element depends is in error. This element might be OK but cannot function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.
DMTF Reserved
6 32767
 Reserved.
Vendor Reserved
32768 = value
Reserved.

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 (10 32767)

Vendor Reserved (32768 65535)

EnabledState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")

EnabledState 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.

This property is inherited from CIM_ProtocolEndpoint.

Value Meaning
Unknown
0
 The element state is unknown.
Other
1
 The element is in a state other than one listed here.
Enabled
2
 The element is or could be executing commands, will process any queued commands, and queues new requests.
Disabled
3
 The element will not execute commands and will drop any new requests.
Shutting Down
4
 The element is in the process of going to a Disabled state.
Not Applicable
5
 The element does not support being enabled or disabled.
Enabled but Offline
6
 The element might be completing commands, and will drop any new requests.
In Test
7
 The element is in a test state.
Deferred
8
 The element might be completing commands, but will queue any new requests.
Quiesce
9
 The element is enabled but in a restricted mode.
Starting
10
 The element is in the process of going to an Enabled state. New requests are queued.
DMTF Reserved
11 32767
Vendor Reserved
32768 65535

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.

Values Meaning
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
31 = value
DMTF has reserved the unused portion of the continuum for additional HealthStates values in the future.

InstallDate

Data type: datetime

Access type: Read-only

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.

InstanceID

Data type: string

Access type: Read-only

Uniquely and opaquely identifies an instance of this class within the scope of the containing Namespace.

[!Important]In order to ensure uniqueness within the Namespace, the value of InstanceID should be constructed in the following pattern:

OrgID:LocalID

OrgID must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity defining the InstanceID, or be a registered ID that is assigned by a recognized global authority. This is similar to the structure of Schema class names. In addition, to ensure uniqueness the first colon in InstanceID must be between the OrgID andLocalID. Therefor the OrgID must not contain a colon (':').

LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.

If the preceding pattern 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 Namespace.

For Distributed Management Task Force (DMTF) defined instances, the pattern must be used with the OrgID set to CIM.

This property is inherited from CIM_ManagedElement.

InterfaceAlias

Data type: string

Access type: Read-only

The user-friendly interface name.

InterfaceIndex

Data type: uint32

Access type: Read-only

The user-friendly interface index.

IPAddress

Data type: string

Access type: Read-only

The IP address.

IPv4Address

Data type: string

Access type: Read-only

The IPv4 address that this ProtocolEndpoint represents.

This property is inherited from CIM_IPProtocolEndpoint.

IPv6Address

Data type: string

Access type: Read-only

The IPv6 address that this ProtocolEndpoint represents.

This property is inherited from CIM_IPProtocolEndpoint.

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).

This property is inherited from CIM_IPProtocolEndpoint.

Unknown (0)

IPv4 Only (1)

IPv6 Only (2)

Both IPv4 and IPv6 (3)

Name

Data type: string

Access type: Read-only

Qualifiers: MaxLen (256), key

A string that identifies this protocol endpoint 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.

OperatingStatus

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

Indicates the current operational condition of the element. This property can be used to provide more detail about the current state of the element. It can also indicate transitional states. A NULL value indicates that the instrumentation does not support this property.

This property is inherited from CIM_ManagedSystemElement.

Value Meaning
Unknown
0
 Indicates that the instrumentation cannot report on the OperatingStatus property at this time.
Not Available
1
 Indicates that the instrumentation is capable of reporting this property, but intentionally does not report it for this element.
Servicing
2
 Indicates that the element is in process to be configured, maintained, cleaned, or otherwise administered.
Starting
3
 Indicates that the element is being initialized.
Stopping
4
 Indicates that the element is being brought to an orderly stop.
Stopped
5
 Indicates that the element is intentionally stopped.
Aborted
6
 Indicates that the element stopped in an unexpected way.
Dormant
7
 Indicates that the element is inactive or quiesced.
Completed
8
 Indicates that the element completed its operation. We recommend using a PrimaryStatus property value of OK, Error, or Degraded to indicate success or failure of the operation.
Migrating
9
 Indicates that the element is being moved between host elements.
Emigrating
10
 Indicates that the element is being moved away from the host element.
Immigrating
11
 Indicates that the element is being moved to a new host element.
Snapshotting
12
 Indicates that a snapshot copy of the element is being created.
Shutting Down
13
 Indicates that the element is being brought to an abrupt stop.
In Test
14
 Indicates that the element is performing test functions.
Transitioning
15
 Indicates that the element is between states and is not fully available in either state. Use another value that indicates a more specific transition if one is available.
In Service
16
 Indicates that the element is in service and operational.
DMTF Reserved
17 32767
 Reserved.
Vendor Reserved
32768 = value
Reserved.

OperationalStatus

Data type: uint16 array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

Contains indicators of the current status of the element. The first value of OperationalStatus should contain the primary status for the element.

Note

OperationalStatus replaces the deprecated Status property. Due to the widespread use of the existing Status property in management applications, Microsoft strongly recommends that providers or instrumentation provide both the Status and OperationalStatus properties. When instrumented, Status (because it is single-valued) should also provide the primary status of the element.

This property is inherited from CIM_ProtocolEndpoint.

Values Meaning
Unknown
0
 Indicates the implementation cannot report on OperationalStatus at this time.
Other
1
 Indicates an undefined state.
OK
2
 Indicates full functionality without errors.
Degraded
3
 Indicates the element is working 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
Stressed
4
 Indicates that the element is functioning, but needs attention. Overload and overheated are examples of Stressed states.
Predictive Failure
5
 Indicates that an element is functioning nominally but predicting a failure in the near future.
Error
6
 Indicates that an error has occurred.
Non-Recoverable Error
7
 A nonrecoverable error has occurred.
Starting
8
 The job is starting.
Stopping
9
 The job is stopping.
Stopped
10
 The element has been intentionally stopped.
In Service
11
 Indicates the element is being configured, maintained, cleaned, or otherwise administered.
No Contact
12
 Indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.
Lost Communication
13
 Indicates that the job is known to exist and has been contacted successfully in the past, but is currently unreachable.
Aborted
14
 Indicates the job stopped in an unexpected way. The state and configuration of the job might need to be updated.
Dormant
15
 Indicates that the job is inactive.
Supporting Entity in Error
16
 Indicates that an element on which this job depends is in error. This element may be OK but is unable to function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.
Completed
17
 Indicates that the job has completed its operation. This value should be combined with either OK, ErrorError, 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
18
 "Power Mode" indicates that the element has additional power model information contained in the associated PowerManagementService association.
DMTF Reserved
19 32767
 DMTF has reserved this portion of the range for additional OperationalStatus values in the future.
Vendor Reserved
32768 65535
 Microsoft has reserved the unused portion of the range for additional OperationalStatus values in the future.

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")

Describes the type of Protocol Endpoint 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.

PreferredLifetime

Data type: datetime

Access type: Read/write

Lifetime over which the address is preferred. The default value is infinite.

PrefixLength

Data type: uint8

Access type: Read-only

The prefix length for the IPv6 address of this Protocol Endpoint, if one is defined.

This property is inherited from CIM_IPProtocolEndpoint.

PrefixOrigin

Data type: uint16

Access type: Read/write

Prefix origin of this address.

Other (0)

Manual (1)

WellKnown (2)

Dhcp (3)

RouterAdvertisement (4)

PrimaryStatus

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_ManagedSystemElement.DetailedStatus", "CIM_ManagedSystemElement.HealthState")

Indicates a high-level status value.

This property is inherited from CIM_ManagedSystemElement.

The possible values are.

Unknown (0)

OK (1)

Degraded (2)

Error (3)

DMTF Reserved (4 32767)

Vendor Reserved (32768 = value )

ProtocolIFType

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_ProtocolEndpoint.OtherTypeDescription")

ProtocolIFType's enumeration is limited to IP-related and reserved values for this subclass of ProtocolEndpoint.

This property is inherited from CIM_IPProtocolEndpoint.

Other (1)

IANA Reserved (225 4095)

IPv4 (4096)

IPv6 (4097)

IPv4/v6 (4098)

DMTF Reserved (4301 32767)

Vendor Reserved (32768 65535)

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. 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 StartService 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 CIM_EnabledLogicalElement might not support RequestStateChange. If this occurs, the value 12 ("Not Applicable") is used.

This property is inherited from CIM_EnabledLogicalElement.

Unknown (0)

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 (13 32767)

Vendor Reserved (32768 65535)

SkipAsSource

Data type: boolean

Access type: Read/write

true to not use the address as source address for any outgoing packet unless explicitly asked to.

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.

The possible values are.

("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")

Indicates descriptions of the corresponding values in the OperationalStatus array. For example, if an element in the OperationalStatus property contains the value Stopping, then the element at the same array index in this property might contain an explanation as to why an object is being stopped.

This property is inherited from CIM_ManagedSystemElement.

Store

Data type: uint8

Access type: Read-only

Describes if the set is active or persistent.

Value Meaning
Persistent
0
 Set is persistent (default).
Active
1
 Set only lasts until next boot.

SubnetMask

Data type: string

Access type: Read-only

The mask for the IPv4 address of this protocol endpoint, if one is defined.

This property is inherited from CIM_IPProtocolEndpoint.

SuffixOrigin

Data type: uint16

Access type: Read/write

Suffix origin of this address.

Other (0)

Manual (1)

WellKnown (2)

Dhcp (3)

Link (4)

Random (5)

SystemCreationClassName

Data type: string

Access type: Read-only

Qualifiers: key, MaxLen (256), Propagated ("CIM_System.CreationClassName")

The CreationClassName of the scoping System.

This property is inherited from CIM_ServiceAccessPoint.

SystemName

Data type: string

Access type: Read-only

Qualifiers: key, MaxLen (256), Propagated ("CIM_System.Name")

The Name of the scoping System.

This property is inherited from CIM_ServiceAccessPoint.

TimeOfLastStateChange

Data type: datetime

Access type: Read-only

The 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.

This property is inherited from CIM_ProtocolEndpoint.

TransitioningToState

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.RequestStateChange", "CIM_EnabledLogicalElement.RequestedState", "CIM_EnabledLogicalElement.EnabledState")

TransitioningToState indicates the target state to which the instance is transitioning.

A value of 5 "No Change" shall indicate that no transition is in progress.A value of 12 "Not Applicable" shall indicate the implementation does not support representing ongoing transitions.

A value other than 5 or 12 shall identify the state to which the element is in the process of transitioning.

This property is inherited from CIM_EnabledLogicalElement.

Unknown (0)

Enabled (2)

Disabled (3)

Shut Down (4)

No Change (5)

Offline (6)

Test (7)

Defer (8)

Quiesce (9)

Reboot (10)

Reset (11)

Not Applicable (12)

DMTF Reserved (13 65535)

Type

Data type: uint8

Access type: Read-only

The type of address.

Value Meaning
Unicast
1
 Marks the address as a unicast address. This is the default
Anycast
2
 Marks the address as an anycast address

ValidLifetime

Data type: datetime

Access type: Read/write

Lifetime over which the address is valid. The default value is infinite.

Requirements
Minimum supported client
 Windows 8
Minimum supported server
 Windows Server 2012
Namespace
 Root\StandardCimv2
MOF
NetTCPIP.mof
DLL
NetTCPIP.dll