Skip to main content

Create and restore NIM snapshots

Settings guide

Use snapshots for installation-level rollback and server migration, not everyday configuration recovery.

What a snapshot includesDirect link to What a snapshot includes

A snapshot contains the installed NIM version, configuration, internal databases, and credentials. Snapshots also include SQLite system databases, custom REST system schemas, user settings, tag definitions, and anonymization profiles with their keys. This does not make snapshots a backup of every collected data file, job or schedule result, or log file.

Check the Snapshots description for an incomplete-backup notice when a database could not be backed up. Do not rely on an incomplete snapshot as your only recovery copy.

Create a snapshotDirect link to Create a snapshot

Go to Configuration > Settings > Snapshots, select Create snapshot, and confirm. NIM enters maintenance mode while it creates the snapshot.

Restore a snapshotDirect link to Restore a snapshot

Known snapshot restoration issue

v7.0.1864, v7.0.1865, and v7.0.1866 list a snapshot-restoration issue that can leave the internal.passwords table unrestored. Verify the restored authentication data before treating recovery as complete. Review the published workaround with Tools4ever Support before restoring an affected installation; a successful restore action alone does not establish that every internal table was recovered.

Select the restore icon for the snapshot to recover and confirm the operation. Creating a snapshot of the current state first is recommended. Use this when a failed upgrade or major system issue requires both the installed NIM version and configuration to roll back.

Internal passwords and SQLite databases are restored after the configuration repository has loaded. Failed restores do not restart repeatedly, and maintenance mode is cleared after a failure. The warning above remains applicable to the specifically listed older builds.

A snapshot created with NIM 7.0.1866 or earlier has no user settings or tags. Restoring such a snapshot keeps the current user settings and tags. Check the snapshot's source build and verify restored authentication, databases, and configuration before treating recovery as complete.

Migrate to another serverDirect link to Migrate to another server

  1. Install NIM on the target server.
  2. Create a snapshot on the current server.
  3. Copy its folder from C:\ProgramData\Tools4ever\NIM\sysdata\snapshots\snapshots to the same location on the target server.
  4. Restore the snapshot on the target server.
  5. Collect target systems again and run validation.
caution

Plan the migration window carefully. Snapshot restoration temporarily places NIM in maintenance mode.