Pular para o conteúdo

Comandos do agente

Gerada da ajuda do próprio binário (Zoppy-crm/zoppy-connect-agent@c7f6ec9495ee). Agente local do Zoppy Connect: abre uma conexão de saída até a Zoppy e executa, dentro da sua rede, só o que a lista local libera.

Opções que valem para todos os comandos:

Opção Tipo Descrição
--config string arquivo de configuração (padrão do sistema ou ZOPPY_AGENT_CONFIG)
--data-dir string pasta de dados com a credencial (padrão do sistema ou ZOPPY_AGENT_DATA)

Rode como administrador (Windows) ou root (Linux) os comandos que mudam a máquina: pair, unpair, allow add e allow remove, service, update.

Lista local do que o agente pode alcançar. Tudo que não estiver aqui é recusado, mesmo que o pedido venha da Zoppy. A lista fica só nesta máquina; a Zoppy não consegue mudá-la. O serviço relê o arquivo sozinho a cada alteração.

Libera um host (http) ou banco (sql)

Libera uma API interna (ex.: https://protheus.local:8181/rest)

Janela do terminal
zoppy-agent allow add http [url] [flags]

Exemplos:

Janela do terminal
zoppy-agent allow add http http://protheus.matriz:8080/rest
zoppy-agent allow add http https://sankhya.local/mge --method GET,POST
zoppy-agent allow add http --host 10.0.0.0/24 --port 8080
Opção Tipo Descrição
--ca-file string arquivo PEM da CA interna que assinou o certificado do host
--host string host, IP, *.dominio ou CIDR (10.0.0.0/24)
--insecure-skip-verify bool aceita qualquer certificado deste host (evite; prefira –ca-file)
--method strings métodos liberados (padrão: GET,HEAD)
--path string só caminhos que começam com este (ex.: /rest)
--port ints portas (padrão: a do esquema)
--scheme strings http, https (padrão: os dois)

Libera leitura num banco (SQL Server, Oracle, Firebird, MySQL ou Postgres)

Janela do terminal
zoppy-agent allow add sql [flags]

Exemplos:

Janela do terminal
zoppy-agent allow add sql --engine sqlserver --host SRVSQL01 --database PROTHEUS
zoppy-agent allow add sql --engine oracle --host 10.0.0.20 --port 1521 --database ORCL
zoppy-agent allow add sql --engine firebird --host srv-erp --database 'C:\ERP\DADOS.FDB'
zoppy-agent allow add sql --engine mysql --host 10.0.0.30 --database erp --trust-server-certificate
zoppy-agent allow add sql --engine postgres --host srv-pg --database erp
Opção Tipo Descrição
--ca-file string SQL Server, MySQL, Postgres: arquivo PEM da CA interna que assinou o certificado do servidor
--database stringArray banco (SQL Server, MySQL, Postgres), service name (Oracle) ou caminho/alias (Firebird); repita para vários
--encrypt string disable: conexão sem criptografia (evite)
--engine string sqlserver, oracle, firebird, mysql ou postgres
--host string host, IP, *.dominio ou CIDR
--legacy-auth bool Firebird: aceita Legacy_Auth (só servidores anteriores ao Firebird 3)
--port int porta (padrão: 1433, 1521, 3050, 3306 ou 5432)
--trust-server-certificate bool SQL Server, MySQL, Postgres: aceita qualquer certificado do servidor (evite; prefira –ca-file)

Testa se um endereço seria liberado, sem acessar a rede

Testa uma URL contra a lista

Janela do terminal
zoppy-agent allow check http <url> [flags]
Opção Tipo Descrição
--method string método (default “GET”)

Testa um banco contra a lista

Janela do terminal
zoppy-agent allow check sql [flags]
Opção Tipo Descrição
--database string banco
--engine string sqlserver, oracle, firebird, mysql ou postgres
--host string host
--port int porta

Mostra a lista local

Janela do terminal
zoppy-agent allow list [flags]

Tira um item da lista (veja os números em allow list)

Tira o item http de número N (veja allow list)

Janela do terminal
zoppy-agent allow remove http <número> [flags]
Opção Tipo Descrição
--host string tira todos os itens deste host

Tira o item sql de número N (veja allow list)

Janela do terminal
zoppy-agent allow remove sql <número> [flags]
Opção Tipo Descrição
--host string tira todos os itens deste host

Pareia este agente com a sua empresa na Zoppy.

Gere o código em Conectores > Agente local > Instalar (vale 30 minutos e uma vez só) e rode, como administrador/root:

zoppy-agent pair K7QD-92XM

Janela do terminal
zoppy-agent pair <código> [flags]
Opção Tipo Descrição
--force bool parear de novo mesmo já pareado (o agente antigo deve ser revogado na tela)
--gateway string endereço da Zoppy (padrão: https://agent-connect.zoppy.com.br)
--staging bool parear com o ambiente de staging (https://agent-connect-staging.zoppy.com.br)

Pede a troca da chave do agente na próxima conexão

Janela do terminal
zoppy-agent rotate-key [flags]

Roda o agente em primeiro plano (o serviço usa este comando)

Janela do terminal
zoppy-agent run [flags]

Instala e controla o serviço (Windows ou systemd)

Instala e inicia o serviço (como administrador/root)

Janela do terminal
zoppy-agent service install [flags]

Reinicia o serviço

Janela do terminal
zoppy-agent service restart [flags]

Inicia o serviço

Janela do terminal
zoppy-agent service start [flags]

Para o serviço

Janela do terminal
zoppy-agent service stop [flags]

Remove o serviço (mantém config e credencial)

Janela do terminal
zoppy-agent service uninstall [flags]

Mostra conexão, versão, visto por último e a lista local

Janela do terminal
zoppy-agent status [flags]
Opção Tipo Descrição
--json bool saída em JSON

Apaga a credencial deste agente (revogue também na tela da Zoppy)

Janela do terminal
zoppy-agent unpair [flags]

Procura uma versão nova no manifesto de releases, confere a assinatura Ed25519 com a chave pública embutida neste binário e o hash do binário, e só então troca o executável e reinicia o serviço. Versões sem assinatura válida são recusadas.

Janela do terminal
zoppy-agent update [flags]
Opção Tipo Descrição
--check bool só verifica, não instala

Mostra a versão

Janela do terminal
zoppy-agent version [flags]