Msvm_SyntheticEthernetPortSettingData class

Article
05/31/2018

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_ResourceAllocationSettingData
{
  string  Caption = "Ethernet Port";
  string  Description = "Settings for the Microsoft Synthetic Ethernet Port";
  string  InstanceID = "Microsoft:GUID\device-specific data";
  string  ElementName = "Ethernet Port";
  uint16  ResourceType = 10;
  string  OtherResourceType;
  string  ResourceSubType = "Microsoft Synthetic 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  VirtualSystemIdentifiers[] = "GUID";
  boolean StaticMacAddress = TRUE;
};

Members

The Msvm_SyntheticEthernetPortSettingData class has these types of members:

Properties

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.

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

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 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 is always set to True.

AutomaticDeallocation

Data type: boolean
Access type: Read-only

Indicates whether the resource will be automatically de-allocated. This property is inherited from CIM_ResourceAllocationSettingData and is always set to True.

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

A short textual description (one- line string) of the object. This property is inherited from CIM_ManagedElement and is always set to "Ethernet Port".

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 using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.

ConsumerVisibility

Data type: uint16
Access type: Read-only

The consumers visibility to the allocated resource. This property is inherited from CIM_ResourceAllocationSettingData and is always set to 3 (Virtualized).

Description

Data type: string
Access type: Read-only

A textual description of the object. This property is inherited from CIM_ManagedElement and is always set to "Settings for the Microsoft Synthetic Ethernet Port".

ElementName

Data type: string
Access type: Read-only
Qualifiers: Required

A short textual description (one- line string) of the object. 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 using the ModifyVirtualSystemResources method of the Msvm_VirtualSystemManagementService class.

HostResource

Data type: string array
Access type: Read-only
Qualifiers: HyperVEmbeddedInstance ("CIM_LogicalDevice")

This property is inherited from CIM_ResourceAllocationSettingData and it is always set to NULL.

InstanceID

Data type: string
Access type: Read-only
Qualifiers: Key

This property is inherited from CIM_SettingData and is always set to "Microsoft:GUID\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 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 is always set to NULL.

OtherResourceType

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.ResourceType")

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 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
Qualifiers: ModelCorrespondence ("CIM_ResourcePool.PoolId")

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 system which support over-commitment of resources, this value is typically used for admission control to prevent an allocation from being accepted thus preventing starvation. This property is inherited from CIM_ResourceAllocationSettingData and is always set to 1.

ResourceSubType

Data type: string
Access type: Read-only

A string that describes 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 and is always set to "Microsoft Synthetic Ethernet Port".

ResourceType

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_ResourceAllocationSettingData.OtherResourceType")

The type of resource this setting applies to. This property is inherited from CIM_ResourceAllocationSettingData and is always set to 10 (Ethernet Adapter).

StaticMacAddress

Data type: boolean
Access type: Read-only

Indicates a static MAC address.

This is a read-only property, but it can be changed using the ModifyVirtualSystemResources 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 is always set to 1.

VirtualSystemIdentifiers

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed")

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

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

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 and is always set to 0.

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


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	WindowsVirtualization.mof

Msvm_SyntheticEthernetPortSettingData class

Syntax

Members

Properties

Remarks

Examples

Requirements

See also

Additional resources