validate admin

validate admin コマンドは、統合プロジェクトとビルドを管理します。以下のコマンドオプションを使用するには、特定のパーミッションレベルが必要になる場合があります。詳細については、Klocwork プロジェクトへのアクセスの有効化を参照してください。

使用方法

 validate admin [<common_options>] <subcommand> [<subcommand_options>]

フィールド

<common_options> は、すべての validate admin サブコマンドに適用されるオプションにあるオプションのいずれかです。
<subcommand> は、以下のセクションで説明される validate admin サブコマンドのいずれかです。
<subcommand_options> は特定のサブコマンド用のオプションのいずれかです。

次のように、validate admin 用または validate admin サブコマンド用の引数ファイルも指定できます。

validate admin @<arguments_file>

validate admin <subcommand> @<arguments_file>

引数ファイルを作成して、コマンドライン引数を指定することができます。各引数は、独立した行に指定する必要があります。(引数ファイルにマルチバイト文字が含まれる場合、ファイルは UTF-8 でエンコードされている必要があります。)

例

validate admin --url http://server01.acme.com:8080 list-projects

すべての validate admin サブコマンドに適用されるオプション

以下のテーブルに示すオプションは、すべてのサブコマンドに適用されます。以下のセクションで、validate admin サブコマンドと各サブコマンドに適用されるオプションに関する情報を説明します。以下のオプションはサブコマンドの前に配置します。

名前	説明
@<arguments_file>	validate admin サブコマンドとオプションを含むテキストファイルを指定します。非常に長いコマンドラインが可能です (`validate admin set-project-property` 用の jar ファイルのリストを指定する必要がある場合など)。
--help	ソフトウェアのバージョン、著作権情報、およびコマンドのヘルプを表示します
--url http(s)://<validate_server_host>:<validate_server_port>/	Validate サーバーの URL。セキュアな Validate サーバー接続が構成されている場合は、https:// を使用します。 <host> には、接続する Validate サーバーを実行するホストマシンを指定します。デフォルトは、validate admin が正常に接続した最後のホストか、または validate admin が Validate サーバーに接続していない場合は localhost です。 <port> には、接続する Validate サーバーが使用するポートを指定します。デフォルトは、validate admin が正常に接続した最後のポートか、または validate admin が Validate サーバーに接続していない場合は 8080 です。セキュアな Validate サーバー接続が構成されている場合は、https:// を使用します。
--verbose	プログラム実行についての詳細情報を表示します。これは、エラーのトラブルシューティングに役立ちます
--version	バージョン情報を取得します

validate admin create-project

validate admin create-project を使用して、指定した名前で新しいプロジェクトを作成します。新しく作成されるプロジェクトには、解析 (ビルド) されるまでデータは含まれません。

validate admin create-project <project_name> [options]

フィールド

<project_name> は作成するプロジェクトの名前です。プロジェクト名とビルド名は文字または数字で始まる必要があります。プロジェクト名とビルド名ではピリオド (.)、マイナス記号 (-)、ホワイトスペース、およびアンダースコアも使用できます。名前はそれぞれ 64 文字を超えることはできません。

コマンドラインのプロジェクトをリファレンスするには、プロジェクト名の大文字小文字を正しく区別して指定する必要があります (プロジェクト名では大文字と小文字が区別されます)。プロジェクトの現在の名前を、Validate Static Code Analysis に表示されているとおりに、正確に指定することも必要です。

例

validate admin create-project Toolbus

validate admin create-project を使用したストリームの作成

validate admin create-project を使用して、既存プロジェクトの新しいストリームを作成することもできます。子ストリームを作成する前に、親プロジェクトと指定された親ストリームが既に存在している必要があることに注意してください。プロジェクトやストリームの現在の名前を、Validate Static Code Analysis に表示されているとおりに、正確に指定することも必要です。

例

validate admin create-project myProj/stream1

オプション

名前	説明
--encoding <arg>	プロジェクトで使用するソースファイルのエンコードを指定します。デフォルトは、お使いのシステムのエンコーディングです。許容される値のリストを検索するには、kwconv の `--list` オプションを使用します。詳細については、kwbuildproject の `--encoding` オプションを参照してください。

