Subscribe

UiPath Automation Suite

The UiPath Automation Suite Guide

install-uipath.sh parameters

This page describes the required and optional parameters you can use when running Automation Suite's install-uipath.sh installer.

The install-uipath.sh manual installer allows you to customize the installation experience without running the interactive installer (installUiPathAS.sh).

While the manual installer is suitable for advanced scenario, the deployment templates and the interactive installer are still the recommended options.

The install-uipath.sh installer is available in sf-installer.zip. For download instructions, see Downloading installation packages.

Required parameters


--input -i <string>

Specify the input .json file.

input.json refers to the cluster_config.json that defines the parameters, settings, and preferences applied to the UiPath services deployed via Automation Suite. You need to update this file to change the defaults and use any advanced configuration for your cluster. For details, refer to Manual: Advanced installation experience.

--output -o <string>

Specify the output .json file.

output.json refers to the output file of the manual installer.

 

Optional parameters


--install-kubernetes -k

Install the Kubernetes cluster.

--join-node -j <server|agent>

Used only with -k. Determines the type of node to be joined to an existing cluster. Allowed values: <server|agent>.

--install-fabric -f

Install the fabric components.

--install-services -s

Install the UiPath services.

--install-all -a

Run all installers in order. If no installation is explicitly selected, –install-all will be implied.

--install-type <online|offline>

Specify the installation type. Defaults to online. You cannot set it to online together with –offline-bundle.

--offline-bundle <string>

Specify the path to the offline bundle. Indicates that the installation method is tarball.

--offline-tmp-folder <string>

Optional flag that can be used with --offline-bundle or --optional-offline-bundle. Specify the parent directory for the temporary offline installation folder. Defaults to /tmp.

--optional-offline-bundle <string>

Specify the path to the optional offline bundle.

--pre-reqs -p

Check prerequisites. When using this flag, no other flags can be passed.

--install-offline-prereqs

Used with the tarball installation method, performs the installation of all prerequisites.

--skip-packages-install

Skips the installation of prerequisites during the online installation method. By default, prerequisites are installed.

--upgrade -u

Upgrade an existing Automation Suite cluster.

--kubeconfig <string>

Specify path to the kubeconfig file. When this flag is missing, it defaults to /etc/rancher/rke2/rke2.yaml.

--backup -b

Back up the cluster.

--restore -r

Restore the cluster.

--restore-volume

Restore volume.

--disable-backup

Disable the backup.

-d

Run in debug mode.

-h

Display help.

--accept-license-agreement

Mandatory flag to accept the license agreement.

-c

Install Cilium CNI (Container Network Interface) to replace the default Canal. Only used during upgrade. You cannot use it with any installation flag.

--skip-pre-reqs

Skip prerequisite checks during installation. Note that you cannot skip RPM package validation.

--one-time-manual-backup

Trigger manual backup and disable it after completion.

-m|--machines <comma separated machine's IP>

Specify the targeted machines for installation. Provide comma-separated IP addresses or hostnames of all the machines.

--compare-config

Compare the current configuration file with the cluster state. It compares the input.json file with the current cluster configuration.

--skip-compare-config

Skip compare the current config with the cluster state.

Examples


  • Install the Kubernetes cluster components on the VM where it is executed, using the online installation method.
install-uipath.sh -i ./input.json -o ./output.json -k --accept-license-agreement
  • Install the Kubernetes components on the VM where it is executed, and join it to the existing cluster as a server, using the online installation method.
install-uipath.sh -i ./input.json -o ./output.json -k -j server --accept-license-agreement
  • Perform the complete installation on the current VM, using the online installation method. Includes the Kubernetes cluster components, the Fabric, and the Uipath services.
install-uipath.sh -i ./input.json -o ./output.json -a --accept-license-agreement
  • Perform the complete installation on the current VM, using the online installation method. This time, skip the prerequisites installation.
install-uipath.sh -i ./input.json -o ./output.json -a --skip-packages-install --accept-license-agreement
  • Perform the Kubernetes cluster installation, using the tarball installation method. Also, join the node to the existing cluster and install all the offline prerequisites.
install-uipath.sh -i ./input.json -o ./output.json -k -j agent --offline-bundle "/tmp/sf-infra.tar.gz" --accept-license-agreement --install-offline-prereqs
  • Install the fabric and services components using the offline installation method, without a temporary folder provided.
install-uipath.sh -i ./input.json -o ./output.json -f -s --offline-bundle "/tmp/sf-infra.tar.gz" --accept-license-agreement
  • Execute the installer for an offline installation, but without loading the artifacts.
install-uipath.sh -i ./input.json -o ./output.json --install-type offline -s --accept-license-agreement
  • Execute the installer skipping the prerequisites check
install-uipath.sh -i ./input.json -o ./output.json -k --accept-license-agreement --skip-pre-reqs

Updated 3 months ago


install-uipath.sh parameters


This page describes the required and optional parameters you can use when running Automation Suite's install-uipath.sh installer.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.