HeadLight Suite Docs

créer SNMP dans studio

Informations de connexion à un équipement

Clé Type Description
label String Nom de l’équipement
type String Type de l’équipement
configurationExtension String? Configuration supplémentaire rattaché
ips List<IP> Liste des IP de connexion
snmp SNMP Configuration pour la connexion SNMP
serialNumberNeeded bool? La connexion nécessite un serialNumber
serverTranslation bool? Utilisation des traduction tolgee
offline bool? Chargement du fichier hors ligne (si unique à l’équippement)
modules List<Module>? Liste des modules

Information des IP

Clé Type Description
name String Identifie l’équipement connecté
address String Adresse IP de l’équipement
isDefault bool? Permet de définir l’équipement à utilisé par défaut

Information des modules

Clé Type Description
key String Identifiant du module
name String Nom du module
ip String? Ip du module
port int? Port du module
node String? Node du module (NDC or NDS sour NEXEN)

Gestion du SNMP

Clé Type Description
profile String? Profile de l’équipement
port int Le port SNMP
version String Version SNMP
community String Community SNMP
ftp FTP? Configuration FTP
oidReference String oid utile pour ping l’équipement
oids List<OID> Liste des OID de l’équipement
functions List<SnmpFunction>? Liste de fonctions SNMP
information List<SnmpInformation>? Liste des informations de l’équipement

Information FTP

Clé Type Description
user String Identifiant FTP
password String Mot de passe FTP
port int Port FTP
trapPort int Port du trap SNMP
maxTry int Nombre maximum de tentative de connexion

Les OID SNMP

Clé Type Description
name String Nom de l’information SNMP
oid String L’OID sur l’équipement
technicalKey String Clé identificant l’OID
units String? Unité de la valeur
factor int? Facteur de multiplication de la value reçue
icon String? Nom de l’icone material design à utiliser
display bool? Permet d’afficher la données, par défaut false
repeat int? Durée en ms de la répétition de la requête SNMP
transpose List<KeyValue>? Convertit la valeur SNMP en utilisant la clé pour affiché la valeur lié
valueToSet String? valeur par défaut à envoyé à l’équipement
valueToGet String? techknicalKey d’un autre OID comme valeur par défaut
typeOfKey String? Type de la valeur SNMP
headlineDisplay bool? Permet de mettre l’information dans l’en-tête de la vue
threshold int? …
mode String? Permission sur l’OID
ipName String? Clé de l’IP de l’équipement à utilier
editable bool? Rend la valeur modifiable pour la configuration porteur
range object? valeur de l’oid comprise entre min et max
format object? format d’une table SNMP permettant de définir le type de valeur pour l’index d’un oid de table

KeyValue

C’est un simple objet contenant une clé et une valeur. La clé correspond aux valeurs possible du retour SNMP de l’OID et la valeur permet d’affiché un message correspondant à cette valeur SNMP.

Fonction SNMP

Clé Type Description
label String Nom de la fonction
availability bool? Fonction disponible ou non
technicalKeys List<String>? Liste des OID à mettre à jour avec la fonction
rfidTeis List<String>? Liste des TEI RFID à mettre à jour avec la fonction
timeout int? Duré maximum de la fonction avant annulation

Informations SNMP

Clé Type Description
name String Nom de l’information
technicalKey String TechnicalKey de l’OID utilisé
value String valeur à afficher de base
units String? Unité de la valeur
factor int? Facteur de multiplication de la value reçue
icon String? Nom de l’icone material design à utiliser
display bool? Permet d’afficher la données, par défaut false

Schéma JSON accessible sur gitlab: https://gitlab.thalesdigital.io/odin/mcoach/mcoach-json-validator