Edit

Share via


Get-NetworkControllerDeploymentInfo

Queries the Network Controller for REST information.

Syntax

Default (Default)

Get-NetworkControllerDeploymentInfo
    [-NetworkController] <String>
    [[-Credential] <PSCredential>]
    [[-RestURI] <String>]
    [[-CertificateThumbprint] <String>]
    [<CommonParameters>]

Description

The Get-NetworkControllerDeploymentInfo cmdlet queries the Network Controller for Representational State Transfer (REST) information, such the REST URI and the REST Certificate.

You can run this cmdlet from a computer that has Layer-3 connectivity to the Network Controller.

Examples

Example 1: Get configuration state for all REST resources for a Network Controller

PS C:\>$Credential = Get-Credential
PS C:\> Get-NetworkControllerDeploymentInfo -NetworkController "NC-0.contoso.cloud.com" -Credential $Credential

The first command creates credentials by using the Get-Credential cmdlet, and then stores it in the $Credential variable. The command prompts you for user name and password.

The second command gets configuration state for all REST resources for a Network Controller.

Parameters

-CertificateThumbprint

Specifies certificate thumbprint to use for the Network Controller. Specify this parameter for certificate deployment.

Parameter properties

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

Parameter sets

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

-Credential

Specifies a credential to use for the Network Controller. Specify this parameter for Kerberos deployment.

Parameter properties

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

Parameter sets

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

-NetworkController

Specifies the name or IP address of a Network Controller node.

Parameter properties

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

Parameter sets

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

-RestURI

Specifies the URI to use for Network Controller REST APIs. Specify this parameter for wildcard certificate deployment.

Parameter properties

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

Parameter sets

(All)
Position:2
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

None

Outputs

Object