SPPasswordChangeSettings - dsccommunity/SharePointDsc GitHub Wiki

Parameters

Parameter	Attribute	DataType	Description	Allowed Values
IsSingleInstance	Key	String	Specifies the resource is a single instance, the value must be 'Yes'	Yes
MailAddress	Required	String	The email address to send notifications of password changes to
DaysBeforeExpiry	Write	UInt32	The number of days before password expiry to send send emails
NumberOfRetries	Write	UInt32	How many retries if the password change fails
PasswordChangeWaitTimeSeconds	Write	UInt32	The duration that a password reset will wait for before it times out

Description

Type: Distributed Requires CredSSP: No

This resource is used to control settings that relate to the automatic changing of passwords for managed accounts (where they opt-in to be managed by SharePoint). These settings can be manually controlled through central administration, or configured in this resource. The settings relate to email notifications of when passwords are reset, as well as behavior when a reset

Examples

Example 1

This example sets the password change settings for managed accounts in the local farm

Configuration Example
{
    param
    (
        [Parameter(Mandatory = $true)]
        [PSCredential]
        $SetupAccount
    )

    Import-DscResource -ModuleName SharePointDsc

    node localhost
    {
        SPPasswordChangeSettings ManagedAccountPasswordResetSettings
        {
            IsSingleInstance              = "Yes"
            MailAddress                   = "[email protected]"
            DaysBeforeExpiry              = "14"
            PasswordChangeWaitTimeSeconds = "60"
            NumberOfRetries               = "3"
            PsDscRunAsCredential          = $SetupAccount
        }
    }
}