Suspend-ClusterResource

Suspend-ClusterResource

Turn on maintenance for a disk resource or Cluster Shared Volume so that you can run a disk maintenance tool without triggering failover.

Syntax

Suspend-ClusterResource [-InputObject <psobject>] [[-Name] <string>] [-Cluster <string>] [-Force] [-RedirectedAccess] [-VolumeName <string>] [<CommonParameters>]
  • InputObject

  • Name

  • Cluster

  • Force

  • RedirectedAccess

  • VolumeName

Detailed Description

This cmdlet applies to disks and Cluster Shared Volumes only. 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

Specifies the name of the cluster to run this cmdlet on. If you type "-Cluster ." or omit the parameter, the cmdlet runs on the local cluster.

Default Value: **

Data Type: string

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Force

Performs the operation without prompting for confirmation. By default this operation will ask for confirmation from the user before proceeding.

Default Value: **

Data Type: SwitchParameter

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

InputObject

Specifies the cluster resource to suspend.

Default Value: **

Data Type: psobject

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

true (ByValue)

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Name

Specifies the name of the cluster resource to suspend.

Default Value: **

Data Type: string

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

1

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

RedirectedAccess

Causes the cluster shared volume(s) access to the storage device to be redirected over the network through another cluster node. This parameter is only applicable to cluster shared volumes.

Default Value: **

Data Type: SwitchParameter

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

VolumeName

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

Default Value: **

Data Type: string

Attributes

Name Value PSMAML Attribute

Required?

false

required

Variable Length?

false

variableLength

Accept wildcard characters?

false

globbing

Accept Pipeline Input?

false

pipelineInput

Position?

named

position

Value Attributes

Name Value PSMAML Attribute

Required?

true

required

Variable Length?

false

variableLength

Input Type

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

Return Type

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

Examples

-------------------------- EXAMPLE 1 --------------------------

Command Prompt: C:\PS>

 
Suspend-ClusterResource "Cluster Disk 2" 
 
Name                State               Group               ResourceType 
----                -----               -----               ------------ 
Cluster Disk 2      Online(Maintenance) Available Storage   Physical Disk

Description

-----------

This command turns on maintenance for Cluster Disk 2 so that you can run a disk maintenance tool without triggering failover.

 

-------------------------- EXAMPLE 2 --------------------------

Command Prompt: C:\PS>

 
Get-ClusterSharedVolume "Cluster Disk 5" | Suspend-ClusterResource 
 
Name                       State                      Node 
----                       -----                      ---- 
Cluster Disk 5             Online                     node2

Description

-----------

This command turns on maintenance for all volumes on the Cluster Shared Volume "Cluster Disk 5."

See Also

Reference

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

Other Resources

Online version: