Edit

Msvm_GuestServiceInterfaceComponentSettingData class

  • Article

Represents the configured state of the guest service interface component. This class derives from the CIM_ResourceAllocationSettingData class.

The following syntax is simplified from MOF code and includes all inherited properties.

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_GuestServiceInterfaceComponentSettingData : CIM_ResourceAllocationSettingData
{
  string  ElementName;
  string  InstanceID;
  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 = 3;
  uint16  DefaultEnabledStatePolicy = 2;
};

Members

The Msvm_GuestServiceInterfaceComponentSettingData class has these types of members:

Properties

The Msvm_GuestServiceInterfaceComponentSettingData class has these properties.

Address

Data type: string

Access type: Read-only

The address of the resource. For example, the MAC address of a Ethernet port.

AllocationUnits

Data type: string

Access type: Read-only

This property specifies the units of allocation used by the Reservation and Limit properties. For example, when ResourceType=Processor, AllocationUnits may be set to MHz. When ResourceType=Memory, AllocationUnits may be set to MB

AutomaticAllocation

Data type: boolean

Access type: Read-only

This property specifies if the resource will be automatically allocated. For example when set to true, when the consuming virtual computer system is powered on, this resource would be allocated. A value of false indicates the resource must be explicitly allocated. For example, the setting may represent removable media (that is, cdrom or floppy) where at power on time, the media is not present. An explicit operation is required to allocate the resource.

AutomaticDeallocation

Data type: boolean

Access type: Read-only

This property specifies if the resource will be automatically deallocated. For example, when set to true, when the consuming virtual computer system is powered off, this resource would be deallocated. When set to false, the resource will remain allocated and must be explicitly deallocated.

Connection

Data type: string array

Access type: Read-only

The thing to which this resource is connected. For example, a named network or switch port.

ConsumerVisibility

Data type: uint16

Access type: Read-only

Describes the consumers visibility to the allocated resource.

Value Meaning
Unknown
0
 Unknown.
Passed-Through
2
 The underlying or host resource is utilized and passed through to the consumer, possibly using partitioning. At least one item shall be present in the DeviceID property.
Virtualized
3
 The resource is virtualized and may not map directly to an underlying/host resource. Some implementations may support specific assignment for virtualized resources, in which case the host resource(s) are exposed using the DeviceID property.
Not represented
4
 A representation of the resource does not exist within the context of the resource consumer.
DMTF reserved
..
Vendor Reserved
32767..65535

DefaultEnabledStatePolicy

Data type: uint16

Access type: Read-only

The enabled and disabled states of guest communication services by default.

This is a read-only property, but it can be changed using the ModifyResourceSettings method of the Msvm_VirtualSystemManagementService class.

Note

Added in Windows 10.

Enabled (2)

Disabled (3)

ElementName

Data type: string

Access type: Read-only

The display name for this instance of SettingData. In addition, the display name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.)

EnabledState

Data type: uint16

Access type: Read-only

The enabled and disabled states of an element.

This is a read-only property, but it can be changed by using the ModifyVirtualSystemResources method (or ModifyResourceSettings in Windows 10 or later) of the Msvm_VirtualSystemManagementService class.

Valid values are:

Enabled (2)

Disabled (3)

HostResource

Data type: string array

Access type: Read-only

This property exposes specific assignment to host or underlying resources. The embedded instances shall contain only key properties and be treated as Object Paths. If the virtual resource may be scheduled on a number of underlying resources, this property should remain NULL. In that case, the DeviceAllocatedFromPool or ResourceAllocationFromPool associations may be used to determine the pool of host resources on which this virtual resource may be scheduled. If specific assignment is utilized, all underlying resources used by this virtual resource shall be listed in this array. Typically, the array will contain one item, however for aggregate allocations, such as multiple processors, multiple host resources may be specified.

InstanceID

Data type: string

Access type: Read-only

Qualifiers: Key

Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: OrgID:LocalID Where OrgID and LocalID are separated by a colon (:), and where OrgID must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the SchemaName_ClassName structure of Schema class names.) In addition, to ensure uniqueness, OrgID must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between OrgID and LocalID. LocalID is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the OrgID set to CIM.

Limit

Data type: uint64

Access type: Read-only

This property specifies the upper bound, or maximum amount of resource that will be granted for this allocation. For example, a system which supports memory paging may support setting the Limit of a Memory allocation below that of the VirtualQuantity, thus forcing paging to occur for this allocation.

MappingBehavior

Data type: uint16

Access type: Read-only

Specifies how this resource maps to underlying resources. If the HostResource array contains any entries, this property reflects how the resource maps to those specific resources.

Unknown (0)

Not Supported (1)

Dedicated (2)

Soft Affinity (3)

Hard Affinity (4)

DMTF Reserved (..)

Vendor Reserved (32767..65535)

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 "Other".

Parent

Data type: string

Access type: Read-only

The Parent of the resource. For example, a controller for the current allocation.

PoolID

Data type: string

Access type: Read-only

This property specifies which ResourcePool the resource is currently allocated from, or which ResourcePool the resource will be allocated from when the allocation occurs.

Reservation

Data type: uint64

Access type: Read-only

This property specifies the amount of resource guaranteed to be available for this allocation. On system which support over-commitment of resources, this value is typically used for admission control to prevent an allocation from being accepted thus preventing resource depletion.

ResourceSubType

Data type: string

Access type: Read-only

A string describing an implementation specific sub-type for this resource. For example, this may be used to distinguish different models of the same resource type.

ResourceType

Data type: uint16

Access type: Read-only

The type of resource this allocation setting represents.

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)

Other Network Adapter (11)

I/O Slot (12)

I/O Device (13)

Floppy Drive (14)

CD Drive (15)

DVD drive (16)

Serial port (17)

Parallel port (18)

USB Controller (19)

Graphics controller (20)

Storage Extent (21)

Disk (22)

Tape (23)

Other storage device (24)

Firewire Controller (25)

Partitionable Unit (26)

Base Partitionable Unit (27)

Power Supply (28)

Cooling Device (29)

DMTF reserved (..)

Vendor Reserved (32767..65535)

VirtualQuantity

Data type: uint64

Access type: Read-only

This property specifies the quantity of resources presented to the consumer. For example, when ResourceType=Processor, this property would reflect the number of discrete Processors presented to the virtual computer system. When ResourceType=Memory, this property could reflect the number of MB reported to the virtual computer system.

Weight

Data type: uint32

Access type: Read-only

This property specifies a relative priority for this allocation in relation to other allocations from the same ResourcePool. This property has no unit of measure, and is only relevant when compared to other allocations competing for the same host resources.

Requirements

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

See also

CIM_ResourceAllocationSettingData

CIM_ResourceAllocationSettingData