Represents a virtual switch. Each switch has many different ports to which network adapters can be attached. The switch itself is not highly configurable and acts mostly as a placeholder.
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_VirtualSwitch : CIM_ComputerSystem
{
string Caption = "Virtual Switch";
string Description;
string ElementName;
datetime InstallDate;
uint16 OperationalStatus[] = 2;
string Status;
uint16 HealthState = 5;
uint16 EnabledState = 5;
string OtherEnabledState;
uint16 RequestedState = 12;
datetime TimeOfLastStateChange;
string Name;
string PrimaryOwnerName;
string IdentifyingDescriptions[];
string OtherIdentifyingInfo[];
uint16 Dedicated[] = 0;
uint16 ResetCapability = 5;
uint16 PowerManagementCapabilities[];
string StatusDescriptions[] = { "OK" };
uint16 EnabledDefault = 2;
string CreationClassName = "Msvm_VirtualSwitch";
string PrimaryOwnerContact;
string Roles[];
string NameFormat;
string OtherDedicatedDescriptions[];
string ScopeOfResidence;
uint32 NumLearnableAddresses;
uint32 MaxVMQOffloads;
uint32 MaxChimneyOffloads;
};
Members
The Msvm_VirtualSwitch class has these types of members:
Methods
The Msvm_VirtualSwitch class has these methods.
| Method | Description |
|---|---|
| RequestStateChange | This method is not supported. |
| SetPowerState | This method is not supported. |
Properties
The Msvm_VirtualSwitch class has these properties.
-
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 "Virtual Switch".
-
-
CreationClassName
-
The name of the class or the subclass that is used in the creation of an instance. This property is inherited from CIM_System and is always set to "Msvm_VirtualSwitch".
-
Dedicated
-
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIB.IETF|MIB-II.sysServices", "FC-GS.INCITS-T11 | Platform | PlatformType"), ArrayType ("Indexed"), ModelCorrespondence ("CIM_ComputerSystem.OtherDedicatedDescriptions")
Indicates whether the computer system is a special-purpose system (dedicated to a particular use), versus being a general-purpose system. This property is inherited from CIM_ComputerSystem and it is set to 0 (Not Dedicated).
-
-
Description
-
-
Data type: string
-
Access type: Read-only
A textual description of the object. This property is inherited from CIM_ManagedElement.
-
-
ElementName
-
-
Data type: string
-
Access type: Read-only
A user-friendly name for the object. This property is inherited from CIM_ManagedElement.
-
-
EnabledDefault
-
-
Data type: uint16
-
Access type: Read/write
An administrator's default or startup configuration for the enabled state of an element. This property is inherited from CIM_EnabledLogicalElement and is always set to 2 (Enabled).
-
-
EnabledState
-
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")
The enabled and disabled states of this element. This property is inherited from CIM_EnabledLogicalElement and is always set to 5 (Not Applicable).
-
-
Not Applicable (5)
-
Indicates the element does not support to be enabled or disabled.
HealthState
-
Data type: uint16
-
Access type: Read-only
The current health of the element. This property is inherited from CIM_ManagedSystemElement and is always set to 5 (OK).
OK (5)
The element is fully functional and operates within normal operational parameters and without error.
IdentifyingDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ComputerSystem.OtherIdentifyingInfo")
This property is inherited from CIM_ComputerSystem and it is set to NULL.
InstallDate
-
Data type: datetime
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")
A datetime value that indicates when the object was installed. This property is inherited from CIM_ManagedSystemElement.
MaxChimneyOffloads
-
Data type: uint32
-
Access type: Read-only
The maximum number of Chimney offloads allowed for a port on this switch.
Windows Server 2008: The MaxChimneyOffloads property is not supported until Windows Server 2008 R2.
MaxVMQOffloads
-
Data type: uint32
-
Access type: Read-only
The maximum number of VM queue (VMQ) offloads allowed for a port on this switch.
Windows Server 2008: The MaxVMQOffloads property is not supported until Windows Server 2008 R2.
Name
A name that uniquely identifies the service and provides an indication of the functionality that is managed. This property is inherited from CIM_System.
NameFormat
-
Data type: string
-
Access type: Read-only
A string that identifies how the system name was generated, using the subclass heuristic. This property is inherited from CIM_ComputerSystem and it is set to NULL.
NumLearnableAddresses
-
Data type: uint32
-
Access type: Read-only
The number of learnable addresses for this switch.
OperationalStatus
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")
The current status of the element. This property is inherited from CIM_ManagedSystemElement and is always set to 2 (OK).
OK (2)
Indicates full functionality without errors.
OtherDedicatedDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ComputerSystem.Dedicated")
A string that describes how or why the system is dedicated when the Dedicated array includes the value 2 (Other). This property is inherited from CIM_ComputerSystem and it is set to NULL.
OtherEnabledState
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
The enabled or disabled state of the element when the EnabledState property is set to 1 (Other). This property is inherited from CIM_EnabledLogicalElement and is not used.
OtherIdentifyingInfo
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: MaxLen (256), ArrayType ("Indexed"), ModelCorrespondence ("CIM_ComputerSystem.IdentifyingDescriptions")
This property is inherited from CIM_ComputerSystem and it is set to NULL.
PowerManagementCapabilities
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities.PowerCapabilities"), MappingStrings ("MIF.DMTF|System Power Controls|001.2")
This property is inherited from CIM_ComputerSystem but it is not used.
PrimaryOwnerContact
-
Data type: string
-
Access type: Read/write
-
Qualifiers: MaxLen (256), MappingStrings ("MIF.DMTF|General Information|001.4")
A string that provides information on how the primary owner of the service can be reached. This property is inherited from CIM_System and is not used.
PrimaryOwnerName
-
Data type: string
-
Access type: Read/write
-
Qualifiers: MaxLen (64), MappingStrings ("MIF.DMTF|General Information|001.3")
The name of the primary owner for the service, if one is defined. This property is inherited from CIM_System and is not used.
RequestedState
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
The last requested or desired state for the management service. This property is inherited from CIM_EnabledLogicalElement and is always set to 12 (Not Applicable).
Not Applicable (12)
Indicates that this instance does not support the RequestedState property.
ResetCapability
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|System Hardware Security|001.4")
This property is inherited from CIM_ComputerSystem and it is set to 5 (Not Implemented).
Not Implemented (5)
Not Implemented.
Roles
-
Data type: string array
-
Access type: Read/write
An array of strings that describe the roles the system plays in the information technology environment. This property is inherited from CIM_System and it is set to NULL.
ScopeOfResidence
-
Data type: string
-
Access type: Read/write
The authorization manager scope for the switch service.
Status
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)
This property is inherited from CIM_ManagedSystemElement but it is not used.
StatusDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")
Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement and is always set to "OK".
TimeOfLastStateChange
-
Data type: datetime
-
Access type: Read-only
The date or time when the enabled state of the element last changed. This property is inherited from CIM_EnabledLogicalElement and is not used.
Remarks
Access to the Msvm_VirtualSwitch 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 |
|