module VagrantPlugins::ProviderLibvirt::Action

Public Class Methods

action_destroy() click to toggle source

This is the action that is primarily responsible for completely freeing the resources of the underlying virtual machine.

# File lib/vagrant-libvirt/action.rb, line 178
def self.action_destroy
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use Call, IsCreated do |env, b2|
      unless env[:result]
        # Try to remove stale volumes anyway
        b2.use SetNameOfDomain
        b2.use RemoveStaleVolume if env[:machine].config.vm.box
        b2.use MessageNotCreated unless env[:result]

        next
      end

      b2.use Call, DestroyConfirm do |env2, b3|
        if env2[:result]
          b3.use ClearForwardedPorts
          # b3.use PruneNFSExports
          b3.use DestroyDomain
          b3.use DestroyNetworks
          b3.use ProvisionerCleanup
        else
          b3.use MessageWillNotDestroy
        end
      end
    end
  end
end
action_halt() click to toggle source

This is the action that is primarily responsible for halting the virtual machine.

# File lib/vagrant-libvirt/action.rb, line 122
def self.action_halt
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use ClearForwardedPorts
    b.use Call, IsCreated do |env, b2|
      unless env[:result]
        b2.use MessageNotCreated
        next
      end

      b2.use Call, IsSuspended do |env2, b3|
        b3.use CreateNetworks if env2[:result]
        b3.use ResumeDomain if env2[:result]
      end

      b2.use Call, IsRunning do |env2, b3|
        next unless env2[:result]

        # VM is running, halt it.
        b3.use HaltDomain
      end
    end
  end
end
action_package() click to toggle source

Create/package a new Vagrant Box from the current Domain. This action requires access to the Domain disk image files and will use virt-sysprep (from libguestfs project) to clean the image, removing host SSH keys, etc.

# File lib/vagrant-libvirt/action.rb, line 168
def self.action_package
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use action_halt
    b.use PackageDomain
  end
end
action_provision() click to toggle source

This action is called when `vagrant provision` is called.

# File lib/vagrant-libvirt/action.rb, line 229
def self.action_provision
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use Call, IsCreated do |env, b2|
      unless env[:result]
        b2.use MessageNotCreated
        next
      end

      b2.use Call, IsRunning do |env2, b3|
        unless env2[:result]
          b3.use MessageNotRunning
          next
        end

        b3.use Provision
        # b3.use SyncFolders
      end
    end
  end
end
action_read_mac_addresses() click to toggle source
# File lib/vagrant-libvirt/action.rb, line 296
def self.action_read_mac_addresses
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use ReadMacAddresses
  end
end
action_reload() click to toggle source

This is the action implements the reload command It uses the halt and start actions

# File lib/vagrant-libvirt/action.rb, line 149
def self.action_reload
  Vagrant::Action::Builder.new.tap do |b|
    b.use Call, IsCreated do |env, b2|
      unless env[:result]
        b2.use MessageNotCreated
        next
      end

      b2.use ConfigValidate
      b2.use action_halt
      b2.use action_start
    end
  end
end
action_resume() click to toggle source

This is the action that is primarily responsible for resuming suspended machines.

# File lib/vagrant-libvirt/action.rb, line 275
def self.action_resume
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use Call, IsCreated do |env, b2|
      unless env[:result]
        b2.use MessageNotCreated
        next
      end

      b2.use Call, IsSuspended do |env2, b3|
        unless env2[:result]
          b3.use MessageNotSuspended
          next
        end
        b3.use CreateNetworks
        b3.use ResumeDomain
      end
    end
  end
end
action_ssh() click to toggle source

This action is called to SSH into the machine.

# File lib/vagrant-libvirt/action.rb, line 207
def self.action_ssh
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use Call, IsCreated do |env, b2|
      unless env[:result]
        b2.use MessageNotCreated
        next
      end

      b2.use Call, IsRunning do |env2, b3|
        unless env2[:result]
          b3.use MessageNotRunning
          next
        end

        b3.use SSHExec
      end
    end
  end
end
action_ssh_run() click to toggle source

This is the action that will run a single SSH command.

# File lib/vagrant-libvirt/action.rb, line 304
def self.action_ssh_run
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use Call, IsCreated do |env, b2|
      unless env[:result]
        b2.use MessageNotCreated
        next
      end

      b2.use Call, IsRunning do |env2, b3|
        unless env2[:result]
          b3.use MessageNotRunning
          next
        end

        b3.use SSHRun
      end
    end
  end
end
action_start() click to toggle source

Assuming VM is created, just start it. This action is not called directly by any subcommand. VM can be suspended, already running or in poweroff state.

# File lib/vagrant-libvirt/action.rb, line 68
def self.action_start
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use Call, IsRunning do |env, b2|
      # If the VM is running, run the necessary provisioners
      if env[:result]
        b2.use action_provision
        next
      end

      b2.use Call, IsSuspended do |env2, b3|
        # if vm is suspended resume it then exit
        if env2[:result]
          b3.use CreateNetworks
          b3.use ResumeDomain
          next
        end

        if !env[:machine].config.vm.box
          # With no box, we just care about network creation and starting it
          b3.use CreateNetworks
          b3.use SetBootOrder
          b3.use StartDomain
        else
          # VM is not running or suspended.

          b3.use Provision

          # Ensure networks are created and active
          b3.use CreateNetworks
          b3.use SetBootOrder

          b3.use PrepareNFSValidIds
          b3.use SyncedFolderCleanup
          b3.use SyncedFolders

          # Start it..
          b3.use StartDomain

          # Machine should gain IP address when comming up,
          # so wait for dhcp lease and store IP into machines data_dir.
          b3.use WaitTillUp

          b3.use ForwardPorts
          b3.use PrepareNFSSettings
          b3.use ShareFolders
        end
      end
    end
  end
end
action_suspend() click to toggle source

This is the action that is primarily responsible for suspending the virtual machine.

# File lib/vagrant-libvirt/action.rb, line 253
def self.action_suspend
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use Call, IsCreated do |env, b2|
      unless env[:result]
        b2.use MessageNotCreated
        next
      end

      b2.use Call, IsRunning do |env2, b3|
        unless env2[:result]
          b3.use MessageNotRunning
          next
        end
        b3.use SuspendDomain
      end
    end
  end
end
action_up() click to toggle source

This action is called to bring the box up from nothing.

# File lib/vagrant-libvirt/action.rb, line 19
def self.action_up
  Vagrant::Action::Builder.new.tap do |b|
    b.use ConfigValidate
    b.use BoxCheckOutdated
    b.use Call, IsCreated do |env, b2|
      # Create VM if not yet created.
      if !env[:result]
        b2.use SetNameOfDomain
        if !env[:machine].config.vm.box
          b2.use CreateDomain
          b2.use CreateNetworks
          b2.use CreateNetworkInterfaces
          b2.use SetBootOrder
          b2.use StartDomain
        else
          b2.use HandleStoragePool
          b2.use HandleBox
          b2.use HandleBoxImage
          b2.use CreateDomainVolume
          b2.use CreateDomain

          b2.use Provision
          b2.use PrepareNFSValidIds
          b2.use SyncedFolderCleanup
          b2.use SyncedFolders
          b2.use PrepareNFSSettings
          b2.use ShareFolders
          b2.use CreateNetworks
          b2.use CreateNetworkInterfaces
          b2.use SetBootOrder

          b2.use StartDomain
          b2.use WaitTillUp

          b2.use ForwardPorts
          b2.use SetHostname
          # b2.use SyncFolders
        end
      else
        env[:halt_on_error] = true
        b2.use action_start
      end
    end
  end
end
remove_libvirt_image() click to toggle source

remove image from libvirt storage pool

# File lib/vagrant-libvirt/action.rb, line 12
def self.remove_libvirt_image
  Vagrant::Action::Builder.new.tap do |b|
    b.use RemoveLibvirtImage
  end
end