Build Status Gem Version Coverage Status Code Climate

Quickmox

Quickmox is a Ruby gem for managing Proxmox hosts by using SSH screen-scraping techniques.

Installation

Add this line to your application's Gemfile:

gem 'quickmox'

And then execute:

$ bundle

Or install it yourself as:

$ gem install quickmox

Usage

require 'quickmox'
include Quickmox

host = Host.new( SSHTransport.new('hostname','username','password') )
    .connect
    .scan

p host.localname
p host.uptime

host.guests.each do |guest|
    guest.scan
    p guest.status
    guest.params.keys.each do |key|
        puts "#{key}: #{guest.params[key]}"
    end
end if host.is_proxmox?

host.disconnect

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rspec spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jkvalk/quickmox. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.