Verifies service activation and group permissions for your installation of Microsoft Communications Server “14”.
Syntax
Test-CsTopology [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-GlobalCatalog <Fqdn>] [-GlobalSettingsDomainController <Fqdn>] [-Report <String>] [-Service <String>] [-WhatIf [<SwitchParameter>]] |
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
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. |
|
SkipPrepareCheck |
Optional |
Boolean |
When set to True, Test-CsTopology skips its initial preparation check. |
|
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.xml" |
|
GlobalCatalog |
Optional |
String |
Fully qualified domain name 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 |
Fully qualified domain name of a domain controller where global settings are stored If global settings are stored in the System container in Active Directory 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. |
|
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might arise when running the command. |
|
Verbose |
Optional |
Switch Parameter |
Reports detailed activity to the screen as the cmdlet runs. |
|
WhatIf |
Optional |
Switch Parameter |
Describes what would happen if you executed the command without actually executing the command. |
|
Confirm |
Optional |
Switch Parameter |
Prompts you for confirmation before executing the command. |
Detailed Description
The Test-CsTopology cmdlet provides a way for you to verify that Microsoft Communications Server is functioning correctly at a global level. By default, the cmdlet checks your entire Communications Server infrastructure, verifying that the required services are u running and that the appropriate permissions have been set for these services and for the universal security groups created when you install Microsoft Communications Server.
In addition to verifying the validity of Communications 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 conferencing server on the pool atl-cs-001.litwareinc.com:
Test-CsTopology –Service "ConferenceServer:atl-cs-001.litwareinc.com".
Return Types
Test-CsTopology returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.
Examples
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
Test-CsTopology |
|
The preceding command validates the entire Microsoft Communications Server topology.
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
Test-CsTopology -Report "C:\Logs\Topology.xml" |
|
The command shown in Example 2 is a near-duplicate 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 --------------------------
| Copy Code |
|
|---|---|
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.