Disable-NetworkControllerNode

Disable-NetworkControllerNode

Disables a network controller node for maintenance purposes.

構文

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

詳細説明

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.

パラメーター

-CertificateThumbprint<String>

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.

Aliases

none

必須/オプション

false

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-ComputerName<String>

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

Aliases

none

必須/オプション

false

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-Credential<PSCredential>

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.

Aliases

none

必須/オプション

false

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-Name<String>

Specifies the name of the node to be disabled.

Aliases

none

必須/オプション

true

位置

named

既定値

none

パイプライン入力の受け入れ

true(ByPropertyName)

ワイルドカード文字の受け入れ

false

-PassThru

作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットから出力は生成されません。

Aliases

none

必須/オプション

false

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-UseSsl

Indicates that the remote machine 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.

Aliases

none

必須/オプション

false

位置

named

既定値

none

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-Confirm

コマンドレットを実行する前に確認メッセージを表示します。

必須/オプション

false

位置

named

既定値

false

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

-WhatIf

コマンドレットが実行された場合に何が起きるのかを示します。コマンドレットは実行されません。

必須/オプション

false

位置

named

既定値

false

パイプライン入力の受け入れ

false

ワイルドカード文字の受け入れ

false

<CommonParameters>

このコマンドレットは共通のパラメーターをサポートしています(-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable)。詳細については、TechNet の「 「about_CommonParameters」 (https://go.microsoft.com/fwlink/p/?LinkID=113216) を参照してください。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットが出力するオブジェクトの型です。

  • 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

使用例

Example 1: Disable a network controller node

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

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

関連項目

Add-NetworkControllerNode

Enable-NetworkControllerNode

Get-NetworkControllerNode

Remove-NetworkControllerNode

Set-NetworkControllerNode