Calix SMx

This guide includes instructions for creating an SMx API user to connect Calix SMx to Layer 9.

Prerequisites

• Access to SMx with administrator privileges
• Ability to create users and manage the Accept List
• The SMx API reachable on its management interface (default port 18443)

Step 1: Create an SMx User

Create a dedicated user for Layer 9 rather than reusing an operator login, so audit logs stay clear about which actions came from the integration.

Grant the user permission to read device and ONT configuration. If Layer 9 will also collect syslog from your OLTs, additionally grant permission to modify syslog host configuration.

The user authenticates with HTTP Basic — the same username and password used to log in to the SMx UI. There is no separate API key to generate.

Instructions for creating users and roles can be found in the SMx System Administrator Guide: Creating Users and Creating Roles.

Step 2: Add the Collector to the Accept List

SMx restricts API access by source IP, and entries are tied to a specific user. Add the IP address of the Layer 9 collector virtual machine on your network — the same machine that runs the Telegraf SNMP collector. The Layer 9 team will provide the address.

1. Open the System tab
2. Expand System Accept/Block List Management
3. Open Accept List Configuration and create an entry
4. Bind the entry to the user created in Step 1

See Managing Accept and Block Lists.

Step 3: Share Credentials with Layer 9

Share the following with the Layer 9 team:

• The SMx hostname or IP address, and the port if it is not 18443
• The username and password for the user created in Step 1

Reference

• AXOS SMx Northbound Interface API Guide
• Creating Users
• Creating Roles
• Managing Accept and Block Lists