Lister les moniteurs

GET /api/snmp/monitors

Renvoie une liste des moniteurs SNMP.

En-têtes de requête:

• Authorization – Les identifiants de l’utilisateur

Paramètres:

• limit (int) – Le nombre maximum de résultats souhaités (défaut: 20)

• offset (int) – Le numéro du premier résultat souhaité (défaut: 0)

• sort ([name+|name-|address+|address-]) – Le paramètre selon lequel les moniteurs seront triés (défaut: name+)

Status Codes:

• 200 OK – Les moniteurs ont été renvoyés avec succès

• 400 Bad Request – Un ou plusieurs des paramètres de la requête sont invalides

• 401 Unauthorized – Authentification d’utilisateur invalide

Objet JSON de réponse:

• monitors (array) – La liste des moniteurs demandés

Tableau d’objets JSON de réponse:

• name (string) – Le nom du moniteur SNMP.

• version (string) – La version de SNMP utilisée par le moniteur. Les versions acceptées sont « SNMPv2 » et « SNMPv3 » (SNMPv1 n’est pas supporté).

• udpAddress (string) – L’adresse UDP du moniteur à laquelle les notifications SNMP doivent être envoyées.

• useInforms (bool) – Spécifie le type de notification à envoyer au moniteur. Si faux (par défaut), Gateway enverra des traps. Si vrai, Gateway enverra des informs.

• community (string) – [SNMPv2 uniquement] La valeur de communauté (ou mot de passe) du moniteur. Par défaut, la valeur « public » est utilisée.

• contextName (string) – [SNMPv3 uniquement] Le nom du contexte SNMPv3.

• contextEngineID (string) – [SNMPv3 uniquement] L’ID du moteur de contexte SNMPv3.

• snmpv3Security (string) –

  [SNMPv3 uniquement] Spécifie le niveau de

  sécurité SNMPv3 à utiliser avec ce moniteur. Les valeurs acceptées sont :

  • noAuthNoPriv: pas d’authentification ni de confidentialité

  • authNoPriv: authentification, mais pas de confidentialité

  • authPriv: authentification et confidentialité

  Par défaut, l’authentification et la confidentialité sont toutes deux désactivées.

• authEngineID (string) – [SNMPv3 uniquement] L’ID du moteur d’authentification. N’a aucun effet si le moniteur utilise des informs (voir l’option useInforms ci-dessus).

• authUsername (string) – [SNMPv3 uniquement] Le nom d’utilisateur. À noter que le nom d’utilisateur est requis avec SNMPv3 même si l’authentification est désactivée.

• authProtocol (string) – [SNMPv3 uniquement] L’algorithme d’authentification utilisé. Les valeurs acceptées sont : MD5, SHA, SHA-224, SHA-256, SHA-384 et SHA-512.

• authPassphrase (string) – [SNMPv3 uniquement] La passphrase d’authentification.

• privProtocol (string) – [SNMPv3 uniquement] L’algorithme de confidentialité utilisé. Les valeurs acceptées sont : DES, AES, AES-192, AES-192C, AES-256 et AES-256C.

• privPassphrase (string) – [SNMPv3 uniquement] La passphrase de confidentialité.

Exemple de requête

GET https://my_waarp_gateway.net/api/snmp/monitors HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Exemple de réponse

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 482

{
    "monitors": [{
        "name": "snmpv3-monitor",
        "version": "SNMPv3",
        "udpAddress": "127.0.0.1:162",
        "useInforms": true,
        "snmpv3Security": "authNoPriv",
        "authUsername": "waarp-gw",
        "authProtocol": "SHA",
        "authPassphrase": "sesame"
    }, {
        "name": "snmpv2-monitor",
        "version": "SNMPv2",
        "udpAddress": "192.168.1.1:162",
        "useInforms": false,
        "community": "private"
    }]
}