Skip To Content

Backup utility

In this topic

The Backup utility creates a backup of your ArcGIS Server site configuration. The backup preserves information about your services and settings. It is stored as an .agssite file. Use the Restore utility if you ever need to apply the backup to return your site to its original state.

See Backing up and restoring your ArcGIS Server site configuration to learn more about the backup and restore capabilities of ArcGIS Server.

Parameters

ParameterDetails

-u

The name of an ArcGIS Server user who will execute the utility. The user must have the appropriate level of privileges to execute the action. 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 one of the following formats:

  • http://gisserver.domain.com:6080
  • http://webadaptor.domain.com/arcgis
If your site is configured with web-tier authentication, you'll need to specify the local URL to your site.

-f

The path to a folder where the backup will be placed as an .agssite file. The ArcGIS Server account must have write access to this folder.

-h

Prints help for the utility.

Examples

The following example creates a backup in a folder named mybackups.

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/backup -u admin -p admin -s http://myserver:6080 -f /tmp/mybackups