functions/Export-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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
function Export-DbaAvailabilityGroup
{
<#
.SYNOPSIS
Exports SQL Server Availability Groups to a T-SQL file.
 
.DESCRIPTION
Exports SQL Server Availability Groups creation scripts to a T-SQL file. This is a function that is not available in SSMS.
 
.PARAMETER SqlServer
The SQL Server instance name. SQL Server 2012 and above supported.
 
.PARAMETER FilePath
The directory name where the output files will be written. A sub directory with the format 'ServerName$InstanceName' will be created. A T-SQL scripts named 'AGName.sql' will be created under this subdirectory for each scripted Availability Group.
 
.PARAMETER AvailabilityGroups
Specify which Availability Groups to export (Dynamic Param)
 
.PARAMETER NoClobber
Do not overwrite existing export files.
 
.PARAMETER SqlCredential
Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted. To use:
 
$scred = Get-Credential, then pass $scred object to the -SqlCredential parameter.
 
SQL Server does not accept Windows credentials being passed as credentials. To connect as a different Windows user, run PowerShell as that user.
 
.PARAMETER WhatIf
Shows you what it'd output if you were to run the command
  
.PARAMETER Confirm
Confirms each step/line of output
  
.NOTES
Author: Chris Sommer (@cjsommer), cjsommmer.com
 
dbatools PowerShell module (https://dbatools.io)
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/Export-DbaAvailabilityGroup
 
.EXAMPLE
Export-DbaAvailabilityGroup -SqlServer sql2012
 
Exports all Availability Groups from SQL server "sql2012". Output scripts are written to the Documents\SqlAgExports directory by default.
  
.EXAMPLE
Export-DbaAvailabilityGroup -SqlServer sql2012 -FilePath C:\temp\availability_group_exports
 
Exports all Availability Groups from SQL server "sql2012". Output scripts are written to the C:\temp\availability_group_exports directory.
 
.EXAMPLE
Export-DbaAvailabilityGroup -SqlServer sql2012 -FilePath 'C:\dir with spaces\availability_group_exports' -AvailabilityGroups AG1,AG2
 
Exports Availability Groups AG1 and AG2 from SQL server "sql2012". Output scripts are written to the C:\dir with spaces\availability_group_exports directory.
 
.EXAMPLE
Export-DbaAvailabilityGroup -SqlServer sql2014 -FilePath C:\temp\availability_group_exports -NoClobber
 
Exports all Availability Groups from SQL server "sql2014". Output scripts are written to the C:\temp\availability_group_exports directory. If the export file already exists it will not be overwritten.
 
#>

[CmdletBinding(SupportsShouldProcess = $true)]
Param (
[parameter(Mandatory = $true, ValueFromPipeline = $true)]
[Alias("ServerInstance", "SqlInstance")]
[object[]]$SqlServer,
[System.Management.Automation.PSCredential]$SqlCredential,
[Alias("OutputLocation", "Path")]
[string]$FilePath = "$([Environment]::GetFolderPath("MyDocuments"))\SqlAgExport",
[switch]$NoClobber
)

DynamicParam { if ($SqlServer) { return Get-ParamSqlAvailabilityGroups -SqlServer $SqlServer -SqlCredential $SqlCredential } }

BEGIN
{
Write-Output "Beginning Export-DbaAvailabilityGroup on $SqlServer"
$AvailabilityGroups = $PSBoundParameters.AvailabilityGroups

Write-Verbose "Connecting to SqlServer $SqlServer"

try
{
$server = Connect-SqlServer -SqlServer $SqlServer -SqlCredential $SqlCredential
}
catch
{
Write-Warning "Can't connect to $SqlServer. Moving on."
Continue
}
}

PROCESS
{
# Get all of the Availability Groups and filter if required
$allags = $server.AvailabilityGroups

if ($AvailabilityGroups)
{
Write-Verbose 'Filtering AvailabilityGroups'
$allags = $allags | Where-Object { $_.name -in $AvailabilityGroups }
}

if ($allags.count -gt 0)
{

# Set and create the OutputLocation if it doesn't exist
$sqlinst = $SQLServer.Replace('\', '$')
$OutputLocation = "$FilePath\$sqlinst"

if (!(Test-Path $OutputLocation -PathType Container))
{
New-Item -Path $OutputLocation -ItemType Directory -Force | Out-Null
}

# Script each Availability Group
foreach ($ag in $allags)
{
$agname = $ag.Name

# Set the outfile name
if ($AppendDateToOutputFilename.IsPresent)
{
$formatteddate = (Get-Date -Format 'yyyyMMdd_hhmm')
$outfile = "$OutputLocation\${AGname}_${formatteddate}.sql"
}
else
{
$outfile = "$OutputLocation\$agname.sql"
}

# Check NoClobber and script out the AG
if ($NoClobber.IsPresent -and (Test-Path -Path $outfile -PathType Leaf))
{
Write-Warning "OutputFile $outfile already exists. Skipping due to -NoClobber parameter"
}
else
{
Write-output "Scripting Availability Group [$agname] on $SQLServer to $outfile"

# Create comment block header for AG script
"/*" | Out-File -FilePath $outfile -Encoding ASCII -Force
" * Created by dbatools 'Export-DbaAvailabilityGroup' cmdlet on '$(Get-Date)'" | Out-File -FilePath $outfile -Encoding ASCII -Append
" * See https://dbatools.io/Export-DbaAvailabilityGroup for more help" | Out-File -FilePath $outfile -Encoding ASCII -Append

# Output AG and listener names
" *" | Out-File -FilePath $outfile -Encoding ASCII -Append
" * Availability Group Name: $($ag.name)" | Out-File -FilePath $outfile -Encoding ASCII -Append
$ag.AvailabilityGroupListeners | ForEach-Object { " * Listener Name: $($_.name)" } | Out-File -FilePath $outfile -Encoding ASCII -Append

# Output all replicas
" *" | Out-File -FilePath $outfile -Encoding ASCII -Append
$ag.AvailabilityReplicas | ForEach-Object { " * Replica: $($_.name)" } | Out-File -FilePath $outfile -Encoding ASCII -Append

# Output all databases
" *" | Out-File -FilePath $outfile -Encoding ASCII -Append
$ag.AvailabilityDatabases | ForEach-Object { " * Database: $($_.name)" } | Out-File -FilePath $outfile -Encoding ASCII -Append

# $ag | Select-Object -Property * | Out-File -FilePath $outfile -Encoding ASCII -Append

"*/" | Out-File -FilePath $outfile -Encoding ASCII -Append

# Script the AG
$ag.Script() | Out-File -FilePath $outfile -Encoding ASCII -Append
}
}
}
else
{
Write-Output "No Availability Groups detected on $SqlServer"
}
}

END
{
$server.ConnectionContext.Disconnect()
If ($Pscmdlet.ShouldProcess("console", "Showing finished message")) { Write-Output "Completed Export-DbaAvailabilityGroup on $SqlServer" }
}
}