Edit

Querying the Hyper-V Extensible Switch Configuration

  • Article

The Hyper-V extensible switch interface includes object identifier (OID) requests that are issued by an extensible switch extension to query the current configuration of the extensible switch, its ports, and its network adapter connections. These requests include the following OIDs:

OID_SWITCH_NIC_ARRAY
This OID query request returns an array. Each element in the array specifies the configuration parameters of a network adapter that is associated with an extensible switch port.

OID_SWITCH_PARAMETERS
This OID query request returns the current configuration of the extensible switch.

OID_SWITCH_PORT_ARRAY
This OID query request returns an array. Each element in the array specifies the configuration parameters for an extensible switch port.

OID_SWITCH_PORT_PROPERTY_ENUM
This OID method request returns an array. Each element in the array specifies the properties of a policy for a specified extensible switch port.

OID_SWITCH_PROPERTY_ENUM
This OID method request returns an array. Each element in the array specifies the properties of an extensible switch policy.

Note  When a switch extension binds for a Hyper-v Extensible Switch, it must first issue the OID_SWITCH_PARAMETERS OID to obtain the basic switch information. If the IsActive member of the NDIS_SWITCH_PARAMETERS structure is FALSE, the extension must not issue the other query OIDs until the switch has finished activation. In this case, the NetEventSwitchActivate NET_PNP_EVENT notification specifies the switch activation event. If the IsActive member is TRUE at bind, the extension can safely issue the other query OIDs. Querying for the configuration while the Hyper-v Extensible Switch has not completed activation will result in the extension having an incomplete initial view of the switch configuration.

Note  When an extension generates its own OID requests, it does this in the same way as any NDIS filter driver. For more information on how this is done, see Generating OID Requests from an NDIS Filter Driver.

For more information on the control path for extensible switch OID requests, see Hyper-V Extensible Switch Control Path for OID Requests.