ENROLLED Tab
    • 02 Sep 2024
    • 10 Minutes to read
    • Dark
      Light
    • PDF

    ENROLLED Tab

    • Dark
      Light
    • PDF

    Article summary

    This tab shows the list of Nodegrid devices enrolled in ZPE Cloud. It also displays the device details.

    NOTE

    In the main table, when a Hostname checkbox is selected, additional device information is shown in the Device Details table (bottom of the page).

    In the Access column, if the device is configured for remote access, click CONNECT and select the desired connection method (Web/Console). For information on how to enable remote access, see the section https://docs.zpesystems.com/docs/general-services-sub-tab.

    The Subscriptions Use/Available (upper right) indicates the number of current subscriptions.

    Description of Buttons

    Click MENU to display additional side panel options:

    • APPLY CONFIGURATION  – applies configuration to the selected device(s).

    • SOFTWARE UPGRADE – applies software upgrade to the selected device(s).

    • BACKUP  – backs up the selected device(s).

    • RELOAD - refreshes the table contents.

    • MENU – expands side panel with additional buttons:

      • CLOSE button – closes side panel.

      • CELLULAR UPGRADE button – starts cellular upgrade process on selected device(s).

      • MOVE TO AVAILABLE button – moves selected device(s) to Available status.

      • Custom commands that can be applied to the selected device(s). For information on how to add a custom command, see the section Apply Custom Command to Device.

    • APPLY PACKAGE – displays Apply Package page (to select and apply a package to the selected device (v5.10+ only).

    Manage Enrollment

    Apply Configuration

    1. Go to DEVICES :: ENROLLED.

    2. In the table, locate the device and select the checkbox.

    3. Click APPLY CONFIGURATION (displays dialog). 

    4. Locate the configuration (one or more) and select the checkbox(es).

    5. In the Apply menu, select when the configuration is applied.

      • Now radio button (when saved, the operation executes immediately)

      • On the First Connection radio button (execute operation the first time the device(s) comes online)

      • Schedule (if selected, choose a date to execute the operation)

      • Recurrent (if selected, how often the operation is executed: hourly, daily, weekly, monthly). Choose from the Every Date drop-down.

    6. Click SAVE.

    Software Upgrade

    1. Go to DEVICES :: ENROLLED.

    2. In the table, locate the device(s) and select the checkbox.

    3. Click SOFTWARE UPGRADE (displays dialog). 

    4. Locate the version and select the checkbox. If needed, use the Search function. 

      1. When you select a version lower than the current version a warning is displayed on the system to alert the user about the downgrade.


        For Nodegrid version below 6.0.10:

        For Nodegrid versions 6.0.10 and above:

        CAUTION:

        If you downgrade your Nodegrid device (running versions 6.0.10 or above) to a version below 6.0.10 and if the device is enrolled in a non-US ZPE Cloud instance, such as the EU ZPE Cloud instance, the device will lose its access to the ZPE Cloud. Therefore, you must unenroll the device from the ZPE Cloud and reenroll it to restore its access to the ZPE Cloud. For detailed steps, refer to Unenrolling the Nodegrid Device During Downgrade.

      2. Click Continue.

      3. The device is downgraded to the selected version. You can view the updated version of the selected device on the Enrolled tab.

    5. (optional) Select the Force Boot Mode checkbox (hover over the  icon for information).

    6. In the Apply menu, select one: 

      • Now radio button (when saved, the operation executes immediately)

      • On First Connection radio button (execute operation the first time the device(s) comes online)

      • Schedule (if selected, choose a date to execute the operation)

      • Recurrent (if selected, how often the operation is executed: hourly, daily, weekly, monthly). Choose from the Every Date drop-down.

    7. Click SAVE.

      NOTE

      Devices connected to ZPE Cloud through GSM / LTE or weak connections are not recommended to receive profiles greater than 500MB, including software upgrades (around 700MB to 1.7GB), as it might affect your Data Usage plan and the connection might be reset in the middle of the download, causing the Job of the Profile to fail.

    Unenrolling the Nodegrid Device During Downgrade

    Follow these steps to unenroll the device and downgrade the device to a version lower than 6.0.10. Before performing these steps make sure that you have direct access to the Nodegrid device:

    1. Log in to the ZPE Cloud Web UI.

    2. Go to Devices :: Enrolled.

    3. In the table, locate the device you want to unenroll and select the checkbox(es).

    4. Click MENU (expands dialog).

    5. On the left panel, click MOVE TO AVAILABLE.

    6. Click Move to confirm unenrolling the device. The selected device is moved to the AVAILABLE tab.

    7. Click AVAILABLE.

    8. In the table, locate the device and select the checkbox(es).

    9. Click Remove.

    10. Type confirmation text.

    11. Click OK.

    12. Access the device via the terminal as root.

    13. Execute the following command to unenroll your device from ZPE Cloud. You must perform this step to ensure that the complete instance of your Nodegrid device is removed from the ZPE Cloud. If you have any queries while performing this step, contact support@zpesystems.com

      Text

      zpe_cloud_enroll  -u https://zpecloud.eu --realm zpe --enroll-clean
    14. Downgrade the device to the older version.

      Note:

      After you remove your device from ZPE Cloud you will no longer be able to access the device via Cloud. To downgrade, access the Nodegrid device via the terminal or the Web UI and follow the downgrade process. Refer to the section Software Upgrade Tool for downgrade steps.

    15. Execute the following step to enroll the device back into the ZPE Cloud:
      CLI

       Text

      zpe_cloud_enroll -c <customer-code> -k <enrollment-key> -u https://zpecloud.eu --realm zpe

         Web UI

          In the Nodegrid Web UI, under System::Toolkit::Cloud enrollment, set customer code, enrollment key and URL and click Enroll.

    Backup Device

    NOTE

    The Backup operation requires Nodegrid version 4.1.9 or higher. The Cellular upgrade operation requires version 4.2 or higher.

    1. Go to DEVICES :: ENROLLED.

    2. In the table, locate the device(s) and select the checkbox(es).

    3. Click BACKUP (displays dialog).

    4. On the File Protection menu, select one:

      • None radio button (without encryption – backup file sent to ZPE Cloud without encryption. File can be downloaded and applied to a device through Nodegrid Manager.)

      • TPM Encrypted radio button (TPM encrypted file (backup file is encrypted and sent to ZPE Cloud. File can only be decrypted with the same hardware that encrypted it.)

      • Password encrypted radio button (backup file is sent to ZPE Cloud encrypted – saved on Nodegrid device under ZPE CLOUD SETTINGS :: ENABLE FILE PROTECTION with OpenSSL. Password must be known to decrypt the backup file when downloaded from ZPE Cloud.)

    5. On the File Storage menu, select one.

      NOTE

      On ZPE Cloud, each device may have a maximum of five backups. At that limit, one or more backups must be deleted. There are two storage options available:

      • Temporary radio button (on a new backup request with five backups slots filled, the oldest backup is deleted)

      • Persistent radio button (when backup slots are full, the user must manually select the backup to delete)

    6. In the Apply menu, select one: 

      • Now radio button (when saved, operation executes immediately)

      • Schedule (if selected, choose a date to execute the operation)

      • Recurrent (if selected, how often the operation is executed: hourly, daily, weekly, monthly). Choose from the Every Date drop-down.

    7. Click SAVE.

    Cellular Upgrade

    1. Go to DEVICES :: ENROLLED.

    2. In the table, locate the device(s) and select the checkbox(es).

    3. Click MENU (expands dialog). 

    4. On the left panel, click CELLULAR UPGRADE (displays dialog). 

    5. Available Model drop-down, select one.

    6. Firmware drop-down, select one. (as needed) If the Select All checkbox is selected, all cellular units are upgraded. Alternatively, select one version on the device drop-down.

    7. If the First connection checkbox is selected, the upgrade occurs when the device next connects to the Cloud (Schedule is disabled). If the Schedule checkbox is selected, select the date/time on the pop-up calendar.

    8. Click SAVE.

    Move to Available

    1. Go to DEVICES :: ENROLLED.

    2. In the table, locate the device(s) and select the checkbox(es).

    3. Click MENU (expands dialog). 

    4. On the left panel, click MOVE TO AVAILABLE.

    5. Click Move to confirm unenrolling the device.

    The selected device is moved to the AVAILABLE tab.

    Apply Custom Command to Device

    1. Go to DEVICES :: ENROLLED.

    2. In the table, locate the device(s) and select the checkbox(es).

    3. Click MENU (expands dialog). 

    4. Select checkbox(es) of devices.

    5. In the left column, locate and click the Custom Command to apply to selected devices.

    To check the job status, go to PROFILES :: OPERATION :: JOBS. In the Hostname column, locate the device.

    Apply Package to Device

    NOTE

    This applies only to Nodegrid v5.10+ devices.

    1. Go to DEVICES :: ENROLLED.

    2. In the table, locate the device(s) and select the checkbox(es).

    3. Click APPLY PACKAGE (opens dialog). 

    4. On the table, locate the Package to be applied, and select the checkbox.

    5. (if applicable) Select the Force Apply/Unapply checkbox.

      NOTE

      If selected, the package will be applied, regardless of the package version level.

    6. In Apply menu, select when the action is applied. 

      • Now (when saved, execute the operation immediately)

      • On First Connection (execute operation the first time the device(s) comes online)

      • Schedule (if selected, choose a date to execute the operation)

    7. Click SAVE.

    Manage Individual Devices

    When you click any of the devices listed on the Enrolled tab, all the required information related to the device is displayed on this page. If the selected device is allowed to be accessed by ZPE Cloud, the CONSOLE, WEB, and RESYNC buttons are activated as shown in the following image:
    image.png

    • CONSOLE: Allows the user to access the device through CLI

    • WEB: Allows the user to access the device using the GUI

    • RESYNC: Allows syncing data every 15 minutes

    • EXPAND ALL: Expands all the sections displayed under every drop-down

    • RELOAD: Refreshes the page

    Device Information

    In the Device information section, you can view the following details;

    • Hostname: The hostname of the device

    • Network Interface: The name of the network interface port that connects the device to the network

    • Public IP Address: The IP address of the device used to identify

    • Status: Shows if the device is offline or online

    • Last Connection: Indicates the time when the device was connected last time

    • Uptime*: Indicates the average operational time of the device

    • Last Job Name: The name of the last job run on the device. If you click the job name, you can view the information related to that particular job.

    • Part number: The part number of the device

    • Serial number: The serial number of the device

    • Version: The version of the Nodegrid device. A warning message is indicated next to the version number if you are using an unsupported version. Unsupported versions include v4.2 or earlier, and 5.10.1. In such a case it is recommended to upgrade to a supported version.

    Additionally, this page contains a Connection History graph. This graph is a visual representation of the availability of the device for a selected period. You can select the start date and end date and click CONFIRM. The graph is populated based on the selected date ranges.

    * The Green color indicates that the device was available or online for that duration


    * The Grey color indicates that there is no information available for the device


    * The Red color indicates that the device was offline for a given period.


    * The Yellow color indicates failover

    Network Connections

    You can view the network-related information such as the name of the network interface, the type of the port, the status of the device, the IP address of the device, and the MAC address of the device.

    Mobile Connection Details

    This section is populated only when the SIM card is available for the device. The section displays SIM card-related details such as the Connection Name, Network Interface, IMEI number, shows if the SIM card is active or not, the mobile phone associated with the SIM card, and a subscriber ID.

    You can also view a graph on this page that shows the data usage patterns in gigabytes, the strength of the signal, and the renewal day details. You can unselect any of the fields to not include them in the graph. Just click any of the fields to unselect or select them to make part of the graph.
    image.png

    image.png

    If there is more than one SIM card available, the information is displayed under the active SIM cards only.

    Jobs

    This section provides a summary of all the jobs that were run on the device.
    You can view the job ID, job name, type, application associated with the job, the date and time of the creation of the job, and the date and time when the job was finished.

    You can click SEE MORE to get more insights on the listed jobs. When you click the JOB ID, the job details are populated.
    Jobs are usually created to upload configuration or run a script and so on. On this page, you can view the type of configuration uploaded, the name of the configuration, the registration, the time when the job was finished, the status of the job, hostname, serial number, and model number of the device.

    Events

    The Events section lists any events such as device outage, or system failover caused to the device.

    Device Details

    This section lists all the devices attached to the selected devices.
    For example, if you select a Nodegrid NSR device and it has other devices attached to it, this section lists the slot number where the device is attached, the part number of the device, the type of the device attached, and any add-ons for the device.


    Was this article helpful?

    ESC

    Eddy AI, facilitating knowledge discovery through conversational intelligence