commands

^

Get-DbaDbSnapshot

Author Simone Bizzotto (@niphlod)
Availability Windows, Linux, macOS

 

Synopsis

Get database snapshots with details

Description

Retrieves the list of database snapshot available, along with their base (the db they are the snapshot of) and creation time

Syntax

Get-DbaDbSnapshot
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Database] <Object[]>]
    [[-ExcludeDatabase] <Object[]>]
    [[-Snapshot] <Object[]>]
    [[-ExcludeSnapshot] <Object[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaDbSnapshot -SqlInstance sqlserver2014a

Returns a custom object displaying Server, Database, DatabaseCreated, SnapshotOf, SizeMB, DatabaseCreated

Example: 2
PS C:\> Get-DbaDbSnapshot -SqlInstance sqlserver2014a -Database HR, Accounting

Returns information for database snapshots having HR and Accounting as base dbs

Example: 3
PS C:\> Get-DbaDbSnapshot -SqlInstance sqlserver2014a -Snapshot HR_snapshot, Accounting_snapshot

Returns information for database snapshots HR_snapshot and Accounting_snapshot

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

Return information for only specific databases

Alias
Required False
Pipeline false
Default Value
-ExcludeDatabase

The database(s) to exclude - this list is auto-populated from the server

Alias
Required False
Pipeline false
Default Value
-Snapshot

Return information for only specific snapshots

Alias
Required False
Pipeline false
Default Value
-ExcludeSnapshot

The snapshot(s) to exclude - this list is auto-populated from the server

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 Get-DbaDbSnapshot on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaDbSnapshot.