Checking portal diagnostics
Portal for ArcGIS (Linux) includes a diagnostics tool which you can use to check the diagnostics of your portal. For example, the tool allows you to:
- Validate that your machine meets the minimum system requirements to run Portal for ArcGIS.
- Check the state of Portal for ArcGIS, for example, such as validating that all core Portal for ArcGIS services are started.
If any issues are encountered when checking portal diagnostics, the tool will provide a possible cause and solution to the problem.
Running the tool
You'll run the portal diagnostics tool from the command line on the machine hosting Portal for ArcGIS. To run the tool, navigate to the <Portal for ArcGIS installation directory>/arcgis/portal/tools/portaldiag directory in the command line and execute portaldiag.
Keep in mind that you'll need to run this tool as the Portal for ArcGIS installation owner. This is the user who owns the Portal for ArcGIS installation directory. In order for the tool to execute, the installation owner needs at least read and write permissions to the /tmp directory on the machine hosting Portal for ArcGIS.
Interpreting portal diagnostics
After running the tool, a report is generated that contains a summary of all the portal diagnostic checks performed. It also indicates if the checks display a warning, or if they passed, failed, or are not applicable to the system.
Each check is identified with a code formatted DIAG<number> followed by the status of the check performed. For an explanation of each diagnostics check, see the table below. You can use this information to analyze the current state of the machine hosting Portal for ArcGIS.
Check number | Check title | Description |
|---|---|---|
DIAG000 | Check for installation as root | Installing Portal for ArcGIS as root is not supported. This check will fail if Portal for ArcGIS is detected to be installed as root. |
DIAG001 | Check for 64-bit architecture | Portal for ArcGIS is supported only on 64-bit architecture. If the machine is 32-bit architecture, this check will fail. Consult the Portal for ArcGIS System Requirements for supported operating systems. |
DIAG002 | Check OS version | A warning will display if the operating system is not of a supported Linux distribution or version. Consult the Portal for ArcGIS System Requirements for supported Linux platforms and OS versions. If the operating system is not of a supported Linux distribution, all the other checks will not be preformed. |
DIAG003 | Check host name for invalid characters | Valid characters for the host name of the machine hosting Portal for ArcGIS include alphanumeric a–z, 0–9, '-' and '.' characters, as outlined in the RFC 952 specification. The check will fail if the host name contains one or more invalid characters. |
DIAG005 | Check OS patches | An updated libX11 patch that fixes a bug for Red Hat Enterprise Linux 5 Update 7 is required for the proper support of Portal for ArcGIS. If this patch is not installed on Red Hat Enterprise Linux 5 Update 7, the check will return a warning. Consult the Portal for ArcGIS System Requirements for details. |
DIAG016 | Check Portal for ArcGIS ports | Portal for ArcGIS communicates through port 7080. When SSL is enabled, Portal for ArcGIS uses port 7443 by default. Other required ports include 7005, 7654, 7199, and 7099. This check verifies if the required default ports are in use by another user or process. If this check returns a warning, Portal for ArcGIS will not run properly. To correct this issue, open ports 7080, 7005, 7443, 7654, 7199, 7099, and restart Portal for ArcGIS. |
DIAG020 | Check host name IP address mismatches | If the host name entry for the machine in the /etc/hosts file does not match the IP address of the machine, this check will return a warning. This will cause Portal for ArcGIS to function improperly. To correct this issue, fix the host name entry and restart Portal for ArcGIS. |
DIAG026 | Check processes for Portal for ArcGIS core services | The check verifies if all the core services are started after Portal for ArcGIS is started. It returns a warning if one or more core services are not started. To correct this issue, start Portal for ArcGIS by running the startportal.sh script or restart Portal for ArcGIS if it is already running. |
DIAG028 | Check data directory | Portal for ArcGIS requires the dir.data folder specified in <path_to>/portal-config.properties be created and accessible at all times. Portal for ArcGIS also requires that the dir.data folder and its contents have access permission of 700. This check will fail or return a warning if the above requirements are not met. To fix any issues, restart Portal for ArcGIS, as this will re-create the default files and folders as well as reassigning 700 access permission to the dir.data folder and its contents. If restarting Portal for ArcGIS does not fix the issues, make sure the dir.data folder can be created and accessed by the installation owner of Portal for ArcGIS. |