All ArcGIS Monitor machines in a deployment must be upgraded to the same 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. Running the setup automatically upgrades Monitor Server or Monitor Agent. 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 old version is replaced.
- For Monitor Agent machines to function, they must be the same version as the Monitor Server machine.
- Stop the ArcGIS Monitor Server service and ArcGIS Monitor Agent service on all Monitor Server and Monitor Agent machines using Windows Services Manager before you upgrade. Monitoring is not available when the services are stopped.
Create a list of Monitor Agent machines
Each machine in an ArcGIS Monitor deployment must be upgraded, and all machines must use the same version of Monitor.
To create a list of Monitor Agent machines in the deployment that need to be upgraded, complete the following steps:
- Access ArcGIS Monitor if necessary.
The Home page appears.
- Click Monitoring.
The Monitoring page appears. Registered components are listed alphabetically by name.
- Click the Agents tab.
The Agents page appears with a list of Monitor Agent machines.
- Click Hide and click ID to add the ID column to the agent list.
- Record the address of each Monitor Agent machine.
- Identify the Monitor Agent machine with the same address as the Monitor Server machine and record its corresponding ID.
The ID is required later in the upgrade process.
Create a list of registered host component machines
Starting with Monitor 2024.0, all registered host component machines must have their own installation of Monitor Agent.
To create a list of registered host component machines, complete the following steps:
- Access ArcGIS Monitor if necessary.
The Home page appears.
- Click Monitoring.
The Monitoring page appears. Registered components are listed alphabetically by name.
- Click the Hosts filter under Monitored components.
- Record the address of each host component.
Upgrade a Monitor deployment
The recommended order to upgrade a Monitor deployment is as follows:
- Upgrade Monitor Server and its integrated Monitor Agent.
- Upgrade existing Monitor Agent machines.
- Install Monitor Agent on all registered host component machines.
Note:
Starting with the Monitor 2024.0 release, all host machines must have Monitor Agent installed to collect metrics.
Upgrade Monitor Server
Once you have the installation files and backup files, complete the upgrade steps for Monitor Server. Do not uninstall Monitor Server before installing the new version.
You can upgrade using an interactive wizard-driven experience by launching the Setup.exe program or run Setup.exe from a command prompt or batch script to silently upgrade Monitor Server. The Setup.exe installation file detects and updates the existing installation of Monitor Server.
Upgrade using an interactive wizard-driven experience
After you complete the prerequisites outlined in the Prepare to upgrade Monitor section, complete the following steps to upgrade Monitor Server and its integrated Monitor Agent installation using an interactive wizard. To upgrade using commands instead, proceed to the next section.
- Run the Monitor Server Setup.exe file on the Monitor Server machine.
Do not uninstall the existing Monitor Server installation.
- During the installation, read the license agreement and accept it, or exit if you do not agree with the terms.
When you accept the license agreement, the Monitor Server setup program displays the features that will be installed.
- When prompted, provide the credentials for the ArcGIS Monitor account.
Typically, this is the username and password that you defined when the software was installed. If the username or password has changed since the software was installed, provide the credentials for the current ArcGIS Monitor account. If you are unsure of the username or password for the account, contact your system administrator.
- Once you have updated the Monitor Server installation, open a supported web browser, access Monitor, and verify that the software is updated and licensed.
- Run the Monitor Agent Setup.exe file on the Monitor Server machine.
- During the installation, read the license agreement and accept it, or exit if you do not agree with the terms.
When you accept the license agreement, the Monitor setup program displays the features that will be installed.
- When prompted, provide the credentials for the ArcGIS Monitor account.
Typically, this is the username and password that you defined when the software was installed. If the username or password has changed since the software was installed, provide the credentials for the current ArcGIS Monitor account. If you are unsure of the username or password for the account, contact your system administrator.
- Once you have installed Monitor Agent, open a command prompt window on the Monitor Server machine.
- Run the command below, editing the command line parameters to include the root URL to Monitor Server, your username and password, and the Monitor Agent ID.
<Monitor Agent installation location>\bin\arcgis-monitor-agent.exe admin:system:register --server-url <https://monitorserver.domain.com:30443/arcgis> --username <user> --password <password> --agent-id <agent ID>
You must provide the ID of the Monitor Server machine's integrated Monitor Agent using the --agent-id parameter.
The following is an example:
"C:\Program Files\ArcGIS\Monitor\Agent\bin\arcgis-monitor-agent.exe" admin:system:register --server-url https://monitorserver.domain.com:30443/arcgis --username jdoe --password "my password" --agent-id 1
A confirmation message appears.
- Once you have registered the Monitor Agent installation, open a supported web browser, access Monitor, and verify that Monitor Agent is connected to Monitor Server.
Upgrade using commands
Rather than run the setup program, you can run the Setup.exe file at a command prompt or in a batch script to update Monitor Server. To avoid receiving a prompt to proceed with the upgrade, run the command in silent mode by including the /qb parameter in the script.
After you complete the prerequisites outlined in the Prepare to upgrade Monitor section, complete the following steps to upgrade Monitor Server:
- Run the Monitor Server Setup.exe file from a command prompt or in a script on the Monitor Server machine.
Do not uninstall the existing Monitor Server installation.
The ACCEPTEULA 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 or omitting this parameter results in a failed installation. For more information, review the Master Agreement.
When upgrading using the Setup.exe file in silent mode, you must specify the ArcGIS Monitor account. Typically, this is the account you defined when installing the software. If the account has changed since the software was installed, provide the current username and password of the ArcGIS Monitor account.
If you do not specify the ArcGIS Monitor account, or it does not match the account used by the current installation, a message is displayed indicating the credentials could not be validated and the installation fails. If you are unsure of the username or password for the account, contact your system administrator.
In the following example, the account used by the software is myaccount and the password is my.password:
<path to ArcGIS Monitor Server setup download folder>\Setup.exe /qb ACCEPTEULA=yes USER_NAME=myaccount PASSWORD=my.password
In the following example, the domain account used by the software is mydomain\myaccount and the password is my.password:
<path to ArcGIS Monitor Server setup download folder>\Setup.exe /qb ACCEPTEULA=yes USER_NAME=mydomain\myaccount PASSWORD=my.password
Caution:
Command line parameters are case sensitive. If you have trouble upgrading, confirm that the case matches the properties as shown in the examples.
- Once you have updated the Monitor Server installation, open a supported web browser, access Monitor, and verify that the software is updated and licensed.
- Run the Monitor Agent Setup.exe file from a command prompt or in a script on the Monitor Server machine.
The ACCEPTEULA 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 or omitting this parameter results in a failed installation. For more information, review the Master Agreement.
When upgrading using the Setup.exe file in silent mode, you must specify the ArcGIS Monitor account. Typically, this is the account you defined when installing the software. If the account has changed since the software was installed, provide the current username and password of the ArcGIS Monitor account.
If you do not specify the ArcGIS Monitor account, or it does not match the account used by the current installation, a message is displayed indicating that the credentials could not be validated and the installation fails.
In the following example, the account used by the software is myaccount and the password is my.password:
<path to the ArcGIS Monitor Agent setup download>\setup.exe /qb ACCEPTEULA=yes USER_NAME=myaccount PASSWORD=my.password
In the following example, the domain account used by the software is mydomain\myaccount and the password is my.password:
<path to ArcGIS Monitor Agent setup download folder>\Setup.exe /qb ACCEPTEULA=yes USER_NAME=mydomain\myaccount PASSWORD=my.password
Caution:
Command line parameters are case sensitive. If you have trouble upgrading, confirm that the case matches the properties as shown in the examples.
- Once you have installed Monitor Agent, run the command below, editing the command line parameters where necessary.
<Monitor Agent installation location>\bin\arcgis-monitor-agent.exe admin:system:register --server-url <https://monitorserver.domain.com:30443/arcgis> --username <user> --password <password> --agent-id <agent ID>
You must provide the ID of the Monitor Server machine's integrated Monitor Agent using the --agent-id parameter.
The following is an example:
"C:\Program Files\ArcGIS\Monitor\Agent\bin\arcgis-monitor-agent.exe" admin:system:register --server-url https://monitorserver.domain.com:30443/arcgis --username jdoe --password "my password" --agent-id 1
A confirmation message appears.
- Once you have registered the Monitor Agent installation, open a supported web browser, access Monitor, and verify that Monitor Agent is connected to Monitor Server.
Upgrade Monitor Agent
Once you have the installation files and backup files, complete the upgrade steps on each Monitor Agent machine in your Monitor deployment. All Monitor Agent machines in the deployment must run the same Monitor release. Do not uninstall Monitor Agent before installing the new version.
You can upgrade using an interactive wizard-driven experience by launching the Setup.exe program or run Setup.exe from a command prompt or batch script to silently upgrade Monitor Agent. The Setup.exe installation file detects and updates the existing installation of Monitor Agent.
Upgrade using an interactive wizard-driven experience
After you complete the prerequisites outlined in the Prepare to upgrade Monitor section, complete the following steps to upgrade Monitor Agent using an interactive wizard. To upgrade using commands instead, proceed to the next section.
- Run the Monitor Agent Setup.exe program on each Monitor Agent machine in the deployment.
Do not uninstall the existing Monitor Agent installation.
- During the installation, read the license agreement and accept it, or exit if you do not agree with the terms.
When you accept the license agreement, the Monitor setup program displays the features that will be installed.
- When prompted, provide the credentials for the ArcGIS Monitor account.
Typically, this is the username and password that you defined when the software was installed. If the username or password has changed since the software was installed, provide the credentials for the current ArcGIS Monitor account. If you are unsure of the username or password for the account, contact your system administrator.
- 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 using commands
Rather than launching the setup program, you can run the Setup.exe file at a command prompt or in a batch script to update Monitor Server. To avoid receiving a prompt to proceed with the upgrade, run the command in silent mode by including the /qb parameter in the script.
After you complete the prerequisites outlined in the Prepare to upgrade Monitor section, complete the following steps to upgrade Monitor Server:
- Run the Monitor Setup.exe file from a command prompt or in a script on each Monitor Agent machine in the deployment.
Do not uninstall the existing Monitor Agent installation.
The ACCEPTEULA 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 or omitting this parameter results in a failed installation. For more information, review the Master Agreement.
When upgrading using the Setup.exe file in silent mode, you must specify the ArcGIS Monitor account. Typically, this is the account you defined when installing the software. If the account has changed since the software was installed, provide the current username and password of the ArcGIS Monitor account.
If you do not specify the ArcGIS Monitor account, or it does not match the account used by the current installation, message is displayed indicating that the credentials could not be validated and the installation fails.
In the following example, the account used by the software is myaccount and the password is my.password:
<path to the ArcGIS Monitor setup download>\setup.exe /qb ACCEPTEULA=yes ADDLOCAL=Agent USER_NAME=myaccount PASSWORD=my.password
In the following example, the domain account used by the software is mydomain\myaccount and the password is my.password:
<path to ArcGIS Monitor setup download folder>\Setup.exe /qb ACCEPTEULA=yes ADDLOCAL=Agent USER_NAME=mydomain\myaccount PASSWORD=my.password
Caution:
Command line parameters are case sensitive. If you are have trouble upgrading, confirm that the case matches the properties as shown in the examples.
- 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.
Install Monitor Agent on registered host component machines
Once you have upgraded Monitor Server and Monitor Agent, complete the following steps to install Monitor Agent on all registered host component machines:
- Install Monitor Agent on each registered host component machine in the deployment.
Tip:
You can also install Monitor Agent silently using commands.
- Register Monitor Agent with Monitor Server as a new agent.
Once you have registered the Monitor Agent installation, open a supported web browser, access Monitor, and verify that Monitor Agent is connected to Monitor Server.
Considerations after upgrading
Monitor backups that you created before upgrading cannot be used to restore a Monitor deployment. 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.