en-US/about_SPManagedAccount.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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
.NAME
    SPManagedAccount

# Description
    
    **Type:** Distributed
    
    This resource will ensure a managed account is provisioned in to the SharePoint
    farm. The Account object specific the credential to store (including username
    and password) to set as the managed account. The settings for
    EmailNotification, PreExpireDays and Schedule all relate to enabling automatic
    password change for the managed account, leaving these option out of the
    resource will ensure that no automatic password changing from SharePoint occurs.
    
    The default value for the Ensure parameter is Present. When not specifying this
    parameter, the managed account is created.
    
.PARAMETER AccountName
    Key - string
    The username of the account

.PARAMETER Account
    Write - String
    The credential with password of the account

.PARAMETER EmailNotification
    Write - Uint32
    How many days before a password change should an email be sent

.PARAMETER PreExpireDays
    Write - Uint32
    How many days before a password expires should it be changed

.PARAMETER Schedule
    Write - string
    What is the schedule for the password reset

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present ensures managed account exists, absent ensures it is removed

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


.EXAMPLE
    This example shows how to create a new managed account in a local farm.


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

            [Parameter(Mandatory = $true)]
            [PSCredential]
            $ManagedAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPManagedAccount NewManagedAccount
            {
                AccountName          = $ManagedAccount.UserName
                Account              = $ManagedAccount
                Ensure               = "Present"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example shows how to create a new managed account in a local farm, using
    the automatic password change schedule


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

            [Parameter(Mandatory = $true)]
            [PSCredential]
            $ManagedAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPManagedAccount NewManagedAccount
            {
                AccountName          = $ManagedAccount.UserName
                Account              = $ManagedAccount
                Ensure               = "Present"
                Schedule             = "monthly between 7 02:00:00 and 7 03:00:00" 
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }