LMSクライアント

$Date: 2015/08/27 04:25:05 $


目次


概要

LMSクライアントは、LMSサーバーにアクセスしてライセンス認証をし、有償で提供されるアプリケーションのアクティベーションを行います。本文書では、ライセンス情報およびライセンス認証の動作について解説します。


対象機種とファームウェアリビジョン

ヤマハネットワーク機器では、以下の機種およびファームウェアで、LMSクライアント機能をサポートしています。

機種 ファームウェア
FWX120 Rev.11.03.13

ライセンス情報

LMSクライアントが取得したライセンス情報はshow status licenseコマンドで確認することができます。

# show status license
=======================================================
品番          状態                         有効期限
-------------------------------------------------------
YSL-MC120     有効                         2016/08/31
=======================================================

表示項目について

品番

ライセンス製品の品番です。各品番が対応するアプリケーションについてはライセンス管理システム(LMS)を参照してください。

状態

LMSクライアントのライセンスの状態は、show status licenseを参照してください。

[状態遷移図]

State transition diagram

[状態遷移の例]: 有効 ->更新猶予期間

State transition example 1

[状態遷移の例]: 有効 ->認証猶予期間 -> 有効

State transition example 2

有効期限

ライセンスの有効期限は、"年/月/日"形式で表示します。

表示例

各ライセンスの状態における表示例は、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

ライセンス情報の取得方法(タイミング)は以下の通りです。

起動直後

ヤマハネットワーク機器を起動後、はじめてインターネットに接続したとき、自動的にライセンス認証を行います。

アプリケーションを使用する設定を変更したとき

ライセンス認証を必要とするアプリケーションを使用する設定に変更したタイミングでライセンス認証を行います。

アプリケーションがアクティベートされていない状態で動作しようとするとき

ライセンス認証が未実施である、あるいは有効なライセンスがない状態でアプリケーションが動作しようとするとき、ライセンス認証が行われます。たとえば、メールセキュリティーがアクティベートされていない状態で、ヤマハネットワーク機器が受信メールを受け取ったとき、ライセンス認証を行います。

定期認証

アプリケーションがアクティベートされているとき、LMSクライアントは定期的にライセンス認証を行い、ライセンスの状態を確認しています。これを「定期認証」と呼びます。定期認証は24時間間隔で実行されます。

定期認証に12回連続で失敗するとアプリケーションがディアクティベートされます。この認証回数のことを「ディアクティベートまでの定期認証回数」と呼びます。ディアクティベートまでの定期認証回数は不揮発性メモリに記録されるため、再起動後も継続してアプリケーションを使うことができます。この値はライセンス認証に成功したときに12になり、定期認証に失敗したとき、あるいは再起動(電源の OFF/ONを含む)をしたときに1減ります。再起動後にディアクティベートまでの定期認証回数が1減るのは、ライセンスの不正利用を防ぐためです。ディアクティベートまでの定期認証回数が0となりアプリケーションがディアクティベートされると、それ以降定期認証は実行されなくなりますが、例えば後述の「手動認証」によってアプリケーションがアクティベートされた時点から定期認証は再開されます。

アプリケーションがディアクティベートされるまでの時間は、次の定期認証までの時間とディアクティベートまでの定期認証回数とで求められます。

以上の仕組みにより、ネットワークのトラブルやサーバーのメンテナンス等によりライセンス認証に失敗しても、少なくとも11日間(途中で電源のON/OFFを行わない場合)はアプリケーションを使用することができます。またディアクティベートまでの定期認証回数を不揮発性メモリに記録することで、再起動をしてもアプリケーションがすぐに使えなくなることはありません。

定期認証に連続で失敗した場合の例を以下に示します。

Periodic authentication example

手動認証

license authentication goコマンドを実行することで、手動でライセンス認証を行うことができます。定期認証が停止しているとき、アプリケーションをアクティベートするために実行してください。

確認方法

LMSクライアントが行ったライセンス認証の状態は、show status license authenticationで確認できます。


コマンド

◯ライセンス認証の実行
[書式]
license authentication go
[設定値及び初期値]
[設定値] : -
[初期値] : -
[説明]
LMSサーバーに対してライセンス認証を行う。実行中にCtrl-C押下で中断することができる。
◯ライセンス情報の表示
[書式]
show status license
[説明]
LMSクライアントが取得したライセンス情報を表示する。表示する項目は以下の通り。
[ノート]
ライセンスを保持していない場合、あるいはLMSサーバーからライセンス情報を取得していない場合、当コマンドを実行しても情報は表示されない。
[表示例]
有効:
# 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
[説明]
ライセンス認証の状態を表示する。表示する項目は以下の通り。
[表示例]
定期認証動作時:
# 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

以下に本機能において出力される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 のライセンスは更新猶予期間である。
License PRODUCT is Authentication 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. ソケットを生成できなかった。

PRODUCTはライセンス製品の品番。


関連文書


[EOF]