en-US/about_SPPasswordChangeSettings.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
.NAME
    SPPasswordChangeSettings

# Description
    
    **Type:** Distributed
    
    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
    
.PARAMETER MailAddress
    key - string
    The email address to send notifications of password changes to

.PARAMETER DaysBeforeExpiry
    Write - Uint32
    The number of days before password expiry to send send emails

.PARAMETER PasswordChangeWaitTimeSeconds
    Write - Uint32
    The duration that a password reset will wait for before it times out

.PARAMETER NumberOfRetries
    Write - Uint32
    How many retries if the password change fails

.PARAMETER InstallAccount
    Write - String
    POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5


.EXAMPLE
    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
            {
                MailAddress                   = "sharepoint`@contoso.com"
                DaysBeforeExpiry              = "14"
                PasswordChangeWaitTimeSeconds = "60"
                NumberOfRetries               = "3"
                PsDscRunAsCredential          = $SetupAccount
            }
        }
    }