automation-suite
2024.10
true
- Overview
- About uipathctl
- uipathctl reference documentation
- 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 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 get
- uipathctl config token-signing-certificates rotate
- uipathctl config token-signing-certificates update
- Upgrade
- Authentication
- Monitoring and alerting
- Product-specific configuration
- Troubleshooting
uipathctl Reference Guide
Last updated Nov 11, 2024
About uipathctl
uipathctl is a UiPath® command-line tool that allows you to perform various operations in Automation Suite on EKS/AKS, Automation Suite on OpenShift, and Automation Suite on Linux.
You can use uipathctl to check prerequisites in your environment, install Automation Suite, as well as configure and manage it from a single unified CLI.
Note, however, that not all commands referenced in this guide are suitable for all Automation Suite flavors. If certain commands are exclusive to one Automation Suite flavor, they should be marked accordingly.
It is important to be aware of the specific naming conventions we employ for the Automation Suite configuration file. The
input.json name is used for Automation Suite on EKS/AKS and Automation Suite on OpenShift, whereas cluster_config.json is specific to Automation Suite on Linux only.
For more information, including a complete list of
uipathctl operations, see the uipathctl reference documentation.
You can install
uipathctl on the Linux, macOS, and Windows platforms.
Note:
Currently,
uipathctl is only compatible with the x86 architecture.
You cannot run uipathctl on machines based on the ARM architecture,
such as Macs with Apple Silicon (M series) CPUs.
