CUCM None Device Analyzer

An automation tool for Cisco Unified Communications Manager (CUCM) administrators to identify, visualize, and report devices with a "None" (unregistered) status. By combining the AXL API for inventory and RISPort70 for real-time status queries, this tool helps optimize licensing and maintain a clean CUCM database.

Example output: bar chart showing model distribution of "None" status devices.

Table of Contents

• Use Case
• Features
• Prerequisites
• Installation
• Configuration
• Usage
• Sample Output
• Rate Limiting
• Known Issues
• Contributing
• Security
• Links & Resources
• License
• Contact

Use Case

In enterprise UC environments, CUCM databases accumulate devices that are no longer actively registered — phones from decommissioned sites, migrated endpoints, or devices that failed to re-register after configuration changes. These devices consume licenses and create noise in inventory reports.

This tool automates the detection process by:

1. Pulling all registered phone objects from CUCM via AXL (SOAP/XML)
2. Querying their live registration status via RISPort70 in real-time
3. Cross-referencing both sources to identify devices with no active registration (None status)
4. Generating a console table, a bar chart (sorted by model)

Outcome: Administrators can quickly identify which device models are most affected, take cleanup or troubleshooting actions, and reduce unnecessary license consumption.

Features

• AXL Integration: Automatically retrieves all device names and model information from the CUCM database.
• RISPort Real-Time Analysis: Queries the live registration status of each device.
• Visual Reporting: Generates a bar chart (via matplotlib) showing the count of "None" devices by model.
• Rate Limit Protection: Includes built-in delays between batch queries to protect CUCM services in large-scale environments.
• Graceful Error Handling: Automatically retries on rate limit errors without interrupting the scan.

Prerequisites

• Python 3.8+ (Download)
• Network access to your CUCM Publisher node on port 8443
• A CUCM user account with the following roles:
  • Standard AXL API Access
  • Standard RealtimeAndTraceCollection
• AXL and RISPort services enabled on CUCM

Installation

1. Clone the repository

git clone https://github.com/ErenKilinc1/CUCM-None-Device-Analyzer.git
cd CUCM-None-Device-Analyzer

2. Create and activate a virtual environment

macOS / Linux:

python3 -m venv venv
source venv/bin/activate

Windows:

python -m venv venv
venv\Scripts\activate

3. Install dependencies

pip install -r requirements.txt

Configuration

The scripts read credentials from environment variables. Create a .env file in the project root:

CUCM_IP=192.168.1.1
CUCM_USERNAME=axl_api_user
CUCM_PASSWORD=your_password_here
CUCM_VERSION=12.5

Security note: Never commit your .env file to version control. It is listed in .gitignore by default.

Usage

Ensure your virtual environment is active and your .env file is configured, then run either script:

Graphical model analysis (bar chart):

python none_devices_with_model.py

Scripts Overview

Sample Output

AXL: Fetching device and model information from database...
Success: 5420 devices ready for analysis.

#     | Device Name               | Model                       | Status
---------------------------------------------------------------------------
1     | SEP7A11C87D07C4           | Cisco 7841                  | None
2     | SEPEAF55C447BAB           | Cisco 840                   | None
3     | SEP8D9C22D03F88           | Cisco 7841                  | None
4     | SEP01188F574785           | Cisco 7911                  | None
5     | TCTUSER                   | Cisco Dual Mode for iPhone  | None
6     | SEPUSER                   | Cisco IP Communicator       | None
7     | SEP2C7BA3C22C8F           | Cisco 8851                  | None
8     | SEP00521A78DCAF           | Cisco 8851                  | None
9     | SEP00478D87A1F5           | Cisco 8851                  | None
10    | SEP36ACC9D4F2F4           | Cisco 9971                  | None
11    | SEP07006CE9D047           | Cisco 9971                  | None
12    | BOTUSER                   | Cisco Dual Mode for Android | None
---------------------------------------------------------------------------

After processing, a bar chart window opens automatically showing device counts grouped by model.

Rate Limiting

The RISPort70 API enforces request rate limits. The scripts automatically:

• Pause 4.5 seconds between every batch of 100 devices
• Wait an additional 15 seconds and retry if a rate limit error is detected

This ensures CUCM services (Tomcat/RIS) remain healthy even in large-scale deployments with 10,000+ devices.

Known Issues

• CUCM versions below 12.0 may require changes to the ciscoaxl initialization parameters and WSDL paths.
• Self-signed certificates on CUCM are expected; SSL verification is intentionally disabled via urllib3. In production, consider providing a proper CA bundle.
• The chart window requires a graphical display environment. On headless servers, switch to the Agg matplotlib backend.
• Very large deployments (10,000+ devices) will take significant time due to rate limiting.

Contributing

Contributions are welcome! Please read CONTRIBUTING.md for the full process.

Quick start:

1. Fork the repository
2. Create a feature branch: git checkout -b feature/my-improvement
3. Commit your changes with descriptive messages
4. Open a Pull Request against the main branch

Ideas for extensions:

• Export results to CSV or JSON
• Support for additional device classes (gateways, trunks, CTI route points)
• Filter by site, device pool, or calling search space
• Scheduled runs with alerting

Security

Please review our Security Policy before reporting vulnerabilities. Do not open public GitHub issues for security bugs — follow the responsible disclosure process described in SECURITY.md.

Links & Resources

DevNet Sandbox

Test this script against a live CUCM environment using the Cisco DevNet Sandboxes:

• Cisco Collaboration Sandboxes — Search for "Collaboration"

DevNet Learning Labs

• Introduction to AXL
• Cisco Collaboration APIs Overview
• Cisco CUCM AXL API Reference
• Cisco RISPort70 API Reference

Related Article

• Python & AXL API with Cisco CUCM Automation (Medium)

Dependencies

• ciscoaxl — Python library for CUCM AXL API
• zeep — Python SOAP client for RISPort70
• matplotlib — Bar chart visualization

Getting Help

If you encounter issues:

• Open an issue in the GitHub Issues tab
• Visit the Cisco DevNet Community

License

This project is licensed under the MIT License — see the LICENSE file for details.

Contact

Abdullah Eren Kilinc

• Medium: Python & AXL API — Cisco CUCM Automation
• Project Link: https://github.com/ErenKilinc1/CUCM-None-Device-Analyzer