< Back
New-DbaDbMasterKey
Post
NAME New-DbaDbMasterKey
SYNOPSIS
Creates a new database master key
SYNTAX
New-DbaDbMasterKey [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-Credential] <Pscredential>] [[-Database] <System.String[]>] [[-SecurePassword] <Securestring>]
[[-InputObject] <Microsoft.SqlServer.Management.Smo.Database[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Creates a new database master key. If no database is specified, the master key will be created in master.
PARAMETERS
-Credential [<Pscredential>]
Enables easy creation of a secure password.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Database [<System.String[]>]
The database where the master key will be created. Defaults to master.
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 [<Microsoft.SqlServer.Management.Smo.Database[]>]
Database object piped in from Get-DbaDatabase.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SecurePassword [<Securestring>]
Secure string used to create the key.
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.
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: Certificate
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-DbaDbMasterKey -SqlInstance Server1
You will be prompted to securely enter your password, then a master key will be created in the master database on
server1 if it does not exist.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>New-DbaDbMasterKey -SqlInstance Server1 -Credential usernamedoesntmatter
You will be prompted by a credential interface to securely enter your password, then a master key will be created
in the master database on server1 if it does not exist.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>New-DbaDbMasterKey -SqlInstance Server1 -Database db1 -Confirm:$false
Suppresses all prompts to install but prompts in th console to securely enter your password and creates a master
key in the 'db1' database
RELATED LINKS
SYNOPSIS
Creates a new database master key
SYNTAX
New-DbaDbMasterKey [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-Credential] <Pscredential>] [[-Database] <System.String[]>] [[-SecurePassword] <Securestring>]
[[-InputObject] <Microsoft.SqlServer.Management.Smo.Database[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Creates a new database master key. If no database is specified, the master key will be created in master.
PARAMETERS
-Credential [<Pscredential>]
Enables easy creation of a secure password.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Database [<System.String[]>]
The database where the master key will be created. Defaults to master.
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 [<Microsoft.SqlServer.Management.Smo.Database[]>]
Database object piped in from Get-DbaDatabase.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SecurePassword [<Securestring>]
Secure string used to create the key.
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.
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: Certificate
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-DbaDbMasterKey -SqlInstance Server1
You will be prompted to securely enter your password, then a master key will be created in the master database on
server1 if it does not exist.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>New-DbaDbMasterKey -SqlInstance Server1 -Credential usernamedoesntmatter
You will be prompted by a credential interface to securely enter your password, then a master key will be created
in the master database on server1 if it does not exist.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>New-DbaDbMasterKey -SqlInstance Server1 -Database db1 -Confirm:$false
Suppresses all prompts to install but prompts in th console to securely enter your password and creates a master
key in the 'db1' database
RELATED LINKS