Commandes de l’interface de ligne de commande de découverte

Liste des commandes disponibles pour l’interface Découverte de ligne de commande (CLI) dans l’application Concepteur de modèle Améliorations.

Demander des applications dans l'App Store

Visitez le site Web ServiceNow Store pour découvrir toutes les applications disponibles et pour obtenir des informations sur la procédure à suivre pour soumettre des demandes à la boutique. Pour obtenir des informations sur les notes de publication cumulatives pour toutes les applications publiées, consultez les ServiceNow Storenotes de publication relatives à l'historique des versions.

aperçus de découverte

Récupère les détails de vos configurations et modèles de détection. Vous y trouverez notamment des informations sur les modèles personnalisés, les détails des instances et les détails du module d’extension.

Groupe de commandes

Groupe parent : découverte

Rôles requis

discovery_admin

Si vous utilisez un service lié à Découverte, vous devez disposer des rôles requis pour ce service.

Structure de commande

snc discovery discovery-insights

Exemple

Récupérez les détails de vos configurations et modèles de découverte en exécutant la commande suivante :

snc discovery discovery-insights

La commande renvoie un JSON objet (format par défaut) contenant les informations de la table suivante.

Tableau 1. Objets JSON retournés à partir de la commande discovery-insights

Objet	Détails
customizedPatterns	patternName : nom du modèle personnalisé source : emplacement où les changements personnalisés sont contenus (par exemple, Par défaut)
instanceDetails	buildDate : date de génération de l’instance (format : MM-JJ-YYYY_HHMM) buildName : nom de la version de l’instance
pluginDetails	Modules d’extension liés à la configuration de Découverte ou nécessaires à l’exécution CLI.

Valeur de retour

✔ Discovery diagnostics successfully completed.
{
   "customizedPattern": [
      {
         "patternName": "A10",
         "source": "Default"
      },
      {
         "patternName": ".NET Application",
         "source": "Default"
      }
   ],
   "instanceDetails": {
      "buildDate": "09-16-2023_2010",
      "buildName": "utah-p0"
   },
   "pluginDetails": {
      "CMDB CI Class Models": "1.48",
      "Discovery and Service Mapping Patterns": "1.8.0",
      "Pattern Designer Enhancements": "3.1.0",
      "Visibility Content": "6.13.0"
   }
}

obtenir des informations d’identification de découverte

Récupère la liste des informations d’identification de découverte.

Groupe de commandes

Groupe parent : découverte

Rôles requis

discovery_admin

Si vous utilisez un service lié à Découverte, vous devez disposer des rôles requis pour ce service.

Structure de commande

snc discovery get-discovery-credentials [arguments]

Argument:

--testableonly : inclut uniquement les informations d’identification qui peuvent être testées. Valeurs possibles : vrai ou faux.

Exemples

Récupérez une liste des informations d’identification de découverte en exécutant la commande suivante :

snc discovery get-discovery-credentials

Répertoriez uniquement les informations d’identification de découverte testables en exécutant la commande avec l’argument suivant :

snc discovery get-discovery-credentials --testableonly="true"

Valeur de retour

✔ Get only testable credentials [ssh, snmpv3, snmp, ssh_private_key, windows, vmware, jdbc, jms]: true
✔ Discovery credentials details retrieved
{
   "credentials": [
      {
         "active": true,
         "name": "shCred",
         "type": "ssh",
         "updated": "2023-10-16 10:57:27"
      },
      {
         "active": true,
         "name": "WindowsCred",
         "type": "windows",
         "updated": "2023-10-10 12:18:17"
      },
      {
         "active": true,
         "name": "Azure",
         "type": "azure",
         "updated": "2022-10-19 05:57:21"
      },
      {
         "active": true,
         "name": "public",
         "type": "snmp",
         "updated": "2023-09-28 07:40:35"
      },
      {
         "active": true,
         "name": "Windows MID Server Service Account",
         "type": "windows",
         "updated": "2023-10-16 10:57:23"
      },
      …
   ]
}

get-discovery-logs

Récupère les journaux de découverte avec des options flexibles, notamment :

• Filtrage de statut
• Inclusion de l’appareil
• Journaux de file d’attente ECC (canal de communication externe)
• Journaux de modèles
• Choix de formats de sortie

Groupe de commandes

Groupe parent : découverte

Rôles requis

discovery_admin

Si vous utilisez un service lié à Découverte, vous devez disposer des rôles requis pour ce service.

Structure de commande

snc discovery get-discovery-logs [arguments]

Arguments

Tableau 2. Arguments en faveur de la commande get-discovery-logs

Argument	Description
--status-id	Numéro de statut de découverte par lequel filtrer les journaux.
--Dispositifs	Inclut des journaux spécifiques à l’appareil. Valeurs possibles : vrai ou faux.
--ecc-queue-logs	Inclut les journaux de file d’attente ECC associés. Valeurs possibles : vrai ou faux.
--journaux de modèle	Inclut des journaux d’exécution de modèles. Valeurs possibles : vrai ou faux.
--modèle-niveau-journal	Niveau de gravité maximum par lequel filtrer les journaux de modèle. Les options disponibles sont les suivantes : DÉBOGAGE : inclut uniquement les messages du journal de débogage (par défaut) ERREUR : inclut les messages d’erreur et de débogage WARN : inclut les messages WARN, ERROR et DEBUG INFO : inclut tous les messages
--limite-journal	Nombre maximal d’enregistrements de journal à renvoyer, entre 1 et 100 (100 par défaut). S’applique uniquement aux journaux de modèle et de file d’attente ECC.
--format de sortie	Format de sortie pour les journaux. Les formats pris en charge sont JSON (format par défaut) ou table.

Exemples

Récupérez les journaux de découverte en exécutant la commande suivante :

snc discovery get-discovery-logs [options]

Personnalisez la récupération du journal en incluant les arguments un par un ou sous la forme d’une seule commande.

• Pour exécuter la commande un argument à la fois :

  snc discovery get-discovery-logs
  Discovery status number: DIS0010013
  Include Devices: true
  Include ECC Queue logs: true
  Include pattern execution logs: true
  Pattern max log level (INFO, WARN, ERROR, DEBUG): DEBUG
  Maximum number of log records to return: 100
  Output format [supported: json(default), table]: json

• Pour exécuter la commande en tant que commande unique :

  snc discovery get-discovery-logs --status-id="DIS0010013" --ecc-queue-logs="true" --devices="true" --pattern-logs="true" --output-format="json"

Si le nombre maximal d’enregistrements de journal à renvoyer est élevé, envisagez d’utiliser un format de sortie de table.

Valeur de retour

✔ Discovery Status details retrieved
{
   "Devices": [
      {
         "CMDBCI": "",
         "ClassificationProbe": "Windows - Classify",
         "Completed": "4",
         "CompletedActivity": "Updated CI",
         "Created": "2023-10-17 09:25:33",
         "CurrentActivity": null,
         "Issues": "0",
         "ScanStatus": "Completed 4",
         "Started": "4",
         "Status": "DIS0010136"
      }
   ],
   "DiscoveryLogs": [
      {
         "CI": "",
         "Created": "2023-10-17 09:25:24",
         "Device": "",
         "ECCQueueInput": "",
         "Level": "0",
         "Message": "Discovery started",
         "Source": "Discovery",
         "Status": "DIS0010136"
      },
      {
         "CI": "",
         "Created": "2023-10-17 09:26:49",
         "Device": "192.168.1.100",
         "ECCQueueInput": "HorizontalDiscoveryProbe",
         "Level": "0",
         "Message": "Exploring CI Pattern, Pattern name: Windows OS - Servers",
         "Source": "DiscoverySensor",
         "Status": "DIS0010136"
      },
      {
         "CI": "",
         "Created": "2023-10-17 09:27:01",
         "Device": "192.168.1.100",
         "ECCQueueInput": "",
         "Level": "0",
         "Message": "Discovery completed",
         "Source": "Discovery",
         "Status": "DIS0010136"
      }
   ],
   "DiscoveryStatus": [
      {
         "Completed": "5",
         "Created": "2023-10-17 09:25:24",
         "Description": "Discover Now",
         "Discover": "CIs",
         "Duration": "1970-01-01 00:01:37",
         "Number": "DIS0010136",
         "Schedule": "WinServer",
         "Started": "5",
         "State": "Completed",
         "Updated": "2023-10-17 09:27:08"
      }
   ],
…
}

get-midservers

Récupère des informations détaillées sur , y compris des détails d’état Serveurs MIDet de validation. Vous pouvez éventuellement inclure Serveurs MID des journaux des problèmes dans la sortie.

Groupe de commandes

Groupe parent : découverte

Rôles requis

discovery_admin

Si vous utilisez un service lié à Découverte, vous devez disposer des rôles requis pour ce service.

Structure de commande

snc discovery get-midservers [arguments]

Argument

--include-issues : Inclut des journaux de problèmes avec chaque Serveur MIDfichier . Valeurs possibles : vrai ou faux (par défaut : vrai).

Exemple

Récupérez les Serveurs MID détails le en exécutant la commande suivante :

snc discovery get-midservers

Récupérez une liste et leurs journaux de Serveurs MID problèmes en exécutant la commande avec l’argument suivant :

snc discovery get-midservers --include-issues=true

Valeur de retour

✔ MID Server details were fetched successfully.
{
   "mid_servers": [
      {
         "home_directory": "C:\\Users\\admin\\Desktop\\midInstallationFolder\\agent",
         "host_name": "LocalLab",
         "host_os_version": "10.0.xxxx",
         "ip_address": "192.168.0.1",
         "issues": [],
         "last_refreshed": "2023-10-01 00:00:00",
         "name": "WindowsMidServer",
         "started": "2023-10-01 00:01:01",
         "status": "Up",
         "sys_id": "cb8d1625c3fdb110c72691477d01312e",
         "unresolved_issues": "0",
         "validated": "true",
         "validated_at": "2023-10-01 00:01:01"
      }
   ]
}

get-pattern-commands

Récupère une liste complète des commandes associées à un modèle de détection spécifié, identifié par son nom ou son sys_id.

Groupe de commandes

Groupe parent : découverte

Rôles requis

discovery_admin

Si vous utilisez un service lié à Découverte, vous devez disposer des rôles requis pour ce service.

Structure de commande

snc discovery get-pattern-commands [arguments]

Argument

--pattern : nom ou sys_id du modèle

Exemples

Récupérez une liste des commandes associées au modèle spécifié en exécutant la commande avec le nom du modèle ou le sys_id.

• Exécutez la commande en entrant le nom du modèle Système d’exploitation Windows : serveurs :

  snc discovery get-pattern-commands --pattern="Windows OS - Servers"

• Exécutez la commande en saisissant le modèle sys_id 670e55a4db702200c06776231f961942 :

  snc discovery get-pattern-commands --pattern="670e55a4db702200c06776231f961942"

Valeur de retour

✔ Commands fetched successfully. 
[
   {
      "Command": "\"\\root\\CIMV2\" \"SELECT Caption,IPAddress,MACAddress,DHCPEnabled,Index,InterfaceIndex,IPEnabled FROM Win32_NetworkAdapterConfiguration\"",
      "Command Type": "wmi",
      "sys_id": "2e677c4ec3adb1106618b10ad0013185"
   },
   {
      "Command": "\"\\root\\CIMV2\" \"SELECT Index,InterfaceIndex,Name,Manufacturer,NetConnectionID FROM Win32_NetworkAdapter\"",
      "Command Type": "wmi",
      "sys_id": "6a677c4ec3adb1106618b10ad0013185"
   },
   {
      "Command": "powershell -command \\Get-NetRoute -AddressFamily IPv6\\",
      "Command Type": "shell",
      "sys_id": "a6677c4ec3adb1106618b10ad0013185"
   },
   {
      "Command": "\"\\root\\CIMV2\" \"SELECT Destination,Mask,NextHop, InterfaceIndex FROM Win32_IP4RouteTable\"",
      "Command Type": "wmi",
      "sys_id": "e2677c4ec3adb1106618b10ad0013185"
   },
   {
      "Command": "\"\\root\\CIMV2\" \"SELECT DefaultIPGateway FROM Win32_NetworkAdapterConfiguration\"",
      "Command Type": "wmi",
      "sys_id": "e6677c4ec3adb1106618b10ad00131ab"
   },
…
]

get-patterns

Récupère une liste complète des modèles de détection disponibles.

Groupe de commandes

Groupe parent : découverte

Rôles requis

discovery_admin

Si vous utilisez un service lié à Découverte, vous devez disposer des rôles requis pour ce service.

Structure de commande

snc discovery get-patterns

Exemple

Récupérez une liste des modèles de détection disponibles en exécutant la commande suivante :

snc discovery get-patterns

Valeur de retour

✔ Details of Discovery Patterns successfully retrieved.
[
   {
      "active": true,
      "ci_type": "cmdb_ci_appl_dot_net",
      "name": ".NET Application",
      "pattern_type": "1 - Application"
   },
   {
      "active": true,
      "ci_type": "cmdb_ci_lb_service",
      "name": "A10",
      "pattern_type": "1 - Application"
   },
   {
      "active": true,
      "ci_type": "cmdb_ci_lb_a10",
      "name": "A10 Load Balancer",
      "pattern_type": "3 - Infrastructure"
   },
   {
      "active": true,
      "ci_type": "cmdb_ci_lb_a10",
      "name": "A10 Load Balancer SSH",
      "pattern_type": "3 - Infrastructure"
   },
   {
      "active": true,
      "ci_type": "cmdb_ci_appl_generic",
      "name": "A10 SSH Hosting Formatting",
      "pattern_type": "2 - Shared library"
   },
   …
]

MIDSERVER-action

Exécute diverses actions sur Serveurs MID, par exemple : arrêter, reprendre ou redémarrer.

Groupe de commandes

Groupe parent : découverte

Rôles requis

discovery_admin

Si vous utilisez un service lié à Découverte, vous devez disposer des rôles requis pour ce service.

Structure de commande

snc discovery midserver-action [arguments]

Arguments

Tableau 3. Arguments en faveur de la commande midserver-action

Argument	Description
-m ou --mid-server	Nom ou sys_id du Serveur MID
-a ou --action	Action à effectuer sur le Serveur MID. Les options disponibles sont les suivantes : invalider reprendre stop mise en pause autoUpgrade mise à niveau restart file_discovery_refresh grab_logs valider

Exemple

Effectuez une action sur un Serveur MID avec la commande suivante :

snc discovery midserver-action [options]

Redémarrez Serveur MID WinMidServer en exécutant la commande suivante :

snc discovery midserver-action --mid-server="WinMidServer" --action="restart"

Valeur de retour

✔ Successfully submitted mid-server action
{
   "Action": "restart",
   "MidServer": "cb8d1625c3fdb110c72691477d01312e",
   "Output": "Mid server restart in-progress."
}

✔ Mid server action executed successfully
restart executed successfully.

Découverte rapide

Exécute une découverte rapide par rapport à un élément de configuration (CI) ou une adresse IP spécifié.

Remarque :

Lorsque les nouvelles tentatives de rappel dépassent la limite maximale, vous pouvez recevoir le message d’erreur suivant :

✗ Discovery Failed.
{
"CurrentActivity": "",
"DiscoveryStatus": {},
"State": "Active"
}

Le message indique que les nouvelles tentatives de rappel ont été dépassées. Bien que la détection ait échoué, elle est toujours en cours d’exécution en arrière-plan. Vérifiez les journaux de découverte en exécutant la commande snc discovery get-discovery-logs ou en consultant l’instance ServiceNow® pour les mises à jour du statut de découverte.

Groupe de commandes

Groupe parent : découverte

Rôles requis

discovery_admin

Si vous utilisez un service lié à Découverte, vous devez disposer des rôles requis pour ce service.

Structure de commande

snc discovery quick-discovery [arguments]

Arguments

Tableau 4. Arguments en faveur de la détection rapide de commande

Argument	Description
--type	Type d’hôte cible : IP ou CI.
--cible	Détails de l’hôte cible. IP : adresse IP CI : les options disponibles sont les suivantes : Nom Sys_id Numéro de série
--journaux-d’erreurs uniquement	Inclut uniquement les journaux d’erreurs. Valeurs possibles : true ou false (par défaut : true).

Exemples

Exécutez une découverte rapide par rapport à une entité cible à l’aide d’un critère spécifié.

snc discovery quick-discovery

• Exécutez une détection rapide par rapport à l’adresse IP 192.168.1.100 en exécutant la commande et l’argument suivants :

  snc discovery quick-discovery --type="ip" --target="192.168.1.100"

• Exécutez une découverte rapide par rapport au CI spécifié en exécutant la commande avec le nom, le sys_id ou le numéro de série.
  • Pour exécuter une découverte rapide par rapport au CI nom ecommerce001, entrez :

    snc discovery quick-discovery --type="ci" --target="ecommerce001"

  • Pour exécuter une détection rapide par rapport au CI sys_id d0e8761137201000deeabfc8bcbe5da7, saisissez :

    snc discovery quick-discovery --type="ci" --target="d0e8761137201000deeabfc8bcbe5da7"

  • Pour exécuter une découverte rapide par rapport au L3BB911 du numéro de série CI, entrez :

    snc discovery quick-discovery --type="ci" --target="L3BB911"

Valeur de retour

snc discovery quick-discovery --type="ip" --target="192.168.1.100"
✔ Discovery job submitted
Status Number: DIS0010054
✔ Discovery is complete
{
   "DiscoveryLogs": [],
   "DiscoveryStatus": [
      {
         "Completed": "5",
         "Created": "2023-10-17 10:59:52",
         "Description": "Discover CI",
         "Discover": "CIs",
         "Duration": "1970-01-01 00:01:41",
         "Number": DIS0010054,
         "Schedule": "",
         "Started": "5",
         "State": "Completed",
         "Updated": "2023-10-17 11:02:06"
      }
   ],
   "State": "Completed"
}

exécuter-commande

Exécute des commandes sur des équipements distants à l’aide des informations d’identification, des cibles et Serveurs MID.

Groupe de commandes

Groupe parent : découverte

Rôles requis

discovery_admin

Si vous utilisez un service lié à Découverte, vous devez disposer des rôles requis pour ce service.

Structure de commande

snc discovery run-command [arguments]

Arguments

Tableau 5. Arguments en faveur de la commande run-command

Argument	Description
--commander	Commande à exécuter.
--type_commande	Type d’opération à effectuer.
--Credential	Informations d’identification utilisées pour exécuter la commande.
--MIDSERVER	Nom utilisé Serveur MID pour communiquer avec la cible.
--os-server	Classe CI qui représente le système d’exploitation du serveur (système d’exploitation du serveur) sur lequel exécuter les commandes. Par exemple, entrez cmdb_ci_linux_server pour le Linux serveur.
--cible	Adresse IP de l’hôte sur laquelle vous souhaitez exécuter la commande.

Exemple

Exécutez la commande suivante pour que la requête WMI (Windows Management Instrumentation) demande au système de récupérer les propriétés et IdentifyingNumber de la UUID classe Win32_ComputerSystemProduct dans l’espace de noms \root\CIMV2 :

snc discovery run-command --command="\"\\root\\CIMV2\" \"SELECT UUID,IdentifyingNumber FROM Win32_ComputerSystemProduct\"" --command-type="wmi" --credential="WinCred" --midserver="WinMidServer" --os-server="cmdb_ci_win_server" --target="192.168.1.1"

Valeur de retour

✔ The command is sent for execution.
{
"eccQueueOutputSysId": "9a3c55a3c33db910c72691477d0131cd"
}

✔ Command Executed Successfully...
{
"result": {
"IdentifyingNumber": "VMware-00 00 00 00 00 00 00 00-00 00 00 00 00 00 00 00",
"Name": "VMware Virtual Platform",
"Object Reference": null,
"UUID": "61410042-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Version": "None",
"__CLASS": "Win32_ComputerSystemProduct",
"internal_classname": "Win32_ComputerSystemProduct",
"internal_namespace": "root/cimv2"
}
}

test-découverte-informations d’identification

Valide les informations d’identification de découverte par rapport à un système cible spécifié à l’aide d’un Serveur MIDfichier . La commande vérifie uniquement l’état de préparation des informations d’identification pour les tâches de découverte de réseau. Elle ne modifie ni n’affecte la configuration des informations d’identification Discovery ou du système cible.

Important :

Cette commande nécessite qu’un fichier XML spécifique ait été importé dans la liste Politique d’accès au module. Pour plus d’informations, reportez-vous à l’article CLI de détection [KB1553142] dans le .Now Support Base de connaissances

Groupe de commandes

Groupe parent : découverte

Rôles requis

discovery_admin

Si vous utilisez un service lié à Découverte, vous devez disposer des rôles requis pour ce service.

Structure de commande

snc discovery test-discovery-credential [arguments]

Arguments

Tableau 6. Arguments en faveur de l’évaluation des informations d’identification de découverte

Argument	Description
--dbname	Nom de la base de données sur laquelle tester ces informations d’identification.
--dbtype	Type de base de données sur laquelle tester ces informations d’identification. Les options disponibles sont les suivantes : MSSQL : pour Microsoft SQL Server MySQL Oracle
--ICF	Nom de la classe JNDI (Java Naming and Directory Interface) utilisée pour créer InitialContext. Le nom de la classe JNDI doit inclure d’abord le nom du package, puis le nom de la classe. Par exemple, pour vous connecter à la classe ActiveMQ JNDI, saisissez : org.apache.activemq.jndi.ActiveMQInitialContextFactory.
--MIDSERVER	Nom de la Serveur MID à utiliser pour ce test. Pour tester Windows les informations d’identification, vous devez utiliser un Windows Serveur MIDfichier .
--nom	Nom des informations d'identification.
--port	Port sur la cible à utiliser pour ce test. Le système préremplit ce champ avec le port par défaut pour le type d’information d’identification sélectionné.
--cible	Hôte cible sur lequel ces informations d’identification sont exécutées. Cette valeur doit être une adresse IP pour tous les types d’informations d’identification à l’exception VMwarede , pour laquelle la valeur peut être l’URL d’hôte.

Exemple

Testez les informations d’identification de découverte WinCred par rapport à Serveur MID WinMidServer en exécutant la commande suivante :

snc discovery test-discovery-credential --name="WinCred" --target="192.168.1.1" --midserver="WinMidServer"

La commande renvoie un message de réussite lorsque les conditions suivantes sont remplies :

• Les informations d’identification sont valides
• La connexion au système cible a réussi
• Ce qui est spécifié Serveur MID est opérationnel

Si ces conditions ne sont pas remplies, un message d’erreur détaillant les problèmes s’affiche.

Valeur de retour

✔ Discovery credentials tested successfully
Credential Test Id [ecc-sys-id]: "2b36e40ec3727990c72691477d0131c6"
✔ The credential test is complete
{
   "output": "Test Succeeded"
}

Pour plus d’informations sur Découverte CLI, reportez-vous à l’article Discovery CLI [KB1553142] dans le .Now Support Base de connaissances