├── .editorconfig ├── .github └── ISSUE_TEMPLATE │ └── bug_report.yml ├── .gitignore ├── .vscode ├── launch.json └── tasks.json ├── 3rd-party-licenses.md ├── Corsinvest.ProxmoxVE.AutoSnap.sln ├── Initialize-Tools.ps1 ├── LICENSE.md ├── README.md ├── icon.png ├── script-hook.bat ├── script-hook.sh └── src ├── Corsinvest.ProxmoxVE.AutoSnap.Api ├── Application.cs ├── Corsinvest.ProxmoxVE.AutoSnap.Api.csproj ├── HookPhase.cs ├── PhaseEventArgs.cs ├── ResultBaseSnap.cs ├── ResultSnap.cs └── ResultSnapVm.cs └── Corsinvest.ProxmoxVE.AutoSnap ├── Commands.cs ├── Corsinvest.ProxmoxVE.AutoSnap.csproj └── Program.cs /.editorconfig: -------------------------------------------------------------------------------- 1 | # All files 2 | [*] 3 | guidelines = 80 4 | 5 | # C# or VB files 6 | [*.{cs,vb}] 7 | guidelines = 80, 120 -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.yml: -------------------------------------------------------------------------------- 1 | name: Bug Report 2 | description: File a bug report 3 | labels: [needs investigation] 4 | body: 5 | - type: markdown 6 | attributes: 7 | value: | 8 | Thanks for taking the time to fill out this bug report. Note that this template is only for bug reports. 9 | - type: textarea 10 | id: what-happened 11 | attributes: 12 | label: What happened? 13 | description: Please describe the issue briefly. You can use log, screenshots, gifs or videos to further explain your problem. 14 | placeholder: Describe your issue! 15 | validations: 16 | required: true 17 | - type: textarea 18 | id: expected-behavior 19 | attributes: 20 | label: Expected behavior 21 | description: Please provide a clear and concise description of what you expected to happen. 22 | placeholder: Describe the expected behavior! 23 | validations: 24 | required: true 25 | - type: textarea 26 | id: logs 27 | attributes: 28 | label: Relevant log output 29 | description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. Use parameter --debug for full logs. Remeber remove password. 30 | render: shell 31 | - type: input 32 | id: proxmox-ve-version 33 | attributes: 34 | label: Proxmox VE Version 35 | description: Proxmox VE Version 36 | placeholder: 5.X.X 37 | validations: 38 | required: true 39 | - type: input 40 | id: bug-version 41 | attributes: 42 | label: Version (bug) 43 | description: With which version are you experiencing the issue? 44 | placeholder: 1.X.X 45 | validations: 46 | required: true 47 | - type: input 48 | id: working-version 49 | attributes: 50 | label: Version (working) 51 | description: Did it work on a previous version? If so, which version? 52 | placeholder: 1.X.X 53 | - type: dropdown 54 | id: os 55 | attributes: 56 | label: On what operating system are you experiencing the issue? 57 | description: You don't have to test it on every os. 58 | multiple: true 59 | options: 60 | - Windows 61 | - Mac OSX 62 | - Linux 63 | - Other 64 | validations: 65 | required: true 66 | 67 | - type: checkboxes 68 | id: pr 69 | attributes: 70 | label: Pull Request 71 | description: Are you interested in implementing a fix via a Pull Request? That would be the fastest way to resolve your issue. We appreciate every contribution! 72 | options: 73 | - label: I would like to do a Pull Request 74 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.rsuser 8 | *.suo 9 | *.user 10 | *.userosscache 11 | *.sln.docstates 12 | 13 | # User-specific files (MonoDevelop/Xamarin Studio) 14 | *.userprefs 15 | 16 | # Mono auto generated files 17 | mono_crash.* 18 | 19 | # Build results 20 | [Dd]ebug/ 21 | [Dd]ebugPublic/ 22 | [Rr]elease/ 23 | [Rr]eleases/ 24 | x64/ 25 | x86/ 26 | [Aa][Rr][Mm]/ 27 | [Aa][Rr][Mm]64/ 28 | bld/ 29 | [Bb]in/ 30 | [Oo]bj/ 31 | [Ll]og/ 32 | 33 | # Visual Studio 2015/2017 cache/options directory 34 | .vs/ 35 | # Uncomment if you have tasks that create the project's static files in wwwroot 36 | #wwwroot/ 37 | 38 | # Visual Studio 2017 auto generated files 39 | Generated\ Files/ 40 | 41 | # MSTest test Results 42 | [Tt]est[Rr]esult*/ 43 | [Bb]uild[Ll]og.* 44 | 45 | # NUnit 46 | *.VisualState.xml 47 | TestResult.xml 48 | nunit-*.xml 49 | 50 | # Build Results of an ATL Project 51 | [Dd]ebugPS/ 52 | [Rr]eleasePS/ 53 | dlldata.c 54 | 55 | # Benchmark Results 56 | BenchmarkDotNet.Artifacts/ 57 | 58 | # .NET Core 59 | project.lock.json 60 | project.fragment.lock.json 61 | artifacts/ 62 | 63 | # StyleCop 64 | StyleCopReport.xml 65 | 66 | # Files built by Visual Studio 67 | *_i.c 68 | *_p.c 69 | *_h.h 70 | *.ilk 71 | *.meta 72 | *.obj 73 | *.iobj 74 | *.pch 75 | *.pdb 76 | *.ipdb 77 | *.pgc 78 | *.pgd 79 | *.rsp 80 | *.sbr 81 | *.tlb 82 | *.tli 83 | *.tlh 84 | *.tmp 85 | *.tmp_proj 86 | *_wpftmp.csproj 87 | *.log 88 | *.vspscc 89 | *.vssscc 90 | .builds 91 | *.pidb 92 | *.svclog 93 | *.scc 94 | 95 | # Chutzpah Test files 96 | _Chutzpah* 97 | 98 | # Visual C++ cache files 99 | ipch/ 100 | *.aps 101 | *.ncb 102 | *.opendb 103 | *.opensdf 104 | *.sdf 105 | *.cachefile 106 | *.VC.db 107 | *.VC.VC.opendb 108 | 109 | # Visual Studio profiler 110 | *.psess 111 | *.vsp 112 | *.vspx 113 | *.sap 114 | 115 | # Visual Studio Trace Files 116 | *.e2e 117 | 118 | # TFS 2012 Local Workspace 119 | $tf/ 120 | 121 | # Guidance Automation Toolkit 122 | *.gpState 123 | 124 | # ReSharper is a .NET coding add-in 125 | _ReSharper*/ 126 | *.[Rr]e[Ss]harper 127 | *.DotSettings.user 128 | 129 | # JustCode is a .NET coding add-in 130 | .JustCode 131 | 132 | # TeamCity is a build add-in 133 | _TeamCity* 134 | 135 | # DotCover is a Code Coverage Tool 136 | *.dotCover 137 | 138 | # AxoCover is a Code Coverage Tool 139 | .axoCover/* 140 | !.axoCover/settings.json 141 | 142 | # Visual Studio code coverage results 143 | *.coverage 144 | *.coveragexml 145 | 146 | # NCrunch 147 | _NCrunch_* 148 | .*crunch*.local.xml 149 | nCrunchTemp_* 150 | 151 | # MightyMoose 152 | *.mm.* 153 | AutoTest.Net/ 154 | 155 | # Web workbench (sass) 156 | .sass-cache/ 157 | 158 | # Installshield output folder 159 | [Ee]xpress/ 160 | 161 | # DocProject is a documentation generator add-in 162 | DocProject/buildhelp/ 163 | DocProject/Help/*.HxT 164 | DocProject/Help/*.HxC 165 | DocProject/Help/*.hhc 166 | DocProject/Help/*.hhk 167 | DocProject/Help/*.hhp 168 | DocProject/Help/Html2 169 | DocProject/Help/html 170 | 171 | # Click-Once directory 172 | publish/ 173 | 174 | # Publish Web Output 175 | *.[Pp]ublish.xml 176 | *.azurePubxml 177 | # Note: Comment the next line if you want to checkin your web deploy settings, 178 | # but database connection strings (with potential passwords) will be unencrypted 179 | *.pubxml 180 | *.publishproj 181 | 182 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 183 | # checkin your Azure Web App publish settings, but sensitive information contained 184 | # in these scripts will be unencrypted 185 | PublishScripts/ 186 | 187 | # NuGet Packages 188 | *.nupkg 189 | # NuGet Symbol Packages 190 | *.snupkg 191 | # The packages folder can be ignored because of Package Restore 192 | **/[Pp]ackages/* 193 | # except build/, which is used as an MSBuild target. 194 | !**/[Pp]ackages/build/ 195 | # Uncomment if necessary however generally it will be regenerated when needed 196 | #!**/[Pp]ackages/repositories.config 197 | # NuGet v3's project.json files produces more ignorable files 198 | *.nuget.props 199 | *.nuget.targets 200 | 201 | # Microsoft Azure Build Output 202 | csx/ 203 | *.build.csdef 204 | 205 | # Microsoft Azure Emulator 206 | ecf/ 207 | rcf/ 208 | 209 | # Windows Store app package directories and files 210 | AppPackages/ 211 | BundleArtifacts/ 212 | Package.StoreAssociation.xml 213 | _pkginfo.txt 214 | *.appx 215 | *.appxbundle 216 | *.appxupload 217 | 218 | # Visual Studio cache files 219 | # files ending in .cache can be ignored 220 | *.[Cc]ache 221 | # but keep track of directories ending in .cache 222 | !?*.[Cc]ache/ 223 | 224 | # Others 225 | ClientBin/ 226 | ~$* 227 | *~ 228 | *.dbmdl 229 | *.dbproj.schemaview 230 | *.jfm 231 | *.pfx 232 | *.publishsettings 233 | orleans.codegen.cs 234 | 235 | # Including strong name files can present a security risk 236 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 237 | #*.snk 238 | 239 | # Since there are multiple workflows, uncomment next line to ignore bower_components 240 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 241 | #bower_components/ 242 | 243 | # RIA/Silverlight projects 244 | Generated_Code/ 245 | 246 | # Backup & report files from converting an old project file 247 | # to a newer Visual Studio version. Backup files are not needed, 248 | # because we have git ;-) 249 | _UpgradeReport_Files/ 250 | Backup*/ 251 | UpgradeLog*.XML 252 | UpgradeLog*.htm 253 | ServiceFabricBackup/ 254 | *.rptproj.bak 255 | 256 | # SQL Server files 257 | *.mdf 258 | *.ldf 259 | *.ndf 260 | 261 | # Business Intelligence projects 262 | *.rdl.data 263 | *.bim.layout 264 | *.bim_*.settings 265 | *.rptproj.rsuser 266 | *- [Bb]ackup.rdl 267 | *- [Bb]ackup ([0-9]).rdl 268 | *- [Bb]ackup ([0-9][0-9]).rdl 269 | 270 | # Microsoft Fakes 271 | FakesAssemblies/ 272 | 273 | # GhostDoc plugin setting file 274 | *.GhostDoc.xml 275 | 276 | # Node.js Tools for Visual Studio 277 | .ntvs_analysis.dat 278 | node_modules/ 279 | 280 | # Visual Studio 6 build log 281 | *.plg 282 | 283 | # Visual Studio 6 workspace options file 284 | *.opt 285 | 286 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 287 | *.vbw 288 | 289 | # Visual Studio LightSwitch build output 290 | **/*.HTMLClient/GeneratedArtifacts 291 | **/*.DesktopClient/GeneratedArtifacts 292 | **/*.DesktopClient/ModelManifest.xml 293 | **/*.Server/GeneratedArtifacts 294 | **/*.Server/ModelManifest.xml 295 | _Pvt_Extensions 296 | 297 | # Paket dependency manager 298 | .paket/paket.exe 299 | paket-files/ 300 | 301 | # FAKE - F# Make 302 | .fake/ 303 | 304 | # CodeRush personal settings 305 | .cr/personal 306 | 307 | # Python Tools for Visual Studio (PTVS) 308 | __pycache__/ 309 | *.pyc 310 | 311 | # Cake - Uncomment if you are using it 312 | # tools/** 313 | # !tools/packages.config 314 | 315 | # Tabs Studio 316 | *.tss 317 | 318 | # Telerik's JustMock configuration file 319 | *.jmconfig 320 | 321 | # BizTalk build output 322 | *.btp.cs 323 | *.btm.cs 324 | *.odx.cs 325 | *.xsd.cs 326 | 327 | # OpenCover UI analysis results 328 | OpenCover/ 329 | 330 | # Azure Stream Analytics local run output 331 | ASALocalRun/ 332 | 333 | # MSBuild Binary and Structured Log 334 | *.binlog 335 | 336 | # NVidia Nsight GPU debugger configuration file 337 | *.nvuser 338 | 339 | # MFractors (Xamarin productivity tool) working folder 340 | .mfractor/ 341 | 342 | # Local History for Visual Studio 343 | .localhistory/ 344 | 345 | # BeatPulse healthcheck temp database 346 | healthchecksdb 347 | 348 | # Backup folder for Package Reference Convert tool in Visual Studio 2017 349 | MigrationBackup/ 350 | 351 | # Ionide (cross platform F# VS Code tools) working folder 352 | .ionide/ 353 | 354 | *.parm 355 | 356 | artifacts_exe/ 357 | dotnet-releaser.toml -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.2.0", 3 | "configurations": [ 4 | { 5 | // Usare IntelliSense per individuare gli attributi esistenti per il debug C# 6 | // Usa il passaggio del mouse per la descrizione degli attributi esistenti 7 | // Per ulteriori informazioni, visitare https://github.com/dotnet/vscode-csharp/blob/main/debugger-launchjson.md 8 | "name": ".NET Core Launch (console)", 9 | "type": "coreclr", 10 | "request": "launch", 11 | "preLaunchTask": "build", 12 | // Se i framework di destinazione sono stati modificati, assicurarsi di aggiornare il percorso del programma. 13 | "program": "${workspaceFolder}/src/Corsinvest.ProxmoxVE.AutoSnap/bin/Debug/net9.0/cv4pve-autosnap.dll", 14 | "args": [ 15 | "@Parm.parm" 16 | ], 17 | "cwd": "${workspaceFolder}/src/Corsinvest.ProxmoxVE.AutoSnap", 18 | // Per ulteriori informazioni sul campo 'console', vedere https://aka.ms/VSCode-CS-LaunchJson-Console 19 | "console": "internalConsole", 20 | "stopAtEntry": false 21 | }, 22 | { 23 | "name": ".NET Core Attach", 24 | "type": "coreclr", 25 | "request": "attach" 26 | } 27 | ] 28 | } -------------------------------------------------------------------------------- /.vscode/tasks.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "2.0.0", 3 | "tasks": [ 4 | { 5 | "label": "build", 6 | "command": "dotnet", 7 | "type": "process", 8 | "args": [ 9 | "build", 10 | "${workspaceFolder}/Corsinvest.ProxmoxVE.AutoSnap.sln", 11 | "/property:GenerateFullPaths=true", 12 | "/consoleloggerparameters:NoSummary;ForceNoAlign" 13 | ], 14 | "problemMatcher": "$msCompile" 15 | }, 16 | { 17 | "label": "publish", 18 | "command": "dotnet", 19 | "type": "process", 20 | "args": [ 21 | "publish", 22 | "${workspaceFolder}/Corsinvest.ProxmoxVE.AutoSnap.sln", 23 | "/property:GenerateFullPaths=true", 24 | "/consoleloggerparameters:NoSummary;ForceNoAlign" 25 | ], 26 | "problemMatcher": "$msCompile" 27 | }, 28 | { 29 | "label": "watch", 30 | "command": "dotnet", 31 | "type": "process", 32 | "args": [ 33 | "watch", 34 | "run", 35 | "--project", 36 | "${workspaceFolder}/Corsinvest.ProxmoxVE.AutoSnap.sln" 37 | ], 38 | "problemMatcher": "$msCompile" 39 | } 40 | ] 41 | } -------------------------------------------------------------------------------- /3rd-party-licenses.md: -------------------------------------------------------------------------------- 1 | # License overview of included 3rd party libraries 2 | 3 | The project is licensed under the terms of the [LICENSE.md](LICENSE.md) 4 | 5 | However, includes several third-party Open-Source libraries, which are licensed under their own respective Open-Source licenses. 6 | 7 | ## Libraries directly included 8 | 9 | [Corsinvest ProxmoxVE Api](https://github.com/Corsinvest/cv4pve-api-dotnet) 10 | License: GPLv3 11 | 12 | [Corsinvest ProxmoxVE Api Extension](https://github.com/Corsinvest/cv4pve-api-dotnet) 13 | License: GPLv3 14 | 15 | [Dotnet Core](https://github.com/dotnet/core) 16 | License: MIT 17 | -------------------------------------------------------------------------------- /Corsinvest.ProxmoxVE.AutoSnap.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 17 4 | VisualStudioVersion = 17.1.32210.238 5 | MinimumVisualStudioVersion = 15.0.26124.0 6 | Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{C6B0694C-362C-4BEE-8EBA-28ECF5780D57}" 7 | EndProject 8 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Corsinvest.ProxmoxVE.AutoSnap", "src\Corsinvest.ProxmoxVE.AutoSnap\Corsinvest.ProxmoxVE.AutoSnap.csproj", "{6D4D450B-25C7-4CC8-AFB5-3EFCBD32EC37}" 9 | EndProject 10 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Corsinvest.ProxmoxVE.AutoSnap.Api", "src\Corsinvest.ProxmoxVE.AutoSnap.Api\Corsinvest.ProxmoxVE.AutoSnap.Api.csproj", "{857DC686-6FB8-4FA6-8534-B062768152E3}" 11 | EndProject 12 | Global 13 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 14 | Debug|Any CPU = Debug|Any CPU 15 | Debug|x64 = Debug|x64 16 | Debug|x86 = Debug|x86 17 | Release|Any CPU = Release|Any CPU 18 | Release|x64 = Release|x64 19 | Release|x86 = Release|x86 20 | EndGlobalSection 21 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 22 | {6D4D450B-25C7-4CC8-AFB5-3EFCBD32EC37}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 23 | {6D4D450B-25C7-4CC8-AFB5-3EFCBD32EC37}.Debug|Any CPU.Build.0 = Debug|Any CPU 24 | {6D4D450B-25C7-4CC8-AFB5-3EFCBD32EC37}.Debug|x64.ActiveCfg = Debug|Any CPU 25 | {6D4D450B-25C7-4CC8-AFB5-3EFCBD32EC37}.Debug|x64.Build.0 = Debug|Any CPU 26 | {6D4D450B-25C7-4CC8-AFB5-3EFCBD32EC37}.Debug|x86.ActiveCfg = Debug|Any CPU 27 | {6D4D450B-25C7-4CC8-AFB5-3EFCBD32EC37}.Debug|x86.Build.0 = Debug|Any CPU 28 | {6D4D450B-25C7-4CC8-AFB5-3EFCBD32EC37}.Release|Any CPU.ActiveCfg = Release|Any CPU 29 | {6D4D450B-25C7-4CC8-AFB5-3EFCBD32EC37}.Release|Any CPU.Build.0 = Release|Any CPU 30 | {6D4D450B-25C7-4CC8-AFB5-3EFCBD32EC37}.Release|x64.ActiveCfg = Release|Any CPU 31 | {6D4D450B-25C7-4CC8-AFB5-3EFCBD32EC37}.Release|x64.Build.0 = Release|Any CPU 32 | {6D4D450B-25C7-4CC8-AFB5-3EFCBD32EC37}.Release|x86.ActiveCfg = Release|Any CPU 33 | {6D4D450B-25C7-4CC8-AFB5-3EFCBD32EC37}.Release|x86.Build.0 = Release|Any CPU 34 | {857DC686-6FB8-4FA6-8534-B062768152E3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 35 | {857DC686-6FB8-4FA6-8534-B062768152E3}.Debug|Any CPU.Build.0 = Debug|Any CPU 36 | {857DC686-6FB8-4FA6-8534-B062768152E3}.Debug|x64.ActiveCfg = Debug|Any CPU 37 | {857DC686-6FB8-4FA6-8534-B062768152E3}.Debug|x64.Build.0 = Debug|Any CPU 38 | {857DC686-6FB8-4FA6-8534-B062768152E3}.Debug|x86.ActiveCfg = Debug|Any CPU 39 | {857DC686-6FB8-4FA6-8534-B062768152E3}.Debug|x86.Build.0 = Debug|Any CPU 40 | {857DC686-6FB8-4FA6-8534-B062768152E3}.Release|Any CPU.ActiveCfg = Release|Any CPU 41 | {857DC686-6FB8-4FA6-8534-B062768152E3}.Release|Any CPU.Build.0 = Release|Any CPU 42 | {857DC686-6FB8-4FA6-8534-B062768152E3}.Release|x64.ActiveCfg = Release|Any CPU 43 | {857DC686-6FB8-4FA6-8534-B062768152E3}.Release|x64.Build.0 = Release|Any CPU 44 | {857DC686-6FB8-4FA6-8534-B062768152E3}.Release|x86.ActiveCfg = Release|Any CPU 45 | {857DC686-6FB8-4FA6-8534-B062768152E3}.Release|x86.Build.0 = Release|Any CPU 46 | EndGlobalSection 47 | GlobalSection(SolutionProperties) = preSolution 48 | HideSolutionNode = FALSE 49 | EndGlobalSection 50 | GlobalSection(NestedProjects) = preSolution 51 | {6D4D450B-25C7-4CC8-AFB5-3EFCBD32EC37} = {C6B0694C-362C-4BEE-8EBA-28ECF5780D57} 52 | {857DC686-6FB8-4FA6-8534-B062768152E3} = {C6B0694C-362C-4BEE-8EBA-28ECF5780D57} 53 | EndGlobalSection 54 | GlobalSection(ExtensibilityGlobals) = postSolution 55 | SolutionGuid = {FF0CE8AE-82AF-4E55-B4CF-21752D47280F} 56 | EndGlobalSection 57 | EndGlobal 58 | -------------------------------------------------------------------------------- /Initialize-Tools.ps1: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: Copyright Corsinvest Srl 2 | # SPDX-License-Identifier: GPL-3.0-only 3 | 4 | Import-Module ..\..\..\cmds\Corsinvest.Dotnet.Develop.psm1 -Verbose -Force -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # cv4pve-autosnap 2 | 3 | [![License](https://img.shields.io/github/license/Corsinvest/cv4pve-autosnap.svg)](LICENSE.md) [![Release](https://img.shields.io/github/release/Corsinvest/cv4pve-autosnap.svg)](https://github.com/Corsinvest/cv4pve-autosnap/releases/latest) ![GitHub All Releases](https://img.shields.io/github/downloads/Corsinvest/cv4pve-autosnap/total.svg) 4 | [![Nuget](https://img.shields.io/nuget/v/Corsinvest.ProxmoxVE.AutoSnap.Api.svg)](https://www.nuget.org/packages/Corsinvest.ProxmoxVE.AutoSnap.Api/) 5 | [![.NET C#](https://img.shields.io/badge/.NET-C%23-blue)](https://docs.microsoft.com/en-us/dotnet/csharp/) 6 | 7 | Proxmox VE automatic snapshot tool 8 | 9 | [More information about cv4pve-autosnap](http://www.corsinvest.it/continuous-protection-data-proxmox-ve/) 10 | 11 | [More information about Qemu guest agent](https://pve.proxmox.com/wiki/Qemu-guest-agent) 12 | 13 | :star: We appreciate your star, it helps! 14 | 15 | ```text 16 | ______ _ __ 17 | / ____/___ __________(_)___ _ _____ _____/ /_ 18 | / / / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/ 19 | / /___/ /_/ / / (__ ) / / / / |/ / __(__ ) /_ 20 | \____/\____/_/ /____/_/_/ /_/|___/\___/____/\__/ 21 | 22 | 23 | Automatic snapshot VM/CT with retention (Made in Italy) 24 | 25 | cv4pve-autosnap is a part of suite cv4pve. 26 | For more information visit https://www.corsinvest.it/cv4pve 27 | 28 | Usage: 29 | cv4pve-autosnap [command] [options] 30 | 31 | Options: 32 | --api-token Api token format 'USER@REALM!TOKENID=UUID'. Require Proxmox VE 6.2 or later 33 | --username User name @ 34 | --password The password. Specify 'file:path_file' to store password in file. 35 | --validate-certificate Validate SSL Certificate Proxmox VE node. 36 | --host (REQUIRED) The host name host[:port],host1[:port],host2[:port] 37 | --vmid (REQUIRED) The id or name VM/CT comma separated (eg. 100,101,102,TestDebian) 38 | -vmid,-name,-@node-???,-@tag-?? exclude from list (e.g. @all,-200,-TestUbuntu,-@tag-customer1) 39 | range 100:107,-105,200:204 40 | '@pool-???' for all VM/CT in specific pool (e.g. @pool-customer1), 41 | '@tag-???' for all VM/CT in specific tags (e.g. @tag-customerA), 42 | '@node-???' for all VM/CT in specific node (e.g. @node-pve1, @node-\$(hostname)), 43 | '@all-???' for all VM/CT in specific host (e.g. @all-pve1, @all-\$(hostname)), 44 | '@all' for all VM/CT in cluster 45 | --timeout Timeout operation in seconds [default: 30] 46 | --timestamp-format Specify different timestamp format [default: yyMMddHHmmss] 47 | --max-perc-storage Max percentage storage [default: 95] 48 | --version Show version information 49 | -?, -h, --help Show help and usage information 50 | 51 | Commands: 52 | snap Will snap one time 53 | clean Remove auto snapshots 54 | status Get list of all auto snapshots 55 | ``` 56 | 57 | ## Copyright and License 58 | 59 | Copyright: Corsinvest Srl 60 | For licensing details please visit [LICENSE.md](LICENSE.md) 61 | 62 | ## Commercial Support 63 | 64 | This software is part of a suite of tools called cv4pve-tools. If you want commercial support, visit the [site](https://www.cv4pve-tools.com) 65 | 66 | ## Tutorial 67 | 68 | [![Tutorial](http://img.youtube.com/vi/kM5KhD9seT4/0.jpg)](https://www.youtube.com/watch?v=kM5KhD9seT4 "Tutorial") 69 | 70 | ## Web GUI Version in cv4pve-admin 71 | 72 | [![cv4pve-admin](https://raw.githubusercontent.com/Corsinvest/cv4pve-admin/main/src/Corsinvest.ProxmoxVE.Admin/wwwroot/doc/images/screenshot/modules/autosnap/modules-safe-autosnap.png)](https://github.com/Corsinvest/cv4pve-admin) 73 | 74 | ## Introduction 75 | 76 | Automatic snapshot for Proxmox VE with retention. 77 | 78 | In this version the tool works outside the Proxmox VE host using the API. The reasons are: 79 | 80 | * if the host does not work the tool does not work 81 | * using the API, future changes are guaranteed 82 | * Root access is not required, a user is required to perform the operation 83 | * use of standard https / https json technology 84 | 85 | ## Main features 86 | 87 | * Completely written in C# 88 | * Use native Api REST Proxmox VE (library C#) 89 | * Independent os (Windows, Linux, Macosx) 90 | * Installation rapid, unzip file extract binary 91 | * Not require installation in Proxmox VE 92 | * Execute out side Proxmox VE 93 | * For KVM and LXC 94 | * Work for single node or cluster, automatically resolve VM/CT id/name 95 | * Use id or name with --vmid parameter 96 | * Can keep multiple snapshots --keep 97 | * Clean all snapshots 98 | * Multiple schedule VM/CT using --label (es. daily,monthly) 99 | * Hook script 100 | * Multiple VM/CT (100,102,ubuVm,debVm,pipperoVm,fagianoVm or all or pool) in a single execution 101 | * Exclusion specific VM/CT using minus e.g --vmid=all,-100 102 | * Exclusion template from snapshot 103 | * Waiting for the snapshot process to finish 104 | * Alerting in QEMU, agent not enabled. 105 | * Save memory VM Qemu in snap using parameter --state. 106 | * No stop on error 107 | * Script hook for [metrics](https://github.com/Corsinvest/cv4pve-metrics) 108 | * Timeout remove/create snapshot in --timeout parameter specify in second 109 | * Support multiple host for HA in --host parameter es. host[:port],host1[:port],host2[:port] 110 | * Multiple output text,unicode,unicodeAlt,markdown,html 111 | * Use Api token --api-token parameter 112 | * Support range vmid 100:103,134,200:204,-102 113 | * Support different timestamp format with parameter --timestamp-format 114 | * Check the storage space used by the disks in the VM / CT is available by default (95%) parameter --max-perc-storage 115 | * Execution with file parameter e.g. @FileParameter.parm 116 | * Snapshots are removed with **force** parameter 117 | * Decide only runs VM/CT 118 | * Support [Proxmox VE Tags](https://pve.proxmox.com/pve-docs/pve-admin-guide.html#_tags) in vmid 119 | * Validate certificate SSL, default not validate 120 | 121 | ## Permission 122 | 123 | For execution is required permission: VM.Audit, VM.Snapshot, Datastore.Audit, Pool.Audit. 124 | 125 | ## Api token 126 | 127 | From version 6.2 of Proxmox VE is possible to use [Api token](https://pve.proxmox.com/pve-docs/pveum-plain.html). 128 | This feature permit execute Api without using user and password. 129 | If using **Privilege Separation** when create api token remember specify in permission. 130 | 131 | ## Custom timestamp format 132 | 133 | Timestamp format is based on [C# date and time format string](https://docs.microsoft.com/it-it/dotnet/standard/base-types/custom-date-and-time-format-strings). 134 | 135 | ## Configuration and use 136 | 137 | E.g. install on linux 64 138 | 139 | Download last package e.g. Debian cv4pve-autosnap-linux-x64.zip, on your os and install: 140 | 141 | ```sh 142 | root@debian:~# unzip cv4pve-autosnap-linux-x64.zip 143 | ``` 144 | 145 | This tool need basically no configuration. 146 | 147 | ## Snapshot a VM/CT one time 148 | 149 | ```sh 150 | root@debian:~# cv4pve-autosnap --host=192.168.0.100 --username=root@pam --password=fagiano --vmid=111 snap --label=daily --keep=2 151 | ``` 152 | 153 | This command snap VM 111. 154 | 155 | ```sh 156 | root@debian:~# cv4pve-autosnap --host=192.168.0.100 --username=root@pam --password=fagiano --vmid="all,-111" snap --label=daily --keep=2 157 | ACTION Snap 158 | VMs: all,-111 159 | Label: daily 160 | Keep: 2 161 | State: False 162 | Timeout: 30000 163 | Timestamp format: yyMMddHHmmss 164 | Max % Storage : 95% 165 | ---------------------------------------------------------------------------- 166 | | Storage | Type | Valid | Used % | Max Disk (GB) | Disk (GB) | 167 | ---------------------------------------------------------------------------- 168 | | cv-pve01/hddpool | zfspool | Ok | 58.2 | 1797 | 1046 | 169 | | cv-pve01/nfs-arc | nfs | Ok | 21.1 | 3269 | 689 | 170 | | cv-pve01/ssdpool | zfspool | Ok | 24.4 | 859 | 209 | 171 | | cv-pve02/hddpool | zfspool | Ok | 71.7 | 1797 | 1288 | 172 | | cv-pve02/nfs-arc | nfs | Ok | 21.1 | 3269 | 689 | 173 | | cv-pve02/ssdpool | zfspool | Ok | 5.5 | 898 | 49 | 174 | ---------------------------------------------------------------------------- 175 | ----- VM 103 Qemu ----- 176 | VM 103 consider enabling QEMU agent see https://pve.proxmox.com/wiki/Qemu-guest-agent 177 | Create snapshot: autodaily211203164953 178 | Remove snapshot: autodaily211202164953 179 | VM execution 00:00:02.3060904 180 | ----- VM 105 Qemu ----- 181 | Create snapshot: autodaily211203164955 182 | Remove snapshot: autodaily211202164955 183 | .... 184 | ``` 185 | 186 | This command snap all VMs except 111. 187 | 188 | The --keep tells that it should be kept 2 snapshots, if there are more than 2 snapshots, the 3 one will be erased (sorted by creation time). 189 | The --state save memory VM. 190 | The --timeout specify the timeout remove/creation snapshot. 191 | 192 | When create a snapshot the software add "auto" prefix of the name the snapshot. 193 | 194 | On the VM it is checked if "QEMU agent" is enabled, otherwise an alert is displayed. 195 | 196 | ## Clean a VM/CT one time 197 | 198 | ```sh 199 | root@debian:~# cv4pve-autosnap --host=192.168.0.100 --username=root@pam --password=fagiano --vmid=111 clean --label=4hours --keep=2 200 | ----- VM 100 QEMU ----- 201 | Remove snapshot: auto4hours190617080002 202 | Remove snapshot: auto4hours190617120002 203 | Remove snapshot: auto4hours190617160002 204 | Remove snapshot: auto4hours190617200002 205 | ``` 206 | 207 | ## Status snapshots 208 | 209 | ```sh 210 | root@debian:~# cv4pve-autosnap --host=192.168.0.100 --username=root@pam --password=fagiano --vmid=100 status 211 | 212 | ┌──────┬─────┬───────────────────┬──────────────────────────────┬──────────────────────────────┬─────────────────┬─────┐ 213 | │ NODE │ VM │ TIME │ PARENT │ NAME │ DESCRIPTION │ RAM │ 214 | ├──────┼─────┼───────────────────┼──────────────────────────────┼──────────────────────────────┼─────────────────┼─────┤ 215 | │ pve1 │ 100 │ 19/08/28 09:21:35 │ no-parent │ auto4hours190828112133 │ cv4pve-autosnap │ │ 216 | │ pve1 │ 100 │ 19/08/28 12:23:09 │ auto4hours190828112133 │ auto4hours190828142307 │ cv4pve-autosnap │ │ 217 | │ pve1 │ 100 │ 19/08/29 06:50:23 │ auto4hours190828142307 │ auto4hours190829085021 │ cv4pve-autosnap │ │ 218 | │ pve1 │ 100 │ 19/08/29 07:32:15 │ auto4hours190829085021 │ auto4hours190829093214 │ cv4pve-autosnap │ │ 219 | └──────┴─────┴───────────────────┴──────────────────────────────┴──────────────────────────────┴─────────────────┴─────┘ 220 | ``` 221 | 222 | Output type: 223 | 224 | ```Text 225 | -o|--output Type output (default: text) Text,Json,JsonPretty 226 | 227 | ``` 228 | 229 | ## Execution with file parameter 230 | 231 | Is possible execute with file parameter 232 | 233 | ```sh 234 | root@debian:~# cv4pve-autosnap @FileParameter.parm 235 | ``` 236 | 237 | File **FileParameter.parm** 238 | 239 | ```txt 240 | --host=192.168.0.100 241 | --username=root@pam 242 | --password=fagiano 243 | --vmid=100 244 | status 245 | ``` 246 | 247 | ## Hook script 248 | 249 | Before run hook script, program create environment variable: 250 | 251 | ```sh 252 | CV4PVE_AUTOSNAP_PHASE 253 | CV4PVE_AUTOSNAP_VMID 254 | CV4PVE_AUTOSNAP_VMNAME 255 | CV4PVE_AUTOSNAP_VMTYPE 256 | CV4PVE_AUTOSNAP_LABEL 257 | CV4PVE_AUTOSNAP_KEEP 258 | CV4PVE_AUTOSNAP_SNAP_NAME 259 | CV4PVE_AUTOSNAP_VMSTATE #1/0 260 | CV4PVE_AUTOSNAP_DEBUG #1/0 261 | CV4PVE_AUTOSNAP_DRY_RUN #1/0 262 | CV4PVE_AUTOSNAP_DURATION 263 | CV4PVE_AUTOSNAP_STATE #1/0 264 | ``` 265 | 266 | See example hook file script-hook.bat, script-hook.sh 267 | 268 | ## Some words about Snapshot consistency and what qemu-guest-agent can do for you 269 | 270 | Bear in mind, that when taking a snapshot of a running VM, it's basically like if you have a server which gets pulled away from the Power. Often this is not cathastrophic as the next fsck will try to fix Filesystem Issues, but in the worst case this could leave you with a severely damaged Filesystem, or even worse, half written Inodes which were in-flight when the power failed lead to silent data corruption. To overcome these things, we have the qemu-guest-agent to improve the consistency of the Filesystem while taking a snapshot. It won't leave you a clean filesystem, but it sync()'s outstanding writes and halts all i/o until the snapshot is complete. Still, there might me issues on the Application layer. Databases processes might have unwritten data in memory, which is the most common case. Here you have the opportunity to do additional tuning, and use hooks to tell your vital processes things to do prio and post freezes. 271 | 272 | First, you want to make sure that your guest has the qemu-guest-agent running and is working properly. Now we use custom hooks to tell your services with volatile data, to flush all unwritten data to disk. On debian based linux systems the hook file can be set in ```/etc/default/qemu-guest-agent``` and could simply contain this line: 273 | 274 | ```sh 275 | DAEMON_ARGS="-F/etc/qemu/fsfreeze-hook" 276 | ``` 277 | 278 | Create ```/etc/qemu/fsfreeze-hook``` and make ist look like: 279 | 280 | ```sh 281 | #!/bin/sh 282 | 283 | # This script is executed when a guest agent receives fsfreeze-freeze and 284 | # fsfreeze-thaw command, if it is specified in --fsfreeze-hook (-F) 285 | # option of qemu-ga or placed in default path (/etc/qemu/fsfreeze-hook). 286 | # When the agent receives fsfreeze-freeze request, this script is issued with 287 | # "freeze" argument before the filesystem is frozen. And for fsfreeze-thaw 288 | # request, it is issued with "thaw" argument after filesystem is thawed. 289 | 290 | LOGFILE=/var/log/qga-fsfreeze-hook.log 291 | FSFREEZE_D=$(dirname -- "$0")/fsfreeze-hook.d 292 | 293 | # Check whether file $1 is a backup or rpm-generated file and should be ignored 294 | is_ignored_file() { 295 | case "$1" in 296 | *~ | *.bak | *.orig | *.rpmnew | *.rpmorig | *.rpmsave | *.sample | *.dpkg-old | *.dpkg-new | *.dpkg-tmp | *.dpkg-dist | 297 | *.dpkg-bak | *.dpkg-backup | *.dpkg-remove) 298 | return 0 ;; 299 | esac 300 | return 1 301 | } 302 | 303 | # Iterate executables in directory "fsfreeze-hook.d" with the specified args 304 | [ ! -d "$FSFREEZE_D" ] && exit 0 305 | for file in "$FSFREEZE_D"/* ; do 306 | is_ignored_file "$file" && continue 307 | [ -x "$file" ] || continue 308 | printf "$(date): execute $file $@\n" >>$LOGFILE 309 | "$file" "$@" >>$LOGFILE 2>&1 310 | STATUS=$? 311 | printf "$(date): $file finished with status=$STATUS\n" >>$LOGFILE 312 | done 313 | 314 | exit 0 315 | ``` 316 | 317 | For testing purposes place this into ```/etc/qemu/fsfreeze-hook.d/10-info```: 318 | 319 | ```sh 320 | #!/bin/bash 321 | dt=$(date +%s) 322 | 323 | case "$1" in 324 | freeze) 325 | echo "frozen on $dt" | tee >(cat >/tmp/fsfreeze) 326 | ;; 327 | thaw) 328 | echo "thawed on $dt" | tee >(cat >>/tmp/fsfreeze) 329 | ;; 330 | esac 331 | 332 | ``` 333 | 334 | Now you can place files for different Services in ```/etc/qemu/fsfreeze-hook.d/``` that tell those services what to to prior and post snapshots. A very common example is mysql. Create a file ```/etc/qemu/fsfreeze-hook.d/20-mysql``` containing 335 | 336 | ```sh 337 | #!/bin/sh 338 | 339 | # Flush MySQL tables to the disk before the filesystem is frozen. 340 | # At the same time, this keeps a read lock in order to avoid write accesses 341 | # from the other clients until the filesystem is thawed. 342 | 343 | MYSQL="/usr/bin/mysql" 344 | MYSQL_OPTS="-uroot" 345 | MYSQL_PWD="mypassword" 346 | FIFO=/var/run/mysql-flush.fifo 347 | 348 | # Check mysql is installed and the server running 349 | [ -x "$MYSQL" ] && "$MYSQL" $MYSQL_OPTS < /dev/null || exit 0 350 | 351 | flush_and_wait() { 352 | printf "FLUSH TABLES WITH READ LOCK \\G\n" 353 | trap 'printf "$(date): $0 is killed\n">&2' HUP INT QUIT ALRM TERM 354 | read < $FIFO 355 | printf "UNLOCK TABLES \\G\n" 356 | rm -f $FIFO 357 | } 358 | 359 | case "$1" in 360 | freeze) 361 | mkfifo $FIFO || exit 1 362 | flush_and_wait | "$MYSQL" $MYSQL_OPTS & 363 | # wait until every block is flushed 364 | while [ "$(echo 'SHOW STATUS LIKE "Key_blocks_not_flushed"' |\ 365 | "$MYSQL" $MYSQL_OPTS | tail -1 | cut -f 2)" -gt 0 ]; do 366 | sleep 1 367 | done 368 | # for InnoDB, wait until every log is flushed 369 | INNODB_STATUS=$(mktemp /tmp/mysql-flush.XXXXXX) 370 | [ $? -ne 0 ] && exit 2 371 | trap "rm -f $INNODB_STATUS; exit 1" HUP INT QUIT ALRM TERM 372 | while :; do 373 | printf "SHOW ENGINE INNODB STATUS \\G" |\ 374 | "$MYSQL" $MYSQL_OPTS > $INNODB_STATUS 375 | LOG_CURRENT=$(grep 'Log sequence number' $INNODB_STATUS |\ 376 | tr -s ' ' | cut -d' ' -f4) 377 | LOG_FLUSHED=$(grep 'Log flushed up to' $INNODB_STATUS |\ 378 | tr -s ' ' | cut -d' ' -f5) 379 | [ "$LOG_CURRENT" = "$LOG_FLUSHED" ] && break 380 | sleep 1 381 | done 382 | rm -f $INNODB_STATUS 383 | ;; 384 | 385 | thaw) 386 | [ ! -p $FIFO ] && exit 1 387 | echo > $FIFO 388 | ;; 389 | 390 | *) 391 | exit 1 392 | ;; 393 | esac 394 | ``` 395 | -------------------------------------------------------------------------------- /icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Corsinvest/cv4pve-autosnap/dd05828f37b652fb54f5bbd6bc61af256212d371/icon.png -------------------------------------------------------------------------------- /script-hook.bat: -------------------------------------------------------------------------------- 1 | @ECHO OFF 2 | REM SPDX-License-Identifier: GPL-3.0-only 3 | REM SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl 4 | REM 5 | REM Corsinvest automatic snapshot for Proxmox VE cv4pve-autosnap hook script. 6 | REM Process environment variables as received from and set by cv4pve-autosnap. 7 | 8 | ECHO ---------------------------------------------------------- 9 | ECHO CV4PVE_AUTOSNAP_PHASE: %CV4PVE_AUTOSNAP_PHASE% 10 | ECHO CV4PVE_AUTOSNAP_VMID: %CV4PVE_AUTOSNAP_VMID% 11 | ECHO CV4PVE_AUTOSNAP_VMNAME: %CV4PVE_AUTOSNAP_VMNAME% 12 | ECHO CV4PVE_AUTOSNAP_VMTECHNOLOGY: %CV4PVE_AUTOSNAP_VMTECHNOLOGY% 13 | ECHO CV4PVE_AUTOSNAP_LABEL: %CV4PVE_AUTOSNAP_LABEL% 14 | ECHO CV4PVE_AUTOSNAP_KEEP: %CV4PVE_AUTOSNAP_KEEP% 15 | ECHO CV4PVE_AUTOSNAP_VMSTATE: %CV4PVE_AUTOSNAP_VMSTATE% 16 | ECHO CV4PVE_AUTOSNAP_SNAP_NAME: %CV4PVE_AUTOSNAP_SNAP_NAME% 17 | ECHO CV4PVE_AUTOSNAP_DEBUG: %CV4PVE_AUTOSNAP_DEBUG% 18 | ECHO CV4PVE_AUTOSNAP_DRY_RUN: %CV4PVE_AUTOSNAP_DRYRUN% 19 | ECHO CV4PVE_AUTOSNAP_DURATION %CV4PVE_AUTOSNAP_DURATION% 20 | ECHO CV4PVE_AUTOSNAP_STATE %CV4PVE_AUTOSNAP_STATE% 21 | 22 | IF "%CV4PVE_AUTOSNAP_PHASE%"=="clean-job-start" ( 23 | REM 24 | ) ELSE IF "%CV4PVE_AUTOSNAP_PHASE%"=="clean-job-end" ( 25 | REM 26 | ) ELSE IF "%CV4PVE_AUTOSNAP_PHASE%"=="snap-job-start" ( 27 | REM 28 | ) ELSE IF "%CV4PVE_AUTOSNAP_PHASE%"=="snap-job-end" ( 29 | REM 30 | ) ELSE IF "%CV4PVE_AUTOSNAP_PHASE%"=="snap-create-pre" ( 31 | REM 32 | ) ELSE IF "%CV4PVE_AUTOSNAP_PHASE%"=="snap-create-post" ( 33 | REM 34 | ) ELSE IF "%CV4PVE_AUTOSNAP_PHASE%"=="snap-create-abort" ( 35 | REM 36 | ) ELSE IF "%CV4PVE_AUTOSNAP_PHASE%"=="snap-remove-pre" ( 37 | REM 38 | ) ELSE IF "%CV4PVE_AUTOSNAP_PHASE%"=="snap-remove-post" ( 39 | REM 40 | ) ELSE IF "%CV4PVE_AUTOSNAP_PHASE%"=="snap-remove-abort" ( 41 | REM 42 | ) ELSE ( 43 | ECHO "unknown phase '$CV4PVE_AUTOSNAP_PHASE'" 44 | EXIT 1 45 | ) -------------------------------------------------------------------------------- /script-hook.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # SPDX-License-Identifier: GPL-3.0-only 3 | # SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl 4 | # 5 | # Corsinvest automatic snapshot for Proxmox VE cv4pve-autosnap hook script. 6 | # Process environment variables as received from and set by cv4pve-autosnap. 7 | 8 | hook() { 9 | echo "----------------------------------------------------------" 10 | echo "CV4PVE_AUTOSNAP_PHASE: $CV4PVE_AUTOSNAP_PHASE" 11 | echo "CV4PVE_AUTOSNAP_VMID: $CV4PVE_AUTOSNAP_VMID" 12 | echo "CV4PVE_AUTOSNAP_VMNAME: $CV4PVE_AUTOSNAP_VMNAME" 13 | echo "CV4PVE_AUTOSNAP_VMTECHNOLOGY: $CV4PVE_AUTOSNAP_VMTECHNOLOGY" 14 | echo "CV4PVE_AUTOSNAP_LABEL: $CV4PVE_AUTOSNAP_LABEL" 15 | echo "CV4PVE_AUTOSNAP_KEEP: $CV4PVE_AUTOSNAP_KEEP" 16 | echo "CV4PVE_AUTOSNAP_VMSTATE: $CV4PVE_AUTOSNAP_VMSTATE" 17 | echo "CV4PVE_AUTOSNAP_SNAP_NAME: $CV4PVE_AUTOSNAP_SNAP_NAME" 18 | echo "CV4PVE_AUTOSNAP_DEBUG: $CV4PVE_AUTOSNAP_DEBUG" 19 | echo "CV4PVE_AUTOSNAP_DRY_RUN: $CV4PVE_AUTOSNAP_DRY_RUN" 20 | echo "CV4PVE_AUTOSNAP_DURATION $CV4PVE_AUTOSNAP_DURATION" 21 | echo "CV4PVE_AUTOSNAP_STATE $CV4PVE_AUTOSNAP_STATE" 22 | 23 | case "$CV4PVE_AUTOSNAP_PHASE" in 24 | #clean job status 25 | clean-job-start);; 26 | clean-job-end);; 27 | 28 | #snap job status 29 | snap-job-start);; 30 | snap-job-end);; 31 | 32 | #create snapshot 33 | snap-create-pre);; 34 | snap-create-post);; 35 | snap-create-abort);; 36 | 37 | #remove snapshot 38 | snap-remove-pre);; 39 | snap-remove-post);; 40 | snap-remove-abort);; 41 | 42 | *) echo "unknown phase '$CV4PVE_AUTOSNAP_PHASE'"; return 1;; 43 | esac 44 | } 45 | 46 | hook -------------------------------------------------------------------------------- /src/Corsinvest.ProxmoxVE.AutoSnap.Api/Application.cs: -------------------------------------------------------------------------------- 1 | /* 2 | * SPDX-License-Identifier: GPL-3.0-only 3 | * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl 4 | */ 5 | 6 | using System.ComponentModel; 7 | using System.Diagnostics; 8 | using System.Text; 9 | using Corsinvest.ProxmoxVE.Api; 10 | using Corsinvest.ProxmoxVE.Api.Extension; 11 | using Corsinvest.ProxmoxVE.Api.Extension.Utils; 12 | using Corsinvest.ProxmoxVE.Api.Shared.Models.Cluster; 13 | using Corsinvest.ProxmoxVE.Api.Shared.Models.Vm; 14 | using Corsinvest.ProxmoxVE.Api.Shared.Utils; 15 | using Microsoft.Extensions.Logging; 16 | 17 | namespace Corsinvest.ProxmoxVE.AutoSnap.Api 18 | { 19 | /// 20 | /// Command autosnap. 21 | /// 22 | public class Application 23 | { 24 | private readonly ILogger _logger; 25 | 26 | /// 27 | /// Permissions request 28 | /// 29 | /// 30 | public IEnumerable Permissions { get; } = new[] { "VM.Audit", "VM.Snapshot", "Datastore.Audit", "Pool.Allocate" }; 31 | 32 | private static readonly string Prefix = "auto"; 33 | 34 | /// 35 | /// Default time stamp format 36 | /// 37 | public static readonly string DefaultTimestampFormat = "yyMMddHHmmss"; 38 | 39 | /// 40 | /// Application name 41 | /// 42 | public static readonly string Name = "cv4pve-autosnap"; 43 | 44 | /// 45 | /// Old application name 46 | /// 47 | private static readonly string OldName = "eve4pve-autosnap"; 48 | 49 | private readonly PveClient _client; 50 | private readonly bool _dryRun; 51 | private readonly TextWriter _out; 52 | 53 | /// 54 | /// Constructor command 55 | /// 56 | /// 57 | /// 58 | /// 59 | /// 60 | public Application(PveClient client, ILoggerFactory loggerFactory, TextWriter @out, bool dryRun) 61 | { 62 | _client = client; 63 | _dryRun = dryRun; 64 | _out = @out; 65 | _logger = loggerFactory.CreateLogger(); 66 | } 67 | 68 | private static string GetTimestampFormat(string timestampFormat) 69 | => string.IsNullOrWhiteSpace(timestampFormat) 70 | ? DefaultTimestampFormat 71 | : timestampFormat; 72 | 73 | /// 74 | /// Get label from description 75 | /// 76 | /// 77 | /// 78 | /// 79 | public static string GetLabelFromName(string name, string timestampFormat) 80 | { 81 | var tmsLen = GetTimestampFormat(timestampFormat).Length; 82 | var prfLen = Prefix.Length; 83 | return tmsLen + prfLen < name.Length ? name[prfLen..^tmsLen] : ""; 84 | } 85 | 86 | /// 87 | /// Event phase. 88 | /// 89 | public event EventHandler PhaseEvent; 90 | 91 | /// 92 | /// Phases 93 | /// 94 | /// 95 | public static Dictionary Phases { get; } = new() 96 | { 97 | { "clean-job-start", HookPhase.CleanJobStart }, 98 | { "clean-job-end", HookPhase.CleanJobEnd }, 99 | { "snap-job-start", HookPhase.SnapJobStart }, 100 | { "snap-job-end", HookPhase.SnapJobEnd }, 101 | { "snap-create-pre", HookPhase.SnapCreatePre }, 102 | { "snap-create-post", HookPhase.SnapCreatePost }, 103 | { "snap-create-abort", HookPhase.SnapCreateAbort }, 104 | { "snap-remove-pre", HookPhase.SnapRemovePre }, 105 | { "snap-remove-post", HookPhase.SnapRemovePost }, 106 | { "snap-remove-abort", HookPhase.SnapRemoveAbort } 107 | }; 108 | 109 | /// 110 | /// Phase string to enum 111 | /// 112 | /// 113 | /// 114 | public static HookPhase PhaseStrToEnum(string phase) => Phases[phase]; 115 | 116 | /// 117 | /// Phase enum to string 118 | /// 119 | /// 120 | /// 121 | public static string PhaseEnumToStr(HookPhase phase) => Phases.SingleOrDefault(a => a.Value == phase).Key; 122 | 123 | private void CallPhaseEvent(HookPhase phase, 124 | IClusterResourceVm vm, 125 | string label, 126 | int keep, 127 | string snapName, 128 | bool vmState, 129 | double duration, 130 | bool status) 131 | { 132 | _logger.LogDebug("Phase: {phase}", PhaseEnumToStr(phase)); 133 | 134 | try 135 | { 136 | PhaseEvent?.Invoke(this, new PhaseEventArgs(phase, 137 | vm, 138 | label, 139 | keep, 140 | snapName, 141 | vmState, 142 | duration, 143 | status)); 144 | } 145 | catch (Exception ex) { _logger.LogError(ex, ex.Message); } 146 | } 147 | 148 | private async Task> GetVmsAsync(string vmIdsOrNames) 149 | => (await _client.GetVmsAsync(vmIdsOrNames)).Where(a => !a.IsUnknown); 150 | 151 | /// 152 | /// Status auto snapshot. 153 | /// 154 | /// 155 | /// 156 | /// 157 | public async Task>> StatusAsync(string vmIdsOrNames, string label, string timestampFormat) 158 | { 159 | timestampFormat = GetTimestampFormat(timestampFormat); 160 | 161 | var ret = new Dictionary>(); 162 | 163 | foreach (var vm in await GetVmsAsync(vmIdsOrNames)) 164 | { 165 | var snapshots = FilterApp(await SnapshotHelper.GetSnapshotsAsync(_client, vm.Node, vm.VmType, vm.VmId)); 166 | if (!string.IsNullOrWhiteSpace(label)) { snapshots = FilterLabel(snapshots, label, timestampFormat); } 167 | ret.Add(vm, snapshots); 168 | } 169 | return ret; 170 | } 171 | 172 | private static IEnumerable FilterApp(IEnumerable snapshots) 173 | => snapshots.Where(a => (a.Description + "").Replace("\n", "") == Name 174 | || (a.Description + "").Replace("\n", "") == OldName); 175 | 176 | private static string GetPrefix(string label) => Prefix + label; 177 | 178 | private static IEnumerable FilterLabel(IEnumerable snapshots, string label, string timestampFormat) 179 | { 180 | var lenTms = GetTimestampFormat(timestampFormat).Length; 181 | return FilterApp(snapshots.Where(a => (a.Name.Length - lenTms) > 0 && a.Name[..^lenTms] == GetPrefix(label))); 182 | } 183 | 184 | /// 185 | /// Execute a autosnap. 186 | /// 187 | /// 188 | /// 189 | /// 190 | /// 191 | /// 192 | /// 193 | /// 194 | /// 195 | /// 196 | public async Task SnapAsync(string vmIdsOrNames, 197 | string label, 198 | int keep, 199 | bool state, 200 | long timeout, 201 | string timestampFormat, 202 | int maxPercentageStorage, 203 | bool onlyRuns) 204 | { 205 | timestampFormat = GetTimestampFormat(timestampFormat); 206 | var pveFullVersion = (await _client.Version.Version()).ToData().version as string; 207 | var pveVersion = double.Parse(pveFullVersion.Split(".")[0]); 208 | 209 | _out.WriteLine($@"ACTION Snap 210 | PVE Version: {pveFullVersion} 211 | VMs: {vmIdsOrNames} 212 | Label: {label} 213 | Keep: {keep} 214 | State: {state} 215 | Only running: {onlyRuns} 216 | Timeout: {Math.Round(timeout / 1000.0, 1)} sec. 217 | Timestamp format: {timestampFormat} 218 | Max % Storage : {maxPercentageStorage}%"); 219 | 220 | var ret = new ResultSnap(); 221 | ret.Start(); 222 | 223 | CallPhaseEvent(HookPhase.SnapJobStart, null, label, keep, null, state, 0, true); 224 | 225 | var storagesCheck = new Dictionary(); 226 | var storagesPrint = new List(); 227 | 228 | var vms = await GetVmsAsync(vmIdsOrNames); 229 | if (!vms.Any()) 230 | { 231 | _out.WriteLine($"----- VMs with '{vmIdsOrNames}' NOT FOUND -----"); 232 | _out.WriteLine($"----- POSSIBLE PROBLEM PERMISSION 'VM.Audit' -----"); 233 | } 234 | 235 | var nodes = vms.Select(a => a.Node).Distinct().ToList(); 236 | 237 | var checkStorage = pveVersion >= 6; 238 | 239 | if (checkStorage) 240 | { 241 | var contentAllowed = new[] { "images", "rootdir" }; 242 | 243 | var storages = (await _client.GetStoragesAsync()) 244 | .Where(a => !a.IsUnknown && nodes.Contains(a.Node)) 245 | .ToList(); 246 | 247 | if (storages.Exists(a => string.IsNullOrWhiteSpace(a.Content))) 248 | { 249 | //content not exists 250 | //found in nodes/storages 251 | foreach (var node in nodes) 252 | { 253 | var nodeStorages = await _client.Nodes[node].Storage.GetAsync(string.Join(",", contentAllowed)); 254 | 255 | foreach (var storage in storages.Where(a => a.Node == node)) 256 | { 257 | storage.Content = nodeStorages.FirstOrDefault(a => a.Storage == storage.Storage 258 | && a.Type == storage.PluginType) 259 | ?.Content ?? ""; 260 | } 261 | } 262 | } 263 | 264 | storages = storages.Where(a => a.Content.Split(',') 265 | .Any(a => contentAllowed.Contains(a))) 266 | .OrderBy(a => a.Node) 267 | .ThenBy(a => a.Storage) 268 | .ToList(); 269 | 270 | if (!storages.Any()) { _out.WriteLine($"----- POSSIBLE PROBLEM PERMISSION 'Datastore.Audit' -----"); } 271 | 272 | //check storage capacity 273 | foreach (var storage in storages) 274 | { 275 | var valid = !(storage.DiskUsage == 0 276 | || storage.DiskSize == 0 277 | || storage.DiskUsagePercentage > maxPercentageStorage); 278 | 279 | var key = $"{storage.Node}/{storage.Storage}"; 280 | storagesPrint.Add(item: new object[] 281 | { 282 | key, 283 | storage.PluginType, 284 | valid? "Ok": "Ko", 285 | Math.Round(storage.DiskUsagePercentage * 100, 1), 286 | FormatHelper.FromBytes(storage.DiskSize), 287 | FormatHelper.FromBytes(storage.DiskUsage), 288 | }); 289 | 290 | storagesCheck.Add(key, valid); 291 | } 292 | 293 | if (storagesPrint.Any()) 294 | { 295 | var size = new[] { 25, 10, 10, 10, 12, 12 }; 296 | 297 | string FormatLine(object[] values) 298 | { 299 | var ret = new StringBuilder(); 300 | for (int i = 0; i < size.Length; i++) { ret.Append((values[i] + "").PadLeft(size[i])); } 301 | return ret.ToString(); 302 | } 303 | 304 | _out.WriteLine(FormatLine(new[] { "Storage", "Type", "Valid", "Used % ", "Disk Size", "Disk Usage" })); 305 | foreach (var item in storagesPrint) { _out.WriteLine(FormatLine(item)); } 306 | } 307 | } 308 | else 309 | { 310 | _out.WriteLine($"The Proxmox VE version {pveFullVersion} does not verify the storage % usage!"); 311 | } 312 | 313 | foreach (var vm in vms) 314 | { 315 | _out.WriteLine($"----- VM {vm.VmId} {vm.Type} {vm.Status} -----"); 316 | 317 | if (!vm.IsRunning && onlyRuns) 318 | { 319 | _out.WriteLine("Skip VM '--only-running' parameter used!"); 320 | continue; 321 | } 322 | 323 | //exclude template 324 | if (vm.IsTemplate) 325 | { 326 | _out.WriteLine("Skip VM is template"); 327 | continue; 328 | } 329 | 330 | VmConfig vmConfig = vm.VmType switch 331 | { 332 | VmType.Qemu => await _client.Nodes[vm.Node].Qemu[vm.VmId].Config.GetAsync(), 333 | VmType.Lxc => await _client.Nodes[vm.Node].Lxc[vm.VmId].Config.GetAsync(), 334 | _ => throw new InvalidEnumArgumentException(), 335 | }; 336 | 337 | var execSnapVm = new ResultSnapVm 338 | { 339 | VmId = vm.VmId 340 | }; 341 | ret.Vms.Add(execSnapVm); 342 | execSnapVm.Start(); 343 | 344 | //check agent enabled 345 | if (vm.VmType == VmType.Qemu && !((VmConfigQemu)vmConfig).AgentEnabled) 346 | { 347 | _out.WriteLine($"VM {vm.VmId} consider enabling QEMU agent see https://pve.proxmox.com/wiki/Qemu-guest-agent"); 348 | } 349 | 350 | if (checkStorage && vmConfig.Disks.Any()) 351 | { 352 | //verify storage 353 | var validStorage = false; 354 | foreach (var item in vmConfig.Disks) 355 | { 356 | storagesCheck.TryGetValue($"{vm.Node}/{item.Storage}", out validStorage); 357 | if (!validStorage) { break; } 358 | } 359 | 360 | if (!validStorage) 361 | { 362 | _out.WriteLine($"Skip VM problem storage space out of {maxPercentageStorage}%"); 363 | execSnapVm.Stop(); 364 | continue; 365 | } 366 | } 367 | 368 | //create snapshot 369 | var snapName = GetPrefix(label) + DateTime.Now.ToString(timestampFormat); 370 | 371 | CallPhaseEvent(HookPhase.SnapCreatePre, vm, label, keep, snapName, state, 0, true); 372 | 373 | _out.WriteLine($"Create snapshot: {snapName}"); 374 | 375 | var inError = true; 376 | if (!_dryRun) 377 | { 378 | try 379 | { 380 | var result = await SnapshotHelper.CreateSnapshotAsync(_client, 381 | vm.Node, 382 | vm.VmType, 383 | vm.VmId, 384 | snapName, 385 | Name, 386 | state, 387 | timeout); 388 | 389 | inError = await CheckResultAsync(result); 390 | } 391 | catch (Exception ex) 392 | { 393 | _logger.LogError(ex, ex.Message); 394 | _out.WriteLine(ex.Message); 395 | } 396 | } 397 | 398 | if (inError) 399 | { 400 | execSnapVm.Stop(); 401 | CallPhaseEvent(HookPhase.SnapCreateAbort, vm, label, keep, snapName, state, execSnapVm.Elapsed.TotalSeconds, false); 402 | continue; 403 | } 404 | 405 | //remove old snapshot 406 | if (!await SnapshotsRemoveAsync(vm, label, keep, timeout, timestampFormat)) 407 | { 408 | execSnapVm.Stop(); 409 | continue; 410 | } 411 | 412 | execSnapVm.Stop(); 413 | execSnapVm.Status = true; 414 | 415 | CallPhaseEvent(HookPhase.SnapCreatePost, vm, label, keep, snapName, state, execSnapVm.Elapsed.TotalSeconds, execSnapVm.Status); 416 | 417 | _out.WriteLine($"VM execution {execSnapVm.Elapsed}"); 418 | } 419 | 420 | ret.Stop(); 421 | 422 | CallPhaseEvent(HookPhase.SnapJobEnd, null, label, keep, null, state, ret.Elapsed.TotalSeconds, ret.Status); 423 | 424 | _out.WriteLine($"Total execution {ret.Elapsed}"); 425 | 426 | _logger.LogDebug($"Snap Exit: {ret.Status}"); 427 | 428 | return ret; 429 | } 430 | 431 | /// 432 | /// Clean autosnap. 433 | /// 434 | /// 435 | /// 436 | /// 437 | /// 438 | /// 439 | /// 440 | public async Task CleanAsync(string vmIdsOrNames, string label, int keep, long timeout, string timestampFormat) 441 | { 442 | timestampFormat = GetTimestampFormat(timestampFormat); 443 | 444 | _out.WriteLine($@"ACTION Clean 445 | VMs: {vmIdsOrNames} 446 | Label: {label} 447 | Keep: {keep} 448 | Timeout: {Math.Round(timeout / 1000.0, 1)} sec. 449 | Timestamp format: {timestampFormat}"); 450 | 451 | var watch = new Stopwatch(); 452 | watch.Start(); 453 | 454 | var ret = true; 455 | CallPhaseEvent(HookPhase.CleanJobStart, null, label, keep, null, false, 0, false); 456 | 457 | foreach (var vm in await GetVmsAsync(vmIdsOrNames)) 458 | { 459 | //exclude template 460 | if (vm.IsTemplate) 461 | { 462 | _out.WriteLine("Skip VM is template"); 463 | continue; 464 | } 465 | 466 | _out.WriteLine($"----- VM {vm.VmId} {vm.Type} -----"); 467 | if (!await SnapshotsRemoveAsync(vm, label, keep, timeout, timestampFormat)) { ret = false; } 468 | } 469 | 470 | watch.Stop(); 471 | CallPhaseEvent(HookPhase.CleanJobEnd, null, label, keep, null, false, watch.Elapsed.TotalSeconds, true); 472 | 473 | return ret; 474 | } 475 | 476 | private async Task CheckResultAsync(Result result) 477 | { 478 | var inError = result.InError(); 479 | if (inError) { _out.WriteLine(result.GetError()); } 480 | 481 | //check error in task 482 | if (await _client.TaskIsRunningAsync(result.ToData())) 483 | { 484 | _out.WriteLine($"Error task in run... increase the timeout!"); 485 | inError = true; 486 | } 487 | else 488 | { 489 | var taskStatus = await _client.GetExitStatusTaskAsync(result.ToData()); 490 | if (taskStatus != "OK") 491 | { 492 | _out.WriteLine($"Error in task: {taskStatus}"); 493 | inError = true; 494 | } 495 | } 496 | 497 | return inError; 498 | } 499 | 500 | private async Task SnapshotsRemoveAsync(IClusterResourceVm vm, 501 | string label, 502 | int keep, 503 | long timeout, 504 | string timestampFormat) 505 | { 506 | foreach (var snapshot in FilterLabel(await SnapshotHelper.GetSnapshotsAsync(_client, vm.Node, vm.VmType, vm.VmId), 507 | label, 508 | timestampFormat).Reverse().Skip(keep).Reverse()) 509 | { 510 | var watch = new Stopwatch(); 511 | watch.Start(); 512 | 513 | CallPhaseEvent(HookPhase.SnapRemovePre, vm, label, keep, snapshot.Name, false, 0, false); 514 | 515 | _out.WriteLine($"Remove snapshot: {snapshot.Name}"); 516 | 517 | var inError = false; 518 | if (!_dryRun) 519 | { 520 | try 521 | { 522 | var result = await SnapshotHelper.RemoveSnapshotAsync(_client, 523 | vm.Node, 524 | vm.VmType, 525 | vm.VmId, 526 | snapshot.Name, 527 | timeout, 528 | true); 529 | inError = await CheckResultAsync(result); 530 | } 531 | catch (Exception ex) 532 | { 533 | _logger.LogError(ex, ex.Message); 534 | _out.WriteLine(ex.Message); 535 | } 536 | } 537 | 538 | watch.Stop(); 539 | if (inError) 540 | { 541 | _logger.LogWarning($"Snap remove: problem in remove "); 542 | 543 | CallPhaseEvent(HookPhase.SnapRemoveAbort, 544 | vm, 545 | label, 546 | keep, 547 | snapshot.Name, 548 | false, 549 | watch.Elapsed.TotalSeconds, 550 | false); 551 | return false; 552 | } 553 | 554 | CallPhaseEvent(HookPhase.SnapRemovePost, 555 | vm, 556 | label, 557 | keep, 558 | snapshot.Name, 559 | false, 560 | watch.Elapsed.TotalSeconds, 561 | true); 562 | } 563 | 564 | return true; 565 | } 566 | } 567 | } -------------------------------------------------------------------------------- /src/Corsinvest.ProxmoxVE.AutoSnap.Api/Corsinvest.ProxmoxVE.AutoSnap.Api.csproj: -------------------------------------------------------------------------------- 1 |  2 | 3 | net7.0;net8.0;net9.0 4 | Library 5 | 6 | 1.10.0 7 | enable 8 | Corsinvest Srl 9 | Corsinvest Srl 10 | Corsinvest Srl 11 | 12 | https://github.com/Corsinvest/cv4pve-api-autosnap 13 | icon.png 14 | README.md 15 | ProxmoxVE;Api,Client;Rest;Corsinvest;AutoSnap 16 | GPL-3.0-only 17 | ..\..\..\.nupkgs\ 18 | Github 19 | https://github.com/Corsinvest/cv4pve-api-autosnap 20 | true 21 | true 22 | True 23 | 24 | 25 | $(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb 26 | 27 | true 28 | snupkg 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 41 | 42 | 43 | -------------------------------------------------------------------------------- /src/Corsinvest.ProxmoxVE.AutoSnap.Api/HookPhase.cs: -------------------------------------------------------------------------------- 1 | /* 2 | * SPDX-License-Identifier: GPL-3.0-only 3 | * SPDX-FileCopyrightText: 2020 Copyright Corsinvest Srl 4 | */ 5 | 6 | namespace Corsinvest.ProxmoxVE.AutoSnap.Api 7 | { 8 | /// 9 | /// Hook phase 10 | /// 11 | public enum HookPhase 12 | { 13 | /// 14 | /// Clean Job Start 15 | /// 16 | CleanJobStart = 0, 17 | 18 | /// 19 | /// Clean Job End 20 | /// 21 | CleanJobEnd = 1, 22 | 23 | /// 24 | /// Snap Job Start 25 | /// 26 | SnapJobStart = 2, 27 | 28 | /// 29 | /// Snap Job End 30 | /// 31 | SnapJobEnd = 3, 32 | 33 | /// 34 | /// Snap Create Pre 35 | /// 36 | SnapCreatePre = 4, 37 | 38 | /// 39 | /// Snap Create Post 40 | /// 41 | SnapCreatePost = 5, 42 | 43 | /// 44 | /// Snap Create Abort 45 | /// 46 | SnapCreateAbort = 6, 47 | 48 | /// 49 | /// Snap Remove Pre 50 | /// 51 | SnapRemovePre = 7, 52 | 53 | /// 54 | /// Snap Remove Post 55 | /// 56 | SnapRemovePost = 8, 57 | 58 | /// 59 | /// Snap Remove Abort 60 | /// 61 | SnapRemoveAbort = 9 62 | } 63 | } -------------------------------------------------------------------------------- /src/Corsinvest.ProxmoxVE.AutoSnap.Api/PhaseEventArgs.cs: -------------------------------------------------------------------------------- 1 | /* 2 | * SPDX-License-Identifier: GPL-3.0-only 3 | * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl 4 | */ 5 | 6 | using System.Globalization; 7 | using Corsinvest.ProxmoxVE.Api.Shared.Models.Cluster; 8 | 9 | namespace Corsinvest.ProxmoxVE.AutoSnap.Api 10 | { 11 | /// 12 | /// Phase event arguments 13 | /// 14 | public class PhaseEventArgs 15 | { 16 | /// 17 | /// Constructor 18 | /// 19 | /// 20 | /// 21 | /// 22 | /// 23 | /// 24 | /// 25 | /// 26 | /// 27 | public PhaseEventArgs(HookPhase phase, 28 | IClusterResourceVm vm, 29 | string label, 30 | int keep, 31 | string snapName, 32 | bool vmState, 33 | double duration, 34 | bool status) 35 | { 36 | Phase = phase; 37 | Vm = vm; 38 | Label = label; 39 | Keep = keep; 40 | SnapName = snapName; 41 | VMState = vmState; 42 | Duration = duration; 43 | Status = status; 44 | } 45 | 46 | /// 47 | /// Phase 48 | /// 49 | /// 50 | public HookPhase Phase { get; } 51 | 52 | /// 53 | /// VM Info 54 | /// 55 | /// 56 | public IClusterResourceVm Vm { get; } 57 | 58 | /// 59 | /// Label 60 | /// 61 | /// 62 | public string Label { get; } 63 | 64 | /// 65 | /// Keep 66 | /// 67 | /// 68 | public int Keep { get; } 69 | 70 | /// 71 | /// Snapshot name 72 | /// 73 | /// 74 | public string SnapName { get; } 75 | 76 | /// 77 | /// State memory 78 | /// 79 | /// 80 | public bool VMState { get; } 81 | 82 | /// 83 | /// Duration 84 | /// 85 | /// 86 | public double Duration { get; } 87 | 88 | /// 89 | /// Status 90 | /// 91 | /// 92 | public bool Status { get; } 93 | 94 | /// 95 | /// Environments 96 | /// 97 | /// 98 | public IReadOnlyDictionary Environments 99 | => new Dictionary 100 | { 101 | {"CV4PVE_AUTOSNAP_PHASE", Application.PhaseEnumToStr(Phase)}, 102 | {"CV4PVE_AUTOSNAP_VMID", Vm.VmId + "" }, 103 | {"CV4PVE_AUTOSNAP_VMNAME", Vm.Name }, 104 | {"CV4PVE_AUTOSNAP_VMTYPE", Vm.Type + "" }, 105 | {"CV4PVE_AUTOSNAP_LABEL", Label }, 106 | {"CV4PVE_AUTOSNAP_KEEP", Keep + "" }, 107 | {"CV4PVE_AUTOSNAP_SNAP_NAME", SnapName }, 108 | {"CV4PVE_AUTOSNAP_VMSTATE", VMState ? "1" : "0" }, 109 | {"CV4PVE_AUTOSNAP_DURATION", (Duration + "").Replace(CultureInfo.CurrentCulture.NumberFormat.NumberDecimalSeparator,".") }, 110 | {"CV4PVE_AUTOSNAP_STATE", Status ? "1" : "0" }, 111 | }; 112 | } 113 | } -------------------------------------------------------------------------------- /src/Corsinvest.ProxmoxVE.AutoSnap.Api/ResultBaseSnap.cs: -------------------------------------------------------------------------------- 1 | /* 2 | * SPDX-License-Identifier: GPL-3.0-only 3 | * SPDX-FileCopyrightText: 2020 Copyright Corsinvest Srl 4 | */ 5 | 6 | using System.Diagnostics; 7 | 8 | namespace Corsinvest.ProxmoxVE.AutoSnap.Api 9 | { 10 | /// 11 | /// ResultBase 12 | /// 13 | public class ResultBaseSnap 14 | { 15 | private readonly Stopwatch _execution = new(); 16 | 17 | internal void Start() => _execution.Start(); 18 | internal void Stop() => _execution.Stop(); 19 | 20 | /// 21 | /// Elapsed 22 | /// 23 | public TimeSpan Elapsed => _execution.Elapsed; 24 | 25 | /// 26 | /// Status 27 | /// 28 | /// 29 | public virtual bool Status { get; internal set; } 30 | } 31 | } -------------------------------------------------------------------------------- /src/Corsinvest.ProxmoxVE.AutoSnap.Api/ResultSnap.cs: -------------------------------------------------------------------------------- 1 | /* 2 | * SPDX-License-Identifier: GPL-3.0-only 3 | * SPDX-FileCopyrightText: 2020 Copyright Corsinvest Srl 4 | */ 5 | 6 | namespace Corsinvest.ProxmoxVE.AutoSnap.Api 7 | { 8 | /// 9 | /// Execution Snap 10 | /// 11 | public class ResultSnap : ResultBaseSnap 12 | { 13 | /// 14 | /// Vms 15 | /// 16 | public List Vms { get; } = new List(); 17 | 18 | /// 19 | /// Status 20 | /// 21 | /// 22 | public override bool Status 23 | { 24 | get => !Vms.Any(a => !a.Status); 25 | internal set { } 26 | } 27 | } 28 | } -------------------------------------------------------------------------------- /src/Corsinvest.ProxmoxVE.AutoSnap.Api/ResultSnapVm.cs: -------------------------------------------------------------------------------- 1 | /* 2 | * SPDX-License-Identifier: GPL-3.0-only 3 | * SPDX-FileCopyrightText: 2020 Copyright Corsinvest Srl 4 | */ 5 | 6 | namespace Corsinvest.ProxmoxVE.AutoSnap.Api 7 | { 8 | /// 9 | /// Execution Vm 10 | /// 11 | public class ResultSnapVm : ResultBaseSnap 12 | { 13 | /// 14 | /// Vm id 15 | /// 16 | /// 17 | public long VmId { get; internal set; } 18 | } 19 | } -------------------------------------------------------------------------------- /src/Corsinvest.ProxmoxVE.AutoSnap/Commands.cs: -------------------------------------------------------------------------------- 1 | /* 2 | * SPDX-License-Identifier: GPL-3.0-only 3 | * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl 4 | */ 5 | 6 | using System.CommandLine; 7 | using Corsinvest.ProxmoxVE.Api.Shared.Utils; 8 | using Corsinvest.ProxmoxVE.Api.Shell.Helpers; 9 | using Corsinvest.ProxmoxVE.AutoSnap.Api; 10 | using Microsoft.Extensions.Logging; 11 | 12 | namespace Corsinvest.ProxmoxVE.AutoSnap; 13 | 14 | /// 15 | /// Shell command. 16 | /// 17 | public class Commands 18 | { 19 | private string _scriptHook; 20 | private readonly ILoggerFactory _loggerFactory; 21 | private readonly bool _dryRun; 22 | private readonly bool _debug; 23 | private readonly TextWriter _out; 24 | 25 | public Commands(RootCommand command, ILoggerFactory loggerFactory) 26 | { 27 | _dryRun = command.DryRunIsActive(); 28 | _debug = command.DebugIsActive(); 29 | _out = Console.Out; 30 | 31 | _loggerFactory = loggerFactory; 32 | 33 | var optVmIds = command.VmIdsOrNamesOption(); 34 | optVmIds.IsRequired = true; 35 | 36 | var optTimeout = command.TimeoutOption(); 37 | optTimeout.SetDefaultValue(30L); 38 | 39 | var optTimestampFormat = command.AddOption("--timestamp-format", $"Specify different timestamp format"); 40 | optTimestampFormat.SetDefaultValue(Application.DefaultTimestampFormat); 41 | 42 | var optMaxPercentageStorage = command.AddOption("--max-perc-storage", "Max percentage storage") 43 | .AddValidatorRange(1, 100); 44 | optMaxPercentageStorage.SetDefaultValue(95); 45 | 46 | Snap(command, optVmIds, optTimeout, optTimestampFormat, optMaxPercentageStorage); 47 | Clean(command, optVmIds, optTimeout, optTimestampFormat); 48 | Status(command, optVmIds, optTimestampFormat); 49 | } 50 | 51 | private async Task CreateAppAsync(RootCommand command) 52 | { 53 | var app = new Application(await command.ClientTryLoginAsync(_loggerFactory), _loggerFactory, _out, _dryRun); 54 | app.PhaseEvent += App_PhaseEvent; 55 | return app; 56 | } 57 | 58 | private void App_PhaseEvent(object sender, PhaseEventArgs e) 59 | { 60 | if (!File.Exists(_scriptHook)) { return; } 61 | 62 | var (stdOut, exitCode) = ShellHelper.Execute(_scriptHook, 63 | true, 64 | new Dictionary(e.Environments) 65 | { 66 | { "CV4PVE_AUTOSNAP_DEBUG", _debug ? "1" : "0" }, 67 | { "CV4PVE_AUTOSNAP_DRY_RUN", _dryRun ? "1" : "0" }, 68 | }, 69 | _out, 70 | _dryRun, 71 | _debug); 72 | 73 | if (exitCode != 0) { _out.WriteLine($"Script return code: {exitCode}"); } 74 | if (!string.IsNullOrWhiteSpace(stdOut)) { _out.Write(stdOut); } 75 | } 76 | 77 | private static Option OptionLabel(Command command) 78 | => command.AddOption("--label", "Is usually 'hourly', 'daily', 'weekly', or 'monthly'"); 79 | 80 | private static Option OptionKeep(Command command, int min = 1) 81 | { 82 | var opt = command.AddOption("--keep", "Specify the number which should will keep") 83 | .AddValidatorRange(min, 100); 84 | 85 | opt.IsRequired = true; 86 | return opt; 87 | } 88 | 89 | private void Status(RootCommand command, Option optVmIds, Option optTimestampFormat) 90 | { 91 | var cmd = command.AddCommand("status", "Get list of all auto snapshots"); 92 | var optLabel = OptionLabel(cmd); 93 | var optOutput = cmd.TableOutputOption(); 94 | 95 | cmd.SetHandler(async (vmIds, label, timestampFormat, output) => 96 | { 97 | var app = await CreateAppAsync(command); 98 | var snapshots = await app.StatusAsync(vmIds, label, timestampFormat); 99 | if (snapshots.Any()) 100 | { 101 | var rows = new List(); 102 | foreach (var (vm, items) in snapshots) 103 | { 104 | rows.AddRange(items.Select(a => new object[] { vm.Node, 105 | vm.VmId, 106 | a.Date.ToString("yy/MM/dd HH:mm:ss"), 107 | a.Parent, 108 | a.Name, 109 | (a.Description + "").Replace("\n", ""), 110 | a.VmStatus ? "X" : "" })); 111 | } 112 | 113 | _out.Write(TableGenerator.To(["NODE", "VM", "TIME", "PARENT", "NAME", "DESCRIPTION", "VM STATUS"], 114 | rows, 115 | output)); 116 | } 117 | }, optVmIds, optLabel, optTimestampFormat, optOutput); 118 | } 119 | 120 | private void Clean(RootCommand command, 121 | Option optVmIds, 122 | Option optTimeout, 123 | Option optTimestampFormat) 124 | { 125 | var cmd = command.AddCommand("clean", "Remove auto snapshots"); 126 | var optLabel = OptionLabel(cmd); 127 | optLabel.IsRequired = true; 128 | 129 | var optKeep = OptionKeep(cmd, 0); 130 | var optScript = cmd.ScriptFileOption(); 131 | 132 | cmd.SetHandler(async (ctx) => 133 | { 134 | _scriptHook = ctx.ParseResult.GetValueForOption(optScript); 135 | var app = await CreateAppAsync(command); 136 | ctx.ExitCode = await app.CleanAsync(ctx.ParseResult.GetValueForOption(optVmIds), 137 | ctx.ParseResult.GetValueForOption(optLabel), 138 | ctx.ParseResult.GetValueForOption(optKeep), 139 | ctx.ParseResult.GetValueForOption(optTimeout) * 1000, 140 | ctx.ParseResult.GetValueForOption(optTimestampFormat)) ? 0 : 1; 141 | }); 142 | } 143 | 144 | private void Snap(RootCommand command, 145 | Option optVmIds, 146 | Option optTimeout, 147 | Option optTimestampFormat, 148 | Option optMaxPercentageStorage) 149 | { 150 | var cmd = command.AddCommand("snap", "Will snap one time"); 151 | 152 | var optLabel = OptionLabel(cmd); 153 | optLabel.IsRequired = true; 154 | 155 | var optKeep = OptionKeep(cmd); 156 | var optScript = cmd.ScriptFileOption(); 157 | var optState = cmd.AddOption("--state", "Save the vmstate (Include RAM)"); 158 | var optOnlyRunning = cmd.AddOption("--only-running", "Only VM/CT are running"); 159 | 160 | cmd.SetHandler(async (ctx) => 161 | { 162 | _scriptHook = ctx.ParseResult.GetValueForOption(optScript); 163 | var app = await CreateAppAsync(command); 164 | var snap = await app.SnapAsync(ctx.ParseResult.GetValueForOption(optVmIds), 165 | ctx.ParseResult.GetValueForOption(optLabel), 166 | ctx.ParseResult.GetValueForOption(optKeep), 167 | ctx.ParseResult.GetValueForOption(optState), 168 | ctx.ParseResult.GetValueForOption(optTimeout) * 1000, 169 | ctx.ParseResult.GetValueForOption(optTimestampFormat), 170 | ctx.ParseResult.GetValueForOption(optMaxPercentageStorage), 171 | ctx.ParseResult.GetValueForOption(optOnlyRunning)); 172 | 173 | ctx.ExitCode = snap.Status ? 0 : 1; 174 | }); 175 | } 176 | } -------------------------------------------------------------------------------- /src/Corsinvest.ProxmoxVE.AutoSnap/Corsinvest.ProxmoxVE.AutoSnap.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | Exe 4 | 1.16.0 5 | net9.0 6 | enable 7 | cv4pve-autosnap 8 | Corsinvest Srl 9 | Daniele Corsini 10 | Corsinvest Srl 11 | Corsinvest for Proxmox VE Auto Snapshot 12 | Corsinvest for Proxmox VE Auto Snapshot 13 | Corsinvest for Proxmox VE Auto Snapshot 14 | true 15 | false 16 | GPL-3.0-only 17 | 18 | 19 | 20 | 23 | 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /src/Corsinvest.ProxmoxVE.AutoSnap/Program.cs: -------------------------------------------------------------------------------- 1 | /* 2 | * SPDX-License-Identifier: GPL-3.0-only 3 | * SPDX-FileCopyrightText: 2019 Copyright Corsinvest Srl 4 | */ 5 | 6 | using Corsinvest.ProxmoxVE.Api.Shell.Helpers; 7 | using Corsinvest.ProxmoxVE.AutoSnap; 8 | using Corsinvest.ProxmoxVE.AutoSnap.Api; 9 | using Microsoft.Extensions.Logging; 10 | 11 | var app = ConsoleHelper.CreateApp(Application.Name, "Automatic snapshot VM/CT with retention"); 12 | var loggerFactory = ConsoleHelper.CreateLoggerFactory(app.GetLogLevelFromDebug()); 13 | 14 | _ = new Commands(app, loggerFactory); 15 | return await app.ExecuteAppAsync(args, loggerFactory.CreateLogger(typeof(Program))); --------------------------------------------------------------------------------