Edit

Set-NetAdapterRdma

  • Reference
Module:
NetAdapter

Sets the remote direct memory access (RDMA) properties on the network adapter.

Syntax

Set-NetAdapterRdma
   [[-Name] <String[]>]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Enabled <Boolean>]
   [-IncludeHidden]
   [-NoRestart]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   [-Confirm]
   [-WhatIf]
Set-NetAdapterRdma
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Enabled <Boolean>]
   [-NoRestart]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   -InputObject <CimInstance[]>
   [-Confirm]
   [-WhatIf]
Set-NetAdapterRdma
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-Enabled <Boolean>]
   [-IncludeHidden]
   [-NoRestart]
   [-PassThru]
   [-ThrottleLimit <Int32>]
   -InterfaceDescription <String[]>
   [-Confirm]
   [-WhatIf]

Description

The Set-NetAdapterRdma cmdlet sets the remote direct memory access (RDMA) properties on the network adapter. RDMA is a feature that enables network adapters to transfer data directly between each other without requiring the main processor of the computer to be part of that transfer. This results in lower latency and lower processor utilization. The Enable-NetAdapterRdma and DisableNetAdapterRdma cmdlets can also be used to manage RDMA.

Examples

EXAMPLE 1

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

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

EXAMPLE 2

PS C:\>Set-NetAdapterRdma -Name MyAdapter -Enabled $False

This example disables RDMA on the network adapter named MyAdapter. Note: The Disable-NetAdapterRdma cmdlet is the preferred cmdlet to perform this operation.

Parameters

-AsJob

ps_cimcommon_asjob

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Enabled

Sets the state of RDMA on the network adapter. The acceptable values for this parameter are: $true or $false.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludeHidden

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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

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

Type:CimInstance[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InterfaceDescription

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.

Type:String[]
Aliases:ifDesc
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-Name

Specifies the name of the network adapter.

Type:String[]
Aliases:ifAlias, InterfaceAlias
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-NoRestart

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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

CimInstance[]

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

CimInstance

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.