---
title: "Provisioning Vendors Module Documentation"
description: "Documentation for Vendors"
---

## Table of Contents
1. [Navigation & Access](#navigation--access)
2. [Screenshots & Visual Interface](#screenshots--visual-interface)
3. [Module Overview (Technical)](#1-module-overview-technical)
4. [Module Overview (Commercial/Business)](#2-module-overview-commercialbusiness)
5. [Module Overview (End User/Administrator)](#3-module-overview-end-useradministrator)
6. [User Roles & Key Capabilities](#-user-roles--key-capabilities)
7. [Provisioning System Context](#4-provisioning-system-context)
8. [Common Scenarios & Examples](#5-common-scenarios--examples)
9. [Limitations & Important Notes](#6-limitations--important-notes)
10. [Model Context Protocol (MCP) AI Integration](#model-context-protocol-mcp-ai-integration)
11. [Troubleshooting Tips](#7-troubleshooting-tips)
12. [Glossary](#8-glossary)
---

## Navigation & Access

To access the Provisioning Vendors configuration module:
1. Log in to the Ring2All Web Portal (`https://<domain-or-ip>/login`).
2. In the left navigation sidebar, expand **Settings**.
3. Under **Provisioning**, click **Vendors** (`/settings/provisioning/provisioning-vendors`).
4. To view or edit hardware vendor specifications, click on any vendor row or click the **Edit** action button (`/settings/provisioning/provisioning-vendors/:id`).

---

## Screenshots & Visual Interface

### Provisioning Vendors Catalog Overview
Global inventory of certified VoIP hardware manufacturers, showing manufacturer brand names, official websites, linked device model counts, and configuration actions.
![Provisioning Vendors List](/screenshots/settings/provisioning/vendors-list.png)

### Provisioning Vendor Configuration & Protocol Management
Detailed vendor definition view managing brand identities, support URLs, MAC OUI prefixes, supported provisioning protocols (HTTP, HTTPS, TFTP, FTP), and redirection parameters.
![Provisioning Vendor Form](/screenshots/settings/provisioning/vendors-form.png)

---

## 1. Module Overview (Technical)

### What Are Provisioning Vendors?

Provisioning Vendors is a **phone manufacturer management module** that maintains the list of supported IP phone brands in the auto-provisioning system. Vendors are the top level of the device hierarchy.

### Architecture

```
┌─────────────────────────────────────────────────────────────────┐
│             Provisioning System Architecture                   │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Provisioning Hierarchy:                                        │
│                                                                 │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Provisioning Vendors                              │   │
│  │                                                          │   │
│  │  ├─ Yealink                                             │   │
│  │  ├─ Grandstream                                         │   │
│  │  ├─ Polycom                                             │   │
│  │  ├─ Cisco                                               │   │
│  │  ├─ Fanvil                                              │   │
│  │  └─ Snom                                                │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Has many models                                        │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Device Models                                     │   │
│  │                                                          │   │
│  │  ├─ Yealink T54W                                        │   │
│  │  ├─ Yealink T46U                                        │   │
│  │  ├─ Grandstream GXP2170                                 │   │
│  │  └─ ...                                                 │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│       │                                                         │
│       ▼ Used in templates and devices                          │
│  ┌──────────────────────────────────────────────────────────┐   │
│  │        Templates → Devices                               │   │
│  │                                                          │   │
│  │  Template (Yealink T54W) → Device (MAC: AA:BB:CC:...)   │   │
│  │                                                          │   │
│  └──────────────────────────────────────────────────────────┘   │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘
```

---

## 2. Module Overview (Commercial/Business)

### Business Value

Provisioning Vendors provides **manufacturer organization**:

| Without Vendors | With Vendors |
|-----------------|--------------|
| Flat device list | Organized hierarchy |
| No brand grouping | Vendor-based filtering |
| Manual tracking | Centralized catalog |
| No consistency | Standardized naming |

### Use Cases

1. **Multi-vendor Deployments**
   - Support multiple phone brands
   - Organize by manufacturer

2. **Model Management**
   - Group models by vendor
   - Consistent identification

3. **Template Organization**
   - Filter templates by vendor
   - Vendor-specific settings

4. **Device Inventory**
   - Track devices by brand
   - Reporting by vendor

### Feature Highlights

| Feature | Benefit |
|---------|---------|
| **Vendor Catalog** | Complete manufacturer list |
| **Model Grouping** | Organized by brand |
| **CRUD Operations** | Add/edit/delete vendors |
| **Device Count** | Track devices per vendor |

---

## 3. Module Overview (End User/Administrator)

### What Can You Do?

- View all supported phone vendors
- Add new vendors/manufacturers
- Edit vendor information
- Delete unused vendors
- See associated device models

### Provisioning Vendors Interface

```
┌─────────────────────────────────────────────────────────────────┐
│              Provisioning Vendors                               │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  [+ Create Vendor]                                              │
│                                                                 │
│  [🔍 Search vendors...]                                         │
│                                                                 │
│  ┌───────────────────────────────────────────────────────────┐  │
│  │ Vendor Name     │ Models │ Devices │ Status  │ Actions   │  │
│  ├─────────────────┼────────┼─────────┼─────────┼───────────┤  │
│  │ Yealink         │ 15     │ 45      │ ✓ Active│ ✏️ 🗑     │  │
│  │ Grandstream     │ 12     │ 30      │ ✓ Active│ ✏️ 🗑     │  │
│  │ Polycom         │ 8      │ 12      │ ✓ Active│ ✏️ 🗑     │  │
│  │ Cisco           │ 10     │ 8       │ ✓ Active│ ✏️ 🗑     │  │
│  │ Fanvil          │ 9      │ 20      │ ✓ Active│ ✏️ 🗑     │  │
│  │ Snom            │ 7      │ 5       │ ✓ Active│ ✏️ 🗑     │  │
│  └───────────────────────────────────────────────────────────┘  │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘
```

### Create/Edit Vendor

```
┌─────────────────────────────────────────────────────────────────┐
│              Create Vendor                                      │
├─────────────────────────────────────────────────────────────────┤
│                                                                 │
│  Vendor Name: [Yealink                      ]                  │
│                                                                 │
│  Description: [Leading IP phone manufacturer]                  │
│                                                                 │
│  Website: [https://www.yealink.com         ]                   │
│                                                                 │
│  Logo: [📤 Upload]                                              │
│                                                                 │
│  Status: [Active ▼]                                            │
│                                                                 │
│  [Save] [Cancel]                                                │
│                                                                 │
└─────────────────────────────────────────────────────────────────┘
```

### Quick Tips

> [!TIP]
> **Pre-populated**: Common vendors are typically pre-installed.

> [!TIP]
> **Add Custom**: Create vendors for less common phone brands.

> [!NOTE]
> **Dependencies**: Cannot delete vendors with associated models.

---

## 🎯 User Roles & Key Capabilities

| Role | Key Capabilities & Permissions | Operational Scope |
| :--- | :--- | :--- |
| **PBX Super Administrator** | • Global VoIP hardware vendor catalog administration and OUI prefix maintenance<br>• Creation, update, and deletion of vendor brand profiles and support portal endpoints<br>• Protocol compliance enforcement (HTTP, HTTPS, TFTP, FTP) and redirect service configuration<br>• Dependency validation preventing accidental removal of vendors with active linked models | Platform-Wide |
| **Tenant Administrator** | • Read-only catalog browsing of certified hardware manufacturers<br>• Vendor compatibility audit for prospective IP phone procurement<br>• Selection of preferred vendor hardware for tenant-wide device deployments | Domain Scope |
| **Field Engineer / VoIP Technician** | • Review of certified manufacturer support URLs, firmware directories, and MAC OUI prefixes<br>• On-site device hardware verification against the global vendor registry | Platform / Field |
| **AI Copilot / MCP Agent** | • Autonomous hardware manufacturer discovery (`list_provisioning_vendors`)<br>• Model compatibility validation during automated device onboarding workflows | Autonomous Assistant |

---

## 4. Provisioning System Context

### Related Modules

| Module | Purpose |
|--------|---------|
| **Provisioning Vendors** | Phone manufacturers |
| **Device Models** | Specific phone models |
| **Provisioning Templates** | Configuration templates |
| **Provisioning Devices** | Individual phones |
| **Provisioning Security** | Auth settings |

### Data Flow

```
Vendor → Model → Template → Device
   │        │        │         │
Yealink → T54W → Sales Phone → MAC: AA:BB:CC:DD:EE:FF
```

### Supported Vendors

| Vendor | Common Models |
|--------|---------------|
| **Yealink** | T54W, T46U, T42S, W60B |
| **Grandstream** | GXP2170, GXP2160, GRP2612 |
| **Polycom** | VVX450, VVX350, VVX150 |
| **Cisco** | 7861, 7841, 8851 |
| **Fanvil** | X6U, X5U, X4U |
| **Snom** | D385, D335, D715 |

---

## 5. Common Scenarios & Examples

### Scenario 1: View Vendors

1. Navigate to Provisioning → Vendors
2. Browse vendor list
3. See models and device counts

### Scenario 2: Add New Vendor

1. Click "Create Vendor"
2. Enter vendor name
3. Add description (optional)
4. Upload logo (optional)
5. Save

### Scenario 3: Edit Vendor

1. Find vendor in list
2. Click Edit
3. Update information
4. Save

### Scenario 4: Delete Vendor

1. Find unused vendor
2. Verify no associated models
3. Click Delete
4. Confirm deletion

---

## 6. Limitations & Important Notes

### Technical Notes

> [!NOTE]
> **System Vendors**: Some vendors may be system-defined.

> [!NOTE]
> **Model Dependency**: Vendors with models cannot be deleted.

> [!WARNING]
> **Careful Deletion**: Ensure no dependencies before deleting.

### Best Practices

1. **Use Standard Names**: Match official vendor names
2. **Add Logos**: Visual identification in lists
3. **Keep Updated**: Add new vendors as needed
4. **Don't Duplicate**: One entry per manufacturer
5. **Check Dependencies**: Before deleting

### Common Vendor Names

| Standard Name | Avoid |
|---------------|-------|
| Yealink | YeaLink, YEALINK |
| Grandstream | GrandStream, Grand Stream |
| Polycom | PolycomInc, Poly |
| Cisco | CISCO, Cisco Systems |

---

## Model Context Protocol (MCP) AI Integration

The **Provisioning Vendors** module provides Model Context Protocol (MCP) integration allowing AI Copilots, VoIP provisioning assistants, and automation bots to query certified hardware manufacturer catalogs in real time.

### Available MCP Telephony Tools

| Tool Name | Action Type | Access Level | Description |
| :--- | :--- | :--- | :--- |
| `list_provisioning_vendors` | `READ` | `Read-Only` | Lists all supported VoIP hardware vendors/manufacturers, including brand name, description, and website URL. |

### Tool Schemas & Input Parameters

#### `list_provisioning_vendors`
Lists all certified VoIP hardware manufacturers available in the auto-provisioning catalog.

```json
{
  "name": "list_provisioning_vendors",
  "description": "Lists all supported VoIP hardware vendors/manufacturers (e.g., Yealink, Grandstream, Cisco, Polycom, Fanvil) in Ring2All PBX.",
  "parameters": {
    "type": "object",
    "properties": {},
    "additionalProperties": false
  }
}
```

### Natural Language Prompt Examples

#### English Prompts
> 💬 "List all supported IP phone vendors in the provisioning catalog."
> 💬 "Which VoIP phone manufacturers are certified for auto-provisioning on Ring2All?"
> 💬 "Show me the manufacturer details and official website for Grandstream and Yealink."

#### Spanish Prompts (Español)
> 💬 "Lista todos los fabricantes de teléfonos VoIP soportados en el catálogo de aprovisionamiento."
> 💬 "¿Cuáles marcas de terminales SIP están certificadas para aprovisionamiento automático en Ring2All?"
> 💬 "Muestra los detalles de fabricantes y sitios oficiales registrados en la plataforma."

### Enterprise Safeguards & Compliance

- **Immutable Manufacturer Registry**: Global vendor definitions are protected by referential integrity. Deleting a vendor is strictly prohibited if child models or active provisioned devices exist in the system.
- **RBAC Enforcement**: Calling `list_provisioning_vendors` requires at least read-only administrative access (`auxiliary_devices` MCP permission scope).
- **Audit Logging**: All queries and manufacturer modifications are recorded in the PBX administrative audit log with caller ID, timestamp, and IP origin.

---

## 7. Troubleshooting Tips

### Common Issues

| Symptom | Possible Cause | Solution |
|---------|---------------|----------|
| Can't delete | Has models | Remove models first |
| Duplicate vendor | Already exists | Edit existing |
| Logo not showing | Invalid format | Use PNG/JPG |
| Vendor not in list | Not created | Create vendor |

### Check Vendor Data

```sql
SELECT 
  id,
  name,
  description,
  enabled
FROM public.provisioning_vendors
ORDER BY name;
```

### Check Model Count

```sql
SELECT 
  v.name AS vendor,
  COUNT(m.id) AS model_count
FROM public.provisioning_vendors v
LEFT JOIN public.provisioning_device_models m ON m.vendor_id = v.id
GROUP BY v.id, v.name
ORDER BY v.name;
```

---

## 8. Glossary

| Term | Definition |
|------|------------|
| **Vendor** | Phone manufacturer/brand |
| **Model** | Specific phone model |
| **Template** | Configuration template |
| **Provisioning** | Automatic phone configuration |
| **MAC Address** | Device hardware identifier |

---

*Documentation last updated: January 2026*