Msvm_RdvComponentSettingData class
Represents the configured state of the Remote Desktop Virtualization (RDV) component.
The default state is Enabled.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_RdvComponentSettingData : CIM_ResourceAllocationSettingData
{
string Caption;
string Description;
string InstanceID;
string ElementName;
uint16 ResourceType;
string OtherResourceType;
string ResourceSubType;
string PoolID;
uint16 ConsumerVisibility;
string HostResource[];
string AllocationUnits;
uint64 VirtualQuantity;
uint64 Reservation;
uint64 Limit;
uint32 Weight;
boolean AutomaticAllocation;
boolean AutomaticDeallocation;
string Parent;
string Connection[];
string Address;
uint16 MappingBehavior;
uint16 EnabledState = 2;
};
Members
The Msvm_RdvComponentSettingData class has these types of members:
Properties
The Msvm_RdvComponentSettingData class has these properties.
-
Address
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers:
The address of the resource, for example, the MAC address of a Ethernet port.
This property is inherited from CIM_ResourceAllocationSettingData.
-
-
AllocationUnits
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers:
The allocation units used by the Reservation and Limit properties.
This property is inherited from CIM_ResourceAllocationSettingData.
-
-
AutomaticAllocation
-
-
Data type: boolean
-
Access type: Read-only
-
Qualifiers:
true to automatically allocate the resource; otherwise, false.
This property is inherited from CIM_ResourceAllocationSettingData.
-
-
AutomaticDeallocation
-
-
Data type: boolean
-
Access type: Read-only
-
Qualifiers:
true to automatically deallocate the resource; otherwise, false.
This property is inherited from CIM_ResourceAllocationSettingData.
-
-
Caption
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
A short textual description of the object.
This property is inherited from CIM_ManagedElement.
-
-
Connection
-
-
Data type: string array
-
Access type: Read-only
-
Qualifiers:
An array that indicates the objects connected to the resource, such as a named network or switch port.
This property is inherited from CIM_ResourceAllocationSettingData.
-
-
ConsumerVisibility
-
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers:
The consumers visibility to the allocated resource.
This property is inherited from CIM_ResourceAllocationSettingData.
-
-
Unknown (0)
-
Passed-Through (2)
-
Virtualized (3)
-
Not represented (4)
-
DMTF reserved
- 5 32766
-
Vendor Reserved
- 32767 65535
Description
-
Data type: string
-
Access type: Read-only
A textual description of the object.
This property is inherited from CIM_ManagedElement.
ElementName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Required
The user-friendly name for an instance of this class. In addition, the user-friendly name can be used as an index for a search or query. The name does not have to be unique within a namespace.
This property is inherited from CIM_SettingData.
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 using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.
HostResource
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: HyperVEmbeddedInstance ("CIM_LogicalDevice")
An array that contains the assignment of the allocated resources. Each non-null value of this property must be formated as an RFC3986 based URI. If the resource is modeled, then the value should be a WBEM URI.
This property is inherited from CIM_ResourceAllocationSettingData.
InstanceID
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key
Uniquely 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 the InstanceID property 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 that defines the InstanceID property, or be a registered ID that is assigned by a recognized global authority.
- OrgID must not contain a colon. The first colon in InstanceID must be between the OrgID andLocalID.
- LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.
- If the above pattern is not used, the defining entity must assure that the resultant InstanceID value is not re-used across any InstanceID properties that are produced by this provider or other providers for this namespace.
- For DMTF defined instances, the pattern must be used with the OrgID set to "CIM".
This property is inherited from CIM_SettingData.
Limit
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers:
The maximum amount of resource to grant to the allocation. The unit type of this property is specified by the AllocationUnits property.
This property is inherited from CIM_ResourceAllocationSettingData.
MappingBehavior
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers:
Indicates how the resource maps to underlying resources.
This property is inherited from CIM_ResourceAllocationSettingData.
Unknown (0)
Not Supported (1)
Dedicated (2)
Soft Affinity (3)
Hard Affinity (4)
DMTF Reserved
Vendor Reserved
OtherResourceType
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.ResourceType")
A description of the resource type when the ResourceType property is set to 1 (other).
This property is inherited from CIM_ResourceAllocationSettingData.
Parent
-
Data type: string
-
Access type: Read-only
-
Qualifiers:
The parent of the resource, for example, a controller for the current allocation.
This property is inherited from CIM_ResourceAllocationSettingData.
PoolID
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_ResourcePool.PoolId")
The ID of the resource pool that generated the resource.
This property is inherited from CIM_ResourceAllocationSettingData.
Reservation
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers:
The number of resource that are guaranteed to be available for this allocation. On systems that support over-commitment of resources, this value is typically used for admission control.
The unit type of this property is specified by the AllocationUnits property.
This property is inherited from CIM_ResourceAllocationSettingData.
ResourceSubType
-
Data type: string
-
Access type: Read-only
-
Qualifiers:
An implementation specific sub-type 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
-
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.OtherResourceType")
The type of resource that is represented by the allocation settings.
This property is inherited from CIM_ResourceAllocationSettingData.
Other (1)
Computer System (2)
Processor (3)
Memory (4)
IDE Controller (5)
Parallel SCSI HBA (6)
FC HBA (7)
iSCSI HBA (8)
IB HCA (9)
Ethernet Adapter (10)
I/O Slot (11)
I/O Device (12)
Floppy Drive (13)
CD Drive (14)
DVD drive (15)
Serial port (16)
Parallel port (17)
USB Controller (18)
Graphics controller (19)
Storage Extent (20)
Disk (21)
Tape (22)
Other storage device (23)
Firewire Controller (24)
Partitionable Unit (25)
Base Partitionable Unit (26)
Power Supply (27)
Cooling Device (28)
DMTF reserved
Vendor Reserved
VirtualQuantity
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers:
The number of resources presented to the consumer of the resource.
This property is inherited from CIM_ResourceAllocationSettingData.
Weight
-
Data type: uint32
-
Access type: Read-only
-
Qualifiers:
The relative priority for this allocation in relation to other allocations from the same resource pool.
This property is inherited from CIM_ResourceAllocationSettingData.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 |
| End of client support |
None supported |
| End of server support |
Windows Server 2012 R2 |
| Namespace |
Root\virtualization |
| MOF |
|