Skip To Content

ArcGIS Server command line utilities

ArcGIS Server includes utilities that you can use to administer the server from the operating system command line. These are installed as a series of scripts in <ArcGIS Server installation location>/tools/admin. These utilities can be run directly from this location or by referencing the full path to the directory.

With these utilities, you can do the following:

  • Start and stop services
  • Publish services from a service definition (.sd) file
  • Back up or restore a site configuration
  • Define new map caches
  • Build and delete map caches
  • Convert map cache formats from exploded to compact
  • Scan ArcGIS Server for security best practices
Note:

These utilities only support token-based authentication. If your site uses web-tier authentication, you'll need to run these scripts using a built-in account and specify the local URL to your site, as described in the following section.

Common parameters

The parameters described in the following table are used in many of the utilities:

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 is specified with the -u parameter.

-s

The URL of the site, in one of the following formats:

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

Note:

You cannot use https and port 6443 for these utilities. Before running any of them, change your site's protocol settings to HTTP and HTTPS, unless you've already done so.

-h

Prints help for the utility.

These parameters are included in the following example:

Legacy:

If you implemented logic that automates the execution of these utilities, you need to update your scripts to remove the Python dependencies. The following are examples:

  • <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 for correct usage:

<ArcGIS Server installation location>/arcgis/server/tools/admin/manageservice -u admin -p admin -s http://gisserver.domain.com:6080
Note:

The Manage Site utility was deprecated at 10.7.


In this topic
  1. Common parameters