prlbackup 1.0.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.DS_Store
+Gemfile.lock
+pkg/*
+vendor/ruby

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in prlbackup.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,21 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :cli => '--color' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})           { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')        { "spec" }
+end
+
+guard 'cucumber' do
+  watch(%r{^bin/.+$})                 { 'features' }
+  watch(%r{^lib/.+$})                 { 'features' }
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})    { 'features' }
+  watch(%r{^features/steps/.+$})       { 'features' }
+end
+
+guard 'ronn', :cli => '--manual="PRLBACKUP MANUAL" --style=toc' do
+  watch(%r{^man/.+\.ronn$})
+  watch(%r{^man/.+\.(md|markdown)$})
+end

data/README.md

@@ -0,0 +1,27 @@
+prlbackup(1) -- an awesome backup tool for Parallels Server Virtual Machines
+============================================================================
+
+Installation
+------------
+
+	gem install prlbackup
+
+Usage
+-----
+
+Take a look at `gem man prlbackup`.
+
+Note on Patches/Pull Requests
+-----------------------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with Rakefile, gemspec or History.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+
+Copyright (c) 2012 Björn Albers (MIT License)

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "--format pretty"
+end
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w[--color]
+  t.pattern = "./spec/**/*_spec.rb"
+end
+
+task :default => :features

data/bin/prlbackup

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'prlbackup'
+
+PrlBackup::CLI.run

data/features/cleanup.feature

@@ -0,0 +1,29 @@
+Feature: Cleanup
+
+  In order to not waste my time manually cleaning up
+  As a sysadmin using Parallels Server
+  I want to old backups to be automatically deleted
+
+  Background:
+    Given the following virtual machines:
+      | uuid                                   | status  | name          |
+      | {97351580-afd7-4aff-9960-814196b28e37} | stopped | Mac OS X Lion |
+      | {423dba54-45e3-46f1-9aa2-87d61ce6b757} | running | Windows XP    |
+      | {55aae003-298d-4199-82ed-23658a218605} | stopped | Ubuntu        |
+
+  Scenario: Delete old backups
+    Given I double `prlctl backup-list {55aae003-298d-4199-82ed-23658a218605}` with stdout:
+      """
+      ID Backup_ID                              Node                 Date                 Type       Size
+      {55aae003-298d-4199-82ed-23658a218605} {ae6565dd-7f8f-42cb-a088-8b1d98f5160b} psfm.example.com 02/27/2012 13:11:32     f 10537597943
+      {55aae003-298d-4199-82ed-23658a218605} {ae6565dd-7f8f-42cb-a088-8b1d98f5160b}.2 psfm.example.com 02/27/2012 15:26:02     i 2951747588
+      {55aae003-298d-4199-82ed-23658a218605} {5f9dd263-ec56-443e-9917-dab9b40d3027} psfm.example.com 03/13/2012 18:06:00     f 11748325372
+      {55aae003-298d-4199-82ed-23658a218605} {2aeb4ada-6623-4087-9fc5-f09aeaafd81e} psfm.example.com 03/23/2012 21:25:50     f 47315014888
+      {55aae003-298d-4199-82ed-23658a218605} {68f7e154-6755-46f6-ad1f-a79c5f488f35} psfm.example.com 03/28/2012 15:09:05     f 23462808438
+      {55aae003-298d-4199-82ed-23658a218605} {68f7e154-6755-46f6-ad1f-a79c5f488f35}.2 psfm.example.com 04/05/2012 17:21:12     i 12841952117
+      """
+    When I successfully run `prlbackup --keep-only 2 Ubuntu`
+    Then the double `prlctl backup-delete --tag {ae6565dd-7f8f-42cb-a088-8b1d98f5160b}` should have been run
+    And the double `prlctl backup-delete --tag {5f9dd263-ec56-443e-9917-dab9b40d3027}` should have been run
+    But the double `prlctl backup-delete --tag {2aeb4ada-6623-4087-9fc5-f09aeaafd81e}` should not have been run
+    And the double `prlctl backup-delete --tag {68f7e154-6755-46f6-ad1f-a79c5f488f35}` should not have been run

data/features/create_backups.feature

@@ -0,0 +1,53 @@
+Feature: Create Backups
+
+  In order to sleep well
+  As a sysadmin using Parallels Server
+  I want to create my backups with prlbackup
+
+  Background:
+    Given the following virtual machines:
+      | uuid                                   | status  | name          |
+      | {97351580-afd7-4aff-9960-814196b28e37} | stopped | Mac OS X Lion |
+      | {423dba54-45e3-46f1-9aa2-87d61ce6b757} | running | Windows XP    |
+      | {55aae003-298d-4199-82ed-23658a218605} | stopped | Ubuntu        |
+
+  Scenario: Backup single VM (already stopped)
+    When I successfully run `prlbackup Ubuntu`
+    Then the double `prlctl stop {55aae003-298d-4199-82ed-23658a218605}` should not have been run
+    And the double `prlctl backup {55aae003-298d-4199-82ed-23658a218605}` should have been run
+    And the double `prlctl start {55aae003-298d-4199-82ed-23658a218605}` should not have been run
+
+  Scenario: Backup multiple VMs
+    When I successfully run `prlbackup Ubuntu Windows\ XP`
+    Then the double `prlctl backup {55aae003-298d-4199-82ed-23658a218605}` should have been run
+    And the double `prlctl backup {423dba54-45e3-46f1-9aa2-87d61ce6b757}` should have been run
+    But the double `prlctl backup {97351580-afd7-4aff-9960-814196b28e37}` should not have been run
+
+  Scenario: Stop VM during backup
+    When I successfully run `prlbackup "Windows XP"`
+    Then the double `prlctl stop {423dba54-45e3-46f1-9aa2-87d61ce6b757}` should have been run
+    And the double `prlctl backup {423dba54-45e3-46f1-9aa2-87d61ce6b757}` should have been run
+    And the double `prlctl start {423dba54-45e3-46f1-9aa2-87d61ce6b757}` should have been run
+
+  Scenario: Create full backup
+    When I successfully run `prlbackup --full Ubuntu`
+    And the double `prlctl backup {55aae003-298d-4199-82ed-23658a218605} --full` should have been run
+
+  Scenario: Backup all VMs
+    When I successfully run `prlbackup --all`
+    Then the double `prlctl backup {97351580-afd7-4aff-9960-814196b28e37}` should have been run
+    And the double `prlctl backup {423dba54-45e3-46f1-9aa2-87d61ce6b757}` should have been run
+    And the double `prlctl backup {55aae003-298d-4199-82ed-23658a218605}` should have been run
+
+  Scenario: Exclude VMs from Backup
+    When I successfully run `prlbackup --all --exclude "Mac OS X Lion"`
+    Then the double `prlctl backup {423dba54-45e3-46f1-9aa2-87d61ce6b757}` should have been run
+    And the double `prlctl backup {55aae003-298d-4199-82ed-23658a218605}` should have been run
+    But the double `prlctl backup {97351580-afd7-4aff-9960-814196b28e37}` should not have been run
+
+  Scenario: Dry-run
+    When I successfully run `prlbackup --dry-run "Windows XP"`
+    Then the double `prlctl list --info "Windows XP"` should have been run
+    But the double `prlctl stop {423dba54-45e3-46f1-9aa2-87d61ce6b757}` should not have been run
+    And the double `prlctl backup {423dba54-45e3-46f1-9aa2-87d61ce6b757}` should not have been run
+    And the double `prlctl start {423dba54-45e3-46f1-9aa2-87d61ce6b757}` should not have been run

data/features/dev_steps.feature

@@ -0,0 +1,60 @@
+Feature: Development Steps
+
+  In order to keep my cucumber scenarios nice and tight
+  As a developer of prlbackup
+  I want convenient development steps to fake virtual machines
+
+  Background:
+    Given the following virtual machines:
+      | uuid                                   | status  | name          |
+      | {97351580-afd7-4aff-9960-814196b28e37} | stopped | Mac OS X Lion |
+      | {423dba54-45e3-46f1-9aa2-87d61ce6b757} | running | Windows XP    |
+      | {55aae003-298d-4199-82ed-23658a218605} | stopped | Ubuntu        |
+
+  Scenario: prlctl list --info Ubuntu
+    When I successfully run `prlctl list --info Ubuntu`
+    Then the stdout should contain exactly:
+      """
+      ID: {55aae003-298d-4199-82ed-23658a218605}
+      Name: Ubuntu
+      State: stopped
+
+      """
+
+  Scenario: prlctl stop ...
+    When I successfully run `prlctl stop {55aae003-298d-4199-82ed-23658a218605}`
+    Then the stdout should contain exactly:
+      """
+      Stopping the VM...
+      The VM has been successfully stopped.
+
+      """
+
+  Scenario: prlctl backup ...
+    When I successfully run `prlctl backup {55aae003-298d-4199-82ed-23658a218605}`
+    Then the stdout should contain exactly:
+      """
+      Backing up the VM Ubuntu
+      The virtual machine has been successfully backed up with backup id {d51e6df1-83e9-46e2-aef1-3807d721c1be}.
+
+      """
+
+  Scenario: prlctl start ...
+    When I successfully run `prlctl start {55aae003-298d-4199-82ed-23658a218605}`
+    Then the stdout should contain exactly:
+      """
+      Starting the VM...
+      The VM has been successfully started.
+
+      """
+
+  Scenario: prlctl list --all ...
+    When I run `prlctl list --all --output uuid`
+    Then the stdout should contain exactly:
+      """
+      UUID
+      {97351580-afd7-4aff-9960-814196b28e37}
+      {423dba54-45e3-46f1-9aa2-87d61ce6b757}
+      {55aae003-298d-4199-82ed-23658a218605}
+
+      """

data/features/logging.feature

@@ -0,0 +1,39 @@
+Feature: Logging
+
+  In order to be able to review the backup activities
+  As a sysadmin using Parallels Server
+  I want to have a logging feature
+
+  Background:
+    Given the following virtual machines:
+      | uuid                                   | status  | name          |
+      | {97351580-afd7-4aff-9960-814196b28e37} | stopped | Mac OS X Lion |
+      | {423dba54-45e3-46f1-9aa2-87d61ce6b757} | running | Windows XP    |
+      | {55aae003-298d-4199-82ed-23658a218605} | stopped | Ubuntu        |
+
+  Scenario: Log the last stdout line from prlctl
+    When I successfully run `prlbackup "Windows XP"`
+    And the stdout should contain "[Windows XP] Starting backup..."
+    And the stdout should contain "The VM has been successfully stopped"
+    And the stdout should contain "The virtual machine has been successfully backed up with backup id"
+    And the stdout should contain "The VM has been successfully started"
+
+  Scenario: Log the virtual machines name
+    When I successfully run `prlbackup --all`
+    Then the output should match /Mac OS X Lion.+successfully backed up/
+    And the output should match /Windows XP.+successfully backed up/
+    And the output should match /Ubuntu.+successfully backed up/
+
+  Scenario: Log errors
+    Given I double `prlctl backup {55aae003-298d-4199-82ed-23658a218605}` with exit status 42 and stderr:
+      """
+      BOOOOM!
+      """
+    When I run `prlbackup Ubuntu`
+    Then the output should match /ERROR.+BOOOOM/
+
+  Scenario: Be verbose
+    When I run `prlbackup --verbose "Windows XP"`
+    Then the stdout should contain "Running `prlctl stop \{423dba54-45e3-46f1-9aa2-87d61ce6b757\}`" 
+    And the stdout should contain "Running `prlctl backup \{423dba54-45e3-46f1-9aa2-87d61ce6b757\}`" 
+    And the stdout should contain "Running `prlctl start \{423dba54-45e3-46f1-9aa2-87d61ce6b757\}`" 

data/features/steps/dev_steps.rb

@@ -0,0 +1,49 @@
+Before do
+  @aruba_timeout_seconds = 10
+end
+
+Given /^the following virtual machines?:$/ do |vm_table|
+  format = "%-40s%-13s%-16s%s"
+  all_vm = %w[UUID]
+  vm_table.hashes.each do |vm|
+    name, uuid, status  = vm["name"], vm["uuid"], vm["status"]
+    all_vm << vm['uuid']
+    steps %Q{
+      Given I double `prlctl list --info "#{name}"` with stdout:
+        """
+        ID: #{uuid}
+        Name: #{name}
+        State: #{status}
+        """
+      And I double `prlctl list --info #{uuid}` with stdout:
+        """
+        ID: #{uuid}
+        Name: #{name}
+        State: running
+        """
+      And I double `prlctl stop #{uuid}` with stdout:
+        """
+        Stopping the VM...
+        The VM has been successfully stopped.
+        """
+      And I double `prlctl backup #{uuid}` with stdout:
+        """
+        Backing up the VM #{name}
+        The virtual machine has been successfully backed up with backup id {d51e6df1-83e9-46e2-aef1-3807d721c1be}.
+        """
+      And I double `prlctl start #{uuid}` with stdout:
+        """
+        Starting the VM...
+        The VM has been successfully started.
+        """
+    }
+  end
+  
+  all_vm = all_vm.join("\n")
+  steps %Q{
+    Given I double `prlctl list --all --output uuid` with stdout:
+      """
+	    #{all_vm}
+	    """
+  }
+end

data/features/support/env.rb

@@ -0,0 +1,2 @@
+require 'aruba/cucumber'
+require 'aruba-doubles/cucumber'

data/lib/prlbackup/cli.rb

@@ -0,0 +1,90 @@
+module PrlBackup
+  class CLI
+    include Mixlib::CLI
+
+    option :full,
+      :long         => '--full',
+      :short        => '-f',
+      :description  => 'Create full backups.',
+      :boolean      => true,
+      :default      => false
+
+    option :all,
+      :long         => '--all',
+      :short        => '-a',
+      :description  => 'Backup all virtual machines.',
+      :boolean      => true,
+      :default      => false
+
+    option :verbose,
+      :long         => '--verbose',
+      :short        => '-v',
+      :description  => 'Be verbose.',
+      :boolean      => 'true',
+      :default      => false
+
+    option :exclude,
+      :long         => '--exclude',
+      :short        => '-e',
+      :description  => 'Exclude given virtual machines from backup (in combination with --all).',
+      :boolean      => true,
+      :default      => false
+
+    option :dry_run,
+      :long         => '--dry-run',
+      :short        => '-n',
+      :description  => 'Dont run commands which have an impact on virtual machines.',
+      :boolean      => true,
+      :default      => false
+
+    option :keep_only,
+      :long         => '--keep-only n',
+      :short        => '-k n',
+      :description  => 'Keep only n full backups (delete the oldest!)',
+      :proc         => Proc.new { |k| k.to_i }
+
+    class << self
+      # Run the backups with given options and arguments.
+      def run
+        self.new.run(ARGV)
+      end
+    end
+
+    # Parse options and create safe backups for the selected virtual machines.
+    def run(argv)
+      parse_options!(argv)
+      selected_virtual_machines.each do |vm|
+        vm.safe_backup
+        vm.cleanup if config[:keep_only]
+      end
+    end
+
+  private
+
+    # Parse options and set global configuration.
+    def parse_options!(argv)
+      @arguments = parse_options(argv)
+      PrlBackup.config = config
+    end
+
+    # The list of selected virtual machines which will be backed up.
+    # Note that this selection is based on the options and arguments.
+    # @return [Array<VirtualMachine>]
+    def selected_virtual_machines
+      case
+      when config[:all] && config[:exclude]
+        VirtualMachine.select { |vm| !given_virtual_machines.include?(vm) }
+      when config[:all]
+        VirtualMachine.all
+      else
+        given_virtual_machines
+      end
+    end
+
+    # The list of virtual machines given as arguments via ARGV.
+    # @return [Array<VirtualMachine>]
+    def given_virtual_machines
+      @given_virtual_machines ||= @arguments.map { |a| VirtualMachine.new(a) }
+    end
+  end
+end

data/lib/prlbackup/version.rb

@@ -0,0 +1,3 @@
+module PrlBackup
+  VERSION = '1.0.0'
+end

data/lib/prlbackup/virtual_machine.rb

@@ -0,0 +1,111 @@
+module PrlBackup
+  class VirtualMachine
+    include PrlBackup
+
+    class << self
+      include Enumerable
+      include PrlBackup
+
+      # Iterate over all virtual machines.
+      # @param [Block]
+      def each
+        all.each { |virtual_machine| yield(virtual_machine) }
+      end
+
+      # Return a list of all virtual machines.
+      # @return [Array<VirtualMachine>]
+      def all
+        cmd = %w{prlctl list --all --output uuid}
+        command(*cmd).split("\n").grep(/(\{[a-f0-9-]+\})/) { new($1) }
+      end
+    end
+
+    # Initialize with a valid name or UUID from the virtual machine.
+    def initialize(name_or_uuid)
+      @name_or_uuid = name_or_uuid
+      update_info
+    end
+
+    def config
+      PrlBackup.config
+    end
+
+    # Safely backup the virtual machine.
+    # @note A running virtual machine will be stopped during the backup!
+    def safe_backup(full=false)
+      logger.info('Starting backup...')
+      stopped? ? backup : (stop; backup; start)
+    end
+
+    # Cleanup (delete) old backups.
+    def cleanup
+      backups = full_backups
+      delete_backup(backups.shift) while backups.count > config[:keep_only]
+    end
+
+    # Return the virtual machine's name.
+    # @return [String]
+    def name
+      info[/^Name:\s+(.+)$/,1] if info
+    end
+
+    # Return the virtual machine's UUID.
+    # @return [String]
+    def uuid
+      info[/^ID:\s+(\{[a-f0-9-]+\})$/,1] if info
+    end
+
+    # Is equal if the virtual machines UUIDs are equal.
+    def ==(other_vm)
+      uuid == other_vm.uuid
+    end
+
+    # Return the name of the virtual machine.
+    def to_s
+      name || 'Unknown VM'
+    end
+
+  private
+
+    # Info string about the virtual machine.
+    # @Note These infos will only be updated when calling `update_info`.
+    attr_reader :info
+
+    # Start the virtual machine.
+    def start
+      command!('prlctl', 'start', uuid)
+    end
+
+    # Stop the virtual machine.
+    def stop
+      command!('prlctl', 'stop', uuid)
+    end
+
+    # Backup the virtual machine.
+    def backup
+      cmd = ['prlctl', 'backup', uuid]
+      cmd << '--full' if config[:full]
+      command!(*cmd)
+    end
+
+    # Update and return info string for the virtual machine.
+    # @return [String] infos
+    def update_info
+      @info = command('prlctl', 'list', '--info', @name_or_uuid)
+    end
+
+    def stopped?
+      update_info[/^State:\s+stopped$/]
+    end
+
+    # List of full backups for the virtual machine.
+    def full_backups
+      command('prlctl', 'backup-list', uuid).split("\n").map { |l| $1 if l[/^\{[a-f0-9-]+\}\s+(\{[a-f0-9-]+\})[^(\.\d+)]/] }.compact
+    end
+
+    # Delete the backup given by backup UUID.
+    def delete_backup(backup_uuid)
+      command!('prlctl', 'backup-delete', '--tag', backup_uuid)
+    end
+  end
+end

data/lib/prlbackup.rb

@@ -0,0 +1,51 @@
+require 'mixlib/cli'
+require 'logger'
+require 'shellwords'
+require 'prlbackup/version'
+require 'prlbackup/cli'
+require 'prlbackup/virtual_machine'
+
+module PrlBackup
+  class << self
+    # The global configuration based on command line options.
+    attr_accessor :config
+  end
+
+  # Run the command and log the last line from stdout unless --dry-run.
+  # @return [String] stdout of the comand.
+  def command!(*args)
+    logger.info("Running `#{args.shelljoin}`...") if PrlBackup.config[:verbose]
+    unless PrlBackup.config[:dry_run]
+      output = command(*args)
+      logger.info(output.split("\n").last)
+    else
+      output = ''
+    end
+    output
+  end
+
+  # Run the command until it is finished.
+  # @Note This will even run when option --dry-run is selected!
+  # @return [String] stdout of the comand.
+  def command(*args)
+    output = `#{args.shelljoin} 2>&1`
+    status = $?
+    unless status.success?
+      logger.error("Command `#{args.shelljoin}` failed with exit status #{status.exitstatus}:\n#{output}")
+      exit(1)
+    end
+    output
+  end
+
+  def logger
+    @logger ||= create_logger
+  end
+
+private
+
+  def create_logger
+    l = Logger.new(STDOUT)
+    l.formatter = proc { |severity, datetime, progname, msg| "prlbackup #{severity}: [#{self}] #{msg}\n" }
+    l
+  end
+end

data/man/prlbackup

