报告 CLI 选项
您可以将以下任何参数与 opensearch-reporting-cli 工具一起使用。
| 参数 | 描述 | 可接受的值和用法 | 环境变量 |
|---|---|---|---|
-u, --url | 可视化的 URL。 | 从 OpenSearch Dashboards > 可视化 > 共享 > 永久链接 > 复制链接 获取。 | OPENSEARCH_URL |
-a, --auth | 报告的认证类型。 | 您可以指定 Basic basic、Cognito cognito、SAML saml 或 No Auth none。如果未指定值，报告 CLI 工具默认为无认证类型 none。Basic、Cognito 和 SAML 需要使用 -c 标志提供凭据。 | 不适用 |
-c, --credentials | OpenSearch 登录凭据。 | 输入您的用户名和密码，用冒号分隔。例如，username:password。Basic、Cognito 和 SAML 认证类型必需。 | OPENSEARCH_USERNAME 和 OPENSEARCH_PASSWORD |
-t, --tenant | OpenSearch Dashboards 中的租户。 | 默认租户为 private。 | 不适用 |
-f, --format | 报告的文件格式。 | 可以是 pdf、png 或 csv。默认值为 pdf。 | 不适用 |
-w, --width | 报告的窗口宽度（像素）。 | 默认值为 1680。 | 不适用 |
-l, --height | 报告的最小窗口高度（像素）。 | 默认值为 600。 | 不适用 |
-n, --filename | 报告的文件名。 | 默认值为 reporting。 | opensearch-report-YYY-MM-DDTHH-mm-ss.sssZ |
-e, --transport | 发送电子邮件的传输机制。 | 对于 Amazon SES，指定 ses。Amazon SES 要求您的系统上有 AWS 配置来存储凭据。对于 SMTP，使用 smtp 并使用 --smtpusername 和 --smtppassword 指定登录凭据。 | OPENSEARCH_TRANSPORT |
-s, --from | 发件人的电子邮件地址。 | 例如，user@amazon.com。 | OPENSEARCH_FROM |
-r, --to | 收件人的电子邮件地址。 | 例如，user@amazon.com。 | OPENSEARCH_TO |
--smtphost | SMTP 服务器的主机名。 | 例如，SMTP_HOST。 | OPENSEARCH_SMTP_HOST |
--smtpport | SMTP 连接的端口。 | 例如，SMTP_PORT。 | OPENSEARCH_SMTP_PORT |
--smtpsecure | 指定在连接到服务器时使用 TLS。 | 例如，SMTP_SECURE。 | OPENSEARCH_SMTP_SECURE |
--smtpusername | SMTP 用户名。 | 例如，SMTP_USERNAME。 | OPENSEARCH_SMTP_USERNAME |
--smtppassword | SMTP 密码。 | 例如，SMTP_PASSWORD。 | OPENSEARCH_SMTP_PASSWORD |
--subject | 用引号括起来的电子邮件主题文本。 | 可以是任何字符串。默认值为“这是一封包含您的仪表板报告的电子邮件”。 | OPENSEARCH_EMAIL_SUBJECT |
--note | 电子邮件正文，可以是字符串或文本文件路径。 | 默认备注是“您好，\n这是最新的报告！” | OPENSEARCH_EMAIL_NOTE |
-h, --help | 指定显示命令行中的可选参数列表。 | 不适用 |
获取帮助
要获取所有可用 CLI 参数的列表，请运行以下命令
$ opensearch-reporting-cli -h