virt-back 0.2.2__tar.gz → 0.2.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. {virt-back-0.2.2 → virt-back-0.2.4}/PKG-INFO +60 -30
  2. {virt-back-0.2.2 → virt-back-0.2.4}/README.md +59 -29
  3. {virt-back-0.2.2 → virt-back-0.2.4}/setup.py +1 -1
  4. {virt-back-0.2.2 → virt-back-0.2.4}/virt_back.egg-info/PKG-INFO +60 -30
  5. {virt-back-0.2.2 → virt-back-0.2.4}/setup.cfg +0 -0
  6. {virt-back-0.2.2 → virt-back-0.2.4}/virt-back +0 -0
  7. {virt-back-0.2.2 → virt-back-0.2.4}/virt_back.egg-info/SOURCES.txt +0 -0
  8. {virt-back-0.2.2 → virt-back-0.2.4}/virt_back.egg-info/dependency_links.txt +0 -0
  9. {virt-back-0.2.2 → virt-back-0.2.4}/virt_back.egg-info/requires.txt +0 -0
  10. {virt-back-0.2.2 → virt-back-0.2.4}/virt_back.egg-info/top_level.txt +0 -0
  11. {virt-back-0.2.2 → virt-back-0.2.4}/virtback.py +0 -0
{virt-back-0.2.2 → virt-back-0.2.4}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: virt-back
3
- Version: 0.2.2
3
+ Version: 0.2.4
4
4
  Summary: virt-back: A backup utility for QEMU, KVM, XEN, and Virtualbox guests
5
5
  Home-page: https://git.unturf.com/python/virt-back
6
6
  Author: Russell Ballestrini
@@ -24,52 +24,82 @@ https://git.unturf.com/python/virt-back
24
24
  **usage**
25
25
 
26
26
  ```
27
- root@guile[/mnt/downloads/virt-back]# ./virt-back --help
28
- Usage: virt-back [options]
29
-
30
- A backup utility for QEMU, KVM, XEN, and Virtualbox guests. Virt-back is a
31
- python application that uses the libvirt api to safely shutdown, gzip, and
32
- restart guests. The backup process logs to syslog for auditing and virt-back
33
- works great with cron for scheduling outages. Virt-back has been placed in the
34
- public domain and the latest version may be downloaded here:
27
+ virt-back --help
28
+ usage: virt-back [-h] [-q] [-d] [-g] [-a amount] [-p 'PATH'] [-u 'URI'] [-i] [--info-all] [-b] [-r] [-s] [-c] [--backup-all] [--reboot-all] [--shutdown-all] [--create-all]
29
+
30
+ A backup utility for QEMU, KVM, XEN, and Virtualbox guests. Virt-back is a python application that uses the libvirt api to safely shutdown, gzip, and restart guests. The backup process
31
+ logs to syslog for auditing and virt-back works great with cron for scheduling outages. Virt-back has been placed in the public domain and the latest version may be downloaded here:
32
+
35
33
  https://git.unturf.com/python/virt-back
36
34
 
37
- Options:
35
+ options:
38
36
  -h, --help show this help message and exit
39
37
  -q, --quiet prevent output to stdout
40
38
  -d, --date append date to tar filename [default: no date]
41
39
  -g, --no-gzip do not gzip the resulting tar file
42
- -a amount, --retention=amount
40
+ -a amount, --retention amount
43
41
  backups to retain [default: 3]
44
- -p 'PATH', --path='PATH'
42
+ -p 'PATH', --path 'PATH'
45
43
  backup path [default: '/KVMBACK']
46
- -u 'URI', --uri='URI'
44
+ -u 'URI', --uri 'URI'
47
45
  optional hypervisor uri
48
46
 
49
- Actions for info testing:
50
- These options display info or test a list of guests.
47
+ Actions for info testing:
48
+ These options display info or test a list of guests.
49
+
50
+ -i, --info info/test a list of guests (space delimited dom names)
51
+ --info-all attempt to show info on ALL guests
52
+
53
+ Actions for a list of dom names:
54
+ WARNING: These options WILL bring down guests!
55
+
56
+ -b, --backup backup a list of guests (space delimited dom names)
57
+ -r, --reboot reboot a list of guests (space delimited dom names)
58
+ -s, --shutdown shutdown a list of guests (space delimited dom names)
59
+ -c, --create start a list of guests (space delimited dom names)
60
+
61
+ Actions for all doms:
62
+ WARNING: These options WILL bring down ALL guests!
63
+
64
+ --backup-all attempt to shutdown, backup, and start ALL guests
65
+ --reboot-all attempt to shutdown and then start ALL guests
66
+ --shutdown-all attempt to shutdown ALL guests
67
+ --create-all attempt to start ALL guests
68
+ ```
69
+
70
+
71
+ ## Dependencies
72
+
73
+ Before installing `virt-back`, you need to ensure that the necessary development libraries for `libvirt` are installed on your system. These libraries are required for the `libvirt-python` package, which `virt-back` depends on.
51
74
 
52
- -i, --info info/test a list of guests (space delimited dom names)
53
- --info-all attempt to show info on ALL guests
75
+ ### Fedora/RedHat
54
76
 
55
- Actions for a list of dom names:
56
- WARNING: These options WILL bring down guests!
77
+ On Fedora or RedHat-based systems, you can install the `libvirt-devel` package using `dnf`:
57
78
 
58
- -b, --backup backup a list of guests (space delimited dom names)
59
- -r, --reboot reboot a list of guests (space delimited dom names)
60
- -s, --shutdown shutdown a list of guests (space delimited dom names)
61
- -c, --create start a list of guests (space delimited dom names)
79
+ ```bash
80
+ sudo dnf install libvirt-devel
81
+ ```
82
+
83
+ ### Ubuntu/Debian
62
84
 
63
- Actions for all doms:
64
- WARNING: These options WILL bring down ALL guests!
85
+ On Ubuntu or Debian-based systems, you can install the `libvirt-dev` package using `apt-get`:
65
86
 
66
- --backup-all attempt to shutdown, backup, and start ALL guests
67
- --reboot-all attempt to shutdown and then start ALL guests
68
- --shutdown-all attempt to shutdown ALL guests
69
- --create-all attempt to start ALL guests
87
+ ```bash
88
+ sudo apt-get install libvirt-dev
70
89
  ```
71
90
 
72
- How to backup zfs snapshot all KVM instances on a TrueNAS Scale,
91
+ ### Installing `virt-back`
92
+
93
+ Once the necessary development libraries are installed, you can install `virt-back` using `pip`:
94
+
95
+ ```bash
96
+ pip install virt-back
97
+ ```
98
+
99
+ This will install `virt-back` along with its dependencies, including `libvirt-python`.
100
+
101
+
102
+ ## How to backup zfs snapshot all KVM instances on a TrueNAS Scale,
73
103
 
74
104
  ```
75
105
  root@guile[/mnt/downloads/virt-back]# ./virt-back -u "qemu+unix:///system?socket=/run/truenas_libvirt/libvirt-sock" --backup-all --path /mnt/personal/backup/virt-back --no-gzip --retention 5
{virt-back-0.2.2 → virt-back-0.2.4}/README.md RENAMED
@@ -12,52 +12,82 @@ https://git.unturf.com/python/virt-back
12
12
  **usage**
13
13
 
14
14
  ```
15
- root@guile[/mnt/downloads/virt-back]# ./virt-back --help
16
- Usage: virt-back [options]
17
-
18
- A backup utility for QEMU, KVM, XEN, and Virtualbox guests. Virt-back is a
19
- python application that uses the libvirt api to safely shutdown, gzip, and
20
- restart guests. The backup process logs to syslog for auditing and virt-back
21
- works great with cron for scheduling outages. Virt-back has been placed in the
22
- public domain and the latest version may be downloaded here:
15
+ virt-back --help
16
+ usage: virt-back [-h] [-q] [-d] [-g] [-a amount] [-p 'PATH'] [-u 'URI'] [-i] [--info-all] [-b] [-r] [-s] [-c] [--backup-all] [--reboot-all] [--shutdown-all] [--create-all]
17
+
18
+ A backup utility for QEMU, KVM, XEN, and Virtualbox guests. Virt-back is a python application that uses the libvirt api to safely shutdown, gzip, and restart guests. The backup process
19
+ logs to syslog for auditing and virt-back works great with cron for scheduling outages. Virt-back has been placed in the public domain and the latest version may be downloaded here:
20
+
23
21
  https://git.unturf.com/python/virt-back
24
22
 
25
- Options:
23
+ options:
26
24
  -h, --help show this help message and exit
27
25
  -q, --quiet prevent output to stdout
28
26
  -d, --date append date to tar filename [default: no date]
29
27
  -g, --no-gzip do not gzip the resulting tar file
30
- -a amount, --retention=amount
28
+ -a amount, --retention amount
31
29
  backups to retain [default: 3]
32
- -p 'PATH', --path='PATH'
30
+ -p 'PATH', --path 'PATH'
33
31
  backup path [default: '/KVMBACK']
34
- -u 'URI', --uri='URI'
32
+ -u 'URI', --uri 'URI'
35
33
  optional hypervisor uri
36
34
 
37
- Actions for info testing:
38
- These options display info or test a list of guests.
35
+ Actions for info testing:
36
+ These options display info or test a list of guests.
37
+
38
+ -i, --info info/test a list of guests (space delimited dom names)
39
+ --info-all attempt to show info on ALL guests
40
+
41
+ Actions for a list of dom names:
42
+ WARNING: These options WILL bring down guests!
43
+
44
+ -b, --backup backup a list of guests (space delimited dom names)
45
+ -r, --reboot reboot a list of guests (space delimited dom names)
46
+ -s, --shutdown shutdown a list of guests (space delimited dom names)
47
+ -c, --create start a list of guests (space delimited dom names)
48
+
49
+ Actions for all doms:
50
+ WARNING: These options WILL bring down ALL guests!
51
+
52
+ --backup-all attempt to shutdown, backup, and start ALL guests
53
+ --reboot-all attempt to shutdown and then start ALL guests
54
+ --shutdown-all attempt to shutdown ALL guests
55
+ --create-all attempt to start ALL guests
56
+ ```
57
+
58
+
59
+ ## Dependencies
60
+
61
+ Before installing `virt-back`, you need to ensure that the necessary development libraries for `libvirt` are installed on your system. These libraries are required for the `libvirt-python` package, which `virt-back` depends on.
39
62
 
40
- -i, --info info/test a list of guests (space delimited dom names)
41
- --info-all attempt to show info on ALL guests
63
+ ### Fedora/RedHat
42
64
 
43
- Actions for a list of dom names:
44
- WARNING: These options WILL bring down guests!
65
+ On Fedora or RedHat-based systems, you can install the `libvirt-devel` package using `dnf`:
45
66
 
46
- -b, --backup backup a list of guests (space delimited dom names)
47
- -r, --reboot reboot a list of guests (space delimited dom names)
48
- -s, --shutdown shutdown a list of guests (space delimited dom names)
49
- -c, --create start a list of guests (space delimited dom names)
67
+ ```bash
68
+ sudo dnf install libvirt-devel
69
+ ```
70
+
71
+ ### Ubuntu/Debian
50
72
 
51
- Actions for all doms:
52
- WARNING: These options WILL bring down ALL guests!
73
+ On Ubuntu or Debian-based systems, you can install the `libvirt-dev` package using `apt-get`:
53
74
 
54
- --backup-all attempt to shutdown, backup, and start ALL guests
55
- --reboot-all attempt to shutdown and then start ALL guests
56
- --shutdown-all attempt to shutdown ALL guests
57
- --create-all attempt to start ALL guests
75
+ ```bash
76
+ sudo apt-get install libvirt-dev
58
77
  ```
59
78
 
60
- How to backup zfs snapshot all KVM instances on a TrueNAS Scale,
79
+ ### Installing `virt-back`
80
+
81
+ Once the necessary development libraries are installed, you can install `virt-back` using `pip`:
82
+
83
+ ```bash
84
+ pip install virt-back
85
+ ```
86
+
87
+ This will install `virt-back` along with its dependencies, including `libvirt-python`.
88
+
89
+
90
+ ## How to backup zfs snapshot all KVM instances on a TrueNAS Scale,
61
91
 
62
92
  ```
63
93
  root@guile[/mnt/downloads/virt-back]# ./virt-back -u "qemu+unix:///system?socket=/run/truenas_libvirt/libvirt-sock" --backup-all --path /mnt/personal/backup/virt-back --no-gzip --retention 5
{virt-back-0.2.2 → virt-back-0.2.4}/setup.py RENAMED
@@ -7,7 +7,7 @@ with open(os.path.join(os.path.dirname(__file__), "README.md"), encoding="utf-8"
7
7
 
8
8
  setup(
9
9
  name="virt-back",
10
- version="0.2.2",
10
+ version="0.2.4",
11
11
  description="virt-back: A backup utility for QEMU, KVM, XEN, and Virtualbox guests",
12
12
  keywords="backup virtual hypervisor QEMU KVM XEN Virtualbox",
13
13
  long_description=long_description,
{virt-back-0.2.2 → virt-back-0.2.4}/virt_back.egg-info/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: virt-back
3
- Version: 0.2.2
3
+ Version: 0.2.4
4
4
  Summary: virt-back: A backup utility for QEMU, KVM, XEN, and Virtualbox guests
5
5
  Home-page: https://git.unturf.com/python/virt-back
6
6
  Author: Russell Ballestrini
@@ -24,52 +24,82 @@ https://git.unturf.com/python/virt-back
24
24
  **usage**
25
25
 
26
26
  ```
27
- root@guile[/mnt/downloads/virt-back]# ./virt-back --help
28
- Usage: virt-back [options]
29
-
30
- A backup utility for QEMU, KVM, XEN, and Virtualbox guests. Virt-back is a
31
- python application that uses the libvirt api to safely shutdown, gzip, and
32
- restart guests. The backup process logs to syslog for auditing and virt-back
33
- works great with cron for scheduling outages. Virt-back has been placed in the
34
- public domain and the latest version may be downloaded here:
27
+ virt-back --help
28
+ usage: virt-back [-h] [-q] [-d] [-g] [-a amount] [-p 'PATH'] [-u 'URI'] [-i] [--info-all] [-b] [-r] [-s] [-c] [--backup-all] [--reboot-all] [--shutdown-all] [--create-all]
29
+
30
+ A backup utility for QEMU, KVM, XEN, and Virtualbox guests. Virt-back is a python application that uses the libvirt api to safely shutdown, gzip, and restart guests. The backup process
31
+ logs to syslog for auditing and virt-back works great with cron for scheduling outages. Virt-back has been placed in the public domain and the latest version may be downloaded here:
32
+
35
33
  https://git.unturf.com/python/virt-back
36
34
 
37
- Options:
35
+ options:
38
36
  -h, --help show this help message and exit
39
37
  -q, --quiet prevent output to stdout
40
38
  -d, --date append date to tar filename [default: no date]
41
39
  -g, --no-gzip do not gzip the resulting tar file
42
- -a amount, --retention=amount
40
+ -a amount, --retention amount
43
41
  backups to retain [default: 3]
44
- -p 'PATH', --path='PATH'
42
+ -p 'PATH', --path 'PATH'
45
43
  backup path [default: '/KVMBACK']
46
- -u 'URI', --uri='URI'
44
+ -u 'URI', --uri 'URI'
47
45
  optional hypervisor uri
48
46
 
49
- Actions for info testing:
50
- These options display info or test a list of guests.
47
+ Actions for info testing:
48
+ These options display info or test a list of guests.
49
+
50
+ -i, --info info/test a list of guests (space delimited dom names)
51
+ --info-all attempt to show info on ALL guests
52
+
53
+ Actions for a list of dom names:
54
+ WARNING: These options WILL bring down guests!
55
+
56
+ -b, --backup backup a list of guests (space delimited dom names)
57
+ -r, --reboot reboot a list of guests (space delimited dom names)
58
+ -s, --shutdown shutdown a list of guests (space delimited dom names)
59
+ -c, --create start a list of guests (space delimited dom names)
60
+
61
+ Actions for all doms:
62
+ WARNING: These options WILL bring down ALL guests!
63
+
64
+ --backup-all attempt to shutdown, backup, and start ALL guests
65
+ --reboot-all attempt to shutdown and then start ALL guests
66
+ --shutdown-all attempt to shutdown ALL guests
67
+ --create-all attempt to start ALL guests
68
+ ```
69
+
70
+
71
+ ## Dependencies
72
+
73
+ Before installing `virt-back`, you need to ensure that the necessary development libraries for `libvirt` are installed on your system. These libraries are required for the `libvirt-python` package, which `virt-back` depends on.
51
74
 
52
- -i, --info info/test a list of guests (space delimited dom names)
53
- --info-all attempt to show info on ALL guests
75
+ ### Fedora/RedHat
54
76
 
55
- Actions for a list of dom names:
56
- WARNING: These options WILL bring down guests!
77
+ On Fedora or RedHat-based systems, you can install the `libvirt-devel` package using `dnf`:
57
78
 
58
- -b, --backup backup a list of guests (space delimited dom names)
59
- -r, --reboot reboot a list of guests (space delimited dom names)
60
- -s, --shutdown shutdown a list of guests (space delimited dom names)
61
- -c, --create start a list of guests (space delimited dom names)
79
+ ```bash
80
+ sudo dnf install libvirt-devel
81
+ ```
82
+
83
+ ### Ubuntu/Debian
62
84
 
63
- Actions for all doms:
64
- WARNING: These options WILL bring down ALL guests!
85
+ On Ubuntu or Debian-based systems, you can install the `libvirt-dev` package using `apt-get`:
65
86
 
66
- --backup-all attempt to shutdown, backup, and start ALL guests
67
- --reboot-all attempt to shutdown and then start ALL guests
68
- --shutdown-all attempt to shutdown ALL guests
69
- --create-all attempt to start ALL guests
87
+ ```bash
88
+ sudo apt-get install libvirt-dev
70
89
  ```
71
90
 
72
- How to backup zfs snapshot all KVM instances on a TrueNAS Scale,
91
+ ### Installing `virt-back`
92
+
93
+ Once the necessary development libraries are installed, you can install `virt-back` using `pip`:
94
+
95
+ ```bash
96
+ pip install virt-back
97
+ ```
98
+
99
+ This will install `virt-back` along with its dependencies, including `libvirt-python`.
100
+
101
+
102
+ ## How to backup zfs snapshot all KVM instances on a TrueNAS Scale,
73
103
 
74
104
  ```
75
105
  root@guile[/mnt/downloads/virt-back]# ./virt-back -u "qemu+unix:///system?socket=/run/truenas_libvirt/libvirt-sock" --backup-all --path /mnt/personal/backup/virt-back --no-gzip --retention 5
{virt-back-0.2.2 → virt-back-0.2.4}/setup.cfg RENAMED
File without changes
{virt-back-0.2.2 → virt-back-0.2.4}/virt-back RENAMED
File without changes
{virt-back-0.2.2 → virt-back-0.2.4}/virtback.py RENAMED
File without changes