Sha256: ba33b6fe2e76e2758c09736b800a74311c1f3210104be2c12159078f63676789

Contents?: true

Size: 1.1 KB

Versions: 16

Compression:

Stored size: 1.1 KB

Contents

module Vagrant
  class Commands
    # Halts a running vagrant instance. This forcibly halts the instance;
    # it is the equivalent of pulling the power on a machine. The instance
    # can be restarted again with {up}.
    #
    # This command requires than an instance already be brought up with
    # `vagrant up`.
    class Halt < Base
      Base.subcommand "halt", self
      description "Halts the currently running vagrant environment"

      def execute(args=[])
        all_or_single(args, :halt)
      end

      def halt_single(name)
        vm = env.vms[name.to_sym]
        if vm.nil?
          error_and_exit(:unknown_vm, :vm => name)
          return # for tests
        end

        if vm.created?
          vm.halt(options)
        else
          vm.env.logger.info "VM '#{name}' not created. Ignoring."
        end
      end

      def options_spec(opts)
        opts.banner = "Usage: vagrant halt"

        # Defaults
        options[:force] = false

        opts.on("-f", "--force", "Forceful shutdown of virtual machine.") do |v|
          options[:force] = true
        end
      end
    end
  end
end

Version data entries

16 entries across 16 versions & 2 rubygems

Version Path
vagrantup-0.5.4 lib/vagrant/commands/halt.rb
vagrantup-0.5.3 lib/vagrant/commands/halt.rb
vagrantup-0.5.2 lib/vagrant/commands/halt.rb
vagrantup-0.5.1 lib/vagrant/commands/halt.rb
vagrantup-0.5.0 lib/vagrant/commands/halt.rb
vagrantup-0.4.3.dev lib/vagrant/commands/halt.rb
vagrantup-0.4.1 lib/vagrant/commands/halt.rb
vagrantup-0.4.0 lib/vagrant/commands/halt.rb
vagrant-0.5.4 lib/vagrant/commands/halt.rb
vagrant-0.5.3 lib/vagrant/commands/halt.rb
vagrant-0.5.2 lib/vagrant/commands/halt.rb
vagrant-0.5.1 lib/vagrant/commands/halt.rb
vagrant-0.5.0 lib/vagrant/commands/halt.rb
vagrant-0.4.2 lib/vagrant/commands/halt.rb
vagrant-0.4.1 lib/vagrant/commands/halt.rb
vagrant-0.4.0 lib/vagrant/commands/halt.rb