PSCI

1.0.11

modules/deploy/dsc/ext/PsGallery/xSharePoint.0.10.0.0/en-us/about_xSPDiagnosticLoggingSettings.help.txt

                                NAME

    xSPDiagnosticLoggingSettings

PARAMETERS

    LogPath (Key, string)

    LogSpaceInGB (Required, uint32)

    AppAnalyticsAutomaticUploadEnabled (Write, boolean)

    CustomerExperienceImprovementProgramEnabled (Write, boolean)

    DaysToKeepLogs (Write, uint32)

    DownloadErrorReportingUpdatesEnabled (Write, boolean)

    ErrorReportingAutomaticUploadEnabled (Write, boolean)

    ErrorReportingEnabled (Write, boolean)

    EventLogFloodProtectionEnabled (Write, boolean)

    EventLogFloodProtectionNotifyInterval (Write, uint32)

    EventLogFloodProtectionQuietPeriod (Write, uint32)

    EventLogFloodProtectionThreshold (Write, uint32)

    EventLogFloodProtectionTriggerPeriod (Write, uint32)

    LogCutInterval (Write, uint32)

    LogMaxDiskSpaceUsageEnabled (Write, boolean)

    ScriptErrorReportingDelay (Write, uint32)

    ScriptErrorReportingEnabled (Write, boolean)

    ScriptErrorReportingRequireAuth (Write, boolean)

    InstallAccount (Write, String)

DESCRIPTION

This resource is responsible for configuring settings to do with the diagnostic (ULS) logging on servers in the farm.

These settings are applied to the diagnostic logging service for the farm and do not need to be applied to each server individually, the settings will be propagated throughout the farm when they are set. 

EXAMPLE

    xSPDiagnosticLoggingSettings ApplyDiagnosticLogSettings

    {

        PsDscRunAsCredential                        = $InstallAccount

        LogPath                                     = "L:\ULSLogs"

        LogSpaceInGB                                = 10

        AppAnalyticsAutomaticUploadEnabled          = $false

        CustomerExperienceImprovementProgramEnabled = $true

        DaysToKeepLogs                              = 7

        DownloadErrorReportingUpdatesEnabled        = $false

        ErrorReportingAutomaticUploadEnabled        = $false

        ErrorReportingEnabled                       = $false

        EventLogFloodProtectionEnabled              = $true

        EventLogFloodProtectionNotifyInterval       = 5

        EventLogFloodProtectionQuietPeriod          = 2

        EventLogFloodProtectionThreshold            = 5

        EventLogFloodProtectionTriggerPeriod        = 2

        LogCutInterval                              = 15

        LogMaxDiskSpaceUsageEnabled                 = $true

        ScriptErrorReportingDelay                   = 30

        ScriptErrorReportingEnabled                 = $true

        ScriptErrorReportingRequireAuth             = $true

    }