Upgrade ArcGIS Monitor

Follow the steps in the sections below to upgrade ArcGIS Monitor 2024.0 or later.

Learn more about upgrading Monitor 2023.3 or earlier

Note:

All machines in a Monitor deployment must be upgraded to the same major.minor version.

Prepare to upgrade Monitor

Review the following information and complete any required actions before you upgrade Monitor:

• Review the Monitor system requirements to ensure that your hardware meets the current requirements.
• Create a backup of the Monitor database and all Monitor machines in the deployment, and store the backup files in a secure, remote location.
• Download the latest ArcGIS Monitor software installation files and authorization file from My Esri.
• Do not uninstall the previous version of ArcGIS Monitor Server or ArcGIS Monitor Agent until instructed to do so. There is no need to obtain and install each previously released version in sequence.

  Note:

  Only one version can be installed on a machine at a time; when you install a new version, the previous version is replaced.

• For Monitor Agent machines to function, they must be the same major.minor version as the Monitor Server machine.
• Ensure that the ArcGIS Monitor account has shell access.

  In earlier versions of Monitor, the setup package automatically created the ArcGIS Monitor account without shell access. To create a password and allow shell access for the ArcGIS Monitor account, run the following commands as a user in the sudoers group:

  sudo passwd <ArcGIS Monitor account name>
  sudo usermod -s /bin/bash <ArcGIS Monitor account name>

• Stop the arcgis-monitor-server service on the Monitor Server machine and the arcgis-monitor-agent service on all Monitor Agent machines by running the following commands as the root user:
  • Monitor Server: systemctl stop arcgis-monitor-server
  • Monitor Agent: systemctl stop arcgis-monitor-agent
  Monitoring is not available when the service is stopped.

  Note:

  Some deployments may contain an installation of Monitor Agent on the Monitor Server machine.

Upgrade a Monitor deployment

The recommended order to upgrade a Monitor deployment is as follows:

1. Upgrade Monitor Server.
2. Upgrade Monitor Agent.

   Note:

   Some deployments may contain an installation of Monitor Agent on the Monitor Server machine.

Starting with the Monitor 2024.0 release, all host machines must have Monitor Agent installed to collect metrics.

Learn more about deploying Monitor

Upgrade Monitor Server

Once you have the installation and backup files, complete the upgrade steps for Monitor Server. Do not uninstall The existing Monitor Server version until instructed to do so.

You can upgrade using an interactive command line interface (CLI), or silently upgrade Monitor Server from the CLI. The setup script detects and updates the existing installation of Monitor Server.

Upgrade using an interactive CLI

After you complete the prerequisites outlined in the Prepare to upgrade Monitor section, complete the steps below to upgrade Monitor Server using an interactive CLI. To perform a silent upgrade instead, proceed to the next section.

1. Start a terminal session on the Monitor Server machine with the root account.
2. Run the following commands to uninstall previous versions of Monitor Server:
   • Ubuntu:

     systemctl stop arcgis-monitor-server
     systemctl disable arcgis-monitor-server
     rm -rf /usr/lib/systemd/system/arcgis-monitor-server.service
     rm -rf /etc/systemd/system/multi-user.target.wants/arcgis-monitor-server.service
     dpkg --purge arcgis-monitor-server

   • Red Hat Enterprise Linux Server:

     systemctl stop arcgis-monitor-server
     systemctl disable arcgis-monitor-server
     rm -rf /usr/lib/systemd/system/arcgis-monitor-server.service
     rm -rf /etc/systemd/system/multi-user.target.wants/arcgis-monitor-server.service
     rpm -ev ArcGIS-Monitor-server

3. Start a terminal session on the Monitor Server machine with the ArcGIS Monitor account.

   Note:

   In earlier versions of Monitor, the setup package automatically created the ArcGIS Monitor account without shell access. To create a password and allow shell access for the ArcGIS Monitor account, run the following commands as a user in the sudoers group:

   sudo passwd <ArcGIS Monitor account name>
   sudo usermod -s /bin/bash <ArcGIS Monitor account name>

4. Change the directory to the location that contains the Monitor .tar.gz file and uncompress it.

   For example, use tar -zxvf ArcGIS_Monitor_Server.tar.gz.

5. Change the directory to the location that contains the extracted Monitor Server setup file.
6. From the command shell, run Setup.sh.

   The following is an example:

   ./Setup.sh

7. During the installation, read the license agreement and accept it, or exit if you do not agree with the terms.

   Tip:

   Press Q on your keyboard to close the Master Agreement.

8. Follow the prompts on the screen to install the software.
9. After the installation has finished, run the following commands as the root user to configure the arcgis-monitor-server service to automatically start with the operating system:

   cp <Monitor Server installation location>/framework/etc/scripts/arcgis-monitor-server.service /etc/systemd/system/.
   chmod 600 /etc/systemd/system/arcgis-monitor-server.service
   systemctl daemon-reload
   systemctl enable arcgis-monitor-server
   systemctl start arcgis-monitor-server

   The default installation directory is <ArcGIS Monitor user account home directory>/arcgis/monitor/server.

10. Verify that the arcgis-monitor-server service is running, and start the service if necessary:
    1. Run the following command to check the status of the service:

       systemctl status arcgis-monitor-server

    2. If the service is not running, run the following command as the root user to start the service:

       systemctl start arcgis-monitor-server

11. Once you have updated the Monitor Server installation, open a supported web browser, access Monitor, and verify that the software is updated and licensed.

Upgrade silently from the CLI

Rather than running the interactive CLI, you can upgrade Monitor Server silently.

After you complete the prerequisites outlined in the Prepare to upgrade Monitor section, complete the following steps to upgrade Monitor Server:

1. Start a terminal session on the Monitor Server machine with the root account.
2. Run the following commands to uninstall previous versions of Monitor Server:
   • Ubuntu:

     systemctl stop arcgis-monitor-server
     systemctl disable arcgis-monitor-server
     rm -rf /usr/lib/systemd/system/arcgis-monitor-server.service
     rm -rf /etc/systemd/system/multi-user.target.wants/arcgis-monitor-server.service
     dpkg --purge arcgis-monitor-server

   • Red Hat Enterprise Linux Server:

     systemctl stop arcgis-monitor-server
     systemctl disable arcgis-monitor-server
     rm -rf /usr/lib/systemd/system/arcgis-monitor-server.service
     rm -rf /etc/systemd/system/multi-user.target.wants/arcgis-monitor-server.service
     rpm -ev ArcGIS-Monitor-server

3. Start a terminal session on the Monitor Server machine with the ArcGIS Monitor account.

   Note:

   In earlier versions of Monitor, the setup package automatically created the ArcGIS Monitor account without shell access. To create a password and allow shell access for the ArcGIS Monitor account, run the following commands as a user in the sudoers group:

   sudo passwd <ArcGIS Monitor account name>
   sudo usermod -s /bin/bash <ArcGIS Monitor account name>

4. Change the directory to the location that contains the Monitor .tar.gz file and uncompress it.

   The following is an example:

   tar -zxvf ArcGIS_Monitor_Server.tar.gz

5. Change the directory to the location that contains the extracted ArcGIS Monitor Server setup file.
6. From the command shell, run Setup.sh.

   The --license-agreement parameter is required to accept the End User License Agreement (EULA) during a silent installation. Specify yes to agree to the EULA and install the software. Specifying no results in a failed installation.

   The following is an example:

   ./Setup.sh -l yes [options]

   -l; --license-agreement CHOICE	This property is required to accept the End User License Agreement (EULA) during a silent installation. Specify yes to agree to the EULA and install the software. Specifying no or omitting this property will result in a failed installation. The download contains a PDF of the EULA. The EULA.pdf file is in the Documentation folder.
   -d; --directory DIRECTORY	Optional. By default, Monitor Server is installed to the $HOME directory. DIRECTORY specifies a different installation directory. The /arcgis/monitor/server path is appended to the installation directory.
   -h; --help	Displays command line help and exits.

7. After the installation has finished, run the following commands as the root user to configure the arcgis-monitor-server service to automatically start with the operating system:

   cp <Monitor Server installation location>/framework/etc/scripts/arcgis-monitor-server.service /etc/systemd/system/.
   chmod 600 /etc/systemd/system/arcgis-monitor-server.service
   systemctl daemon-reload
   systemctl enable arcgis-monitor-server
   systemctl start arcgis-monitor-server

   The default installation directory is <ArcGIS Monitor user account home directory>/arcgis/monitor/server.

8. Verify that the arcgis-monitor-server service is running, and start the service if necessary:
   1. Run the following command to check the status of the service:

      systemctl status arcgis-monitor-server

   2. If the service is not running, run the following command as the root user to start the service:

      systemctl start arcgis-monitor-server

9. Once you have updated the Monitor Server installation, open a supported web browser, access Monitor, and verify that the software is updated and licensed.

Upgrade Monitor Agent

Once you have the installation and backup files, complete the upgrade steps on each Monitor Agent machine in the Monitor deployment. All machines in the Monitor deployment must be upgraded to the same major.minor version. Do not uninstall the exiting Monitor Agent version until instructed to do so.

You can upgrade using an interactive command line interface (CLI), or silently upgrade Monitor Agent from the CLI. The setup script detects and updates the existing installation of Monitor Agent.

Note:

Some deployments may contain an installation of Monitor Agent on the Monitor Server machine.

Upgrade using an interactive CLI

After you complete the prerequisites outlined in the Prepare to upgrade Monitor section, complete the steps below to upgrade Monitor Agent using an interactive CLI. To perform a silent upgrade instead, proceed to the next section.

1. Start a terminal session on the Monitor Agent machine with the root account.
2. Run the following commands to uninstall previous versions of Monitor Agent.
   • Ubuntu:

     systemctl stop arcgis-monitor-agent
     systemctl disable arcgis-monitor-agent
     rm -rf /usr/lib/systemd/system/arcgis-monitor-agent.service
     rm -rf /etc/systemd/system/multi-user.target.wants/arcgis-monitor-agent.service
     dpkg --purge arcgis-monitor-agent

   • Red Hat Enterprise Linux Server:

     systemctl stop arcgis-monitor-agent
     systemctl disable arcgis-monitor-agent
     rm -rf /usr/lib/systemd/system/arcgis-monitor-agent.service
     rm -rf /etc/systemd/system/multi-user.target.wants/arcgis-monitor-agent.service
     rpm -ev ArcGIS-Monitor-agent

3. Start a terminal session on the Monitor Agent machine with the ArcGIS Monitor account.

   Note:

   In earlier versions of Monitor, the setup package automatically created the ArcGIS Monitor account without shell access. To create a password and allow shell access for the ArcGIS Monitor account, run the following commands as a user in the sudoers group:

   sudo passwd <ArcGIS Monitor account name>
   sudo usermod -s /bin/bash <ArcGIS Monitor account name>

4. Change the directory to the location that contains the Monitor .tar.gz file and uncompress it.

   The following is an example:

   tar -zxvf ArcGIS_Monitor_Agent.tar.gz

5. Change the directory to the location that contains the extracted Monitor Agent setup file.
6. From the command shell, run Setup.sh.

   The following is an example:

   ./Setup.sh

7. During the installation, read the license agreement and accept it, or exit if you do not agree with the terms.

   Tip:

   Press Q on your keyboard to close the Master Agreement.

8. Follow the prompts on the screen to install the software.
9. After the installation has finished, run the following commands as the root user to configure the arcgis-monitor-agent service to automatically start with the operating system:

   cp <Monitor Agent installation location>/framework/etc/scripts/arcgis-monitor-agent.service /etc/systemd/system/.
   chmod 600 /etc/systemd/system/arcgis-monitor-agent.service
   systemctl daemon-reload
   systemctl enable arcgis-monitor-agent
   systemctl start arcgis-monitor-agent

10. Verify that the arcgis-monitor-agent service is running, and start the service if necessary:
    1. Run the following command to check the status of the service:

       systemctl status arcgis-monitor-agent

    2. If the service is not running, run the following command as the root user to start the service:

       systemctl start arcgis-monitor-agent

11. Once you have updated the Monitor Agent installation, open a supported web browser, access Monitor, and verify that the Monitor Agent machine is connected to Monitor Server.

Upgrade silently from the CLI

Rather than running the interactive CLI, you can upgrade Monitor Agent silently.

After you complete the prerequisites outlined in the Prepare to upgrade Monitor section, complete the following steps to upgrade Monitor Agent:

1. Start a terminal session on the Monitor Agent machine with the root account.
2. Run the following commands to uninstall previous versions of Monitor Agent:
   • Ubuntu:

     systemctl stop arcgis-monitor-agent
     systemctl disable arcgis-monitor-agent
     rm -rf /usr/lib/systemd/system/arcgis-monitor-agent.service
     rm -rf /etc/systemd/system/multi-user.target.wants/arcgis-monitor-agent.service
     dpkg --purge arcgis-monitor-agent

   • Red Hat Enterprise Linux Server:

     systemctl stop arcgis-monitor-agent
     systemctl disable arcgis-monitor-agent
     rm -rf /usr/lib/systemd/system/arcgis-monitor-agent.service
     rm -rf /etc/systemd/system/multi-user.target.wants/arcgis-monitor-agent.service
     rpm -ev ArcGIS-Monitor-agent

3. Start a terminal session on the Monitor Agent machine with the ArcGIS Monitor account.

   Note:

   In earlier versions of Monitor, the setup package automatically created the ArcGIS Monitor account without shell access. To create a password and allow shell access for the ArcGIS Monitor account, run the following commands as a user in the sudoers group:

   sudo passwd <ArcGIS Monitor account name>
   sudo usermod -s /bin/bash <ArcGIS Monitor account name>

4. Change the directory to the location that contains the Monitor .tar.gz file and uncompress it.

   The following is an example:

   tar -zxvf ArcGIS_Monitor_Agent.tar.gz

5. Change the directory to the location that contains the extracted Monitor Agent setup file.
6. From the command shell, run Setup.sh.

   The --license-agreement parameter is required to accept the End User License Agreement (EULA) during a silent installation. Specify yes to agree to the EULA and install the software. Specifying no results in a failed installation.

   The following is an example:

   ./Setup.sh -l yes [options]

   -l; --license-agreement CHOICE	This property is required to accept the End User License Agreement (EULA) during a silent installation. Specify yes to agree to the EULA and install the software. Specifying no or omitting this property will result in a failed installation. The download contains a PDF of the EULA. The EULA.pdf file is in the Documentation folder.
   -d; --directory DIRECTORY	Optional. By default, Monitor Server is installed to the $HOME directory. DIRECTORY specifies a different installation directory. The /arcgis/monitor/agent path is appended to the installation directory.
   -h; --help	Displays command line help and exits.

7. After the installation has finished, run the following commands as the root user to configure the arcgis-monitor-agent service to automatically start with the operating system:

   cp <Monitor Agent installation location>/framework/etc/scripts/arcgis-monitor-agent.service /etc/systemd/system/.
   chmod 600 /etc/systemd/system/arcgis-monitor-agent.service
   systemctl daemon-reload
   systemctl enable arcgis-monitor-agent
   systemctl start arcgis-monitor-agent

8. Verify that the arcgis-monitor-agent service is running, and start the service if necessary:
   1. Run the following command to check the status of the service:

      systemctl status arcgis-monitor-agent

   2. If the service is not running, run the following command as the root user to start the service:

      systemctl start arcgis-monitor-agent

9. Once you have updated the Monitor Agent installation, open a supported web browser, access Monitor, and verify that the Monitor Agent machine is connected to Monitor Server.

Considerations after upgrading

It is recommended that you create a backup of the Monitor database and all Monitor machines in the deployment after upgrading. After upgrading, confirm that the deployment is collecting data as expected by accessing Monitor and viewing collection details and component details.