model (Modèle)

Sommaire
casp1041
Sommaire
Utilisez la ressource model (Modèle) pour créer ou supprimer un modèle et pour lire ou modifier des attributs de modèle. Cette section contient un exemple présentant la création d’un modèle. Pour plus d’informations, reportez-vous à la section Exemple : création d’un modèle basé sur le type de modèle.
La ressource model (Modèle) opère sur un modèle unique à la fois. Pour les groupes de modèles, utilisez la ressource models (Modèles).
  • URL de base
    http://<hostname><:portnumber>/spectrum/restful/model
POST model
L'opération POST model vous permet de créer un modèle et de mettre à jour l’attribut de liste sur le modèle spécifié.
Création d'un modèle
L'opération POST model suivant crée un modèle et renvoie le descripteur de modèle.
  • URL
    http://<hostname><:portnumber>/spectrum/restful/model[?landscapeid=<landscape_handle>][&mtypeid=<mtype_handle>][&agentport=<snmp_port>][&commstring=<comm_str>][&retry=<retry_cnt>][&timeout=<timeout_val>][&ipaddress=<ip_address>][&parentmh=<model_handle>][&relationid=<rel_handle>][&attr=<attr_id>&val=<num>]
  • Méthode HTTP
    POST
  • Body (Corps)
    Aucun
  • Contenu du corps
    Non utilisé
  • En-tête
    application/xml, application/json
  • Sortie
    Fichier XML ou JSON qui répertorie le descripteur du modèle créé ou l’erreur si le modèle ne peut pas être créé.
URL Parameters (Paramètres d'URL)
  • &landscapeid=<
    landscape_handle
    >
    (Facultatif) Spécifie le paysage dans lequel le modèle sera créé.
  • &mtypeid=<
    mtype_handle
    >
    (Facultatif) Spécifie le descripteur de type de modèle du modèle à créer. Obligatoire si le paramètre ipaddress n’est pas spécifié (voir ci-dessous).
  • &agentport=<
    snmp_port
    >
    (Facultatif) Spécifie le port de gestion SNMP sur l’unité.
    Valeur par défaut :
    161
  • &commstring=<
    comm_str
    >
    (Facultatif) Spécifie la chaîne de communauté.
    Par défaut :
    public
  • &retry=<
    retry_cnt
    >
    (Facultatif) Spécifie le nombre de nouvelles tentatives.
    Valeur par défaut :
    3
  • &timeout=<
    timeout_val
    >
    (Facultatif) Spécifie la valeur du délai d’expiration.
    Valeur par défaut :
    3000
  • &ipaddress=<
    ip_address
    >
    (Facultatif) Spécifie l’adresse IP.
  • &parentmh=<
    model_handle
    >
    (Facultatif) Spécifie le modèle parent (Association gauche).
  • &relationid=<
    rel_handle
    >
    (Facultatif) Spécifie l’association du parent à ce modèle.
    Valeur par défaut :
    Collects (Collecte)
  • &attr=<
    attr_id
    >&val=<
    num
    >
    (Facultatif) Spécifie l’ID et la valeur de l’attribut.
Mise à jour de l’attribut de liste sur le modèle spécifié
L'opération POST model suivante met à jour l’attribut de liste sur le modèle spécifié.
  • URL
    http://<hostname><:portnumber>/spectrum/restful/model/attr/update
  • Méthode HTTP
    POST
  • Body (Corps)
    XML
  • Contenu du corps
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <update-model-attrlist-request xmlns="http://www.ca.com/spectrum/restful/schema/request"> <model mh="<model_handle>"/> <attribute-list id="<attribute_id>"> <instance oid="<instance_id_0>" value="<value>"/> <instance oid="<instance_id_1>" value="<value>"/> </attribute-list> </update-model-attrlist-request>
  • Paramètres du corps
    <model mh="<model_handle>"/>
    Spécifie le modèle à mettre à jour.
    <attribute-list id="<attribute_id>">
    Spécifie l'ID de l'attribut à mettre à jour.
    <instance oid="<instance_id_0>" value="<value>"/>
    Spécifie l’ID d’instance et les valeurs à mettre à jour.
    Répétez la balise d’ID d’instance pour mettre à jour plusieurs instances dans l’attribut de liste.
  • En-tête
    application/xml, application/json
  • Sortie
    Fichier XML qui répertorie le descripteur de modèle du modèle mis à jour ou une erreur si le modèle ne peut pas être mis à jour.
GET model
L'opération GET model lit les attributs du modèle spécifié.
  • URL
    http://<hostname><:portnumber>/spectrum/restful/model/<model_handle>[?attr=<attr_ID>]
  • Méthode HTTP
    GET
  • Body (Corps)
    Aucun
  • Contenu du corps
    Non utilisé
  • En-tête
    application/xml, application/json
  • Sortie
    Liste XML ou JSON des attributs demandés
URL Parameters (Paramètres d'URL)
  • model_handle
    Spécifie le modèle.
  • &attr=<
    attr_ID
    >
    (Facultatif) Spécifie les attributs demandés. Vous pouvez spécifier plusieurs paramètres d'attribut.
PUT model
L'opération PUT model met à jour les attributs sur le modèle spécifié.
  • URL
    http://<hostname><:portnumber>/spectrum/restful/model/<model_handle>?attr=<attr_ID>&val=<num>
  • Méthode HTTP
    PUT
  • Body (Corps)
    Aucun
  • Contenu du corps
    Non utilisé
  • En-tête
    application/xml, application/json
  • Sortie
    Liste XML ou JSON des attributs demandés
URL Parameters (Paramètres d'URL)
  • model_handle
    Spécifie le modèle à mettre à jour.
  • &attr=<
    attr_ID
    >&val=<
    num
    >
    Spécifie les attributs et les valeurs à mettre à jour. Vous pouvez spécifier plusieurs paires attribut-valeur.
DELETE model
L'opération DELETE model supprime le modèle spécifié.
  • URL
    http://<hostname><:portnumber>/spectrum/restful/model/<model_handle>
  • Méthode HTTP
    DELETE
  • Body (Corps)
    Aucun
  • Contenu du corps
    Non utilisé
  • En-tête
    application/xml, application/json
  • Sortie
    Liste XML ou JSON indiquant une réussite ou un échec
URL Parameters (Paramètres d'URL)
  • model_handle
    Spécifie le modèle à supprimer.