UiPath Documentation
automation-suite
2024.10
false
UiPath logo, featuring letters U and I in white

uipathctl reference guide

Last updated Feb 24, 2026

uipathctl snapshot backup enable

Description

Enable the periodical snapshot backup of the cluster.

uipathctl snapshot backup enable [flags]
uipathctl snapshot backup enable [flags]

Options

  -h, --help               help for enable
  -p, --prefix string      This will prefix the names of all the snapshot backups with the given string.
                               This is only used if you wish to enable schedule backup.
                             The default value is snapshot
                                (default "snapshot")
  -r, --retention string   Retention policy in duration format Hh:Mm:Ss, for e.g 8h5m1s.
                               Default value of 168h.
                                (default "168h")
      --schedule string    Unix cron expression for schedule
                               this is only required if you wish to enable schedule backup.
                             Default value "*/45 * * * *" denotes every 45th minutes backup is triggered.
                                (default "*/45 * * * *")
  -h, --help               help for enable
  -p, --prefix string      This will prefix the names of all the snapshot backups with the given string.
                               This is only used if you wish to enable schedule backup.
                             The default value is snapshot
                                (default "snapshot")
  -r, --retention string   Retention policy in duration format Hh:Mm:Ss, for e.g 8h5m1s.
                               Default value of 168h.
                                (default "168h")
      --schedule string    Unix cron expression for schedule
                               this is only required if you wish to enable schedule backup.
                             Default value "*/45 * * * *" denotes every 45th minutes backup is triggered.
                                (default "*/45 * * * *")

Options inherited from parent commands

      --context string      name of the kubeconfig context to use
  -f, --force               override all user prompts to true
      --kubeconfig string   kubectl configuration file (default: ~/.kube/config)
      --log-format string   log format. one of [text,json] (default "text")
      --log-level string    set log level. one of [trace,debug,info,error] (default "error")
  -q, --quiet               suppress all output except for errors and warnings
      --timeout duration    timeout of the command (default 5h0m0s)
      --versions string     optional path to versions file
      --context string      name of the kubeconfig context to use
  -f, --force               override all user prompts to true
      --kubeconfig string   kubectl configuration file (default: ~/.kube/config)
      --log-format string   log format. one of [text,json] (default "text")
      --log-level string    set log level. one of [trace,debug,info,error] (default "error")
  -q, --quiet               suppress all output except for errors and warnings
      --timeout duration    timeout of the command (default 5h0m0s)
      --versions string     optional path to versions file
  • Description
  • Options
  • Options inherited from parent commands

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated