Crie um comando personalizado em CLI da ServiceNow
Gerencie sua aplicação personalizada na linha de comando criando comandos personalizados no CLI da ServiceNow.
Antes de Iniciar
Função necessária: administrador
Por Que e Quando Desempenhar Esta Tarefa
Procedimento
-
Disponibilize um endpoint REST para um CLI da ServiceNowcomando.
- Navegar até CLI (Command Line Interface, interface de linha de comando) > Endpoints.
-
Selecione Novo e preencha o formulário.
Campo Descrição Caminho do recurso Necessário. Caminho para o endpoint na instância para mapear um comando. Pode ser o caminho para uma REST API de entrada ou uma REST API com script. Por exemplo, api/now/table/(tabela)/(sysid). Para obter mais informações, consulte REST APIs disponíveis e. REST com script .Método HTTP Necessário. Método HTTP a ser usado quando o usuário executa o comando associado. Aplicação Escopo da aplicação somente leitura para o endpoint.
- Opcional:
Crie um grupo de comando.
Como alternativa, você pode adicionar seu novo comando a um grupo de comando existente.
- Navegar até CLI (Command Line Interface, interface de linha de comando) > Grupos de comandos.
-
Selecione Novo e preencha o formulário.
Campo Descrição Nome Necessário. Nome do grupo de comando. Grupo primário Grupo de comando primário. Grupo de referência Grupo de comando a ser referenciado. Por exemplo, você pode criar um novo grupo de comando como um alias para um grupo de comando existente. Quando o usuário chama um comando referenciado usando o novo grupo de comandos, o comando original é executado. Isso permite que você crie um grupo de comandos específico para sua aplicação personalizada que inclui comandos novos e existentes. Descrição resumida Necessário. Descrição resumida do grupo de comando. Descrição Descrição do grupo de comando usado como texto de ajuda quando o usuário executa o. --helpno grupo de comando.Aplicação Escopo da aplicação somente leitura para o grupo de comando. Ativo Quando selecionado, o grupo de comando fica ativo.
-
Crie um comando.
- Navegar até CLI (Command Line Interface, interface de linha de comando) > Comandos.
-
Selecione Novo e preencha o formulário.
Campo Descrição Nome Necessário. Nome do comando. Grupo de comandos Necessário. Grupo de comando do qual o comando faz parte. Comando de referência Comando para referência. Por exemplo, você pode criar um novo comando como um alias para um comando existente. Quando o usuário chama o novo comando, o comando original é executado. Isso permite que você crie um comando específico para sua aplicação personalizada que executa a funcionalidade existente. Nota:Um comando não pode fazer referência a um comando que faz referência a outro comando ou a um comando descendente, um comando ancestral ou um comando de retorno de chamada.endpoint da API Necessário. Chamada de API a ser executada quando o usuário executa o comando. Descrição resumida Necessário. Descrição resumida do comando. Aplicação Escopo da aplicação somente leitura para o comando. Ativo Quando selecionado, o comando fica ativo. É um comando de retorno de chamada Quando verdadeiro, designa o comando como um comando de retorno de chamada. Selecione esta opção para ocultar o comando do cliente de CLI e impedir que os usuários o chamem a partir da linha de comando. Use este campo com Retorno de chamada seção de um comando primário. O comando de retorno de chamada é executado quando o comando primário é concluído.
Texto de ajuda Descrição Descrição do comando usado como texto de ajuda quando o usuário executa o. --helpcomando.Exemplos Exemplos do comando usado como texto de ajuda quando o usuário executa o. --helpcomando.Expressões Expressão que indica êxito Expressão usada para avaliar a resposta do servidor e determinar se o comando foi bem-sucedido. Por exemplo, código.resultado: 1.Expressão de falha Expressão usada para avaliar a resposta do servidor e determinar se o comando falhou. Mensagens Mensagem de Sucesso Mensagem exibida no cliente de CLI quando o comando é bem-sucedido. Mensagem de andamento Mensagem exibida no cliente de CLI quando o comando está em andamento. Mensagem de falha Mensagem exibida no cliente de CLI quando o comando falha. Retorno de chamada Expressão do retorno de chamada Expressão usada para determinar se o comando de retorno de chamada deve ser executado. Por exemplo, você pode escrever uma expressão que verifica um processo de execução longa. Se a expressão produzir um determinado resultado, o retorno de chamada será executado. Comando de retorno de chamada Comando a ser executado quando Expressão de retorno de chamada está satisfeito. Deve ser um comando com É o comando de retorno de chamada campo selecionado. Intervalo do retorno de chamada O intervalo entre as execuções do comando de retorno de chamada. Unidade: Milissegundos
Padrão: 1 000
Máximo de novas tentativas Número máximo de vezes que o comando de retorno de chamada é executado. Padrão: 10
-
Nas listas relacionadas Argumentos de comando, crie todos os argumentos de comando necessários para o comando.
Crie um argumento de comando para permitir que os usuários definam opções ao executar um comando.
Campo Descrição Nome Necessário. Nome do argumento do comando, por exemplo dados.Nome Curto dama curta do argumento de comando, por exemplo d.Tipo de dados Necessário. Tipo de dados esperado para o argumento de comando. As opções incluem: - Cadeia de caracteres: Permite que os usuários insiram uma cadeia de caracteres como entrada.
- Inteiro: Permite que os usuários insiram um número como entrada.
- Booliano: Permite que os usuários insiram
verdadeirooufalsocomo entrada. - Entrada de arquivo: Permite que os usuários carreguem um arquivo como entrada. Mapeie este argumento para um corpo Tipo de parâmetro Na lista relacionada Argumentos do endpoint da API na próxima etapa. Os usuários podem passar texto simples, YAML, JSON ou outro tipo de arquivo aceito pela REST API. Por padrão, quando o usuário envia um arquivo YAML, o cliente de CLI é convertido em arquivo para o formato JSON. Use o. Ignorar o pré-processamento campo para desabilitar este comportamento.
- Senha: Permite que os usuários insiram uma senha com segurança como entrada.
Nota:Para tipos de dados de entrada de arquivo, o limite de tamanho de arquivo é de 10 MB por padrão. No entanto, você altera esse limite usando glide.rest.scripted.max_inbound_content_length_mbpropriedade do sistema.Ignorar o pré-processamento Defina este sinalizador para impedir que o cliente de CLI converta arquivos YAML no formato JSON antes de enviá-los na solicitação. Quando Tipo de dados está definido como Entrada de arquivo E o usuário envia um arquivo YAML, o cliente de CLI converte o arquivo em JSON antes de executar o comando por padrão. Nota:Aplica-se somente quando Tipo de dados está definido como Entrada de arquivo .Valor padrão Valor padrão a ser usado quando o usuário não passar um valor. Descrição resumida Necessário. Descrição resumida do argumento do comando. Usado como texto de ajuda quando o usuário executa o. --helpcomando.Aplicação Escopo da aplicação somente leitura para o argumento. Comando Necessário. Comando ao qual o argumento se aplica. Obrigatório Quando selecionado, o usuário deve fornecer um valor para o argumento ao executar o comando associado. Aviso Prompt para solicitar informações do usuário. A CLI solicita informações quando o usuário não inclui um argumento obrigatório em um comando. Expressão de visibilidade Expressão usada para determinar se a CLI deve solicitar o argumento. Normalmente usado para exibir um argumento com base no valor fornecido a um argumento anterior. Ordem Ordem na qual solicitar o argumento. -
Nas listas relacionadas Argumentos do endpoint da API, crie todos os argumentos de endpoint da API necessários para o comando.
Mapeie argumentos de comando da lista relacionada Argumentos de comando para parâmetros no endpoint REST.
Campo Descrição Nome Necessário. Nome do argumento. Valor Necessário. O valor do comando que você deseja passar para o endpoint REST. Você pode passar um valor estático ou uma expressão como (flags.table). Use o.sinalizadoresvariável global para acessar os argumentos do comando.Tipo de Parâmetro Necessário. O tipo de parâmetro no endpoint REST para o qual você deseja passar Valor para. Por exemplo, se você selecionar Corpo , A CLI passa o valor de Valor Para o corpo do endpoint REST. As opções incluem: - Corpo
- Cabeçalho
- Caminho
- Consulta
Aplicação Escopo da aplicação somente leitura para o argumento. Comando Necessário. Comando ao qual o argumento se aplica. -
Nas listas relacionadas Valores de retorno, crie todos os valores de retorno necessários para o comando.
Crie valores de retorno para retornar somente determinadas chaves da resposta.
Campo Descrição Expressão do caminho Necessário. Expressão que representa o caminho para a chave que você deseja retornar. Alias Nome da variável para atribuir o valor de retorno. Aplicação Escopo da aplicação somente leitura para o comando. Comando Necessário. Comando ao qual o valor de retorno se aplica.