ServiceNow CLI 사용 가능한 명령
기본 시스템에서 ServiceNow CLI사용할 수 있는 명령 및 명령 인수 .
전역 명령 인수
명령 인수를 사용하여 CLI 명령에 대한 옵션을 설정합니다.
- --도움
설명, 지원되는 인수 및 예제를 포함하여 지정된 명령에 대한 도움말 정보를 제공합니다. 자세한 내용은 ServiceNow CLI에 대한 도움 받기 문서를 참조하십시오.
$ snc --help- --디버그
명령 실행 시 디버그 로깅 출력을 제공합니다. 자세한 내용은 ServiceNow CLI에 대한 도움 받기 문서를 참조하십시오.
$ snc record delete --table incident --sysid 552c48888c033300964f4932b03eb092 --debug- --프로필
명령에 사용할 명명된 프로파일을 지정합니다. 자세한 내용은 연결 프로파일 구성 및 관리 ServiceNow CLI 문서를 참조하십시오.
$ snc configure profile set --profile <profilename>- --출력
명령에 사용할 출력 형식을 지정합니다. 는 ServiceNow CLI 다음 출력 형식을 지원합니다.
json: 출력 형식은 json입니다. 이것이 기본값입니다.{ "default": { "appversion": "1.0.8", "host": "https://myinstance.service-now.com", "hostversion": "Paris", "loginmethod": "basic", "output": "json", "username": "admin" }, "user1": { "appversion": "1.0.8", "host": "https://otherinstance.service-now.com", "hostversion": "Paris", "loginmethod": "basic", "output": "yaml", "username": "admin" } }yaml: 출력 형식이 YAML로 지정됩니다. YAML을 사용하여 YAML 형식의 문자열을 내보내거나 사용하는 서비스 및 도구로 출력을 처리합니다.default: appversion: 1.0.8 host: https://myinstance.service-now.com hostversion: Paris loginmethod: basic output: json username: admin user1: appversion: 1.0.8 host: https://otherinstance.service-now.com hostversion: Paris loginmethod: basic output: yaml username: admintext: 출력 형식은 여러 줄의 탭으로 구분된 문자열 값으로 지정됩니다. 이 출력을 grep, sed 및 awk와 같은 기존 UNIX 텍스트 도구 및 PowerShell에서 수행하는 텍스트 처리에 사용합니다.default https://myinstance.service-now.com Paris 1.0.8 basic admin json user1 https://otherinstance.service-now.com Paris 1.0.8 basic admin yamltable: 출력 형식은 사람이 읽을 수 있는 형식으로 정보를 제공하는 테이블로 지정됩니다.NAME HOST HOST VERSION APP VERSION LOGIN METHOD USERNAME OUTPUT ------------------------------------------------------------------------------- default myinstance Paris 1.0.8 basic admin json user1 otherinstance Paris 1.0.8 basic admin yamlnone: CLI는 출력을 콘솔에 인쇄하지 않습니다. 성공, 오류 및 진행률 메시지는 여전히 표시됩니다.
$ snc record query --table incident --query ‘active=true’ --output json- --대화형 없음
- CLI에서 사용자에게 인수 값을 묻는 메시지를 표시하지 못하도록 합니다. 사용자가 필수 인수에 대한 값을 전달하지 않으면 시스템이 기본값을 사용합니다. 기본값이 정의되지 않은 경우 시스템에서 오류가 발생합니다.
- --자세한 정보 없음
- 이 명령은 메시지 없이 자동으로 실행됩니다. 자동화된 테스트 시나리오에서 이 인수를 사용합니다.
프로파일 구성
인스턴스에 연결하거나, 연결 프로파일을 보고, 연결 및 사용 가능한 명령을 새로 고치거나, 더 이상 필요하지 않은 프로파일을 삭제할 연결 프로파일을 생성합니다. 프로파일 구성에 대한 자세한 내용은 다음 문서를 참조하십시오 연결 프로파일 구성 및 관리 ServiceNow CLI.
- 기본 프로파일 설정
기본적으로 사용하는 연결 프로파일을 ServiceNow CLI 생성합니다. CLI와 인스턴스의 초기 연결을 설정하려면 기본 프로파일을 만들어야 합니다.
$ snc configure profile set시스템은 다음 정보를 입력하라는 메시지를 표시합니다.
요청된 정보 설명 호스트 연결할 인스턴스의 호스트 이름입니다. 전체 URL(https://my-instance.service-now.com) 또는 호스트 이름(my-instance)만 모두 지원합니다. 로그인 방법 인스턴스에 연결하는 데 사용할 로그인 방법입니다. 기본, OAuth 및 OAuth + MFA를 지원합니다. 사용자 이름 인스턴스에 연결하는 데 사용할 사용자 이름입니다. 암호 인스턴스에 연결하는 데 사용할 암호입니다. 클라이언트 ID 로그인 방법이 OAuth 또는 OAuth + MFA일 때 인스턴스에 연결하는 데 사용할 클라이언트 ID입니다. 클라이언트 비밀 로그인 방법이 OAuth 또는 OAuth + MFA일 때 인스턴스에 연결하는 데 사용할 클라이언트 비밀입니다. 인증 코드 로그인 방법이 OAuth + MFA일 때 인스턴스에 연결하는 데 사용할 인증 코드입니다. 기본 출력 형식 명령 결과의 형식을 지정하는 방법을 지정합니다. 옵션은 json, yaml, 텍스트 및 테이블입니다. - 명명된 프로파일 설정
특정 명령에 사용할 명명된 연결 프로파일을 생성합니다. 이를 통해 특정 명령에 대해 다른 인스턴스 또는 연결 프로토콜을 지정할 수 있습니다.
$ snc configure profile set [--profile profile-name]시스템은 다음 정보를 입력하라는 메시지를 표시합니다.
요청된 정보 설명 호스트 연결할 인스턴스의 호스트 이름입니다. 전체 URL(https://my-instance.service-now.com) 또는 호스트 이름(my-instance)만 모두 지원합니다. 로그인 방법 인스턴스에 연결하는 데 사용할 로그인 방법입니다. 기본, OAuth 및 OAuth + MFA를 지원합니다. 사용자 이름 인스턴스에 연결하는 데 사용할 사용자 이름입니다. 암호 인스턴스에 연결하는 데 사용할 암호입니다. 클라이언트 ID 로그인 방법이 OAuth 또는 OAuth + MFA일 때 인스턴스에 연결하는 데 사용할 클라이언트 ID입니다. 클라이언트 비밀 로그인 방법이 OAuth 또는 OAuth + MFA일 때 인스턴스에 연결하는 데 사용할 클라이언트 비밀입니다. 인증 코드 로그인 방법이 OAuth + MFA일 때 인스턴스에 연결하는 데 사용할 인증 코드입니다. 기본 출력 형식 명령 결과의 형식을 지정하는 방법을 지정합니다. 옵션은 json, yaml, 텍스트 및 테이블입니다. - 프로파일 보기
구성 파일에 설정된 모든 연결 프로파일을 보거나 특정 프로파일에 대한 정보를 봅니다.
$ snc configure profile list [--profile profile-name]- 프로파일 제거
더 이상 필요하지 않은 명명된 연결 프로파일을 구성 파일에서 제거합니다.
$ snc configure profile remove [--profile profile-name]- 프로파일 새로 고침
지정된 프로파일의 인스턴스에서 사용 가능한 명령을 업데이트합니다. CLI를 최신 상태로 유지하려면 해당 인스턴스에서 명령을 수정한 후 연결을 새로 고치십시오.
$ snc configure profile refresh [--profile profile-name]
기록 운영 수행
명령줄 도구를 사용하여 인스턴스에서 기록을 생성, 읽기, 업데이트, 삭제 및 쿼리합니다.ServiceNow CLI 기록 작업 수행에 대한 자세한 내용은 다음 문서를 참조하십시오 를 사용하여 기록 작업 수행 ServiceNow CLI.
- 기록 작성
지정된 테이블에 단일 기록을 삽입합니다.
$ snc record create [--table table --data data]이러한 인수에 대한 값을 전달합니다.
매개변수 설명 테이블 필수 기록을 저장할 테이블의 이름입니다. 데이터 필수 지정된 기록에서 JSON 문자열 형식으로 정의할 각 필드의 필드 이름 및 연결된 값입니다. - 기록 삭제
지정된 테이블에서 지정된 기록을 삭제합니다.
$ snc record delete [--table table --sysid sys_id]이러한 인수에 대한 값을 전달합니다.
매개변수 설명 테이블 필수 기록을 삭제할 테이블의 이름입니다. sysid 필수 삭제할 기록의 Sys_id입니다. - 기록 가져오기
지정된 테이블에서 지정된 sys_id에 기초한 단일 기록을 조회합니다.
$ snc record get [--table table --sysid sys_id]이러한 인수에 대한 값을 전달합니다.
매개변수 설명 테이블 필수 기록을 조회할 테이블의 이름입니다. sysid 필수 검색할 기록의 Sys_id입니다. - 쿼리 기록
지정된 테이블에서 여러 기록을 조회합니다.
$ snc record query [--displayvalue displayValue --fields fields --limit limit --offset offset --query query --table table]이러한 인수에 대한 값을 전달합니다.
매개변수 설명 displayValue - -display값을포함하여 데이터베이스에서 참조 및 선택 필드에 대한 표시 값을 검색합니다. 실제 값을 검색하려면 이 매개변수를 포함하지 마십시오.필드 데이터베이스에서 반환할 필드 이름의 목록이며 쉼표로 구분됩니다. 제한 반환할 최대 기록 수입니다. 오프셋 기록 검색을 시작할 시작 기록 인덱스입니다. 이 값을 사용하여 기록 검색을 페이지 매김합니다. 쿼리 필수 --query "<column_name><operator><value>"형식으로 결과 세트를 필터링하는 데 사용되는 인코딩된 쿼리입니다.테이블 필수 기록을 쿼리할 테이블의 이름입니다. - 기록 업데이트
지정된 기록을 지정된 데이터 속성으로 업데이트합니다.
$ snc record update [--sysid sys_id --table table --data data]이러한 인수에 대한 값을 전달합니다.
매개변수 설명 테이블 필수 기록을 저장할 테이블의 이름입니다. sysid 필수 업데이트할 기록의 Sys_id입니다. 데이터 필수 지정된 기록에서 JSON 문자열 형식으로 정의할 각 필드의 필드 이름 및 연결된 값입니다.
확장 기능 활용
에 확장을 ServiceNow CLI 추가하여 추가 기능과 명령을 로드하거나, 기존 확장을 업데이트하거나, 더 이상 필요하지 않은 확장을 제거합니다. 자세한 내용은 확장 관리 ServiceNow CLI 문서를 참조하십시오.
- 사용 가능한 확장 찾기
$ snc extension list-available -o table- 확장 설치
$ snc extension add --name <extension-name>- 확장 업데이트
$ snc extension update --name <extension-name>- 확장자 제거
$ snc extension remove --name <extension-name>
ui-component 확장 사용
- UI 구성요소 확장 추가
에 을 UI 구성요소 확장 추가합니다.ServiceNow CLI
$ snc extension add --name ui-component- 프로젝트 설정
구성요소를 개발하는 데 필요한 구성요소 프로젝트와 파일 세트를 생성합니다. 인스턴스에 연결하여 구성요소에 대한 애플리케이션 범위를 생성하거나 나중에 확인하기 위해 범위를 예약할 수 있습니다.
$ snc ui-component project [--name name --description description --scope scope --offline]이러한 인수에 대한 값을 전달합니다.
이름 설명 이름 필수 프로젝트 이름입니다. 유효하고 고유한 npm 패키지 이름이어야 합니다. 설명 인스턴스의 npm 레지스트리 및 플러그인 목록에서 사용할 수 있는 프로젝트 설명입니다. 범위 이 프로젝트 및 해당 구성요소에 할당할 제안된 애플리케이션 범위입니다. 제공된 경우 인스턴스는 이름을 확인합니다. 인스턴스에서 애플리케이션 개발을 위한 네임스페이스 식별자 가이드라인을 사용합니다. 자세한 내용은 애플리케이션 범위를 참조하십시오. 최대: 18자.
케이스: 스네이크 케이스.
기본값:x_customerprefix_componentname, 위치:customerPrefix는 인스턴스의 시스템 속성에 glide.appcreator.company.code 있는 값입니다.ComponentName은 프로젝트를 생성할 때 구성요소의이름매개변수에 제공된 값입니다.
또는 now-ui.json 파일의
scopeName매개변수에 값을 추가할 수 있습니다.오프라인 예인 경우 인스턴스에서 연결이 끊어지는 동안 구성요소를 생성하고 스캐폴딩합니다. 지정된 범위 이름의 확인을 건너뜁니다. 기본값은
false입니다.- 개발 서버 실행
구성요소 코드를 추가하고 로컬 개발 서버를 사용하여 테스트합니다.
$ snc ui-component develop [--entry entry --open --port port --host host]이러한 인수에 대한 값을 전달합니다.
이름 설명 항목 구성요소 프로젝트의 테스트 모듈 경로입니다. 기본값: example/index.js.
오픈 기본 브라우저를 열고 테스트 페이지로 이동합니다. 기본값은 false입니다.
포트 개발 서버가 실행되는 포트입니다. 기본값: 8081.
호스트 다른 사용자가 외부에서 로컬 개발 서버에 액세스할 수 있도록 하려면 사용할 호스트 주소입니다. 일반적으로 0.0.0.0으로설정- 인스턴스에 구성요소 배포
인스턴스에 애플리케이션 플러그인으로 표시할 구성요소를 배포합니다.
$ snc ui-component deploy [--open --force]이러한 인수에 대한 값을 전달합니다.
이름 설명 오픈 true일 경우 기본 브라우저가 열리고 인스턴스 내로 이동합니다.UI 빌더 기본값: false
강제 적용 구성요소 변경을 배포하고 기존 구성요소 기록을 덮어씁니다. 기본값은 false입니다.