Instance Registration

After setting up the the Multi-Instance Management (MIM) controller as described in Multi-Instance Management Controller Setup, it is possible to start registering instances of pfSense® Plus software with the controller.

This is a two way process: Instances must be registered with the MIM controller and the MIM 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 MIM Controller

The first task is to register the instance with the MIM controller.

First, enable MIM on the instance and copy the registration data:

  • Open the pfSense software GUI on the instance

  • Navigate to System > Advanced, Multi-Instance Management 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 MIM GUI on the designated controller (Accessing the Multi-Instance Management GUI)

  • Click Systems > Dashboard in left menu

  • Click mim-add-item in the toolbox on right to add a new item

    Note

    Depending on the controller configuration, this may first require a click on the mim-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 MIM 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 MIM controller:

  • Open the MIM GUI on the designated controller (Accessing the Multi-Instance Management GUI)

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

    Note

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

  • Click the JSON tab

  • Click mim-copy Copy

  • Click mim-window-close to close the window

Next, enter that activation data on the instance:

  • Open the pfSense software GUI on the instance

  • Navigate to System > Advanced, Multi-Instance Management 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 MIM controller.