Skip To Content

Restore utility

In this topic

This utility restores your site configuration based on a backup that you have previously made using the Backup utility. See Backing up and restoring your ArcGIS Server site configuration to learn about the backup and restore capabilities of ArcGIS Server.

This utility always uses token-based authentication.

Parameters

ParameterDetails

-u

The name of an ArcGIS Server user who will execute the utility. This doesn't need to be the same user who created the backup. If your site is configured with web-tier authentication, specify a built-in user, such as the primary site administrator account.

-p

The password of the user who was specified with the -u parameter.

-s

The URL of the site, in the following format:

  • http://gisserver.domain.com:6080
You cannot perform the restore through the ArcGIS Web Adaptor URL.

-f

The absolute path of the .agssite backup file to be restored. The ArcGIS Server account must have permission to read from this location.

-r

Path to a folder where the utility will generate its report. The ArcGIS Server account must have write permissions to this folder. The report is always written to the console, regardless of whether you provide this path.

-h

Prints help for the utility.

Examples

The following example restores a backup from a file named Jan-24-2013_13-25-23.agssite.

Legacy:

At 10.2.2 and earlier versions, you were required to reference the Python directory and Python extension (.py) when executing the utilities from the command line. At 10.3, this is no longer required. You can run the utilities directly from the command line without referencing these Python dependencies.

If you implemented logic that automates the execution of these utilities, you need to update your scripts to remove the Python dependencies, for example:

  • <ArcGIS Server installation location>/arcgis/server/tools/python
  • The .py extension when referring to the name of the command line utility

See the following example below for correct usage:

<ArcGIS Server installation location>/arcgis/server/tools/admin/restore -u admin -p admin -s http://gisserver.domain.com:6080 -f /tmp/mybackups/Jan-24-2013_13-25-23.agssite -r /tmp/mybackups