Skip To Content

Migrate services with the UpdateArcMapServices utility

Starting with the ArcGIS 2022 releases, future versions of ArcGIS Server will no longer support the ArcMap service runtime. Only services using the ArcGIS Pro service runtime will be supported, both for newly published services and existing services on an upgraded server site.

It is recommended that you migrate, republish, or remove all services that use the ArcMap service runtime prior to upgrading to ArcGIS 2022 and later releases. ArcGIS Enterprise 10.9 offers multiple options to prepare for this upcoming change.

Learn more about migrating services

A new command line utility, UpdateArcMapServices, allows you to automate a bulk migration of your GIS services. The utility offers two modes: In analysis mode, you can assess which services in your site are ready to be migrated to the ArcGIS Pro service runtime. Then, in execution mode, you can migrate all eligible services at once. Service runtime migration won't affect the content or settings of your services.

Prerequisites to migrate a service runtime

The UpdateArcMapServices utility can migrate the following types of services:

  • Map services
  • Feature services
  • Image services
  • WMS services
  • WCS services
  • WFS services
  • Network Analysis services
Note:

Hosted services are not supported for migration.

While the utility allows you to migrate more additional service types than the Edit Runtime operation in ArcGIS Server Manager does, there are still limitations to which services can be migrated to the ArcGIS Pro service runtime. When you run the utility in analysis mode, the result window categorizes ineligible services based on their reason for ineligibility:

Only services published from ArcMap are analyzed. (Services originally published from ArcGIS Pro cannot be migrated to the ArcMap service runtime.)

Service instances

The ArcGIS Pro service runtime supports both dedicated and shared instance types for map services. Therefore, during the migration process, the utility assigns an instance type to each migrated map service. This is based on the default instance type setting on your ArcGIS Server site.

Ensure you consider the implications of this before migrating services. For example, if your ArcGIS Server site's default instance type is shared instances, and you're preparing to migrate a service that receives heavy traffic, consider editing the service to use dedicated instances after migration to ensure it has adequate resources.

Learn more about configuring service instance settings

Access the command line utility

The migration utility is hosted in the <ArcGIS Server installation location>/tools/UpdateArcMapServices folder on your ArcGIS Server machine. You can run the UpdateArcMapServices.sh file directly from this location or by referencing the full path to the directory.

When you run the UpdateArcMapServices utility in either mode, an HTML page opens to display tool results. Both modes display counts of the services that are eligible or currently ineligible to be migrated. In execution mode, logs relating to the migration operation are displayed, as well as a count of the services that have successfully been migrated to the ArcGIS Pro service runtime.

Parameters

The utility supports the following input parameters:

ParameterDescription

-m, --mode

Specify the mode in which you want the tool to run: analysis mode (the default) assesses and displays the services that are currently eligible and ineligible to be migrated, while execution mode proceeds to migrate all eligible services to the ArcGIS Pro service runtime.

-o, --output

Define the directory to which the tool report file will be generated. If undefined, the tool generates its report to a temporary directory.

-u, --username

If your site's Primary Site Administrator (PSA) account is unavailable, specify an account username for a server administrator or (if the server is federated) a portal administrator.

-h, --help

Prints help for the utility.

Example usage

A GIS administrator wants all their organization's services to use the ArcGIS Pro service runtime. The administrator opens the command line and accesses the tool directory using the following command:

cd <ArcGIS Server installation location>/arcgis/server/tools/UpdateArcMapServices

To first obtain a list of the eligible and ineligible services, the administrator runs the tool in analysis mode. Because they intend to share this list with colleagues, the administrator specifies a different output location.

UpdateArcMapServices.sh -m analysis -o /Home/SharedDocs

The tool runs and determines that five of the services in the ArcGIS Server site are currently ineligible for migration. The GIS staff works to remove the incompatible elements of those services. When it's determined that a service cannot be made eligible for migration, they begin re-authoring it into ArcGIS Pro to be republished.

When the site is ready, the administrator next runs the tool in execution mode.

UpdateArcMapServices.sh -m execution

During the tool execution, the administrator monitors the HTML results page to view the logs for each migration task. When the tool completes, each eligible service has successfully been migrated to the to the ArcGIS Pro service runtime.