duplicati/Duplicati/CommandLine/ServerUtil/Commands/ServerStatus.cs
Marcelo C. d15e398e81 Added machine-readable output for serverutil commands
This comes from suggestion on issue https://github.com/duplicati/duplicati/issues/6056

The chosen argument was --json which produces a json that wraps the result with extended properties such as in example:

``
{
  "Timestamp": "2025-03-28T15:47:01.3368160-03:00",
  "UnixTimestamp": 1743187621,
  "Command": "import",
  "Success": true,
  "ExitCode": 0,
  "Messages": [
    "Importing backup configuration from ../2-firstbacku.json",
    "Connecting to http://127.0.0.1:8200/...",
    "No database found in../data/",
    "Imported \"firstbackup (5)\" with ID 8"
  ],
  "Exceptions": [],
  "Imported": {
    "Id": "8",
    "Name": "firstbackup (5)"
  }
}
``

The documentation will reflect all commands and schemas as this makes its way into Canary
2025-03-28 16:08:45 -03:00

65 lines
3 KiB
C#

// Copyright (C) 2025, The Duplicati Team
// https://duplicati.com, hello@duplicati.com
//
// 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 the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
using System.CommandLine;
using System.CommandLine.NamingConventionBinder;
namespace Duplicati.CommandLine.ServerUtil.Commands;
public static class ServerStatus
{
public static Command Create() =>
new Command("status", "Gets the server status")
.WithHandler(CommandHandler.Create<Settings, OutputInterceptor>(async (settings, output) =>
{
var state = await (await settings.GetConnection(output)).GetServerState();
output.AppendConsoleMessage($"Server state: {state.ProgramState}");
output.AppendCustomObject("ServerState", state.ProgramState);
if (state.ActiveTask != null)
{
output.AppendConsoleMessage(
$"Active task: [Task {state.ActiveTask.Item1}]: BackupId = {state.ActiveTask.Item2}");
output.AppendCustomObject("ActiveTask",
new { Task = state.ActiveTask.Item1, BackupId = state.ActiveTask.Item2 });
}
else
{
output.AppendConsoleMessage("Active task: None");
output.AppendCustomObject("ActiveTask", null);
}
if (state.SchedulerQueueIds.Any())
{
output.AppendConsoleMessage("Scheduled tasks:");
foreach (var (taskId, backupId) in state.SchedulerQueueIds) output.AppendConsoleMessage($" [Task {taskId}]: BackupId = {backupId}");
output.AppendCustomObject("SchedulerTasks", state.SchedulerQueueIds.Select(id => new { Task = id.Item1, BackupId = id.Item2 }).ToArray());
}
else
{
output.AppendConsoleMessage("Scheduler tasks: Empty");
output.AppendCustomObject("SchedulerTasks", null);
}
output.SetResult(true);
}));
}