Represents the configured state of an emulated Ethernet adapter.
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_EmulatedEthernetPortSettingData : CIM_EthernetPortAllocationSettingData
{
string Caption = "Ethernet Port";
string Description = "Settings for the Microsoft Emulated Ethernet Port";
string InstanceID = "Microsoft:VMID\VDID\device-specific-data";
string ElementName = "Ethernet Port";
uint16 ResourceType = 10;
string OtherResourceType;
string ResourceSubType = "Microsoft Emulated Ethernet Port";
string PoolID;
uint16 ConsumerVisibility = 3;
string HostResource[];
string AllocationUnits = "Ports";
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 DesiredVLANEndpointMode;
string OtherEndpointMode;
boolean StaticMacAddress = TRUE;
boolean ClusterMonitored = TRUE;
};
Members
The Msvm_EmulatedEthernetPortSettingData class has these types of members:
Properties
The Msvm_EmulatedEthernetPortSettingData class has these properties.
Address
Data type: string
Access type: Read-only
The address of the resource. For example, the MAC address of an Ethernet port. This property is inherited from CIM_ResourceAllocationSettingData.
This is a read-only property, but it can be changed by using the ModifyResourceSettings method of the Msvm_VirtualSystemManagementService class.
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 units of allocation used by the Reservation and Limit properties. This property is inherited from CIM_ResourceAllocationSettingData, and it is always set to "Ports".
AutomaticAllocation
Data type: boolean
Access type: Read-only
Indicates whether the resource will be automatically allocated. This property is inherited from CIM_ResourceAllocationSettingData, and it is always set to True.
AutomaticDeallocation
Data type: boolean
Access type: Read-only
Indicates whether the resource will be automatically deallocated. This property is inherited from CIM_ResourceAllocationSettingData, and it is always set to True.
Caption
Data type: string
Access type: Read-only
A short description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Ethernet Port".
ClusterMonitored
Data type: boolean
Access type: Read-only
Indicates whether this ethernet adapter is monitored by a cluster. This property defaults to true if not configured.
This is a read-only property, but it can be changed by using the ModifyResourceSettings method of the Msvm_VirtualSystemManagementService class.
Windows 8.1: This value is not supported until Windows 8.1 and Windows Server 2012 R2.
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. This property is inherited from CIM_ResourceAllocationSettingData.
This is a read-only property, but it can be changed by using the ModifyResourceSettings method of the Msvm_VirtualSystemManagementService class.
ConsumerVisibility
Data type: uint16
Access type: Read-only
Describes the consumers 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 "Settings for the Microsoft Emulated Ethernet Port".
DesiredVLANEndpointMode
Data type: uint16
Access type: Read-only
The desired configuration mode for the VLAN endpoint. This property is used to set the initial OperationalEndpointMode property value in the instance of Msvm_VLANEndpoint class associated with the targeted Ethernet port. See the OperationalEndpointMode property of the Msvm_VLANEndpoint class for possible values. This property is inherited from CIM_EthernetPortAllocationSettingData.
ElementName
Data type: string
Access type: Read-only
The user-configurable display name for the device this RASD instance is associated with. This property is inherited from CIM_SettingData, and it is set to "Ethernet Port". Changing this property will change the element name of the associated logical device derivative.
This is a read-only property, but it can be changed by using the ModifyResourceSettings method of the Msvm_VirtualSystemManagementService class.
HostResource
Data type: string array
Access type: Read-only
This property is inherited from CIM_ResourceAllocationSettingData, and it is always set to Null.
InstanceID
Data type: string
Access type: Read-only
Within the scope of the instantiating namespace, InstanceID opaquely and uniquely identifies an instance of this class. This property is inherited from CIM_SettingData, and it is always set to "Microsoft:VMID\VDID\device-specific-data".
Limit
Data type: uint64
Access type: Read-only
The upper bound, or maximum amount of resource that will be granted for this allocation. This property is inherited from CIM_ResourceAllocationSettingData, and it is always set to 1.
MappingBehavior
Data type: uint16
Access type: Read-only
Specifies how this resource maps to underlying resources. This property is inherited from CIM_ResourceAllocationSettingData, and it is always set to Null.
OtherEndpointMode
Data type: string
Access type: Read-only
A string that describes the type of VLAN endpoint model that is supported by this VLAN endpoint. This property is only used when the DesiredVLANEndpointMode property is set to 1 (Other). This property should be set to Null when the DesiredVLANEndpointMode property is any value other than 1. This property is inherited from CIM_EthernetPortAllocationSettingData.
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 is set to 0 ("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. For example, a controller for the current allocation. This property is inherited from CIM_ResourceAllocationSettingData.
PoolID
Data type: string
Access type: Read-only
The pool the resource is currently allocated from, or the pool the resource will be allocated from when the allocation occurs. This property is inherited from CIM_ResourceAllocationSettingData.
Reservation
Data type: uint64
Access type: Read-only
The amount of resource guaranteed to be available for this allocation. On systems that support over-commitment of resources, this value is typically used for admission control to prevent an allocation from being accepted. This property is inherited from CIM_ResourceAllocationSettingData, and it is always set to 1.
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, and it is always set to "Microsoft Emulated Ethernet Port".
ResourceType
Data type: uint16
Access type: Read-only
The type of resource this setting applies to. This property is inherited from CIM_ResourceAllocationSettingData, and it is always set to 10 (Ethernet Adapter).
StaticMacAddress
Data type: boolean
Access type: Read-only
Indicates whether to use a static MAC address.
This is a read-only property, but it can be changed by using the ModifyResourceSettings method of the Msvm_VirtualSystemManagementService class.
VirtualQuantity
Data type: uint64
Access type: Read-only
The quantity of resources presented to the consumer. This property is inherited from CIM_ResourceAllocationSettingData, and it is always set to 1.
VirtualQuantityUnits
Data type: string
Access type: Read-only
Specifies the unit of measurement for this resource allocation. 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
A relative priority for this allocation in relation to other allocations from the same ResourcePool. This property is inherited from CIM_ResourceAllocationSettingData, and it is always set to 0.
Remarks
Access to the Msvm_EmulatedEthernetPortSettingData class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.
Examples
See Querying networking objects.
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 |
See also
CIM_EthernetPortAllocationSettingData
CIM_ResourceAllocationSettingData
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
