Onboarding Guide

Note

Before adding a device to Portweaver, the device itself must be prepared for API and SSH access. For security, Portweaver only supports connecting to the API via HTTPS, and a proper SSL certificate must be configured per device.

---

Prerequisites

Each device must be configured to support:

• HTTPS (SSL) management
• REST API access
• SSH access
• A service account with sufficient permissions

Refer to the appropriate setup guide for your firmware to get started.

Note

The same account must be used for both REST API and SSH access.

This can be implemented using:

• A local device account
• A RADIUS-backed account

---

Adding a Device

Once the device has been prepared:

1. Open the dashboard
2. Click “add device”

3. Fill out the required fields:

• IPv4 address
• username
• password
• type

Note

The selected driver type must match the device firmware (e.g. AOS-CX vs AOS-S).

4. Submit the form with “connect”

---

Connection Process

After submission:

• The device will appear in the dashboard immediately
• Portweaver will begin establishing a connection in the background

During this phase:

• REST API connectivity is verified
• SSH access is initialized
• Device data is collected and cached

Once complete, the device transitions to an online state if it successfully logs in.

---

Removing a Device

To remove a device:

1. Right-click anywhere on the device card
2. Click “Remove”

You’ll be prompted to ensure you want to remove the device.

---

Summary

• Devices must be prepared before onboarding
• A single service account is used for both REST and SSH
• Adding a device is handled entirely through the dashboard
• Devices connect asynchronously after being added
• Removal is performed directly from the device card

This workflow keeps device management simple while allowing Portweaver to handle connection and state internally.