Skip To Content
ArcGIS Developer
Dashboard

Register Machine

Description

This operation registers a server machine with the site. The server machine must have ArcGIS Server software installed and authorized. Registering machines this way is a "pull" approach to growing the site and is a convenient way when a large number of machines need to be added to a site. In contrast, a server machine can choose to join a site.

Note:

If you are adding more than one machine to your site, then your server directories and configuration store must be directories on a shared file system.

If your site has registered Relational Data Store Types and more machines are added, you must completely restart ArcGIS Server on each newly registered machine. To do this, you need to restart the Windows Service or use the stopserver/startserver scripts on Linux.

Note:

At 10.9.1, when installing ArcGIS Server you will have the option to disable the ArcMap service runtime, removing Python 2.x from your deployment. Attempting to register a server machine that has a conflicting ArcMap runtime status to the site will result in an error. For example, if the existing site has the ArcMap runtime disabled, and the server machine to be registered has the ArcMap runtime enabled, this operation will fail. For more information, see the JSON Response examples section below.

Request parameters

ParameterDescription
machineName

The name of the server machine that needs to be registered with the site. This server machine must have ArcGIS Server software installed and authorized.

Example

machineName=MACHINE2.DOMAIN.COM
adminURL

The URL where the Administrator API is running on the server machine.

Example

adminURL=https://machine.domain.com:6443/arcgis/admin
f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

Below is a sample POST request for register:

POST /webadaptor/admin/machines/register HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

machineName=MACHINE2.DOMAIN.COM&adminURL=https://machine.domain.com:6080/server/admin&f=json

JSON Response examples

The following is a sample success response for the register operation, indicating that the machine has been registered successfully with the site.

{
  "status": "success"
}

The following error response is returned when an attempt is made to register a machine with a conflicting ArcMap runtime status than that of the existing site:

{
  "status": "error",
  "messages": ["Failed to join the site 'https://SERVERSITE.DOMAIN.COM:6443/arcgis/admin'. The state of the ArcMap Runtime Support feature configured on machine 'serverMachine.domain.com' does not match site running at 'https://SERVERSITE.DOMAIN.COM:6443/arcgis/admin'. All machines in a site are required to have the same ArcMap Runtime Support configuration. Information on how to resolve this issue is available in the help topic 'About multiple-machine ArcGIS Server sites'."],
  "code": 500
}