functions/Get-DbaAgDatabase.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
function Get-DbaAgDatabase {
    <#
        .SYNOPSIS
            Outputs the databases involved in the Availability Group(s) found on the server.
 
        .DESCRIPTION
            Default view provides most common set of properties for information on the database in an Availability Group(s).
 
            **Information returned on the database will be specifc to that replica, whether it is
            primary or a secondary.**
 
            **This command will return an SMO object, but it is the AvailabilityDatabases object
            and not the Server.Databases object.
 
        .PARAMETER SqlInstance
            The SQL Server instance. 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 AvailabilityGroup
            Specify the Availability Group name that you want to get information on.
 
        .PARAMETER Database
            Specify the database to pull information on, this will be auto-populated for tab completion. Multiple databases can be provided.
 
        .PARAMETER Silent
            Use this switch to disable any kind of verbose messages
 
        .NOTES
            Tags: DisasterRecovery, AG, AvailabilityGroup, Replica
            Original Author: Shawn Melton (@wsmelton)
 
            Website: https://dbatools.io
            Copyright: (C) Chrissy LeMaire, clemaire@gmail.com
            License: GNU GPL v3 https://opensource.org/licenses/GPL-3.0
 
        .LINK
            https://dbatools.io/Get-DbaAgDatabase
 
        .EXAMPLE
            Get-DbaAgDatabase -SqlInstance sqlserver2014a
 
            Returns basic information on all the databases in each Availability Group found on sqlserver2014a
 
        .EXAMPLE
            Get-DbaAgDatabase -SqlInstance sqlserver2014a -AvailabilityGroup AG-a
 
            Returns basic information on all the databases in the Availability Group AG-a on sqlserver2014a
 
        .EXAMPLE
            Get-DbaAgDatabase -SqlInstance sqlserver2014a -AvailabilityGroup AG-a -Database AG-Database
 
            Returns basic information on the database AG-Database found in the Availability Group AG-a on server sqlserver2014a
    #>

    [CmdletBinding()]
    param (
        [parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [Alias("ServerInstance", "SqlServer")]
        [DbaInstanceParameter[]]$SqlInstance,
        [PSCredential][System.Management.Automation.CredentialAttribute()]
        $SqlCredential,
        [parameter(ValueFromPipeline = $true)]
        [object[]]$AvailabilityGroup,
        [object[]]$Database,
        [switch]$Silent
    )

    process {
        foreach ($serverName in $SqlInstance) {
            try {
                $server = Connect-SqlInstance -SqlInstance $serverName -SqlCredential $SqlCredential -MinimumVersion 11
            }
            catch {
                Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $instance -Continue
            }

            if ($server.IsHadrEnabled -eq $false) {
                Stop-Function -Message "Availability Group (HADR) is not configured for the instance: $serverName" -Target $serverName -Continue
            }

            $ags = $server.AvailabilityGroups
            if ($AvailabilityGroup) {
                $ags = $ags | Where-Object Name -in $AvailabilityGroup
            }

            foreach ($ag in $ags) {
                $agDatabases = $ag.AvailabilityDatabases
                foreach ($agDb in $agDatabases) {
                    if ($Database -and $agDb.Name -notmatch $Database) {
                        continue
                    }

                    Add-Member -Force -InputObject $agDb -MemberType NoteProperty -Name ComputerName -value $server.NetName
                    Add-Member -Force -InputObject $agDb -MemberType NoteProperty -Name InstanceName -value $server.ServiceName
                    Add-Member -Force -InputObject $agDb -MemberType NoteProperty -Name SqlInstance -value $server.DomainInstanceName
                    Add-Member -Force -InputObject $agDb -MemberType NoteProperty -Name Replica -value $server.NetName

                    $defaults = 'ComputerName','InstanceName','SqlInstance','Parent as AvailabilityGroup','Replica','Name as DatabaseName','SynchronizationState','IsFailoverReady','IsJoined','IsSuspended'
                    Select-DefaultView -InputObject $agDb -Property $defaults
                }
            }
        }
    }
}