en-US/about_SPConfigWizard.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
.NAME
    SPConfigWizard

# Description
    
    **Type:** Utility
    
    This resource is used to perform the upgrade step of installing SharePoint
    updates, like Cumulative Updates, Service Packs and Language Packs. The
    DatabaseUpgradeDays and DatabaseUpgradeTime parameters specify a window in
    which the update can be installed. This module has to be used to complete the
    update installation step, performed by SPProductUpdate.
    
.PARAMETER Ensure
    Key - string
    Allowed values: Present, Absent
    Present to install SharePoint. Absent is currently not supported

.PARAMETER DatabaseUpgradeDays
    Write - String
    Allowed values: mon, tue, wed, thu, fri, sat, sun
    Specify on which dates running the Configuration Wizard is allowed

.PARAMETER DatabaseUpgradeTime
    Write - String
    Specify in which time frame running the Configuration Wizard is allowed

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


.EXAMPLE
    This example runs the Configuration Wizard as soon as it is applied.


    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPConfigWizard RunConfigWizard
            {
                Ensure               = "Present"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example only runs the Configuration Wizard in the specified window:
    - Saturday and Sunday night between 3am and 5am.


    Configuration Example 
    {
        param(
            [Parameter(Mandatory = $true)]
            [PSCredential]
            $SetupAccount
        )
        Import-DscResource -ModuleName SharePointDsc

        node localhost {
            SPConfigWizard RunConfigWizard
            {
                Ensure               = "Present"
                DatabaseUpgradeDays  = "sat", "sun"
                DatabaseUpgradeTime  = "3:00am to 5:00am"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }