Edit

Share via

New-NetworkControllerNodeObject

Module:
NetworkController Module

Creates a network controller node object.

Syntax

Default (Default) 

New-NetworkControllerNodeObject
    -Name <String>
    -Server <String>
    -FaultDomain <String>
    -RestInterface <String>
    [-NodeCertificate <X509Certificate2>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The New-NetworkControllerNodeObject cmdlet creates a network controller node object. This cmdlet is used for configuring a network controller for the first time. The object created from this cmdlet is passed to the Install-NetworkControllerCluster cmdlet to create a network controller cluster.

The steps for configuring a network controller are:

  • 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 node object

PS C:\> New-NetworkControllerNodeObject -Name "Node1" -Server "NCNode1.contoso.com" -FaultDomain "fd:/rack1/host1" -RestInterface "Ethernet"

This command creates a network controller node object named Node1. The fully qualified domain name of the computer is NCNode1.contoso.com and the interface on the computer listening to REST requests is named Ethernet.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FaultDomain

Specifies the servers that are likely to experience failure at the same time due to shared physical dependencies such as power and networking sources.

Fault domains typically represent hierarchies that are related to these shared dependencies, with more servers likely to fail together from a higher point in the fault domain tree. During runtime, a network controller considers the fault domains in the cluster and attempts to spread out the network controller services so that they are in separate fault domains. This process helps ensure, in case of failure of any one fault domain, that the availability of that service and its state is not compromised.

Fault domains are specified in a hierarchical format. For example: /DC1/Rack1/Host1, where DC1 is the datacenter name, Rack1 is the rack name and Host1 is the name of the host where the node is placed.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies the name of the computer to be added to the deployment.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NodeCertificate

Specifies the certificate used for authenticating the computer. You only need to specify this parameter if the cluster is using certificate based authentication.

Parameter properties

Type:X509Certificate2
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RestInterface

Specifies the name of the interface on the node that will receive requests from the representational state transfer (REST) clients.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Server

Specifies the fully qualified domain name (FQDN), IP address, or hostname of the computer to be added to the deployment. If Kerberos authentication is being used for cluster authentication, FQDN must be provided.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

undefined

This cmdlet returns an object that contains the following fields:

  • Name of the node
  • Hostname, FQDN, or IP address of the node
  • Fault domain of the node
  • Name of interface to be used for REST operations on the node
  • Node certificate