Groups: Difference between revisions

From VoIPmonitor.org
(Fix mismatched heading levels)
(Restructure page: add Overview section, expand IP Groups with Trunk checkbox explanation, add Email Groups section, fix formatting (numbered lists, syntax highlighting), improve AI RAG section)
Line 1: Line 1:
== Groups ==
[[Category:GUI manual]]
{{DISPLAYTITLE:Groups: IP, Telephone Numbers & Emails}}


Groups define sets of IP addresses/networks, telephone numbers/prefixes, and emails. These can be used across the WEB GUI, such as in alerts or filters. Typically, define SIP trunks from operators as groups for use in alerts or filters.
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.


IP groups include a "Trunk" checkbox to distinguish internal/incoming/outgoing calls in CDR filters.
== Overview ==


[[File:groups.png]]
VoIPmonitor supports three types of groups:


== Telephone Numbers ==
{| class="wikitable"
|-
! 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
|}
 
[[File:groups.png|center|600px|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 ===


Groups for telephone numbers allow you to define sets of phone numbers or prefixes that can be used in CDR filters, alerts, and other parts of the GUI.
# Navigate to GUI → Groups → IPs
# Click "New group"
# Enter a descriptive group name (e.g., "Provider A SIP Trunk")
# Add IP addresses or CIDR ranges, one per line
# Configure the '''Trunk''' checkbox if applicable
# Save the group


=== Accessing Telephone Number Groups ===
=== Trunk Checkbox ===


Navigate to: GUI -> Groups -> Tel. numbers
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).
 
This allows the CDR filter to distinguish:
* '''Internal calls''' – Both caller and called IPs are NOT in any trunk group
* '''Incoming calls''' – Caller IP is in a trunk group, called IP is not
* '''Outgoing calls''' – Called IP is in a trunk group, caller IP is not
 
=== Example IP Group Entries ===
 
<pre>
192.168.1.100
10.0.0.0/24
172.16.0.0/16
2001:db8::1/128
</pre>
 
== 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 ===
=== Creating and Managing Phone Number Groups ===
Line 21: Line 62:
==== Manual Entry ====
==== Manual Entry ====


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


==== Import/Export (Recommended for Large Lists) ====
==== Import/Export (Recommended for Large Lists) ====
Line 32: Line 74:
'''To import phone numbers:'''
'''To import phone numbers:'''


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


'''Example import file:'''
'''Example import file:'''
<pre>
 
<syntaxhighlight lang="text">
+12025551234
+12025551234
+12025551235
+12025551235
+12025551236
+12025551236
+447911123456
+447911123456
</pre>
</syntaxhighlight>


=== Using Phone Number Groups in CDR Filters ===
=== Using Phone Number Groups in CDR Filters ===
Line 50: Line 93:
After creating a phone number group:
After creating a phone number group:


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


'''Benefits of using groups:'''
'''Benefits of using groups:'''
Line 63: Line 106:
=== Maximum Limits ===
=== Maximum Limits ===


The Caller/Called manual entry fields in the CDR filter form are designed for small lists, but there is no explicitly documented hard limit. However, for large lists of phone numbers, using groups with the import/export functionality is the recommended approach to ensure stability and maintainability.
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.


== IP anonymize rewrite rules ==
== Email Groups ==
 
Email groups define sets of email addresses for use in alerts and reports.
 
=== Creating Email Groups ===
 
# Navigate to GUI → Groups → Emails
# Click "New group"
# Enter a group name (e.g., "NOC Team", "Management")
# Add email addresses, one per line
# 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.
This feature replaces original IP addresses in the database with anonymized values. It is useful for privacy compliance (GDPR) or hiding internal network topology.
Line 74: Line 135:


{| class="wikitable"
{| class="wikitable"
|-
! Field !! Description
! Field !! Description
|-
|-
Line 80: Line 142:
| '''IP to anonymize''' || The original IP or network range you want to hide.
| '''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).
| '''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.
| '''Anonymous IP''' || The new IP address that will be stored in the database.
Line 88: Line 150:


=== Example: Network Prefix Anonymization ===
=== 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''):


* '''IP to anonymize:''' 192.168.1.0
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):
* '''Mask:''' 24
 
* '''Anonymous IP:''' 10.0.0.0
{| class="wikitable"
* '''Mask:''' 24
|-
! 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.''
'''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 ===
== AI Summary for RAG ==


'''Summary:''' This article explains how to configure Groups (telephone numbers, IP addresses, and emails) and IP anonymize rewrite rules in VoIPmonitor. Telephone number groups support manual entry and import/export for large lists, with automatic propagation to all filters. IP anonymize rewrite rules are used to replace original IP addresses in the database with masked values for privacy compliance (GDPR) or to hide internal network topology.
'''Summary:''' This page explains how to configure Groups (IP addresses, telephone numbers, and emails) and IP anonymize rewrite rules in VoIPmonitor. IP groups support the Trunk checkbox to distinguish internal/incoming/outgoing calls. Telephone number groups support manual entry and import/export for large lists. Email groups are used for alert and report distribution. IP anonymize rewrite rules replace original IP addresses in the database with masked values for privacy compliance (GDPR).


'''Keywords:''' groups, IP groups, tel numbers, telephone numbers, emails, SIP trunks, alerts, filters, import, export, CDR filter, Caller Groups, Called Groups, Trunk checkbox, IP anonymize, rewrite rules, GDPR, privacy, IP masking, network topology
'''Keywords:''' groups, IP groups, telephone numbers, tel numbers, email groups, SIP trunks, alerts, filters, import, export, CDR filter, Caller Groups, Called Groups, Trunk checkbox, internal calls, incoming calls, outgoing calls, IP anonymize, rewrite rules, GDPR, privacy, IP masking, network anonymization


'''Key Questions:'''
'''Key Questions:'''
* What are Groups and how are they used in VoIPmonitor?
* What types of groups are available in VoIPmonitor?
* How do I import a list of phone numbers into a group?
* How do I create an IP group for a SIP trunk?
* How do I filter CDRs by a large list of phone numbers?
* What is the Trunk checkbox and how does it affect call classification?
* What is the purpose of the Trunk checkbox in IP groups?
* How do I import a large list of phone numbers into a group?
* How do I configure IP anonymize rewrite rules?
* How do I filter CDRs by a group of phone numbers?
* How can I mask real IP addresses for GDPR compliance?
* How do I configure IP anonymize rewrite rules for GDPR compliance?
* How to anonymize a network prefix while preserving host addresses?
* How to anonymize a network prefix while preserving host addresses?
* How do I set up email groups for alerts?

Revision as of 19:23, 4 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")
  4. Add IP addresses or CIDR ranges, one per line
  5. Configure the Trunk checkbox if applicable
  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).

This allows the CDR filter to distinguish:

  • Internal calls – Both caller and called IPs are NOT in any trunk group
  • Incoming calls – Caller IP is in a trunk group, called IP is not
  • Outgoing calls – Called IP is in a trunk group, caller IP is not

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.

Manual Entry

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

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) and IP anonymize rewrite rules in VoIPmonitor. IP groups support the Trunk checkbox to distinguish internal/incoming/outgoing calls. Telephone number groups support manual entry and import/export for large lists. Email groups are used for alert and report distribution. IP anonymize rewrite rules replace original IP addresses in the database with masked values for privacy compliance (GDPR).

Keywords: groups, IP groups, telephone numbers, tel numbers, email groups, SIP trunks, alerts, filters, import, export, CDR filter, Caller Groups, Called Groups, Trunk checkbox, internal calls, incoming calls, outgoing calls, IP anonymize, rewrite rules, GDPR, privacy, IP masking, network anonymization

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?
  • 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?