Onboard IoT devices using the MAC account registration portal

In this topic, you will learn how to activate the MAC account registration portal and use it to onboard IoT devices to a network managed by Portnox™ Cloud. You can create new MAC-based accounts or add devices to existing ones.

Important:
To be able to onboard IoT devices using their MAC addresses, your NAS must support MAB authentication.

You can use this method to connect IoT devices to wired or Wi-Fi networks. The procedure is the same for both network types.

Configure a group in Portnox Cloud for MAC-based access

In this section, you will configure your Portnox™ Cloud group to allow devices to connect using MAC-based authentication.

To connect to the network, the IoT device’s account must be in a group that allows MAC-based authentication for the selected network (wired or specific Wi-Fi).

Do one of the following:

  • If you already have a group that you want to assign this IoT device to, check its configuration for the selected network: wired and/or a specific Wi-Fi network.
  • If you don’t have a group for the IoT device, create a new group and turn on MAC-based authentication for the selected network.

For more information about creating and editing the networks in the group, see the following topic: Create a group.

Activate the MAC account registration portal

This step must be done by a Portnox Cloud administrator with full access. Then, selected Cloud administrators and groups of users can use this portal to register new MAC-based accounts and add devices to existing ones.

  1. In the Cloud portal top menu, click on the Settings option.

  2. In the Cloud portal left-hand side menu, click on the Services > GENERAL SETTINGS > MAC account manual onboarding (Web app) option.

  3. In the MAC account manual onboarding (Web app) section, click on the Edit link, and activate the Enable MAC account registration portal checkbox.

    More options appear in the MAC account manual onboarding (Web app) section.

  4. Click on the  ⧉  icon next to the Url field to copy the URL and share it with selected administrators.

    Note:
    The URL for this content doesn’t change. You can use your company’s link shortening services or redirects to create a URL that is easier for your administrators to remember and access.
  5. In the Administrators allowed to onboard MAC accounts section, select the Portnox Cloud administrators that can use the MAC account registration portal.

  6. In the Groups allowed to onboard MAC accounts and Groups allowed to onboard existing MAC accounts sections, select the relevant groups:
    1. In the Groups allowed to onboard MAC accounts field, select the user groups whose members should have access to the MAC account registration portal.

      This field must contain groups with users, not MAC accounts. Users in these groups can create new MAC accounts.

      For example, if you select Vorlon administrators and the user kosh.naranek@vorlon.com is a member, Kosh can access the MAC onboarding portal and create new MAC accounts.

    2. In the Groups allowed to onboard existing MAC accounts field, select the groups that contain the MAC accounts users should be allowed to edit.

      All users who have access to the onboarding portal (Portnox Cloud administrators and users selected in the Groups allowed to onboard MAC accounts field) can add devices to MAC accounts that belong to these groups.

      For example, if you select the group Vorlon MAC devices and the MAC account Vorlon Headquarters is in that group, any user with portal access (including Kosh mentioned above) can add devices to that account.

  7. In the Assign MAB-account to the group field, select the Portnox Cloud group that all new MAC-based accounts will be assigned to.

    This should be a group that is configured earlier for MAC-based access for all relevant networks.

  8. Optional: Activate the Set up expiration for all MAC addresses field and select a value in the field on the right-hand side.

    If this setting is turned on, all MAC addresses submitted in the portal expire after the selected period, counted from the time of submission. This setting overrides the expiration selected for each device in the portal.

    Note:
    Setting an expiration date only stops future MAB authentication attempts. It does not disconnect a device that is already connected. The device keeps its network access until the NAS forces reauthentication, based on its configured reauthentication or session timeout. Set the expiration early enough relative to that timeout to achieve the access cutoff time you intend.
  9. Click on the Save button to save your changes or click on the Cancel button to abandon all changes.

    After you click on one of the buttons, Portnox Cloud will exit the edit mode.

Result: Selected administrators and groups of users can now use the MAC account registration portal to create MAC-based accounts and add devices to existing ones.

Find the network adapter’s MAC address

In this section, you will find the MAC address of the network adapter installed in the IoT device that you want to connect to the network.

  • Use the web interface or the access console of the IoT device to find out the MAC address of its network adapter.
  • If you can’t find the network adapter’s MAC address, try the following:
    1. If possible, connect the IoT device to the network managed by Portnox Cloud and enter any credentials.
    2. In the Cloud portal top menu, click on the Alerts option.
    3. Find a recent alert that says: 802.1X access attempt denied due to wrong credentials.
    4. Click on the Additional Info link in this alert.

      The MAC address of the IoT device appears below the alert.

    You can also look for a recent alert that says: MAC bypass denied and click on the Add MAC(s) to new or existing account link to proceed to the next task.

Create a new MAC-based account using the MAC account registration portal

  1. Open the MAC account registration portal in your browser.

    The URL is in the Cloud portal settings (copy the portal URL).

  2. On the sign-in page, enter your email address or username in the Email or username field and click on the Continue button.

    • If your browser opens the sign-in page of your identity provider, sign in there.

    • If the Password field appears, enter your Portnox Cloud password and click on the Sign in button.

  3. On the How would you like to proceed? page, click on the Create New Account tile, and then click on the Continue button.

  4. On the Create a New MAB Account page, enter a name in the Account Name field and an optional description in the Description field. Then, click on the Continue button.

    The Add Devices page appears.

  5. Optional: To import MAC addresses from a text file, click on the Import File tab. Then, drag the file to the upload area, or click on the upload area and select the file.

    Each line of the file contains the following fields, separated by semicolons:

    • MAC address
    • Description (optional)
    • Expiration in hours (optional). Enter 0 or never, or leave the field empty, for no expiration.

    MAC addresses can be in any of the following formats:

    • XX:XX:XX:XX:XX:XX
    • XX-XX-XX-XX-XX-XX
    • XXXX.XXXX.XXXX

    For example:

    00:00:5E:00:53:11;Environmental conditioning unit 4, Floor 1;never
    00-00-5E-00-53-12;Environmental conditioning unit 5, Floor 1;0
    0000.5e00.5313;Environmental conditioning unit 6, Floor 2;720
    00:00:5E:00:53:14;Environmental conditioning unit 7, Floor 2;
    00:00:5E:00:53:15;;

    The portal loads the devices from the file into the Manual Entry tab.

  6. In the Manual Entry tab, enter the devices or review the loaded ones:

    1. Enter the MAC address in the MAC Address field.
    2. Optional: Enter a description of the device in the Description field.
    3. In the Expiration field, select when the MAC address expires.

      To set an exact date and time, select the On date... option and select the date in the field on the right-hand side.

      Important:
      If the Set up expiration for all MAC addresses setting is turned on (portal settings), it overrides the value of this field.
    4. To add another device, click on the Add Another Device button.
    5. To delete a row, click on the trash can icon at the end of the row.
  7. Make sure that no row shows the Invalid MAC format message, and then click on the Submit Devices button.

    The counter next to the Submit Devices button shows only valid devices. Fix or delete invalid rows before you submit.

    The Devices have been onboarded page appears with a summary of the account and the registered devices.

    To add more devices, click on the Onboard More Devices button.

Note:
By default, if a device doesn’t connect to the network for 90 days, its MAC address is removed from the MAB account. You can change this period or disable this option here: Settings > Services > GENERAL SETTINGS > Inactive MAC-addresses purge interval > Edit. This does not mean that the device will be removed from the Portnox Cloud account. It means that if the device has been inactive for the configured period, and it tries to authenticate again after that period using its MAC address, it will no longer be recognized. The process for the Inactive MAC-addresses purge function is as follows:
  • You add a MAC address to a MAB account – the day when you do this counts as day 1.
  • The day counter increases every day at midnight tenant-time,
  • Any time the device with the MAC address authenticates, the counter resets to 1.
  • The moment that the counter reaches the configured limit, the MAC address is removed from the MAB account.
  • The device with the MAC address is no longer in the MAB account so it cannot authenticate.

Add devices to an existing MAC-based account using the MAC account registration portal

  1. Open the MAC account registration portal in your browser.

    The URL is in the Cloud portal settings (copy the portal URL).

  2. On the sign-in page, enter your email address or username in the Email or username field and click on the Continue button.

    • If your browser opens the sign-in page of your identity provider, sign in there.

    • If the Password field appears, enter your Portnox Cloud password and click on the Sign in button.

  3. On the How would you like to proceed? page, click on the Edit an Existing Account tile, and then click on the Continue button.

  4. On the Find an Existing MAB Account page, start typing the account name in the Account Name field.

    Matching accounts appear in the list below the field after you type at least 4 characters.

  5. Select the account in the list, and then click on the Continue button.

    The Add Devices page appears and lists the devices already in the account.

  6. Optional: To import MAC addresses from a text file, click on the Import File tab. Then, drag the file to the upload area, or click on the upload area and select the file.

    Each line of the file contains the following fields, separated by semicolons:

    • MAC address
    • Description (optional)
    • Expiration in hours (optional). Enter 0 or never, or leave the field empty, for no expiration.

    MAC addresses can be in any of the following formats:

    • XX:XX:XX:XX:XX:XX
    • XX-XX-XX-XX-XX-XX
    • XXXX.XXXX.XXXX

    For example:

    00:00:5E:00:53:11;Environmental conditioning unit 4, Floor 1;never
    00-00-5E-00-53-12;Environmental conditioning unit 5, Floor 1;0
    0000.5e00.5313;Environmental conditioning unit 6, Floor 2;720
    00:00:5E:00:53:14;Environmental conditioning unit 7, Floor 2;
    00:00:5E:00:53:15;;

    The portal loads the devices from the file into the Manual Entry tab.

  7. In the Manual Entry tab, enter the devices or review the loaded ones:

    1. Enter the MAC address in the MAC Address field.
    2. Optional: Enter a description of the device in the Description field.
    3. In the Expiration field, select when the MAC address expires.

      To set an exact date and time, select the On date... option and select the date in the field on the right-hand side.

      Important:
      If the Set up expiration for all MAC addresses setting is turned on (portal settings), it overrides the value of this field.
    4. To add another device, click on the Add Another Device button.
    5. To delete a row, click on the trash can icon at the end of the row.
  8. Make sure that no row shows the Invalid MAC format message, and then click on the Submit Devices button.

    The counter next to the Submit Devices button shows only valid devices. Fix or delete invalid rows before you submit.

    The Devices have been onboarded page appears with a summary of the account and the registered devices.

    To add more devices, click on the Onboard More Devices button.

Connect the IoT device to the network managed by Portnox Cloud

In this section, you will establish the network connection between the IoT device and the network managed by Portnox™ Cloud.

  1. Configure the IoT device to connect to the network.

    Use the web interface or the access console of the IoT device to configure network access.

  2. Connect the IoT device to the network.

    If the IoT device asks for credentials to access the network, enter any credentials. First, your NAS will try to authenticate your IoT device using credentials, and if that fails, the NAS will check if it can authenticate the IoT device using its MAC address.

  3. Check the Portnox Cloud logs to make sure the connection is successful.
    1. In the Cloud portal top menu, click on the Alerts option.
    2. Find a recent alert that says: 802.1X authentication success.

    Result: The IoT device is connected to the network.