Edit

Msvm_SyntheticEthernetPortSettingData class

  • Article

Represents the configured state of a synthetic 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_SyntheticEthernetPortSettingData : CIM_EthernetPortAllocationSettingData
{
  string  InstanceID;
  string  Caption = "Virtual Ethernet Port Default Settings";
  string  Description = "Describes the default settings for the virtual Ethernet port resources.";
  string  ElementName;
  uint16  ResourceType = 10;
  string  OtherResourceType;
  string  ResourceSubType = "Microsoft:Hyper-V:Synthetic Ethernet Port";
  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  DesiredVLANEndpointMode;
  string  OtherEndpointMode;
  string  VirtualSystemIdentifiers[];
  boolean DeviceNamingEnabled = FALSE;
  boolean AllowPacketDirect = FALSE;
  boolean StaticMacAddress = False;
  boolean ClusterMonitored = TRUE;
};

Members

The Msvm_SyntheticEthernetPortSettingData class has these types of members:

Properties

The Msvm_SyntheticEthernetPortSettingData 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. 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 units of allocation used by the Reservation and Limit properties. This property is inherited from CIM_ResourceAllocationSettingData.

AllowPacketDirect

Data type: boolean

Access type: Read/write

Indicates if PacketDirect projection is enabled for the VM.

Note

Added in Windows 10, version 1703 and Windows Server 2016.

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

A short description of the object. This property is inherited from CIM_ManagedElement.

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.

ConsumerVisibility

Data type: uint16

Access type: Read-only

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.

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 the 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.

DeviceNamingEnabled

Data type: boolean

Access type: Read-only

Indicates whether this ethernet adapter supports device naming.

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

Note

Added in Windows 10 and Windows Server 2016.

ElementName

Data type: string

Access type: Read-only

A short description of the object. This property is inherited from CIM_SettingData.

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

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 upper bound, or maximum amount of resource that will be granted for this allocation. 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.

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 "Other" (0). 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 which 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.

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

Specifies if the MAC address is static.

VirtualQuantity

Data type: uint64

Access type: Read-only

The quantity of resources presented to the consumer. 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.

VirtualSystemIdentifiers

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed")

A string array of identifiers of this resource presented to the virtual machine's operating system. The indexes and values per index are defined on a per resource basis (that is, for each enumerated ResourceType property value).

Weight

Data type: uint32

Access type: Read-only

A relative priority for this allocation in relation to other allocations from the same resource pool. This property is inherited from CIM_ResourceAllocationSettingData.

Remarks

Access to the Msvm_SyntheticEthernetPortSettingData 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