Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Set-NetAdapterVmq

Set-NetAdapterVmq

msft_netadaptervmq.cmdletdefinition.cdxml

Synopsis

Sets the virtual machine queue (VMQ) properties of the network adapter.

Syntax

Set-NetAdapterVmq [-Name] [-AsJob] [-BaseProcessorGroup] [-BaseProcessorNumber] [-CimSession] [-Enabled] [-IncludeHidden] [-MaxProcessorNumber] [-MaxProcessors] [-NoRestart] [-NumaNode] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetAdapterVmq [-AsJob] [-BaseProcessorGroup] [-BaseProcessorNumber] [-CimSession] [-Enabled] [-MaxProcessorNumber] [-MaxProcessors] [-NoRestart] [-NumaNode] [-PassThru] [-ThrottleLimit] [-InputObject] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetAdapterVmq [-AsJob] [-BaseProcessorGroup] [-BaseProcessorNumber] [-CimSession] [-Enabled] [-IncludeHidden] [-MaxProcessorNumber] [-MaxProcessors] [-NoRestart] [-NumaNode] [-PassThru] [-ThrottleLimit] [-InterfaceDescription] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-NetAdapterVmq cmdlet sets the virtual machine queue (VMQ) properties of the 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 (VMs) 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>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Enabled <Boolean>

Sets the enabled state of VMQ. The acceptable values for this parameter are:  $true or $false.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-IncludeHidden <SwitchParameter>

Specifies both visible and hidden network adapters should be included. 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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <CimInstance[]>

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

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-InterfaceDescription <String[]>

Specifies the network adapter interface description. 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.

Aliases

ifDesc

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

true

-MaxProcessorNumber <Byte>

Specifies the largest processor number in the group.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-MaxProcessors <UInt32>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <String[]>

Specifies the name of the network adapter.

Aliases

ifAlias, InterfaceAlias

Required?

true

Position

1

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

true

-NoRestart <SwitchParameter>

Specifies that the network adapter is not restarted as part of running this cmdlet. Note: Many advanced properties require restarting the network adapter before the new settings take effect.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-NumaNode <UInt16>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-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 PowerShell® 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.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterVmqSettingData[]

Return Type

Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterVmqSettingData

Notes

None

Examples

EXAMPLE 1

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

PS C:\>Set-NetAdapterVmq –Name MyAdapter -Enabled $True

Online Version
Disable-NetAdapterVmq
Enable-NetAdapterVmq
Get-NetAdapterVmq
Get-NetAdapterVmqQueue