Install-NetworkController

Syntax

Install-NetworkController
       -Node <NetworkControllerNode[]>
       -ClientAuthentication <ClientAuthentication>
       [-ClientCertificateThumbprint <String[]>]
       [-ClientSecurityGroup <String>]
       -ServerCertificate <X509Certificate2>
       [-RestIPAddress <String>]
       [-RestName <String>]
       [-Force]
       [-ComputerName <String>]
       [-UseSsl]
       [-Credential <PSCredential>]
       [-CertificateThumbprint <String>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Install-NetworkController cmdlet creates a network controller application on the network controller cluster. After you run this cmdlet, the network controller is running.

The steps for configuring a network controller are as follows:

• Install the network controller role on all the computers that will be functioning as a network controller in your deployment.
• From one of those computers (or any other remote computer), run the New-NetworkControllerNodeObject cmdlet to enter the details of the node to be part of the deployment. Repeat this step for all the computers that are part of the deployment. These node objects will be passed as a parameter to the next cmdlet.
• Run the Install-NetworkControllerCluster cmdlet to create a new network controller cluster.
• Run the Install-NetworkController cmdlet to create the network controller application on top of the cluster.

Examples

Example 1: Create a network controller in a test environment

PS C:\> $NodeObject = New-NetworkControllerNodeObject -Name "Node01" -Server "NCNode11" -FaultDomain "fd:/rack1/host1" -RestInterface Ethernet
PS C:\> $Certificate = Get-Item Cert:\LocalMachine\My | Get-ChildItem | where {$_.Subject -imatch "NCEncryption" }
PS C:\> Install-NetworkControllerCluster -Node $NodeObject -ClusterAuthentication None
PS C:\> Install-NetworkController -Node $NodeObject -ClientAuthentication None -RestIpAddress "10.0.0.1/24" -ServerCertificate $Certificate
Node                            : {Node01}
ClientAuthentication            : None
ClientCertificateThumbprint     :
ClientSecurityGroup             :
ServerCertificate               : [Subject]
                                   CN=NCEncryption

                                  [Issuer]
                                    CN=Contoso

                                  [Serial Number]
                                    1C00000003786A607D6EFB733F000000000003

                                  [Not Before]
                                    2/11/2015 6:18:21 AM

                                  [Not After]
                                    2/10/2017 6:18:21 AM

                                  [Thumbprint]
                                    D4FDE4F607849083C590466334D66037C0E38001

RestIPAddress                   : 10.0.0.1/24
Version                         : 10.0.0

The first command creates a network controller node object, and then stores it in the $NodeObject variable.

The second command gets a certificate named NCEncryption, and then stores it in the $Certificate variable. The command uses standard Windows PowerShell® cmdlets. For more information, type Get-Help Get-Item, Get-Help Get-ChildItem, and Get-Help Where.

The third command creates a network controller cluster by using the Install-NetworkControllerCluster cmdlet. The cluster contains the node object stored in $NodeObject.

The final command deploys the network controller in a test environment. Since single node is used in the deployment, there is no high availability support. This network controller employs no authentication between the cluster nodes, or between the REST clients and network controller. The command specifies the $Certificate to encrypt the traffic between the REST clients and network controller.

Example 2: Create a network controller in a domain joined environment

PS C:\> $Node01 = New-NetworkControllerNodeObject -Name "Node01" -Server "NCNode01.Contoso.com" -FaultDomain "fd:/rack1/host1" -RestInterface Ethernet
PS C:\> $Node02 = New-NetworkControllerNodeObject -Name "Node02" -Server "NCNode02.Contoso.com" -FaultDomain "fd:/rack1/host2" -RestInterface Ethernet
PS C:\> $Node03 = New-NetworkControllerNodeObject -Name "Node03" -Server "NCNode03.Contoso.com" -FaultDomain "fd:/rack2/host3" -RestInterface Ethernet
PS C:\> $Certificate = Get-Item Cert:\LocalMachine\My | Get-ChildItem | where {$_.Subject -imatch "NCEncryption" }
PS C:\> Install-NetworkControllerCluster -Node @($Node01,$Node02,$Node03) -ClusterAuthentication Kerberos -ManagementSecurityGroup "Contoso\NCManagementAdmins" -LogLocation "\\share\diagnostics" -CredentialEncryptionCertificate $Certificate
PS C:\> Install-NetworkController -Node @($Node01,$Node02,$Node03) -ClientAuthentication Kerberos -ClientSecurityGroup "Contoso\RestClients" -RestIpAddress "10.0.0.1/24" -StoreCertificate $Certificate -EnableAllLogs
Node                            : {Node01, Node02, Node03}
ClientAuthentication            : Kerberos
ClientCertificateThumbprint     :
ClientSecurityGroup             : Contoso\RestClients
ServerCertificate                  : [Subject]
                                   CN=NCEncryption

                                  [Issuer]
                                    CN=Contoso

                                  [Serial Number]
                                    1C00000003786A607D6EFB733F000000000003

                                  [Not Before]
                                    2/11/2015 6:18:21 AM

                                  [Not After]
                                    2/10/2017 6:18:21 AM

                                  [Thumbprint]
                                    D4FDE4F607849083C590466334D66037C0E38001

RestIPAddress                   : 10.0.0.1/24
Version                         : 10.0.0

The first three commands create network controller node objects, and then stores them in the $Node01, $Node02, and $Node03 variables.

The fourth command gets a certificate named NCEncryption, and then stores it in the $Certificate variable. The command uses standard cmdlets.

The fifth command creates a network controller cluster by using the Install-NetworkControllerCluster cmdlet. The cluster contains the node objects stored in the variables.

The final command deploys the network controller in a domain joined environment. Network controller uses Kerberos authentication between the cluster nodes, and between the REST clients and network controller. Only clients that are part of the RestClients security group can communicate with the network controller. The certificate in $Certificate is used to encrypt traffic between the REST clients and network controller.

Parameters

-CertificateThumbprint

-ClientAuthentication

-ClientCertificateThumbprint

-ClientSecurityGroup

-ComputerName

-Confirm

-Credential

-Force

-Node

-RestIPAddress

-RestName

-ServerCertificate

-UseSsl

-WhatIf

Inputs

None

Outputs

Object

This cmdlet returns an object that contains the following fields:

• Names of the network controller nodes
• Authentication mode used between cluster nodes
• Client security group
• Client certificate thumbprints
• Server certificate that is used for encryption of data between the network controller and REST and southbound clients.
• REST IP address
• Application version

Related Links

• Get-NetworkController
• Set-NetworkController
• Uninstall-NetworkController
• New-NetworkControllerNodeObject
• Install-NetworkControllerCluster