Get-NetworkControllerDiscoveredTopologyLink

Get-NetworkControllerDiscoveredTopologyLink

Gets links in the discovered topology of the network.

Syntax

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




Detailed Description

The Get-NetworkControllerDiscoveredTopologyLink cmdlet gets links in the discovered topology of the network. Specify resource IDs to obtain particular links. To discover the topology of a network, run 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?

true

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

-ResourceId<String[]>

Specifies an array of resource IDs of topology links that this cmdlet gets.


Aliases

none

Required?

false

Position?

1

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.

  • This cmdlet returns a topology link object that contains the following information:

    -- AggregateId. A system generated identifier that groups the links that are part of a single logical link, such as multiple physical links that form an aggregated link for uplink, which would share same AggregateId.
    -- Label. A description of the link.
    -- Type. The type of the link. Acceptable values for this property are Regular, Virtual, AggregateLink, and VLANTrunk.
    -- TerminationPoint1. The interface for one end of the link.
    -- TerminationPoint2. The interface for the other end of the link.
    -- Whether the link is manually added or auto-discovered.
    -- Whether the link is marked hidden. Hidden links do not appear in the output.


Examples

Example 1: Display properties of a link

The first command retrieves a topology link in the discovered topology that has the specified resource ID, and the stores it in the $Link variable.

The second command displays Properties property of $Link, which shows that the link is a regular link and displays the two termination points.


PS C:\> $Link = Get-NetworkControllerDiscoveredTopologyLink -ConnectionUri "https://restserver" -ResourceId "ff5c5fea-0527-4011-83a8-de0bf4b121d9"
PS C:\> $Link.Properties

Example 2: Display a termination point of a link

The first command retrieves a topology link in the discovered topology that has the specified resource ID, and the stores it in the $Link variable.

The second command displays Properties.Terminationpoint1 property of $Link, which shows the resource details of one of the termination points.


PS C:\> $Link = Get-NetworkControllerDiscoveredTopologyLink -ConnectionUri "https://restserver" -ResourceId "ff5c5fea-0527-4011-83a8-de0bf4b121d9"
PS C:\> $Link.Properties.Terminationpoint1

Related topics

Community Additions

Show: