Returning a controller to near factory defaults

At times it may be necessary to restore an controller to a known good empty state, either to recommission it with the current release build, or before recommissioning it with an earlier build. To do this, you can install a clean .dist (distribution) file.

The platform is running Niagara 4. You have backed up any station files as well as any other files needed later, for example digital certificate keys. Always export certificate keys for any TLS-configured unit and store the exported keys in a safe place, such that if the controller needed to be replaced (a hardware swap-out), you could re-import the keys.

Wiping a controller clean is, typically, unnecessary if you are upgrading an operational controller to a later software build. Using the Commissioning Wizard should be all that is necessary. However, if you are downgrading a controller to an earlier build, you should install a clean .dist file first, to avoid compatibility problems. This applies especially to JACE controllers, as binaries for the (QNX) OS are included in .dist files.

Installing a clean .dist wipes the entire file system and installs an appropriate version of the Niagara platform daemon, resetting the unit to a near factory state. If the controller came with an appliance installed, installing a clean .dist also removes the appliance. Only the following settings are preserved:

  • TCP/IP settings

  • license files

  • brand.properties

  • most secure communication (TLS) configuration

    All other data are deleted from the file system, including station bog files, Px files, modules, etc.The unit’s TLS private key information is also deleted. In addition, installing a clean .dist deletes all configured platform users, restoring the factory-default platform credentials and port (3011).

  1. Using Workbench, open a platform connection to the controller.
  2. To access the !cleanDist directory, open the Distribution File Installer and click the Cleaning button.
    Each clean dist file has the suffix -clean in its name. Clean distribution files are located in your Sys Home !cleanDist folder—apart from other dist files under your software database.

    Clean dist files appear listed with a WARNING in the Description. You can select only the appropriate file for the currently opened platform.

  3. Select the appropriate clean dist file for the platform and click Install.
    Removing a file system takes a few minutes, then the controller automatically reboots. Wait for the reboot to complete.
    Note: After reboot from a clean dist install, the controller requires port (3011).
  4. Do one of the following:
    • To re-install the software versions to the controller, open a version ofWorkbench that uses the same software version that you want on the controller, and use the platform Commissioning Wizard to install the desired software build.
    • If you have a backup dist file for the controller that was made when it had the desired prior N4 software version, use the Distribution File Installer to install it.