validate admin delete-build

このコマンドを使用して、プロジェクトビルドをビルドリストとデータベースから削除します。

一度削除すると、このビルドデータは復旧できません。

validate admin delete-build <project_name> <build_name>

フィールド

<project_name> はビルドを削除するプロジェクトの名前です。
<build_name> は削除するビルドの名前です。

例

validate admin delete-build Toolbus build_9

validate admin delete-ci-build

このコマンドを使用して、継続的インテグレーションビルドを CI ビルドリストとデータベースから削除します。

一度削除すると、この CI ビルドデータは復元できません。

validate admin delete-ci-build <project_name> <ci_build_name>

フィールド

<project_name> はビルドを削除するプロジェクトの名前です。
<ci_build_name> は削除するビルドの名前です。

例

validate admin delete-ci-build demothenes ci_build_2

validate admin delete-config

このコマンドを使用して、プロジェクトレベルまたはシステムの構成ファイルを削除します。構成ファイルの管理の詳細については、validate admin import-config を参照してください。

validate admin delete-config <project_name> <config-file_name>

フィールド

<project_name> は構成ファイルを削除するプロジェクトの名前です。

注意:

このようにして構成ファイルを削除すると、そのファイルはファイルシステムから実際に削除されます。

プロジェクト名として "workspace" を指定すると、プロジェクトの構成ファイルのデフォルトのリストから構成ファイルを削除する必要があります。

<config-file_name> は削除する構成ファイルの名前です。ファイルへのパスを指定するのではなく、ファイル名を指定します。

例

validate admin delete-config Toolbus metrics_custom.mconf

validate admin delete-config workspace OurMetrics.mconf

validate admin delete-project

このコマンドを使用して、指定したプロジェクトとそのすべてのビルドをプロジェクトリストとデータベースから削除します。

注意:

一度削除すると、このプロジェクトデータは復旧できません。

validate admin delete-project <project_name>

フィールド

<project_name> は削除するプロジェクトの名前です。

例

validate admin delete-project Toolbus --force

validate admin delete-project Toolbus_2 --delete-inactive-project

プロジェクトに関連付けられたストリームがある場合、プロジェクトとそれに関連するすべてのストリームを削除するには、--force オプションを追加する必要があります。

非アクティブ状態のプロジェクトを削除するには、--delete-inactive-project フラグを使用する必要があります。

オプション

名前 (および短い名前)	説明
--delete-inactive-project	このフラグを使用して、非アクティブなプロジェクトを削除します
--force	このオプションを使用して、プロジェクトおよび関連するストリームを強制的に削除します。

validate admin duplicate-project

このコマンドは新しいプロジェクトを作成するときのショートカットとして使用します。これにより、プロジェクトの設定、表示、モジュール、プロジェクトに関連付けられたユーザーと権限、ソースタイプの場所へのポインター、および構成ファイルが複製されます。当初のプロジェクトのビルドは複製されません。

validate admin duplicate-project <existing_project_name> <new_project_name>

フィールド

<existing_project_name> は複製する既存のプロジェクトの名前です。
<new_project_name> は作成するプロジェクトの名前です。プロジェクト名とビルド名は文字または数字で始まる必要があります。プロジェクト名とビルド名ではピリオド (.)、マイナス記号 (-)、ホワイトスペース、およびアンダースコアも使用できます。名前はそれぞれ 64 文字を超えることはできません。

コマンドラインのプロジェクトをリファレンスするには、プロジェクト名の大文字小文字を正しく区別して指定する必要があります (プロジェクト名では大文字と小文字が区別されます)。プロジェクトの現在の名前を、Validate Static Code Analysis に表示されているとおりに、正確に指定することも必要です。

例

validate admin duplicate-project Toolbus New_Toolbus

複製するプロジェクトの .conf ファイルに手動で構成されたプロパティや設定が含まれている場合、duplicate-project 操作の際にそのプロパティおよび値を確実にコピーするには、プロジェクトの Validate サーバーを再起動 (または元の変更を構成した後に再起動) する必要があります。

validate admin get-build-properties

