Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Disable-NetworkControllerNode

Last Updated: 4/18/2017

SYNOPSIS

Disables a network controller node for maintenance purposes.

SYNTAX

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

DESCRIPTION

The Disable-NetworkControllerNode cmdlet temporarily disables a network controller node for maintenance purposes. Once you disable a node, it will not be in functional state until you enable again by calling Enable-NetworkControllerNode.

EXAMPLES

Example 1: Disable a network controller node

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

This command disables the node named Node1 in the network controller deployment.

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. This parameter is used only if you run this cmdlet on a computer that is not part of the network controller cluster.

Type: String
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the name of the node to be disabled.

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UseSsl

Indicates that the remote computer uses the Secure Sockets 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
Parameter Sets: (All)
Aliases: 

Required: False
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
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

OUTPUTS

The output for this cmdlet 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
  • Status of the node

NOTES

Add-NetworkControllerNode

Enable-NetworkControllerNode

Get-NetworkControllerNode

Remove-NetworkControllerNode

Set-NetworkControllerNode

© 2017 Microsoft