Get-NetworkControllerDesiredStateTopologyTerminationPoint

Get-NetworkControllerDesiredStateTopologyTerminationPoint

Gets termination points in the desired state topology.

Syntax

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




Detailed Description

The Get-NetworkControllerDesiredStateTopologyTerminationPoint cmdlet gets termination points in the desired state topology. Specify resource IDs to obtain particular termination points.

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 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 information for a termination point:

    -- If the termination point is a server interface, a reference to the server network interface.
    -- If the termination point is a virtual interface on server, a reference to the server virtual network interface.
    -- If the termination point is a virtual server interface, a reference to the virtual server network interface.
    -- If the termination point is a switch port, a reference to the switch port.
    -- If the termination point is a virtual port, a reference to virtual port.
    -- Whether the endpoint is a host baseboard management controller (BMC) interface.


Examples

Example 1: Display termination point properties

The first command gets the termination points on the topology node that has the specified resource ID. The command stores the results in the $Point variable.

The second command displays the properties of $Point. In this example, there are two termination points that have the type NetworkInterface.


PS C:\> $Point = Get-NetworkControllerDesiredStateTopologyTerminationpoint -ConnectionUri "https://networkcontroller" -TopologyNodeId "44e866e3-4bbb-4afb-93d4-f26b1853ef55"
PS C:\> $Point.Properties

Example 2: Display termination point network interface details

The first command gets the termination points on the topology node that has the specified resource ID. The command stores the results in the $Point variable.

The second command displays the properties of the first network interface in $Point. The command displays the reference to the actual network interface.


PS C:\> $Point = Get-NetworkControllerDesiredStateTopologyTerminationpoint -ConnectionUri "https://networkcontroller" -TopologyNodeId "44e866e3-4bbb-4afb-93d4-f26b1853ef55"
PS C:\> $Point.Properties.NetworkInterface[0]

Related topics

Community Additions

Show: