-
-
Notifications
You must be signed in to change notification settings - Fork 794
/
Get-DbaAvailabilityGroup.ps1
114 lines (86 loc) · 5.06 KB
/
Get-DbaAvailabilityGroup.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
107
108
109
110
111
112
113
114
function 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).
.PARAMETER SqlInstance
The target SQL Server instance or instances. You must have sysadmin access and server version must be SQL Server version 2012 or higher.
.PARAMETER 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.
.PARAMETER AvailabilityGroup
Return only specific availability groups.
.PARAMETER IsPrimary
If this switch is enabled, a boolean indicating whether SqlInstance is the Primary replica in the AG is returned.
.PARAMETER 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.
.NOTES
Tags: AG, HA
Author: Shawn Melton (@wsmelton) | Chrissy LeMaire (@cl)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
.LINK
https://dbatools.io/Get-DbaAvailabilityGroup
.EXAMPLE
PS C:\> Get-DbaAvailabilityGroup -SqlInstance sqlserver2014a
Returns basic information on all the Availability Group(s) found on sqlserver2014a.
.EXAMPLE
PS C:\> Get-DbaAvailabilityGroup -SqlInstance sqlserver2014a -AvailabilityGroup AG-a
Shows basic information on the Availability Group AG-a on sqlserver2014a.
.EXAMPLE
PS C:\> Get-DbaAvailabilityGroup -SqlInstance sqlserver2014a | Select-Object *
Returns full object properties on all Availability Group(s) on sqlserver2014a.
.EXAMPLE
PS C:\> Get-DbaAvailabilityGroup -SqlInstance sqlserver2014a | Select-Object -ExpandProperty PrimaryReplicaServerName
Returns the SQL Server instancename of the primary replica as a string
.EXAMPLE
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.
#>
[CmdletBinding()]
param (
[parameter(Mandatory, ValueFromPipeline)]
[DbaInstanceParameter[]]$SqlInstance,
[PSCredential]$SqlCredential,
[string[]]$AvailabilityGroup,
[switch]$IsPrimary,
[switch]$EnableException
)
process {
foreach ($instance in $SqlInstance) {
try {
$server = Connect-DbaInstance -SqlInstance $instance -SqlCredential $SqlCredential -MinimumVersion 11
} catch {
Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $instance -Continue
}
if (-not $server.IsHadrEnabled) {
Stop-Function -Message "Availability Group (HADR) is not configured for the instance: $instance." -Target $instance -Continue
}
$ags = $server.AvailabilityGroups
if ($AvailabilityGroup) {
$ags = $ags | Where-Object Name -in $AvailabilityGroup
}
foreach ($ag in $ags) {
# Refresh list of databases to fix #9094
$ag.AvailabilityDatabases.Refresh()
Add-Member -Force -InputObject $ag -MemberType NoteProperty -Name ComputerName -value $server.ComputerName
Add-Member -Force -InputObject $ag -MemberType NoteProperty -Name InstanceName -value $server.ServiceName
Add-Member -Force -InputObject $ag -MemberType NoteProperty -Name SqlInstance -value $server.DomainInstanceName
if ($IsPrimary) {
$defaults = 'ComputerName', 'InstanceName', 'SqlInstance', 'Name as AvailabilityGroup', 'IsPrimary'
Add-Member -Force -InputObject $ag -MemberType NoteProperty -Name IsPrimary -Value ($ag.LocalReplicaRole -eq "Primary")
Select-DefaultView -InputObject $ag -Property $defaults
} else {
$defaults = 'ComputerName', 'InstanceName', 'SqlInstance', 'LocalReplicaRole', 'Name as AvailabilityGroup', 'PrimaryReplicaServerName as PrimaryReplica', 'ClusterType', 'DtcSupportEnabled', 'AutomatedBackupPreference', 'AvailabilityReplicas', 'AvailabilityDatabases', 'AvailabilityGroupListeners'
Select-DefaultView -InputObject $ag -Property $defaults
}
}
}
}
}