CheckInstanceTestBuilder - 범위 지정

CheckInstanceTestBuilder 스크립트 포함을 사용하면 검사 인스턴스에서 테스트 검사 요청을 빌드할 수 있습니다.

이 API에는 Framework(sn_agent) 스토어 애플리케이션이 필요 Agent Client Collector 하며 sn_agent 네임스페이스 내에서 제공됩니다. 자세한 내용은 Agent Client Collector를 참조하십시오.

REST API 솔루션은 Agent Client Collector API를 참조하십시오.

이 API에는 다음을 가능하게 하는 메서드가 포함되어 있습니다.

• 검사 인스턴스를 테스트할 것으로 설정
• 테스트를 실행할 구성 항목 설정

테스트 중에 사용할 다음 식별자 중 하나를 지정할 수도 있습니다.

• 자격 증명 sys_id
• 자격 증명 별칭 ID
• 자격 증명 이름

CheckInstanceTestBuilder - CheckInstanceTestBuilder()

CheckInstanceTestBuilder 인스턴스를 만듭니다.

표 1. 매개변수

이름	유형	설명
없음

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

var builder = new sn_agent.CheckInstanceTestBuilder();

CheckInstanceTestBuilder - 빌드()

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

표 2. 매개변수

이름	유형	설명
없음

표 3. 반환

속성	설명
객체	두 가지 속성(테스트 결과 기록 ID 및 오류)이 있는 JSON 객체입니다. 빌드에 성공하면 테스트 결과 ID가 반환되고 error는 null입니다. 빌드 중에 오류가 발생하면 테스트 결과 ID가 null이 되고 오류가 표시됩니다.

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

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

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

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

CheckInstanceTestBuilder - withCheckId(checkId 문자열)

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

표 4. 매개변수

이름	유형	설명
checkId	문자열	검사 정의 [sn_agent_check_def] 테이블에 나열된 검사 정의의 Sys_id입니다.

표 5. 반환

유형	설명
CheckInstanceTestBuilder	메서드가 호출된 작성기 인스턴스입니다.

다음 예제에서는 테스트 검사를 만드는 방법을 보여 줍니다.

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

CheckInstanceTestBuilder - withCiId(String ciId)

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

표 6. 매개변수

이름	유형	설명
ciId	문자열	CMDB 구성 항목의 Sys_id입니다.

표 7. 반환

유형	설명
CheckInstanceTestBuilder	메서드가 호출된 작성기 인스턴스입니다.

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

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

CheckInstanceTestBuilder - withCredentialsAliasId(String credentialsAliasId)

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

주:

이를 실행하면 withCredentialsName, withCredentialsAliasId 또는 withCredentialsAliasName을 호출하여 수행한 이전 할당이 제거됩니다.

표 8. 매개변수

이름	유형	설명
credentialsAliasId	문자열	자격 증명 별칭 기록의 Sys_id입니다.

표 9. 반환

유형	설명
CheckInstanceTestBuilder	메서드가 호출된 작성기 인스턴스입니다.

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

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

CheckInstanceTestBuilder - withCredentialsAliasName(String credentialsAliasName)

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

주:

이를 실행하면 withCredentialsName, withCredentialsAliasId 또는 withCredentialsAliasName을 호출하여 수행한 이전 할당이 제거됩니다.

표 10. 매개변수

이름	유형	설명
credentialsAliasName	문자열	자격 증명 별칭의 이름입니다.

표 11. 반환

유형	설명
CheckInstanceTestBuilder	메서드가 호출된 작성기 인스턴스입니다.

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

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

CheckInstanceTestBuilder - withCredentialsId(문자열 credentialsId)

테스트하는 동안 사용할 sys_id 자격 증명을 설정합니다.

주:

이를 실행하면 withCredentialsName, withCredentialsAliasId 또는 withCredentialsAliasName을 호출하여 수행한 이전 할당이 제거됩니다.

표 12. 매개변수

이름	유형	설명
자격 증명 ID	문자열	자격 증명 기록의 Sys_id입니다.

표 13. 반환

유형	설명
CheckInstanceTestBuilder	메서드가 호출된 작성기 인스턴스입니다.

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

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

CheckInstanceTestBuilder - withCredentialsName(String credentialsName)

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

주:

이를 실행하면 withCredentialsName, withCredentialsAliasId 또는 withCredentialsAliasName을 호출하여 수행한 이전 할당이 제거됩니다.

표 14. 매개변수

이름	유형	설명
자격 증명 이름	문자열	자격 증명 기록의 이름입니다.

표 15. 반환

유형	설명
CheckInstanceTestBuilder	메서드가 호출된 작성기 인스턴스입니다.

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

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

CheckInstanceTestBuilder - withProxyAgentId(String agentId)

테스트를 실행할 에이전트를 설정합니다. 테스트된 검사 인스턴스와 정책이 프록시인 경우에만 허용됩니다.

표 16. 매개변수

이름	유형	설명
agentId	문자열	이 검사를 실행할 에이전트 프록시의 고유 ID입니다. 이 값은 Agent Client Collector [sn_agent_cmdb_ci_agent] 테이블의 에이전트 ID 열에 나열됩니다.

표 17. 반환

유형	설명
CheckInstanceTestBuilder	메서드가 호출된 작성기 인스턴스입니다.

다음 예제에서는 테스트 검사를 생성하고 프록시 에이전트 ID를 설정하는 방법을 보여줍니다.

var checkId = "158279505372b30034b8ddeeff7b1270";
var agentId = "<agentID>";
var builder = new sn_agent.CheckInstanceTestBuilder();
var testResultJson = builder.withCheckId(checkId).withAgentId(agentId).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);