找出 config.yaml 檔案。通常位於 Linux 的 /etc/bindplane-agent/ 目錄,或 Windows 的安裝目錄。
使用文字編輯器 (例如 nano、vi 或記事本) 開啟檔案。
按照下列方式編輯 config.yaml 檔案:
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:'YAMAHA_ROUTER'raw_log_field:bodyingestion_labels:service:pipelines:logs/source0__chronicle_w_labels-0:receivers:-udplogexporters:-chronicle/chronicle_w_labels
視基礎架構需求,替換通訊埠和 IP 位址。
將 <customer_id> 替換為實際的客戶 ID。
將 /path/to/ingestion-authentication-file.json 更新為「取得 Google SecOps 擷取驗證檔案」部分中,驗證檔案的儲存路徑。
重新啟動 Bindplane 代理程式,以套用變更
如要在 Linux 中重新啟動 Bindplane 代理程式,請執行下列指令:
sudosystemctlrestartbindplane-agent
如要在 Windows 中重新啟動 Bindplane 代理程式,可以使用「服務」控制台,或輸入下列指令:
net stop BindPlaneAgent && net start BindPlaneAgent
設定 Yamaha 路由器的系統記錄
使用 SSH 或 CLI 連線至路由器。
將系統記錄檔主機設為 Bindplane 代理程式 IP:
預設通訊埠為 514/UDP。
請將 <BINDPLANE_IP> 替換為實際的 Bindplane 代理程式 IP 位址。
sysloghost<BINDPLANE_IP>
選用:設定 Syslog 設施和層級:
syslogfacilitylocal0
sysloginfo
儲存設定,確保變更在重新啟動後仍會保留:
save
為必要模組啟用 Syslog 輸出
為特定功能啟用記錄功能:
防火牆 (IP 篩選器) 記錄:
ipfilterlogon
NAT 記錄:
其中 1000 是您使用的 NAT 描述元編號 (請視需要調整)。
natdescriptorlogon1000
PPPoE / WAN 連線記錄:
pppoeuselogon
如果您使用 DHCP WAN (而非 PPPoE),請記錄 DHCP 事件:
dhcpservicelogon
IPsec VPN 記錄:
ipseclogon
如果是 L2TP 和 PPTP:
l2tplogon
pptplogon
記錄介面啟動/關閉事件:
logstateon
如果您使用連結監控功能,也可以啟用 Ping 存留時間記錄:
pingkeepalivelogon
啟用管理員存取記錄 (例如 SSH 或 Telnet):
consolenotice
sshnotice
telnetnotice
記錄 DHCP 指派作業:
dhcpservicelogon
DNS 記錄 (如果使用內建 DNS 轉送器):
dnsservicelogon
郵件轉移記錄 (如果使用電子郵件快訊):
smtpservicelogon
動態 DNS 記錄:
ddnsservicelogon
NTP 事件:
ntpdatelogon
驗證記錄:
authlogon
半徑記錄:
pppuseradiuslogon
儲存設定,確保變更在重新啟動後仍會保留:
save
UDM 對應表
記錄欄位
UDM 對應
邏輯
data
metadata.description
系統會使用 grok 模式,從原始記錄的 data 欄位擷取說明。系統會根據記錄訊息的格式使用不同模式。例如:「initiate ISAKMP phase」、「Connection closed」、「succeeded for SSH」。
data
metadata.event_timestamp
時間戳記是使用 grok 模式從原始記錄的 data 欄位擷取,然後使用 date 篩選器轉換為時間戳記物件。支援 MMM dd HH:mm:ss 和 MMM d HH:mm:ss 格式。
data
principal.asset.hostname
主機名稱是使用 grok 模式,從原始記錄的 data 欄位中擷取而得。
data
principal.asset.ip
系統會使用 Grok 模式,從原始記錄的 data 欄位擷取主體 IP 位址。並對應至 principal.asset.ip 和 principal.ip。
data
principal.hostname
主機名稱是使用 grok 模式,從原始記錄的 data 欄位中擷取而得。
data
principal.ip
系統會使用 Grok 模式,從原始記錄的 data 欄位擷取主體 IP 位址。並對應至 principal.asset.ip 和 principal.ip。
data
principal.user.userid
系統會使用 grok 模式,從原始記錄的 data 欄位中擷取使用者 ID。
data
target.asset.ip
系統會使用 grok 模式,從原始記錄的 data 欄位中擷取目標 IP 位址。
data
target.ip
系統會使用 grok 模式,從原始記錄的 data 欄位中擷取目標 IP 位址。剖析器邏輯會根據特定欄位是否存在,判斷事件類型。如果同時存在 principal 和 target,事件類型為 NETWORK_CONNECTION。如果 user 存在,事件類型為 USER_UNCATEGORIZED。如果只有 principal,則事件類型為 STATUS_UPDATE。否則預設為 GENERIC_EVENT。硬式編碼為「YAMAHA_ROUTER」。硬式編碼為「YAMAHA_ROUTER」。硬式編碼為「YAMAHA_ROUTER」。
[[["容易理解","easyToUnderstand","thumb-up"],["確實解決了我的問題","solvedMyProblem","thumb-up"],["其他","otherUp","thumb-up"]],[["難以理解","hardToUnderstand","thumb-down"],["資訊或程式碼範例有誤","incorrectInformationOrSampleCode","thumb-down"],["缺少我需要的資訊/範例","missingTheInformationSamplesINeed","thumb-down"],["翻譯問題","translationIssue","thumb-down"],["其他","otherDown","thumb-down"]],["上次更新時間:2025-09-10 (世界標準時間)。"],[],[],null,["# Collect Yamaha router 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 Yamaha router logs to Google Security Operations using Bindplane. The parser uses grok patterns to extract fields like timestamp, hostname, user, description, source and destination IP addresses from the syslog messages. It then maps these extracted fields to the UDM, categorizing the event type based on the presence of principal, target, and user information.\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 the Yamaha router appliance\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: 'YAMAHA_ROUTER'\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/yamaha-router#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 for the Yamaha router\n--------------------------------------\n\n1. Connect to the router using SSH or CLI.\n2. Set Syslog Host to the Bindplane agent IP:\n\n - Default port is **514/UDP**.\n - Replace `\u003cBINDPLANE_IP\u003e` with the actual Bindplane agent IP address.\n\n syslog host \u003cBINDPLANE_IP\u003e\n\n3. Optional: Set Syslog facility and level:\n\n syslog facility local0\n syslog info\n\n4. Save the configuration to ensure the changes persist after reboot:\n\n save\n\nEnable Syslog output for the required modules\n---------------------------------------------\n\n1. Enable logging for specific features:\n\n - Firewall (IP filter) logging:\n\n ip filter log on\n\n - NAT logging:\n\n - Where 1000 is the NAT descriptor number you're using (adjust as needed).\n\n nat descriptor log on 1000\n\n - PPPoE / WAN connection logging:\n\n pppoe use log on\n\n - If you use DHCP WAN (instead of PPPoE), log DHCP events:\n\n dhcp service log on\n\n - For IPsec VPN logging:\n\n ipsec log on\n\n - For L2TP and PPTP:\n\n l2tp log on\n pptp log on\n\n - Log interface up/down events:\n\n log state on\n\n - You can also enable logging for ping keepalive if you're using link monitoring:\n\n ping keepalive log on\n\n - Enable logging for administrative access (such as SSH or Telnet):\n\n console notice\n ssh notice\n telnet notice\n\n - Log DHCP assignments:\n\n dhcp service log on\n\n - DNS logging (if using built-in DNS forwarder):\n\n dns service log on\n\n - Mail transfer logging (if using email alerts):\n\n smtp service log on\n\n - Dynamic DNS logging:\n\n ddns service log on\n\n - NTP events:\n\n ntpdate log on\n\n - Authentication logging:\n\n auth log on\n\n - Radius logging:\n\n ppp use radius log on\n\n2. Save configuration to ensure changes persist after reboot:\n\n save\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)"]]