Out-TopologyTree

In this article

    Formats VMware server topology to a tree view form.

    Applies to versions: 8.0, 9.0

    Syntax

    Out-TopologyTree [-Topology] <Topology> [<CommonParameters>]

    Detailed Description

    This cmdlet retrives the list of clusters and hosts for the specified VMware server and displays a formatted topology tree.

    Parameters

    -Topology <Topology>  

    Specifies the VMware server topology for which you want to display the formatted topology tree.

    Description

    Aliases

     

    Required?

    True

    Position?

    1

    Default Value

     

    Accept Pipeline Input?

    True (ByValue, ByPropertyName)

    Accept Wildcard Characters?

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see Microsoft Docs.

    Input

    The cmdlet accepts the Veeam.Psves.Topology object as the input value. The object is stored in the Topology property of the Veeam.Psves.VMwareServer object.

    The cmdlet accepts the following types of values for the -Topology parameter:

    Output

    The cmdlet returns a Veeam.Psves.Topology.FormattedTopology object that stores the formatted topology tree.

    Example 1

    This example describes how to display formatted topology for the “dev-vcenter” server.

    Get-VMwareServer -Include dev-vcenter | Out-TopologyTree

    Example 2

    This example describes how to display formatted topology for the “prod-vcenter” server.

    The first command retrieves VMware server prod-vcenter and stores it in the $prod variable.

    The second command displays formatted topology tree for the "prod-vcenter".

    $prod = Get-VMwareServer prod-vcenter

    Out-TopologyTree $prod.topology

    You can also pass the Veeam.Psves.VMwareServer object referenced by the $prod variable through pipeline:

    $prod | Out-TopologyTree

    Example 3

    This command shows topology of all connected VMware servers.

    Get-VMwareServer | Out-TopologyTree