Set-NetworkController

Artikel
11/16/2015

Set-NetworkController

Sets network controller application settings.

Syntax

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

Detaillierte Beschreibung

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.

Parameter

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

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-ClientAuthentication<ClientAuthentication>

Specifies the type of authentication that network controller uses to communicate with REST clients. Die zulässigen Werte für diesen Parameter sind:

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

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

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

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

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

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-ComputerName<String>

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

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	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.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-PassThru

Gibt ein Objekt an, das das Element darstellt, mit dem Sie arbeiten. Dieses Cmdlet generiert standardmäßig keine Ausgabe.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

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

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

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

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

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

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	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.

Aliase	none
Erforderlich?	false
Position?	named
Standardwert	none
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-Confirm

Fordert Sie vor der Ausführung des Cmdlet zum Bestätigen auf.

Erforderlich?	false
Position?	named
Standardwert	false
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-WhatIf

Zeit, was passieren würde, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Erforderlich?	false
Position?	named
Standardwert	false
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

<CommonParameters>

Dieses Cmdlet unterstützt die allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer und -OutVariable. Weitere Informationen finden Sie unter about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Eingaben

Der Eingabetyp ist der Typ der Objekte, die Sie per Piping an das Cmdlet übergeben können.

Ausgaben

Der Ausgabetyp ist der Typ der Objekte, die vom Cmdlet ausgegeben werden.

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

Beispiele

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

Freigeben über

Set-NetworkController