ライセンスコマンド

ライセンス管理コンソールを使用すると、多くのライセンス管理タスクを簡単に実行できます。一方、コマンドプロンプト上で使用するライセンス管理コマンドでは、管理コンソール上で実行できるタスクに加え、さらに詳細なライセンス管理を行えます。たとえば、lmdiagコマンドでは、ライセンスのチェックアウト時の問題を診断することができます。

ライセンス管理コマンドは、次のフォルダーに配置されます:

  • 32ビットサーバー:C:\Program Files\Citrix\Licensing\LS
  • 64ビットサーバー:C:\Program Files(x86)\Citrix\Licensing\LS

コマンド一覧

コマンド 説明
lmadmin ライセンスの構成を行います。ライセンスの構成および管理タスクについては、ライセンス管理コンソールを使用し、lmadminコマンドは使用しないでください。
lmdiag ライセンスのチェックアウト時の問題を診断します。
lmdown License ManagerデーモンとCitrixベンダーデーモンを正しく停止します(デフォルトでは無効になっています)。
lmhostid ライセンスサーバーの名前を表示します。
lmreread License Managerデーモンにライセンスファイルを再読み込みさせて、Citrixベンダーデーモンを起動します。
lmstat ライセンスサーバーの状態を表示します。
lmutil ライセンス管理コマンドの一覧を表示したり、ほかのコマンドを実行したりします。
lmver ライセンスサーバーのバイナリファイルのバージョン情報を表示します。
udadmin ライセンス済みのすべてのユーザーとデバイスを表示し、特定のユーザーとデバイスを削除します。このコマンドはユーザーまたはデバイスライセンスにのみ適用します。注: udadmin -exportを指定することで、ライセンス一覧ではなく製品の使用状況をエクスポートします。ライセンス一覧を取得するには、udadmin -listを指定します。

ライセンス管理コマンドの表記規則

ライセンス管理コマンドの表記規則は以下のとおりです:

表記規則 説明  
  太字 コマンドまたはスイッチを示します(lmstatなど)。
  斜体 変数を値に置き換えます。たとえば、次のような式になります:lmstat -c license_file_list。実際にコマンドを実行するときは、license_file_listを1つ以上のライセンスファイルの名前に置き換えます。
  [半角の角かっこ] コマンドに追加できるオプション項目を示します。

共通のオプション

次の表は、ライセンス管理コマンドの多くで使用されるオプションを示します:

引数 説明
-all ネットワーク上にあるすべてのライセンスサーバーにコマンドが適用されます。
-c ライセンスファイルまたはライセンスサーバーのポートとホスト名を指定します。ライセンスファイルのファイル名を記述せずにパスのみを指定した場合、そのフォルダーのすべてのライセンスファイルにコマンドが適用されます。ローカルホストの指定:-c @localhost、リモートのライセンスサーバーの指定:-c @servername、クラスター内のライセンスサーバーの指定:-c @clientaccesspointname、パスの指定:-c path、ライセンスファイルの名前の指定:-c license_file_list。複数のライセンスファイルを指定する場合は、各パスをセミコロン(;)で区切ります。パスにスペースが含まれる場合は、二重引用符(”)で囲む必要があります。
-h ライセンスハンドルを指定します。この情報は、lmstat -aコマンドで確認できます。ライセンスハンドルとは、チェックアウトされたライセンスを識別するための番号を指します。
-help コマンドの使用方法を表示します。
-s [server] パラメーターで指定したサーバーのライセンスファイルの情報を表示します。特定のサーバーを指定しない場合、すべてのライセンスサーバーが対象になります。
-verbose 検出されたすべてのエラーの詳細な説明を表示します。

チェックアウト時の問題の診断(lmdiag)

lmdiagコマンド使用すると、ライセンスをチェックアウトできないときの問題を診断できます。特に、ライセンスが有効で、ライセンスサーバーの動作に問題がないかどうかをテストできます。ライセンスサーバー上でこのコマンドを実行すると、ライセンスのチェックアウトが試行されます。

また、lmdiagコマンドを使用して、特定の種類のライセンスが正しく動作しているかどうかについて確認することもできます。たとえば、MPS_ADV_CCUを引数として指定すると、Citrix Virtual AppsサーバーAdvanced Editionの製品ライセンスのみを対象にしてlmdiagコマンドを実行できます。

構文:

lmdiag -c license_file_list [-n] [feature[:keyword=value]]

引数 説明
-c license_file_list 診断するファイルを指定します。-c @localhostまたは-c @server-nameを使用することもできます。
-n 非インタラクティブモードで実行します。このモードでは、lmdiagの実行時に入力が不要です。
feature 診断する製品ライセンスを指定します。
keyword=value 対象となる製品ライセンスの属性を指定します。ライセンスファイルで、1つの製品に対して複数の行が記述されている場合に、対象となる行を特定します。例: lmdiag -c @localhost MPS_ENT_CCU:HOSTID=LICSERV01により、ホストIDが “LICSERV01” であるライセンスのチェックアウトが試行されます。属性名(<keyword>)として指定できるのは、VERSION、HOSTID、EXPDATE、KEY、VENDOR_STRING、およびISSUERです。

featureパラメーターを指定しない場合、すべての製品ライセンスに対してlmdiagコマンドが実行されます。lmdiagコマンドは、指定したライセンスの情報を表示した後、各ライセンスをチェックアウトします。チェックアウトに成功すると、lmdiagコマンドにより成功したことが表示されます。チェックアウトに失敗すると、lmdiagコマンドによりその理由が表示されます。lmdiagコマンドを実行すると、ライセンスサーバー上のすべてのTCP/IPポートへの接続が試行されます。これにより、ライセンスファイルで指定されているポート番号が正しいかどうかが診断され、lmdiagによりリスニング中のTCP/IPポート番号が一覧表示されます。-c<license_file_list>を指定した場合は指定したファイルが診断されます。

lmdiagコマンドでは、ライセンスのチェックアウトを試行するときに、シトリックス製品が動作するサーバーへの接続は行いません。lmdiagコマンドで診断できるのはライセンスサーバー上の問題だけです。つまり、シトリックス製品が不正なライセンスサーバーに接続しているために発生する問題は、lmdiagコマンドでは診断できません。たとえば、ライセンスサーバーにその製品の正しいライセンスが格納されていない場合などです。このため、シトリックス製品側で接続先のライセンスサーバーが正しく設定されていない場合でも、lmdiagコマンドでは正しくチェックアウトできたことを示すメッセージが表示されます。

デーモンの停止(lmdown)

lmdownコマンドを使用すると、ライセンスサーバー上のLicense ManagerデーモンとCitrixベンダーデーモンを停止できますが、このコマンドはデフォルトで無効になっています。有効にするには次の手順に従います:

  1. ライセンスサービスを停止します。
  2. lmadmin - allowStopServerおよび/または-allowRemoteStop Serverを実行します。
  3. ライセンスサーバーを再起動します。

構文:

lmdown -c license_file_list [-vendor CITRIX] [-q] [-all]

引数 説明
-c license_file_listまたは-c@localhostまたは-c@server ライセンスファイルを指定します。lmdownコマンドでは、常に-c license_file_listを指定してください。-c @localhostまたは-c @server-nameを使用することもできます。
-vendor CITRIX Citrixベンダーデーモンだけを停止します。License Managerデーモンは停止されません。
-q 非インタラクティブモードで実行します。そうでない場合は、lmdownが「Are you sure? [y/n]:」を表示します。
-all 複数のサーバーが指定されると、すべてが自動的にシャットダウンされます。-qオプションは-allオプションに含まれます。

lmdownコマンドは、ライセンスサーバー上で実行する必要があります。-allオプションを使用して、ネットワーク上のすべてのライセンスサーバーを停止できます。

lmdownコマンドに複数のサーバーを指定し(-cオプションで指定したパスに複数のライセンスファイルがある場合など)、-allオプションを指定しなかった場合は、停止するライセンスサーバーの選択肢が表示されます。-cオプションを使用して、ライセンスサーバーの名前を指定すれば、リモートのライセンスサーバーを停止できます。

注:

WindowsのタスクマネージャーでCitrixライセンスサービスを終了する場合は、License Managerデーモン(lmgrd.exeプロセス)を停止してから、Citrixベンダーデーモン(CITRIX.exeプロセス)を停止してください。

Citrixベンダーデーモンだけを停止して再起動するには、lmdown -c @localhost -vendor CITRIXを実行してから、lmreread -c @localhost -vendor CITRIXを実行します。

ホスト名の確認(lmhostid)

lmhostidコマンドを使用すると、そのライセンスサーバーのホストIDが表示されます。このコマンドを使用して、ライセンスサーバーのホスト名を確認できます。ライセンスファイルにライセンスサーバーのホスト名が正しく記述されているかどうかを確認することができます。

Citrixライセンスサーバーfor Windowsバージョン11.5以降では、複数のライセンスサーバーがある環境で複数のホストIDが表示されます。

構文:

lmhostid -bindingidentifier

引数(<bindingidentifier>) 説明
-ether アプライアンスのMACアドレスに関連付けられた製品ライセンスで使用します。
-internet TCP/IPアドレスが必要な、Windowsベースのシトリックス製品ライセンスで使用します。
-hostname ライセンスサーバーのホスト名(<hostname>)に関連付けられたWindowsベースのシトリックス製品ライセンスで使用します。注: ライセンスファイルに記述されているホスト名(<hostname>)は、ライセンスサーバーの名前と同じである必要があります(大文字と小文字が区別されます)。

ライセンスファイルとオプションファイルの再読み込み(lmreread)

lmrereadコマンドを使用すると、ライセンスファイルやオプションファイルをCitrixベンダーデーモンで再読み込みできます。ライセンスファイルやオプションファイルが再読み込みされると、Citrixベンダーデーモンで新しいファイルが使用されます。

lmrereadコマンドをリモートで実行することはできません。対象となるデーモンが動作しているライセンスサーバー上でこのコマンドを実行します。

構文:

lmreread -c license_file_list [-all] [-vendor CITRIX]

引数 説明
-c@localhostまたは-c license_file_list ライセンスファイルを指定します。
-all 複数のlmgrdが指定されている場合に、すべてのLicense Managerデーモンで再読み込みを行います。
-vendor CITRIX Citrixベンダーデーモンを再起動します。

例:

  • lmreread -c @localhost [-all]
  • lmreread -c @client_access_point_name
  • lmreread -c /opt/citrix/licensing/myfiles/CITRIX.lic -vendor CITRIX

ライセンス管理コマンド一覧の表示(lmutil)

スタンドアロンで使用する場合、lmutilコマンドを実行すると、ライセンス管理コマンドが表示されます。lmutilにほかのコマンドを付けて指定すると、そのコマンドが実行されます。

構文:

lmutil

lmutil other_command

例:

  • lmutil

    すべてのライセンス管理コマンドを表示します。

  • lmutil lmstat -c @localhost

    lmstatコマンドを実行します。

ライセンス使用状況の確認(lmstat)

lmstat コマンドは、ネットワーク上のライセンスの使用状況を監視するときに便利なツールで、以下のライセンスチェックアウト情報を確認できます:

  • ライセンスをチェックアウトしている製品
  • チェックアウトデータ
  • ライセンスファイルのバージョン
  • ライセンスサーバーの名前とポート番号
  • ライセンスのチェックアウト日時
  • Citrixベンダーデーモンの状態や、ライセンスファイルの情報

lmstatコマンドでは、ライセンスサーバーから取得した情報が表示されます。複数の接続によりライセンスが共有されている場合でも、lmstatコマンドでは使用ライセンス数1として表示されます。

構文:

lmstat [-a] [-c license_file_list] [-f [feature]] [-i [feature] [-s[server] [-S [CITRIX]] [-t timeout_value]

引数 説明
-a すべての情報を表示します。
-c @localhostまたは -c@<server> または-c <license_file_list> 使用するライセンスファイルを指定します。
-f [<feature>] <feature>パラメーターで指定した製品ライセンスを使用している製品を表示します。このパラメーターで製品を指定しない場合、すべての製品ライセンスが対象になります。
-i [<feature>] パラメーターで指定した製品ライセンスのINCREMENT行の情報を表示します。パラメーターを指定しない場合、すべての製品ライセンスが対象になります。
-s [<server>] パラメーターで指定したサーバーのライセンスファイルの情報を表示します。特定のサーバーを指定しない場合、すべてのライセンスサーバーが対象になります。
-S [CITRIX] Citrixベンダーデーモンにより提供されているすべての製品ライセンスの使用サーバーを表示します。
-t <timeout_value> 接続タイムアウトを<timeout_value>に設定します。lmstatコマンドがライセンスサーバーに接続する時のタイムアウトを設定します。

lmstat -c@localhost -aの出力例は、次のとおりです。画面レイアウト上、この例では改行されることがあります。

License server status: 27000@localhost

   License file(s) on localhost: C:\Program Files (x86)\Citrix\Licensing\MyFiles\citrix_startup.lic:C:\Program Files (x86)\Citrix\Licensing\MyFiles\License.lic:

   localhost: license server UP v11.15.0

   Vendor daemon status (on LicenseServer):

      CITRIX: UP v11.15.0

Feature usage info:

   Users of CITRIX: (Total of 10000 licenses issued; Total of 1 licenses in use)

   "CITRIX" v2038.0101, vendor: CITRIX, expiry: permanent(no expiration date)
vendor_string: ;LT=SYS;GP=720;SA=0
floating license

   XDT DDCPrinc-0001.citrix.com XDT XDT_PLT&MPS_PLT_2018.0518 (v1.0) (localhost/27000 102), start Tue 5/8 17:59

Users of CTXLSDIAG: (Total of 10000 licenses issued; Total of 0 licenses in use)

Users of XDT_PLT_CCS: (Total of 200000 licenses issued; Total of 3 licenses in use)

   "XDT_PLT_CCS" v2018.1201, vendor: CITRIX, expiry: 01-dec-2018
vendor_string: ;LT=Retail;GP=720;PSL=10;CL=VDS,VDA,VDE,VDP;SA=0;ODP=0;NUDURMIN=2880;NUDURMAX=525600
floating license

   XDT DDCAux-0001.citrix.com XDT 00001E3A (v2018.0518) (localhost/27000 534201), start Wed 5/9 15:17
   XDT DDCAux-0001.citrix.com XDT 00001E81 (v2018.0518) (localhost/27000 392504), start Wed 5/9 15:18
   XDT DDCAux-0001.citrix.com XDT 00001E0C (v2018.0518) (localhost/27000 419703), start Wed 5/9 15:18

このlmstatの出力でMPS_ENT_CCUの行に含まれる情報は次のとおりです:

    説明
MPS citrix_product_name ライセンスの対象製品です。
mps_server1 hostname シトリックス製品サーバーの名前です。
MPS display ライセンスの対象製品です。
license_server1 server_host ライセンスサーバーの名前です。
27000 port ライセンスサーバーが使用するTCP/IPポートの番号です。
203 handle ライセンスハンドルです。ライセンスハンドルとは、チェックアウトされたライセンスを識別するための番号を指します。
start Wed 3/17 11:56 checkout_time このライセンスが最初にチェックアウトされた日時です。

多くのライセンスがチェックアウトされている環境では、lmstat -c@localhost -aにより多くのネットワークトラフィックが発生する場合があります。

lmstat -aを実行すると、ライセンスのチェックアウトデータを確認できます。

バイナリのバージョンの表示(lmver)

lmverコマンドを実行すると、ライセンス管理コマンドなど、指定したバイナリファイルのバージョン情報が表示されます。ただし、lmadminコマンドのバージョン情報は表示されません。このコマンドのバージョン情報を表示するには、lmadmin -versionを実行します。

構文:

lmver binary

例:

lmver lmdiag

ユーザーやデバイスの表示とライセンスの解放(udadmin)

udadminコマンドを使用すると、ライセンスが割り当てられたユーザーとデバイスを表示したり、特定のユーザーやデバイスのライセンスを解放したりできます。

ユーザーのライセンスの解放が必要になるのは、従業員が退職したり休職したりする場合です。デバイスのライセンスの解放が必要になるのは、デバイスが故障した場合などです。

注意:

上記以外の理由により90日の自動解放期間の前に大量のライセンスを解放することは、Citriのライセンス契約書に反する行為となる場合があります。事前にシトリックスに問い合わせてください。

udadminのコマンドラインヘルプは英語のみで表示されますが、このコマンドは英語以外のシステムでも使用できます。

構文:

udadmin [-options] [-delete -events -export -list -times]
オプション 説明
-f feature name -listまたは-deleteとともに使用して、機能名で指定するユーザーまたはデバイスのライセンスを表示したり、解放したりします。
-user user name ユーザー名で指定するユーザーのライセンスのみを解放します。
-device device name デバイス名で指定するデバイスのライセンスのみを解放します。
-a ライセンスサーバーにインストールされているすべての機能とバージョンを一覧表示します。
引数 説明
-delete ユーザー、機能、またはデバイスのライセンスを一度に1つ解放します。
-events 各機能のユーザー/デバイスライセンスによって記録されたすべてのイベントを、時系列で並べ替えてレポートします。
-export すべてのユーザー/デバイスデータを1つのCSVドキュメントにエクスポートします。最初の行は列のヘッダーです。feature、userの形式です。すべての一意の項目(user、deviceId、versionRequested)が1行で報告されます。同じ項目(userid、deviceid、versionRequested)の余分なライセンス要求は個別には表示されません。タイムスタンプは、最新の要求で更新されます。
-list ライセンスが割り当てられたユーザーとデバイスおよび最後の更新以来の時間を表示します。最後のレポートの15分間に重要なアクティビティが発生した場合は、次の更新までの時間が表示されます。-list -timesを指定すると、タイムスタンプを含む出力が生成されます。
-times -list -timesを指定すると、タイムスタンプを含む出力が生成されます。
引数なしまたは? udadminコマンドの使用情報を表示します。

例:

  • udadmin -list -a

    使用状況データは0分経過しています。次の更新は15分後です。

    ユーザー:

    u01.01 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017)

    u01.04 XDT_ENT_UD 2017.1201 (Thu Sep 14 13:41:07 2017) . . .

    デバイス:

    D.ADV.23 XDT_ADV_UD 2017.1201 (Thu Sep 21 18:31:01 2017)

    D01 XDT_PLT_UD 2017.1201 (Tue Sep 12 14:30:33 2017)

  • udadmin -list -a

    すべての機能、バージョン、ライセンス数、およびライセンス済みのユーザーとデバイスを機能ごとに一覧表示します。

  • udadmin -export

    feature,userId,deviceId,deviceName,versionRequested,versionUserAllocated,versionDeviceAllocated,time

  • udadmin -f XDT_ENT_UD -device dn01.88 -delete

    指定したデバイスに割り当てられているXDT_ENT_UDライセンスを解放します。