Set-NetworkController

Set-NetworkController

Sets network controller application settings.

構文

Parameter Set: Default
Set-NetworkController [-CertificateThumbprint <String> ] [-ClientAuthentication <ClientAuthentication> {None | Kerberos | X509} ] [-ClientCertificateThumbprint <String[]> ] [-ClientSecurityGroup <String> ] [-ComputerName <String> ] [-Credential <PSCredential> ] [-PassThru] [-RestIPAddress <String> ] [-RestName <System.String> ] [-ServerCertificate <System.Security.Cryptography.X509Certificates.X509Certificate2> ] [-UseSsl] [-Confirm] [-WhatIf] [ <CommonParameters>]

詳細説明

The Set-NetworkController cmdlet sets network controller application settings. You can modify the following settings:

-- Client authentication mode.
-- Client security group. If the client authentication mode is Kerberos, you must specify a client security group.
-- Client certificate thumbprints. If the client authentication mode is x509, you must specify certificate thumbprints.
-- The IP address that network controller uses for representational state transfer (REST) communication.
-- Secure Sockets Layer (SSL) certificate that network controller uses for encrypting the communication between the REST clients and the network controller, as well as to secure communication with southbound clients.

パラメーター

-CertificateThumbprint<String>

Specifies the digital public key X.509 certificate of a user account that has permission to perform this action. Specify 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.

-ClientAuthentication<ClientAuthentication>

Specifies the type of authentication that network controller uses to communicate with REST clients. このパラメーターに指定できる値は、次のとおりです。

-- Kerberos
-- X509
-- None

If the clients and network controller computers are domain joined, you should specify Kerberos authentication. Otherwise, specify X509 authentication. We do not recommend a value of None for production environments.

-ClientCertificateThumbprint<String[]>

Specifies an array of thumbprints of the certificates of REST clients that can communicate with the network controller. Specify this parameter only if the value of the ClientAuthentication parameter is X509.

-ClientSecurityGroup<String>

Specifies the security group that contains the name of the REST clients that can communicate with the network controller. Specify this parameter only if the value of the ClientAuthentication parameter is Kerberos.

-ComputerName<String>

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

-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.

-PassThru

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

-RestIPAddress<String>

Specifies the IP address on which network controller nodes communicate with the REST clients. This IP address must not be an existing IP address on any of the network controller nodes.

-RestName<System.String>

Specifies the DNS name of the Network Controller cluster. This must be specified if the Network Controller nodes are in different subnets. In this case, you must also enable dynamic registration of the RestName on the DNS servers.

-ServerCertificate<System.Security.Cryptography.X509Certificates.X509Certificate2>

Specifies the certificate to use to encrypt communication between network controller and REST clients, and also to secure communication between Network Controller and the southbound clients. This certificate must have Server Authentication EKU and should be trusted by the REST clients. Also, the certificate subject name or subject alternative name (SAN) must resolve to the REST IP address in DNS.

-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.

-Confirm

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

-WhatIf

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

<CommonParameters>

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

入力

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

出力

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

• This cmdlet returns an object that contains the following fields:

  -- Names of the network controller nodes
  -- Authentication mode used between Network Controller and the REST clients
  -- Client security group
  -- Client certificate thumbprints
  -- SSL certificate that is used for encryption of data between REST clients and network controller
  -- REST IP address
  -- Application version

使用例

Example 1: Change the authentication mode for clients

This command changes the authentication mechanism between REST clients and network controller to Kerberos. In order to change the authentication mode to Kerberos, you must also specify the ClientSecurityGroup parameter.

PS C:\> Set-NetworkController -ClientAuthentication Kerberos -ClientSecurityGroup "Contoso\RestClients" -PassThru

Example 2: Change the REST IP address

This command changes the REST IP address to 10.0.0.1. This command requires that the subnet mask be specified in the IP address.

PS C:\> Set-NetworkController -RestIPAddress 10.0.0.1/24

関連項目

Export-NetworkController

Get-NetworkController

Import-NetworkController

Install-NetworkController

Uninstall-NetworkController