NDIS_SWITCH_PORT_PARAMETERS structure (ntddndis.h)

Article
05/26/2021

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

Syntax

typedef struct _NDIS_SWITCH_PORT_PARAMETERS {
  NDIS_OBJECT_HEADER            Header;
  ULONG                         Flags;
  NDIS_SWITCH_PORT_ID           PortId;
  NDIS_SWITCH_PORT_NAME         PortName;
  NDIS_SWITCH_PORT_FRIENDLYNAME PortFriendlyName;
  NDIS_SWITCH_PORT_TYPE         PortType;
  BOOLEAN                       IsValidationPort;
  NDIS_SWITCH_PORT_STATE        PortState;
} NDIS_SWITCH_PORT_PARAMETERS, *PNDIS_SWITCH_PORT_PARAMETERS;

Members

Header

The type, revision, and size of the NDIS_SWITCH_PORT_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_PORT_PARAMETERS structure, the Revision member of Header must be set to the following value:

NDIS_SWITCH_PORT_PARAMETERS_REVISION_1

Original version for NDIS 6.30 and later.

Set the Size member to NDIS_SIZEOF_NDIS_SWITCH_PORT_PARAMETERS_REVISION_1.

Flags

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

PortId

An NDIS_SWITCH_PORT_ID value that contains the unique identifier of the extensible switch port.

PortName

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

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

PortFriendlyName

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

PortType

An NDIS_SWITCH_PORT_TYPE value that specifies the type of the extensible switch port.

IsValidationPort

If TRUE, indicates a port that is temporarily created for test and validation purposes before a VM network adapter connection is established. For more information about this port type, see Validation Ports.

PortState

An NDIS_SWITCH_PORT_STATE value that specifies the current state of the port.

Remarks

The InformationBuffer member of the NDIS_OID_REQUEST structure contains a pointer to an NDIS_SWITCH_PORT_PARAMETERS structure for the following OID requests:

OID query requests of OID_SWITCH_PORT_ARRAY return an NDIS_SWITCH_PORT_ARRAY structure that contains an array of elements. Each element is formatted as an NDIS_SWITCH_PORT_PARAMETERS structure.

Extensible switch extensions can access the port property buffer inside an NDIS_SWITCH_PORT_PARAMETERS structure by using the NDIS_SWITCH_PORT_AT_ARRAY_INDEX macro.

Note The NDIS_SWITCH_PORT_NAME and NDIS_SWITCH_PORT_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)