Groups: Difference between revisions

From VoIPmonitor.org
No edit summary
(Rewrite: condensed structure, consolidated checkbox options into table, added See Also section)
 
(10 intermediate revisions by the same user not shown)
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 reusable sets of IP addresses, telephone numbers, and emails for filtering CDRs, configuring alerts, and reports.


IP groups include a "Trunk" checkbox to distinguish internal/incoming/outgoing calls in CDR filters.
{{Note|1=After creating a new group, '''log out and log back in''' for it to appear in dropdown lists (CDR filters, alerts, charts).}}


[[File:groups.png]]
== Group Types ==


== IP anonymize rewrite rules ==
{| class="wikitable"
|-
! Type !! Path !! Use Cases
|-
| '''IP''' || Groups → IPs || SIP trunks, call direction classification, CDR filtering by IP
|-
| '''Tel. Numbers''' || Groups → Tel. numbers || Filter CDRs by caller/called, alert on number ranges
|-
| '''Emails''' || Groups → Emails || Recipients for alerts and reports
|}
 
== IP Groups ==
 
Define sets of IP addresses or CIDR ranges for filtering and classification.
 
=== Creating IP Groups ===
 
# Navigate to '''Groups → IPs'''
# Click "New group", enter name
# Add IPs or CIDR ranges (one per line):
<syntaxhighlight lang="text">
192.168.1.100
10.0.0.0/24
2001:db8::1/128
</syntaxhighlight>
# Configure checkboxes (see below)
# Save
 
=== Checkbox Options ===
 
{| class="wikitable"
|-
! Checkbox !! Purpose !! When to Use
|-
| '''Trunk''' || Marks IPs as external carrier/provider || SIP trunk IPs from your VoIP provider
|-
| '''Server''' || Marks IPs as internal infrastructure || Your PBX, SBC, or media servers
|-
| '''SIP history group''' || Merges private/public IPs in SIP ladder view || NAT devices where signaling uses public IP but RTP uses private IP
|}
 
=== Call Direction Classification ===
 
Using '''Trunk''' and '''Server''' checkboxes enables precise filtering:
 
{| class="wikitable"
|-
! Direction !! Filter Logic
|-
| '''Outbound''' || callerIP in '''Server''' group AND calledIP in '''Trunk''' group
|-
| '''Inbound''' || callerIP in '''Trunk''' group AND calledIP in '''Server''' group
|-
| '''Internal''' || Both IPs in same group (or neither in any group)
|}
 
<kroki lang="mermaid">
%%{init: {'flowchart': {'nodeSpacing': 20, 'rankSpacing': 50}}}%%
flowchart LR
    subgraph Server["Server Group (Internal)"]
        PBX[PBX/SBC]
    end
    subgraph Trunk["Trunk Group (External)"]
        Carrier[Carrier/Provider]
    end
    PBX -->|"Outbound"| Carrier
    Carrier -->|"Inbound"| PBX
</kroki>
 
=== SIP History Group for NAT ===
 
When a device behind NAT shows different IPs in signaling vs media:
* Public IP: 1.2.3.4 (in SIP headers)
* Private IP: 10.0.0.3 (actual device)
 
Create a group with both IPs and enable '''SIP history group''' checkbox. The GUI will consolidate duplicate flows into a single column in SIP ladder view.
 
== Telephone Number Groups ==
 
Define sets of phone numbers or patterns for CDR filtering and alerts.
 
=== Creating Groups ===
 
'''Manual entry:'''
# Navigate to '''Groups → Tel. numbers'''
# Click "New group"
# Add numbers one per line
# Save


This feature replaces original IP addresses in the database with anonymized values. It is useful for privacy compliance (GDPR) or hiding internal network topology.
'''Import/Export (for large lists):'''
# Click "import/export" button
# Upload text file with one number per line


[[File:New_IP_anonymize_rewrite_rule.png|thumb|right|400px|IP anonymization settings]]
=== Regex Patterns ===


=== Configuration Fields ===
{{Warning|1=Entries are literal strings by default. Wrap patterns with <code>R(...)</code> to enable regex.}}


{| class="wikitable"
{| class="wikitable"
|-
! Pattern !! Description
|-
| <code>R(^500[0-9]{4}$)</code> || Match 7-digit numbers starting with 500
|-
| <code>R(^(\+|00))</code> || International numbers (+ or 00 prefix)
|-
| <code>R([a-zA-Z])</code> || Numbers containing letters (malformed IDs)
|}
=== Using in CDR Filters ===
# Go to CDR view → Filter Form
# In '''Group Filters''' section, select your group from '''Caller Groups''' or '''Called Groups'''
# Click Search
{{Tip|Changes to the group automatically apply to all filters using it.}}
== Email Groups ==
Define recipient lists for [[Alerts|alerts]] and [[Reports|reports]].
# Navigate to '''Groups → Emails'''
# Click "New group"
# Add email addresses (one per line)
# Save
== IP Anonymize Rewrite Rules ==
Replace original IPs with anonymized values in the database (GDPR compliance).
{{Warning|1=Rules apply only to '''new data''' after saving. Existing records are not modified.}}
=== Configuration ===
{| class="wikitable"
|-
! Field !! Description
! Field !! Description
|-
|-
| '''Description''' || Name of the rule.
| '''IP to anonymize''' || Original IP or network to hide
|-
|-
| '''IP to anonymize''' || The original IP or network range you want to hide.
| '''Mask [0-32]''' || Source CIDR mask (32 = single IP, 24 = subnet)
|-
|-
| '''Mask [0-32]''' || Source CIDR mask (e.g., '''32''' for a single IP, '''24''' for a whole subnet).
| '''Anonymous IP''' || Replacement IP stored in database
|-
|-
| '''Anonymous IP''' || The new IP address that will be stored in the database.
| '''Mask [0-32]''' || Target mask (same as source = preserves host part)
|}
 
'''Example:''' Map 192.168.1.x → 10.0.0.x (preserve host address):
 
{| class="wikitable"
|-
! Setting !! Value
|-
|-
| '''Mask [0-32]''' || Target mask. If this matches the source mask, the host part of the IP is preserved (1:1 mapping).
| IP to anonymize || 192.168.1.0
|-
| Mask || 24
|-
| Anonymous IP || 10.0.0.0
|-
| Mask || 24
|}
|}


=== Example: Network Prefix Anonymization ===
== See Also ==
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
* '''Mask:''' 24
* '''Anonymous IP:''' 10.0.0.0
* '''Mask:''' 24


''Note: These rules apply only to new data processed after saving the configuration.''
* [[Alerts]] - Using email groups for notifications
* [[Reports]] - Using groups in scheduled reports
* [[Call_Detail_Record_-_CDR]] - CDR filtering with groups


=== AI Summary for RAG ===
== AI Summary for RAG ==


'''Summary:''' This article explains how to configure Groups and IP anonymize rewrite rules in VoIPmonitor. Groups allow defining sets of IP addresses, phone numbers, and emails for use in alerts and filters, with a specific "Trunk" option for distinguishing call directions. 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:''' VoIPmonitor Groups feature for defining reusable sets of IP addresses, telephone numbers, and emails. IP groups support Trunk, Server, and SIP history group checkboxes for call direction classification (Outbound = callerIP in Server + calledIP in Trunk; Inbound = reverse) and NAT device consolidation in SIP ladder view. Telephone number groups support manual entry, import/export for large lists, and regex patterns with R(...) wrapper syntax. Email groups define recipients for alerts and reports. IP Anonymize Rewrite Rules enable GDPR-compliant IP masking for new data only. Important: log out and back in after creating groups for them to appear in dropdown lists.


'''Keywords:''' groups, IP groups, tel numbers, emails, SIP trunks, alerts, filters, Trunk checkbox, IP anonymize, rewrite rules, GDPR, privacy, IP masking, network topology
'''Keywords:''' groups, IP groups, telephone numbers, email groups, SIP trunks, Trunk checkbox, Server checkbox, SIP history group, call direction, inbound, outbound, CDR filter, Caller Groups, Called Groups, regex patterns, R() wrapper, import export, IP anonymize, GDPR, NAT, SIP ladder, GUI refresh, login refresh


'''Key Questions:'''
'''Key Questions:'''
* What are Groups and how are they used in VoIPmonitor?
* What types of groups are available in VoIPmonitor?
* What is the purpose of the Trunk checkbox in IP groups?
* How do I create an IP group for a SIP trunk?
* How do I configure IP anonymize rewrite rules?
* What is the Trunk checkbox and Server checkbox used for?
* How can I mask real IP addresses for GDPR compliance?
* How do I differentiate inbound and outbound calls?
* How to anonymize a network prefix while preserving host addresses?
* What is the SIP history group checkbox for NAT devices?
* How do I use regex patterns in telephone number groups?
* How do I import a large list of phone numbers?
* Why is my new group not visible in dropdown lists?
* How do I configure IP anonymization for GDPR?

Latest revision as of 16:48, 8 January 2026


Groups define reusable sets of IP addresses, telephone numbers, and emails for filtering CDRs, configuring alerts, and reports.

ℹ️ Note: After creating a new group, log out and log back in for it to appear in dropdown lists (CDR filters, alerts, charts).

Group Types

Type Path Use Cases
IP Groups → IPs SIP trunks, call direction classification, CDR filtering by IP
Tel. Numbers Groups → Tel. numbers Filter CDRs by caller/called, alert on number ranges
Emails Groups → Emails Recipients for alerts and reports

IP Groups

Define sets of IP addresses or CIDR ranges for filtering and classification.

Creating IP Groups

  1. Navigate to Groups → IPs
  2. Click "New group", enter name
  3. Add IPs or CIDR ranges (one per line):
192.168.1.100
10.0.0.0/24
2001:db8::1/128
  1. Configure checkboxes (see below)
  2. Save

Checkbox Options

Checkbox Purpose When to Use
Trunk Marks IPs as external carrier/provider SIP trunk IPs from your VoIP provider
Server Marks IPs as internal infrastructure Your PBX, SBC, or media servers
SIP history group Merges private/public IPs in SIP ladder view NAT devices where signaling uses public IP but RTP uses private IP

Call Direction Classification

Using Trunk and Server checkboxes enables precise filtering:

Direction Filter Logic
Outbound callerIP in Server group AND calledIP in Trunk group
Inbound callerIP in Trunk group AND calledIP in Server group
Internal Both IPs in same group (or neither in any group)

SIP History Group for NAT

When a device behind NAT shows different IPs in signaling vs media:

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

Create a group with both IPs and enable SIP history group checkbox. The GUI will consolidate duplicate flows into a single column in SIP ladder view.

Telephone Number Groups

Define sets of phone numbers or patterns for CDR filtering and alerts.

Creating Groups

Manual entry:

  1. Navigate to Groups → Tel. numbers
  2. Click "New group"
  3. Add numbers one per line
  4. Save

Import/Export (for large lists):

  1. Click "import/export" button
  2. Upload text file with one number per line

Regex Patterns

⚠️ Warning: Entries are literal strings by default. Wrap patterns with R(...) to enable regex.

Pattern Description
R(^500[0-9]{4}$) Match 7-digit numbers starting with 500
00)) International numbers (+ or 00 prefix)
R([a-zA-Z]) Numbers containing letters (malformed IDs)

Using in CDR Filters

  1. Go to CDR view → Filter Form
  2. In Group Filters section, select your group from Caller Groups or Called Groups
  3. Click Search

💡 Tip: Changes to the group automatically apply to all filters using it.

Email Groups

Define recipient lists for alerts and reports.

  1. Navigate to Groups → Emails
  2. Click "New group"
  3. Add email addresses (one per line)
  4. Save

IP Anonymize Rewrite Rules

Replace original IPs with anonymized values in the database (GDPR compliance).

⚠️ Warning: Rules apply only to new data after saving. Existing records are not modified.

Configuration

Field Description
IP to anonymize Original IP or network to hide
Mask [0-32] Source CIDR mask (32 = single IP, 24 = subnet)
Anonymous IP Replacement IP stored in database
Mask [0-32] Target mask (same as source = preserves host part)

Example: Map 192.168.1.x → 10.0.0.x (preserve host address):

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

See Also

AI Summary for RAG

Summary: VoIPmonitor Groups feature for defining reusable sets of IP addresses, telephone numbers, and emails. IP groups support Trunk, Server, and SIP history group checkboxes for call direction classification (Outbound = callerIP in Server + calledIP in Trunk; Inbound = reverse) and NAT device consolidation in SIP ladder view. Telephone number groups support manual entry, import/export for large lists, and regex patterns with R(...) wrapper syntax. Email groups define recipients for alerts and reports. IP Anonymize Rewrite Rules enable GDPR-compliant IP masking for new data only. Important: log out and back in after creating groups for them to appear in dropdown lists.

Keywords: groups, IP groups, telephone numbers, email groups, SIP trunks, Trunk checkbox, Server checkbox, SIP history group, call direction, inbound, outbound, CDR filter, Caller Groups, Called Groups, regex patterns, R() wrapper, import export, IP anonymize, GDPR, NAT, SIP ladder, GUI refresh, login refresh

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 Server checkbox used for?
  • How do I differentiate inbound and outbound calls?
  • What is the SIP history group checkbox for NAT devices?
  • How do I use regex patterns in telephone number groups?
  • How do I import a large list of phone numbers?
  • Why is my new group not visible in dropdown lists?
  • How do I configure IP anonymization for GDPR?
Retrieved from "https://www.voipmonitor.org/doc/index.php?title=Groups&oldid=10078"