system-commands
시스템에 등록된 쿼리 명령어 목록과 각 명령어의 상세 정보를 조회합니다.
명령어 속성
| 항목 | 설명 |
|---|---|
| 명령어 유형 | 드라이버 쿼리 |
| 필요 권한 | 없음 |
| 라이선스 사용량 | 집계 안 함 |
| 병렬 실행 | 미지원 |
| 분산 실행 | 미지원 |
문법
system-commands
옵션
옵션 없음
출력 필드
| 필드 | 타입 | 설명 |
|---|---|---|
| name | 문자열 | 쿼리 명령어의 이름 |
| description | 문자열 | 쿼리 명령어의 설명 |
| options | 맵 | 쿼리 명령어를 실행할 때 입력할 수 있는 옵션. 각 옵션의 필수 여부, 표시 이름, 설명을 포함합니다. |
| outputs | 맵 | 쿼리 명령어를 실행하면 출력되는 필드와 설명 |
| usage | 문자열 | 쿼리 명령어의 사용 예시 |
| display_group | 문자열 | 쿼리 명령어가 속한 그룹 (마에스트로, 소나, 포렌식 등) |
| display_name | 문자열 | 쿼리 명령어를 표시할 때 사용할 이름 |
오류 코드
파싱 오류
해당 사항 없음
런타임 오류
해당 사항 없음
설명
system-commands 명령어는 시스템에 등록된 모든 쿼리 명령어의 목록과 각 명령어의 상세 정보를 조회합니다. 세션의 로케일 설정에 따라 설명, 옵션, 출력 필드의 정보가 해당 언어로 반환됩니다.
options 필드는 각 옵션별로 필수 여부(required), 표시 이름(display_name), 설명(description)을 맵 형태로 반환합니다. outputs 필드도 동일한 구조로 각 출력 필드의 정보를 반환합니다.
사용 예
-
전체 쿼리 명령어 목록 조회
system-commands -
특정 명령어 정보 조회
system-commands | search name == "stats" -
소나 명령어만 조회
system-commands | search display_group == "Sonar"
호환성
system-commands 명령어는 소나 4.0 이전 버전부터 제공되었습니다.