Comandos operacionais#
Gerado automaticamente a partir do binário cgnatsh desta versão (0.1.36). Comandos marcados com 🔒 exigem perfil de administrador; os demais também funcionam no perfil somente-leitura. No modo de configuração, prefixe com run para executá-los (ex.: run show cgnat stats).
Grupos: change · clear · configure · confirm · exit · export · help · license · logout · monitor · ping · poweroff · quit · reboot · request · restart · setup · shell · show · traceroute
Grupo change#
| Comando | Descrição | Perfil |
|---|---|---|
change password <<usuário>> |
Define a senha de um usuário | somente-leitura |
Grupo clear#
| Comando | Descrição | Perfil |
|---|---|---|
clear cgnat subscriber <<ip-privado>> |
Derruba as sessões de um assinante | 🔒 admin |
Grupo configure#
| Comando | Descrição | Perfil |
|---|---|---|
configure |
Entra no modo de configuração | 🔒 admin |
Grupo confirm#
| Comando | Descrição | Perfil |
|---|---|---|
confirm |
Confirma um commit-confirm pendente | 🔒 admin |
Grupo exit#
| Comando | Descrição | Perfil |
|---|---|---|
exit |
Sai da CLI | somente-leitura |
Grupo export#
| Comando | Descrição | Perfil |
|---|---|---|
export cgnat allocations <<de> <até> <arquivo.csv> [ip-privado]> |
Exporta o log de alocações em CSV | 🔒 admin |
Grupo help#
| Comando | Descrição | Perfil |
|---|---|---|
help |
Lista os comandos | somente-leitura |
Grupo license#
| Comando | Descrição | Perfil |
|---|---|---|
license activate <<CHAVE>> |
Instala ou troca a chave de licença e valida com o servidor | 🔒 admin |
license refresh |
Valida a licença com o servidor agora | 🔒 admin |
Grupo logout#
| Comando | Descrição | Perfil |
|---|---|---|
logout |
Sai da CLI | somente-leitura |
Grupo monitor#
| Comando | Descrição | Perfil |
|---|---|---|
monitor bandwidth <<interface>> |
Taxa de tráfego da interface ao vivo (Ctrl-C sai) | somente-leitura |
monitor cgnat |
Painel ao vivo do CGNAT (Ctrl-C sai) | 🔒 admin |
monitor log <[cgnatd|kernel|nftables|ssh|system]> |
Acompanha o log ao vivo (Ctrl-C sai) | 🔒 admin |
monitor traffic interface <<interface> [filtro]> |
Captura de pacotes (tcpdump) | 🔒 admin |
Grupo ping#
| Comando | Descrição | Perfil |
|---|---|---|
ping <<host> [count N] [size N] [interface X]> |
Envia ICMP echo | somente-leitura |
Grupo poweroff#
| Comando | Descrição | Perfil |
|---|---|---|
poweroff |
Desliga o servidor | 🔒 admin |
Grupo quit#
| Comando | Descrição | Perfil |
|---|---|---|
quit |
Sai da CLI | somente-leitura |
Grupo reboot#
| Comando | Descrição | Perfil |
|---|---|---|
reboot |
Reinicia o servidor | 🔒 admin |
Grupo request#
| Comando | Descrição | Perfil |
|---|---|---|
request cgnat block <<ip> [minutos] [motivo]> |
Bloqueia um IP de origem no XDP | 🔒 admin |
request cgnat detach <[flush]> |
Remove os links XDP fixados (o NAT para); com 'flush' apaga também os mapas fixados (sessões) | 🔒 admin |
request cgnat fast-forward resume |
Tira a suspensão do watchdog e reaplica o caminho rápido | 🔒 admin |
request cgnat unblock <<ip>> |
Remove um IP da lista de bloqueio | 🔒 admin |
request cgnat unwatch <<ip|all>> |
Para de observar um IP (ou all) e apaga os contadores | 🔒 admin |
request cgnat watch <<ip> [minutos, padrão 30]> |
Observa um IP (origem ou destino, na chegada): registra veredito e motivo de cada pacote dele | 🔒 admin |
request system 2fa disable <<usuário>> |
Remove o TOTP de um usuário | 🔒 admin |
request system 2fa setup <<usuário>> |
Ativa o código TOTP de um usuário (mostra o QR code) | 🔒 admin |
request system alert secret <<webhook|telegram> <valor>> |
Grava um segredo dos avisos (URL do webhook ou token do Telegram) em arquivo protegido | 🔒 admin |
request system alert test |
Envia uma mensagem de teste pelos canais de aviso configurados | 🔒 admin |
request system backup generate-key |
Cria a chave SSH do backup e mostra a parte pública | 🔒 admin |
request system backup now |
Gera e envia um backup da configuração agora | 🔒 admin |
request system tuning apply |
Reaplica o ajuste automático (kernel e NICs do dataplane) agora, sem reiniciar | 🔒 admin |
request system update check |
Consulta no servidor de licenças se há versão nova do Portgrid | 🔒 admin |
request system update install <[no-os]> |
Atualiza antes a base do Debian (apt update + full-upgrade -y + autoremove, e instala as ferramentas de apoio que faltarem), depois baixa, confere a assinatura e instala a versão nova do Portgrid (exige licença válida) | 🔒 admin |
request system update os |
Atualiza só a base do Debian (apt update + full-upgrade -y + autoremove) e instala as ferramentas de apoio que faltarem | 🔒 admin |
request system update rollback |
Volta para a versão anterior do Portgrid | 🔒 admin |
request system wireguard generate-key <<nome-do-túnel>> |
Cria a chave privada de um túnel WireGuard e mostra a chave pública | 🔒 admin |
Grupo restart#
| Comando | Descrição | Perfil |
|---|---|---|
restart cgnatd |
Reinicia o serviço cgnatd (derruba as sessões NAT) | 🔒 admin |
Grupo setup#
| Comando | Descrição | Perfil |
|---|---|---|
setup |
Assistente inicial: hostname, IP de gerência, gateway, DNS e licença | 🔒 admin |
Grupo shell#
| Comando | Descrição | Perfil |
|---|---|---|
shell |
Abre o bash do Debian (exit volta para cá) | 🔒 admin |
Grupo show#
| Comando | Descrição | Perfil |
|---|---|---|
show bonding <[nome]> |
Estado dos bonds | somente-leitura |
show bridge |
Bridges e suas portas | somente-leitura |
show cgnat audit-export |
Situação do envio dos registros de alocação ao coletor remoto | somente-leitura |
show cgnat blocked |
IPs na lista de bloqueio do XDP | somente-leitura |
show cgnat capacity |
Ocupação dos pools: blocos livres, assinantes por endereço e endereços cheios | somente-leitura |
show cgnat dataplane |
Estado do dataplane XDP | somente-leitura |
show cgnat diagnose <<ip-privado>> |
Diagnóstico de um assinante: limites, fluxos, destinos, eventos e leitura automática | 🔒 admin |
show cgnat errors |
Erros do control-plane | somente-leitura |
show cgnat fast-forward |
Estado do caminho rápido: modo, watchdog, contadores por motivo e taxas | somente-leitura |
show cgnat flows <<ip-privado>> |
Conexões ativas de um assinante | 🔒 admin |
show cgnat logs <[ip]> |
Log de alocações de portas (UTC) | somente-leitura |
show cgnat lookup <<ip-público> <porta> [AAAA-MM-DD [HH:MM]]> |
Quem usava um IP público:porta num instante (ordem judicial) | somente-leitura |
show cgnat nic <[<placa>]> |
Placa do dataplane: driver, link, XDP, filas, anéis, IRQs, NUMA e PCIe | somente-leitura |
show cgnat performance <[segundos, padrão 5]> |
Mede o custo do XDP por pacote, a CPU por núcleo e as perdas das placas numa janela | 🔒 admin |
show cgnat policies |
Políticas de tradução | somente-leitura |
show cgnat pools |
Pools de endereços públicos | somente-leitura |
show cgnat port-mappings |
Mapeamentos de porta abertos pelos assinantes (UPnP, PCP e NAT-PMP) | somente-leitura |
show cgnat stats |
Contadores do dataplane (inclui proteções DDoS) | somente-leitura |
show cgnat subscribers <[ip]> |
Assinantes e seus blocos | somente-leitura |
show cgnat summary |
Resumo do CGNAT | somente-leitura |
show cgnat timeouts |
Timeouts de fluxos | somente-leitura |
show cgnat top <[sessions|blocks|drops|peak]> |
Maiores consumidores e assinantes em risco | somente-leitura |
show cgnat upnp |
O mesmo que show cgnat port-mappings | somente-leitura |
show cgnat watch |
O que o XDP decidiu para os IPs em observação (veredito e motivo do descarte) | somente-leitura |
show cli audit <[quantidade]> |
Comandos executados por cada usuário (UTC) | 🔒 admin |
show commits |
Histórico de commits | somente-leitura |
show configuration <[all | commands] [<caminho>]> |
Configuração em execução (toda ou só um trecho, ex.: interfaces, firewall input); 'all' mostra também o que é automático ou padrão (marcado # auto) e o estado efetivo | somente-leitura |
show dns |
Servidores DNS em uso (resolv.conf) | somente-leitura |
show firewall |
Regras do nftables carregadas (com contadores) | somente-leitura |
show interfaces <[<interface> [offload|ring|channels|coalesce|steering|statistics|driver]]> |
Interfaces de rede (estado, IP, MTU) | somente-leitura |
show ip arp |
Vizinhos ARP | somente-leitura |
show ip route |
Tabela de rotas IPv4 | somente-leitura |
show license |
Situação da licença do Portgrid | somente-leitura |
show log <[cgnatd|kernel|nftables|system]> |
Logs do sistema | somente-leitura |
show nat |
Regras de NAT do próprio servidor carregadas (com contadores) | somente-leitura |
show ntp |
Fontes de tempo (chrony) | somente-leitura |
show sysctl <[filtro]> |
Valores atuais dos parâmetros de kernel | somente-leitura |
show system alarms |
Alarmes ativos: serviços, licença, dataplane, pools, tabela de fluxos, placas, disco e memória | somente-leitura |
show system backup |
Configuração e cópias do backup automático | 🔒 admin |
show system cpu |
Uso de CPU e carga | somente-leitura |
show system health |
Verificação de saúde do servidor e do CGNAT | somente-leitura |
show system memory |
Uso de memória | somente-leitura |
show system storage |
Uso de disco | somente-leitura |
show system tuning |
Parâmetros do kernel: valor atual x recomendado para este hardware | somente-leitura |
show uptime |
Tempo de atividade | somente-leitura |
show users |
Sessões abertas | somente-leitura |
show version |
Versões do sistema | somente-leitura |
show wireguard |
Estado dos túneis WireGuard (wg show) | somente-leitura |
Grupo traceroute#
| Comando | Descrição | Perfil |
|---|---|---|
traceroute <<host>> |
Rota até o destino | somente-leitura |