Edit

Share via

Get-OffloadDataTransferSetting

  • Reference
Module:
Storage

Returns offloaded data transfer (ODX) settings for the specified subsystem.

Syntax

Get-OffloadDataTransferSetting
   [-StorageSubSystem <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-OffloadDataTransferSetting cmdlet returns offloaded data transfer (ODX) settings for the specified storage subsystem.

Note: This cmdlet does not return settings for storage arrays that use the Storage Management Initiative Specification (SMI-S) protocol.

Examples

Example 1: Get all ODX settings

PS C:\>Get-OffloadDataTransferSetting

This example gets all ODX settings for connected storage arrays, not including storage arrays that support ODX using the SMI-S protocol.

Example 2: Get storage subsystems that have SMPs that support ODX

PS C:\>Get-OffloadDataTransferSetting | Get-StorageSubSystem

This example displays all storage subsystems on storage management providers that support ODX, not including storage arrays that support ODX using the SMI-S protocol.

Example 3: Get the ODX settings for a particular storage subsystem

PS C:\>$stsubsys = Get-StorageSubsystem -FriendlyName "Big Array"



PS C:\>Get-OffloadDataTransferSetting -StorageSubsystem $stsubsys

This example returns the offload data transfer settings for the StorageSubsystem objects returned by Get-StorageSubSystem cmdlet.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

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-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

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

-StorageSubSystem

Specifies the storage subsystem for which you want to get ODX settings. Enter a StorageSubsystem CIM object, which is exposed by the Get-StorageSubSystem cmdlet.

Type:CimInstance
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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

Inputs

CimInstance

You can pipe a StorageSubsystem object to the StorageSubsystem parameter.

Outputs

CimInstance

This cmdlet outputs one or more objects that represents the ODX settings for one or more storage subsystems.

Notes

  • When used in Failover Cluster, cmdlets from the Storage module operate on cluster level (all servers in the cluster).