Set-NetworkControllerNode
Sets a node in a network controller cluster.
Syntax
Set-NetworkControllerNode
-Name <String>
[-RestInterface <String>]
[-NodeCertificate <X509Certificate2>]
[-PassThru]
[-Force]
[-ComputerName <String>]
[-UseSsl]
[-Credential <PSCredential>]
[-CertificateThumbprint <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-NetworkControllerNode cmdlet changes the settings of a node in a network controller cluster. Use this cmdlet to modify the settings for the interface on which the node listens for representational state transfer (REST) requests, and to set the node certificate.
Examples
Example 1: Set the REST interface for a network controller node
PS C:\> Set-NetworkControllerNode -Name "Node1" -RestInterface "Corpnet" -PassThru
Name : Node1
Server : NCNode1.contoso.com
FaultDomain : fd:/rack1/host1
RestInterface : Corpnet
NodeCertificate :
Status : UpThis command sets the REST interface to Corpnet for the node named Node1.
Parameters
-CertificateThumbprint
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputerName
Specifies the name of the network controller node on which this cmdlet operates.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | 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 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Forces the command to run without asking for user confirmation.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of a node. This cmdlet updates the settings for the node that you specify.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NodeCertificate
Specifies the certificate to use to authenticate a computer. You should only specify this parameter if the cluster uses certificate-based authentication.
| Type: | X509Certificate2 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| 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 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RestInterface
Specifies the name of the interface on the node that receives requests from REST clients.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
This cmdlet returns an object that 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 use for REST operations on the node
- Node certificate