functions/Get-DbaOrphanUser.ps1
|
#ValidationTags#Messaging,FlowControl,Pipeline,CodeStyle# function Get-DbaOrphanUser { <# .SYNOPSIS Get orphaned users. .DESCRIPTION An orphan user is defined by a user that does not have their matching login. (Login property = ""). .PARAMETER SqlInstance The target SQL Server instance or instances. .PARAMETER SqlCredential Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential) .PARAMETER Database Specifies the database(s) to process. Options for this list are auto-populated from the server. If unspecified, all databases will be processed. .PARAMETER ExcludeDatabase Specifies the database(s) to exclude from processing. Options for this list are auto-populated from the server .PARAMETER WhatIf If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run. .PARAMETER Confirm If this switch is enabled, you will be prompted for confirmation before executing any operations that change state. .PARAMETER EnableException By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch. .NOTES Tags: Orphan, Database, User, Security, Login Author: Claudio Silva (@ClaudioESSilva) | Garry Bargsley (@gbargsley) | Simone Bizzotto (@niphlod) Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT .LINK https://dbatools.io/Get-DbaOrphanUser .EXAMPLE PS C:\> Get-DbaOrphanUser -SqlInstance localhost\sql2016 Finds all orphan users without matching Logins in all databases present on server 'localhost\sql2016'. .EXAMPLE PS C:\> Get-DbaOrphanUser -SqlInstance localhost\sql2016 -SqlCredential $cred Finds all orphan users without matching Logins in all databases present on server 'localhost\sql2016'. SQL Server authentication will be used in connecting to the server. .EXAMPLE PS C:\> Get-DbaOrphanUser -SqlInstance localhost\sql2016 -Database db1 Finds orphan users without matching Logins in the db1 database present on server 'localhost\sql2016'. #> [CmdletBinding()] param ( [parameter(Mandatory, ValueFromPipeline)] [Alias("ServerInstance", "SqlServer")] [DbaInstanceParameter[]]$SqlInstance, [PSCredential]$SqlCredential, [Alias("Databases")] [object[]]$Database, [object[]]$ExcludeDatabase, [Alias('Silent')] [switch]$EnableException ) process { foreach ($instance in $SqlInstance) { try { $server = Connect-SqlInstance -SqlInstance $instance -SqlCredential $SqlCredential } catch { Write-Message -Level Warning -Message "Failed to connect to: $instance." continue } $DatabaseCollection = $server.Databases | Where-Object IsAccessible if ($Database) { $DatabaseCollection = $DatabaseCollection | Where-Object Name -In $Database } if ($ExcludeDatabase) { $DatabaseCollection = $DatabaseCollection | Where-Object Name -NotIn $ExcludeDatabase } if ($DatabaseCollection.Count -gt 0) { foreach ($db in $DatabaseCollection) { try { #if SQL 2012 or higher only validate databases with ContainmentType = NONE if ($server.versionMajor -gt 10) { if ($db.ContainmentType -ne [Microsoft.SqlServer.Management.Smo.ContainmentType]::None) { Write-Message -Level Warning -Message "Database '$db' is a contained database. Contained databases can't have orphaned users. Skipping validation." Continue } } Write-Message -Level Verbose -Message "Validating users on database '$db'." $UsersToWork = $db.Users | Where-Object { $_.Login -eq "" -and ($_.ID -gt 4) -and (($_.Sid.Length -gt 16 -and $_.LoginType -in @([Microsoft.SqlServer.Management.Smo.LoginType]::SqlLogin, [Microsoft.SqlServer.Management.Smo.LoginType]::Certificate)) -eq $false) } if ($UsersToWork.Count -gt 0) { Write-Message -Level Verbose -Message "Orphan users found" foreach ($user in $UsersToWork) { [PSCustomObject]@{ ComputerName = $server.ComputerName InstanceName = $server.ServiceName SqlInstance = $server.DomainInstanceName DatabaseName = $db.Name User = $user.Name } } } else { Write-Message -Level Verbose -Message "No orphan users found on database '$db'." } #reset collection $UsersToWork = $null } catch { Stop-Function -Message $_ -Continue } } } else { Write-Message -Level VeryVerbose -Message "There are no databases to analyse." } } } } |