MSFT_NetTCPSetting class

Article
05/08/2024

Represents the TCP parameter setting for the Microsoft TCP/IP (Internet Protocol Suite) WMIv2 provider.

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

Syntax

[UMLPackagePath("CIM::Policy"), ClassVersion("1.0.0"), dynamic, provider("nettcpip"), AMENDMENT]
class MSFT_NetTCPSetting : CIM_PolicyAction
{
  string  InstanceID;
  string  Caption;
  string  Description;
  string  ElementName;
  string  CommonName;
  string  PolicyKeywords[];
  string  SystemCreationClassName;
  string  SystemName;
  string  PolicyRuleCreationClassName;
  string  PolicyRuleName;
  string  CreationClassName;
  string  PolicyActionName;
  boolean DoActionLogging;
  string  SettingName;
  uint32  MinRto;
  uint32  InitialCongestionWindow;
  uint8   CwndRestart;
  uint8   MemoryPressureProtection;
  uint8   CongestionProvider;
  uint8   AutoTuningLevelLocal;
  uint8   EcnCapability;
  uint8   Timestamps;
  uint32  InitialRto;
  uint8   ScalingHeuristics;
  uint16  DynamicPortRangeStartPort;
  uint16  DynamicPortRangeNumberOfPorts;
  uint8   AutoTuningLevelGroupPolicy;
  uint8   AutoTuningLevelEffective;
  uint32  DelayedAckTimeout;
  uint8   DelayedAckFrequency;
  uint8   AutomaticUseCustom;
  uint8   NonSackRttResiliency;
  uint8   ForceWS;
  uint8   MaxSynRetransmissions;
  uint16  AutoReusePortRangeStartPort;
  uint16  AutoReusePortRangeNumberOfPorts;
};

Members

The MSFT_NetTCPSetting class has these types of members:

Properties

Properties

The MSFT_NetTCPSetting class has these properties.

AutomaticUseCustom

Data type: uint8
Access type: Read/write

Gets and sets a value that indicates whether the automatic template setting specifies custom or default templates. This property can contain one of the following values.

Value	Meaning
Disabled 0	The automatic template setting specifies the default templates.
Enabled 1	The automatic template setting specifies custom templates.

AutoReusePortRangeNumberOfPorts

Data type: uint16
Access type: Read/write

Number of ports starting from the AutoReusePortRangeStartPort property for automatic reuse port range.

**Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012: **

This property is not supported before Windows 10 and Windows Server 2016.

AutoReusePortRangeStartPort

Data type: uint16
Access type: Read/write

Starting automatic reuse port number between 1025 and 65535.

**Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012: **

This property is not supported before Windows 10 and Windows Server 2016.

AutoTuningLevelEffective

Data type: uint8
Access type: Read-only

Gets a value that indicates whether the auto tunning level is determined by group policy or a local setting.

Value	Meaning
Local 0	The auto tunning level is determined by a local setting.
GroupPolicy 1	The auto tunning level is determined by group policy.

AutoTuningLevelGroupPolicy

Data type: uint8
Access type: Read-only

Gets and sets the auto tunning level for group policy. This parameter can contain one of the following values.

Value	Meaning
Disabled 0	The auto tunning level is disabled.
HighlyRestricted 1	The auto tunning level is highly restricted.
Restricted 2	The auto tunning level is restricted.
Normal 3	The auto tunning level is normal.
Experimental 4	The auto tunning level is experimental.

AutoTuningLevelLocal

Data type: uint8
Access type: Read/write

Gets and sets the local auto tuning level. This property contains one of the following values.

Value	Meaning
Disabled 0
HighlyRestricted 1	Highly Restricted
Restricted 2
Normal 3
Experimental 4

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.

CommonName

Data type: string
Access type: Read-only

A user-friendly name of this policy-related object.

This property is inherited from CIM_Policy.

CongestionProvider

Data type: uint8
Access type: Read/write

Gets and sets the TCP congestion provider setting. This property contains one of the following values.

Value	Meaning
Default 0
CTCP 2	Compound TCP (CTCP)
DCTCP 3	Datacenter TCP (DCTCP)

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

CwndRestart

Data type: uint8
Access type: Read/write

Gets and sets a value that indicates whether a congested window is restarted. This property contains one of the following values.

Value	Meaning
Disabled 0	A congested window is not restarted.
Enabled 1	A congested window is restarted.

DelayedAckFrequency

Data type: uint8
Access type: Read/write

Gets and sets number of unresolved acknowledgments (ACK) that will cause the ACK timer to be ignored. This parameter value can range from 1 to 255.

DelayedAckTimeout

Data type: uint32
Access type: Read/write

Gets and sets the TCP delayed ACK timeout, in milliseconds. This property can contain a value from 10 to 600.

Description

Data type: string
Access type: Read-only

Provides a textual description of the object.

This property is inherited from CIM_ManagedElement.

DoActionLogging

Data type: boolean
Access type: Read-only

Causes a log message to be generated when the action is performed.

This property is inherited from CIM_PolicyAction.

DynamicPortRangeNumberOfPorts

Data type: uint16
Access type: Read/write

Gets and sets the number of ports in the dynamic port range.

DynamicPortRangeStartPort

Data type: uint16
Access type: Read/write

Gets and sets the starting port of the dynamic port range. The property can contain a value between 1 and 65535.

EcnCapability

Data type: uint8
Access type: Read/write

Gets and sets the Explicit Congestion Notification (ECN) feature. This property contains one of the following values.

Value	Meaning
Disabled 0	ECN is disabled.
Enabled 1	ECN is enabled.

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.

ForceWS

Data type: uint8
Access type: Read/write

Gets and sets a value indicates whether forced window scaling is enabled.

Windows 8 and Windows Server 2012: This property is not supported before Windows 8.1 and Windows Server 2012 R2.

Value	Meaning
Disabled 0	Forced window scaling is disabled.
Enabled 1	Forced window scaling is enabled.

InitialCongestionWindow

Data type: uint32
Access type: Read/write

Gets and sets the maximum segment size of the initial congestion window. The property value can range from 2 to 64.

InitialRto

Data type: uint32
Access type: Read/write

Gets and sets the retransmit timeout, in milliseconds. The default value for this property is 3000.

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.

MaxSynRetransmissions

Data type: uint8
Access type: Read/write

Gets and sets the number of times to attempt to reestablish a connection with SYN packetes. This property can contain a value that ranges from 2 to 8.

Windows 8 and Windows Server 2012: This property is not supported before Windows 8.1 and Windows Server 2012 R2.

MemoryPressureProtection

Data type: uint8
Access type: Read/write

Gets and sets the memory pressure protection setting. This property contains one of the following values.

Value	Meaning
Disabled 0	Disable memory pressure protection.
Enabled 1	Enable memory pressure protection.
Default 2	Restore the memory pressure protection state to the system default.

MinRto

Data type: uint32
Access type: Read/write

Gets and sets the TCP retransmission timeout, in milliseconds. The property value can range from 20 milliseconds to 300 milliseconds.

NonSackRttResiliency

Data type: uint8
Access type: Read/write

Gets and sets a value that enables Round-Trip Time (RTT) resiliency for clients that do not support Selective Acknowledgment (SACK).

Windows 8 and Windows Server 2012: This property is not supported before Windows 8.1 and Windows Server 2012 R2.

Value	Meaning
Disabled 0	Disable RTT resiliency for clients that do not support SACK.
Enabled 1	Enable RTT resiliency for clients that do not support SACK.

PolicyActionName

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

A user-friendly name of this policy action.

This property is inherited from CIM_PolicyAction.

PolicyKeywords

Data type: string array
Access type: Read-only

An array of keywords for characterizing / categorizing policy objects. Keywords are of one of two types:

Keywords defined in this and other MOFs, or in DMTF white papers. These keywords provide a vendor- independent, installation-independent way of characterizing policy objects.
Installation-dependent keywords for characterizing policy objects. Examples include 'Engineering', 'Billing', and 'Review in December 2000'.

This MOF defines the following keywords: UNKNOWN, CONFIGURATION, USAGE, SECURITY, SERVICE, MOTIVATIONAL, INSTALLATION, and EVENT. These concepts are self-explanatory and are further discussed in the SLA/Policy White Paper. One additional keyword is defined: POLICY. The role of this keyword is to identify policy-related instances that may not be otherwise identifiable, in some implementations. The keyword POLICY is NOT mutually exclusive of the other keywords specified above.

This property is inherited from CIM_Policy.

PolicyRuleCreationClassName

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

For a rule-specific policy action, the CreationClassName of the policy rule object with which this Action is associated. For a reusable policy action, a special value, 'NO RULE', should be used to indicate that this Action is reusable and not associated with a single policy rule.

This property is inherited from CIM_PolicyAction.

PolicyRuleName

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

For a rule-specific policy action, the name of the policy rule object with which this Action is associated. For a reusable policy action, a special value, 'NO RULE', should be used to indicate that this Action is reusable and not associated with a single policy rule.

This property is inherited from CIM_PolicyAction.

ScalingHeuristics

Data type: uint8
Access type: Read/write

Gets and sets a value that indicates whether window scaling heuristics are enabled.

Value	Meaning
Disabled 0	Window scaling heuristics is disabled.
Enabled 1	Window scaling heuristics is enabled.

SettingName

Data type: string
Access type: Read-only

Gets the name of the setting. This property contains one of the following values.

DatacenterCustom
InternetCustom
Datacenter
Compat
Internet
Automatic

SystemCreationClassName

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

The name of the class or the subclass used in the creation of the System object in whose scope this policy action is defined.

This property helps to identify the System object in whose scope this instance of policy action exists. For a rule-specific policy action, this is the System in whose context the policy rule is defined. For a reusable policy action, this is the instance of PolicyRepository (which is a subclass of System) that holds the Action.

Note that this property, and the analogous property SystemName, do not represent propagated keys from an instance of the class System. Instead, they are properties defined in the context of this class, which repeat the values from the instance of System to which this policy action is related, either directly via the policy action InPolicyRepository association or indirectly via the PolicyActionInPolicyRule aggregation.

This property is inherited from CIM_PolicyAction.

SystemName

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

The name of the System object in whose scope this policy action is defined.

This property completes the identification of the System object in whose scope this instance of policy action exists. For a rule-specific policy action, this is the System in whose context the policy rule is defined. For a reusable policy action, this is the instance of PolicyRepository (which is a subclass of System) that holds the Action.

This property is inherited from CIM_PolicyAction.

Timestamps

Data type: uint8
Access type: Read/write

Gets and sets the RFC timestamp setting. This property contains one of the following values.

Value	Meaning
Disabled 0	Disable RFC 1323 timestamps.
Enabled 1	Enable RFC 1323 timestamps.

Requirements


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

Share via

MSFT_NetTCPSetting class

Syntax

Members

Properties

Requirements

See also

Feedback

Additional resources