en-US/about_SPRemoteFarmTrust.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
.NAME
    SPRemoteFarmTrust

# Description
    
    **Type:** Distributed
    
    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
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the remote farm trust is created.
    
.PARAMETER Name
    Key - string
    A name of the remote farm, used to create token issuer and root authority

.PARAMETER RemoteWebAppUrl
    Required - string
    The URL of a web app in the remote farm, must use HTTPS

.PARAMETER LocalWebAppUrl
    Required - string
    The URL of a local web app to connect the remote farm to

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Set to present to ensure the trust exists, or absent to ensure it is removed

.PARAMETER InstallAccount
    Write - String
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5


.EXAMPLE
    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"
            }
        }
    }