Installomatorのパラメータの紹介

管理されているmacOSデバイスに、最新バーションのアプリケーションを配布する方法として、Installomatorというスクリプトがあります。

以前、Jamf ProとInstallomatorで常に最新のアプリケーションを配布するの記事では基本的な使い方を紹介しました。 今回はInstallomatorをより深く理解するために、Installomatorで使用できるパラメータたちを紹介します。

v10.5時点の情報であるため、バーションアップに伴い情報に差異が発生する可能性がある点に注意してください。

この記事はcorp-engr 情シスSlack（コーポレートエンジニア x 情シス）#1 Advent Calendar 2024の9日目の記事でもあります。

• Installomatorの挙動を制御するパラメータ
  • DEBUG
  • LOGGING
  • NOTIFY
  • NOTIFY_DIALOG
  • LOGO
  • BLOCKING_PROCESS_ACTION
  • PROMPT_TIMEOUT
  • IGNORE_APP_STORE_APPS
  • SYSTEMOWNER
  • INSTALL
  • REOPEN
  • INTERRUPT_DND
  • IGNORE_DND_APPS
  • RETURN_LABEL_NAME
  • DIALOG_CMD_FILE
  • DIALOG_LIST_ITEM_NAME
• Installomatorのラベルに関するパラメータ
  • 必須のパラメータ
  • バージョン情報に関する任意のパラメータ
  • 任意のパラメータ
• Installomator実行時にパラメータを変更する
  • パラメータとして用意されている関数を変更する
• 終わりに

Installomatorの挙動を制御するパラメータ

スクリプト内にはいくつかのデフォルト設定がありますが、スクリプトを呼び出すときにカスタマイズできます。

DEBUG

デバッグモードに関する設定です。

LOGGING

ログの出力に関する設定です。

NOTIFY

ユーザーに表示される通知を制御する設定です。

通知方法の優先順位は以下のとおりです。

1. NOTIFY_DIALOG パラメータが有効で、swiftDialogのバージョン2以上がインストールされている場合、swiftDialogが使用されます。
2. Jamf Proでエンロールされている場合、Management Action.appが使用されます。
3. Workspace ONEでエンロールされている場合、Hub CLIが使用されます。
4. swiftDialogのバージョン2以上がインストールされている場合、swiftDialogが使用されます。
5. AppleScriptを使用した通知センターへの通知が使用されます。

NOTIFY_DIALOG

swiftDialogを使用するかどうかを制御する設定です。

LOGO

実行中のブロッキングプロセスがあった場合のダイアログに表示されるアイコンを指定する設定です。

プリセットとして、エンロールされているMDMのアイコンを指定できます。 また、LOGOパラメータはパスを許容しているため、たとえば/Applications/Google\ Chrome.app/Contents/Resources/app.icnsのように任意のアイコンを指定できます。

BLOCKING_PROCESS_ACTION

アプリケーションのインストールまたは更新時に実行中のブロッキングプロセスを検出したときのスクリプトの動作を制御する設定です。

アプリケーションにupdateTool変数が定義されている場合は、updateToolでの更新が終わり次第、Installomatorが終了するため、BLOCKING_PROCESS_ACTIONは実質無視されます。

各処理でブロックするプロセスが3回終了しない場合、Installomatorが終了します。

PROMPT_TIMEOUT

BLOCKING_PROCESS_ACTION変数に、

• prompt_user
• prompt_user_then_kill
• prompt_user_loop

を指定した場合のダイアログのタイムアウト時間を、秒単位で設定します。

デフォルトで86400秒が設定されています。

IGNORE_APP_STORE_APPS

以前にApp Store（Volume Purchase）からインストールされたアプリケーションを処理する方法を制御する設定です。

SYSTEMOWNER

dmg、zip、tbz、bz2ファイルから解凍してインストールするアプリケーションの所有者を制御する設定です。

ユーザーとして実行されるSparkleなどの組込みの更新メカニズムがアプリケーションを更新する場合に有用になることがあります。

INSTALL

アプリケーションのバーション情報が比較できる場合のインストール方法を制御する設定です。

REOPEN

アプリケーションを更新する場合、終了したアプリケーションを再度起動するかどうかを制御する設定です。

INTERRUPT_DND

スクリーンセーバーの起動を妨げるディスプレイアサーションが有効になっている場合の挙動を制御する設定です。

ディスプレイアサーションが有効な状態の主な例は以下の通りです。

• Zoomの会議中
• Microsoft PowerPointのプレゼンテーション中
• ブラウザのアクティブなタブでYouTubeビデオの再生中

どのアプリケーションがディスプレイアサーションを有効にしているかは、以下のコマンドで確認できます。

/usr/bin/pmset -g assertions | /usr/bin/awk '/NoDisplaySleepAssertion | PreventUserIdleDisplaySleep/ && match($0,/\(.+\)/) && ! /coreaudiod/ {gsub(/^.*\(/,"",$0); gsub(/\).*$/,"",$0); print};'

IGNORE_DND_APPS

INTERRUPT_DNDパラメータにnoが設定されている場合、ディスプレイアサーションが有効なアプリケーションを無視する一覧を,（カンマ）区切りで設定します。

以下は例です。

IGNORE_DND_APPS="firefox,Google Chrome,Safari,Microsoft Edge,Opera,Amphetamine,caffeinate"

RETURN_LABEL_NAME

Installomatorスクリプトの出力の末行にラベルに対応するアプリケーション名を出力するかどうかを制御する設定です。

アプリケーションのインストールは実行されません。

別のスクリプトからInstallomatorスクリプトを呼び出す場合などで、ラベル名に対応するアプリケーション名が取得できるため、後続の処理がある場合に有用です。

displayName=$(/usr/local/Installomator/Installomator.sh googlechromepkg RETURN_LABEL_NAME=1 | tail -n 1)
echo "${displayName}"
# Google Chrome

DIALOG_CMD_FILE

Installomatorの進捗に関する情報記録するswiftDialogのコマンドファイルのファイルパスを設定します。

デフォルトでは空文字が設定されています。空文字の場合、Installomatorはコマンドファイルに情報を記録しません。

Installomatorでは進捗に関するswiftDialogのプロセスを起動しないため、Installomatorを実行するプロセスが事前にswiftDialogのプロセスを起動させておく必要があります。

DIALOG_LIST_ITEM_NAME

Installomatorの進捗に関する情報記録するswiftDialogのリストアイテムを設定します。

デフォルトでは空文字が設定されています。

Installomatorのラベルに関するパラメータ

Installomatorのgooglechromepkgなどのラベルには、そのアプリケーションをどのようにインストールするのかを設定する変数および関数が存在します。

# googlechromepkgラベルの例
googlechromepkg)
    name="Google Chrome"
    type="pkg"
    #
    # Note: this url acknowledges that you accept the terms of service
    # https://support.google.com/chrome/a/answer/9915669
    #
    downloadURL="https://dl.google.com/chrome/mac/stable/accept_tos%3Dhttps%253A%252F%252Fwww.google.com%252Fintl%252Fen_ph%252Fchrome%252Fterms%252F%26_and_accept_tos%3Dhttps%253A%252F%252Fpolicies.google.com%252Fterms/googlechrome.pkg"
    appNewVersion=$(getJSONValue "$(curl -fsL "https://versionhistory.googleapis.com/v1/chrome/platforms/mac/channels/stable/versions/all/releases?filter=fraction>0.01,endtime=none&order_by=version%20desc" )" "releases[0].version" )
    expectedTeamID="EQHXZ8M8AV"
    updateTool="/Library/Google/GoogleSoftwareUpdate/GoogleSoftwareUpdate.bundle/Contents/Resources/GoogleSoftwareUpdateAgent.app/Contents/MacOS/GoogleSoftwareUpdateAgent"
    updateToolArguments=( -runMode oneshot -userInitiated YES )
    updateToolRunAsCurrentUser=1
    ;;

ここでは、ラベルにどんなパラメータが用意されているのかを紹介します。

必須のパラメータ

ラベルを構成するには、アプリケーションをダウンロードしてインストールするために以下の値が最低限必要です。

バージョン情報に関する任意のパラメータ

Installomatorには現在インストールれているアプリケーションのバーションと、インストール予定のアプリケーションのバーションを比較するためのパラメータが用意されています。 現在インストールされているアプリケーションのバーションと異なる場合のみ、アプリケーションをインストールするように設定できます。

これにより、余計にアーカイブのダウンロードやインストール処理を実施せずに済むメリットがあります。

インストールされているアプリケーションのバージョン情報を特定するロジック

そもそも現在インストールされているアプリケーションのバージョン情報はどのように取得するのでしょうか。 これは、Installomatorスクリプト内のgetAppVersion関数に定義されています。

getAppVersion関数は以下のロジックおよび優先順位でバージョン情報を特定しています。

1. appCustomVersion関数が定義されていた場合、その関数を実行してバージョン情報を取得する。
2. packageID変数が定義されていた場合、インストールされているpkgのメタデータ（plist）からpkg-versionの値を取得する。値が空文字の場合は次の判定ロジックに進む。
3. targetDir変数に定義されたディレクトリ、/Applications、または/Applications/Utilities配下のappName変数の値のアプリケーション、またはname変数の値の.appディレクトリの存在を確認する。
   • 上記で見つからない場合、Spotlightの検索メタデータでname変数の値に部分一致するアプリケーションディレクトリを取得する。
4. 見つかった.appのディレクトリ配下のContents/Info.plistからversionKey変数で定義したキーの値を取得する。

上記でバーション情報が特定できない場合でもInstallomatorの処理は続行されます。

任意のパラメータ

ラベルには、さまざまなインストールおよび更新に対応できるように、多くの任意のパラメータが用意されています。

Installomator実行時にパラメータを変更する

Installomatorの「挙動を制御するパラメータ」と「ラベルのパラメータ」の2種類を紹介しましたが、これらのパラメータをInstallomatorスクリプトを実行する際に変更できます。

たとえば、googlechromepkgデバッグモードを無効化して、アーカイブのURLをダウンロードする際にユーザーエージェントを付与するとした場合、以下のようにしてInstallomatorスクリプトを実行します。

./Installomator.sh googlechromepkg DEBUG=1 curlOptions=( -H "User-Agent: sample" )

「挙動を制御するパラメータ」に関してはすでによく知られている方法ではありますが、「ラベルのパラメータ」の変更も可能であるため、スクリプトを実行する我々自身でさまざまな応用が可能となります。

パラメータとして用意されている関数を変更する

「ラベルのパラメータ」のappCustomVersionは、変数ではなく関数であるため、設定したい場合はひと工夫が必要です。

`./Installomator.sh googlechromepkg "_=;appCustomVersion(){ echo '1.0.0' }"`

内部では、引数ごとに文字列をeval関数に渡しています。この実装を利用して、変数だけではなく関数も設定できます。

ただ、これはコマンドインジェクションのようなことをやってしまっているため、自己責任でお願いします。

終わりに

今回はInstallomatorの「挙動を制御するパラメータ」および「ラベルのパラメータ」を紹介しました。 これでより深くInstallomatorを理解できるようになったのではないでしょうか。

あんなことができるんじゃないか？あの不具合が解消できるかも！などのきっかけになれば幸いです。

また、このパラメータに関する内容を応用した、「Installomatorでサポートされていないアプリケーションをインストールする」という記事も合わせて書きましたので、ぜひご覧ください。