This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Reporting CLI options

You can use any of the following arguments with the opensearch-reporting-cli tool.

ArgumentDescriptionAcceptable values and usageEnvironment variable
-u, —urlThe URL for the visualization.Obtain from OpenSearch Dashboards > Visualize > Share > Permalinks > Copy link.OPENSEARCH_URL
-a, —authThe authentication type for the report.You can specify either Basic basic, Cognito cognito, SAML saml, or No Auth none. If no value is specified, the Reporting CLI tool defaults to no authentication, type none. Basic, Cognito, and SAML require credentials with the -c flag.N/A
-c, —credentialsThe OpenSearch login credentials.Enter your username and password separated by a colon. For example, username:password. Required for Basic, Cognito, and SAML authentication types.OPENSEARCH_USERNAME and OPENSEARCH_PASSWORD
-t, —tenantThe tenants in OpenSearch Dashboards.The default tenant is private.N/A
-f, —formatThe file format for the report.Can be either pdf, png, or csv. The default is pdf.N/A
-w, —widthThe window width in pixels for the report.Default is 1680.N/A
-l, —heightThe minimum window height in pixels for the report.Default is 600.N/A
-n, —filenameThe file name of the report.Default is reporting.opensearch-report-YYY-MM-DDTHH-mm-ss.sssZ
-e, —transportThe transport mechanism for sending the email.For Amazon SES, specify ses. Amazon SES requires an AWS configuration on your system to store the credentials. For SMTP, use smtp and also specify the login credentials with —smtpusername and —smtppassword.OPENSEARCH_TRANSPORT
-s, —fromThe email address of the sender.For example, user@amazon.com.OPENSEARCH_FROM
-r, —toThe email address of the recipient.For example, user@amazon.com.OPENSEARCH_TO
—smtphostThe hostname of the SMTP server.For example, SMTP_HOST.OPENSEARCH_SMTP_HOST
—smtpportThe port for the SMTP connection.For example, SMTP_PORT.OPENSEARCH_SMTP_PORT
—smtpsecureSpecifies to use TLS when connecting to the server.For example, SMTP_SECURE.OPENSEARCH_SMTP_SECURE
—smtpusernameThe SMTP username.For example, SMTP_USERNAME.OPENSEARCH_SMTP_USERNAME
—smtppasswordThe SMTP password.For example, SMTP_PASSWORD.OPENSEARCH_SMTP_PASSWORD
—subjectThe email subject text encased in quotes.Can be any string. The default is “This is an email containing your dashboard report”.OPENSEARCH_EMAIL_SUBJECT
—noteThe email body, either a string or a path to a text file.The default note is “Hi,\nHere is the latest report!”OPENSEARCH_EMAIL_NOTE
-h, —helpSpecifies to display the list of optional arguments from the command line.N/A 

Getting help

To get a list of all available CLI arguments, run the following command:

  1. $ opensearch-reporting-cli -h