Caché ライセンスの管理

ライセンス・サーバの構成

管理ポータルを使用してライセンス・サーバを構成するには、次を実行します。

1. システム, ライセンス, ライセンスサーバ ページに移動します。

2. これによって、このインストールに対して構成されたライセンス・サーバのリストが表示されます。このページから、既存のサーバ定義を編集または削除したり、新しいサーバを追加できます。

3. ライセンス・サーバを構成するには、[追加] をクリックします。

4. [名前] ボックスにライセンス・サーバの名前を、[ホスト名/IPアドレス] ボックスに実行のホストの IP アドレスを、[ポート] ボックスにライセンス・サーバが使用する UDP ポート番号を入力します。

   Note:

   この名前によって構成内のライセンス・サーバが特定されるため、構成内で一意にする必要があります。

   ライセンス・サーバは、そのライセンス・サーバが実行されているホストの IP アドレスと、通信に使用するポートによって定義されます。ドット十進法形式 (192.29.233.19) や、アルファベット形式 (mycomputer.myorg.com) で IP アドレスを入力できます。IPv6 を有効にした場合は、コロン区切りの形式で IPv6 アドレスを入力できます (2001:fecd:ba23:cd1f:dcb1:1010:9234:4085)。ライセンス・サーバのポート番号は、1024 と 65535 の間の数値にする必要があります。既定のポート番号は 4001 です。冗長ライセンス・サーバのポート番号は、実行されているホストが異なる場合、一意にする必要はありませんが、その IP アドレスで使用されるすべてのポート番号とは異なる数値にする必要があります。

5. リストされたライセンス・サーバの名前をクリックして、前の手順に示した情報に更新します。

6. 構成からライセンス・サーバを削除するには、[削除] をクリックします。

インスタンスに対して複数のライセンス・サーバが構成されている場合、アクティブ・ライセンス・サーバの行には、影が付いています。

次のように $System.License.ShowServer メソッドを使用してどのライセンス・サーバがアクティブであるかを表示することもできます。

 Do $System.License.ShowServer()

ライセンス・トラブルシューティング

ライセンスを入力して Caché を再起動した後、1 ユーザしかログインできない場合には、管理ポータルを使用して確認してください。システム, ライセンス使用量 ページの [プロセス単位].を選択すると、実行中のプロセスの数が表示されます。ライセンス情報の表示には、ポータルの システム, ライセンス, ライセンスキー ページを使用することもできます。"ライセンス・キーの有効化" を参照してください。キーが無効の場合、[CustomerName] フィールドにその説明が表示されます。

また、ライセンス・エラー・メッセージは、コンソール・ログおよびシステム・モニタ・ログで確認することもできます。これらのログは、それぞれポータルの システム, システムログ, コンソールログ ページと システム, システムログ, システム・モニタ・ログ ページで表示できます ("Caché 監視ガイド" の “管理ポータルを使用した Caché の監視” の章にある "ログ・ファイルの監視" のセクションを参照)。Caché システム・モニタは、ライセンスの有効期限の警告とアラートをこれらのログに書き込み、Caché ヘルス・モニタは、ライセンス取得のアラートと警告を書き込みます。ライセンス制限が超過されると、ライセンス・モジュールごとのコンソール・ログに警告が書き込まれます。Caché アプリケーション・モニタでは、ライセンス・メトリックベースのアラートを構成して、電子メール通知を送信したり、通知メソッドを呼び出したりできます。これらの監視ツールの詳細は、"Caché 監視ガイド" の “Caché システム・モニタの使用” を参照してください。

$System.License.Help では、ライセンス問題のトラブルシューティングに使用できる方法のリストが表示されます。

 Do $System.License.Help()

このドキュメントでは、これらのメソッドの多くについて説明しています。ライセンスの問題により、ターミナル・セッションを確立できない場合は、管理者としてコマンド・プロンプトを実行して、install-dir/bin に移動します。次に、以下のコマンドを使用して、ライセンス問題のトラブルシューティング用にコマンド・プロンプト・ウィンドウで別のターミナル・セッションを確立します。

cache -s ..\Mgr -B

オペレーティング・システムのコマンド行からのライセンスのアップグレード

%SYSTEM.License.Upgrade()Opens in a new tab メソッドにより、installdir\mgr ディレクトリにコピーされた新しいライセンス・キーがアクティブ化されます。すべてのライセンス・ユニットがユーザによって消費され、ターミナル・ウィンドウを開くことができない場合、以下のようにして、このメソッドをコマンド行から実行して容量の大きい新しいライセンス・キーをアクティブ化できます。

csession <instancename> -U %SYS '##Class(%SYSTEM.License).Upgrade()'

csession コマンドの詳細については、このガイドの “Caché 複数インスタンスの使用法” の章で "Caché インスタンスの接続" を参照してください。

ローカル・ライセンス情報を表示するメソッド

以下のサブルーチンは、ローカルのインスタンス共有メモリに格納されているライセンス・テーブルのコンテンツをダンプします。通常は、クライアントを識別します。

$System.License.DumpLocalAll は、現在のディレクトリの all.dmp ファイルにすべてのローカル・ライセンス・テーブル・エントリをダンプします。

 Do $System.License.DumpLocalAll()

all.dmp ファイルのコンテンツの例を以下に示します。

License Capacity = 5, Current use = 2, Units Remaining = 3

   0)  User ID = 127.0.0.1, Connections = 2, CSP Count = 0, Time active = 90
   1)  User ID = 192.9.202.81, Connections = 1, CSP Count = 0, Time active = 49
   2)  free
   3)  free
   4)  free

$System.License.DumpLocalInUse は、現在のディレクトリの inuse.dmp ファイルに、使用中のすべてのローカル・ライセンス・テーブル・エントリをダンプします。

 Do $System.License.DumpLocalInUse()

inuse.dmp ファイルのコンテンツの例を以下に示します。

License Capacity = 5, Current use = 2, Units Remaining = 3

$System.License.DumpLocalPID は、現在のディレクトリの piduse.dmp ファイルに、ローカル・ライセンス・テーブルの使用状況をプロセス ID 別にダンプします。

 Do $System.License.DumpLocalPID()

piduse.dmp ファイルのコンテンツの例を以下に示します。

PID     Process LID     Type    Con     MaxCon  CSPCon  LU      Active  Grace

592     System                  0       0       0       0       0       0
2816    System                  0       0       0       0       0       0
688     System                  0       0       0       0       0       0

ライセンス・サーバ情報を表示するメソッド

以下のサブルーチンは、ライセンス・サーバによって保持されているライセンス・テーブルのコンテンツをダンプします。出力ファイルは、アクティブなライセンス・サーバが実行されているホスト上の指定ディレクトリにあります。

$System.License.ShowSummary は、ライセンス・サーバでのライセンス情報の要約を表示します。Distributed license use セクションには、ライセンス・サーバによって現在サポートされているすべての Caché インスタンスのライセンス使用状況がまとめて表示されます。Local license use セクションには、プログラムが実行されている 1 つの Caché インスタンスに対するライセンス使用状況のビューが表示されます。

 Do $System.License.ShowSummary()

$System.License.DumpServer は、ライセンス・サーバを実行しているホスト上のファイル dumpserver.txt に、このルーチンを実行したサーバに関連するライセンス・サーバ・データベース情報をダンプします。

 Do $System.License.DumpServer()

$System.License.DumpServers は、ライセンス・サーバを実行しているホスト上のファイル dumpservers.txt に、既知のすべてのサーバに対するライセンス・サーバ・データベース情報をダンプします。

 Do $System.License.DumpServers()

$System.License.DumpKey は、ライセンス・サーバを実行しているホスト上のファイル dumpkey.txt に、このインスタンスによって使用されるキーとそれを共有するインスタンスをダンプします。

 Do $System.License.DumpKey()

$System.License.DumpKeys は、ライセンス・サーバを実行しているホスト上のファイル dumpkeys.txt に、すべてのキーを、それらを使用するインスタンスとクライアントを示して、ダンプします。

 Do $System.License.DumpKeys()

ログインはローカルで制御されるため、ライセンスの数が上限値を一時的に上回ることは可能ですが、ライセンス・サーバで制限が強制されます。各インスタンスは、インスタンス共有メモリ内で維持されるローカル・ライセンス・テーブルに基づいて、ログインを許可または拒否します。各インスタンスからは、ローカル・ライセンス・テーブルに加えられた変更を説明する定期的な更新がライセンス・サーバに送信されます。すべてのインスタンスのライセンスの使用の合計が制限を超えると、ライセンス・サーバは各インスタンスからの更新メッセージに対して否定応答を送信します。

この否定応答を受け取ると、これ以上のライセンス・ユニットは使用できないため、各インスタンスでは新しいログインが拒否されます。開始しようとしている Caché プロセスのライセンス・ユーザ ID が、現在のいずれのプロセスのライセンス・ユーザ ID にも一致しない場合、そのログインは新しいものであると見なされます。この状態は、すべてのインスタンスによる使用の合計が許可された上限を下回るまで存続し、その時点で、ライセンス・サーバはインスタンスの更新に対して肯定応答の送信を開始します。これにより、インスタンスのそれぞれで、新しいログインが許可されます。

ライセンス・ログイン

ライセンス・ログインには、自動ログインと明示ログインの 2 つのモードがあります。既定は自動ログインです。ライセンス・システムは、クライアントの IP アドレスを識別して、そのアドレスをライセンス・ユーザ ID として使用します。クライアントが IP を使用してサーバに直接接続する場合、これは正確に機能します。しかし、ファイアウォールがクライアントとサーバの間にある場合は、すべてのクライアントが同じ IP アドレスを持つように見えるため、うまく機能しません。また、ターミナル・サーバが telnet プロトコルを使用している場合、Caché にはすべてのターミナル・サーバ・ポートが 1 つの IP アドレスとして認識されるため、自動ログインではユーザが区別できません。すべての接続が同じアドレスからのものであるため、すべての接続が同じユーザ ID を持ちます。ユーザがファイアウォールを経由して接続したり、ターミナル・サーバから telnet 転送を使用する場合は、明示ログインを使用してください。

ネットワーク転送に IP を使用していない場合は、IP アドレスをライセンス・ユーザ ID として使用できません。この場合、ライセンス・システムは、その他のさまざまなソースをユーザ ID として使用します。UNIX®/Linux システムで at デーモンによって開始されたバッチ・プロセスには、また別の問題があります。このようなプロセスは、ユーザと関連していないのでライセンス・ユニットを共有しません。このようなプロセスでは、プロセス ID がライセンス識別子として使用されます。

明示ログインが選択されているときは、Caché ではユーザ ID の自動検出は試行されません。アプリケーションは $System.License.Login(UserIdentifier) メソッドを明示的に呼び出して、ライセンス・ユーザ ID を提供し、ライセンスを取得する必要があります。

明示ログインは、$System.License.DeferUserIdentification([0 or 1]) 関数を呼び出すことで使用可能になります。この呼び出しは、システムの起動時に ^%ZSTART ルーチンの SYSTEM エントリ・ポイントから実行できます。引数値が 1 の場合、ライセンスの取得はログイン時に延期され、明示ログインを実行できます。引数値が 0 の場合、ライセンスの取得はプロセス開始時に自動で行われます。

ログインが延期されたとき、ユーザは即時にライセンス・ログイン・メソッドを呼び出す必要があります。ライセンス・ログインを実行していないプロセスは、最初の 4000 個の Caché コマンドで停止し、その後 1000 個の Caché コマンドごとに停止します。

自動ログインが処理できない場合は、明示ログインを使用します。自動ログインに構成されている場合でも、いつでも $System.License.Login(UserIdentifier) を呼び出して、明示的にユーザのライセンスを識別できることを覚えておいてください。

ユーザ名ライセンス

$USERNAME の値を使用してライセンス付与するユーザを識別できます。これにより、個々のユーザの確実な識別に IP アドレスが使用できない状況でも、より正確なカウントが可能です。

%SYSTEM.LicenseOpens in a new tab クラスの $SYSTEM.License.UserNameLicensing() メソッドを使用してライセンス・ユーザ ID を指定する方法を変更できます。既定では、Caché ではクライアント IP アドレスを使用して、ライセンス追跡サブシステムに対してユーザを識別します。最小ではない初期セキュリティ設定で Caché をインストールした場合は、各プロセスにはユーザ ID ($USERNAME) があります。$SYSTEM.License.UserNameLicensing() システム・メソッドを呼び出して、Caché ライセンス・サブシステムで、ライセンス・ユーザ識別子として $USERNAME を使用するようにできます。

$SYSTEM.License.UserNameLicensing() メソッドはシステムの状態を変更します。このメソッドを SYSTEM^%ZSTART から呼び出して、インスタンスの起動時にユーザ名ライセンスを有効にすることができます。このメソッドには、以下の関数があります。

• $SYSTEM.License.UserNameLicensing(1) — $USERNAME ベースのライセンスを有効にし、前の状態を返します。

• $SYSTEM.License.UserNameLicensing(0) — $USERNAME ベースのライセンスを無効にし、前の状態を返します。

• $SYSTEM.License.UserNameLicensing() — 現在の状態を返します。特殊なログイン規則を使用するライセンス・タイプの引数で呼び出された場合は、エラーを返す可能性があります。

以下の例は、ユーザ名ライセンスが現在有効であるか無効であるかを示します。

 Write " Username Licensing",!
 Write " 1-enabled, 0-disabled",!
 Write $SYSTEM.License.UserNameLicensing(),!

以下の例は、ユーザ名ライセンスを有効にし、その後無効にします。

 Set RC=$SYSTEM.License.UserNameLicensing(1)
 Write RC,!
 Set RC=$SYSTEM.License.UserNameLicensing(0)
 Write RC

詳細は、"Caché ObjectScript リファレンス" の "$USERNAME" 特殊変数を参照してください。

ライセンス・ログインの特別な考慮事項

ライセンス・ログインに関して、以下に示す特別な考慮事項に注意してください。

• ログインにおいて、CSP 接続は特殊です。インターシステムズは、CSP アプリケーションでは %CSP.SessionOpens in a new tab と同様のメソッド %CSP.Session.Login を使用して、ユーザのライセンスを識別することを強くお勧めします。そうしない場合、ライセンス・ユーザ ID として CSP セッション ID が使用されますが、各セッションで 1 つのライセンス・ユニットを消費するので、多くの場合は不適切な設定となります。例えば、ユーザは複数のブラウザ・ウィンドウを同時に開くことができます。また、ユーザは複数の経路 (CSP、ターミナル・ウィンドウ、および Visual Basic クライアントからの Caché Direct 接続) を使用して接続できます。この場合、%CSP.SessionOpens in a new tab メソッド %CSP.Session.Login(username, password) を使用して、セッションに対する明示的なライセンス・ログインを実行できます。

• 匿名 SOAP 要求 (Caché のログインを必要としない SOAP 要求) は最短 10 秒間で 1 ライセンスを消費しますが、ユーザが特定される SOAP 要求は “ユーザ要求“ と見なされるため、ライセンスが必要です。SOAP セッションの実装の詳細は、"Caché での Web サービスおよび Web クライアントの作成" の "SOAP セッション管理" を参照してください。

• Caché は、バックグラウンド・プロセスを区別したり、これらのプロセスを個別にカウントすることはありません。ユーザ・プロセスが他のプロセスを開始する場合、その子プロセスはユーザの最大許容プロセス数全体に対し 1 つとしてカウントされます。

• 管理ポータルの システム, タスクマネージャ ページにある [新規タスク] オプション (このドキュメントの “Caché の管理” の章の "タスク・マネージャの使用" を参照) を使用して作成した各タスクは、[タスクを実行するユーザ] セレクタで指定した Caché のユーザ名と、ホスト IP アドレスに変換されるループバック IP アドレス (127.0.0.1) に基づいたライセンス・ユーザ ID で 1 つのライセンス・ユニットを消費します。これにより、特定のユーザとして別々のホスト上で実行されるタスクが、そのユーザの最大許容プロセス数 ("ユーザの識別" を参照) に対して、確実に合計されるようになります。

• ユーザの起動ルーチン (^%ZSTART または従来の ^ZSTU、および ^ZMIRROR) により開始するプロセスも、特別なケースです。このルーチンを実行中のプロセスには、親プロセスがありません。したがってログインは、このルーチンが呼び出される前に、そのユーザ ID User Startup に対して実行されます。このルーチンから Job コマンドによって開始されたプロセスは、このユーザ ID を持ちます。必要な場合は、ルーチンから $System.License.Login(UserId) を呼び出して、ユーザ ID を変更できます。これは、このルーチンで開始するバックグラウンド・プロセスが maxconn より 1 つ少なく、消費するライセンスが 1 つで済むことを意味します。ライセンス条件に従って、これらのプロセスに個別のライセンスが必要な場合 (例えば、個別のライセンスが必要な実験装置の一部を起動している場合など)、適切なユーザ ID に対するライセンスを取得するために $System.License.Login(UserId) を呼び出す必要があります。

