OS Manuals

/usr/bin/velero

Backup and migrate Kubernetes applications and their persistent volumes

From velero-fips 1.18.4-r9 (enterprise-packages), captured 2026-11-08 by running velero --help (exit 0). permalink

Velero is a tool for managing disaster recovery, specifically for Kubernetes
cluster resources. It provides a simple, configurable, and operationally robust
way to back up your application state and associated data.

If you're familiar with kubectl, Velero supports a similar model, allowing you to
execute commands such as 'velero get backup' and 'velero create schedule'. The same
operations can also be performed as 'velero backup get' and 'velero schedule create'.

Usage:
  velero [command]

Available Commands:
  backup            Work with backups
  backup-location   Work with backup storage locations
  bug               Report a Velero bug
  client            Velero client related commands
  completion        Generate completion script
  create            Create velero resources
  debug             Generate debug bundle
  delete            Delete velero resources
  describe          Describe velero resources
  get               Get velero resources
  help              Help about any command
  install           Install Velero
  plugin            Work with plugins
  repo              Work with repositories
  restore           Work with restores
  schedule          Work with schedules
  snapshot-location Work with snapshot locations
  uninstall         Uninstall Velero
  version           Print the velero version and associated image

Flags:
      --add_dir_header                      If true, adds the file directory to the header of the log messages
      --alsologtostderr                     log to standard error as well as files (no effect when -logtostderr=true)
      --alsologtostderrthreshold severity   logs at or above this threshold go to stderr when -alsologtostderr=true (no effect when -logtostderr=true)
      --colorized optionalBool              Show colored output in TTY. Overrides 'colorized' value from $HOME/.config/velero/config.json if present. Enabled by default
      --features stringArray                Comma-separated list of features to enable for this Velero process. Combines with values from $HOME/.config/velero/config.json if present
  -h, --help                                help for velero
      --kubeconfig string                   Path to the kubeconfig file to use to talk to the Kubernetes apiserver. If unset, try the environment variable KUBECONFIG, as well as in-cluster configuration
      --kubecontext string                  The context to use to talk to the Kubernetes apiserver. If unset defaults to whatever your current-context is (kubectl config current-context)
      --legacy_stderr_threshold_behavior    If true, stderrthreshold is ignored when logtostderr=true (legacy behavior). If false, stderrthreshold is honored even when logtostderr=true (default true)
      --log_backtrace_at traceLocation      when logging hits line file:N, emit a stack trace (default :0)
      --log_dir string                      If non-empty, write log files in this directory (no effect when -logtostderr=true)
      --log_file string                     If non-empty, use this log file (no effect when -logtostderr=true)
      --log_file_max_size uint              Defines the maximum size a log file can grow to (no effect when -logtostderr=true). Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
      --logtostderr                         log to standard error instead of files (default true)
  -n, --namespace string                    The namespace in which Velero should operate (default "velero")
      --one_output                          If true, only write logs to their native severity level (vs also writing to each lower severity level; no effect when -logtostderr=true)
      --skip_headers                        If true, avoid header prefixes in the log messages
      --skip_log_headers                    If true, avoid headers when opening log files (no effect when -logtostderr=true)
      --stderrthreshold severity            logs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=true unless -legacy_stderr_threshold_behavior=false) (default 2)
  -v, --v Level                             number for the log level verbosity
      --vmodule moduleSpec                  comma-separated list of pattern=N settings for file-filtered logging

Use "velero [command] --help" for more information about a command.
Options (21)
OptionDescriptionSource
--add_dir_headerIf true, adds the file directory to the header of the log messageshelp
--alsologtostderrlog to standard error as well as files (no effect when -logtostderr=true)help
--alsologtostderrthreshold severitylogs at or above this threshold go to stderr when -alsologtostderr=true (no effect when -logtostderr=true)help
--colorized optionalBoolShow colored output in TTY.help
--features stringArrayComma-separated list of features to enable for this Velero process.help
-h, --helphelp for velerohelp
--kubeconfig stringPath to the kubeconfig file to use to talk to the Kubernetes apiserver.help
--kubecontext stringThe context to use to talk to the Kubernetes apiserver.help
--legacy_stderr_threshold_behaviorIf true, stderrthreshold is ignored when logtostderr=true (legacy behavior).help
--log_backtrace_at traceLocationwhen logging hits line file:N, emit a stack trace (default :0)help
--log_dir stringIf non-empty, write log files in this directory (no effect when -logtostderr=true)help
--log_file stringIf non-empty, use this log file (no effect when -logtostderr=true)help
--log_file_max_size uintDefines the maximum size a log file can grow to (no effect when -logtostderr=true).help
--logtostderrlog to standard error instead of files (default true)help
-n, --namespace stringThe namespace in which Velero should operate (default "velero")help
--one_outputIf true, only write logs to their native severity level (vs also writing to each lower severity level;help
--skip_headersIf true, avoid header prefixes in the log messageshelp
--skip_log_headersIf true, avoid headers when opening log files (no effect when -logtostderr=true)help
--stderrthreshold severitylogs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=true unless -legacy_stderr_threshold_behavior=false) (default 2)help
-v, --v Levelnumber for the log level verbosityhelp
--vmodule moduleSpeccomma-separated list of pattern=N settings for file-filtered logginghelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.