$Date: 2022/09/08 04:42:19 $
LMSクライアントは、LMSサーバーにアクセスしてライセンス認証をし、有償で提供されるアプリケーションのアクティベーションを行います。本文書では、ライセンス情報およびライセンス認証の動作について解説します。
ヤマハネットワーク機器では、以下の機種およびファームウェアで、LMSクライアント機能をサポートしています。
| 機種 | ファームウェア |
|---|---|
| FWX120 | Rev.11.03.13以降 |
| NVR700W | Rev.15.00.17以降 |
| RTX830 | Rev.15.02.13以降 |
| RTX1300 | すべてのリビジョン |
LMSクライアントが取得したライセンス情報はshow status licenseコマンドで確認することができます。
# show status license ======================================================= 品番 状態 有効期限 ------------------------------------------------------- YSL-MC120 有効 2016/08/31 =======================================================
ライセンス製品の品番です。各品番が対応するアプリケーションについてはライセンス管理システム(LMS)を参照してください。
LMSクライアントのライセンスの状態は、show status licenseを参照してください。
[状態遷移図]
[状態遷移の例]: 有効 ->更新猶予期間
[状態遷移の例]: 有効 ->認証猶予期間 -> 有効
ライセンスの有効期限は、"年/月/日"形式で表示します。
各ライセンスの状態における表示例は、show status licenseを参照してください。
LMSクライアントとLMSサーバーとの通信は、TCP/443を使用して行います。
ライセンス認証を必要とするアプリケーションを使用する設定になっている場合、LMSクライアントはLMSサーバーからライセンス情報を取得します。該当するアプリケーションとコマンドは以下の通りです。
| アプリケーション | コマンド |
|---|---|
| メールセキュリティー | mail security use on |
| URLフィルター | url filter external-database use reputation ysl-mc category ysl-mc |
| アプリケーション制御 | dpi use on |
ライセンス情報の取得方法（タイミング）は以下の通りです。
ヤマハネットワーク機器を起動後、はじめてインターネットに接続したとき、自動的にライセンス認証を行います。
ライセンス認証を必要とするアプリケーションを使用する設定に変更したタイミングでライセンス認証を行います。
アプリケーションがアクティベートされているとき、LMSクライアントは定期的にライセンス認証を行い、ライセンスの状態を確認しています。これを「定期認証」と呼びます。定期認証は24時間間隔で実行されます。
定期認証に12回連続で失敗するとアプリケーションがディアクティベートされます。この認証回数のことを「ディアクティベートまでの定期認証回数」と呼びます。ディアクティベートまでの定期認証回数は不揮発性メモリに記録されるため、再起動後も継続してアプリケーションを使うことができます。この値はライセンス認証に成功したときに12になり、定期認証に失敗したとき、あるいは再起動（電源の OFF/ONを含む）をしたときに1減ります。再起動後にディアクティベートまでの定期認証回数が1減るのは、ライセンスの不正利用を防ぐためです。ディアクティベートまでの定期認証回数が0となりアプリケーションがディアクティベートされると、それ以降定期認証は実行されなくなりますが、例えば後述の「手動認証」によってアプリケーションがアクティベートされた時点から定期認証は再開されます。
アプリケーションがディアクティベートされるまでの時間は、次の定期認証までの時間とディアクティベートまでの定期認証回数とで求められます。
以上の仕組みにより、ネットワークのトラブルやサーバーのメンテナンス等によりライセンス認証に失敗しても、少なくとも11日間（途中で電源のON/OFFを行わない場合）はアプリケーションを使用することができます。またディアクティベートまでの定期認証回数を不揮発性メモリに記録することで、再起動をしてもアプリケーションがすぐに使えなくなることはありません。
定期認証に連続で失敗した場合の例を以下に示します。
license authentication goコマンドを実行することで、手動でライセンス認証を行うことができます。定期認証が停止しているとき、アプリケーションをアクティベートするために実行してください。
LMSクライアントが行ったライセンス認証の状態は、show status license authenticationで確認できます。
以下の機種およびファームウェアでは、ライセンス認証に失敗したときにライセンス認証のリトライを行います。
| 機種 | ファームウェア |
|---|---|
| NVR700W | Rev.15.00.17以降 |
| RTX830 | Rev.15.02.14以降 |
| RTX1300 | すべてのリビジョン |
ライセンス認証のリトライは起動直後の認証や定期認証などのルーターが自発的に行うライセンス認証が失敗したときに行います。手動認証に失敗したときはリトライは行いません。ライセンス認証のタイミングと結果に対するリトライの有無は以下の通りです。
| 認証のタイミング | 認証結果 | リトライ |
|---|---|---|
| 起動直後 | 成功 | ✕ |
| 失敗 | ○ | |
| アプリケーションを使用する設定を変更 | 成功 | ✕ |
| 失敗 | ○ | |
| 定期認証 | 成功 | ✕ |
| 失敗 | ○ | |
| 手動認証 | 成功 | ✕ |
| 失敗 | ✕ |
初期設定ではライセンス認証に失敗してから30秒後にリトライを行い、5回まで試行します。5回連続してリトライに失敗した場合はリトライを停止します。リトライを行うまでの間隔とリトライ回数はlicense authentication retry intervalコマンドで設定できます。
ライセンス認証に失敗してからリトライを行うまでの待ち時間中にアプリケーションを使用する設定を変更/定期認証/手動認証などによるライセンス認証が発生した場合はリトライを中止します。
ライセンス認証に失敗してからリトライを行うまでの待ち時間中にlicense authentication retry intervalコマンドの設定が変更された場合は変更前の設定に従います。
定期認証のリトライに成功した場合、次の定期認証はリトライが成功してから24時間後に行います。なお、定期認証のリトライに失敗した回数は「ディアクティベートまでの定期認証回数」には影響を及ぼしません。
| ライセンスの状態(日/英) | 説明 |
|---|---|
| 有効 /Active |
ライセンスが有効期限内であり、当該品番に対応するアプリケーションを使用できる状態。 |
| 更新猶予期間 /Renew grace period |
有効期限を過ぎている状態。この状態より一定期間経過すると対応するアプリケーションを使用できなくなるため、ライセンスの購入手続きが必要となる。 |
| 認証猶予期間 /Authentication grace period |
一時的にライセンス認証が猶予されている状態。ヤマハネットワーク機器が有効なライセンス情報を保持している状態で再起動し、その後LMSサーバーと通信できない場合にこの状態となる。対応するアプリケーションを使用することはできるが、ディアクティベートまでの時間が経過するまでにライセンス認証を行う必要がある。ディアクティベートまでの時間はshow status license authenticationコマンドで確認することができる。 |
# show status license ======================================================= 品番 状態 有効期限 ------------------------------------------------------- YSL-MC120 有効 2016/08/31 =======================================================更新猶予期間:
# show status license ======================================================= 品番 状態 有効期限 ------------------------------------------------------- YSL-MC120 更新猶予期間 2016/08/31 =======================================================認証猶予期間:
# show status license ======================================================= 品番 状態 有効期限 ------------------------------------------------------- - 認証猶予期間 - =======================================================ライセンスを保持していない場合／LMSサーバーからライセンス情報を取得していない場合:
# show status license ライセンスがありません。
# show status license authentication 最終更新日時: 2015/05/31 01:02:03 ディアクティベートまでの定期認証回数: 4 次の定期認証までの時間: 05:59:47 ディアクティベートまでの時間: 23:59:47再起動直後:
# show status license authentication 最終更新日時: - ディアクティベートまでの定期認証回数: 3 次の定期認証までの時間: 05:59:42 ディアクティベートまでの時間: 17:59:42定期認証停止時:
# show status license authentication 定期認証は実行されていません。
以下に本機能において出力されるSYSLOGメッセージの一覧を示します。実際に出力される各メッセージの先頭には、"[LMS_CLIENT]"というプレフィックスが付与されます。
| レベル | 出力メッセージ | 内容 |
|---|---|---|
| INFO | PRODUCT is activated. | PRODUCT がアクティベートされた。 |
| PRODUCT is deactivated. | PRODUCT がディアクティベートされた。 | |
| License authentication succeeded. | ライセンス認証に成功した。 | |
| License authentication failed. | ライセンス認証に失敗した。 | |
| License authentication is aborted. | ライセンス認証が中断された。 | |
| License authentication is already running. | ライセンス認証が既に実行されている。 | |
| Periodic license authentication fail (N time[s]). | 定期認証に連続で N 回失敗した。 | |
| License PRODUCT expired. | PRODUCT のライセンスが有効期限を過ぎた。 | |
| Clear license information. | ライセンス情報をクリアした。 | |
| Received illegal message from LMS server. | LMSサーバーから不正なメッセージを受信した。 | |
| Received API status CODE from LMS server. | LMSサーバーからAPIステータス CODE であるメッセージを受信した。 | |
| Received HTTP status CODE from LMS server. | LMSサーバーからHTTPステータス CODE であるレスポンスを受信した。 | |
| DEBUG | License PRODUCT is active. | PRODUCT のライセンスは有効である。 |
| License PRODUCT is Renew grace period. | PRODUCT のライセンスは更新猶予期間である。 | |
| Can't connect to LMS server (No such domain). | LMSサーバーに接続できなかった (ドメイン名が見つからない)。 | |
| Can't connect to LMS server (TCP connection timeout). | LMSサーバーに接続できなかった (TCP接続タイムアウト)。 | |
| Can't create socket. | ソケットを生成できなかった。 | |
| Retry license authentication (count = N) | ライセンス認証のリトライを実行した。N はリトライ回数。 | |
| Stop retrying license authentication | ライセンス認証のリトライを中止した。 |
※ PRODUCTはライセンス製品の品番。