Install Immune Guard on Nodegrid appliances
  • 18 May 2023
  • 1 Minute to read
  • Dark
    Light
  • PDF

Install Immune Guard on Nodegrid appliances

  • Dark
    Light
  • PDF

Article summary

Install Immune Guard on Nodegrid OS

The following guide outlines how Immune Guard can be installed on any Nodegrid OS using ZPE Cloud.

Requirements

  • Immune Guard subscript
  • valid ZPE Cloud account
  • Nodegrid OS version 5.8 or newer

Overview

The installation process contains the following steps:

  • Create ZPE Cloud profiles
  • Store the Immune Guard API as Custom Variable
  • Install Immune Guard on Nodegrid OS
  • Schedule regular scans

ZPE Cloud setup

Create ZPE Cloud profile for Immune Guard Installation

SettingValueComment
NameInstall Immune Guard
DescriptionInstall Immune Guard for Firmware Security
TypeScript
Dynamic TemplateEnabled
View Code asShell
Codecopy below scriptadjust version and file name as needed
#!/bin/bash
wget https://packages.immune.app/v3.13.1/guard-linux-v3.13.1 -O /var/opt/guard
chmod +x /var/opt/guard
/var/opt/guard enroll {{ guard_key }}
  • Click on Save

image.png

Create ZPE Cloud profile to run Immune Guard scan

  • Navigate to Profiles -> Configuration
  • Click on ADD to create a new Profile, and provide the following details
SettingValueComment
NameRun Immune Guard Scan
DescriptionRun Immune Guard Scan
TypeScript
Dynamic TemplateDisabled
Custom CommandEnabled
Button NameRUN_IMMUNE_GUARD
View Code asShell
Codecopy below script
#!/bin/bash
/var/opt/guard attest
  • Click on Save
    image.png

Store Immune Guard API Key

  • Navigate to Profiles -> Custom Fields
  • click on NEW
  • Create a new custom field with the following value
SettingValueCommit
Nameguard_key
Value<API KEY from Immune Guard>
ScopeGlobal

image.png

Install Immune Guard on Nodegrid OS

  • Navigate to Devices -> Enrolled
  • Select a or multiple devices
  • click on APPLY CONFIGURATION
  • Search for Run Immune Guard Scan
  • Click on SAVE
  • Immune Guard will now be installed onto the devices and enrolled with the provided API key
  • To review the current deployment status, navigate to Profiles -> Operations

Run Immune Guard Scan (Once off)

  • Navigate to Devices -> Enrolled
  • Select one or multiple devices
  • click on MENU to expand the menu
  • Click on RUN_IMMUNE_GUARD

Schedule Immune Guard Scan

  • Navigate to Devices -> Enrolled
  • Select a or multiple devices
  • click on APPLY CONFIGURATION
  • Search for Run Immune Guard Scan
  • Select under *Apply -> Schedule
  • Set a start date and time
  • Enable Recurrent and select the frequency, for example, daily
  • Click on SAVE

image.png


Was this article helpful?

What's Next
ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence