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

uipathctl reference guide

Last updated Apr 28, 2025

uipathctl health bundle

Description

Generate a support bundle that you can use to troubleshoot Automation Suite issues.

uipathctl health bundle [PATH] [flags]uipathctl health bundle [PATH] [flags]

Examples

# Generate the bundle in the OS temporary directory
uipathctl health bundle input.json --versions versions.json

# Generate the bundle in a specific directory
uipathctl health bundle input.json --versions versions.json --output-dir /foo/bar

# Generate the bundle with historical logs for 2 days from 2021-09-01
uipathctl health bundle input.json --versions versions.json --from 2021-09-01 --days 7 --include historical-logs

# Generate the bundle excluding rke2-bundle
uipathctl health bundle input.json --versions versions.json --exclude rke2-bundle
# Generate the bundle in the OS temporary directory
uipathctl health bundle input.json --versions versions.json

# Generate the bundle in a specific directory
uipathctl health bundle input.json --versions versions.json --output-dir /foo/bar

# Generate the bundle with historical logs for 2 days from 2021-09-01
uipathctl health bundle input.json --versions versions.json --from 2021-09-01 --days 7 --include historical-logs

# Generate the bundle excluding rke2-bundle
uipathctl health bundle input.json --versions versions.json --exclude rke2-bundle

Options

            --days int            Number of days from the start date for which we want to collect the historical logs. (default -1)
      --exclude string      Specify components (comma separated) to exclude from the bundle. For example, --exclude=rke2-bundle
      --from string         Start date to collect the historical logs in YYYY-MM-DD format.
  -h, --help                help for bundle
      --include string      Specify additional components (comma separated) to include in the bundle. For example, --include=historical-logs
      --limit-bytes int     Maximum bytes of logs to return. Defaults to no limit.
      --namespace string    The namespace where UiPath Automation Suite is deployed
      --output-dir string   path to output directory
      --versions string     path to versions file            --days int            Number of days from the start date for which we want to collect the historical logs. (default -1)
      --exclude string      Specify components (comma separated) to exclude from the bundle. For example, --exclude=rke2-bundle
      --from string         Start date to collect the historical logs in YYYY-MM-DD format.
  -h, --help                help for bundle
      --include string      Specify additional components (comma separated) to include in the bundle. For example, --include=historical-logs
      --limit-bytes int     Maximum bytes of logs to return. Defaults to no limit.
      --namespace string    The namespace where UiPath Automation Suite is deployed
      --output-dir string   path to output directory
      --versions string     path to versions file

Options inherited from parent commands

      --context string      name of the kubeconfig context to use
      --excluded strings    components to be excluded from execution, defaults to none
  -f, --force               override all user prompts to true
      --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)
  -q, --quiet               suppress all output except for errors and warnings
      --timeout duration    timeout of the command (default 5h0m0s)      --context string      name of the kubeconfig context to use
      --excluded strings    components to be excluded from execution, defaults to none
  -f, --force               override all user prompts to true
      --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)
  -q, --quiet               suppress all output except for errors and warnings
      --timeout duration    timeout of the command (default 5h0m0s)
  • Description
  • Examples
  • Options
  • Options inherited from parent commands

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo
Trust and Security
© 2005-2026 UiPath. All rights reserved.