MSFT_NetBaseIPProtocol, ROOT\StandardCimv2

Class | Childs (2) | Methods (1) | Properties (42) | Qualifiers (6) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

The base class of IPv4 and IPv6 protocol for Microsoft TCPIP WMIv2 provider.

MSFT_NetBaseIPProtocol - child subclasses in ROOT\StandardCimv2

Number of classes:2
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
MSFT_NetIPv4Protocol04211---
MSFT_NetIPv6Protocol04811---

MSFT_NetBaseIPProtocol methods

MSFT_NetBaseIPProtocol has 1 methods (1 Derived)

NameOriginReturn
RequestStateChangeCIM_EnabledLogicalElementuint32 {'out':True}

MSFT_NetBaseIPProtocol properties

MSFT_NetBaseIPProtocol has 42 properties (14 Local, 28 Derived)

NameOriginCIMType
AddressMaskReplyMSFT_NetBaseIPProtocol17 [uint8]
AvailableRequestedStatesCIM_EnabledLogicalElement18 [uint16]
CaptionCIM_ManagedElement8 [string]
CommunicationStatusCIM_ManagedSystemElement18 [uint16]
key
CreationClassName
CIM_ServiceAccessPoint8 [string]
DefaultHopLimitMSFT_NetBaseIPProtocol19 [uint32]
DescriptionCIM_ManagedElement8 [string]
DetailedStatusCIM_ManagedSystemElement18 [uint16]
DhcpMediaSenseMSFT_NetBaseIPProtocol17 [uint8]
ElementNameCIM_ManagedElement8 [string]
EnabledDefaultCIM_EnabledLogicalElement18 [uint16]
EnabledStateCIM_EnabledLogicalElement18 [uint16]
GroupForwardedFragmentsMSFT_NetBaseIPProtocol17 [uint8]
HealthStateCIM_ManagedSystemElement18 [uint16]
IcmpRedirectsMSFT_NetBaseIPProtocol17 [uint8]
InstallDateCIM_ManagedSystemElement101 [datetime]
InstanceIDCIM_ManagedElement8 [string]
MediaSenseEventLogMSFT_NetBaseIPProtocol17 [uint8]
MldLevelMSFT_NetBaseIPProtocol19 [uint32]
MldVersionMSFT_NetBaseIPProtocol19 [uint32]
MulticastForwardingMSFT_NetBaseIPProtocol17 [uint8]
key
Name
CIM_ManagedSystemElement8 [string]
NameFormatCIM_ProtocolEndpoint8 [string]
NeighborCacheLimitMSFT_NetBaseIPProtocol19 [uint32]
OperatingStatusCIM_ManagedSystemElement18 [uint16]
OperationalStatusCIM_ManagedSystemElement18 [uint16]
OtherEnabledStateCIM_EnabledLogicalElement8 [string]
OtherTypeDescriptionCIM_ProtocolEndpoint8 [string]
PrimaryStatusCIM_ManagedSystemElement18 [uint16]
ProtocolIFTypeCIM_ProtocolEndpoint18 [uint16]
ProtocolTypeCIM_ProtocolEndpoint18 [uint16]
RandomizeIdentifiersMSFT_NetBaseIPProtocol17 [uint8]
ReassemblyLimitMSFT_NetBaseIPProtocol19 [uint32]
RequestedStateCIM_EnabledLogicalElement18 [uint16]
RouteCacheLimitMSFT_NetBaseIPProtocol19 [uint32]
SourceRoutingBehaviorMSFT_NetBaseIPProtocol19 [uint32]
StatusCIM_ManagedSystemElement8 [string]
StatusDescriptionsCIM_ManagedSystemElement8 [string]
key
SystemCreationClassName
CIM_ServiceAccessPoint8 [string]
key
SystemName
CIM_ServiceAccessPoint8 [string]
TimeOfLastStateChangeCIM_EnabledLogicalElement101 [datetime]
TransitioningToStateCIM_EnabledLogicalElement18 [uint16]

Detailed description of MSFT_NetBaseIPProtocol methods

Derived methods (1) of MSFT_NetBaseIPProtocol class

