ServiceNow CLI Verfügbare Befehle

Zürich erstellt oder ändert Anwendungen

Release

zurich

ft:locale

de-DE

ft:publication_title

Zürich erstellt oder ändert Anwendungen

ft:clusterId

cadev

bundleId

cadev

workflow

Development, Data, and Analytics

ServiceNow CLI Verfügbare Befehle

Freigeben Version: Zurich

Aktualisiert 31. Juli 2025

9 Minuten Lesedauer

Befehle und Befehlsargumente, die für das Basissystem verfügbar sind ServiceNow CLI.

Globale Befehlsargumente

Verwenden Sie Befehlsargumente, um Optionen für CLI-Befehle festzulegen.

--help

Stellt Hilfeinformationen für den angegebenen Befehl bereit, einschließlich Beschreibung, unterstützter Argumente und Beispiele. Weitere Informationen finden Sie unter Hilfe zu ServiceNow CLI erhalten.

$ snc --help

--debug

Stellt bei der Ausführung eines Befehls eine Debug-Protokollierungsausgabe bereit. Weitere Informationen finden Sie unter Hilfe zu ServiceNow CLI erhalten.

$ snc record delete --table incident --sysid 552c48888c033300964f4932b03eb092 --debug

--Profile

Gibt das benannte Profil an, das für einen Befehl verwendet werden soll. Weitere Informationen finden Sie unter Konfigurieren und Verwalten von ServiceNow CLIVerbindungsprofile.

$ snc configure profile set --profile <profilename>

--Ausgabe

Gibt das Ausgabeformat an, das für einen Befehl verwendet werden soll. Die ServiceNow CLIUnterstützt die folgenden Ausgabeformate.

json : Die Ausgabe ist als JSON formatiert. Dies ist der Standard.


{
   "default": {
      "appversion": "1.0.8",
      "host": "https://myinstance.service-now.com",
      "hostversion": "Paris",
      "loginmethod": "basic",
      "output": "json",
      "username": "admin"
   },
   "user1": {
      "appversion": "1.0.8",
      "host": "https://otherinstance.service-now.com",
      "hostversion": "Paris",
      "loginmethod": "basic",
      "output": "yaml",
      "username": "admin"
   }
}

yaml : Die Ausgabe ist als YAML formatiert. Verwenden Sie YAML, um die Ausgabe mit Services und Tools zu verarbeiten, die YAML-formatierte Zeichenfolgen ausgeben oder verbrauchen.

default:
   appversion: 1.0.8
   host: https://myinstance.service-now.com
   hostversion: Paris
   loginmethod: basic
   output: json
   username: admin
user1:
   appversion: 1.0.8
   host: https://otherinstance.service-now.com
   hostversion: Paris
   loginmethod: basic
   output: yaml
   username: admin

Text : Die Ausgabe ist als mehrere Zeilen mit tabulatorgetrennten Zeichenfolgenwerten formatiert. Verwenden Sie diese Ausgabe mit traditionellen UNIX-Texttools wie grep, sed und awk und der Textverarbeitung, die von PowerShell ausgeführt wird.
```
default   https://myinstance.service-now.com   Paris   1.0.8   basic   admin   json 
user1   https://otherinstance.service-now.com   Paris   1.0.8   basic   admin   yaml
```

Tabelle : Die Ausgabe ist als Tabelle formatiert, die die Informationen in einem visuell lesbaren Format darstellt.

NAME   HOST   HOST   VERSION   APP   VERSION   LOGIN   METHOD   USERNAME   OUTPUT 
-------------------------------------------------------------------------------
default   myinstance   Paris   1.0.8   basic   admin   json 
user1   otherinstance   Paris   1.0.8   basic   admin   yaml

Keine : Die CLI druckt die Ausgabe nicht an die Konsole. Erfolgs-, Fehler- und Fortschrittsmeldungen werden weiterhin angezeigt.

$ snc record query --table incident --query ‘active=true’ --output json

--no-interactive

Verhindert, dass die CLI den Anwender zur Eingabe von Argumentwerten auffordert. Wenn der Anwender keinen Wert für ein erforderliches Argument übergibt, verwendet das System den Standardwert. Wenn kein Standardwert definiert ist, löst das System einen Fehler aus.

--no-verbose

Der Befehl wird automatisch ohne Nachrichten ausgeführt. Verwenden Sie dieses Argument in automatisierten Testszenarien.

Konfigurieren Sie das Profil

Erstellen Sie ein Verbindungsprofil, um eine Verbindung mit Ihrer Instanz herzustellen, zeigen Sie Verbindungsprofile an, aktualisieren Sie Ihre Verbindung und die verfügbaren Befehle, oder löschen Sie Profile, die Sie nicht mehr benötigen.Weitere Informationen zum Konfigurieren Ihres Profils finden Sie unter Konfigurieren und Verwalten von ServiceNow CLIVerbindungsprofile.

Richten Sie ein Standardprofil ein

Erstellen Sie ein Verbindungsprofil, das ServiceNow CLIVerwendet standardmäßig. Sie müssen ein Standardprofil erstellen, um die anfängliche Verbindung der CLI mit einer Instanz einzurichten.

$ snc configure profile set

Das System fordert Sie zur Eingabe der folgenden Informationen auf:


Angeforderte Informationen	Beschreibung
Host	Der Hostname der Instanz, mit der eine Verbindung hergestellt werden soll. Unterstützt sowohl die vollständige URL (https://my-instance.service-now.com) als auch nur den Hostnamen (my-instance).
Anmeldemethode	Die Anmeldemethode, die zum Herstellen einer Verbindung mit der Instanz verwendet werden soll. Unterstützt `Standard` , `OAuth` , Und `OAuth + MFA` .
Anwendername	Der Anwendername, der zum Herstellen einer Verbindung mit der Instanz verwendet werden soll.
Passwort	Das Passwort, das für die Verbindung mit der Instanz verwendet werden soll.
Client-ID	Die Client-ID, die zum Herstellen einer Verbindung mit der Instanz verwendet werden soll, wenn die Anmeldemethode OAuth oder OAuth + MFA ist.
Geheimer Clientschlüssel	Das geheime Clientgeheimnis, das zum Herstellen einer Verbindung mit der Instanz verwendet werden soll, wenn die Anmeldemethode OAuth oder OAuth + MFA ist.
Authentifizierungscode	Der Authentifizierungscode, der für die Verbindung mit der Instanz verwendet werden soll, wenn die Anmeldemethode OAuth + MFA ist.
Standardausgabeformat	Gibt an, wie die Befehlsergebnisse formatiert werden sollen. Optionen sind `json` , `yaml` , `Text` , Und `Tabelle` .

Richten Sie ein benanntes Profil ein

Erstellen Sie ein benanntes Verbindungsprofil, das mit bestimmten Befehlen verwendet werden soll. Auf diese Weise können Sie eine andere Instanz oder ein anderes Verbindungsprotokoll für einen bestimmten Befehl angeben.

$ snc configure profile set [--profile profile-name]

Das System fordert Sie zur Eingabe der folgenden Informationen auf:


Angeforderte Informationen	Beschreibung
Host	Der Hostname der Instanz, mit der eine Verbindung hergestellt werden soll. Unterstützt sowohl die vollständige URL (https://my-instance.service-now.com) als auch nur den Hostnamen (my-instance).
Anmeldemethode	Die Anmeldemethode, die zum Herstellen einer Verbindung mit der Instanz verwendet werden soll. Unterstützt `Standard` , `OAuth` , Und `OAuth + MFA` .
Anwendername	Der Anwendername, der zum Herstellen einer Verbindung mit der Instanz verwendet werden soll.
Passwort	Das Passwort, das für die Verbindung mit der Instanz verwendet werden soll.
Client-ID	Die Client-ID, die zum Herstellen einer Verbindung mit der Instanz verwendet werden soll, wenn die Anmeldemethode OAuth oder OAuth + MFA ist.
Geheimer Clientschlüssel	Das geheime Clientgeheimnis, das zum Herstellen einer Verbindung mit der Instanz verwendet werden soll, wenn die Anmeldemethode OAuth oder OAuth + MFA ist.
Authentifizierungscode	Der Authentifizierungscode, der für die Verbindung mit der Instanz verwendet werden soll, wenn die Anmeldemethode OAuth + MFA ist.
Standardausgabeformat	Gibt an, wie die Befehlsergebnisse formatiert werden sollen. Optionen sind `json` , `yaml` , `Text` , Und `Tabelle` .

Profile anzeigen

Zeigen Sie alle in der Konfigurationsdatei festgelegten Verbindungsprofile an, oder zeigen Sie Informationen zu einem bestimmten Profil an.

$ snc configure profile list [--profile profile-name]

Entfernen Sie ein Profil

Entfernen Sie ein benanntes Verbindungsprofil, das Sie nicht mehr benötigen, aus der Konfigurationsdatei.

$ snc configure profile remove [--profile profile-name]

Aktualisieren Sie ein Profil

Aktualisieren Sie die verfügbaren Befehle aus der Instanz für das angegebene Profil. Aktualisieren Sie Ihre Verbindung, nachdem Sie einen der Befehle in der entsprechenden Instanz geändert haben, um die CLI auf dem neuesten Stand zu halten.

$ snc configure profile refresh [--profile profile-name]

Führen Sie Datensatzvorgänge aus

Erstellen, lesen, aktualisieren, löschen und Abfragen von Datensätzen in Ihrer Instanz mithilfe von ServiceNow CLIBefehlszeilen-Tool. Weitere Informationen zum Ausführen von Datensatzvorgängen finden Sie unter Führen Sie Datensatzvorgänge mit aus ServiceNow CLI.

Einen Datensatz erstellen

Fügt einen einzelnen Datensatz in eine angegebene Tabelle ein.

$ snc record create [--table table --data data]

Übergeben Sie Werte für diese Argumente.


Parameter	Beschreibung
Tabelle	Erforderlich. Name der Tabelle, in der der Datensatz gespeichert werden soll.
Daten	Erforderlich. Feldname und zugeordneter Wert für jedes Feld, das im angegebenen Datensatz im JSON-Zeichenfolgenformat definiert werden soll.

Löschen Sie einen Datensatz

Löscht den angegebenen Datensatz aus der angegebenen Tabelle.

$ snc record delete [--table table --sysid sys_id]

Übergeben Sie Werte für diese Argumente.


Parameter	Beschreibung
Tabelle	Erforderlich. Name der Tabelle, in der der Datensatz gelöscht werden soll.
sysid	Erforderlich. SYS_ID des zu löschenden Datensatzes.

Ruft einen Datensatz ab

Ruft einen einzelnen Datensatz basierend auf der angegebenen sys_ID aus der angegebenen Tabelle ab.

$ snc record get [--table table --sysid sys_id]

Übergeben Sie Werte für diese Argumente.


Parameter	Beschreibung
Tabelle	Erforderlich. Name der Tabelle, aus der der Datensatz abgerufen werden soll.
sysid	Erforderlich. SYS_ID des abzurufenden Datensatzes.

Abfragedatensätze

Ruft mehrere Datensätze aus einer angegebenen Tabelle ab.

$ snc record query [--displayvalue displayValue --fields fields --limit limit --offset offset --query query --table table]

Übergeben Sie Werte für diese Argumente.


Parameter	Beschreibung
displayValue	Einbeziehen `--anzeigewert` Dient zum Abrufen des Anzeigewerts aus der Datenbank für Referenz- und Auswahlfelder. Schließen Sie diesen Parameter nicht ein, um die ist-Werte abzurufen.
Felder	Kommagetrennte Liste von Feldnamen, die von der Datenbank zurückgegeben werden sollen.
limit	Maximale Anzahl der zurückzugebenden Datensätze.
Offset	Startdatensatzindex, für den der Datensatz abgerufen werden soll. Verwenden Sie diesen Wert, um den Datensatzabruf zu paginieren.
query	Erforderlich. Codierte Abfrage, die zum Filtern des Ergebnissatzes im folgenden Format verwendet wird: `--query „<column_name> <operator> <value>“` .
Tabelle	Erforderlich. Name der Tabelle, in der die Datensätze abgefragt werden sollen.

Einen Datensatz aktualisieren

Aktualisiert den angegebenen Datensatz mit den angegebenen Datenattributen.

$ snc record update [--sysid sys_id --table table --data data]

Übergeben Sie Werte für diese Argumente.


Parameter	Beschreibung
Tabelle	Erforderlich. Name der Tabelle, in der der Datensatz gespeichert werden soll.
sysid	Erforderlich. SYS_ID des zu aktualisierenden Datensatzes.
Daten	Erforderlich. Feldname und zugeordneter Wert für jedes Feld, das im angegebenen Datensatz im JSON-Zeichenfolgenformat definiert werden soll.

Arbeiten Sie mit Erweiterungen

Fügen Sie Erweiterungen zu hinzu ServiceNow CLIUm zusätzliche Funktionen und Befehle zu laden, aktualisieren Sie vorhandene Erweiterungen, oder entfernen Sie Erweiterungen, die Sie nicht mehr benötigen. Weitere Informationen finden Sie unter Verwalten ServiceNow CLIErweiterungen.

Suchen Sie nach verfügbaren Erweiterungen

$ snc extension list-available -o table

Installieren Sie eine Erweiterung

$ snc extension add --name <extension-name>

Aktualisieren Sie eine Erweiterung

$ snc extension update --name <extension-name>

Entfernen Sie eine Erweiterung

$ snc extension remove --name <extension-name>

Verwenden Sie die ui-Komponentenerweiterung

Fügen Sie die ui-Komponentenerweiterung hinzu

Fügen Sie hinzu Erweiterung der UI-KomponenteAn ServiceNow CLI.

$ snc extension add --name ui-component

Richten Sie Ihr Projekt ein

Erstellen Sie das Komponentenprojekt und den Satz von Dateien, die zum entwickeln einer Komponente erforderlich sind. Sie können eine Verbindung zu Ihrer Instanz herstellen und einen Anwendungsbereich für Ihre Komponente erstellen oder einen Bereich reservieren, um ihn später zu verifizieren.

$ snc ui-component project [--name name --description description --scope scope --offline]

Übergeben Sie Werte für diese Argumente.


Name	Beschreibung
Name	Erforderlich. Der Projektname. Muss ein gültiger und eindeutiger NPM-Paketname sein.
Beschreibung	Die Projektbeschreibung, die in der NPM-Registrierung und in der Plugins-Liste in Ihrer Instanz verfügbar sein soll.
scope	Vorgeschlagener Anwendungsbereich, der diesem Projekt und seinen Komponenten zugewiesen werden soll. Falls angegeben, validiert die Instanz den Namen. Verwenden Sie die Richtlinien für Namespace-Bezeichner für die Anwendungsentwicklung auf der Instanz. Weitere Informationen finden Sie unter Anwendungsbereich . Maximal 18 Zeichen. Fall: Schlangenfall. Standard: `X_customerprefix_component Name` , Wobei: `Customerprefix` Ist der Wert in glide.appcreator.company.codeSystemeigenschaft in Ihrer Instanz. `komponentenname` Ist der in der Komponente angegebene Wert `Name` Parameter, wenn Sie das Projekt erstellt haben. Alternativ können Sie einen Wert zu hinzufügen `Bereichsname` Parameter in Now-ui.JSON Datei.
offline	Bei „wahr“ wird eine Komponente erstellt und erstellt, während sie von Ihrer Instanz getrennt wird. Überspringt die Validierung des angegebenen Bereichsnamens. Standard: `false`

Führen Sie den Entwicklungsserver aus

Fügen Sie Ihren Komponentencode hinzu, und testen Sie ihn mit einem lokalen Entwicklungsserver.

$ snc ui-component develop [--entry entry --open --port port --host host]

Übergeben Sie Werte für diese Argumente.


Name	Beschreibung
Eintrag	Pfad zum Testmodul in Ihrem Komponentenprojekt. Standard: Example/index.js .
offen	Öffnet den Standardbrowser und navigiert zur Testseite. Standard: Falsch.
port	Port, auf dem der Entwicklungsserver ausgeführt wird. Standard: 8081.
host	Hostadresse, die verwendet werden soll, wenn Ihr lokaler Entwicklungsserver für andere extern zugänglich sein soll. Normalerweise auf festgelegt `0.0.0.0`

Stellen Sie eine Komponente in einer Instanz bereit

Stellen Sie Ihre Komponente bereit, um sie in Ihrer Instanz als Anwendungs-Plugin anzuzeigen.

$ snc ui-component deploy [--open --force]

Übergeben Sie Werte für diese Argumente.


Name	Beschreibung
offen	Bei „wahr“ wird der Standardbrowser geöffnet und zu navigiert UI BuilderIn Ihrer Instanz. Standardwert: false
force	Stellt Komponentenänderungen bereit und überschreibt alle vorhandenen Komponentendatensätze. Standard: Falsch.