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 health
- uipathctl health bundle
- uipathctl health check
- uipathctl health diagnose
- uipathctl health test

OUT OF SUPPORT
uipathctl reference guide
Last updated Apr 29, 2025
Generate a support bundle that you can use to troubleshoot Automation Suite issues.
uipathctl health bundle [PATH] [flags]uipathctl health bundle [PATH] [flags]# Generate the bundle in the OS temporary directory
uipathctl health bundle input.json
# Generate the bundle in a specific directory
uipathctl health bundle input.json --output-dir /foo/bar
# Generate the bundle without additional health/prereq report
uipathctl health bundle input.json --skip-diagnose
# Generate the bundle in the OS temporary directory
uipathctl health bundle input.json
# Generate the bundle in a specific directory
uipathctl health bundle input.json --output-dir /foo/bar
# Generate the bundle without additional health/prereq report
uipathctl health bundle input.json --skip-diagnose
-h, --help help for bundle
-p, --include-previous If false, skips printing the logs for the previous instance of the container in a pod if it exists. (default true)
--limit-bytes int Maximum bytes of logs to return. Defaults to no limit.
--output-dir string path to output directory
--since-time string Only return logs after a specific date (RFC3339). Defaults to all logs.
--skip-diagnose skip additional health/prereq report
--versions string path to versions file -h, --help help for bundle
-p, --include-previous If false, skips printing the logs for the previous instance of the container in a pod if it exists. (default true)
--limit-bytes int Maximum bytes of logs to return. Defaults to no limit.
--output-dir string path to output directory
--since-time string Only return logs after a specific date (RFC3339). Defaults to all logs.
--skip-diagnose skip additional health/prereq report
--versions string path to versions file--context string name of the kubeconfig context to use
--excluded strings components to be excluded from execution, defaults to none
--included strings components to be included in the execution, defaults to all
--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")
-o, --output output output format. one of [json,yaml,text,junit] (default text)
--timeout duration timeout of the command (default 1h0m0s)--context string name of the kubeconfig context to use
--excluded strings components to be excluded from execution, defaults to none
--included strings components to be included in the execution, defaults to all
--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")
-o, --output output output format. one of [json,yaml,text,junit] (default text)
--timeout duration timeout of the command (default 1h0m0s)