Comandos da CLI da Descoberta

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 12 min. de leitura

    • Uma lista de comandos que estão disponíveis para a Descoberta Interface de linha de comando (CLI) na aplicação Designer de padrões Melhorias.

    Solicitar aplicativos na 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.

    descobertas-insights

    Recupera detalhes sobre suas configurações e padrões de descoberta. Os detalhes incluem informações de padrão personalizado, detalhes da instância e detalhes do plug-in.

    Grupo de comandos
    Grupo primário: descoberta
    Funções necessárias
    descoberta_admin
    Se estiver usando um serviço relacionado a Descoberta, você deverá ter as funções necessárias para esse serviço.
    Estrutura de comando
    snc discovery discovery-insights
    Exemplo
    Recupere detalhes sobre suas configurações e padrões de descoberta executando o seguinte comando: 
    snc discovery discovery-insights
    O comando retorna um objeto JSON (formato padrão) que contém as informações na tabela a seguir.
    Tabela 1. Objetos JSON retornados do comando discovery-insights
    Objeto Detalhes
    personalizadoPadrões
    • padrãoNome: nome do padrão personalizadozde ed.
    • origem: local onde as mudanças personalizadas estão contidas (por exemplo, Padrão)
    instanceDetails
    • buildDate: data da criação da instância (formato: MM-DD-YYYY_HHMM)
    • buildName: nome da compilação da instância
    pluginDetails Plug-ins relacionados à configuração de descoberta ou que são necessários para executar CLI.
    Valor de retorno
    ✔ Discovery diagnostics successfully completed.
{
   "customizedPattern": [
      {
         "patternName": "A10",
         "source": "Default"
      },
      {
         "patternName": ".NET Application",
         "source": "Default"
      }
   ],
   "instanceDetails": {
      "buildDate": "09-16-2023_2010",
      "buildName": "utah-p0"
   },
   "pluginDetails": {
      "CMDB CI Class Models": "1.48",
      "Discovery and Service Mapping Patterns": "1.8.0",
      "Pattern Designer Enhancements": "3.1.0",
      "Visibility Content": "6.13.0"
   }
}

    obter-descoberta-credenciais

    Recupera a lista de credenciais de descoberta.

    Grupo de comandos
    Grupo primário: descoberta
    Funções necessárias
    descoberta_admin
    Se estiver usando um serviço relacionado a Descoberta, você deverá ter as funções necessárias para esse serviço.
    Estrutura de comando
    snc discovery get-discovery-credentials [arguments]
    Argumento:
    --testableonly: inclui somente credenciais que podem ser testadas. Valores possíveis: verdadeiro ou falso.
    Exemplos
    Recupere uma lista das credenciais de descoberta executando o seguinte comando: 
    snc discovery get-discovery-credentials
    Liste somente credenciais de descoberta testáveis executando o comando com o seguinte argumento: 
    snc discovery get-discovery-credentials --testableonly="true"
    Valor de retorno
    ✔ Get only testable credentials [ssh, snmpv3, snmp, ssh_private_key, windows, vmware, jdbc, jms]: true
✔ Discovery credentials details retrieved
{
   "credentials": [
      {
         "active": true,
         "name": "shCred",
         "type": "ssh",
         "updated": "2023-10-16 10:57:27"
      },
      {
         "active": true,
         "name": "WindowsCred",
         "type": "windows",
         "updated": "2023-10-10 12:18:17"
      },
      {
         "active": true,
         "name": "Azure",
         "type": "azure",
         "updated": "2022-10-19 05:57:21"
      },
      {
         "active": true,
         "name": "public",
         "type": "snmp",
         "updated": "2023-09-28 07:40:35"
      },
      {
         "active": true,
         "name": "Windows MID Server Service Account",
         "type": "windows",
         "updated": "2023-10-16 10:57:23"
      },
      …
   ]
}

    get-discovery-logs

    Recupera logs de descoberta com opções flexíveis, incluindo:
    • Filtragem de status
    • Inclusão de dispositivo
    • Logs da fila do canal de comunicação externa (ECC)
    • Logs de padrão
    • Opções de formato de saída
    Grupo de comandos
    Grupo primário: descoberta
    Funções necessárias
    descoberta_admin
    Se estiver usando um serviço relacionado a Descoberta, você deverá ter as funções necessárias para esse serviço.
    Estrutura de comando
    snc discovery get-discovery-logs [arguments]
    Argumentos
    Tabela 2. Argumentos para o comando get-discovery-logs
    Argumento Descrição
    --status-id Número do status da descoberta pelo qual os logs serão filtrados.
    --dispositivos Inclui logs específicos do dispositivo. Valores possíveis: verdadeiro ou falso.
    --ecc-queue-logs Inclui logs de fila do ECC associados. Valores possíveis: verdadeiro ou falso.
    --pattern-logs Inclui logs de execução de padrão. Valores possíveis: verdadeiro ou falso.
    --padrão-log-nível Nível máximo de severidade pelo qual filtrar logs de padrão. As opções disponíveis são:
    • DEBUG: inclui somente mensagens de log de DEBUG (padrão)
    • ERRO: inclui mensagens de ERRO e DEPURAÇÃO
    • WARN: inclui mensagens WARN, ERROR e DEBUG
    • INFO: inclui todas as mensagens
    --log-limit Número máximo de registros de log a serem retornados entre 1 e 100 (padrão: 100). Aplica-se somente à fila do ECC e aos logs de padrão.
    --output-format Formato de saída para os logs. Os formatos compatíveis são JSON (formato padrão) ou tabela.
    Exemplos
    Recupere logs de descoberta executando o seguinte comando:
    snc discovery get-discovery-logs [options]
    Personalize a recuperação de log incluindo os argumentos um de cada vez ou como um único comando.
    • Para executar o comando um argumento de cada vez:
      snc discovery get-discovery-logs
Discovery status number: DIS0010013
Include Devices: true
Include ECC Queue logs: true
Include pattern execution logs: true
Pattern max log level (INFO, WARN, ERROR, DEBUG): DEBUG
Maximum number of log records to return: 100
Output format [supported: json(default), table]: json
    • Para executar o comando como um único comando:
      snc discovery get-discovery-logs --status-id="DIS0010013" --ecc-queue-logs="true" --devices="true" --pattern-logs="true" --output-format="json"
    Se o número máximo de registros de log a serem retornados for alto, considere usar um formato de saída de tabela.
    Valor de retorno
    ✔ Discovery Status details retrieved
{
   "Devices": [
      {
         "CMDBCI": "",
         "ClassificationProbe": "Windows - Classify",
         "Completed": "4",
         "CompletedActivity": "Updated CI",
         "Created": "2023-10-17 09:25:33",
         "CurrentActivity": null,
         "Issues": "0",
         "ScanStatus": "Completed 4",
         "Started": "4",
         "Status": "DIS0010136"
      }
   ],
   "DiscoveryLogs": [
      {
         "CI": "",
         "Created": "2023-10-17 09:25:24",
         "Device": "",
         "ECCQueueInput": "",
         "Level": "0",
         "Message": "Discovery started",
         "Source": "Discovery",
         "Status": "DIS0010136"
      },
      {
         "CI": "",
         "Created": "2023-10-17 09:26:49",
         "Device": "192.168.1.100",
         "ECCQueueInput": "HorizontalDiscoveryProbe",
         "Level": "0",
         "Message": "Exploring CI Pattern, Pattern name: Windows OS - Servers",
         "Source": "DiscoverySensor",
         "Status": "DIS0010136"
      },
      {
         "CI": "",
         "Created": "2023-10-17 09:27:01",
         "Device": "192.168.1.100",
         "ECCQueueInput": "",
         "Level": "0",
         "Message": "Discovery completed",
         "Source": "Discovery",
         "Status": "DIS0010136"
      }
   ],
   "DiscoveryStatus": [
      {
         "Completed": "5",
         "Created": "2023-10-17 09:25:24",
         "Description": "Discover Now",
         "Discover": "CIs",
         "Duration": "1970-01-01 00:01:37",
         "Number": "DIS0010136",
         "Schedule": "WinServer",
         "Started": "5",
         "State": "Completed",
         "Updated": "2023-10-17 09:27:08"
      }
   ],
…
}

    get-midservers

    Recupera informações detalhadas sobre MID Servers, incluindo detalhes de status e validação. Opcionalmente, você pode incluir MID Servers logs de problema na saída.

    Grupo de comandos
    Grupo primário: descoberta
    Funções necessárias
    descoberta_admin
    Se estiver usando um serviço relacionado a Descoberta, você deverá ter as funções necessárias para esse serviço.
    Estrutura de comando
    snc discovery get-midservers [arguments]
    Argumento

    --include-issues: inclui logs de problemas com cada MID Server. Valores possíveis: verdadeiro ou falso (padrão: verdadeiro).

    Exemplo
    Recupere detalhes sobre MID Servers executando o seguinte comando:
    snc discovery get-midservers
    Recupere uma lista de MID Servers e seus logs de problemas executando o comando com o seguinte argumento: 
    snc discovery get-midservers --include-issues=true
    Valor de retorno
    ✔ MID Server details were fetched successfully.
{
   "mid_servers": [
      {
         "home_directory": "C:\\Users\\admin\\Desktop\\midInstallationFolder\\agent",
         "host_name": "LocalLab",
         "host_os_version": "10.0.xxxx",
         "ip_address": "192.168.0.1",
         "issues": [],
         "last_refreshed": "2023-10-01 00:00:00",
         "name": "WindowsMidServer",
         "started": "2023-10-01 00:01:01",
         "status": "Up",
         "sys_id": "cb8d1625c3fdb110c72691477d01312e",
         "unresolved_issues": "0",
         "validated": "true",
         "validated_at": "2023-10-01 00:01:01"
      }
   ]
}

    get-pattern-commands

    Recupera uma lista abrangente de comandos associados a um padrão de descoberta especificado, identificado por seu nome ou seu sys_id.

    Grupo de comandos
    Grupo primário: descoberta
    Funções necessárias
    descoberta_admin
    Se estiver usando um serviço relacionado a Descoberta, você deverá ter as funções necessárias para esse serviço.
    Estrutura de comando
    snc discovery get-pattern-commands [arguments]
    Argumento

    --pattern: nome do padrão ou sys_id

    Exemplos
    Recupere uma lista de comandos associados ao padrão especificado executando o comando com o nome do padrão ou o sys_id.
    • Execute o comando inserindo o nome do padrão SO Windows - Servidores:
      snc discovery get-pattern-commands --pattern="Windows OS - Servers"
    • Execute o comando inserindo o padrão sys_id 670e55a4db702200c06776231f961942:
      snc discovery get-pattern-commands --pattern="670e55a4db702200c06776231f961942"
    Valor de retorno
    ✔ Commands fetched successfully. 
[
   {
      "Command": "\"\\root\\CIMV2\" \"SELECT Caption,IPAddress,MACAddress,DHCPEnabled,Index,InterfaceIndex,IPEnabled FROM Win32_NetworkAdapterConfiguration\"",
      "Command Type": "wmi",
      "sys_id": "2e677c4ec3adb1106618b10ad0013185"
   },
   {
      "Command": "\"\\root\\CIMV2\" \"SELECT Index,InterfaceIndex,Name,Manufacturer,NetConnectionID FROM Win32_NetworkAdapter\"",
      "Command Type": "wmi",
      "sys_id": "6a677c4ec3adb1106618b10ad0013185"
   },
   {
      "Command": "powershell -command \\Get-NetRoute -AddressFamily IPv6\\",
      "Command Type": "shell",
      "sys_id": "a6677c4ec3adb1106618b10ad0013185"
   },
   {
      "Command": "\"\\root\\CIMV2\" \"SELECT Destination,Mask,NextHop, InterfaceIndex FROM Win32_IP4RouteTable\"",
      "Command Type": "wmi",
      "sys_id": "e2677c4ec3adb1106618b10ad0013185"
   },
   {
      "Command": "\"\\root\\CIMV2\" \"SELECT DefaultIPGateway FROM Win32_NetworkAdapterConfiguration\"",
      "Command Type": "wmi",
      "sys_id": "e6677c4ec3adb1106618b10ad00131ab"
   },
…
]

    obter-padrões

    Recupera uma lista abrangente de padrões de descoberta disponíveis.

    Grupo de comandos
    Grupo primário: descoberta
    Funções necessárias
    descoberta_admin
    Se estiver usando um serviço relacionado a Descoberta, você deverá ter as funções necessárias para esse serviço.
    Estrutura de comando
    snc discovery get-patterns
    Exemplo
    Recupere uma lista de padrões de descoberta disponíveis executando o seguinte comando:
    snc discovery get-patterns
    Valor de retorno
    ✔ Details of Discovery Patterns successfully retrieved.
[
   {
      "active": true,
      "ci_type": "cmdb_ci_appl_dot_net",
      "name": ".NET Application",
      "pattern_type": "1 - Application"
   },
   {
      "active": true,
      "ci_type": "cmdb_ci_lb_service",
      "name": "A10",
      "pattern_type": "1 - Application"
   },
   {
      "active": true,
      "ci_type": "cmdb_ci_lb_a10",
      "name": "A10 Load Balancer",
      "pattern_type": "3 - Infrastructure"
   },
   {
      "active": true,
      "ci_type": "cmdb_ci_lb_a10",
      "name": "A10 Load Balancer SSH",
      "pattern_type": "3 - Infrastructure"
   },
   {
      "active": true,
      "ci_type": "cmdb_ci_appl_generic",
      "name": "A10 SSH Hosting Formatting",
      "pattern_type": "2 - Shared library"
   },
   …
]

    midserver-action

    Executa várias ações em MID Servers, por exemplo: parar, retomar ou reiniciar.

    Grupo de comandos
    Grupo primário: descoberta
    Funções necessárias
    descoberta_admin
    Se estiver usando um serviço relacionado a Descoberta, você deverá ter as funções necessárias para esse serviço.
    Estrutura de comando
    snc discovery midserver-action [arguments]
    Argumentos
    Tabela 3. Argumentos para o comando midserver-action
    Argumento Descrição
    -m ou --mid-server Nome ou sys_id do MID Server
    -a ou --action Ação a ser executada no MID Server. As opções disponíveis são:
    • invalidar
    • resume
    • parar
    • pause
    • autoUpgrade
    • upgrade
    • reiniciar
    • file_discovery_refresh
    • Grab_logs
    • validar
    Exemplo
    Execute uma ação em um MID Server com o seguinte comando: 
    snc discovery midserver-action [options]
    Reinicie o MID Server WinMidServer executando o seguinte comando:
    snc discovery midserver-action --mid-server="WinMidServer" --action="restart"
    Valor de retorno
    ✔ Successfully submitted mid-server action
{
   "Action": "restart",
   "MidServer": "cb8d1625c3fdb110c72691477d01312e",
   "Output": "Mid server restart in-progress."
}

