en-US/about_SPProductUpdate.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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
.NAME
    SPProductUpdate

# Description
    
    This resource is used to perform the update step of installing SharePoint
    updates, like Cumulative Updates and Service Packs. The SetupFile parameter
    should point to the update file. The ShutdownServices parameter is used to
    indicate if some services (Timer, Search and IIS services) have to be stopped
    before installation of the update. This will speed up the installation. The
    BinaryInstallDays and BinaryInstallTime parameters specify a window in which
    the update can be installed. This module requires the Configuration Wizard
    resource to fully complete the installation of the update, which can be done
    through the use of SPConfigWizard.
    
    NOTE:
    When files are downloaded from the Internet, a Zone.Identifier alternate data
    stream is added to indicate that the file is potentially from an unsafe source.
    To use these files, make sure you first unblock them using Unblock-File.
    SPProductUpdate will throw an error when it detects the file is blocked.
    
    IMPORTANT:
    This resource retrieves build information from the Configuration Database.
    Therefore it requires SharePoint to be installed and a farm created. If you
    like to deploy a new farm and install updates automatically, you need to
    implement the following order:
    
    1. Install the SharePoint Binaries (SPInstall)
    2. (Optional) Install SharePoint Language Pack(s) Binaries
       (SPInstallLanguagePack)
    3. Create SPFarm (SPFarm)
    4. Install Cumulative Updates (SPProductUpdate)
    5. Run the Configuration Wizard (SPConfigWizard)
    
.PARAMETER SetupFile
    Key - String
    The name of the update setup file

.PARAMETER ShutdownServices
    Write - Boolean
    Shutdown SharePoint services to speed up installation

.PARAMETER BinaryInstallDays
    Write - String
    Allowed values: mon, tue, wed, thu, fri, sat, sun
    Specify on which dates the installation is allowed

.PARAMETER BinaryInstallTime
    Write - String
    Specify in which time frame the installation is allowed

.PARAMETER Ensure
    Write - string
    Allowed values: Present, Absent
    Present to install SharePoint. Absent is currently not supported

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


.EXAMPLE
    This example installs the Cumulative Update only in the specified window.
    It also shuts down services to speed up the installation process.


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

        node localhost {
            SPProductUpdate InstallCUMay2016
            {
                SetupFile            = "C:\Install\CUMay2016\ubersrv2013-kb3115029-fullfile-x64-glb.exe"
                ShutdownServices     = $true
                BinaryInstallDays    = "sat", "sun"
                BinaryInstallTime    = "12:00am to 2:00am"
                Ensure               = "Present"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example installs the SharePoint 2013 Service Pack only in the specified window.
    It also shuts down services to speed up the installation process.


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

        node localhost {
            SPProductUpdate InstallCUMay2016
            {
                SetupFile            = "C:\Install\SP2013SP1\officeserversp2013-kb2880552-fullfile-x64-en-us.exe"
                ShutdownServices     = $true
                BinaryInstallDays    = "sat", "sun"
                BinaryInstallTime    = "12:00am to 2:00am"
                Ensure               = "Present"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }


.EXAMPLE
    This example installs the SharePoint 2013 Dutch Language Pack Service Pack only in the specified window.
    It also shuts down services to speed up the installation process.


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

        node localhost {
            SPProductUpdate InstallCUMay2016
            {
                SetupFile            = "C:\Install\SP2013-LP_NL-SP1\serverlpksp2013-kb2880554-fullfile-x64-nl-nl.exe"
                ShutdownServices     = $true
                BinaryInstallDays    = "sat", "sun"
                BinaryInstallTime    = "12:00am to 2:00am"
                Ensure               = "Present"
                PsDscRunAsCredential = $SetupAccount
            }
        }
    }