--- sourceDocument: Yokohama Erstellen oder ändern Sie Anwendungen sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/application-development Release : - yokohama ft:locale : - de-DE ft:publication_title : - Yokohama Erstellen oder ändern Sie Anwendungen ft:clusterId : - cadev bundleId : - cadev workflow : - Creator --- ServiceNow CLI Verfügbare Befehle ================================= ServiceNow CLI Verfügbare Befehle {#ariaid-title1} ================================================== * Freigeben Version: Yokohama * * Aktualisiert 30. Januar 2025 * * ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 8 Minuten Lesedauer Für das Basissystem ServiceNow CLIverfügbare Befehle und Befehlsargumente. Globale Befehlsargumente {#sn-cli-commands__section_orq_sps_l4b} ---------------------------------------------------------------- Verwenden Sie Befehlsargumente, um Optionen für beliebige 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](https://servicenow-prod.fluidtopics.net/nqq5nsEH_RHvch~gNZqb8Q "Sehen Sie sich verfügbare Befehle, Befehlsoptionen und Beispiele an, oder generieren Sie eine Debug-Protokollierungsausgabe."). $ snc --help --debug : stellt eine Debug-Protokollierungsausgabe bereit, wenn ein Befehl ausgeführt wird. Weitere Informationen finden Sie unter [Hilfe zu ServiceNow CLI erhalten](https://servicenow-prod.fluidtopics.net/nqq5nsEH_RHvch~gNZqb8Q "Sehen Sie sich verfügbare Befehle, Befehlsoptionen und Beispiele an, oder generieren Sie eine Debug-Protokollierungsausgabe."). $ 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 [Ihre ServiceNow CLI -Verbindungsprofile konfigurieren und verwalten](https://servicenow-prod.fluidtopics.net/adJf9eX3Ax33hEnpBSgMvg "Erstellen Sie ein Verbindungsprofil, um eine Verbindung zu Ihrer -Instanz herzustellen, zeigen Sie Verbindungsprofile an, aktualisieren Sie Ihre Verbindung und verfügbare Befehle, oder löschen Sie nicht mehr benötigte Profile."). $ snc configure profile set --profile --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 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 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 von durch Tabulatoren getrennten Zeichenfolgenwerten formatiert. Verwenden Sie diese Ausgabe mit herkömmlichen UNIX-Texttools wie grep, sed und awk sowie 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. {#sn-cli-commands__ul_iwy_c2t_l4b} $ 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 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. Profil konfigurieren {#sn-cli-commands__section_rv3_b4s_l4b} ------------------------------------------------------------ Erstellen Sie ein Verbindungsprofil, um eine Verbindung zu Ihrer -Instanz herzustellen, zeigen Sie Verbindungsprofile an, aktualisieren Sie Ihre Verbindung und verfügbare Befehle, oder löschen Sie nicht mehr benötigte Profile. Weitere Informationen zum Konfigurieren Ihres Profils finden Sie unter [Ihre ServiceNow CLI -Verbindungsprofile konfigurieren und verwalten](https://servicenow-prod.fluidtopics.net/adJf9eX3Ax33hEnpBSgMvg "Erstellen Sie ein Verbindungsprofil, um eine Verbindung zu Ihrer -Instanz herzustellen, zeigen Sie Verbindungsprofile an, aktualisieren Sie Ihre Verbindung und verfügbare Befehle, oder löschen Sie nicht mehr benötigte Profile."). Richten Sie ein Standardprofil ein : Erstellen Sie ein Verbindungsprofil, das von ServiceNow CLI standardmäßig verwendet wird. Sie müssen ein Standardprofil erstellen, um die erste Verbindung der CLI mit einer Instanz einzurichten. $ snc configure profile set Das System fordert Sie zur Eingabe der folgenden Informationen auf: {#sn-cli-commands__id_mvn_zft_l4b__entry__2} | Informationen angefordert | Beschreibung | |---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Host | Der Hostname der Instanz, zu der eine Verbindung hergestellt werden soll. Unterstützt die vollständige URL (https://my-instance.service-now.com) oder nur den Hostnamen (my-instance). | | Anmeldemethode | Die zum Herstellen einer Verbindung mit der Instanz zu verwendende Anmeldemethode. Unterstützt Basic, OAuthund OAuth + MFA. | | Anwendername | Der Anwendername, der zum Herstellen der Verbindung mit der Instanz verwendet wird. | | Passwort | Das zum Herstellen der Verbindung mit der Instanz zu verwendende Passwort. | | Client-ID | Die Client-ID, die zum Herstellen einer Verbindung mit der Instanz verwendet wird, wenn die Anmeldemethode OAuth oder OAuth + MFA verwendet wird. | | Geheimer Clientschlüssel | Der geheime Clientschlüssel für die Verbindung mit der Instanz, wenn OAuth oder OAuth + MFA als Anmeldemethode verwendet wird. | | Authentifizierungscode | Der Authentifizierungscode für die Verbindung mit der Instanz, wenn OAuth + MFA als Anmeldemethode verwendet wird. | | Standardausgabeformat | Gibt an, wie die Befehlsergebnisse formatiert werden. Optionen sind json, yaml, textund table. | [ ] {#sn-cli-commands__id_mvn_zft_l4b} Richten Sie ein benanntes Profil ein : Erstellen Sie ein benanntes Verbindungsprofil zur Verwendung mit bestimmten Befehlen. 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: {#sn-cli-commands__table_drn_ggt_l4b__entry__2} | Informationen angefordert | Beschreibung | |---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Host | Der Hostname der Instanz, zu der eine Verbindung hergestellt werden soll. Unterstützt die vollständige URL (https://my-instance.service-now.com) oder nur den Hostnamen (my-instance). | | Anmeldemethode | Die zum Herstellen einer Verbindung mit der Instanz zu verwendende Anmeldemethode. Unterstützt Basic, OAuthund OAuth + MFA. | | Anwendername | Der Anwendername, der zum Herstellen der Verbindung mit der Instanz verwendet wird. | | Passwort | Das zum Herstellen der Verbindung mit der Instanz zu verwendende Passwort. | | Client-ID | Die Client-ID, die zum Herstellen einer Verbindung mit der Instanz verwendet wird, wenn die Anmeldemethode OAuth oder OAuth + MFA verwendet wird. | | Geheimer Clientschlüssel | Der geheime Clientschlüssel für die Verbindung mit der Instanz, wenn OAuth oder OAuth + MFA als Anmeldemethode verwendet wird. | | Authentifizierungscode | Der Authentifizierungscode für die Verbindung mit der Instanz, wenn OAuth + MFA als Anmeldemethode verwendet wird. | | Standardausgabeformat | Gibt an, wie die Befehlsergebnisse formatiert werden. Optionen sind json, yaml, textund table. | [ ] {#sn-cli-commands__table_drn_ggt_l4b} Profile anzeigen : Zeigen Sie alle in der Konfigurationsdatei festgelegten Verbindungsprofile oder Informationen zu einem bestimmten Profil an. $ snc configure profile list [--profile profile-name] Entfernt 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 : Aktualisiert 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 {#sn-cli-commands__section_wbn_b4s_l4b} -------------------------------------------------------------------------- Mit dem Befehlszeilentool ServiceNow CLI können Sie Datensätze in Ihrer -Instanz erstellen, lesen, aktualisieren, löschen und abfragen. Weitere Informationen zum Ausführen von Datensatzvorgängen finden Sie unter [Führen Sie Datensatzvorgänge mit durch ServiceNow CLI](https://servicenow-prod.fluidtopics.net/6tNjOPhVdAV6wAZMJ4Qkog "Mit dem Befehlszeilentool ServiceNow CLI können Sie Datensätze in Ihrer -Instanz erstellen, lesen, aktualisieren, löschen und abfragen."). 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. {#sn-cli-commands__id_sll_wxf_m4b__entry__2} | Parameter | Beschreibung | |-----------|--------------------------------------------------------------------------------------------------------------------------------------------------| | Tabelle | Erforderlich. Name der Tabelle, in der der Datensatz gespeichert werden soll. | | Daten | Erforderlich. Feldname und der zugeordnete Wert für jedes Feld, das im angegebenen Datensatz definiert werden soll, im JSON-Zeichenfolgenformat. | [ ] {#sn-cli-commands__id_sll_wxf_m4b} 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. {#sn-cli-commands__id_dtm_cyf_m4b__entry__2} | Parameter | Beschreibung | |-----------|----------------------------------------------------------------------------| | Tabelle | Erforderlich. Name der Tabelle, in der der Datensatz gelöscht werden soll. | | sysid | Erforderlich. Sys_id des zu löschenden Datensatzes. | [ ] {#sn-cli-commands__id_dtm_cyf_m4b} Rufen Sie 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. {#sn-cli-commands__id_kfw_myf_m4b__entry__2} | Parameter | Beschreibung | |-----------|------------------------------------------------------------------------------| | Tabelle | Erforderlich. Name der Tabelle, aus der der Datensatz abgerufen werden soll. | | sysid | Erforderlich. Sys_id des abzurufenden Datensatzes. | [ ] {#sn-cli-commands__id_kfw_myf_m4b} Datensätze abfragen : 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. {#sn-cli-commands__id_b5x_qyf_m4b__entry__2} | Parameter | Beschreibung | |--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | displayValue | Fügen Sie `„--displayvalue"` hinzu, um den Anzeigewert für Referenz- und Auswahlfelder aus der Datenbank abzurufen. Fügen Sie diesen Parameter nicht ein, um die Ist-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 zum Filtern des Ergebnissatzes im folgenden Format: `--query '`\\\ " . | | Tabelle | Erforderlich. Name der Tabelle, in der die Datensätze abgefragt werden sollen. | [ ] {#sn-cli-commands__id_b5x_qyf_m4b} 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. {#sn-cli-commands__id_kj3_vyf_m4b__entry__2} | 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 zugeordnete Wert für jedes Feld, das im angegebenen Datensatz definiert werden soll, im JSON-Zeichenfolgenformat. | [ ] {#sn-cli-commands__id_kj3_vyf_m4b} Mit Erweiterungen arbeiten {#sn-cli-commands__section_s5q_b4s_l4b} ------------------------------------------------------------------ Fügen Sie ServiceNow CLI Erweiterungen 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](https://servicenow-prod.fluidtopics.net/1wYszuTNnjyCOHACYHj94Q "Fügen Sie ServiceNow CLI Erweiterungen hinzu, um zusätzliche Funktionen und Befehle zu laden, vorhandene Erweiterungen zu aktualisieren oder nicht mehr benötigte Erweiterungen zu entfernen."). Suchen Sie nach verfügbaren Erweiterungen : $ snc extension list-available -o table Installieren Sie eine -Erweiterung : $ snc extension add --name Aktualisiert eine Erweiterung : $ snc extension update --name Entfernen Sie eine Erweiterung : $ snc extension remove --name Verwenden Sie die Erweiterung UI-Component {#sn-cli-commands__section_is3_24s_l4b} ---------------------------------------------------------------------------------- Fügen Sie die Erweiterung UI-Komponente 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 für die Entwicklung einer Komponente erforderlich sind. Sie können eine Verbindung zu Ihrer -Instanz herstellen und einen Anwendungsbereich für Ihre Komponente erstellen oder einen Bereich zur späteren Überprüfung reservieren. $ snc ui-component project [--name name --description description --scope scope --offline] Übergeben Sie Werte für diese Argumente. {#sn-cli-commands__table_gsw_mbg_m4b__entry__2} | Name | Beschreibung | |-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | name | Erforderlich. Der Projektname. Muss ein gültiger und eindeutiger NPM-Paketname sein. | | description | Die Projektbeschreibung muss in der NPM-Registrierung und in der Plugins-Liste in Ihrer Instanz verfügbar sein. | | 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 in der -Instanz. Weitere Informationen finden Sie [unter Anwendungsbereich](https://servicenow-prod.fluidtopics.net/OmI_bbNsGBOXBVHXbCMs5w "Die Definition von Anwendungsbereichen schützt Anwendungen, indem der Zugriff auf Anwendungsdateien und -daten identifiziert und eingeschränkt wird."). Maximal: 18 Zeichen. Fall: Fall Standard: `x_customerprefix_componentname`, wobei: * `„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. {#sn-cli-commands__scope-params} Alternativ können Sie dem Parameter `scopeName` in der Datei now-ui.json einen Wert hinzufügen. | | offline | Bei Festlegung auf „true" wird eine Komponente erstellt und als Gerüst erstellt, während die Verbindung zu Ihrer Instanz getrennt ist. Überspringt die Validierung des angegebenen Bereichsnamens. Standard: `false` | [ ] {#sn-cli-commands__table_gsw_mbg_m4b} 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. {#sn-cli-commands__table_lnx_bzt_vkb__entry__2} | Name | Beschreibung | |---------|----------------------------------------------------------------------------------------------------------------------------------------| | Eintrag | Pfad zum Testmodul in Ihrem Komponentenprojekt. Standard: example/index.js. | | offen | Öffnet den Standardbrowser und navigiert zur Testseite. Standard: false. | | port | Port, auf dem der Entwicklungsserver ausgeführt wird. Standard: 8081. | | host | Zu verwendende Hostadresse, wenn Ihr lokaler Entwicklungsserver von extern zugänglich sein soll. Normalerweise auf `0.0.0.0`festgelegt | [ ] {#sn-cli-commands__table_lnx_bzt_vkb} Stellen Sie eine Komponente für eine Instanz bereit : Stellen Sie Ihre Komponente bereit, damit sie in Ihrer Instanz als Anwendungs-Plugin angezeigt wird. $ snc ui-component deploy [--open --force] Übergeben Sie Werte für diese Argumente. {#sn-cli-commands__table_ck1_qzt_vkb__entry__2} | Name | Beschreibung | |-------|-----------------------------------------------------------------------------------------------------------------------| | offen | Bei „true" wird der Standardbrowser geöffnet, und Sie navigieren zu UI Builder in Ihrer -Instanz. Standardwert: false | | force | Stellt Komponentenänderungen bereit und überschreibt alle vorhandenen Komponentendatensätze. Standard: false. | [ ] {#sn-cli-commands__table_ck1_qzt_vkb}