Obtenir de l'aide avec ServiceNow CLI

Consultez les commandes disponibles, les options de commande et les exemples, ou générez une sortie de journalisation de débogage.

Avant de commencer

• Installer ServiceNow CLI
• Configuration et gestion de vos ServiceNow CLI profils de connexion
• Rôle requis : aucun

Pourquoi et quand exécuter cette tâche

Outre l’option de sortie de journalisation de débogage, l’interface de ligne de commande consigne toutes les exécutions de commandes dans un fichier journal aux emplacements suivants :

• Linux et Mac : ~/.snc/.logs.
• Windows :%USERPROFILE%\.snc\.logs.

Procédure

1. Pour voir les commandes et arguments disponibles, ouvrez l’outil de ligne de commande de votre système et entrez la commande pour laquelle vous avez besoin d’aide, suivie de l’argument --aide .

   L’exemple suivant affiche de l’aide pour les commandes de niveau supérieur disponibles.

   $ snc --help

   L’exemple suivant présente les commandes disponibles spécifiques au profil.

   $ snc configure profile --help

   L’interface de ligne de commande affiche de l’aide pour la commande demandée, divisée en huit sections :

   Nom

   Le nom de la commande.

   Name
        set

   Description

   Description de la fonction de la commande et de ses valeurs de retour.

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

   Synopsis

   Syntaxe de base pour l’utilisation de la commande et de ses options.

   Synopsis
        snc configure profile set [arguments]

   Commandes disponibles

   Commandes disponibles dans le groupe de commandes actuel.

   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.

   Groupes de commande

   Les groupes de commandes disponibles sous le groupe de commande actuel.

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

   Arguments

   Description de chacun des arguments acceptés par la commande.

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

   Arguments globaux

   Les arguments globaux acceptés par la commande.

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

   Exemples

   Exemples de la commande demandée.

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

2. Pour générer une sortie de journalisation de débogage, ouvrez l’outil de ligne de commande de votre système et entrez la commande que vous souhaitez déboguer, suivie de l’argument --debug .

   L’exemple suivant génère une sortie de journalisation de débogage lors de la tentative d’exécution de l’opération.

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

   L’interface de ligne de commande génère une sortie de journalisation de débogage lors de l’exécution de la commande.