Export (0) Print
Expand All
Expand Minimize

Get-OffloadDataTransferSetting

Updated: July 17, 2013

Applies To: Windows Server 2012

Get-OffloadDataTransferSetting

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

Syntax

Parameter Set: ByStorageSubSystem
Get-OffloadDataTransferSetting [-AsJob] [-CimSession <CimSession[]> ] [-StorageSubSystem <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]




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

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-StorageSubSystem<CimInstance>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-ThrottleLimit<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_StorageSubsystem

    You can pipe a StorageSubsystem object to the StorageSubsystem parameter.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_OffloadDataTransferSetting

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


Examples

Example 1: Get all ODX settings

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


PS C:\> Get-OffloadDataTransferSetting

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

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.


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

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

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


 

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

 

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

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft