本文へスキップ

ドキュメント 管理

MDMで展開

Jamf Pro、Kandji、Microsoft Intuneなどのデバイス管理(MDM)ツールでMacを管理している場合は、ライセンスキーファイルを使って、それらのMacでVMPalを認証できます。VMPalは、起動時やファイルが変更されたときにファイルを読み込み、自動的にキーを認証します。組織のキーを必須にして、そのキーなしではVMPalを使えないようにすることもできます。また、ライセンス管理では、機能をオフにしたり、Macのアップデート先のバージョンを選んだりできます。Windows版VMPalもキーファイルを読み込みます。詳しくはWindows PCの場合をご覧ください。

ライセンスキーファイルと以下の制限を使うには、それらに対応したバージョンのVMPalが必要です。古いバージョンでは無視されます。

キーファイルを作成する

キーファイルは、.vmpallicensekeyという名前のプレーンテキストファイルです。1行目にライセンスキーを書きます。

VP-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
require: true

requireの行は省略できます。

  • require: true:キーが認証されるまでVMPalを使えず、ユーザは別のキーを認証できません。
  • require: false、またはrequireの行がない場合:キーを認証しますが、組織のキーを認証できない間は、ユーザが自分のライセンスを使い続けたり、認証したりできます。

補足事項は次のとおりです。

  • キーはkey: VP-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXXと書くこともできます。
  • requireにはyesとno、1と0、onとoffも使え、require = trueという書き方もできます。それ以外の値はtrueとみなされます。
  • #で始まる行はコメントです。VMPalは、知らないフィールドを無視します。
  • 空行とコメントだけのファイルは、ファイルがないものとして扱われます。フィールドはあってもキーがないファイルは無視されます。例外は/Users/Sharedにあるrequire: trueです。キーがなくてもキーを必須にするため、ファイルにキーが書かれるまでVMPalは使えません。
  • UTF-8のテキストとして保存してください。

キーファイルをインストールする

ファイルは/Users/Shared/.vmpallicensekeyにインストールします。所有者はrootにして、rootだけが書き込めるようにします(所有者root:wheel、モード0644)。すると、VMPalはMacのすべてのユーザに対してキーを認証し、Mac 1台につき1シートを使います。

次のスクリプトを、たとえばMDMポリシーのスクリプトとして、rootで実行します。キーを必須にせずに認証だけを行う場合は、"require: true"を省いてください。

#!/bin/sh
set -eu
KEY="VP-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
KEY_FILE="/Users/Shared/.vmpallicensekey"

# Any user can create files in /Users/Shared: write the file under a new name
# only root can change, then move it over whatever is at KEY_FILE. -h replaces
# a link there instead of following it
TMP_FILE=$(mktemp /Users/Shared/.vmpallicensekey.XXXXXX)
printf '%s\n' "$KEY" "require: true" > "$TMP_FILE"
chown root:wheel "$TMP_FILE"
chmod 0644 "$TMP_FILE"
rm -rf "$KEY_FILE"
mv -fh "$TMP_FILE" "$KEY_FILE"
# Fails if a user made a folder there meanwhile: run the script again
[ -f "$KEY_FILE" ] && [ ! -L "$KEY_FILE" ]

スクリプトと同じように、ファイルの所有者をrootにし、rootだけが書き込めるようにしておいてください。VMPalは、所有者が誰であっても、/Users/Sharedにあるキーファイルを適用します。ファイルを所有するユーザはファイルを変更したり削除したりできるため、ユーザが変更できるファイルではrequireを回避されてしまいます。シンボリックリンクではなく、ファイルそのものをインストールしてください。VMPalは、/Users/Shared/.vmpallicensekeyにあるシンボリックリンクを無視します。ハードリンクは、ファイルそのものとして読み込まれます。ハードリンクはMac上のどこにあってもファイルの別名にすぎないため、何も変わりません。

VMPalは、認証したライセンスをキーファイルの隣の/Users/Shared/.vmpallicenseに保存します。そのため、Macのすべてのユーザがライセンスを共有し、ユーザごとに別のシートを使うことはありません。このファイルを事前に作成する場合は、すべてのユーザが書き込めるようにしてください(モード0666)。ファイルが存在していてユーザが書き込めない場合、認証は「VMPalはライセンスを/Users/Sharedに保存できませんでした。」というメッセージで失敗します。VMPalは、その隣の.vmpallicensepolicyに、ライセンスの所有者のポリシーのうち最後に取得したものも保存します。

ユーザ1人だけにキーファイルをインストールすることもできます。場所は~/Library/Application Support/com.tableplus.VMPal/.vmpallicensekeyです。この場合、VMPalはそのユーザのライセンスを同じフォルダに保存します。ユーザは自分のフォルダのファイルを削除できるため、VMPalはそこではrequireを無視します。/Users/Sharedのキーファイルは、ユーザのフォルダのキーファイルより優先されます。

ユーザに表示される内容

VMPalは起動時にキーファイルを読み込みます。起動している間は、新しいキーファイルや変更されたキーファイルを約1分以内に検出します。

/Users/Sharedにキーファイルがある場合 VMPalの動作
ライセンスなし 確認せずに組織のキーを認証します。
ユーザが入力したライセンス 「このMacのVMPalは組織によって管理されています」と表示してから、ユーザのライセンスの代わりに組織のキーを認証します。ユーザのライセンスはMacから削除され、そのシートは解放されます。
すでに組織のキーで認証済み 何もしません。設定 › ライセンスには「VMPalは、管理者がこのMacに設定したライセンスキーで認証されています。」と表示され、認証対象: このMacのすべてのユーザが表示されます。このMacの認証を解除は表示されません。

キーを認証できない場合、VMPalは「ライセンスキー****1234を認証」というアラートで理由を表示します(1234の部分はキーの最後の4文字です)。アラートには次のボタンがあります。

  • やり直す:VMPalがライセンスサーバに接続できなかった場合や、サーバに問題があった場合。
  • ライセンス所有者にメール:すべてのシートが使用中の場合や、ライセンスのアップデート期間が終了している場合。追加のライセンス管理者(いない場合はライセンスの所有者)宛てのメールを作成します。メールには、キーの最後の4文字、理由、Macの名前、macOSとVMPalのバージョンが含まれます。
  • 以前のビルドをダウンロード:このバージョンのVMPalが、ライセンスのアップデート期間の終了後に公開された場合。VMPalをダウンロード:このビルドが取り下げられた場合。どちらも、ライセンスの対象となる最新のバージョン、またはアップデートで選んだバージョンをダウンロードします。
  • 別のキーを試すと無料版を使う:ライセンスのないMacで、キーが必須でない場合。それ以外の場合はOKです。

VMPalがこのアラートを表示するのは、起動ごとに最大1回です。キーの認証は、あとで再試行します。requireがない場合、自分のライセンスを使い続けているユーザは、以降の再試行でVMPalが組織のキーを認証するまで、そのライセンスを使えます。

require: trueの場合

  • 組織のキーが認証されるまで、VMPalは「ライセンスキー****1234を認証中」と表示し、VMとHubの読み込み、ウインドウの表示、ターミナルのタブの復元、ログイン時に起動するVMの起動、コーディングエージェントやvmpalへの応答を行いません。ログイン時に開いた場合、VMPalはDockに表示され、誰かが気づくまでアイコンが跳ね続けます。
  • 認証に失敗した場合、VMPalは理由を表示し、やり直す、ライセンス所有者にメール(すべてのシートが使用中、またはアップデート期間が終了している場合)、以前のビルドをダウンロード(バージョンがライセンスに対して新しすぎる場合)、VMPalをダウンロード(このビルドが取り下げられた場合)、終了を表示します。「終了」を選んでも、VMPalが復元するターミナルのタブは次回の起動のために残ります。
  • VMPalは自動でも再試行します。ネットワークやサーバのエラーのあとは1分ごと、それ以外は15分ごとです。キーファイルも1分ごとに読み直すため、修正したキーファイルは1分以内に反映されます。
  • ユーザは別のキーを認証できません。設定 › ライセンスには組織のキーが伏せ字で表示され、認証があります。そこで入力したキーや、vmpal://license/activateリンクから渡されたキーには、「このMacは組織のライセンスキー****1234でのみ認証できます。変更するには管理者に連絡してください。」と表示されます。
  • VMPalがセッションの途中で終了することはありません。VMPalの起動中にMacがライセンスを失った場合、VMPalは組織のキーをもう一度認証しようとし、できなければ「このキーが認証されるまで、VMPalを再び開くことはできません。」と表示します。キーが認証されるまでは、実行中のVMはそのまま動作しますが、新たにVMを起動することはできず、vmpalはVMPalを使えず、VMPalの次回の起動はブロックされます。
  • VMPalの起動中にキーファイルをインストールまたは変更した場合、VMPalは約1分以内に組織のキーを認証します。それまでの間、VMPalがキーファイルから認証したライセンスは、VMも含めて引き続き使えます。ただし、ユーザが入力したライセンスの場合は、VMを起動できず、vmpalもVMPalを使えません。
  • 初回の起動には、vmpal.comへの接続が必要です。

VMとコマンドライン

各VMは専用のプロセスで動作し、このプロセスはVMPalのウインドウなしで起動できます。DockのVMのアイコンから、ログイン時に起動に設定したVMならログイン時に、またはvmpalから起動します。これらのプロセスとvmpalは、ライセンスファイルを自分で読み込むため、同じルールに従います。

  • require: trueの場合、Macに組織のキーのライセンスがない間は、VMは起動しません。「仮想マシンを起動できません」と表示され、VMPalを開くからVMPalを開いてキーを認証できます。
  • 同じ状況では、VMPalを必要とするvmpalコマンドは、「VMPal can't be used until it's activated with your organization's license key ****1234, as device management requires. Open VMPal to activate it.」というメッセージですぐに失敗します。
  • 例外は、VMPalがキーファイルから認証したライセンスです。キーを変更したあとなど、VMPalがそのライセンスの代わりに組織のキーを認証している間も、VMは起動でき、vmpalも使えます。
  • 以下の制限は、各VMにも適用されます。

機能とアップデートを制限する

ライセンス管理で設定するライセンスキーのVMPalのポリシーセクションは、キーファイルで認証したか手動で認証したかにかかわらず、そのキーで認証したすべてのMacとPCに適用されます。この設定は、ライセンスの所有者と追加のライセンス管理者が変更できます。ライセンス管理はアクセスリンクから開きます。

設定 Macでの動作
コーディングエージェントを無効にする(MCPとエージェントによる操作) VMPalのMCPサーバ、コーディングエージェントへのVMPalの追加、すべてのVMでのエージェントによる操作をオフにします。vmpalはコマンドを拒否します。VMで実行するHubのスクリプトも、エージェントによる操作が必要なため、スキップされます
MacでのHubスクリプトを無効にする Mac自体で実行するスクリプトの実行を、「今すぐ実行」からでもvmpalからでもスキップします。エージェントやvmpalは、そこでスクリプトを実行させることができません。VM内のスクリプトは引き続き実行されます
クラッシュレポートを無効にする VMPalとVMからのクラッシュレポートをオフにします
共有フォルダを無効にする すべてのVMで共有フォルダをオフにします
クリップボードとドラッグ&ドロップを無効にする すべてのVMで、クリップボードの共有と、VMとの間でのファイルのドラッグをオフにします。リモートコントロールでも、別のMacの画面へのファイルのドロップと、そこからのファイルのドラッグがオフになります
リモートコントロールを無効にする ほかのMacからそのMacに接続できなくなり、そのMacからほかのMacにも接続できなくなります。リモートコントロールのスイッチはオフのままになり、ウインドウ、コンピュータを追加…、コーディングエージェントからほかのMacにアクセスできなくなります
アップデート 自動(利用可能な最新版):ライセンスで許可されている最新のバージョンにMacをアップデートします。バージョンを選ぶと、ここで変更するまでMacをそのバージョンに留めます

共有フォルダ、クリップボード、リモートコントロールの制限には、MacにVMPal 0.95以降が必要です。それより前のバージョンでは、共有フォルダとクリップボードを両方とも無効にしている間だけ、2つをまとめてオフにします。

Mac上では、オフにした機能の設定が淡色表示になり、「ライセンスの所有者によって無効にされています。ロックを解除するには管理者に連絡してください。」と表示されます。設定 › ライセンスでは、それらが制限の下に一覧表示されます。コーディングエージェントとvmpalには、「The license owner turned off coding agents for VMPal on this Mac. Contact your admin to unlock it.」と伝えられます。各VMは自身の設定を保持しており、機能を再びオンにすると元に戻ります。

アップデートには、ライセンスの購入時に最新だったバージョンと、それ以降でライセンスの対象となるバージョンが一覧表示されます。バージョンを選ぶと、VMPalはそれより新しいバージョンをインストールせず、古いバージョンに戻ることもありません。すでに新しいバージョンを使っているMacは、そのバージョンのままです。アップデート画面と設定 › 情報には、「ライセンスの所有者が承認したアップデートはビルド88までです。」と表示されます。バージョンを選ぶ前にVMPalがダウンロードしたアップデートは、VMPalの終了時にインストールされます。選んだバージョンが取り下げられた場合は、自動(利用可能な最新版)、つまりライセンスで許可されている最新のバージョンにMacがアップデートされます。

VMPalが変更を取得するのは、起動時、前面に表示されたとき(最大で1時間に1回)、そしてキーファイルのあるMacでは6時間ごとです。変更はVMPalと実行中のVMにすぐに適用されますが、次の例外があります。

  • 再びオンにしたクラッシュレポートは、VMPalまたは各VMの次回の起動から有効になります。
  • macOS 13のVMの共有フォルダは、VMの次回の起動時に変わります。
  • すでに進行中のHubの実行は続行されます。待機中の実行はスキップされます。

ライセンスを失ったMacは、キーファイルがインストールされている限り、最後のポリシーを保持します。ポリシーのセクションが表示されない場合は、お使いのライセンスキーで有効にするようお問い合わせください。

MDMツールでVMPalのアップデートを直接インストールする場合は、ライセンスの対象となるバージョン、またはアップデートで選んだバージョンだけをインストールしてください。ライセンスのアップデート期間の終了後に公開されたバージョンは認証できず、require: trueの場合は、古いビルドをインストールするまでVMPalがブロックされます。

キーを変更または削除する

  • キーを変更する:たとえば上のスクリプトで、ファイルを置き換えます。VMPalは約1分以内に、または起動していない場合は次回の起動時に、新しいキーを認証します。新しいキーが認証されるまでは、古いライセンスがVMも含めて引き続き使えます。ただしrequire: trueの場合は、新しいキーが必須になります。新しいキーが認証されるまで、VMPalの次回の起動はそのキーを待ちます。
  • ライセンス管理でライセンスキーを再発行する:キーファイルも新しいキーに更新してください。すでに認証済みのMacは引き続き使えますが、認証が必要なMacは古いキーを使えず、require: trueの場合はブロックされます。
  • Macを解放する:キーファイルを削除するか(rootでrm -f /Users/Shared/.vmpallicensekey)、空にします。約1分以内に、または起動していない場合は次回の起動時に、VMPalはMacの登録を解除します。これにより、シートが解放され、ライセンスが削除され、制限が解除されます。その時点でMacがvmpal.comに接続できない場合、シートは使用中のままになるので、ライセンス管理でそのMacを削除してください。

フィールドはあってもキーがないファイルなど、VMPalが読み取れないキーファイルでは何も変わりません。

Windows PCの場合

Windows版VMPalも、同じ形式のライセンスキーファイルを読み込み、アラート、require、キーの変更と削除について同じルールに従います。違いは次のとおりです。

PCの場合
すべてのユーザ用のキーファイル C:\ProgramData\VMPal\.vmpallicensekey。requireが有効なのはこの場所だけです
1人のユーザ用のキーファイル %LOCALAPPDATA%\VMPal\.vmpallicensekey
すべてのユーザ用のライセンス C:\ProgramData\VMPal\.vmpallicense。PCに紐づけて暗号化され、隣の.vmpallicensepolicyに最後のポリシーが保存されます
キーファイルで無視した内容の記録 %LOCALAPPDATA%\VMPal\Logs\License.log

キーファイルには、UTF-8、またはメモ帳やWindows PowerShellが保存するようなバイトオーダーマーク付きのUTF-16を使えます。リンク(シンボリックリンクまたはジャンクション)になっているキーファイルや、1MBを超えるキーファイルは無視されます。

PCにキーファイルをインストールする

C:\ProgramDataには、どのユーザでもフォルダを作成でき、フォルダを作成した人はその中身を削除できます。そのため、このスクリプトはまず、誰が作成したかにかかわらず、C:\ProgramData\VMPalの所有権をAdministratorsグループに渡します。スクリプトは、たとえばMicrosoft Intuneのプラットフォームスクリプトとして、管理者またはSYSTEMで実行してください。キーを必須にせずに認証だけを行う場合は、"require: true"を省いてください。

$ErrorActionPreference = "Stop"
$Key = "VP-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
$Folder = Join-Path $env:ProgramData "VMPal"
$KeyFile = Join-Path $Folder ".vmpallicensekey"

# Administrators own the folder. Users can read it and add files, such as
# VMPal's shared license, but can't change or delete the administrators' files
New-Item -ItemType Directory -Force -Path $Folder | Out-Null
takeown /F $Folder /A | Out-Null
$Acl = New-Object Security.AccessControl.DirectorySecurity
$Acl.SetOwner([Security.Principal.SecurityIdentifier]"S-1-5-32-544")
$Acl.SetAccessRuleProtection($true, $false)
$Both = "ContainerInherit, ObjectInherit"
foreach ($Rule in @(("S-1-5-18", "FullControl", $Both, "None"),
                    ("S-1-5-32-544", "FullControl", $Both, "None"),
                    ("S-1-5-32-545", "ReadAndExecute", $Both, "None"),
                    ("S-1-5-32-545", "CreateFiles", "None", "None"),
                    ("S-1-3-0", "FullControl", $Both, "InheritOnly"))) {
    $Acl.AddAccessRule((New-Object Security.AccessControl.FileSystemAccessRule(
        [Security.Principal.SecurityIdentifier]$Rule[0], $Rule[1], $Rule[2], $Rule[3], "Allow")))
}
Set-Acl -LiteralPath $Folder -AclObject $Acl

# Written under a new name, then moved to the key file's path
$Temp = "$KeyFile." + [guid]::NewGuid().ToString("N")
[IO.File]::WriteAllLines($Temp, [string[]]($Key, "require: true"))
$Old = Get-Item -LiteralPath $KeyFile -Force -ErrorAction SilentlyContinue
if ($Old -and $Old.PSIsContainer) { throw "$KeyFile is a folder: delete it, then run this script again" }
# Deletes a link itself, never what it points to
if ($Old) { [IO.File]::Delete($KeyFile) }
# Fails if a user made a file there meanwhile: run the script again
Move-Item -LiteralPath $Temp -Destination $KeyFile

PCでは次のようになります。

  • require: trueの場合、VMPalはウインドウを開く前、リモートコントロールをオンにする前、サインイン時に起動するよう設定されたVMを起動する前に、「Activating license key ****1234」と表示します。サインイン時に起動するものがない場合、VMPalは待ちません。
  • 組織のキーが認証されるまで、VMは起動しません。「Device management requires VMPal to be activated with your organization's license key ****1234 before VMs can start.」と表示されます。コーディングエージェントとvmpalは、Macと同じように拒否されます。入力したキーには、「This PC can only be activated with your organization's license key ****1234. Contact your admin to change it.」と表示されます。
  • VMPalは、起動時と1時間ごとに、また必須のキーを待っている間は1分ごとに、ライセンスを確認します。キーファイルは1分ごとに読み込みます。
  • Download the Old BuildとDownload VMPalは、ライセンスの対象となる最新のWindows版VMPalをダウンロードします。

ポリシーはPCにも適用されます。

設定 PCでの動作
コーディングエージェントを無効にする(MCPとエージェントによる操作) VMPalのMCPサーバとvmpalは、VM内からの呼び出しも含めてすべての呼び出しを拒否し、各VMの設定でエージェントによる操作が淡色表示になります
MacでのHubスクリプトを無効にする 何もしません。Windows版VMPalにはHubがありません
クラッシュレポートを無効にする VMPalからのクラッシュレポートをオフにします。再びオンにすると、VMPalの次回の起動から有効になります
共有フォルダを無効にする 実行中のVMも含め、すべてのVMで共有フォルダをオフにします。コーディングエージェントによるコピーは、コーディングエージェントも無効にしていない限り、引き続き使えます
クリップボードとドラッグ&ドロップを無効にする クリップボードの共有と、VMとの間でのファイルのコピーやドラッグをオフにします。拡張セッションには、次回の接続から反映されます。リモートコントロールでは、クリップボードとファイルのドロップが双方向ともオフになります
リモートコントロールを無効にする ほかのコンピュータからそのPCに接続できなくなり、そのPCからほかのコンピュータにも接続できなくなります。すでに開いている接続は終了します
アップデート PCは常に、ライセンスで許可されている最新のバージョンにアップデートされます。選んだバージョンはMacにだけ適用されます
PCに表示されるメッセージ 対処方法
VMPal couldn't save the license in C:\ProgramData\VMPal. スクリプトをもう一度実行してください。スクリプトにより、すべてのユーザがフォルダにファイルを追加できるようになります。
VMPal couldn't save the license on this PC. ユーザのフォルダにキーファイルがある場合は、ユーザが%LOCALAPPDATA%\VMPalに書き込めることを確認してください。

トラブルシューティング

メッセージ 対処方法
このライセンスのライセンス数をすべて使用しています。 ライセンス管理で使わなくなったMacを削除するか、シートを追加してください。
このライセンスキーは無効です。 ファイル内のキーを確認してください。ライセンスキーを再発行したあとは特に注意してください。
このバージョンのVMPalは、ライセンスのアップデート期間の終了後に公開されました。 以前のビルドをダウンロードで古いビルドをインストールするか、ライセンスを更新してください。
このビルドは登録から削除されました。VMPalをアップデートしてから、もう一度お試しください。 同じアラートのVMPalをダウンロードで、別のバージョンをインストールしてください。ライセンスの対象となる最新のバージョン、またはアップデートで選んだバージョンがダウンロードされます。
VMPalはライセンスサーバに接続できませんでした。ネットワーク接続を確認してから、もう一度お試しください。 MacがHTTPSでvmpal.comに接続できることを確認してください。VMPalは、vmpal.comからのリダイレクトには従いません。
VMPalはライセンスを/Users/Sharedに保存できませんでした。 /Users/Shared/.vmpallicenseを削除するか、リンクではなく、すべてのユーザが書き込めるファイル(モード0666)にしてください。
VMPalはライセンスをこのMacに保存できませんでした。 ユーザのフォルダにキーファイルがある場合は、ユーザが~/Library/Application Support/com.tableplus.VMPalに書き込めることを確認してください。
VMPalはこのライセンスキーを認証できませんでした。 時間をおいてもう一度お試しください。問題が続く場合はお問い合わせください。
仮想マシンを起動できません VMPalを開いてください。VMPalが組織のキーを認証します。

VMPalは、知らないフィールドや、trueとして読み取ったrequireの値など、キーファイルで無視した内容をログに記録します。確認するには、次のコマンドを実行します。

log show --last 1d --predicate 'eventMessage CONTAINS "License key file"'

ローカルの管理者は、キーファイルを削除できてしまいます。すべてのMacをキーファイルに対応したバージョンに保つには、MDMツールでVMPalのアップデートを管理してください。