< Back
Add-DbaDbRoleMember
Post
NAME Add-DbaDbRoleMember
SYNOPSIS
Adds a Database User to a database role for each instance(s) of SQL Server.
SYNTAX
Add-DbaDbRoleMember [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-Database] <System.String[]>] [[-Role] <System.String[]>] [-User]
<System.String[]> [[-InputObject] <System.Object[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
The Add-DbaDbRoleMember adds users in a database to a database role or 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
-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.
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
-User [<System.String[]>]
The user(s) to add to role(s) specified.
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:\\>Add-DbaDbRoleMember -SqlInstance localhost -Database mydb -Role db_owner -User user1
Adds user1 to the role db_owner in the database mydb on the local default SQL Server instance
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Add-DbaDbRoleMember -SqlInstance localhost, sql2016 -Role SqlAgentOperatorRole -User user1 -Database msdb
Adds user1 in servers localhost and sql2016 in the msdb database to the SqlAgentOperatorRole
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>$servers = Get-Content C:\\servers.txt
PS C:\\> $servers | Add-DbaDbRoleMember -Role SqlAgentOperatorRole -User user1 -Database msdb
Adds user1 to the SqlAgentOperatorROle in the msdb database in every server in C:\\servers.txt
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Add-DbaDbRoleMember -SqlInstance localhost -Role "db_datareader","db_datawriter" -User user1 -Database
DEMODB
Adds user1 in the database DEMODB on the server localhost to the roles db_datareader and db_datawriter
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>$roles = Get-DbaDbRole -SqlInstance localhost -Role "db_datareader","db_datawriter" -Database DEMODB
PS C:\\> $roles | Add-DbaDbRoleMember -User user1
Adds user1 in the database DEMODB on the server localhost to the roles db_datareader and db_datawriter
RELATED LINKS
https://dbatools.io/Add-DbaDbRoleMember
SYNOPSIS
Adds a Database User to a database role for each instance(s) of SQL Server.
SYNTAX
Add-DbaDbRoleMember [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-Database] <System.String[]>] [[-Role] <System.String[]>] [-User]
<System.String[]> [[-InputObject] <System.Object[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
The Add-DbaDbRoleMember adds users in a database to a database role or 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
-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.
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
-User [<System.String[]>]
The user(s) to add to role(s) specified.
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:\\>Add-DbaDbRoleMember -SqlInstance localhost -Database mydb -Role db_owner -User user1
Adds user1 to the role db_owner in the database mydb on the local default SQL Server instance
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Add-DbaDbRoleMember -SqlInstance localhost, sql2016 -Role SqlAgentOperatorRole -User user1 -Database msdb
Adds user1 in servers localhost and sql2016 in the msdb database to the SqlAgentOperatorRole
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>$servers = Get-Content C:\\servers.txt
PS C:\\> $servers | Add-DbaDbRoleMember -Role SqlAgentOperatorRole -User user1 -Database msdb
Adds user1 to the SqlAgentOperatorROle in the msdb database in every server in C:\\servers.txt
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Add-DbaDbRoleMember -SqlInstance localhost -Role "db_datareader","db_datawriter" -User user1 -Database
DEMODB
Adds user1 in the database DEMODB on the server localhost to the roles db_datareader and db_datawriter
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>$roles = Get-DbaDbRole -SqlInstance localhost -Role "db_datareader","db_datawriter" -Database DEMODB
PS C:\\> $roles | Add-DbaDbRoleMember -User user1
Adds user1 in the database DEMODB on the server localhost to the roles db_datareader and db_datawriter
RELATED LINKS
https://dbatools.io/Add-DbaDbRoleMember