Ctrl K
ring2all.com

Provisioning Devices Module Documentation

Table of Contents

  1. Module Overview (Technical)
  2. Module Overview (Commercial/Business)
  3. Module Overview (End User/Administrator)
  4. Configuration Sections
  5. Settings Reference
  6. Common Scenarios & Examples
  7. Limitations & Important Notes
  8. Troubleshooting Tips
  9. Glossary

---

1. Module Overview (Technical)

What Are Provisioning Devices?

Provisioning Devices is a device inventory and configuration module that manages individual IP phones. Each device is identified by MAC address, linked to a template, and can have SIP accounts and custom configuration overrides.

Architecture

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│            Provisioning Devices Architecture                  │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Admin Panel                                                    │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Provisioning Devices                              │   │
│  │                                                          │   │
│  │  Device Entry:                                           │   │
│  │  ├─ MAC Address: AA:BB:CC:DD:EE:FF                      │   │
│  │  ├─ Vendor/Model: Yealink T54W                          │   │
│  │  ├─ Template: Sales Team                                │   │
│  │  ├─ SIP Accounts: Line 1 → Ext 1001                    │   │
│  │  └─ Custom Overrides (optional)                         │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Template + Device variables                            │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Configuration Generator                           │   │
│  │                                                          │   │
│  │  Template (Jinja2) + Device Data → Config File          │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Stored for retrieval                                   │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Provisioning Server                               │   │
│  │                                                          │   │
│  │  /provisioning/AABBCCDDEEFF.cfg                         │   │
│  │                                                          │   │
│  │  Phone boots → Requests config → Gets personalized file │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Key Tables

TablePurpose
public.provisioning_devicesDevice inventory

Key Files

FileDescription
modules/provisioningDevices/Frontend module
/var/www/provisioning/.cfgGenerated config files
---

2. Module Overview (Commercial/Business)

Business Value

Provisioning Devices provides centralized device management:

Without DevicesWith Devices
Manual configAuto-provisioning
No inventoryComplete inventory
Static configsDynamic templates
Unknown IPsAuto-detected IPs

Use Cases

  1. Device Inventory

- Track all phones

- Record MAC addresses

  1. Template Assignment

- Apply standard config

- Customize per device

  1. SIP Account Setup

- Assign extensions

- Multi-line support

  1. Network Discovery

- Scan for devices

- Auto-detect phones

Feature Highlights

FeatureBenefit
MAC RegistrationDevice identification
Template LinkingConsistent config
SIP AccountsLine assignment
Custom OverridesPer-device changes
Network ScanDevice discovery
Config PreviewVerify before deploy
---

3. Module Overview (End User/Administrator)

What Can You Do?

  • Add devices by MAC address
  • Assign vendor/model/template
  • Configure SIP accounts per line
  • Override DSS keys, phonebook, expansion
  • Scan network for devices
  • Import devices in bulk
  • Preview generated configuration

Provisioning Devices Interface

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Provisioning Devices                               │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  [+ Add Device] [🔍 Scan Network] [📥 Import]                   │
│                                                                 │
│  ┌───────────────────────────────────────────────────────────┐  │
│  │ MAC Address      │ Vendor    │ Model  │ Template   │ IP    │ │
│  ├──────────────────┼───────────┼────────┼────────────┼───────┤ │
│  │ AA:BB:CC:DD:EE:01│ Yealink   │ T54W   │ Sales Team │ Auto  │ │
│  │ AA:BB:CC:DD:EE:02│ Yealink   │ T54W   │ Sales Team │ Auto  │ │
│  │ 11:22:33:44:55:01│ Grandstream│ GXP2170│ Reception │ Auto  │ │
│  │ CC:DD:EE:FF:00:01│ Polycom   │ VVX450 │ Conf Room │ Auto  │ │
│  └───────────────────────────────────────────────────────────┘  │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Add/Edit Device

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Add Device                                         │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  MAC Address: [AA:BB:CC:DD:EE:FF      ]                        │
│    Format XX:XX:XX:XX:XX:XX                                     │
│                                                                 │
│  Description: [John Smith's desk phone]                        │
│                                                                 │
│  Vendor: [Yealink ▼]                                           │
│  Model: [T54W ▼]                                               │
│  Template: [Sales Team ▼]                                      │
│                                                                 │
│  IP Address: [192.168.1.100    ] (Auto-detected)               │
│                                                                 │
│  Provisioning URL: https://pbx.example.com/provisioning/       │
│                    AABBCCDDEEFF.cfg    [📋 Copy]               │
│                                                                 │
│  ──────────────────────────────────────────────────────────────│
│                                                                 │
│  SIP Accounts                                                   │
│  This model supports 16 SIP account(s)                         │
│                                                                 │
│  ┌─────────────────────────────────────────────────────────────┐│
│  │ Line │ Extension     │                                     ││
│  ├──────┼───────────────┼─────────────────────────────────────┤│
│  │ 1    │ [1001 ▼]      │ John Smith                          ││
│  │ 2    │ [Select ▼]    │ -                                   ││
│  │ 3    │ [Select ▼]    │ -                                   ││
│  └─────────────────────────────────────────────────────────────┘│
│                                                                 │
│  2 of 16 accounts configured                                   │
│                                                                 │
│  ──────────────────────────────────────────────────────────────│
│                                                                 │
│  Configuration:                                                 │
│  DSS Keys: ○ Using Template Configuration  ● Custom            │
│  Phonebook: ● Using Template Phonebook  ○ Custom               │
│  Expansion: ● Using Template Expansion  ○ Custom               │
│                                                                 │
│  [👁 Preview Config] [Save] [Cancel]                           │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Network Scan

Plaintext
┌─────────────────────────────────────────────────────────────────┐
│              Scan Network                                       │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Scan your network CIDR range to discover compatible devices.  │
│                                                                 │
│  CIDR Range: [192.168.1.0/24           ] [🔍 Scan]             │
│                                                                 │
│  Detected Devices:                                              │
│  ┌─────────────────────────────────────────────────────────────┐│
│  │ ☐ │ MAC Address       │ IP          │ Vendor    │ Model   ││
│  ├───┼───────────────────┼─────────────┼───────────┼─────────┤│
│  │ ✓ │ AA:BB:CC:DD:EE:10 │ 192.168.1.50│ Yealink   │ T54W    ││
│  │ ✓ │ AA:BB:CC:DD:EE:11 │ 192.168.1.51│ Yealink   │ T46U    ││
│  │ ☐ │ 11:22:33:44:55:10 │ 192.168.1.60│ Grandstream│ Unknown││
│  └─────────────────────────────────────────────────────────────┘│
│                                                                 │
│  [Import Selected]                                              │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘

Quick Tips

TIP
MAC Format: Use XX:XX:XX:XX:XX:XX format exactly.
TIP
Preview First: Preview config before deploying to phone.
NOTE
Template Inheritance: Customize only when needed.

---

4. Configuration Sections

Basic Information

FieldDescription
MAC AddressDevice unique identifier
DescriptionUser/location notes
VendorPhone manufacturer
ModelSpecific phone model
TemplateConfiguration template
IP AddressAuto-detected IP

SIP Accounts

FieldDescription
LinePhone line number
ExtensionAssigned SIP extension

Configuration Overrides

SectionOptions
DSS KeysTemplate or Custom
PhonebookTemplate or Custom
ExpansionTemplate or Custom
---

5. Settings Reference

MAC Address Format

FormatExample
Colon-separatedAA:BB:CC:DD:EE:FF
Hyphen-separatedAA-BB-CC-DD-EE-FF
No separatorAABBCCDDEEFF

Template vs Custom

ModeDescription
TemplateInherits from template
CustomDevice-specific overrides

Provisioning URL

Plaintext
https://server/provisioning/{MAC}.cfg

---

6. Common Scenarios & Examples

Scenario 1: Add Single Device

  1. Click "Add Device"
  2. Enter MAC address
  3. Select vendor, model, template
  4. Assign SIP account(s)
  5. Preview and save

Scenario 2: Network Discovery

  1. Click "Scan Network"
  2. Enter CIDR range (e.g., 192.168.1.0/24)
  3. Click Scan
  4. Select discovered devices
  5. Click Import Selected

Scenario 3: Custom DSS Keys

  1. Edit device
  2. Change DSS Keys to "Custom"
  3. Configure keys specific to this device
  4. Save

Scenario 4: Preview Configuration

  1. Edit device
  2. Click "Preview Config"
  3. Verify generated configuration
  4. Save if correct

---

7. Limitations & Important Notes

Technical Notes

NOTE
Auto-IP: IP address updates when phone contacts server.
NOTE
Model Required: Select model before configuring accounts.
WARNING
MAC Unique: Each MAC address must be unique.

Best Practices

  1. Use Templates: Override only when necessary
  2. Description: Add meaningful descriptions
  3. Preview: Always preview before saving
  4. Scan Regularly: Find new devices
  5. Document: Keep inventory current

Network Scan Requirements

RequirementNotes
Same NetworkServer must reach devices
CIDR FormatUse 192.168.1.0/24 format
MAC PrefixesVendors must have OUI configured
---

8. Troubleshooting Tips

Common Issues

SymptomPossible CauseSolution
Phone not provisioningWrong MACVerify MAC address
Config not appliedTemplate errorPreview config
Scan finds nothingWrong CIDRCheck network range
Extension not workingAccount not assignedCheck SIP accounts

Check Device

Sql
SELECT 
  d.mac_address,
  m.model_name,
  t.name AS template,
  d.settings
FROM public.provisioning_devices d
JOIN public.provisioning_device_models m ON m.id = d.model_id
JOIN public.provisioning_templates t ON t.id = d.template_id
WHERE d.mac_address = 'AA:BB:CC:DD:EE:FF';

Test Provisioning URL

Bash
# Test device config retrieval
curl https://server/provisioning/AABBCCDDEEFF.cfg

Phone-side Verification

  1. Access phone web interface
  2. Check provisioning URL setting
  3. Verify credentials (if auth enabled)
  4. Force provisioning/reboot

---

9. Glossary

TermDefinition
MAC AddressHardware identifier
ProvisioningAuto-configuration
TemplateConfiguration base
OverrideDevice-specific change
CIDRNetwork range notation
SIP AccountExtension registration
---

Lua Script Status ℹ️

Configuration Module

ComponentStatus
Provisioning Devicesℹ️ Device inventory - generates config files from templates
Provisioning Devices is a configuration module. Device data is merged with templates to generate configuration files. No Lua handlers are used - config files are served via HTTP.

---

Documentation last updated: January 2026*

AI Assistant

👋 Hello! I'm your Ring2All documentation assistant. I can help you find information about configuring and using the Ring2All PBX platform.

How can I help you today?