3CX Rest API

Compatibilité

Ce connecteur a été conçu pour être compatible avec les produits suivants.

Produit	Modèles	Versions
3CX	-	20.0.0.1620

La version 18 de 3CX n'est plus supportée et devrait être mise à jour en version 20.

Contenu du pack

Modèles

Le connecteur de supervision 3CX Rest API apporte un modèle d'hôte :

• App-VoIP-3cx-Restapi-custom

Le connecteur apporte le modèle de service suivant (classé selon le modèle d'hôte auquel il est rattaché) :

App-VoIP-3cx-Restapi-custom

Alias	Modèle de service	Description
System	App-Voip-3cx-System-Restapi-custom	Contrôle l'état du système

Les services listés ci-dessus sont créés automatiquement lorsque le modèle d'hôte App-VoIP-3cx-Restapi-custom est utilisé.

Métriques & statuts collectés

Voici le tableau des services pour ce connecteur, détaillant les métriques rattachées à chaque service.

System

Métrique	Unité
system.calls.active.usage.count	count
system.calls.active.free.count	count
system.calls.active.usage.percentage	%
system.extensions.registered.count	count
service#status	N/A

Prérequis

En fonction du type de compte administrateur dont vous disposez, vous trouverez les informations nécessaires dans la documentation officielle de 3CX.

Installer le connecteur de supervision

Pack

La procédure d'installation des connecteurs de supervision diffère légèrement suivant que votre licence est offline ou online.

1. Si la plateforme est configurée avec une licence online, l'installation d'un paquet n'est pas requise pour voir apparaître le connecteur dans le menu Configuration > Connecteurs > Connecteurs de supervision. Au contraire, si la plateforme utilise une licence offline, installez le paquet sur le serveur central via la commande correspondant au gestionnaire de paquets associé à sa distribution :

Alma / RHEL / Oracle Linux 8

dnf install centreon-pack-applications-voip-3cx-restapi

Alma / RHEL / Oracle Linux 9

dnf install centreon-pack-applications-voip-3cx-restapi

Debian 11 & 12

apt install centreon-pack-applications-voip-3cx-restapi

CentOS 7

yum install centreon-pack-applications-voip-3cx-restapi

2. Quel que soit le type de la licence (online ou offline), installez le connecteur 3CX Rest API depuis l'interface web et le menu Configuration > Connecteurs > Connecteurs de supervision.

Plugin

À partir de Centreon 22.04, il est possible de demander le déploiement automatique du plugin lors de l'utilisation d'un connecteur. Si cette fonctionnalité est activée, et que vous ne souhaitez pas découvrir des éléments pour la première fois, alors cette étape n'est pas requise.

Plus d'informations dans la section Installer le plugin.

Utilisez les commandes ci-dessous en fonction du gestionnaire de paquets de votre système d'exploitation :

Alma / RHEL / Oracle Linux 8

dnf install centreon-plugin-Applications-Voip-3cx-Restapi

Alma / RHEL / Oracle Linux 9

dnf install centreon-plugin-Applications-Voip-3cx-Restapi

Debian 11 & 12

apt install centreon-plugin-applications-voip-3cx-restapi

CentOS 7

yum install centreon-plugin-Applications-Voip-3cx-Restapi

Utiliser le connecteur de supervision

Utiliser un modèle d'hôte issu du connecteur

1. Ajoutez un hôte à Centreon depuis la page Configuration > Hôtes.
2. Complétez les champs Nom, Alias & IP Address/DNS correspondant à votre ressource.
3. Appliquez le modèle d'hôte App-VoIP-3cx-Restapi-custom. Une liste de macros apparaît. Les macros vous permettent de définir comment le connecteur se connectera à la ressource, ainsi que de personnaliser le comportement du connecteur.
4. Renseignez les macros désirées. Attention, certaines macros sont obligatoires.

Macro	Description	Valeur par défaut	Obligatoire
3CXUSERNAME	Define the username for authentication	USERLOGIN	X
3CXPASSWORD	Define the password associated with the username	USERPASSWORD	X
3CXPROTO	Define the protocol to reach the API (default: 'https')	https
3CXPORT	Define the port to connect to (default: '443')	443
3CX_AUTH_MODE	Define the authentication mode. oauth2: for 3CX Enterprise edition. Uses OAuth2 client_credentials flow via POST /connect/token. Requires an API client created in 3CX admin console (/#/office/integrations/api). The API client must have at least the 'Admin' role. login: for 3CX Pro edition. Uses username/password login via POST /webclient/api/Login/GetAccessToken. Requires a System Owner account with 2FA disabled. IMPORTANT: The poller IP must be whitelisted in 3CX admin console under Security > Console Restrictions > Allow access from specific IP addresses. Without this, 3CX returns a degraded token causing 403 errors on all API endpoints	oauth2
3CXEXTRAOPTIONS	Any extra option you may want to add to every command (a --verbose flag for example). Toutes les options sont listées ici.

5. Déployez la configuration. L'hôte apparaît dans la liste des hôtes supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails de l'hôte : celle-ci montre les valeurs des macros.

Utiliser un modèle de service issu du connecteur

1. Si vous avez utilisé un modèle d'hôte et coché la case Créer aussi les services liés aux modèles, les services associés au modèle ont été créés automatiquement, avec les modèles de services correspondants. Sinon, créez les services désirés manuellement et appliquez-leur un modèle de service.
2. Renseignez les macros désirées (par exemple, ajustez les seuils d'alerte). Les macros indiquées ci-dessous comme requises (Obligatoire) doivent être renseignées.

Extension

Macro	Description	Valeur par défaut	Obligatoire
DND_PROFILE_NAME	Name of the profile to consider as DND (Do Not Disturb). Default: DND. In 3CX version 20, the DND boolean field no longer exists. DND status is derived from the CurrentProfileName field. Use this option to specify the exact profile name configured in your 3CX instance for DND. Example: --dnd-profile-name='Do not disturb'	DND
INCLUDE_EXTENSION	Filter extension (by number, first name or last name)
EXCLUDE_EXTENSION	Exclude extension (by number, first name or last name)
WARNING_COUNT	Threshold for extensions count
CRITICAL_COUNT	Threshold for extensions count
WARNING_STATUS	Define the conditions to match for the status to be WARNING. You can use the following variables: extension, registered, dnd, profile, status, duration
CRITICAL_STATUS	Define the conditions to match for the status to be CRITICAL. You can use the following variables: extension, registered, dnd, profile, status, duration
EXTRA_OPTIONS	Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.

License

Macro	Description	Valeur par défaut	Obligatoire
WARNING_LICENSE	Set warning condition for license status. Default: '%{expires_in} < 10' (license expires within 10 days). Variables available: activated, license_active, expires_in, expires_date	%{expires_in} < 10
CRITICAL_LICENSE	Set critical condition for license status. Default: '%{activated} !~ /true/ || %{license_active} !~ /true/' (license not activated or not active). Variables available: activated, license_active, expires_in (in days), expires_date	%{activated} !~ /true/ || %{license_active} !~ /true/
WARNING_SUPPORT	Set warning condition for support status. Default: '%{support} !~ /true/' (support disabled). Variables available: support, maintenance_expires_in (in days), maintenance_expires_date	%{support} !~ /true/
CRITICAL_SUPPORT	Set critical condition for support status. Variables available: support, maintenance_expires_in, maintenance_expires_date
EXTRA_OPTIONS	Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.

System

Macro	Description	Valeur par défaut	Obligatoire
UNKNOWNSTATUS	Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %{error}, %{service}
WARNINGCALLSACTIVEFREE	Thresholds
CRITICALCALLSACTIVEFREE	Thresholds
WARNINGCALLSACTIVEUSAGE	Thresholds
CRITICALCALLSACTIVEUSAGE	Thresholds
WARNINGCALLSACTIVEUSAGEPRCT	Thresholds
CRITICALCALLSACTIVEUSAGEPRCT	Thresholds
WARNINGEXTENSIONSREGISTERED	Thresholds
CRITICALEXTENSIONSREGISTERED	Thresholds
CRITICALSTATUS	Define the conditions to match for the status to be CRITICAL (default: '%{error} =~ /false/'). You can use the following variables: %{error}, %{service}	%{error} =~ /true/
WARNINGSTATUS	Define the conditions to match for the status to be WARNING. You can use the following variables: %{error}, %{service}
EXTRAOPTIONS	Any extra option you may want to add to the command (a --verbose flag for example). Toutes les options sont listées ici.

3. Déployez la configuration. Le service apparaît dans la liste des services supervisés, et dans la page Statut des ressources. La commande envoyée par le connecteur est indiquée dans le panneau de détails du service : celle-ci montre les valeurs des macros.

Comment puis-je tester le plugin et que signifient les options des commandes ?

Une fois le plugin installé, vous pouvez tester celui-ci directement en ligne de commande depuis votre collecteur Centreon en vous connectant avec l'utilisateur centreon-engine (su - centreon-engine). Vous pouvez tester que le connecteur arrive bien à superviser une ressource en utilisant une commande telle que celle-ci (remplacez les valeurs d'exemple par les vôtres) :

/usr/lib/centreon/plugins/centreon_3cx_restapi.pl \
	--plugin=apps::voip::3cx::restapi::plugin \
	--mode=system \
	--hostname='10.0.0.1' \
	--port='443' \
	--proto='https' \
	--api-username='USERLOGIN' \
	--api-password='USERPASSWORD' \
	--unknown-status='' \
	--auth-mode='' \
	--warning-status='' \
	--critical-status='%\{error\} =~ /true/' \
	--warning-calls-active-usage='' \
	--critical-calls-active-usage='' \
	--warning-calls-active-free='' \
	--critical-calls-active-free='' \
	--warning-calls-active-usage-prct='' \
	--critical-calls-active-usage-prct='' \
	--warning-extensions-registered='' \
	--critical-extensions-registered='' 

La commande devrait retourner un message de sortie similaire à :

OK: extensions registered: 70 All services are ok | 'system.calls.active.usage.count'=63;;;0;1000 'system.calls.active.free.count'=53;;;0;1000 'system.calls.active.usage.percentage'=44%;;;0;1000 'system.extensions.registered.count'=70;;;0;70

Diagnostic des erreurs communes

Rendez-vous sur la documentation dédiée des plugins basés sur HTTP/API.

Modes disponibles

Dans la plupart des cas, un mode correspond à un modèle de service. Le mode est renseigné dans la commande d'exécution du connecteur. Dans l'interface de Centreon, il n'est pas nécessaire de les spécifier explicitement, leur utilisation est implicite dès lors que vous utilisez un modèle de service. En revanche, vous devrez spécifier le mode correspondant à ce modèle si vous voulez tester la commande d'exécution du connecteur dans votre terminal.

Tous les modes disponibles peuvent être affichés en ajoutant le paramètre --list-mode à la commande :

/usr/lib/centreon/plugins/centreon_3cx_restapi.pl \
	--plugin=apps::voip::3cx::restapi::plugin \
	--list-mode

Le plugin apporte les modes suivants :

Mode	Modèle de service associé
extension [code]	App-Voip-3cx-Extension-Restapi-custom
license [code]	App-Voip-3cx-License-Restapi-custom
system [code]	App-Voip-3cx-System-Restapi-custom

Options disponibles

Options des modes

Les options disponibles pour chaque modèle de services sont listées ci-dessous :

Extension

Option	Description
--include-extension	Filter extension (by number, first name or last name).
--exclude-extension	Exclude extension (by number, first name or last name).
--dnd-profile-name	Name of the profile to consider as DND (Do Not Disturb). Default: DND. In 3CX version 20, the DND boolean field no longer exists. DND status is derived from the CurrentProfileName field. Use this option to specify the exact profile name configured in your 3CX instance for DND. Example: --dnd-profile-name='Do not disturb'
--unknown-status	Define the conditions to match for the status to be UNKNOWN. You can use the following variables: extension, registered, dnd, profile, status, duration
--warning-status	Define the conditions to match for the status to be WARNING. You can use the following variables: extension, registered, dnd, profile, status, duration
--critical-status	Define the conditions to match for the status to be CRITICAL. You can use the following variables: extension, registered, dnd, profile, status, duration
--warning-count	Threshold for extensions count.
--critical-count	Threshold for extensions count.

License

Option	Description
--warning-license	Set warning condition for license status. Default: '%{expires_in} < 10' (license expires within 10 days). Variables available: activated, license\_active, expires\_in, expires\_date
--critical-license	Set critical condition for license status. Default: '%{activated} !~ /true/ || %{license_active} !~ /true/' (license not activated or not active). Variables available: activated, license\_active, expires\_in (in days), expires\_date
--warning-support	Set warning condition for support status. Default: '%{support} !~ /true/' (support disabled). Variables available: support, maintenance\_expires\_in (in days), maintenance\_expires\_date
--critical-support	Set critical condition for support status. Variables available: support, maintenance\_expires\_in, maintenance\_expires\_date

System

Option	Description
--mode	Define the mode in which you want the plugin to be executed (see--list-mode).
--dyn-mode	Specify a mode with the module's path (advanced).
--list-mode	List all available modes.
--mode-version	Check minimal version of mode. If not, unknown error.
--version	Return the version of the plugin.
--custommode	When a plugin offers several ways (CLI, library, etc.) to get information the desired one must be defined with this option.
--list-custommode	List all available custom modes.
--multiple	Multiple custom mode objects. This may be required by some specific modes (advanced).
--pass-manager	Define the password manager you want to use. Supported managers are: environment, file, keepass, hashicorpvault and teampass.
--verbose	Display extended status information (long output).
--debug	Display debug messages.
--filter-perfdata	Filter perfdata that match the regexp. Example: adding --filter-perfdata='avg' will remove all metrics that do not contain 'avg' from performance data.
--filter-perfdata-adv	Filter perfdata based on a "if" condition using the following variables: label, value, unit, warning, critical, min, max. Variables must be written either %{variable} or %(variable). Example: adding --filter-perfdata-adv='not (%(value) == 0 and %(max) eq "")' will remove all metrics whose value equals 0 and that don't have a maximum value.
--explode-perfdata-max	Create a new metric for each metric that comes with a maximum limit. The new metric will be named identically with a '_max' suffix). Example: it will split 'used_prct'=26.93%;0:80;0:90;0;100 into 'used_prct'=26.93%;0:80;0:90;0;100 'used_prct_max'=100%;;;;
--change-perfdata --extend-perfdata	Change or extend perfdata. Syntax: --extend-perfdata=searchlabel,newlabel,target[,[newuom],[min],[m ax]] Common examples: Convert storage free perfdata into used: --change-perfdata='free,used,invert()' Convert storage free perfdata into used: --change-perfdata='used,free,invert()' Scale traffic values automatically: --change-perfdata='traffic,,scale(auto)' Scale traffic values in Mbps: --change-perfdata='traffic_in,,scale(Mbps),mbps' Change traffic values in percent: --change-perfdata='traffic_in,,percent()'
--extend-perfdata-group	Add new aggregated metrics (min, max, average or sum) for groups of metrics defined by a regex match on the metrics' names. Syntax: --extend-perfdata-group=regex,namesofnewmetrics,calculation[,[ne wuom],[min],[max]] regex: regular expression namesofnewmetrics: how the new metrics' names are composed (can use $1, $2... for groups defined by () in regex). calculation: how the values of the new metrics should be calculated newuom (optional): unit of measure for the new metrics min (optional): lowest value the metrics can reach max (optional): highest value the metrics can reach Common examples: Sum wrong packets from all interfaces (with interface need --units-errors=absolute): --extend-perfdata-group=',packets_wrong,sum(packets_(discard |error)_(in|out))' Sum traffic by interface: --extend-perfdata-group='traffic_in_(.*),traffic_$1,sum(traf fic_(in|out)_$1)'
--change-short-output --change-long-output	Modify the short/long output that is returned by the plugin. Syntax: --change-short-output=patternreplacementmodifier Most commonly used modifiers are i (case insensitive) and g (replace all occurrences). Example: adding --change-short-output='OK~Up~gi' will replace all occurrences of 'OK', 'ok', 'Ok' or 'oK' with 'Up'
--change-exit	Replace an exit code with one of your choice. Example: adding --change-exit=unknown=critical will result in a CRITICAL state instead of an UNKNOWN state.
--range-perfdata	Rewrite the ranges displayed in the perfdata. Accepted values: 0: nothing is changed. 1: if the lower value of the range is equal to 0, it is removed. 2: remove the thresholds from the perfdata.
--filter-uom	Mask the units when they don't match the given regular expression.
--opt-exit	Replace the exit code in case of an execution error (i.e. wrong option provided, SSH connection refused, timeout, etc). Default: unknown.
--output-ignore-perfdata	Remove all the metrics from the service. The service will still have a status and an output.
--output-ignore-label	Remove the status label ("OK:", "WARNING:", "UNKNOWN:", CRITICAL:") from the beginning of the output. Example: 'OK: Ram Total:...' will become 'Ram Total:...'
--output-xml	Return the output in XML format (to send to an XML API).
--output-json	Return the output in JSON format (to send to a JSON API).
--output-openmetrics	Return the output in OpenMetrics format (to send to a tool expecting this format).
--output-file	Write output in file (can be combined with json, xml and openmetrics options). E.g.: --output-file=/tmp/output.txt will write the output in /tmp/output.txt.
--disco-format	Applies only to modes beginning with 'list-'. Returns the list of available macros to configure a service discovery rule (formatted in XML).
--disco-show	Applies only to modes beginning with 'list-'. Returns the list of discovered objects (formatted in XML) for service discovery.
--float-precision	Define the float precision for thresholds (default: 8).
--source-encoding	Define the character encoding of the response sent by the monitored resource Default: 'UTF-8'.
--hostname	Define the name or the address of the 3CX server.
--port	Define the port to connect to (default: '443').
--proto	Define the protocol to reach the API (default: 'https').
--api-username	Define the username for authentication.
--api-password	Define the password associated with the username.
--auth-mode	Define the authentication mode (default: oauth2). oauth2: for 3CX Enterprise edition. Uses OAuth2 client_credentials flow via POST /connect/token. Requires an API client created in 3CX admin console (/#/office/integrations/api). The API client must have at least the 'Admin' role. login: for 3CX Pro edition. Uses username/password login via POST /webclient/api/Login/GetAccessToken. Requires a System Owner account with 2FA disabled. IMPORTANT: The poller IP must be whitelisted in 3CX admin console under Security > Console Restrictions > Allow access from specific IP addresses. Without this, 3CX returns a degraded token causing 403 errors on all API endpoints.
--timeout	Define the timeout in seconds (default: 30).
--unknown-http-status	Define the conditions to match on the HTTP Status for the returned status to be UNKNOWN. Default: '%{http_code} < 200 or %{http_code} >= 300'
--warning-http-status	Define the conditions to match on the HTTP Status for the returned status to be WARNING. Example: '%{http_code} == 500'
--critical-http-status	Define the conditions to match on the HTTP Status for the returned status to be CRITICAL. Example: '%{http_code} == 500'
--http-peer-addr	Set the address you want to connect to. Useful if hostname is only a vhost, to avoid IP resolution.
--proxyurl	Proxy URL. Example: http://my.proxy:3128
--proxypac	Proxy pac file (can be a URL or a local file).
--insecure	Accept insecure SSL connections.
--http-backend	Perl library to use for HTTP transactions. Possible values are: lwp (default) and curl.
--ssl-opt	Set SSL Options (--ssl-opt="SSL_version => TLSv1" --ssl-opt="SSL_verify_mode => SSL_VERIFY_NONE").
--curl-opt	Set CURL Options (--curl-opt="CURLOPT_SSL_VERIFYPEER => 0" --curl-opt="CURLOPT_SSLVERSION => CURL_SSLVERSION_TLSv1_1" ).
--memcached	Memcached server to use (only one server).
--redis-server	Redis server to use (only one server). Syntax: address[:port]
--redis-attribute	Set Redis Options (--redis-attribute="cnx_timeout=5").
--redis-db	Set Redis database index.
--failback-file	Failback on a local file if Redis connection fails.
--memexpiration	Time to keep data in seconds (default: 86400).
--statefile-dir	Define the cache directory (default: '/var/lib/centreon/centplugins').
--statefile-suffix	Define a suffix to customize the statefile name (default: '').
--statefile-concat-cwd	If used with the '--statefile-dir' option, the latter's value will be used as a sub-directory of the current working directory. Useful on Windows when the plugin is compiled, as the file system and permissions are different from Linux.
--statefile-format	Define the format used to store the cache. Available formats: 'dumper', 'storable', 'json' (default).
--statefile-key	Define the key to encrypt/decrypt the cache.
--statefile-cipher	Define the cipher algorithm to encrypt the cache (default: 'AES').
--filter-category	Filter updates' category.
--unknown-status	Define the conditions to match for the status to be UNKNOWN. You can use the following variables: %{error}, %{service}
--warning-status	Define the conditions to match for the status to be WARNING. You can use the following variables: %{error}, %{service}
--critical-status	Define the conditions to match for the status to be CRITICAL (default: '%{error} =~ /false/'). You can use the following variables: %{error}, %{service}
--warning-* --critical-*	Thresholds. Can be: 'calls-active-usage', 'calls-active-free', 'calls-active-usage-prct', 'extensions-registered'.

Pour un mode, la liste de toutes les options disponibles et leur signification peut être affichée en ajoutant le paramètre --help à la commande :

/usr/lib/centreon/plugins/centreon_3cx_restapi.pl \
	--plugin=apps::voip::3cx::restapi::plugin \
	--mode=system \
	--help