Remove-Network Controller Node

Module:
networkcontroller
Removes a node from the network controller deployment.

Syntax 

Remove-NetworkControllerNode
      [-Name <String>]
      [-Force]
      [-PassThru]
      [-ComputerName <String>]
      [-UseSsl]
      [-Credential <PSCredential>]
      [-CertificateThumbprint <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-NetworkControllerNode cmdlet removes a node from the existing set of nodes in a network controller deployment. You can use this cmdlet to scale down a cluster in the case that it has more capacity than is needed for operations. You cannot scale down from a three node deployment. If you want to move to a single node deployment from a three node deployment, you must unconfigure the cluster and configure it again with a single node.

Examples

Example 1: Remove a node from an existing network controller deployment by node name 

PS C:\> Remove-NetworkControllerNode -Name "Node1"

This command removes the node named Node1 from the existing network controller deployment.

Optional Parameters

-CertificateThumbprint

Specifies the digital public key X.509 certificate of a user account that has permission to perform this action. This is the certificate thumbprint of the certificate. Specify this parameter only if you run this cmdlet on a computer that is not part of the network controller cluster.

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ComputerName

Specifies the name of the network controller node on which this cmdlet operates.

Type: String
Position: Named
Default value: None
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
Accept pipeline input: False
Accept wildcard characters: False
-Credential

Specifies a user credential that has permission to perform this action. The default is the current user. Specify this parameter only if you run this cmdlet on a computer that is not part of the network controller cluster.

Type: PSCredential
Position: Named
Default value: None
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: None
Accept pipeline input: False
Accept wildcard characters: False
-Name

Specifies the name of the node to be removed from the deployment.

Type: String
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

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

Indicates that the remote computer uses Secure Socket Layer (SSL) protocol to establish a connection to the Network Controller node. The default value of this parameter is false. Specify this parameter only if you run this cmdlet on a computer that is not part of the network controller cluster.

Type: SwitchParameter
Position: Named
Default value: None
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
Accept pipeline input: False
Accept wildcard characters: False

Outputs

This cmdlet returns an object that contains the following fields:

  • Name of the node
  • Hostname, fully qualified domain name (FQDN), or IP address of the node
  • Fault domain of the node
  • Name of interface to be used for representational state transfer (REST) operations on the node
  • Node certificate