Win32_TSNetworkAdapterSetting class

The Win32_TSNetworkAdapterSetting WMI class defines various configuration settings for the Win32_Terminal class including properties related to the network adapter and the maximum number of connections allowed.

The following syntax is simplified from MOF code and includes all defined and inherited properties, in alphabetical order. For reference information on methods, see the table of methods later in this topic.

Syntax

[dynamic, provider("Win32_WIN32_TSNETWORKADAPTERSETTING_Prov"), ClassContext("local|hkey_local_machine\\SYSTEM\\CurrentControlSet\\Control\\TerminalServer\\WinStations"), AMENDMENT]
class Win32_TSNetworkAdapterSetting : Win32_TerminalSetting
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Name;
  string   Status;
  string   TerminalName;
  string   DeviceIDList[];
  uint32   MaximumConnections;
  string   NetworkAdapterID;
  uint32   NetworkAdapterLanaID;
  string   NetworkAdapterList[];
  string   NetworkAdapterName;
  uint32   PolicySourceMaximumConnections;
};

Members

The Win32_TSNetworkAdapterSetting class has these types of members:

Methods

The Win32_TSNetworkAdapterSetting class has these methods.

MethodDescription
SelectAllNetworkAdapters

Selects all network adapters.

SelectNetworkAdapterIP

Selects a network adapter based on the adapter's IP address.

SetNetworkAdapterLanaID

Specifies the NetBIOS Local Area Network Adapter (LANA) number of the network adapter to set.

 

Properties

The Win32_TSNetworkAdapterSetting class has these properties.

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

Short description (one-line string) of the object.

This property is inherited from CIM_ManagedSystemElement.

Description
Data type: string
Access type: Read-only

Description of the object.

This property is inherited from CIM_ManagedSystemElement.

DeviceIDList
Data type: string array
Access type: Read-only

String array of available device IDs returned in the order of physical network adapters returned in the NetworkAdapterList property array. The device ID value is the DeviceID property in Win32_NetworkAdapter

InstallDate
Data type: datetime
Access type: Read-only
Qualifiers: Mappingstrings ("MIF.DMTF|ComponentID|001.5")

The date the object was installed. A lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

MaximumConnections
Data type: uint32
Access type: Read/write

The maximum number of connections allowed. The value MAXINT denotes an unlimited number of connections.

Name
Data type: string
Access type: Read-only

The name of the object.

This property is inherited from CIM_ManagedSystemElement.

NetworkAdapterID
Data type: string
Access type: Read-only

The GUID that represents the ID of the network adapter to set. A GUID that consists of all zeros denotes all network adapters.

NetworkAdapterLanaID
Data type: uint32
Access type: Read-only

NetBIOS Local Area Network Adapter (LANA) number of the network adapter that is used to identify the network adapter assigned to the terminal.

NetworkAdapterList
Data type: string array
Access type: Read-only

String array of available physical network adapters and the corresponding device IDs. The device IDs are the DeviceID property in Win32_NetworkAdapter.

NetworkAdapterName
Data type: string
Access type: Read-only

Description of the network adapter to set. This value is in Win32_NetworkAdapterConfiguration.

PolicySourceMaximumConnections
Data type: uint32
Access type: Read-only

Indicates whether the MaximumConnections property is configured by the server, group policy, or by default.

0

Server

1

Group policy

2

Default

Status
Data type: string
Access type: Read-only
Qualifiers: MaxLen (10)

Current status of the object. Various operational and nonoperational statuses can be defined. Operational statuses include: "OK", "Degraded", and "Pred Fail" (an element, such as a SMART-enabled hard disk drive, may be functioning properly but predicting a failure in the near future). Nonoperational statuses include: "Error", "Starting", "Stopping", and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither "OK" nor in one of the other states.

This property is inherited from CIM_ManagedSystemElement.

("OK")

("Error")

("Degraded")

("Unknown")

("Pred Fail")

("Starting")

("Stopping")

("Service")

TerminalName
Data type: string
Access type: Read-only

The name of the terminal.

This property is inherited from Win32_TerminalSetting.

Remarks

Be aware that Winstations associated with the console session cannot access the methods and properties of this class. If an attempt is made to do so by specifying "Console" as the value of the TerminalName property, methods of this object return WBEM_E_NOT_SUPPORTED. This error code is also returned if a window station attempts to call methods of this object to add or modify the security properties of the LocalSystem, LocalService, or NetworkService accounts.

To connect to the "Root\CIMV2\TerminalServices" namespace, the authentication level must include packet privacy. For C/C++ calls, this is an authentication level of RPC_C_AUTHN_LEVEL_PKT_PRIVACY. For Visual Basic and scripting calls, this is an authentication level of WbemAuthenticationLevelPktPrivacy or "pktPrivacy", with a value of 6. The following Visual Basic Scripting Edition (VBScript) example shows how to connect to a remote computer with packet privacy.


strComputer = "RemoteServer1" 
Set objServices = GetObject( _
    "winmgmts:{authenticationLevel=pktPrivacy}!Root/CIMv2/TerminalServices")


Managed Object Format (MOF) files contain the definitions for Windows Management Instrumentation (WMI) classes. MOF files are not installed as part of the Microsoft Windows Software Development Kit (SDK). They are installed on the server when you add the associated role by using the Server Manager. For more information about MOF files, see Managed Object Format (MOF).

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Namespace

Root\CIMv2\TerminalServices

MOF

TSCfgWmi.mof

DLL

TSCfgWmi.dll

See also

Win32_NetworkAdapter
Win32_NetworkAdapterConfiguration
Win32_TerminalSetting
Win32_TSNetworkAdapterListSetting

 

 

Show: