-
Notifications
You must be signed in to change notification settings - Fork 221
Expand file tree
/
Copy pathRemove-MSHVSnapshot.ps1
More file actions
102 lines (88 loc) · 3.69 KB
/
Remove-MSHVSnapshot.ps1
File metadata and controls
102 lines (88 loc) · 3.69 KB
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
#Requires -Version 5.0
#Requires -Modules Hyper-V
<#
.SYNOPSIS
Deletes a virtual machine snapshot
.DESCRIPTION
Use "Win2K12R2 or Win8.x" for execution on Windows Server 2012 R2 or on Windows 8.1,
when execute on Windows Server 2016 / Windows 10 or newer, use "Newer Systems"
.NOTES
This PowerShell script was developed and optimized for ScriptRunner. The use of the scripts requires ScriptRunner.
The customer or user is authorized to copy the script from the repository and use them in ScriptRunner.
The terms of use for ScriptRunner do not apply to this script. In particular, ScriptRunner Software GmbH assumes no liability for the function,
the use and the consequences of the use of this freely available script.
PowerShell is a product of Microsoft Corporation. ScriptRunner is a product of ScriptRunner Software GmbH.
© ScriptRunner Software GmbH
.COMPONENT
Requires Module Hyper-V
.LINK
https://github.com/scriptrunner/ActionPacks/tree/master/Hyper-V/Snapshots
.Parameter VMHostName
[sr-en] Name of the Hyper-V host
.Parameter HostName
[sr-en] Name of the Hyper-V host
.Parameter VMName
[sr-en] Name of the virtual machine of which the snapshot is to be deleted
.Parameter SnapshotName
[sr-en] Virtual machine snapshot to be deleted
.Parameter IncludeAllChildSnapshots
[sr-en] Snapshots children are to be deleted along with the snapshot
.Parameter AccessAccount
[sr-en] User account that have permission to perform this action
#>
param(
[Parameter(Mandatory = $true,ParameterSetName = "Win2K12R2 or Win8.x")]
[string]$VMHostName,
[Parameter(Mandatory = $true, ParameterSetName = "Win2K12R2 or Win8.x")]
[Parameter(Mandatory = $true, ParameterSetName = "Newer Systems")]
[string]$VMName,
[Parameter(Mandatory = $true, ParameterSetName = "Win2K12R2 or Win8.x")]
[Parameter(Mandatory = $true, ParameterSetName = "Newer Systems")]
[string]$SnapshotName,
[Parameter( ParameterSetName = "Win2K12R2 or Win8.x")]
[Parameter( ParameterSetName = "Newer Systems")]
[switch]$IncludeAllChildSnapshots,
[Parameter(ParameterSetName = "Newer Systems")]
[string]$HostName,
[Parameter(ParameterSetName = "Newer Systems")]
[PSCredential]$AccessAccount
)
Import-Module Hyper-V
try {
if($PSCmdlet.ParameterSetName -eq "Win2K12R2 or Win8.x"){
$HostName=$VMHostName
}
if([System.String]::IsNullOrWhiteSpace($HostName)){
$HostName = "."
}
if($null -eq $AccessAccount){
$Script:shot = Get-VMSnapshot -VMName $VMName -Name $SnapshotName -ComputerName $HostName -ErrorAction Stop
}
else {
$Script:Cim = New-CimSession -ComputerName $HostName -Credential $AccessAccount
$Script:shot = Get-VMSnapshot -VMName $VMName -Name $SnapshotName -CimSession $Script:Cim -ErrorAction Stop
}
if($null -ne $Script:shot){
Remove-VMSnapshot -VMSnapshot $Script:shot -IncludeAllChildSnapshots:$IncludeAllChildSnapshots -ErrorAction Stop
if($SRXEnv) {
$SRXEnv.ResultMessage = "Snapshot $($SnapshotName) removed from virtual machine $($VMName)"
}
else {
Write-Output "Snapshot $($SnapshotName) removed from virtual machine $($VMName)"
}
}
else{
if($SRXEnv) {
$SRXEnv.ResultMessage = "Snapshot $($SnapshotName) not found on virtual machine $($VMName)"
}
Throw "Snapshot $($SnapshotName) not found on virtual machine $($VMName)"
}
}
catch {
throw
}
finally{
if($null -ne $Script:Cim){
Remove-CimSession $Script:Cim
}
}