How to Generate a Parameter file?

How to Generate a Parameter file?

Issue: During the multinode upgrade, a parameter file is generated during primary node installation and a problem is observed during the secondary node upgrade/installation.

Resolution:

Use the inbuilt script present in the installation folder location “C:\Program Files (x86)\UiPath\Orchestrator\Tools” .

Steps:

  1. Open PowerShell Prompt as administrator and type “cd” followed by the ps script file path(“C:\Program Files (x86)\UiPath\Orchestrator\Tools”) and press enter
  2. Then type the command Generate-ParametersFile.ps1 which is the file name, followed by – exportlocation .\{Folderlocation}\ and press enter
  3. This command will generate a parameters.json file in the {folderlocation} folder


Consideration:

The parameter file will include the below-mentioned parameter and be used during secondary node installation or upgradation.

IIS Parameters

Command

Description

ORCHESTRATORFOLDER
Enables installing Orchestrator in a custom location. By default, Orchestrator is installed in C:\Program Files (x86)\UiPath\Orchestrator.
WEBSITE_NAME

The name of the Orchestrator website. Editing this parameter is not recommended.

WEBSITE_PORT
The port to use to enable the communication between the computer and Orchestrator. If not specified, the default value 443 is used to enable to use HTTPS.
If another port is used, be sure to append it to the PUBLIC_URL Identity Server parameter as detailed below.
WEBSITE_PORT_DO_VALIDATE

Allows to indicate if a validation of the website port availability is performed. The available options are:

  • 0 - No validation is performed.
  • 1 - A validation is performed.
Note: Submitting any value to this parameter causes the corresponding checkbox in the UI to appear as checked, even though the port is validated only if the parameter value is 1.
WEBSITE_PORT_FIREWALL

Enables you to indicate if firewall rules are automatically added for this port. The available options are:

  • 0 - Firewall rules are not added.
  • 1 - Firewall rules are added.
Note: Submitting any value to this parameter causes the corresponding checkbox in the UI to appear as checked, even though the firewall rule is created only if the parameter value is 1.
CERTIFICATE_SUBJECT

The name of the SSL certificate to use to secure connections with Orchestrator. If not specified, by default the full computer name is used.

Application Pool Parameters

Command

Description

APPPOOL_NAME

The name of the Application Pool used for Orchestrator.

APPPOOL_IDENTITY_TYPE
It can only be used with the Orchestrator feature. The type of application pool used for Orchestrator, supports the following values: USER and APPPOOLIDENTITY.
APPPOOL_USER_NAME
The username running the application pool. This parameter needs to be included only if APPPOOL_IDENTITY_TYPE was set to USER.
APPPOOL_PASSWORD
The password of the user running the application pool. This parameter needs to be included only if APPPOOL_IDENTITY_TYPE was set to USER.

Database Parameters

Parameter

Description

DB_SERVER_NAME
The name of the server on which the database you want to use is located. Please note that the following special characters are not supported: an empty space, \, /, *, :, ?, ", <, >, |, and the maximum length is 123 characters.
It can only be used on the first Orchestrator installation, with the Orchestrator feature and all the other database specific parameters.
DB_DATABASE_NAME

The name of the database you want to connect to.

It can only be used on the first Orchestrator installation, with the Orchestrator feature and all the other database specific parameters. To use the database of a previous installation (pre-v20.4 only) do so by specifying the APP_ENCRYPTION_KEY parameter.
DB_AUTHENTICATION_MODE
Enables to choose the authentication method for the database. It can have the following two parameters WINDOWS or SQL.
It can only be used on the first Orchestrator installation, with the Orchestrator feature and all the other database specific parameters.
DB_USER_NAME

To be used only if the SQL authentication method is chosen. The SQL database user.

It can only be used on the first Orchestrator installation, with the Orchestrator feature and all the other database specific parameters.
DB_PASSWORD

To be used only if you chose the SQL authentication method. The SQL database user password.

It can only be used on the first Orchestrator installation, with the Orchestrator feature and all the other database specific parameters.
DB_CONNECTION_STRING
Enables to configure specific settings (such as MultiSubnetFailover=True) for the connection to the main Orchestrator database.

Use this connection string as an alternative to the existing database parameters (individual server instance, database name, database username, etc.).

It can be used either for clean installations or upgrades, in silent mode.