Obtenha ajuda com ServiceNow CLI

Consulte os comandos, opções de comando e exemplos disponíveis ou gere uma saída de registro em log de depuração.

Antes de Iniciar

• Instalar o ServiceNow CLI
• Configure e gerencie seus perfis de conexão ServiceNow CLI
• Função necessária: none

Por Que e Quando Desempenhar Esta Tarefa

Além da opção de saída de log de depuração, a CLI registra todas as execuções de comando em um arquivo de log nos seguintes locais:

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

Procedimento

1. Para ver os comandos e argumentos disponíveis, abra a ferramenta de linha de comando do sistema e insira o comando com o qual você precisa de ajuda, seguido pelo argumento --help.

   O exemplo a seguir exibe a ajuda para os comandos de nível superior disponíveis.

   $ snc --help

   O exemplo a seguir exibe os comandos específicos de perfil disponíveis.

   $ snc configure profile --help

   A CLI exibe a ajuda para o comando solicitado dividida em oito seções:

   Nome

   O nome do comando.

   Name
        set

   Descrição

   A descrição do que o comando faz e seus valores de retorno.

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

   Sinopse

   A sintaxe básica para usar o comando e suas opções.

   Synopsis
        snc configure profile set [arguments]

   Comandos disponíveis

   Os comandos disponíveis no grupo de comando atual.

   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.

   Grupos de comandos

   Os grupos de comandos disponíveis no grupo de comandos atual.

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

   Argumentos

   Uma descrição de cada um dos argumentos que o comando aceita.

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

   Argumentos globais

   Os argumentos globais que o comando aceita.

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

   Exemplos

   Exemplos do comando solicitado.

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

2. Para gerar saída de log de depuração, abra a ferramenta de linha de comando do sistema e insira o comando que você deseja depurar, seguido pelo argumento --debug.

   O exemplo a seguir gera a saída de log de depuração ao tentar executar a operação.

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

   A CLI gera saída de log de depuração ao executar o comando.