Neste documento, explicamos como ingerir registros do VyOS no Google Security Operations usando o Bindplane. O analisador extrai campos das mensagens do syslog, com foco principal em eventos DHCP. Ele usa padrões grok para identificar e categorizar mensagens com base no processo (dhcpd, kernel etc.) e mapeia informações relevantes para campos da UDM, processando solicitações, confirmações, ofertas de DHCP e outros tipos de eventos de maneira diferente. Ele também preenche detalhes genéricos de eventos para registros não DHCP e mapeia informações de conexão de rede quando disponíveis.
Antes de começar
Verifique se você tem os pré-requisitos a seguir:
Instância do Google SecOps
Windows 2016 ou mais recente ou um host Linux com systemd
Se você estiver executando por trás de um proxy, verifique se as portas do firewall estão abertas.
Acesso privilegiado ao VyOS
Receber o arquivo de autenticação de ingestão do Google SecOps
Faça login no console do Google SecOps.
Acesse Configurações do SIEM > Agentes de coleta.
Baixe o arquivo de autenticação de ingestão. Salve o arquivo de forma segura no sistema em que o Bindplane será instalado.
Receber o ID do cliente do Google SecOps
Faça login no console do Google SecOps.
Acesse Configurações do SIEM > Perfil.
Copie e salve o ID do cliente na seção Detalhes da organização.
Instalar o agente do Bindplane
Instale o agente do Bindplane no sistema operacional Windows ou Linux de acordo com as instruções a seguir.
Instalação do Windows
Abra o Prompt de Comando ou o PowerShell como administrador.
Configurar o agente do Bindplane para ingerir o Syslog e enviar ao Google SecOps
Acesse o arquivo de configuração:
Localize o arquivo config.yaml. Normalmente, ele fica no diretório /etc/bindplane-agent/ no Linux ou no diretório de instalação no Windows.
Abra o arquivo usando um editor de texto (por exemplo, nano, vi ou Bloco de Notas).
Edite o arquivo config.yaml da seguinte forma:
receivers:udplog:# Replace the port and IP address as requiredlisten_address:"0.0.0.0:514"exporters:chronicle/chronicle_w_labels:compression:gzip# Adjust the path to the credentials file you downloaded in Step 1creds_file_path:'/path/to/ingestion-authentication-file.json'# Replace with your actual customer ID from Step 2customer_id:<customer_id>
endpoint:malachiteingestion-pa.googleapis.com# Add optional ingestion labels for better organizationlog_type:'VYOS'raw_log_field:bodyingestion_labels:service:pipelines:logs/source0__chronicle_w_labels-0:receivers:-udplogexporters:-chronicle/chronicle_w_labels
Substitua a porta e o endereço IP conforme necessário na sua infraestrutura.
Substitua os seguintes campos pelos seus detalhes:
<bindplane-address>: insira o endereço IP do agente do Bindplane.
<bindolane-port>: insira o número da porta do agente do Bindplane (por exemplo, 514).
<udp-or-tcp>: insira UDP ou TCP, dependendo da configuração do Bindplane (por exemplo, UDP).
Tabela de mapeamento da UDM
Campo de registro
Mapeamento do UDM
Lógica
clientIp
principal.ip
Endereço IP do cliente extraído da mensagem DHCP.
clientMac
principal.mac
Endereço MAC do cliente extraído da mensagem DHCP.
datetime
metadata.event_timestamp
O carimbo de data/hora extraído da mensagem de registro.
dst_ipaddress
target.ip
Endereço IP de destino extraído da mensagem de registro.
hostname
observer.hostname
Nome do host extraído da mensagem de registro. Determinado pelo analisador com base no process e em outros campos. Pode ser GENERIC_EVENT, NETWORK_CONNECTION, NETWORK_DHCP ou STATUS_UPDATE. Codificado como "VYOS".
msg
metadata.description
A mensagem original do registro ou uma parte dela, dependendo da lógica de análise. Definido como "DHCP Event" se process for "dhcpd". Codificado como "VYOS DHCP". Codificado como "VYOS".
network.dhcp.chaddr
network.dhcp.chaddr
Endereço MAC do cliente extraído de mensagens DHCP.
network.dhcp.ciaddr
network.dhcp.ciaddr
Endereço IP do cliente em uma mensagem DHCPREQUEST. Opcode da mensagem DHCP. Definido como "BOOTREQUEST" para DHCPREQUEST e DHCPINFORM, "BOOTREPLY" para DHCPACK e DHCPNAK. Tipo de mensagem DHCP. Derivado de eventType e pode ser REQUEST, ACK, INFORM, NAK ou OFFER.
network.dhcp.yiaddr
network.dhcp.yiaddr
Seu endereço IP (cliente) em uma mensagem DHCPACK ou DHCPOFFER. Defina como "DHCP" se o process for "dhcpd".
pri_host
principal.hostname
Nome do host associado a um cliente em mensagens DHCP.
rem_msg
metadata.description
Parte restante da mensagem após a análise inicial, usada para descrição em alguns casos.
src_ipaddress
principal.ip
Endereço IP de origem extraído da mensagem de registro.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-21 UTC."],[],[],null,["# Collect VyOS logs\n=================\n\nSupported in: \nGoogle secops [SIEM](/chronicle/docs/secops/google-secops-siem-toc)\n| **Note:** This feature is covered by [Pre-GA Offerings Terms](https://chronicle.security/legal/service-terms/) of the Google Security Operations Service Specific Terms. Pre-GA features might have limited support, and changes to pre-GA features might not be compatible with other pre-GA versions. For more information, see the [Google SecOps Technical Support Service guidelines](https://chronicle.security/legal/technical-support-services-guidelines/) and the [Google SecOps Service Specific Terms](https://chronicle.security/legal/service-terms/).\n\nThis document explains how to ingest VyOS logs to Google Security Operations using Bindplane. The parser extracts fields from the syslog messages, primarily focusing on DHCP events. It uses grok patterns to identify and categorize messages based on the process (dhcpd, kernel, etc.), then maps relevant information to UDM fields, handling DHCP requests, acknowledgments, offers, and other event types differently. It also populates generic event details for non-DHCP logs and maps network connection information when available.\n\nBefore you begin\n----------------\n\nMake sure you have the following prerequisites:\n\n- Google SecOps instance\n- Windows 2016 or later or a Linux host with `systemd`\n- If running behind a proxy, ensure firewall [ports](/chronicle/docs/ingestion/use-bindplane-agent#verify_the_firewall_configuration) are open\n- Privileged access to VyOS\n\nGet Google SecOps ingestion authentication file\n-----------------------------------------------\n\n1. Sign in to the Google SecOps console.\n2. Go to **SIEM Settings \\\u003e Collection Agents**.\n3. Download the **Ingestion Authentication File**. Save the file securely on the system where Bindplane will be installed.\n\nGet Google SecOps customer ID\n-----------------------------\n\n1. Sign in to the Google SecOps console.\n2. Go to **SIEM Settings \\\u003e Profile**.\n3. Copy and save the **Customer ID** from the **Organization Details** section.\n\nInstall the Bindplane agent\n---------------------------\n\nInstall the Bindplane agent on your Windows or Linux operating system according\nto the following instructions.\n\n### Windows installation\n\n1. Open the **Command Prompt** or **PowerShell** as an administrator.\n2. Run the following command:\n\n msiexec /i \"https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi\" /quiet\n\n### Linux installation\n\n1. Open a terminal with root or sudo privileges.\n2. Run the following command:\n\n sudo sh -c \"$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)\" install_unix.sh\n\n### Additional installation resources\n\nFor additional installation options, consult the [installation guide](/chronicle/docs/ingestion/use-bindplane-agent#install_the_bindplane_agent).\n\nConfigure the Bindplane agent to ingest Syslog and send to Google SecOps\n------------------------------------------------------------------------\n\n1. Access the configuration file:\n - Locate the `config.yaml` file. Typically, it's in the `/etc/bindplane-agent/` directory on Linux or in the installation directory on Windows.\n - Open the file using a text editor (for example, `nano`, `vi`, or Notepad).\n2. Edit the `config.yaml` file as follows:\n\n receivers:\n udplog:\n # Replace the port and IP address as required\n listen_address: \"0.0.0.0:514\"\n\n exporters:\n chronicle/chronicle_w_labels:\n compression: gzip\n # Adjust the path to the credentials file you downloaded in Step 1\n creds_file_path: '/path/to/ingestion-authentication-file.json'\n # Replace with your actual customer ID from Step 2\n customer_id: \u003ccustomer_id\u003e\n endpoint: malachiteingestion-pa.googleapis.com\n # Add optional ingestion labels for better organization\n log_type: 'VYOS'\n raw_log_field: body\n ingestion_labels:\n\n service:\n pipelines:\n logs/source0__chronicle_w_labels-0:\n receivers:\n - udplog\n exporters:\n - chronicle/chronicle_w_labels\n\n - Replace the port and IP address as required in your infrastructure.\n - Replace `\u003ccustomer_id\u003e` with the actual customer ID.\n - Update `/path/to/ingestion-authentication-file.json` to the path where the authentication file was saved in the [Get Google SecOps ingestion authentication file](/chronicle/docs/ingestion/default-parsers/vyos#get-auth-file) section.\n\nRestart the Bindplane agent to apply the changes\n------------------------------------------------\n\n- To restart the Bindplane agent in **Linux**, run the following command:\n\n sudo systemctl restart bindplane-agent\n\n- To restart the Bindplane agent in **Windows** , you can either use the\n **Services** console or enter the following command:\n\n net stop BindPlaneAgent && net start BindPlaneAgent\n\nConfigure Syslog on VyOS\n------------------------\n\n1. Sign in to the VyOS router using CLI.\n2. Enter the following commands:\n\n set system syslog marker interval 1200\n set system syslog remote \u003cbindplane-address\u003e facility local0 level info port \u003cbindolane-port\u003e protocol \u003cudp-or-tcp\u003e format include-timezone\n\n3. Make sure to replace the following fields with your details:\n\n - `\u003cbindplane-address\u003e`: Enter the Bindplane agent IP address.\n - `\u003cbindolane-port\u003e`: Enter the Bindplane agent port number (for example, `514`).\n - `\u003cudp-or-tcp\u003e`: Enter either UDP or TCP, depending on your Bindplane configuration (for example, `UDP`).\n\nUDM Mapping Table\n-----------------\n\n**Need more help?** [Get answers from Community members and Google SecOps professionals.](https://security.googlecloudcommunity.com/google-security-operations-2)"]]