en-US/about_SPCacheAccounts.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
73
74
75
76
77
78
79
80
81
82
83
84
85
.NAME
    SPCacheAccounts

# Description
    
    This resource is used to set the "super user" and "super reader" cache accounts
    for the specified web application object (as described in the TechNet article
    [Configure object cache user accounts in SharePoint Server 2013](https://technet.microsoft.com/en-us/library/ff758656.aspx)).
    
.PARAMETER WebAppUrl
    Key - string
    The URL of the web application to set the accounts for

.PARAMETER SuperUserAlias
    Required - string
    The account name for the super user

.PARAMETER SuperReaderAlias
    Required - string
    The account name for the super reader

.PARAMETER SetWebAppPolicy
    Write - boolean
    Should the web app policy be set for these accounts?

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


.EXAMPLE
    This example sets the super use and reader accounts for the specified web app. It will
    also set the appropriate web app policies by default for these accounts.


    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPCacheAccounts SetCacheAccounts
            {
                WebAppUrl            = "http://sharepoint.contoso.com"
                SuperUserAlias       = "DEMO\svcSPSuperUser"
                SuperReaderAlias     = "DEMO\svcSPReader"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example sets the super use and reader accounts for the specified web app. It will
    not set the web app policies for these accounts though, allowing them to be controlled
    elsewhere (either manually or with SPWebAppPolicy)


    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPCacheAccounts SetCacheAccounts
            {
                WebAppUrl            = "http://sharepoint.contoso.com"
                SuperUserAlias       = "DEMO\svcSPSuperUser"
                SuperReaderAlias     = "DEMO\svcSPReader"
                SetWebAppPolicy      = $false
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }