< Back

Remove-DbaDbRole

Mon Jan 13, 2020 1:20 pm

NAME Remove-DbaDbRole



SYNOPSIS

Removes a database role from database(s) for each instance(s) of SQL Server.





SYNTAX

Remove-DbaDbRole [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]

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

[[-ExcludeRole] <System.String[]>] [-IncludeSystemDbs <Switch>] [[-InputObject] <System.Object[]>]

[-EnableException <Switch>] [<CommonParameters>]





DESCRIPTION

The Remove-DbaDbRole removes role(s) from database(s) 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



-ExcludeRole [<System.String[]>]

The role(s) to exclude.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-IncludeSystemDbs [<Switch>]

If this switch is enabled, roles can be removed from system databases.



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: Ben Miller (@DBAduck)



Website: https://dbatools.io

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

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



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



PS C:\\>Remove-DbaDbRole -SqlInstance localhost -Database dbname -Role "customrole1", "customrole2"



Removes roles customrole1 and customrole2 from the database dbname on the local default SQL Server instance

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



PS C:\\>Remove-DbaDbRole -SqlInstance localhost, sql2016 -Database db1, db2 -Role role1, role2, role3



Removes role1,role2,role3 from db1 and db2 on the local and sql2016 SQL Server instances

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



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



PS C:\\> $servers | Remove-DbaDbRole -Database db1, db2 -Role role1



Removes role1 from db1 and db2 on the servers in C:\\servers.txt

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



PS C:\\>$roles = Get-DbaDbRole -SqlInstance localhost, sql2016 -Database db1, db2 -Role role1, role2, role3



PS C:\\> $roles | Remove-DbaDbRole



Removes role1,role2,role3 from db1 and db2 on the local and sql2016 SQL Server instances



RELATED LINKS

https://dbatools.io/Remove-DbaDbRole