Export (0) Print
Expand All
Expand Minimize
0 out of 1 rated this helpful - Rate this topic

Suspend-ClusterNode

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Suspend-ClusterNode

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

Syntax

Parameter Set: InputObject
Suspend-ClusterNode [[-Name] <StringCollection> ] [[-TargetNode] <String> ] [-Cluster <String> ] [-Drain] [-ForceEvacuation] [-InputObject <PSObject> ] [-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

none

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ForceEvacuation

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


Aliases

none

Required?

false

Position?

named

Default Value

none

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

none

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

none

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

none

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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

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

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.FailoverClusters.PowerShell.ClusterNode

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".

Related topics

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.