Edit

Share via

Remove-WorkgroupClusterNode

Module:
FailoverClusters Module

Removes a node from a workgroup cluster.

Syntax

Default (Default) 

Remove-WorkgroupClusterNode
    [-Node] <String[]>
    [-Credentials] <PSCredential[]>
    [-Name] <String>
    [[-Wait] <Int32>]
    [-IgnoreStorageConnectivityLoss]
    [-CleanupDisks]
    [-Force]
    [-Confirm]
    [-WhatIf]
    [<CommonParameters>]

Description

The Remove-WorkgroupCluster function removes a node from the membership in a workgroup Cluster. The rest of the parameters will be forwarded to the Remove-ClusterNode function. Please refer to the documentation for the Remove-ClusterNode cmdlet.

Examples

EXAMPLE 1

Remove-WorkgroupClusterNode -Node "Node1", "Node2" -Credentials $cred1, $cred2 -Name $Node2

This example removes Node2 from the cluster membership.

EXAMPLE 2

Remove-WorkgroupClusterNode -Node "Node1", "Node2" -Credentials $cred1, $cred2 -Name $Node3

This example removes Node3 from the cluster membership.

Manual cleanup may be required to clear the node state by logging into Node3 and running Clear-ClusterNode.

Parameters

-CleanupDisks

Removes any residual cluster metadata from the specified disks. This metadata includes information that the cluster service uses to manage the disks. By cleaning the metadata, the disks are freed from any old cluster configurations, making them available for new clusters or other purposes. This cmdlet may prevent potential conflicts that could arise from leftover metadata when reusing disks.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Credentials

An array of credentials for the nodes.

Parameter properties

Type:

PSCredential[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IgnoreStorageConnectivityLoss

Indicates that this cmdlet doesn't check whether the cluster node contains non-shared storage, if Storage Spaces Direct is enabled. If you don't specify this parameter, the cmdlet checks whether this node has any Storage Spaces Direct storage. If this cmdlet finds Storage Spaces Direct storage, it prompts you for confirmation before it removes the node.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

The name of the node to be removed. If the name isn't included in Node parameter, the first node in the Node parameter will be used to remove the node. Additional cleanup will be required to clear the node state.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:3
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Node

An array of nodes in the workgroup cluster.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Wait

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

Parameter properties

Type:Int32
Default value:0
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:4
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet isn't run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.