Install ArcGIS Velocity

To install ArcGIS Velocity, you can run the Velocity installation wizard, or you can run the installation silently from a command line.

After installation of Velocity, the software must be authorized with a license file. Authorization can be completed using the software authorization wizard, or can be run silently from a command line.

The steps below guide you through the installation of ArcGIS Velocity. To use Velocity, the software must be authorized with a license file. The license file can be provided during or after the installation. Refer to these steps to authorize the software silently using the command line after installation.

Prerequisites before deploying Velocity

Before deploying Velocity, ensure all the following prerequisites are met:

Verify that you have an existing ArcGIS Enterprise base enterprise deployment, as mentioned in system requirements.
Verify that your machine meets the hardware and software requirements for Velocity, as mentioned in system requirements.
Verify that your firewall allows communication on the ports used by Velocity, as mentioned in ports used by Velocity.
Obtain your software download and authorization file from My Esri.

After verifying these items, complete the steps in the following sections to install Velocity.

Install Velocity using the installation wizard

Note:

Do not close the Command Prompt window that opens during the Windows installation process. Closing it may interrupt the installation and cause errors.

To install Velocity using the installation wizard, complete the following steps:

Browse to the location of the setup files downloaded from My Esri and double-click Setup.exe.
Read and accept the master agreement, or close the window if you disagree with the terms.
Specify the Velocity installation directory and click Next.

The Velocity installation directory stores all Velocity software components.

The default installation location is C:\Program Files\ArcGIS\Velocity.
Specify the account for running Velocity services. The following two options are available:
- Specify the account name and password
- I have a configuration file with the account information generated by a previous run of this setup
The Specify the account name and password option allows you to directly provide an account name and password. The account can be a local account, domain account, or Managed Service Account. The account you specify does not have to be a member of the Administrators group.
- If you use a Managed Service Account, the account must already be configured for your machine.
- If you use a local operating system account, the account is created automatically if it does not already exist. The default account name is arcgis. The password policy for this account is determined by your operating system and your organization's security policy, not by the Velocity setup.
- If you use a domain account, it must already exist on the domain and must be entered using the following format: mydomain\domainaccount.
- For production systems, it is recommended that you designate a preexisting account that resides in your domain or Active Directory domain account, and follows your organization's security policy. For more information, refer to accounts used by Velocity.
Note:

Creating a local account during installation is primarily for the convenience of quickly installing Velocity.

If you have a Velocity configuration file generated by previously running the Velocity for ArcGIS setup, choose the I have a configuration file with the account information generated by a previous run of this setup option. Browse to the location of the portal configuration file. The Velocity for ArcGIS account is automatically configured with account information stored in the configuration file.
Optionally, export the account credentials used in the current Velocity installation for future installation.

Once the installation is complete, use the software authorization wizard to authorize your instance of Velocity.

Use the software authorization wizard

Note:

Do not close the Command Prompt window that opens during the Windows installation process. Closing it may interrupt the installation and cause errors.

Once the installation is complete, the ArcGIS Velocity for ArcGIS Enterprise software authorization wizard opens. To authorize the installation with Velocity license, complete the following steps:

The software authorization wizard can be opened manually using the search function in your computer's Start menu and searching for Software Authorization for ArcGIS Velocity for ArcGIS Enterprise.
When the software authorization wizard opens, you have the following options:
1. I have already installed my software and need to authorize it — Select this option if you do not already have an authorization file, and click Next. On the subsequent dialog box, choose one of the options to authorize your software. You will need an internet connection to complete the authorization.
2. I have already authorized the software and need to authorize additional extensions — Use this option if you have additional extensions to authorize.
3. I have received an authorization file and am now ready to finish the authorization process — Select this option if you have already received your authorization file from My Esri. Browse to the authorization file on disk, and click Next to complete your authorization.
Choose an applicable option, click Next, then click Finish.

Note:

If you cancel the software authorization wizard, the services that run Velocity will not start. To complete the authorization, search for the Software Authorization for ArcGIS Velocity for ArcGIS Enterprise app and complete the steps described above. After authorization is complete, the services that run Velocity must be stopped and restarted. Refer to processes started by Velocity for steps.

Install Velocity silently

Velocity can be installed and authorized silently using the command line. Each machine with an installation of Velocity requires an authorization file.

Note:

Command line parameters are case sensitive. If you have trouble getting your installation to work, confirm that the case matches each property as illustrated in the code examples below.

Installation command line parameter

The following parameter is required when installing Velocity silently:

   ACCEPTEULA=yes

This property is required to accept the End User License Agreement (EULA) during a silent installation. Specify Yes to agree to EULA and install the software. Specifying No or omitting this property results in a failed installation.

The download contains a PDF version of the EULA. The EULA.pdf file is in the \Documentation folder.

For example,

<path to setup directory>\setup.exe ACCEPTEULA=yes /qb+

Optional installation command line parameters

The following are optional command line parameters.

```
/L*vx<full path to .log file>
```
This optional property enables detailed logging during the installation process. Logs are written to the provided .log file.
```
LIF=<license path>\< Server_Velocity.ecp or .prvc>
```
This property is the full path to the license file.

Note:

A license file is needed for the successful installation and authorization of Velocity. If you do not provide a license file during the installation process, you need to authorize the software later. Refer to authorize Velocity silently for steps.
```
INSTALLDIR=<installation location>
```
This optional parameter allows you to specify the installation location of Velocity from the command line. If you do not set this property, the default installation location of C:\Program Files\ArcGIS\Velocity\ is used.

In the following example, installation logs are written to a custom location, a Velocity license file is provided, and Velocity is installed to a custom location:

<path to setup directory>\setup.exe /L*vx C:\installLogs.log ACCEPTEULA=yes LIF=C:\licenses\Server_Velocity.ecp INSTALLDIR=C:\NewServerDir /qb+

Configuring the Velocity account using command line parameters

The account that runs Velocity services 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 Velocity account during silent installation, the account is automatically set to the local system account.

Note:

For production systems, it is recommended that you use a preexisting account that resides in your domain or active directory and adheres to your organization's security policy. Creating a local account during installation is primarily for the convenience of quickly installing Portal for ArcGIS.

Passing account credentials directly

Note:

If the Velocity account is not defined during a silent (/qb) installation or the credentials are not valid, the Velocity account is set to the Local System account.

```
USER_NAME=<operating system account>
```
The account can be a domain account or a local account. If you are using a domain account, it must already exist. If you are using a local account, the account will be created if it does not exist. If the account is not valid, a message appears during installation indicating that the account or password is invalid.
```
MSA=TRUE
```
This parameter should only be used with a Managed Service Account. A Managed Service Account must already exist in your domain. Do not use this parameter with a local account or with a domain account that uses a password. A Managed Service Account does not use the PASSWORD parameter.
```
PASSWORD=<account password>
```
This parameter specifies the password for the account defined by the USER_NAME parameter. If the password is not valid, a message appears during installation indicating that the account or password is invalid.

For example,

Silent installation using a domain account:

<path to setup directory>\setup.exe /L*vx <full path to a .log file> ACCEPTEULA=yes LIF=<license path>\Server_Velocity.ecp USER_NAME=mydomain\mydomainaccount PASSWORD=my.password /qb+

Silent installation using a new or existing local account:

<path to setup directory>\setup.exe /L*vx <full path to a .log file> ACCEPTEULA=yes LIF=<license path>\Server_Velocity.ecp USER_NAME=myaccount PASSWORD=my.password /qb+

Silent installation using a Managed Service Account:

<path to setup directory>\setup.exe /L*vx <full path to a .log file > ACCEPTEULA=yes LIF=<license path>\Server_Velocity.ecp USER_NAME=gMSA_ACCT_NAME PASSWORD= /qb+

Importing Velocity account credentials using a configuration file

Server configuration files can be exported during installation for future installations. During installation, the following command line parameter can be used to import ArcGIS Server account credentials using a server configuration file.

CONFIGPATH=<full path and name of server configuration file>

For example,

<path to setup directory>\setup.exe /L*vx < full path to a .log file> ACCEPTEULA=yes LIF=<license path>\Server_Velocity.ecp CONFIGPATH=<full path to config file> /qb+

Exporting ArcGIS Velocity account credentials to a server configuration file

The two command line parameters below must be used together to export ArcGIS Server account credentials to a server configuration file.

```
EXPORTCONFIG=Yes 
```
Use this property to export the account information entered with the USER_NAME and PASSWORD command line parameters. The account information is stored in an encrypted XML file, known as a server configuration file. This property is set to No by default.
```
CONFIGPATH=<full path and name of server configuration file>
```
Used in conjunction with EXPORTCONFIG=Yes, this property allows you to define the name of the server configuration file and the location where it is stored. The file name must end with .xml and the specified folder must already exist. If the file does not have an .xml extension and the specified directory does not already exist, the server configuration file creation may not be successful.

For example,

<path to setup directory>\setup.exe /L*vcx <full path to .log file> ACCEPTEULA=yes LIF=<license path>\Server_Velocity.ecp USER_NAME=myaccount PASSWORD=my.password EXPORTCONFIG=Yes CONFIGPATH=C:\velocityconfig.xml /qb+

Install Velocity silently

To install Velocity silently, complete the following steps:

Uncompress the tar.gz file using the following command.

tar -zxvf ArcGIS_Velocity_for_ArcGIS_Enterprise_<version>.tar.gz

Browse to the directory where the file was uncompressed, and open <installation media root>/Documentation/EULA.pdf. Read the license agreement.

From the directory, run the Setup file to install Velocity.

   <untar directory>/Setup -l yes -d <directory> -a <authorization file>

Parameter	Description
-l; --license-agreement CHOICE	Required for installation. The value is either Yes or No. Yes indicates that you have read and agreed to the Esri Master Agreement (E204, E300). You can review the agreement at any time.
-a; --authorization-file PATH_TO_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, as detailed in authorize Velocity silently.
-d; --directory DIRECTORY	Specifies the install directory. If the directory does not exist, it will be created by the installer. The path `/arcgis/Velocity/` is appended to the installation directory.

Configure Velocity to be started with the operating system by following the appropriate instructions below.
Note:

When sudo is referenced, you can instead log in as root to run the command.
```
$ sudo su root
OR
$ su root
OR
$ su
```

Copy the systemd service and slice unit files to the systemd directory.

  sudo cp <installation location>/*.service <installation location>/*.slice /etc/systemd/system

Copy the ArcGISVelocityMetrics service to the systemd home directory.

  sudo cp <installation location>/metrics/ArcGISVelocityMetrics.service /etc/systemd/system

Enable the required Velocity services so they start automatically at system boot.

sudo systemctl enable ArcGISVelocityControlPlane.service ArcGISVelocityFeed.service ArcGISVelocityGateway.service ArcGISVelocityMetrics.service ArcGISVelocityRealtimeAnalytic.service ArcGISVelocityStreamServer.service

Start the Velocity services.

sudo systemctl start ArcGISVelocityControlPlane.service ArcGISVelocityFeed.service ArcGISVelocityGateway.service ArcGISVelocityMetrics.service ArcGISVelocityRealtimeAnalytic.service ArcGISVelocityStreamServer.service

Authorize Velocity silently

If you did not authorize your software during installation, run the following command to authorize Velocity silently with an authorization file (.ecp) or a provisioning file (.prvc).

<installation directory>\tools\SoftwareAuthorization\SoftwareAuthorization.exe /S /Ver 12.1 /Lif <Path_to_File>

<installation location>/tools/authorizeSoftware -f <full path to the .ecp file or .prvc file>

After authorizing, stop and restart the services that run Velocity. Refer to processes started by Velocity for steps.

After installing and authorizing ArcGIS Velocity, continue to create a Velocity site.