AgentNowHandler - 범위 지정됨

  • 릴리스 버전: Washingtondc
  • 업데이트 날짜 2024년 02월 01일
  • 읽기5분

    • AgentNowHandler Script Include를 사용하면 요청 시 검사 정의를 실행하고, 요청 시 실행 및 테스트 검사 실행의 상태를 확인하고, 요청 시 실행된 백그라운드 검사를 중지할 수 있습니다.

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

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

    AgentNowHandler - AgentNowHandler()

    AgentNowHandler 인스턴스를 만듭니다.

    표 1. 매개변수
    이름 유형 설명
    없음

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

    var handler = new sn_agent.AgentNowHandler();

    AgentNowHandler - getRequestStatus(requestId 문자열)

    지정된 ID로 요청의 상태를 가져옵니다.

    표 2. 매개변수
    이름 유형 설명
    requestId 문자열 runCheckForCis() 메서드를 호출하여 생성된 검사 요청 ID입니다.
    표 3. 반환
    속성 설명
    객체 요청 상태 및 적용 가능한 오류 메시지입니다.
    status 요청 상태입니다.
    가능한 값:
    • done – 확인이 성공했습니다.
    • failure – 확인에 실패했습니다. 자세한 내용은 오류 메시지를 참조하십시오.
    • mid_flow – MID Server에서 요청 출력을 처리하고 있습니다.
    • 처리 중 – 확인이 진행 중입니다.
    • timeout – runCheckForCis() 메서드에 설정된 처리 시간 제한을 초과했는지 확인합니다.

    데이터 유형: 문자열
    err_msg 오류 메시지입니다(있는 경우).
    가능한 값:
    • 관련 CI에 대한 에이전트를 찾을 수 없습니다.
    • 지정된 ID의 신원 조사 요청이 없습니다.
    • 지정된 ID의 요청이 없습니다.
    • 지정된 ID의 테스트 결과가 없습니다.
    • 요청 시간 초과.

    데이터 유형: 문자열

    다음 예제에서는 요청의 상태를 가져오는 방법을 보여 줍니다.

    var handler = new sn_agent.AgentNowHandler();
var check = {checkDefId: "158279505372b30034b8ddeeff7b1270"};
var computerGr = new GlideRecord("cmdb_ci_computer");
computerGr.query();
var requestId = handler.runCheckForCis(computerGr, check, 0, 60);

var reqStatusJson = handler.getRequestStatus(requestId);
gs.info(JSON.stringify(reqStatusJson));

    AgentNowHandler - getTestResultStatus(testResultId 문자열)

    지정된 테스트 결과의 테스트 검사 상태를 가져옵니다.

    표 4. 매개변수
    이름 유형 설명
    테스트결과 ID 문자열 테스트 검사 요청을 만들어 생성된 테스트 결과 ID입니다.
    표 5. 반환
    속성 설명
    status 테스트 결과의 상태입니다.
    가능한 값:
    • 0: 보류 중
    • 1: 진행 중
    • 2: 완료
    • 3: 지정된 ID의 테스트 결과 없음

    데이터 유형: 문자열
    output 상태를 설명하는 출력입니다.

    데이터 유형: 문자열

    다음 예제에서는 완료된 테스트 검사 요청의 결과 상태를 가져오는 방법을 보여 줍니다.

    var testCheckStatusJson = handler.getTestResultStatus("testResultId");
gs.info(JSON.stringify(testCheckStatusJson));

    AgentNowHandler - runCheckForCis(객체 cis, 객체 검사, 번호 우선순위, 번호 시간 제한)

    지정된 구성 항목에 대해 검사를 실행합니다.

    표 6. 매개변수
    이름 유형 설명
    CI GlideRecord 검사가 작동하는 CMDB 테이블(모든 애플리케이션, 호스트 또는 에이전트)의 GlideRecord입니다.
    확인 객체 검사 ID 및 선택적 검사 매개변수를 포함합니다. 
    {
  "checkDefId": "String",
  "params": Object
}
    check.checkDefId 문자열 검사 정의 [sn_agent_check_def] 테이블의 검사 정의 Sys_id.
    check.params 객체 옵션입니다. 매개변수 이름 및 값의 맵입니다. 이러한 설정은 검사 정의의 매개변수 기록과 지정된 값을 재정의하는 데 사용할 수 있습니다. 
    "params": {
  "<parameter name>": "String"
}
    priority 번호 ECC 큐에서 설정할 요청의 우선순위입니다.
    가능한 값:
    • 0: 대화형
    • 1: 신속 처리
    • 2: 표준
    timeout 번호 요청에 대한 시간 제한 값(초)입니다.
    표 7. 반환
    유형 설명
    문자열 생성된 신원 조사 요청의 Sys_id입니다.

    다음 예제에서는 신원 조사를 실행하고 요청 ID를 가져오는 방법을 보여줍니다.

    var handler = new sn_agent.AgentNowHandler();
var check = {checkDefId: "028fcd5067c80010b7b72dbd2685ef4f"};
var computerGr = new GlideRecord("cmdb_ci_computer");
computerGr.query();
var requestId = handler.runCheckForCis(computerGr, check, 0, 60);

gs.info(requestId);

    출력:

    b9cf14aedb5e30106f4810284b961990

    AgentNowHandler - stopBackgroundCheck(requestId 문자열)

    신원 조사를 중지합니다.

    신원 조사를 시작하려면 runCheckForCis() 메서드를 사용합니다.

    표 8. 매개변수
    이름 유형 설명
    requestId 문자열 runCheckForCis() 메서드를 호출하여 생성된 신원 조사 요청의 ID입니다.
    표 9. 반환
    유형 설명
    없음

    다음 예제에서는 신원 조사 실행을 중지하는 방법을 보여 줍니다.

    handler.stopBackgroundCheck(backRequestId);