CMS-NBI-CLIENT

Modern async Python client for Calix Management System (CMS) Northbound Interface (NBI) with full HTTPS support, connection pooling, circuit breakers, and structured logging.

Note: This package is not owned, supported, or endorsed by Calix. It's an independent implementation for interacting with CMS NBIs.

Features

• Modern Async/Await: Built on aiohttp for high-performance async operations
• HTTPS Support: Full TLS/SSL support with certificate validation
• Connection Pooling: Reuse connections for better performance
• Circuit Breaker: Automatic failure detection and recovery
• Structured Logging: Rich logs with structlog for better debugging
• Type Safety: Full type hints and Pydantic validation
• Secure Storage: Encrypted credential storage using system keyring
• XML Security: Protection against XXE and other XML attacks
• Comprehensive Testing: High test coverage with pytest
• Backward Compatible: Sync wrapper for legacy code

Quick Start

Installation

pip install cms-nbi-client

Basic Usage

import asyncio
from cmsnbiclient import CMSClient, Config

# Modern async usage
async def main():
    config = Config(
        credentials={
            "username": "your_username",
            "password": "your_password"
        },
        connection={
            "host": "cms.example.com"
        }
    )
    
    async with CMSClient(config) as client:
        # Create ONT
        result = await client.e7.create_ont(
            network_name="NTWK-1",
            ont_id="123",
            admin_state="enabled"
        )
        print(result)

# Run async code
asyncio.run(main())

# Synchronous usage (backward compatible)
with CMSClient.sync(config) as client:
    result = client.e7.query_ont(
        network_name="NTWK-1",
        ont_id="123"
    )
    print(result)

Configuration

Configuration can be provided via:

• Direct instantiation
• Environment variables
• Configuration files (JSON/YAML)

# Environment variables
export CMS_USERNAME=your_username
export CMS_PASSWORD=your_password
export CMS_CONNECTION__HOST=cms.example.com
export CMS_CONNECTION__VERIFY_SSL=true

# From file
config = Config.from_file("config.yaml")

Advanced Features

Connection Pooling

config = Config(
    performance={
        "connection_pool_size": 100,
        "max_concurrent_requests": 50
    }
)

Circuit Breaker

config = Config(
    performance={
        "enable_circuit_breaker": True,
        "circuit_breaker_threshold": 5,
        "circuit_breaker_timeout": 60
    }
)

Structured Logging

from cmsnbiclient import setup_logging

# JSON logs for production
setup_logging(log_level="INFO", json_logs=True)

# Pretty logs for development
setup_logging(log_level="DEBUG", json_logs=False)

Documentation

For detailed documentation and examples, see the /Examples folder.

Available Operations

E7 Operations

• Create: ONT, VLAN, VLAN Members, Ethernet Services
• Delete: ONT, VLAN, VLAN Members, Ethernet Services
• Query: System info, ONT profiles, VLANs, DHCP leases
• Update: ONT configuration, Ethernet services

REST Operations

• Device queries
• System information

Development

Setup Development Environment

# Install poetry
pip install poetry

# Install dependencies
poetry install

# Run tests
poetry run pytest

# Run linting
poetry run black .
poetry run isort .
poetry run flake8
poetry run mypy .

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run tests and linting
5. Submit a pull request

Resources

Official Calix Documentation

• Calix Management System (CMS) R14.1 Northbound Interface API Guide
• Calix E-Series (E7 OS R2.5) Engineering and Planning Guide
• Paul Clark's website contains a good amount of Calix docs
• FOR CURRENT CALIX DOCUMENTATION YOU WILL NEED A CALIX ACCOUNT TO GAIN ACCESS TO THEIR LIBRARY

Authors

• @somenetworking

License

GPL-3.0

Changelog

See CHANGELOG.md for version history.