functions/Test-DbaDatabaseOwner.ps1

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
function Test-DbaDatabaseOwner
{
<#
.SYNOPSIS
Checks database owners against a login to validate which databases do not match that owner.
 
.DESCRIPTION
This function will check all databases on an instance against a SQL login to validate if that
login owns those databases or not. By default, the function will check against 'sa' for
ownership, but the user can pass a specific login if they use something else. Only databases
that do not match this ownership will be displayed, but if the -Detailed switch is set all
databases will be shown.
 
Best Practice reference: http://weblogs.sqlteam.com/dang/archive/2008/01/13/Database-Owner-Troubles.aspx
  
.NOTES
Original Author: Michael Fal (@Mike_Fal), http://mikefal.net
 
dbatools PowerShell module (https://dbatools.io, clemaire@gmail.com)
Copyright (C) 2016 Chrissy LeMaire
 
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
 
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
 
.PARAMETER SqlServer
SQLServer name or SMO object representing the SQL Server to connect to. This can be a
collection and recieve pipeline input
 
.PARAMETER SqlCredential
PSCredential object to connect under. If not specified, currend Windows login will be used.
 
.PARAMETER TargetLogin
Specific login that you wish to check for ownership. This defaults to 'sa' or the sysadmin name if sa was renamed.
 
.PARAMETER Detailed
Switch parameter. When declared, function will return all databases and whether or not they
match the declared owner.
 
.PARAMETER Datbases
Auto-populated list of databases to check.
  
.PARAMETER Exclude
Auto-populated list of databases to exclude from check.
 
.LINK
https://dbatools.io/Test-DbaDatabaseOwner
 
.EXAMPLE
Test-DbaDatabaseOwner -SqlServer localhost
 
Returns all databases where the owner does not match 'sa'.
 
.EXAMPLE
Test-DbaDatabaseOwner -SqlServer localhost -TargetLogin 'DOMAIN\account'
 
Returns all databases where the owner does not match 'DOMAIN\account'. Note
that TargetLogin must be a valid security principal that exists on the target server.
#>

[OutputType("System.Object[]")]
[CmdletBinding()]
Param (
[parameter(Mandatory = $true)]
[Alias("ServerInstance", "SqlInstance")]
[object[]]$SqlServer,
[System.Management.Automation.PSCredential]$SqlCredential,
[string]$TargetLogin,
[Switch]$Detailed
)
 DynamicParam { if ($SqlServer) { return Get-ParamSqlDatabases -SqlServer $SqlServer[0] -SqlCredential $SourceSqlCredential } }

BEGIN
{
$databases = $psboundparameters.Databases
$exclude = $psboundparameters.Exclude

#connect to the instance and set return array empty
$return = @()
}

PROCESS
{
foreach ($servername in $sqlserver)
{
Write-Verbose "Connecting to $servername"
$server = Connect-SqlServer $servername -SqlCredential $SqlCredential

# dynamic sa name for orgs who have changed their sa name
if ($psboundparameters.TargetLogin.length -eq 0)
{
$TargetLogin = ($server.logins | Where-Object { $_.id -eq 1 }).Name
}

#Validate login
if (($server.Logins.Name) -notcontains $TargetLogin)
{
if ($sqlserver.count -eq 1)
{
throw "Invalid login: $TargetLogin"
return $null
}
else
{
Write-Warning "$TargetLogin is not a valid login on $servername. Moving on."
Continue
}
}
#use online/available dbs
            $dbs = $server.Databases

            #filter database collection based on parameters
if ($Databases.Length -gt 0)
{
$dbs = $dbs | Where-Object { $databases -contains $_.Name }
}

if ($Exclude.Length -gt 0)
{
$dbs = $dbs | Where-Object { $Exclude -notcontains $_.Name }
}

#for each database, create custom object for return set.
foreach ($db in $dbs)
{
Write-Verbose "Checking $db"
$row = [ordered]@{
Server = $server.Name
Database = $db.Name
DBState = $db.Status
CurrentOwner = $db.Owner
TargetOwner = $TargetLogin
OwnerMatch = ($db.owner -eq $TargetLogin)
}

#add each custom object to the return array
$return += New-Object PSObject -Property $row
}
}
}

END
{
#return results
if ($Detailed)
{
Write-Verbose "Returning detailed results."
return $return
}
else
{
Write-Verbose "Returning default results."
return ($return | Where-Object { $_.OwnerMatch -eq $false })
}
}
}