Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Suspend-ClusterResource

Suspend-ClusterResource

microsoft.failoverclusters.powershell.dll

Synopsis

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

Suspend-ClusterResource [-Name] [-Cluster] [-Force] [-InputObject] [-RedirectedAccess] [-VolumeName] [-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

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

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

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

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

Accept pipeline input?

false

Accept wildcard characters?

false

-RedirectedAccess <SwitchParameter>

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

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

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.FailoverClusters.PowerShell.ClusterResource
Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume

Return Type

Microsoft.FailoverClusters.PowerShell.ClusterResource
Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume

Notes

None

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"
Name                State               Group               ResourceType 
----                -----               -----               ------------ 
Cluster Disk 2      Online(Maintenance) Available Storage   Physical Disk 

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
Name                       State                      Node 
----                       -----                      ---- 
Cluster Disk 5             Online                     node2 

Online Version
Add-ClusterResource
Get-ClusterResource
Move-ClusterResource
Remove-ClusterResource
Resume-ClusterResource
Start-ClusterResource
Stop-ClusterResource