commands

^

Test-DbaBackupEncrypted

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

 

Synopsis

Tests to see if a backup is encrypted

Description

Tests to see if a backup is encrypted

Syntax

Test-DbaBackupEncrypted
    [-SqlInstance] <DbaInstanceParameter>
    [[-SqlCredential] <PSCredential>]
    [-FilePath] <String[]>
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Test-DbaBackupEncrypted -SqlInstance sql01 -Path /tmp/northwind.bak

Test to see if /tmp/northwind.bak is encrypted

Example: 2
PS C:\> Get-ChildItem \\nas\sql\backups | Test-DbaBackupEncrypted -SqlInstance sql01

Test to see if all of the backups in \nas\sql\backups are encrypted

Required Parameters

-SqlInstance

The target SQL Server instance or instances.

Alias
Required True
Pipeline false
Default Value
-FilePath

The path to the backups

Alias FullName
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
-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

 

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