12. Linha de comando

Tudo o que se configura no painel também pode ser feito pela linha de comando, no console do equipamento ou por SSH. No console restrito ou como root, digite berrycade <comando>.

A tecla Tab completa comandos, seções, nomes que já existem na configuração (políticas, endereços, zonas, interfaces…), campos e valores possíveis. berrycade --help lista todos os comandos e berrycade <comando> --help mostra os detalhes de cada um.

Figura 23 — Console do painel: htop, ping e a ajuda da CLI

12.1 Como as alterações são aplicadas

A linha de comando usa a mesma API e o mesmo mecanismo de aplicação do painel:

• a validação é a mesma do painel; em caso de erro, a mensagem indica o campo e sugere a correção (por exemplo, campo desconhecido: coment — você quis dizer: comment?);
• cada alteração é gravada no histórico de revisões e no log de auditoria com o usuário cli;
• depois de aplicar, a CLI pergunta Confirmar? [s/N]. Sem a confirmação dentro do prazo (60 s por padrão, em Sistema › Configurações), a configuração anterior volta sozinha. Se a alteração cortar o acesso por SSH, a resposta não chega e nada se perde;
• a opção --sim confirma sem perguntar, para uso em scripts. Ela dispensa a proteção contra perda de acesso: use com cuidado;
• com o painel parado, os comandos de configuração não funcionam. Os comandos de recuperação (12.5) continuam disponíveis.

12.2 Configuração

Formato dos campos:

• campo=valor: texto, número ou true/false (também sim/não);
• subcampos com ponto: dhcp_server.enabled=true, admin.https_port=8443;
• listas separadas por vírgula: src_addr=servidor1,servidor2. campo+=valor acrescenta à lista e campo-=valor retira;
• valores com espaço vão entre aspas: "comment=Saída para a internet";
• campo=null limpa um campo opcional;
• categorias do filtro web: categories.malware=block (ou monitor, allow).

12.3 Seções da configuração

12.4 Operação

12.5 Recuperação e acesso

Estes comandos funcionam mesmo com o painel parado:

12.6 Exemplos

Ver as políticas e os detalhes da primeira:

berrycade show policies
berrycade show policies 1

Criar um objeto de endereço e liberá-lo na política 1:

berrycade add addresses name=servidor type=subnet value=10.0.0.10/32 "comment=Servidor de arquivos"
berrycade set policies 1 src_addr+=servidor

Criar uma VLAN de usuários com zona própria e DHCP (a faixa .100–.200 é preenchida automaticamente):

berrycade add zones name=usuarios "description=VLAN de usuários"
berrycade add vlans name=usuarios parent=lan vid=10 zone=usuarios address=192.168.10.1/24 dhcp_server.enabled=true

Ajustes gerais, filtro web e IDS:

berrycade set system dns.servers=8.8.8.8,1.1.1.1
berrycade set webfilter_profiles Libera_Tudo categories.malware=block
berrycade ids zone lan alert

DHCP, logs e backup:

berrycade dhcp reserve 60:c7:27:08:bb:ae 172.16.1.50 lan --nome notebook
berrycade logs traffic --tipo denied --limite 20
berrycade backup export /root/backup.swbk --senha