en-US/about_SPUserProfileSyncService.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
63
64
65
66
67
68
69
70
71
72
.NAME
    SPUserProfileSyncService

# Description
    
    This resource is responsible for ensuring that the user profile sync service
    has been provisioned (Ensure = "Present") or is not running (Ensure =
    "Absent") on the current server. This resource uses the InstallAccount to
    validate the current state only, the set method which will do the provisioning
    uses the FarmAccount to do the actual work - this means that CredSSP
    authentication will need to be permitted to allow a connection to the local
    server. To allow successful provisioning the farm account must be in the local
    administrators group, however it is not best practice to leave this account in
    the Administrators group. Therefore this resource will add the FarmAccount
    credential to the local administrators group at the beginning of the set
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the user profile sync service is provisioned.
    
.PARAMETER UserProfileServiceAppName
    Key - string
    The name of the user profile service for this sync instance

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present to ensure the service is running, absent to ensure it is not

.PARAMETER FarmAccount
    Required - String
    The farm account, which is needed to provision the service app

.PARAMETER RunOnlyWhenWriteable
    Write - Boolean
    Should the sync service only run when the user profile database is in a writeable state?

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


.EXAMPLE
    This example provisions the user profile sync service to the local server


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

            [Parameter(Mandatory = $true)]
            [PSCredential]
            $FarmAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPUserProfileSyncService UserProfileSyncService
            {  
                UserProfileServiceAppName   = "User Profile Service Application"
                Ensure                      = "Present"
                FarmAccount                 = $FarmAccount
                RunOnlyWhenWriteable        = $true
                InstallAccount              = $SetupAccount
            }
        }
    }