アプリケーション・ライセンスのロード

アプリケーションの実行時に $SYSTEM.License.LoadAppLicenseFile メソッドを使用すると、どのようなアプリケーション・ライセンスでも Caché インスタンスでロードしてアクティブ化できます。このメソッドの詳細は、%SYSTEM.LicenseOpens in a new tab のクラスリファレンスに記載されています ("アプリケーション・ライセンス API" を参照)。この方法でロードされたアプリケーション・ライセンスは、アクティブな Caché ライセンスには関連付けられませんが、Caché インスタンスによって個別に追跡されます。

各アプリケーション・ライセンスは、[AppName] で始まるセクションに含まれます。アプリケーション名 (AppName) には、ピリオド (.) は使用できません。ライセンスの残りは、ライセンス付与された機能を表す、繰り返されない一連の keyword=value ペアで構成されます。必要なフォーマットの詳細は、$SYSTEM.License.LoadAppLicenseFileOpens in a new tab メソッドのドキュメントを参照してください。

以下のアプリケーション・ライセンスのサンプルでは、keyword=value のペアを使用して複数のアプリケーション機能に対してライセンス付与されるユーザの数を制限し、すべてのユーザに対して Extended Lab Reports 機能を有効にします。

[BestLabApplication]
Lab Users=50
Lab Administrators=2
Lab Devices=5
Extended Lab Reports=Enabled

アプリケーション・ライセンスには、改ざんを防ぐ Caché の保護は適用されませんが、カスタムのアプリケーション・コードによって保護できます。例えば、チェックサムをキーワード・セクションに埋め込み、有効化する前にアプリケーションによって検証できます。

アプリケーション・ライセンス API

%SYSTEM.LicenseOpens in a new tab クラスは、アプリケーション・ライセンスを管理するための以下のメソッドを提供します。

• %SYSTEM.License.LoadAppLicenseFile

  ファイルからアプリケーション・ライセンスをロードします。

• %SYSTEM.License.GetAppLicense

  現在ロードされているアプリケーション・ライセンスのコンテンツを keyword=value のペアの文字列として返します。

• %SYSTEM.License.GetAppLicenseMaxUsed

  ライセンスがロードされてからアプリケーション・ライセンス・キーワードに関連付けられている消費済みライセンス・ユニットの最大数を取得します。

• %SYSTEM.License.GetAppNames

  現在インターシステムズ、保護/非保護のアプリケーション・ライセンス、またはこれらの組み合わせによってライセンス付与されているアプリケーションの名前を返します。

• %SYSTEM.License.IsAppLicensed

  アプリケーションまたは機能がライセンス付与されているか、保護/非保護のアプリケーション・ライセンスのどちらによって付与されているかを示します。

• %SYSTEM.License.TakeApplicationLicense

  アプリケーションと機能のライセンスを消費します。現在のプロセスのライセンス・ユーザ ID (または CSP の場合はセッション・ライセンス ID) は、消費されているアプリケーション・ライセンスに関連付けられているユーザ識別子です。

• %SYSTEM.License.ReturnApplicationLicense

  現在のプロセスのライセンス・ユーザ ID または CSP の場合はセッション・ライセンス ID に関連付けられているライセンス・リソースを含むアプリケーション・ライセンスおよび機能のライセンスを解放します。

• %SYSTEM.License:ApplicationServerLogin

  現在ロードされているアプリケーション・ライセンスを使用しているインスタンスの数が、キーで指定した制限を超過しているかどうかを示します。

• %SYSTEM.License.GetAppLicenseValue

  アプリケーション・ライセンス・キーワードに関連付けられている値を取得します。

• %SYSTEM.License.GetAppLicenseMin

  アプリケーション・ライセンス機能キーワードに関連付けられている使用可能なライセンスの最低数を取得します。キーワードに関連付けられている値は数値です。

• %SYSTEM.License.GetAppLicenseFree

  アプリケーション・ライセンス機能キーワードに関連付けられている使用可能なライセンスの最大数を取得します。キーワードに関連付けられている値は数値です。

• %SYSTEM.License.GetProcessAppsTaken

  プロセス PID に対して取得されているアプリケーション・ライセンス・タイプの $List を取得するか、なしの場合は "" を取得します。

• %SYSTEM.License:ApplicationUserList

  ユーザ ID によってライセンスとアプリケーション・ライセンスを返します。