Hardware

URL:: https://<root>/machines/<machine>/hardware
Methods:: GET
Version Introduced:: 11.3

Access requirements

Required privileges

The Portal Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.

Security and Infrastructure

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Portal Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Portal Directory API. For security reasons, all POST requests made to the Portal Administrator API must include a token in the request body.

Learn how to generate a token

Description

The hardware resource returns information related to the hardware on a specific portal machine, including the CPU and core information, memory usage, and disk usage.

Request parameters

Parameter	Details
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

Response properties

Property	Details
`osInformation`	The machine's operating system.
`cpuInformation`	The specifications of the machine's central processing unit (CPU).
`systemMemory`	The amount of system memory (in MB).
`systemMemoryAvailable`	The amount of available system memory (in MB).
`physicalProcessorCount`	The number of physical cores in the CPU.
`logicalProcessorCount`	The number of logical cores in the CPU. This value is the number of physical cores multiplied by the number of threads each core can run via hyperthreading.
`localDiskUsage`	The disk usage information for Portal for ArcGIS. This property lists the mount, disk space, and path of each directory. The table below outlines each of the properties included in `localDiskUsage`.

Properties for localDiskUsage

Property	Details
`mount`	The the drive or partition the directory is on. If it's a Windows share, this will be represented as `N/A`.
`diskTotalSpaceGB`	The total amount of disk space on the drive (in GB).
`diskUsableSpaceGB`	The amount of usable space on the drive (in GB).
`exceededDiskSpaceThreshold`	Determines whether the available disk space on the drive is less than the value set by the diskSpaceThresholdGB property. If the `diskSpaceThresholdGB` is not defined as part of the system properties, the threshold is 5GB. If the available disk space is less than the threshold value (either set by the system property or the default of 5GB), this property will return as `true`, indicating that additional space may need to be made available on those drives. Values: `true` \| `false`
`directory`	The directory type. Note The content directory will not be included in the response if the deployment uses cloud storage. Values: `TEMP` \| `CONTENT` \| `INSTALL` \| `INDEX` \| `DB`
`path`	The directory path.

Example usage

The following is a sample request URL used to access the hardware resource:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/portaladmin/machines/MACHINE.EXAMPLE.COM/hardware?f=pjson

JSON Response example

Use dark colors for code blocksCopy
{
  "osInformation": "GNU/Linux Oracle Linux Server 8.9 (unknown) build 5.4.17-2136.328.3.el8uek.x86_64",
  "cpuInformation": "Intel(R) Xeon(R) Gold 6252 CPU @ 2.10GHz\n 2 physical CPU package(s)\n 2 physical CPU core(s)\n 2 logical CPU(s)\nIdentifier: Intel64 Family 6 Model 45 Stepping 2\nProcessorID: 0F8BFBFF000206D2\nMicroarchitecture: Sandy Bridge (Server)",
  "systemMemory": 14698,
  "systemMemoryAvailable": 9202,
  "physicalProcessorCount": 2,
  "logicalProcessorCount": 2,
  "localDiskUsage": [
    {
      "mount": "/data",
      "diskTotalSpaceGB": 185,
      "diskUsableSpaceGB": 141,
      "exceededDiskSpaceThreshold": false,
      "directory": "TEMP",
      "path": "/data/arcgis/portal/usr/arcgisportal/temp"
    },
    {
      "mount": "/data",
      "diskTotalSpaceGB": 185,
      "diskUsableSpaceGB": 141,
      "exceededDiskSpaceThreshold": false,
      "directory": "CONTENT",
      "path": "/data/arcgis/portal/usr/arcgisportal/content"
    },
    {
      "mount": "/data",
      "diskTotalSpaceGB": 185,
      "diskUsableSpaceGB": 141,
      "exceededDiskSpaceThreshold": false,
      "directory": "INSTALL",
      "path": "/data/arcgis/portal/"
    },
    {
      "mount": "/data",
      "diskTotalSpaceGB": 185,
      "diskUsableSpaceGB": 141,
      "exceededDiskSpaceThreshold": false,
      "directory": "INDEX",
      "path": "/data/arcgis/portal/usr/arcgisportal/index"
    },
    {
      "mount": "/data",
      "diskTotalSpaceGB": 185,
      "diskUsableSpaceGB": 141,
      "exceededDiskSpaceThreshold": false,
      "directory": "DB",
      "path": "/data/arcgis/portal/usr/arcgisportal/db"
    }
  ]
}