Get-NetworkControllerDesiredStateTopologyNodeVicinity

Get-NetworkControllerDesiredStateTopologyNodeVicinity

Gets neighboring nodes and links in the desired state topology.

Syntax

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




Detailed Description

The Get-NetworkControllerDesiredStateTopologyNodeVicinity cmdlet gets the neighboring nodes and the links that connect to the neighboring nodes for topology nodes in the desired state topology of the network.

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.

You might use this information to identify and configure switches or routers directly connected to a host. For example, if you provision a new IP address on a host, you can program the neighboring switch with a new route.

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

-TopologyNodeId<String[]>

Specifies an array of IDs of topology nodes for which this cmdlet gets neighboring node and link information.


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 an object that contains neighboring nodes and connecting links.

    For each neighboring topology node, this cmdlet gets following information:

    -- A reference to the server or switch that the topology node represents.
    -- Termination points of each topology node. For each termination point, this cmdlet gets following information:

    ---- Type. Types of termination points include physical network interface, server virtual network interface, virtual server network interface, switch port, and virtual switch port.
    ---- Whether the termination point is a BMC interface.
    ---- Reference to the actual interface or port that the termination point represents.

    For each link to a neighboring node, this cmdlet gets 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: View node properties

The first command gets the nodes that neighbor the specified topology node and links to those nodes, and stores the results in the $Vicinity variable.

The second command displays Properties property of $Vicinity.


PS C:\> $Vicinity = Get-NetworkControllerDesiredStateTopologyNodeVicinity -ConnectionUri "https://restserver" -TopologyNodeId "4343e132-a719-46e5-a140-04ed904bee77"
PS C:\> $Vicinity.Properties

Example 2: View node details

The first command gets the nodes that neighbor the specified topology node, and stores the results in the $Vicinity variable.

The second command displays details of one of the topology nodes in $Vicinity.


PS C:\> $Vicinity = Get-NetworkControllerDesiredStateTopologyNodeVicinity -ConnectionUri "https://restserver" -TopologyNodeId "4343e132-a719-46e5-a140-04ed904bee77" 
PS C:\> $Vicinity.Properties.TopologyNodes[1] 

Related topics

Community Additions

Show: