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-ClusterNode

Suspend-ClusterNode

microsoft.failoverclusters.powershell.dll

Synopsis

Suspends activity on a failover cluster node, that is, pauses the node.

Syntax

Suspend-ClusterNode [-Name] [-TargetNode] [-Cluster] [-Drain] [-ForceEvacuation] [-InputObject] [-Wait] [<CommonParameters>]

Detailed Description

The Suspend-ClusterNode cmdlet suspends activity on a failover cluster node, that is, pauses the node. If you use the Drain parameter, clustered roles currently running on the node will be drained before the node is paused.

Pausing (suspending) a node is usually done when applying 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 <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

-Drain <SwitchParameter>

Specifies that all of the workloads are gracefully moved to other nodes while maintaining the highest levels of availability and using the best placement logic.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-ForceEvacuation <SwitchParameter>

Specifies that workloads are moved from a node even in the case of an error.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <PSObject>

Specifies the cluster node to suspend (with or without draining), or the cluster on which to run the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-Name <StringCollection>

Specifies the name of the cluster node to suspend (with or without draining).

Aliases

None

Required?

false

Position

1

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-TargetNode <String>

Specifies a node to which to drain the workloads.

Aliases

None

Required?

false

Position

2

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Wait <SwitchParameter>

Specifies the time in seconds to wait for the cmdlet. If the Wait parameter is not specified, then the cmdlet waits for completion. If -Wait 0 is specified, then the call is initiated and the cmdlet returns without waiting.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.FailoverClusters.PowerShell.Cluster
Microsoft.FailoverClusters.PowerShell.ClusterNode

Return Type

Microsoft.FailoverClusters.PowerShell.ClusterNode

Notes

None

Examples

EXAMPLE 1

This example pauses the node named node1 on the local cluster.

PS C:\>Suspend-ClusterNode node1
Name                                                                      State 
----                                                                      ----- 
node1                                                                    Paused 

EXAMPLE 2

This example pauses the node named node2 on the cluster named cluster2.

PS C:\>Suspend-ClusterNode node2 -Cluster cluster2
Name                                                                      State 
----                                                                      ----- 
node2                                                                    Paused 

EXAMPLE 3

This example pauses the node named node1 and moves the workloads from it to the node named node2.

PS C:\>Suspend-ClusterNode -Name node1 -Target node2 -Drain
Name                                                                      State 
----                                                                      ----- 
node1                                                                    Paused 

EXAMPLE 4

This example provides a preview of the operation that will be performed on the node named node1.

PS C:\>Suspend-ClusterNode node1 -Drain -Whatif
What if: Performing operation "Suspend-ClusterNode" on Target "node1".

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