このコマンドを使用して、指定したプロジェクトビルドのプロパティを表示します。ビルドプロパティの完全なリストは、統合プロジェクトとビルドプロパティのリファレンスを参照してください。

特定のプロジェクトビルドのプロパティを表示するには、次のコマンドを入力します。

validate admin [--url http(s)://<host>:<port>/] get-build-properties <project_name> <build_name>

フィールド

<host>:<port> には、Validate サーバーを実行するホストマシン (デフォルトは localhost) とポート (デフォルトは 8080) を指定します。
<project_name> はビルドプロパティを表示するプロジェクトの名前です。
<build_name> はプロパティを表示するビルドの名前です。

例

validate admin get-build-properties Toolbus build_2

validate admin get-project-properties

このコマンドを使用して、指定したプロジェクトのプロパティを表示します。これらのプロパティの一部は編集可能です。プロジェクトプロパティの完全なリストは、統合プロジェクトとビルドプロパティのリファレンスを参照してください。

既存のプロジェクトのプロパティを表示するには、次のコマンドを入力します。

validate admin [--url http(s)://<host>:<port>/] get-project-properties <project_name>

フィールド

<host>:<port> には、Validate サーバーを実行するホストマシン (デフォルトは localhost) とポート (デフォルトは 8080) を指定します。
<project_name> はプロパティを表示するプロジェクトの名前です。

例

validate admin get-project-properties Toolbus

validate admin get-projects-root

このコマンドを使用して、現在の projects_root (つまり、Validate サーバーを起動した projects_root) を表示します。

validate admin get-projects-root

例

validate admin --url http://ServerXZY.acme.com:8080 get-projects-root

validate admin import-config

validate admin import-config を使用して、構成ファイルを単一のプロジェクトまたは projects_root 全体にインポートします。

validate admin import-config <project_name> <file>

フィールド

<project_name> は構成ファイルをインポートするプロジェクトの名前です。

プロジェクト名として "workspace" を指定すると、(projects_root ディレクトリにある) プロジェクトの構成ファイルのデフォルトのリストに構成ファイルをインポートする必要があります。

<file> はインポートする構成ファイルへのフルパスです。構成ファイルのタイプは、拡張子または名前で判断されます。

例

validate admin import-config Toolbus C:\Validate\OurMetrics.mconf

validate admin import-config Toolbus C:\Validate\Toolbus_ownership.sow

validate admin import-config workspace C:\Validate\OurMetrics.mconf

詳細については、統合プロジェクト用構成ファイルの管理を参照してください。

validate admin export-config

validate admin export-config を使用して、構成ファイルをサーバーまたはプロジェクトからローカルマシンにダウンロードします。

validate admin export-config [options] <project-name> <server-file> <local-file>

フィールド

<project_name> はプロジェクトの名前であり、そこから構成ファイルをダウンロードします。

<server-file> は、ダウンロードするサーバーファイルの名前です。
<local-file> は、ローカルマシンに保存される、フォルダーまたはファイルの名前です。

例

validate admin export-config Toolbus ExportedOurMetrics.mconf C:\Validate\OurMetrics.mconf

validate admin export-config Toolbus ExportedOurMetrics.mconf C:\Validate\

validate admin list-builds

このコマンドを使用して、指定したプロジェクトの既存のビルドを一覧表示します。

validate admin list-builds <project_name>

フィールド

<project_name> はビルドを表示するプロジェクトの名前です。

例

validate admin list-builds Toolbus --detail

--detail オプションを追加すると、次のように、ビルドの日付、ビルドの自動削除の有無、およびビルドタグのリストが出力されます。

date=<date of build> keep=<true/false>  tags=<list of build tags>

validate admin list-ci-builds

このコマンドを使用して、指定したプロジェクトの既存の CI ビルドを一覧表示します。

validate admin list-ci-builds <project_name>

フィールド

<project_name> は、CI ビルドを表示したいプロジェクトの名前です。

例

validate admin list-ci-builds demosthenes --detail

--detail オプションを追加すると、次のように、ビルドの日付、ビルドの自動削除の有無、およびビルドタグのリストが出力されます。

date=<date of build> keep=<true/false>  tags=<list of build tags>

validate admin list-config-files

validate admin list-config-files を使用して、指定したプロジェクトで使用される構成ファイルを一覧表示します。「Validate プロジェクト用構成ファイル」も参照してください。

validate admin list-config-files <project_name>

フィールド

<project_name> は構成ファイルを表示するプロジェクトの名前です。

例

validate admin list-config-files Toolbus

validate admin list-config-types

validate admin list-config-types を使用して、有効なタイプの構成ファイルの名前と拡張子を一覧表示します。編集可能な構成ファイルを参照してください。

validate admin list-config-types

例

validate admin --url http://myhost.acme.com:8080 list-config-types

validate admin list-projects

このコマンドを使用して、現在の projects_root ディレクトリにある既存のプロジェクトのリストを表示します。

validate admin list-projects

例

validate admin --url http://myserver.acme.com:8080 list-projects

オプション

名前 (および短い名前)	説明
--include-streams (-s)	結果にストリームを含める
--prefix-filter (-x) <string>	指定された接頭辞で始まるプロジェクトとストリームに結果を制限する
--include-inactive (-i)	非アクティブ状態のプロジェクトを含む、すべてのプロジェクトをリストする
--format-json (-f)	すべてのプロジェクトとその詳細を JSON 形式でリストする

validate admin load

このコマンドを使用して、kwbuildproject によって作成された Validate テーブルを Validate サーバーにロードします。

validate admin load <project_name | path_to_stream> [<tables-directory>]

フィールド

<project_name | path_to_stream> は、ビルドをロードするプロジェクトの名前またはストリームへのパスです。
<tables-directory> は、kwbuildproject によって生成された Validate テーブルへのパスです。テーブルディレクトリを projects_root ディレクトリに配置しないでください。このディレクトリの読み取り権限と作成権限を所有している必要があります。

例 1: プロジェクト名

validate admin load Toolbus /my/tables/directory

例 2: ストリームへのパス

validate admin load Toolbus/variant1 /my/tables/directory

オプション

名前 (および短い名前)	説明
--file-overrides <file>	ファイルを追加、削除、または名前変更するためのオーバーライドファイルを指定します。このオプションを使用すると、複雑なシナリオをより適切に制御して、ファイルの不一致を減らすことができます。ファイルオーバーライドファイルの使用の詳細については、ビルドのロードで推奨される手法を参照してください。
--force	前の解析がまだ進行中でも、新しい解析を開始します。このオプションは、解析は中止されたが、ビルド状態として「進行中」と表示されている場合にのみ使用します。新しい解析が正常に終了した場合は、`--force` オプションは必要ありません。
--ignore-defect-threshold	プロジェクトに設定された欠陥しきい値制限を無視し、それを超えた場合でもビルドを強制的にロードします。
--name <build_name>	デフォルト以外のビルドの名前を設定します。デフォルトは "build#," で、フィールド # は 1、または最後に作成されたビルドよりも大きくします。削除されたビルドの番号は再利用できません。ビルド名では、数字 (0 ～ 9)、アルファベット (A ～ Z、a ～ z)、ピリオド (.)、マイナス記号 (-)、ホワイトスペース、およびアンダースコア文字のみ使用できます。<build_name> は 64 文字を超えることはできません。
--tags	ビルドタグのカンマ区切りリストを指定します。

validate admin lock-project-version

このコマンドは、以前のバージョンの Validate から、それ以降のバージョンの Validate サーバーにビルドをロードする場合に使用します。以前のバージョンの Validate を実行しているビルドマシンでこのコマンドを実行すると、このコマンドは、ビルドマシン上のエンジンおよびチェッカー設定に関する情報を格納するファイルを作成します。これにはすべてのカスタムチェッカーも含まれており、また有効なチェッカーも無効なチェッカーも含まれています。サーバーはこの情報をプロジェクトの基本設定として使用します。

validate admin lock-project-version <project_name> --url http(s)://<host>:<port>/

フィールド

<project_name> は、(新しい) Validate サーバーでのプロジェクト名です
<host>:<port> には、(新しい) Validate サーバーを実行しているホストマシン (デフォルトは localhost) とポート (デフォルトは 8080) を指定します。

例

validate admin lock-project-version myproject --url http://my2018server.acme.com:8084

詳細については、ビルドのクロスバージョンサポートを参照してください。

validate admin rename-build

このコマンドを使用して、ビルドの名前を変更します。

validate admin rename-build <project_name> <build_name> <new_build_name>

フィールド

<project_name> は名前を変更するプロジェクトの名前です。
<build_name> は名前を変更するビルドの名前です。
<new_build_name> はビルドに付ける名前です。

プロジェクト名とビルド名は文字または数字で始まる必要があります。プロジェクト名とビルド名ではピリオド (.)、マイナス記号 (-)、ホワイトスペース、およびアンダースコアも使用できます。名前はそれぞれ 64 文字を超えることはできません。

コマンドラインのプロジェクトをリファレンスするには、プロジェクト名の大文字小文字を正しく区別して指定する必要があります (プロジェクト名では大文字と小文字が区別されます)。プロジェクトの現在の名前を、Validate Static Code Analysis に表示されているとおりに、正確に指定することも必要です。

ホワイトスペースまたはピリオドを使用する場合は、名前を二重引用符で囲みます。

例

validate admin rename-build demosthenes buidl_6 build_6

validate admin rename-ci-build

このコマンドを使用して、CI ビルドの名前を変更します。

validate admin rename-ci-build <project_name> <ci_build_name> <new_ci_build_name>

フィールド

<project_name> は名前を変更するプロジェクトの名前です。
<ci_build_name> は変更する CI ビルドの名前です。
<new_ci_build_name> は CI ビルドに付ける名前です。

プロジェクト名とビルド名は文字または数字で始まる必要があります。プロジェクト名とビルド名ではピリオド (.)、マイナス記号 (-)、ホワイトスペース、およびアンダースコアも使用できます。名前はそれぞれ 64 文字を超えることはできません。

コマンドラインのプロジェクトをリファレンスするには、プロジェクト名の大文字小文字を正しく区別して指定する必要があります (プロジェクト名では大文字と小文字が区別されます)。Validate に表示されているとおりに、現在のプロジェクト名を正確に指定することも必要です。

ホワイトスペースまたはピリオドを使用する場合は、名前を二重引用符で囲みます。

例

validate admin rename-ci-build demosthenes buidl_2 build_2

validate admin rename-project

このコマンドを使用して、プロジェクトの名前を変更します。

validate admin rename-project <path-to-project-or-stream> <new-project-or-stream-name>

フィールド

<path-to-project-or-stream> は、名前を変更するプロジェクトまたはストリームへのフルパスです
<new-project-or-stream-name> は、プロジェクトまたはストリームに付ける名前です

プロジェクト名、ストリーム名、ビルド名は、文字または数字で始まる必要があります。プロジェクト名とビルド名ではピリオド (.)、マイナス記号 (-)、ホワイトスペース、およびアンダースコアも使用できます。名前はそれぞれ 64 文字を超えることはできません。

コマンドラインでプロジェクトまたはストリームを参照するには、大文字と小文字を正しく使用して指定する必要があります (プロジェクト名とストリーム名では大文字と小文字が区別されるため)。プロジェクトの場合、現在の名前を、Validate Static Code Analysis に表示されているとおりに、正確に指定することも必要です。ストリームの場合、ストリームへのフルパス (例: myProj/myStream1/subVariant) を指定する必要があります。

ホワイトスペースまたはピリオドを使用する場合は、名前を二重引用符で囲みます。

例

validate admin rename-project myProj/demosthenes demosthenes-new

validate admin set-project-property

このコマンドを使用して、既存のプロジェクトのプロパティを設定します。変更内容は後続のすべての解析実行に適用されます。

前提条件: すべての Validate サーバーが実行している。Validate サーバーの管理を参照してください。

validate admin --url http(s)://<server>:<port> set-project-property <project_name> <property> <value>

フィールド

<project_name> は、既存のプロジェクトの名前です。
<property> は、validate admin で表示されるプロジェクトプロパティに示されているプロパティのいずれかです。
<value> はプロジェクトプロパティの値です

例

常時グループ化オフでサーバーの指摘が表示されるように、指摘グループ化のデフォルト設定を変更します:

validate admin --url http://myserver:8080/ set-project-property Toolbus grouping_on_default false

アップロードされたファイルが単一ファイル内の同じ種類の欠陥数の上限を超えた場合に、ビルドを失敗させるしきい値を設定します:

validate admin set-project-property Toolbus same_kind_defect_per_file_threshold 5000

新しいプロジェクトのデフォルトとしてプロパティ値を設定するには、特定のプロジェクト名の代わりに workspace を使用します。例:

validate admin --url http://myserver:8080/ set-project-property workspace grouping_on_default false

validate admin set-project-property workspace same_kind_defect_per_file_threshold 5000

Notes

値がカンマで区切られたリストで構成されるプロパティに値を追加する場合は、追加する値 (値と値の間にスペース不要) だけでなく、すべての既存の値も指定する必要があります。そうしないと、既存の値は指定した値で上作成されます。

指定する値は Validate によって検証されません。このため、プロパティ値の設定によっては解析が失敗する可能性があります。無効なオプションが設定されている場合、そのコマンドを再度実行し、オプションの設定を元に戻します。無効なプロパティ以外のすべてのプロパティについては現在値を指定します。

以下の条件が当てはまる場合、プロパティ値全体を一重引用符で囲みます。

値にスペースが含まれる。
値がカンマで区切られたリストである。
値にダッシュ 2 個で始まるコマンドラインスイッチが含まれる。

詳細については、統合プロジェクトとビルドプロパティのリファレンスを参照してください。

validate admin set-project-state

このコマンドを使用して、既存のプロジェクトの状態を設定します。

validate admin set-project-state <project_name> <value>

フィールド

<project_name> は、既存のプロジェクトの名前です。
<value> はプロジェクトの状態の値 (active または inactive) です。

例

validate admin set-project-state project_1 active

set-project-state コマンドを使用できるのは、プロジェクトのルート管理者だけです。

validate admin unlock-project-version

プロジェクトで、以前のバージョンの Validate からのチェッカー構成をもはや使用しない場合は、このコマンドを使用して lock-project-version を元に戻します。このコマンドの実行後は、Validate はビルドがロードされた Validate サーバー用のチェッカー構成を使用します (ビルドマシンで実行された解析とは異なる一連のチェッカーにすることができます)。

validate admin unlock-project-version <project_name> --url http(s)://<host>:<port>/

フィールド

<project_name> は、(新しい) Validate サーバーでのプロジェクト名です
<host>:<port> には、(新しい) Validate サーバーを実行しているホストマシン (デフォルトは localhost) とポート (デフォルトは 8080) を指定します。

例

validate admin unlock-project-version myproject --url http://my2018server.acme.com:8084

詳細については、ビルドのクロスバージョンサポートを参照してください。

終了コード

validate admin コマンドを実行すると、次のいずれかの終了コードが生成されます。コマンドが正常に実行され、エラーがない場合の終了コードは 0、エラーが発生した場合の

終了コードは 1 です。
サブコマンドは --help または --version

エラーが発生し、終了コードは 1 です。終了コード。validate admin load コマンドが終了コード 1 を返した場合の詳細は、build.log ファイルを確認してください。

ビルドライセンス消費

以下の validate admin サブコマンドを実行すると、ビルドライセンスが消費されます:

create-project: 指定された名前で空のプロジェクトを作成する
delete-build: プロジェクトからビルドを削除する
delete-ci-build: プロジェクトから CI ビルドを削除する
delete-config: プロジェクトから構成ファイルを削除する
delete-project: プロジェクトとそのすべてのビルドを削除する
duplicate-project: 指定されたプロジェクトの複製を作成する
import-config: プロジェクトに構成ファイルをインポートする
load: 選択したプロジェクトの新しいビルドをロードする
lock-project-version: プロジェクトバージョンをロックする
rename-build: ビルド名の変更
rename-ci-build: プロジェクト CI ビルドの名前を変更する
rename-project: プロジェクト/ストリームの名前を変更する
set-project-property: プロジェクトのプロパティを設定する
set-project-state: プロジェクトの状態を設定する
unlock-project-version: プロジェクトバージョンのロックを解除する