Msvm_SwitchPort class

Represents a port on the 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_SwitchPort : CIM_SwitchPort
{
  string   Caption = "Switch Port";
  string   ElementName;
  datetime InstallDate;
  uint16   HealthState = 5;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  string   SystemCreationClassName = "Msvm_VirtualSwitch";
  string   SystemName;
  string   CreationClassName = "Msvm_SwitchPort";
  string   Description = "Microsoft Virtual Switch Port";
  uint16   OperationalStatus[] = 2;
  uint16   EnabledState = 5;
  datetime TimeOfLastStateChange;
  uint16   ProtocolType;
  uint16   ProtocolIFType = 1;
  uint16   PortNumber;
  String   StatusDescriptions[] = "OK";
  uint16   EnabledDefault = 2;
  String   Name;
  String   NameFormat;
  String   OtherTypeDescription = "Virtual Ethernet";
  boolean  BroadcastResetSupported = FALSE;
  string   ScopeOfResidence;
  string   Status;
  uint32   VMQOffloadWeight = 100;
  string   AllowedIPv6Addresses[];
  string   AllowedIPv4Addresses[];
  boolean  PreventIPSpoofing;
  uint32   ChimneyOffloadWeight = 0;
  uint32   VMQOffloadUsage;
  uint32   ChimneyOffloadUsage;
  uint32   VMQOffloadLimit;
  uint32   ChimneyOffloadLimit;
  boolean  AllowMacSpoofing;
};

Members

The Msvm_SwitchPort class has these types of members:

• Methods
• Properties

Methods

The Msvm_SwitchPort class has these methods.

Properties

The Msvm_SwitchPort class has these properties.

AllowedIPv4Addresses

Data type: string array

Access type: Read/write

The list of IPv4 addresses which are valid in ARP and neighbor Discovery packets.

Each address in the list must point a text string of an IPv4 address in dotted-decimal notation as in "192.168.16.0", an example of an IPv4 address in dotted-decimalnotation.

AllowedIPv6Addresses

Data type: string array

Access type: Read/write

The list of IPv6 addresses which are valid in ARP and neighbor Discovery packets.The basic string representation consists of 8 hexadecimal numbers separated by colons.A string of consecutive zero numbers may be replaced with a double-colon.There can only be one double-colon in the string representation of the IPv6 address.The last 32 bits may be represented in IPv4-style dotted-octet notationif the address is a IPv4-compatible address.

AllowMacSpoofing

Data type: boolean

Access type: Read/write

Indicates whether the port will allow MAC spoofing.

Value	Meaning
TRUE	The port will allow MAC addresses to be spoofed. All valid unicast MAC address values are allowed except those of ports with the AllowMacSpoofing property set to FALSE.
FALSE	The port will allow only MAC addresses configured within Hyper-V management to be used.

Windows Server 2008: The AllowMacSpoofing property is not supported until Windows Server 2008 R2.

BroadcastResetSupported

Data type: boolean

Access type: Read-only

Qualifiers: Experimental, MappingStrings ("FC-SWAPI.INCITS-T11|SWAPI_PORT_CONFIG_CAPS_T.PortForceLipSupported"), ModelCorrespondence ("CIM_ProtocolEndpoint.BroadcastReset")

Indicates whether the instrumentation supports the BroadcastReset method. This property is inherited from CIM_SwitchPort and is always set to FALSE.

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 "Switch Port".

ChimneyOffloadLimit

Data type: uint32

Access type: Read/write

The current TCP Chimney Offloading resources limit on this port. The limit is the maximum usage of TCP Chimney Offloading resources on the port.

Windows Server 2008: The ChimneyOffloadLimit property is not supported until Windows Server 2008 R2.

ChimneyOffloadUsage

Data type: uint32

Access type: Read/write

The current TCP Chimney Offloading usage on this port. The usage is the amount of TCP Chimney Offloading resources in use on the port.

Windows Server 2008: The ChimneyOffloadUsage property is not supported until Windows Server 2008 R2.

ChimneyOffloadWeight

Data type: uint32

Access type: Read/write

The weight assigned to this port for TCP Chimney Offloading. The weight is the relative importance when assigning TCP Chimney Offloading resources. Setting the ChimneyOffloadWeight property to 0 disables TCP Chimney Offloading on the port. The default is 0.

Windows Server 2008: The ChimneyOffloadWeight property is not supported until Windows Server 2008 R2.

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256)

The name of the class or the subclass used in the creation of an instance. This property is inherited from CIM_ServiceAccessPoint and is always set to "Msvm_SwitchPort".

Description

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("MIB.IETF|IF-MIB.ifDescr")

A textual description of the object. This property is inherited from CIM_ProtocolEndpoint and is always set to "Microsoft Virtual Switch Port".

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: MappingStrings ("MIB.IETF|IF-MIB.ifAdminStatus")

The enabled and disabled states of this element. This property is inherited from CIM_ProtocolEndpoint and is always set to 5 (Not Applicable).

Not Applicable (5)

The element does not support being enabled or disabled.

Remarks

Access to the Msvm_SwitchPort class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.

Examples

See Querying Networking Objects.

Requirements

See also

CIM_SwitchPort

CIM_SwitchPort

Networking Classes