class Proxmox::Proxmox
Object to manage Proxmox
server
Attributes
Return connection status
-
connected
-
error
Public Class Methods
Create a object to manage a Proxmox
server through API
Example:
Proxmox::Proxmox.new('https://the-proxmox-server:8006/api2/json/', 'node', 'root', 'secret', 'pam', {verify_ssl: false})
# File lib/proxmox.rb, line 25 def initialize(pve_cluster, node, username, password, realm, ssl_options = {}) @pve_cluster = pve_cluster @node = node @username = username @password = password @realm = realm @ssl_options = ssl_options @connection_status = 'error' @site = RestClient::Resource.new(@pve_cluster, @ssl_options) @auth_params = create_ticket end
Public Instance Methods
# File lib/proxmox.rb, line 49 def delete(path) http_action_delete(path) end
# File lib/proxmox.rb, line 37 def get(path, args = {}) http_action_get(path, args) end
Get CT config
Return a string as task ID
Example:
openvz_config(200)
Example return:
{ 'quotaugidlimit' => 0, 'disk' => 0, 'ostemplate' => 'ubuntu-10.04-standard_10.04-4_i386.tar.gz', 'hostname' => 'test.test.com', 'nameserver' => '127.0.0.1 192.168.1.1', 'memory' => 256, 'searchdomain' => 'domain.com', 'onboot' => 0, 'cpuunits' => 1000, 'swap' => 256, 'quotatime' => 0, 'digest' => 'e7e6e21a215af6b9da87a8ecb934956b8983f960', 'cpus' => 1, 'storage' => 'local' }
# File lib/proxmox.rb, line 314 def openvz_config(vmid) http_action_get "nodes/#{@node}/openvz/#{vmid}/config" end
Set CT config
Return nil
Example:
openvz_config(200, { 'swap' => 2048 })
Example return:
nil
# File lib/proxmox.rb, line 333 def openvz_config_set(vmid, data) http_action_put("nodes/#{@node}/openvz/#{vmid}/config", data) end
Delete CT
Return a string as task ID
Example:
openvz_delete(200)
Example return:
UPID:localhost:000BC66A:1279E395:521EFC4E:vzdelete:200:root@pam:
# File lib/proxmox.rb, line 204 def openvz_delete(vmid) http_action_delete "nodes/#{@node}/openvz/#{vmid}" end
Get CT list
Return a Hash of all openvz container
Example:
openvz_get
Example return:
{ '101' => { 'maxswap' => 536870912, 'disk' => 405168128, 'ip' => '192.168.1.5', 'status' => 'running', 'netout' => 272, 'maxdisk' => 4294967296, 'maxmem' => 536870912, 'uptime' => 3068073, 'swap' => 0, 'vmid' => '101', 'nproc' => '10', 'diskread' => 0, 'cpu' => 0.00031670581100007, 'netin' => 0, 'name' => 'test2.domain.com', 'failcnt' => 0, 'diskwrite' => 0, 'mem' => 22487040, 'type' => 'openvz', 'cpus' => 1 }, [...] }
# File lib/proxmox.rb, line 155 def openvz_get data = http_action_get "nodes/#{@node}/openvz" ve_list = {} data.each do |ve| ve_list[ve['vmid']] = ve end ve_list end
Create CT container
Return a String as task ID
Examples:
openvz_post('ubuntu-10.04-standard_10.04-4_i386', 200) openvz_post('ubuntu-10.04-standard_10.04-4_i386', 200, {'hostname' => 'test.test.com', 'password' => 'testt' })
Example return:
UPID:localhost:000BC66A:1279E395:521EFC4E:vzcreate:200:root@pam:
# File lib/proxmox.rb, line 181 def openvz_post(ostemplate, vmid, config = {}) config['vmid'] = vmid config['ostemplate'] = "local%3Avztmpl%2F#{ostemplate}.tar.gz" vm_definition = config.to_a.map { |v| v.join '=' }.join '&' http_action_post("nodes/#{@node}/openvz", vm_definition) end
Shutdown CT
Return a string as task ID
Example:
openvz_shutdown(200)
Example return:
UPID:localhost:000BC66A:1279E395:521EFC4E:vzshutdown:200:root@pam:
# File lib/proxmox.rb, line 280 def openvz_shutdown(vmid) http_action_post "nodes/#{@node}/openvz/#{vmid}/status/shutdown" end
Start CT
Return a string as task ID
Example:
openvz_start(200)
Example return:
UPID:localhost:000BC66A:1279E395:521EFC4E:vzstart:200:root@pam:
# File lib/proxmox.rb, line 242 def openvz_start(vmid) http_action_post "nodes/#{@node}/openvz/#{vmid}/status/start" end
Get CT status
Return a string as task ID
Example:
openvz_delete(200)
Example return:
UPID:localhost:000BC66A:1279E395:521EFC4E:vzdelete:200:root@pam:
# File lib/proxmox.rb, line 223 def openvz_status(vmid) http_action_get "nodes/#{@node}/openvz/#{vmid}/status/current" end
Stop CT
Return a string as task ID
Example:
openvz_stop(200)
Example return:
UPID:localhost:000BC66A:1279E395:521EFC4E:vzstop:200:root@pam:
# File lib/proxmox.rb, line 261 def openvz_stop(vmid) http_action_post "nodes/#{@node}/openvz/#{vmid}/status/stop" end
# File lib/proxmox.rb, line 41 def post(path, args = {}) http_action_post(path, args) end
# File lib/proxmox.rb, line 45 def put(path, args = {}) http_action_put(path, args) end
Get task status
-
taksstatus
-
taskstatus:exitstatus
Example:
taskstatus 'UPID:localhost:00051DA0:119EAABC:521CCB19:vzcreate:203:root@pam:'
Examples return:
- running - stopped:OK
# File lib/proxmox.rb, line 69 def task_status(upid) data = http_action_get "nodes/#{@node}/tasks/#{URI.encode upid}/status" status = data['status'] exitstatus = data['exitstatus'] if exitstatus "#{status}:#{exitstatus}" else "#{status}" end end
Get template list
Return a Hash of all templates
Example:
templates
Example return:
{ 'ubuntu-10.04-standard_10.04-4_i386' => { 'format' => 'tgz', 'content' => 'vztmpl', 'volid' => 'local:vztmpl/ubuntu-10.04-standard_10.04-4_i386.tar.gz', 'size' => 142126884 }, 'ubuntu-12.04-standard_12.04-1_i386' => { 'format' => 'tgz', 'content' => 'vztmpl', 'volid' => 'local:vztmpl/ubuntu-12.04-standard_12.04-1_i386.tar.gz', 'size' => 130040792 } }
# File lib/proxmox.rb, line 108 def templates data = http_action_get "nodes/#{@node}/storage/local/content" template_list = {} data.each do |ve| name = ve['volid'].gsub(%r{local:vztmpl\/(.*).tar.gz}, '\1') template_list[name] = ve end template_list end
Private Instance Methods
Extract data or return error
# File lib/proxmox.rb, line 367 def check_response(response) if response.code == 200 JSON.parse(response.body)['data'] else 'NOK: error code = ' + response.code.to_s end end
Methods manages auth
# File lib/proxmox.rb, line 340 def create_ticket post_param = { username: @username, realm: @realm, password: @password } @site['access/ticket'].post post_param do |response, _request, _result, &_block| if response.code == 200 extract_ticket response else @connection_status = 'error' end end end
Method create ticket
# File lib/proxmox.rb, line 352 def extract_ticket(response) data = JSON.parse(response.body) ticket = data['data']['ticket'] csrf_prevention_token = data['data']['CSRFPreventionToken'] unless ticket.nil? token = 'PVEAuthCookie=' + ticket.gsub!(/:/, '%3A').gsub!(/=/, '%3D') end @connection_status = 'connected' { CSRFPreventionToken: csrf_prevention_token, cookie: token } end
# File lib/proxmox.rb, line 394 def http_action_delete(url) @site[url].delete @auth_params do |response, _request, _result, &_block| check_response response end end
# File lib/proxmox.rb, line 388 def http_action_get(url, data = {}) @site[url].get @auth_params.merge(data) do |response, _request, _result, &_block| check_response response end end
Methods manage http dialogs
# File lib/proxmox.rb, line 376 def http_action_post(url, data = {}) @site[url].post data, @auth_params do |response, _request, _result, &_block| check_response response end end
# File lib/proxmox.rb, line 382 def http_action_put(url, data = {}) @site[url].put data, @auth_params do |response, _request, _result, &_block| check_response response end end