commands

^

Get-DbaDbRole

Author Ben Miller (@DBAduck)
Availability Windows, Linux, macOS

 

Synopsis

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

Description

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

Syntax

Get-DbaDbRole
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <String[]>]
    [[-ExcludeDatabase] <String[]>]
    [[-Role] <String[]>]
    [[-ExcludeRole] <String[]>]
    [-ExcludeFixedRole]
    [[-InputObject] <Database[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaDbRole -SqlInstance localhost

Returns all database roles in all databases on the local default SQL Server instance

Example: 2
PS C:\> Get-DbaDbRole -SqlInstance localhost, sql2016

Returns all roles of all database(s) on the local and sql2016 SQL Server instances

Example: 3
PS C:\> $servers = Get-Content C:\servers.txt
PS C:\> $servers | Get-DbaDbRole

Returns roles of all database(s) for every server in C:\servers.txt

Example: 4
PS C:\> Get-DbaDbRole -SqlInstance localhost -Database msdb

Returns roles of the database msdb on localhost.

Example: 5
PS C:\> Get-DbaDbRole -SqlInstance localhost -Database msdb -ExcludeFixedRole

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

Example: 6
PS C:\> Get-DbaDbRole -SqlInstance localhost -Database msdb -Role 'db_owner'

Returns the db_owner role in the msdb database on localhost.

Optional Parameters

-SqlInstance

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.

Alias
Required False
Pipeline true (ByValue)
Default Value
-SqlCredential

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.

Alias
Required False
Pipeline false
Default Value
-Database

The database(s) to process. This list is auto-populated from the server. If unspecified, all databases will be processed.

Alias
Required False
Pipeline false
Default Value
-ExcludeDatabase

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

Alias
Required False
Pipeline false
Default Value
-Role

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

Alias
Required False
Pipeline false
Default Value
-ExcludeRole

The role(s) to exclude.

Alias
Required False
Pipeline false
Default Value
-ExcludeFixedRole

Excludes all fixed roles.

Alias
Required False
Pipeline false
Default Value False
-InputObject

Enables piped input from Get-DbaDatabase

Alias
Required False
Pipeline true (ByValue)
Default Value
-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.

Alias
Required False
Pipeline false
Default Value False

 

Want to see the source code for this command? Check out Get-DbaDbRole on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaDbRole.