Get-ResiliencySetting
Get-ResiliencySetting
Gets the resiliency settings (also known as storage layouts) available for creating virtual disks on the specified storage subsystem.
Syntax
Parameter Set: ByName
Get-ResiliencySetting [-AsJob] [-CimSession <CimSession[]> ] [-Name <String[]> ] [-StoragePool <CimInstance> ] [-ThrottleLimit <Int32> ] [ <CommonParameters>]
Parameter Set: ByUniqueId
Get-ResiliencySetting [-AsJob] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-UniqueId <String[]> ] [ <CommonParameters>]
Detailed Description
The Get-ResiliencySetting cmdlet gets the resiliency settings (storage layouts) available for creating virtual disks on the specified storage subsystem. The resiliency settings vary depending on the storage subsystem; the Storage Spaces subsystem supports the Simple, Mirror, and Parity resiliency settings.
Parameters
-AsJob
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 |
-Name<String[]>
Specifies the name of the resiliency setting or settings to get. The supported resiliency setting names vary by storage subsystem; the Storage Spaces subsystem supports the following values: Simple, Mirror, or Parity.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-StoragePool<CimInstance>
Specifies the storage pool object for which to get resiliency settings. Enter a StoragePool CIM object. The Storage Pool CIM object is exposed by the Get-StoragePool 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 |
-UniqueId<String[]>
Specifies the UniqueID of the resiliency setting object to get. If the UniqueID includes brackets, enclose the string in quotation marks.
Aliases |
Id |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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_StoragePool
You can pipe an MSFT_StoragePool object to the StoragePool parameter to get the resiliency setting associated with the StoragePool object.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Storage/MSFT_ResiliencySetting
The Get-ResiliencySetting cmdlet returns objects representing resiliency settings for a particular storage pool.
Notes
- The
Microsoft.Management.Infrastructure.CimInstanceobject 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.
Examples
Example 1: Get all resiliency setting objects
This example gets all resiliency setting objects for each storage pool, showing which resiliency settings are available for use when creating virtual disks. If there are multiple storage pools, the same resiliency setting might appear more than once, with each object representing the resiliency setting support for a particular storage pool.
PS C:\> Get-ResiliencySetting
Example 2: Get only Mirror, Parity, and Simple resiliency setting objects
This example displays only the resiliency settings for the types Mirror, Parity and Simple. Other defined resiliency settings are not displayed.
PS C:\> Get-ResiliencySetting -Name Mirror,Parity,Simple
Example 3: Get a resiliency setting object by UniqueID
This example displays one particular resiliency setting object by specifying its UniqueID value, enclosed in quotation marks.
PS C:\> Get-ResiliencySetting -UniqueId "{5d792e9b-ca00-11e1-9350-00155db7aa01}:1"