DSCResources/DSC_FSRMSettings/en-US/about_FSRMSettings.help.txt

.NAME
    FSRMSettings
 
.DESCRIPTION
    This resource is used to configure settings in File Server Resource Manager.
 
.PARAMETER IsSingleInstance
    Key - String
    Allowed values: Yes
    Specifies the resource is a single instance, the value must be 'Yes'.
 
.PARAMETER SmtpServer
    Write - String
    Specifies the fully qualified domain name (FQDN) or IP address of the SMTP server that FSRM uses to send email.
 
.PARAMETER AdminEmailAddress
    Write - String
    Specifies a semicolon-separated list of email addresses for the recipients of any email that the server sends to the administrator.
 
.PARAMETER FromEmailAddress
    Write - String
    Specifies the default email address from which FSRM sends email messages.
 
.PARAMETER CommandNotificationLimit
    Write - UInt32
    Specifies the minimum number of seconds between individual running events of a command-type notification.
 
.PARAMETER EmailNotificationLimit
    Write - UInt32
    Specifies the minimum number of seconds between individual running events of an email-type notification.
 
.PARAMETER EventNotificationLimit
    Write - UInt32
    Specifies the minimum number of seconds between individual running events of an event-type notification.
 
.EXAMPLE 1
 
This configuration will configure the FSRM Settings on a server.
 
Configuration FSRMSettings_Config
{
    Import-DscResource -Module FSRMDsc
 
    Node localhost
    {
        FSRMSettings FSRMSettings
        {
            IsSingleInstance = 'Yes'
            SmtpServer = 'smtp.contoso.com'
            AdminEmailAddress = 'fsadmin@contoso.com'
            FromEmailAddress = 'fsuser@contoso.com'
            CommandNotificationLimit = 90
            EmailNotificationLimit = 90
            EventNotificationLimit = 90
        } # End of FSRMSettings Resource
    } # End of Node
} # End of Configuration