FB_SnmpManager

Présentation

Type :

Bloc fonction

Disponible à partir de :

V1.0.0.0

Tâche

Le bloc fonction FB_SnmpManager permet d'envoyer des requêtes SNMP aux équipements gérés sur des réseaux IP (Internet Protocol).

Description fonctionnelle

Le bloc fonction FB_SnmpManager est l'interface utilisateur des communications SNMP.

Une seule requête à un agent peut être prise en charge à la fois.

Le bloc fonction doit être activé et prêt à traiter une requête. Au début de l'exécution d'une requête, les entrées i_etRequest et iq_stRequestInfo doivent être définies. Les informations des entrées servent à créer un télégramme SNMP contenant la requête puis à l'envoyer à l'agent via UDP. L'entrée i_ifUserManagement est utilisée pour référencer l'instance de FB_SnmpManager qui contient l'utilisateur spécifié dans l'entrée i_sUser. Les données utilisateur sont utilisées pour authentifier et crypter la requête SNMPv3. Le bloc fonction attend une réponse de l'agent, la traite et présente les informations reçues dans iq_stRequestInfo.stResponse. Tant que le bloc fonction exécute une requête, la sortie q_xBusy est à TRUE et q_etResult indique l'état de l'opération. La sortie q_xDone signale une exécution réussie et q_xError indique si le bloc fonction détecte une erreur lors de l'exécution, avec q_etResult et q_sResultMsg présentant des informations complémentaires sur la nature ou la cause de l'erreur détectée. Si une erreur est détectée, le bloc fonction doit être réinitialisé en le désactivant et en le réactivant.

Interface

Entrée

Type de données

Description

i_xEnable

BOOL

Activation et initialisation du bloc fonction.

i_xExecute

BOOL

La commande spécifiée dans i_etRequest est exécutée sur le front montant de cette entrée.

i_etRequest

ET_SnmpRequest

Requête SNMP exécutée si i_xExecute est TRUE. Assurez-vous que iq_stRequestInfo est disponible avant l'exécution de la requête SNMP.

i_etVersion

ET_SnmpProtocolVersion

Spécifie la version du protocole pour la communication avec l'agent. La valeur par défaut est ET_SnmpProtocolVersion.Version2c.

i_etSecurityLevel

ET_SecurityLevel

Niveau de sécurité associé à l'envoi des messages SNMPv3.

NOTE : Le compte utilisateur spécifié dans i_sUser doit être configuré en fonction du niveau de sécurité sélectionné.

i_sUser

STRING

Nom du compte utilisateur pour l'authentification et le cryptage de la requête SNMPv3.

i_ifUserManagement

IF_UserManagement

Référence à l'instance FB_UserManagement dans laquelle le compte utilisateur a été créé.

NOTE : Cette entrée peut être ignorée si aucun compte utilisateur n'est spécifié par i_sUser.

Entrée/sortie

Type de données

Description

iq_stRequestInfo

ST_RequestInformation

Permet de transmettre la structure contenant les informations pour l'envoi d'une requête à un agent et la structure pour la présentation de la réponse reçue de l'agent.

Sortie

Type de données

Description

q_xActive

BOOL

Si le bloc fonction est actif, cette sortie est TRUE.

q_xReady

BOOL

Si l'initialisation réussit, cette sortie est TRUE tant que le bloc fonction accepte des entrées.

q_xBusy

BOOL

Si cette sortie est TRUE, le bloc fonction est en train d'exécuter la commande spécifiée dans i_etRequest.

q_xDone

BOOL

Si cette sortie est TRUE, le bloc fonction a exécuté avec succès la commande spécifiée dans i_etRequest. Des données supplémentaires sont fournies dans iq_stRequestInfo.q_stResponse.

q_xError

BOOL

Si cette sortie est TRUE, une erreur a été détectée. Pour plus d'informations, consultez q_etResult et q_etResultMsg.

q_etResult

ET_Result

Fournit des informations de diagnostic et d'état.

q_sResultMsg

STRING[255]

Fournit des informations supplémentaires de diagnostic et d'état.