< Back

Get-DbaDbRoleMember

Mon Jan 13, 2020 10:54 am

NAME Get-DbaDbRoleMember



SYNOPSIS

Get members of database roles for each instance(s) of SQL Server.





SYNTAX

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

[[-SqlCredential] <Pscredential>] [[-Database] <System.String[]>] [[-ExcludeDatabase] <System.String[]>] [[-Role]

<System.String[]>] [[-ExcludeRole] <System.String[]>] [-ExcludeFixedRole <Switch>] [-IncludeSystemUser <Switch>]

[[-InputObject] <System.Object[]>] [-EnableException <Switch>] [<CommonParameters>]





DESCRIPTION

The Get-DbaDbRoleMember returns connected SMO object for database roles for each instance(s) of SQL Server.





PARAMETERS

-Database [<System.String[]>]

The database(s) to process. This list is 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.String[]>]

The database(s) to exclude. This list is auto-populated from the server.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-ExcludeFixedRole [<Switch>]

Excludes all members of fixed roles.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-ExcludeRole [<System.String[]>]

The role(s) to exclude.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-IncludeSystemUser [<Switch>]

Includes system users. By default system users are not included.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-InputObject [<System.Object[]>]

Enables piped input from Get-DbaDbRole or Get-DbaDatabase



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Role [<System.String[]>]

The role(s) to process. If unspecified, all roles will be processed.



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. This can be a collection and receive pipeline input to allow the

function to be executed against multiple SQL Server 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: Role, Database, Security, Login

Author: Klaas Vandenberghe (@PowerDBAKlaas)



Website: https://dbatools.io

Copyright: (c) 2018 by dbatools, licensed under MIT

License: MIT https://opensource.org/licenses/MIT



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



PS C:\\>Get-DbaDbRoleMember -SqlInstance localhost



Returns all members of all database roles on the local default SQL Server instance

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



PS C:\\>Get-DbaDbRoleMember -SqlInstance localhost, sql2016



Returns all members of all database roles on the local and sql2016 SQL Server instances

-------------------------- EXAMPLE 3 --------------------------



PS C:\\>$servers = Get-Content C:\\servers.txt



PS C:\\> $servers | Get-DbaDbRoleMember



Returns all members of all database roles for every server in C:\\servers.txt

-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Get-DbaDbRoleMember -SqlInstance localhost -Database msdb



Returns non-system members of all roles in the msdb database on localhost.

-------------------------- EXAMPLE 5 --------------------------



PS C:\\>Get-DbaDbRoleMember -SqlInstance localhost -Database msdb -IncludeSystemUser -ExcludeFixedRole



Returns all members of non-fixed roles in the msdb database on localhost.

-------------------------- EXAMPLE 6 --------------------------



PS C:\\>Get-DbaDbRoleMember -SqlInstance localhost -Database msdb -Role 'db_owner'



Returns all members of the db_owner role in the msdb database on localhost.

-------------------------- EXAMPLE 7 --------------------------



PS C:\\>$roles = Get-DbaDbRole -SqlInstance localhost -Database msdb -Role 'db_owner'



PS C:\\> $roles | Get-DbaDbRoleMember



Returns all members of the db_owner role in the msdb database on localhost.



RELATED LINKS

https://dbatools.io/Get-DbaDbRoleMember