Backup-DbaServiceMasterKey


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

Want to see the source code for this command? Check out Backup-DbaServiceMasterKey on GitHub.
Want to see the Bill Of Health for this command? Check out Backup-DbaServiceMasterKey.

Synopsis

Backs up specified service master key.

Description

Backs up specified service master key.

Syntax

Backup-DbaServiceMasterKey
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-KeyCredential] <PSCredential>]
    [[-SecurePassword] <SecureString>]
    [[-Path] <String>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Backup-DbaServiceMasterKey -SqlInstance server1\sql2016
>> ComputerName : SERVER1
>> InstanceName : SQL2016
>> SqlInstance  : SERVER1\SQL2016
>> Filename     : E:\MSSQL13.SQL2016\MSSQL\Backup\server1$sql2016-SMK-20170614162311.key
>> Status       : Success

Prompts for export password, then logs into server1\sql2016 with Windows credentials then backs up the service master key to the default backup directory.

Example: 2

PS C:\> Backup-DbaServiceMasterKey -SqlInstance Server1 -Path \\nas\sqlbackups\keys

Logs into sql2016 with Windows credentials then backs up the service master key to the \nas\sqlbackups\keys directory.

Required Parameters

-SqlInstance

The target SQL Server instance or instances.


Alias
Required	True
Pipeline	true (ByValue)
Default Value

Optional Parameters

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


Alias
Required	False
Pipeline	false
Default Value

-KeyCredential

Pass a credential object for the password


Alias
Required	False
Pipeline	false
Default Value

-SecurePassword

The password to encrypt the exported key. This must be a SecureString.


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.


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


Alias
Required	False
Pipeline	false
Default Value	False

-WhatIf

Shows what would happen if the command were to run. No actions are actually performed.


Alias	wi
Required	False
Pipeline	false
Default Value

-Confirm

Prompts you for confirmation before executing any changing operations within the command.


Alias	cf
Required	False
Pipeline	false
Default Value