Kwservice

kwservice コマンドで、Klocwork サーバーを管理します。

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

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

使用方法

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

例 

kwservice --projects-root C:\Klocwork 2023.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 コマンドを使用して、すべての Klocwork サーバーまたは個々の Klocwork サーバーのステータスを確認します。

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

使用方法 

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

例

すべての Klocwork サーバーのステータスをチェックするには:

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 コマンドを使用して、Klocwork サーバーのホスト名およびポート番号を表示します。

使用方法 

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

例 

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

kwservice list-services

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

使用方法 

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

例 

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

kwservice restart

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

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

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

使用方法 

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

例

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

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> は、次の表に示した任意のプロパティです
プロパティ 説明 デフォルト値 以下のサーバーに適用
host 指定されたサーバーのホスト名 localhost すべて
メモリ サーバーが使用できるメモリ量。有効な Java -Xmx 値を指定する必要があります。たとえば 2G。 1G Tomcat
ポート 指定されたサーバーに使用されるポート番号 ライセンスサーバー: 27000 データベースサーバー: 3306 Klocwork サーバー: 8080 すべて

kwservice setup

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

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

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

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

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

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

使用方法 

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

例

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

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

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

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

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

--migrate オプションは、Klocwork の以前のバージョンから projects_root を移行するために使用されます。アップグレードについては、前バージョンからのアップグレードを参照してください。

kwservice stop

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

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

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

使用方法 

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

例

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

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

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

kwservice --projects-root C:\Klocwork\projects_root stop klocwork
関連する概念