Export (0) Print
Expand All
Expand Minimize

Test-CsTopology

 

Topic Last Modified: 2013-02-21

Verifies service activation and group permissions for your installation of Lync Server. This cmdlet was introduced in Lync Server 2010.

Test-CsTopology [-GlobalCatalog <Fqdn>] [-GlobalSettingsDomainController <Fqdn>] [-Report <String>] [-Service <String>]

Example 1 validates the entire Lync Server topology.

Test-CsTopology

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.

Test-CsTopology -Report "C:\Logs\Topology.xml"

In Example 3, the Test-CsTopology cmdlet is used to validate a single service: Registrar:atl-cs-001.litwareinc.com.

Test-CsTopology -Service "Registrar:atl-cs-001.litwareinc.com"

The Test-CsTopology cmdlet provides a way for you to verify that Lync Server 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, the Test-CsTopology cmdlet 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"}

 

Parameter Required Type Description

GlobalCatalog

Optional

Microsoft.Rtc.Management.Deploy.Fqdn

Fully qualified domain name (FQDN) of a global catalog server in your domain. This parameter is not required if you are running the Test-CsTopology cmdlet on a computer with an account in your domain.

GlobalSettingsDomainController

Optional

Microsoft.Rtc.Management.Deploy.Fqdn

FQDN of a domain controller where global settings are stored. If global settings are stored in the System container in Active Directory Domain Services, 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.

Report

Optional

System.String

Enables you to specify a file path for the log file created when the cmdlet runs. For example: -Report "C:\Logs\Topology.html"

Service

Optional

System.String

When present, the Test-CsTopology cmdlet 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.

None. The Test-CsTopology cmdlet does not accept pipelined input.

The Test-CsTopology cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft