class VagrantPlugins::ProviderLibvirt::Provider

This is the base class for a provider for the V2 API. A provider is responsible for creating compute resources to match the needs of a Vagrant-configured system.

Public Class Methods

new(machine) click to toggle source
# File lib/vagrant-libvirt/provider.rb, line 10
def initialize(machine)
  @machine = machine
  raise 'REQUIRE USE RUBY >= 1.9.3 VERSION' if RUBY_VERSION < '1.9.3'
end

Public Instance Methods

action(name) click to toggle source

This should return an action callable for the given name.

# File lib/vagrant-libvirt/provider.rb, line 16
def action(name)
  # Attempt to get the action method from the Action class if it
  # exists, otherwise return nil to show that we don't support the
  # given action.
  action_method = "action_#{name}"
  return Action.send(action_method) if Action.respond_to?(action_method)
  nil
end
mac_addresses() click to toggle source
# File lib/vagrant-libvirt/provider.rb, line 52
def mac_addresses
  # Run a custom action called "read_mac_addresses" which will return
  # a list of mac addresses used by the machine. The returned data will
  # be in the following format:
  #
  # {
  #   <ADAPTER_ID>: <MAC>
  # }
  env = @machine.action('read_mac_addresses')
  env[:machine_mac_addresses]
end
machine_id_changed() click to toggle source

This method is called if the underying machine ID changes. Providers can use this method to load in new data for the actual backing machine or to realize that the machine is now gone (the ID can become `nil`).

# File lib/vagrant-libvirt/provider.rb, line 29
def machine_id_changed
end
ssh_info() click to toggle source

This should return a hash of information that explains how to SSH into the machine. If the machine is not at a point where SSH is even possible, then `nil` should be returned.

# File lib/vagrant-libvirt/provider.rb, line 35
def ssh_info
  # Run a custom action called "read_ssh_info" which does what it says
  # and puts the resulting SSH info into the `:machine_ssh_info` key in
  # the environment.
  #
  # Ssh info has following format..
  #
  #{
  #  :host => "1.2.3.4",
  #  :port => "22",
  #  :username => "mitchellh",
  #  :private_key_path => "/path/to/my/key"
  #}
  env = @machine.action('read_ssh_info')
  env[:machine_ssh_info]
end
state() click to toggle source

This should return the state of the machine within this provider. The state must be an instance of {MachineState}.

# File lib/vagrant-libvirt/provider.rb, line 66
def state
  # Run a custom action we define called "read_state" which does
  # what it says. It puts the state in the `:machine_state_id`
  # key in the environment.
  env = @machine.action('read_state')

  state_id = env[:machine_state_id]

  # Get the short and long description
  short = I18n.t("vagrant_libvirt.states.short_#{state_id}")
  long  = I18n.t("vagrant_libvirt.states.long_#{state_id}")

  # Return the MachineState object
  Vagrant::MachineState.new(state_id, short, long)
end
to_s() click to toggle source
# File lib/vagrant-libvirt/provider.rb, line 82
def to_s
  id = @machine.id.nil? ? "new" : @machine.id
  "Libvirt (#{id})"
end