CLI da ServiceNow
. CLI da ServiceNowé uma interface de linha de comando que permite executar operações de instância do seu sistema local. Você pode estender a CLI para incluir novos comandos que atendam às necessidades da sua aplicação.
Benefícios
. CLI da ServiceNowpermite que você:
- Execute operações básicas de CRUD em registros em sua instância.
- Desenvolva componentes personalizados e implante-os em sua instância para personalizar uma IU.
- Crie comandos personalizados que permitem gerenciar aplicações personalizadas a partir da linha de comando.
- Use o. CLI da ServiceNowem scripts para simplificar tarefas de configuração e atividades operacionais.
Arquitetura
Os comandos são armazenados em uma tabela na instância à qual você está conectado. Quando CLI da ServiceNowconecta-se à instância e recebe todos os comandos disponíveis compatíveis com essa instância.
Os comandos são mapeados para um endpoint REST que é executado de forma assíncrona. Para obter mais informações, consulte Crie um comando personalizado em CLI da ServiceNow.
Ativando CLI da ServiceNow
Instale CLI da ServiceNow solicitando-o do ServiceNow Store. Acesse o site ServiceNow Store para ver todos os aplicativos disponíveis e obter informações sobre como enviar solicitações para a loja. Para obter informações sobre notas de versão cumulativa para todos os aplicativos liberados, consulte as ServiceNow Store notas de versão do histórico de versão.
Arquivo de configuração
. CLI da ServiceNowarmazena informações de perfil em um config.json arquivo que, por padrão, é armazenado em seu diretório inicial no seguinte caminho:
- Linux e Mac: /.snc/config.json
- Windows: USERPROFILE%.snc/config.json
A CLI usa esse arquivo para determinar quais informações usar para se conectar a uma instância e quais configurações usar para gerar saída. Por padrão, o. CLI da ServiceNowusa as configurações encontradas em padrão perfil para se conectar a uma instância. Para usar configurações alternativas, você pode criar e fazer referência a adicionais nomeado perfis. Para obter mais informações, consulte Configurando e gerenciando seu CLI da ServiceNowperfis de conexão.
O exemplo a seguir mostra um arquivo de configuração com um perfil padrão e um perfil nomeado. Cada perfil pode usar credenciais diferentes e especificar hosts e formatos de saída diferentes.
{
"profiles":{
"default":{
"host":"https://myinstance.service-now.com",
"loginmethod":"basic",
"username":"admin",
"output":"json",
"hostversion":"Paris",
"appversion":"1.0"
},
"user1":{
"host":"https://otherinstance.service-now.com",
"loginmethod":"basic",
"username":"user1",
"output":"yaml",
"hostversion":"Paris",
"appversion":"1.0"
}
}
}Estrutura de comando
CLI da ServiceNow os comandos seguem esta estrutura:
- A chamada de base para
sncprograma. - O grupo de comando de nível superior seguido por todos os grupos de comando secundários.
- O comando que especifica qual operação executar.
- Argumentos gerais da CLI exigidos pela operação. Você pode especificar argumentos em qualquer ordem.
$ snc <command-group> <command> [arguments]Os argumentos podem aceitar vários tipos de valores de entrada, como números, cadeias de caracteres e objetos JSON. Os tipos compatíveis dependem do comando especificado.
Valores de argumento
Muitos valores de argumento no CLI da ServiceNowsão cadeia de caracteres simples ou valores numéricos, como a tabela e o nome da tabela no exemplo a seguir.
$ snc record create --table incident --data "{short_description: 'New Incident'}"Você pode cercar cadeias de caracteres que não contenham caracteres de espaço com aspas ou não. No entanto, você deve usar aspas ao redor de cadeias de caracteres que incluam um ou mais caracteres de espaço.
Formatos de saída
. CLI da ServiceNowcompatível com quatro 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: admintexto: 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 yamltabela: 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 yamlnenhum: A CLI não imprime a saída no console. As mensagens de sucesso, erro e andamento ainda são exibidas.
Você pode especificar a saída do comando de duas maneiras:
- Use o.
saídaem um perfil nomeado no arquivo de configuração - O exemplo a seguir define o formato de saída padrão como texto.
{ "profiles":{ "default":{ "output":"text" } } - Use o.
--outputargumento na linha de comando - O exemplo a seguir define a saída de um único comando como JSON. Esta opção no comando substitui qualquer valor definido no momento no arquivo de configuração.
$ snc record query --table incident --query ‘active=true’ --output json