automation-suite
2023.4
false
- Overview
- Pre-installation
- Installation
- Cluster administration
- Backup and restore
- uipathctl snapshot
- uipathctl snapshot backup
- uipathctl snapshot backup create
- uipathctl snapshot backup disable
- uipathctl snapshot backup enable
- uipathctl snapshot delete
- uipathctl snapshot list
- uipathctl snapshot restore
- uipathctl snapshot restore create
- uipathctl snapshot restore delete
- uipathctl snapshot restore history
- uipathctl snapshot restore logs
- Certificate management
- uipathctl config additional-ca-certificates get
- uipathctl config additional-ca-certificates update
- uipathctl config tls-certificates get
- uipathctl config tls-certificates update
- uipathctl identity get-saml-certificate
- uipathctl identity get-token-signing-certificate
- uipathctl identity rotate-saml-certificates
- uipathctl identity rotate-token-signing-certificates
- uipathctl identity update-saml-certificate
- uipathctl identity update-token-signing-certificate
- Upgrade
- Authentication
- Monitoring and alerting
- Product-specific configuration
- Troubleshooting
uipathctl snapshot backup enable

OUT OF SUPPORT
uipathctl reference guide
Last updated Apr 29, 2025
uipathctl snapshot backup enable
Enable the periodical snapshot backup of the cluster.
uipathctl snapshot backup enable [flags]
uipathctl snapshot backup enable [flags]
-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 * * * *")
--context string name of the kubeconfig context to use
--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 1h0m0s)
--context string name of the kubeconfig context to use
--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 1h0m0s)