Instance Registration

After setting up the Netgate® Nexus controller as described in Netgate® Nexus Controller Setup, it is possible to start registering instances of pfSense® Plus software with the controller for multi-instance management (MIM).

This is a two way process: Instances must be registered with the Netgate® Nexus controller and the controller must be activated on instances.

Repeat the process in this document for each instance of pfSense® Plus software to be registered with the controller.

Register Instance with Controller

The first task is to register the instance with the Netgate® Nexus controller.

First, enable Netgate® Nexus on the instance and copy the registration data:

  • Open the pfSense software WebGUI on the instance

  • Navigate to System > Advanced, |product_name| tab

  • Check Enable

  • Click Save

  • Click Copy to the right of the Registration Data field

Next, use that registration data to add the device to the controller

  • Open the pfSense® Plus GUI on the designated controller (Accessing the Netgate® Nexus GUI)

  • Click Systems > Dashboard in left menu

  • Click nexus-add-item in the toolbox on the right side of the page to add a new item

    Note

    Depending on the controller configuration, this may first require a click on the nexus-hamburger (hamburger menu) button to expand the right menu.

  • Set Create Method to Quick

    This is the default option.

  • Click in the Device info JSON text field

  • Paste the clipboard contents

  • Click OK

The device will now appear on the Netgate® Nexus GUI dashboard, but with incomplete information since the registration is not yet complete.

Activate MIM on pfSense® Plus Software Instance

To complete the registration, the controller must also be activated on the instance.

First, copy the activation data from the Netgate® Nexus controller:

  • Open the Netgate® Nexus GUI on the designated controller (Accessing the Netgate® Nexus GUI)

  • Click nexus-help (Help) in the toolbox on right

    Note

    Depending on the controller configuration, this may first require a click on the nexus-hamburger (hamburger menu) button to expand the right menu.

  • Click the JSON tab

  • Click nexus-copy Copy

  • Click nexus-window-close to close the window

Next, enter that activation data on the instance:

  • Open the pfSense® Plus WebGUI on the instance

  • Navigate to System > Advanced, Netgate® Nexus tab

  • Click in the Activation Data field

  • Paste the clipboard contents

  • Click Save

Now the registration is complete and the instance can be managed from the controller.