class Provider
Public Class Methods
@param [Vagrant::Machine] machine The machine that this provider
is responsible for.
# File lib/provider.rb, line 6 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/provider.rb, line 14 def action(name) puts "#{name} was called" case name when :up then ->(a) {self.action :start} when :start then ->(a) {} end end
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`). 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/provider.rb, line 28 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/provider.rb, line 52 def ssh_info nil end
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/provider.rb, line 61 def state nil end