Update Notebook Server Properties

properties

The JSON object containing the server properties.

f

The response format. The default response format is html .

Values: html | json | pjson

applyDefaultUserWorkspacePermissions

New at 10.7.1. This property applies to Linux machines only. If set to true , the system reverts to using the OS default permission settings when creating users' private workspace directories. The default is false . If you set this property to true , the OS user running the ArcGIS Notebook Server daemon must have a UID of 1050 and a GID of 100 to match that of the container user. See Configure ArcGIS Notebook Server directories for more information.

containerCreatedThreshold

The time (in minutes) after which an empty container is closed automatically. The default is 60 (1 hour).

containersStartPort

The lowest ephemeral port that containers in the site can use for communication with the server.

allowHiddenFileDownloads

By default, hidden files—files that have names starting with a dot (.)—stored in a user's workspace cannot be downloaded using the data access download API. Set this property to true to allow the owner of those files to download them.

asyncJobsCleanIntervalHours

New at 10.9. By default, the async job cleanup process runs once every 6 hours. Using this property, administrators can set custom intervals to clean up jobs.

The async job cleanup process runs once in the specified time (in hours). It only cleans up jobs that are older than 6 hours (this default age can be changed using the asyncJobsCleanupAgeHours property).

Only jobs in completed or failed states are cleaned up.

The value is 6 hours and is not present in System Properties.

To override the default setting, provide an appropriate integer value.

asyncJobsCleanAgeHours

New at 10.9. This property controls the age (in hours) at which jobs are cleaned up. By default, jobs that are 6 hours or older are cleaned up. Administrators can set custom ages (in hours) that a job must be before it is cleaned up.

The default value is 6 hours and is not present in System Properties.

To override the default setting, provide an appropriate integer value.

containersStopPort

The highest ephemeral port that containers in the site can use. Containers will open on ports between this value and the containersStartPort value.

containerNetworkName

New at 11.2 This property enables ArcGIS Notebook Server to use a specific network with interactive and scheduled notebook containers.

To use this system property, you must first create a container network using the following command: docker network create -d bridge|nat <network-name> .

Example:

1
{"containerNetworkName" : "my-network"}

ArcGIS Notebook Server will use the default bridge network when this property is not specified.

disableServicesDirectory

New at 10.8.1. If true , HTML access to the REST Services Directory is disabled for ArcGIS Notebook Server.

diskSpaceThresholdGB

New at 10.8. The threshold of remaining available disk space after which ArcGIS Notebook Server logs messages about low disk space. The default is 5 GB.

dockerConnectionHost

The host name the Docker component uses to communicate with the site. The default is localhost .

dockerConnectionPort

The port the server site uses to communicate with its Docker component.

dockerExtraHosts

New at 11.0. Pass specific portal IP addresses or portal host names in a JSON array that will be added to the etc/hosts file of the container.

If you encounter a connection error while running a notebook cell that includes gis = GIS("home"), it may be due to the ArcGIS Notebook Server container's failure to resolve the portal's DNS name. In such cases, you can configure the dockerExtraHosts property.

Example

1
2
3
4
5
6
7
{
  "dockerExtraHosts": [
      { "hostname" : "portal.domain.com",
        "ip" : "12.34.56.78"
      }
   ]
}

exportTempDirectory

(Optional)

A directory that will be used as a temporary location during the exportSite operation prior to copying the exported file (.agssite ) to the final location specified in the export site request.

idleNotebookThreshold

The time (in minutes) after which idle notebooks are closed automatically. The default is 720 (12 hours).

jsapiCDN

Updates the default JSAPI URL used in a notebook by the ArcGIS API for Python and map widgets.

Example

1
"jsapiCDN": "jsapiCDN": "https://portal-domain.com/portal/jsapi/jsapi4/"

Example

1
"jsapiCDN": https://my.disconnected-domain.com/arcgis_js_v424_api/arcgis_js_api/javascript/4.24/

maxContainersPerNode

The maximum number of user-opened containers that can be simultaneously active per machine, assuming the machine has the necessary CPU and memory resources to support the containers. Containers opened by the executeNotebook operation do not count toward this limit.

maxExecuteNotebookContainersPerNode

The maximum number of containers opened through the remote executeNotebook operation that can be simultaneously active per machine. The default value is 10. This limit applies to notebooks opened through scheduled tasks, webhooks, web tools, and the executeNotebook API.

maxExecuteNotebookTimeMinutes

The maximum amount of time (in minutes) that a notebook web tool or a notebook run through a web hook or executeNotebook operation can take to complete. If any of these operations runs this long, it will be terminated. The default value is 120 minutes (2 hours).

maxSnapshotsPerNotebookItem

New at 10.9. The maximum number of snapshots allowed for a notebook. The default value is 5.

useWindowsContainers

Introduced at 11.1. This property applies to Windows machines only. It specifies whether the notebook server will use a Windows container-based notebook run time or a Linux container-based notebook run time. The default value is false for notebook server installations on Windows Server 2019 and true for notebook server installations on Windows Server 2022. For a notebook server upgraded from previous versions, the default value is false .

Values:true | false

WebContextURL

The web URL users see.

Example

1
https://mydomain.com/gis

webSocketSize

The maximum packet size (in megabytes) that can be sent by WebSocket communication with the server site. The default is 16 MB.