constants

Documentation

Index

• Constants
• Variables

Constants

const (
	CommandBackup    = "backup"
	CommandCheck     = "check"
	CommandForget    = "forget"
	CommandInit      = "init"
	CommandPrune     = "prune"
	CommandSnapshots = "snapshots"
	CommandUnlock    = "unlock"
	CommandMount     = "mount"
	CommandCopy      = "copy"
	CommandDump      = "dump"
	CommandFind      = "find"
	CommandLs        = "ls"
	CommandRestore   = "restore"
	CommandStats     = "stats"
	CommandTag       = "tag"
)

Restic commands

const (
	DefaultConfigurationFile    = "profiles"
	DefaultProfileName          = "default"
	DefaultCommand              = "snapshots"
	DefaultFilterResticFlags    = true
	DefaultResticLockRetryAfter = 60 * time.Second
	DefaultResticStaleLockAge   = 1 * time.Hour
	DefaultTheme                = "light"
	DefaultIONiceFlag           = false
	DefaultIONiceClass          = 2
	DefaultStandardNiceFlag     = 0
	DefaultBackgroundNiceFlag   = 5
	DefaultVerboseFlag          = false
	DefaultQuietFlag            = false
	DefaultMinMemory            = 100
	DefaultSenderTimeout        = 30 * time.Second
	DefaultPrometheusPushFormat = "text"
	BatteryFull                 = 100
	LocalLockRetryDelay         = 5 * time.Second
)

Configuration defaults

const (
	EnvProfileName      = "PROFILE_NAME"
	EnvProfileCommand   = "PROFILE_COMMAND"
	EnvError            = "ERROR"
	EnvErrorMessage     = "ERROR_MESSAGE"
	EnvErrorCommandLine = "ERROR_COMMANDLINE"
	EnvErrorExitCode    = "ERROR_EXIT_CODE"
	EnvErrorStderr      = "ERROR_STDERR"
)

const (
	FlagAsChild = "as-child"
	FlagPort    = "parent-port"
)

resticprofile flag

const (
	SchedulerLaunchd = "launchd"
	SchedulerWindows = "taskscheduler"
	SchedulerSystemd = "systemd"
	SchedulerCrond   = "crond"
)

Scheduler type

const (
	MinResticLockRetryDelay        = 15 * time.Second
	MaxResticLockRetryDelay        = 30 * time.Minute
	MaxResticLockRetryTimeArgument = 10 * time.Minute
	MinResticStaleLockAge          = 15 * time.Minute
)

Limits for restic lock handling (stale locks and retry on lock failure)

const (
	ScheduleLockModeOptionFail   = "fail"
	ScheduleLockModeOptionIgnore = "ignore"
)

Schedule lock mode config options

const (
	ExitCodeSuccess = 0
	ExitCodeError   = 1
	ExitCodeWarning = 3
)

const (
	TemporaryDirMarker = "temp:"
	JSONSchema         = "$schema"
)

const (
	ParameterIONice          = "ionice"
	ParameterIONiceClass     = "ionice-class"
	ParameterIONiceLevel     = "ionice-level"
	ParameterNice            = "nice"
	ParameterPriority        = "priority"
	ParameterDefaultCommand  = "default-command"
	ParameterInitialize      = "initialize"
	ParameterResticBinary    = "restic-binary"
	ParameterInherit         = "inherit"
	ParameterHost            = "host"
	ParameterPath            = "path"
	ParameterTag             = "tag"
	ParameterKeepTag         = "keep-tag"
	ParameterGroupBy         = "group-by"
	ParameterVerbose         = "verbose"
	ParameterDescription     = "description"
	ParameterVersion         = "version"
	ParameterRetryLock       = "retry-lock"
	ParameterRepository      = "repo"
	ParameterRepositoryFile  = "repository-file"
	ParameterPasswordFile    = "password-file"
	ParameterPasswordCommand = "password-command"
	ParameterKeyHint         = "key-hint"
)

Parameter

const (
	SectionConfigurationDescription = "description"
	SectionConfigurationGlobal      = "global"
	SectionConfigurationRetention   = "retention"
	SectionConfigurationEnvironment = "env"
	SectionConfigurationGroups      = "groups"
	SectionConfigurationIncludes    = "includes"
	SectionConfigurationInherit     = "inherit"
	SectionConfigurationProfiles    = "profiles"
	SectionConfigurationSchedules   = "schedules"
	SectionConfigurationMixins      = "mixins"
	SectionConfigurationMixinUse    = "use"

	SectionDefinitionCommon = "common"
	SectionDefinitionForget = "forget"
)

Section

const (
	SchedulePermissionUser         = "user"
	SchedulePermissionUserLoggedOn = "user_logged_on"
	SchedulePermissionUserLoggedIn = "user_logged_in"
	SchedulePermissionSystem       = "system"
	SchedulePriorityBackground     = "background"
	SchedulePriorityStandard       = "standard"

	VerbosityNone   = 0
	VerbosityLevel1 = 1
	VerbosityLevel2 = 2
	VerbosityLevel3 = 3
)

Parameter values

const (
	ApplicationName = "resticprofile"
)

Variables

var (
	// PriorityValues is the map between the name and the value
	PriorityValues = map[string]int{
		"idle":       priority.Idle,
		"background": priority.Background,
		"low":        priority.Low,
		"normal":     priority.Normal,
		"high":       priority.High,
		"highest":    priority.Highest,
	}
)