Install Orb Using Catalyst Center
- Introduction
- Prerequisites
- Building Your IOx Package
- Step 1: Install the Application Hosting Package
- Step 2: Prepare Your Wireless Infrastructure
- Step 3: Upload the Orb Application
- Step 4: Deploy to Access Points
- Step 5: Monitor Deployment Status
- Step 6: Verify Orb Registration
- Network Architecture
- Managing Deployed Applications
- Troubleshooting
- Limitations
- Additional Resources
This documentation is in beta and intended for advanced users. If you encounter issues or have questions, please reach out to [email protected] or join our Discord community.
Introduction
This guide walks you through deploying the Orb sensor across Cisco Catalyst 9000 Access Points using Catalyst Center (formerly DNA Center). This method is ideal for enterprise networks managing multiple APs where centralized deployment and monitoring is required.
With Catalyst Center, you can:
- Deploy Orb to multiple access points simultaneously
- Monitor application health from a central dashboard
- Manage application lifecycle across your wireless infrastructure
Prerequisites
Before you begin, ensure you have:
- Catalyst Center 2.1.2.x or later
- Cisco IOS XE 17.3.1 or later on your Wireless LAN Controllers
- Catalyst 9000 series access points (see compatibility list)
- The Application Hosting package installed on Catalyst Center
- A Cisco DNA Advantage license
- An IOx package (
package.tar) containing the Orb sensor and your deployment token - An Orb deployment token
Access points require direct, routable (non-NAT) connectivity to Catalyst Center on HTTPS port 8443 for application hosting to function.
Building Your IOx Package
Pre-built packages are coming soon. In the meantime, you must build your own package.tar that includes your deployment token. Follow the Building the IOx Package section in the ioxclient guide to create your package using the IOx SDE.
Once you have your package.tar, return here to deploy it via Catalyst Center.
Step 1: Install the Application Hosting Package
The Application Hosting feature must be installed on Catalyst Center before you can deploy IOx applications.
- Log in to Catalyst Center.
- Navigate to System > Software Updates > Installed Apps.
- Under Automation, locate Application Hosting.
- Click Install if not already installed.
- Wait for the installation to complete.
Step 2: Prepare Your Wireless Infrastructure
Verify Controller and AP Status
- Navigate to Provision > Inventory.
- Ensure your Wireless LAN Controllers show Managed status.
- Verify your Catalyst 9000 APs are discovered and managed.
Configure Site Hierarchy
- Navigate to Design > Network Hierarchy.
- Create or verify your site hierarchy.
- Assign WLCs and APs to appropriate sites.
Step 3: Upload the Orb Application
- Navigate to Provision > IoT Services > App Hosting.
- Click Add Application.
- Enter the application details:
- Application Name:
Orb Sensor - Description:
Network monitoring sensor
- Application Name:
- Click Choose File and select your
package.tarfile. - Click Upload.
Wait for the upload to complete. The application will appear in the application list.
Step 4: Deploy to Access Points
Select Target Access Points
- In IoT Services > App Hosting, select the Orb Sensor application.
- Click Enable IoT Services.
- Select the site(s) containing your target access points.
- Choose specific APs or select all APs at the site.
Configure Deployment Settings
Network Configuration:
- By default, applications use NAT with IP addresses from the 192.168.11.x/27 range
- For custom networking, configure the auxiliary-client interface on your WLC
Resource Allocation:
- CPU: 400 units
- Memory: 80 MB
- Disk: 10 MB
Review the configuration and click Deploy.
Step 5: Monitor Deployment Status
- Navigate to Provision > IoT Services > App Hosting.
- Select the Orb Sensor application.
- View the deployment status for each access point:
- DEPLOYING: Installation in progress
- RUNNING: Successfully deployed and running
- FAILED: Deployment failed (check logs for details)
View Application Details
- Click on a specific access point in the deployment list.
- Review:
- Application status
- Resource utilization
- Network connectivity
- Log output
Step 6: Verify Orb Registration
Once deployed, Orb sensors will automatically register with your account using the deployment token embedded in the package.
- Log in to your Orb dashboard at orb.net.
- Navigate to the Sensors page.
- Verify your Catalyst APs appear as registered sensors.
Network Architecture
Default NAT Configuration
By default, IOx applications on Catalyst APs:
- Receive IP addresses via DHCP from the 192.168.11.x/27 range
- Communicate externally through NAT using the AP's management IP
- Have internet access through the AP's uplink
Custom Network Segmentation
For deployments requiring traffic separation:
- On the WLC, configure an auxiliary-client interface (AHI)
- Assign a dedicated VLAN for IOx traffic
- Configure routing for the IOx VLAN
- Update the deployment to use the custom network
Managing Deployed Applications
Stopping an Application
- Navigate to IoT Services > App Hosting.
- Select the application.
- Select the target APs.
- Click Stop.
Removing an Application
- Stop the application on all APs.
- Select the application.
- Click Remove to uninstall from selected APs.
Updating an Application
- Upload the new version of the package.
- Stop the running application on target APs.
- Remove the old version.
- Deploy the new version.
Troubleshooting
Deployment Fails
If deployment fails on specific APs:
- Verify the AP has connectivity to Catalyst Center on port 8443
- Check the AP has sufficient resources (100 MB RAM available)
- Ensure IOS XE version meets minimum requirements (17.3.1+)
- Review Catalyst Center logs for detailed error messages
Application Shows FAILED Status
Common causes and solutions:
- Package size: Ensure the package is under 10 MB
- Architecture mismatch: Verify the package is built for aarch64
- Resource constraints: Check AP resource availability
- Network issues: Verify AP can reach external services
APs Not Appearing in IoT Services
If APs don't appear as deployment targets:
- Verify APs are in Managed status in Inventory
- Check the Application Hosting package is installed
- Ensure APs support IOx (Catalyst 9000 series only)
- Confirm IOS XE version compatibility
Orb Sensor Not Registering
If sensors deploy but don't appear in your Orb dashboard:
- Verify the deployment token is correct in the package
- Check the AP has internet connectivity
- Review application logs for connection errors
- Ensure DNS resolution is working on the AP
Limitations
- Maximum 2 concurrent applications per access point
- Package size limit of 10 MB
- Memory allocation of 100 MB per AP
- Requires non-NAT connectivity from APs to Catalyst Center
- USB storage support varies by model and PoE budget