Disable-StorageHighAvailability

  • Reference
Module:
Storage

Disables a Storage resource.

Syntax

Disable-StorageHighAvailability
       [-DiskNumber] <UInt32[]>
       [-CimSession <CimSession[]>]
       [-ThrottleLimit <Int32>]
       [-AsJob]
       [-PassThru]
       [<CommonParameters>]
Disable-StorageHighAvailability
       -DiskUniqueId <String[]>
       [-CimSession <CimSession[]>]
       [-ThrottleLimit <Int32>]
       [-AsJob]
       [-PassThru]
       [<CommonParameters>]
Disable-StorageHighAvailability
       -DiskFriendlyName <String[]>
       [-CimSession <CimSession[]>]
       [-ThrottleLimit <Int32>]
       [-AsJob]
       [-PassThru]
       [<CommonParameters>]
Disable-StorageHighAvailability
       -DiskPath <String[]>
       [-CimSession <CimSession[]>]
       [-ThrottleLimit <Int32>]
       [-AsJob]
       [-PassThru]
       [<CommonParameters>]
Disable-StorageHighAvailability
       -InputObject <CimInstance[]>
       [-CimSession <CimSession[]>]
       [-ThrottleLimit <Int32>]
       [-AsJob]
       [-PassThru]
       [<CommonParameters>]

Description

The Disable-StorageHighAvailability cmdlet configures a Storage resource to be in an unavailable or inactive state.

Examples

Example 1: Disable a disk that is a resource in a failover cluster

This command uses the Get-Disk cmdlet to display the properties of disk number 9. The disk number is specific to the cluster node that owns the cluster disk resource.
PS C:\>Get-Disk -Number 9 | Format-Table -Property Number,IsHighlyAvailable,IsClustered,IsScaleOut

Number IsHighlyAvailable IsClustered IsScaleOut
------ ----------------- ----------- ----------
     9              True        True       True


The next command removes disk number 9 its failover cluster. The final command repeats the first command to display the new status of the disk.
PS C:\> Disable-StorageHighAvailability -DiskNumber 9
PS C:\> Get-Disk -Number 9 | Format-Table Number,IsHighlyAvailable,IsClustered,IsScaleOut

Number IsHighlyAvailable IsClustered IsScaleOut
------ ----------------- ----------- ----------
     9             False       False      False

This example removes a disk from a failover cluster by using its disk number.

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

-DiskFriendlyName

Specifies an array of friendly names of disks.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DiskNumber

Specifies an array of disk numbers.

Type:UInt32[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DiskPath

Specifies an array of disk paths.

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-DiskUniqueId

Specifies an array of unique IDs, as strings, of disks.

Type:String[]
Aliases:DiskId
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

Specifies the input object that is used in a pipeline command.

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
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 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

Notes

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