Edit

Share via

Win32_TSVirtualIP class

  • Article

Defines Internet protocol (IP) virtualization settings for a Remote Desktop Session Host (RD Session Host) server.

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

Syntax

[dynamic, provider("Win32_WIN32_TSVIRTUALIP_Prov"), ClassContext("local|hkey_local_machine\\SYSTEM\\CurrentControlSet\\Control\\TerminalServer\\TSAppSrv\\VirtualIP"), AMENDMENT]
class Win32_TSVirtualIP : CIM_Setting
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Name;
  string   Status;
  uint32   VirtualIPActive;
  uint32   PolicySourceVirtualIPActive;
  uint32   VirtualIPMode;
  uint32   PolicySourceVirtualIPMode;
  string   ProgramList[];
  uint32   PolicySourceProgramList;
  string   NetworkAdapterDescription;
  string   NetworkAdapterMacAddress;
  uint32   PolicySourceNetworkAdapter;
  string   NetworkAdapterDescriptionList[];
  string   NetworkAdapterMacList[];
  uint32   VirtualizeLoopbackAddressesEnabled;
};

Members

The Win32_TSVirtualIP class has these types of members:

Methods

The Win32_TSVirtualIP class has these methods.

Method Description
AddProgram Adds a program to the list of programs that use IP virtualization.
RemoveProgram Removes a program from the list of programs that use IP virtualization.
SelectNetworkAdapter Sets the MAC address of the network adapter to use for IP virtualization.
SetProgramList Overwrites the list of programs that use IP virtualization.
SetVirtualIPActive Sets the VirtualIPActive property value.
SetVirtualIPMode Sets the VirtualIPMode property value.
SetVirtualizeLoopbackAddressesEnabled Sets the VirtualizeLoopbackAddressesEnabled property value.
Windows Server 2008 R2: This method is not available prior to Windows Server 2012.

Properties

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

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.

Name

Data type: string

Access type: Read-only

The name of the object.

This property is inherited from CIM_ManagedSystemElement.

NetworkAdapterDescription

Data type: string

Access type: Read-only

The description for the network adapter.

NetworkAdapterDescriptionList

Data type: string array

Access type: Read-only

The list of descriptions of the available physical network adapters.

NetworkAdapterMacAddress

Data type: string

Access type: Read-only

The MAC address of the network adapter.

NetworkAdapterMacList

Data type: string array

Access type: Read-only

The list of MAC addresses of the available physical network adapters.

PolicySourceNetworkAdapter

Data type: uint32

Access type: Read-only

Indicates whether the network adapter is configured by the server or by group policy.

0 (0x0)

Server

1 (0x1)

Group policy

PolicySourceProgramList

Data type: uint32

Access type: Read-only

Indicates whether the ProgramList property is configured by the server or by group policy.

0 (0x0)

Server

1 (0x1)

Group policy

PolicySourceVirtualIPActive

Data type: uint32

Access type: Read-only

Indicates if the VirtualIPActive property is configured by the server or by group policy.

0 (0x0)

Server

1 (0x1)

Group policy

PolicySourceVirtualIPMode

Data type: uint32

Access type: Read-only

Indicates if the VirtualIPMode property is configured by the server or by group policy.

0 (0x0)

Server

1 (0x1)

Group policy

ProgramList

Data type: string array

Access type: Read-only

Specifies the programs that are configured to use IP virtualization. This may a program name or the full path.

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

VirtualIPActive

Data type: uint32

Access type: Read-only

Qualifiers: key

Specifies if IP virtualization is active on the server. This can be one of the following values.

FALSE (0)

IP virtualization is not active.

TRUE (1)

IP virtualization is active.

VirtualIPMode

Data type: uint32

Access type: Read-only

Specifies which IP virtualization mode is being used on the server. This can be one of the following values.

Per-Session (0)

The IP virtualization mode is per-session.

Per-Program (1)

The IP virtualization mode is per-user.

VirtualizeLoopbackAddressesEnabled

Data type: uint32

Access type: Read-only

Specifies whether loopback address virtualization is enabled.

Windows Server 2008 R2: This property is not available prior to Windows Server 2012.

FALSE (0)

Not enabled

TRUE (1)

Enabled

Remarks

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

Requirement Value
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2008 R2
Namespace
 Root\CIMv2\TerminalServices
MOF
TSCfgWmi.mof
DLL
TSCfgWmi.dll