[GAS]Jamf APIを利用して指定PCのポリシー実行履歴をまとめた一覧シートを作成

#Google Apps Script

#jamf

t_o_d

2023.03.19

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

t_o_dと申します。
Jamf Proでのデバイス管理の際に、Jamf Pro APIを利用すると容易に情報を取得することができます。
そこでGASを利用して指定したPCのポリシー実行履歴を一覧としてシートに書き出す方法を記録いたします。

結果

今回の手順で以下のような「指定したPCのポリシー実行履歴一覧シート」を作成します。

環境

mac OS Ventura 13.1
Google Apps Script

準備

Jamf APIを利用するためのアカウントを用意してこちらを参考に以下の権限を付与してください。
- Read - Computers

手順

スプレッドシート作成

新規でスプレッドシートを作成してください。
その後、シート内の「拡張機能」タブから「Apps Script」でスクリプトエディタを開いてください。

プロパティ設定

スクリプトエディタを開いたら、スクリプトプロパティに以下の内容を設定してください。

プロパティ	値
BASIC_TOKEN	Jamfユーザー名:Jamfパスワード例: ユーザー名がaaa、パスワードがbbbであれば「aaa:bbb」となります。
CLASSIC_API_BASE	Jamf CLASSIC API URL
PRO_API_BASE	Jamf PRO API URL
SHEET_ID	上記で作成したスプレッドシートID

コード記述

プロパティ設定後、以下の内容をスクリプトエディタの任意のgsファイルに記述します。

const properties = PropertiesService.getScriptProperties().getProperties();
const baseProApi = properties.PRO_API_BASE
const baseClassicApi = properties.CLASSIC_API_BASE

function main(){
  // ポリシー履歴取得
  const bearerToken = getBearerToken();
  const pcName = '対象PC名'
  const policyLogs = getPolicyLogs(bearerToken, pcName)

  // 書き込み用(日時順にsort)
  const headers = [['ID', 'ポリシー名', '実行日時', 'ステータス']]
  const insertPolicyLogs = policyLogs.map(policyLog => {
    return [
      policyLog.policy_id,
      policyLog.policy_name,
      Utilities.formatDate(new Date(policyLog.date_completed_utc), "JST", "yyyy-MM-dd HH:mm:ss"),
      policyLog.status,
    ]
  }).sort((a, b)=> new Date(b[2]) - new Date(a[2]));
  const insertValues = [...headers, ...insertPolicyLogs];

  // 書き込み
  const policySheetId = properties.SHEET_ID
  const policySheet = SpreadsheetApp.openById(policySheetId).getSheets()[0];
  const columns = headers[0].length
  if(policySheet.getLastRow() !== 0){
    policySheet.clearContents(); // 値があれば初期化
  }
  policySheet.getRange(1, 1, insertValues.length, columns).setValues(insertValues);
}

// Bearerトークン取得
function getBearerToken(){
  const basicToken = Utilities.base64Encode(properties.BASIC_TOKEN)
  const res = UrlFetchApp.fetch(`${baseProApi}/auth/token`, {
      method: 'post',
      headers: {
        'Authorization': `Basic ${basicToken}`,
      },
  });
  const json = JSON.parse(res.getContentText());
  return json.token
}

// 指定PCのポリシー履歴取得
function getPolicyLogs(bearerToken, pcName){
  const res = UrlFetchApp.fetch(`${baseClassicApi}/computerhistory/name/${pcName}/subset/PolicyLogs`, {
    method: 'get',
    headers: {
      'Authorization': `Bearer ${bearerToken}`,
      'accept': 'application/json'
    }
  });
  const json = JSON.parse(res.getContentText());
  return json.computer_history.policy_logs
}

実行

コード記述後、8行目の「対象PC名」を任意の値に修正します。
修正後、main関数を実行して、スプレッドシートが以下の内容となることを確認します。

以上です。

まとめ

今後もJamf APIのさまざまなサービスを適宜利用していき、日々の業務改善に努めてまいります。

参考

アノテーション株式会社について

アノテーション株式会社は、クラスメソッド社のグループ企業として「オペレーション・エクセレンス」を担える企業を目指してチャレンジを続けています。「らしく働く、らしく生きる」のスローガンを掲げ、様々な背景をもつ多様なメンバーが自由度の高い働き方を通してお客様へサービスを提供し続けてきました。現在当社では一緒に会社を盛り上げていただけるメンバーを募集中です。少しでもご興味あれば、アノテーション株式会社WEBサイトをご覧ください。