As an administrator of your organization or member with the correct privileges, you can federate a server site with your ArcGIS Enterprise portal and designate federated servers for certain server licensing roles from the Organization tab.
Learn more about using your portal with ArcGIS Server
- Make sure the TLS certificate in the administration URL is trusted by your portal or contains the URL hostname.
When federating an ArcGIS Server, the TLS certificate used in the administration URL must either be fully trusted by your portal or contain the URL hostname as either the common name (CN) or subject alternative name (SAN). If either of these conditions is not met, the federation process will fail.
An example scenario would be an administration URL that uses a wildcard certificate signed by a certificate authority that is not well-known, like a domain CA. As the URL hostname is typically not included as a SAN in a wildcard certificate, your portal must trust the CA that signed the certificate. As a result, the root, and intermediate certificate if it exists, needs to be imported into your portal before federating.
- Sign in to the ArcGIS Enterprise portal website as a default administrator or custom role with administrative privileges to manage server settings.
You must connect to the website through the Web Adaptor URL (such as https://webadaptorhost.domain.com/webadaptorname/home). Do not use the internal URL on port 7443.
- Click Organization at the top of the site and click the Settings tab.
- Click Servers on the left side of the page.
Add a server site
To federate a server with your portal, complete the following steps to add a server site:
- Click Add server site.
- On the Federate server site page that appears, provide the following information:
- Services URL—The URL used by external users when accessing the server site composed of a scheme, host, and single-level context. If the site includes the Web Adaptor, the URL includes the Web Adaptor address, for example, http://webadaptorhost.domain.com/webadaptorname. If you've added ArcGIS Server to your organization's reverse proxy server, the URL is the reverse proxy server address (for example, http://reverseproxy.domain.com/myorg). If your organization requires HTTPS for all communication, use https instead of http. Note that the federation operation will perform a validation check to determine whether the provided Services URL is accessible from the server site. If the resulting validation check fails, a warning will be generated in the Portal for ArcGIS logs. However, federation will not fail if the Services URL is not validated, as the URL may not be accessible from the server site, such as is the case when the server site is behind a firewall.
- Administration URL—The URL used for accessing the server site when performing administrative operations on the internal network. The format of the Administration URL depends on the type of server being added to your portal:
- GIS, Image, Workflow Manager, GeoAnalytics, or Knowledge Server: https://server.domain.com:6443/arcgis
- Notebook Server: https://notebookserver.domain.com:11443/arcgis
- Mission Server: https://missionserver.domain.com:20443/arcgis
Note:
If you federate with a multimachine site or highly available ArcGIS Server, or if your ArcGIS Server is hosted in a cloud environment, use the Web Adaptor or load balancer URL in this field instead. The Administration URL setting must be a URL that the portal can use to communicate with all servers in the site, even when one of them is unavailable. If you use a Web Adaptor for this URL, ensure that you have enabled administrative access to the server through the Web Adaptor.
- Username—The user name of the primary site administrator account that was used to initially sign in to and administer the server site. If this account is disabled, you'll need to reenable it.
- Password—The password of the primary site administrator account.
- Click Next to federate your server site.
Note:
Federating the server site may take some time to complete.
- Optionally, on the Configure server role page, use the toggle button to select the server role you want to configure on your federated server site. You can configure multiple server roles on your server site as long as the site meets the requirements for the server role. If requirements are not met, click Requirements missing for more information or review the requirements for the desired server role. If you do not wish to configure a server role, you can skip this step by clicking Done. You can configure a server role at a later time using the configure server role option on a federated server site.
- Click Save server role.
The server site has been federated with your portal and, if selected, configured with a server role or roles. The server site will be listed in the Federated server sites section of the Servers page.
Manage a server site
You can perform actions to manage a federated server site, such as update the alias, configure a server role, view licenses, and validate the server site.
Edit server name
You can provide a user-friendly alias to help identify your federated server site by clicking the Edit button next to the server name and entering a new name. Click Save to update the server name.
Note:
This name is used for display purposes only and updating it will not modify the URLs associated with your server site.
Configure server role
To configure a server role on a server site, locate the site in the federated server sites list and open the Configure server role window by doing one of the following:
- Next to Server role, click the current server role or Configure server role if no role is currently assigned.
- Click the More options button and select Configure server role.
The above options open the Configure server role window. Use the toggle buttons to select the server role or roles you want to configure or remove on your federated server site. You can configure multiple server roles on your server site as long as the site meets the requirements for each role. If requirements are not met, click Requirements missing for more information or review the requirements for the desired server role. Click Save to configure or remove the selected server role or roles.
View licenses
You may view the licensed roles, extensions, and associated expiry dates authorized on a server site. Click the More options button and select View licenses.
Validate server site
You can validate a server site to verify the status of your server. Click the More options button and select Validate server site. You can also validate all federated server sites by clicking the Validate server sites button above the list of servers. A general status message appears in the Status row for the server sites being validated. Hover over the status message to view additional information.
Server roles
You can configure your server site with the following server roles to add functionality to your portal.
Hosting Server
You can designate a server site licensed as an ArcGIS GIS Server site to serve as your hosting server. A hosting server allows you to publish hosted layers, add files to the portal's Map Viewer Classic, and perform feature and raster analysis in Map Viewer Classic and ArcGIS Pro. To be configured as your hosting server, the server site must have a relational type of ArcGIS Data Store registered as its managed database.
When a hosting server is configured with your portal, it is automatically used for standard feature analysis in Map Viewer Classic and ArcGIS Pro.
The requirements for configuring a server site as a Hosting Server are as follows:
- The hosting server must be licensed as an ArcGIS GIS Server at the Standard or Advanced edition.
- A relational data store must be configured with the server site.
Note:
Once a hosting server has been set, it cannot be changed through the portal website. To remove the hosting server role, you must update the server role in the Portal Administrator Directory. For instructions, see Update Server in the ArcGIS REST API help.
GeoAnalytics Server
If you have a server site licensed as an ArcGIS GeoAnalytics Server site, you can designate it to perform your portal's GeoAnalytics Tools feature analysis here.
The requirements for configuring a server site as a GeoAnalytics Server are as follows:
- The GeoAnalytics Server must be licensed for ArcGIS GeoAnalytics Server.
- A hosting server must be configured with the portal.
- A spatiotemporal big data store must be configured with the hosting server.
Learn about the differences between standard and GeoAnalytics Tools
Raster Analysis Server
If you have a server site licensed as an ArcGIS Image Server site, you can designate it to perform your portal's raster analysis. Raster analysis in ArcGIS Enterprise is designed to use distributed processing across machines with ArcGIS Image Server.
The requirements for configuring a server site as a Raster Analysis Server are as follows:
- The Raster Analysis Server must be licensed for ArcGIS Image Server.
- A hosting server must be configured with the portal.
- A raster store must be configured with the server site.
Learn more about setting up raster analysis in ArcGIS Enterprise
Image Hosting Server
If you have a server site licensed as an ArcGIS Image Server site, you can designate it to serve as your portal's Image Hosting Server here. The Image Hosting Server hosts your raster store, all the image services created from imagery layers, and if a Raster Analysis Server is configured, all the distributed image services generated by your Raster Analysis Server.
The ideal configuration for raster analysis includes at least two ArcGIS Image Server sites—a Raster Analysis Server and an Image Hosting Server—in addition to your portal's hosting server. If your organization does not have those resources available, a single ArcGIS Image Server site can be used for both raster analysis and image hosting.
The requirements for configuring a server site as an Image Hosting Server are as follows:
- The Image Hosting Server must be licensed for ArcGIS Image Server.
- A hosting server must be configured with the portal.
- A file share raster store, or a database raster store AND a cloud store raster store, must be configured with the server site.
Notebook Server
If you have a server site licensed as an ArcGIS Notebook Server site, designate it as the portal's notebook server here. Clicking the server URL takes you to its ArcGIS Notebook Server Manager site in the portal, which was introduced in 10.8.
When an ArcGIS Notebook Server site is configured, a Notebook tab appears on the top ribbon of your portal website. Clicking this tab opens a new ArcGIS Notebook in the portal notebook editor.
The requirements for configuring a server site as a Notebook Server are as follows:
- This must be an ArcGIS Notebook Server site.
- A hosting server must be configured with the portal.
Mission Server
If you have a server licensed with ArcGIS Mission Server, designate it as the portal's mission server here. ArcGIS Mission Server facilitates communication between ArcGIS Mission Manager and ArcGIS Mission Responder.
The requirements for configuring a server site as a Mission Server are as follows:
- This must be an ArcGIS Mission Server site.
- A hosting server must be configured with the portal.
Workflow Manager Server
If you have a server licensed with ArcGIS Workflow Manager, designate it as the portal's Workflow Manager Server here. Setting up a Workflow Manager Server and licensing it with the user type extension enables access to the Workflow Manager services and the Workflow Manager web app that is integrated with the ArcGIS Enterprise portal.
The requirements for configuring a server site as a Workflow Manager Server are as follows:
- This must be an ArcGIS Workflow Manager site.
- A hosting server must be configured with the portal.
Knowledge Server
If you have a server site licensed as an ArcGIS Knowledge Server site, designate it as the portal's knowledge server here. Setting up a Knowledge Server allows your members to use ArcGIS Pro with ArcGIS Enterprise to create knowledge graphs.
The requirements for configuring a server site as a Knowledge Server are as follows:
- This must be an ArcGIS Knowledge Server site.
- A hosting server must be configured with the portal.
- A graph store must be configured with the server site.