From: Marcin Haba Date: Fri, 10 Mar 2023 12:20:41 +0000 (+0100) Subject: baculum: Add VMware vSphere restore host list endpoint X-Git-Tag: Release-13.0.3~115 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=98022bb60b5ec26234d4263a5e15864a958e7834;p=thirdparty%2Fbacula.git baculum: Add VMware vSphere restore host list endpoint --- diff --git a/gui/baculum/protected/API/Modules/ConsoleOutputQueryPage.php b/gui/baculum/protected/API/Modules/ConsoleOutputQueryPage.php index 0c0145323..c32f174ab 100644 --- a/gui/baculum/protected/API/Modules/ConsoleOutputQueryPage.php +++ b/gui/baculum/protected/API/Modules/ConsoleOutputQueryPage.php @@ -61,5 +61,22 @@ abstract class ConsoleOutputQueryPage extends ConsoleOutputPage { } return $ret; } + + /** + * Analyze the query command output for errors. + * + * @param array $output query command raw output + * @return bool true if error found, otherwise false + */ + protected function isError(array $output) { + $error = false; + while (count($output) > 0 && preg_match('/^[\w\d]+=/', $output[0]) === 0 && strpos($output[0], '[DE') === false) { + array_shift($output); + } + if (count($output) > 0 && (stripos($output[0], 'error') !== false || strpos($output[0], '[DE') !== false)) { + $error = true; + } + return $error; + } } ?> diff --git a/gui/baculum/protected/API/Pages/API/PluginVSphereListRestoreHosts.php b/gui/baculum/protected/API/Pages/API/PluginVSphereListRestoreHosts.php new file mode 100644 index 000000000..f386993a9 --- /dev/null +++ b/gui/baculum/protected/API/Pages/API/PluginVSphereListRestoreHosts.php @@ -0,0 +1,155 @@ + + * @category API + * @package Baculum API + */ +class PluginVSphereListRestoreHosts extends ConsoleOutputQueryPage { + + public function get() { + $client = null; + $clientid = $this->Request->contains('id') ? (int)$this->Request['id'] : 0; + $result = $this->getModule('bconsole')->bconsoleCommand( + $this->director, + ['.client'], + null, + true + ); + if ($result->exitcode === 0) { + $client_val = $this->getModule('client')->getClientById($clientid); + if (is_object($client_val) && in_array($client_val->name, $result->output)) { + $client = $client_val->name; + } else { + $this->output = ClientError::MSG_ERROR_CLIENT_DOES_NOT_EXISTS; + $this->error = ClientError::ERROR_CLIENT_DOES_NOT_EXISTS; + return; + } + } else { + $this->output = PluginVSphereError::MSG_ERROR_WRONG_EXITCODE; + $this->error = PluginVSphereError::ERROR_WRONG_EXITCODE; + return; + } + + $misc = $this->getModule('misc'); + $out_format = ConsoleOutputPage::OUTPUT_FORMAT_RAW; + if ($this->Request->contains('output') && $this->isOutputFormatValid($this->Request['output'])) { + $out_format = $this->Request['output']; + } + $server = $this->Request->contains('server') && $misc->isValidName($this->Request['server'])? $this->Request['server'] : ''; + + $plugin = 'vsphere:'; + if (!empty($server)) { + $plugin .= ' server="' . $server . '"'; + } + $out = new \StdClass; + $out->output = []; + $params = ['client' => $client, 'plugin' => $plugin]; + if ($out_format === ConsoleOutputPage::OUTPUT_FORMAT_RAW) { + $out = $this->getRawOutput($params); + } elseif($out_format === ConsoleOutputPage::OUTPUT_FORMAT_JSON) { + $out = $this->getJSONOutput($params); + } + + if ($out->exitcode !== 0) { + $out->error = PluginVSphereError::ERROR_EXECUTING_PLUGIN_QUERY_COMMAND; + $out->output = PluginVSphereError::MSG_ERROR_EXECUTING_PLUGIN_QUERY_COMMAND . implode(PHP_EOL, $out->output); + $this->getModule('logging')->log( + Logging::CATEGORY_EXECUTE, + $out->output . ", Error={$out->error}" + ); + } else { + $out->error = BconsoleError::ERROR_NO_ERRORS; + } + $this->output = $out->output; + $this->error = $out->error; + } + + /** + * Get vSphere host list output from console in raw format. + * + * @param array $params command parameters + * @return StdClass object with output and exitcode + */ + protected function getRawOutput($params = []) { + $ret = $this->getModule('bconsole')->bconsoleCommand( + $this->director, + [ + '.query', + 'plugin="' . $params['plugin'] . '"', + 'client="' . $params['client'] . '"', + 'parameter="restore_host"' + ] + ); + if ($ret->exitcode != 0) { + $this->getModule('logging')->log( + Logging::CATEGORY_EXECUTE, + 'Wrong output from vSphere RAW restore host list: ' . implode(PHP_EOL, $ret->output) + ); + $ret->output = []; // don't provide errors to output, only in logs + } elseif ($this->isError($ret->output)) { + $ret->exitcode = PluginVSphereError::ERROR_EXECUTING_PLUGIN_QUERY_COMMAND; + } + return $ret; + } + + /** + * Get vSphere restore host list output from console in JSON format. + * + * @param array $params command parameters + * @return StdClass object with output and exitcode + */ + protected function getJSONOutput($params = []) { + $result = $this->getRawOutput($params); + if ($result->exitcode === 0) { + $rows = $this->getRestoreHostRows($result->output); + $result->output = $this->parseOutputKeyValue($rows); + } + return $result; + } + + /** + * Filter rows with restore host items. + * + * @param array $output dot query command output + * @return array + */ + private function getRestoreHostRows(array $output) { + $out = []; + for ($i = 0; $i < count($output); $i++) { + if (preg_match('/^restore_host=/', $output[$i]) === 1) { + $out[] = $output[$i]; + } + } + return $out; + } +} diff --git a/gui/baculum/protected/API/Pages/API/endpoints.xml b/gui/baculum/protected/API/Pages/API/endpoints.xml index 9e50080d5..e9c6055bf 100644 --- a/gui/baculum/protected/API/Pages/API/endpoints.xml +++ b/gui/baculum/protected/API/Pages/API/endpoints.xml @@ -144,6 +144,7 @@ + diff --git a/gui/baculum/protected/API/openapi_baculum.json b/gui/baculum/protected/API/openapi_baculum.json index 4f27230b4..e1c3685c3 100644 --- a/gui/baculum/protected/API/openapi_baculum.json +++ b/gui/baculum/protected/API/openapi_baculum.json @@ -8632,6 +8632,15 @@ }, { "$ref": "#/components/parameters/Output" + }, + { + "name": "server", + "in": "query", + "required": true, + "description": "VMware server name", + "schema": { + "type": "string" + } } ] } @@ -8686,6 +8695,61 @@ ] } }, + "/api/v2/plugins/vsphere/{clientid}/restore-hosts": { + "get": { + "tags": ["plugins"], + "summary": "VMware vSphere restore host list", + "description": "VMware vSphere restore host list.", + "responses": { + "200": { + "description": "List of VMware vSphere restore hosts", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "output": { + "type": "array", + "items": { + "type": "object", + "properties": { + "restore_host": { + "description": "VMware vSphere restore host", + "type": "string" + } + } + } + }, + "error": { + "type": "integer", + "description": "Error code", + "enum": [0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 11, 150, 1000] + } + } + } + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/ClientId" + }, + { + "$ref": "#/components/parameters/Output" + }, + { + "name": "server", + "in": "query", + "required": true, + "description": "VMware server name", + "schema": { + "type": "string" + } + } + ] + } + }, "/api/v2/search": { "get": { "tags": ["tools"],