ServiceNow CLI verfügbare Befehle

Washington DC Anwendungen erstellen oder ändern

Release

washingtondc

ft:locale

de-DE

ft:publication_title

Washington DC Anwendungen erstellen oder ändern

ft:clusterId

cadev

bundleId

cadev

workflow

Creator

ServiceNow CLI verfügbare Befehle

Freigeben Version: Washingtondc

Aktualisiert 1. Februar 2024

8 Minuten Lesedauer

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

Globale Befehlsargumente

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

--help

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

$ snc --help

--debug

stellt beim Ausführen 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 Sie Ihre ServiceNow CLI -Verbindungsprofile.

$ snc configure profile set --profile <profilename>

--output

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

json: Die Ausgabe wird als JSON formatiert. Dies ist die Standardeinstellung.


{
   "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 wird 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 wird als mehrere Zeilen mit durch Tabulatoren getrennten Zeichenfolgenwerten formatiert. Verwenden Sie diese Ausgabe mit herkömmlichen UNIX-Textwerkzeugen wie grep, sed und awk und der von PowerShell durchgeführten Textverarbeitung.
```
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
```

table: Die Ausgabe wird als Tabelle formatiert, die die Informationen in einem für Menschen 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 gibt die Ausgabe nicht an die Konsole aus. Erfolgs-, Fehler- und Fortschrittsmeldungen werden weiterhin angezeigt.

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

--no-interactive

Verhindert, dass die CLI den Benutzer zur Eingabe von Argumentwerten auffordert. Wenn der Benutzer keinen Wert für ein erforderliches Argument übergibt, verwendet das System den Standardwert. Wenn kein Standardwert definiert ist, gibt 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 zu Ihrer Instanz herzustellen, Verbindungsprofile anzuzeigen, Ihre Verbindung und verfügbare Befehle zu aktualisieren oder nicht mehr benötigte Profile zu löschen. Weitere Informationen zum Konfigurieren Ihres Profils finden Sie unter Konfigurieren und verwalten Sie Ihre ServiceNow CLI -Verbindungsprofile.

Richten Sie ein Standardprofil ein

Erstellen Sie ein Verbindungsprofil, das standardmäßig von ServiceNow CLI verwendet wird. 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 `Basic`, `OAuth`und `OAuth + MFA`.
Benutzername	Der Benutzername, der für die Verbindung mit der Instanz verwendet werden soll.
Passwort	Das für die Verbindung mit der Instanz zu verwendende Passwort.
Client-ID	Die Client-ID, die für die Verbindung mit der Instanz verwendet werden soll, wenn die Anmeldemethode OAuth oder OAuth + MFA lautet.
Geheimer Clientschlüssel	Der geheime Clientschlüssel, der für die Verbindung mit der Instanz verwendet wird, wenn die Anmeldemethode OAuth oder OAuth + MFA ist.
Authentifizierungscode	Der für die Verbindung mit der Instanz zu verwendende Authentifizierungscode, wenn die Anmeldemethode OAuth + MFA lautet.
Standardausgabeformat	Gibt an, wie die Befehlsergebnisse formatiert werden sollen. Optionen sind `json`, `yaml`, `text`und `table`.

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 `Basic`, `OAuth`und `OAuth + MFA`.
Benutzername	Der Benutzername, der für die Verbindung mit der Instanz verwendet werden soll.
Passwort	Das für die Verbindung mit der Instanz zu verwendende Passwort.
Client-ID	Die Client-ID, die für die Verbindung mit der Instanz verwendet werden soll, wenn die Anmeldemethode OAuth oder OAuth + MFA lautet.
Geheimer Clientschlüssel	Der geheime Clientschlüssel, der für die Verbindung mit der Instanz verwendet wird, wenn die Anmeldemethode OAuth oder OAuth + MFA ist.
Authentifizierungscode	Der für die Verbindung mit der Instanz zu verwendende Authentifizierungscode, wenn die Anmeldemethode OAuth + MFA lautet.
Standardausgabeformat	Gibt an, wie die Befehlsergebnisse formatiert werden sollen. Optionen sind `json`, `yaml`, `text`und `table`.

Zeigen Sie Profile an

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 durch

Erstellen, lesen, aktualisieren, löschen und fragen Sie Datensätze in Ihrer Instanz mit dem Befehlszeilentool ServiceNow CLI ab. 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 der zugehörige 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	`Schließen Sie --displayvalue` ein, um den Anzeigewert aus der Datenbank für Referenz- und Auswahlfelder abzurufen. Schließen Sie diesen Parameter nicht ein, um die tatsächlichen Werte abzurufen.
Felder	Kommagetrennte Liste von Feldnamen, die aus 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 der zugehörige Wert für jedes Feld, das im angegebenen Datensatz im JSON-Zeichenfolgenformat definiert werden soll.

Arbeiten Sie mit Erweiterungen

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

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-Component-Erweiterung

Fügen Sie die UI-Komponentenerweiterung hinzu

Fügen Sie Erweiterung der UI-Komponente zu ServiceNow CLIhinzu .

$ 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 Sie können einen Bereich reservieren, um ihn später zu überprüfen.

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

Übergeben Sie Werte für diese Argumente.


Name	Beschreibung
Name	Erforderlich. Projektname. Muss ein gültiger und eindeutiger NPM-Paketname sein.
Beschreibung	Die Projektbeschreibung, die in der npm-Registrierung und der Plugin-Liste in Ihrer Instanz verfügbar sein soll.
scope	Vorgeschlagener Anwendungsbereich, der diesem Projekt und seinen Komponenten zugewiesen werden soll. Wenn angegeben, validiert die Instanz den Namen. Verwenden Sie die Richtlinien für Namespace-Bezeichner für die Anwendungsentwicklung in der Instanz. Weitere Informationen finden Sie unter Anwendungsbereich. Maximum: 18 Zeichen. Fall: Schlangenfall. Standard: `x_customerprefix_componentname`, wobei Folgendes gilt: `customerprefix` ist der Wert in der Systemeigenschaft glide.appcreator.company.code in Ihrer Instanz. `componentname` ist der Wert, der im `Namensparameter` der Komponente angegeben wurde, als Sie das Projekt erstellt haben. Alternativ können Sie dem Parameter `scopeName` in der Datei now-ui.json einen Wert hinzufügen. Weitere Informationen finden Sie unter Ändern Sie den Anwendungsbereich einer Komponente.
offline	Bei „true“ wird eine Komponente erstellt und ein Gerüst erstellt, während die Verbindung zu Ihrer Instanz getrennt ist. Ü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: beispiel/index.js.
offen	Öffnet den Standardbrowser und navigiert zur Testseite. Standard: false.
port	Port, an dem der Entwicklungsserver ausgeführt wird Standard: 8081.
host	Zu verwendende Hostadresse, wenn Ihr lokaler Entwicklungsserver von extern für andere zugänglich sein soll. In der Regel auf `0.0.0.0`festgelegt

Stellen Sie eine Komponente in einer Instanz bereit

Stellen Sie die Komponente bereit, die in Ihrer Instanz als Anwendungs-Plugin angezeigt werden soll.

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

Übergeben Sie Werte für diese Argumente.


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