Get-NetworkControllerDesiredStateTopologyLink

Get-NetworkControllerDesiredStateTopologyLink

Gets links in the desired state topology.

Syntax

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




Detailed Description

The Get-NetworkControllerDesiredStateTopologyLink cmdlet gets links in the desired state topology. Specify resource IDs to obtain particular links.

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.


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.

Examples

Example 1: Get all links

The first command retrieves the topology links for the specified network controller, and then store the results in the $Link variable.

The second command displays the contents of $Link. In this example, there is only one link.


PS C:\> $Link=Get-NetworkControllerDesiredStateTopologyLink -ConnectionUri 'https://restserver' 
PS C:\> $Link

Example 2: Display properties of a link

The first command retrieves the topology links for the specified network controller, and then store the results 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-NetworkControllerDesiredStateTopologyLink -ConnectionUri "https://restserver" 
PS C:\> $Link.Properties

Example 3: Display a termination point of a link

The first command retrieves a topology link in the desired 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 "64d60cf0-b78d-42b9-8cc8-6d5e4ff8f117"
PS C:\> $Link.Properties.terminationPoint1

Related topics

Community Additions

Show: