README.md

[PACKAGE]: ../../raw/master/mkp/huawei_entity_optical-0.0.4-20230603.mkp "huawei_entity_optical-0.0.4-20230603.mkp"
# Huawei optical modules

This check will monitor the *Temperature*, *Voltage*, *Electrical current* and *Optical signal power*  of optical modules (SFP).

---
### Download

* [Download latest mkp file][PACKAGE]

**Note**: before you update to a newer version, always check the [CHANGELOG](CHANGELOG). There might be incompatible changes.

---                   
### Installation

You can install the package by uploading it to your CheckMK site and as site user run 
```
mkp install PACKAGENAME-VERSION.mkp
```
or beginning with CMK2.2.x
```
mkp add PACKAGENAME-VERSION.mkp
mkp enable PACKAGENAME VERSION
```
In the non RAW editions of CheckMK you can use the GUI to install the package (_Setup_ -> _Extension Packages_ -> _Upload package_)

---
### Want to contribute?

Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contributing")

---
### Check Info *huawei_entity_optical_temp*

* *service*: this check creates the service *Temperature* for each SFP with the interface name as the item
* *state*: **critical**/**warning** if outside the limits
* *wato*: upper and lower limits
* *perfdata*: 
    * Temperature in °C

![sample output](img/sample_temperature.png?raw=true "sample [SHORT TITLE]")

---
### Check Info *huawei_entity_optical_current*

* *service*: this check creates the service *Current* for each SFP with the interface name as the item
* *state*: **critical**/**warning** if outside the limits
* *wato*: upper and lower limits
* *perfdata*:
    * Electrical current in Ampere

![sample output](img/sample_current.png?raw=true "sample [SHORT TITLE]")

---
### Check Info *huawei_entity_optical_dom*

* *service*: this check creates the service *DOM* for each SFP with the interface name as the item
* *state*: **critical**/**warning** if outside the limits
* *wato*: lower and upper levels for RX/TX signal power and levels for deviation.
* *perfdata*:
    * RX and TX signal power in dBm
    * RX and TX signal power deviation in dBm

Deviation extension is based on [CheckMK PR #211](https://github.com/tribe29/checkmk/pull/211) *Add deviation power to cisco_temperature.dom* by [*agabellini*](https://github.com/agabellini)

![sample output](img/sample_dom.png?raw=true "sample")

---
### Check Info *huawei_entity_optical_voltage*

* *service*:  this check creates the service *Voltage* for each SFP with the interface name as the item
* *state*: **critical**/**warning** if outside the limits
* *wato*: upper and lower limits
* *perfdata*:
    * Voltage in Volt

![sample output](img/sample_voltage.png?raw=true "sample")