Get-NetworkControllerDiscoveredTopologyTerminationPoint

Get-NetworkControllerDiscoveredTopologyTerminationPoint

Gets the termination point of a topology node in the discovered network topology.

Syntax

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




Detailed Description

The Get-NetworkControllerDiscoveredTopologyTerminationPoint cmdlet gets the termination point of a topology node in the discovered network topology. Specify resource IDs to obtain particular nodes.

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.

If you do not specify a resource ID, this cmdlet gets all the termination points of the specified topology node.

To discover the topology of a network, run the Invoke-NetworkControllerTopologyDiscovery cmdlet. You can then compare the discovered topology with the desired state topology to find issues and correct them manually. This process helps you ensure that wiring and cabling is correct.

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 termination points that this cmdlet gets.


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TopologyNodeId<String[]>

Specifies an array of IDs for topology nodes for which this cmdlet gets termination points.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true(ByPropertyName)

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 the following properties for each termination point:

    ---- Interface name of the termination point.
    ---- Interface type.
    ---- MAC address.
    ---- VLAN IDs.
    ---- IP configuration. Configuration contains the following information:

    ------ IP address.
    ------ Network prefix.
    ------ Default gateway.
    ------ VLAN.
    ------ Virtual subnet ID.
    ------ Routing domain ID
    ------ Whether IP address is configured statically or by using DHCP.

    ---- Administrative status.
    ---- Operational status.
    ---- System GUID.
    ---- Interface GUID.
    ---- If the termination point is a port channel, a Port channel ID.
    ---- If the termination point is part of a Network Adapter Team, a name of a Network Adapter Team.
    ---- Interface index.
    ---- Interface speed.
    ---- Whether the discovered termination endpoint represents a baseboard management controller (BMC) network interface of a host computer.


Examples

Example 1: Display termination points in discovered topology

This command gets the termination points of a topology node that has the specified ID in the discovered topology.


PS C:\> Get-NetworkControllerDiscoveredTopologyTerminationPoint -ConnectionUri "https://restserver" -TopologyNodeId "fc284b32-38ba-47d2-a67a-6443d3938bb1"

Example 2: Display termination point properties

The first command gets the termination points of a topology node that has the specified ID in the discovered topology. The command stores the results in the $Endpoint variable.

The second command displays the properties of the first termination point in $Endpoint. In this example, the termination point is a switch port named Device_02_EP_01.


PS C:\> $Endpoint = Get-NetworkControllerDiscoveredTopologyTerminationPoint -ConnectionUri "https://restserver" -TopologyNodeId "fc284b32-38ba-47d2-a67a-6443d3938bb1"
PS C:\> $Endpoint[0].Properties

Related topics

Community Additions

Show: