Utilisation des services Web pour gérer les attributs d'alarme

Les administrateurs peuvent utiliser les services Web pour créer des attributs d'alarme. Vous pouvez créer ces attributs pour un client hébergé spécifique ou pour tous les clients hébergés (niveau global).
capm360
Les administrateurs peuvent utiliser les services Web pour créer des attributs d'alarme. Vous pouvez créer ces attributs pour un client hébergé spécifique ou pour tous les clients hébergés (niveau global).
Vous pouvez créer le même attribut au niveau du client hébergé et au niveau global. L'attribut de niveau client hébergé s'applique à l'utilisateur de client hébergé alors que l'attribut de niveau global s'applique uniquement à tous les autres utilisateurs de client hébergé.
N'utilisez pas ces services Web pour gérer les attributs externes, qui correspondent directement à des variables MIB spécifiques dans
DX NetOps Spectrum
.
Pour plus d'informations, reportez-vous à la section Vue Alarmes.
Opérations de service Web des attributs d'alarme
Envoyez l'appel suivant pour afficher les opérations disponibles pour le service Web des attributs du d'alarme :
http://
PC_host
:8181/pc/center/rest/alarmattributes/documentation
Opérations
  • PC_host
    :8181
  • Spécifie le nom d'hôte
    NetOps Portal
    . 8181 est le port requis.
  • delete
    Supprime l'attribut à l'aide de l'ID spécifié.
    URL :
    http://
    hôte_PC
    :8181/pc/center/webservice/alarmattributes/tenantId/
    {tenantId}
    /attributeId/
    {attributeId}
    • {tenantId}
      ID du client hébergé souhaité.
    • {attributeId}
      ID hexadécimal de l'attribut d'alarme
    Méthode HTTP :
    DELETE
    Le type de retour est une chaîne.
  • delete global
    Supprime l'attribut global à l'aide de l'ID spécifié.
    URL :
    http://
    hôte_PC
    :8181/pc/center/webservice/alarmattributes/global/attributeId/
    {attributeId}
    • {attributeId}
      ID hexadécimal de l'attribut d'alarme
    Méthode HTTP :
    DELETE
    Le type de retour est une chaîne.
  • get id names
    Renvoie une liste vide. Dans les autres services Web, cette option peut potentiellement renvoyer une liste d’identificateurs que vous pouvez utiliser dans d’autres méthodes pour identifier certains objets.
    URL :
    http://
    hôte_PC
    :8181/pc/center/webservice/alarmattributes/idNames
    Méthode HTTP :
    GET
  • get list for tenant
    Permet d'obtenir la liste de toutes les définitions d'attributs pour le client hébergé spécifié.
    URL :
    http://
    hôte_PC
    :8181/pc/center/webservice/alarmattributes/tenantId/
    {tenantId}
    • {tenantId}
      ID du client hébergé souhaité.
    Méthode HTTP :
    GET
    XSD pour le XML renvoyé :
    http://
    hôte_PC
    :8181/pc/center/rest/alarmattributes/xsd
  • add or update
    Ajoute ou met à jour un attribut pour le client hébergé spécifié.
    URL :
    http://
    hôte_PC
    :8181/pc/center/webservice/alarmattributes/tenantId/
    {tenantId}
    • {tenantId}
      ID du client hébergé souhaité.
    Méthode HTTP =
    POST
    XSD pour le XML fourni :
    http://
    hôte_PC
    : 8181/pc/center/rest/alarmattributes/xsd
    XSD pour le XML renvoyé :
    http://
    hôte_PC
    :8181/pc/center/rest/alarmattributes/xsd
  • get global list
    Génère la liste de toutes les définitions des attributs globaux.
    URL :
    http://
    hôte_PC
    :8181/pc/center/webservice/alarmattributes/global
    Méthode HTTP :
    GET
    XSD pour le XML renvoyé :
    http://
    hôte_PC
    :8181/pc/center/rest/alarmattributes/xsd
  • add or update global
    Ajoute ou met à jour un attribut global.
    URL :
    http://
    hôte_PC
    :8181/pc/center/webservice/alarmattributes/global
    Méthode HTTP =
    POST
    XSD pour le XML fourni :
    http://
    hôte_PC
    : 8181/pc/center/rest/alarmattributes/xsd
    XSD pour le XML renvoyé :
    http://
    hôte_PC
    :8181/pc/center/rest/alarmattributes/xsd
Création d'attributs d'alarme à l'aide des services Web
Utilisez un client REST pour créer et configurer des attributs d'alarme à l'aide du service Web d'attributs d'alarme.
Procédez comme suit :
  1. Configurez un client REST avec une connexion au serveur
    NetOps Portal
    .
  2. Utilisez le format suivant pour l'URL dans le client REST :
    http://
    hôte_PC
    :8181/pc/center/webservice/alarmattributes/tenantId/8
    8 est l'ID du client hébergé par défaut.
  3. Sélectionnez
    POST
    comme
    Méthode HTTP
    .
  4. Fournissez un nom d'utilisateur et un mot de passe valides pour un compte d'utilisateur global disposant d'un accès d'administrateur global à
    NetOps Portal
    .
  5. Sélectionnez
    application/xml
    comme configuration pour
    Body Content-type
    .
  6. Ajoutez le code XML suivant dans la section de texte Body (Corps) :
    <AlarmAttribute>
    <AttributeID>
    HEX_ID
    </AttributeID>
    <Name>
    Attribute_Name
    </Name>
    <Description>
    Attribute_Description
    </Description>
    <Type>
    Value_Type
    </Type>
    <AddAsFilter>true</AddAsFilter>
    <AddAsColumn>true</AddAsColumn>
    </AlarmAttribute>
    • AttributeID
      Spécifiez l'ID hexadécimal de l'attribut d'alarme.
    • Nom
      Attribuez un nom à l'attribut d'alarme.
    • Description
      Entrez une description pour l'attribut d'alarme.
    • Type
      Spécifiez l’un des types autorisés suivants :
      • STRING
        Un champ de chaîne, par exemple, le nom d’unité.
      • BOOLEAN
        Une valeur booléenne, par exemple, Acquittée.
      • ADDRESS_RANGE
        Champ d’adresse IP, par exemple, l’adresse IP.
      • INTEGER
        Une valeur numérique, par exemple, Nombre d’occurrences.
      • HEX
        Une valeur hexadécimale, par exemple, Code de la cause.
      • OCTET_STRING
        Valeur de chaîne traitée en tant que valeur numérique
    • AddAsFilter
      Indiquez si l'attribut doit ou non être ajouté à la liste de filtres.
      Valeur par défaut :
      true
    • AddAsColumn
      Indiquez si l'attribut doit ou non être ajouté sous forme de colonne dans une vue Alarme. La colonne est masquée par défaut.
      Valeur par défaut :
      true
  7. Remplacez les valeurs par celles que vous souhaitez utiliser pour le nouvel attribut d'alarme.
    Exemple :
    <AlarmAttribute>
    <AttributeID>0x129e7</AttributeID>
    <Name>Topology Model Name</Name>
    <Description>The Topology Model Name String</Description>
    <Type>STRING</Type>
    <AddAsFilter>true</AddAsFilter>
    <AddAsColumn>true</AddAsColumn>
    </AlarmAttribute>
  8. Exécutez la méthode.
  9. Répétez les étapes précédentes pour créer autant d'attributs d'alarme que nécessaire.