Get-NetworkControllerDesiredStateTopologyNode
Get-NetworkControllerDesiredStateTopologyNode
Gets a node in the desired state topology.
Syntax
Parameter Set: Default
Get-NetworkControllerDesiredStateTopologyNode [[-ResourceId] <String[]> ] -ConnectionUri <String> [-CertificateThumbprint <String> ] [-Credential <PSCredential> ] [ <CommonParameters>]
Detailed Description
The Get-NetworkControllerDesiredStateTopologyNode cmdlet gets a node in the desired state topology of the network. You provide a desired state topology to the network controller. Specify resource IDs to obtain particular nodes.
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 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 objects that contain the following properties:
-- A reference to the server or switch that the topology node represents.
-- Termination points of each topology node. For each termination point, the cmdlet retrieves the following information:---- Type. Termination point types include physical network interface, server virtual network interface, virtual server network interface, switch port, or virtual switch port.
---- Whether the termination point is a baseboard management controller (BMC) interface.
---- A reference to the interface or port that the termination point represents.
Examples
Example 1: View the properties of a node
The first command gets the topology node that has the specified ID from the desired state topology, and then stores it in the $Node variable.
The second command displays the Properties property of $Node.
PS C:\> $Node = Get-NetworkControllerDesiredStateTopologyNode -ConnectionUri "https://restserver" -ResourceId "4343e132-a719-46e5-a140-04ed904bee77"
PS C:\> $Node.Properties
Example 2: View the Server property of a node
The first command gets the topology node that has the specified ID from the desired state topology, and then stores it in the $Node variable.
The second command displays the server resource details of $Node.
PS C:\> $Node = Get-NetworkControllerDesiredStateTopologyNode -ConnectionUri "https://restserver" -ResourceId "4343e132-a719-46e5-a140-04ed904bee77"
PS C:\> $Node.Properties.Server
Related topics
Get-NetworkControllerDesiredStateTopology