Kwservice

kwservice は Validate サーバーを管理します。

Linux で SSH を使用するか、Windows で Windows Services 管理を使用して、サーバーをリモートで管理できます。それ以外の場合は、start、restart、および stop コマンドをローカルに発行する必要があります。

残りの kwservice サブコマンドの場合、ログインしているマシンから projects_root ディレクトリを表示できる必要があります。

使用方法

kwservice [common-options] <subcommand> [options]

例 

kwservice --projects-root C:\Klocwork 2024.1 Server\projects_root start license

共通オプション

名前 (および短い名前) 説明
--help このヘルプを表示します。
--projects-root (-r) サーバーが実行されている projects_root ディレクトリのパス。すべての kwservice コマンドに必須です。
--verbose プログラム実行についての詳細情報を表示します。これは、エラーのトラブルシューティングに役立ちます
--version バージョン情報を表示します

変数の例

この記事の例では、次の変数を使用しています。

  • <service_name> は、次のいずれかになります:
    • データベース
    • ライセンス
    • klocwork
  • <projects_root> は、サーバーが実行されている projects_root です。

kwservice check

kwservice check コマンドを使用して、すべてのサーバーまたは個々のサーバーのステータスを確認します。

サーバーを Windows Services の一環として実行している場合 (デフォルトの設定)、kwservice の代わりに Windows Services 管理を使用して、サーバーの開始、停止、確認を行う必要があります。

使用方法 

kwservice --projects-root <projects_root> check [<service_name>]

例

すべてのサーバーのステータスを確認するには:

kwservice --projects-root C:\Klocwork\projects_root check

ライセンスサーバーのステータスをチェックするには:

kwservice --projects-root C:\Klocwork\projects_root check license

kwservice get-service-properties

kwservice get-service-properties コマンドを使用して、サーバーのホスト名およびポート番号を表示します。

使用方法 

kwservice --projects-root <projects_root> get-service-properties <service_name>

例 

kwservice --projects-root C:\Klocwork\projects_root get-service-properties klocwork

kwservice list-services

このコマンドを使用して、サーバーをリストします。

使用方法 

kwservice --projects-root <projects_root> list-services

例 

kwservice --projects-root C:\Klocwork\projects_root list-services

kwservice migrate

このコマンドを使って、projects_root を移行します。プロジェクトを移行すると、その下にネストされているすべてのストリームも移行されます。サポートされているアップグレードパスと具体的な移行のユースケースについては、「プロジェクトルートディレクトリの移行」を参照してください。

使用方法 

kwservice --migrate

例 

kwservice --migrate --exclude-projects-file C:/exclude.txt --priority-projects-file C:/priority.txt

オプション

名前 (および短い名前) 説明
--migrate (-m) projects_root の移行
--exclude-projects-file (-x) <string> プロジェクトを移行から除外するために、除外ファイルを指定します。除外できるのは基本プロジェクトのみです。個別のストリームを除外することはできません
--priority-projects-file (-y) <string> 移行の順序に優先順位を付けるために、優先プロジェクトファイルを指定します。優先度付けできるのは基本プロジェクトのみです。個別のストリームを優先度付けすることはできません

kwservice restart

このコマンドを使用して、すべてのまたは個々のサーバーをワンステップで停止してから再起動します。

Klocwork サーバーを Windows Services の一環として実行している場合 (デフォルト)、kwservice の代わりに Windows Services 管理を使用して、Klocwork サーバーの開始、停止、確認を行う必要があります。

Unix で SSH を使用して、または Windows で Windows Services 管理を使用して、サーバーをリモートで管理できます。それ以外の場合は、start、restart、および stop コマンドをサーバーにローカルに発行する必要があります。

使用方法 

kwservice --projects-root <projects_root> restart [<service_name>]

例

すべてのサーバーを再起動するには:

kwservice --projects-root C:\Klocwork\projects_root restart

ライセンスサーバーを再起動するには:

kwservice --projects-root C:\Klocwork\projects_root restart license

kwservice set-service-property

このコマンドを使用して、Klocwork サーバーのプロパティを設定します。

Important: このコマンドを実行する前に、関連するサーバーを停止する必要があります。kwservice stop を参照してください。

使用方法 

kwservice --projects-root <projects_root> set-service-property <service_name> <property> <value>
  • <service_name> は、次のいずれかです。
    • データベース
    • ライセンス
    • klocwork
  • <property> は、次の表に示した任意のプロパティです
