에서 사용자 지정 명령 생성 ServiceNow CLI
에서 사용자 지정 명령을 생성하여 명령줄에서 사용자 지정 애플리케이션을 관리합니다.ServiceNow CLI
시작하기 전에
필요한 역할: 관리자
이 태스크 정보
프로시저
-
명령에서 REST 엔드포인트를 사용할 수 있도록 합니다.ServiceNow CLI
- 다음으로 이동 명령줄 인터페이스(CLI) > 엔드포인트.
-
새로 만들기를 선택하고 양식을 작성합니다.
필드 설명 자원 경로 필수 명령을 매핑할 인스턴스의 엔드포인트 경로입니다. 인바운드 REST API 또는 스크립트된 REST API의 경로일 수 있습니다. 예: api/now/table/{table}/{sysid}. 자세한 내용은 사용 가능한 REST API 및 스크립팅된 REST API를 참조하십시오.HTTP 메서드 필수 사용자가 연결된 명령을 실행할 때 사용할 HTTP 메서드입니다. 애플리케이션 엔드포인트에 대한 읽기 전용 애플리케이션 범위입니다.
- 옵션:
명령 그룹을 생성합니다.
또는 기존 명령 그룹에 새 명령을 추가할 수 있습니다.
- 다음으로 이동 명령줄 인터페이스(CLI) > 명령 그룹.
-
새로 만들기를 선택하고 양식을 작성합니다.
필드 설명 이름 필수 명령 그룹의 이름입니다. 상위 그룹 상위 명령 그룹입니다. 참조 그룹 참조할 명령 그룹입니다. 예를 들어, 새 명령 그룹을 기존 명령 그룹의 별칭으로 생성할 수 있습니다. 사용자가 새 명령 그룹을 사용하여 참조된 명령을 호출하면 원래 명령이 실행됩니다. 이렇게 하면 새 명령과 기존 명령을 모두 포함하는 사용자 지정 애플리케이션과 관련된 명령 그룹을 만들 수 있습니다. 간단한 설명 필수 명령 그룹에 대한 짧은 설명입니다. 설명 사용자가 명령 그룹에서 --help명령을 실행할 때 도움말 텍스트로 사용되는 명령 그룹에 대한 설명입니다.애플리케이션 명령 그룹에 대한 읽기 전용 애플리케이션 범위입니다. 활성 선택하면 명령 그룹이 활성화됩니다.
-
명령을 생성합니다.
- 다음으로 이동 명령줄 인터페이스(CLI) > 명령.
-
새로 만들기를 선택하고 양식을 작성합니다.
필드 설명 이름 필수 명령의 이름입니다. 명령 그룹 필수 명령이 속한 명령 그룹입니다. 참조 명령 참조할 명령입니다. 예를 들어, 기존 명령의 별칭으로 새 명령을 생성할 수 있습니다. 사용자가 새 명령을 호출하면 원래 명령이 실행됩니다. 이렇게 하면 기존 기능을 실행하는 사용자 지정 애플리케이션에 특정한 명령을 만들 수 있습니다. 주:명령은 다른 명령을 참조하는 명령을 참조하거나 하위 명령, 상위 명령 또는 콜백 명령을 참조할 수 없습니다.API 엔드포인트 필수 사용자가 명령을 실행할 때 실행할 API 호출입니다. 간단한 설명 필수 명령에 대한 간단한 설명입니다. 애플리케이션 명령에 대한 읽기 전용 애플리케이션 범위입니다. 활성 선택하면 명령이 활성화됩니다. 콜백 명령 예일 때는 명령을 콜백 명령으로 지정합니다. CLI 클라이언트에서 명령을 숨기고 사용자가 명령줄에서 호출하지 못하도록 하려면 이 옵션을 선택합니다. 이 필드를 기본 명령의 콜백 섹션과 함께 사용합니다. 콜백 명령은 기본 명령이 완료되면 실행됩니다.
도움말 텍스트 설명 사용자가 --help명령을 실행할 때 도움말 텍스트로 사용되는 명령에 대한 설명입니다.예제 사용자가 --help명령을 실행할 때 도움말 텍스트로 사용되는 명령의 예입니다.표현식 성공 표현식 서버의 응답을 평가하고 명령이 성공했는지 여부를 결정하는 데 사용되는 표현식입니다. 예: result.code = 1.실패 표현식 서버의 응답을 평가하고 명령이 실패했는지 여부를 결정하는 데 사용되는 표현식입니다. 메시지 성공 메시지 명령이 성공하면 CLI 클라이언트에 표시되는 메시지입니다. 진행률 메시지 명령이 진행 중일 때 CLI 클라이언트에 표시되는 메시지입니다. 실패 메시지 명령이 실패할 때 CLI 클라이언트에 표시되는 메시지입니다. 콜백 콜백 표현식 콜백 명령을 실행할지 여부를 결정하는 데 사용되는 표현식입니다. 예를 들어 장기 실행 프로세스를 확인하는 식을 작성할 수 있습니다. 표현식에서 특정 결과를 생성하면 콜백이 실행됩니다. 콜백 명령 콜백 표현식이 충족될 때 실행할 명령입니다. 콜백 명령 필드가 선택된 명령이어야 합니다. 콜백 간격 콜백 명령 실행 간격입니다. 단위: 밀리초
기본값: 1,000
최대 재시도 콜백 명령이 실행되는 최대 횟수입니다. 기본값: 10
-
명령 인수 관련 목록에서 명령에 필요한 명령 인수를 생성합니다.
명령 실행 시 사용자가 옵션을 설정할 수 있도록 명령 인수를 생성합니다.
필드 설명 이름 필수 명령 인수의 이름입니다( 예: 데이터).짧은 이름 명령 인수의 짧은 dame입니다( 예: d).데이터 유형 필수 명령 인수에 예상되는 데이터의 유형입니다. 옵션은 다음과 같습니다. - 문자열: 사용자가 문자열을 입력으로 입력할 수 있습니다.
- 정수: 사용자가 숫자를 입력으로 입력할 수 있습니다.
- 부울: 사용자가
true또는false를 입력으로 입력할 수 있습니다. - 파일 입력: 사용자가 파일을 입력으로 업로드할 수 있습니다. 다음 단계에서 이 인수를 API 엔드포인트 인수 관련 목록의 본문 매개변수 유형 에 매핑합니다. 사용자는 일반 텍스트, YAML, JSON 또는 REST API에서 허용하는 다른 파일 형식을 전달할 수 있습니다. 사용자가 YAML 파일을 제출하면 CLI 클라이언트는 기본적으로 JSON 형식으로 파일을 변환합니다. 전 처리 건너뛰 기 필드를 사용하여 이 동작을 비활성화합니다.
- 암호: 사용자가 암호를 입력으로 안전하게 입력할 수 있습니다.
주:파일 입력 데이터 유형의 경우 파일 크기 제한은 기본적으로 10MB입니다. 그러나 시스템 속성을 사용하여 이 제한을 변경합니다 glide.rest.scripted.max_inbound_content_length_mb .전처리 건너뛰기 CLI 클라이언트가 요청으로 보내기 전에 YAML 파일을 JSON 형식으로 변환하지 못하도록 하려면 이 플래그를 설정합니다. 데이터 유형이 파일 입력으로 설정되고 사용자가 YAML 파일을 제출하면 CLI 클라이언트는 기본적으로 명령을 실행하기 전에 파일을 JSON으로 변환합니다. 주:데이터 유형이 파일 입력으로 설정된 경우에만 적용됩니다.기본값 사용자가 값을 전달하지 않을 때 사용되는 기본값입니다. 간단한 설명 필수 명령 인수에 대한 간단한 설명입니다. 사용자가 --help명령을 실행할 때 도움말 텍스트로 사용됩니다.애플리케이션 인수에 대한 읽기 전용 애플리케이션 범위입니다. 명령 필수 인수가 적용되는 명령입니다. 필수 이 옵션을 선택하면 연결된 명령을 실행할 때 사용자가 인수에 대한 값을 제공해야 합니다. 프롬프트 사용자에게 정보를 요청하는 프롬프트. 사용자가 명령에 필수 인수를 포함하지 않는 경우 CLI는 정보를 묻는 메시지를 표시합니다. 가시성 표현식 CLI에서 인수를 프롬프트해야 하는지 여부를 결정하는 데 사용되는 표현식입니다. 일반적으로 이전 인수에 제공된 값을 기반으로 인수를 표시하는 데 사용됩니다. 순서 인수를 프롬프트할 순서입니다. -
API 엔드포인트 인수 관련 목록에서 명령에 필요한 API 엔드포인트 인수를 생성합니다.
명령 인수 관련 목록의 명령 인수를 REST 엔드포인트의 매개변수에 매핑합니다.
필드 설명 이름 필수 인수의 이름입니다. 값 필수 REST 엔드포인트에 전달하려는 명령의 값입니다. 정적 값 또는 {flags.table}과 같은 표현식을 전달할 수 있습니다.flags전역 변수를 사용하여 명령 인수에 액세스합니다.매개변수 유형 필수 값을 전달하려는 REST 엔드포인트의 매개변수 유형입니다. 예를 들어 본문을 선택하면 CLI는 값 필드의 값을 REST 엔드포인트 본문에 전달합니다. 옵션은 다음과 같습니다. - 본문
- 머리글
- 경로
- 쿼리
애플리케이션 인수에 대한 읽기 전용 애플리케이션 범위입니다. 명령 필수 인수가 적용되는 명령입니다. -
반환 값 관련 목록에서 명령에 필요한 반환 값을 생성합니다.
응답에서 특정 키만 반환하는 반환 값을 생성합니다.
필드 설명 경로 표현식 필수 반환하려는 키의 경로를 나타내는 표현식입니다. 별칭 반환 값을 할당할 변수 이름입니다. 애플리케이션 명령에 대한 읽기 전용 애플리케이션 범위입니다. 명령 필수 반환 값이 적용되는 명령입니다.