functions/Get-DbaAvailabilityGroup.ps1

Function Get-DbaAvailabilityGroup
{
<#
.SYNOPSIS
Outputs information of the Availabilty Group(s) found on the server.
 
.DESCRIPTION
By default outputs a small set of information around the Availability Group found on the server.
 
.PARAMETER SqlServer
The SQL Server instance. You must have sysadmin access and server version must be SQL Server version 2012 or higher.
 
.PARAMETER SqlCredential
Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted.
 
.PARAMETER Detailed
Output is expanded with more information around each Availability Group replica found on the server.
 
.PARAMETER AvailabilityGroups
Specify the Availability Group name that you want to get information on.
 
.PARAMETER Simple
Show only server name, availability groups and role.
 
.PARAMETER Detailed
Shows detailed information about the AGs including EndpointUrl and BackupPriority.
 
.PARAMETER IsPrimary
Returns true or false for the server passed in.
 
.PARAMETER WhatIf
Shows what would happen if the command were to run. No actions are actually performed.
 
.PARAMETER Confirm
Prompts you for confirmation before executing any changing operations within the command.
 
.NOTES
Tags: DisasterRecovery, Backup
Original Author: Shawn Melton (@wsmelton) | Chrissy LeMaire (@ctrlb)
 
dbatools PowerShell module (https://dbatools.io, clemaire@gmail.com)
Copyright (C) 2016 Chrissy LeMaire
 
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
 
.LINK
https://dbatools.io/Get-DbaAvailabilityGroup
 
.EXAMPLE
Get-DbaAvailabilityGroup -SqlServer sqlserver2014a
Returns basic information on all the Availability Group(s) found on sqlserver2014a
 
.EXAMPLE
Get-DbaAvailabilityGroup -SqlServer sqlserver2014a -Simple
Show only server name, availability groups and role
 
.EXAMPLE
Get-DbaAvailabilityGroup -SqlServer sqlserver2014a -Detailed
Returns basic information plus additional info on each replica for all Availability Group(s) on sqlserver2014a
 
.EXAMPLE
Get-DbaAvailabilityGroup -SqlServer sqlserver2014a -AvailabilityGroup AG-a
Shows basic information on the Availability Group AG-a on sqlserver2014a
     
.EXAMPLE
Get-DbaAvailabilityGroup -SqlServer sqlserver2014a -AvailabilityGroup AG-a -IsPrimary
Returns true/false if the server, sqlserver2014a, is the primary replica for AG-a Availability Group
#>

    [CmdletBinding(SupportsShouldProcess = $true)]
    Param (
        [parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [Alias("ServerInstance", "SqlInstance")]
        [object[]]$SqlServer,
        [object]$SqlCredential,
        [switch]$Simple,
        [switch]$Detailed,
        [switch]$IsPrimary
    )
    
    DynamicParam { if ($sqlserver) { return Get-ParamSqlAvailabilityGroups -SqlServer $sqlserver[0] -SqlCredential $SqlCredential } }
    
    BEGIN
    {
        $agCollection = @()
        $AvailabilityGroups = $PSBoundParameters.AvailabilityGroups
    }
    
    PROCESS
    {
        foreach ($servername in $sqlserver)
        {
            $agReplicas = @()
            $server = Connect-SqlServer -SqlServer $servername -SqlCredential $SqlCredential
            
            $version = $server.VersionMajor
            if ($version -lt 11) 
            {
                Write-Verbose "$server Major Version detected: $version"
                Write-Warning "$server is version $version. Availability Groups are only supported in SQL Server 2012 and above."
                continue
            }

            if (!$server.IsHadrEnabled)
            {
                Write-Warning "$server Availability Group is not configured."
                continue
            }

            if ($AvailabilityGroups)
            {
                foreach ($ag in $AvailabilityGroups)
                {
                    $agReplicas += $server.AvailabilityGroups[$ag].AvailabilityReplicas
                }
            }
            else
            {
                $agReplicas += $server.AvailabilityGroups.AvailabilityReplicas
            }
            
            if (!$agReplicas)
            {
                Write-Warning "[$servername] Availability Groups not found"
                continue
            }
            
            
            foreach ($r in $agReplicas)
            {
                $agCollection += [pscustomobject]@{
                    AvailabilityGroup = $r.Parent.Name
                    ReplicaName = $r.name
                    Role = $r.Role
                    SyncState = $r.RollupSynchronizationState
                    AvailabilityMode = $r.AvailabilityMode
                    FailoverMode = $r.FailoverMode
                    ConnectionModeInPrimaryRole = $r.ConnectionModeInPrimaryRole
                    ReadableSecondary = $r.ConnectionModeInSecondaryRole
                    SessionTimeout = $r.SessionTimeout
                    EndpointUrl = $r.EndpointUrl
                    BackupPriority = $r.BackupPriority
                    ExcludeReplica = if ($r.BackupPriority -eq 0) { $true } else { $false }
                    QuorumVoteCount = $r.QuorumVoteCount
                    ReadonlyRoutingUrl = $r.ReadonlyRoutingConnectionUrl
                    ReadonlyRoutingList = $r.ReadonlyRoutingList -join ","
                }
            }
            
            $server.ConnectionContext.Disconnect()
        }
    }
    
    END
    {
        if ($AvailabilityGroups)
        {
            $agCollection = ($agCollection | Where-Object AvailabilityGroup -in $AvailabilityGroups)
        }
        
        if ($IsPrimary)
        {
            return ($agCollection | Where-Object { $_.ReplicaName -in $sqlserver -and $_.Role -ne 'Unknown' } | Select-Object ReplicaName, AvailabilityGroup, @{ Name="IsPrimary"; Expression={ $_.Role -eq "Primary" } } )
        }
        
        if ($Simple)
        {
            return $agCollection | Select-Object ReplicaName, AvailabilityGroup, Role
        }
        
        if ($Detailed)
        {
            return $agCollection
        }
        else
        {
            return ($agCollection | Select-Object AvailabilityGroup, ReplicaName, Role, SyncState, AvailabilityMode, FailoverMode)
        }
    }
}