Suspend-ClusterResource

  • Reference
Module:
FailoverClusters

Turns on maintenance for a disk resource or CSV so that you can run a disk maintenance tool without triggering failover.

Syntax

Suspend-ClusterResource
       [[-Name] <String>]
       [-VolumeName <String>]
       [-RedirectedAccess]
       [-Force]
       [-InputObject <PSObject>]
       [-Cluster <String>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

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, Logical Unit Number (LUNs), in cluster storage, turning on maintenance leaves dependent resources online.

Examples

Example 1: Turn on maintenance for a CSV

PS C:\> Suspend-ClusterResource -Name "Cluster Disk 2"
Name                State               Group               ResourceType 
----                -----               -----               ------------ 
Cluster Disk 2      Online(Maintenance) Available Storage   Physical Disk

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

PS C:\> Get-ClusterSharedVolume -Name "Cluster Disk 5" | Suspend-ClusterResource
Name                       State                      Node 
----                       -----                      ---- 
Cluster Disk 5             Online                     node2

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.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the cluster resource, a disk or CSV, to suspend.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name of the cluster resource, a disk or CSV, to suspend.

Type:String
Position:0
Default value:None
Required:False
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.

Type:SwitchParameter
Aliases:FileSystemRedirectedAccess
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VolumeName

Specifies the name of the volume to suspend. This parameter is only applicable to CSVs. If this parameter is not specified, then the operation will be performed on all volumes on the CSV.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.FailoverClusters.PowerShell.ClusterResource

Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume

Outputs

Microsoft.FailoverClusters.PowerShell.ClusterResource

Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume