agent

package
v1.65.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 13, 2026 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Overview

Package agent holds the goback agent command, which runs a machine's backups on their schedules from one config file.

Index

Constants

This section is empty.

Variables

View Source
var Command = cli.Command{
	Name:  "agent",
	Usage: "Run a machine's scheduled backups from one config file",
	Description: "The config file names the store once. It lists each backup with its kind and schedule. A global\n" +
		"flag or its environment variable overrides the matching store setting in the file.",
	Subcommands: []cli.Command{
		{
			Name:   "run",
			Usage:  "Run the backups until SIGTERM; SIGHUP reloads the backups from the config",
			Flags:  []cli.Flag{configFlag},
			Action: runAction,
		},
		{
			Name:  "check",
			Usage: "Check the config, the store and each backup's database",
			Description: "check validates the config and opens the store. It prints each job's last run and next due\n" +
				"time. It connects to each backup's database and lists what the database lacks for the backup.",
			Flags:  []cli.Flag{configFlag},
			Action: checkAction,
		},
		{
			Name:  "status",
			Usage: "Print the status file of a running agent without opening the store",
			Flags: []cli.Flag{
				configFlag,
				cli.BoolFlag{
					Name:  "check",
					Usage: "exit 1 if the agent is hung or a job is stale; exit 2 if there is no status to read",
				},
			},
			Action: statusAction,
		},
	},
}

Command is the agent command.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL