› ›

Auditbeat 命令参考

编辑

Auditbeat 命令参考

编辑

Auditbeat 提供了一个命令行界面，用于启动 Auditbeat 和执行常见任务，例如测试配置文件和加载仪表板。

命令行还支持用于控制全局行为的全局标志。

如果出现以下情况，请使用 sudo 运行以下命令：

配置文件由 root 拥有，或
Auditbeat 被配置为捕获需要 root 访问权限的数据

此处描述的某些功能需要 Elastic 许可证。有关更多信息，请参阅 https://elastic.ac.cn/subscriptions 和许可证管理。

命令
`export`	将配置、索引模板、ILM 策略或仪表板导出到标准输出。
`help`	显示任何命令的帮助。
`keystore`	管理密钥库。
`run`	运行 Auditbeat。如果您在不指定命令的情况下启动 Auditbeat，则默认使用此命令。
`setup`	设置初始环境，包括索引模板、ILM 策略和写入别名，以及 Kibana 仪表板（如果可用）。
`test`	测试配置。
`version`	显示有关当前版本的信息。

另请参阅全局标志。

`export` 命令

编辑

将配置、索引模板、ILM 策略或仪表板导出到标准输出。您可以使用此命令快速查看您的配置、查看索引模板和 ILM 策略的内容，或从 Kibana 导出仪表板。

概要

auditbeat export SUBCOMMAND [FLAGS]

子命令

config

将当前配置导出到标准输出。如果您使用 -c 标志，则此命令会导出指定文件中定义的配置。

dashboard

导出仪表板。您可以使用此选项将仪表板存储在模块中的磁盘上并自动加载它。例如，要将仪表板导出到 JSON 文件，请运行

auditbeat export dashboard --id="DASHBOARD_ID" > dashboard.json

要查找 DASHBOARD_ID，请查看 Kibana 中仪表板的 URL。默认情况下，export dashboard 将仪表板写入标准输出。此示例显示如何将仪表板写入 JSON 文件，以便您可以稍后导入它。JSON 文件将包含带有所有可视化效果和搜索的仪表板。您必须为 Auditbeat 单独加载索引模式。

要加载仪表板，请将生成的 dashboard.json 文件复制到 Auditbeat 的 kibana/6/dashboard 目录中，然后运行 auditbeat setup --dashboards 以导入仪表板。

如果 Kibana 未在 localhost:5061 上运行，您还必须在 setup.kibana 下调整 Auditbeat 配置。

template

将索引模板导出到标准输出。您可以指定 --es.version 标志以进一步定义要导出的内容。此外，您可以通过 --dir 定义目录，将模板导出到文件而不是 stdout。

ilm-policy: 将索引生命周期管理策略导出到标准输出。您可以指定 --es.version 和 --dir，将策略导出为文件，而不是导出到 stdout。

标志

--es.version VERSION: 与 template 一起使用时，导出与指定版本兼容的索引模板。与 ilm-policy 一起使用时，如果指定的 ES 版本启用了 ILM，则导出 ILM 策略。
-h, --help: 显示 export 命令的帮助。
--dir DIRNAME: 定义一个目录，模板、管道和 ILM 策略应作为文件导出到该目录，而不是将它们打印到 stdout。
--id DASHBOARD_ID: 与 dashboard 一起使用时，指定仪表板 ID。

另请参阅全局标志。

示例

auditbeat export config
auditbeat export template --es.version 8.17.0
auditbeat export dashboard --id="a7b35890-8baa-11e8-9676-ef67484126fb" > dashboard.json

`help` 命令

编辑

显示任何命令的帮助。如果未指定命令，则显示 run 命令的帮助。

概要

auditbeat help COMMAND_NAME [FLAGS]

COMMAND_NAME: 指定要显示帮助的命令的名称。

标志

-h, --help: 显示 help 命令的帮助。

另请参阅全局标志。

示例

auditbeat help export

`keystore` 命令

编辑

管理密钥库。

概要

auditbeat keystore SUBCOMMAND [FLAGS]

子命令

add KEY: 将指定的键添加到密钥库。使用 --force 标志覆盖现有键。使用 --stdin 标志通过 stdin 传递值。
create: 创建一个密钥库来保存密钥。使用 --force 标志覆盖现有密钥库。
list: 列出密钥库中的密钥。
remove KEY: 从密钥库中删除指定的键。

标志

--force: 对 add 和 create 子命令有效。与 add 一起使用时，覆盖指定的键。与 create 一起使用时，覆盖密钥库。
--stdin: 与 add 一起使用时，使用标准输入作为密钥值的来源。
-h, --help: 显示 keystore 命令的帮助。

另请参阅全局标志。

示例

auditbeat keystore create
auditbeat keystore add ES_PWD
auditbeat keystore remove ES_PWD
auditbeat keystore list

有关更多示例，请参阅密钥库。

`run` 命令

编辑

