Get-DbaBackupDevice

Garry Bargsley (@gbargsley), blog.garrybargsley.com

Windows, Linux, macOS

Synopsis

Retrieves configured backup devices from SQL Server instances for inventory and management

This function returns all backup devices configured on SQL Server instances, including their type (disk, tape, URL), physical locations, and settings. Backup devices are logical names that map to physical backup destinations, allowing DBAs to create standardized backup locations that can be referenced in backup scripts and maintenance plans. Use this to audit backup device configurations across your environment, verify backup paths are accessible, or document your backup infrastructure for compliance and disaster recovery planning.

Syntax

Get-DbaBackupDevice
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaBackupDevice -SqlInstance localhost

Returns all Backup Devices on the local default SQL Server instance

Example: 2

PS C:\> Get-DbaBackupDevice -SqlInstance localhost, sql2016

Returns all Backup Devices for the local and sql2016 SQL Server instances

Required Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function
to be executed against multiple SQL Server instances.

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

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

Property	Value
Alias
Required	False
Pipeline	false
Default Value	False

Outputs

Microsoft.SqlServer.Management.Smo.BackupDevice

Returns one BackupDevice object per configured backup device on each SQL Server instance.

Default display properties (via Select-DefaultView):

ComputerName: The name of the computer hosting the SQL Server instance
InstanceName: The name of the SQL Server instance
SqlInstance: The full SQL Server instance name (computer\instance)
Name: The logical name of the backup device
BackupDeviceType: The type of backup device (Disk, Tape, or Url)
PhysicalLocation: The physical path or location of the backup device (file path, tape device, or URL)
SkipTapeLabel: Boolean indicating whether to skip tape label validation

Additional properties available (from SMO BackupDevice object):

Urn: The Uniform Resource Name identifying the backup device
State: The state of the SMO object (Existing, Creating, Pending, etc.)
Parent: Reference to the parent Server object All properties from the SMO BackupDevice object are accessible using Select-Object *.