Automation Suite installation guide

Last updated Feb 24, 2025

Automated: Disabling the Backup on the Cluster

Important:

Disabling the cluster backup will cause the loss of data created between the last scheduled backup and the time you disable the backup.

Make sure you have prepared your environment for using uipathctl.sh script. For details, see Using uipathctl.sh.

Disabling the Backup

To disable the backup on the cluster, take the following steps:

Log into the server node that you previously identified as the Ansible host node, and navigate to the installer folder. The installer is located in the /opt/UiPathAutomationSuite/{version}/installer folder.
Run the following command with the basic parameters to disable the backup. Make sure you use the parameter values applicable to you.
```
./uipathctl.sh disable-backup --install-type online --backup-endpoint "10.0.0.1" --backup-mount "/asbackup" --backup-name "mycluster"./uipathctl.sh disable-backup --install-type online --backup-endpoint "10.0.0.1" --backup-mount "/asbackup" --backup-name "mycluster"
```

Basic Parameters

Parameter	Value
`--install-type`	Possible values: `online` and `offline`.
`--backup-endpoint`	The endpoint of your NFS server. The value of this parameter can be either the IP address or the FQDN of the NFS server. Example: IP Address – `10.0.0.1` FQDN – `mynfs.mycompany.com`
`--backup-mount`	Location on the NFS server where you mounted the disk on which you will store the backup data. This is an absolute file path. Example: `/asbackup`
`--backup-name`	The name of the backup that you want to associate with your Automation Suite cluster. The same name will also be used to create a folder under the `--backup-mount` location where the backup data will be stored. The value of this parameter must be a name, not a file path. Example: Accepted value - mycluster Bad value - /asbackup/mycluster
`-backup-config`	Alternative to `--backup-endpoint`, `--backup-mount`, and `--backup-name`. You can provide the `backup.json` file to `uipathctl.sh` script at the time of configuring the backup. For details, see the Preparing the backup configuration section.

Advanced Parameters

Parameter	Value
`--ansible-username`	Specify the username that will be used for SSH connections to all the nodes. Defaults to the current user. If you are using different username for all the nodes, then instead of using this parameter, set the username for all the nodes in `inventory.ini` and pass it to the script. Example: While running the script, you are logged in with the `myadminuser` username. However, if you wish to use the `testadmin` username to connect via SSH, you must use `testadmin` when configuring this parameter.
`--inventory`	Specify an existing Ansible inventory file. If not specified, one will be generated automatically from the existing cluster with basic configuration. In certain scenarios where you want to have more granular control, you may want to provide your own inventory file. One such example would be if you want to use different SSH usernames or ssh keys for all the nodes in the cluster. For details, see Generating the Ansible inventory.ini file.

Parameter

Value

--ansible-username

Specify the username that will be used for SSH connections to all the nodes. Defaults to the current user. If you are using different username for all the nodes, then instead of using this parameter, set the username for all the nodes in inventory.ini and pass it to the script.

Example:

While running the script, you are logged in with the myadminuser username. However, if you wish to use the testadmin username to connect via SSH, you must use testadmin when configuring this parameter.

--inventory

Specify an existing Ansible inventory file. If not specified, one will be generated automatically from the existing cluster with basic configuration.

In certain scenarios where you want to have more granular control, you may want to provide your own inventory file. One such example would be if you want to use different SSH usernames or ssh keys for all the nodes in the cluster.

For details, see Generating the Ansible inventory.ini file.

On this page