class Vagrant::Plugin::V1::Provider
This is the base class for a provider for the V1
API. A provider is responsible for creating compute resources to match the needs of a Vagrant-configured system.
Public Class Methods
Initialize the provider to represent the given machine.
@param [Vagrant::Machine] machine The machine that this provider
is responsible for.
# File lib/vagrant/plugin/v1/provider.rb, line 12 def initialize(machine) end
Public Instance Methods
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/v1/provider.rb, line 20 def action(name) nil end
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/v1/provider.rb, line 30 def machine_id_changed end
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/v1/provider.rb, line 54 def ssh_info nil end
This should return the state of the machine within this provider. The state can be any symbol.
@return [Symbol]
# File lib/vagrant/plugin/v1/provider.rb, line 62 def state nil end