forked from scriptrunner/ActionPacks
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathRemove-VMHVSnapShot.ps1
91 lines (75 loc) · 3.14 KB
/
Remove-VMHVSnapShot.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
#Requires -Version 4.0
# Requires -Modules VMware.PowerCLI
<#
.SYNOPSIS
Removes the specified virtual machine snapshot
.DESCRIPTION
.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 VMware.PowerCLI
.LINK
https://github.com/scriptrunner/ActionPacks/tree/master/VMware/VMs
.Parameter VIServer
Specifies the IP address or the DNS name of the vSphere server to which you want to connect
.Parameter VICredential
Specifies a PSCredential object that contains credentials for authenticating with the server
.Parameter VMId
Specifies the ID of the virtual machine you want the snapshot retrieve
.Parameter VMName
Specifies the name of the virtual machine you want the snapshot retrieve
.Parameter SnapShotName
Specifies the name of the snapshot
.Parameter RemoveChildren
Indicates that you want to remove the children of the specified snapshots as well
#>
[CmdLetBinding()]
Param(
[Parameter(Mandatory = $true,ParameterSetName = "byID")]
[Parameter(Mandatory = $true,ParameterSetName = "byName")]
[string]$VIServer,
[Parameter(Mandatory = $true,ParameterSetName = "byID")]
[Parameter(Mandatory = $true,ParameterSetName = "byName")]
[pscredential]$VICredential,
[Parameter(Mandatory = $true,ParameterSetName = "byID")]
[string]$VMId,
[Parameter(Mandatory = $true,ParameterSetName = "byName")]
[string]$VMName,
[Parameter(Mandatory = $true,ParameterSetName = "byID")]
[Parameter(Mandatory = $true,ParameterSetName = "byName")]
[string]$SnapShotName,
[Parameter(ParameterSetName = "byID")]
[Parameter(ParameterSetName = "byName")]
[switch]$RemoveChildren
)
Import-Module VMware.PowerCLI
try{
$Script:vmServer = Connect-VIServer -Server $VIServer -Credential $VICredential -ErrorAction Stop
if($PSCmdlet.ParameterSetName -eq "byID"){
$Script:machine = Get-VM -Server $Script:vmServer -Id $VMId -ErrorAction Stop
}
else{
$Script:machine = Get-VM -Server $Script:vmServer -Name $VMName -ErrorAction Stop
}
$Script:snapshot = Get-Snapshot -Server $Script:vmServer -VM $Script:machine -Name $SnapShotName -ErrorAction Stop
$null = Remove-Snapshot -Snapshot $Script:snapshot -RemoveChildren:$RemoveChildren -Confirm:$false -ErrorAction Stop
if($SRXEnv) {
$SRXEnv.ResultMessage = "SnapShot $($SnapShotName) successfully removed"
}
else{
Write-Output "SnapShot $($SnapShotName) successfully removed"
}
}
catch{
throw
}
finally{
if($null -ne $Script:vmServer){
Disconnect-VIServer -Server $Script:vmServer -Force -Confirm:$false
}
}