Get-NetworkControllerDesiredStateTopology

Get-NetworkControllerDesiredStateTopology

Gets the desired state topology information from the network controller.

Syntax

Parameter Set: Default
Get-NetworkControllerDesiredStateTopology [-CertificateThumbprint <String> ] [-ConnectionUri <String> ] [-Credential <PSCredential> ] [ <CommonParameters>]

Detailed Description

The Get-NetworkControllerDesiredStateTopology cmdlet gets the desired state topology information from the network controller.

You provide the desired state topology to the Network Controller. It represents the expected topology of the network.

A desired state topology consists of topology nodes, termination points on topology nodes, and links between termination points. A topology node is a device on the network, such as a network switch, a router, or a server. A termination point is an interface on a topology node, such as a server physical interface or a switch port. Each link joins two termination points. Links between termination points depict the topology of the network.

Parameters

-CertificateThumbprint<String>

Specifies the certificate thumbprint of a digital public key X.509 certificate of a user account that has permission to perform this action. In order for Network Controller to authorize the account, specify this thumbprint by using the ClientCertificateThumbprint parameter of the Install-NetworkController or Set-NetworkController cmdlet.

-ConnectionUri<String>

Specifies the Uniform Resource Identifier (URI) of the network controller that all Representational State Transfer (REST) clients use to connect to that controller.

-Credential<PSCredential>

Specifies a user credential that has permission to perform this action. The default value is the current user.

This user must be a member of in the security group specified by the ClientSecurityGroup parameter of the Install-NetworkController cmdlet.

<CommonParameters>

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

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Display topology properties

The first command gets the desired state topology for the network controller identified by the URI, and then stores it in the $Topology variable.

The second command displays the Properties property of $Topology.

PS C:\> $Topology = Get-NetworkControllerDesiredStateTopology -ConnectionUri "https://restserver"
PS C:\> $Topology.Properties

Example 2: Display topology node properties

The first command gets the desired state topology for the network controller identified by the URI, and then stores it in the $Topology variable.

The second command displays the properties of topology nodes in $Topology.

PS C:\> $Topology = Get-NetworkControllerDesiredStateTopology -ConnectionUri "https://restserver"
PS C:\> $Topology.Properties.topologyNodes

Example 3: Display properties for a topology node

The first command gets the desired state topology for the network controller identified by the URI, and then stores it in the $Topology variable.

The second command displays the properties of the first topology node. It shows that the topology node is a Server and displays the resource IDs of the termination points.

PS C:\> $Topology = Get-NetworkControllerDesiredStateTopology -ConnectionUri "https://restserver"
PS C:\> $Topology.Properties.topologyNodes[0].Properties

Related topics

Get-NetworkControllerDiscoveredTopology

Install-NetworkController

Set-NetworkController