Snapshot Management

Runtime Snapshots save the VNS3 Controller Configuration.

Once your VNS3 Controllers and Clients are configured and running, save the configuration with Runtime Snapshots. Snapshots can be used to reconfigure a new Controller with the same SSL Certificates, Keyset, firewall, routes and peering with just one file upload.

Create a Snapshot

Via the UI

  1. From the left menu, Click snapshots
  2. Click “Take new snapshot”
  3. Clicking on the snapshot name to download to your machine
  4. Enter your UI credentials to download from webserver

Download the snapshot to your local network. In the event of a Controller failure or re-provisioning event, you can upload the snapshot file to a new VNS3 Controller. The new Controller will retain all the configuration settings as your saved snapshot.

VNS3 Config Snapshots Page

VNS3 Config Snapshot Save Modal

Tip: A slight configuration change on each server on the virtual network is necessary if you have not assigned Elastic IPs to your Controller. The OpenVPN configuration file (vnscubed.) on each server needs the new IP of the new Controller referenced in the remote commands section. To automate this step, you can assign an Elastic IP (see AWS billing for rates) to the Controller and reference the Elastic IP in each server’s OpenVPN configuration file. If you are utilizing Elastic IPs, once the Elastic IP is transferred to the new Controller, your overlay network devices will automatically connect back with the Controllers.

Via the API

A typical workflow for creating and downloading snapshots via the API is composed of 2 API calls:

  1. POST create snapshot - retrieve the snapshot name.
  2. GET download snapshot with the snapshot name

Snapshoting can also be managed for you with VNS3:ms.

Import Snapshot

Snapshots can be imported into an unlicensed controller to restore a previous VNS3 controller configuration.

Via the UI

  1. From the left menu click Upload snapshot
  2. Browse for your saved snapshot file and upload

The Controller will reboot with the updated configuration. The same Clientpacks will be available in the Controller, so redistribution to each server on the virtual network is not necessary.

VNS3 Admin Import Snapshot UI

Tip: A slight configuration change on each server on the virtual network is necessary if you have not assigned Elastic IPs to your Controller. The OpenVPN configuration file (vnscubed.) on each server needs the new IP of the new Controller referenced in the remote commands section. To automate this step, you can assign an Elastic IP (see AWS billing for rates) to the Controller and reference the Elastic IP in each server’s OpenVPN configuration file.

Via the API

A snapshot can be uploaded into an unlicensed controller with the PUT import snapshot endpoint.