✔ Mid server action executed successfully
restart executed successfully.

    descoberta rápida

    Executa uma descoberta rápida em um item de configuração (IC) ou endereço IP especificado.

    Nota:
    Quando as novas tentativas de retorno de chamada excederem o limite máximo, você poderá receber a seguinte mensagem de erro: 
    ✗ Discovery Failed.
{
"CurrentActivity": "",
"DiscoveryStatus": {},
"State": "Active"
}
    A mensagem indica que as novas tentativas de retorno de chamada foram excedidas, mas, embora a descoberta tenha falhado, ela ainda está sendo executada em segundo plano. Verifique os logs de descoberta executando o comando snc discovery get-discovery-logs ou verificando a instância ServiceNow® em busca de atualizações no status da descoberta.
    Grupo de comandos
    Grupo primário: descoberta
    Funções necessárias
    descoberta_admin
    Se estiver usando um serviço relacionado a Descoberta, você deverá ter as funções necessárias para esse serviço.
    Estrutura de comando
    snc discovery quick-discovery [arguments]
    Argumentos
    Tabela 4. Argumentos para comando de descoberta rápida
    Argumento Descrição
    --tipo Tipo de host de destino: IP ou IC.
    --target Detalhes do host de destino.
    • IP: endereço IP
    • IC: as opções disponíveis são:
      • Nome
      • Sys_id
      • Número de série
    --somente logs de erro Inclui somente logs de erro. Valores possíveis: verdadeiro ou falso (padrão: verdadeiro).
    Exemplos
    Execute uma descoberta rápida em uma entidade de destino usando os critérios especificados.
    snc discovery quick-discovery
    • Execute uma descoberta rápida no endereço IP 192.168.1.100 executando o seguinte comando e argumento:
      snc discovery quick-discovery --type="ip" --target="192.168.1.100"
    • Execute uma descoberta rápida no IC especificado executando o comando com o nome, sys_id ou número de série.
      • Para executar uma descoberta rápida em relação ao nome de IC ecomerce001, insira:
        snc discovery quick-discovery --type="ci" --target="ecommerce001"
      • Para executar uma descoberta rápida no IC sys_id d0e8761137201000deeabfc8bcbe5da7, insira:
        snc discovery quick-discovery --type="ci" --target="d0e8761137201000deeabfc8bcbe5da7"
      • Para executar uma descoberta rápida em relação ao número de série do IC L3BB911, insira:
        snc discovery quick-discovery --type="ci" --target="L3BB911"
    Valor de retorno
    snc discovery quick-discovery --type="ip" --target="192.168.1.100"
✔ Discovery job submitted
Status Number: DIS0010054
✔ Discovery is complete
{
   "DiscoveryLogs": [],
   "DiscoveryStatus": [
      {
         "Completed": "5",
         "Created": "2023-10-17 10:59:52",
         "Description": "Discover CI",
         "Discover": "CIs",
         "Duration": "1970-01-01 00:01:41",
         "Number": DIS0010054,
         "Schedule": "",
         "Started": "5",
         "State": "Completed",
         "Updated": "2023-10-17 11:02:06"
      }
   ],
   "State": "Completed"
}

    executar-comando

    Executa comandos em dispositivos remotos usando credenciais, destinos e MID Serversespecificados.

    Grupo de comandos
    Grupo primário: descoberta
    Funções necessárias
    descoberta_admin
    Se estiver usando um serviço relacionado a Descoberta, você deverá ter as funções necessárias para esse serviço.
    Estrutura de comando
    snc discovery run-command [arguments]
    Argumentos
    Tabela 5. Argumentos para o comando run-command
    Argumento Descrição
    --comando Comando a ser executado.
    --comando-tipo Tipo de operação a ser executada.
    --credencial Credencial usada para executar o comando.
    --midserver Nome do MID Server usado para se comunicar com o destino.
    --os-server Classe de IC que representa o sistema operacional do servidor (SO do servidor) no qual os comandos serão executados. Por exemplo, insira cmdb_ci_linux_server para o servidor Linux.
    --target Endereço IP do host no qual você deseja executar o comando.
    Exemplo
    Execute o seguinte comando para que a consulta doWMI(Windows Management Instrumentation) solicite que o sistema recupere as propriedades UUID e IdentifyingNumber da classe Win32_ComputerSystemProduct no namespace \root\CIMV2 :
    snc discovery run-command --command="\"\\root\\CIMV2\" \"SELECT UUID,IdentifyingNumber FROM Win32_ComputerSystemProduct\"" --command-type="wmi" --credential="WinCred" --midserver="WinMidServer" --os-server="cmdb_ci_win_server" --target="192.168.1.1"
    Valor de retorno
    ✔ The command is sent for execution.
{
"eccQueueOutputSysId": "9a3c55a3c33db910c72691477d0131cd"
}

✔ Command Executed Successfully...
{
"result": {
"IdentifyingNumber": "VMware-00 00 00 00 00 00 00 00-00 00 00 00 00 00 00 00",
"Name": "VMware Virtual Platform",
"Object Reference": null,
"UUID": "61410042-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Version": "None",
"__CLASS": "Win32_ComputerSystemProduct",
"internal_classname": "Win32_ComputerSystemProduct",
"internal_namespace": "root/cimv2"
}
}

    testar-descoberta-credencial

    Valida as credenciais de descoberta em relação a um sistema de destino especificado usando um MID Serverdesignado. O comando verifica somente a prontidão de credenciais para tarefas de descoberta de rede. Ele não modifica ou afeta a configuração da credencial de descoberta ou do sistema de destino.

    Importante:

    Este comando requer que um arquivo XML específico tenha sido importado para a lista Política de acesso ao módulo. Para obter mais informações, consulte o artigo da CLI de Descoberta [KB1553142] na Now Support Base de conhecimento.

    Grupo de comandos
    Grupo primário: descoberta
    Funções necessárias
    descoberta_admin
    Se estiver usando um serviço relacionado a Descoberta, você deverá ter as funções necessárias para esse serviço.
    Estrutura de comando
    snc discovery test-discovery-credential [arguments]
    Argumentos
    Tabela 6. Argumentos para test-discovery-credential
    Argumento Descrição
    --dbname Nome do banco de dados no qual essas credenciais são testadas.
    --dbtype Tipo de banco de dados no qual essas credenciais serão testadas. As opções disponíveis são:
    • MSSQL — para Microsoft SQL Server
    • MySQL
    • Oracle
    --icf Nome da classe Java Naming and Directory Interface (JNDI) que é usada para criar o InitialContext. O nome da classe JNDI deve incluir primeiro o nome do pacote e, em seguida, o nome da classe. Por exemplo, para se conectar à classe JNDI do ActiveMQ, insira: org.apache.activemq.jndi.ActiveMQInitialContextFactory.
    --midserver Nome do MID Server a ser usado para este teste. Para testar Windows credenciais, você deve usar um Windows MID Server.
    --nome Nome da credencial.
    --porta Porta no destino a ser usada para este teste. O sistema preenche previamente este campo com a porta padrão para o tipo de credencial selecionado.
    --target Host de destino no qual essas credenciais são executadas. Este valor deve ser um endereço IP para todos os tipos de credenciais, exceto VMware, para o qual o valor pode ser o URL do host.
    Exemplo
    Teste a credencial de descoberta WinCred em relação ao MID Server WinMidServer executando o seguinte comando:
    snc discovery test-discovery-credential --name="WinCred" --target="192.168.1.1" --midserver="WinMidServer"
    O comando retorna uma mensagem de sucesso quando as seguintes condições são atendidas:
    • A credencial é válida
    • A conexão com o sistema de destino foi bem-sucedida
    • O especificado MID Server está operacional
    Se essas condições não forem atendidas, será exibida uma mensagem de erro detalhando os problemas.
    Valor de retorno
    ✔ Discovery credentials tested successfully
Credential Test Id [ecc-sys-id]: "2b36e40ec3727990c72691477d0131c6"
✔ The credential test is complete
{
   "output": "Test Succeeded"
}

    Para obter mais informações sobre Descoberta CLI, consulte o artigo da CLI de Descoberta [KB1553142] na Now Support Base de conhecimento.