functions/Get-DbaRoleMember.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
161
162
163
164
165
166
167
Function Get-DbaRoleMember
{
<#
.SYNOPSIS
Get members of all roles on a Sql instance.
 
.DESCRIPTION
Get members of all roles on a Sql instance.
 
Default output includes columns SQLServer, Database, Role, Member.
 
.PARAMETER SQLInstance
The SQL Server that you're connecting to.
 
.PARAMETER SqlCredential
Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted. To use:
 
$scred = Get-Credential, then pass $scred object to the -SqlCredential parameter.
 
SQL Server does not accept Windows credentials being passed as credentials. To connect as a different Windows user, run PowerShell as that user.
 
.PARAMETER IncludeServerLevel
Shows also information on Server Level Permissions.
 
.PARAMETER NoFixedRole
Excludes all members of fixed roles.
 
.PARAMETER Credential
Credential object used to connect to the SQL Server as a different user.
 
.NOTES
Author: Klaas Vandenberghe ( @PowerDBAKlaas )
 
dbatools PowerShell module (https://dbatools.io)
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/.
 
.LINK
 https://dbatools.io/Get-DbaRoleMember
 
.EXAMPLE
Get-DbaRoleMember -SqlServer ServerA
 
Returns a custom object displaying SQLServer, Database, Role, Member for all DatabaseRoles.
 
.EXAMPLE
Get-DbaRoleMember -SqlServer sql2016 | Out-Gridview
 
Returns a gridview displaying SQLServer, Database, Role, Member for all DatabaseRoles.
 
.EXAMPLE
Get-DbaRoleMember -SqlServer ServerA\sql987 -IncludeServerLevel
 
Returns a gridview displaying SQLServer, Database, Role, Member for both ServerRoles and DatabaseRoles.
 
#>

[CmdletBinding()]
Param (
[parameter(Mandatory = $true, ValueFromPipeline = $true)]
[Alias("SqlServer", "Server", "Instance")]
[string[]]$SqlInstance,
[PsCredential]$SqlCredential,
[switch]$IncludeServerLevel,
[switch]$NoFixedRole
)

DynamicParam
{
if ($SqlInstance)
{
Get-ParamSqlDatabases -SqlServer $SqlInstance[0] -SqlCredential $Credential
}
}

BEGIN
{
$databases = $psboundparameters.Databases
}

PROCESS
{
foreach ($instance in $sqlinstance)
{
Write-Verbose "Connecting to $Instance"
try
{
$server = Connect-SqlServer -SqlServer $Instance -SqlCredential $sqlcredential
}
catch
{
Write-Warning "Failed to connect to $Instance"
continue
}

if ($IncludeServerLevel)
{
Write-Verbose "Server Role Members included"
$instroles = $null
Write-Verbose "Getting Server Roles on $instance"
$instroles = $server.roles
if ($NoFixedRole)
{
$instroles = $instroles | Where-Object { $_.isfixedrole -eq $false }
}
ForEach ($instrole in $instroles)
{
Write-Verbose "Getting Server Role Members for $instrole on $instance"
$irmembers = $null
$irmembers = $instrole.enumserverrolemembers()
ForEach ($irmem in $irmembers)
{
[PSCustomObject]@{
SQLInstance = $instance
Database = $null
Role = $instrole.name
Member = $irmem.tostring()
}
}
}
}

$dbs = $server.Databases

if ($databases.count -gt 0)
{
$dbs = $dbs | Where-Object { $databases -contains $_.Name }
}

foreach ($db in $dbs)
{
Write-Verbose "Checking accessibility of $db on $instance"

if ($db.IsAccessible -ne $true)
{
Write-Warning "Database $db on $instance is not accessible"
continue
}

$dbroles = $db.roles
Write-Verbose "Getting Database Roles for $db on $instance"

if ($NoFixedRole)
{
$dbroles = $dbroles | Where-Object { $_.isfixedrole -eq $false }
}

foreach ($dbrole in $dbroles)
{
Write-Verbose "Getting Database Role Members for $dbrole in $db on $instance"
$dbmembers = $dbrole.enummembers()
ForEach ($dbmem in $dbmembers)
{
[PSCustomObject]@{
SqlInstance = $instance
Database = $db.name
Role = $dbrole.name
Member = $dbmem.tostring()
}
}
}
}
}
}
}