commands

^

Backup-DbaDbMasterKey

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows, Linux, macOS

 

Synopsis

Backs up specified database master key.

Description

Backs up specified database master key.

Syntax

Backup-DbaDbMasterKey
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Credential] <PSCredential>]
    [[-Database] <String[]>]
    [[-ExcludeDatabase] <String[]>]
    [[-SecurePassword] <SecureString>]
    [[-Path] <String>]
    [[-InputObject] <Database[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Backup-DbaDbMasterKey -SqlInstance server1\sql2016
ComputerName : SERVER1<br>
InstanceName : SQL2016<br>
SqlInstance  : SERVER1\SQL2016<br>
Database     : master<br>
Filename     : E:\MSSQL13.SQL2016\MSSQL\Backup\server1$sql2016-master-20170614162311.key<br>
Status       : Success<br>
```<br>
Prompts for export password, then logs into server1\sql2016 with Windows credentials then backs up all database keys to the default backup directory.<br>

##### Example:  2 

PS C:> Backup-DbaDbMasterKey -SqlInstance Server1 -Database db1 -Path \nas\sqlbackups\keys

Logs into sql2016 with Windows credentials then backs up db1's keys to the \\nas\sqlbackups\keys directory.<br>
### Optional Parameters
##### -SqlInstance
The target SQL Server instance or instances.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| 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.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value |  |

##### -Credential
Pass a credential object for the password<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value |  |

##### -Database
Backup master key from specific database(s).<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value |  |

##### -ExcludeDatabase
The database(s) to exclude - this list is auto-populated from the server.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value |  |

##### -SecurePassword
The password to encrypt the exported key. This must be a SecureString.<br>

|  |  |
| - | - |
| Alias | Password |
| Required | False |
| Pipeline | false |
| Default Value |  |

##### -Path
The directory to export the key. If no path is specified, the default backup directory for the instance will be used.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value |  |

##### -InputObject
Database object piped in from Get-DbaDatabase<br>

|  |  |
| - | - |
| 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.<br>

|  |  |
| - | - |
| Alias |  |
| Required | False |
| Pipeline | false |
| Default Value | False |

##### -WhatIf
Shows what would happen if the command were to run. No actions are actually performed.<br>

|  |  |
| - | - |
| Alias | wi |
| Required | False |
| Pipeline | false |
| Default Value |  |

##### -Confirm
Prompts you for confirmation before executing any changing operations within the command.<br>

|  |  |
| - | - |
| Alias | cf |
| Required | False |
| Pipeline | false |
| Default Value |  |



&nbsp;

Want to see the source code for this command? Check out [Backup-DbaDbMasterKey](https://github.com/sqlcollaborative/dbatools/blob/master/functions/Backup-DbaDbMasterKey.ps1) on GitHub.
<br>
Want to see the Bill Of Health for this command? Check out [Backup-DbaDbMasterKey](https://sqlcollaborative.github.io/boh#Backup-DbaDbMasterKey).