MSFT_NetTransportFilter class

Represents the filter for the transport protocol parameter setting for the Microsoft TCP/IP WMI v2 provider.

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

Syntax

[UMLPackagePath("CIM::Network::Filtering"), ClassVersion("1.0.0"), dynamic, provider("nettcpip"), AMENDMENT]
class MSFT_NetTransportFilter : CIM_FilterEntryBase
{
  string   InstanceID;
  string   Caption;
  string   Description;
  string   ElementName;
  datetime InstallDate;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  string   Name;
  string   SystemCreationClassName;
  string   SystemName;
  string   CreationClassName;
  boolean  IsNegated;
  uint16   Protocol;
  uint16   LocalPortStart;
  uint16   LocalPortEnd;
  uint16   RemotePortStart;
  uint16   RemotePortEnd;
  string   DestinationPrefix;
  string   SettingName;
};

Members

The MSFT_NetTransportFilter class has these types of members:

Properties

The MSFT_NetTransportFilter class has these properties.

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.

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

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

Description
Data type: string
Access type: Read-only

Provides a textual description of the object.

This property is inherited from CIM_ManagedElement.

DestinationPrefix
Data type: string
Access type: Read-only

The destination prefix to filter.

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.

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

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.

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

IsNegated
Data type: boolean
Access type: Read-only

Boolean indicating that the match condition described in the properties of the FilterEntryBase subclass should be negated. This property is defined for ease of use when filtering on simple negations - for example, to select all source ports except 162. It is not recommended that this Boolean be set to True when filtering on multiple criteria, such as defining an IPHeadersFilter based on source/destination addresses, ports, and DiffServ Code Points.

This property is inherited from CIM_FilterEntryBase.

LocalPortEnd
Data type: uint16
Access type: Read-only

The end of the local port number.

LocalPortStart
Data type: uint16
Access type: Read-only

The start of the local port number.

Name
Data type: string
Access type: Read-only
Qualifiers: MaxLen (256) , key, Override ("Name")

Defines the label by which the Filter Entry is known and uniquely identified.

This property is inherited from CIM_FilterEntryBase.

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.

ValueMeaning
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_ManagedSystemElement.

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

 

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 )
Protocol
Data type: uint16
Access type: Read-only

Specifies the protocol to which the filter applies.

TCP (6)
UDP (17)
RemotePortEnd
Data type: uint16
Access type: Read-only

The end of the remote port number.

RemotePortStart
Data type: uint16
Access type: Read-only

The start of the remote port number.

SettingName
Data type: string
Access type: Read-only

The name of the setting associated with the filter. For information about the setting, see MSFT_NetTCPSetting.

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.

SystemCreationClassName
Data type: string
Access type: Read-only
Qualifiers: key, MaxLen (256) , Propagated ("CIM_ComputerSystem.CreationClassName")

The scoping computer system's CreationClassName.

This property is inherited from CIM_FilterEntryBase.

SystemName
Data type: string
Access type: Read-only
Qualifiers: key, MaxLen (256) , Propagated ("CIM_ComputerSystem.Name")

The scoping ComputerSystem's Name.

This property is inherited from CIM_FilterEntryBase.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Namespace

Root\StandardCimv2

MOF

NetTCPIP.mof

DLL

NetTCPIP.dll

See also

CIM_FilterEntryBase
MSFT_NetTCPSetting

 

 

Community Additions

ADD
Show: