Test-CsFederatedPartner
Topic Last Modified: 2012-03-27
Verifies the ability to connect to a federated domain.
Syntax
Test-CsFederatedPartner -TargetFqdn <String> -Domain <String> [-Certificate <X509Certificate2>] [-Force <SwitchParameter>] [-OutVerboseVariable <String>] [-ProxyFqdn <String>]
Detailed Description
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"}
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Domain |
Required |
String |
Fully qualified domain name (FQDN) of the federated domain. For example: -Domain "fabrikam.com". |
TargetFqdn |
Required |
Switch Parameter |
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 |
X.509 certificate |
Enables you to provide an X509 certificate for authentication purposes when connecting to the federated domain. |
ProxyFqdn |
Optional |
String |
FQDN of the access proxy server used by the federated organization. |
OutVerboseVariable |
Optional |
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. |
Force |
Optional |
Switch Parameter |
Suppresses the display of any non-fatal error message that might occur when running the command. |
Verbose |
Optional |
String |
Reports detailed activity on the screen as the cmdlet runs. |
Input Types
None. Test-CsFederatedPartner does not accept pipelined input.
Return Types
Test-CsFederatedPartner returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object.
Example
-------------------------- Example 1 --------------------------
Test-CsFederatedPartner -TargetFqdn accessproxy.litwareinc.com -Domain fabrikam.com
The command shown in Example 1 verifies the connection between the local access proxy server (accessproxy.litwareinc.com) and the federated domain Fabrikam.com.