Suspend-ClusterResource
Suspend-ClusterResource
Turns on maintenance for a disk resource or Cluster Shared Volume (CSV) so that you can run a disk maintenance tool without triggering failover.
Syntax
Parameter Set: InputObject
Suspend-ClusterResource [[-Name] <String> ] [-Cluster <String> ] [-Force] [-InputObject <PSObject> ] [-RedirectedAccess] [-VolumeName <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Suspend-ClusterResource cmdlet turns on maintenance for a disk resource or Cluster Shared Volume (CSV) so that a disk maintenance tool can be run without triggering failover.
This cmdlet only applies to disks and CSVs. For Cluster Shared Volumes, turning on maintenance takes dependent resources offline, which interrupts client access. For other disks (LUNs) in cluster storage, turning on maintenance leaves dependent resources online.
Parameters
-Cluster<String>
Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is . or it is omitted, then the cmdlet runs on the local cluster.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Force
Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObject<PSObject>
Specifies the cluster resource, a disk or CSV, to suspend.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the cluster resource, a disk or CSV, to suspend.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RedirectedAccess
Causes CSV access to the storage device to be redirected over the network through another cluster node. This parameter is only applicable to CSVs.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VolumeName<String>
Specifies the name of the volume to suspend. This parameter is only applicable to Cluster Shared Volumes (CSVs). If this parameter is not specified, then the operation will be performed on all volumes on the CSV.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
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 (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.FailoverClusters.PowerShell.ClusterResource
- Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.FailoverClusters.PowerShell.ClusterResource
- Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume
Examples
EXAMPLE 1
This example turns on maintenance for CSV named Cluster Disk 2 so that you can run a disk maintenance tool without triggering failover.
PS C:\> Suspend-ClusterResource –Name "Cluster Disk 2"
EXAMPLE 2
This example turns on maintenance for all volumes on the CSV named Cluster Disk 5.
PS C:\> Get-ClusterSharedVolume –Name "Cluster Disk 5" | Suspend-ClusterResource