Get-CsTopology
Topic Last Modified: 2012-03-23
Returns information about your Microsoft Lync Server 2010 infrastructure, including internal domains, sites, clusters, computers, services, and back-end instances of SQL Server.
Syntax
Get-CsTopology [-AsXml <SwitchParameter>] [-LocalStore <SwitchParameter>]
Detailed Description
The Get-CsTopology cmdlet returns information about how Lync Server 2010 has been set up and configured. Called without any additional parameters, the cmdlet provides an overview of your Lync Server infrastructure; in that scenario, the cmdlet gives you an overall view of such things as your domains, your sites, and the computers running Lync 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 Lync 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.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsTopology cmdlet locally: RTCUniversalUserAdmins, RTCUniversalServerAdmins.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
AsXml |
Optional |
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 an XML file. |
LocalStore |
Optional |
Switch Parameter |
Retrieves the topology data from the local replica of the Central Management store rather than from the Central Management store itself. |
Input Types
None. Get-CsTopology does not accept pipelined input.
Return Types
Get-CsTopology returns instances of the Microsoft.Rtc.Management.Deploy.Internal.DefaultTopology object.
Example
-------------------------- Example 1 ------------------------
Get-CsTopology
The preceding command returns complete details for your Lync Server topology. This is done by calling Get-CsTopology without any additional parameters.
-------------------------- Example 2 ------------------------
Get-CsTopology | Select-Object -ExpandProperty Machines
Example 2 returns information about the computers found in your Lync Server topology. To do this, the command first calls Get-CsTopology to return the complete Lync 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 ------------------------
Get-CsTopology -AsXML | Out-File C:\Logs\Topology.xml
The command shown in Example 3 returns information about your Lync 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:\Logs\Topology.xml.