Windows PowerShell command on Get-command Set-NetAdapterRdma

NAME

Set-NetAdapterRdma

SYNOPSIS

Sets the RDMA properties on the network adapter.

SYNTAX

Set-NetAdapterRdma [[-Name] ] [-AsJob] [-CimSession ] [-Enabled ]

[-IncludeHidden] [-NoRestart] [-PassThru] [-ThrottleLimit ] [-Confirm] [-WhatIf] []

Set-NetAdapterRdma [-AsJob] [-CimSession ] [-Enabled ] [-NoRestart] [-PassThru]

[-ThrottleLimit ] -InputObject [-Confirm] [-WhatIf] []

Set-NetAdapterRdma [-AsJob] [-CimSession ] [-Enabled ] [-IncludeHidden] [-NoRestart]

[-PassThru] [-ThrottleLimit ] -InterfaceDescription [-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.

PARAMETERS

-AsJob []

ps_cimcommon_asjob Required? false Position? named Default value 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-CimSession or Get-CimSession cmdlet. The default is the current session on the local

computer. Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false

-Enabled

Indicates whether RDMA is enabled on the network adapter. The acceptable values for this parameter are: True or False. Required? false Position? named Default value 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. Required? false Position? named Default value 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. Required? true Position? named Default value Accept pipeline input? true (ByValue) Accept wildcard characters? false

-InterfaceDescription

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. Required? true Position? named Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? true

-Name

Specifies an array of network adapter names. Required? false Position? 1 Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? true

-NoRestart []

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. Required? false Position? named Default value 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. Required? false Position? named Default value 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 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. Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false

-Confirm []

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet. Required? false Position? named Default value false Accept pipeline input? false Accept wildcard characters? false

-WhatIf []

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. Required? false Position? named Default value false Accept pipeline input? false Accept wildcard characters? false This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

Microsoft.Management.Infrastructure.CimInstance#ROOT/StandardCimv2/MSFT_NetAdapterRdmaSettingData[] 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_NetAdapterRdmaSettingData 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.

Example 1: Enable RDMA on the specified network adapter

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

This command enables RDMA on the network adapter named MyAdapter. The Enable-NetAdapterRdma cmdlet is the

preferred cmdlet to perform this operation.

Example 2: Disable RDMA on the specified network adapter

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

This command disables RDMA on the network adapter named MyAdapter. The Disable-NetAdapterRdma cmdlet is the

preferred cmdlet to perform this operation.