Hardware Configuration

URL:: https://<notebookserveradmin>/machines/<machine>/hardware
Methods:: GET
Required Capability:: Administrator
Version Introduced:: 10.7

Description

This resource displays hardware information for the machine in your ArcGIS Notebook Server site. It updates the information when it detects any change to the configuration of your machine, as well as each time the machine is restarted.

Request parameters

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

Response properties

Property	Details
CPU (`cpu` )	The specifications of the machine's central processing unit (CPU).
OS (`os` )	The current operating system of the machine.
System Memory (in MB) (`systemMemoryMB` )	The amount of system memory in megabytes.
System Memory Available (in MB) (`systemMemoryAvailableMB` )	The amount of system memory available in megabytes. Note This property was added in ArcGIS Notebook Server 10.7.1.
Number of Processors (Physical) (`numPhysicalProcessors` )	The number of physical cores in the CPU.
Number of Processors (Logical) (`numLogicalProcessors` )	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.
Drive mount (`mount` )	The mount folder path for the drive.
Total Disk Space (GB) (`diskTotalSpace` )	The total disk space. The values returned for this property are in GB.
Total Usable Space Remaining (GB) (`diskUsableSpace` )	The total amount of usable disk space. The values returned for this property are in GB.
Exceeds Disk Space Threshold (`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` Note This property was added in ArcGIS Notebook Server 10.9.

JSON Response syntax

Use dark colors for code blocksCopy
{
  "cpu": "<Specification of CPU>",
  "os": "<Operating system of machine>",
  "systemMemoryMB": <long integer>,
  "numPhysicalProcessors": <integer>,
  "numLogicalProcessors": <integer>,
  "systemMemoryAvailableMB": <integer>
  "localDiskUsage": [
    {
      "diskTotalSpace": <integer>,
      "diskUsableSpace": <integer>,
      "exceededDiskSpaceThreshold": <boolean>,
      "mount": "<mount location path>",
    }
  ]
}

JSON Response example

Response example for a Linux machine where the disk space threshold (diskSpaceThresholdGB ) system property is set to 10 GB :

Use dark colors for code blocksCopy
{
  "numLogicalProcessors": 4,
  "systemMemoryAvailableMB": 11770,
  "os": "GNU/Linux Ubuntu 18.04.3 LTS (Bionic Beaver) build 4.15.0-55-generic",
  "cpu": "Intel(R) Xeon(R) CPU E5-2698 v4 @ 2.20GHz\n 4 physical CPU package(s)\n 4 physical CPU core(s)\n 4 logical CPU(s)\nIdentifier: Intel64 Family 6 Model 45 Stepping 2\nProcessorID: 0F81FBFF002006D2",
  "systemMemoryMB": 15032,
  "numPhysicalProcessors": 4,
  "localDiskUsage": [
    {
      "diskTotalSpace": 9,
      "diskUsableSpace": 6,
      "exceededDiskSpaceThreshold": true,
      "mount": "/"
    },
    {
      "diskTotalSpace": 206,
      "diskUsableSpace": 181,
      "exceededDiskSpaceThreshold": false,
      "mount": "/data"
    }
  ]
}

Response example for a Windows machine:

Use dark colors for code blocksCopy
{
  "numLogicalProcessors": 8,
  "systemMemoryAvailableMB": 6381,
  "os": "Microsoft Windows Server 2016 build 17763",
  "cpu": "Intel(R) Xeon(R) CPU E5-1620 v3 @ 3.50GHz",
  "systemMemoryMB": 16306,
  "numPhysicalProcessors": 4,
  "localDiskUsage": [
    {
      "diskTotalSpace": 235,
      "diskUsableSpace": 95,
      "mount": "C:\"
    }
  ]
}