commands

^

Get-DbaDbFileGroup

Author Patrick Flynn (@sqllensman)
Availability Windows, Linux, macOS

 

Synopsis

Returns a summary of information on filegroups

Description

Shows information around filegroups.

Syntax

Get-DbaDbFileGroup
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <Object[]>]
    [[-InputObject] <Database[]>]
    [[-FileGroup] <String[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaDbFileGroup -SqlInstance sql2016

Return all FileGroups for all databases on instance sql2016

Example: 2
PS C:\> Get-DbaDbFileGroup -SqlInstance sql2016 -Database MyDB

Return all FileGroups for database MyDB on instance sql2016

Example: 3
PS C:\> Get-DbaDbFileGroup -SqlInstance sql2016 -FileGroup Primary

Returns information on filegroup called Primary if it exists in any database on the server sql2016

Example: 4
PS C:\> 'localhost','localhost\namedinstance' | Get-DbaDbFileGroup

Returns information on all FileGroups for all databases on instances 'localhost','localhost\namedinstance'

Example: 5
PS C:\> 'localhost','localhost\namedinstance' | Get-DbaDbFileGroup

Returns information on all FileGroups for all databases on instances 'localhost','localhost\namedinstance'

Example: 6
PS C:\> Get-DbaDatabase -SqlInstance SQL1\SQLExpress,SQL2 -ExcludeDatabase model,master | Get-DbaDbFileGroup

Returns information on all FileGroups for all databases except model and master on instances SQL1\SQLExpress,SQL2

Optional Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input.

Alias
Required False
Pipeline true (ByValue)
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.

Alias
Required False
Pipeline false
Default Value
-Database

The database(s) to process - this list is auto-populated from the server. If unspecified, all databases will be processed.

Alias
Required False
Pipeline false
Default Value
-InputObject

Database object piped in from Get-DbaDatabase

Alias
Required False
Pipeline true (ByValue)
Default Value
-FileGroup

Define a specific FileGroup you would like to query.

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