< Back

Get-DbaDbOrphanUser

Mon Jan 13, 2020 10:50 am

NAME Get-DbaDbOrphanUser



SYNOPSIS

Get orphaned users.





SYNTAX

Get-DbaDbOrphanUser [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]

<Pscredential>] [[-Database] <System.Object[]>] [[-ExcludeDatabase] <System.Object[]>] [-EnableException <Switch>]

[<CommonParameters>]





DESCRIPTION

An orphan user is defined by a user that does not have their matching login. (Login property = "").





PARAMETERS

-Database [<System.Object[]>]

Specifies the database(s) to process. Options for this list are auto-populated from the server. If

unspecified, all databases will be processed.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-EnableException [<Switch>]

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.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-ExcludeDatabase [<System.Object[]>]

Specifies the database(s) to exclude from processing. Options for this list are auto-populated from the server



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-SqlCredential [<Pscredential>]

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).



Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory -

Integrated are all supported.



For MFA support, please use Connect-DbaInstance.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]

The target SQL Server instance or instances.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



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



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-DbaDbOrphanUser -SqlInstance localhost\\sql2016



Finds all orphan users without matching Logins in all databases present on server 'localhost\\sql2016'.

-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-DbaDbOrphanUser -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 3 --------------------------



PS C:\\>Get-DbaDbOrphanUser -SqlInstance localhost\\sql2016 -Database db1



Finds orphan users without matching Logins in the db1 database present on server 'localhost\\sql2016'.



RELATED LINKS

https://dbatools.io/Get-DbaDbOrphanUser