
# Ribbon SBC Edge by HTTP

## Overview

The Ribbon Session Border Controller Edge (SBC Edge) is a security and interoperability solution for medium-sized businesses and large branch offices.

This template is designed for the effortless deployment of Ribbon SBC Edge monitoring and doesn't require any external scripts.

More details can be found in the official Ribbon documentation:
- [REST API Reference](https://publicdoc.rbbn.com/spaces/UXAPIDOC/pages/17400598/Configuration+Resources)
- [REST API User's Guide](https://publicdoc.rbbn.com/spaces/UXAPIDOC/pages/387008766/REST+API+User+s+Guide)

## Requirements

Zabbix version: 7.0 and higher.

## Tested versions

This template has been tested on:
- Ribbon SBC 2000

## Configuration

> Zabbix should be configured according to the instructions in the [Templates out of the box](https://www.zabbix.com/documentation/7.0/manual/config/templates_out_of_the_box) section.

## Setup

1. Create a new user according to [REST API requirements](https://publicdoc.rbbn.com/spaces/UXAPIDOC/pages/387008769/REST+API+-+Requirements).
2. Create a new host.
3. Link the template to the host created earlier.
4. Set the host macros (on the host or template level) required for getting data:
```text
{$RIBBON.URL}
```
5. Set the host macros (on the host or template level) with the login and password of the user created earlier:
```text
{$RIBBON.USERNAME}
{$RIBBON.PASSWORD}
```

### Macros used

|Name|Description|Default|
|----|-----------|-------|
|{$RIBBON.USERNAME}|
Ribbon SBC username.
||
|{$RIBBON.PASSWORD}|
Ribbon SBC user password.
||
|{$RIBBON.URL}|
Ribbon SBC API IP.
||
|{$RIBBON.PROXY}|
Sets the HTTP proxy value. If this macro is empty, then no proxy is used.
||
|{$RIBBON.INTERVAL}|
The update interval for the script items that retrieve data from the API. Can be used with context if needed (check the context values in relevant items).
|`1m`|
|{$RIBBON.INTERVAL:"get_system_stats"}|
The update interval for the script item that retrieve the system stats.
|`1m`|
|{$RIBBON.INTERVAL:"get_interface"}|
The update interval for the script item that retrieve the interface data.
|`1m`|
|{$RIBBON.INTERVAL:"get_fan"}|
The update interval for the script item that retrieve the fan data.
|`15m`|
|{$RIBBON.INTERVAL:"get_disk"}|
The update interval for the script item that retrieve the disk partition data.
|`5m`|
|{$RIBBON.INTERVAL:"get_psu"}|
The update interval for the script item that retrieve the power supply data.
|`5m`|
|{$RIBBON.INTERVAL:"get_dsp_card"}|
The update interval for the script item that retrieve the DSP card data.
|`5m`|
|{$RIBBON.INTERVAL:"get_sip_server"}|
The update interval for the script item that retrieve the SIP server data.
|`5m`|
|{$RIBBON.INTERVAL:"get_certificate"}|
The update interval for the script item that retrieve the certificate info.
|`5m`|
|{$RIBBON.INTERVAL:"get_alarm"}|
The update interval for the script item that retrieve the active alarms.
|`5m`|
|{$RIBBON.TIMEOUT}|
The timeout threshold for the script items that retrieve data from the API.
|`60s`|
|{$RIBBON.CPU.UTIL.CRIT}|
The threshold of CPU usage in percent.
|`90`|
|{$RIBBON.MEMORY.UTIL.CRIT}|
The threshold of memory usage in percent.
|`90`|
|{$RIBBON.DSP.CARD.CPU.USAGE.CRIT}|
The threshold of DSP card CPU usage in percent.
|`90`|
|{$RIBBON.TEMP.BOTTOM.MAIN.BOARD.CRIT}|
The threshold of temperature on the bottom of the main board in degrees Celsius.
|`80`|
|{$RIBBON.TEMP.TOP.MAIN.BOARD.CRIT}|
The threshold of temperature on the top of the main board in degrees Celsius.
|`80`|
|{$RIBBON.TEMP.CORE.CRIT}|
The threshold of core switch temperature in degrees Celsius.
|`80`|
|{$RIBBON.TEMP.PSU.CRIT}|
The threshold of power supply temperature in degrees Celsius.
|`80`|
|{$RIBBON.INTERFACE.DISCOVERY.TYPE.MATCHES}|
Sets the regex string of the interface type to be allowed in discovery.
|`.*`|
|{$RIBBON.INTERFACE.DISCOVERY.TYPE.NOT_MATCHES}|
Sets the regex string of the interface type to be ignored in discovery.
|`CHANGE_IF_NEEDED`|
|{$RIBBON.INTERFACE.DISCOVERY.NAME.MATCHES}|
Sets the regex string of the interface name to be allowed in discovery.
|`.*`|
|{$RIBBON.INTERFACE.DISCOVERY.NAME.NOT_MATCHES}|
Sets the regex string of the interface name to be ignored in discovery.
|`CHANGE_IF_NEEDED`|
|{$RIBBON.DISK.DISCOVERY.TYPE.MATCHES}|
Sets the regex string of the disk type to be allowed in discovery.
|`.*`|
|{$RIBBON.DISK.DISCOVERY.TYPE.NOT_MATCHES}|
Sets the regex string of the disk type to be ignored in discovery.
|`CHANGE_IF_NEEDED`|
|{$RIBBON.DISK.DISCOVERY.NAME.MATCHES}|
Sets the regex string of the disk name to be allowed in discovery.
|`.*`|
|{$RIBBON.DISK.DISCOVERY.NAME.NOT_MATCHES}|
Sets the regex string of the disk name to be ignored in discovery.
|`CHANGE_IF_NEEDED`|
|{$RIBBON.SIP.SERVER.DISCOVERY.NAME.MATCHES}|
Sets the regex string of the SIP server name to be allowed in discovery.
|`.*`|
|{$RIBBON.SIP.SERVER.DISCOVERY.NAME.NOT_MATCHES}|
Sets the regex string of the SIP server name to be ignored in discovery.
|`CHANGE_IF_NEEDED`|
|{$RIBBON.SIP.SIGNAL.GROUP.DISCOVERY.DESCR.MATCHES}|
Sets the regex string of the SIP signal group description to be allowed in discovery.
|`.*`|
|{$RIBBON.SIP.SIGNAL.GROUP.DISCOVERY.DESCR.NOT_MATCHES}|
Sets the regex string of the SIP signal group description to be ignored in discovery.
|`CHANGE_IF_NEEDED`|
|{$RIBBON.CERTIFICATE.DISCOVERY.NAME.MATCHES}|
Sets the regex string of the certificate name to be allowed in discovery.
|`.*`|
|{$RIBBON.CERTIFICATE.DISCOVERY.NAME.NOT_MATCHES}|
Sets the regex string of the certificate name to be ignored in discovery.
|`CHANGE_IF_NEEDED`|
|{$RIBBON.ALARM.DISCOVERY.STATE.MATCHES}|
Sets of the alarm state to be allowed in discovery.
|`.*`|
|{$RIBBON.ALARM.DISCOVERY.STATE.NOT_MATCHES}|
Sets of the alarm state to be ignored in discovery.
|`CHANGE_IF_NEEDED`|
|{$RIBBON.ALARM.DISCOVERY.EVENT.ID.MATCHES}|
Sets of the alarm event ID to be allowed in discovery. See the https://publicdoc.rbbn.com/spaces/UXDOC70/pages/122292177/Alarms+and+Events+Reference for possible values.
|`.*`|
|{$RIBBON.ALARM.DISCOVERY.EVENT.ID.NOT_MATCHES}|
Sets of the alarm event ID to be ignored in discovery.
|`CHANGE_IF_NEEDED`|
|{$RIBBON.DISK.USED.MAX}|
The threshold of the disk usage in percent.
|`90`|
|{$RIBBON.SIP.SERVER.TRANSACTIONS.FAILED.MAX}|
The threshold of the SIP server failed transactions.
|`100`|

### Items

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|Get system stats|
Gets the system statistics.
|Script|ribbon.system.stats.get|
|Get interface|
Gets the system ethernet port statistics.
|Script|ribbon.net.if.get|
|Get fan|
Gets fan data.
|Script|ribbon.fan.get|
|Get disk partition|
Gets the system disk partition.
|Script|ribbon.disk.get|
|Get power supply|
Gets PSU data.
|Script|ribbon.psu.get|
|Get DSP cards|
Gets DSP card data.
|Script|ribbon.dsp.card.get|
|Get SIP servers|
Gets SIP server data.
|Script|ribbon.sip.server.get|
|Get SIP Signaling Group|
Gets SIP Signaling Group data.
|Script|ribbon.sip.signal.group.get|
|Get certificate info|
Gets certificate information.
|Script|ribbon.cert.get|
|Get active alarms|
Gets the active alarms.
|Script|ribbon.alarm.get|
|Node name|
Sets the DNS host name for the system.
|Dependent item|ribbon.system.node.name
**Preprocessing**

- 
JSON Path: `$.system.NodeName`

- 
Discard unchanged with heartbeat: `12h`

|
|Serial number|
Sets the serial number of the system.
|Dependent item|ribbon.system.serial.number
**Preprocessing**

- 
JSON Path: `$.system.SerialNumber`

- 
Discard unchanged with heartbeat: `12h`

|
|Status|
Indicates the hardware initialization state for this card.

Possible values:

- None

- Card Idle

- Card Detected

- Card Activating

- Card Activated

- Card Remove Requested

- Card Removing

- Card Removed

- Card Downloading

- Card Failed

- Card Disabled Long Loop

- MAX
|Dependent item|ribbon.system.status
**Preprocessing**

- 
JSON Path: `$.system.Status`

- 
Discard unchanged with heartbeat: `12h`

|
|Memory total|
Indicates the amount of RAM available in the system.
|Dependent item|ribbon.system.total.memory
**Preprocessing**

- 
JSON Path: `$.system.TotalSystemMemory`

- 
Custom multiplier: `1048576`

- 
Discard unchanged with heartbeat: `12h`

|
|Software base version|
Base software version.
|Dependent item|ribbon.system.software.base.version
**Preprocessing**

- 
JSON Path: `$.system.rt_Software_Base_Version`

- 
Discard unchanged with heartbeat: `12h`

|
|Software base build number|
The exact build: machine, time, and date. It should be reported whenever reporting any bug or crash related to the current software.
|Dependent item|ribbon.system.software.base.build
**Preprocessing**

- 
JSON Path: `$.system.rt_Software_Base_BuildNumber`

- 
Discard unchanged with heartbeat: `12h`

|
|Number of call attempts|
Total number of call attempts system-wide since the system came up.
|Dependent item|ribbon.number.call.attempts
**Preprocessing**

- 
JSON Path: `$.systemcallstats.rt_NumCallAttempts`

- 
Discard unchanged with heartbeat: `1h`

|
|Number of call failed|
Total number of failed calls system-wide since the system came up.
|Dependent item|ribbon.number.call.failed
**Preprocessing**

- 
JSON Path: `$.systemcallstats.rt_NumCallFailed`

- 
Discard unchanged with heartbeat: `1h`

|
|Number of call succeeded|
Total number of successful calls system-wide since the system came up.
|Dependent item|ribbon.number.call.succeeded
**Preprocessing**

- 
JSON Path: `$.systemcallstats.rt_NumCallSucceeded`

- 
Discard unchanged with heartbeat: `1h`

|
|Number of call currently up|
Number of currently connected calls system-wide.
|Dependent item|ribbon.number.call.currently
**Preprocessing**

- 
JSON Path: `$.systemcallstats.rt_NumCallCurrentlyUp`

|
|CPU Load average 15m|
Average number of processes over the last fifteen minutes waiting to run because the CPU is busy.
|Dependent item|ribbon.cpu.load.avg15
**Preprocessing**

- 
JSON Path: `$.historicalstatistics.rt_CPULoadAverage15m`

- 
Custom multiplier: `0.01`

|
|CPU Load average 1m|
Average number of processes over the last minute waiting to run because the CPU is busy.
|Dependent item|ribbon.cpu.load.avg1
**Preprocessing**

- 
JSON Path: `$.historicalstatistics.rt_CPULoadAverage1m`

- 
Custom multiplier: `0.01`

|
|CPU Load average 5m|
Average number of processes over the last five minutes waiting to run because the CPU is busy.
|Dependent item|ribbon.cpu.load.avg5
**Preprocessing**

- 
JSON Path: `$.historicalstatistics.rt_CPULoadAverage5m`

- 
Custom multiplier: `0.01`

|
|CPU usage|
Average CPU usage in percent.
|Dependent item|ribbon.cpu.usage
**Preprocessing**

- 
JSON Path: `$.historicalstatistics.rt_CPUUsage`

|
|File descriptor usage|
Number of file descriptors used by the system.
|Dependent item|ribbon.fd.usage
**Preprocessing**

- 
JSON Path: `$.historicalstatistics.rt_FDUsage`

|
|Memory usage|
Average usage of system memory in percent.
|Dependent item|ribbon.memory.usage
**Preprocessing**

- 
JSON Path: `$.historicalstatistics.rt_MemoryUsage`

|
|Temporary partition usage|
Percentage of the temporary partition used.
|Dependent item|ribbon.tmp.part.usage
**Preprocessing**

- 
JSON Path: `$.historicalstatistics.rt_TmpPartUsage`

|
|ASM Operating System License Type|
The ASM Operating System version that is licensed by the factory.

Possible values:

- Unknown

- Win2008R2

- Win2012R2

- Win2019
|Dependent item|ribbon.chassis.asm.license.type
**Preprocessing**

- 
JSON Path: `$.chassis.AsmOsLicenseType`

- 
Discard unchanged with heartbeat: `12h`

|
|Chassis Status|
Indicates the hardware initialization state for this card.

Possible values:

  - None

  - Card Idle

  - Card Detected

  - Card Activating

  - Card Activated

  - Card Remove Requested

  - Card Removing

  - Card Removed

  - Card Downloading

  - Card Failed

  - Card Disabled Long Loop

  - MAX
|Dependent item|ribbon.chassis.status
**Preprocessing**

- 
JSON Path: `$.chassis.rt_Status`

- 
Discard unchanged with heartbeat: `12h`

|
|Chassis board bottom temperature|
Indicates the temperature on the bottom of the main board in degrees Celsius.
|Dependent item|ribbon.chassis.board.bottom.temp
**Preprocessing**

- 
JSON Path: `$.chassis.rt_Chassis_BoardBottom_Temp1`

|
|Chassis board top temperature|
Indicates the temperature on the top of the main board in degrees Celsius.
|Dependent item|ribbon.chassis.board.top.temp
**Preprocessing**

- 
JSON Path: `$.chassis.rt_Chassis_BoardTop_Temp2`

|
|Chassis core switch temperature|
Indicates the core switch temperature in degrees Celsius.
|Dependent item|ribbon.chassis.core.switch.temp
**Preprocessing**

- 
JSON Path: `$.chassis.rt_Chassis_CoreSwitch_Temp`

|
|Chassis type|
Indicates the hardware or software platform type of the SBC system.

For hardware appliances, identifies whether the device is an SBC1000 or SBC2000.

For software-based deployments (SWe), indicates the virtual or software chassis type.
|Dependent item|ribbon.chassis.type
**Preprocessing**

- 
JSON Path: `$.chassis.rt_Chassis_Type`

- 
Discard unchanged with heartbeat: `12h`

|
|DNS server 1|
Primary DNS server currently in use on the system.
|Dependent item|ribbon.system.dns.server1
**Preprocessing**

- 
JSON Path: `$.system.rt_DNSServer1IP`

- 
Discard unchanged with heartbeat: `1h`

|
|DNS server 2|
Secondary DNS server currently in use on the system.
|Dependent item|ribbon.system.dns.server2
**Preprocessing**

- 
JSON Path: `$.system.rt_DNSServer2IP`

- 
Discard unchanged with heartbeat: `1h`

|
|License type|
Shows the type of license.

  0 - No license installed.

  1 - Node license is installed.

  2 - Base license is installed.
|Dependent item|ribbon.license.type
**Preprocessing**

- 
JSON Path: `$.license.LicenseType`

- 
Discard unchanged with heartbeat: `12h`

|
|License class|
Indicates the version of license format.

  0 - This is a v1 or legacy SBC 1000/2000 license.

  1 - This is a v2 or legacy SWe Edge license.

  2 - This is a v3 or new SWe Edge license.
|Dependent item|ribbon.license.class
**Preprocessing**

- 
JSON Path: `$.license.LicenseClass`

- 
Discard unchanged with heartbeat: `12h`

|
|SIP Channels licensed|
Displays the total number of SIP channel licenses purchased for the system.
|Dependent item|ribbon.license.sip.channels
**Preprocessing**

- 
JSON Path: `$.license.SIPChannels`

- 
Discard unchanged with heartbeat: `12h`

|
|Available SIP Channels licensed|
Displays the total number of SIP Channel licenses currently available for use on the system.
|Dependent item|ribbon.license.sip.channels.available
**Preprocessing**

- 
JSON Path: `$.license.AvailableSIPCh`

- 
Discard unchanged with heartbeat: `12h`

|
|SIP Registrations licensed|
Displays the total number of SIP registration licenses purchased for the system. Deprecated on SWe Edge since SIP registration feature is now free.
|Dependent item|ribbon.license.sip.registrations
**Preprocessing**

- 
JSON Path: `$.license.SIPRegistrations`

⛔️Custom on fail: Discard value

- 
Discard unchanged with heartbeat: `12h`

|
|SIP Registrations available|
Displays the total number of SIP registration licenses currently available for use on the system. Deprecated on SWe Edge since SIP registration feature is now free.
|Dependent item|ribbon.license.sip.registrations.available
**Preprocessing**

- 
JSON Path: `$.license.AvailableSIPReg`

⛔️Custom on fail: Discard value

- 
Discard unchanged with heartbeat: `12h`

|
|License expiration date|
Shows when the license is due to expire. This attribute is only applicable to the SBC 1000 and 2000.
|Dependent item|ribbon.license.expiration.date
**Preprocessing**

- 
JSON Path: `$.license.ExpirationDate`

⛔️Custom on fail: Discard value

- 
Discard unchanged with heartbeat: `12h`

|

### Triggers

|Name|Description|Expression|Severity|Dependencies and additional info|
|----|-----------|----------|--------|--------------------------------|
|Ribbon: System status - Card Failed|
The current system status - Card Failed.
|`last(/Ribbon SBC Edge by HTTP/ribbon.system.status)=9`|Average||
|Ribbon: High CPU utilization|
CPU utilization is too high. The system might be slow to respond.
|`min(/Ribbon SBC Edge by HTTP/ribbon.cpu.usage,5m)>{$RIBBON.CPU.UTIL.CRIT}`|Average||
|Ribbon: High memory utilization|
Memory utilization is too high. The system might be slow to respond.
|`min(/Ribbon SBC Edge by HTTP/ribbon.memory.usage,5m)>{$RIBBON.MEMORY.UTIL.CRIT}`|Average||
|Ribbon: Chassis status - Card Failed|
The current chassis status - Card Failed.
|`last(/Ribbon SBC Edge by HTTP/ribbon.chassis.status)=9`|Average||
|Ribbon: Temperature on the bottom of the main board is above critical threshold|
This trigger uses temperature the bottom of the main board value.
|`avg(/Ribbon SBC Edge by HTTP/ribbon.chassis.board.bottom.temp,5m)>{$RIBBON.TEMP.BOTTOM.MAIN.BOARD.CRIT}`|High||
|Ribbon: Temperature on the top of the main board is above critical threshold|
This trigger uses temperature of on the top of the main board value.
|`avg(/Ribbon SBC Edge by HTTP/ribbon.chassis.board.top.temp,5m)>{$RIBBON.TEMP.TOP.MAIN.BOARD.CRIT}`|High||
|Ribbon: Temperature on chassis core switch is above critical threshold|
This trigger uses temperature of chassis core switch value.
|`avg(/Ribbon SBC Edge by HTTP/ribbon.chassis.core.switch.temp,5m)>{$RIBBON.TEMP.CORE.CRIT}`|High||
|Ribbon: DNS server 1 has been changed|
The DNS server 1 has been changed. Acknowledge to close the problem manually.
|`last(/Ribbon SBC Edge by HTTP/ribbon.system.dns.server1,#1)<>last(/Ribbon SBC Edge by HTTP/ribbon.system.dns.server1,#2) and length(last(/Ribbon SBC Edge by HTTP/ribbon.system.dns.server1))>0`|Warning|**Manual close**: Yes|
|Ribbon: DNS server 2 has been changed|
The DNS server 2 has been changed. Acknowledge to close the problem manually.
|`last(/Ribbon SBC Edge by HTTP/ribbon.system.dns.server2,#1)<>last(/Ribbon SBC Edge by HTTP/ribbon.system.dns.server2,#2) and length(last(/Ribbon SBC Edge by HTTP/ribbon.system.dns.server2))>0`|Warning|**Manual close**: Yes|

### LLD rule Network interface discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|Network interface discovery|
Used for discovering system interfaces.
|Dependent item|ribbon.net.if.discovery
**Preprocessing**

- 
JavaScript: `The text is too long. Please see the template.`

- 
Discard unchanged with heartbeat: `1h`

|

### Item prototypes for Network interface discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|Interface [{#INTERFACE.NAME}]: Raw data|
Raw data of the interface.
|Dependent item|ribbon.net.if.raw.data[{#INTERFACE.ID}]
**Preprocessing**

- 
JSON Path: `$.{#INTERFACE.ID}`

|
|Interface [{#INTERFACE.NAME}]: Config interface state|
Specifies the Administrative State of the resource.

Possible values:

- Disabled

- Enabled
|Dependent item|ribbon.net.if.config.state[{#INTERFACE.ID}]
**Preprocessing**

- 
JSON Path: `$.ConfigIEState`

- 
Discard unchanged with heartbeat: `1h`

|
|Interface [{#INTERFACE.NAME}]: Operational status|
The operational status of the interface.

Possible values:

- Up

- Down
|Dependent item|ribbon.net.if.operator.state[{#INTERFACE.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_ifOperatorStatus`

|
|Interface [{#INTERFACE.NAME}]: Networking mode|
Specifies if the port is in switched mode or routed mode.

Possible values:

- Switch

- Route
|Dependent item|ribbon.net.if.networking.mode[{#INTERFACE.ID}]
**Preprocessing**

- 
JSON Path: `$.ifNetworkingMode`

- 
Discard unchanged with heartbeat: `12h`

|
|Interface [{#INTERFACE.NAME}]: Interface type|
Specifies the interface type.

Possible values:

- Ethernet

- VLAN

- QINQ

- BONDED

- BRIDGE
|Dependent item|ribbon.net.if.type[{#INTERFACE.ID}]
**Preprocessing**

- 
JSON Path: `$.ifType`

- 
Discard unchanged with heartbeat: `12h`

|
|Interface [{#INTERFACE.NAME}]: Bits received|
Displays the number of received bits on this port.
|Dependent item|ribbon.net.if.in.octets[{#INTERFACE.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_ifInOctets`

- Change per second
- 
Custom multiplier: `8`

|
|Interface [{#INTERFACE.NAME}]: Bits sent|
Displays the number of transmitted bits on this port.
|Dependent item|ribbon.net.if.out.octets[{#INTERFACE.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_ifOutOctets`

- Change per second
- 
Custom multiplier: `8`

|
|Interface [{#INTERFACE.NAME}]: Speed|
An estimate of the interface's current bandwidth in bits per second.

Possible values:

- 10 Mbps

- 100 Mbps

- 1000 Mbps

- Auto
|Dependent item|ribbon.net.if.speed[{#INTERFACE.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_ifSpeed`

- 
Discard unchanged with heartbeat: `12h`

|

### Trigger prototypes for Network interface discovery

|Name|Description|Expression|Severity|Dependencies and additional info|
|----|-----------|----------|--------|--------------------------------|
|Ribbon: Interface [{#INTERFACE.NAME}]: Operational status is DOWN|
The operational status of the interface is down.
|`last(/Ribbon SBC Edge by HTTP/ribbon.net.if.operator.state[{#INTERFACE.ID}])=1 and last(/Ribbon SBC Edge by HTTP/ribbon.net.if.config.state[{#INTERFACE.ID}])=1`|Average||

### LLD rule Disk partition discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|Disk partition discovery|
Used for discovering system disk partition.
|Dependent item|ribbon.disk.discovery
**Preprocessing**

- 
JavaScript: `The text is too long. Please see the template.`

- 
Discard unchanged with heartbeat: `1h`

|

### Item prototypes for Disk partition discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|Disk [{#DISK.NAME}]: Raw data|
Raw data of the disk partition.
|Dependent item|ribbon.disk.raw.data[{#DISK.ID}]
**Preprocessing**

- 
JSON Path: `$.{#DISK.ID}`

|
|Disk [{#DISK.NAME}]: Type|
Identifies the user-friendly physical device holding the partition.

Possible values:

- Configuration

- Logs

- Temp

- Core File

- ASM Module

- Software Update

- Internal Logs

- System

- Others

- Packet Capture Logs
|Dependent item|ribbon.disk.type[{#DISK.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_PartitionType`

- 
Discard unchanged with heartbeat: `12h`

|
|Disk [{#DISK.NAME}]: Utilization|
Amount of memory used by this partition, expressed as a percentage.
|Dependent item|ribbon.disk.usage.percent[{#DISK.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_CurrentUsage`

|
|Disk [{#DISK.NAME}]: Size|
Specifies the maximum amount of memory, in bytes available in this partition.
|Dependent item|ribbon.disk.size.max[{#DISK.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_MaximumSize`

- 
Discard unchanged with heartbeat: `12h`

|
|Disk [{#DISK.NAME}]: Available|
Amount of memory in bytes, available for use in the file system.
|Dependent item|ribbon.disk.size.available[{#DISK.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_MemoryAvailable`

|
|Disk [{#DISK.NAME}]: Used|
Amount of memory in bytes, used by the existing files in the file system.
|Dependent item|ribbon.disk.size.used[{#DISK.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_MemoryUsed`

|

### Trigger prototypes for Disk partition discovery

|Name|Description|Expression|Severity|Dependencies and additional info|
|----|-----------|----------|--------|--------------------------------|
|Ribbon: Disk [{#DISK.NAME}]: Disk space usage is high|
Disk space usage is larger than the threshold.
|`min(/Ribbon SBC Edge by HTTP/ribbon.disk.usage.percent[{#DISK.ID}],5m)>{$RIBBON.DISK.USED.MAX:"{#DISK.NAME}"}`|Average||

### LLD rule Power supply discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|Power supply discovery|
Used for discovering the power supply.
|Dependent item|ribbon.psu.discovery
**Preprocessing**

- 
JavaScript: `The text is too long. Please see the template.`

- 
Discard unchanged with heartbeat: `1h`

|

### Item prototypes for Power supply discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|PSU [{#PSU.ID}]: Raw data|
Raw data for this power supply.
|Dependent item|ribbon.psu.raw.data[{#PSU.ID}]
**Preprocessing**

- 
JSON Path: `$.{#PSU.ID}`

|
|PSU [{#PSU.ID}]: AC input good|
Indicates whether the AC power input for this power supply is in a good state.

Possible values:

- False

- True
|Dependent item|ribbon.psu.ac.input.good[{#PSU.ID}]
**Preprocessing**

- 
JSON Path: `$.ACInputGood`

- 
Discard unchanged with heartbeat: `3h`

|
|PSU [{#PSU.ID}]: Power in|
Input power of this power supply in watts.
|Dependent item|ribbon.psu.power.in[{#PSU.ID}]
**Preprocessing**

- 
JSON Path: `$.PowerIn`

|
|PSU [{#PSU.ID}]: Power out|
Output power of this power supply in watts.
|Dependent item|ribbon.psu.power.out[{#PSU.ID}]
**Preprocessing**

- 
JSON Path: `$.PowerOut`

|
|PSU [{#PSU.ID}]: Voltage in|
Input voltage of this power supply.
|Dependent item|ribbon.psu.voltage.in[{#PSU.ID}]
**Preprocessing**

- 
JSON Path: `$.VoltageIn`

|
|PSU [{#PSU.ID}]: Voltage out|
Output voltage of this power supply.
|Dependent item|ribbon.psu.voltage.out[{#PSU.ID}]
**Preprocessing**

- 
JSON Path: `$.VoltageOut`

|
|PSU [{#PSU.ID}]: Current in|
Input current of this power supply in amperes.
|Dependent item|ribbon.psu.current.in[{#PSU.ID}]
**Preprocessing**

- 
JSON Path: `$.CurrentIn`

|
|PSU [{#PSU.ID}]: Current out|
Output current of this power supply in amperes.
|Dependent item|ribbon.psu.current.out[{#PSU.ID}]
**Preprocessing**

- 
JSON Path: `$.CurrentOut`

|
|PSU [{#PSU.ID}]: Temperature|
Temperature of this power supply in degrees Celsius.
|Dependent item|ribbon.psu.temp[{#PSU.ID}]
**Preprocessing**

- 
JSON Path: `$.Temp`

|
|PSU [{#PSU.ID}]: Fan1 speed|
The speed of the first fan on this power supply in RPM.
|Dependent item|ribbon.psu.fan1.speed[{#PSU.ID}]
**Preprocessing**

- 
JSON Path: `$.Fan1_Speed`

|
|PSU [{#PSU.ID}]: Fan2 speed|
The speed of the second fan on this power supply in RPM.
|Dependent item|ribbon.psu.fan2.speed[{#PSU.ID}]
**Preprocessing**

- 
JSON Path: `$.Fan2_Speed`

|

### Trigger prototypes for Power supply discovery

|Name|Description|Expression|Severity|Dependencies and additional info|
|----|-----------|----------|--------|--------------------------------|
|Ribbon: PSU [{#PSU.ID}]: AC input is not OK|
The AC power input of the power supply reports a bad state.
|`last(/Ribbon SBC Edge by HTTP/ribbon.psu.ac.input.good[{#PSU.ID}]) = 0`|Warning|**Manual close**: Yes|
|Ribbon: PSU [{#PSU.ID}]: Temperature on power supply is above critical threshold|
This trigger uses temperature of power supply value.
|`avg(/Ribbon SBC Edge by HTTP/ribbon.psu.temp[{#PSU.ID}],5m)>{$RIBBON.TEMP.PSU.CRIT}`|High||

### LLD rule Fan discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|Fan discovery|
Used for discovering fans.
|Dependent item|ribbon.fan.discovery
**Preprocessing**

- 
JavaScript: `The text is too long. Please see the template.`

- 
Discard unchanged with heartbeat: `1h`

|

### Item prototypes for Fan discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|Fan [{#FAN.ID}]: Speed|
Indicates the speed of the fan in RPM.
|Dependent item|ribbon.fan.speed[{#FAN.ID}]
**Preprocessing**

- 
JSON Path: `$.{#FAN.ID}.Fan_Speed`

|

### LLD rule DSP card discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|DSP card discovery|
Used for discovering DSP cards.
|Dependent item|ribbon.dsp.card.discovery
**Preprocessing**

- 
JavaScript: `The text is too long. Please see the template.`

- 
Discard unchanged with heartbeat: `1h`

|

### Item prototypes for DSP card discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|DSP Card [{#DSP.CARD.ID}]: Raw data|
Raw data for `{#DSP.CARD.ID}` DSP card.
|Dependent item|ribbon.dsp.card.raw.data[{#DSP.CARD.ID}]
**Preprocessing**

- 
JSON Path: `$.{#DSP.CARD.ID}`

|
|DSP Card [{#DSP.CARD.ID}]: Status|
Indicates the hardware initialization state for this DSP card.

Possible values:

  - None

  - Card Idle

  - Card Detected

  - Card Activating

  - Card Activated

  - Card Remove Requested

  - Card Removing

  - Card Removed

  - Card Downloading

  - Card Failed

  - Card Disabled Long Loop

  - MAX
|Dependent item|ribbon.dsp.card.status[{#DSP.CARD.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_Status`

- 
Discard unchanged with heartbeat: `1h`

|
|DSP Card [{#DSP.CARD.ID}]: Location|
The hardware module's location within the SBC.

Possible values:

  - Unknown

  - LineCard1

  - LineCard2

  - DSPCard1

  - DSPCard2

  - DSPCard3

  - DSPCard4

  - DSPCard5

  - DSPCard6

  - BITS_WAN

  - SFP

  - COMExpress

  - Mainboard

  - PSU1

  - PSU2

  - UX1000_Telco_1

  - UX1000_Telco_2

  - UX1000_Telco_3

  - UX1000_Telco_4

  - UX1000_Telco_5

  - UX1000_Telco_6

  - UX1000_DS1_Telco

  - UX1000_DS1_WAN

  - MAX
|Dependent item|ribbon.dsp.card.location[{#DSP.CARD.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_Location`

- 
Discard unchanged with heartbeat: `12h`

|
|DSP Card [{#DSP.CARD.ID}]: Available|
Identifies whether a DSP Module is installed in this slot.

Possible values:

  - False

  - True
|Dependent item|ribbon.dsp.card.available[{#DSP.CARD.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_Available`

- 
Discard unchanged with heartbeat: `1h`

|
|DSP Card [{#DSP.CARD.ID}]: Service status|
Indicates the status of the DSP Module

`Detected` - The module is detected by the SBC software but is not initialized or available for signal processing tasks.

`Available` - The module is ready for signal processing tasks.
|Dependent item|ribbon.dsp.card.service.status[{#DSP.CARD.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_ServiceStatus`

|
|DSP Card [{#DSP.CARD.ID}]: CPU usage|
Indicates the current CPU level for this DSP. Only applicable if the DSP is available.
|Dependent item|ribbon.dsp.card.cpu.usage.percent[{#DSP.CARD.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_CPUUsage`

⛔️Custom on fail: Discard value

|
|DSP Card [{#DSP.CARD.ID}]: Channels in use|
Indicates the number of channels currently in use on the DSP Module.
|Dependent item|ribbon.dsp.card.channels.in.use[{#DSP.CARD.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_ChannelsInUse`

|
|DSP Card [{#DSP.CARD.ID}]: Updated time|
Indicates the time, when this DSP reported it's CPU usage.
|Dependent item|ribbon.dsp.card.updated.time[{#DSP.CARD.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_UpdatedTime`

|

### Trigger prototypes for DSP card discovery

|Name|Description|Expression|Severity|Dependencies and additional info|
|----|-----------|----------|--------|--------------------------------|
|Ribbon: DSP Card [{#DSP.CARD.ID}]: Status is FAILED|
The DSP card status is failed.
|`last(/Ribbon SBC Edge by HTTP/ribbon.dsp.card.status[{#DSP.CARD.ID}])=9`|High||
|Ribbon: DSP Card [{#DSP.CARD.ID}]: Service status is Detected|
The DSP card service status is Detected.
|`last(/Ribbon SBC Edge by HTTP/ribbon.dsp.card.service.status[{#DSP.CARD.ID}])=0`|Warning||
|Ribbon: DSP Card [{#DSP.CARD.ID}]: CPU usage is high|
The DSP card CPU usage is higher than the threshold.
|`avg(/Ribbon SBC Edge by HTTP/ribbon.dsp.card.cpu.usage.percent[{#DSP.CARD.ID}],15m)>{$RIBBON.DSP.CARD.CPU.USAGE.CRIT:"{#DSP.CARD.ID}"}`|Average||

### LLD rule SIP server discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|SIP server discovery|
Used for discovering SIP servers.
|Dependent item|ribbon.sip.server.discovery
**Preprocessing**

- 
JavaScript: `The text is too long. Please see the template.`

- 
Discard unchanged with heartbeat: `1h`

|

### Item prototypes for SIP server discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|SIP Server [{#SIP.SERVER.NAME}]:[{#SIP.SERVER.DESCR}]: Raw data|
Raw data for this SIP server.
|Dependent item|ribbon.sip.server.raw.data[{#SIP.SERVER.NAME}]
**Preprocessing**

- 
JSON Path: `$.{#SIP.SERVER.ID}.metrics`

|
|SIP Server [{#SIP.SERVER.NAME}]:[{#SIP.SERVER.DESCR}]: Status|
Indicates the status of the SIP server.
|Dependent item|ribbon.sip.server.status[{#SIP.SERVER.NAME}]
**Preprocessing**

- 
JSON Path: `$.rt_ServerStatus`

- 
Discard unchanged with heartbeat: `1h`

|
|SIP Server [{#SIP.SERVER.NAME}]:[{#SIP.SERVER.DESCR}]: Uptime|
Displays the time for which the server was functioning and responding to SIP Options.
|Dependent item|ribbon.sip.server.uptime[{#SIP.SERVER.NAME}]
**Preprocessing**

- 
JSON Path: `$.rt_UpTime`

|
|SIP Server [{#SIP.SERVER.NAME}]:[{#SIP.SERVER.DESCR}]: Downtime|
Displays the time for which server was down due to not responding to options request or dns failures.
|Dependent item|ribbon.sip.server.downtime[{#SIP.SERVER.NAME}]
**Preprocessing**

- 
JSON Path: `$.rt_DownTime`

|
|SIP Server [{#SIP.SERVER.NAME}]:[{#SIP.SERVER.DESCR}]: Host|
Specifies the IP address or FQDN where this Signaling Group sends SIP messages. If an FQDN is configured all the associated servers are included and used according to the server selection configuration element.
|Dependent item|ribbon.sip.server.host[{#SIP.SERVER.NAME}]
**Preprocessing**

- 
JSON Path: `$.Host`

- 
Discard unchanged with heartbeat: `3h`

|
|SIP Server [{#SIP.SERVER.NAME}]:[{#SIP.SERVER.DESCR}]: Port|
Specifies the port number to send SIP messages.
|Dependent item|ribbon.sip.server.port[{#SIP.SERVER.NAME}]
**Preprocessing**

- 
JSON Path: `$.Port`

- 
Discard unchanged with heartbeat: `3h`

|
|SIP Server [{#SIP.SERVER.NAME}]:[{#SIP.SERVER.DESCR}]: Type|
Specifies the method to use to lookup SIP servers

`eConventionalSrvr` - A configured server entry defined by IP or FQDN.

`eSrvRecordTemplateSrvr` - This is not an actual server but a template which will populate the server(s) once the SRV Query gets a response from DNS.

`eSrvRecordSrvr`- The actual server created after SRV Query."
|Dependent item|ribbon.sip.server.type[{#SIP.SERVER.NAME}]
**Preprocessing**

- 
JSON Path: `$.ServerType`

- 
Discard unchanged with heartbeat: `3h`

|
|SIP Server [{#SIP.SERVER.NAME}]:[{#SIP.SERVER.DESCR}]: Transactions|
Displays the number of SBC client transactions with the server.
|Dependent item|ribbon.sip.server.transactions[{#SIP.SERVER.NAME}]
**Preprocessing**

- 
JSON Path: `$.rt_Transactions`

|
|SIP Server [{#SIP.SERVER.NAME}]:[{#SIP.SERVER.DESCR}]: Transactions failed|
Displays the number of failed SBC client transactions with the server.
|Dependent item|ribbon.sip.server.transactions.failed[{#SIP.SERVER.NAME}]
**Preprocessing**

- 
JSON Path: `$.rt_TransactionFalures`

|

### Trigger prototypes for SIP server discovery

|Name|Description|Expression|Severity|Dependencies and additional info|
|----|-----------|----------|--------|--------------------------------|
|Ribbon: SIP Server [{#SIP.SERVER.NAME}]: Failed transactions are high|
The number of failed transactions is higher than the threshold.
|`last(/Ribbon SBC Edge by HTTP/ribbon.sip.server.transactions.failed[{#SIP.SERVER.NAME}])>{$RIBBON.SIP.SERVER.TRANSACTIONS.FAILED.MAX:"{#SIP.SERVER.NAME}"}`|Average||

### LLD rule SIP signal group discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|SIP signal group discovery|
Used for discovering SIP signal groups.
|Dependent item|ribbon.sip.signal.group.discovery
**Preprocessing**

- 
JavaScript: `The text is too long. Please see the template.`

- 
Discard unchanged with heartbeat: `1h`

|

### Item prototypes for SIP signal group discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|SIP Signal Group [{#SIP.SIGNAL.GROUP.DESCR}]: Raw data|
Raw data for this SIP signal group.
|Dependent item|ribbon.sip.signal.group.raw.data[{#SIP.SIGNAL.GROUP.ID}]
**Preprocessing**

- 
JSON Path: `$.{#SIP.SIGNAL.GROUP.ID}`

|
|SIP Signal Group [{#SIP.SIGNAL.GROUP.DESCR}]: Type|
Provides the signaling type of the signaling group.

Possible values:

- sgISDN

- sgSIP

- sgCAS
|Dependent item|ribbon.sip.signal.group.type[{#SIP.SIGNAL.GROUP.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_Type`

- 
Discard unchanged with heartbeat: `1h`

|
|SIP Signal Group [{#SIP.SIGNAL.GROUP.DESCR}]: Status|
Provides the runtime operational status of the signaling group.

Possible values:

- sgsUP

- sgsDOWN

- sgsUpDraining

- sgsUpDrained

- sgsUpPeersDown

- sgsNONE_EXISTS
|Dependent item|ribbon.sip.signal.group.status[{#SIP.SIGNAL.GROUP.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_Status`

- 
Discard unchanged with heartbeat: `1h`

|
|SIP Signal Group [{#SIP.SIGNAL.GROUP.DESCR}]: Number of channels|
Provides the number of channels currently provisioned on this signaling group.
|Dependent item|ribbon.sip.signal.group.number.of.channels[{#SIP.SIGNAL.GROUP.ID}]
**Preprocessing**

- 
JSON Path: `$.rt_NumberOfChannels`

|

### Trigger prototypes for SIP signal group discovery

|Name|Description|Expression|Severity|Dependencies and additional info|
|----|-----------|----------|--------|--------------------------------|
|Ribbon: SIP Signal Group [{#SIP.SIGNAL.GROUP.DESCR}]: Status is DOWN|
The SIP signaling group status is down.
|`last(/Ribbon SBC Edge by HTTP/ribbon.sip.signal.group.status[{#SIP.SIGNAL.GROUP.ID}])=1`|Warning||

### LLD rule Certificate discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|Certificate discovery|
Used for discovering certificates.
|Dependent item|ribbon.cert.discovery
**Preprocessing**

- 
JavaScript: `The text is too long. Please see the template.`

- 
Discard unchanged with heartbeat: `1h`

|

### Item prototypes for Certificate discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|Certificate [{#CERT.NAME}]: Raw data|
Raw data for "{#CERT.NAME}" certificate.
|Dependent item|ribbon.cert.status.raw.data[{#CERT.ID}]
**Preprocessing**

- 
JSON Path: `$.{#CERT.ID}`

- 
Discard unchanged with heartbeat: `1h`

|
|Certificate [{#CERT.NAME}]: Valid until|
Indicates the expiration date of this certificate.
|Dependent item|ribbon.cert.status.valid.until[{#CERT.ID}]
**Preprocessing**

- 
JSON Path: `$.CertEndDateEpoch`

|
|Certificate [{#CERT.NAME}]: Status|
Displays the status of the certificate validation and verification against the trusted CA.
|Dependent item|ribbon.cert.status[{#CERT.ID}]
**Preprocessing**

- 
JSON Path: `$.CertVerifyStatus`

|

### Trigger prototypes for Certificate discovery

|Name|Description|Expression|Severity|Dependencies and additional info|
|----|-----------|----------|--------|--------------------------------|
|Ribbon: Certificate [{#CERT.NAME}]: Status in not OK|
The certificate status is not OK.
|`last(/Ribbon SBC Edge by HTTP/ribbon.cert.status[{#CERT.ID}])<>"OK"`|High||

### LLD rule Alarm discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|Alarm discovery|
Used for discovering active alarms.
|Dependent item|ribbon.alarm.discovery
**Preprocessing**

- 
JavaScript: `The text is too long. Please see the template.`

- 
Discard unchanged with heartbeat: `1h`

|

### Item prototypes for Alarm discovery

|Name|Description|Type|Key and additional info|
|----|-----------|----|-----------------------|
|Alarm [{#ALARM.EVENT.ID}.{#ALARM.EVENT.SUB.ID}]: Source: [{#ALARM.SOURCE}]: Severity|
Severity of `{#ALARM.CONDITION}` event.
|Dependent item|ribbon.alarm.severity[{#ALARM.ID}]
**Preprocessing**

- 
JSON Path: `$.{#ALARM.ID}.aSeverity`

|

### Trigger prototypes for Alarm discovery

|Name|Description|Expression|Severity|Dependencies and additional info|
|----|-----------|----------|--------|--------------------------------|
|Ribbon: Alarm [{#ALARM.EVENT.ID}.{#ALARM.EVENT.SUB.ID}]: Source: [{#ALARM.SOURCE}]: Severity is critical|
The alarm `{#ALARM.CONDITION}` severity is critical.
|`last(/Ribbon SBC Edge by HTTP/ribbon.alarm.severity[{#ALARM.ID}])=4`|High|**Manual close**: Yes|
|Ribbon: Alarm [{#ALARM.EVENT.ID}.{#ALARM.EVENT.SUB.ID}]: Source: [{#ALARM.SOURCE}]: Severity is major|
The alarm `{#ALARM.CONDITION}` severity is major.
|`last(/Ribbon SBC Edge by HTTP/ribbon.alarm.severity[{#ALARM.ID}])=3`|Average|**Manual close**: Yes|
|Ribbon: Alarm [{#ALARM.EVENT.ID}.{#ALARM.EVENT.SUB.ID}]: Source: [{#ALARM.SOURCE}]: Severity is minor|
The alarm `{#ALARM.CONDITION}` severity is minor.
|`last(/Ribbon SBC Edge by HTTP/ribbon.alarm.severity[{#ALARM.ID}])=2`|Warning|**Manual close**: Yes|

## Feedback

Please report any issues with the template at [`https://support.zabbix.com`](https://support.zabbix.com)

You can also provide feedback, discuss the template, or ask for help at [`ZABBIX forums`](https://www.zabbix.com/forum/zabbix-suggestions-and-feedback)

