Remote Worker Agents (Endpoints)
Integrations
Requirements
A NetBeez dashboard with a valid license (request a quote if you don't have one)
Read more - If you wish to learn more about the agent types or tech specs
Locate the secret key
Go to the NetBeez Settings of your dashboard (top right grey cog
), then go to the About page (the left menu), and locate on that page your Secret Key (highlighted here below an example):
NetBeez supported options for Agents
Linux Debian
Virtual appliance (OVA)
Docker container
AWS EC2
Cloud services
Windows client
macOS client
Network Agents
Option 1 - Debian Linux package
NOTE: The highest supported Debian version can be downloaded from here: bullseye armhf.
1. Log in to the Linux host where you want to install the software Agent.
2. Fetch the installation script:
curl -L -O https://raw.githubusercontent.com/netbeez/agent-installation/master/agent_setup.sh
3. Execute the following script as a sudo user. Replace <secret_key> in the following command with the actual secret key received upon registration of your dashboard. Otherwise, find the <secret_key> on the About page in your NetBeez Settings:
sudo bash agent_setup.sh --modify-interface --secret=<secret_key>
Please note: 32-bit versions of Linux are not supported.
4. To update an installed Debian Linux agent to a newer version run:
sudo apt-get update; sudo apt-get install netbeez-agent
Option 2 - Virtual appliance
Fresh Image, using the install script
Note: Currently supported on Debian 10, Debian 11, Ubuntu 18.04, and Ubuntu 20.04
Follow this link to download an Ubuntu OVA if none is not currently set up.
Once a virtual appliance is running on your VM host, follow these steps:
1. Log in to the virtual appliance.
2. Fetch the deployment script:
curl -O https://netbeez-public.s3.amazonaws.com/agent_artifacts/agent_deploy.sh
3. Execute the script as a sudo user. Make sure to replace the <secret_key> in the following command with the actual secret key received upon registration of your dashboard or find it on the About page in your NetBeez settings:
sudo env URL="https://netbeez-public.s3.amazonaws.com/agent_artifacts/nbagent_virtual-model-ova_d744be74_14.3.4.tar.gz" SECRET="<secret_key>" bash agent_deploy.sh && sudo bash /usr/local/netbeez/agent_cleanup.sh && sudo bash /usr/local/netbeez/ova_modify_interfaces.sh
Importing from our OVA image (Agent Version v.9.0)
1. Download the NetBeez Agent virtual appliance at the following URL:
2. Import the appliance into your virtual environment (VMWare, vBox, etc.)
Note: If you are using vBox manager, make sure to select Linux/Ubuntu as OS Type.
Note: By default, the OVA is provisioned with 1 vCPU and 1 GB of RAM; these resources should be enough for most installations.
3. Log in to the virtual appliance using netbeez/netbeez as username/password.
4. Fetch the installation script:
curl -L -O https://raw.githubusercontent.com/netbeez/agent-installation/master/agent_setup.sh
5. Execute the script as a sudo user. Make sure to replace <secret_key> in the following command with the actual secret key received upon registration of your dashboard or find it on the About page in your NetBeez settings:
sudo bash agent_setup.sh --secret="<secret_key>"
Option 3 - Docker container
NetBeez has released the Docker Agent, an Agent that runs in a Docker container. To install a Docker Agent, run the following command:
docker volume create netbeez-config-vol
docker run -d --restart=always -e "NB_SECRET_KEY=<secret_key>" -v netbeez-config-vol:/etc/netbeez/persistence/:rw netbeez/nb-agent
NOTE: give all the "-e" parameters before the volume "-v" option
Replace the <secret_key> with your server's secret key, as well as the volume with a created docker volume.
To configure the Docker Agent, follow the setup guide on DockerHub.
A video with information on installing a Docker Agent on Windows can be viewed HERE.
Option 4 - AWS EC2
NetBeez agents can be deployed to AWS EC2 with the NetBeez AMI. View this tutorial for a more detailed walk-through of deploying an agent on AWS EC2.
If using your own AMI, follow the steps in Option 5. Otherwise, continue with these steps:
1. Log into your AWS account.
2. Click Services > Compute > EC2.
3. Click AMI Catalog on the left.
4. Click Community AMIs.
5. Type 'NetBeez' in the field and press Enter.
6. Click the Select button.
7. Click Launch Instance with AMI button.
8. Name the instance.
9. Set instance type, t2.medium is recommended.
10. Complete the Key Pair (login) Section.
11. Complete the Network Settings Section.
12. Click Launch Instance.
13. SSH into the instance.
14. Run the agent setup commands located on your NetBeez dashboard under Settings > About inside the instance.
The agent will now appear under the Agents > Network Agents tab of your NetBeez dashboard.
Option 5 - Cloud services
NetBeez agents can be deployed to cloud services such as AWS, Azure, and Google Cloud Platform. In order to install the agent, an instance will need to be spun up, in the hosting service, running either Debian 10, Debian 11, Ubuntu 18.04, or Ubuntu 20.04.
Follow these steps to install and deploy the agent to the dashboard:
1. SSH into the instance.
2. Fetch the deployment script:
curl -O https://netbeez-public.s3.amazonaws.com/agent_artifacts/agent_deploy.sh
3. Execute the script as a sudo user. Make sure to replace <secret_key> in the following command with the actual secret key received upon registration of your dashboard or find it on the About page in your NetBeez settings:
sudo env URL="https://netbeez-public.s3.amazonaws.com/agent_artifacts/nbagent_cloud_d744be74_14.3.4.tar.gz" SECRET="<secret_key>" bash agent_deploy.sh && sudo bash /usr/local/netbeez/agent_cleanup.sh && sudo bash /usr/local/netbeez/ova_modify_interfaces.sh
Remote Worker Agents
Option 6 - Windows installer
The Windows Remote Worker agent is an executable program that runs on Windows Desktops and Laptops. Currently, Windows 7, 10, and 11 are supported.
1. Download the latest version of the executable (in MSI format) here:
2. Once downloaded, double-click on the MSI and follow the instruction; the installation wizard will ask you for the dashboard's secret key which can be found on the NetBeez dashboard by going to Settings -> About page.
If the installation is successful, your agent will connect to the dashboard, and you will be able to find an icon on the Windows System Tray in the lower right to control the agent service. The NetBeez agent will start on Windows boot automatically.
For mass deployment of the Windows remote worker agent by NetBeez, please review this article.
Option 7 - macOS installer
The macOS Remote Worker agent is an executable program that runs on Apple Desktops and MacBooks. Currently, macOS 10.15 and later versions (Catalina, Big Sur, Monterey, etc) are supported.
1. Download the latest version of the executable (in DMG format) here:
2. Once downloaded, double-click on the DMG and follow the instructions; the installation wizard will ask you for the dashboard's secret key which can be found on the NetBeez dashboard by going to Settings -> About page.
If the installation is successful, your agent will connect to the dashboard, and you will be able to find an icon in the upper right to control the agent service. The NetBeez agent will start automatically when the computer boots.
FAQ
Q: What should I do after I have loaded the Agents?
A: Log in to your dashboard instance, the URL of which was sent with the welcome email, and then create and review your monitoring Targets.
Q: The OVA file I downloaded has an .ovf extension.
A: This is a known issue with Chrome. Please see the reported issue here. You can still load and use the image.
Q: Why doesn't the virtual Agent seem to boot after I have imported it in vBox?
A: Make sure to select Linux/Ubuntu-64 as a machine type.
Q: Where is the Agent log?
A: The default agent log file location is /var/log/netbeez/nbagent_prod.log for virtual and Raspberry Pi images, while it's /var/log/netbeez/netbeez-agent.log for the software Agent.
Q: What happens if the Agent does not show up on the dashboard?
A: Check out this troubleshooting guide
Q: I get an error decompressing the Raspberry Pi image on Windows.
A: Use the 7-Zip program on Windows.