-
Notifications
You must be signed in to change notification settings - Fork 4
/
Manage-CloudSnapshots.ps1
259 lines (209 loc) · 13.6 KB
/
Manage-CloudSnapshots.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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
<#
.DESCRIPTION
This scipt starts a manual backup & deletes the backup cloud snapshots older than specified retention days.
Steps to execute the script:
----------------------------
1. Open powershell, create a new folder & change directory to the folder.
mkdir C:\scripts\StorSimpleSDKTools
cd C:\scripts\StorSimpleSDKTools
2. Download nuget CLI under the same folder in Step1.
Various versions of nuget.exe are available on nuget.org/downloads. Each download link points directly to an .exe file, so be sure to right-click and save the file to your computer rather than running it from the browser.
wget https://dist.nuget.org/win-x86-commandline/latest/nuget.exe -Out C:\scripts\StorSimpleSDKTools\nuget.exe
3. Download the dependent SDK
C:\scripts\StorSimpleSDKTools\nuget.exe install Microsoft.Azure.Management.Storsimple8000series
C:\scripts\StorSimpleSDKTools\nuget.exe install Microsoft.IdentityModel.Clients.ActiveDirectory -Version 2.28.3
C:\scripts\StorSimpleSDKTools\nuget.exe install Microsoft.Rest.ClientRuntime.Azure.Authentication -Version 2.2.9-preview
4. Download the script from script center.
wget https://raw.githubusercontent.com/anoobbacker/storsimpledevicemgmttools/master/Manage-CloudSnapshots.ps1 -Out Manage-CloudSnapshots.ps1
.\Manage-CloudSnapshots.ps1 -SubscriptionId [subid] -TenantId [tenantid] -ResourceGroupName [resource group] -ManagerName [device manager] -DeviceName [device name] -BackupPolicyName [backup policy name] -RetentionInDays [retention days] -AuthNType [Type of auth] -AADAppId [AAD app Id] -AADAppAuthNKey [AAD App Auth Key] -WhatIf [$true/$false]
----------------------------
.PARAMS
SubscriptionId: Input the Subscription ID where the StorSimple 8000 series device manager is deployed.
TenantId: Input the Tenant ID of the subscription. Get Tenant ID using Get-AzureRmSubscription cmdlet or go to the documentation https://aka.ms/ss8000-script-tenantid.
DeviceName: Input the name of the StorSimple device on which to create/update the volume.
ResourceGroupName: Input the name of the resource group on which to create/update the volume.
ManagerName: Input the name of the resource (StorSimple device manager) on which to create/update the volume.
BackupPolicyName: Input the name of the Backup policy to use to create the cloud snapshot.
RetentionInDays: Input the days of the retention to use to delete the older backups. Default value 20 days.
AuthNType: Input if you want to go with username, AAD authentication key or certificate. Refer https://aka.ms/ss8000-script-sp.
Possible values: [UserNamePassword, AuthenticationKey, Certificate]
AADAppId: Input application ID for which the service principal was set. Refer https://aka.ms/ss8000-script-sp.
AADAppAuthNKey: Input application authentication key for which the AAD application. Refer https://aka.ms/ss8000-script-sp.
AADAppAuthNCertPath: Input the service principal certificate for the AAD application. Refer https://aka.ms/ss8000-script-spcert.
AADAppAuthNCertPassword: Input the service principal ceritifcate password for the AAD application. Refer https://aka.ms/ss8000-script-spcert.
WhatIf: Input the WhatIf arg as $true if you want to see what changes the script will make. Possible values [$false, $true]
#>
Param
(
[parameter(Mandatory = $true, HelpMessage = "Input the Subscription ID where the StorSimple 8000 series device manager is deployed.")]
[String]
$SubscriptionId,
[parameter(Mandatory = $true, HelpMessage = "Input the ID of the tenant of the subscription. Get using Get-AzureRmSubscription cmdlet.")]
[String]
$TenantId,
[parameter(Mandatory = $true, HelpMessage = "Input the name of the resource group on which to read backup schedules and backup catalogs.")]
[String]
$ResourceGroupName,
[parameter(Mandatory = $true, HelpMessage = "Input the name of the resource (StorSimple device manager) on which to read backup schedules and backup catalogs.")]
[String]
$ManagerName,
[parameter(Mandatory = $true, HelpMessage = "Input the name of the StorSimple device on which to read backup schedules and backup catalogs.")]
[String]
$DeviceName,
[parameter(Mandatory = $true, HelpMessage = "Input the name of the Backup policy to use to create the cloud snapshot.")]
[String]
$BackupPolicyName,
[parameter(Mandatory = $false, HelpMessage = "Input the days of the retention to use to delete the older backups. Default value 20 days.")]
[string]
$RetentionInDays = 20,
[parameter(Mandatory = $false, HelpMessage = "Input if you want to go with username, AAD authentication key or certificate. Refer https://aka.ms/ss8000-script-sp.")]
[ValidateSet('UserNamePassword', 'AuthenticationKey', 'Certificate')]
[String]
$AuthNType = 'UserNamePassword',
[parameter(Mandatory = $false, HelpMessage = "Input application ID for which the service principal was set. Refer https://aka.ms/ss8000-script-sp.")]
[String]
$AADAppId,
[parameter(Mandatory = $false, HelpMessage = "Input application authentication key for which the AAD application. Refer https://aka.ms/ss8000-script-sp.")]
[String]
$AADAppAuthNKey,
[parameter(Mandatory = $false, HelpMessage = "Input the service principal certificate for the AAD application.")]
[String]
$AADAppAuthNCertPath,
[parameter(Mandatory = $false, HelpMessage = "Input the service principal ceritifcate password for the AAD application.")]
[String]
$AADAppAuthNCertPassword,
[parameter(Mandatory = $false, HelpMessage = "Input the WhatIf arg if you want to see what changes the script will make.")]
[ValidateSet($true, $false)]
[bool]
$WhatIf = $true
)
# Set Current directory path
$ScriptDirectory = $PSScriptRoot
# Load all required assemblies
[System.Reflection.Assembly]::LoadFrom((Join-Path $ScriptDirectory "Microsoft.IdentityModel.Clients.ActiveDirectory.2.28.3\lib\net45\Microsoft.IdentityModel.Clients.ActiveDirectory.dll")) | Out-Null
[System.Reflection.Assembly]::LoadFrom((Join-Path $ScriptDirectory "Microsoft.Rest.ClientRuntime.Azure.3.3.7\lib\net452\Microsoft.Rest.ClientRuntime.Azure.dll")) | Out-Null
[System.Reflection.Assembly]::LoadFrom((Join-Path $ScriptDirectory "Microsoft.Rest.ClientRuntime.2.3.8\lib\net452\Microsoft.Rest.ClientRuntime.dll")) | Out-Null
[System.Reflection.Assembly]::LoadFrom((Join-Path $ScriptDirectory "Newtonsoft.Json.6.0.8\lib\net45\Newtonsoft.Json.dll")) | Out-Null
[System.Reflection.Assembly]::LoadFrom((Join-Path $ScriptDirectory "Microsoft.Rest.ClientRuntime.Azure.Authentication.2.2.9-preview\lib\net45\Microsoft.Rest.ClientRuntime.Azure.Authentication.dll")) | Out-Null
[System.Reflection.Assembly]::LoadFrom((Join-Path $ScriptDirectory "Microsoft.Azure.Management.Storsimple8000series.1.0.0\lib\net452\Microsoft.Azure.Management.Storsimple8000series.dll")) | Out-Null
# Print method
Function PrettyWriter($Content, $Color = "Yellow") {
Write-Host $Content -Foregroundcolor $Color
}
# Create a query filter
Function GenerateBackupFilter() {
param([String] $FilterByEntityId, [DateTime] $FilterByStartTime, [DateTime] $FilterByEndTime)
$queryFilter = $null
if ($FilterByStartTime -ne $null) {
$queryFilter = "createdTime ge '$($FilterByStartTime.ToString('r'))'"
}
if($FilterByEndTime -ne $null) {
if(![string]::IsNullOrEmpty($queryFilter)) {
$queryFilter += " and "
}
$queryFilter += "createdTime le '$($FilterByEndTime.ToString('r'))'"
}
if ( !([string]::IsNullOrEmpty($FilterByEntityId)) ) {
if(![string]::IsNullOrEmpty($queryFilter)) {
$queryFilter += " and "
}
if ( $FilterByEntityId -like "*/backupPolicies/*" ) {
$queryFilter += "backupPolicyId eq '$($FilterByEntityId)'"
} else {
$queryFilter += "volumeId eq '$($FilterByEntityId)'"
}
}
return $queryFilter
}
# Define constant variables (DO NOT CHANGE BELOW VALUES)
$FrontdoorUrl = "urn:ietf:wg:oauth:2.0:oob"
$TokenUrl = "https://management.azure.com" # Run 'Get-AzureRmEnvironment | Select-Object Name, ResourceManagerUrl' cmdlet to get the Fairfax url.
$DomainId = "1950a258-227b-4e31-a9cf-717495945fc2"
try {
$FrontdoorUri = New-Object System.Uri -ArgumentList $FrontdoorUrl
$TokenUri = New-Object System.Uri -ArgumentList $TokenUrl
# Set Synchronization context
$SyncContext = New-Object System.Threading.SynchronizationContext
[System.Threading.SynchronizationContext]::SetSynchronizationContext($SyncContext)
# Verify Credentials
if ("UserNamePassword".Equals($AuthNType)) {
# Username password
$AADClient = [Microsoft.Rest.Azure.Authentication.ActiveDirectoryClientSettings]::UsePromptOnly($DomainId, $FrontdoorUri)
$Credentials = [Microsoft.Rest.Azure.Authentication.UserTokenProvider]::LoginWithPromptAsync($TenantId, $AADClient).GetAwaiter().GetResult()
} elseif ("AuthenticationKey".Equals($AuthNType) ) {
# AAD Application authentication key
if ( [string]::IsNullOrEmpty($AADAppId) -or [string]::IsNullOrEmpty($AADAppAuthNKey) ) {
throw "Invalid inputs! Ensure that you input the arguments -AADAppId and -AADAppAuthNKey."
}
$Credentials =[Microsoft.Rest.Azure.Authentication.ApplicationTokenProvider]::LoginSilentAsync($TenantId, $AADAppId, $AADAppAuthNKey).GetAwaiter().GetResult();
} elseif ("Certificate".Equals($AuthNType) ) {
# AAD Service Principal Certificates
if ( [string]::IsNullOrEmpty($AADAppId) -or [string]::IsNullOrEmpty($AADAppAuthNCertPassword) -or [string]::IsNullOrEmpty($AADAppAuthNCertPath) ) {
throw "Invalid inputs! Ensure that you input the arguments -AADAppId, -AADAppAuthNCertPath and -AADAppAuthNCertPassword."
}
if ( !(Test-Path $AADAppAuthNCertPath) ) {
throw "Certificate file $AADAppAuthNCertPath couldn't found!"
}
$CertPassword = ConvertTo-SecureString $AADAppAuthNCertPassword -AsPlainText -Force
$ClientCertificate = New-Object -TypeName System.Security.Cryptography.X509Certificates.X509Certificate2 -ArgumentList @($AADAppAuthNCertPath, $CertPassword)
$ClientAssertionCertificate = New-Object Microsoft.IdentityModel.Clients.ActiveDirectory.ClientAssertionCertificate -ArgumentList $AADAppId, $ClientCertificate
$Credentials = [Microsoft.Rest.Azure.Authentication.ApplicationTokenProvider]::LoginSilentWithCertificateAsync($TenantId, $ClientAssertionCertificate).GetAwaiter().GetResult()
}
if ($Credentials -eq $null) {
throw "Failed to authenticate!"
}
# Get StorSimpleClient instance
$StorSimpleClient = New-Object Microsoft.Azure.Management.StorSimple8000Series.StorSimple8000SeriesManagementClient -ArgumentList $TokenUri, $Credentials
# Set SubscriptionId
$StorSimpleClient.SubscriptionId = $SubscriptionId
# Set backup expiration date
$Today = (Get-Date).ToUniversalTime()
$ExpirationDate = $Today.AddDays(-$RetentionInDays)
# Set backup type (CloudSnapshot)
$BackupType = 'CloudSnapshot'
if ( $WhatIf )
{
PrettyWriter "WhatIf: Perform manual backup." "Red"
}
else
{
Write-Output "Starting a manual backup."
[Microsoft.Azure.Management.StorSimple8000Series.BackupPoliciesOperationsExtensions]::BeginBackupNow($StorSimpleClient.BackupPolicies, $DeviceName, $BackupPolicyName, $BackupType, $ResourceGroupName, $ManagerName)
PrettyWriter "Successfully started the manual backup." "Yellow"
}
$CompletedSnapshots =@()
# Get all backups by Device
$BackupPolicyId = "/subscriptions/$SubscriptionId/resourceGroups/$ResourceGroupName/providers/Microsoft.StorSimple/managers/$ManagerName/devices/$DeviceName/backupPolicies/$BackupPolicyName"
$BackupStartTime = (Get-Date -Date "1970-01-01 00:00:00Z").ToUniversalTime()
$BackupFilter = GenerateBackupFilter $BackupPolicyId $BackupStartTime $ExpirationDate
$oDataQuery = New-Object Microsoft.Rest.Azure.OData.ODataQuery[Microsoft.Azure.Management.StorSimple8000Series.Models.BackupFilter] -ArgumentList $BackupFilter
$CompletedSnapshots = [Microsoft.Azure.Management.StorSimple8000Series.BackupsOperationsExtensions]::ListByDevice($StorSimpleClient.Backups, $DeviceName, $ResourceGroupName, $ManagerName, $oDataQuery)
Write-Output "`nFind the backup snapshots prior to $ExpirationDate ($RetentionInDays days) and delete them."
PrettyWriter "Query: $BackupFilter`n" "Yellow"
foreach ($Snapshot in $CompletedSnapshots)
{
$SnapShotName = $SnapShot.Name
$SnapshotStartTimeStamp = $Snapshot.CreatedOn
if ($SnapshotStartTimeStamp -lt $ExpirationDate)
{
if ( $WhatIf )
{
PrettyWriter "WhatIf: Trigger delete of snapshot $($SnapShotName) which was created on $($SnapshotStartTimeStamp)" "Red"
}
else
{
Write-Output "Deleting $($SnapShotName) which was created on $($SnapshotStartTimeStamp)."
[Microsoft.Azure.Management.StorSimple8000Series.BackupsOperationsExtensions]::BeginDelete($StorSimpleClient.Backups, $DeviceName, $SnapShotName, $ResourceGroupName, $ManagerName)
PrettyWriter "Successfully started deletion of snapshot $($SnapShotName) which was created on $($SnapshotStartTimeStamp)." "Yellow"
}
}
else
{
#Write-Output "Skipping $SnapShotName at $SnapshotStartTimeStamp"
}
}
}
catch {
# Print error details
Write-Error $_.Exception.Message
}