Skip to main content

Back up and restore NIM configuration

Settings guide

Protect NIM configuration before change, then restore only what you need when recovery is required.

Always back up before restoring

A full restore overwrites the current NIM configuration. A partial restore can overwrite the selected objects.

Always back up the current configuration before restoring anything, whether restoring the full configuration or individual objects. Create a new repository and download its JSON backup to a safe location outside the NIM server before proceeding.

Understand repositoriesDirect link to Understand repositories

A repository is a backup of NIM objects and configuration, including systems, roles, relations, filters, apps, and jobs. It does not replace a full installation snapshot.

Create and download a repositoryDirect link to Create and download a repository

Capture the current configurationDirect link to Capture the current configuration

Go to Configuration > Settings > Repositories, select Add, and wait for the new repository to appear.

Step 1 of 2

Restore a repositoryDirect link to Restore a repository

Back up the current configuration before any restoreDirect link to Back up the current configuration before any restore

  1. Go to Configuration > Settings > Repositories and select Add to create a new repository of the current configuration.
  2. Wait for the new repository to appear, then download its JSON backup and store it in an access-controlled location outside the NIM server.
  3. Confirm the backup has been saved before selecting a repository or objects to restore.

Do this before every full or partial restore. Use a fresh backup of the current configuration, even when you already have older repositories or snapshots.

Step 1 of 4

Maintain repositoriesDirect link to Maintain repositories

Use Edit > Cleanup to remove objects before sharing a repository. Use the delete icon only after confirming the repository is no longer needed for recovery or distribution.