Reporting CLI options
출처: 문서
본문
Reporting CLI 옵션
opensearch-reporting-cli 도구에는 아래 인자 중 어떤 것이든 사용할 수 있어요.
| 인자 | 설명 | 허용되는 값과 사용법 | 환경 변수
:--------------------- | :--- | :--- |
-u, --url | 시각화의 URL이에요. | OpenSearch Dashboards > Visualize > Share > Permalinks > Copy link에서 가져오세요. | OPENSEARCH_URL
-a, --auth | 리포트의 인증 유형이에요. | Basic basic, Cognito cognito, SAML saml, 인증 없음 none 중 하나를 지정할 수 있어요. 값을 지정하지 않으면 Reporting CLI 도구는 기본적으로 인증 없음, 즉 none 타입으로 동작해요. Basic, Cognito, SAML은 -c 플래그로 자격 증명을 지정해야 해요. | N/A
-c, --credentials | OpenSearch 로그인 자격 증명이에요. | 사용자 이름과 비밀번호를 콜론으로 구분해서 입력하세요. 예를 들어 username:password처럼요. Basic, Cognito, SAML 인증 유형에서는 필수예요. | OPENSEARCH_USERNAME 및 OPENSEARCH_PASSWORD
-t, --tenant | OpenSearch Dashboards의 테넌트예요. | 기본 테넌트는 private이에요.| N/A
-f, --format | 리포트의 파일 형식이에요. | pdf, png, csv 중 하나를 사용할 수 있어요. 기본값은 pdf예요.| N/A
-w, --width | 리포트의 창 너비(픽셀)예요. | 기본값은 1680이에요.| N/A
-l, --height | 리포트의 최소 창 높이(픽셀)예요. | 기본값은 600이에요. | N/A
-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 | 보내는 사람의 이메일 주소예요. | 예를 들어 [email protected]이 있어요. | OPENSEARCH_FROM
-r, --to | 받는 사람의 이메일 주소예요. | 예를 들어 [email protected]이 있어요. | 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 | 따옴표로 감싼 이메일 제목 텍스트예요. | 어떤 문자열이든 사용할 수 있어요. 기본값은 "This is an email containing your dashboard report"예요. | OPENSEARCH_EMAIL_SUBJECT
--note | 이메일 본문이에요. 문자열이나 텍스트 파일 경로를 사용할 수 있어요. | 기본 노트는 "Hi,\nHere is the latest report!"예요. | OPENSEARCH_EMAIL_NOTE
-h, --help | 명령줄에서 선택적 인자 목록을 표시하도록 지정하는 옵션이에요. | N/A
도움말 보기
사용할 수 있는 모든 CLI 인자 목록을 보려면 다음 명령어를 실행하세요:
$ opensearch-reporting-cli -h