Skip to content

Add getTicket() function. Add $verbose_mode (default: false). #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lsthompson wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Add getTicket() function. Add $verbose_mode (default: false). #42

Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
6b2e425
Add link to repo & remove (c) year
lsthompson Jun 9, 2023
ee84c98
Improve tagging of error_log usage
lsthompson Jun 14, 2023
d4a2ded
Add getTicket(); comment out verbose logging; error pass-back detail
lsthompson Jun 19, 2023
8268aba
getTicket() return only ticket, not CSRF etc
lsthompson Jun 19, 2023
8b1ad23
Wrong paste; redo of previous commit (ticket only)
lsthompson Jun 19, 2023
68e5e8a
Add $verbose_mode; except only (no return) (pull #42 review)
lsthompson Jun 20, 2023
1ab736e
Revert exception to error_log per review
lsthompson Jun 20, 2023
0238c58
Tidy-up; improve README; etc.
lsthompson Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 55 additions & 44 deletions pve2_api.class.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
/*

Proxmox VE APIv2 (PVE2) Client - PHP Class
https://github.com/CpuID/pve2-api-php-client/

Copyright (c) 2012-2014 Nathan Sullivan
Copyright (c) Nathan Sullivan

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
Expand Down Expand Up @@ -41,19 +42,19 @@ class PVE2_API {

public function __construct ($hostname, $username, $realm, $password, $port = 8006, $verify_ssl = false) {
if (empty($hostname) || empty($username) || empty($realm) || empty($password) || empty($port)) {
throw new PVE2_Exception("Hostname/Username/Realm/Password/Port required for PVE2_API object constructor.", 1);
throw new PVE2_Exception("PVE2 API: Hostname/Username/Realm/Password/Port required for PVE2_API object constructor.", 1);
}
// Check hostname resolves.
if (gethostbyname($hostname) == $hostname && !filter_var($hostname, FILTER_VALIDATE_IP)) {
throw new PVE2_Exception("Cannot resolve {$hostname}.", 2);
throw new PVE2_Exception("PVE2 API: Cannot resolve {$hostname}.", 2);
}
// Check port is between 1 and 65535.
if (!filter_var($port, FILTER_VALIDATE_INT, ['options' => ['min_range' => 1, 'max_range' => 65535]])) {
throw new PVE2_Exception("Port must be an integer between 1 and 65535.", 6);
throw new PVE2_Exception("PVE2 API: Port must be an integer between 1 and 65535.", 6);
}
// Check that verify_ssl is boolean.
if (!is_bool($verify_ssl)) {
throw new PVE2_Exception("verify_ssl must be boolean.", 7);
throw new PVE2_Exception("PVE2 API: verify_ssl must be boolean.", 7);
}

$this->hostname = $hostname;
Expand Down Expand Up @@ -106,7 +107,7 @@ public function login () {
// Just to be safe, set this to null again.
$this->login_ticket_timestamp = null;
if ($login_request_info['ssl_verify_result'] == 1) {
throw new PVE2_Exception("Invalid SSL cert on {$this->hostname} - check that the hostname is correct, and that it appears in the server certificate's SAN list. Alternatively set the verify_ssl flag to false if you are using internal self-signed certs (ensure you are aware of the security risks before doing so).", 4);
throw new PVE2_Exception("PVE2 API: Invalid SSL cert on {$this->hostname} - check that the hostname is correct, and that it appears in the server certificate's SAN list. Alternatively set the verify_ssl flag to false if you are using internal self-signed certs (ensure you are aware of the security risks before doing so).", 4);
}
return false;
} else {
Expand All @@ -126,12 +127,21 @@ public function login () {
# Use with care, and DO NOT use with root, it may harm your system
public function setCookie() {
if (!$this->check_login_ticket()) {
throw new PVE2_Exception("Not logged into Proxmox host. No Login access ticket found or ticket expired.", 3);
throw new PVE2_Exception("PVE2 API: Not logged into Proxmox. No login Access Ticket found or Ticket expired.", 3);
}

setrawcookie("PVEAuthCookie", $this->login_ticket['ticket'], 0, "/");
}

# Gets the PVE Access Ticket
public function getTicket() {
if ($this->login_ticket['ticket']) {
return $this->login_ticket['ticket'];
} else {
return false;
}
}

/*
* bool check_login_ticket ()
* Checks if the login ticket is valid still, returns false if not.
Expand Down Expand Up @@ -165,7 +175,7 @@ private function action ($action_path, $http_method, $put_post_parameters = null
}

if (!$this->check_login_ticket()) {
throw new PVE2_Exception("Not logged into Proxmox host. No Login access ticket found or ticket expired.", 3);
throw new PVE2_Exception("PVE2 API: Not logged into Proxmox. No login Access Ticket found or Ticket expired.", 3);
}

// Prepare cURL resource.
Expand Down Expand Up @@ -209,7 +219,7 @@ private function action ($action_path, $http_method, $put_post_parameters = null
curl_setopt($prox_ch, CURLOPT_HTTPHEADER, $put_post_http_headers);
break;
default:
throw new PVE2_Exception("Error - Invalid HTTP Method specified.", 5);
throw new PVE2_Exception("PVE2 API: Error - Invalid HTTP Method specified.", 5);
return false;
}

Expand All @@ -230,12 +240,12 @@ private function action ($action_path, $http_method, $put_post_parameters = null
$action_response_array = json_decode($body_response, true);

$action_response_export = var_export($action_response_array, true);
error_log("----------------------------------------------\n" .
"FULL RESPONSE:\n\n{$action_response}\n\nEND FULL RESPONSE\n\n" .
"Headers:\n\n{$header_response}\n\nEnd Headers\n\n" .
"Data:\n\n{$body_response}\n\nEnd Data\n\n" .
"RESPONSE ARRAY:\n\n{$action_response_export}\n\nEND RESPONSE ARRAY\n" .
"----------------------------------------------");
// error_log("----------------------------------------------\n" .
// "FULL RESPONSE:\n\n{$action_response}\n\nEND FULL RESPONSE\n\n" .
// "Headers:\n\n{$header_response}\n\nEnd Headers\n\n" .
// "Data:\n\n{$body_response}\n\nEnd Data\n\n" .
// "RESPONSE ARRAY:\n\n{$action_response_export}\n\nEND RESPONSE ARRAY\n" .
// "----------------------------------------------");

unset($action_response);
unset($action_response_export);
Expand All @@ -251,20 +261,21 @@ private function action ($action_path, $http_method, $put_post_parameters = null
return $action_response_array['data'];
}
} else {
error_log("This API Request Failed.\n" .
"HTTP Response - {$split_http_response_line[1]}\n" .
"HTTP Error - {$split_headers[0]}");
throw new PVE2_Exception("PVE2 API: This API Request Failed.\n" .
"HTTP CODE: {$split_http_response_line[1]},\n" .
"HTTP ERROR: {$split_headers[0]},\n" .
"REPLY INFO: {$body_response}");
return false;
}
} else {
error_log("Error - Invalid HTTP Response.\n" . var_export($split_headers, true));
throw new PVE2_Exception("PVE2 API: Error - Invalid HTTP Response.\n" . var_export($split_headers, true));
return false;
}

if (!empty($action_response_array['data'])) {
return $action_response_array['data'];
} else {
error_log("\$action_response_array['data'] is empty. Returning false.\n" .
throw new PVE2_Exception("PVE2 API: \$action_response_array['data'] is empty. Returning false.\n" .
var_export($action_response_array['data'], true));
return false;
}
Expand All @@ -286,7 +297,7 @@ public function reload_node_list () {
$this->cluster_node_list = $nodes_array;
return true;
} else {
error_log(" Empty list of nodes returned in this cluster.");
error_log("PVE2 API: Empty list of Nodes returned in this Cluster.");
return false;
}
}
Expand Down Expand Up @@ -342,12 +353,12 @@ public function get_vms () {
$this->$cluster_vms_list = $result;
return $this->$cluster_vms_list;
} else {
error_log(" Empty list of vms returned in this cluster.");
error_log("PVE2 API: Empty list of VMs returned in this Cluster.");
return false;
}
}
} else {
error_log(" Empty list of nodes returned in this cluster.");
error_log("PVE2 API: Empty list of Nodes returned in this Cluster.");
return false;
}
}
Expand All @@ -365,14 +376,14 @@ public function start_vm ($node,$vmid) {
$url = "/nodes/" . $node . "/qemu/" . $vmid . "/status/start";
$post = $this->post($url,$parameters);
if ($post) {
error_log("Started vm " . $vmid . "");
error_log("PVE2 API: Started VM " . $vmid . "");
return true;
} else {
error_log("Error starting vm " . $vmid . "");
error_log("PVE2 API: Error starting VM " . $vmid . "");
return false;
}
} else {
error_log("no vm or node valid");
error_log("PVE2 API: No VM or Node valid");
return false;
}
}
Expand All @@ -391,14 +402,14 @@ public function shutdown_vm ($node,$vmid) {
$url = "/nodes/" . $node . "/qemu/" . $vmid . "/status/shutdown";
$post = $this->post($url,$parameters);
if ($post) {
error_log("Shutdown vm " . $vmid . "");
error_log("PVE2 API: Shutdown VM " . $vmid . "");
return true;
} else {
error_log("Error shutting down vm " . $vmid . "");
error_log("PVE2 API: Error shutting down VM " . $vmid . "");
return false;
}
} else {
error_log("no vm or node valid");
error_log("PVE2 API: No VM or Node valid");
return false;
}
}
Expand All @@ -417,14 +428,14 @@ public function stop_vm ($node,$vmid) {
$url = "/nodes/" . $node . "/qemu/" . $vmid . "/status/stop";
$post = $this->post($url,$parameters);
if ($post) {
error_log("Stopped vm " . $vmid . "");
error_log("PVE2 API: Stopped VM " . $vmid . "");
return true;
} else {
error_log("Error stopping vm " . $vmid . "");
error_log("PVE2 API: Error stopping VM " . $vmid . "");
return false;
}
} else {
error_log("no vm or node valid");
error_log("PVE2 API: No VM or Node valid");
return false;
}
}
Expand All @@ -442,14 +453,14 @@ public function resume_vm ($node,$vmid) {
$url = "/nodes/" . $node . "/qemu/" . $vmid . "/status/resume";
$post = $this->post($url,$parameters);
if ($post) {
error_log("Resumed vm " . $vmid . "");
error_log("PVE2 API: Resumed VM " . $vmid . "");
return true;
} else {
error_log("Error resuming vm " . $vmid . "");
error_log("PVE2 API: Error resuming VM " . $vmid . "");
return false;
}
} else {
error_log("no vm or node valid");
error_log("PVE2 API: No VM or Node valid");
return false;
}
}
Expand All @@ -467,14 +478,14 @@ public function suspend_vm ($node,$vmid) {
$url = "/nodes/" . $node . "/qemu/" . $vmid . "/status/suspend";
$post = $this->post($url,$parameters);
if ($post) {
error_log("Suspended vm " . $vmid . "");
error_log("PVE2 API: Suspended VM " . $vmid . "");
return true;
} else {
error_log("Error suspending vm " . $vmid . "");
error_log("PVE2 API: Error suspending VM " . $vmid . "");
return false;
}
} else {
error_log("no vm or node valid");
error_log("PVE2 API: No VM or Node valid");
return false;
}
}
Expand All @@ -495,14 +506,14 @@ public function clone_vm ($node,$vmid) {
$url = "/nodes/" . $node . "/qemu/" . $vmid . "/clone";
$post = $this->post($url,$parameters);
if ($post) {
error_log("Cloned vm " . $vmid . " to " . $lastid . "");
error_log("PVE2 API: Cloned VM " . $vmid . " to " . $lastid . "");
return true;
} else {
error_log("Error cloning vm " . $vmid . " to " . $lastid . "");
error_log("PVE2 API: Error cloning VM " . $vmid . " to " . $lastid . "");
return false;
}
} else {
error_log("no vm or node valid");
error_log("PVE2 API: No VM or Node valid");
return false;
}
}
Expand Down Expand Up @@ -531,14 +542,14 @@ public function snapshot_vm ($node,$vmid,$snapname = NULL) {
$url = "/nodes/" . $node . "/qemu/" . $vmid . "/snapshot";
$post = $this->post($url,$parameters);
if ($post) {
error_log("Cloned vm " . $vmid . " to " . $lastid . "");
error_log("PVE2 API: Snapshotted VM " . $vmid . " to " . $lastid . "");
return true;
} else {
error_log("Error cloning vm " . $vmid . " to " . $lastid . "");
error_log("PVE2 API: Error snapshotting VM " . $vmid . " to " . $lastid . "");
return false;
}
} else {
error_log("no vm or node valid");
error_log("PVE2 API: No VM or Node valid");
return false;
}
}
Expand Down