Get-NetworkControllerDiscoveredTopologyNode

Get-NetworkControllerDiscoveredTopologyNode

Gets topology nodes in the discovered network topology.

Syntax

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




Detailed Description

The Get-NetworkControllerDiscoveredTopologyNode cmdlet gets topology nodes in the discovered network topology. Specify resource IDs to obtain particular nodes. To discover the topology of a network, run the Invoke-NetworkControllerTopologyDiscovery cmdlet.

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.

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 topology nodes that this cmdlet gets.


Aliases

none

Required?

false

Position?

1

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 the following information for each topology node:

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


Examples

Example 1: Get a topology node

This command gets the topology node that has the specified resource ID from the discovered topology.


PS C:\> Get-NetworkControllerDiscoveredTopologyNode -ConnectionUri "https://restserver" -ResourceId "951f133f-612b-4134-a588-ed1f73c2a468"

Example 2: View the properties of a node

The first command gets the topology node that has the specified resource ID from the discovered topology, and then stores it in the $Node variable.

The second command displays the Properties property of $Node. It shows that the node is a server, that name of the node is host_02, that the operating system of the node is Microsoft Windows Server 2012 R2 Datacenter (6.3.9600) 64-bit, and other information.


PS C:\> $Node = Get-NetworkControllerDiscoveredTopologyNode -ConnectionUri "https://restserver: -ResourceId "951f133f-612b-4134-a588-ed1f73c2a468"
PS C:\> $Node.Properties

Related topics

Community Additions

Show: