Remove-WorkgroupClusterNode
Removes a node from a workgroup cluster.
Syntax
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 $Node2This example removes Node2 from the cluster membership.
EXAMPLE 2
Remove-WorkgroupClusterNode -Node "Node1", "Node2" -Credentials $cred1, $cred2 -Name $Node3This 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credentials
An array of credentials for the nodes.
| Type: | PSCredential[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Forces the command to run without asking for user confirmation.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | 3 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Node
An array of nodes in the workgroup cluster.
| Type: | String[] |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | Int32 |
| Position: | 4 |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |