Get-NetworkControllerDiscoveredTopologyNodeVicinity

Get-NetworkControllerDiscoveredTopologyNodeVicinity

Gets neighboring nodes and links in the discovered topology.

Syntax

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




Detailed Description

The Get-NetworkControllerDiscoveredTopologyNodeVicinity cmdlet gets the neighboring nodes and the links that connect to the neighboring nodes for nodes in the discovered topology of the network.

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.

You might use this information to 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:

    -- Operating system.
    -- Model number.
    -- Serial number.
    -- Type of the node. Possible values for type include server, switch, virtualServer, and virtualSwitch.
    -- Vendor name.
    -- Whether the node is hidden. If hidden, it will not appear in the output of this cmdlet.
    -- Whether the node has been manually added or has been automatically discovered.
    -- The termination points in each topology node. Each termination point contains the following information:

    ---- 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.
    ------ Whether IP address is configured statically or by using DHCP.

    ---- Administrative status.
    ---- Operational status.
    ---- Port channel ID, if the termination point is a port channel.
    ---- Interface index.
    ---- Interface speed.
    ---- Whether the discovered termination endpoint represents a baseboard management controller (BMC) network interface of a host computer.

    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: Display neighboring nodes

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

The second command displays Properties property of $Vicinity.


PS C:\> $Vicinity = Get-NetworkControllerDiscoveredTopologyNodeVicinity -ConnectionUri "https://restserver" -TopologyNodeId "951f133f-612b-4134-a588-ed1f73c2a468"
PS C:\> $Vicinity.Properties

Related topics

Community Additions

Show: