Discovery-CLI-Befehle
Eine Liste der Befehle, die für die Befehlszeilenschnittstelle Discovery (CLI) in der Anwendung Musterdesigner Erweiterungen verfügbar sind.
Apps im Store anfordern
Besuchen Sie die ServiceNow Store-Website, um alle verfügbaren Apps anzuzeigen und Informationen zum Senden von Anforderungen an den Store zu erhalten. Kumulative Informationen zum Release für alle veröffentlichten Apps finden Sie in den Release-Hinweisen zum ServiceNow Store-Versionsverlauf.
Discovery-Einblicke
Ruft Details zu Ihren Discovery-Konfigurationen und -Mustern ab. Die Details umfassen Informationen zu anwenderdefinierten Mustern, Instanzdetails und Plugin-Details.
- Befehlsgruppe
- Übergeordnete Gruppe: Discovery
- Erforderliche Rollen
- discovery_admin
- Befehlsstruktur
snc discovery discovery-insights- Beispiel
- Rufen Sie Details zu Ihren Discovery-Konfigurationen und -Mustern ab, indem Sie den folgenden Befehl ausführen:
Der Befehl gibt ein Objekt JSON (Standardformat) zurück, das die Informationen in der folgenden Tabelle enthält.snc discovery discovery-insightsTabelle : 1. Vom Befehl „discovery-insights“ zurückgegebene JSON-Objekte Objekt Details anwenderdefinierte MusterPatternName: Name des anwenderdefinierten Mustersz.Quelle: Speicherort, an dem die anwenderdefinierten Changes enthalten sind (z. B. Standard)
instanceDetailsbuildDate: Datum des Instanzerstellung (Format: MM-TT-JJJJ_HHMM)buildName: Name des Instanz-Builds
pluginDetailsPlugins, die zur Discovery-Konfiguration gehören oder zum Ausführen CLIvon erforderlich sind. - Rückgabewert
✔ 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" } }
„get-discovery-credentials“
Ruft die Liste der Discovery-Anmeldeinformationen ab.
- Befehlsgruppe
- Übergeordnete Gruppe: Discovery
- Erforderliche Rollen
- discovery_admin
- Befehlsstruktur
snc discovery get-discovery-credentials [arguments]- Argument:
--testableonly: Enthält nur Anmeldeinformationen, die getestet werden können. Mögliche Werte: true oder false.- Beispiele
- Rufen Sie eine Liste der Discovery-Anmeldeinformationen ab, indem Sie den folgenden Befehl ausführen:
snc discovery get-discovery-credentialsListen Sie nur testbare Discovery-Anmeldeinformationen auf, indem Sie den Befehl mit dem folgenden Argument ausführen:snc discovery get-discovery-credentials --testableonly="true" - Rückgabewert
✔ 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
- Statusfilterung
- Geräteeinschluss
- Protokolle der ECC-Warteschlangen (External Communication Channel).
- Musterprotokolle
- Auswahlmöglichkeiten für Ausgabeformate
- Befehlsgruppe
- Übergeordnete Gruppe: Discovery
- Erforderliche Rollen
- discovery_admin
- Befehlsstruktur
snc discovery get-discovery-logs [arguments]- Argumente
Tabelle : 2. Argumente für den Befehl „get-discovery-logs“. Argument Beschreibung --status-idDiscovery-Statusnummer, nach der Protokolle gefiltert werden sollen. --devicesEnthält gerätespezifische Protokolle. Mögliche Werte: true oder false. --ecc-queue-logsEnthält zugehörige ECC-Warteschlangenprotokolle. Mögliche Werte: true oder false. --pattern-logsEnthält Musterausführungsprotokolle. Mögliche Werte: true oder false. --pattern-log-levelMaximaler Schweregrad für die Filterung von Musterprotokollen. Verfügbare Optionen: - DEBUG: Enthält nur DEBUG-Protokollnachrichten (Standard)
- FEHLER: Enthält FEHLER- und DEBUG-Nachrichten
- WARN: Enthält WARN-, ERROR- und DEBUG-Nachrichten
- INFO: Schließt alle Nachrichten ein
--log-limitMaximale Anzahl der zurückzugebenden Protokolldatensätze liegt zwischen 1 und 100 (Standard: 100). Gilt nur für ECC-Warteschlangen und Musterprotokolle. --AusgabeformatAusgabeformat für die Protokolle. Unterstützte Formate sind JSON (Standardformat) oder Tabelle. - Beispiele
- Rufen Sie Discovery-Protokolle ab, indem Sie den folgenden Befehl ausführen:
Passen Sie den Protokollabruf an, indem Sie die Argumente entweder einzeln oder als einzelnen Befehl einfügen.snc discovery get-discovery-logs [options]- So führen Sie den Befehl mit einem Argument nach dem anderen aus:
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 - So führen Sie den Befehl als einzelnen Befehl aus:
snc discovery get-discovery-logs --status-id="DIS0010013" --ecc-queue-logs="true" --devices="true" --pattern-logs="true" --output-format="json"
- So führen Sie den Befehl mit einem Argument nach dem anderen aus:
- Rückgabewert
✔ 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-midserver
Ruft detaillierte Informationen zu MID Serversab, einschließlich Status- und Validierungsdetails. Optional können Sie Problemprotokolle MID Servers in die Ausgabe aufnehmen.
- Befehlsgruppe
- Übergeordnete Gruppe: Discovery
- Erforderliche Rollen
- discovery_admin
- Befehlsstruktur
snc discovery get-midservers [arguments]- Argument
--include-issues: Schließt Problemprotokolle mit jedem MID-Serverein. Mögliche Werte: „true“ oder „false“ (Standard: true).- Beispiel
- Rufen Sie Details zu MID Servers ab, indem Sie den folgenden Befehl ausführen:
Rufen Sie eine Liste von MID Servers und die zugehörigen Problemprotokolle ab, indem Sie den Befehl mit dem folgenden Argument ausführen:snc discovery get-midserverssnc discovery get-midservers --include-issues=true - Rückgabewert
✔ 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
Ruft eine umfassende Liste von Befehlen ab, die einem angegebenen Discovery-Muster zugeordnet sind, identifiziert durch seinen Namen oder seine sys_id.
- Befehlsgruppe
- Übergeordnete Gruppe: Discovery
- Erforderliche Rollen
- discovery_admin
- Befehlsstruktur
snc discovery get-pattern-commands [arguments]- Argument
--pattern: Mustername oder sys_id- Beispiele
- Rufen Sie eine Liste von Befehlen ab, die dem angegebenen Muster zugeordnet sind, indem Sie den Befehl entweder mit dem Musternamen oder der sys_id ausführen.
- Führen Sie den Befehl aus, indem Sie den Musternamen
Windows OS – Servereingeben:snc discovery get-pattern-commands --pattern="Windows OS - Servers" - Führen Sie den Befehl aus, indem Sie das Muster sys_id
670e55a4db702200c06776231f961942eingeben:snc discovery get-pattern-commands --pattern="670e55a4db702200c06776231f961942"
- Führen Sie den Befehl aus, indem Sie den Musternamen
- Rückgabewert
✔ 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
Ruft eine umfassende Liste der verfügbaren Discovery-Muster ab.
- Befehlsgruppe
- Übergeordnete Gruppe: Discovery
- Erforderliche Rollen
- discovery_admin
- Befehlsstruktur
snc discovery get-patterns- Beispiel
- Rufen Sie eine Liste der verfügbaren Discovery-Muster ab, indem Sie den folgenden Befehl ausführen:
snc discovery get-patterns - Rückgabewert
✔ 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
Führt verschiedene Aktionen für MID Serversaus, z. B. Anhalten, Fortsetzen oder Neustarten.
- Befehlsgruppe
- Übergeordnete Gruppe: Discovery
- Erforderliche Rollen
- discovery_admin
- Befehlsstruktur
snc discovery midserver-action [arguments]- Argumente
Tabelle : 3. Argumente für den Befehl „midserver-action“. Argument Beschreibung -moder--mid-serverName oder sys_id des MID-Server -aoder--actionAktion, die für MID-Serverausgeführt werden soll. Verfügbare Optionen: - für ungültig erklären
- resume
- Stoppen
- pause
- autoUpgrade
- Upgrade
- restart
- „file_discovery_refresh“
- GRAB_logs
- validieren
- Beispiel
- Führen Sie eine -Aktion für MID-Server mit dem folgenden Befehl aus:
Starten Sie MID-Serversnc discovery midserver-action [options]WinMidServerneu, indem Sie den folgenden Befehl ausführen:snc discovery midserver-action --mid-server="WinMidServer" --action="restart" - Rückgabewert
✔ Successfully submitted mid-server action { "Action": "restart", "MidServer": "cb8d1625c3fdb110c72691477d01312e", "Output": "Mid server restart in-progress." } ✔ Mid server action executed successfully restart executed successfully.
Schnell-Discovery
Führt eine Schnell-Discovery für ein angegebenes Configuration Item (CI) oder eine angegebene IP-Adresse aus.
✗ Discovery Failed.
{
"CurrentActivity": "",
"DiscoveryStatus": {},
"State": "Active"
}Die Meldung gibt an, dass die Anzahl der Rückrufwiederholungen überschritten wurde, die Erkennung jedoch fehlgeschlagen ist, aber weiterhin im Hintergrund ausgeführt wird. Überprüfen Sie die Discovery-Protokolle, indem Sie entweder den Befehl snc discovery get-discovery-logs ausführen oder die Instanz ServiceNow® auf Aktualisierungen des Discovery-Status überprüfen.- Befehlsgruppe
- Übergeordnete Gruppe: Discovery
- Erforderliche Rollen
- discovery_admin
- Befehlsstruktur
snc discovery quick-discovery [arguments]- Argumente
Tabelle : 4. Argumente für die Befehls-Schnell-Discovery Argument Beschreibung --typeZiel-Hosttyp: entweder IP oder CI. --targetDetails des Zielhosts. - IP: IP-Adresse
- CI: Die verfügbaren Optionen sind:
- Name
- Sys_id
- Seriennummer
--error-logs-onlyEnthält nur Fehlerprotokolle. Mögliche Werte: „true“ oder „false“ (Standard: true). - Beispiele
- Führen Sie eine Schnell-Discovery für eine Zielentität anhand eines angegebenen Kriteriums aus.
snc discovery quick-discovery- Führen Sie eine Schnell-Discovery für die IP-Adresse
192.168.1.100aus, indem Sie den folgenden Befehl und das folgende Argument ausführen:snc discovery quick-discovery --type="ip" --target="192.168.1.100" - Führen Sie eine Schnell-Discovery für das angegebene CI aus, indem Sie den Befehl mit dem Namen, sys_id oder der Seriennummer ausführen.
- Geben Sie Folgendes ein, um eine Schnell-Discovery für den CI-Namen
eCommerce001auszuführen:snc discovery quick-discovery --type="ci" --target="ecommerce001" - Um eine Schnell-Discovery für das CI sys_id
d0e8761137201000deeabfc8bcbe5da7auszuführen, geben Sie Folgendes ein:snc discovery quick-discovery --type="ci" --target="d0e8761137201000deeabfc8bcbe5da7" - Um eine Schnell-Discovery für die CI-Seriennummer
L3BB911auszuführen, geben Sie Folgendes ein:snc discovery quick-discovery --type="ci" --target="L3BB911"
- Geben Sie Folgendes ein, um eine Schnell-Discovery für den CI-Namen
- Führen Sie eine Schnell-Discovery für die IP-Adresse
- Rückgabewert
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" }
run-command
Führt Befehle auf Remotegeräten mit den angegebenen Anmeldeinformationen, Zielen und MID Serversaus.
- Befehlsgruppe
- Übergeordnete Gruppe: Discovery
- Erforderliche Rollen
- discovery_admin
- Befehlsstruktur
snc discovery run-command [arguments]- Argumente
Tabelle : 5. Argumente für den Befehl „run-command“. Argument Beschreibung --BefehlAuszuführender Befehl --command-typeAuszuführender Vorgangstyp. --credentialAnmeldeinformationen, die zum Ausführen des Befehls verwendet werden. --midserverName von MID-Server, der für die Kommunikation mit dem Ziel verwendet wird. --os-serverCI-Klasse, die das Serverbetriebssystem darstellt, unter dem die Befehle ausgeführt werden sollen. Geben Sie beispielsweise cmdb_ci_linux_server für den Server Linux ein. --targetHost-IP-Adresse, auf der Sie den Befehl ausführen möchten. - Beispiel
- Führen Sie den folgenden Befehl aus, damit die Abfrage von Windows Management Instrumentation (
WMI) das System auffordert, die Eigenschaften UUID und IdentifyingNumber aus der Klasse Win32_ComputerSystemProduct im Namespace \root\CIMV2 abzurufen: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" - Rückgabewert
✔ 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-Discovery-Anmeldeinformationen
Validiert die Discovery-Anmeldeinformationen anhand eines angegebenen Zielsystems mithilfe eines festgelegten MID-Server. Der Befehl überprüft nur die Bereitschaft der Anmeldeinformationen für Netzwerk-Discovery-Aufgaben. Die Konfiguration der Discovery-Anmeldeinformationen oder des Zielsystems wird dadurch nicht geändert oder beeinflusst.
Dieser Befehl erfordert, dass eine bestimmte XML-Datei in die Liste „Modulzugriffsrichtlinie“ importiert wurde. Weitere Informationen finden Sie im Artikel Discovery CLI [KB1553142] in der Now Support Knowledge Base.
- Befehlsgruppe
- Übergeordnete Gruppe: Discovery
- Erforderliche Rollen
- discovery_admin
- Befehlsstruktur
snc discovery test-discovery-credential [arguments]- Argumente
Tabelle : 6. Argumente für „test-discovery-credential“. Argument Beschreibung --dbnameName der Datenbank, für die diese Anmeldeinformationen getestet werden sollen. --dbtypeTyp der Datenbank, für die diese Anmeldeinformationen getestet werden sollen. Verfügbare Optionen: - MSSQL: für Microsoft SQL Server
- MySQL
- Oracle
--icfName der JNDI-Klasse (Java Benennungs- und Verzeichnisschnittstelle), die zum Erstellen des InitialContext verwendet wird. Der Name der JNDI-Klasse muss zuerst den Paketnamen und dann den Klassennamen enthalten. Um beispielsweise eine Verbindung zur Klasse ActiveMQ JNDI herzustellen, geben Sie Folgendes ein: org.apache.activemq.jndi.ActiveMQInitialContextFactory.--midserverName von MID-Server, der für diesen Test verwendet werden soll. Zum Testen Windows der -Anmeldeinformationen müssen Sie Windows MID-Serververwenden. --nameName des Berechtigungsnachweises --portPort des Ziels, der für diesen Test verwendet werden soll. Das System füllt dieses Feld vorab mit dem Standardport für den ausgewählten Anmeldeinformationstyp aus. --targetZielhost, auf dem diese Anmeldeinformationen ausgeführt werden. Dieser Wert muss für alle Anmeldeinformationstypen außer VMwareeine IP-Adresse sein, für die der Wert die Host-URL sein kann. - Beispiel
- Testen Sie die Discovery-Anmeldeinformationen
WinCredfür MID-ServerWinMidServer, indem Sie den folgenden Befehl ausführen:
Der Befehl gibt eine Erfolgsmeldung zurück, wenn die folgenden Bedingungen erfüllt sind:snc discovery test-discovery-credential --name="WinCred" --target="192.168.1.1" --midserver="WinMidServer"- Die Anmeldeinformationen sind gültig
- Die Verbindung zum Zielsystem wurde erfolgreich hergestellt
- Der angegebene MID-Server ist betriebsbereit
- Rückgabewert
✔ Discovery credentials tested successfully Credential Test Id [ecc-sys-id]: "2b36e40ec3727990c72691477d0131c6" ✔ The credential test is complete { "output": "Test Succeeded" }
Weitere Informationen zu Discovery CLIfinden Sie im Artikel Discovery-CLI [KB1553142] in der Now Support Knowledge Base.