functions/Watch-DbaDbLogin.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
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
208
209
210
211
212
213
function Watch-DbaDbLogin {
    <#
        .SYNOPSIS
            Tracks SQL Server logins: which host they came from, what database they're using, and what program is being used to log in.
 
        .DESCRIPTION
            Watch-DbaDbLogin uses SQL Server process enumeration to track logins in a SQL Server table. This is helpful when you need to migrate a SQL Server and update connection strings, but have inadequate documentation on which servers/applications are logging into your SQL instance.
 
            Running this script every 5 minutes for a week should give you a sufficient idea about database and login usage.
 
        .PARAMETER SqlInstance
            The SQL Server that stores the Watch database.
 
        .PARAMETER SqlCms
            Specifies a Central Management Server to query for a list of servers to watch.
 
        .PARAMETER SqlCmsGroups
            This is an auto-populated array that contains your Central Management Server top-level groups. You can use one or many groups.
 
            If -SqlCmsGroups is not specified, the Watch-DbaDbLogin script will run against all servers in your Central Management Server.
 
        .PARAMETER ServersFromFile
            Specifies a file containing a list of servers to watch. This file must contain one server name per line.
 
        .PARAMETER Database
            The name of the Watch database. By default, this is DatabaseLogins.
 
        .PARAMETER Table
            The name of the Watch table. By default, this is DbLogins.
 
        .PARAMETER SqlCredential
   Allows you to login to servers using SQL Logins instead of Windows Authentication (AKA Integrated or Trusted). To use:
 
   $scred = Get-Credential, then pass $scred object to the -SqlCredential parameter.
 
   Windows Authentication will be used if SqlCredential is not specified. SQL Server does not accept Windows credentials being passed as credentials.
 
   To connect as a different Windows user, run PowerShell as that user.
 
        .NOTES
            Tags: Logins
            Author: Chrissy LeMaire (@cl), netnerds.net
            Requires: sysadmin access on all SQL Servers for the most accurate results
 
            Website: https://dbatools.io
            Copyright: (C) Chrissy LeMaire, clemaire@gmail.com
            License: GNU GPL v3 https://opensource.org/licenses/GPL-3.0
 
        .LINK
            https://dbatools.io/Watch-DbaDbLogin
 
        .EXAMPLE
            Watch-DbaDbLogin -SqlInstance sqlserver -SqlCms SqlCms1
 
            A list of all database instances within the Central Management Server SqlCms1 is generated. Using this list, the script enumerates all the processes and gathers login information and saves it to the table Dblogins in the DatabaseLogins database on SQL Server sqlserver.
 
        .EXAMPLE
            Watch-DbaDbLogin -SqlInstance sqlcluster -Database CentralAudit -ServersFromFile .\sqlservers.txt
 
            A list of servers is gathered from the file sqlservers.txt in the current directory. Using this list, the script enumerates all the processes and gathers login information and saves it to the table Dblogins in the CentralAudit database on SQL Server sqlcluster.
 
        .EXAMPLE
            Watch-DbaDbLogin -SqlInstance sqlserver -SqlCms SqlCms1 -SqlCmsGroups SQL2014Clusters -SqlCredential $cred
 
            A list of servers is generated using database instance names within the SQL2014Clusters group on the Central Management Server SqlCms1. Using this list, the script enumerates all the processes and gathers login information and saves it to the table Dblogins in the DatabaseLogins database on sqlserver.
 
    #>

    [CmdletBinding(DefaultParameterSetName = "Default")]
    Param (
        [parameter(Mandatory = $true)]
        [Alias("ServerInstance", "SqlServer")]
        [DbaInstanceParameter]$SqlInstance,
        [string]$Database = "DatabaseLogins",
        [string]$Table = "DbLogins",
        [PSCredential]$SqlCredential,
        # Central Management Server

        [string]$SqlCms,
        # File with one server per line

        [string]$ServersFromFile
    )

    process {
        if ([string]::IsNullOrEmpty($SqlCms) -and [string]::IsNullOrEmpty($ServersFromFile)) {
            throw "You must specify a server list source using -SqlCms or -ServersFromFile"
        }

        <#
   Setup datatable & bulk copy
  #>


        if ($sqlcredential.UserName) {
            $username = $sqlcredential.Username
            $password = $SqlCredential.GetNetworkCredential().Password
            $connectionstring = "Data Source=$SqlInstance;Initial Catalog=$Database;User Id=$username;Password=$password;"
        }
        else { $connectionstring = "Data Source=$SqlInstance;Integrated Security=true;Initial Catalog=$Database;" }


        $bulkcopy = New-Object ("Data.SqlClient.Sqlbulkcopy") $connectionstring
        $bulkcopy.DestinationTableName = $Table

        $datatable = New-Object "System.Data.DataTable"
        $null = $datatable.Columns.Add("SQLServer")
        $null = $datatable.Columns.Add("Loginname")
        $null = $datatable.Columns.Add("Host")
        $null = $datatable.Columns.Add("Dbname")
        $null = $datatable.Columns.Add("Program")

        $systemdbs = "master", "msdb", "model", "tempdb"
        $excludedPrograms = "Microsoft SQL Server Management Studio - Query", "SQL Management"

        <#
   Get servers to query from Central Management Server or File
  #>

        $servers = @()
        if ($SqlCms) {
            $server = New-Object Microsoft.SqlServer.Management.Smo.Server $SqlCms
            $sqlconnection = $server.ConnectionContext.SqlConnectionObject

            try { $cmstore = New-Object Microsoft.SqlServer.Management.RegisteredServers.RegisteredServersStore($sqlconnection) }
            catch { throw "Cannot access Central Management Server" }

            if ($SqlCmsGroups) {
                foreach ($groupname in $SqlCmsGroups) {
                    $CMS = $cmstore.ServerGroups["DatabaseEngineServerGroup"].ServerGroups[$groupname]
                    $servers += ($cms.GetDescendantRegisteredServers()).servername
                }
            }
            else {
                $CMS = $cmstore.ServerGroups["DatabaseEngineServerGroup"]
                $servers = ($cms.GetDescendantRegisteredServers()).servername
                if ($servers -notcontains $SqlCms) { $servers += $SqlCms }
            }
        }

        If ($ServersFromFile) {
            $servers = Get-Content $ServersFromFile
        }

        <#
   Process each server
  #>


        foreach ($servername in $servers) {
            Write-Output "Attempting to connect to $servername."
            try { $server = Connect-SqlInstance -SqlInstance $servername -SqlCredential $SqlCredential }
            catch { Write-Error "Can't connect to $servername. Skipping."; continue }

            if (!(Test-SqlSa $server)) { Write-Warning "Not a sysadmin on $servername, resultset would be underwhelming. Skipping."; continue }


            $procs = $server.EnumProcesses() | Where-Object { $_.Host -ne $sourceserver.ComputerNamePhysicalNetBIOS -and ![string]::IsNullOrEmpty($_.Host) }
            $procs = $procs | Where-Object { $systemdbs -notcontains $_.Database -and $excludedPrograms -notcontains $_.Program } | Select-Object Login, Host, Database, Program

            foreach ($p in $procs) {
                $row = $datatable.NewRow()
                $row.itemarray = $server.name, $p.Login, $p.Host, $p.Database, $p.Program
                $datatable.Rows.Add($row)
            }
            $server.ConnectionContext.Disconnect()
            Write-Output "Added process information for $servername to datatable."
        }

        <#
   Write to $Table in $Database on $SqlInstance
  #>


        try {
            $bulkcopy.WriteToServer($datatable)
            if ($datatable.rows.count -eq 0) {
                Write-Warning "Nothing done."
            }
            $bulkcopy.Close()
            Write-Output "Updated $Table in $Database on $SqlInstance with $($datatable.rows.count) rows."
        }
        catch { Write-Error "Could not update $Table in $Database on $SqlInstance. Do the database and table exist and do you have access?" }

    }

    end {
        Write-Output "Script completed"
        Test-DbaDeprecation -DeprecatedOn "1.0.0" -Silent:$false -Alias Watch-SqlDbLogin
    }
    <#
 ---- SQL database and table ----
 
  CREATE DATABASE DatabaseLogins
  GO
  USE DatabaseLogins
  GO
   CREATE TABLE [dbo].[DbLogins](
   [SQLServer] varchar(128),
   [LoginName] varchar(128),
   [Host] varchar(128),
   [DbName] varchar(128),
   [Program] varchar(256),
   [Timestamp] datetime default getdate(),
  )
 -- Create Unique Clustered Index with IGNORE_DUPE_KEY=ON to avoid duplicates
  CREATE UNIQUE CLUSTERED INDEX [ClusteredIndex-Combo] ON [dbo].[DbLogins]
   (
   [SQLServer] ASC,
   [LoginName] ASC,
   [Host] ASC,
   [DbName] ASC,
   [Program] ASC
  ) WITH (IGNORE_DUP_KEY = ON)
  GO
 #>

}