Edit

Share via

Suspend-ClusterNode

  • Reference
Module:
FailoverClusters

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

Syntax

Suspend-ClusterNode
       [[-Name] <StringCollection>]
       [-Drain]
       [-ForceDrain]
       [-Wait]
       [[-TargetNode] <String>]
       [-InputObject <PSObject>]
       [-Cluster <String>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

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, or 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.

Examples

Example 1: Pause a node of the local cluster

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

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

Example 2: Pause a node of a cluster

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

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

Example 3: Pause a node and move its workloads

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

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

Example 4: Preview a pause operation

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

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

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

-Drain

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.

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

-ForceDrain

The -ForceDrain switch, used in conjunction with the -Drain switch, allows all the workloads to be safely moved to other nodes, while maintaining the highest levels of availability and using the best placement logic.

If some or all of the workloads can't be moved safely, any workload that failed will be stopped and moved to another node as a failed role. Thereafter, the node will be forced to pause.

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

-InputObject

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

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

-Name

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

Type:StringCollection
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TargetNode

Specifies a node to which to drain the workloads.

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

-Wait

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

Type:SwitchParameter
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.Cluster

Microsoft.FailoverClusters.PowerShell.ClusterNode

Outputs

Microsoft.FailoverClusters.PowerShell.ClusterNode