Agent Client Collector API

  • Rversion finale: Zurich
  • Mis à jour 31 juil. 2025
  • 75 minutes de lecture

    • L’API Agent Client Collector fournit des points de terminaison pour gérer les actions sur les agents disponibles et les politiques de gestion.

    Cette API nécessite l’application Agent Client Collector de stockage Framework (sn_agent) et est fournie dans l’espace de noms sn_agent . Les points de terminaison de cette API nécessitent le rôle agent_client_collector_admin. Pour plus d’informations, reportez-vous à Agent Client Collector.
    Points de terminaison Agent Management

    Pour plus d’informations sur l’exécution de tâches similaires dans un include de script, consultez AccAgentsAPI.

    Gestion des politiques et workflow
    Utilisez les API de gestion des politiques pour afficher les détails, activer/désactiver une politique, mettre à jour une politique et publier une politique.
    Pour mettre à jour une politique :
    1. Obtenir une liste des politiques et des détails avec GET /agents/policies/list. Ce point de terminaison nécessite le rôle agent_client_collector_user.
      • Pour mettre à jour une politique à l’état Brouillon, utilisez les sys_ids récupérés dans la liste des politiques dans les points de terminaison de mise à jour.
      • Pour mettre à jour une politique à l’état Publié ou Publié*, procurez-vous une copie de bac à sable modifiable avec GET /agents/policy/sandbox_from_published/{policy_id}. Utilisez les sys_ids de cette réponse pour modifier les propriétés à l’aide d’un point de terminaison de mise à jour.
    2. Modifiez les détails de la politique à l’aide d’un point de terminaison de mise à jour.
    3. Publiez la politique à l’aide de GET /agents/policy/publish/{policy_id}.
    Une fois publiée, la politique devient active. Cette API comprend également des points de terminaison permettant d’activer ou de désactiver une stratégie publiée :

    Agent Client Collector : GET /agents/{agent_id}

    Obtient les informations d’un agent spécifié.

    Format d'URL

    /api/sn_agent/agents/{agent_id}

    Paramètres de demande pris en charge

    Tableau 1. Paramètres de chemin d'accès
    Nom Description
    agent_id ID unique d’un agent répertorié dans la colonne ID de l’agent de la table Agent Client Collectors [sn_agent_cmdb_ci_agent].

    Pour obtenir une liste des ID d’agent et d’autres détails, exécutez le point de terminaison GET /agents/list .

    Type de données : chaîne
    Tableau 2. Paramètres de requête
    Nom Description
    Aucun
    Tableau 3. Paramètres du corps de la demande (JSON)
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 4. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 5. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 6. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    403 L’utilisateur ne dispose pas du rôle agent_client_collector_user.
    404 Agent avec l’ID fourni introuvable.

    Paramètres de corps de réponse (JSON)

    Nom Description
    <Tableau> Tableau d’objets JSON contenant des informations étendues sur l’agent.
    {
   "agent_id": "String",
   "data_collection": Number,
   "ip_address": "String",
   "is_duplicate": Boolean,
   "is_restart_enabled": Boolean,
   "name": "String",
   "number_of_running_checks": Number,
   "status": Number,
   "up_since": "String",
   "version": "String"
}
    agent_id ID de l’agent tel que soumis.

    Type de données : chaîne
    data_collection La collecte de données indique si des vérifications planifiées doivent être exécutées. Ces vérifications font partie des politiques planifiées pour l’exécution de cet agent.
    Valeurs possibles :
    • 0 : Activé : les vérifications s’exécutent comme prévu.
    • 1 : Désactivé (manuel) – Les vérifications ont été désactivées manuellement.
    • 2 : Désactivé (auto) – Les vérifications ont été désactivées automatiquement en raison de la consommation élevée du processeur par le

    Type de données : nombre
    ip_address Adresse IP de l’agent.

    Type de données : chaîne
    is_duplicate

    Marqueur indiquant si cet agent est un doublon d’un autre. Il ne doit y avoir qu’un seul agent sur un hôte donné.

    Valeurs possibles :
    • vrai : l’agent a le même hôte qu’un agent Alive/Up avec un ID d’agent différent. Désactiver ou désinstaller le doublon
    • faux : cet agent n’a pas de doublons à l’état Actif/En service.

    Type de données : booléennes
    is_restart_enabled

    Marqueur indiquant si le redémarrage est activé. Le redémarrage de l’agent n’est pas configurable. Cela dépend du système d’exploitation et de la version du système d’exploitation sur lequel l’agent s’exécute.

    Valeurs possibles :
    • vrai : le redémarrage est activé pour cet agent.
    • faux : le redémarrage est désactivé pour cet agent.

    Type de données : booléennes
    nom Nom de l’agent.

    Type de données : chaîne
    number_of_running_checks Le nombre de vérifications dont l’exécution est planifiée pour l’agent. Ces vérifications font partie des politiques planifiées pour l’exécution de cet agent.

    Type de données : nombre
    état État de l’agent.
    Valeurs possibles :
    • 0 : actif/actif : l’agent est actif.
    • 1 : avertissement – L’agent n’a pas reçu de message de maintien de connexion au cours des dernières minutes.
    • 2 : Inactif : l’agent n’a pas reçu de message de maintien de connexion depuis longtemps.
    • 3 : Redémarrage – L’agent redémarre.

    Type de données : nombre
    up_since Heure UTC depuis que le statut de l’agent est activé/augmenté. La valeur est au format GlideDateTime .

    Type de données : chaîne
    version La version de l’agent est en cours d’exécution Agent Client Collector .

    Type de données : chaîne

    Demande cURL

    L’exemple suivant montre comment obtenir les détails de l’agent.

    curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Sortie :

    {
  "name": "WIN-V26KAP7PI2G",
  "status": 2,
  "agent_id": "074b14e2eb3ce9d4",
  "ip_address": "10.196.55.14",
  "number_of_running_checks": 11,
  "data_collection": 0,
  "is_restart_enabled": true,
  "is_duplicate": false,
  "up_since": "2021-03-31 12:02:17",
  "version": "2.3.0"
}

    Agent Client Collector : GET /agents/{agent_id}/data/off

    Désactive la collecte de données pour un agent spécifié à l’état actif/actif.

    Pour déterminer si la collecte de données d’un agent est activée ou désactivée, exécutez le point de terminaison GET /agents/{agent_id} .

    Format d'URL

    /api/sn_agent/agents/{agent_id}/data/off

    Paramètres de demande pris en charge

    Tableau 7. Paramètres de chemin d'accès
    Nom Description
    agent_id ID unique d’un agent répertorié dans la colonne ID de l’agent de la table Agent Client Collectors [sn_agent_cmdb_ci_agent].

    Pour obtenir une liste des ID d’agent et d’autres détails, exécutez le point de terminaison GET /agents/list .

    Type de données : chaîne
    Tableau 8. Paramètres de requête
    Nom Description
    Aucun
    Tableau 9. Paramètres du corps de la demande (JSON)
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 10. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 11. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 12. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    403 L’utilisateur ne dispose pas du rôle agent_client_collector_admin.
    404 L’agent est introuvable ou n’est pas à l’état actif/actif.

    Paramètres de corps de réponse (JSON)

    Nom Description
    message Message contenant les résultats de réussite ou d’échec de l’opération.

    Type de données : chaîne

    Demande cURL

    L’exemple suivant montre comment désactiver la collecte de données d’agent.

    curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>/data/off" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Sortie :

    {
"message": "Data Collection Disabled For Agent With ID: <agent_id>"
}

    Agent Client Collector : GET /agents/{agent_id}/data/on

    Active la collecte de données pour un agent spécifié à l’état actif/actif.

    Pour déterminer si la collecte de données d’un agent est activée ou désactivée, exécutez le point de terminaison GET /agents/{agent_id} .

    Format d'URL

    /api/sn_agent/agents/{agent_id}/data/on

    Paramètres de demande pris en charge

    Tableau 13. Paramètres de chemin d'accès
    Nom Description
    agent_id ID unique d’un agent répertorié dans la colonne ID de l’agent de la table Agent Client Collectors [sn_agent_cmdb_ci_agent].

    Pour obtenir une liste des ID d’agent et d’autres détails, exécutez le point de terminaison GET /agents/list .

    Type de données : chaîne
    Tableau 14. Paramètres de requête
    Nom Description
    Aucun
    Tableau 15. Paramètres du corps de la demande (JSON)
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 16. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 17. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 18. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    403 L’utilisateur ne dispose pas du rôle agent_client_collector_admin.
    404 L’agent est introuvable ou n’est pas à l’état actif/actif.

    Paramètres de corps de réponse (JSON)

    Nom Description
    message Message contenant les résultats de réussite ou d’échec de l’opération.

    Type de données : chaîne

    Demande cURL

    L’exemple suivant montre comment activer la collecte de données d’agent.

    curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>/data/on" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Sortie :

    {
  "message": "Data Collection Enabled For Agent With ID: <agent_id>"
}

    Agent Client Collector : GET /agents/{agent_id}/discovery

    Exécute une vérification de détection pour localiser les CI liés à un agent. L’agent spécifié doit être à l’état actif/actif.

    Format d'URL

    /api/sn_agent/agents/{agent_id}/discovery

    Paramètres de demande pris en charge

    Tableau 19. Paramètres de chemin d'accès
    Nom Description
    agent_id ID unique d’un agent répertorié dans la colonne ID de l’agent de la table Agent Client Collectors [sn_agent_cmdb_ci_agent].

    Pour obtenir une liste des ID d’agent et d’autres détails, exécutez le point de terminaison GET /agents/list .

    Type de données : chaîne
    Tableau 20. Paramètres de requête
    Nom Description
    Aucun
    Tableau 21. Paramètres du corps de la demande (JSON)
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 22. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 23. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 24. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    403 L’utilisateur ne dispose pas du rôle agent_client_collector_admin.
    404 L’agent est introuvable ou n’est pas à l’état actif/actif.

    Paramètres de corps de réponse (JSON)

    Nom Description
    message Message contenant les résultats de réussite ou d’échec de l’opération.

    Type de données : chaîne

    Demande cURL

    L’exemple suivant montre comment exécuter la détection sur un agent avec l’état actif/actif.

    curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>/discovery" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Sortie :

    {
  "message": "Running Discovery For Agent With ID: <agent_id>"
}

    Agent Client Collector : GET /agents/check_defs/{check_def_id}

    Obtient une définition de vérification spécifiée avec des détails.

    Format d'URL

    /api/sn_agent/agents/check_defs/{check_def_id}

    Paramètres de demande pris en charge

    Tableau 25. Paramètres de chemin d'accès
    Nom Description
    check_def_id Sys_id de la définition de vérification répertoriée dans la table Définitions de vérification [sn_agent_check_def].

    Type de données : chaîne
    Tableau 26. Paramètres de requête
    Nom Description
    Aucun
    Tableau 27. Paramètres du corps de la demande (JSON)
    Nom Description
    x-include-check-params Marqueur indiquant si les détails des paramètres de vérification existants sont renvoyés. Les informations pour chaque paramètre de vérification standard et sécurisé sont incluses dans un objet JSON.
    Valeurs valides :
    • true : renvoie les détails des paramètres de vérification.
    • faux : ne pas renvoyer les détails des paramètres de vérification.

    Type de données : booléennes

    Valeur par défaut : false

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 28. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 29. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 30. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    404 La définition de vérification n’a pas été trouvée avec le sys_id fourni.

    Paramètres de corps de réponse (JSON)

    Propriétés Description
    vérifier Détails de la définition de vérification spécifiée.
    {
 "background": Boolean,
 "check_group": "String",
 "check_type": "String",
 "command": "String",
 "error": "String",
 "name": "String",
 "params": [Array],
 "plugins": [Array],
 "proxy_valid": Boolean,
 "secure_params": [Array],
 "sys_id": "String",
 "timeout": Number
}
    arrière-plan Marqueur indiquant si cette définition de vérification est une vérification d’arrière-plan. Une vérification des antécédents est une vérification dont l’agent commence l’exécution et n’attend pas la fin de son exécution.
    Valeurs valides :
    • vrai : cette définition de vérification est une vérification d’arrière-plan.
    • faux : cette définition de vérification n’est pas une vérification d’arrière-plan.

    Type de données : booléennes
    check_group Groupe spécifié pour cette définition de vérification.

    Type de données : chaîne
    check_type Type de vérification.
    Valeurs possibles :
    • Événements : les résultats de vérification sont transformés en événement de gestion des événements.
    • Mesures : les valeurs du résultat de la vérification sont transformées en mesures.

    Type de données : chaîne
    commande Commande exécutée Agent Client Collector .

    Type de données : chaîne
    erreur Message en cas d’erreur. Nul dans le cas contraire.

    Type de données : chaîne
    nom Nom de la vérification.

    Type de données : chaîne
    paramètres Liste des définitions de paramètres associées à la définition de vérification. Ces résultats ne sont inclus que si le withParams paramètre est défini sur vrai.
    "params": [
  {
    "active": Boolean,
    "default_value": "String",
    "mandatory": Boolean,
    "name": "String",
    "sys_id": "String"
   }
]

    Type de données : tableau
    params.active Marqueur indiquant si le paramètre de vérification est actif.
    Valeurs valides :
    • vrai : le paramètre de vérification est actif.
    • false : le paramètre de vérification est inactif.

    Type de données : booléennes
    params.default_value Spécifie la valeur par défaut de ce paramètre de vérification.

    Type de données : chaîne
    params.mandatory Marqueur indiquant si le paramètre de vérification est requis.
    Valeurs valides :
    • true : le paramètre de vérification est requis.
    • false : le paramètre de vérification est facultatif.

    Type de données : booléennes
    params.name Nom du paramètre de vérification.

    Type de données : chaîne
    params.sys_id Sys_id du paramètre de vérification répertorié dans la table Vérifier les définitions de paramètres sécurisés [sn_agent_check_param_def].

    Type de données : chaîne
    modules d'extension Liste des Agent Client Collector modules d’extension associés à cette vérification.

    Type de données : tableau
    proxy_valid Marqueur indiquant si la politique de définition de vérification est définie pour fonctionner comme un proxy.
    Valeurs valides :
    • vrai : cette politique de définition de vérification est définie pour fonctionner comme un proxy.
    • faux : cette politique de définition de vérification n’est pas définie pour fonctionner comme un proxy.

    Type de données : booléennes
    secure_params Liste des personnes affectées à cette vérification. Ces résultats ne sont inclus que si le withParams paramètre est défini sur vrai.
    "secure_params": [
  {
    "active": Boolean,
    "name": "String",
    "order": Number,
    "sys_id": "String"
   }
]

    Type de données : tableau
    secure_params.actif Marqueur indiquant si le paramètre sécurisé est actif.
    Valeurs valides :
    • true : le paramètre sécurisé est actif.
    • false : le paramètre sécurisé est inactif.

    Type de données : booléennes
    secure_params.nom Nom du paramètre sécurisé.

    Type de données : chaîne
    secure_params.commande Ordre dans lequel le paramètre est envoyé à la commande/au script de vérification.

    Type de données : nombre
    secure_params.sys_id Sys_id du paramètre sécurisé répertorié dans la table Vérifier les définitions de paramètres sécurisés [sn_agent_check_secure_param_def].

    Type de données : chaîne
    sys_id Sys_id de la définition de vérification répertoriée dans la table Définitions de vérification [sn_agent_check_def].

    Type de données : chaîne
    timeout Délai d’expiration en secondes.

    Type de données : nombre

    Demande cURL

    L’exemple suivant montre comment obtenir des informations pour une définition de vérification spécifiée.

    curl "https://instance.service-now.com/api/sn_agent/agents/check_defs/94436b237f705300f128134f8dfa91a4" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Sortie :

    {
  "name": "app.apache.metrics-apache",
  "command": "metrics-apache-graphite.rb -p {{.labels.params_port}} --path {{.labels.params_path}} -h {{.labels.params_host}}",
  "plugins": [
    "monitoring-plugin-common"
  ],
  "timeout": 60,
  "proxy_valid": true,
  "background": false,
  "check_type": "Metrics",
  "check_group": "Apache",
  "sys_id": "94436b237f705300f128134f8dfa91a4",
  "params": [
    {
      "name": "port",
      "active": true,
      "mandatory": true,
      "default_value": "80",
      "sys_id": "58436b237f705300f128134f8dfa91a8"
    },
    {
      "name": "path",
      "active": true,
      "mandatory": true,
      "default_value": "/server-status?auto",
      "sys_id": "98436b237f705300f128134f8dfa91aa"
    },
    {
      "name": "scheme",
      "active": false,
      "mandatory": false,
      "default_value": null,
      "sys_id": "a4e57a96db3bbb4035305c55dc9619f6"
    },
    {
      "name": "host",
      "active": true,
      "mandatory": true,
      "default_value": "127.0.0.1",
      "sys_id": "d4436b237f705300f128134f8dfa91a6"
    },
    {
      "name": "ssl_secure_connection",
      "active": false,
      "mandatory": false,
      "default_value": null,
      "sys_id": "e3b272c4530100106ffeddeeff7b1275"
    }
  ],
  "secure_params": [
    {
      "name": "cred_user_name",
      "active": true,
      "order": 1,
      "sys_id": "2494cd6e53170010f42cddeeff7b1273"
    },
    {
      "name": "cred_password",
      "active": true,
      "order": 2,
      "sys_id": "35948d6e53170010f42cddeeff7b127f"
    }
  ]
}

    Agent Client Collector : GET /agents/check_defs/list

    Obtient une liste des définitions de vérification avec des détails.

    Format d'URL

    /api/sn_agent/agents/check_defs/list

    Paramètres de demande pris en charge

    Tableau 31. Paramètres de chemin d'accès
    Nom Description
    Aucun
    Tableau 32. Paramètres de requête
    Nom Description
    Aucun
    Tableau 33. Paramètres du corps de la demande (JSON)
    Nom Description
    requête x-enc Chaîne de requête codée pour filtrer la liste de résultats de la définition de vérification. Utilisez null pour une liste non filtrée des définitions de vérification dans le système.

    Type de données : chaîne
    x-include-check-params Marqueur indiquant si les détails des paramètres de vérification existants sont renvoyés. Les informations pour chaque paramètre de vérification standard et sécurisé sont incluses dans un objet JSON.
    Valeurs valides :
    • true : renvoie les détails des paramètres de vérification.
    • faux : ne pas renvoyer les détails des paramètres de vérification.

    Type de données : booléennes

    Valeur par défaut : false
    Limite X Limite le nombre d’enregistrements renvoyés. Définir la valeur sur null pour utiliser la valeur par défaut.

    Type de données : nombre

    Par défaut : 20 000

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 34. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 35. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 36. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.

    Paramètres de corps de réponse (JSON)

    Nom Description
    Définitions des vérifications Liste des définitions et détails de vérification fournis sous forme d’objets JSON.
    [
 {
  "background": Boolean,
  "check_group": "String",
  "check_type": "String",
  "command": "String",
  "name": "String",
  "params": [Array],
  "plugins": [Array],
  "proxy_valid": Boolean,
  "secure_params": [Array],
  "sys_id": "String",
  "timeout": Number 
 }
]

    Type de données : tableau
    arrière-plan Marqueur indiquant si cette définition de vérification est une vérification d’arrière-plan. Une vérification des antécédents est une vérification dont l’agent commence l’exécution et n’attend pas la fin de son exécution.
    Valeurs valides :
    • vrai : cette définition de vérification est une vérification d’arrière-plan.
    • faux : cette définition de vérification n’est pas une vérification d’arrière-plan.

    Type de données : booléennes
    check_group Groupe spécifié pour cette définition de vérification.

    Type de données : chaîne
    check_type Type de vérification.
    Valeurs possibles :
    • Événements : les résultats de vérification sont transformés en événement de gestion des événements.
    • Mesures : les valeurs du résultat de la vérification sont transformées en mesures.

    Type de données : chaîne
    commande Commande exécutée Agent Client Collector .

    Type de données : chaîne
    nom Nom de la vérification.

    Type de données : chaîne
    paramètres Liste des définitions de paramètres associées à la définition de vérification. Ces résultats ne sont inclus que si le withParams paramètre est défini sur vrai.
    "params": [
  {
    "active": Boolean,
    "default_value": "String",
    "mandatory": Boolean,
    "name": "String",
    "sys_id": "String"
   }
]

    Type de données : tableau
    params.active Marqueur indiquant si le paramètre de vérification est actif.
    Valeurs valides :
    • vrai : le paramètre de vérification est actif.
    • false : le paramètre de vérification est inactif.

    Type de données : booléennes
    params.default_value Spécifie la valeur par défaut de ce paramètre de vérification.

    Type de données : chaîne
    params.mandatory Marqueur indiquant si le paramètre de vérification est requis.
    Valeurs valides :
    • true : le paramètre de vérification est requis.
    • false : le paramètre de vérification est facultatif.

    Type de données : booléennes
    params.name Nom du paramètre de vérification.

    Type de données : chaîne
    params.sys_id Sys_id du paramètre de vérification répertorié dans la table Vérifier les définitions de paramètres sécurisés [sn_agent_check_param_def].

    Type de données : chaîne
    modules d'extension Liste des Agent Client Collector modules d’extension associés à cette vérification.

    Type de données : tableau
    proxy_valid Marqueur indiquant si la politique de définition de vérification est définie pour fonctionner comme un proxy.
    Valeurs valides :
    • vrai : cette politique de définition de vérification est définie pour fonctionner comme un proxy.
    • faux : cette politique de définition de vérification n’est pas définie pour fonctionner comme un proxy.

    Type de données : booléennes
    secure_params Liste des personnes affectées à cette vérification. Ces résultats ne sont inclus que si le withParams paramètre est défini sur vrai.
    "secure_params": [
  {
    "active": Boolean,
    "name": "String",
    "order": Number,
    "sys_id": "String"
   }
]

    Type de données : tableau
    secure_params.actif Marqueur indiquant si le paramètre sécurisé est actif.
    Valeurs valides :
    • true : le paramètre sécurisé est actif.
    • false : le paramètre sécurisé est inactif.

    Type de données : booléennes
    secure_params.nom Nom du paramètre sécurisé.

    Type de données : chaîne
    secure_params.commande Ordre dans lequel le paramètre est envoyé à la commande/au script de vérification.

    Type de données : nombre
    secure_params.sys_id Sys_id du paramètre sécurisé répertorié dans la table Vérifier les définitions de paramètres sécurisés [sn_agent_check_secure_param_def].

    Type de données : chaîne
    sys_id Sys_id de la définition de vérification répertoriée dans la table Définitions de vérification [sn_agent_check_def].

    Type de données : chaîne
    timeout Délai d’expiration en secondes.

    Type de données : nombre

    Demande cURL

    L’exemple suivant montre comment récupérer une liste de deux définitions de vérification avec des valeurs de paramètre.

    curl "https://instance.service-now.com/api/sn_agent/agents/check_defs/list" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Sortie :

    {
  "check_definitions": [
    {
      "name": "checks_api_test",
      "command": "echo hello",
      "plugins": [],
      "timeout": 9,
      "proxy_valid": true,
      "background": false,
      "check_type": "TestCheck",
      "check_group": "computer",
      "sys_id": "7f1f9026dba530106f4810284b96194f",
      "params": [],
      "secure_params": [
        {
          "name": "check_api_test_check_secure_param2",
          "active": true,
          "order": 2,
          "sys_id": "2d30a066dba530106f4810284b9619c1"
        },
        {
          "name": "check_api_test_check_secure_param1",
          "active": true,
          "order": 100,
          "sys_id": "4c20a066dba530106f4810284b9619a8"
        }
      ]
    },
    {
      "name": "checks_api_test222",
      "command": "echo hello1212121",
      "plugins": [],
      "timeout": 60,
      "proxy_valid": true,
      "background": false,
      "check_type": "TestCheck",
      "check_group": "computer",
      "sys_id": "99e12466dba530106f4810284b961976",
      "params": [
        {
          "name": "check_api_test_check_param_222",
          "active": true,
          "mandatory": false,
          "default_value": "test_test_test",
          "sys_id": "44026466dba530106f4810284b9619b2"
        }
      ],
      "secure_params": []
    }
  ]
}

    Agent Client Collector : GET /agents/exec/background/stop/{request_id}

    Arrête une vérification des antécédents.

    Pour démarrer une vérification des antécédents, utilisez l’API POST /agents/check_defs/{check_def_id}/run .

    Format d'URL

    /api/sn_agent/agents/exec/background/stop/{request_id}

    Paramètres de demande pris en charge

    Tableau 37. Paramètres de chemin d'accès
    Nom Description
    request_id ID d’une demande de vérification des antécédents générée par l’exécution de l’API POST /agents/check_defs/{check_def_id}/run .
    Tableau 38. Paramètres de requête
    Nom Description
    Aucun
    Tableau 39. Paramètres du corps de la demande (JSON)
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 40. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 41. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 42. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    404 La demande avec l’ID fourni est introuvable.

    Paramètres de corps de réponse (JSON)

    Nom Description
    Aucun

    Demande cURL

    L’exemple suivant montre comment arrêter une vérification des antécédents.

    curl "https://instance.service-now.com/api/sn_agent/agents/exec/background/stop/02359174db2a30108a0751f4f3961997" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Agent Client Collector : GET /agents/exec/run/{request_id}

    Obtient l’état de la demande avec l’ID donné.

    Format d'URL

    /api/sn_agent/agents/exec/run/{request_id}

    Paramètres de demande pris en charge

    Tableau 43. Paramètres de chemin d'accès
    Nom Description
    request_id ID d’une demande de vérification des antécédents générée par l’exécution de l’API POST /agents/check_defs/{check_def_id}/run .
    Tableau 44. Paramètres de requête
    Nom Description
    Aucun
    Tableau 45. Paramètres du corps de la demande (JSON)
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 46. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 47. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 48. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    202 Message avec l’ID fourni indiquant que la demande est en cours.
    400 Erreur dans les arguments fournis dans le corps de la demande.
    404 La demande avec l’ID fourni est introuvable.
    408 Délai d’exécution de la demande avec l’ID fourni.
    500 Erreur lors de la vérification de l’état de la demande avec l’ID fourni.

    Paramètres de corps de réponse (JSON)

    Nom Description
    état État de la demande.
    Valeurs possibles :
    • terminé : la vérification a réussi.
    • échec : la vérification a échoué. Pour plus d’informations, consultez le message d’erreur.
    • mid_flow : la sortie de la demande est gérée par le Serveur MID.
    • traitement : la vérification est en cours.
    • timeout : le traitement de vérification a dépassé la limite de temps définie dans la méthode runCheckForCis( ).

    Type de données : chaîne
    err_msg Message d’erreur le cas échéant.
    Valeurs possibles :
    • Aucun agent trouvé pour les CI concernés.
    • Aucune demande de vérification des antécédents avec l’ID fourni.
    • Aucune demande avec l’ID fourni.
    • Aucun résultat de test avec l’ID fourni.
    • Délai d’expiration de la demande.

    Type de données : chaîne

    Demande cURL

    L’exemple suivant montre comment obtenir l’état d’une demande.

    curl "https://instance.service-now.com/api/sn_agent/agents/exec/run/12fed13cdb2a30108a0751f4f3961981" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Agent Client Collector : GET /agents/exec/test/{test_result_id}

    Obtient l’état de vérification du test du résultat de test donné.

    Format d'URL

    /api/sn_agent/agents/exec/test/{test_result_id}

    Paramètres de demande pris en charge

    Tableau 49. Paramètres de chemin d'accès
    Nom Description
    test_result_id ID de résultat de test généré lors de la création d’une demande de vérification de test.
    Tableau 50. Paramètres de requête
    Nom Description
    Aucun
    Tableau 51. Paramètres du corps de la demande (JSON)
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 52. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 53. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 54. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    202 Message avec l’ID fourni indiquant que la demande est en cours.
    404 La demande avec l’ID fourni est introuvable.
    408 Délai d’exécution de la demande avec l’ID fourni.
    500 Erreur lors de la vérification de l’état de la demande avec l’ID fourni.

    Paramètres de corps de réponse (JSON)

    Propriétés Description
    état État des résultats des tests.
    Valeurs possibles :
    • 0 : en attente
    • 1 : En cours
    • 2 : Terminé
    • 3 : Aucun résultat de test avec l’ID fourni

    Type de données : chaîne
    sortie Sortie décrivant l’état.

    Type de données : chaîne

    Demande cURL

    L’exemple suivant montre comment obtenir l’état de résultat d’une demande de vérification de test terminée.

    curl "https://instance.service-now.com/api/sn_agent/agents/check_instances/99e12466dba530106f4810284b961976/test" \
--request POST \
--header "Accept:application/json" \
--user 'username':'password'

    Agent Client Collector : GET /agents/list

    Obtient une liste d’agents avec des informations connexes.

    Format d'URL

    /api/sn_agent/agents/list

    Paramètres de demande pris en charge

    Tableau 55. Paramètres de chemin d'accès
    Nom Description
    Aucun
    Tableau 56. Paramètres de requête
    Nom Description
    Aucun
    Tableau 57. Paramètres du corps de la demande (JSON)
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 58. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    requête x-enc Requête codée sur la table Agent Client Collectors [sn_agent_cmdb_ci_agent] au format Glide standard. Voir Chaînes de requête codées.
    Limite X Limite les résultats à un nombre maximal d’agents. Utilisez null ou undefined pour les deux s’ils ne sont pas requis. Par défaut/max : 20 000

    Type de données : nombre
    Tableau 59. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 60. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    403 L’utilisateur ne dispose pas du rôle agent_client_collector_user.

    Paramètres de corps de réponse (JSON)

    Propriété Description
    <Tableau> Tableau d’objets JSON contenant des informations étendues sur l’agent.
    [
 {
   "agent_id": "String",
   "data_collection": Number,
   "ip_address": "String",
   "is_duplicate": Boolean,
   "is_restart_enabled": Boolean,
   "name": "String",
   "number_of_running_checks": Number,
   "status": Number,
   "up_since": "String",
   "version": "String"
 }
]
    agent_id ID de l’agent tel que soumis.

    Type de données : chaîne
    data_collection La collecte de données indique si des vérifications planifiées doivent être exécutées. Ces vérifications font partie des politiques planifiées pour l’exécution de cet agent.
    Valeurs possibles :
    • 0 : Activé : les vérifications s’exécutent comme prévu.
    • 1 : Désactivé (manuel) – Les vérifications ont été désactivées manuellement.
    • 2 : Désactivé (auto) – Les vérifications ont été désactivées automatiquement en raison de la consommation élevée du processeur par le

    Type de données : nombre
    ip_address Adresse IP de l’agent.

    Type de données : chaîne
    is_duplicate

    Marqueur indiquant si cet agent est un doublon d’un autre. Il ne doit y avoir qu’un seul agent sur un hôte donné.

    Valeurs possibles :
    • vrai : l’agent a le même hôte qu’un agent Alive/Up avec un ID d’agent différent. Désactiver ou désinstaller le doublon
    • faux : cet agent n’a pas de doublons à l’état Actif/En service.

    Type de données : booléennes
    is_restart_enabled

    Marqueur indiquant si le redémarrage est activé. Le redémarrage de l’agent n’est pas configurable. Cela dépend du système d’exploitation et de la version du système d’exploitation sur lequel l’agent s’exécute.

    Valeurs possibles :
    • vrai : le redémarrage est activé pour cet agent.
    • faux : le redémarrage est désactivé pour cet agent.

    Type de données : booléennes
    nom Nom de l’agent.

    Type de données : chaîne
    number_of_running_checks Le nombre de vérifications dont l’exécution est planifiée pour l’agent. Ces vérifications font partie des politiques planifiées pour l’exécution de cet agent.

    Type de données : nombre
    état État de l’agent.
    Valeurs possibles :
    • 0 : actif/actif : l’agent est actif.
    • 1 : avertissement – L’agent n’a pas reçu de message de maintien de connexion au cours des dernières minutes.
    • 2 : Inactif : l’agent n’a pas reçu de message de maintien de connexion depuis longtemps.
    • 3 : Redémarrage – L’agent redémarre.

    Type de données : nombre
    up_since Heure UTC depuis que le statut de l’agent est activé/augmenté. La valeur est au format GlideDateTime .

    Type de données : chaîne
    version La version de l’agent est en cours d’exécution Agent Client Collector .

    Type de données : chaîne

    Demande cURL

    L’exemple suivant montre comment restreindre les résultats par requête et par numéro. La requête renvoie tous les agents qui ne sont pas dans l’état arrêté avec un maximum de deux résultats.

    curl "https://instance.service-now.com/api/sn_agent/agents/list" \
--request GET \
--header "Accept:application/json" \
--header "X-Enc-Query: agent_extended_info.status!=2" \
--header "X-Limit: 2" \
--user 'username':'password'

    Sortie :

    {
   "agents": [
     {
       "name": "007-175",
       "status": 0,
        "agent_id": "007-175",
       "ip_address": "11.222.63.66",
        "number_of_running_checks": 0,
       "data_collection": 0,
       "is_restart_enabled": false,
       "is_duplicate": false,
       "up_since": "2021-03-24 14:36:45",
       "version": "2.4.0"
     },
     {
       "name": "win2016-dc-64bit",
       "status": 0,
       "agent_id": "007-64",
       "ip_address": "10.222.333.42",
       "number_of_running_checks": 1,
       "data_collection": 0,
       "is_restart_enabled": true,
       "is_duplicate": false,
       "up_since": "2021-03-24 11:04:38",
       "version": "2.4.0"
     }
   ]
}

    Demande cURL

    L’exemple suivant montre comment répertorier tous les agents du système. Cet exemple n’utilise aucune requête et aucun nombre maximal de résultats.

    curl "https://instance.service-now.com/api/sn_agent/agents/list" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Agent Client Collector : GET /agents/{agent_id}/log

    Demande le journal d’un agent spécifié avec l’état actif/actif.

    Remarque :
    Pour récupérer le journal et vérifier sa progression, transmettez l’ID de demande renvoyé au point de terminaison GET /agents/log/{request_id}/ .

    Format d'URL

    /api/sn_agent/agents/{agent_id}/log

    Paramètres de demande pris en charge

    Tableau 61. Paramètres de chemin d'accès
    Nom Description
    agent_id ID unique d’un agent répertorié dans la colonne ID de l’agent de la table Agent Client Collectors [sn_agent_cmdb_ci_agent].

    Pour obtenir une liste des ID d’agent et d’autres détails, exécutez le point de terminaison GET /agents/list .

    Type de données : chaîne
    Tableau 62. Paramètres de requête
    Nom Description
    Aucun
    Tableau 63. Paramètres du corps de la demande (JSON)
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 64. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 65. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 66. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    403 L’utilisateur ne dispose pas du rôle agent_client_collector_admin.
    404 L’agent est introuvable ou n’est pas à l’état actif/actif.

    Paramètres de corps de réponse (JSON)

    Nom Description
    request_id Sys_id d’une demande dans la table Demandes d’Agent Client Collector [sn_agent_request].

    Vous pouvez utiliser cet ID pour récupérer le journal et vérifier sa progression avec le point de terminaison GET /agents/log/{request_id}/ .

    Type de données : chaîne

    Demande cURL

    L’exemple suivant montre comment obtenir un ID de demande de journal.

    curl "https://instance.service-now.com/api/sn_agent/agents/<sys_id>/log" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Sortie :

    "request_id": "<sys_id>"

    Agent Client Collector : GET /agents/log/{request_id}/

    Vérifie l’état d’une demande de journal d’empreinte.

    Détecte les changements dans le journal lors de la récupération de la demande envoyée avec GET /api/sn_agent/agents/{agent_id}/log.

    Format d'URL

    /api/sn_agent/agents/log/{request_id}/

    Paramètres de demande pris en charge

    Tableau 67. Paramètres de chemin d'accès
    Nom Description
    request_id Sys_id d’une demande dans la table Demandes d’Agent Client Collector [sn_agent_request].

    Pour l’ID de demande, exécutez GET /api/sn_agent/agents/{agent_id}/log.

    Type de données : chaîne
    Tableau 68. Paramètres de requête
    Nom Description
    Aucun
    Tableau 69. Paramètres du corps de la demande (JSON)
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 70. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 71. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 72. Codes d'état
    Code d'état Description
    200 L’état de la demande est terminé et le journal saisi est prêt.
    202 La demande d’extraction du journal avec l’ID fourni est toujours en cours.
    403 L’utilisateur ne dispose pas du rôle agent_client_collector_admin.
    404 Demande d’extraction du journal avec l’ID fourni introuvable.
    408 La demande de saisie du journal a expiré.
    500 La demande de journal d’emprise a rencontré une erreur.

    Paramètres de corps de réponse (JSON)

    Propriétés Description
    sortie Informations décrivant l’état.

    Demande cURL

    L’exemple suivant montre comment utiliser un ID de demande pour obtenir l’état d’une demande de journal d’extraction.

    curl "https://instance.service-now.com/api/sn_agent/agents/log/<request_ID>" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Sortie :

    {
  "output": "SensuSnReadFile OK: {\"component\":\"agent\",\"level\":\"info\",\"msg\":\"Agent Protection: cpu of all checks: 0%\",\"time\":\"2021-04-05T00:21:41-07:00\"},...
}

    Agent Client Collector : GET /agents/policies/list

    Obtient une liste des politiques qui sont à l’état de brouillon publié ou non publié.

    Format d'URL

    /api/sn_agent/agents/policies/list

    Paramètres de demande pris en charge

    Tableau 73. Paramètres de chemin d'accès
    Nom Description
    Aucun
    Tableau 74. Paramètres de requête
    Nom Description
    Aucun
    Tableau 75. Paramètres du corps de la demande (JSON)
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 76. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    requête x-enc Facultatif. Chaîne de requête codée au format Glide standard. Voir Chaînes de requête codées.
    x-include-check-params Facultatif. Marqueur indiquant s’il faut renvoyer les instances de vérification et leurs paramètres dans les résultats.
    Valeurs valides :
    • vrai : inclut les instances de vérification et leurs paramètres dans les résultats.
    • faux : n’incluez pas les instances de vérification et leurs paramètres dans les résultats.

    Valeur par défaut : false

    Type de données : booléennes
    x-include-checks-and-agents Facultatif. Marqueur indiquant s’il faut inclure les instances et les agents de vérification dans les résultats.
    Valeurs valides :
    • vrai : inclut les instances et les agents de vérification dans les résultats.
    • faux : n’incluez pas les vérifications et les agents dans les résultats.

    Valeur par défaut : false

    Type de données : booléennes
    Tableau 77. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 78. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    403 L’utilisateur ne dispose pas du rôle agent_client_collector_user.

    Paramètres de corps de réponse (JSON)

    Tableau 79. Objet
    Propriété Description
    politiques Liste des politiques récupérées. Inclut les vérifications et les agents dans les résultats si elles sont interrogées à l’aide d’en-têtes de demande spécifiques. Pour plus d’informations sur les politiques, consultez Vérifications et politiques par défaut.
    {
  "policies": [
    {
      "active": Boolean,
      "agent_ids": "String",
      "checks": [Array],
      "cred_alias": "String",
      "credential_alias": "String",
      "filter": "String",
      "interval": "Number",
      "monitored_ci_group": "String",
      "monitored_ci_script": "String",
      "monitored_ci_type_filter": Boolean,
      "monitored_ci_type_group": Boolean,
      "monitored_ci_type_script": "String",
      "name": "String",
      "params": [Array],
      "publish_status": "String",
      "secure_params": [Array],
      "sys_id": "String",
      "sys_updated_on": "String",
      "table": "String"
    }
  ]
}

    Type de données : tableau
    politiques.actives Marqueur indiquant si la politique est active.
    Valeurs valides :
    • vrai : la politique est active.
    • faux : la politique n’est pas active.

    Type de données : booléennes
    policies.agent_ids ID unique d’un agent. Ces résultats ne s’affichent que si le paramètre d’en-tête X-Include-Checks-And-Agents est défini sur vrai.

    Pour obtenir des informations étendues sur un agent, exécutez l’ID dans le point de terminaison GET /agents/{agent_id} .

    Type de données : chaîne

    Table : dans la colonne ID de l’agent de la table Agent Client Collectors [sn_agent_cmdb_ci_agent].
    Politiques.Vérifications Liste des objets définissant les vérifications répertoriés dans la table Instances de vérification [sn_agent_check]. Ces résultats s’affichent uniquement si le paramètre d’en-tête X-Include-Checks-And-Agents ou X-Include-Check-Params est défini sur vrai.

    Type de données : tableau d’objets

    "checks": [
   {
     "active": Boolean,
     "auto_generate": Boolean,
     "check_type": "String"
     "command_prefix": "String",
     "command": "String",
     "event_status_change_threshold": Number,
     "event_status_repair_threshold": Number,
     "interval": Number,
     "name": "String",
     "sys_id": "String",
     "timeout": "String"
   }
]

    Table :
    policies.checks.active Marqueur indiquant si la vérification de politique est active.
    Valeurs valides :
    • vrai : la vérification de la politique est active.
    • faux : la vérification de la politique est inactive.

    Type de données : booléennes
    policies.checks.auto_generate Marqueur indiquant s’il faut générer automatiquement la commande avec la command_prefix valeur.
    Valeurs valides :
    • vrai : remplit automatiquement la propriété avec les command valeurs des paramètres actifs.
    • false : la commande n’est pas générée automatiquement.

    Type de données : booléennes
    policies.checks.check_type Type de case à cocher spécifiant l’option de surveillance.
    Valeurs possibles :
    • Découverte : vérifiez que localise les CI liés à l’agent.
    • Événements : le résultat du chèque est transformé en événement de gestion des événements.
    • Mesures : les valeurs du résultat de la vérification sont transformées en mesures.

    Type de données : chaîne
    politiques.vérifications.commande Commande exécutée Agent Client Collector . Paramètre pris à partir d’un modèle ou d’un CI surveillé.
    Remarque :
    Si auto_generate la valeur est vrai, cette propriété est automatiquement renseignée avec le préfixe et les marqueurs des paramètres actifs répertoriés dans l’objet parameters .

    Type de données : chaîne
    policies.checks.command_prefix Si la propriété a la valeur vrai, cette commande est utilisée pour la auto_generate génération automatique. Le préfixe se compose d'une partie de la commande statique (qui ne change pas), telle que le nom du script.

    Type de données : chaîne
    policies.checks.event_status_change_threshold Nombre de fois consécutives que l’état de la réponse d’une vérification doit se produire avant qu’un nouvel événement ne soit envoyé. Renvoie la valeur null si cette option n’est pas définie.

    Par exemple, si cette valeur est 3, une vérification dont l’état de la réponse passe de OK à Erreur génère un nouvel événement avec un état d’erreur après la troisième occurrence consécutive du changement d’état.

    Type de données : nombre
    policies.checks.event_status_repair_threshold Nombre de fois consécutives où l’état de la réponse d’une vérification doit s’améliorer pour fermer l’événement précédent. Renvoie la valeur null si cette option n’est pas définie.

    Par exemple, si cette valeur est égale à 3, une vérification dont l’état de la réponse passe de Erreur à OK ferme l’événement précédent et génère un nouvel événement avec un état OK après la troisième occurrence consécutive du changement d’état.

    Type de données : nombre
    Intervalle.Vérifications.Politiques Durée d’attente en secondes entre les exécutions de vérification. Par exemple, une valeur de 60 signifie que la vérification s'exécute toutes les 60 secondes.

    Type de données : nombre
    policies.checks.name Nom de la vérification.

    Type de données : chaîne
    policies.checks.sys_id Sys_id de la vérification.

    Type de données : chaîne

    Table : instances de vérification [sn_agent_check]
    Politiques.Vérifications.Délai d’expiration Durée, en secondes, après laquelle l’exécution de la vérification s’arrête lorsqu’aucune sortie n’est renvoyée. Par exemple, une valeur de 60 signifie que, lorsque l'exécution de la vérification ne renvoie pas une valeur pendant 60 secondes, l'exécution s'arrête.

    Type de données : chaîne
    policies.cred_alias Nom des informations d'identification.

    Type de données : chaîne

    Table : Informations d’identification [discovery_credentials]
    policies.credential_alias Sys_id de l’alias d’informations d’identification.

    Type de données : chaîne

    Table : Alias de connexion et d’informations d’identification [sys_alias]
    politiques.filtre Filtre limitant les vérifications de la politique pour surveiller uniquement les critères spécifiés.

    Type de données : chaîne
    Intervalle.Politiques Durée d’attente en secondes entre les vérifications de politiques. Par exemple, une valeur de 60 signifie que la vérification s'exécute toutes les 60 secondes.
    Remarque :
    La valeur de la checks.interval propriété remplace la valeur configurée dans ce champ.

    Type de données : nombre
    policies.monitored_ci_group Nom des groupes CMDB associés à la politique.

    Ce champ n’est appliqué que si la valeur de la monitored_ci_type_group propriété est vraie.

    Type de données : chaîne

    Table : Groupes CMDB [cmdb_group]
    policies.monitored_ci_script Script pour la surveillance des CI.

    Ce champ n’est appliqué que si la valeur de la policies.monitored_ci_type_script propriété est vraie.

    Type de données : chaîne
    policies.monitored_ci_type_filter Marqueur indiquant si le filtrage par type de CI est activé. Le type de CI est répertorié dans la table propriété.
    Valeurs valides :
    • vrai : le filtrage par groupe de vérifications est activé.
    • faux : le filtrage par groupe de vérifications est désactivé.

    Type de données : booléennes
    policies.monitored_ci_type_group Marqueur indiquant si la surveillance par type de groupe CMDB est activée.
    Valeurs valides :
    • vrai : le type de groupe CMDB est activé.
    • faux : le type de groupe CMDB est désactivé.

    Type de données : booléennes
    policies.monitored_ci_type_script Marqueur indiquant si le script de surveillance des CI est activé.
    Valeurs valides :
    • vrai : le script de surveillance des CI est activé.
    • faux : le script de surveillance des CI est désactivé.

    Type de données : booléennes
    policies.name Nom de la politique.

    Type de données : chaîne
    policies.publish_status Indique si la politique est publiée.
    Valeurs possibles :
    • Brouillon : la politique n’a pas été publiée et est modifiable à l’aide des points de terminaison de mise à jour.
    • Publié : la politique est publiée. Le brouillon (copie du bac à sable) et la copie publiée sont identiques.
    • Publié* : la politique est publiée, mais la copie brouillon (vue sandbox) comporte des changements introuvables dans la copie publiée.

    Type de données : chaîne
    policies.sys_id Sys_id de la politique.

    Type de données : chaîne

    Tableau : Politiques [sn_agent_policy]
    policies.sys_updated_on Date et heure de dernière mise à jour de la politique.

    Type de données : chaîne
    politiques.table Champ de type CI surveillé de la politique. Ce champ n’est appliqué que si la monitored_ci_type_filter valeur est vraie.

    Type de données : chaîne
    Politiques.Paramètres Liste des objets contenant des informations sur les paramètres de vérification. Ces résultats ne s’affichent que si le paramètre d’en-tête X-Include-Check-Params est défini sur vrai.

    Type de données : tableau d’objets

    "params": [
  {
    "active": Boolean,
    "flag": "String",
    "mandatory: Boolean,
    "name": "String",
    "sys_id": "String",
    "value": "String",
    "value_required": Boolean
  }
]

    Table : Vérifier les paramètres [sn_agent_check_param]
    policies.params.active Marqueur indiquant si le paramètre de vérification est actif.
    Valeurs valides :
    • vrai : le paramètre de vérification est actif.
    • faux : le paramètre de vérification est inactif.

    Type de données : booléennes
    policies.params.flag Marqueur de paramètre à utiliser lors de l’invocation de vérification.

    Type de données : chaîne
    policies.params.mandatory Marqueur indiquant si cette vérification est obligatoire.
    Valeurs valides :
    • vrai : cette vérification est obligatoire.
    • faux : cette vérification est facultative.

    Type de données : booléennes
    policies.params.name Nom du paramètre.

    Type de données : chaîne
    policies.params.sys_id Sys_id du paramètre.

    Type de données : chaîne

    Table : Vérifier les paramètres [sn_agent_check_param]
    politiques.paramètres.valeur Valeur du paramètre.

    Type de données : chaîne
    policies.params.value_required Marqueur indiquant si les informations fournies par la propriété value sont requises.
    Valeurs valides :
    • true : la propriété value est requise.
    • false : la propriété value est nulle ou n’est pas obligatoire.

    Type de données : booléennes
    policies.secure_params Liste des objets contenant des informations sur les paramètres de sécurité de vérification. Pour plus d’informations, voir Création d’un paramètre sécurisé pour une vérification. Ces résultats ne s’affichent que si le paramètre d’en-tête X-Include-Check-Params est défini sur vrai.

    Type de données : tableau d’objets

    "secure_params": [
   {
     "active": Boolean,
     "name": "String",
     "order": Number,
     "sys_id": "String"
   }
]

    Table : Vérifier les paramètres sécurisés [sn_agent_check_secure_param]
    policies.secure_params.active Marqueur indiquant si le paramètre de sécurité de vérification est actif.
    Valeurs valides :
    • true : le paramètre de vérification sécurisé est actif.
    • faux : le paramètre de sécurité de vérification est inactif.

    Type de données : booléennes
    policies.secure_params.name Nom du paramètre sécurisé.

    Type de données : chaîne
    policies.secure_params.commande Ordre dans lequel le paramètre est envoyé à la commande/au script de vérification.

    Type de données : nombre
    policies.secure_params.sys_id Sys_id de l’enregistrement.

    Type de données : chaîne

    Table : Vérifier le paramètre sécurisé [sn_agent_check_secure_param]

    Demande cURL

    L’exemple suivant montre comment restreindre les résultats par requête et par numéro. La requête renvoie toutes les politiques actives ainsi que l’ID de l’agent associé.

    curl "https://instance.service-now.com/api/sn_agent/agents/policies/list" \
--request GET \
--header "Accept:application/json" \
--header 'X-Enc-Query: active=true ' \
--header 'X-Include-Checks-And-Agents: true' \
--user 'username' : 'password'

    Sortie :

    {
  "policies": [
    {
      "name": "Basic Discovery",
      "sys_id": "68bfd27c536113006dfeddeeff7b12be",
      "active": "true",
      "interval": "43200",
      "sys_updated_on": "2020-07-21 10:14:12",
      "monitored_ci_type_filter": "true",
      "filter": "discovery_source=AgentClientCollector^ORlast_discoveredRELATIVELT@dayofweek@ago@14",
      "table": "cmdb_ci_server",
      "monitored_ci_type_script": "false",
      "monitored_ci_script": "/*\n      Provide a script to get monitored CI type. ...",
      "monitored_ci_type_group": "false",
      "monitored_ci_group": "null// group name as seen in cmdb_group table",
      "cred_alias": "null// credential name as seen in discovery_credentials table",
      "credential_alias": "null// credential alias sys id as seen in sys_alias table",
      "publish_status": "Published",
      "checks": [
        {
          "name": "check-discovery-basic",
          "sys_id": "5b10c644c7e10010b9a4362c14c260aa",
          "active": "true",
          "command": "check_discover.rb",
          "command_prefix": "check_discover.rb",
          "auto_generate": "true",
          "timeout": "60",
          "interval": "43200",
          "event_status_change_threshold": null,
          "event_status_repair_threshold": null,
          "check_type": "Discovery"
        }
      ],
      "agent_ids": "b1faba21b066256f,a088b75b1b25b0a0"
    }
  ]
}

    Agent Client Collector : GET /agents/policy/activate/{policy_id}

    Active une politique publiée.

    Pour obtenir la liste des politiques publiées, utilisez GET /agents/policies/list. Ce point de terminaison ne prend en charge que les sys_ids dans lesquels la valeur de la propriété de la politique publish_status est publiée ou publiée*.

    Format d'URL

    /api/sn_agent/agents/policy/activate/{policy_id}

    Paramètres de demande pris en charge

    Tableau 80. Paramètres de chemin d'accès
    Nom Description
    policy_id Sys_id de la politique publiée.

    Type de données : chaîne

    Tableau : Politiques [sn_agent_policy]
    Tableau 81. Paramètres de requête
    Nom Description
    Aucun
    Tableau 82. Paramètres du corps de la demande (JSON)
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 83. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 84. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 85. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    403 L’utilisateur ne dispose pas du rôle agent_client_collector_admin.
    404 Aucun enregistrement trouvé avec la sys_id fournie.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON)

    En-tête Description
    message Message contenant les résultats de réussite ou d’échec de l’opération.

    Type de données : chaîne

    Demande cURL

    L’exemple suivant montre comment activer une politique.

    curl "https://instance.service-now.com/api/sn_agent/agents/policy/activate/<sys_id>" \
--request GET \
--header "Accept:application/json" \
--user 'username' : 'password'

    Sortie :

    {
  "message": "Operation was successful"
}

    Agent Client Collector : GET /agents/policy/deactivate/{policy_id}

    Désactive une politique publiée.

    Pour obtenir la liste des politiques publiées, utilisez GET /agents/policies/list. Ce point de terminaison ne prend en charge que les sys_ids dans lesquels la valeur de la propriété de la politique publish_status est publiée ou publiée*.

    Format d'URL

    /api/sn_agent/agents/policy/activate/{policy_id}

    Paramètres de demande pris en charge

    Tableau 86. Paramètres de chemin d'accès
    Nom Description
    policy_id Sys_id de la politique publiée.

    Type de données : chaîne

    Tableau : Politiques [sn_agent_policy]
    Tableau 87. Paramètres de requête
    Nom Description
    Aucun
    Tableau 88. Paramètres du corps de la demande (JSON)
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 89. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 90. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 91. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    403 L’utilisateur ne dispose pas du rôle agent_client_collector_admin.
    404 Aucun enregistrement trouvé avec la sys_id fournie.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON)

    En-tête Description
    message Message contenant les résultats de réussite ou d’échec de l’opération.

    Type de données : chaîne

    Demande cURL

    L’exemple suivant montre comment désactiver une politique.

    curl "https://instance.service-now.com/api/sn_agent/agents/policy/deactivate/<sys_id>" \
--request GET \
--header "Accept:application/json" \
--user 'username' : 'password'

    Sortie :

    {
  "message": "Operation was successful"
}

    Agent Client Collector : GET /agents/policy/publish/{policy_id}

    Publie une ébauche de politique.

    Utilisez l’un des points de terminaison suivants pour modifier une copie brouillon ou bac à sable avant sa publication :

    Format d'URL

    /api/sn_agent/agents/policy/publish/{policy_id}

    Paramètres de demande pris en charge

    Tableau 92. Paramètres de chemin d'accès
    Nom Description
    policy_id Sys_id d’une politique dans la table Politiques [sn_agent_policy] qui est à l’état Brouillon ou une copie de bac à sable.

    Type de données : chaîne
    Tableau 93. Paramètres de requête
    Nom Description
    Aucun
    Tableau 94. Paramètres du corps de la demande (JSON)
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 95. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 96. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 97. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    403 L’utilisateur ne dispose pas du rôle agent_client_collector_admin.
    404 Aucun enregistrement trouvé avec la sys_id fournie.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON)

    En-tête Description
    message Message contenant les résultats de réussite ou d’échec de l’opération.

    Type de données : chaîne

    Demande cURL

    L’exemple suivant montre comment publier une stratégie.

    curl "https://instance.service-now.com/api/sn_agent/agents/policy/publish/<sys_id>" \
--request GET \
--header "Accept:application/json" \
--user 'username' : 'password'

    Sortie :

    {
  "message": "Operation was successful"
}

    Agent Client Collector : GET /agents/policy/sandbox_from_published/{policy_id}

    Obtient la copie sandbox d’une politique publiée et fournit les détails de la politique.

    Utilisez la copie de bac à sable pour effectuer des mises à jour d’une politique et la publier. Vous pouvez utiliser les sys_ids dans le corps de la réponse pour utiliser les points de terminaison suivants :

    Pour obtenir la liste des politiques publiées, utilisez GET /agents/policies/list. Ce point de terminaison ne prend en charge que les sys_ids dans lesquels la valeur de la propriété de la politique publish_status est publiée ou publiée*.

    Format d'URL

    /api/sn_agent/agents/policy/sandbox_from_published/{policy_id}

    Paramètres de demande pris en charge

    Tableau 98. Paramètres de chemin d'accès
    Nom Description
    policy_id Sys_id de la politique publiée.

    Type de données : chaîne

    Tableau : Politiques [sn_agent_policy]
    Tableau 99. Paramètres de requête
    Nom Description
    Aucun
    Tableau 100. Paramètres du corps de la demande (JSON)
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 101. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 102. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 103. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    403 L’utilisateur ne dispose pas du rôle agent_client_collector_admin.
    404 Aucun enregistrement trouvé avec la sys_id fournie.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON)

    Propriété Description
    <Object> Détails étendus de la copie de bac à sable associée à la politique. Pour plus d’informations sur les politiques, consultez Vérifications et politiques par défaut.
    {
  "active": Boolean"
  "agent_ids": "String",
  "checks": [Array],
  "cred_alias": "String",
  "credential_alias": "String",
  "filter": "String",
  "interval": "Number",
  "monitored_ci_group": "String",
  "monitored_ci_script": "String",
  "monitored_ci_type_filter": Boolean,
  "monitored_ci_type_group": Boolean,
  "monitored_ci_type_script": "String",
  "name": "String",
  "params": [Array],
  "publish_status": "String",
  "secure_params": [Array],
  "sys_id": "String",
  "sys_updated_on": "String",
  "table": "String"
}
    actif Marqueur indiquant si la politique est active.
    Valeurs valides :
    • vrai : la politique est active.
    • faux : la politique n’est pas active.

    Type de données : booléennes
    agent_ids ID unique d’un agent. Ces résultats ne s’affichent que si le paramètre d’en-tête X-Include-Checks-And-Agents est défini sur vrai.

    Pour obtenir des informations étendues sur un agent, exécutez l’ID dans le point de terminaison GET /agents/{agent_id} .

    Type de données : chaîne

    Table : dans la colonne ID de l’agent de la table Agent Client Collectors [sn_agent_cmdb_ci_agent].
    Contrôles Liste des objets définissant les vérifications répertoriés dans la table Instances de vérification [sn_agent_check]. 
    "checks": [
   {
     "active": Boolean,
     "auto_generate": Boolean,
     "check_type": "String"
     "command_prefix": "String",
     "command": "String",
     "event_status_change_threshold": Number,
     "event_status_repair_threshold": Number,
     "interval": Number,
     "name": "String",
     "sys_id": "String",
     "timeout": "String"
   }
]

    Type de données : tableau
    checks.active Marqueur indiquant si la vérification de politique est active.
    Valeurs valides :
    • vrai : la vérification de la politique est active.
    • faux : la vérification de la politique est inactive.

    Type de données : booléennes
    checks.auto_generate Marqueur indiquant s’il faut générer automatiquement la commande avec la command_prefix valeur.
    Valeurs valides :
    • vrai : remplit automatiquement la propriété avec les command valeurs des paramètres actifs.
    • false : la commande n’est pas générée automatiquement.

    Type de données : booléennes
    checks.check_type Type de case à cocher spécifiant l’option de surveillance.
    Valeurs possibles :
    • Découverte : vérifiez que localise les CI liés à l’agent.
    • Événements : le résultat du chèque est transformé en événement de gestion des événements.
    • Mesures : les valeurs du résultat de la vérification sont transformées en mesures.

    Type de données : chaîne
    checks.command Commande exécutée Agent Client Collector . Paramètre pris à partir d’un modèle ou d’un CI surveillé.
    Remarque :
    Si auto_generate la valeur est vrai, cette propriété est automatiquement renseignée avec le préfixe et les marqueurs des paramètres actifs répertoriés dans l’objet parameters .

    Type de données : chaîne
    checks.command_prefix Si la propriété a la valeur vrai, cette commande est utilisée pour la auto_generate génération automatique. Le préfixe se compose d'une partie de la commande statique (qui ne change pas), telle que le nom du script.

    Type de données : chaîne
    checks.event_status_change_threshold Nombre de fois consécutives que l’état de la réponse d’une vérification doit se produire avant qu’un nouvel événement ne soit envoyé. Renvoie la valeur null si cette option n’est pas définie.

    Par exemple, si cette valeur est 3, une vérification dont l’état de la réponse passe de OK à Erreur génère un nouvel événement avec un état d’erreur après la troisième occurrence consécutive du changement d’état.

    Type de données : nombre
    checks.event_status_repair_threshold Nombre de fois consécutives où l’état de la réponse d’une vérification doit s’améliorer pour fermer l’événement précédent. Renvoie la valeur null si cette option n’est pas définie.

    Par exemple, si cette valeur est égale à 3, une vérification dont l’état de la réponse passe de Erreur à OK ferme l’événement précédent et génère un nouvel événement avec un état OK après la troisième occurrence consécutive du changement d’état.

    Type de données : nombre
    checks.interval Durée d’attente en secondes entre les exécutions de vérification. Par exemple, une valeur de 60 signifie que la vérification s'exécute toutes les 60 secondes.

    Type de données : nombre
    checks.name Nom de la vérification.

    Type de données : chaîne
    checks.sys_id Sys_id de la vérification. Le point de terminaison POST /agents/update/check/{check_id} prend cette valeur pour mettre à jour la copie du bac à sable.

    Type de données : chaîne

    Table : instances de vérification [sn_agent_check]
    checks.timeout Durée, en secondes, après laquelle l’exécution de la vérification s’arrête lorsqu’aucune sortie n’est renvoyée. Par exemple, une valeur de 60 signifie que, lorsque l'exécution de la vérification ne renvoie pas une valeur pendant 60 secondes, l'exécution s'arrête.

    Type de données : chaîne
    cred_alias Nom des informations d'identification.

    Type de données : chaîne

    Table : Informations d’identification [discovery_credentials]
    credential_alias Sys_id de l’alias d’informations d’identification.

    Type de données : chaîne

    Table : Alias de connexion et d’informations d’identification [sys_alias]
    filtre Filtre limitant les vérifications de la politique pour surveiller uniquement les critères spécifiés.

    Type de données : chaîne
    intervalle Durée d’attente en secondes entre les vérifications de politiques. Par exemple, une valeur de 60 signifie que la vérification s'exécute toutes les 60 secondes.
    Remarque :
    La valeur de la checks.interval propriété remplace la valeur configurée dans ce champ.

    Type de données : nombre
    monitored_ci_group Nom des groupes CMDB associés à la politique.

    Ce champ n’est appliqué que si la valeur de la monitored_ci_type_group propriété est vraie.

    Type de données : chaîne

    Table : Groupes CMDB [cmdb_group]
    monitored_ci_script Script pour la surveillance des CI.

    Ce champ n’est appliqué que si la valeur de la policies.monitored_ci_type_script propriété est vraie.

    Type de données : chaîne
    monitored_ci_type_filter Marqueur indiquant si le filtrage par type de CI est activé. Le type de CI est répertorié dans la table propriété.
    Valeurs valides :
    • vrai : le filtrage par groupe de vérifications est activé.
    • faux : le filtrage par groupe de vérifications est désactivé.

    Type de données : booléennes
    monitored_ci_type_group Marqueur indiquant si la surveillance par type de groupe CMDB est activée.
    Valeurs valides :
    • vrai : le type de groupe CMDB est activé.
    • faux : le type de groupe CMDB est désactivé.

    Type de données : booléennes
    monitored_ci_type_script Marqueur indiquant si le script de surveillance des CI est activé.
    Valeurs valides :
    • vrai : le script de surveillance des CI est activé.
    • faux : le script de surveillance des CI est désactivé.

    Type de données : booléennes
    nom Nom de la politique.

    Type de données : chaîne
    publish_status Indique si la politique est publiée.
    Valeurs possibles :
    • Brouillon : la politique n’a pas été publiée et est modifiable à l’aide des points de terminaison de mise à jour.
    • Publié : la politique est publiée. Le brouillon (copie du bac à sable) et la copie publiée sont identiques.
    • Publié* : la politique est publiée, mais la copie brouillon (vue sandbox) comporte des changements introuvables dans la copie publiée.

    Type de données : chaîne
    paramètres Liste des objets contenant des informations sur les paramètres de vérification. Ces résultats ne s’affichent que si le paramètre d’en-tête X-Include-Check-Params est défini sur vrai.

    Type de données : tableau d’objets

    "params": [
  {
    "active": Boolean,
    "flag": "String",
    "mandatory: Boolean,
    "name": "String",
    "sys_id": "String",
    "value": "String",
    "value_required": Boolean
  }
]

    Table : Vérifier les paramètres [sn_agent_check_param]
    params.active Marqueur indiquant si le paramètre de vérification est actif.
    Valeurs valides :
    • vrai : le paramètre de vérification est actif.
    • faux : le paramètre de vérification est inactif.

    Type de données : booléennes
    params.flag Marqueur de paramètre à utiliser lors de l’invocation de vérification.

    Type de données : chaîne
    params.mandatory Marqueur indiquant si cette vérification est obligatoire.
    Valeurs valides :
    • vrai : cette vérification est obligatoire.
    • faux : cette vérification est facultative.

    Type de données : booléennes
    params.name Nom du paramètre.

    Type de données : chaîne
    params.sys_id Sys_id du paramètre répertorié dans le tableau Paramètres de vérification [sn_agent_check_param]. Le point de terminaison POST /agents/update/check_param/{param_id} prend cette valeur pour mettre à jour la copie du bac à sable.

    Type de données : chaîne
    params.value Valeur du paramètre.

    Type de données : chaîne
    params.value_required Marqueur indiquant si les informations fournies par la propriété value sont requises.
    Valeurs valides :
    • true : la propriété value est requise.
    • false : la propriété value est nulle ou n’est pas obligatoire.

    Type de données : booléennes
    secure_params Liste des objets contenant des informations sur les paramètres de sécurité de vérification. Pour plus d’informations, voir Création d’un paramètre sécurisé pour une vérification. Ces résultats ne s’affichent que si le paramètre d’en-tête X-Include-Check-Params est défini sur vrai.

    Type de données : tableau d’objets

    "secure_params": [
   {
     "active": Boolean,
     "name": "String",
     "order": Number,
     "sys_id": "String"
   }
]

    Table : Vérifier les paramètres sécurisés [sn_agent_check_secure_param]
    secure_params.actif Marqueur indiquant si le paramètre de sécurité de vérification est actif.
    Valeurs valides :
    • true : le paramètre de vérification sécurisé est actif.
    • faux : le paramètre de sécurité de vérification est inactif.

    Type de données : booléennes
    secure_params.nom Nom du paramètre sécurisé.

    Type de données : chaîne
    secure_params.commande Ordre dans lequel le paramètre est envoyé à la commande/au script de vérification.

    Type de données : nombre
    secure_params.sys_id Sys_id de l’enregistrement. Le point de terminaison POST /agents/update/check_secure_param/{param_id} prend cette valeur pour mettre à jour la copie du bac à sable.

    Type de données : chaîne

    Table : Vérifier le paramètre sécurisé [sn_agent_check_secure_param]
    sys_id Sys_id de la politique. Le point de terminaison POST /agents/update/policy/{policy_id} prend cette valeur pour mettre à jour la copie du bac à sable.

    Type de données : chaîne

    Tableau : Politiques [sn_agent_policy]
    sys_updated_on Date et heure de dernière mise à jour de la politique.

    Type de données : chaîne
    Table Champ de type CI surveillé de la politique. Ce champ n’est appliqué que si la monitored_ci_type_filter valeur est vraie.

    Type de données : chaîne

    Demande cURL

    L’article suivant montre comment obtenir des informations sur la politique de mesures de conteneur Docker.

    curl "https://instance.service-now.com/api/sn_agent/agents/policy/sandbox_from_published/<sys_id>" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Sortie :

    {
  "name": "Docker Container Metrics",
  "sys_id": "b01e609a1b9fe4943e7f0b05464bcb91",
  "active": "false",
  "interval": "60",
  "sys_updated_on": "2021-04-05 19:52:28",
  "monitored_ci_type_filter": "true",
  "filter": "operational_status=1",
  "table": "cmdb_ci_docker_container",
  "monitored_ci_type_script": "false",
  "monitored_ci_script": "/*\n Provide a script to get monitored CI type.",
  "monitored_ci_type_group": "false",
  "monitored_ci_group": "null// group name as seen in cmdb_group table",
  "cred_alias": "null// credential name as seen in discovery_credentials table",
  "credential_alias": "null// credential alias sys id as seen in sys_alias table",
  "publish_status": "Published",
  "checks": [
    {
      "name": "container.docker.metrics-docker",
      "sys_id": "701e609a1b9fe4943e7f0b05464bcb94",
      "active": "true",
      "command": "metrics-docker-stats.rb -N {{.labels.params_ci_container_id}} -P -n -i",
      "command_prefix": "metrics-docker-stats.rb -N {{.labels.params_ci_container_id}}",
      "auto_generate": "true",
      "timeout": "60",
      "interval": "60",
      "event_status_change_threshold": null,
      "event_status_repair_threshold": null,
      "check_type": "Metrics",
      "params": [
        {
          "name": "scheme",
          "sys_id": "c11e609a1b9fe4943e7f0b05464bcb97",
          "value": null,
          "active": "false",
          "mandatory": "false",
          "value_required": "true",
          "flag": "-s"
        },
        ...
        {
          "name": "docker_host",
          "sys_id": "cd1e609a1b9fe4943e7f0b05464bcb97",
          "value": null,
          "active": "false",
          "mandatory": "false",
          "value_required": "true",
          "flag": "-H"
        }
      ],
      "secure_params": []
    }
  ]
}

    Agent Client Collector : GET /agents/{agent_id}/restart

    Redémarre un agent spécifié avec l’état actif/actif.

    Si Agent Client Collector des problèmes de performances surviennent, vous pouvez redémarrer l’agent. Le redémarrage manuel est pris en charge dans les environnements suivants :
    • Agents basés sur Linux utilisant systemd
    • Agents Windows

    Format d'URL

    /api/sn_agent/agents/{agent_id}/restart

    Paramètres de demande pris en charge

    Tableau 104. Paramètres de chemin d'accès
    Nom Description
    agent_id ID unique d’un agent répertorié dans la colonne ID de l’agent de la table Agent Client Collectors [sn_agent_cmdb_ci_agent].

    Pour obtenir une liste des ID d’agent et d’autres détails, exécutez le point de terminaison GET /agents/list .

    Type de données : chaîne
    Tableau 105. Paramètres de requête
    Nom Description
    Aucun
    Tableau 106. Paramètres du corps de la demande (JSON)
    Nom Description
    Aucun

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 107. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 108. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 109. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    403 L’utilisateur ne dispose pas du rôle agent_client_collector_admin.
    404 Aucun enregistrement trouvé avec le sys_id fourni ou cet agent ne prend pas en charge le redémarrage.

    Paramètres de corps de réponse (JSON)

    Nom Description
    message Message contenant les résultats de réussite ou d’échec de l’opération.

    Type de données : chaîne

    Demande cURL

    L’exemple suivant montre comment redémarrer un agent.

    curl "https://instance.service-now.com/api/sn_agent/agents/<agent_id>/restart" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'

    Sortie :

    {
  "message": "Restarting Agent With ID: <agent_id>"
}

    Agent Client Collector : POST /agents/check_defs/{check_def_id}/run

    Exécute une vérification par rapport à l’élément de configuration donné.

    Pour arrêter une vérification des antécédents, utilisez l’ID de demande fourni dans l’API GET /agents/exec/background/stop/{request_id} .

    Format d'URL

    /api/sn_agent/agents/check_defs/{check_def_id}/run

    Paramètres de demande pris en charge

    Tableau 110. Paramètres de chemin d'accès
    Nom Description
    check_def_id Sys_id d’une définition de vérification dans la table Définitions de vérification [sn_agent_check_def].
    Tableau 111. Paramètres de requête
    Nom Description
    Aucun
    Tableau 112. Paramètres du corps de la demande (JSON)
    Nom Description
    paramètres Carte des noms et valeurs de paramètres. Ces paramètres peuvent être utilisés pour remplacer les enregistrements de paramètres de la définition de vérification et ses valeurs spécifiées. 
    "params": {
  "<parameter name>": "String"
}

    Type de données : objet
    Priorité Priorité de la demande à définir sur la file d’attente ECC.
    Valeurs possibles :
    • 0 : interactif
    • 1 : Accéléré
    • 2 : standard

    Type de données : nombre
    requête Requête codée pour récupérer le GlideRecord à partir de la table spécifiée dans la table propriété.

    Type de données : chaîne
    Table Nom de la table cmdb_ci pour cette vérification des antécédents.

    Type de données : chaîne
    timeout Valeur du délai d’expiration de la demande en secondes.

    Type de données : nombre

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 113. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 114. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 115. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    400 Une erreur s’est produite dans les arguments fournis dans le corps de la demande.
    404 La définition de vérification avec l’ID fourni est introuvable.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON)

    Nom Description
    requestId Sys_id de la demande de vérification des antécédents générée.

    Demande cURL

    L’exemple suivant montre comment exécuter une vérification des antécédents et obtenir son ID de demande.

    curl "https://instance.service-now.com/api/sn_agent/agents/check_defs/a90d3c361be1301060d2773ad54bcb6f/run" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"table\":\"sn_agent_check_def\"}" \
--user 'username':'password'

    Sortie :

    {
  "request_id": "278c0170db2a30108a0751f4f3961926"
}

    Agent Client Collector : POST /agents/check_defs/{check_def_id}/test

    Permet de créer des demandes de vérification de test sur les définitions de vérification.

    Utilisez cette API pour les tâches suivantes :
    • Définir la définition de vérification sur test
    • Définir l’élément de configuration par rapport auquel exécuter le test
    Vous pouvez également spécifier l’un des identificateurs suivants à utiliser pendant le test :
    • sys_id d’informations d’identification
    • ID d’alias d’informations d’identification
    • Nom des informations d'identification

    Format d'URL

    /api/sn_agent/agents/check_defs/{check_def_id}/test

    Paramètres de demande pris en charge

    Tableau 116. Paramètres de chemin d'accès
    Nom Description
    check_def_id Sys_id de la définition de vérification répertoriée dans la table Définitions de vérification [sn_agent_check_def].
    Tableau 117. Paramètres de requête
    Nom Description
    Aucun
    Tableau 118. Paramètres du corps de la demande (JSON)
    Nom Description
    ci_id Sys_id d’un élément de configuration CMDB.
    credentials_id Sys_id d’un enregistrement d’informations d’identification.
    credentials_name Nom de l’enregistrement des informations d’identification.
    credentials_alias_id Sys_id d’un enregistrement d’alias d’informations d’identification.
    credentials_alias_name Nom d’un alias d’informations d’identification.

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 119. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 120. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 121. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    500 Erreur lors de la création de la demande de test.

    Paramètres de corps de réponse (JSON)

    Nom Description
    result_id Sys_id de l’enregistrement des résultats du test.

    Agent Client Collector : POST /agents/check_instances/{check_instance_id}/test

    Permet de créer des demandes de vérification de test sur les instances de vérification.

    Utilisez cette API pour les tâches suivantes :
    • Définir l’instance de vérification sur test
    • Définir l’élément de configuration par rapport auquel exécuter le test
    Vous pouvez également spécifier l’un des identificateurs suivants à utiliser pendant le test :
    • sys_id d’informations d’identification
    • ID d’alias d’informations d’identification
    • Nom des informations d'identification

    Format d'URL

    /api/sn_agent/agents/check_instances/{check_instance_id}/test

    Paramètres de demande pris en charge

    Tableau 122. Paramètres de chemin d'accès
    Nom Description
    check_instance_id Sys_id de la définition de vérification répertoriée dans la table Définitions de vérification [sn_agent_check_def].
    Tableau 123. Paramètres de requête
    Nom Description
    Aucun
    Tableau 124. Paramètres du corps de la demande (JSON)
    Nom Description
    ci_id Sys_id d’un élément de configuration CMDB.
    credentials_id Sys_id d’un enregistrement d’informations d’identification.
    credentials_name Nom de l’enregistrement des informations d’identification.
    credentials_alias_id Sys_id d’un enregistrement d’alias d’informations d’identification.
    credentials_alias_name Nom d’un alias d’informations d’identification.
    proxy_agent_id ID unique d’un proxy d’agent pour exécuter cette vérification. Cette valeur est indiquée dans la colonne ID de l’agent de la table Agent Client Collectors [sn_agent_cmdb_ci_agent].

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 125. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 126. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 127. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    500 Erreur lors de la création de la demande de test.

    Paramètres de corps de réponse (JSON)

    Nom Description
    result_id Sys_id de l’enregistrement des résultats du test.

    Agent Client Collector : POST /agents/update/check/{check_id}

    Met à jour une vérification de politique sélectionnée.

    Pour récupérer les propriétés d’une copie de bac à sable de la politique, utilisez GET /agents/policy/sandbox_from_published/{policy_id}.

    Format d'URL

    /api/sn_agent/agents/update/check/{check_id}

    Paramètres de demande pris en charge

    Tableau 128. Paramètres de chemin d'accès
    Nom Description
    check_id Sys_id d’une copie de bac à sable de vérification de politique dans la table Instances de vérification [sn_agent_check].

    Type de données : chaîne
    Tableau 129. Paramètres de requête
    Nom Description
    Aucun
    Tableau 130. Paramètres du corps de la demande (JSON)
    Nom Description
    actif Marqueur indiquant si la vérification de politique est active.
    Valeurs valides :
    • vrai : la vérification de la politique est active.
    • faux : la vérification de la politique est inactive.

    Type de données : booléennes
    auto_generate Marqueur indiquant s’il faut générer automatiquement la commande avec la command_prefix valeur.
    Valeurs valides :
    • vrai : remplit automatiquement la propriété avec les command valeurs des paramètres actifs.
    • false : la commande n’est pas générée automatiquement.

    Type de données : booléennes
    check_type Type de case à cocher spécifiant l’option de surveillance.
    Valeurs possibles :
    • Découverte : vérifiez que localise les CI liés à l’agent.
    • Événements : le résultat du chèque est transformé en événement de gestion des événements.
    • Mesures : les valeurs du résultat de la vérification sont transformées en mesures.

    Type de données : chaîne
    commande Commande exécutée Agent Client Collector . Paramètre pris à partir d’un modèle ou d’un CI surveillé.
    Remarque :
    Si auto_generate la valeur est vrai, cette propriété est automatiquement renseignée avec le préfixe et les marqueurs des paramètres actifs répertoriés dans l’objet parameters .

    Type de données : chaîne
    command_prefix Si la propriété a la valeur vrai, cette commande est utilisée pour la auto_generate génération automatique. Le préfixe se compose d'une partie de la commande statique (qui ne change pas), telle que le nom du script.

    Type de données : chaîne
    event_status_change_threshold Nombre de fois consécutives que l’état de la réponse d’une vérification doit se produire avant qu’un nouvel événement ne soit envoyé. Renvoie la valeur null si cette option n’est pas définie.

    Par exemple, si cette valeur est 3, une vérification dont l’état de la réponse passe de OK à Erreur génère un nouvel événement avec un état d’erreur après la troisième occurrence consécutive du changement d’état.

    Type de données : nombre
    event_status_repair_threshold Nombre de fois consécutives où l’état de la réponse d’une vérification doit s’améliorer pour fermer l’événement précédent. Renvoie la valeur null si cette option n’est pas définie.

    Par exemple, si cette valeur est égale à 3, une vérification dont l’état de la réponse passe de Erreur à OK ferme l’événement précédent et génère un nouvel événement avec un état OK après la troisième occurrence consécutive du changement d’état.

    Type de données : nombre
    intervalle Durée d’attente en secondes entre les exécutions de vérification. Par exemple, une valeur de 60 signifie que la vérification s'exécute toutes les 60 secondes.

    Type de données : nombre
    nom Nom de la vérification.

    Type de données : chaîne
    timeout Durée, en secondes, après laquelle l’exécution de la vérification s’arrête lorsqu’aucune sortie n’est renvoyée. Par exemple, une valeur de 60 signifie que, lorsque l'exécution de la vérification ne renvoie pas une valeur pendant 60 secondes, l'exécution s'arrête.

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 131. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 132. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 133. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    403 L’utilisateur ne dispose pas du rôle agent_client_collector_admin.
    404 Aucun enregistrement trouvé avec la sys_id fournie.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON)

    Nom Description
    message Message contenant les résultats de réussite ou d’échec de l’opération.

    Type de données : chaîne

    Demande cURL

    L’exemple suivant montre comment mettre à jour les propriétés d’événement, de changement et de réparation d’une vérification de politique.

    curl "https://instance.service-now.com/api/sn_agent/agents/update/check/<check_sys_id>" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"event_status_change_threshold\" : \"2\",
    \"event_status_repair_threshold\" : \"1\"
}" \
--user 'username':'password'

    Sortie :

    {
  "message": "Operation was successful"
}

    Agent Client Collector : POST /agents/update/check_def_params/{check_def_param_id}

    Permet de modifier une ou plusieurs valeurs de champ d’un paramètre de vérification spécifié.

    Format d'URL

    /api/sn_agent/agents/update/check_def_params/{check_def_param_id}

    Paramètres de demande pris en charge

    Tableau 134. Paramètres de chemin d'accès
    Nom Description
    check_def_param_id Sys_id du paramètre de vérification.

    Type de données : chaîne

    Table : Vérifier les définitions des paramètres [sn_agent_check_param_def]
    Tableau 135. Paramètres de requête
    Nom Description
    Aucun
    Tableau 136. Paramètres du corps de la demande (JSON)
    Nom Description
    actif Marqueur indiquant si le paramètre de vérification est actif.
    Valeurs valides :
    • vrai : le paramètre de vérification est actif.
    • false : le paramètre de vérification est inactif.

    Type de données : booléennes
    default_value Spécifie la valeur par défaut de ce paramètre de vérification.

    Type de données : chaîne
    obligatoire

    Marqueur indiquant si le paramètre de vérification est requis.

    Valeurs valides :
    • true : le paramètre de vérification est requis.
    • false : le paramètre de vérification est facultatif.

    Type de données : booléennes
    nom Nom du paramètre de vérification.

    Type de données : chaîne
    Remarque :
    Consultez le dictionnaire de données pour obtenir une liste complète des champs et des types de définition de vérification.

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 137. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 138. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 139. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    404 Le paramètre de vérification est introuvable avec sys_id fourni.
    500 Erreur lors de la mise à jour du paramètre de vérification.

    Paramètres de corps de réponse (JSON)

    Nom Description
    Aucun Message de réussite ou d’erreur.

    Demande cURL

    L’exemple suivant montre comment activer un paramètre de vérification.

    curl "https://instance.service-now.com/api/sn_agent/agents/update/check_def_params/02d89bb01b307490f271ea42b24bcb63" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"active\":\"true\"}" \
--user 'username':'password'

    Sortie :

    "message": "Check Definition Parameter Updated Successfully"

    Agent Client Collector : POST /agents/update/check_def_secure_params/{check_def_secure_param_id}

    Permet de changer une ou plusieurs valeurs de champ d’un paramètre sécurisé de vérification spécifié.

    Format d'URL

    /api/sn_agent/agents/update/check_def_secure_params/{check_def_secure_param_id}

    Paramètres de demande pris en charge

    Tableau 140. Paramètres de chemin d'accès
    Nom Description
    check_def_secure_param_id Sys_id du paramètre sécurisé.

    Type de données : chaîne

    Table : Vérifier les définitions de paramètres sécurisés [sn_agent_check_secure_param_def]
    Tableau 141. Paramètres de requête
    Nom Description
    Aucun
    Tableau 142. Paramètres du corps de la demande (JSON)
    Nom Description
    actif Marqueur indiquant si le paramètre sécurisé est actif.
    Valeurs valides :
    • true : le paramètre sécurisé est actif.
    • false : le paramètre sécurisé est inactif.

    Type de données : booléennes
    nom Nom du paramètre sécurisé.

    Type de données : chaîne
    order Ordre dans lequel le paramètre est envoyé à la commande/au script de vérification.

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 143. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 144. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 145. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    404 Le paramètre sécurisé de vérification n’a pas été trouvé avec sys_id fourni.
    500 Erreur lors de la mise à jour du paramètre sécurisé de vérification.

    Paramètres de corps de réponse (JSON)

    Nom Description
    Aucun Message de réussite ou d’erreur.

    Demande cURL

    L’exemple suivant montre comment activer un paramètre de sécurité de vérification.

    curl "https://instance.service-now.com/api/sn_agent/agents/update/check_def_secure_params/2d30a066dba530106f4810284b9619c1" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"active\":\"true\"}" \
