Skip to main content

Back up and restore a deployment

Administrators should make periodic backups of ArcGIS Monitor so that it can be restored in the event of hardware failure, human error, or migration.

Make a backup of Monitor Server

To make a backup of the ArcGIS Monitor Server machine in a deployment, complete the following steps:

  1. Sign in to the Monitor Server machine with an account that has access to the Monitor Server installation location.

  2. Back up the C:\Users\<ArcGIS Monitor account username>\AppData\Local\ESRI\ArcGISMonitor\config-store-server directory.

  3. Back up the <ArcGIS Monitor account home directory>/.config/ESRI/ArcGISMonitor/config-store-server directory.

Make a backup of the Monitor database

To back up the Monitor database, you must have read access to all of the Monitor database tables. The following steps back up the Monitor database using the PostgreSQL pg_dump utility. Depending on your organization's database infrastructure, you may need to use another method to back up the Monitor database.

To back up the Monitor database with the pg_dump utility, complete the following steps:

  1. Sign in to the machine that contains the Monitor database with an account that has permissions to perform administrative operations on the Monitor database.

  2. Back up the Monitor database.

    Learn more about backing up databases in PostgreSQL

Restore Monitor Server

To ensure a successful restoration, backups should be restored in the order listed below. Depending on the type of failure or migration, you may not need to perform all of the steps.

To restore Monitor Server, complete the following steps:

  1. Restore the Monitor database.

    Learn more about restoring databases in PostgreSQL

  2. Install Monitor Server if necessary.

  3. Sign in to the Monitor Server machine with an account that has access to the Monitor Server installation directory.

  4. Start Windows Service Manager.

  5. Right-click ArcGIS Monitor Server in Windows Service Manager and click Stop.

  6. Delete the C:\Users\<ArcGIS Monitor account username>\AppData\Local\ESRI\ArcGISMonitor\config-store-server directory.

  7. Copy the backup of the Monitor Server configuration store to the C:\Users\<ArcGIS Monitor account username>\AppData\Local\ESRI\ArcGISMonitor\config-store-server directory.

    Ensure that the ArcGIS Monitor account retains full read and write permissions to the configuration store directory.

  8. Right-click ArcGIS Monitor Server in Windows Service Manager and click Start.

  9. Open a command shell.

  10. Run the following command to stop the arcgis-monitor-server service:

    sudo systemctl stop arcgis-monitor-server

  11. Delete the <ArcGIS Monitor account home directory>/.config/ESRI/ArcGISMonitor/config-store-server directory.

  12. Copy the backup of the Monitor Server configuration store to the <ArcGIS Monitor account home directory>/.config/ESRI/ArcGISMonitor/config-store-server directory.

    Ensure that the ArcGIS Monitor account retains full read and write permissions to the configuration store directory.

  13. Run the following command to start the arcgis-monitor-server service:

    sudo systemctl start arcgis-monitor-server

  14. Access ArcGIS Monitor if necessary.

    The Home page appears.

  15. If the Monitor database was restored to a different database, register Monitor Server with the new Monitor database.

  16. Verify the status of the restoration.

    Note:

    Monitor Agent machines that were registered with Monitor Server are automatically reconnected to Monitor Server.

  17. Verify that all Monitor Agent machines are connected to Monitor Server and reconnect them to Monitor Server as necessary.

Restore Monitor Agent

In the event of hardware failure, human error, or migration, you may need to reinstall Monitor Agent and reconnect it to Monitor Server. Depending on the type of failure or migration, you may not need to perform all of the steps below.

If you are transferring a Monitor Agent machine's responsibilities to another machine, you must disconnect it from ArcGIS Monitor Server and note its agent ID.

To restore Monitor Agent, complete the following steps:

  1. Install Monitor Agent if necessary.

  2. Sign in to the Monitor Agent machine with an account that has access to the Monitor Agent installation directory.

  3. Open a command prompt window on the Monitor Agent machine.

  4. Start a terminal session on the Monitor Agent machine.

  5. Run the command below, editing the parameters where necessary, to check the status of the connection with Monitor Server.

    <Monitor Agent installation location>\bin\arcgis-monitor-agent.exe admin:system:info

    ./<Monitor Agent installation location>/bin/arcgis-monitor-agent admin:system:info

    The following is an example:

    C:\Program Files\ArcGIS\Monitor\Agent\bin\arcgis-monitor-agent.exe admin:system:info

    $HOME/arcgis/monitor/agent/bin/arcgis-monitor-agent admin:system:info

  6. Do one of the following:

    • If the connection status is connected, no further action is necessary.

    • If the connection status is disconnected, 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.example.com:30443/arcgis> --username <username> --password <password> --agent-id <agent ID>

      ./<Monitor Agent installation location>/bin/arcgis-monitor-agent admin:system:register --server-url <https://monitorserver.example.com:30443/arcgis> --username <username> --password <password> --agent-id <agent ID>

      You must provide the ID of the Monitor Agent machine 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.example.com:30443/arcgis --username jdoe --password "my password" --agent-id 28

      $HOME/arcgis/monitor/agent/bin/arcgis-monitor-agent admin:system:register --server-url https://monitorserver.example.com:30443/arcgis --username jdoe --password "my password" --agent-id 28

      A confirmation message appears, indicating that Monitor Agent is registered with Monitor Server.