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
79 lines
3.5 KiB
C#
79 lines
3.5 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 RunBackup
|
|
{
|
|
public static Command Create() =>
|
|
new Command("run", "Runs a backup")
|
|
{
|
|
new Argument<string>("backup", "The backup to run, either ID or exact name (case-insensitive)") {
|
|
Arity = ArgumentArity.ExactlyOne
|
|
},
|
|
new Option<bool>("--wait", "Wait for the backup to finish before returning") {
|
|
IsRequired = false
|
|
},
|
|
new Option<int>("--poll-interval", description: "The interval in seconds to poll for backup status", getDefaultValue: () => 5) {
|
|
IsRequired = false
|
|
},
|
|
new Option<bool>("--quiet", "Do not print progress messages") {
|
|
IsRequired = false
|
|
}
|
|
}
|
|
.WithHandler(CommandHandler.Create<Settings, OutputInterceptor, string, bool, int, bool>(async (settings, output, backup, wait, pollinterval, quiet) =>
|
|
{
|
|
if (pollinterval < 1)
|
|
throw new UserReportedException("Poll interval must be at least 1 second");
|
|
|
|
var connection = await settings.GetConnection(output);
|
|
|
|
var matchingBackup = (await connection.ListBackups())
|
|
.FirstOrDefault(b => string.Equals(b.Name, backup, StringComparison.OrdinalIgnoreCase) || string.Equals(b.ID, backup));
|
|
|
|
if (matchingBackup == null)
|
|
throw new UserReportedException("No backup found with supplied ID or name");
|
|
|
|
if (!quiet)
|
|
output.AppendConsoleMessage($"Running backup {matchingBackup.Name} (ID: {matchingBackup.ID})");
|
|
|
|
await connection.RunBackup(matchingBackup.ID);
|
|
|
|
if (wait)
|
|
{
|
|
if (!quiet)
|
|
output.AppendConsoleMessage("Waiting for backup to finish...");
|
|
await connection.WaitForBackup(matchingBackup.ID, TimeSpan.FromSeconds(pollinterval), msg =>
|
|
{
|
|
if (!quiet)
|
|
output.AppendConsoleMessage($"[{DateTime.Now}]: {msg}");
|
|
});
|
|
|
|
if (!quiet)
|
|
output.AppendConsoleMessage("Backup finished");
|
|
}
|
|
output.SetResult(true);
|
|
}));
|
|
}
|