Get-DbaAvailabilityGroup

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

Synopsis

Returns availability group objects from a SQL Server instance.

Description

Returns availability group objects from a SQL Server instance.

Default view provides most common set of properties for information on the Availability Group(s).

Syntax

Get-DbaAvailabilityGroup
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-AvailabilityGroup] <String[]>]
    [-IsPrimary]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaAvailabilityGroup -SqlInstance sqlserver2014a

Returns basic information on all the Availability Group(s) found on sqlserver2014a.

Example: 2

PS C:\> Get-DbaAvailabilityGroup -SqlInstance sqlserver2014a -AvailabilityGroup AG-a

Shows basic information on the Availability Group AG-a on sqlserver2014a.

Example: 3

PS C:\> Get-DbaAvailabilityGroup -SqlInstance sqlserver2014a | Select-Object *

Returns full object properties on all Availability Group(s) on sqlserver2014a.

Example: 4

PS C:\> Get-DbaAvailabilityGroup -SqlInstance sqlserver2014a | Select-Object -ExpandProperty PrimaryReplicaServerName

Returns the SQL Server instancename of the primary replica as a string

Example: 5

PS C:\> Get-DbaAvailabilityGroup -SqlInstance sqlserver2014a -AvailabilityGroup AG-a -IsPrimary

Returns true/false if the server, sqlserver2014a, is the primary replica for AG-a Availability Group.

Required Parameters

-SqlInstance

The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL Server version 2012 or higher.

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.

-AvailabilityGroup

Return only specific availability groups.

-IsPrimary

If this switch is enabled, a boolean indicating whether SqlInstance is the Primary replica in the AG is returned.

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