Get-NetworkControllerNode
Gets the network controller node settings.
Syntax
Default (Default)
Get-NetworkControllerNode
[-Name <String>]
[-ComputerName <String>]
[-UseSsl]
[-Credential <PSCredential>]
[-CertificateThumbprint <String>]
[<CommonParameters>]
Description
The Get-NetworkControllerNode cmdlet gets the network controller node settings such as the node name, fully qualified ___domain name (FQDN), IP address, fault ___domain, representational state transfer (REST) interface of the node, and the node certificate, if applicable.
Examples
Example 1: Get all network controller nodes in a deployment
PS C:\> Get-NetworkControllerNode
Name : Node1
Server : NCNode1.contoso.com
FaultDomain : fd:/host1/node1
RestInterface : Ethernet
NodeCertificate :
Status : Up
Name : Node2
Server : NCNode2.contoso.com
FaultDomain : fd:/host2/node2
RestInterface : Ethernet
NodeCertificate :
Status : Up
Name : Node3
Server : NCNode3.contoso.com
FaultDomain : fd:/host3/node3
RestInterface : Ethernet
NodeCertificate :
Status : Up
This command gets the network controller node settings for all nodes in the deployment.
Example 2: Get network controller node settings for a specified node by name
PS C:\> Get-NetworkControllerNode -Name "Node1"
Node1Name : Node1
Server : NCNode1.contoso.com
FaultDomain : fd:/host1/node1
RestInterface : Ethernet
NodeCertificate :
Status : Up
This command gets the network controller node settings for a specific node named Node1.
Parameters
-CertificateThumbprint
Specifies the digital public key X.509 certificate of a user account that has permission to perform this action. This is 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.
Parameter properties
Type: | String |
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 |
-ComputerName
Specifies the name of the network controller node on which this cmdlet operates.
Parameter properties
Type: | String |
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 |
-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.
Parameter properties
Type: | PSCredential |
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 |
-Name
Specifies the friendly name of the node for the network controller. If not provided, settings are retrieved for all nodes in the deployment.
Parameter properties
Type: | String |
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: | True |
Value from remaining arguments: | 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.
Parameter properties
Type: | SwitchParameter |
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 |
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.
Inputs
String
Outputs
Object
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