Test-CsFederatedPartner

Module:

SkypeForBusiness

Applies to:

Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

Verifies the ability to connect to a federated domain. This cmdlet was introduced in Lync Server 2010.

Syntax

Test-CsFederatedPartner
    [-TargetFqdn] <String>
    [-Domain] <String>
    [-Certificate <X509Certificate2>]
    [-ProxyFqdn <String>]
    [-Force]
    [-Verbose]
    [-OutVerboseVariable <String>]
    [-OutLoggerVariable <String>]
    [<CommonParameters>]

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. When using this cmdlet, make sure that the TargetFqdn parameter points to the internal Edge Server FQDN to which federated SIP traffic is directed.

Examples

-------------------------- 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. Note that TargetFqdn must point to the internal Edge Server FQDN to which federated SIP traffic is directed.

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

Test-CsFederatedPartner -TargetFqdn accessproxy.litwareinc.com -Domain push.lync.com -ProxyFqdn sipfed.online.lync.com

Example 2 shows how you can test the connection between your domain and the Lync Server Push Notification Service. You must have configured this service as a hosting provider and must have added push.lync.com to your list of allowed domains for this test to succeed. For more information, see Configuring for push notifications in Lync Server 2013.

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

Get-CsAllowedDomain | ForEach-Object {Test-CsFederatedPartner -TargetFqdn accessproxy.litwareinc.com -Domain $_.Identity}

In Example 3, connectivity is verified for all the domains on your allowed domains list. To do this, the command first uses the Get-CsAllowedDomain cmdlet to retrieve a collection of all your allowed domains. That collection is then piped to the ForEach-Object cmdlet. In turn, ForEach-Object runs the Test-CsFederatedPartner cmdlet against each domain in the collection.

Parameters

-Certificate

Enables you to provide an X509 certificate for authentication purposes when connecting to the federated domain.

Type:	X509Certificate2
Aliases:	ce
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-Domain

Fully qualified domain name (FQDN) of the federated domain. For example: -Domain "fabrikam.com".

Type:	String
Aliases:	d
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-Force

Suppresses the display of any non-fatal error message that might occur when running the command.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-OutLoggerVariable

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

Type:	String
Aliases:	olv
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-OutVerboseVariable

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.

Type:	String
Aliases:	ovv
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-ProxyFqdn

FQDN of the access proxy server used by the federated organization.

Type:	String
Aliases:	pe
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-TargetFqdn

FQDN of the access proxy server used by your organization for federated SIP traffic. The TargetFqdn must point to the internal Edge Server FQDN to which federated SIP traffic is directed.

Type:	String
Aliases:	t
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019

-Verbose

Reports detailed activity on the screen as the cmdlet runs.

Type:	SwitchParameter
Aliases:	vb
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Lync Server 2010

Inputs

None. Test-CsFederatedPartner does not accept pipelined input.

Outputs

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

Related Links

• Get-CsAllowedDomain