Class: Vagrant::Plugin::V1::Host

Inherits:
Object
  • Object
show all
Defined in:
lib/vagrant/plugin/v1/host.rb

Overview

Base class for a host in Vagrant. A host class contains functionality that is specific to a specific OS that is running Vagrant. This abstraction is done because there is some host-specific logic that Vagrant must do in some cases.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ui) ⇒ Host

Initializes a new host class.

The only required parameter is a UI object so that the host objects have some way to communicate with the outside world.

Parameters:

  • ui (UI)

    UI for the hosts to output to.


34
35
36
# File 'lib/vagrant/plugin/v1/host.rb', line 34

def initialize(ui)
  @ui = ui
end

Class Method Details

.match?Boolean

This returns true/false depending on if the current running system matches the host class.

Returns:

  • (Boolean)

13
14
15
# File 'lib/vagrant/plugin/v1/host.rb', line 13

def self.match?
  nil
end

.precedenceObject

The precedence of the host when checking for matches. This is to allow certain host such as generic OS's ("Linux", "BSD", etc.) to be specified last.

The hosts with the higher numbers will be checked first.

If you're implementing a basic host, you can probably ignore this.


24
25
26
# File 'lib/vagrant/plugin/v1/host.rb', line 24

def self.precedence
  5
end

Instance Method Details

#nfs?Boolean

Returns true of false denoting whether or not this host supports NFS shared folder setup. This method ideally should verify that NFS is installed.

Returns:

  • (Boolean)

43
44
45
# File 'lib/vagrant/plugin/v1/host.rb', line 43

def nfs?
  false
end

#nfs_export(id, ip, folders) ⇒ Object

Exports the given hash of folders via NFS.

Parameters:

  • id (String)

    A unique ID that is guaranteed to be unique to match these sets of folders.

  • ip (String)

    IP of the guest machine.

  • folders (Hash)

    Shared folders to sync.


53
54
# File 'lib/vagrant/plugin/v1/host.rb', line 53

def nfs_export(id, ip, folders)
end

#nfs_prune(valid_ids) ⇒ Object

Prunes any NFS exports made by Vagrant which aren't in the set of valid ids given.

Parameters:

  • valid_ids (Array<String>)

    Valid IDs that should not be pruned.


61
62
# File 'lib/vagrant/plugin/v1/host.rb', line 61

def nfs_prune(valid_ids)
end