Groups: Difference between revisions

From VoIPmonitor.org
(Add documentation for SIP history group checkbox to merge private and public IPs in SIP ladder view)
(Add GUI refresh requirement after creating new groups)
Line 45: Line 45:


The '''SIP history group''' checkbox merges private and public IP addresses into a single column in the SIP ladder/history view. This is particularly useful for devices behind NAT (Network Address Translation) where the SIP signaling shows public IP addresses while RTP media uses private IP addresses.
The '''SIP history group''' checkbox merges private and public IP addresses into a single column in the SIP ladder/history view. This is particularly useful for devices behind NAT (Network Address Translation) where the SIP signaling shows public IP addresses while RTP media uses private IP addresses.
==== Important: GUI Refresh Required ====
After creating a new IP group, telephone number group, or email group, the group may not immediately appear in dropdown lists used throughout the GUI (such as CDR filter templates, alert configurations, or charts). This is because the GUI loads available groups at login time.
'''Solution:'''
If you create a new group and it is not visible in the grouping list or dropdown:
# Log out of the GUI
# Log back in
# The newly created group will now appear in all relevant dropdowns
This applies to all group types (IP, telephone numbers, and emails) when used in:
* CDR filter templates (Caller Groups, Called Groups dropdowns)
* Alert configurations
* Charts filters
* Any GUI component that groups are used in


When enabled:
When enabled:
Line 219: Line 235:
== AI Summary for RAG ==
== AI Summary for RAG ==


'''Summary:''' This page explains how to configure Groups (IP addresses, telephone numbers, and emails) in VoIPmonitor. IP groups support Trunk, Server, and SIP history group checkboxes: Trunk and Server checkboxes classify call direction (Outbound: callerIP in Server group and calledIP in Trunk group; Inbound: callerIP in Trunk group and calledIP in Server group); The SIP history group checkbox merges private and public IPs in the SIP ladder/history view for devices behind NAT, consolidating duplicate flows into a single display. These groups are used in CDR filter templates for capacity planning and reporting. Telephone number groups support manual entry, import/export, and regular expression patterns for matching number ranges or specific patterns (e.g., containing letters, international prefixes). Email groups are used for alert and report distribution.
'''Summary:''' This page explains how to configure Groups (IP addresses, telephone numbers, and emails) in VoIPmonitor. IP groups support Trunk, Server, and SIP history group checkboxes: Trunk and Server checkboxes classify call direction (Outbound: callerIP in Server group and calledIP in Trunk group; Inbound: callerIP in Trunk group and calledIP in Server group); The SIP history group checkbox merges private and public IPs in the SIP ladder/history view for devices behind NAT, consolidating duplicate flows into a single display. These groups are used in CDR filter templates for capacity planning and reporting. Telephone number groups support manual entry, import/export, and regular expression patterns for matching number ranges or specific patterns (e.g., containing letters, international prefixes). Email groups are used for alert and report distribution. '''Important:''' After creating a new group (IP, telephone number, or email), the GUI requires a logout and login refresh for the group to appear in dropdown lists throughout the application (CDR filters, alerts, charts).


'''Keywords:''' groups, IP groups, telephone numbers, tel numbers, email groups, SIP trunks, alerts, filters, import, export, CDR filter, Caller Groups, Called Groups, Trunk checkbox, Server checkbox, SIP history group, inbound calls, outbound calls, internal calls, capacity planning, callerIP, calledIP, CDR filter templates, IP anonymize, rewrite rules, GDPR, privacy, IP masking, network anonymization, NAT, network address translation, SIP ladder, SIP history view, duplicate flows, private IP, public IP, consolidate flows, SIP history tab, NAT device, call flow display, regex patterns, regular expressions, number filtering, anti-fraud alerts, telephone number groups in alerts, malformed caller IDs
'''Keywords:''' groups, IP groups, telephone numbers, tel numbers, email groups, SIP trunks, alerts, filters, import, export, CDR filter, Caller Groups, Called Groups, Trunk checkbox, Server checkbox, SIP history group, inbound calls, outbound calls, internal calls, capacity planning, callerIP, calledIP, CDR filter templates, IP anonymize, rewrite rules, GDPR, privacy, IP masking, network anonymization, NAT, network address translation, SIP ladder, SIP history view, duplicate flows, private IP, public IP, consolidate flows, SIP history tab, NAT device, call flow display, regex patterns, regular expressions, number filtering, anti-fraud alerts, telephone number groups in alerts, malformed caller IDs
Line 240: Line 256:
* Can I use regular expressions in telephone number groups?
* Can I use regular expressions in telephone number groups?
* How to create a telephone number group for numbers containing letters?
* How to create a telephone number group for numbers containing letters?
* Why is my new IP group not visible in the CDR grouping list after creating it?
* Do I need to refresh the GUI after creating a new group?

Revision as of 08:52, 6 January 2026


Groups define sets of IP addresses/networks, telephone numbers/prefixes, and emails. These can be used across the WEB GUI for filtering CDRs, configuring alerts, and other features. Groups allow you to manage large collections of identifiers efficiently and reuse them across multiple configurations.

Overview

VoIPmonitor supports three types of groups:

Group Type Use Cases Access Path
IP Groups Define SIP trunks, filter by source/destination IP, distinguish internal/external calls GUI → Groups → IPs
Telephone Number Groups Filter CDRs by caller/called numbers, alert on specific number ranges GUI → Groups → Tel. numbers
Email Groups Define recipients for alerts and reports GUI → Groups → Emails
Groups management interface
Groups management interface

IP Groups

IP Groups allow you to define sets of IP addresses or network ranges that can be used in CDR filters and alerts.

Creating IP Groups

  1. Navigate to GUI → Groups → IPs
  2. Click "New group"
  3. Enter a descriptive group name (e.g., "Provider A SIP Trunk" or "Internal PBX Servers")
  4. Add IP addresses or CIDR ranges, one per line
  5. Configure the Trunk, Server, or SIP history group checkboxes as applicable (see below)
  6. Save the group

Trunk Checkbox

The Trunk checkbox is an important feature for IP groups. When enabled, it marks the IPs in this group as belonging to an external SIP trunk (e.g., your VoIP provider) or carrier.

Server Checkbox

The Server checkbox marks IPs in this group as belonging to your internal PBX servers or VoIP infrastructure. This is used in conjunction with the Trunk checkbox to accurately classify call direction.

SIP History Group Checkbox

The SIP history group checkbox merges private and public IP addresses into a single column in the SIP ladder/history view. This is particularly useful for devices behind NAT (Network Address Translation) where the SIP signaling shows public IP addresses while RTP media uses private IP addresses.

Important: GUI Refresh Required

After creating a new IP group, telephone number group, or email group, the group may not immediately appear in dropdown lists used throughout the GUI (such as CDR filter templates, alert configurations, or charts). This is because the GUI loads available groups at login time.

Solution: If you create a new group and it is not visible in the grouping list or dropdown:

  1. Log out of the GUI
  2. Log back in
  3. The newly created group will now appear in all relevant dropdowns

This applies to all group types (IP, telephone numbers, and emails) when used in:

  • CDR filter templates (Caller Groups, Called Groups dropdowns)
  • Alert configurations
  • Charts filters
  • Any GUI component that groups are used in

When enabled:

  • The GUI treats all IPs in this group as belonging to the same logical endpoint
  • Duplicate flows showing both private and public IPs are consolidated into a single display
  • Call flows in the SIP History tab become easier to read and analyze

Use Case Example: For a SIP trunk behind NAT where:

  • Public IP: 1.2.3.4 (appears in SIP signaling)
  • Private IP: 10.0.0.3 (actual device IP)

Create a group and add both IP addresses, then enable the SIP history group checkbox. The GUI will merge these into a single column in the SIP ladder view instead of showing duplicate flows.

=== Call Direction Classification

Using both Trunk and Server checkboxes, you can create precise CDR filter templates for differentiating inbound and outbound traffic:

  • Outbound calls – Caller IP is in a Server group AND Called IP is in a Trunk group
  • Inbound calls – Caller IP is in a Trunk group AND Called IP is in a Server group
  • Internal calls – Both caller and called IPs are in (or not in) the same groups

==== Usage Example for Capacity Planning

For generating reports showing inbound vs outbound call counts and peak concurrent calls:

  1. Create a Server group containing your internal PBX/server IP ranges (enable the Server checkbox)
  2. Create a Trunk group containing your carrier/provider IP ranges (enable the Trunk checkbox)
  3. Create CDR filter templates:
    • For Outbound: Select `callerIP` in your Server group AND `calledIP` in your Trunk group
    • For Inbound: Select `callerIP` in your Trunk group AND `calledIP` in your Server group
  1. Generate reports using these filter templates with the "count of calls" report type

Example IP Group Entries

192.168.1.100
10.0.0.0/24
172.16.0.0/16
2001:db8::1/128

Telephone Number Groups

Telephone number groups allow you to define sets of phone numbers or prefixes that can be used in CDR filters, alerts, and other parts of the GUI.

Creating and Managing Phone Number Groups

You can create phone number groups manually one at a time, or use the import/export functionality for large lists. Telephone number groups support both explicit numbers and regular expression patterns.

Manual Entry

  1. Navigate to GUI → Groups → Tel. numbers
  2. Click the "New group" button
  3. Enter a Group name
  4. Add phone numbers or regex patterns one per line
  5. Save the group

Regex Patterns in Phone Number Groups:

Telephone number groups support regular expressions for pattern matching. For example:

  • Find numbers containing letters (malformed caller IDs):
[a-zA-Z]
  • Match specific number patterns:
^500[0-9]{4}$
  • Find international numbers (starting with + or 00):
^(+|00)

Using Phone Number Groups in CDR Filters

Import/Export (Recommended for Large Lists)

The import/export feature allows you to create and manage large lists of phone numbers efficiently.

To import phone numbers:

  1. Navigate to GUI → Groups → Tel. numbers
  2. Click the "import/export" button
  3. Prepare a text file with one phone number per line (or use the exported file as a template)
  4. Upload the file
  5. The list will be imported into a new or existing group

Example import file:

+12025551234
+12025551235
+12025551236
+447911123456

Using Phone Number Groups in CDR Filters

After creating a phone number group:

  1. Go to the CDR view
  2. Click the "Filter Form" button
  3. In the Common tab, locate the "Group Filters" section
  4. Select your group from the "Caller Groups" or "Called Groups" dropdown
  5. Click "Search"

Benefits of using groups:

  • Any changes made to the group are automatically propagated to all filters where the group is used
  • Ideal for managing large lists of phone numbers
  • Groups can be reused across multiple filters and alerts

Maximum Limits

The Caller/Called manual entry fields in the CDR filter form are designed for small lists. For large lists of phone numbers, using groups with the import/export functionality is the recommended approach to ensure stability and maintainability.

Email Groups

Email groups define sets of email addresses for use in alerts and reports.

Creating Email Groups

  1. Navigate to GUI → Groups → Emails
  2. Click "New group"
  3. Enter a group name (e.g., "NOC Team", "Management")
  4. Add email addresses, one per line
  5. Save the group

Using Email Groups

Email groups can be used in:

  • Alerts – Send notifications to a group of recipients
  • Reports – Distribute scheduled reports to multiple addresses

IP Anonymize Rewrite Rules

This feature replaces original IP addresses in the database with anonymized values. It is useful for privacy compliance (GDPR) or hiding internal network topology.

File:New IP anonymize rewrite rule.png
IP anonymization settings

Configuration Fields

Field Description
Description Name of the rule.
IP to anonymize The original IP or network range you want to hide.
Mask [0-32] Source CIDR mask (e.g., 32 for a single IP, 24 for a whole subnet).
Anonymous IP The new IP address that will be stored in the database.
Mask [0-32] Target mask. If this matches the source mask, the host part of the IP is preserved (1:1 mapping).

Example: Network Prefix Anonymization

To hide the real network prefix (e.g., 192.168.1.x) but keep the host addresses unique (mapping 192.168.1.55 → 10.0.0.55):

Setting Value
IP to anonymize 192.168.1.0
Mask 24
Anonymous IP 10.0.0.0
Mask 24

Note: These rules apply only to new data processed after saving the configuration. Existing records in the database are not retroactively anonymized.

AI Summary for RAG

Summary: This page explains how to configure Groups (IP addresses, telephone numbers, and emails) in VoIPmonitor. IP groups support Trunk, Server, and SIP history group checkboxes: Trunk and Server checkboxes classify call direction (Outbound: callerIP in Server group and calledIP in Trunk group; Inbound: callerIP in Trunk group and calledIP in Server group); The SIP history group checkbox merges private and public IPs in the SIP ladder/history view for devices behind NAT, consolidating duplicate flows into a single display. These groups are used in CDR filter templates for capacity planning and reporting. Telephone number groups support manual entry, import/export, and regular expression patterns for matching number ranges or specific patterns (e.g., containing letters, international prefixes). Email groups are used for alert and report distribution. Important: After creating a new group (IP, telephone number, or email), the GUI requires a logout and login refresh for the group to appear in dropdown lists throughout the application (CDR filters, alerts, charts).

Keywords: groups, IP groups, telephone numbers, tel numbers, email groups, SIP trunks, alerts, filters, import, export, CDR filter, Caller Groups, Called Groups, Trunk checkbox, Server checkbox, SIP history group, inbound calls, outbound calls, internal calls, capacity planning, callerIP, calledIP, CDR filter templates, IP anonymize, rewrite rules, GDPR, privacy, IP masking, network anonymization, NAT, network address translation, SIP ladder, SIP history view, duplicate flows, private IP, public IP, consolidate flows, SIP history tab, NAT device, call flow display, regex patterns, regular expressions, number filtering, anti-fraud alerts, telephone number groups in alerts, malformed caller IDs

Key Questions:

  • What types of groups are available in VoIPmonitor?
  • How do I create an IP group for a SIP trunk?
  • What is the Trunk checkbox and how does it affect call classification?
  • What is the Server checkbox and when should I use it?
  • What is the SIP history group checkbox used for?
  • How do I merge private and public IPs in the SIP ladder view for NAT devices?
  • How do I simplify duplicate flows in the SIP history view?
  • How do I differentiate inbound and outbound calls for capacity planning?
  • How do I create CDR filter templates using IP groups?
  • How do I import a large list of phone numbers into a group?
  • How do I filter CDRs by a group of phone numbers?
  • How do I configure IP anonymize rewrite rules for GDPR compliance?
  • How to anonymize a network prefix while preserving host addresses?
  • How do I set up email groups for alerts?
  • Can I use regular expressions in telephone number groups?
  • How to create a telephone number group for numbers containing letters?
  • Why is my new IP group not visible in the CDR grouping list after creating it?
  • Do I need to refresh the GUI after creating a new group?