RequestStateChange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RequestedStateuint160-{'Description':'371','In':True,'ModelCorrespondence':['CIM_EnabledLogicalElement.RequestedState'],'ValueMap':['2', '3', '4', '6', '7', '8', '9', '10', '11', '..', '32768..65535'],'Values':['347', '348', '355', '357', '358', '365', '352', '359', '360', '29', '30']}
Jobref:CIM_ConcreteJob1-{'Description':'372','Out':True}
TimeoutPerioddatetime2-{'Description':'373','In':True}
Description'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.
A return code of 0 shall indicate the state change was successfully initiated.
A return code of 3 shall indicate that the state transition cannot complete within the interval specified by the TimeoutPeriod parameter.
A return code of 4096 (0x1000) shall indicate the state change was successfully initiated, a ConcreteJob has been created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.'
ModelCorrespondence['CIM_EnabledLogicalElement.RequestedState']
ValueMap['0', '1', '2', '3', '4', '5', '6', '..', '4096', '4097', '4098', '4099', '4100..32767', '32768..65535']
Values['Completed 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']
RequestStateChange method is in 33 classes of ROOT\StandardCimv2 and in 15 namespaces

Detailed description of MSFT_NetBaseIPProtocol properties

Local properties (14) of MSFT_NetBaseIPProtocol class

AddressMaskReply property
CIMTYPE'uint8'
Description'Whether the computer will respond to ICMP Address mask packets'
readTrue
ValueMap['0', '1']
Values['Disabled', 'Enabled']
writeTrue
AddressMaskReply property is in 3 classes of ROOT\StandardCimv2 and in 2 namespaces
DefaultHopLimit property
CIMTYPE'uint32'
Description'Default HopLimit of packets sent.'
readTrue
writeTrue
DefaultHopLimit property is in 3 classes of ROOT\StandardCimv2 and in 2 namespaces
DhcpMediaSense property
CIMTYPE'uint8'
Description'Whether media sense is enabled or not.'
readTrue
ValueMap['1', '0']
Values['Enabled', 'Disabled']
writeTrue
DhcpMediaSense property is in 3 classes of ROOT\StandardCimv2 and in 2 namespaces
GroupForwardedFragments property
CIMTYPE'uint8'
Description'Whether fragments should be collected into groups before being forwarded.'
readTrue
ValueMap['0', '1']
Values['Disabled', 'Enabled']
writeTrue
GroupForwardedFragments property is in 3 classes of ROOT\StandardCimv2 and in 2 namespaces
IcmpRedirects property
CIMTYPE'uint8'
Description'Whether the path cache is updated in response to ICMP redirect packets.'
readTrue
ValueMap['0', '1']
Values['Disabled', 'Enabled']
writeTrue
IcmpRedirects property is in 3 classes of ROOT\StandardCimv2 and in 2 namespaces
MediaSenseEventLog property
CIMTYPE'uint8'
Description'Whether media sense logging is enabled or not.'
readTrue
ValueMap['1', '0']
Values['Enabled', 'Disabled']
writeTrue
MediaSenseEventLog property is in 3 classes of ROOT\StandardCimv2 and in 2 namespaces
MldLevel property
CIMTYPE'uint32'
Description'Level of multicast support. - None: Multicast packets can neither be sent nor received - SendOnly: Multicast packets can be sent but not received - All: Multicast packets can be sent as well as received'
readTrue
ValueMap['0', '1', '2']
Values['None', 'SendOnly', 'All']
writeTrue
MldLevel property is in 3 classes of ROOT\StandardCimv2 and in 2 namespaces
MldVersion property
CIMTYPE'uint32'
Description'Maximum IGMP/MLD version supported by the host.'
readTrue
ValueMap['2', '3', '4']
Values['Version1', 'Version2', 'Version3']
writeTrue
MldVersion property is in 3 classes of ROOT\StandardCimv2 and in 2 namespaces
MulticastForwarding property
CIMTYPE'uint8'
Description'Whether multicast packets can be forwarded.'
readTrue
ValueMap['0', '1']
Values['Disabled', 'Enabled']
writeTrue
MulticastForwarding property is in 3 classes of ROOT\StandardCimv2 and in 2 namespaces
NeighborCacheLimit property
CIMTYPE'uint32'
Description'Maximum number of neighbor cache entries.'
readTrue
writeTrue
NeighborCacheLimit property is in 3 classes of ROOT\StandardCimv2 and in 2 namespaces
RandomizeIdentifiers property
CIMTYPE'uint8'
Description'Whether interface identifiers are randomized.'
readTrue
ValueMap['0', '1']
Values['Disabled', 'Enabled']
writeTrue
RandomizeIdentifiers property is in 3 classes of ROOT\StandardCimv2 and in 2 namespaces
ReassemblyLimit property
CIMTYPE'uint32'
Description'Maximum size of reassembly buffer in bytes.'
readTrue
writeTrue
ReassemblyLimit property is in 3 classes of ROOT\StandardCimv2 and in 2 namespaces
RouteCacheLimit property
CIMTYPE'uint32'
Description'Maximum number of route cache entries.'
readTrue
writeTrue
RouteCacheLimit property is in 3 classes of ROOT\StandardCimv2 and in 2 namespaces
SourceRoutingBehavior property
CIMTYPE'uint32'
Description'Determines the behavior for source routed packets. Per RFC 5095 support for forwarding of source routed IPv6 packets has been removed, and the setting forward now has the same effect as dontforward.'
readTrue
ValueMap['0', '1', '2']
Values['Forward', 'DontForward', 'Drop']
writeTrue
SourceRoutingBehavior property is in 3 classes of ROOT\StandardCimv2 and in 2 namespaces

Derived properties (28) of MSFT_NetBaseIPProtocol class

AvailableRequestedStates property
CIMTYPE'uint16'
Description'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.'
ModelCorrespondence['CIM_EnabledLogicalElement.RequestStateChange', 'CIM_EnabledLogicalElementCapabilities.RequestedStatesSupported']
ValueMap['2', '3', '4', '6', '7', '8', '9', '10', '11', '..']
Values['Enabled', 'Disabled', 'Shut Down', 'Offline', 'Test', 'Defer', 'Quiesce', 'Reboot', 'Reset', 'DMTF Reserved']
AvailableRequestedStates property is in 32 classes of ROOT\StandardCimv2 and in 7 namespaces
Caption property
CIMTYPE'string'
Description'The Caption property is a short textual description (one- line string) of the object.'
MaxLen64
Caption property is in 175 classes of ROOT\StandardCimv2 and in 37 namespaces
CommunicationStatus property
CIMTYPE'uint16'
Description'CommunicationStatus indicates the ability of the instrumentation to communicate with the underlying ManagedElement. CommunicationStatus consists of one of the following values: Unknown, None, Communication OK, Lost Communication, or No Contact.
A Null return indicates the implementation (provider) does not implement this property.
"Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
"Not Available" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).
"Communication OK " indicates communication is established with the element, but does not convey any quality of service.
"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 Managed Element is known to exist and has been contacted successfully in the past, but is currently unreachable.'
ValueMap['0', '1', '2', '3', '4', '..', '0x8000..']
Values['Unknown', 'Not Available', 'Communication OK', 'Lost Communication', 'No Contact', 'DMTF Reserved', 'Vendor Reserved']
CommunicationStatus property is in 68 classes of ROOT\StandardCimv2 and in 9 namespaces
CreationClassName property
CIMTYPE'string'
Description'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.'
keyTrue
MaxLen256
CreationClassName property is in 50 classes of ROOT\StandardCimv2 and in 20 namespaces
Description property
CIMTYPE'string'
Description'The Description property provides a textual description of the object.'
Description property is in 176 classes of ROOT\StandardCimv2 and in 142 namespaces
DetailedStatus property
CIMTYPE'uint16'
Description'DetailedStatus compliments PrimaryStatus with additional status detail. It consists of one of the following values: Not Available, No Additional Information, Stressed, Predictive Failure, Error, Non-Recoverable Error, SupportingEntityInError. Detailed status is used to expand upon the PrimaryStatus of the element.
A Null return indicates the implementation (provider) does not implement this property.
"Not Available" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).
"No Additional Information" indicates that the element is functioning normally as indicated by PrimaryStatus = "OK".
"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 normally but a failure is predicted in the near future.
"Non-Recoverable Error " indicates that this element is in an error condition that requires human intervention.
"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.'
ModelCorrespondence['CIM_EnabledLogicalElement.PrimaryStatus', 'CIM_ManagedSystemElement.HealthState']
ValueMap['0', '1', '2', '3', '4', '5', '..', '0x8000..']
Values['Not Available', 'No Additional Information', 'Stressed', 'Predictive Failure', 'Non-Recoverable Error', 'Supporting Entity in Error', 'DMTF Reserved', 'Vendor Reserved']
DetailedStatus property is in 68 classes of ROOT\StandardCimv2 and in 9 namespaces
ElementName property
CIMTYPE'string'
Description'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.
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. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.'
ElementName property is in 175 classes of ROOT\StandardCimv2 and in 21 namespaces
EnabledDefault property
CIMTYPE'uint16'
Description'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).'
ValueMap['2', '3', '5', '6', '7', '9', '..', '32768..65535']
Values['Enabled', 'Disabled', 'Not Applicable', 'Enabled but Offline', 'No Default', 'Quiesce', 'DMTF Reserved', 'Vendor Reserved']
writeTrue
EnabledDefault property is in 32 classes of ROOT\StandardCimv2 and in 10 namespaces
EnabledState property
CIMTYPE'uint16'
Description'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. 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.
Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.'
ModelCorrespondence['CIM_EnabledLogicalElement.OtherEnabledState']
ValueMap['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11..32767', '32768..65535']
Values['Unknown', 'Other', 'Enabled', 'Disabled', 'Shutting Down', 'Not Applicable', 'Enabled but Offline', 'In Test', 'Deferred', 'Quiesce', 'Starting', 'DMTF Reserved', 'Vendor Reserved']
EnabledState property is in 32 classes of ROOT\StandardCimv2 and in 13 namespaces
HealthState property
CIMTYPE'uint16'
Description'Indicates 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.'
ValueMap['0', '5', '10', '15', '20', '25', '30', '..']
Values['Unknown', 'OK', 'Degraded/Warning', 'Minor failure', 'Major failure', 'Critical failure', 'Non-recoverable error', 'DMTF Reserved']
HealthState property is in 68 classes of ROOT\StandardCimv2 and in 15 namespaces
InstallDate property
CIMTYPE'datetime'
Description'A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.'
MappingStrings['MIF.DMTF|ComponentID|001.5']
InstallDate property is in 68 classes of ROOT\StandardCimv2 and in 23 namespaces
InstanceID property
CIMTYPE'string'
Description'InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below.
To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm:
:
Where and are separated by a colon (:), and where must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the _ structure of Schema class names.) In addition, to ensure uniqueness, must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between and .
is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance.
If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the set to CIM.'
InstanceID property is in 175 classes of ROOT\StandardCimv2 and in 21 namespaces
Name property
CIMTYPE'string'
Description'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.'
keyTrue
MaxLen256
Name property is in 105 classes of ROOT\StandardCimv2 and in 142 namespaces
NameFormat property
CIMTYPE'string'
Description'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.'
MaxLen256
NameFormat property is in 15 classes of ROOT\StandardCimv2 and in 21 namespaces
OperatingStatus property
CIMTYPE'uint16'
Description'OperatingStatus provides a current status value for the operational condition of the element and can be used for providing more detail with respect to the value of EnabledState. It can also provide the transitional states when an element is transitioning from one state to another, such as when an element is transitioning between EnabledState and RequestedState, as well as other transitional conditions.
OperatingStatus consists of one of the following values: Unknown, Not Available, In Service, Starting, Stopping, Stopped, Aborted, Dormant, Completed, Migrating, Emmigrating, Immigrating, Snapshotting. Shutting Down, In Test
A Null return indicates the implementation (provider) does not implement this property.
"Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
"None" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property).
"Servicing" describes an element being configured, maintained, cleaned, or otherwise administered.
"Starting" describes an element being initialized.
"Stopping" describes an element being brought to an orderly stop.
"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.
"Completed" indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded in the PrimaryStatus 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).
"Migrating" element is being moved between host elements.
"Immigrating" element is being moved to new host element.
"Emigrating" element is being moved away from host element.
"Shutting Down" describes an element being brought to an abrupt stop.
"In Test" element is performing test functions.
"Transitioning" describes an element that is between states, that is, it is not fully available in either its previous state or its next state. This value should be used if other values indicating a transition to a specific state are not applicable.
"In Service" describes an element that is in service and operational.'
ModelCorrespondence['CIM_EnabledLogicalElement.EnabledState']
ValueMap['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '..', '0x8000..']
Values['Unknown', 'Not Available', 'Servicing', 'Starting', 'Stopping', 'Stopped', 'Aborted', 'Dormant', 'Completed', 'Migrating', 'Emigrating', 'Immigrating', 'Snapshotting', 'Shutting Down', 'In Test', 'Transitioning', 'In Service', 'DMTF Reserved', 'Vendor Reserved']
OperatingStatus property is in 68 classes of ROOT\StandardCimv2 and in 9 namespaces
OperationalStatus property
ArrayType'Indexed'
CIMTYPE'uint16'
Description'Indicates 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.'
ModelCorrespondence['CIM_ManagedSystemElement.StatusDescriptions']
ValueMap['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '..', '0x8000..']
Values['Unknown', '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']
OperationalStatus property is in 68 classes of ROOT\StandardCimv2 and in 18 namespaces
OtherEnabledState property
CIMTYPE'string'
Description'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.'
ModelCorrespondence['CIM_EnabledLogicalElement.EnabledState']
OtherEnabledState property is in 32 classes of ROOT\StandardCimv2 and in 11 namespaces
OtherTypeDescription property
CIMTYPE'string'
Description'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.'
MaxLen64
ModelCorrespondence['CIM_ProtocolEndpoint.ProtocolType', 'CIM_ProtocolEndpoint.ProtocolIFType']
OtherTypeDescription property is in 15 classes of ROOT\StandardCimv2 and in 8 namespaces
PrimaryStatus property
CIMTYPE'uint16'
Description'PrimaryStatus provides a high level status value, intended to align with Red-Yellow-Green type representation of status. It should be used in conjunction with DetailedStatus to provide high level and detailed health status of the ManagedElement and its subcomponents.
PrimaryStatus consists of one of the following values: Unknown, OK, Degraded or Error. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time.
"OK" indicates the ManagedElement is functioning normally.
"Degraded" indicates the ManagedElement is functioning below normal.
"Error" indicates the ManagedElement is in an Error condition.'
ModelCorrespondence['CIM_ManagedSystemElement.DetailedStatus', 'CIM_ManagedSystemElement.HealthState']
ValueMap['0', '1', '2', '3', '..', '0x8000..']
Values['Unknown', 'OK', 'Degraded', 'Error', 'DMTF Reserved', 'Vendor Reserved']
PrimaryStatus property is in 78 classes of ROOT\StandardCimv2 and in 9 namespaces
ProtocolIFType property
CIMTYPE'uint16'
Description'ProtocolIFType 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.'
ModelCorrespondence['CIM_ProtocolEndpoint.OtherTypeDescription']
ValueMap['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23', '24', '25', '26', '27', '28', '29', '30', '31', '32', '33', '34', '35', '36', '37', '38', '39', '40', '41', '42', '43', '44', '45', '46', '47', '48', '49', '50', '51', '52', '53', '54', '55', '56', '57', '58', '59', '60', '61', '62', '63', '64', '65', '66', '67', '68', '69', '70', '71', '72', '73', '74', '75', '76', '77', '78', '79', '80', '81', '82', '83', '84', '85', '86', '87', '88', '89', '90', '91', '92', '93', '94', '95', '96', '97', '98', '99', '100', '101', '102', '103', '104', '105', '106', '107', '108', '109', '110', '111', '112', '113', '114', '115', '116', '117', '118', '119', '120', '121', '122', '123', '124', '125', '126', '127', '128', '129', '130', '131', '132', '133', '134', '135', '136', '137', '138', '139', '140', '141', '142', '143', '144', '145', '146', '147', '148', '149', '150', '151', '152', '153', '154', '155', '156', '157', '158', '159', '160', '161', '162', '163', '164', '165', '166', '167', '168', '169', '170', '171', '172', '173', '174', '175', '176', '177', '178', '179', '180', '181', '182', '183', '184', '185', '186', '187', '188', '189', '190', '191', '192', '193', '194', '195', '196', '197', '198', '199', '200', '201', '202', '203', '204', '205', '206', '207', '208', '209', '210', '211', '212', '213', '214', '215', '216', '217', '218', '219', '220', '221', '222', '223', '224', '225..4095', '4096', '4097', '4098', '4099', '4100', '4101', '4102', '4103', '4104', '4105', '4106', '4107', '4108', '4109', '4110', '4111', '4112', '4113', '4114', '4115', '4200', '4201', '4202', '4203', '4204', '4205', '4300', '4400', '4401', '4402', '4403', '4404', '4405', '4406', '..', '32768..']
Values['Unknown', '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', 'Telnet', 'SSH', 'SM CLP', 'SMTP', 'LDAP', 'RDP', 'HTTPS', 'DMTF Reserved', 'Vendor Reserved']
ProtocolIFType property is in 18 classes of ROOT\StandardCimv2 and in 7 namespaces
ProtocolType property
CIMTYPE'uint16'
Description'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.'
ModelCorrespondence['CIM_ProtocolEndpoint.OtherTypeDescription']
ValueMap['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23', '24', '25', '26', '27']
Values['Unknown', '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']
ProtocolType property is in 15 classes of ROOT\StandardCimv2 and in 8 namespaces
RequestedState property
CIMTYPE'uint16'
Description'RequestedState is an integer enumeration that indicates the last requested or desired state for the element, irrespective of the mechanism through which it was requested. 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. Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration.
"Unknown" (0) indicates the last requested state for the element is unknown.
Note that the value "No Change" (5) has been deprecated in lieu of indicating the last requested state is "Unknown" (0). If the last requested or desired state is unknown, RequestedState should have the value "Unknown" (0), but may have the value "No Change" (5).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.

If knowledge of the last RequestedState is not supported for the EnabledLogicalElement, the property shall be NULL or have the value 12 "Not Applicable".'
ModelCorrespondence['CIM_EnabledLogicalElement.EnabledState']
ValueMap['0', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '..', '32768..65535']
Values['Unknown', 'Enabled', 'Disabled', 'Shut Down', 'No Change', 'Offline', 'Test', 'Deferred', 'Quiesce', 'Reboot', 'Reset', 'Not Applicable', 'DMTF Reserved', 'Vendor Reserved']
RequestedState property is in 32 classes of ROOT\StandardCimv2 and in 12 namespaces
Status property
CIMTYPE'string'
Description'A 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.'
MaxLen10
ValueMap['OK', 'Error', 'Degraded', 'Unknown', 'Pred Fail', 'Starting', 'Stopping', 'Service', 'Stressed', 'NonRecover', 'No Contact', 'Lost Comm', 'Stopped']
Status property is in 81 classes of ROOT\StandardCimv2 and in 42 namespaces
StatusDescriptions property
ArrayType'Indexed'
CIMTYPE'string'
Description'Strings 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.'
ModelCorrespondence['CIM_ManagedSystemElement.OperationalStatus']
StatusDescriptions property is in 68 classes of ROOT\StandardCimv2 and in 18 namespaces
SystemCreationClassName property
CIMTYPE'string'
Description'The CreationClassName of the scoping System.'
keyTrue
MaxLen256
Propagated'CIM_System.CreationClassName'
SystemCreationClassName property is in 50 classes of ROOT\StandardCimv2 and in 20 namespaces
SystemName property
CIMTYPE'string'
Description'The Name of the scoping System.'
keyTrue
MaxLen256
Propagated'CIM_System.Name'
SystemName property is in 69 classes of ROOT\StandardCimv2 and in 22 namespaces
TimeOfLastStateChange property
CIMTYPE'datetime'
Description'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.'
TimeOfLastStateChange property is in 33 classes of ROOT\StandardCimv2 and in 17 namespaces
TransitioningToState property
CIMTYPE'uint16'
Description'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.'
ModelCorrespondence['CIM_EnabledLogicalElement.RequestStateChange', 'CIM_EnabledLogicalElement.RequestedState', 'CIM_EnabledLogicalElement.EnabledState']
ValueMap['0', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '..']
Values['Unknown', 'Enabled', 'Disabled', 'Shut Down', 'No Change', 'Offline', 'Test', 'Defer', 'Quiesce', 'Reboot', 'Reset', 'Not Applicable', 'DMTF Reserved']
TransitioningToState property is in 32 classes of ROOT\StandardCimv2 and in 7 namespaces

MSFT_NetBaseIPProtocol Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
ClassVersion'1.0.0'
Description'The base class of IPv4 and IPv6 protocol for Microsoft TCPIP WMIv2 provider.'
dynamicTrue
locale'MS_409'
provider'nettcpip'
UMLPackagePath'CIM::Core::Service'

MSFT_NetBaseIPProtocol System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\StandardCimv2:MSFT_NetBaseIPProtocol'___SYSTEM8
__NAMESPACE'ROOT\StandardCimv2'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_ProtocolEndpoint', 'CIM_ServiceAccessPoint', 'CIM_EnabledLogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT42___SYSTEM3
__RELPATH'MSFT_NetBaseIPProtocol'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_ProtocolEndpoint'___SYSTEM8
__CLASS'MSFT_NetBaseIPProtocol'___SYSTEM8
__GENUS1___SYSTEM3
comments powered by Disqus
WUtils.com