Get-NetAdapterRdma

Gets the RDMA properties for a network adapter.

Syntax

Get-NetAdapterRdma
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-IncludeHidden]
   -InterfaceDescription <String[]>
   [-ThrottleLimit <Int32>]
   [<CommonParameters>]
Get-NetAdapterRdma
   [[-Name] <String[]>]
   [-AsJob]
   [-CimSession <CimSession[]>]
   [-IncludeHidden]
   [-ThrottleLimit <Int32>]
   [<CommonParameters>]

Description

The Get-NetAdapterRdma cmdlet gets the remote direct memory access (RDMA) properties of an RDMA-capable network adapter. RDMA is a feature that enables network adapters to transfer data directly between each other without requiring the main processor of the system to be part of that transfer. This results in lower latency and lower processor utilization.

Examples

Example 1: Get RDMA properties from the specified network adapter

PS C:\> Get-NetAdapterRdma -Name "MyAdapter"

This command gets the RDMA properties from the network adapter named MyAdapter.

Example 2: Get all RDMA properties from the specified network adapter

PS C:\> Get-NetAdapterRdma -Name "MyAdapter" | Format-List -Property "*"

This command displays all the RDMA properties from the adapter named MyAdapter.

Example 3: Get all RDMA capable network adapters that have RDMA enabled

PS C:\> Get-NetAdapterRdma -Name "*" | Where-Object -FilterScript { $_.Enabled }

This command gets all RDMA capable network adapters with RDMA enabled.

Required Parameters

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

Type:String[]
Aliases:ifDesc, InstanceID
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-AsJob

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
Position:Named
Default value:None
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.

Type:CimSession[]
Aliases:Session
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
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies an array network adapter names.

Type:String[]
Aliases:ifAlias, InterfaceAlias
Position:0
Default value:None
Accept pipeline input:True (ByPropertyName)
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
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

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.