- URL: https://<servers-url>/<serverID>/update
- Required Capability:Default administrator role | Servers privilege
- Version Introduced:10.4
Description
The update operation modifies the current administrative URL, server role, and server function set for a federated server.
Modify server roles
When modifying server roles, a federated server can either be modified to act as the hosting server for an organization or be updated to enable an access model that controls who has administrative and publisher access to the federated server (FEDERATED_SERVER_WITH_RESTRICTED_PUBLISHING). Hosting servers can also have their hosting status removed to allow for a different federated server to become the hosting server.
Setting the server role as HOSTING_SERVER will set the specified server as the hosting server for the organization. Before a federated server can be elevated to a hosting server, an enterprise geodatabase must first be registered as a managed database with that specific federated server.
Setting the server role as FEDERATED_SERVER_WITH_RESTRICTED_PUBLISHING will immediately restrict access to the federated server to only portal administrators. Portal members that have been assigned publisher privileges cannot access the federated server unless they are added to the publisher-specific group for the federated server or have the publisher-specific item shared to a group they belong to. For more information, see the Fine-grained access control of federated servers section of the Administer a federated server documentation.
Modify server functions
A federated server can be assigned any of the possible server functions as long as the server meets the specific requirements for each functional type.
| Function | Requirements |
|---|---|
| GeoAnalytics | The following requirements must be met to configure a federated server as an ArcGIS GeoAnalytics Server:
|
| RasterAnalytics | The following requirements must be met to configure a federated server as an ArcGIS Raster Analysis Server:
|
| ImageHosting | The following requirements must be met to configure a federated server as an Image Hosting Server (which will host the raster store, all image services created from imagery layers, and host all the distributed image services generated by a configured raster analysis server):
|
| NotebookServer | This server function was introduced at ArcGIS Enterprise 10.8. The following requirements must be met to configure a federated server as an ArcGIS Notebook Server:
|
| MissionServer | This server function was introduced at ArcGIS Enterprise 10.8. The following requirements must be met to configure a federated server as an ArcGIS Mission Server:
|
| WorkflowManager | This server function was introduced at ArcGIS Enterprise 10.8.1.The following requirements must be met to configure a federated server as an ArcGIS Workflow Manager Server:
|
| KnowledgeServer | This server function was introduced at ArcGIS Enterprise 10.9.1. The following requirements must be met to configure a federated server as an ArcGIS Knowledge Server:
|
Modify administrative URLs
Starting at ArcGIS Enterprise 11.2, this operation can be used to modify the administrative URL for a federated server, which is used when performing administrative operations on an internal network. The format of the administrative URL will vary depending on the federated server's assigned functions:
- Use the following format for federated servers assigned the GeoAnalytics, RasterAnalytics, ImageHosting, WorkflowManager, and KnowledgeServer function types:
https://machine.domain.com:6443/arcgis - Use the following format for federated servers assigned the NotebookServer function type t:
https://machine.domain.com:11443/arcgis - Use the following format for federated servers assigned the MissionServer function type:
https://machine.domain.com:20443/arcgis
Request parameters
| Parameter | Details |
|---|---|
| adminUrl | Introduced at 11.2. Modifies the administrative URL for the federated server, which is used when performing administrative operations on an internal network. Use the machine's fully qualified name for the administrative URL. The URL provided must be a URL that the portal can use to communicate with all servers in the site, even when one of them is unavailable. Note:If you use a web adaptor for this URL, ensure that you enabled administrative access to the server through the web adaptor. Example |
| serverRole | Specifies whether the server is a hosting server for the portal, a federated server, or a server with restricted access to publishing. Values: FEDERATED_SERVER | FEDERATED_SERVER_WITH_RESTRICTED_PUBLISHING | HOSTING_SERVER |
| serverFunction | Specifies the functions for the federated server. The server can be assigned any of the values listed below as long as the server meets the requirements for each functional area. Values can be comma separated, but it is recommended that you do not use a single server for multiple server functions. Values: GeoAnalytics | RasterAnalytics | ImageHosting | NotebookServer (Introduced at 10.8) | MissionServer (Introduced at 10.8) | WorkflowManager (Introduced at 10.8.1) | KnowledgeServer (Introduced at 10.9.1) |
| f | The response format. The default response value is html. Values: html | json | pjson |
Example usage
The following is a sample POST request for the update operation:
POST /webadaptor/portaladmin/federation/servers/FfURK2ysFiMjzDkJ/update HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
adminUrl=https://machine.domain.com:11443/arcgis&serverRole=FEDERATED_SERVER&serverFunction=NotebookServer&f=jsonJSON Response example
{
"status": "success",
"serverId": "iSoD09CM73g0tmu9"
}