Skip to content

SPUsageApplication

Brian Farnhill edited this page Jun 2, 2016 · 19 revisions

Parameters

Parameter Attribute DataType Description Allowed Values
Name Key string The name of the service application
DatabaseName Write string The name of the database for the service app
DatabaseServer Write string The name of the database server
DatabaseCredentials Write String The credentials to use to access the database
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
Ensure Write string Present if the service app should exist, absent if it should not Present, Absent
InstallAccount Write String POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsAccount if using PowerShell 5

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 executed.

Example

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

Clone this wiki locally