Modules/SharePointDsc.Farm/SPFarm.psm1

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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
<#
 
.SYNOPSIS
 
Get-SPDSCConfigDBStatus is used to determine the state of a configuration database
 
.DESCRIPTION
 
Get-SPDSCConfigDBStatus will determine two things - firstly, if the config database
exists, and secondly if the user executing the script has appropriate permissions
to the instance to create the database. These values are used by the SPFarm resource
to determine what actions to take in it's set method.
 
.PARAMETER SQLServer
 
The name of the SQL server to check against
 
.PARAMETER Database
 
The name of the database to validate as the configuration database
 
.EXAMPLE
 
Get-SPDSCConfigDBStatus -SQLServer sql.contoso.com -Database SP_Config
 
#>

function Get-SPDSCConfigDBStatus
{
    param(
        [Parameter(Mandatory = $true)]
        [String]
        $SQLServer,

        [Parameter(Mandatory = $true)]
        [String]
        $Database
    )

    $connection = New-Object -TypeName "System.Data.SqlClient.SqlConnection"
    $connection.ConnectionString = "Server=$SQLServer;Integrated Security=SSPI;Database=Master"
    $command = New-Object -TypeName "System.Data.SqlClient.SqlCommand"

    try 
    {
        $currentUser = ([Security.Principal.WindowsIdentity]::GetCurrent()).Name
        $connection.Open()
        $command.Connection = $connection

        $command.CommandText = "SELECT COUNT(*) FROM sys.databases WHERE name = '$Database'"
        $configDBexists = ($command.ExecuteScalar() -eq 1)

        $command.CommandText = "SELECT COUNT(*) FROM sys.databases WHERE name = '$($Database)_Lock'"
        $lockExists = ($command.ExecuteScalar() -eq 1)

        $serverRolesToCheck = @("dbcreator", "securityadmin")
        $hasPermissions = $true
        foreach ($serverRole in $serverRolesToCheck)
        {
            $command.CommandText = "SELECT IS_SRVROLEMEMBER('$serverRole')"
            if ($command.ExecuteScalar() -eq "0")
            {
                Write-Verbose -Message "$currentUser does not have '$serverRole' role on server '$SQLServer'"
                $hasPermissions = $false
            }
        }

        return @{
            DatabaseExists = $configDBexists
            ValidPermissions = $hasPermissions
            Locked = $lockExists
        }
    }
    finally
    {
        if ($connection.State -eq "Open") 
        {
            $connection.Close()
            $connection.Dispose()
        }
    }
}

<#
 
.SYNOPSIS
 
Add-SPDSCConfigDBLock is used to create a lock to tell other servers that the
config DB is currently provisioning
 
.DESCRIPTION
 
Add-SPDSCConfigDBLock will create an empty database with the same name as the
config DB but suffixed with "_Lock". The presences of this database will
indicate to other servers that the config database is in the process of being
provisioned as the database is removed at the end of the process.
 
.PARAMETER SQLServer
 
The name of the SQL server to check against
 
.PARAMETER Database
 
The name of the database to validate as the configuration database
 
.EXAMPLE
 
Add-SPDSCConfigDBLock -SQLServer sql.contoso.com -Database SP_Config
 
#>

function Add-SPDSCConfigDBLock
{
    param(
        [Parameter(Mandatory = $true)]
        [String]
        $SQLServer,

        [Parameter(Mandatory = $true)]
        [String]
        $Database
    )

    Write-Verbose -Message "Creating lock database $($Database)_Lock"

    $connection = New-Object -TypeName "System.Data.SqlClient.SqlConnection"
    $connection.ConnectionString = "Server=$SQLServer;Integrated Security=SSPI;Database=Master"
    $command = New-Object -TypeName "System.Data.SqlClient.SqlCommand"

    try 
    {
        $connection.Open()
        $command.Connection = $connection

        $command.CommandText = "CREATE DATABASE [$($Database)_Lock]"
        $command.ExecuteNonQuery()
    }
    finally
    {
        if ($connection.State -eq "Open") 
        {
            $connection.Close()
            $connection.Dispose()
        }
    }
}

<#
 
.SYNOPSIS
 
Remove-SPDSCConfigDBLock is used to create a lock to tell other servers that the
config DB is currently provisioning
 
.DESCRIPTION
 
Remove-SPDSCConfigDBLock will cremove the lock database created by the
Add-SPDSCConfigDBLock command.
 
.PARAMETER SQLServer
 
The name of the SQL server to check against
 
.PARAMETER Database
 
The name of the database to validate as the configuration database
 
.EXAMPLE
 
Remove-SPDSCConfigDBLock -SQLServer sql.contoso.com -Database SP_Config
 
#>

function Remove-SPDSCConfigDBLock
{
    param(
        [Parameter(Mandatory = $true)]
        [String]
        $SQLServer,

        [Parameter(Mandatory = $true)]
        [String]
        $Database
    )

    Write-Verbose -Message "Removing lock database $($Database)_Lock"

    $connection = New-Object -TypeName "System.Data.SqlClient.SqlConnection"
    $connection.ConnectionString = "Server=$SQLServer;Integrated Security=SSPI;Database=Master"
    $command = New-Object -TypeName "System.Data.SqlClient.SqlCommand"

    try 
    {
        $connection.Open()
        $command.Connection = $connection

        $command.CommandText = "DROP DATABASE [$($Database)_Lock]"
        $command.ExecuteNonQuery()
    }
    finally
    {
        if ($connection.State -eq "Open") 
        {
            $connection.Close()
            $connection.Dispose()
        }
    }
}