CLI da ServiceNow comandos disponíveis

Comandos e argumentos de comando disponíveis para o sistema base CLI da ServiceNow.

Argumentos de comando global

Use argumentos de comando para definir opções para qualquer comando da CLI.

--help

Fornece informações de ajuda para o comando especificado, que inclui a descrição, argumentos compatíveis e exemplos. Para obter mais informações, consulte Obtenha ajuda com CLI da ServiceNow.

$ snc --help

--debug

fornece saída de log de depuração ao executar um comando. Para obter mais informações, consulte Obtenha ajuda com CLI da ServiceNow.

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

--profile

Especifica o perfil nomeado a ser usado para um comando. Para obter mais informações, consulte Configurando e gerenciando seu CLI da ServiceNowperfis de conexão.

$ snc configure profile set --profile <profilename>

--output

Especifica o formato de saída a ser usado para um comando. . CLI da ServiceNowcompatível com os seguintes formatos de saída.

• json : A saída é formatada como JSON. Este é o padrão.

  
  {
     "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"
     }
  }

• aml : A saída é formatada como YAML. Use YAML para manipular a saída com serviços e ferramentas que emitem ou consomem cadeias de caracteres formatadas em YAML.

  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

• texto : A saída é formatada como várias linhas de valores de cadeia de caracteres separados por tabulação. Use essa saída com ferramentas de texto UNIX tradicionais, como grep, sed e awk, e o processamento de texto realizado pelo PowerShell.

  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

• tabela : A saída é formatada como uma tabela que apresenta as informações em um formato legível.

  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

• nenhum : A CLI não imprime a saída no console. As mensagens de sucesso, erro e andamento ainda são exibidas.

$ snc record query --table incident --query ‘active=true’ --output json

-no-interactive

Impede que a CLI solicite ao usuário valores de argumento. Se o usuário não passar um valor para um argumento obrigatório, o sistema usará o valor padrão. Se nenhum valor padrão for definido, o sistema lançará um erro.

--no-verbose

O comando é executado silenciosamente sem mensagens. ​Use este argumento em cenários de testes automatizados.

Configure o perfil

Crie um perfil de conexão para se conectar à sua instância, exibir perfis de conexão, atualizar a conexão e os comandos disponíveis ou excluir perfis que você não precisa mais.Para obter mais informações sobre como configurar seu perfil, consulte Configurando e gerenciando seu CLI da ServiceNowperfis de conexão.

Configure um perfil padrão

Crie um perfil de conexão que seja CLI da ServiceNowusos por padrão. Você deve criar um perfil padrão para configurar a conexão inicial da CLI com uma instância.

$ snc configure profile set

O sistema solicita as seguintes informações:

Informações solicitadas	Descrição
Host	O nome do host da instância à qual se conectar. Compatível com o URL completo (https://my-instance.service-now.com) ou apenas o nome do host (my-instance).
Método de login	O método de login a ser usado para se conectar à instância. . Básico , OAuth , e. OAuth e MFA .
Nome do usuário	O nome de usuário a ser usado para se conectar à instância.
Senha	A senha a ser usada para se conectar à instância.
ID de cliente	O ID do cliente a ser usado para se conectar à instância quando o método de login for OAuth ou OAuth e MFA.
Segredo do cliente	O segredo do cliente a ser usado para se conectar à instância quando o método de login for OAuth ou OAuth e MFA.
Código de autenticação	O código de autenticação a ser usado para se conectar à instância quando o método de login for OAuth e MFA.
Formato de saída padrão	Especifica como formatar os resultados do comando. As opções são json , aml , texto , e. tabela .

Configure um perfil nomeado

Crie um perfil de conexão nomeado para usar com comandos específicos. Isso permite que você especifique uma instância ou protocolo de conexão diferente para um comando específico.

$ snc configure profile set [--profile profile-name]

O sistema solicita as seguintes informações:

Informações solicitadas	Descrição
Host	O nome do host da instância à qual se conectar. Compatível com o URL completo (https://my-instance.service-now.com) ou apenas o nome do host (my-instance).
Método de login	O método de login a ser usado para se conectar à instância. . Básico , OAuth , e. OAuth e MFA .
Nome do usuário	O nome de usuário a ser usado para se conectar à instância.
Senha	A senha a ser usada para se conectar à instância.
ID de cliente	O ID do cliente a ser usado para se conectar à instância quando o método de login for OAuth ou OAuth e MFA.
Segredo do cliente	O segredo do cliente a ser usado para se conectar à instância quando o método de login for OAuth ou OAuth e MFA.
Código de autenticação	O código de autenticação a ser usado para se conectar à instância quando o método de login for OAuth e MFA.
Formato de saída padrão	Especifica como formatar os resultados do comando. As opções são json , aml , texto , e. tabela .

Perfis de exibição

Exiba todos os perfis de conexão definidos no arquivo de configuração ou exiba informações sobre um perfil específico.

$ snc configure profile list [--profile profile-name]

Remover um perfil

Remova um perfil de conexão nomeado que você não precisa mais do arquivo de configuração.

$ snc configure profile remove [--profile profile-name]

Atualize um perfil

Atualize os comandos disponíveis da instância para o perfil fornecido. Atualize sua conexão depois de modificar qualquer um dos comandos na instância correspondente para manter a CLI atualizada.

$ snc configure profile refresh [--profile profile-name]

Execute operações de registro

Crie, leia, atualize, exclua e consulte registros em sua instância usando o. CLI da ServiceNowferramenta de linha de comando. Para obter mais informações sobre como executar operações de registro, consulte Execute operações de registro usando CLI da ServiceNow.

Criar um registro

Insere um único registro em uma tabela especificada.

$ snc record create [--table table --data data]

Passe valores para estes argumentos.

Parâmetro	Descrição
tabela	Necessário. Nome da tabela na qual o registro será salvo.
dados	Necessário. O nome do campo e o valor associado de cada campo a ser definido no registro especificado no formato de cadeia de caracteres JSON.

Exclua um registro

Exclui o registro especificado da tabela especificada.

$ snc record delete [--table table --sysid sys_id]

Passe valores para estes argumentos.

Parâmetro	Descrição
tabela	Necessário. Nome da tabela na qual o registro será excluído.
sysid	Necessário. Sys_id do registro a ser excluído.

Obtenha um registro

Recupera um único registro com base no sys_id especificado da tabela especificada.

$ snc record get [--table table --sysid sys_id]

Passe valores para estes argumentos.

Parâmetro	Descrição
tabela	Necessário. Nome da tabela da qual recuperar o registro.
sysid	Necessário. Sys_id do registro a ser recuperado.

Registros de consulta

Recupera vários registros de uma tabela especificada.

$ snc record query [--displayvalue displayValue --fields fields --limit limit --offset offset --query query --table table]

Passe valores para estes argumentos.

Parâmetro	Descrição
displayValue	Incluir --displayvalue para recuperar o valor de exibição do banco de dados para campos de referência e de escolha. Não inclua este parâmetro para recuperar os valores reais.
campos	Lista separada por vírgulas de nomes de campo para retornar do banco de dados.
limite	Número máximo de registros a serem retornados.
deslocamento	Índice de registro inicial para o qual iniciar a recuperação de registros. Use este valor para paginar a recuperação de registro.
consulta	Necessário. Consulta codificada usada para filtrar o conjunto de resultados no seguinte formato: --query '<column_name> <operator> <value>' .
tabela	Necessário. Nome da tabela na qual consultar os registros.

Atualizar um registro

Atualiza o registro especificado com os atributos de dados fornecidos.

$ snc record update [--sysid sys_id --table table --data data]

Passe valores para estes argumentos.

Parâmetro	Descrição
tabela	Necessário. Nome da tabela na qual o registro será salvo.
sysid	Necessário. Sys_id do registro a ser atualizado.
dados	Necessário. O nome do campo e o valor associado de cada campo a ser definido no registro especificado no formato de cadeia de caracteres JSON.

Trabalhar com extensões

Adicione extensões ao CLI da ServiceNowpara carregar funcionalidades e comandos adicionais, atualizar extensões existentes ou remover extensões que você não precisa mais. Para obter mais informações, consulte Gerenciar CLI da ServiceNowextensões.

Encontre extensões disponíveis

$ snc extension list-available -o table

Instale uma extensão

$ snc extension add --name <extension-name>

Atualize uma extensão

$ snc extension update --name <extension-name>

Remova uma extensão

$ snc extension remove --name <extension-name>

Use a extensão de componente de iu

Adicione a extensão do componente de iu

Adicione o. extensão do componente de IUpara CLI da ServiceNow.

$ snc extension add --name ui-component

Configure seu projeto

Crie o projeto do componente e o conjunto de arquivos necessários para desenvolver um componente. Você pode se conectar à sua instância e criar um escopo de aplicação para seu componente ou reservar um escopo para verificar mais tarde.

$ snc ui-component project [--name name --description description --scope scope --offline]

Passe valores para estes argumentos.

Nome	Descrição
nome	Necessário. O nome do projeto. Deve ser um nome de pacote npm válido e exclusivo.
descrição	A descrição do projeto a ser disponibilizada no registro do npm e na lista de plug-ins na sua instância.
scope	Escopo da aplicação sugerido para atribuir a este projeto e seus componentes. Se fornecido, a instância valida o nome. Use as diretrizes do identificador de namespace para o desenvolvimento de aplicações na instância. Para obter mais informações, consulte Escopo da aplicação . Máximo: 18 caracteres. Caso: Caso de cobra. Padrão: x_customerprefix_componentname , em que: customerprefix é o valor em glide.appcreator.company.codepropriedade do sistema em sua instância. nome do componente é o valor fornecido nos componentes nome quando você criou o projeto. Como alternativa, você pode adicionar um valor ao Nome do escopo parâmetro no now-ui.json arquivo.
offline	Quando verdadeiro, cria e cria um componente enquanto desconectado da sua instância. Ignora a validação do nome do escopo fornecido. Padrão: falso .

Execute o servidor de desenvolvimento

Adicione o código do componente e teste-o usando um servidor de desenvolvimento local.

$ snc ui-component develop [--entry entry --open --port port --host host]

Passe valores para estes argumentos.

Nome	Descrição
entrada	Caminho para o módulo de teste em seu projeto de componente. Padrão: exemplo/index.js .
em aberto	Abre o navegador padrão e navega até a página de teste. Padrão: Falso.
porta	Porta em que o servidor de desenvolvimento é executado. Padrão: 8081.
Host	Endereço do host a ser usado se você quiser que seu servidor de desenvolvimento local seja acessível externamente por outras pessoas. Normalmente definido como 0.0.0.0

Implantar um componente em uma instância

Implante seu componente para exibir em sua instância como um plug-in de aplicação.

$ snc ui-component deploy [--open --force]

Passe valores para estes argumentos.

Nome	Descrição
em aberto	Quando verdadeiro, abre o navegador padrão e navega para Construtor de IUem sua instância. Padrão: falso
força	Implanta mudanças de componente e substitui todos os registros de componente existentes. Padrão: Falso.