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.
zoppy-agent allow
Seção intitulada “zoppy-agent allow”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.
zoppy-agent allow add
Seção intitulada “zoppy-agent allow add”Libera um host (http) ou banco (sql)
zoppy-agent allow add http
Seção intitulada “zoppy-agent allow add http”Libera uma API interna (ex.: https://protheus.local:8181/rest)
zoppy-agent allow add http [url] [flags]Exemplos:
zoppy-agent allow add http http://protheus.matriz:8080/restzoppy-agent allow add http https://sankhya.local/mge --method GET,POSTzoppy-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) |
zoppy-agent allow add sql
Seção intitulada “zoppy-agent allow add sql”Libera leitura num banco (SQL Server, Oracle, Firebird, MySQL ou Postgres)
zoppy-agent allow add sql [flags]Exemplos:
zoppy-agent allow add sql --engine sqlserver --host SRVSQL01 --database PROTHEUSzoppy-agent allow add sql --engine oracle --host 10.0.0.20 --port 1521 --database ORCLzoppy-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-certificatezoppy-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) |
zoppy-agent allow check
Seção intitulada “zoppy-agent allow check”Testa se um endereço seria liberado, sem acessar a rede
zoppy-agent allow check http
Seção intitulada “zoppy-agent allow check http”Testa uma URL contra a lista
zoppy-agent allow check http <url> [flags]| Opção | Tipo | Descrição |
|---|---|---|
--method |
string | método (default “GET”) |
zoppy-agent allow check sql
Seção intitulada “zoppy-agent allow check sql”Testa um banco contra a lista
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 |
zoppy-agent allow list
Seção intitulada “zoppy-agent allow list”Mostra a lista local
zoppy-agent allow list [flags]zoppy-agent allow remove
Seção intitulada “zoppy-agent allow remove”Tira um item da lista (veja os números em allow list)
zoppy-agent allow remove http
Seção intitulada “zoppy-agent allow remove http”Tira o item http de número N (veja allow list)
zoppy-agent allow remove http <número> [flags]| Opção | Tipo | Descrição |
|---|---|---|
--host |
string | tira todos os itens deste host |
zoppy-agent allow remove sql
Seção intitulada “zoppy-agent allow remove sql”Tira o item sql de número N (veja allow list)
zoppy-agent allow remove sql <número> [flags]| Opção | Tipo | Descrição |
|---|---|---|
--host |
string | tira todos os itens deste host |
zoppy-agent pair
Seção intitulada “zoppy-agent pair”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
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) |
zoppy-agent rotate-key
Seção intitulada “zoppy-agent rotate-key”Pede a troca da chave do agente na próxima conexão
zoppy-agent rotate-key [flags]zoppy-agent run
Seção intitulada “zoppy-agent run”Roda o agente em primeiro plano (o serviço usa este comando)
zoppy-agent run [flags]zoppy-agent service
Seção intitulada “zoppy-agent service”Instala e controla o serviço (Windows ou systemd)
zoppy-agent service install
Seção intitulada “zoppy-agent service install”Instala e inicia o serviço (como administrador/root)
zoppy-agent service install [flags]zoppy-agent service restart
Seção intitulada “zoppy-agent service restart”Reinicia o serviço
zoppy-agent service restart [flags]zoppy-agent service start
Seção intitulada “zoppy-agent service start”Inicia o serviço
zoppy-agent service start [flags]zoppy-agent service stop
Seção intitulada “zoppy-agent service stop”Para o serviço
zoppy-agent service stop [flags]zoppy-agent service uninstall
Seção intitulada “zoppy-agent service uninstall”Remove o serviço (mantém config e credencial)
zoppy-agent service uninstall [flags]zoppy-agent status
Seção intitulada “zoppy-agent status”Mostra conexão, versão, visto por último e a lista local
zoppy-agent status [flags]| Opção | Tipo | Descrição |
|---|---|---|
--json |
bool | saída em JSON |
zoppy-agent unpair
Seção intitulada “zoppy-agent unpair”Apaga a credencial deste agente (revogue também na tela da Zoppy)
zoppy-agent unpair [flags]zoppy-agent update
Seção intitulada “zoppy-agent update”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.
zoppy-agent update [flags]| Opção | Tipo | Descrição |
|---|---|---|
--check |
bool | só verifica, não instala |
zoppy-agent version
Seção intitulada “zoppy-agent version”Mostra a versão
zoppy-agent version [flags]