Suspend-ClusterNode

Suspend-ClusterNode

Suspend activity on a failover cluster node, that is, pause the node.

Syntax

Suspend-ClusterNode [-InputObject <psobject>] [[-Name] <StringCollection>] [-Cluster <string>] [<CommonParameters>]
  • InputObject

  • Name

  • Cluster

Detailed Description

Pausing (suspending) a node is usually done when applying software updates to the node, where the recommended sequence is to move all services and applications off of the node, pause the node, then apply software updates to the node. If you need to perform extensive diagnosis or maintenance on a cluster node, it might be more workable to stop (not pause) the Cluster service on that node.

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

InputObject

Specifies the cluster node 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 node to suspend.

Default Value: **

Data Type: StringCollection

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

Input Type

Microsoft.FailoverClusters.PowerShell.ClusterNode

Return Type

Microsoft.FailoverClusters.PowerShell.ClusterNode

Examples

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

Command Prompt: C:\PS>

 
Suspend-ClusterNode node1 
 
Name                                                  State 
----                                                  ----- 
node1                                                Paused

Description

-----------

This command pauses node1 on the local cluster.

 

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

Command Prompt: C:\PS>

 
Suspend-ClusterNode node2 -Cluster cluster2 
 
Name                                                  State 
----                                                  ----- 
node2                                                Paused

Description

-----------

This command pauses node2 on cluster2.

See Also

Reference

Add-ClusterNode
Get-ClusterNode
Remove-ClusterNode
Resume-ClusterNode
Start-ClusterNode
Stop-ClusterNode

Other Resources

Online version: