Test-CsTopology
Topic Last Modified: 2012-03-26
Verifies service activation and group permissions for your installation of Microsoft Lync Server 2010.
Syntax
Test-CsTopology [-GlobalCatalog <Fqdn>] [-GlobalSettingsDomainController <Fqdn>] [-Report <String>] [-Service <String>]
Detailed Description
The Test-CsTopology cmdlet provides a way for you to verify that Lync Server 2010 is functioning correctly at a global level. By default, the cmdlet checks your entire Lync Server infrastructure, verifying that the required services are running and that the appropriate permissions have been set for these services and for the universal security groups created when you install Lync Server.
In addition to verifying the validity of Lync Server as a whole, Test-CsTopology also lets you check the validity of a specific service. For example, this command checks the state of the A/V Conferencing Server on the pool atl-cs-001.litwareinc.com:
Test-CsTopology –Service "ConferencingServer:atl-cs-001.litwareinc.com".
Who can run this cmdlet: To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Test-CsTopology"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
GlobalCatalog |
Optional |
String |
Fully qualified domain name (FQDN) of a global catalog server in your domain. This parameter is not required if you are running Test-CsTopology on a computer with an account in your domain. |
GlobalSettingsDomainController |
Optional |
String |
FQDN of a domain controller where global settings are stored. If global settings are stored in the System container in Active Directory Domain Services (AD DS), then this parameter must point to the root domain controller. If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. |
Service |
Optional |
Service Identity |
When present, Test-CsTopology limits its validation checks to the specified service. (Note that you can only specify one service at a time when using the Service parameter.) Services should be specified using the appropriate service ID; for example, this syntax refers to the Registrar service on the atl-cs-001.litwareinc.com pool: -Service "Registrar:atl-cs-001.litwareinc.com". If this parameter is not included then the entire topology will be validated. |
Report |
Optional |
String |
Enables you to specify a file path for the log file created when the cmdlet runs. For example: -Report "C:\Logs\Topology.html" |
Verbose |
Optional |
Switch Parameter |
Reports detailed activity to the screen as the cmdlet runs. |
Input Types
None. Test-CsTopology does not accept pipelined input.
Return Types
Test-CsTopology returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.
Example
-------------------------- Example 1 --------------------------
Test-CsTopology
The preceding command validates the entire Lync Server topology.
-------------------------- Example 2 --------------------------
Test-CsTopology -Report "C:\Logs\Topology.xml"
The command shown in Example 2 is a variation of the command shown in Example 1. In this case, however, the Report parameter is included to specify the location (C:\Logs\Topology.xml) where the output file should be written.
-------------------------- Example 3 --------------------------
Test-CsTopology -Service "Registrar:atl-cs-001.litwareinc.com"
In Example 3, Test-CsTopology is used to validate a single service: Registrar:atl-cs-001.litwareinc.com.