运行 Auditbeat。如果您在不指定命令的情况下启动 Auditbeat，则默认使用此命令。

概要

auditbeat run [FLAGS]

或

auditbeat [FLAGS]

标志

-N, --N: 禁用发布以进行测试。此选项禁用除文件输出之外的所有输出。
--cpuprofile FILE: 将 CPU 配置文件数据写入指定的文件。此选项对于排除 Auditbeat 故障很有用。
-h, --help: 显示 run 命令的帮助。
--httpprof [HOST]:PORT: 启动一个用于分析的 http 服务器。此选项对于排除 Auditbeat 故障和分析很有用。
--memprofile FILE: 将内存配置文件数据写入指定的输出文件。此选项对于排除 Auditbeat 故障很有用。
--system.hostfs MOUNT_POINT: 指定用于监视主机的宿主文件系统的挂载点。此标志已弃用，应通过 hostfs 模块配置值指定备用 hostfs。

另请参阅全局标志。

示例

auditbeat run -e

或

auditbeat -e

`setup` 命令

编辑

设置初始环境，包括索引模板、ILM 策略和写入别名，以及 Kibana 仪表板（如果可用）

索引模板确保在 Elasticsearch 中正确映射字段。如果启用了索引生命周期管理，它还会确保定义的 ILM 策略和写入别名连接到与索引模板匹配的索引。ILM 策略负责索引的生命周期，何时进行滚动更新，何时将索引从热阶段移动到下一个阶段等等。
Kibana 仪表板使您可以更轻松地在 Kibana 中可视化 Auditbeat 数据。

此命令设置环境，而不会实际运行 Auditbeat 和摄取数据。指定可选标志以设置资产的子集。

概要

auditbeat setup [FLAGS]

标志

--dashboards: 设置 Kibana 仪表板（如果可用）。此选项从 Auditbeat 程序包加载仪表板。有关更多选项（例如加载自定义仪表板），请参阅 Beats 开发人员指南中的导入现有 Beat 仪表板。
-h, --help: 显示 setup 命令的帮助。
--index-management: 设置与 Elasticsearch 索引管理相关的组件，包括模板、ILM 策略和写入别名（如果支持并配置）。

另请参阅全局标志。

示例

auditbeat setup --dashboards
auditbeat setup --index-management

`test` 命令

编辑

测试配置。

概要

auditbeat test SUBCOMMAND [FLAGS]

子命令

config: 测试配置设置。
output: 通过使用当前设置测试 Auditbeat 是否可以连接到输出。

标志

-h, --help: 显示 test 命令的帮助。

另请参阅全局标志。

示例

auditbeat test config

`version` 命令

编辑

显示有关当前版本的信息。

概要

auditbeat version [FLAGS]

标志

-h, --help: 显示 version 命令的帮助。

另请参阅全局标志。

示例

auditbeat version

全局标志

编辑

无论何时运行 Auditbeat，这些全局标志都可用。

-E, --E "SETTING_NAME=VALUE"

覆盖特定的配置设置。您可以指定多个覆盖。例如

auditbeat -E "name=mybeat" -E "output.elasticsearch.hosts=['http://myhost:9200']"

此设置应用于当前正在运行的 Auditbeat 进程。Auditbeat 配置文件未更改。

-c, --c FILE

指定用于 Auditbeat 的配置文件。您在此处指定的文件相对于 path.config。如果未指定 -c 标志，则使用默认配置文件 auditbeat.yml。

-d, --d SELECTORS

为指定的选择器启用调试。对于选择器，您可以指定以逗号分隔的组件列表，也可以使用 -d "*" 为所有组件启用调试。例如，-d "publisher" 显示所有与发布者相关的消息。

-e, --e

记录到标准错误并禁用 syslog/文件输出。

-environment

出于日志记录目的，指定 Auditbeat 运行的环境。此设置用于在未配置日志输出时选择默认的日志输出。支持的值包括：systemd、container、macos_service 和 windows_service。如果指定了 systemd 或 container，Auditbeat 默认会记录到 stdout 和 stderr。

--path.config

设置配置文件的路径。有关详细信息，请参阅目录布局部分。

--path.data

设置数据文件的路径。有关详细信息，请参阅目录布局部分。

--path.home

设置杂项文件的路径。有关详细信息，请参阅目录布局部分。

--path.logs

设置日志文件的路径。有关详细信息，请参阅目录布局部分。

--strict.perms

对配置文件设置严格的权限检查。默认值为 -strict.perms=true。有关更多信息，请参阅配置文件所有权和权限。

-v, --v

记录 INFO 级别的消息。

« 用于安全设置的密钥库 APT 和 YUM 的存储库 »

Auditbeat 命令参考

Auditbeat 命令参考

export 命令

help 命令

keystore 命令

run 命令

setup 命令

test 命令

version 命令

全局标志

`export` 命令

`help` 命令

`keystore` 命令

`run` 命令

`setup` 命令

`test` 命令

`version` 命令