--user 'username':'password'

    Sortie :

    "message": "Check Definition Secure Parameter Updated Successfully"

    Agent Client Collector : POST /agents/update/check_defs/{check_def_id}

    Permet de modifier une ou plusieurs valeurs de champ d’une définition de vérification spécifiée.

    Format d'URL

    /api/sn_agent/agents/update/check_defs/{check_def_id}

    Paramètres de demande pris en charge

    Tableau 146. Paramètres de chemin d'accès
    Nom Description
    check_def_id Sys_id de la définition de vérification répertoriée dans la table Définitions de vérification [sn_agent_check_def].

    Type de données : chaîne
    Tableau 147. Paramètres de requête
    Nom Description
    Aucun
    Tableau 148. Paramètres du corps de la demande (JSON)
    Nom Description
    actif Indique si cette définition de vérification est active.
    Valeurs valides :
    • 0 : cette définition de vérification est inactive.
    • 1 : Cette définition de vérification est active.

    Type de données : nombre
    arrière-plan Marqueur indiquant si cette définition de vérification est une vérification d’arrière-plan. Une vérification des antécédents est une vérification dont l’agent commence l’exécution et n’attend pas la fin de son exécution.
    Valeurs valides :
    • vrai : cette définition de vérification est une vérification d’arrière-plan.
    • faux : cette définition de vérification n’est pas une vérification d’arrière-plan.

    Type de données : booléennes
    check_group Groupe spécifié pour cette définition de vérification.
    check_type Type de vérification.
    Valeurs possibles :
    • Événements : les résultats de vérification sont transformés en événement de gestion des événements.
    • Mesures : les valeurs du résultat de la vérification sont transformées en mesures.

    Type de données : chaîne
    commande Commande exécutée Agent Client Collector .

    Type de données : chaîne
    nom Nom de la vérification.

    Type de données : chaîne
    paramètres Carte des noms et valeurs de paramètres. Ces paramètres peuvent être utilisés pour remplacer les enregistrements de paramètres de la définition de vérification et ses valeurs spécifiées. 
    "params": {
  "<parameter name>": "String"
}

    Type de données : objet
    modules d'extension Liste de Agent Client Collector modules d'extension associé à cette vérification.

    Type de données : tableau
    proxy_valid

    Marqueur indiquant si la politique de définition de vérification est définie pour fonctionner comme un proxy.

    Valeurs valides :
    • vrai : cette politique de définition de vérification est définie pour fonctionner comme un proxy.
    • faux : cette politique de définition de vérification n’est pas définie pour fonctionner comme un proxy.

    Type de données : booléennes
    requête Requête codée pour récupérer le GlideRecord à partir de la table spécifiée dans la table propriété.

    Type de données : chaîne
    Table Nom de la table cmdb_ci pour cette vérification.

    Type de données : chaîne
    timeout Délai d’expiration en secondes.

    Type de données : nombre
    Remarque :
    Consultez le dictionnaire de données pour obtenir une liste complète des champs et des types de définition de vérification.

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 149. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 150. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 151. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    404 La définition de vérification n’a pas été trouvée avec sys_id fournie.
    500 Erreur lors de la mise à jour de la définition de vérification.

    Paramètres de corps de réponse (JSON)

    Nom Description
    Aucun Message de réussite ou d’erreur.

    Demande cURL

    L’exemple suivant montre comment désactiver une définition de vérification.

    curl "https://instance.service-now.com/api/sn_agent/agents/update/check_defs/99e12466dba530106f4810284b961976" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{\"active\":\"false\"}" \
--user 'username':'password'

    Sortie :

    "message": "Check Definition Updated Successfully"

    Agent Client Collector : POST /agents/update/check_param/{param_id}

    Met à jour un paramètre de vérification de politique sélectionné.

    Pour récupérer les propriétés d’une copie de bac à sable de la politique, utilisez GET /agents/policy/sandbox_from_published/{policy_id}.

    Format d'URL

    /api/sn_agent/agents/update/check_param/{param_id}

    Paramètres de demande pris en charge

    Tableau 152. Paramètres de chemin d'accès
    Nom Description
    param_id Sys_id de la copie du bac à sable du paramètre de vérification de la politique.

    Type de données : chaîne

    Table : Vérifier les paramètres [sn_agent_check_param]
    Tableau 153. Paramètres de requête
    Nom Description
    Aucun
    Tableau 154. Paramètres du corps de la demande (JSON)
    Nom Description
    actif Marqueur indiquant si le paramètre de vérification est actif.
    Valeurs valides :
    • vrai : le paramètre de vérification est actif.
    • faux : le paramètre de vérification est inactif.

    Type de données : booléennes
    marqueur
    obligatoire Marqueur indiquant si cette vérification est obligatoire.
    Valeurs valides :
    • vrai : cette vérification est obligatoire.
    • faux : cette vérification est facultative.

    Type de données : booléennes
    nom Nom du paramètre.

    Type de données : chaîne
    valide Valeur du paramètre.

    Type de données : chaîne
    value_required Marqueur indiquant si les informations fournies par la propriété value sont requises.
    Valeurs valides :
    • true : la propriété value est requise.
    • false : la propriété value est nulle ou n’est pas obligatoire.

    Type de données : booléennes

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 155. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 156. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 157. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    403 L’utilisateur ne dispose pas du rôle agent_client_collector_admin.
    404 Aucun enregistrement trouvé avec la sys_id fournie.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON)

    Nom Description
    message Message contenant les résultats de réussite ou d’échec de l’opération.

    Type de données : chaîne

    Demande cURL

    L’exemple suivant montre comment mettre à jour plusieurs propriétés d’un paramètre de vérification de politique.

    curl "https://instance.service-now.com/api/sn_agent/agents/update/check_param/<param_sys_id>" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"flag\" : \"-d\",
   \"mandatory\" : \"true\",
   \"name\" : \"scheme2\",
   \"value\" : \"120\",
   \"value_required\" : \"false\"
}" \
--user 'username':'password'

    Sortie :

    {
  "message": "Operation was successful"
}

    Agent Client Collector : POST /agents/update/check_secure_param/{param_id}

    Met à jour un paramètre sécurisé de vérification de politique sélectionné.

    Pour récupérer les propriétés d’une copie de bac à sable de la politique, utilisez GET /agents/policy/sandbox_from_published/{policy_id}.

    Format d'URL

    /api/sn_agent/agents/update/check_secure_param/{param_id}

    Paramètres de demande pris en charge

    Tableau 158. Paramètres de chemin d'accès
    Nom Description
    param_id Sys_id de la copie du bac à sable des paramètres sécurisés de vérification de la politique.

    Type de données : chaîne

    Table : Vérifier le paramètre sécurisé [sn_agent_check_secure_param]
    Tableau 159. Paramètres de requête
    Nom Description
    Aucun
    Tableau 160. Paramètres du corps de la demande (JSON)
    Nom Description
    actif Marqueur indiquant si le paramètre de sécurité de vérification est actif.
    Valeurs valides :
    • true : le paramètre de vérification sécurisé est actif.
    • faux : le paramètre de sécurité de vérification est inactif.

    Type de données : booléennes
    nom Nom du paramètre sécurisé.

    Type de données : chaîne
    order Ordre dans lequel le paramètre est envoyé à la commande/au script de vérification.

    Type de données : nombre

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 161. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 162. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 163. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    403 L’utilisateur ne dispose pas du rôle agent_client_collector_admin.
    404 Aucun enregistrement trouvé avec la sys_id fournie.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON)

    Nom Description
    message Message contenant les résultats de réussite ou d’échec de l’opération.

    Type de données : chaîne

    Demande cURL

    L’exemple suivant montre comment mettre à jour les propriétés d’un paramètre sécurisé de vérification de politique.

    curl "https://instance.service-now.com/api/sn_agent/agents/update/check_secure_param/<param_sys_id>" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
   \"name\" : \"new name\",
   \"order\" : \"2\"
}" \
--user 'username':'password'

    Sortie :

    {
  "message": "Operation was successful"
}

    Agent Client Collector : POST /agents/update/policy/{policy_id}

    Met à jour une copie de bac à sable d’une politique.

    Pour récupérer les propriétés d’une copie de bac à sable de la politique, utilisez GET /agents/policy/sandbox_from_published/{policy_id}.

    Format d'URL

    /api/sn_agent/agents/update/policy/{policy_id}

    Paramètres de demande pris en charge

    Tableau 164. Paramètres de chemin d'accès
    Nom Description
    policy_id Sys_id d’une copie de bac à sable de la politique.

    Type de données : chaîne

    Tableau : Politiques [sn_agent_policy]
    Tableau 165. Paramètres de requête
    Nom Description
    Aucun
    Tableau 166. Paramètres du corps de la demande (JSON)
    Nom Description
    cred_alias Nom des informations d'identification.

    Type de données : chaîne

    Table : Informations d’identification [discovery_credentials]
    credential_alias Sys_id de l’alias d’informations d’identification.

    Type de données : chaîne

    Table : Alias de connexion et d’informations d’identification [sys_alias]
    filtre Filtre limitant les vérifications de la politique pour surveiller uniquement les critères spécifiés.

    Type de données : chaîne
    intervalle Durée d’attente en secondes entre les vérifications de politiques. Par exemple, une valeur de 60 signifie que la vérification s'exécute toutes les 60 secondes.
    Remarque :
    La valeur de la checks.interval propriété remplace la valeur configurée dans ce champ.

    Type de données : nombre
    monitored_ci_group Nom des groupes CMDB associés à la politique.

    Ce champ n’est appliqué que si la valeur de la monitored_ci_type_group propriété est vraie.

    Type de données : chaîne

    Table : Groupes CMDB [cmdb_group]
    monitored_ci_script Script pour la surveillance des CI.

    Ce champ n’est appliqué que si la valeur de la policies.monitored_ci_type_script propriété est vraie.

    Type de données : chaîne
    monitored_ci_type_filter Marqueur indiquant si le filtrage par type de CI est activé. Le type de CI est répertorié dans la table propriété.
    Valeurs valides :
    • vrai : le filtrage par groupe de vérifications est activé.
    • faux : le filtrage par groupe de vérifications est désactivé.

    Type de données : booléennes
    monitored_ci_type_group Marqueur indiquant si la surveillance par type de groupe CMDB est activée.
    Valeurs valides :
    • vrai : le type de groupe CMDB est activé.
    • faux : le type de groupe CMDB est désactivé.

    Type de données : booléennes
    monitored_ci_type_script Marqueur indiquant si le script de surveillance des CI est activé.
    Valeurs valides :
    • vrai : le script de surveillance des CI est activé.
    • faux : le script de surveillance des CI est désactivé.

    Type de données : booléennes
    nom Nom de la politique.

    Type de données : chaîne
    Table Champ de type CI surveillé de la politique. Ce champ n’est appliqué que si la monitored_ci_type_filter valeur est vraie.

    Type de données : chaîne

    En-têtes

    Les en-têtes de demande et de réponse suivants s'appliquent à cette action HTTP uniquement ou s'appliquent à cette action d'une manière distincte. Pour obtenir la liste des en-têtes généraux utilisés dans l’API REST, consultez En-têtes d’API REST pris en charge.

    Tableau 167. En-têtes de demandes
    En-tête Description
    Accepter Format de données du corps de la réponse. Prend uniquement en charge application/json.
    Tableau 168. En-têtes de réponses
    En-tête Description
    Aucun

    Codes d'état

    Les codes d'état suivants s'appliquent à cette action HTTP. Pour obtenir la liste des codes d’état possibles utilisés dans l’API REST, consultez Codes de réponse HTTP de l’API REST.

    Tableau 169. Codes d'état
    Code d'état Description
    200 Réussi. La demande a été correctement traitée.
    403 L’utilisateur ne dispose pas du rôle agent_client_collector_admin.
    404 Aucun enregistrement trouvé avec la sys_id fournie.
    500 Erreur interne du serveur. Une erreur inattendue s'est produite lors du traitement de la demande. La réponse contient des informations supplémentaires sur l'erreur.

    Paramètres de corps de réponse (JSON)

    Nom Description
    message Message contenant les résultats de réussite ou d’échec de l’opération.

    Type de données : chaîne

    Demande cURL

    L’exemple suivant montre comment mettre à jour les propriétés/champs de nom et de filtre d’une politique.

    curl "https://instance.service-now.com/api/sn_agent/agents/update/policy/<policy_sys_id>" \--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
  \"name\" : \"new policy name\",
  \"filter\" : \"operational_status=1\"
}" \
--user 'username':'password'

    Sortie :

    {
  "message": "Operation was successful"
}