CheckDefinitionTestBuilder - 범위 지정됨

  • 릴리스 버전: Yokohama
  • 업데이트 날짜 2025년 01월 30일
  • 읽기8분

    • CheckDefinitionTestBuilder 스크립트 포함은 검사 정의에 대한 테스트 검사 요청을 빌드할 수 있는 메서드를 제공합니다.

    이 스크립트 포함에는 프레임워크(sn_agent) 스토어 애플리케이션이 필요하며 에이전트 클라이언트 수집기sn_agent 네임스페이스 내에서 제공됩니다. 자세한 내용은 에이전트 클라이언트 수집기를 참조하십시오.

    REST API 솔루션은 에이전트 클라이언트 수집기 API를 참조하십시오.

    이 스크립트 포함은 다음을 가능하게 하는 메서드를 제공합니다.
    • 검사 정의를 테스트로 설정
    • 테스트를 실행할 구성 항목 설정
    테스트 중에 사용할 다음 식별자 중 하나를 지정할 수도 있습니다.
    • 자격 증명 sys_id
    • 자격 증명 별칭 ID
    • 자격 증명 이름

    CheckDefinitionTestBuilder - CheckDefinitionTestBuilder()

    CheckDefinitionTestBuilder 인스턴스를 만듭니다.

    표 1. 매개변수
    이름 유형 설명
    안 함

    다음 예제에서는 CheckDefinitionTestBuilder를 초기화하는 방법을 보여 줍니다.

    var builder = new sn_agent.CheckDefinitionTestBuilder();

    CheckDefinitionTestBuilder - build()

    인수가 설정된 테스트 검사 요청을 빌드합니다.

    표 2. 매개변수
    이름 유형 설명
    없음
    표 3. 반환
    속성 설명
    객체 두 가지 속성(테스트 결과 기록 ID와 오류)이 있는 JSON 객체입니다. 빌드에 성공하면 테스트 결과 ID가 반환되고 오류는 null입니다. 빌드 중에 오류가 발생하면 테스트 결과 ID가 null이고 오류가 표시됩니다.

    다음 예제에서는 테스트 검사 요청을 빌드하는 방법을 보여줍니다.

    var checkId = "158279505372b30034b8ddeeff7b1270";
var ciId = "cc0dcc855374301062d1ddeeff7b12b0";
var builder = new sn_agent.CheckDefinitionTestBuilder();

var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();

if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder - withCheckId(문자열 checkId)

    테스트할 검사 정의의 sys_id 설정합니다.

    표 4. 매개변수
    이름 유형 설명
    확인 ID 문자열 검사 정의 [sn_agent_check_def] 테이블에 나열된 검사 정의의 Sys_id입니다.
    표 5. 반환
    유형 설명
    CheckDefinitionTestBuilder 메서드가 호출된 빌더 인스턴스입니다.

    다음 예는 테스트 검사를 생성하는 방법을 보여줍니다.

    var checkId = "158279505372b30034b8ddeeff7b1270";
var ciId = "cc0dcc855374301062d1ddeeff7b12b0";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder - withCiId(문자열 ciId)

    테스트를 실행할 구성 항목의 sys_id 설정합니다.

    표 6. 매개변수
    이름 유형 설명
    ciId 문자열 CMDB 구성 항목의 Sys_id.
    표 7. 반환
    유형 설명
    CheckDefinitionTestBuilder 메서드가 호출된 빌더 인스턴스입니다.

    다음 예시는 다음을 사용하여 테스트 검사 요청을 생성하는 방법을 보여줍니다.

    var checkId = "158279505372b30034b8ddeeff7b1270";
var ciId = "cc0dcc855374301062d1ddeeff7b12b0";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder - withCredentialsAliasId(문자열 credentialsAliasId)

    테스트 중에 사용할 자격 증명 별칭 sys_id 설정합니다.

    주:
    이를 실행하면 withCredentialsName, withCredentialsAliasId 또는 withCredentialsAliasName을 호출하여 수행된 모든 이전 할당이 제거됩니다.
    표 8. 매개변수
    이름 유형 설명
    자격 증명 별칭 ID 문자열 자격 증명 기록의 Sys_id.
    표 9. 반환
    유형 설명
    CheckDefinitionTestBuilder 메서드가 호출된 빌더 인스턴스입니다.

    다음 예에서는 테스트 검사를 생성하고 자격 증명 별칭 ID를 설정하는 방법을 보여줍니다.

    var checkId = "158279505372b30034b8ddeeff7b1270";
var credAlias = "<sys_id>";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsAliasId(credAlias).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder - withCredentialsAliasName(문자열, credentialsAliasName)

    테스트 중에 사용할 자격 증명 별칭 이름을 설정합니다. 지정된 값이 여러 자격 증명 별칭 레코드의 이름과 일치하면 그 중 하나가 임의로 선택됩니다.

    주:
    이를 실행하면 withCredentialsName, withCredentialsAliasId 또는 withCredentialsAliasName을 호출하여 수행된 모든 이전 할당이 제거됩니다.
    표 10. 매개변수
    이름 유형 설명
    credentialsAliasName 문자열 자격 증명 별칭의 이름입니다.
    표 11. 반환
    유형 설명
    CheckDefinitionTestBuilder 메서드가 호출된 빌더 인스턴스입니다.

    다음 예시에서는 테스트 검사를 생성하고 자격 증명 별칭 이름을 설정하는 방법을 보여줍니다.

    var checkId = "158279505372b30034b8ddeeff7b1270";
var credentialsAliasName = "credentialsAliasName";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsAliasName(credentialsAliasName).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder - withCredentialsId(문자열 credentialsId)

    테스트 중에 사용할 자격 증명 sys_id 설정합니다.

    주:
    이를 실행하면 withCredentialsName, withCredentialsAliasId 또는 withCredentialsAliasName을 호출하여 수행된 모든 이전 할당이 제거됩니다.
    표 12. 매개변수
    이름 유형 설명
    자격 증명Id 문자열 자격 증명 기록의 Sys_id.
    표 13. 반환
    유형 설명
    CheckDefinitionTestBuilder 메서드가 호출된 빌더 인스턴스입니다.

    다음 예시에서는 테스트 검사를 생성하고 자격 증명 ID를 설정하는 방법을 보여줍니다.

    var checkId = "158279505372b30034b8ddeeff7b1270";
var credID = "<sys_id>";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsId(credID).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder - withCredentialsName(문자열, credentialsName)

    테스트 중에 사용할 자격 증명 이름을 설정합니다. 지정된 값이 여러 자격 증명 기록의 이름인 경우 그 중 하나가 임의로 선택됩니다.

    주:
    이를 실행하면 withCredentialsName, withCredentialsAliasId 또는 withCredentialsAliasName을 호출하여 수행된 모든 이전 할당이 제거됩니다.
    표 14. 매개변수
    이름 유형 설명
    자격 증명 이름 문자열 자격 증명 기록의 이름입니다.
    표 15. 반환
    유형 설명
    CheckDefinitionTestBuilder 메서드가 호출된 빌더 인스턴스입니다.

    다음 예시에서는 테스트 검사를 생성하고 자격 증명 이름을 설정하는 방법을 보여줍니다.

    var checkId = "158279505372b30034b8ddeeff7b1270";
var credname = "credentialsName";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsName(credName).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);