| description | external help file | Module Name | ms.date | online version | schema | title |
|---|---|---|---|---|---|---|
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell. |
MSFT_NetAdapterVmq.cmdletDefinition.cdxml-help.xml |
NetAdapter |
12/20/2016 |
2.0.0 |
Set-NetAdapterVmq |
Sets the VMQ properties of a network adapter.
Set-NetAdapterVmq [-Name] <String[]> [-IncludeHidden] [-BaseProcessorGroup <UInt16>]
[-BaseProcessorNumber <Byte>] [-MaxProcessors <UInt32>] [-MaxProcessorNumber <Byte>] [-NumaNode <UInt16>]
[-Enabled <Boolean>] [-NoRestart] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-PassThru]
[-WhatIf] [-Confirm] [<CommonParameters>]
Set-NetAdapterVmq -InterfaceDescription <String[]> [-IncludeHidden] [-BaseProcessorGroup <UInt16>]
[-BaseProcessorNumber <Byte>] [-MaxProcessors <UInt32>] [-MaxProcessorNumber <Byte>] [-NumaNode <UInt16>]
[-Enabled <Boolean>] [-NoRestart] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-PassThru]
[-WhatIf] [-Confirm] [<CommonParameters>]
Set-NetAdapterVmq -InputObject <CimInstance[]> [-BaseProcessorGroup <UInt16>] [-BaseProcessorNumber <Byte>]
[-MaxProcessors <UInt32>] [-MaxProcessorNumber <Byte>] [-NumaNode <UInt16>] [-Enabled <Boolean>] [-NoRestart]
[-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [-WhatIf] [-Confirm]
[<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.
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.
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.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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.
Type: UInt16
Parameter Sets: (All)
Aliases: BaseG
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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.
Type: Byte
Parameter Sets: (All)
Aliases: BaseN
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseRuns 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.
Type: CimSession[]
Parameter Sets: (All)
Aliases: Session
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseIndicates whether VMQ is enabled or disabled. The acceptable values for this parameter are: $True or $False.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False-IncludeHidden
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.
Type: SwitchParameter
Parameter Sets: ByName, ByInstanceID
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.
Type: CimInstance[]
Parameter Sets: InputObject (cdxml)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseSpecifies 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.
Type: String[]
Parameter Sets: ByInstanceID
Aliases: ifDesc, InstanceID
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies the largest processor number in the group.
Type: Byte
Parameter Sets: (All)
Aliases: MaxN
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the maximum number of processors used by VMQ for load balancing network transmissions.
Type: UInt32
Parameter Sets: (All)
Aliases: Max
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies an array of network adapter names.
Type: String[]
Parameter Sets: ByName
Aliases: ifAlias, InterfaceAlias
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseIndicates 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.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the preferred non-uniform memory access (NUMA) node for the affinity of the VMQs allocated on this network adapter.
Type: UInt16
Parameter Sets: (All)
Aliases: NumaN
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseReturns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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.
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.