@@ -0,0 +1,31 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PRLBACKUP" "" "May 2012" "" "PRLBACKUP MANUAL"
+.
+.SH "NAME"
+\fBprlbackup\fR
+.
+.P
+\&\.\e" generated with Ronn/v0\.7\.3 \.\e" http://github\.com/rtomayko/ronn/tree/0\.7\.3 \. \.TH "PRLBACKUP" "1" "May 2012" "" "PRLBACKUP MANUAL" \. \.SH "NAME" \efBprlbackup\efR \- an awesome backup tool for Parallels Server Virtual Machines \. \.SH "SYNOPSIS" \efBprlbackup\efR \efB\-h\efR|\efB\-\-help\efR \. \.br \efBprlbackup\efR [\efIOPTIONS\efR\.\.\.] \efIvm_id|vm_name\efR\.\.\. \. \.br \efBprlbackup\efR [\efIOPTIONS\efR\.\.\.] \efB\-a\efR|\efB\-\-all\efR \. \.br \efBprlbackup\efR [\efIOPTIONS\efR\.\.\.] \efB\-a\efR|\efB\-\-all\efR \efB\-e\efR|\efB\-\-exclude\efR \efIvm_id|vm_name\efR\.\.\. \. \.SH "DESCRIPTION" \efBprlbackup\efR simplifies the backup of one or multiple Virtual Machines (VM) running on Parallels Server by stoping them during backup and deleting old backups on demand\. A working installation of Parallels Server is required\. \. \.P \efBprlbackup\efR was tested under Parallels Server for Mac 4\.0 (PSfM)\. \. \.SH "OPTIONS" \. \.TP \efB\-h\efR, \efB\-\-help\efR Display a short help\. \. \.TP \efB\-a\efR, \efB\-\-all\efR Backup all virtual machines which are registered in Parallels Server\. \. \.TP \efB\-e\efR, \efB\-\-exclude\efR Backup all but the given virtual machines (only applicable in combination with option \efB\-\-all\efR!)\. \. \.TP \efB\-f\efR, \efB\-\-full\efR Create full backups (by default incremental backups are created)\. Note that the first backup for a VM is always a full backup despide of this option\. \. \.TP \efB\-v\efR, \efB\-\-verbose\efR Show commands with an impact on the VMs prior to their execution\. \. \.TP \efB\-n\efR, \efB\-\-dry\-run\efR Don\e\'t do anything with the VMs, just pretend to\. \. \.TP \efB\-k\efR \efInumber_of_full_backups\efR, \efB\-\-keep\-only\efR \efInumber_of_full_backups\efR Delete the oldest full backup(s) until only \efInumber_of_full_backups\efR exist\. This cleanup action will be executed for each VM right after creating the corresponding backup but only if the backup was successfully created\. Incremental backups are automatically deleted by Parallels Server when their full backup is deleted\. \. \.SH "EXAMPLES" Display short help: \. \.IP "" 4 \. \.nf
+.
+.P
+$ prlbackup \-\-help \. \.fi \. \.IP "" 0 \. \.P Backup VMs by name: \. \.IP "" 4 \. \.nf
+.
+.P
+$ prlbackup Alpha Bravo Charlie \. \.fi \. \.IP "" 0 \. \.P Backup a VM by id: \. \.IP "" 4 \. \.nf
+.
+.P
+$ prlbackup "{97351580\-afd7\-4aff\-9960\-814196b28e37}" \. \.fi \. \.IP "" 0 \. \.P Create full backups of all VMs \. \.IP "" 4 \. \.nf
+.
+.P
+$ prlbackup \-\-full \-\-all \. \.fi \. \.IP "" 0 \. \.P Backup all but not the given VMs: \. \.IP "" 4 \. \.nf
+.
+.P
+$ prlbackup \-\-all \-\-exclude Delta Echo \. \.fi \. \.IP "" 0 \. \.P Show which commands would have been run when backing up all VMs: \. \.IP "" 4 \. \.nf
+.
+.P
+$ prlbackup \-\-dry\-run \-\-verbose \-\-all \. \.fi \. \.IP "" 0 \. \.P Create the weekly full backup for all VMs and delete backups older than four weeks: \. \.IP "" 4 \. \.nf
+.
+.P
+$ prlbackup \-\-all \-\-keep\-only 5 \. \.fi \. \.IP "" 0 \. \.SH "SEE ALSO" \. \.IP "(bu" 4 prlctl(8) \. \.IP "(bu" 4 prlbackup\e\'s homepage \efIhttps://github\.com/bjoernalbers/prlbackup\efR \. \.IP "" 0 \. \.SH "COPYRIGHT" Copyright (c) 2012 Bjoern Albers (\efIbjoernalbers@googlemail\.com\efR) \. \.P Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: \. \.P The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software\. \. \.P THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT\. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE\.