class Vagrant::Plugin::V2::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

installed?() click to toggle source

This is called early, before a machine is instantiated, to check if this provider is installed. This should return true or false.

If the provider is not installed and Vagrant determines it is able to install this provider, then it will do so. Installation is done by calling Environment.install_provider.

If Environment.can_install_provider? returns false, then an error will be shown to the user.

# File lib/vagrant/plugin/v2/provider.rb, line 36
def self.installed?
  # By default return true for backwards compat so all providers
  # continue to work.
  true
end
new(machine) click to toggle source

Initialize the provider to represent the given machine.

@param [Vagrant::Machine] machine The machine that this provider

is responsible for.
# File lib/vagrant/plugin/v2/provider.rb, line 46
def initialize(machine)
end
usable?(raise_error=false) click to toggle source

This is called early, before a machine is instantiated, to check if this provider is usable. This should return true or false.

If raise_error is true, then instead of returning false, this should raise an error with a helpful message about why this provider cannot be used.

@param [Boolean] raise_error If true, raise exception if not usable. @return [Boolean]

# File lib/vagrant/plugin/v2/provider.rb, line 21
def self.usable?(raise_error=false)
  # Return true by default for backwards compat since this was
  # introduced long after providers were being written.
  true
end

Public Instance Methods

_initialize(name, machine) click to toggle source

This is an internal initialize function that should never be overridden. It is used to initialize some common internal state that is used in a provider.

# File lib/vagrant/plugin/v2/provider.rb, line 104
def _initialize(name, machine)
  initialize_capabilities!(
    name.to_sym,
    { name.to_sym => [Class.new, nil] },
    Vagrant.plugin("2").manager.provider_capabilities,
    machine,
  )
end
action(name) click to toggle source

This should return an action callable for the given name.

@param [Symbol] name Name of the action. @return [Object] A callable action sequence object, whether it

is a proc, object, etc.
# File lib/vagrant/plugin/v2/provider.rb, line 54
def action(name)
  nil
end
machine_id_changed() click to toggle source

This method is called if the underlying 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`). No parameters are given, since the underlying machine is simply the machine instance given to this object. And no return value is necessary.

# File lib/vagrant/plugin/v2/provider.rb, line 64
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.

The general structure of this returned hash should be the following:

{
  host: "1.2.3.4",
  port: "22",
  username: "mitchellh",
  private_key_path: "/path/to/my/key"
}

Note: Vagrant only supports private key based authentication, mainly for the reason that there is no easy way to exec into an ‘ssh` prompt with a password, whereas we can pass a private key via commandline.

@return [Hash] SSH information. For the structure of this hash

read the accompanying documentation for this method.
# File lib/vagrant/plugin/v2/provider.rb, line 88
def ssh_info
  nil
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}. Please read the documentation of that class for more information.

@return [MachineState]

# File lib/vagrant/plugin/v2/provider.rb, line 97
def state
  nil
end