Get-NetworkControllerDesiredStateBulkTopologyLinks

Get-NetworkControllerDesiredStateBulkTopologyLinks

Gets all the links in the desired state topology.

Syntax

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




Detailed Description

The Get-NetworkControllerDesiredStateBulkTopologyLinks cmdlet gets all the links in your desired state topology.

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?

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

  • This cmdlet returns an object that contains the following fields:

    -- Resource reference URI
    -- Created time of the resource
    -- Instance ID of the resource
    -- Resource Metadata
    -- Resource ID
    -- Properties of the resource

    For this resource, the properties contain all the topology links. Each topology link 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.
    -- TerminationPoint1. The interface for one end of the link.
    -- TerminationPoint2. The interface for the other end of the link.
    -- Type. The acceptable values for this property are as follows:

    ---- VLANTrunk. A VLAN trunk.
    ---- AggregateLink. A logical link that contains several physical links that have been combined by using Link Aggregation Control Protocol (LACP) or static link aggregation.
    ---- Regular. A non-aggregated physical link.
    ---- Virtual. A link where at least one endpoint is a virtual device.


Examples

Example 1: Get all links

This command gets all the topology links in the desired state topology.


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

Example 2: Display all the topology links

The first command gets all the topology links in the desired state topology, and then stores them in the $Links variable.

The second command displays the Properties property of $Links. This property contains all the topology links in the desired state topology.


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

Example 3: Display the properties of a link

The first command gets all the topology links in the desired state topology, and then stores them in the $Links variable.

The second command displays the first topology link among the Properties property of $Links.


PS C:\> $Links = Get-NetworkControllerDesiredStateBulkTopologyLinks -ConnectionUri "https://restserver"
PS C:\> $Links.Properties.TopologyLinks[0].Properties

Related topics

Community Additions

Show: