Proxmox

A lightweight Ruby gem that provides a clean, idiomatic interface to the Proxmox VE REST API. It handles authentication, token management, and all common API endpoints (nodes, virtual machines, storage, containers, etc.) so you can focus on building automation, orchestration, or custom tooling without dealing with raw HTTP calls.

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add proxmox-sdk

If bundler is not being used to manage dependencies, install the gem by executing:

gem install proxmox-sdk

Usage

require 'proxmox'

client = Proxmox::Client.new(
  base_url: 'https://192.168.1.4:8006',
  username: 'root',
  password: 'SuperSecret!',
  ignore_ssl: true
)

Development

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

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/proxmox.

License

The gem is available as open source under the terms of the MIT License.