SPRemoteFarmTrust - dsccommunity/SharePointDsc GitHub Wiki

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	A name of the remote farm, used to create token issuer and root authority
LocalWebAppUrl	Required	String	The URL of a local web app to connect the remote farm to
RemoteWebAppUrl	Required	String	The URL of a web app in the remote farm, must use HTTPS
Ensure	Write	String	Set to present to ensure the trust exists, or absent to ensure it is removed	Present, Absent

Description

Type: Distributed Requires CredSSP: No

This resource is used to trust a remote SharePoint farm. This is used when federating search results between two different SharePoint farms. The technique is described at: https://technet.microsoft.com/en-us/library/dn133749.aspx

The default value for the Ensure parameter is Present. When not specifying this parameter, the remote farm trust is created.

Examples

Example 1

This example creates a remote farm trust so that the local web app trusts calls that will come from the remote web app.

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPRemoteFarmTrust TrustRemoteFarmForSearch
        {
            Name            = "CentralSearchFarm"
            RemoteWebAppUrl = "https://search.sharepoint.contoso.com"
            LocalWebAppUrl  = "https://local.sharepoint2.contoso.com"
        }
    }
}