Update Notebook Server Properties

URL:: https://<notebookserveradmin>/system/properties/update
Methods:: POST
Required Capability:: Administrator
Version Introduced:: 10.7

Description

This operation allows you to update the server properties. The update operation overwrites all existing properties and restarts the site.

Request parameters

Parameter Details

Parameter	Details
`properties`	The JSON object containing the server properties.
`f`	The response format. The default response format is `html` . Values: `html` \| `json` \| `pjson`

properties

The JSON object containing the server properties.

f

The response format. The default response format is html .

Values: html | json | pjson

Server properties

Parameter	Details
`applyDefaultUserWorkspacePermissions` (Linux only)	Introduced at 10.7.1. 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. Example Use dark colors for code blocksCopy `1 "applyDefaultUserWorkspacePermissions": "false"`
`containerCreatedThreshold`	Specifies the time (in minutes) after which an empty container is closed automatically. The default is 60 (one hour). Example Use dark colors for code blocksCopy `1 "containerCreatedThreshold": 60`
`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>` . Note If ArcGIS Notebook Server is installed on multiple machines, ensure that a network with the same name is made on each notebook server machine. Example: Use dark colors for code blocksCopy `1 {"containerNetworkName" : "my-network"}` ArcGIS Notebook Server will use the default bridge network when this property is not specified. Warning On Linux, the loopback IP address must be configured to be the local host, for example,127.0.0.1 localhost. If it contains the host name, GIS("home") requests in a notebook will fail.
`containerStartPort`	The lowest ephemeral port that containers in the site can use for communication with the server. Example Use dark colors for code blocksCopy `1 "containersStartPort": 30001`
`containerStopPort`	The highest ephemeral port that containers in the site can use. Containers will open on ports between this value and the `containersStartPort` value. Example Use dark colors for code blocksCopy `1 "containersStopPort": 31000`
`diskSpaceThresholdGB`	Introduced at 10.7.1. The threshold of remaining available disk space after which ArcGIS Notebook Server will log messages about low disk space. The default is 5 GB. Example Use dark colors for code blocksCopy `1 "diskSpaceThresholdGB": 5`
`dockerConnectionHost`	The host name the Docker component will use to communicate with the site. The default is `localhost` . Example Use dark colors for code blocksCopy `1 "dockerConnectionHost": localhost`
`dockerConnectionPort`	The port through the server site will use to communicate with its Docker component. Example Use dark colors for code blocksCopy `1 "dockerConnectionPort": 2375`
`idleNotebookThreshold`	The time (in minutes) after which idle notebooks are closed automatically. The default is 1440 (24 hours). Example Use dark colors for code blocksCopy `1 "idleNotebookThreshold": 1440`
`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. Example Use dark colors for code blocksCopy `1 "maxContainersPerNode": 20`
`maxExecuteNotebookContainersPerNode`	Introduced at 10.8. The maximum number of containers opened through the remote `executeNotebook` operation that can be simultaneously active per machine. Example Use dark colors for code blocksCopy `1 "maxExecuteNotebookContainersPerNode": 5`
`maxExecuteNotebookTimeMinutes`	Introduced at 10.8. The maximum amount of time (in minutes) that a notebook run by the `executeNotebook` operation can take to complete. If the notebook runs this long, it will be terminated. The default value is 120 minutes (2 hours). Example Use dark colors for code blocksCopy `1 "maxExecuteNotebookTimeMinutes": 120`
`WebContextURL`	The web URL users see. Example Use dark colors for code blocksCopy `1 "WebContextURL": "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. Example Use dark colors for code blocksCopy `1 "webSocketSize": 16`

Example usage

Use dark colors for code blocksCopy
https://notebookserver:port/arcgis/admin/system/properties/update
	properties={
		"WebContextURL": "https://mydomain.com/gis"
	}