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

Returns information about the Microsoft Communications Server 2010 certificates being used on the local computer.

Syntax

Test-CsCertificateConfiguration [-Confirm [<SwitchParameter>]] [-Force <SwitchParameter>] [-Report <String>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter Required Type Description

Report

Optional

String

Enables you to specify a file path for the log file created when the cmdlet runs. For example: -Report "C:\Logs\Certificates.xml". If this file already exists, it will be overwritten when you run the cmdlet.

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

Test-CsCertificateConfiguration is an example of a "synthetic transaction." Synthetic transactions are used in Communications Server to verify that users are able to successfully complete common tasks such as logging on to the system, exchanging instant messages, or making calls to a phone located on the Public Switched Telephone Network (PSTN). These tests can be conducted "manually" by an administrator, or they can be automatically run by an application such as Microsoft System Center Operations Manager.

Test-CsCertificateConfiguration returns information about the certificates being used by Communications Server.

Return Types

Test-CsCertificateConfiguration returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.

Examples

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

Copy Code
Test-CsCertificateConfiguration

The command shown in Example 1 returns information about the certificates currently being used (on the local computer) by Communications Server.

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

Copy Code
Test-CsCertificateConfiguration | Format_list

The command shown in Example 2 is a variation of the command shown in Example 1. In Example 2, however, the output from Test-CsCertificateConfiguration is piped to the Format-List cmdlet, which then displays that output in a list rather than a table. That helps to ensure that the entire certificate thumbprint is visible on the screen, as opposed to a truncated version of the thumbprint.

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

Copy Code
Test-CsCertificateConfiguration -Report "C:\Logs\Certificates.xml"

The command shown in Example 3 is also a variation of the command shown in Example 1. In this case, however, the Report parameter is used to specify a file path (C:\Logs\Certificates.xml) for the output file generated when you run Test-CsCertificateConfiguration.