ArcGIS Notebook Server provides administrative tools and settings to monitor, manage, and secure your site. All of these resources and operations use the ArcGIS REST API language and can be accessed in the ArcGIS Notebook Server Administrator Directory. Some of the most common settings and resources are made available in the ArcGIS Notebook Server Manager app in the ArcGIS Enterprise portal.
ArcGIS Notebook Server Administrator Directory
Administrative tasks and resources for ArcGIS Notebook Server sites are made available through the ArcGIS Notebook Server Administrator Directory, an ArcGIS REST API directory. As an administrator of an ArcGIS Notebook Server site, you can use the Administrator Directory to perform a range of administrative actions, from monitoring your site to customizing its settings.
As with other REST API directories in ArcGIS Enterprise, you can either access the HTML views of the Administrator Directory in a browser or make programmatic requests to it through a third-party client.
The URL of the directory is formatted https://<notebookserver.domain.com>:11443/arcgis/admin or https://<notebookserverwebadaptor.domain.com>/<context>/admin.
Refer to the API reference (available at the upper right of the directory window) for full documentation of each resource and operation in the directory.
ArcGIS Notebook Server Manager
The ArcGIS Notebook Server Manager app, introduced at 10.8, provides an intuitive graphical interface in the portal for many common administrative tasks and resources. Each resource and operation available in Manager serves as an interface for a certain REST endpoint in the Administrator Directory. You can use Manager to monitor key statistics about usage and performance, to maintain and adjust system settings, and to use system logs for troubleshooting.
Access the Manager app
The app is only accessible to portal members with administrative privileges. There are two ways of accessing ArcGIS Notebook Server Manager.
Access ArcGIS Notebook Server Manager from your ArcGIS Notebook Server home page
Complete the following steps to access ArcGIS Notebook Server Manager from your ArcGIS Notebook Server home page:
- Sign in to your ArcGIS Enterprise portal as an administrator.
- Click Notebook at the top of the site.
- Click Manage > Notebook server.
Note:
You can bookmark Manager with the URL format https://portal.domain.com/portal/home/notebook/manager.html.
Access ArcGIS Notebook Server Manager from your organization
Complete the following steps to access ArcGIS Notebook Server Manager from your organization:
- Sign in to your ArcGIS Enterprise portal as an administrator.
- Click Organization at the top of the site and click the Settings tab.
- Click Servers on the left side of the page.
- Under Federated server sites, locate your ArcGIS Notebook Server and click the Administrator URL.
The link directs you to its ArcGIS Notebook Server Manager app in the portal website.
View site information in Manager
The Overview page in ArcGIS Notebook Server Manager provides a dashboard view of some helpful information and statistics regarding your site.
- Site information—This box provides a link to your site's Administrator Directory and the current version number of your ArcGIS Notebook Server site. It also gives a count of containers and notebooks currently active across your site.
- Health check—This table shows whether each machine in the site has passed its most recent health check and the number of containers active on each machine.
- Recent errors—Logs created in the past 24 hours with the levels WARNING or SEVERE are shown in this table. You can use the Logs page in Manager to see more details about each log.
- Machines—This table gives a list of each machine participating in the site. For each, the machine name, operating system version, number of physical processors, and available system memory in GB are provided.
Available operations in Manager
ArcGIS Notebook Server Manager provides several tools to monitor and manage your site.
Containers tab
This page gives a summary of each Docker container running in your site. For each container, the following information is given:
- Machine—The ArcGIS Notebook Servermachine on which the container is running.
- Member—The user who launched the container by opening a notebook.
- Container ID—The unique ID of the Docker container, which you can use when working with Docker logs.
- Runtime name—The name of the Python runtime in the Docker image applied to the container. Read the introduction to Docker and ArcGIS Notebook Server for more information.
- Version—The runtime version corresponding to the current ArcGIS Notebook Server version.
- Date created—The date on which the container was launched.
Click the Delete button next to a container to terminate it. This won't delete any notebooks that have run in the container.
Tasks tab
This page, available starting at 10.8.1, provides a view of each task that is currently active or completed in your site. Tasks are used to schedule remote running of a notebook either once or on a recurring basis. Notebook authors who have the Schedule Notebooks privilege can create tasks for any notebook they own.
On this page, you can view each active or completed task with its name and the user who created it, the time it was created and when it was last modified, and the current status (Active or Complete).
Each task has three action buttons in its row. You can click the View task details button to review results of each individual run of the task. To make changes to the title, parameters, or schedule of the task, click the Edit task button. To remove a task, click the Delete task button.
Note:
Deleting a task also deletes the run history of the task. To preserve an active task's history, edit its schedule to stop further task runs.
Logs tab
On the Logs page, you can query ArcGIS Notebook Server logs, with options to sort and filter by several parameters. To learn more, see Work with ArcGIS Notebook Server logs.
Settings tab
On the Settings page, the following operations and resources are available:
- Runtimes—Each container runtime currently registered with your site. You can update the resources used by an existing runtime or download its manifest (list of available Python libraries). You can also register a new runtime if you are building a custom image or delete a runtime to make it unavailable to your users.
- Logs—You can change the log settings for your site here.
- Site—Several advanced settings for your ArcGIS Notebook Server site can be changed here.
- Configuration store—View the current location of your site's configuration store, and specify a new location for the configuration store.
- Directories—A list of each current system, output, workspace, or data directory registered with your site is given. You can register a new data directory or specify a new location for an existing server directory.
Reset the primary site administrator account password
You create the primary site administrator account when you create an ArcGIS Notebook Server site. If you need to change the username or password for this account, you can do so using the ArcGIS Notebook Server Administrator API.
If you use the primary site administrator account to register ArcGIS Web Adaptor with your site and you later change the primary site administrator username or password, there is no need to reconfigure the web adaptor. HTTPS communication is not disrupted between the web adaptor and the site after you edit the account.
Follow these steps to change the username or password of the primary site administrator account.
- Open a terminal on the ArcGIS Notebook Server machine.
- Browse to <Notebook Server install directory>/tools/passwordreset.
- Run the command ./passwordreset.sh -p <newpassword>.
The primary site administrator account password is reset.