Suspend-NlbCluster

Suspend-NlbCluster

Suspends all nodes of a Network Load Balancing (NLB) cluster.

Syntax

Parameter Set: NonPipeline
Suspend-NlbCluster [[-HostName] <String> ] [[-InterfaceName] <String> ] [ <CommonParameters>]

Parameter Set: Pipeline
Suspend-NlbCluster -InputObject <Cluster> [ <CommonParameters>]

Detailed Description

The Suspend-NlbCluster cmdlet suspends all nodes of a Network Load Balancing (NLB) cluster. A cluster may need to be suspended to override any remote control cmdlets, or non-Windows PowerShell® operations, that are issued and for maintenance work.

Parameters

-HostName<String>

Specifies the name of the cluster host against which this cmdlet is run. If this parameter is omitted or a value of . is entered, then the local cluster is assumed.

Aliases

hn

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InputObject<Cluster>

Specifies the cluster to suspend.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-InterfaceName<String>

Specifies the interface to which NLB is bound. This is the interface of the cluster against which this cmdlet is run.

Aliases

none

Required?

false

Position?

2

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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

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

  • Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

Outputs

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

  • Microsoft.NetworkLoadBalancingClusters.PowerShell.Cluster

Examples

EXAMPLE 1

This example suspends all cluster nodes on the local cluster.

PS C:\> Suspend-NlbCluster

Get-NlbCluster

New-NlbCluster

Remove-NlbCluster

Resume-NlbCluster

Set-NlbCluster

Start-NlbCluster

Stop-NlbCluster

Suspend-NlbClusterNode