en-US/about_SPInstall.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
.NAME
    SPInstall

# Description
    
    This resource is used to install the SharePoint binaries. The BinaryDir
    parameter should point to the path that setup.exe is located (not to setup.exe
    itself). The ProductKey parameter is used to inject in to the configuration
    file and validate the license key during the installation process. This module
    depends on the prerequisites already being installed, which can be done
    
    ## Installing from network locations
    
    If you wish to install SharePoint from a network location this can
    be done, however you must disable User Account Control (UAC) on the server
    to allow DSC to run the executable from a remote location, and also set
    the PsDscRunAsCredential value to run as an account with local admin
    permissions as well as read access to the network location.
    
    It is *not recommended* to disable UAC for security reasons. The recommended
    approach is to copy the installation media to the local nodes first and
    then execute the installation from there.
    
.PARAMETER BinaryDir
    Key - String
    The directory that contains all of the SharePoint binaries

.PARAMETER ProductKey
    Required - String
    The product key to use during the installation

.PARAMETER InstallPath
    Write - String
    The install directory to use in the installation, leave blank to use the setup defaults

.PARAMETER DataPath
    Write - String
    The data directory to use in the installation, leave blank to use the setup defaults

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


.EXAMPLE
    This module will install SharePoint to the default locations. The binaries for
    SharePoint in this scenario are stored at C:\SPInstall (so it will look to run
    C:\SPInstall\Setup.exe)


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

        node localhost {
            SPInstall InstallBinaries
            {
                BinaryDir  = "C:\SPInstall"
                ProductKey = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"
            }
        }
    }


.EXAMPLE
    This module will install SharePoint to the specific locations set for the
    InstallPath and DataPath directories. 


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

        node localhost {
            SPInstall InstallBinaries
            {
                BinaryDir   = "D:\SharePoint\Binaries"
                InstallPath = "D:\SharePoint\Install"
                DataPath    = "D:\SharePoint\Data"
                ProductKey  = "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"
            }
        }
    }


.EXAMPLE
    This module will install SharePoint Foundation 2013 to the local server


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

        node localhost {
            Package InstallSharePointFoundation
            {
                Ensure             = "Present"
                Name               = "Microsoft SharePoint Foundation 2013 Core"
                Path               = "E:\SharePoint2013\Setup.exe"
                Arguments          = "/config E:\SharePoint2013\files\setupfarmsilent\config.xml"
                ProductID          = "90150000-1014-0000-1000-0000000FF1CE"
                ReturnCode         = 0
            }
        }
    }