ArcGIS REST API

Edit Machine

  • URL:https://server:port/arcgis/admin/machines/<machine>/edit(POST only)
  • Required Capability:Administrator
  • Version Introduced:10.1

Description

This resource allows you to make changes to the configuration of the specified machine in your ArcGIS Server site.

Note:

Editing the machine configuration causes the machine to be restarted. It's recommended that you perform this operation during low usage.

Parameters

ParameterDescription
adminURL

The URL where the Administrator API is running on the server machine. Example: https://<machineName>:6443/arcgis/admin

Caution:

It is recommended that you keep the default URL.

webServerMaxHeapSize

This property defines the maximum file size (in MB) that the web server's Java process can send to ArcGIS Server. The default value is -1 MB, meaning the web server will use one-fourth of the available system memory as the maximum heap size.

If you are observing a server performance impact and you have additional system memory, you can increase the heap size of the web server by updating this value from the default of -1 MB to an appropriate value. Note that doing so will potentially increase the amount of memory assigned to ArcGIS Server processes by your operating system.

webServerCertificateAlias

The alias of the web server SSL certificate.

appServerMaxHeapSize
Note:

This property has no utility in 10.6 and later versions, due to changes in the application server at 10.6.

This property defines the maximum file size that the internal application server's Java process can send to ArcGIS Server. The default value is 256 MB.

socMaxHeapSize

This property defines the maximum file size (in MB) that an individual ArcSOC process can send to the ArcGIS Server internal web server. The default value is 64 MB.

A related property is webServerMaxHeapSize, which limits the overall file size that the web server can in turn send to the ArcGIS Server site.

You may choose to increase this property if you are experiencing performance impacts in your services - for example, if a service is failing to pass a very large JSON file to the server site.

If you only want to change the maximum heap size for a specific service, you can do so by specifying the javaHeapSize framework property in the Edit Service operation.

underMaintenance

This property is a flag you can use to designate the machine as being under maintenance (by you, not by the ArcGIS Server site itself). The default value is false.

When set to true, this causes the machine to "fail" its regular health check report. You can implement logic in your third-party load balancer or reverse proxy server to avoid forwarding service requests to machines that fail the health check. Administrative and publishing requests will still be sent to the machine by the ArcGIS Server site.

This allows you to make changes to the machine (such as updating its OS) without causing service requests to fail.

When you are done, change this property back to false.

<ports>
Note:

Prior to 10.7, ArcGIS Server used ports 4000 through 4003 for intermachine communication, with ports named OpenEJBPort, JMXPort, NamingPort, and DerbyPort. These ports were provided in the Ports section of the Machine resource. They are no longer used at 10.7, so this list is empty.

The names of the intermachine communication ports used by ArcGIS Server and their corresponding port value.

f

The response format. The default response format is html.

Values: html | json

Example usage

https://server:port/arcgis/admin/machines/SERVER1.DOMAIN.COM/edit
adminURL=https://SERVER1.DOMAIN.COM:port/arcgis/admin
webServerMaxHeapSize=-1
webServerCertificateAlias=server1
socMaxHeapSize=64
underMaintenance=false
f=html

JSON response

{"status": "success"}