Install ArcGIS Data Pipelines Server silently

ArcGIS Data Pipelines Server can be installed using the installation wizard or the command prompt. For instructions on using the installation wizard, see Install ArcGIS Data Pipelines Server using the installation wizard.

Each machine with an installation of ArcGIS Data Pipelines Server requires an authorization file. The recommended method of registration is to use the software authorization wizard, which appears after the setup installation, or you can visit My Esri to obtain an authorization file before installing the software.

Prepare to install ArcGIS Data Pipelines Server

Before you install ArcGIS Data Pipelines Server, complete the following:

Verify that your machine meets the system requirements for ArcGIS Data Pipelines Server.
Obtain your software installers and authorization file.
Create a Windows account for the ArcGIS Data Pipelines Server account.

This will be the Run As account for ArcGIS Data Pipelines Server. It is recommended that you use a domain account, which you may need to request from your IT department. If you use a local Windows account, the installation wizard can create the account for you. The configureserviceaccount.bat command line tool can be used to configure the ArcGIS Data Pipelines Server service to run under a gMSA.

Once you've completed these steps, proceed with the command line installation as detailed below.

Installation command line parameters

The following parameters are available when using the command line utility to install ArcGIS Data Pipelines Server:

-m; --mode—(Optional) The install mode options are silent or GUI. The default is GUI.
-l; --license-agreement—Required for silent mode. The options are yes or no. Yes indicates that you have read and agreed to the Esri Master Agreement. You can review the agreement at any time.
-a; --authorization-file—(Optional) The absolute file path to the authorization or provisioning file provided by Esri. If this option is not used, you must authorize the software after installation.
-d; --directory—Use this parameter to change the installation location for ArcGIS Data Pipelines Server from the default location. By default, ArcGIS Data Pipelines Server is installed at ${HOME} directory. The path /arcgis/datapipelines/ is appended to the installation directory.
-v; --verbose—(Optional) Run the installer in verbose mode.
-h; --help—Displays the command line help and exits.
-e; --examples—Displays usage examples of each option and exits.

ACCEPTEULA—This parameter is required to accept the End User License Agreement during a silent installation. Specify yes to agree to the EULA and install the software. Specifying no or omitting this parameter will result in a failed installation. The download contains a PDF version of the End User License Agreement (EULA). The EULA.pdf is located in the \Documentation folder.
INSTALLDIR—Use the INSTALLDIR parameter to change the installation location for ArcGIS Data Pipelines Server from the default location. By default, ArcGIS Data Pipelines Server is installed at C:\Program Files\ArcGIS\DataPipelines\.
USER_NAME—The account can be a domain account or a local account. If you're using a domain account, it must already exist. If you're using a local account, the account will be created if it does not already exist. If the account is not valid, a message appears during installation indicating that the account or password is invalid.
PASSWORD—This is the password for the account specified for the USER_NAME parameter. If the password is not valid, a message appears during installation indicating that the account or password is invalid.
MSA—Set this parameter to TRUE if you are using a Managed Service Account. A Managed Service Account must already exist on your domain. Do not use this parameter with a local account or a domain account with password. A Managed Service Account will not use the PASSWORD parameter. The default is FALSE.
ACCOUNT—Use this parameter if you're importing credentials from a file. Set this parameter to UseConfigFile (matching the case exactly), and use the CONFIGPATH parameter to specify the file to import.
EXPORTCONFIG—Set this parameter to Yes to export the account information set for the USER_NAME and PASSWORD parameters to a server configuration file. The default is No.
CONFIGPATH—Use this parameter when importing or exporting config files. Specify the full path and name of the server configuration file, including the file extension .xml. If you are creating a file, the specified output folder must already exist. |

See below for information on the parameters available to specify the ArcGIS Data Pipelines Server account and run the installer.

Configure the Windows account

The ArcGIS Data Pipelines Server account must be configured when the software is installed silently. For production systems, it is recommended that you designate a preexisting account that resides in your domain or Active Directory and follows your organization's security policy.

If command line parameters are not used to configure the ArcGIS Data Pipelines Server account during silent installation, the account is automatically set to the Local System account.

Follow the examples below to configure the account during installation.

Passing account credentials directly

The following examples outline how to pass account credentials directly:

Using a domain account:

<path to the ArcGIS Data Pipelines Server setup download>\setup.exe /qb USER_NAME=mydomain\mydomainaccount PASSWORD=my.password
Using a new or existing local account:

<path to the ArcGIS Data Pipelines Server setup download>\setup.exe /qb USER_NAME=myaccount PASSWORD=my.password
Using a Managed Service Account:

<path to the ArcGIS Data Pipelines Server setup download>\setup.exe /qb MSA=TRUE USER_NAME=mydomain\mymsa

Import credentials from a server configuration file

You can also use a server configuration file to import your Windows account credentials. Server configuration files can be exported during ArcGIS Data Pipelines Server installation and used in future installations. The following example outlines how to import credentials from an existing server configuration file:

<setup directory>\setup.exe /qb ACCOUNT=UseConfigFile CONFIGPATH=\\networkmachine\serverconfigs\standardaccount.xml

Export credentials to a server configuration file

You can export the account credentials used in the current ArcGIS Data Pipelines Server installation to use in a future installation. The server configuration file that is created is an encrypted XML file.

When exporting a server configuration file to a network share, the Local System account on the machine where ArcGIS Data Pipelines Server is being installed must have write permissions to the network share. For example, if you're installing ArcGIS Data Pipelines Server on a machine named Turing, the Local System account on Turing must have write permission to the network share. If the permissions are not set, the server configuration file may not export successfully.

The following example outlines how to export credentials to a server configuration file:

<setup directory>setup.exe /qb USER_NAME=mydomain\mydomainaccount PASSWORD=my.password1 EXPORTCONFIG=yes CONFIGPATH=\\networkmachine\serverconfigs\standardaccount.xml

Run the setup using command line

To run the setup, open command prompt and navigate to the directory containing setup.exe. The following examples outline how run the setup using various configurations:

Install without specifying an account and an installation directory:

<setup directory>setup.exe /qb INSTALLDIR="C:\Program Files\MyDataPipelinesServerDirectory\" ACCEPTEULA=yes
Install with a domain account and accept the EULA:

<setup directory>setup.exe /qb USER_NAME=mydomain\mydomainaccount PASSWORD=my.password1 ACCEPTEULA=yes
Install using a new or existing local account and specify an install directory:

<setup directory>setup.exe /qb USER_NAME=myaccount PASSWORD=my.password1 ACCEPTEULA=yes
Install using a server configuration file:

<setup directory>\setup.exe /qb ACCOUNT=UseConfigFile CONFIGPATH=\\networkmachine\serverconfigs\standardaccount.xml ACCEPTEULA=yes

Make sure the user has full permissions to the ArcGIS Data Pipelines Server installation directory. The user account specified during ArcGIS Data Pipelines Server installation will be the account used to run the software.

Complete the following steps to install ArcGIS Data Pipelines Server silently:

Open a command shell as the user who will run ArcGIS Data Pipelines Server. Browse to the directory where you downloaded the ArcGIS Data Pipelines Server tar.gz file from My Esri.
Uncompress the tar.gz file with the following command:

tar -xvzf ArcGIS_Data_Pipelines_Server_Linux_<version>.tar.gz
Browse to the directory where the file was uncompressed; then browse to <untar directory>/Documentation/EULA.pdf. Read the license agreement.
From the directory, run the setup silently and authorize it using a .prvc file. For example, run using the following syntax:

<untar directory>/Setup -m silent -l yes -a <full path to .prvc file>

Example usage

To run the setup, open command prompt and navigate to the directory containing setup.exe. The following examples outline how to run the setup using various configurations:

Install silently, accept the license agreement, and specify the license file:

Setup --mode silent --license-agreement yes --authorization-file /path/to/datapipelinesserver.ecp
Install to a custom directory:

Setup -m silent -l yes -a /path/to/datapipelinesserver.ecp -d /path/to/install/datapipelines
Install without licensing:

Setup -m silent -l yes

To learn how to authorize your software after installation, see Authorize your software.

Authorize your software

Once the installation is complete, use the software authorization wizard to authorize your instance of ArcGIS Data Pipelines Server, or you can authorize your software silently.

To authorize your software silently, run SoftwareAuthorization.exe with the following syntax to authorize ArcGIS Data Pipelines Server silently. You must have all user information complete in the authorization or provisioning file before running the file.

If you have a .prvc or .ecp authorization file, use the following command:

<ArcGIS Data Pipelines Server installation>\tools\SoftwareAuthorization\SoftwareAuthorization.exe /S /Ver <version number> /LIF <full path of authorization file, including name and extension>

If you did not authorize your software during installation, run the software authorization with the following syntax to authorize ArcGIS Data Pipelines Server silently. You must have all user information complete in the authorization or provisioning file before running the file.

<ArcGIS Data Pipelines Server install directory>/tools/authorizeSoftware -f <full path to the .ecp file>

Run the following command to view all options for authorization:

<ArcGIS Data Pipelines Server install directory>/tools/authorizeSoftware --help

Authorize in a disconnected environment

You can authorize ArcGIS Data Pipelines Server in a disconnected environment using a provisioning (.prvc) file using the following steps:

Run the following command after the ArcGIS Data Pipelines Server installation is complete:

<ArcGIS Data Pipelines Server install directory>\tools\SoftwareAuthorization\SoftwareAuthorization.exe /S /LIF <full path to the .prvc file> /O <full path to authorization file output>
When the authorization information file output has been created, do one of the following:
- Browse to the Esri self service site. Follow the instructions on the screen to upload your authorization information file and download your .ecp authorization file.
- Send your authorization information file by email to authorize@esri.com. Esri will send your .ecp authorization file back to you in an email.
When you receive your .ecp authorization file using either of the above methods, run the authorizeSoftware script again to process it and complete the server authorization process:

<ArcGIS Data Pipelines Server install directory>\tools\SoftwareAuthorization\SoftwareAuthorization.exe /LIF <full path to the .ecp file>

You can authorize ArcGIS Data Pipelines Server in a disconnected environment using a provisioning (.prvc) file using the following steps:

Run the following command after the ArcGIS Data Pipelines Server installation is complete:

<ArcGIS Data Pipelines Server install directory>/tools/authorizeSoftware -f <full path to the .prvc file> -e <email address> -o <full path to authorization file output>
When the authorization information file output has been created, do one of the following:
- Browse to the Esri self service site. Follow the instructions on the screen to upload your authorization information file and download your .ecp authorization file.
- Send your authorization information file by email to authorize@esri.com. Esri will send your .ecp authorization file back to you in an email.
When you receive your .ecp authorization file using either of the above methods, run the authorizeSoftware script again to process it and complete the server authorization process:

<ArcGIS Data Pipelines Server install directory>/tools/authorizeSoftware/tools/authorizeSoftware -f <full path to the .ecp file>

Authorization is required for each machine with ArcGIS Data Pipelines Server installed. Repeat this process for each installation.

After authorizing your software, create an ArcGIS Data Pipelines Server site. This can be done using the installation wizard or the createsite command line utility. The createsite utility can be used along with a silent installation to fully automate the ArcGIS Data Pipelines Server installation.