Set-NetworkController
Set-NetworkController
Sets network controller application settings.
Syntaxe
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>]
Description détaillée
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.
Paramètres
-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.
Alias |
none |
Requis ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-ClientAuthentication<ClientAuthentication>
Specifies the type of authentication that network controller uses to communicate with REST clients. Les valeurs acceptables pour ce paramètre sont les suivantes :
-- 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.
Alias |
none |
Requis ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
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.
Alias |
none |
Requis ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
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.
Alias |
none |
Requis ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-ComputerName<String>
Specifies the name of the network controller node on which this cmdlet operates.
Alias |
none |
Requis ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
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.
Alias |
none |
Requis ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-PassThru
Renvoie un objet qui représente l'élément sur lequel vous travaillez. Par défaut, cette applet de commande ne génère pas de sortie.
Alias |
none |
Requis ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
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.
Alias |
none |
Requis ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
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.
Alias |
none |
Requis ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
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.
Alias |
none |
Requis ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
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.
Alias |
none |
Requis ? |
false |
Position ? |
named |
Valeur par défaut |
none |
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-Confirm
Vous invite à confirmer l'exécution de l'applet de commande.
Requis ? |
false |
Position ? |
named |
Valeur par défaut |
false |
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-WhatIf
Indique ce qui se produit en cas d'exécution de l'applet de commande. L'applet de commande n'est pas exécutée.
Requis ? |
false |
Position ? |
named |
Valeur par défaut |
false |
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
<CommonParameters>
Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez . about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Entrées
Le type d'entrée correspond au type des objets que vous pouvez adresser à l'applet de commande.
Sorties
Le type de sortie correspond au type des objets que l'applet de commande émet.
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
Exemples
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
Rubriques connexes
Export-NetworkController
Import-NetworkController