Msvm_RdvComponentSettingData class

Represents the configured state of the Remote Desktop Virtualization (RDV) component. The default state is Enabled.

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

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_RdvComponentSettingData : CIM_ResourceAllocationSettingData
{
  string  InstanceID;
  string  Caption = "Remote Desktop Virtualization Service Default Settings";
  string  Description = "Describes the default settings for the Remote Desktop Virtualization Service resources.";
  string  ElementName;
  uint16  ResourceType = 33;
  string  OtherResourceType;
  string  ResourceSubType;
  string  PoolID;
  uint16  ConsumerVisibility = 3;
  string  HostResource[];
  string  AllocationUnits = "count";
  uint64  VirtualQuantity = 1;
  uint64  Reservation = 1;
  uint64  Limit = 1;
  uint32  Weight = 0;
  boolean AutomaticAllocation = True;
  boolean AutomaticDeallocation = True;
  string  Parent;
  string  Connection[];
  string  Address;
  uint16  MappingBehavior;
  string  AddressOnParent;
  string  VirtualQuantityUnits = "count";
  uint16  EnabledState = 2;
};

Members

The Msvm_RdvComponentSettingData class has these types of members:

• Properties

Properties

The Msvm_RdvComponentSettingData class has these properties.

Address

Data type: string

Access type: Read-only

The address of the resource. This property is inherited from CIM_ResourceAllocationSettingData.

AddressOnParent

Data type: string

Access type: Read-only

Describes the address of this resource in the context of the parent. The Parent and AddressOnParent properties are used to describe the controller relationship as well as the ordering of devices on a controller. This property is inherited from CIM_ResourceAllocationSettingData.

AllocationUnits

Data type: string

Access type: Read-only

The unit of allocation used by the Reservation and Limit properties. This property is inherited from CIM_ResourceAllocationSettingData.

AutomaticAllocation

Data type: boolean

Access type: Read-only

Indicates whether the resource will be automatically allocated. This property is inherited from CIM_ResourceAllocationSettingData.

AutomaticDeallocation

Data type: boolean

Access type: Read-only

Indicates whether the resource will be automatically deallocated. This property is inherited from CIM_ResourceAllocationSettingData.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

A short description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Ethernet Switch Port Settings".

Connection

Data type: string array

Access type: Read-only

The device to which this resource is connected. This property is inherited from CIM_ResourceAllocationSettingData.

ConsumerVisibility

Data type: uint16

Access type: Read-only

The consumer's visibility to the allocated resource. This property is inherited from CIM_ResourceAllocationSettingData, and it is always set to 3 (Virtualized).

Description

Data type: string

Access type: Read-only

A description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Ethernet Switch Port Settings".

ElementName

Data type: string

Access type: Read-only

A display name for the object. This property is inherited from CIM_SettingData. Changing this property will change the element name of the associated logical device derivative.

EnabledState

Data type: uint16

Access type: Read-only

The enabled and disabled states of an element. Valid values are 2 (enabled) and 3 (disabled). The default value is 2 (enabled). This is a read-only property, but it can be changed by using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.

HostResource

Data type: string array

Access type: Read-only

Only one host resource can be assigned to each device in the virtual switch, so only the first element of this array can be set. For devices that support this feature, set the first element of the HostResource array to contain a reference to the underlying host resource to be assigned. This property is inherited from CIM_ResourceAllocationSettingData.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.

Limit

Data type: uint64

Access type: Read-only

The maximum amount of corresponding host resources that can be consumed by the virtual switch. This property is inherited from CIM_ResourceAllocationSettingData.

MappingBehavior

Data type: uint16

Access type: Read-only

Specifies how this resource maps to underlying resources. This property is inherited from CIM_ResourceAllocationSettingData.

OtherResourceType

Data type: string

Access type: Read-only

A string that describes the resource type when a well-defined value is not available and ResourceType has the value 1 (Other). This property is inherited from CIM_ResourceAllocationSettingData, and it is not used.

Parent

Data type: string

Access type: Read-only

The parent of the resource. This property is inherited from CIM_ResourceAllocationSettingData.

PoolID

Data type: string

Access type: Read-only

The identifier of the resource pool from which this resource was allocated. This property is inherited from CIM_ResourceAllocationSettingData.

Reservation

Data type: uint64

Access type: Read-only

The amount of resources that are reserved for use by the virtual switch. This property is inherited from CIM_ResourceAllocationSettingData.

ResourceSubType

Data type: string

Access type: Read-only

A string that describes an implementation-specific subtype for this resource. For example, this may be used to distinguish different models of the same resource type. This property is inherited from CIM_ResourceAllocationSettingData.

ResourceType

Data type: uint16

Access type: Read-only

The type of resource this allocation setting represents. This property is inherited from CIM_ResourceAllocationSettingData, and it is always set to 33 (Ethernet connection).

VirtualQuantity

Data type: uint64

Access type: Read-only

The total number of ports in the virtual switch. This property is inherited from CIM_ResourceAllocationSettingData.

VirtualQuantityUnits

Data type: string

Access type: Read-only

Specifies the unit of measurement for the VirtualQuantity property. The value of this property must be a legal value of the Programmatic Units qualifier as defined in Annex C.1 of DSP0004 V2.5 or later. This property is inherited from CIM_ResourceAllocationSettingData.

Weight

Data type: uint32

Access type: Read-only

An integer that defines the weight for each virtual switch. This property is inherited from CIM_ResourceAllocationSettingData.

Range: 0 1000

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Namespace	Root\Virtualization\V2
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe