Introduction
ArcGIS Monitor 2024.0 was released on August 27th, 2024. One major change in this version is that the ArcGIS Monitor Agent software is required on all machines in the ArcGIS Enterprise environment that you wish to collect metrics on. This is different from previous releases, where metrics could be collected on all components using a single agent.
To make the deployment of agents across the environment quicker, my colleague @GeoJen and I have written a set of scripts to automate the process.
The first script, InstallAgents, takes a list of machines, connects to the targets remotely, and installs the ArcGIS Monitor Agent 2024.0 software. The second, ConfigureAgents, takes a list of machines, connects remotely, completes the Agent post-installation steps, and completes registration with your ArcGIS Monitor Server.
The scripts can be downloaded here.
Requirements
To use these scripts, you must:
- Be running Windows
- Have ArcGIS Monitor Server 2024.0 installed and configured.
- Have the ArcGIS Monitor Agent 2024.0 installer downloaded on a central location.
- Be running Powershell 5.1 or above
- Be an administrator on the machine where the script is run and on the machines targeted for Agent configuration.
- Have credentials for an ArcGIS Monitor Server user with the Administrator role.
Usage
InstallAgents
1. Open a Powershell 5.1 prompt and change directories to the folder where you downloaded the scripts to.
2. Launch the script:
.\InstallAgents.ps1
3. Provide a commas-separated list of machines where Agents should be installed:
Target Machines (comma-separated list): machine1.esri.com,machine2.esri.com,machine3.esri.com
4. Enter the credentials for the account that will be used to run the ArcGIS Monitor Agent service:
Connection Credentials
Enter credentials for a user who is an administrator on all target machines
User: myDomain\josh
Password for user myDomain\josh: ****************
5. Provide the path to the ArcGIS Monitor Agent installer directory. This should be the folder that contains Setup.exe:
ArcGIS Monitor Agent Installer: C:\Users\<username>\Documents\ArcGIS Monitor 2024.0\MonitorAgent
After completing these steps, the script will create a remote Powershell connection to each machine specified and install the software. The output will look like this for successful installations:
*********************
machine1.esri.com
*********************
Creating remote session...
Copying installer to remote destination...
Installing ArcGIS Monitor Agent 2024.0...
Installation successful!
*********************
machine2.esri.com
*********************
Creating remote session...
Copying installer to remote destination...
Installing ArcGIS Monitor Agent 2024.0...
Installation successful!
ConfigureAgents
1. Open a Powershell 5.1 prompt and change directories to the folder where you downloaded the scripts to.
2. Launch the script:
.\ConfigureAgents.ps1
3. Provide a commas-separated list of machines where Agents are installed and need to be configured with ArcGIS Monitor Server:
Target Machines (comma-separated list): machine1.esri.com,machine2.esri.com,machine3.esri.com
4. Enter the ArcGIS Monitor Server URL that the targeted Agents should be configured with:
ArcGIS Monitor Server URL: https://monitorserver.esri.com:30443/arcgis
5. Enter the username and password of an ArcGIS Monitor Server user that has the Administrator role:
ArcGIS Monitor Server Credentials
Enter credentials for an administrator user in ArcGIS Monitor Server
User: adminuser
Password for user adminuser: *************************
After completing these steps, the script will create a remote Powershell connection to each machine specified and configure the ArcGIS Monitor Agent software with ArcGIS Monitor Server. The output will look like this for successful configurations:
*********************
machine1.esri.com
*********************
Creating remote session...
Checking for ArcGIS Monitor Agent installation...
Trying to reach ArcGIS Monitor Agent via HTTP...
ArcGIS Monitor Agent reachable!
Configuring with ArcGIS Monitor Server...
[ success ] Successfully authenticated to ArcGIS Monitor Server
[ success ] Successfully registered to ArcGIS Monitor Server
*********************
machine2.esri.com
*********************
Creating remote session...
Checking for ArcGIS Monitor Agent installation...
Trying to reach ArcGIS Monitor Agent via HTTP...
ArcGIS Monitor Agent reachable!
Configuring with ArcGIS Monitor Server...
[ success ] Successfully authenticated to ArcGIS Monitor Server
[ success ] Successfully registered to ArcGIS Monitor Server
