Skip to content
PowerShell Commands

Set-NetAdapterVmq

Set-NetAdapterVmq [-Name*] <String[]> [-AsJob] [-BaseProcessorGroup <UInt16>] [-BaseProcessorNumber <Byte>][-CimSession <CimSession[]>] [-Enabled <Boolean>] [-IncludeHidden] [-MaxProcessorNumber <Byte>] [-MaxProcessors<UInt32>] [-NoRestart] [-NumaNode <UInt16>] [-PassThru] [-ThrottleLimit <Int32>] [-Confirm] [-WhatIf][<CommonParameters>]
Set-NetAdapterVmq [-AsJob] [-BaseProcessorGroup <UInt16>] [-BaseProcessorNumber <Byte>] [-CimSession<CimSession[]>] [-Enabled <Boolean>] [-MaxProcessorNumber <Byte>] [-MaxProcessors <UInt32>] [-NoRestart][-NumaNode <UInt16>] [-PassThru] [-ThrottleLimit <Int32>] -InputObject* <CimInstance[]> [-Confirm] [-WhatIf][<CommonParameters>]
Set-NetAdapterVmq [-AsJob] [-BaseProcessorGroup <UInt16>] [-BaseProcessorNumber <Byte>] [-CimSession<CimSession[]>] [-Enabled <Boolean>] [-IncludeHidden] [-MaxProcessorNumber <Byte>] [-MaxProcessors <UInt32>][-NoRestart] [-NumaNode <UInt16>] [-PassThru] [-ThrottleLimit <Int32>] -InterfaceDescription* <String[]> [-Confirm][-WhatIf] [<CommonParameters>]

The Set-NetAdapterVmq cmdlet sets the virtual machine queue (VMQ) properties of a network adapter. VMQ is a scaling networking technology for Hyper-V switch that improves network throughput by distributing processing of network traffic for multiple virtual machines among multiple processors. A thorough familiarity with VMQ and dynamic VMQ is highly recommended before changing any default values with this cmdlet.

Parameters

-AsJob [<SwitchParameter>]

ps_cimcommon_asjob

-BaseProcessorGroup <UInt16>

Specifies the processor group to be used by VMQ. Support for systems that have more than 64 logical processors is based on the concept of a processor group, which is a static set of up to 64 logical processors. Processor groups are numbered starting with 0. Computers with fewer than 64 logical processors always have a single group, Group 0.

-BaseProcessorNumber <Byte>

Specifies the starting processor to be used within the processor group for VMQ. Support for systems that have more than 64 logical processors is based on the concept of a processor group, which is a static set of up to 64 logical processors. Processor groups are numbered starting with 0. Computers with fewer than 64 logical processors always have a single group, Group 0. A logical processor is identified by a group number, using the BaseProcessorGroup parameter, and a group-relative processor number, using this parameter.

-CimSession <CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

-Enabled <Boolean>

Indicates whether VMQ is enabled or disabled. The acceptable values for this parameter are: $True or $False.

-IncludeHidden [<SwitchParameter>]

Indicates that the cmdlet includes both visible and hidden network adapters in the operation. By default only visible network adapters are included. If a wildcard character is used in identifying a network adapter and this parameter has been specified, then the wildcard string is matched against both hidden and visible network adapters.

-InputObject <CimInstance[]>

  • This value is required
  • Accepts pipeline input ByValue

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

-InterfaceDescription <String[]>

  • This value is required
  • Accepts pipeline input ByPropertyName
  • Accepts wildcard characters

Specifies an array of network adapter interface descriptions. For a physical network adapter this is typically the name of the vendor of the network adapter followed by a part number and description, such as Contoso 12345 Gigabit Network Device.

-MaxProcessorNumber <Byte>

Specifies the largest processor number in the group.

-MaxProcessors <UInt32>

Specifies the maximum number of processors used by VMQ for load balancing network transmissions.

-Name <String[]>

  • This value is required
  • Accepts pipeline input ByPropertyName
  • Accepts wildcard characters

Specifies an array of network adapter names.

-NoRestart [<SwitchParameter>]

Indicates that the cmdlet does not restart the network adapter after completing the operation. Many advanced properties require restarting the network adapter before the new settings take effect.

-NumaNode <UInt16>

Specifies the preferred non-uniform memory access (NUMA) node for the affinity of the VMQs allocated on this network adapter.

-PassThru [<SwitchParameter>]

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

-ThrottleLimit <Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShellr calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

-Confirm [<SwitchParameter>]

  • Default value is false

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

-WhatIf [<SwitchParameter>]

  • Default value is false

Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterVmqSettingData[]
The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
Outputs
Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterVmqSettingData
The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
Examples
  1. Enable VMQ on the specified network adapter: 
    PS C:\> Set-NetAdapterVmq -Name "MyAdapter" -Enabled $True

    This command enables VMQ on the network adapter named MyAdapter. The Enable-NetAdapterVmq cmdlet is the preferred cmdlet to perform this operation.

This work is licensed under a Creative Commons Attribution 4.0 International. It is attributed to Microsoft Corporation and can be found here.

PowerShell Commands