automation-suite
2024.10
true
- Overview
- Pre-installation
- Installation
- Cluster administration
- uipathctl cluster
- uipathctl cluster maintenance
- uipathctl cluster maintenance disable
- uipathctl cluster maintenance enable
- uipathctl cluster maintenance is-enabled
- uipathctl cluster migration
- uipathctl cluster migration export
- uipathctl cluster migration import
- uipathctl cluster migration run
- uipathctl config add-host-admin
- uipathctl config argocd
- uipathctl config argocd registry
- uipathctl config argocd registry get
- uipathctl config argocd registry update
- uipathctl config generate
- uipathctl config kubeconfig
- uipathctl config kubeconfig get
- uipathctl config kubeconfig set
- uipathctl config products
- uipathctl config products scale-down
- uipathctl config products scale-up
- uipathctl registry
- uipathctl registry cleanup
- uipathctl registry hydrate-temp-registry
- uipathctl registry install-temp-registry
- uipathctl registry list-tags
- uipathctl registry seed
- uipathctl registry seed-internal-registry
- uipathctl registry uninstall
- uipathctl registry uninstall-temp-registry
- uipathctl registry upload
- uipathctl registry validate
- uipathctl rke2
- uipathctl rke2 disk
- uipathctl rke2 update-fqdn
- uipathctl rke2 generate-registries
- uipathctl rke2 gpu
- uipathctl internal rke2 hydrate-agent-dir
- uipathctl rke2 node
- uipathctl rke2 node remove
- uipathctl rke2 objectstore
- uipathctl rke2 objectstore uninstall
- uipathctl rke2 registry
- uipathctl rke2 registry hydrate-registry
- uipathctl rke2 registry seed-temp-registry-from-in-cluster
- uipathctl rke2 update-fqdn
- uipathctl version
- 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
- uipathctl config additional-ca-certificates get
- uipathctl config additional-ca-certificates update
- uipathctl config argocd ca-certificates
- uipathctl config argocd ca-certificates get
- uipathctl config argocd ca-certificates update
- uipathctl config saml-certificates
- uipathctl config saml-certificates get
- uipathctl config saml-certificates rotate
- uipathctl config saml-certificates update
- uipathctl config tls-certificates
- uipathctl config tls-certificates get
- uipathctl config tls-certificates update
- uipathctl config token-signing-certificates
- uipathctl config token-signing-certificates automatic-key-management
- uipathctl config token-signing-certificates automatic-key-management disable
- uipathctl config token-signing-certificates automatic-key-management enable
- uipathctl config token-signing-certificates get
- uipathctl config token-signing-certificates rotate
- uipathctl config token-signing-certificates update
- Upgrade
- Authentication
- uipathctl config argocd generate-dex-config
- uipathctl config argocd generate-rbac
- uipathctl config enable-basic-auth
- uipathctl config kerberos-auth
- uipathctl config kerberos-auth global-config
- uipathctl config kerberos-auth global-config update
- uipathctl config kerberos-auth service-config
- uipathctl config kerberos-auth service-config update
- uipathctl config windows-auth
- uipathctl config windows-auth update
- Monitoring and alerting
- uipathctl config
- uipathctl config alerts
- uipathctl config alerts add-email
- uipathctl config alerts remove-email
- uipathctl config alerts update-email
- uipathctl config telemetry
- uipathctl config telemetry get
- uipathctl config telemetry set
- uipathctl resource
- uipathctl resource constraint-report
- uipathctl resource report
- Product-specific configuration
- uipathctl config orchestrator
- uipathctl config orchestrator get-config
- uipathctl config orchestrator update-config
- uipathctl config orchestrator update-encryption-key
- uipathctl config orchestrator upload
- uipathctl service
- uipathctl service aicenter
- uipathctl service aicenter configure
- uipathctl service aicenter sync-skills
- uipathctl service aicenter sync-skill-status
- Troubleshooting
uipathctl health

uipathctl Reference Guide
Last updated Feb 17, 2025
uipathctl health
--excluded strings components to be excluded from execution, defaults to none
-h, --help help for health
--included strings components to be included in the execution, defaults to all
-o, --output output output format. one of [json,yaml,text,junit] (default text)
--excluded strings components to be excluded from execution, defaults to none
-h, --help help for health
--included strings components to be included in the execution, defaults to all
-o, --output output output format. one of [json,yaml,text,junit] (default text)
--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