Back up and restore your 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 your 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 <ArcGIS Monitor account username 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's 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.

Note:

If you are restoring Monitor Server to a different environment, it is recommended that you prevent the Monitor Server machine in the new environment from connecting to the Monitor database in the original environment before the restoration.

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. Open a command shell.
5. Run the following command to stop the arcgis-monitor-server service:
   • Ubuntu: sudo service arcgis-monitor-server stop
   • Red Hat Enterprise Linux Server: sudo systemctl stop arcgis-monitor-server
6. Delete the <ArcGIS Monitor account username home directory>/.config/ESRI/ArcGISMonitor/config-store-server directory.
7. Copy the backup of the Monitor Server configuration store to the <ArcGIS Monitor account username home directory>/.config/ESRI/ArcGISMonitor/config-store-server directory.

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

8. Run the following command to start the arcgis-monitor-server service:
   • Ubuntu: sudo service arcgis-monitor-server start
   • Red Hat Enterprise Linux Server: sudo systemctl start arcgis-monitor-server
9. Access Monitor.
10. If you migrated Monitor Server to a different environment, register Monitor Server with the Monitor database in the new environment.

    Caution:

    If you didn't prevent Monitor Server from connecting to the database in the original environment, you must update the database connection settings to connect to the Monitor database in the new environment.

11. Access Monitor to verify the status of the restoration.

    Note:

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

12. 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. Start a terminal session on the Monitor Agent machine.
3. 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 admin:system:status

   For example:

   ./usr/lib/arcgis/monitor/agent/bin/arcgis-monitor-agent admin:system:status

4. 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 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 Agent machine using the --agent-id parameter.

     The following is an example:

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

     A confirmation message appears.