Get-NetworkControllerDiscoveredTopology

Get-NetworkControllerDiscoveredTopology

Gets the discovered topology of the network.

Syntax

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




Detailed Description

The Get-NetworkControllerDiscoveredTopology cmdlet gets the discovered topology of the network. Use the network controller to discover network topology by using the Invoke-NetworkControllerTopologyDiscovery cmdlet.

A discovered 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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<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: Get network topology

This command gets the discovered network topology from the specified network controller.


PS C:\> Get-NetworkControllerDiscoveredTopology -ConnectionUri "https://restserver"

Example 2: View topology properties

The first command gets the discovered network topology from the specified network controller, and then stores it in the $Topology variable.

The second command displays the Properties property of $Topology.


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

Example 3: Display properties of a topology node

The first command gets the discovered network topology from the specified network controller, and then stores it in the $Topology variable.

The second command displays the properties of the first topology node in the discovered topology. This node is a switch and the name of the node is DC. The command displays the resource ID of the termination points.


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

Related topics

Community Additions

Show: