en-US/about_SPSessionStateService.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
    SPSessionStateService

# Description
    
    **Type:** Distributed
    
    This resource will provision a state service app to the local farm. Specify
    the name of the database server and database name to provision the app with,
    and optionally include the session timeout value. If session timeout is not
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the service application is provisioned.
    
.PARAMETER DatabaseName
    Key - string
    The name of the database for the service

.PARAMETER DatabaseServer
    Key - string
    The name of the database server for the database

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present is the state service should be enabled, absent if it should be disabled

.PARAMETER SessionTimeout
    Write - uint32
    What is the timeout on sessions

.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 new session state service on the local farm.


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

        node localhost {
            SPSessionStateService StateServiceApp
            {
                DatabaseName         = "SP_StateService"
                DatabaseServer       = "SQL.test.domain"
                Ensure               = "Present"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }