.png)
Test-CsFederatedPartner
Topic Last Modified: 2012-08-12
Verifies the ability to connect to a federated domain. This cmdlet was introduced in Lync Server 2010.
Test-CsFederatedPartner -Domain <String> -TargetFqdn <String> [-Certificate <X509Certificate2>] [-Force <SwitchParameter>] [-OutLoggerVariable <String>] [-OutVerboseVariable <String>] [-ProxyFqdn <String>]
The command shown in Example 1 verifies the connection between the local access proxy server (accessproxy.litwareinc.com) and the federated domain Fabrikam.com.
Test-CsFederatedPartner -TargetFqdn accessproxy.litwareinc.com -Domain fabrikam.com
Test-CsFederatedPartner verifies your ability to connect to the domain of a federated partner. In order to verify the connectivity to a domain, that domain must be listed in the collection of allowed (federated) domains. Domains can be added to the allowed list by using the New-CsAllowedDomain cmdlet.
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-CsFederatedPartner"}
| Parameter | Required | Type | Description |
|---|---|---|---|
| Domain | Required | System.String | Fully qualified domain name (FQDN) of the federated domain. For example: -Domain "fabrikam.com". |
| TargetFqdn | Required | System.String | FQDN of the access proxy server used by your organization for federated SIP traffic. The TargetFqdn must point to the internal edge of the proxy server to which federated SIP traffic is directed. |
| Certificate | Optional | System.Security.Cryptography.X509Certificates.X509Certificate2 | Enables you to provide an X509 certificate for authentication purposes when connecting to the federated domain. |
| Force | Optional | System.Management.Automation.SwitchParameter | Suppresses the display of any non-fatal error message that might occur when running the command. |
| OutLoggerVariable | Optional | System.String | When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods – ToHTML and ToXML – that can then be used to save that output to either an HTML or an XML file. To store output in a logger variable named $TestOutput use the following syntax: -OutLoggerVariable TestOutput Note: Do not use prepend a $ character when specifying the variable name.To save the information stored in the logger variable to an HTML file, use a command similar to this: $TestOutput.ToHTML() > C:\Logs\TestOutput.html To save the information stored in the logger variable to an XML file, use a command similar to this: $TestOutput.ToXML() > C:\Logs\TestOutput.xml |
| OutVerboseVariable | Optional | System.String | When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: -OutVerboseVariable TestOutput Do not prepend a $ character when specifying the variable name. |
| ProxyFqdn | Optional | System.String | FQDN of the access proxy server used by the federated organization. |
None. Test-CsFederatedPartner does not accept pipelined input.
Test-CsFederatedPartner returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.
