SPUsageApplication - dsccommunity/SharePointDsc GitHub Wiki

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
Name	Key	String	The name of the service application
DatabaseCredentials	Write	PSCredential	The credentials to use to access the database
DatabaseName	Write	String	The name of the database for the service app
DatabaseServer	Write	String	The name of the database server
Ensure	Write	String	Present if the service app should exist, absent if it should not	Present, Absent
FailoverDatabaseServer	Write	String	The name of the failover database server
UsageLogCutTime	Write	UInt32	The time in minutes to cut over to new log files
UsageLogLocation	Write	String	The location on each server to store the log files
UsageLogMaxFileSizeKB	Write	UInt32	The maximum file size for log files in KB
UsageLogMaxSpaceGB	Write	UInt32	The total space of all log files on disk in GB

Description

Type: Distributed Requires CredSSP: No

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.

Examples

Example 1

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"
            PsDscRunAsCredential  = $SetupAccount
        }
    }
}