en-US/about_SPUsageApplication.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
86
87
.NAME
    SPUsageApplication

# Description
    
    This resource provisions an instance of the usage and health monitoring service
    application. The database settings are only used for initial provisioning, but
    the usage settings can be changed and will be enforced as the resource is
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the service application is provisioned.
    
.PARAMETER Name
    Key - string
    The name of the service application

.PARAMETER DatabaseName
    Write - string
    The name of the database for the service app

.PARAMETER DatabaseServer
    Write - string
    The name of the database server

.PARAMETER DatabaseCredentials
    Write - String
    The credentials to use to access the database

.PARAMETER FailoverDatabaseServer
    Write - string
    The name of the failover database server

.PARAMETER UsageLogCutTime
    Write - uint32
    The time in minutes to cut over to new log files

.PARAMETER UsageLogLocation
    Write - string
    The location on each server to store the log files

.PARAMETER UsageLogMaxFileSizeKB
    Write - uint32
    The maximum file size for log files in KB

.PARAMETER UsageLogMaxSpaceGB
    Write - uint32
    The total space of all log files on disk in GB

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present if the service app should exist, absent if it should not

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


.EXAMPLE
    This example deploys a usage application to the local farm


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

        node localhost {
            SPUsageApplication UsageApplication 
            {
                Name                  = "Usage Service Application"
                DatabaseName          = "SP_Usage"
                UsageLogCutTime       = 5
                UsageLogLocation      = "L:\UsageLogs"
                UsageLogMaxFileSizeKB = 1024
                Ensure                = "Present"
                InstallAccount        = $SetupAccount
            }
        }
    }