[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Returns information about your Microsoft Communications Server 2010 infrastructure, including internal domains, sites, clusters, computers, services, and backend instances of SQL server.


Get-CsTopology [-AsXml <SwitchParameter>] [-LocalStore <SwitchParameter>]


Parameter Required Type Description



Switch Parameter

Returns topology information in XML format. By combining Get-CsTopology, the –AsXml parameter, and the Out-File cmdlet, you can export your topology to a .XML file.



Switch Parameter

Suppresses the display of any non-fatal error message that might arise when running the command.



Switch Parameter

Detailed Description

The Get-CsTopology cmdlet returns information about how Microsoft Communications Server “14” has been setup and configured. Called without any additional parameters, the cmdlet provides an overview of your Communications Server infrastructure; in that scenario, the cmdlet gives you a bird’s-eye view of such things as your Communications Server domains, your Communications Server sites, and the computers running Communications Server services and server roles. Alternatively, you can pass the output of Get-CsTopology to the Select-Object cmdlet; this enables you to access detailed information about a portion of your topology. For example, the following command provides detailed information regarding the SQL Server instances used by Communications Server:

Get-CsTopology | Select-Object –ExpandProperty SqlInstances

You can also use the –AsXml parameter to return detailed information about your entire topology in XML format.

Return Types

Get-CsTopology returns instances of the Microsoft.Rtc.Management.Deploy.Internal.DefaultTopology object.


-------------------------- Example 1 ------------------------

Copy Code

The preceding command returns complete details for your Communications Server 2010 topology. This is done by calling Get-CsTopology without any additional parameters.

-------------------------- Example 2 ------------------------

Copy Code
Get-CsTopology | Select-Object -ExpandProperty Machines

Example 2 returns information about the computers found in your Communications Server topology. To do this, the command first calls Get-CsTopology to return the complete Communications Server topology. This information is then piped to the Select-Object cmdlet, which uses the -ExpandProperty parameter to extract and display detailed information for all the computers included in that topology.

-------------------------- Example 3 ------------------------

Copy Code
Get-CsTopology -AsXML | Out-File C:\Topology.xml

The command shown in Example 3 returns information about your Communications Server topology and then saves that information to an XML file. To carry out this task, the command first calls Get-CsTopology, along with the -AsXml parameter; that causes the data to be returned as formatted XML. That formatted data is then piped to the Out-File cmdlet, which saves the information to the file C:\Topology.xml.