Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Msvm_EthernetSwitchExtension class

Hyper-V

Represents an instance of an extension component bound to a virtual Ethernet switch.

The following syntax is simplified Managed Object Format (MOF) code, and it includes all of the inherited properties.

Syntax

class Msvm_EthernetSwitchExtension : CIM_EnabledLogicalElement
{
  string   InstanceID;
  string   Caption = "Virtual Switch Extension";
  string   Description;
  string   ElementName;
  datetime InstallDate;
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState = 5;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  uint16   EnabledState = 5;
  string   OtherEnabledState;
  uint16   RequestedState;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  uint16   AvailableRequestedStates[];
  uint16   TransitioningToState;
  string   SystemCreationClassName = "Msvm_VirtualEthernetSwitch";
  string   SystemName;
  string   CreationClassName = "Msvm_EthernetSwitchExtension";
  string   Name;
  uint8    ExtensionType;
  string   Vendor;
  string   Version;
};

Members

The Msvm_EthernetSwitchExtension class has these types of members:

Methods

The Msvm_EthernetSwitchExtension class has these methods.

MethodDescription
RequestStateChange

This method is not supported.

 

Properties

The Msvm_EthernetSwitchExtension class has these properties.

AvailableRequestedStates
Data type: uint16 array
Access type: Read-only

Indicates the possible values for the RequestedState parameter of the RequestStateChange method used to initiate a state change. The values listed will be a subset of the values contained in the RequestedStatesSupported property of the associated instance of CIM_EnabledLogicalElementCapabilities, where the values selected are a function of the current state of the CIM_EnabledLogicalElement. This property can be non-Null if an implementation is able to advertise the set of possible values as a function of the current state. This property will be Null if an implementation is unable to determine the set of possible values as a function of the current state.

This property is inherited from CIM_EnabledLogicalElement.

Enabled (2)
Disabled (3)
Shut Down (4)
Offline (6)
Test (7)
Defer (8)
Quiesce (9)
Reboot (10)
Reset (11)
DMTF Reserved (.. )
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 Switch Extension".

CommunicationStatus
Data type: uint16
Access type: Read-only

Indicates the ability of the instrumentation to communicate with the underlying managed element. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

CreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

The name of the class or subclass that is used in the creation of an instance. This property is always set to "Msvm_EthernetSwitchExtension".

Description
Data type: string
Access type: Read-only

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

DetailedStatus
Data type: uint16
Access type: Read-only

Complements the PrimaryStatus property with additional status detail. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

ElementName
Data type: string
Access type: Read-only

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

EnabledDefault
Data type: uint16
Access type: Read-only

An administrator's default or startup configuration for the enabled state of an element. This property is inherited from CIM_EnabledLogicalElement and will be one of the following values.

Enabled (2)
Disabled (3)
Enabled but Offline (6)
EnabledState
Data type: uint16
Access type: Read-only

The enabled and disabled states of an element. This property can also indicate the transitions between these requested states. This property is inherited from CIM_EnabledLogicalElement.

ValueMeaning
Unknown
0
Other
1
Enabled
2

The element is or could be executing commands, will process any queued commands, and queues new requests.

Disabled
3

The element will not execute commands and will drop any new requests.

Shutting Down
4

The element is in the process of going to a Disabled state.

Not Applicable
5

The element does not support being enabled or disabled.

Enabled but Offline
6

The element might be completing commands, and it will drop any new requests.

In Test
7

The element is in a test state.

Deferred
8

The element might be completing commands, but it will queue any new requests.

Quiesce
9

The element is enabled but in a restricted mode. The behavior of the element is similar to the Enabled state, but it processes only a restricted set of commands. All other requests are queued.

Starting
10

The element is in the process of going to an Enabled state. New requests are queued.

DMTF Reserved
11–32767

Reserved.

Vendor Reserved
32768–65535

Reserved.

 

ExtensionType
Data type: uint8
Access type: Read-only

Indicates the type of the extension component.

Unknown (0)
Capture (1)
Filter (2)
Forwarding (3)
Monitoring (4)
Native (5)
HealthState
Data type: uint16
Access type: Read-only

Specifies the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents.

When a critical error occurs, check the event log for details. The EnabledState property can also contain more information. For example, when disk space is critically low, HealthState is set to 25, the virtual machine pauses, and EnabledState is set to 32768 (Paused).

This property is inherited from CIM_ManagedSystemElement.

ValueMeaning
OK
5

The element is fully functional and is operating within normal operational parameters and without error.

Major Failure
20

The element has suffered a major failure.

Critical failure
25

The element is nonfunctional, and recovery might not be possible.

 

InstallDate
Data type: datetime
Access type: Read-only

The date and time the virtual machine configuration was created for a virtual machine, or Null, for a management operating system. This property is inherited from CIM_ManagedSystemElement.

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

Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.

Name
Data type: string
Access type: Read-only
Qualifiers: Key, Override, MaxLen (256)

The unique name of the extension component.

OperatingStatus
Data type: uint16
Access type: Read-only

Provides current status information for the operational condition of the element and can be used for providing more detail with respect to the value of the EnabledState property. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

OperationalStatus
Data type: uint16 array
Access type: Read-only

An array that contains the current statuses of the object. This property is inherited from CIM_ManagedSystemElement.

OtherEnabledState
Data type: string
Access type: Read-only

The enabled or disabled state of the element when the EnabledState property is set to 1 (Other). This property must be set to Null when EnabledState is any value other than 1. This property is inherited from CIM_EnabledLogicalElement, and it is always set to Null.

PrimaryStatus
Data type: uint16
Access type: Read-only

Provides high level status information. This property should be used in conjunction with the DetailedStatus property to provide high level and detailed health status information for the element and its subcomponents. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

RequestedState
Data type: uint16
Access type: Read-only

The last requested or desired state for the element as passed to the RequestStateChange method, or 12 (Not Applicable) if no state change is in progress. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. This property is inherited from CIM_EnabledLogicalElement.

Status
Data type: string
Access type: Read-only

A string that specifies the status of the element. This property is inherited from CIM_ManagedSystemElement.

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

An array that contains strings that describe the corresponding OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement.

SystemCreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

The system creation class name.

SystemName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

The name of the virtual switch to which the extension instance is bound to.

TimeOfLastStateChange
Data type: datetime
Access type: Read-only

The date and time when the enabled state of the element last changed. This property is inherited from CIM_EnabledLogicalElement.

TransitioningToState
Data type: uint16
Access type: Read-only

Indicates the target state to which the instance is transitioning. This property is inherited from CIM_EnabledLogicalElement, but it is not used.

Vendor
Data type: string
Access type: Read-only

Indicates the vendor providing the extension.

Version
Data type: string
Access type: Read-only

The version of the extension in a format of "major.minor", for example "2.0".

Requirements

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

 

 

Community Additions

Show:
© 2014 Microsoft