Server administrators often want to preserve periodic backups of their site configurations so that a site can be restored in the event of hardware failure, human error, or other problems. To address this need, ArcGIS Server allows you to make a backup of your site configuration. You make the backups on a regular basis when your site is healthy. If your site has a problem, you can import a backup to restore the site to its original state.
| Information included in the backup | Information not included |
|---|---|
|
|
Protecting information not included in the backup
As noted above, some information is not included in the backup of your site. It's recommended you manually back up this information at the same time you run the backup utility. When you restore the site, manually copy or move this information back to the site, for example:
- Cache tiles and tiling schemes—Back up all directories where your cache tiles are stored (for example, the entire arcgiscache directory under <ArcGIS Server installation directory>/arcgis/server/usr/directories). These directories will contain the cache tiles and the tiling scheme file conf.xml. The cache directories may also contain a file geodatabase status.gdb that contains information about which tiles have been built. When you restore the site, move or copy the information back to the original arcgiscache directory.
- Data used by your services—If the data used by your services was not copied to a folder on the server when publishing, it will not be included in the backup. Manually back up your data directories, geodatabases, databases, source tables, and any other information used by your services. When you restore the site, verify ArcGIS Server has permissions to access your data locations. For more information, see Making your data accessible to ArcGIS Server.
- Log messages—When the site is running, logs are created and distributed among all ArcGIS Server machines participating in your site. If you want to keep messages logged by the site, manually back up the logs directory on each ArcGIS Server machine (for example, <ArcGIS Serverinstallation directory>/arcgis/server/usr/logs). When you restore the site, move or copy the information back to the original logs directory.
- Primary site administrator name and password—After you restore a site, you continue using the primary site administrator name and password that was in place when performing the restore. This is true even if you restore a site whose primary site administrator had been disabled. It's recommended you record the user name and password and store it in a secure location before performing the restore.
- Statistics data—When the site is running, various service statistics are recorded. If you want to keep statistics information logged by the site, manually back up the statistics directory (for example, <ArcGIS Serverinstallation directory>/arcgisserver/directories/arcgissystem/statistics). When you restore the site, move or copy the information back to the original statistics directory.
- ArcGIS Web Adaptor configurations—If your site includes one or more ArcGIS Web Adaptors, you'll need to reconfigure them with your site after performing the restore. For full instructions, see the configuration topic for Java (Linux).
Making a backup of your site
To make a backup, you open a command prompt and run the Backup utility installed with ArcGIS Server. You must supply the name and password of a user who has administrator privileges to the site when running this utility. Your ArcGIS Server account needs write access to the folder where you will place the backup.
You cannot make other administrative changes to your site while the backup is in progress.
Unregistering relational data store types before restoring a site
If the site has registered relational data store types, you must unregister them before performing a restore. Otherwise, the restore will be broken. Please follow the instructions in the REST API help to unregister all relational data store types.
Restoring a backup of your site
Once you have made a backup, you can restore it at any time. Use the following steps to perform a restore:
- If the site has registered relational data store types, you must unregister all of them before proceeding.
- Close ArcGIS Server Manager and any other application on your machine that is making a connection to ArcGIS Server.
- Start a terminal session and run the Restore utility installed with ArcGIS Server.
You must perform the restore using the URL of the ArcGIS Server machine through port 6080 or 6443. The restore operation is not supported through ArcGIS Web Adaptor.
When running this utility, you must supply the credentials of a user who has administrator privileges to the ArcGIS Server site. This doesn't need to be the same user you used when you created the backup.
The restore operation is computationally intensive and can take some time to complete. The server is unavailable to respond to other requests while the restore is running.
Caution:
Do not perform administrative or publishing operations on the site while the restore is running.
When the restore has completed, the response displays messages about anything that may require manual intervention to completely restore. The restore utility provides an optional parameter to write this information to a file.
- Review and fix any issues listed in the response that require manual intervention.
- If your site included a Web Adaptor, the Web Adaptor will be reconfigured after the site is restored.
- If your site has registered relational data store types after restoring, you must restart ArcGIS Server on each machine in your site by running the stopserver/startserver scripts as the owner of ArcGIS Server. These scripts are located at the $AGSHOME directory.
After you restore a site, you continue using the primary site administrator name and password that was in place when you performed the restore. If you edited the security configuration or added users and roles at any time after you saved the backup, you must make those edits again once the restore is complete.
You may also need to adjust machine settings in your site. For example, if you added machines at any time after you saved the backup, you must add those machines again once the restore is complete.