Hilfe zu ServiceNow CLI erhalten

Sehen Sie sich verfügbare Befehle, Befehlsoptionen und Beispiele an, oder generieren Sie eine Debug-Protokollierungsausgabe.

Vorbereitungen

• ServiceNow CLI installieren
• Konfigurieren und Verwalten von ServiceNow CLIVerbindungsprofile
• Erforderliche Rolle: keine

Warum und wann dieser Vorgang ausgeführt wird

Zusätzlich zur Ausgabeoption „Debug-Protokollierung“ protokolliert die CLI alle Befehlsausführungen in einer Protokolldatei an den folgenden Orten:

• Linux und Mac: ~/.snc/.logs .
• Fenster: %USERPROFILE%\.snc\.Protokolle .

Prozedur

1. Um die verfügbaren Befehle und Argumente anzuzeigen, öffnen Sie das Befehlszeilentool Ihres Systems, und geben Sie den Befehl ein, bei dem Sie Hilfe benötigen, gefolgt von --help Argument.

   Das folgende Beispiel zeigt Hilfe für die verfügbaren Befehle der obersten Ebene an.

   $ snc --help

   Das folgende Beispiel zeigt die verfügbaren profilspezifischen Befehle an.

   $ snc configure profile --help

   Die CLI zeigt die Hilfe für den angeforderten Befehl an, die in acht Abschnitte unterteilt ist:

   Name

   Der Name des Befehls.

   Name
        set

   Beschreibung

   Die Beschreibung der Funktion des Befehls und seiner Rückgabewerte.

   Description
        Configure connection profiles. This command is interactive and will prompt you for each configuration value.

   Synopse

   Die grundlegende Syntax für die Verwendung des Befehls und seiner Optionen.

   Synopsis
        snc configure profile set [arguments]

   Verfügbare Befehle

   Die unter der aktuellen Befehlsgruppe verfügbaren Befehle.

   Available Commands
    list    : Lists the configured connection profiles.
    refresh : Updates the available commands from the instance for the given profile.
    remove  : Removes the specified connection profile.
    set     : Configures connection profiles in order to communicate with an instance.

   Befehlsgruppen

   Die unter der aktuellen Befehlsgruppe verfügbaren Befehlsgruppen.

   Command Groups
        profile : Set, view, and remove connection profiles.

   Argumente

   Eine Beschreibung der einzelnen Argumente, die der Befehl akzeptiert.

   Arguments
        -p, --profile string : Use a specific connection profile when executing a command.

   Globale Argumente

   Die globalen Argumente, die der Befehl akzeptiert.

   Global Arguments
        -d, --debug Print logs to console.
        -h, --help Display detailed help information.
        -o, --output string Set the format for printing command output.

   Beispiele

   Beispiele für den angeforderten Befehl.

   Examples
      Create a new profile to save as the default:
         $ snc configure profile set
            Host:
            Login method:
            Username:
            Password:
            Client id:
            Client secret:

2. Um eine Debug-Protokollierungsausgabe zu generieren, öffnen Sie das Befehlszeilentool Ihres Systems, und geben Sie den Befehl ein, den Sie debuggen möchten, gefolgt von --debug Argument.

   Das folgende Beispiel generiert eine Debug-Protokollierungsausgabe, wenn versucht wird, den Vorgang auszuführen.

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

   Die CLI generiert bei der Ausführung des Befehls eine Debug-Protokollierungsausgabe.