Unattended installation or uninstallation parameters

This section describes parameters that are used during unattended installation or uninstallation in Linux.

The minimal configuration for unattended installation includes -a and registration parameters (for example, --login and --password parameters; --rain and --token parameters). You can use more parameters to customize you installation.

Installation parameters

Basic parameters

{-i |--id=}<list of components>

The components to be installed, separated by commas and without space characters. The following components are available in the .x86_64 installation package:

Component Component description
BackupAndRecoveryAgent Agent for Linux
AgentForPCS Agent for Virtuozzo
OracleAgentFeature Agent for Oracle

Without this parameter, all of the above components will be installed.

Both Agent for Virtuozzo and Agent for Oracle require that Agent for Linux is also installed.

The .i686 installation package contains only BackupAndRecoveryAgent.

{-a|--auto}

The installation and registration process will complete without any further user interaction. When using this parameter, you must specify the account under which the agent will be registered in the Cyber Protection service, either by using the --token parameter, or by using the --login and --password parameters.

{-t|--strict}

If the parameter is specified, any warning that occurs during the installation results in installation failure. Without this parameter, the installation completes successfully even in the case of warnings.

{-n|--nodeps}

The absence of required Linux packages will be ignored during the installation.

{-d|--debug}

Writes the installation log in the verbose mode.

--options-file=<location>

The installation parameters will be read from a text file instead of the command line.

--language=<language ID>

The product language. Available values are as follows: en, bg, cs, da, de, es, fr, hu, id, it, ja, ko, ms, nb, nl, pl, pt, pt_BR, ru, fi, sr, sv, tr, zh, zh_TW.
If this parameter is not specified, the product language will be defined by your system language on the condition that it is in the list above. Otherwise, the product language will set to English (en).

Registration parameters

Specify one of the following parameters:

  • {-g|--login=}<user name> and {-w|--password=}<password>

Credentials for the account under which the agent will be registered in the Cyber Protection service. This cannot be a partner administrator account.

  • --token=<token>

    The registration token is a series of 12 characters, separated by hyphens in three segments. You can generate one in the service console, as described in "Deploying agents through Group Policy".

    You cannot use the --token parameter along with --login, --password, and --register-with-credentials parameters.

    • {-C|--rain=}<service address>

      The URL of the Cyber Protection service.

      You don't need to include this parameter explicitly when you use --login and --password parameters for registration, because the installer uses the correct address by default – this would be the address that you use to log in to the Cyber Protection service. For example:

      However, when you use {-C|--rain=} with the --token parameter, you must specify the exact datacenter address. This is the URL that you see once you are logged in to the Cyber Protection service. For example:

  • --register-with-credentials

If this parameter is specified, the installer's graphical interface will start. To finish the registration, enter the user name and password for the account under which the agent will be registered in the Cyber Protection service. This cannot be a partner administrator account.

  • --skip-registration

Use this parameter if you need to install the agent but you plan to register it in the Cyber Protection service later. For more information on how to do this, refer to "Registering machines manually".

Additional parameters

--http-proxy-host=<IP address> and --http-proxy-port=<port>

The HTTP proxy server that the agent will use for backup and recovery from the cloud, and for connection to the management server. Without these parameters, no proxy server will be used.

--http-proxy-login=<login> and --http-proxy-password=<password>

The credentials for the HTTP proxy server. Use these parameters if the server requires authentication.

--tmp-dir=<location>

Specifies the folder where the temporary files are stored during the installation. The default folder is /var/tmp.

{-s|--disable-native-shared}

Redistributable libraries will be used during the installation, even though they might have already been present on your system.

--skip-prereq-check

There will be no check of whether the packages required for compiling the snapapi module are already installed.

--force-weak-snapapi

The installer will not compile a snapapi module. Instead, it will use a ready-made module that might not match the Linux kernel exactly. Using this option is not recommended.

--skip-svc-start

The services will not start automatically after the installation. Most often, this parameter is used with the --skip-registration one.

Information parameters

{-?|--help}

Shows the description of parameters.

--usage

Shows a brief description of the command usage.

{-v|--version}

Shows the installation package version.

--product-info

Shows the product name and the installation package version.

--snapapi-list

Shows the available ready-made snapapi modules.

--components-list

Shows the installer components.

Parameters for legacy features

These parameters relate to a legacy component, agent.exe.

{-e|--ssl=}<path>

Specifies the path to a custom certificate file for SSL communication.

{-p|--port=}<port>

Specifies the port on which agent.exe listens for connections. The default port is 9876.

Uninstallation parameters

{-u|--uninstall}

Uninstalls the product.

--purge

Uninstalls the product and removes its logs, tasks, and configuration settings. You don't need to specify the --uninstall parameter explicitly when you use the --purge one.

Examples

  • Installing Agent for Linux without registering it.

    ./Cyber_Protection_Agent_for_Linux_x86_64.bin -i BackupAndRecoveryAgent -a --skip-registration

  • Installing Agent for Linux, Agent for Virtuozzo, and Agent for Oracle, and registering them by using credentials.

    ./Cyber_Protection_Agent_for_Linux_x86_64.bin -a --login=johndoe --password=johnspassword

  • Installing Agent for Oracle and Agent for Linux, and registering them by using a registration token.

    ./Cyber_Protection_Agent_for_Linux_x86_64.bin -i BackupAndRecoveryAgent,OracleAgentFeature -a --rain=https://eu2-cloud.company.com --token=34F6-8C39-4A5C

  • Installing Agent for Linux, Agent for Virtuozzo, and Agent for Oracle with configuration settings in a separate text file.

    ./Cyber_Protection_Agent_for_Linux_x86_64.bin -a --options-file=/home/mydirectory/configuration_file

  • Uninstalling Agent for Linux, Agent for Virtuozzo, and Agent for Oracle, and removing all its logs, tasks, and configuration settings.

    ./Cyber_Protection_Agent_for_Linux_x86_64.bin -a --purge