プロパティ 説明 デフォルト値 以下のサーバーに適用
append.license.logging

サーバーの再起動時に <projects root>/logs/license.report.log ファイルを上書きするのではなく追加するには、このプロパティを「true」に設定して、ライセンスサービスと組み合わせて使用します。

例: kwservice set-service-property license append.license.logging true

この設定は、構成されたプロジェクトルートからライセンスサーバーを実行する場合に必要です。他の場所でホストされているライセンスサーバーを使用するようにプロジェクトルートを設定している場合、これは使用されません。

    
host 指定されたサーバーのホスト名 localhost すべて
メモリ サーバーが使用できるメモリ量。有効な Java -Xmx 値を指定する必要があります。たとえば 2G。 1G Tomcat
ポート 指定されたサーバーが使用するポート番号 ライセンスサーバー: 27000 データベースサーバー: 3306 Klocwork サーバー: 8080 すべて

kwservice setup

このコマンドを使用して、追加の projects_root ディレクトリを設定および初期化します。

インストール時に 1 つの projects_root ディレクトリが自動的に作成されます。

projects_root ディレクトリは、サーバーとアプリケーションのためのデータの場所です。そこにはサーバーの設定と、統合プロジェクトやビルド解析の実行に関する情報が含まれています。また、ライセンスファイルも保管されています。デフォルトの場所は <Server_install>/projects_root です。

使用する project_root ディレクトリがデフォルトの場所にない場合は、その場所および作成する追加の projects_root の場所を指定する必要があります。

追加の projects_root ディレクトリを作成する必要がある場合は、Klocwork カスタマーサポートまで詳細をお問い合わせください。

使用方法 

kwservice --projects-root <new_projects_root> setup [options]

フィールド

  • <new_projects_root> は作成する projects_root のパスです。このディレクトリの親ディレクトリは既に存在します。

重要: projects_root へのパスの最大長は 68 ～ 72 文字で、データベースサーバーのポート番号 (1 ～ 5 桁) の長さによって異なります。

例1 (projects_root に使用するデフォルトの場所) 

kwservice --projects-root C:\Klocwork\projects_root_2 setup

例2 (projects_root に使用するデフォルト以外の場所) 

kwservice setup --old-pr C:\mydatabase\projects_root --projects-root C:\mydatabase\projects_root_2

オプション

名前 説明
--license <arg> ライセンスファイルを指定します。このオプションを使用して、指定したライセンスファイルを新しい projects_root ディレクトリにコピーします。
--old-pr <arg> 既存の projects_root ディレクトリを指定します。このオプションを使用して、既存の projects_root からサーバー設定をコピーします。

kwservice start

このコマンドを使用して、すべてサーバーまたは個々のサーバーを起動します。

サーバーを Windows Services の一環として実行している場合 (デフォルトの設定)、kwservice の代わりに Windows Services 管理を使用して、サーバーの開始、停止、確認を行う必要があります。

Linux で SSH を使用するか、Windows で Windows Services 管理を使用して、サーバーをリモートで管理できます。それ以外の場合は、start、restart、および stop コマンドをサーバーにローカルに発行する必要があります。

使用方法 

kwservice --projects-root <projects_root> start [<service_name>]

例

すべてのサーバーを起動するには:

kwservice --projects-root C:\Klocwork\projects_root start

Validate サーバーを起動するには:

kwservice --projects-root C:\Klocwork\projects_root start klocwork

移行オプションに関する注意

--migrate オプションは、Klocwork の以前のバージョンから projects_root を移行するために使用されます。

kwservice stop

このコマンドを使用して、すべてのまたは個々の Validate サーバーを停止します。

サーバーを Windows Services の一環として実行している場合 (デフォルトの設定)、kwservice の代わりに Windows Services 管理を使用して、サーバーの開始、停止、確認を行う必要があります。

Linux で SSH を使用するか、Windows で Windows Services 管理を使用して、サーバーをリモートで管理できます。それ以外の場合は、start、restart、および stop コマンドをサーバーにローカルに発行する必要があります。

使用方法 

kwservice --projects-root <projects_root> stop [<service_name>]

例

すべてのサーバーを停止するには:

kwservice --projects-root C:\Klocwork\projects_root stop

Validate サーバーを停止するには:

kwservice --projects-root C:\Klocwork\projects_root stop klocwork