Msvm_VirtualEthernetSwitchSettingData class

Article
01/07/2021

Represents the current configuration of a virtual Ethernet switch.

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_VirtualEthernetSwitchSettingData : CIM_VirtualEthernetSwitchSettingData
{
  string   InstanceID = "Microsoft:GUID\DeviceSpecificData";
  string   Caption = "Virtual Ethernet Switch Settings";
  string   Description = "Active settings for the virtual Ethernet switch";
  string   ElementName;
  string   VirtualSystemIdentifier;
  string   VirtualSystemType;
  string   Notes[];
  datetime CreationTime;
  string   ConfigurationID;
  string   ConfigurationDataRoot;
  string   ConfigurationFile;
  string   SnapshotDataRoot;
  string   SuspendDataRoot;
  string   SwapFileDataRoot;
  string   LogDataRoot;
  uint16   AutomaticStartupAction;
  datetime AutomaticStartupActionDelay;
  uint16   AutomaticStartupActionSequenceNumber;
  uint16   AutomaticShutdownAction;
  uint16   AutomaticRecoveryAction;
  string   RecoveryFile;
  string   VLANConnection[];
  string   AssociatedResourcePool[];
  uint32   MaxNumMACAddress;
  boolean  IOVPreferred = FALSE;
  string   ExtensionOrder[];
  uint32   BandwidthReservationMode = 0;
  boolean  TeamingEnabled = FALSE;
  boolean  PacketDirectEnabled = FALSE;
};

Members

The Msvm_VirtualEthernetSwitchSettingData class has these types of members:

Properties

Properties

The Msvm_VirtualEthernetSwitchSettingData class has these properties.

AssociatedResourcePool

Data type: string array
Access type: Read-only

A list of host resource pools to be associated or that are currently associated with the Ethernet switch for the purpose of the allocation of Ethernet connections between a virtual machine and an Ethernet switch. Each value must conform to the production WBEM_URI_UntypedInstancePath as defined in DSP0207. This property is inherited from CIM_VirtualEthernetSwitchSettingData.

AutomaticRecoveryAction

Data type: uint16
Access type: Read-only

Action to take for the virtual machine when the software executed by the virtual machine fails. Failures in this case means a failure that is detectable by the host platform, such as a non-interruptible wait state condition. This property is inherited from CIM_VirtualSystemSettingData, and is not used.

AutomaticShutdownAction

Data type: uint16
Access type: Read-only

Action to take for the virtual machine when the host is shut down. This property is inherited from CIM_VirtualSystemSettingData, and is not used.

AutomaticStartupAction

Data type: uint16
Access type: Read-only

Action to take for the virtual machine when the host is started. This property is inherited from CIM_VirtualSystemSettingData, and is not used.

AutomaticStartupActionDelay

Data type: datetime
Access type: Read-only

The delay time before the virtual machine is automatically started up. This property is inherited from CIM_VirtualSystemSettingData, and is not used.

AutomaticStartupActionSequenceNumber

Data type: uint16
Access type: Read-only

A number that indicates the relative sequence of virtual machine activation when the host system is started. A lower number indicates earlier activation. This property is inherited from CIM_VirtualSystemSettingData, and is not used.

BandwidthReservationMode

Data type: uint32
Access type: Read/write

The bandwidth reservation mode.

Default (0)

Weight (1)

Absolute (2)

None (3)

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 "Virtual Ethernet Switch Settings".

ConfigurationDataRoot

Data type: string
Access type: Read-only

The path of a directory where information about the virtual machine configuration is stored. This property is inherited from CIM_VirtualSystemSettingData, and is not used.

ConfigurationFile

Data type: string
Access type: Read-only

The relative path and file name of a file where information about the virtual machine configuration is stored. This path is relative to the ConfigurationDataRoot property. This property is inherited from CIM_VirtualSystemSettingData, and is not used.

ConfigurationID

Data type: string
Access type: Read-only

The unique identifier of the virtual machine configuration. This property is inherited from CIM_VirtualSystemSettingData, and is not used.

CreationTime

Data type: datetime
Access type: Read-only

The date and time at which the settings were created. This property is inherited from CIM_VirtualSystemSettingData.

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 "Active settings for the virtual Ethernet switch".

ElementName

Data type: string
Access type: Read-only

A display name for the object. This property is inherited from CIM_VirtualSystemSettingData.

ExtensionOrder

Data type: string array
Access type: Read/write

An array of embedded instances of the Msvm_EthernetSwitchExtension class that represent the switch extensions bound to this switch, in the order in which they are applied.

InstanceID

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

Uniquely identifies an instance of this class. This property is inherited from CIM_SettingData and is always set to "Microsoft:GUID\DeviceSpecificData".

IOVPreferred

Data type: boolean
Access type: Read/write

Specifies whether single root IO virtualization (SR-IOV) is preferred or not, if available, on the underlying adapter.

LogDataRoot

Data type: string
Access type: Read-only

The path of a directory where log information for the virtual machine is stored. This property is inherited from CIM_VirtualSystemSettingData, and is not used.

MaxNumMACAddress

Data type: uint32
Access type: Read-only

Specifies the maximum number of unique MAC addresses that can be learned by the switch to support MAC Address Learning, as defined in the IEEE 802.1 standard. This property is inherited from CIM_VirtualEthernetSwitchSettingData.

Notes

Data type: string array
Access type: Read-only

User supplied notes that are related to the virtual machine. This property is inherited from CIM_VirtualSystemSettingData.

PacketDirectEnabled

Data type: boolean
Access type: Read/write

Specifies whether PacketDirect should be used, if available. The default value is false.

Note

This property was added in Windows 10 and Windows Server 2016.

RecoveryFile

Data type: string
Access type: Read-only

The full path of a file where recovery related information for the virtual machine is stored. This property is inherited from CIM_VirtualSystemSettingData, and is not used.

SnapshotDataRoot

Data type: string
Access type: Read-only

The path of a directory where information about the virtual machine snapshots is stored. This property is inherited from CIM_VirtualSystemSettingData, and is not used.

SuspendDataRoot

Data type: string
Access type: Read-only

The path of a directory where information about the virtual machine suspend-related information is stored. This property is inherited from CIM_VirtualSystemSettingData, and is not used.

SwapFileDataRoot

Data type: string
Access type: Read-only

The path of a directory where swap files for the virtual machine are stored. This property is inherited from CIM_VirtualSystemSettingData, and is not used.

TeamingEnabled

Data type: boolean
Access type: Read/write

Specifies whether NIC Teaming should be used. The default value is false.

Note

This property was added inWindows 10 and Windows Server 2016.

VirtualSystemIdentifier

Data type: string
Access type: Read-only

The name of the CIM_ComputerSystem object to which this setting data belongs. This property is an override from CIM_VirtualSystemSettingData.

VirtualSystemType

Data type: string
Access type: Read-only

Specifies the type of virtual machine the setting data represents. This property is inherited from the CIM_VirtualSystemSettingData.

VLANConnection

Data type: string array
Access type: Read-only

A list of VLAN identifiers that this switch can access. This property is inherited from CIM_VirtualEthernetSwitchSettingData.

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