NDIS_SWITCH_PARAMETERS structure (ntddndis.h)

Article
06/07/2021

The NDIS_SWITCH_PARAMETERS structure contains the configuration data for a Hyper-V extensible switch.

Syntax

typedef struct _NDIS_SWITCH_PARAMETERS {
  NDIS_OBJECT_HEADER       Header;
  ULONG                    Flags;
  NDIS_SWITCH_NAME         SwitchName;
  NDIS_SWITCH_FRIENDLYNAME SwitchFriendlyName;
  UINT32                   NumSwitchPorts;
  BOOLEAN                  IsActive;
} NDIS_SWITCH_PARAMETERS, *PNDIS_SWITCH_PARAMETERS;

Members

Header

The type, revision, and size of the NDIS_SWITCH_PARAMETERS structure. This member is formatted as an NDIS_OBJECT_HEADER structure.

The Type member of Header must be set to NDIS_OBJECT_TYPE_DEFAULT. To specify the version of the NDIS_SWITCH_PARAMETERS structure, the Revision member of Header must be set to the following value:

NDIS_SWITCH_PARAMETERS_REVISION_1

Original version for NDIS 6.30 and later.

Set the Size member to NDIS_SIZEOF_NDIS_SWITCH_PARAMETERS_REVISION_1.

Flags

A ULONG value that contains a bitwise OR of flags. This member is reserved for NDIS.

SwitchName

An NDIS_SWITCH_NAME value that specifies the unique internal name of the extensible switch.

The internal switch name is used by WMI-based policy management applications. For more information, see Managing Hyper-V Extensible Switch Policies.

SwitchFriendlyName

An NDIS_SWITCH_FRIENDLYNAME value that specifies the user-friendly description of the extensible switch.

NumSwitchPorts

A UINT32 value that specifies the number of ports configured on the extensible switch.

IsActive

A BOOLEAN that if TRUE indicates that the Hyper-V extensible switch activation has finished and it is safe to query for other switch configuration such as enumerating ports, NICs, and properties. If FALSE, the extension must wait for the NetEventSwitchActivate PNP event to be issued before querying for switch configuration.

Remarks

The NDIS_SWITCH_PARAMETERS structure is used in the OID request of OID_SWITCH_PARAMETERS.

This structure is also passed in the vSwitch parameter of the following callout functions for Windows Filtering Platform callout drivers:

Note The NDIS_SWITCH_NAME and NDIS_SWITCH_FRIENDLYNAME data types are type-defined by the IF_COUNTED_STRING structure. A string that is defined by this structure does not have to be null-terminated. However, the length of the string must be set in the Length member of this structure. If the string is null-terminated, the Length member must not include the terminating null character.

Requirements

Requirement	Value
Minimum supported client	Supported in NDIS 6.30 and later.
Header	ntddndis.h (include Ndis.h, Fwpsk.h)