Alarms

Sommaire
casp1042
Utilisez la ressource Alarms (Alarmes) pour lire, modifier et supprimer des alarmes
. Les réponses asynchrones sont prises en charge.
  • Base URL (URL de base)
    http://<hostname><:portnumber>/spectrum/restful/alarms
POST alarms (GET Tunneling)
Pour obtenir tous les ID d'alarme, utilisez POST alarms (GET Tunneling). L'envoi d'une demande d'alarmes vous permet de fournir un document XML qui spécifie les alarmes à récupérer. Le document peut spécifier des alarmes spécifiques à l'aide d'un ID ou d'une spécification de modèle. Une spécification de modèle peut être une liste de descripteurs de modèle, de critères de recherche XML ou une référence à des critères de recherche existants sur le serveur OneClick. Il est également possible d'obtenir des alarmes qui répondent aux exigences d'un filtre d'attribut d'alarme spécifique. Un filtre d'attribut est un sous-ensemble des critères de recherche.
Cette demande POST est une forme de demande GET Tunneling. Vous ne pouvez pas créer d'alarme avec POST alarms. Les alarmes
sont créées en réponse à des événements, comme défini par les fichiers de disposition d'événement.
  • URL
    http://<hostname><:portnumber>/spectrum/restful/alarms[?symptoms=no][?symptoms=yes]
  • HTTP Method (Méthode HTTP)
    POST
  • Body (Corps)
    Des exemples sont fournis dans <
    $SPECROOT
    >/RestfulExamples/xml/Alarms. Ces fichiers XML fournissent des exemples de XML correctement formés à des fins différentes. Utilisez ces exemples comme référence pour votre propre fichier XML :
    • GetAlarmsByModelHandles.xml
    • GetAlarmsBySearchCriteria.xml
    • GetAlarmsForAllDevices.xml
    • GetAlarmsByAlarmIDs.xml
    • GetAlarmsByAttributeFilter.xml
      L'exemple suivant est un simple critère xml permettant de récupérer des ID d'alarme et leurs détails associés tels que le type de modèle, le type de modèle d'alarme, la chaîne de sécurité, la condition, le nom de modèle, la classe de modèles :
      <?xml version="1.0" encoding="UTF-8"?>
      <rs:alarm-request throttlesize="0"
      xmlns:rs="http://www.ca.com/spectrum/restful/schema/request"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.ca.com/spectrum/restful/schema/request ../../../xsd/Request.xsd ">
      <rs:requested-attribute id="0x10000"/> <!--Model Type Name-->
      <rs:requested-attribute id="0x10001"/> <!--Model Type of Alarmed Model-->
      <rs:requested-attribute id="0x10009"/> <!--Security String-->
      <rs:requested-attribute id="0x1000a"/> <!--Condition-->
      <rs:requested-attribute id="0x1006e"/> <!--Model Name-->
      <rs:requested-attribute id="0x11ee8"/> <!--Model Class–>
      <rs:landscape id="0x100000"/>
      </rs:alarm-request>
      <!--If you include landscape attribute(s) in the xml criteria, alarms of all the landscapes that are included are retrieved.-->
  • Body Content (Contenu du corps)
    application/xml
  • Header (En-tête)
    application/xml, application/json
  • Output (Sortie)
    XML ou JSON répertoriant toutes les alarmes dans le
    SpectroSERVER
    ou le Distributed
    SpectroSERVER
    .
    Exemple
    Voici un exemple d'appel :
Java GenericPoster noun=Alarms file=resources/xml/Alarms/GetAlarmsBySearch.xml server=localhost username=jdoe password=spectrum port=8080
URL Parameters (Paramètres d'URL)
  • <?symptoms=no>
    Utilisez ce paramètre pour récupérer tous les ID d'alarme en excluant les ID d'alarme de symptôme.
    En fonction de l'exemple de corps XML, la sortie suivante est renvoyée pour http://<hostname><:portnumber>/spectrum/restful/alarms?symptoms=no :
    <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
    <alarm-response-list error="EndOfResults" throttle="18" total-alarms="18">
    <alarm-responses>
    <alarm id="55d30306-7d7b-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">WA_Link</attribute>
    <attribute id="0x10001">0x102e2</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">3</attribute>
    <attribute id="0x1006e">10.10.10.0</attribute>
    <attribute id="0x11ee8">7</attribute>
    </alarm>
    </alarm>
    </alarm-responses>
    </alarm-response-list>
  • <?symptoms=yes>
    Utilisez ce paramètre pour récupérer tous les ID d'alarme, y compris les ID d'alarme de symptôme.
    En fonction de l'exemple de corps XML, la sortie suivante est renvoyée pour http://<hostname><:portnumber>/spectrum/restful/alarms?symptoms=yes :
    <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
    <alarm-response-list error="EndOfResults" throttle="20" total-alarms="20">
    <alarm-responses>
    <alarm id="55d30306-7d7b-1000-02a9-6c8814e75b4c">
    <attribute id="0x10000">WA_Link</attribute>
    <attribute id="0x10001">0x102e2</attribute>
    <attribute id="0x10009" />
    <attribute id="0x1000a">3</attribute>
    <attribute id="0x1006e">10.10.10.0</attribute>
    <attribute id="0x11ee8">7</attribute>
    </alarm>
    </alarm-responses>
    </alarm-response-list>
  • ?lasthour=
    <num>
    (facultatif) Utilisez ce paramètre pour récupérer les ID d'alarme générés au cours des <
    num
    > dernières heures, <
    num
    > représentant le nombre d'heures. Par exemple, pour récupérer les ID d'alarme générés au cours des deux dernières heures, utilisez l'URL suivante :
    http://<hostname><portnumber>/spectrum/restful/alarm?lasthour=2
    <?xml version="1.0" encoding="UTF-8"?> <rs:alarm-request xmlns:rs="http://www.ca.com/spectrum/restful/schema/request" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" throttlesize="100" xsi:schemaLocation="http://www.ca.com/spectrum/restful/schema/request ../../../xsd/Request.xsd "> <rs:requested-attribute id="0x11f56" /> <rs:requested-attribute id="0x12b4c" /> <rs:requested-attribute id="0x1006e" /> </rs:alarm-request
Alarmes GET
Les alarmes GET renvoient les ID d'alarme. Vous pouvez récupérer des attributs d'alarme spécifiques à l'aide du paramètre &attr=<
attr_id
>.
  • URL
    http://<hostname><:portnumber>/spectrum/restful/alarms[?attr=<attr_ID>][&landscape=<landscape_handle>][&throttlesize=<num>]
  • HTTP Method (Méthode HTTP)
    GET
  • Body (Corps)
    Aucun
  • Body Content (Contenu du corps)
    Non utilisé
  • Header (En-tête)
    application/xml, application/json
  • Output (Sortie)
    XML ou JSON répertoriant les alarmes dans le
    SpectroSERVER
    ou le Distributed
    SpectroSERVER
    .
    Voici un exemple tiré de notre environnement pour récupérer uniquement les ID d'alarme :
    <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
    <alarm-response-list error="EndOfResults" throttle="20" total-alarms="20">
    <alarm-responses>
    <alarm id="55d30306-7d7b-1000-02a9-6c8814e75b4c" />
    <alarm id="55d2d38b-47a6-1000-02a9-6c8814e75b4c" />
    </alarm-responses>
    </alarm-response-list>
    This is an example based on our environment.
URL Parameters (Paramètres d'URL)
  • &attr=<
    attr_ID
    >
    (Facultatif) Spécifie les attributs demandés. Vous pouvez spécifier plusieurs paramètres d'attribut.
    Il existe de nombreux attributs sur un modèle ; pour des performances optimales, vous devez uniquement sélectionner des attributs qui vous intéressent.
  • &landscape=<
    landscape_handle
    >
    (Facultatif) Filtre les paysages interrogés. Vous pouvez spécifier plusieurs paramètres de paysage.
  • &throttlesize=<
    num
    >
    (Facultatif) Spécifie une taille de limitation.
    http://<hostname><portnumber>/spectrum/restful/alarm
    The following output is generated:
    <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
    <alarm-response-list error="EndOfResults" throttle="6" total-alarms="6">
    <alarm-responses>
    <alarm id="55d30306-7d7b-1000-02a9-6c8814e75b4c" />
    <alarm id="55d2d38b-47a6-1000-02a9-6c8814e75b4c" />
    </alarm-responses>
    </alarm-response-list>
    This is an example based on our environment.
Filtres d'alarmes GET
Utilisez les filtres d'alarmes GET pour récupérer les filtres d'alarmes définis dans OneClick.
  • URL
    http://<hostname><:portnumber>/spectrum/restful/alarms/filters
  • HTTP Method (Méthode HTTP)
    GET
  • Body (Corps)
    Aucun
  • Body Content (Contenu du corps)
    Non utilisé
  • Header (En-tête)
    application/xml, application/json
  • Output (Sortie)
    La sortie xml suivante contenant le nom du filtre d'alarme est renvoyée :
    <?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
    - <alarmfilters-response xmlns="http://www.ca.com/spectrum/restful/schema/response">
    <alarmfilter>LAN_alarms</alarmfilter>
    <alarmfilter>Chassis_Alarms</alarmfilter>
    <alarmfilter>core_router_alarms</alarmfilter>
    </alarmfilters-response>
    This is an example based on our environment.
Nombre d'alarmes POST
Utilisez les filtres d'alarmes POST pour récupérer le nombre d'alarmes pour toutes les sévérités de OneClick.
  • URL
    http://<hostname><portnumber>/spectrum/restful/alarms/count
  • HTTP Method (Méthode HTTP)
    POST
  • Body (Corps)
    Vous pouvez utiliser un critère xml étendu pour récupérer le nombre d'alarmes requis. Par exemple, utilisez le corps suivant :
    <?xml version="1.0" encoding="UTF-8"?>
    <rs:alarms-count-request xmlns:rs="http://www.ca.com/spectrum/restful/schema/request"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.ca.com/spectrum/restful/schema/request
    ../../../xsd/Request.xsd ">
    <rs:alarm-filter name="def"/>
    </rs:alarms-count-request>
  • Body Content (Contenu du corps)
    application/xml
  • Header (En-tête)
    application/xml, application/json
  • Output (Sortie)
    La sortie xml suivante contenant le nombre d'alarmes pour toutes les sévérités est renvoyée :
    <alarmcount-response>
    <critical>4</critical>
    <major>21</major>
    <minor>4</minor>
    </alarmcount-response>
Alarmes PUT
Utilisez les alarmes PUT pour mettre à jour les attributs d'alarme.
  • URL
    http://<hostname><:portnumber>/spectrum/restful/alarms/<alarm_id>?attr=<attr_ID>&val=<num>
  • HTTP Method (Méthode HTTP)
    PUT
  • Body (Corps)
    Aucun
  • Body Content (Contenu du corps)
    Non utilisé
  • Header (En-tête)
    application/xml, application/json
  • Output (Sortie)
    Liste XML ou JSON indiquant une réussite ou un échec
URL Parameters (Paramètres d'URL)
  • alarm_ID
    Spécifie l'ID de l'alarme.
  • &attr=<
    attr_ID
    >&val=<
    num
    >
    Spécifie les attributs et les valeurs. Vous pouvez spécifier plusieurs paires attribut-valeur.
Alarmes DELETE
Pour supprimer une alarme à l'aide des alarmes DELETE, incluez l'ID d'alarme sans aucun autre paramètre.
  • URL
    http://<hostname><:portnumber>/spectrum/restful/alarms/<alarm_id>
  • HTTP Method (Méthode HTTP)
    DELETE
  • Body (Corps)
    Aucun
  • Body Content (Contenu du corps)
    Non utilisé
  • Header (En-tête)
    application/xml, application/json
  • Output (Sortie)
    Liste XML ou JSON indiquant une réussite ou un échec
URL Parameters (Paramètres d'URL)
  • alarm_ID
    Spécifie l'alarme à supprimer.