Winlogbeat 命令参考
编辑Winlogbeat 命令参考
编辑Winlogbeat 提供了一个命令行界面，用于启动 Winlogbeat 并执行常见任务，例如测试配置文件和加载仪表板。
命令行还支持用于控制全局行为的全局标志。
此处描述的某些功能需要 Elastic 许可证。有关更多信息，请参见 https://elastic.ac.cn/subscriptions 和 许可证管理。
| 命令 | |
|---|---|
将配置、索引模板、管道或 ILM 策略导出到标准输出。 |
|
显示任何命令的帮助信息。 |
|
管理密钥库。 |
|
运行 Winlogbeat。如果您在未指定命令的情况下启动 Winlogbeat，则默认使用此命令。 |
|
设置初始环境，包括索引模板、ILM 策略和写入别名以及 Kibana 仪表板（如果可用）。 |
|
测试配置。 |
|
显示有关当前版本的信息。 |
另请参见 全局标志。
export 命令
编辑将配置、索引模板、管道或 ILM 策略导出到标准输出。您可以使用此命令快速查看配置，查看索引模板和 ILM 策略的内容，从 Kibana 导出仪表板或导出摄取管道。
概要
winlogbeat export SUBCOMMAND [FLAGS]
子命令
-
config - 将当前配置导出到标准输出。如果您使用
-c标志，则此命令会导出在指定文件中定义的配置。 -
dashboard -
导出仪表板。您可以使用此选项将仪表板存储在模块中的磁盘上并自动加载它。例如，要将仪表板导出到 JSON 文件，请运行
winlogbeat export dashboard --id="DASHBOARD_ID" > dashboard.json
要查找
DASHBOARD_ID，请查看 Kibana 中仪表板的 URL。默认情况下，export dashboard将仪表板写入标准输出。该示例显示了如何将仪表板写入 JSON 文件以便以后导入。JSON 文件将包含具有所有可视化和搜索的仪表板。您必须单独为 Winlogbeat 加载索引模式。要加载仪表板，请将生成的
dashboard.json文件复制到 Winlogbeat 的kibana/6/dashboard目录中，然后运行winlogbeat setup --dashboards以导入仪表板。如果 Kibana 未在
localhost:5061上运行，则还必须调整setup.kibana下的 Winlogbeat 配置。 -
template - 将索引模板导出到标准输出。您可以指定
--es.version标志以进一步定义要导出的内容。此外，您可以通过使用--dir定义目录，将模板导出到文件而不是stdout。
标志
-
--es.version 版本 - 与
template一起使用时，导出与指定版本兼容的索引模板。与ilm-policy一起使用时，如果为 ILM 启用了指定的 ES 版本，则导出 ILM 策略。与pipeline一起使用时，导出与指定版本兼容的管道的版本。 -
-h, --help - 显示
export命令的帮助信息。 -
--dir DIRNAME - 定义一个目录，将模板、管道和 ILM 策略导出到该目录作为文件，而不是将它们打印到
stdout。 -
--id DASHBOARD_ID - 与
dashboard一起使用时，指定仪表板 ID。
另请参见 全局标志。
示例
winlogbeat export config winlogbeat export template --es.version 8.16.0 winlogbeat export dashboard --id="a7b35890-8baa-11e8-9676-ef67484126fb" > dashboard.json
help 命令
编辑显示任何命令的帮助信息。如果未指定命令，则显示 run 命令的帮助信息。
概要
winlogbeat help COMMAND_NAME [FLAGS]
-
COMMAND_NAME - 指定要显示其帮助信息的命令的名称。
标志
-
-h, --help - 显示
help命令的帮助信息。
另请参见 全局标志。
示例
winlogbeat help export
keystore 命令
编辑管理密钥库。
概要
winlogbeat keystore SUBCOMMAND [FLAGS]
子命令
-
add 密钥 - 将指定的密钥添加到密钥库。使用
--force标志覆盖现有密钥。使用--stdin标志通过stdin传递值。 -
create - 创建一个密钥库来保存秘密。使用
--force标志覆盖现有密钥库。 -
list - 列出密钥库中的密钥。
-
remove 密钥 - 从密钥库中删除指定的密钥。
标志
-
--force - 与
add和create子命令有效。与add一起使用时，会覆盖指定的密钥。与create一起使用时，会覆盖密钥库。 -
--stdin - 与
add一起使用时，使用 stdin 作为密钥值的来源。 -
-h, --help - 显示
keystore命令的帮助信息。
另请参见 全局标志。
示例
winlogbeat keystore create winlogbeat keystore add ES_PWD winlogbeat keystore remove ES_PWD winlogbeat keystore list
有关更多示例，请参见 安全密钥库。
run 命令
编辑运行 Winlogbeat。如果您在未指定命令的情况下启动 Winlogbeat，则默认使用此命令。
概要
winlogbeat run [FLAGS]
或者
winlogbeat [FLAGS]
标志
-
-N, --N - 出于测试目的禁用发布。此选项禁用除文件输出之外的所有输出。
-
--cpuprofile 文件 - 将 CPU 配置文件数据写入指定的文件。此选项对于排除 Winlogbeat 故障很有用。
-
-h, --help - 显示
run命令的帮助信息。 -
--httpprof [主机]:端口 - 启动用于分析的 http 服务器。此选项对于排除 Winlogbeat 故障和分析 Winlogbeat 很有用。
-
--memprofile 文件 - 将内存配置文件数据写入指定输出文件。此选项对于排除 Winlogbeat 故障很有用。
-
--system.hostfs 挂载点 - 指定主机文件系统的挂载点，用于监控主机。此标志已弃用，应通过
hostfs模块配置值指定备用 hostfs。
另请参见 全局标志。
示例
winlogbeat run -e
或者
winlogbeat -e
setup 命令
编辑设置初始环境，包括索引模板、ILM 策略和写入别名以及 Kibana 仪表板（如果可用）。
- 索引模板确保在 Elasticsearch 中正确映射字段。如果启用了索引生命周期管理，它还会确保定义的 ILM 策略和写入别名连接到与索引模板匹配的索引。ILM 策略负责索引的生命周期，何时进行滚动，何时将索引从热阶段移动到下一个阶段等。
- Kibana 仪表板使您更容易在 Kibana 中可视化 Winlogbeat 数据。
此命令设置环境，而无需实际运行 Winlogbeat 和摄取数据。指定可选标志以设置资产的子集。
概要
winlogbeat setup [FLAGS]
标志
-
--dashboards - 设置 Kibana 仪表板（如果可用）。此选项从 Winlogbeat 包中加载仪表板。有关更多选项（例如加载自定义仪表板），请参见《Beats 开发人员指南》中的 导入现有 Beat 仪表板。
-
-h, --help - 显示
setup命令的帮助信息。 -
--index-management - 设置与 Elasticsearch 索引管理相关的组件，包括模板、ILM 策略和写入别名（如果受支持并已配置）。
另请参见 全局标志。
示例
winlogbeat setup --dashboards winlogbeat setup --index-management
test 命令
编辑测试配置。
概要
winlogbeat test SUBCOMMAND [FLAGS]
子命令
-
config - 测试配置设置。
-
output - 通过使用当前设置测试 Winlogbeat 是否可以连接到输出。
标志
-
-h, --help - 显示
test命令的帮助信息。
另请参见 全局标志。
示例
winlogbeat test config
version 命令
编辑显示有关当前版本的信息。
概要
winlogbeat version [FLAGS]
标志
-
-h, --help - 显示
version命令的帮助信息。
另请参见 全局标志。
示例
winlogbeat version
全局标志
编辑每当您运行 Winlogbeat 时，这些全局标志都可用。
-
-E, --E “设置名称=值” -
覆盖特定的配置设置。您可以指定多个覆盖。例如
winlogbeat -E "name=mybeat" -E "output.elasticsearch.hosts=['http://myhost:9200']"
此设置应用于当前正在运行的 Winlogbeat 进程。Winlogbeat 配置文件不会更改。
-
-c, --c 文件 - 指定要用于 Winlogbeat 的配置文件。此处指定的文件相对于
path.config。如果未指定-c标志，则使用默认配置文件winlogbeat.yml。 -
-d, --d 选择器 - 为指定的选择器启用调试。对于选择器，您可以指定组件的逗号分隔列表，或者您可以使用
-d "*"为所有组件启用调试。例如，-d "publisher"显示所有与发布者相关的消息。 -
-e, --e - 登录到 stderr 并禁用 syslog/文件输出。
-
-environment - 用于日志记录，指定Winlogbeat运行的环境。此设置用于在未配置日志输出时选择默认日志输出。支持的值包括：
systemd、container、macos_service和windows_service。如果指定systemd或container，Winlogbeat 默认会将日志记录到标准输出 (stdout) 和标准错误 (stderr)。 -
--path.config - 设置配置文件的路径。详情请参见目录布局部分。
-
--path.data - 设置数据文件的路径。详情请参见目录布局部分。
-
--path.home - 设置杂项文件的路径。详情请参见目录布局部分。
-
--path.logs - 设置日志文件的路径。详情请参见目录布局部分。
-
--strict.perms - 设置配置文件的严格权限检查。默认值为
-strict.perms=true。更多信息请参见 配置文件所有权和权限。 -
-v, --v - 记录INFO级别的消息。