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, Logical Unit Number
(LUNs), in cluster storage, turning on maintenance leaves dependent resources online.
Examples
Example 1: Turn on maintenance for a CSV
Suspend-ClusterResource -Name "Cluster Disk 2"
This example turns on maintenance for CSV named Cluster Disk 2 so that you can run a disk
maintenance tool without triggering failover.
Example 2: Turn on maintenance for multiple volumes
Get-ClusterSharedVolume -Name "Cluster Disk 5" | Suspend-ClusterResource
This example turns on maintenance for all volumes on the CSV named Cluster Disk 5.
Parameters
-Cluster
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.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Aliases:
cf
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-InputObject
Specifies the cluster resource, a disk or CSV, to suspend.
Parameter properties
Type:
PSObject
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
True
Value from pipeline by property name:
False
Value from remaining arguments:
False
-Name
Specifies the name of the cluster resource, a disk or CSV, to suspend.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
0
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
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.
Parameter properties
Type:
SwitchParameter
Default value:
None
Supports wildcards:
False
DontShow:
False
Aliases:
FileSystemRedirectedAccess
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-VolumeName
Specifies the name of the volume to suspend. This parameter is only applicable to CSVs. If this
parameter isn't specified, then the operation will be performed on all volumes on the CSV.
Parameter properties
Type:
String
Default value:
None
Supports wildcards:
False
DontShow:
False
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
Parameter properties
Type:
SwitchParameter
Default value:
False
Supports wildcards:
False
DontShow:
False
Aliases:
wi
Parameter sets
(All)
Position:
Named
Mandatory:
False
Value from pipeline:
False
Value from pipeline by property name:
False
Value from remaining arguments:
False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters.