< Back
Rename-DbaLogin
Post
NAME Rename-DbaLogin
SYNOPSIS
Rename-DbaLogin will rename login and database mapping for a specified login.
SYNTAX
Rename-DbaLogin [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [-Login] <String> [-NewLogin] <String> [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
There are times where you might want to rename a login that was copied down, or if the name is not descriptive for
what it does.
It can be a pain to update all of the mappings for a specific user, this does it for you.
PARAMETERS
-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
-Login [<String>]
The current Login on the server - this list is auto-populated from the server.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-NewLogin [<String>]
The new Login that you wish to use. If it is a windows user login, then the SID must match.
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[]>]
Source SQL Server.You must have sysadmin access and server version must be SQL Server version 2000 or greater.
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: Login
Author: Mitchell Hamann (@SirCaptainMitch)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Rename-DbaLogin -SqlInstance localhost -Login DbaToolsUser -NewLogin captain
SQL Login Example
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Rename-DbaLogin -SqlInstance localhost -Login domain\\oldname -NewLogin domain\\newname
Change the windowsuser login name.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Rename-DbaLogin -SqlInstance localhost -Login dbatoolsuser -NewLogin captain -WhatIf
WhatIf Example
RELATED LINKS
https://dbatools.io/Rename-DbaLogin
SYNOPSIS
Rename-DbaLogin will rename login and database mapping for a specified login.
SYNTAX
Rename-DbaLogin [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [[-SqlCredential]
<Pscredential>] [-Login] <String> [-NewLogin] <String> [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
There are times where you might want to rename a login that was copied down, or if the name is not descriptive for
what it does.
It can be a pain to update all of the mappings for a specific user, this does it for you.
PARAMETERS
-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
-Login [<String>]
The current Login on the server - this list is auto-populated from the server.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-NewLogin [<String>]
The new Login that you wish to use. If it is a windows user login, then the SID must match.
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[]>]
Source SQL Server.You must have sysadmin access and server version must be SQL Server version 2000 or greater.
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: Login
Author: Mitchell Hamann (@SirCaptainMitch)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Rename-DbaLogin -SqlInstance localhost -Login DbaToolsUser -NewLogin captain
SQL Login Example
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Rename-DbaLogin -SqlInstance localhost -Login domain\\oldname -NewLogin domain\\newname
Change the windowsuser login name.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Rename-DbaLogin -SqlInstance localhost -Login dbatoolsuser -NewLogin captain -WhatIf
WhatIf Example
RELATED LINKS
https://dbatools.io/Rename-DbaLogin