Skip to content

Latest commit

 

History

History
90 lines (67 loc) · 3.08 KB

README.md

File metadata and controls

90 lines (67 loc) · 3.08 KB
Raw

proxmox-api

Build Status Gem Version

What is it?

ProxmoxAPI is Ruby wrapper for Proxmox REST API. It simply send your requests to Proxmox REST API server without verifying them.

Usage

Installation

You can add this gem to your Gemfile and use bundler:

gem 'proxmox-api'

Or install gem manually:

gem install proxmox

Authorization

Creating connection is as simple as giving all needed info to ProxmoxAPI constructor:

First parameter is node we are going to connect to. Second parameter is options hash. Possible options are:

  1. Ticket creation options :username, :password, :realm, :otp (see /access/ticket request description)

    require 'proxmox_api'

client = ProxmoxAPI.new(
  'proxmox-host.example.org',
  username: 'root', password: 'password', realm: 'pam', verify_ssl: false
)

  2. Token options :token, :secret (see API documentation for details)

    require 'proxmox_api'

client = ProxmoxAPI.new(
  'proxmox-host.example.org',
  token: 'root@pam!tokenid', secret: 'cdbb8fce-c068-4a9b-ade1-a00043db818a', verify_ssl: false
)

  3. SSL options, supported by rest-client. See it's documentation for full list.

ProxmoxAPI constructor will automatically try to get access ticket with given credentials and will raise an exception if this will fail.

Making requests

To build REST API url just chain it to client object. Calling .get, .put, .post or .delete will result in sending appropriate request to Proxmox node.

ProxmoxAPI::ApiException will be raised if server will return error status code.

# Get current status of container with id 101 on pve1 node
client.nodes['pve1'].lxc[101].status.current.get

# Same request. You can use brackets or methods in any valid combination.
client.nodes.pve1.lxc[101].status[:current].get

# Same request again. Full api path can be given with brackets too.
client['nodes/pve1/lxc/101/status/current'].get

# Create user 'user' with password 'password' in 'pve' realm
client.access.users.post(userid: 'user@pve', password: 'password')

# Give user PVEAdmin role on server with vmid 101 
proxmox.access.acl.put(path: 'vms/101', users: 'user@pve', roles: 'PVEAdmin')

If you want to ignore server status codes, you can use dangerous methods:

# Here we use dangerous method to check if user exists
proxmox.access.users['user@pve'].get!.nil?

Contributing

Feel free to create issue or propose pull request on GitHub.