====== コマンドラインコントロール ======

===== 概要 =====

V-Ray オンラインライセンスサーバーはコマンドラインからコントロールを行う、ライセンスサーバーコントローラー(vrlctl)を提供しています。

{{ :chaosgroup:licenses:ovrls:vrlctl.png?nolink |}}

===== アクセス =====


ライセンスサーバーコントローラー の実行ファイル "vrlctl" は、ライセンスサーバーインストール後に以下の場所で見つける事ができます。

|Windows|C:\Program Files\Chaos Group\VRLService\OLS|
|Linux|/usr/ChaosGroup/VRLService/OLS|
|Mac OSX|/Applications/ChaosGroup/VRLService/OLS|

===== 使い方 =====


ライセンスサーバーコントローラーは以下の形式で使用します。

  vrlctl <command>

コマンド無しで実行すると、ヘルプが表示されます。

===== コマンド =====


==== Online ====


これらコマンドは"オンライン"ライセンスサーバーの設定を"有効"、"無効"、"モニタ"を行います。コマンドライン経由でのオンラインライセンス認証に関しては  を参照ください。

|online getcsr|オンラインライセンス・リクエストファイル(cert.csr)をカレントディレクトリに保存します|
|online enable|カレントディレクトリに配置されたオンラインライセンス・キーファイル(cert.crt)を使ってオンラインライセンスを有効化します|
|online disable|ライセンスサーバーのオンラインライセンスを無効にします。|
|online status|オンラインライセンスの状態を表示します|
|online login <username> <password>|指定されたアカウントでオンラインライセンスを認証します|
==== Diagnostics ====


このコマンドはライセンスのトラブルを診断する為にChaosGroupに送信するライセンスサーバーの挙動解析ファイル（診断ファイル）を生成します。（なお診断ファイルの内容はエンドユーザーが理解できる様に出来ていません。）

|diagnostics get <save_path>|ライセンスサーバーの挙動を記録したファイル郡をZip圧縮して出力します。<save_path>が与えられた場合、その場所にファイルを出力します|

==== Config ====


ライセンスサーバーの設定を変更します。

|config get|ライセンスサーバーの設定リストを返します|
|config set <configuration_option> "<new_value>"|指定の設定オプションに値をセットします。<configuration_option>は全て設定項目をドット(.)で接続した形で構成されます。例えば  proxy.host や diagnostics.level のような形式です。新しい値は クウォテーションマーク(")で囲まれる必要があります|

==== Dongle ====


次のコマンドはライセンスサーバーのドングルライセンスを操作するコマンドです。

|dongle enable|ドングルサーバーを有効化します。|
|dongle disable|ドングルサーバーを無効化します。|
|dongle port <new_port>|ドングルサーバーのポートを取得/設定します。<new_port>を指定せずに入力すると現在のドングルポート番号を返します。指定した場合はドングル・サーバーは指定されたポートにセットされます|

==== ブラウザ ====


|vrlctl browser|システムのデフォルトブラウザでライセンスサーバーのウェブインターフェースページを開きます。|


==== グローバルオプション ====


**Help**

コマンドの後に help オプションを追加すると、特定のコマンドに関する追加情報が出力されます。

  vrlctl online enable -h

**Version**

version オプションは、Licensing Server Controller のバージョンを表示します。

  vrlctl -v

===== オンラインライセンス認証 =====


コマンドライン（vrlctl）経由でのオンラインライセンス認証は以下の手順で行います

  * vrlctlのディレクトリをカレントディレクトリにして、コマンドラインにて

  vrlctl online getcsr [出力パス]

と入力すると出力パスにオンラインライセンス・リクエストファイル(cert.csr)が保存されます。

  * http://my.chaosgroup.com にログインし手順に従ってオンラインライセンスキーファイル(cert.crt)を入手します。もしくはコマンドラインで

  online login <username> <password> [cert.csrへのパス]

でもオンラインライセンスキーファイル(cert.crt)を入手できます。この場合、C:\Program Files\Common Files\ChaosGroup\ssl\cert.crt に生成されます。

  * vrlctlディレクトリに オンラインライセンスキーファイル(cert.crt) を配置し

  vrlctl online enable　[cert.crtへのパス]

と入力する事でオンラインライセンスを認証する事ができます。