Unified Agent の設定パラメータ

 

概要概要

このページでは、Unified Agent の設定で使用されるパラメータについて説明します。

構成ファイルのパラメーター

組織のバイタル 

認証、分類、および製品/プロジェクトの定義に使用される一般的なパラメーター。

-project または-projectToken いずれかが必須フィールドです

トップに戻る

パラメータ

説明や期待される動作

Trueのとき

Falseのとき

デフォルト値

コマンドラインパラメーターの利用

パラメータ

説明や期待される動作

Trueのとき

Falseのとき

デフォルト値

コマンドラインパラメーターの利用

apiKey

(必須)組織で一意の識別子。プラグインで組織を識別するために使用されます。 

N/A

N/A

No default

-apiKey

userKey

WhiteSource アカウントのプロファイルページから生成できるユーザーの一意の識別子。

注:  [統合] ページで[ユーザーレベルのアクセスを強制する]が選択されている場合にのみ必要です。

N/A

N/A

No default

-userKey

requesterEmail

提供されたメールは、既存のWhiteSource アカウントと照合されます。新しいライブラリの要求は、要求者の電子メールとして一致したアカウントで作成されます。

user@provider.com

N/A

N/A

No default

利用不可

projectName

更新するプロジェクトの名前(必須)。

注:定義されていない場合は、代わりに projectToken を定義する必要があります。

N/A

N/A

No default

-project

projectVersion

プロジェクトのバージョン。

注:  [統合] ページで[プロジェクト名にバージョンを使用する]が選択されている場合、名前に追加され ます。

N/A

N/A

No default

-projectVersion

projectTag

新しく作成されたプロジェクトに対してのみプロジェクトタグの設定を有効にします。プロジェクトタグは key:value で定義する必要があります

例:projectTag= myTagKey:myTagValue

:このパラメーターは、RepoIntegrations またはAzureDevOps ServicesIntegration を使用している場合はサポートされていません。

N/A

N/A

No default

-projectTag

productName 

更新する製品の名前

N/A

N/A

MyProduct

-product

productVersion

更新する製品とプロジェクトのバージョン。プロジェクトのバージョンを上書きします。

N/A

N/A

No default

-productVersion

productToken 

更新する製品の一意の識別子。見つかった 統合 ページ。

N/A

N/A

No default

-productToken

projectPerFolder

"-d" パラメーターに従って、サブフォルダーごとに1つのプロジェクトを作成します。各サブフォルダーには、フォルダーに応じた名前が付けられます。



フォルダごとのプロジェクトが作成されます

フォルダごとのプロジェクトは作成されません

False

-projectPerFolder

projectPerFolderIncludes 

フォルダーのコンマまたはスペース区切りのリストがスキャンに名付けられるようになった

projectPerFolder が True の場合にのみ関連し ます

N/A

N/A

All folders

利用不可

projectPerFolderExcludes

スキャンから除外されるフォルダー名でコンマまたはスペース区切りのリスト

projectPerFolder が True の場合にのみ関連し ます

N/A

N/A

デフォルトは""

利用不可

wss.connectionTimeoutMinutes

分単位の接続タイムアウト。

N/A

N/A

60

 

wss.url=https://saas.whitesourcesoftware.com/agent

#wss.url=https://app.whitesourcesoftware.com/agent

#wss.url=https://app-eu.whitesourcesoftware.com/agent 

サーバー URL パネルのプロフィールページから、組織のWS サーバー URL に従って関連する URL を有効にします(さらに、[統合]タブにあります)。次に、エージェントパスを追加します。

N/A

N/A

https://saas.whitesourcesoftware.com/agent

-wss.url

 

ポリシー

ポリシーにより、組織はオープンソース導入ポリシーを設定および施行できます。ポリシースキャン設定に関連するパラメータ。

パラメータ

説明や期待される動作

Trueのとき

Falseのとき

デフォルト値

コマンドラインパラメータの利用

パラメータ

説明や期待される動作

Trueのとき

Falseのとき

デフォルト値

コマンドラインパラメータの利用

checkPolicies

WhiteSource を更新する前に、ポリシーチェックのリクエストを送信するかどうか。

  • True に設定する場合  、  forceUpdate も True に設定する必要があります 。

  • False に設定する と、ポリシー関連のデータは生成されません。

ポリシー違反の場合、スキャンは ERROR 終了コードPOLICY_VIOLATION(-2)で終了します。

スキャンは SUCCESS で終了します。ポリシー違反に関係なく、インベントリは更新されます。

False

No

forceCheckAllDependencies

すべての依存関係を強制的にチェックします。 

checkPolicies が True に設定されている場合にのみ使用されます。False に設定されている場合、このフラグは関係ありません。

WhiteSource プロジェクトに導入されたすべての依存関係のすべてのポリシーをチェックします。

WhiteSource プロジェクトに導入された新しい依存関係のみを対象にします。

False

No

updateInventory 

更新要求を送信するかどうか。



更新要求を送信します。

更新リクエストを送信せずに、ポリシーチェックリクエストをWhiteSourceに送信します。つまり、ユーザーはWhiteSourceのインベントリを更新せずにcheckpolicies リクエストを実行 します。

NS

番号

forceUpdate

ポリシー違反に関係なく、組織のインベントリを更新するかどうか。

checkPolicies が True に設定されている場合にのみ使用されます。False に設定されている場合、このフラグは関係ありません。

checkPolicies ステップが失敗した場合でも、プロジェクトを更新します。

  • App- Update

  • Exit code- End with SUCCESS

  • Output- No Error message

ポリシー違反の場合:

  • App- No update

  • Exit code- (-2)

  • Output-end with Error

False

No

forceUpdate.failBuildOnPolicyViolation

Unified Agent の終了 コードをポリシーチェックの結果にするか、スキャンの結果にするかを決定します。
forceUpdate が True に設定されている場合にのみ使用されます。

Unified Agent の終了コードは、ポリシーチェックの結果になります。つまり、チェックポリシーに障害が発生した場合、終了コードは-2になります。

Unified Agent の終了コードは、スキャンの結果になります。(成功または失敗) 

False

No



一般

その他のパラメータ設定。

 

パラメータ

説明や期待される動作

Trueのとき

Falseのとき

デフォルト値

コマンドラインパラメーターの利用

パラメータ

説明や期待される動作

Trueのとき

Falseのとき

デフォルト値

コマンドラインパラメーターの利用

offline

WhiteSource に送信する代わりにオフラインで更新リクエストを作成するかどうか。

スキャンしたプロジェクトの横にある whitesource フォルダーにオフラインリクエストファイルが作成されます。

結果はサーバーに直接送信されます。

False

-offline

updateType

以前にスキャンしたプロジェクトをスキャンする場合、結果を追加するかオーバーライドするか。

  • APPEND- プロジェクトのインベントリにスキャンされたライブラリを追加します。推移的な依存関係のみが追加されている場合は、直接の依存関係として追加されるため、アラートやポリシーなど、アプリケーションのすべてのメカニズムが適用されます。この値は、同じWhiteSourceプロジェクトで管理されている複数のビルドプロセスを操作する場合にのみ使用してください。

  • OVERRIDE- 新しく追加された依存関係を追加します(違い)

N/A

N/A

OVERRIDE

-updateType

ignoreSourceFiles

すべてのパッケージマネージャー/依存関係リゾルバーのパッケージ依存関係のみを含めるかどうか。 

重要:バージョン21.2.2以降、このパラメーターは非推奨になり、新しいパラメーターfileSystemScanに置き換えられます。

x.ignoreSourceFiles 各パッケージマネージャーの個々のパラメーター値をオーバーライドし 、依存関係の解決中に検出されたすべてのソースファイルを無視します。その後、包含/除外パラメータは無視されます。

ignoreSourceFiles を使用すると、includes / excludes パラメータは無視されます

オーバーライドアクションは発生せず、パッケージマネージャーの各 x.ignoreSourceFiles パラメーターのデフォルト値が適用されます(明示的に異なる宣言がない限り)

False

No

fileSystemScan

パッケージマネージャーベースの依存関係の解決に加えて、ソースファイルとバイナリのファイルシステムスキャンの実行にます。スキャンされるファイルは、includesパラメーターとexcludeパラメーター、およびリゾルバー固有のignoreSourceFilesパラメーターによって制御できます。

重要:このパラメーターはバージョン21.2.2の新機能であり、間もなく廃止されるignoreSourceFilesをオーバーライドします

パッケージマネージャーベースの依存関係の解決に加えて、ソースファイルとバイナリのファイルシステムスキャンを実行します。 

パッケージマネージャーベースの依存関係の解決のみが実行されています。 

NS

番号

scanComment

スキャンにコメントを追加します。コメントは、プロジェクトページの ‘Project Vitals’ パネルとプラグインリクエスト履歴レポートに表示されます。UTF-8文字をサポートします。

スキャンにコメントが追加されます。

スキャンにコメントは追加されません。

No default

-scanComment

failErrorLevel

ALLに設定すると  、Unified Agent は、重大なエラー(解決の失敗、プレステップエラーなど)で終了します。

それ以外の場合、動作に変更はありません。

可能な値 -ALL または DEFAULT(大文字のみ)

N/A

N/A

"DEFAULT"

No

requireKnownSha1

既知/未知のSHA-1との依存関係をチェックします。 

不明なSHA-1との依存関係が1つ以上見つかった場合、Unified Agent はスキャンを終了します。

スキャンは正常に続行されます。

True

-requireKnownSha1

generateProjectDetailsJson

スキャンの完了時に、projectTokens と projectNames を含む JSON ファイルを生成するかどうか 。

Unified Agent は、スキャンの最後に、 projectTokens と projectNames を含む ‘scanProjectDetails.json’ という名前の JSON ファイルを生成します。

レポートは生成されません。

False

No

generateScanReport

(組織および製品管理者のみ) True に設定すると、スキャンの最後に JSON 形式のレポートが作成されます。このレポートには、脆弱性、ポリシー違反、上位の修正、および在庫の詳細に関する情報が含まれます。

ファイル名の形式は

'<project_name>-<yyyy-mm-dd>T<HHmmss>+<UTC offset>-scan_report.json'
例: 'Demo App-2019-06-04T181226+0300-scan_report.json'

注:

  • このレポートでは、'userKey' 構成パラメーターは必須です。

  • このレポートを生成するには、構成パラメーター ‘updateInventory’ を True に設定する必要があります。

  • このパラメーターはオフラインモードでは機能しません。

スキャンの最後に JSON 形式のレポートが作成されます。このレポートには、脆弱性、ポリシー違反、上位の修正、およびインベントリの詳細に関する情報が含まれています。

レポートは生成されません。

False

-generateScanReport

scanReportTimeoutMinutes

スキャンレポートを生成するプロセスのタイムアウト(分単位)。タイムアウト間隔が経過した場合、レポートは生成されませんが、スキャンは続行されます。

N/A

N/A

10

No

scanReportFilenameFormat

生成されたスキャンレポートのファイル名形式を制御します。
有効な値は次のとおりです。 

  • project_with_timestamp (default) - 形式は次のようになります : <project_name>-<yyyy-mm-dd>T<HHmmss>+<UTC offset>-scan_report.json

  • project_only - 形式は次のようになります : <project_name>-scan_report.json

  • static - 形式は次のようになります scan_report.json

N/A

N/A

"project_with_timestamp"

No

commandTimeout

コマンド実行のタイムアウト(秒単位)。

該当なし

該当なし

900

-commandTimeout

updateEmptyProject

WhiteSource で空のプロジェクトを作成するか、空のデータで既存のプロジェクトを更新するか。

:このパラメーターは、すべてのリゾルバー/パッケージマネージャーに影響します。

依存関係がない場合でもプロジェクトを更新/作成します 

空のプロジェクトを作成/更新しません

True

No

log.files.level

デフォルトでログを保存する場合、これによりログのレベルが決まります。 

  • Trace

  • Debug(デフォルト)

  • Info

  • Warn

  • Error

  • Off - 機能を無効にします。

注:ログの場所は、log.files.path パラメーターによって決定されます。

注: Unified Agent では、同じライブラリを連続してスキャンするたびに、独自のフォルダが生成されます。構造は次のとおりです。 

wss-scan-<date>-<time>

N/A

N/A

Debug

-log.files.level 

log.files.maxFileSize

デフォルトでログを保存する場合の MB 単位の最大サイズです。このサイズを超えると、ファイルは上書きされます。 

注:これは、Unified Agent の1回の実行(サイクル)を反映しています。ファイルは実行ごとに蓄積されます。

N/A

N/A

10 MB

No

log.files.maxFilesCount

デフォルトでログを保存する場合のログファイルの最大数。この数を超えると、最も古いファイルが新しいファイルで上書きされます。 

注:これは、Unified Agent の1回の実行(サイクル)を反映しています。ファイルは実行ごとに蓄積されます。

N/A

N/A

3

No

log.files.path

作成されたログファイルの場所。

注:  Windows では、値の末尾に "\ " を付けないでください。

 

N/A

N/A

ログのデフォルトの場所は、'whitesource'フォルダーにあります(whiteSourceFolderPath パラメーターによって決定されます)。

No

sendLogsToWss

WhiteSource にログを送信するかどうか。

WhiteSource にログを送信します。

WhiteSource にログを送信しません。

False

No

case.sensitive.glob

ファイルシステムで大文字と小文字を区別する必要があるかどうか。

ファイルシステムでは大文字と小文字が区別されます。

ファイルシステムでは大文字と小文字は区別されません。

False

No

showProgressBar

ログ内にプログレスバーを表示するかどうか。

注:このパラメータは、Unified Agentにのみ有効です(優先順位付けではありません)。

プログレスバーはログ内に表示されます。

プログレスバーはログ内に表示されません。

NS

番号

パッケージマネージャーの依存関係リゾルバー

パッケージマネージャーのスキャン構成に関連するパラメーター。

注: すべてのパッケージマネージャーの依存関係リゾルバーは 、デフォルトでTrueに設定さ れています。

トップに戻る

一般

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

resolveAllDependencies 

スキャンのすべての依存関係リゾルバーをデフォルトで有効にするか無効にするか。

たとえば、次のパラメーターが設定されている場合、この場合は npm の依存関係のみが解決されます 

resolveAllDependencies=false
npm.resolveDependencies=true
#maven.resolveDependencies=false

設定した場合 は True、すべてのパッケージマネージャのためのデフォルト  resolveDependencies に設定されたパラメータ は True、しない限り、明示的に設定 は False

False に設定する と、すべてのパッケージマネージャーのresolveDependencies のデフォルトで 、明示的に True に設定されていない限り 、パラメーターは False に設定され ます

True

-resolveAllDependencies

excludeDependenciesFromNodes=.*commons-io.*,.*maven-model 

正規表現のコンマ区切りリスト。

アーティファクトIDまたは複数のアーティファクトID(カンマ区切り)を指定して、提供されたツリーノードとそのサブノードをスキャンから除外します。

注: これらはプロジェクトインベントリに追加されません。 

N/A

N/A

No default

No

Java

Maven

Maven統合の詳細については、こちらを参照してください。

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

maven.ignoredScopes 

無視する正確なスコープ名を定義します

デフォルトでは、Unified Agent はスコープ 'test' および 'provided' の直接の依存関係を無視します。
この値をオーバーライドして、特定のスコープを有効にすることができます。

N/A

N/A

"provided" と "test"

-maven.ignoredScopes

maven.resolveDependencies 

Maven の依存関係を解決するかどうかには、"pom.xml" が必要です。

プロジェクトが Maven プロジェクトの場合、解決が開始されます。

Maven の解決は解決を開始しません。

True

-maven.resolveDependencies

maven.ignoreSourceFiles  

依存関係リゾルバーを使用する場合、pom.xml 依存関係のみが含まれ、ソースファイルとパッケージは含まれません。

注:fileSystemScantrueの場合にのみ関連します

".java", ".class","pom.xml" などの拡張子を持つファイルをスキャンから無視します。

上記のファイル拡張子を無視しません。

False



maven.aggregateModules  

すべての pom モジュールを、集約された依存関係フラットリスト(階層なし)を使用して単一の WhiteSource プロジェクトに結合します。

フラットリストとして表示される、すべてのモジュールに対して単一のプロジェクトを作成します。

モジュールごとにプロジェクトが作成され、階層ツリーとして表示されます。

False

-maven.aggregateModules

maven.ignorePomModules  

パッケージタグ内に 'pom' 値を含む pom.xml ファイルの依存関係解決を無視するかどうか。つまり、'<packaging>pom</packaging>'。

依存関係リゾルバーは、'pom' 値( '<packaging>pom</packaging>' )のパッケージングタグを含む pom.xml ファイル内で指定されたすべての依存関係を無視します。

依存関係リゾルバーは、 'pom' 値を持つパッケージングタグを含む pom.xml ファイル内で指定されたすべての依存関係を無視しません( '<packaging>pom</packaging>' )

True

No

maven.runPreStep 

見つかった pom.xml フォルダーで "mvn clean install" コマンドを実行するかどうか

"mvn clean install" コマンドを実行します

"mvn clean install" コマンドを実行しません

False

No

maven.ignoreMvnTreeErrors 

コマンド  `mvn dependency:tree`  が失敗した場合、(コマンドの)部分的な出力が存在する場合はそれを解決し、pom.xml ファイルからのすべての直接の依存関係を解析しようとします。

スキャンは成功して終了し、フラットリストを送信します(直接のみ)。

スキャンはエラーで終了します。

False

No

maven.environmentPath 

M2_HOME 環境変数と一致しない場合の Maven インストールへのパス

N/A

N/A

No default

No

maven.m2RepositoryPath 

デフォルトの場所で使用できない場合の .m2 フォルダーへのパス。

N/A

N/A

No default

No

maven.downloadMissingDependencies 

ユーザーが Maven で欠落している依存関係のダウンロードを無効にできるようにします。

リポジトリに欠落している依存関係 jar/binary がある場合、コードは欠落している依存関係をダウンロードしようとします。

欠落している依存関係のダウンロードは無効になります。

True

No

maven.additionalArguments 

 '-' または '--' で始まるパラメータを提供し、Unified Agent はこれらを Maven コマンドの最後に追加する必要があります。

値の例:

  • -s=path/to/settings.xml

  • -s=path/to/settings.xml --threads=2.0C 

N/A

N/A

No default

No

failErrorLevel 

次の場合にエラーコードを返します。

  • resolver.runPrepStep が失敗しました

  • 依存関係の収集/実行中にエラーが発生しました

注:ALL に設定する と、Unified Agent は、SUCCESS ではなく、スキャン内のすべてのエラーに対してエラーコードを返します 。これは、プラグイン(NPM、MAVENなど)から Unified Agent に移行するお客様に役立ちます。

N/A

N/A

DEFAULT

No

maven.projectNameFromDependencyFile 

プロジェクト名が依存関係ファイルから取得されるかどうか。

プロジェクト名は、pom.xml の 'artifactId' フィールドから取得されます。Maven リゾルバーが唯一のアクティブなリゾルバーである場合にのみ機能します。

Unified Agent が、True に設定されている Maven 以外の追加のリゾルバーを識別する と、エラーが生成されます。

プロジェクト名は、CLI /構成ファイルから取得されます。

False

No

Gradle

For more information regarding Gradle integration, refer here.

Back to top.

構成ファイルのパラメーター

説明と予想される動作

真であれば

Falseの場合

ディフォルト

コマンドラインパラメータは利用できますか?

構成ファイルのパラメーター

説明と予想される動作

真であれば

Falseの場合

ディフォルト

コマンドラインパラメータは利用できますか?

gradle.ignoredConfigurations

 

スキャンで無視する依存関係構成を決定できます。

形式は次のとおりです。

  • 無視する正確な構成名。
    値はスペースで区切る必要があります。

例えば: gradle.ignoredConfigurations= testCompileOnly testRuntimeOnly

「testCompileOnly」および「testRuntimeOnly」という名前の構成は無視されます。

  • 構成では正規表現を使用できます。

例:gradle.ignoredConfigurations=.*test.* 文字列「test」を含むすべての構成名を無視します。
注:このパラメーターは以前は名前が付けられていましたgradle.ignoredScopes

該当なし

該当なし

デフォルトなし

番号

gradle.resolveDependencies 

Gradleの依存関係を解決するかどうか。build.gradleまたはbuild.gradle.ktsが必要です。

Gradleの依存関係を解決します

Gradleの依存関係を解決しません

True
(場合を除く)resolveAllDependencies=false

-gradle.resolveDependencies

gradle.ignoreSourceFiles 

依存関係リゾルバーを使用する場合、ソースファイルではなく、パッケージの依存関係のみが含まれます。

注:fileSystemScantrueの場合にのみ関連します

スキャンにはパッケージの依存関係のみが含まれ、ソースファイルは含まれません。

依存関係リゾルバーを使用する場合、パッケージの依存関係とソースファイルが含まれます。

NS

番号

gradle.aggregateModules 

すべてのモジュールに対して単一のプロジェクトを作成するかどうか。

すべてのモジュールに対して単一のプロジェクトを作成します。

モジュールごとにプロジェクトが作成されます。プロジェクトの名前はモジュールの名前と同じになります(その場合、projectNameは無視されます)。

NS

-gradle.aggregateModules

gradle.preferredEnvironment 

'wrapper'に設定すると、UnifiedAgentは 'gradlew'ラッパーコマンドを実行します。'gradle'に設定すると、組み込みのgradleコマンドが使用されます。

該当なし

該当なし

ラッパー

番号

gradle.additionalArguments 

ユーザがUnifiedAgentの既存のコマンドに引数を追加できるようにします。既存のコマンドは、gradle依存関係またはgradleラッパー依存関係です。これは次のように機能します。

ユーザーは「-」または「-」で始まる任意のパラメーターを指定でき、UnifiedAgentはこれらを最後に追加します 

例えば:

  • -Pbranch=dev -PbuildWithSources=false

  • --no-daemon --info

  • -Pbranch=dev -PbuildWithSources=false --no-daemon --info

該当なし

該当なし

デフォルトなし

番号

gradle.includedConfigurations

スキャンに含める依存関係の構成を決定できます。

形式は次のとおりです。

  • 含める正確な構成名。

値はスペースで区切る必要があります。
例えば:

gradle.includedConfigurations= compileOnly testCompileOnly

「compileOnly」および「testCompileOnly」という名前の構成が含まれています。

  • 構成には正規表現を含めることができます。

例えば:

gradle.includedConfigurations=.*Only.*

文字列「Only」を含むすべての構成名が含まれます
注:このパラメーターは以前に名前が付けられていましたgradle.includedScopes 

該当なし

該当なし

デフォルトなし

番号

gradle.excludeModules 

Gradleスキャンで特定のモジュールを除外できるようにします。 

形式は次のとおりです。

  • 除外する正確なモジュール。値はスペースで区切る必要があります。次に例を示します。gradle.excludeModules= DevProd-「Dev」および「Prod」という名前のスコープを除外します。

  • 正規表現。次に例を示します。gradle.excludeModules=。* Dev。*には、文字列「Dev」を(名前のどこかに)含むすべてのモジュール名が含まれます。

該当なし

該当なし

デフォルトなし

番号

gradle.includeModules 

Gradleスキャンに特定のモジュールを含めることができます。

形式は次のとおりです。

  • 含める正確なモジュール。値はスペースで区切る必要があります。次に例を示します。gradle.includeModules= DevProd-「Dev」および「Prod」という名前のモジュールをインクルードします。

  • 正規表現。次に例を示します。gradle.includeModules=。* Dev。*に は、これらの文字を含むすべてのモジュール名が含まれます。

該当なし

該当なし

デフォルトなし

番号

gradle.innerModulesAsDependencies

falseに設定すると、このパラメーターはすべてのモジュールの依存関係を無視し、解像度スキャンから除外します。

解像度スキャンからのすべてのモジュールの依存関係が含まれています。」

すべてのモジュールの依存関係を無視して、解像度スキャンから除外します。

NS

番号

Ant

For more information regarding Apache Ant integration, refer here.

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

ant.resolveDependencies 

Apache Ant ベースのプロジェクトをスキャンするかどうか。

'ant.pathIdIncludes' パラメーターが指定されていない場合、Unified Agent は、プロジェクト内の次の拡張子を検索します: jar, war, ear, par, rar, dll, exe, ko, so, msi, zip, tar, tar.gz, swc, swf

Apache Ant ベースのプロジェクトをスキャンします。

Apache Ant ベースのプロジェクトをスキャンしません。

True

(場合を除く)resolveAllDependencies=false

No

ant.pathIdIncludes 

スキャンに含める正規表現またはパスIDのコンマ/スペース区切りリスト(build.xml ファイルで指定)。

注: このパラメーターの値がスキャンに影響を与えるには、パラメーター 'ant.resolveDependencies' を True に設定する必要があります。

N/A

N/A

".*"

No

ant.external.parameters 

key=value のリスト(コンマで区切られています)。これらの値は、ANT <property> XML タグと同じです。

N/A

N/A

No default

No

JavaScript

NPM + Yarn

NPM統合の詳細については、こちらを参照して ください

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

npm.ignoreDirectoryPatterns

npm 解決中に package.json 依存関係ファイルを検索するときに無視されるディレクトリパターンのリストを定義する文字列パラメーター。ディレクトリのリストは、コンマ/セミコロンで区切られたリストです。

N/A

N/A

example,examples,test,.ws_bower

No

npm.resolveDependencies  

npmの依存関係を解決するかどうか。

注:npm.ignoreDirectoryPatternsで 定義されたディレクトリ内で定義された 'package.json' 依存関係ファイルはスキャンされないため、これらのファイルで宣言された依存関係は無視されます。たとえば、無視するデフォルトのディレクトリセットには、次の依存関係ファイルは含まれません。

*/examples/*package.json

*/example/*package.json

*/.ws_bower/*package.json

*/test/*package.json

npm の依存関係を解決します。

  • yarn.lockのファイルが識別された場合、その後、yarnの解像度が行われます。

  • パッケージ・lock.lockのファイルが識別された場合、その後、NPMの解像度が行われます。

  • 両方のロックファイルが見つかった場合、または見つからなかった場合は、npm.yarnProjectパラメーターを使用して、実行する解決策を決定します

npm の依存関係を解決しません。

True

-npm.resolveDependencies

npm.ignoreSourceFiles 

npm リゾルバーを使用する場合は、node_modules フォルダーの外にある js ファイルを無視するかインクルードして ください。

注:fileSystemScantrueの場合にのみ関連します

node_modules フォルダー外の js ファイルを無視します。

node_modules フォルダーの外に js ファイルを 含めます。

True

No

npm.includeDevDependencies 

開発者の依存関係を含めるかどうか。

スキャンに devDependencies を追加し ます

製品の依存関係のみがスキャンされます。

False

-npm.includeDevDependencies

npm.runPreStep 

見つかった package.json ファイルで "npm install" を実行するかどうか 。

 

 

False

No

npm.ignoreNpmLsErrors 

 'npm list' コマンドのエラーを無視するかどうか。

スキャンは、SUCCESS ステータス+階層ツリーで終了します。

スキャンは SUCCESS ステータス+フラットリストで終了します。

False

No

npm.ignoreScripts 

プロジェクトの package.json ファイル内のスクリプトを無視するかどうか 。

ノート:

  • npm.runPreStep = True の場合にのみ使用され ます。 

  • 20.4.2以降、フラグは Yarn でもサポートされています。

Unified Agent は npm install --ignore-scripts を実行し、プロジェクトのpackage.json ファイル内のスクリプトは 実行されません。

npm install コマンドが実行され、プロジェクトの package.json ファイル内のスクリプトが実行されます 。

False

No

npm.yarnProject 

これが yarn プロジェクトであるかどうか(またはそうでないか)。

 yarn プロジェクトを解決します

 yarn プロジェクトを解決しません

False

No

npm.accessToken

NPM レジストリから必要なデータをフェッチするために、関連する環境(Microsoft Visual Studio または Artifactory )によって提供されるアクセストークン値。

N/A

N/A

Empty

No

npm.identifyByNameAndVersion 

npm レジストリ(プライベートまたはパブリック)からパッケージデータをフェッチするかどうかを定義します。

Unified Agent は、パッケージの名前とバージョンのみを使用します。

npm レジストリ(プライベートまたはパブリック)からパッケージデータを取得します。

False

No

npm.yarn.frozenLockfile 

 ‘--frozen.lockfile’ yarn パラメーターを使用してプレステップを実行できるようにします。
注: 有効になっている場合は、次のパラメーターも True に設定する必要があり ます:  npm.runPreStep および npm.yarnProject

 ‘--frozen.lockfile’ yarn パラメーターを使用してプレステップを実行しません。

 ‘--frozen.lockfile’ yarn パラメーターを使用してプレステップを実行しません。

False

No

npm.resolveMainPackageJsonOnly

npm プロジェクトでは、複数の package.json ファイルが存在する可能性があります。したがって、メインの package.json ファイル(ルートディレクトリにあるファイル)のみを解決するか、すべての package.json ファイルを解決するかを決定でき ます。

Unified Agent は、-d パラメーターとして渡されたフォルダーにpackage.json ファイルがあるかどうかを確認し ます。そのようなファイルが存在しない場合、スキャンは失敗します。それ以外の場合、Unified Agent はこの package.json のみをスキャンし ます。

Unified Agent はすべてのpackage.json ファイルを解決し ます

False

No

npm.removeDuplicateDependencies 

npm の依存関係の解決中に重複する依存関係を削除するかどうか。

npm の依存関係の解決中に重複する依存関係を削除します。

npm の依存関係の解決中に重複する依存関係が含まれます。

True

No

npm.resolveAdditionalDependencies

グローバルな依存関係を解決し、モジュールを必要とするかどうか。

注: Require は、  他の言語でインポートするのと同じです。

グローバルな依存関係を解決し、モジュールを必要とします。

package.json で宣言されている依存関係のみを解決し ます。

False

No

npm.resolveLockFile 

Unified Agent が解決のためにマニフェスト(package.json)とロックファイル(package-lock.json)に依存し、NPM コマンドに依存しないかどうか。ロックファイルが欠落している場合、検出は node_modules フォルダーに基づいて行われます。 

Unified Agent は、package.json とpackage-lock.json を使用して階層ツリーを取得します。package-lock.json が欠落している場合、検出は node_modules フォルダーに基づいて行われます。

Unified Agent は、npm コマンドを実行して階層ツリーを取得します。

False

No

npm.projectNameFromDependencyFile 

プロジェクト名が依存関係ファイルから取得されるかどうか。これは NPM リゾルバー専用のスタンドアロンパラメーターであり、npm リゾルバーが唯一のアクティブなリゾルバーである場合にのみ有効になります。

ユニファイドエージェントが、True に設定されている npm 以外の追加のリゾルバを識別する と、エラーが生成されます。

:productVersion が指定された場合、それはプロジェクトバージョンをオーバーライドし、プロジェクト名の一部になります。

プロジェクト名は package.json ファイルから取得され ます。

プロジェクト名は、CLI/構成ファイルから取得されます。

False

No

npm.failOnNpmLsErrors 

'npm ls' エラーが発生した場合に、失敗してスキャンを終了するかどうか。

'npm ls' の実行中にエラーが発生した場合、次のログが出力され、スキャンが停止します。 " 'npm ls' コマンドでエラーが見つかりましたが、フラグ npm.failOnNpmLsErrors が true の場合、プログラムは終了します。"

'npm ls' でエラーが発生した場合、Unified Agent は引き続き実行され、可能な限り多くの依存関係情報を取得します。

NULL (meaning False -  the scan will not fail on npm ls errors)

No

npm.resolveGlobalPackages 

Docker イメージをスキャンし、npm が使用できない場合、グローバルな依存関係を抽出するために、このパラメーターを使用すると、インストールされて使用可能な NPM に依存する必要がなくなります。これは、Unified Agent が Docker イメージにインストールされているすべてのグローバル npm パッケージを識別するためです。true の場合、 Unified Agent は 'node_modules' ディレクトリ内のすべての package.json ファイルをスキャンし ます。このパラメーターは、Docker イメージをスキャンするときに主に関連します。

 node_modules フォルダーの下にあるすべての package.json ファイルを解決し ます。

node_modules フォルダーの下の package.json ファイルをスキャンしません。

False

No

Bower

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

bower.resolveDependencies 

Bower プロジェクトフォルダを解決するかどうか。

Bower プロジェクトフォルダを解決します

Bower プロジェクトフォルダを解決しません

True

No

bower.ignoreSourceFiles  

依存関係のリゾルバを使用している場合  パッケージの依存関係+ソースファイルを、パッケージの依存関係を含めるかどうか。

注:fileSystemScantrueの場合にのみ関連します

パッケージの依存関係のみが含まれます

パッケージの依存関係とソースファイルを含める

False

No

bower.runPreStep  

Bower プロジェクトをインストールするかどうか。

Bower プロジェクトをインストールします

Bower プロジェクトをインストールしません 

False

No

C#

NuGet

NuGet統合の詳細については、こちらを参照して ください

トップに戻る

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

nuget.resolveDependencies

NuGet の packages.config ファイル と .csproj ファイルを解決するかどうか 。

NuGet の packages.config ファイル と .csproj ファイルを解決し ます。

NuGet の packages.config ファイル と .csproj ファイルは解決されません 。

True

No

nuget.resolvePackagesConfigFiles 

packages.config プロジェクトのルートでファイルを解決するかどうか 。 

注: このパラメーターの値がスキャンに影響を与えるには、パラメーター nuget.resolveDependencies を True に設定する必要があります 。

packages.config ファイルを解決し ます。

packages.config ファイルを解決しません 

True

No

nuget.resolveCsProjFiles 

*.csproj プロジェクトのルートでファイルを解決するかどうか 。

注: このパラメーターの値がスキャンに影響を与えるには、パラメーター nuget.resolveDependencies を True に設定する必要があります 。

*.csproj プロジェクトのルートにあるファイルを解決し ます。

*.csproj プロジェクトのルートにあるファイルは解決されません 。

True

No

nuget.restoreDependencies 

プロジェクトの依存関係をダウンロードするために、見つかった '.csproj' ファイルに対して dotnet 復元を実行するかどうか 。

 見つかった '.csproj' ファイルで dotnet 復元を実行し ます

見つかった '.csproj' ファイルで dotnet 復元を実行しません

False

No

nuget.preferredEnvironment 

優先する NuGet 復元 コマンドを定義し ます。使用可能な値は nuget と dotnet

注:  このパラメーターは、nuget.restoreDepencies パラメーターが True に設定されている場合にのみ使用 されます。

N/A

N/A

No default

No

nuget.packagesDirectory  

WhiteSource 一時ファイルが作成される(およびスキャンの終了時に削除される)ディレクトリへのパスを提供します。

注:復元 コマンド 中のパスサイズに関連するエラーを回避するために、短いディレクトリを指定してください 。

N/A

N/A

No default

No

nuget.ignoreSourceFiles 

パッケージの依存関係を含めるかどうか、依存関係のリゾルバを使用している場合  パッケージの依存関係+ソースファイルを。

パッケージの依存関係のみが含まれます

パッケージの依存関係とソースファイルが含まれています

True

No

nuget.runPreStep 

プロジェクトの依存関係をダウンロードするために、見つかった 'packages.config' ファイルに対して nuget restore を実行するかどうか 。

見つかった 'packages.config' ファイルに対して nuget restore を実行 して、すべての依存関係を一時フォルダーにダウンロードし、このフォルダーをスキャンして、依存関係を取得した後に削除します。

見つかった 'packages.config' ファイルに対して nuget 復元 を実行しません 。

False

No

nuget.resolveNuspecFiles 

*.nuspec プロジェクトのルートでファイルを解決するかどうかを示します 。

注: このパラメーターの値がスキャンに影響を与えるには、パラメーター nuget.resolveDependencies を True に設定する必要があります 。

*.nuspec プロジェクトのルートにあるファイルを解決し ます。

*.nuspec プロジェクトのルートにあるファイルは解決されません 。

True

No

nuget.resolveAssetsFiles 

新しい .NET 依存関係管理構造の obj/project.assets.json ファイルを解決します。

N/A

N/A

True

No

Paket

Paket

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

paket.resolveDependencies 

Paket 依存関係マネージャーを使用して.NET依存関係を解決するかどうか。

パケットプロジェクトは解決されました。

パケットプロジェクトは解決されません。

True

No

paket.ignoredGroups 

どの Paket スコープを無視するか。

値はコンマ/セミコロン/スペースで区切られます。正確な名前に加えて、 GLOB パターンがサポートされています。

N/A

N/A

No default (empty)

No

paket.ignoreSourceFiles 

Paket リゾルバーを使用する場合、packagesフォルダー外の .NET Paket ファイルを無視するかどうかを定義します。

.nupkg, .dll, .exe, .cs, .js などの拡張子を持つファイルをスキャンから無視します

上記のファイル拡張子を無視しません。

True

No

paket.runPreStep 

見つかった Paket フォルダで "paket install" を実行します。

"paket install" コマンドを実行します

コマンドを実行しません。

False

No

paket.exePath 

 "paket install" の実行に使用される paket.exe ファイルへのパス。

N/A

N/A

No default (empty)

No

Python 

Python統合の詳細については、こちらを参照して ください

Pip、Pipenv、Poetry 

次の点に注意してください。

  • プロジェクトディレクトリに少なくとも1つのPython拡張ファイルが含まれていることを確認してください(ルートディレクトリだけでなく、任意のディレクトリに配置できます)。

  • Unified Agentは、プロジェクトディレクトリ内で見つかったすべての「requirements.txt」ファイルに対してコマンド「pipdownload -rrequirements.txt」を実行します(ファイルはルートまたはネストされたディレクトリのいずれかに存在できます)。

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

python.resolveDependencies 

Python の依存関係を解決するかどうか。

"requirements.txt" または "pipfile" が必要です。

Python の依存関係を解決します

Python の依存関係を解決しません。

True

No

python.ignoreSourceFiles 

依存関係リゾルバーを使用する場合、ソースファイルではなく、パッケージの依存関係のみが含まれます。

スキャン中の *.py ファイルを無視します。

拡張子が ".py" のファイルは無視されません。

True

No

python.ignorePipInstallErrors 

'pip download -r requirements.txt' コマンドのエラーを無視するかどうか。

ダウンロードエラーを無視し、パッケージを1つずつダウンロードしようとします

そのようなエラーを考慮し、それに応じて対応します

False

No

python.installVirtualenv 

--user に pip 'virtualenv' をインストールするかどうか。

"python -m pip install --user virtualenv" を実行して仮想環境をインストールします

 コマンドを実行しません 

False

No

python.resolveHierarchyTree 

階層ツリーを解決するか、依存関係のフラットリストを解決するかにかかわらず、ファイルのような "requirements.txt" が必要です。

pipdeptree をインストールし、それを使用して依存関係階層ツリーを解決および検索します

フラットリストのみを解決します

True

No

python.requirementsFileIncludes 

pip パッケージマネージャーを使用する場合、"requirements.txt" ではなく、依存関係をスキャンするファイルを指定する依存関係ファイル名のスペース区切りのリスト。

N/A

4つのサポートされている値があります。

  • Pipfile

  • setup.py

  • pyproject.toml

  • *。txt

該当なし

No

python.resolveSetupPyFiles 

setup.py ファイルの Python 依存関係を解決するかどうか。解決する場合は、依存関係をインストールして解決するために setup.py スクリプトを実行します。

依存関係をインストールして解決するために setup.py を実行します

setup.py ファイルを無視します

False

No

python.runPipenvPreStep 

 pipenv install コマンドを実行するかどうか 。その場合、"pipfile" が必要です。

'pipenv install' コマンドを実行します。"pipenv install --dev"

コマンドを実行しません

False

No

python.pipenvDevDependencies 

"dev" 依存関係をインストールするかどうか、インストールする場合は "python.runPipenvPreStep=true" が必要です

コマンドに --dev を追加すると、次のようになります。

コマンドに--dev追加しません

False

No

python.IgnorePipenvInstallErrors 

'pipenv run pip download' コマンドのエラーを無視するかどうか。

ダウンロードエラーを無視し、パッケージを1つずつダウンロードしようとします

そのようなエラーを考慮し、それに応じて対応します

False

No

python.resolveGlobalPackages 

グローバルパッケージを解決するかどうか。その場合、スキャンディレクトリに site-packages または dist-packages と呼ばれるグローバルパッケージフォルダが必要です。

True に設定され  ていて、site-packages または dist-packages フォルダーがある場合、解像度はそれらのフォルダーの下のパッケージに基づきます。 

グローバルパッケージを解決しません

False

No

python.resolvePipEditablePackages

このパラメーターは、-e フラグが付いた行(パッケージ)を持つ requirements.txt ファイルを処理します。
さらに、パッケージ自体の開発依存関係を解決します 
注: 現在、pip でのみサポートされています。

最初のスキャンでの開発の依存関係を解決します。

最初のスキャンで開発者の依存関係を解決しません。

False

No

python.path

Python 実行可能パスを指します。

実行可能パスが環境変数にすでに設定されている場合は、実行可能ファイル名のみを定義できます(Linux "python2.7"など)。

注: このパラメーターは、"python" 実行可能ファイルを定義された値に置き換えます。

N/A

N/A

python

No

python.pipPath

さまざまなバージョンの pip を使用できます。pip3 に設定すると、 "pip" と "python -m pip" の代わりに、"pip3" と "python -m pip3" が実行されます。

N/A

N/A

pip

No

python.runPoetryPreStep

"poetry install" コマンドを実行するかどうか。

"poetry install" コマンドを実行します

"poetry install" コマンドを実行しません

False

No

python.includePoetryDevDependencies

Poetry プロジェクトの開発者の依存関係をスキャンするかどうか。

Poetry プロジェクトの開発者の依存関係をスキャンします

開発者の依存関係を無視します

False

No

python.localPackagePathsToInstall

必要に応じて、前段階でインストールされるローカルパッケージパスのスペース区切りのリスト。

該当なし

該当なし

空の

番号

python.indexUrl

公式のPypiリポジトリに加えて、ローカルのPypiリポジトリのURL。デフォルトのpypiとは異なるソースからダウンロードされた依存関係がある場合に使用します。

該当なし

該当なし

pypi.org

番号

python.includePipenvDevDependencies

開発者の依存関係を含めたり除外したりできます。

解決策に開発者の依存関係を含めます。

解決策で開発者の依存関係を除外します。

NS

番号

conda

トップに戻る

構成ファイルのパラメーター

説明と予想される動作

真であれば

Falseの場合

ディフォルト

コマンドラインパラメータは利用できますか?

構成ファイルのパラメーター

説明と予想される動作

真であれば

Falseの場合

ディフォルト

コマンドラインパラメータは利用できますか?

conda.resolveDependencies 

condaの依存関係を解決するかどうか。

environment.yml」が必要です。

condaの依存関係を解決します。

condaの依存関係は解決されません。

NS

番号

 

Go

Go統合の詳細については、こちらを参照して ください

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

go.resolveDependencies 

Go の依存関係を解決するかどうか。次のパッケージマネージャーのいずれかによって管理されます。

  • dep

  • godep

  • vndr

  • gogradle

  • govendor

  • gopm

  • glide

 

Go プロジェクトを解決します。

Go プロジェクトは解決されません。

True

No

go.collectDependenciesAtRuntime 

実行時に Go の依存関係を収集するかどうか(他の言語の 'runPreStep' パラメーターと同様)。

True に設定されている 場合、説明についてはここを参照してください 。

select 依存関係マネージャーに関連するコマンドを実行します。

コマンドを実行しません

False

No

go.dependencyManager 

Go プロジェクトをスキャンするときに使用する Go 依存関係マネージャーを決定します。有効な値は次のとおりです。

  • dep

  • godep

  • vndr

  • gogradle

  • govendor

  • gopm

  • glide

空のままにすると、Unified Agent は最初に、このリストの最初のパッケージマネージャーを使用して依存関係を解決しようとします。失敗した場合は続行し、成功するまで次の試行を行います。

N/A

N/A

No default (empty)

No

go.ignoreSourceFiles 

依存関係リゾルバーを使用する場合、ソースファイルではなく、パッケージの依存関係のみが含まれます。

スキャンからの .go. ファイルを無視します。

スキャンからの .go. ファイルを無視しません。

False

No

go.glide.ignoreTestPackages 

グライドリゾルバーを使用する場合、'glide.yaml' ファイルの 'testImport' セクションで定義されたテストパッケージを無視するかどうか。

スキャンからテストパッケージを無視します。

スキャンから言及されたテストパッケージを無視しません。

True

No

go.gogradle.enableTaskAlias 

gogradle のタスクエイリアシングを有効/無効にします。 

gogradle 依存関係マネージャーを使用する場合はTrueに設定し、gradle 引数( 'gradle.properties' 内)に 'gograld.alias = true' を含めます。 

gogradle のタスクエイリアシングを有効にします。

gogradle のタスクエイリアシングを無効にします。

False

No

SBT

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

sbt.resolveDependencies 

Scala 依存関係を解決するかどうか (SBT を使用)。

Scala 依存関係を解決し ます。

Scala の依存関係は解決されません。

True

No

sbt.ignoreSourceFiles 

依存関係リゾルバーを使用する場合、ソースファイル(ファイル拡張子 .scala および .sbt)ではなく、パッケージの依存関係のみが含まれます。

スキャンでそのようなソースファイルを無視します。

そのようなソースファイルをスキャンします。

True

No

sbt.aggregateModules 

すべてのモジュールに対して単一のプロジェクトを作成するかどうか。

すべての SBT モジュールのスキャンされた依存関係を WhiteSource アプリケーションの1つのプロジェクトに収集します。

プロジェクトは、モジュールごとに個別に作成されます。プロジェクトの名前はモジュールの名前と同じになります(この場合、projectName は無視されます)。

False

No

sbt.runPreStep 

見つかった SBT プロジェクトフォルダで "sbt compile" を実行するかどうか。

 "sbt compile" コマンドを実行します

コマンドを実行しません

False

No

sbt.includedScopes

SBT リゾルバーでスキャンする必要があるスコープについて説明します。ユーザーは追加のスコープを定義できます。

N/A

N/A

"compile" と "runtime"

No

R

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

r.resolveDependencies

DESCRIPTION ファイルで定義されたR依存関係を解決するかどうか。

R の依存関係を解決します。

R の依存関係を解決しません

True

No

r.runPreStep

Rscript コマンドを実行するかどうか 。

Rscript コマンドを実行します

Rscript コマンドを実行しません 

False

No

r.ignoreSourceFiles

依存関係リゾルバーを使用する場合、ソースファイルではなく、パッケージの依存関係のみが含まれます。

パッケージの依存関係のみが含まれます。

スキャンには、パッケージの依存関係とソースファイルが含まれます。

True

No

r.cranMirrorUrl

プレステップの実行中に Rパッケージをダウンロードするためのリポジトリ。

:r.runPreStep が True の場合に必要 です。

N/A

N/A

No default

No

r.packageManager

UA が使用する必要がある R パッケージマネージャーのタイプについて説明します。デフォルト値は packrat です。値を 'None' に設定すると、パッケージマネージャーを使用せずに R の依存関係がスキャンされます。たとえば、基本的な R コマンドのみが使用されます。 Rscript -e "installed.packages()".



N/A

N/A

'packrat'

No

PHP

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

php.resolveDependencies 

PHP の依存関係を解決するかどうか(Composer を使用)。

PHP の依存関係を解決します

PHP の依存関係を解決しません

True

No

php.runPreStep 

フォルダで 'composer install' を実行するかどうか。

プロジェクトフォルダで 'composer install' を実行します。

プロジェクトフォルダで 'composer install' を実行しません。

False

No

php.includeDevDependencies 

PHP プロジェクトの開発者の依存関係をスキャンするかどうか。

PHP プロジェクトの開発者の依存関係をスキャンします。

PHP プロジェクトの開発者の依存関係をスキャンしません。

False

No

Ruby

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

ruby.resolveDependencies 

Ruby 依存関係を解決するかどうか 。

Ruby 依存関係を解決し ます。

Ruby 依存関係を解決しません 。

True

No

ruby.ignoreSourceFiles 

依存関係リゾルバーを使用する場合、ソースファイル(ファイル拡張子 .rb)ではなく、パッケージの依存関係のみが含まれます。

そのようなパッケージの依存関係のみが含まれます。

そのようなソースファイルをスキャンしません。

True

No

ruby.installMissingGems 

不足している Ruby 依存関係の gem ファイルをインストールするかどうか。

欠落しているRuby依存関係のgemファイルをインストールします。

欠落しているRuby依存関係のgemファイルはインストールされません。

False

No

ruby.runBundleInstall 

Ruby プロジェクトフォルダーでバンドルインストールを実行するかどうか。

Runs bundle install on the Ruby project file folder.

Will not run bundle install.

False

No

ruby.overwriteGemFile 

ruby.runBundleInstall を有効にした場合にのみ関係します ) 

バンドルインストールの実行後に Gemfile.lock または gems.locked を上書きするかどうか。

Overwrites Gemfile.lock or gems.locked after running Bundle Install.

Will not overwrite Gemfile.lock or gems.locked after running Bundle Install.

False

No

HTML

For more information regarding HTML integration, refer here.

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

html.resolveDependencies 

HTML ファイルからJavaScriptの依存関係を解決するかどうか 。

HTML ファイルからJavaScriptの依存関係を解決し ます。

HTML ファイルからJavaScriptの依存関係を解決しません 。

True

No

Objective C, Swift

CocoaPods

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

cocoapods.resolveDependencies 

CocoaPods の依存関係を解決するかどうか(CocoaPods を使用)。

CocoaPods の依存関係を解決します 

CocoaPods の依存関係を解決しません 

True

No

cocoapods.runPreStep 

フォルダでpod installを実行するかどうか 。

フォルダでpod installを実行 します

インストールコマンドを実行しません

False

No

cocoapods.ignoreSourceFiles 

依存関係リゾルバーを使用する場合、ソースファイルではなく、パッケージの依存関係のみが含まれます。

パッケージの依存関係のみが含まれます

パッケージの依存関係とソースファイルのみが含まれます

True

No

Rust, Cargo

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

cargo.resolveDependencies 

cargo の依存関係を解決するかどうか。Cargo.toml はスキャンされたディレクトリに存在する必要があります。

cargo の依存関係を解決します。

cargo の依存関係は解決されません。

True

No

cargo.runPreStep  

Cargo.toml を検索し、見つかった場合は、プロジェクトのルートフォルダで "cargo build" を実行します。

プロジェクトのルートフォルダで "cargo build" を実行します。

プロジェクトのルートフォルダで "cargo build" を実行しません。

False

No

cargo.ignoreSourceFiles  

依存関係リゾルバーを使用する場合、パッケージの依存関係のみが含まれ、.rs ファイルは含まれません。

依存関係リゾルバーを使用する場合、.rs ファイルではなく、すべてのパッケージ依存関係のみをスキャンします。

UnifiedAgent は .rs ファイルのみをスキャンします

True

No

Elixir, Erlang

Hex

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

hex.resolveDependencies 

Elixir または Erlang の依存関係を解決するかどうか。

Elixir または Erlang の依存関係を解決します

Elixir またはErlangの依存関係を解決しません

True

No

hex.runPreStep 

mix deps.get コマンドを実行するかどうか 。

mix deps.get コマンドを実行します 

mix deps.get コマンドを実行しません 

False

No

hex.ignoreSourceFiles 

依存関係リゾルバーを使用する場合、ソースファイルではなく、パッケージの依存関係のみが含まれます。

パッケージの依存関係のみが含まれます

パッケージの依存関係とソースファイルのみが含まれます

True

No

hex.aggregateModules 

すべてのモジュールに対して単一のプロジェクトを作成するかどうか。

フラットリストとして表示される、すべてのモジュールに対して単一のプロジェクトを作成します

モジュールごとにプロジェクトが作成され、階層ツリーとして表示されます。

False

No

Haskell

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

haskell.resolveDependencies 

Cabal パッケージマネージャーを使用して Haskell の依存関係を解決するかどうか。 

HaskellCabal プロジェクトを解決します

HaskellCabal プロジェクトを解決しません

True

No

haskell.runPreStep 

見つかった各パッケージ/プロジェクトで 'cabal sandbox init' および 'cabal install' コマンドを実行します。 

cabal バージョン3.*の場合 UA は "cabal new-build" コマンドを使用してファイル plan.json を解決します

'cabal install' を実行します 

サンドボックスがない場合は、'cabal sandbox init' を実行します(cabal インストールの前) 

統合エージェントは、サンドボックスが各パッケージにすでに存在していると想定し、そうでない場合は失敗します。

False

No

haskell.ignoreSourceFiles 

依存関係リゾルバーを使用する場合、ソースファイルではなく、パッケージの依存関係のみが含まれます。

スキャンから .hs および .lhs ファイルを無視します。

スキャンから .hs および .lhs ファイルを無視しません。

True 

No

haskell.ignorePreStepErrors 

preStep コマンドからのエラーを無視し、依存関係の解決を試み続けます。

'failErrorLevel' フラグに従って動作します

プレステッププロセスのエラーを無視して、スキャンを続行します。

False

No

Ocaml

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

ocaml.resolveDependencies

依存関係を解決するかどうか。

Ocaml プロジェクトを解決します。

Ocaml プロジェクトは解決されません。

False

No

ocaml.runPrepStep

必要な依存関係をインストールするかどうか。

必要な依存関係をインストールします。

必要な依存関係をインストールしません。

False

No

ocaml.ignoreSourceFiles

依存関係リゾルバーを使用する場合、ソースファイルではなく、パッケージの依存関係のみが含まれます。

ソースファイルではなく、パッケージの依存関係が含まれます。

現在のプロジェクトの依存関係をインストールするために使用されるスイッチ名

True

No

ocaml.switchName

現在のプロジェクトの依存関係をインストールするために使用されるスイッチ名

N/A

N/A

デフォルトではアクティブ化されたスイッチを使用します

No

ocaml.ignoredScopes

無視する正確なスコープ名を定義します。使用可能な値は

  • with-test

  • with-doc

  • none

N/A

N/A

いいえ、デフォルトは "with-test with-doc" です

No

ocaml.aggregateModules

すべての opam パッケージ/モジュールを集約するかどうか。

すべての opam パッケージ/モジュールを集約します。

opam パッケージ/モジュールを集約しません。

False

No

Glob Patterns を含む/除外する

スキャンに含める/除外するファイル(ファイル拡張子、ファイル名、フォルダー名など)。これらのパラメーターは、コンマ、セミコロン、またはスペースで区切られた引数のリストを受け取ることができます。

1つの除外行と1つの包含行のみを使用してください。

  • includes=**/*.c **/*.cc **/*.cp **/*.cpp **/*.cxx **/*.c++ **/*.h **/*.hpp **/*.hxx

  • #includes=**/*.m **/*.mm **/*.js **/*.php

  • #includes=**/*.jar

  • #includes=**/*.gem **/*.rb

  • #includes=**/*.dll **/*.cs **/*.nupkg

  • #includes=**/*.tgz **/*.deb **/*.gzip **/*.rpm **/*.tar.bz2

  • #includes=**/*.zip **/*.tar.gz **/*.egg **/*.whl **/*.py

 

  • #  **/*.<extension> または **/<excluded_dir>/** を追加して、ファイル拡張子または特定のディレクトリを除外します

           excludes=**/*sources.jar **/*javadoc.jar

  • case.sensitive.glob=false

  • followSymbolicLinks=true

Archive Properties

Back to top.

Properties related to archive file extraction (.rar,.zip, .jar).

ドリルダウン階層は最大7つに制限されており、構成ファイルで変更できます。
デフォルトでは、ドリルダウン階層レベルはゼロであり、ドリルダウンはありません。

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

#archiveExtractionDepth 

アーカイブファイルから抽出するレベルの数(最大10)

N/A

N/A

0 (スキャンは発生しません)

No

#archiveIncludes=**/*.war **/*.ear 

スキャン中に含めるアーカイブファイルを指定するコンマ、スペース、または行区切りのリスト

N/A

N/A

デフォルト値は "" です

No

#archiveExcludes=**/*sources.jar 

スキャン中に除外するアーカイブファイルを指定するコンマ、スペース、または行区切りのリスト

N/A

N/A

デフォルト値は "" です

No

Scan Modes

スキャンモードオプション(Docker イメージ、Docker コンテナーなど)。

Docker イメージ

Docker イメージの詳細については、こちらを参照して ください

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

docker.scanImages

すべてまたは指定された画像に対してスキャンを実行します。 

ローカルリゾルバー(パッケージマネージャー)を使用した一般的なスキャンは、リゾルバーがインストールされ、ローカルで使用できる場合にのみ実行されます。

Docker イメージのスキャンの詳細については、ここ を参照してください 。

Docker イメージスキャンとパッケージマネージャースキャン(scanPackageManager)のみが実行されます。

画像スキャンは行われません。

False

-docker.scanImages

docker.includes 

スキャンに含める画像を指定するコンマ、スペース、または行区切りのリスト。

提供される値は、次のいずれかから取得する必要があります。

  • リポジトリ(画像名)

  • Tag

  • 画像ID

N/A

N/A

デフォルト値は

".*.*" です。

(すべての画像がスキャンされます)

No

docker.excludes 

スキャンで除外する画像を指定するコンマ、スペース、または行区切りのリスト。

提供される値は、次のいずれかから取得する必要があります。

  • リポジトリ(画像名)

  • Tag

  • 画像ID

N/A

N/A

デフォルト値は "" です

(画像は除外されません)

No

docker.pull.enable 

関連するすべてのレジストリからすべてから "pull" を実行するかどうか

関連するすべてのレジストリから 'pull' を実行します

何もプルしない

False

No

docker.pull.images 

指定されたフィルター(文字列)に一致するDocker イメージをプルします。

正規表現またはスペースで区切られた値のリストを含めることができます。

N/A

N/A

デフォルト値は "" です

(すべての画像がプルされます)




No

docker.pull.maxImages 

プルする画像の最大数を定義します。プルされたイメージのこの数に達すると、それ以上イメージはプルされません。

N/A

N/A

10

No

docker.pull.tags 

タグが指定されたフィルター(文字列)に一致する Docker イメージをプルします。

正規表現またはスペースで区切られた値のリストを含めることができます。

N/A

N/A

デフォルト値は "" です

(すべての画像がプルされます)

No

docker.pull.digest 

ダイジェストが指定されたフィルター(文字列)に一致する Docker イメージをプルします。

正規表現またはスペースで区切られた値のリストを含めることができます。

N/A

N/A

デフォルト値は "" です

(すべての画像がプルされます)






No

docker.delete.force 

WhiteSource が Docker を使用して 'force' フラグを介してイメージを削除できるようにします。これは、ユーザーが他の画像に関連する画像をプルした場合に必要になるため、この場合、通常の削除が機能しない可能性があります。 

注: このパラメーターは注意して使用してください。

WhiteSource は、 Docker を使用して 'force' フラグを介してイメージを削除します。

WhiteSource は、Docker を使用して 'force' フラグを介してイメージを削除しません。

False

No

docker.login.sudo 

Unified Agent が 'sudo docker login' を実行するかどうか。

Unified Agent は 'sudo docker login' を実行します。

Unified Agent は 'sudo docker login' を実行しません。

True

No

docker.projectNameFormat 

Docker プロジェクトの名前の形式を決定します。

  • 値が default に設定されている 場合、 WhiteSource で作成されるプロジェクト名は、Docker リポジトリ名、タグ、および ID で構成されます。形式は次のとおりです。

  • <Image Name> <Image Tag> <Image ID>

  • 値が repositoryNameAndTag に設定されている場合、   WhiteSource で作成されるプロジェクト名は、次の形式の Docker リポジトリ名とタグで構成されます。

  • <Image Name> <Image Tag>

  • 値が repositoryName に設定されている場合、 プロジェクト名は Docker リポジトリ名のみで構成され ます 

  • <Image Name>

N/A

N/A

"DEFAULT"

No

docker.aws.enable 

Amazon Elastic Container Registry(ECR)から Docker イメージをプルできるようにします。

注:  True に設定すると、 'docker.scanImages' および 'docker.pull.enable' パラメーター値も True に設定されます。

Amazon Elastic Container Registry(ECR)から Docker イメージをプルします。

Amazon Elastic Container Registry(ECR)から Docker イメージをプルしません。

False

No

docker.aws.registryIds 

アマゾンウェブサービスのレジストリ ID リスト(アマゾン ECR レジストリに対応するAWS 12桁のアカウント ID)。リストには次のものが含まれている必要があります。

  • 完全なレジストリ ID であり、GLOB パターンはありません。 

  • 少なくとも1つのレジストリ ID。値はスペースで区切られます。

注:  docker.aws.enable=true の場合は必須です。

N/A

N/A

No default

No

docker.azure.enable 

Azure Container レジストリから Docker イメージをプルできるようにします。 

:True に設定されている場合、'docker.scanImages' および 'docker.pull.enable' パラメーター値も True に設定する必要があります。

Azure Container レジストリから Docker イメージをプルします。 

Azure Container レジストリからDocker イメージをプルしません。 

False

No

docker.azure.userName 

Azure Container レジストリのユーザー名。 

注:  docker.azure.enable が True の場合に必要です。

N/A

N/A

No default

No

docker.azure.userPassword 

Azure Container レジストリのパスワード。

注:  docker.azure.enable=true の場合に必要です。ただし、Azure クライアント CLI を介して Azure アカウントに手動で既にログインしている場合は、必須ではありません。

N/A

N/A

No default

No

docker.azure.registryNames 

Azure Container レジストリ内の Docker レジストリ名、スペース区切り。

:docker.azure.enable=true 場合に必要です

N/A

N/A

No default

No

docker.azure.authenticationType

認証タイプとして “containerRegistry” または "userAccount" のどちらを使用するか。

"userAccount" ログイン方法の要件設定を使用するには、"docker.azure.userName" とを入力する必要があります

"containerRegistry" を使用すると、login メソッドは、パラメーターdocker.azure.registryAuthenticationParameters の構成ファイルで提供されているレジストリのユーザー名とパスワードを使用して各レジストリにログインします。

N/A

N/A

userAccount

No

docker.azure.registryAuthenticationParameters

レジストリ認証パラメータには、各レジストリのユーザー名とパスワードが<registryUsername>:<registryPassword> の形式で含まれている必要があります。docker.azure.registryNames param に複数のレジストリが含まれている場合は、ユーザー名とパスワードをスペースで区切って指定する必要があります。

<registry1UserName>:<registry1Password> <registry2UserName>:<registry2Password>

N/A

N/A

No default

No

docker.artifactory.enable 

Artifactory ProDocker レジストリから Docker イメージをプルできるようにします。 

注:  'docker.scanImages' および 'docker.pull.enable' パラメーター値も True に設定されていることを確認してください。

Artifactory Pro Docker レジストリから Docker イメージをプルします。 

Artifactory Pro Docker レジストリから Docker イメージをプルしません。

False

No

docker.artifactory.url 

http:// または https:// と contextpath を含むArtifactory URL(Artifactory のデフォルトの contextPath は “/artifactory" です)

注意:

  • docker.artifactory.enable=true の場合に必要です。

  • 読み取り専用ユーザーが docker.artifactory.dockerAccessMethod を介して作成される場合、これは  http/s://<public server name>:<HTTP/S port>/<public context path> 構成されている必要があります。

N/A

N/A

No default

No

docker.artifactory.pullUrl 

  • 'docker.artifactory.pullUrl' が空の場合は、 'docker.artifactory.url' の元の動作を使用します

  • 'docker.artifactory.pullUrl' が空でない場合は、それをdocker [login/pull] コマンドへの URL として使用し、 'docker.artifactory.url' を使用してアーティファクトの RESTAPI コマンドを実行します。

N/A

N/A

No default

No

docker.artifactory.userName 

Artifactory Pro Docker レジストリ内のリポジトリ名、スペース区切りのリスト。

注: docker.artifactory.enable=true の場合は必須です。

N/A

N/A

No default

No

docker.artifactory.userPassword 

Artifactory ProDocker レジストリのユーザー名

注:  docker.artifactory.enable=true の場合は必須です。

N/A

N/A

No default

No

docker.artifactory.repositoriesNames 

Artifactory ProDocker レジストリのパスワード。

注:  docker.artifactory.enable=true の場合は必須です。

N/A

N/A

No default

No

docker.artifactory.dockerAccessMethod 

ユーザーが読み取り専用アクセス権を持っている場合に必要です。

値は 、repopathsubdomainport です。

お客様がポートメソッド 'docker.artifactory.dockerAccessMethod=port' を使用する場合、'repository port' を ‘docker.artifactory.repositoriesNames' の各リポジトリに次の形式で追加する必要があります:<repositoryName>:<repositoryPort>

N/A

N/A

No default

No

docker.hub.enabled 

DockerHub レジストリから Docker イメージをプルできるようにします。 

注:  'docker.scanImages' および 'docker.pull.enable' パラメーター値も True に設定されていることを確認してください。

Docker Hub レジストリから Docker イメージをプルします。 

Docker Hub レジストリから Docker イメージをプルしません。

False

No

docker.hub.userName 

Docker Hub レジストリのユーザー名。

注: docker.hub.enable=true の場合は必須

N/A

N/A

No default

No

docker.hub.userPassword 

Azure Container レジストリのパスワードに必要なパスワード。

注:  docker.hub.enable=true の場合は必須

N/A

N/A

No default

No

docker.hub.organizationsNames 

スキャンするユーザーの下にある組織のスペース区切りのリスト。

注:  docker.hub.enable=true の場合は必須です。

N/A

N/A

No default

No

docker.scanTarFiles

ユーザーが Docker イメージの tar ファイルを提供するときに使用されます。

Unified Agent は、.tar ファイルを Docker イメージとしてスキャンします。

Unified Agentは、.tar ファイルを Docker イメージとしてスキャンしません。

False

No

Docker コンテナ

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

docker.scanContainers 

すべてまたは指定されたコンテナをスキャンします。True に設定すると、DockerContainerscan(scanContainers)と Package Manager スキャン(scanPackageManager)のみが発生します。

ローカルリゾルバー(パッケージマネージャー)を使用した一般的なスキャンは、リゾルバーがインストールされ、ローカルで使用できる場合にのみ発生します。

コンテナースキャンを開始する前に、コマンド "docker ps -a" を実行して、リストされているコンテナーを確認します。

DockerContainerscan(scanContainers)と Package Manager スキャン(scanPackageManager)のみが発生します。

すべてのコンテナをスキャンします

False

No

docker.containerIncludes 

スキャンに含めるコンテナーを指定するコンマ、スペース、または行区切りのリスト。

提供される値は、次のいずれかから取得する必要があります。

  • コンテナID

  • コンテナ名

  • 画像名

N/A

N/A

デフォルト値は "*" です(すべてのコンテナーがスキャンされます)

No

docker.containerExcludes 

スキャンで除外するコンテナーを指定するコンマ、スペース、または行で区切られたリスト。

提供される値は、次のいずれかから取得する必要があります。

  • コンテナID

  • コンテナ名

  • 画像名

N/A

N/A

デフォルト値は "" です(コンテナは除外されません)

No

Linux Package Manager 設定

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

scanPackageManager 

Linux パッケージをファイル名とバージョンでスキャンします。サポートされているパッケージタイプは、Debian, RPM, Alpine, Arch Linux, および DNFです。

パッケージの種類に応じて、次のいずれかのコマンドが実行されます。

  • Debian: dpkg -l

  • RPM: rpm -qa

  • Alpine: apk -vv info

  • Arch Linux: pacman -Q

  • DNF/ centOS:8 - コマンドなし、イメージには少なくとも journal.log ファイル(インストールログ)と rpm.dnf.log ファイル(システムパッケージの更新が実行された場合)が含まれている必要があります。

ここに記載されている Linux パッケージは解決されます。'resolveDependencies' パラメーターが True に設定されている場合でも、他のすべての依存関係リゾルバーは無効になります。

オペレーティングシステムパッケージはスキャンされません。

False

No

Serverless 設定

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

serverless.provider 

サーバーレス機能のプロバイダー

N/A

N/A

aws-lambda

No

serverless.scanFunctions 

サーバーレス機能を実行するかどうか

サーバーレス機能をスキャンします

サーバーレス機能をスキャンしません

False

No

serverless.includes 

実行するサーバーレス関数を指定する GLOB パターンのコンマ、スペース、または行区切りのリスト。

N/A

N/A

Empty string

No

serverless.excludes 

除外するサーバーレス関数を指定する GLOB パターンのコンマ、スペース、または行区切りのリスト。

N/A

N/A

Empty string

No

serverless.region 

プロバイダーの地域。

N/A

N/A

Empty string

No

serverless.maxFunctions 

実行できる関数の最大数。

N/A

N/A

10

No

Artifactory 設定

Artifactory統合の詳細については、こちらを参照して ください

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

artifactory.enableScan 

Artifactory リポジトリスキャナーを実行するかどうか

Artifactory リポジトリスキャナーを実行します(Unified Agent ではありません)。

Artifactory リポジトリスキャナーを実行しません

False

No

artifactory.url 

Artifactory ホストURL。

ノート

  • artifactory.enableScan が True の場合に必要 です。

N/A

N/A

No default

No

artifactory.accessToken 

Artifactory アクセストークン。

ノート: 

  • artifactory.enableScan がTrueの場合に必要 

  • とき artifactory.userName & artifactory.userPassword ご利用いただけます。3つのパラメーターすべてが使用可能な場合-ユーザー名/パスワードが優先されます)

N/A

N/A

No default

No

artifactory.repoKeys 

リポジトリ名のリストspace/comma-delimited。

注: artifactory.enableScan が True の場合に必要 です。

 



N/A

N/A

No default

No

artifactory.userName 

Artifactory ユーザー名

注: artifactory.accessToken が利用可能でない限り、artifactory.enableScan が True のとき必須です。

N/A

N/A

No default

No

artifactory.userPassword

Artifactory ユーザーパスワード

注:  artifactory.accessToken が利用可能でない限り、artifactory.enableScan が True のとき必須です。

N/A

N/A

No default

No

Proxy 設定 

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

proxy.host 

プロキシホスト名

N/A

N/A

デフォルト値は ""

-proxy.host

proxy.port 

プロキシポート番号

N/A

N/A

デフォルト値は ""

-proxy.port

proxy.user 

プロキシユーザー名

N/A

N/A

デフォルト値は ""

-proxy.user

proxy.pass 

プロキシパスワード

N/A

N/A

デフォルト値は ""

-proxy.pass

SCM 設定

SCM(Git, SVN, Mercurial)を使用しているお客様の場合、関連する設定(タイプ、ユーザー、パスワード)を定義します。

Back to top.

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

構成ファイルのパラメーター

説明や期待される動作

Trueのとき

Falseのとき

デフォルト

コマンドラインパラメーターの利用

scm.type

すべての scm タイプ(Git, SVN, mercurial(1つを選択)のコンマ区切りのリスト。

注: リモートリポジトリ接続が要求された場合に必要です。

N/A

N/A

デフォルト値は ""

No

scm.user 

リモートリポジトリに接続するためのユーザー名。

注: リポジトリがプライベートであり、資格情報が必要な場合は必須です。 

N/A

N/A

デフォルト値は ""

No

scm.pass 

リモートリポジトリに接続するためのパスワード。

注:

  • SSH を使用して Git リポジトリをフェッチする場合は、この値を秘密鍵のパスフレーズに設定します(scm.ppk で指定)。パスフレーズがない場合は、このパラメーターを空のままにします。

  • リポジトリがプライベートであり、資格情報が必要な場合に必要です。

N/A

N/A

デフォルト値は ""

No

scm.ppk 

秘密鍵へのパス。

注: リポジトリにSSH接続が必要な場合は必須です。

N/A

N/A

デフォルト値は ""

No

scm.url 

リモートリポジトリの URL。例: https://github.com/XXXX/XXXX.git

オンプレミスリポジトリの場合は、オンプレミスインスタンスの URL を指定します。

注: リモートリポジトリ接続が要求された場合に必要です。

N/A

N/A

デフォルト値は ""

No

scm.branch 

スキャンするブランチの名前。

N/A

N/A

デフォルト値は ""

No

scm.tag 

スキャンするタグの名前。

N/A

N/A

デフォルト値は ""

No

scm.npmInstall 

package.json が見つかったときに 'npm install' を実行するかどうか

package.json が見つかったときに 'npm install' を実行します 

package.json が見つかった場合、 'npm install' を実行しません

True

No

scm.npmInstallTimeoutMinutes 

npm インストールタイムアウト(分単位)

N/A

N/A

15分

No

scm.repositoriesFile 

リモートリポジトリのリストを含む JSON ファイルのURL。

N/A

N/A

デフォルト値は ""

-scm.repositoriesFile

環境変数による Unified Agent の設定

Unified Agent 設定ファイルで使用可能なすべてのパラメータは、環境変数を使用して設定することもできます。

環境変数の命名規則:

  • 設定ファイル <a link to the config file/parameters table> で定義されているパラメーター名は大文字に変換され、各ドット (.) はアンダースコア (_)に置き換えられます。

  • WS_ prefix が上記の定義に追加されます

たとえば、  maven.runPreStep パラメーターは、WS_MAVEN_RUNPRESTEP 環境変数を使用して設定でき ます。

環境変数は、いくつかの方法で使用できます。

  • コマンドラインで Unified Agent に渡されます。次に例を示します。
    WS_PROJECTNAME=my-awesome-project java -jar ../wss-unified-agent.jar

  • 実行前に設定し、現在のシェルセッションでのみ使用可能:
    LinuxおよびMacOS:
    export WS_PROJECTNAME=my-awesome-project
    java -jar ../wss-unified-agent.jar
    Windows:
    set WS_PROJECTNAME=my-awesome-project
    java -jar ../wss-unified-agent.jar

  • 実行前に、シェルセッション間で永続化するように設定します。

    • シェル起動スクリプトを使用する Linux および macOS の場合

    • setxコマンドを使用するWindowsの場合 

コマンドライン

どちらかprojectName またはprojectToken 必要なフィールドです。

環境変数による Unified Agent の設定

パラメーター

注:この表は、コマンドラインパラメーターの完全なリストではありません。対応する(標準の)設定ファイルパラメーターを持つコマンドラインパラメーター については、上記の表の右側にある「コマンドラインパラメーターの使用可能」列を参照してください 。 

Parameter

Type

Description

Required

Default

Parameter

Type

Description

Required

Default

-c

String

構成ファイル名(ファイルパスを含む)。

No

デフォルトのファイル名は 'wss-unified-agent.config' です。

  • バージョン19.1.1以降、デフォルトのファイルは 'wss-unified-agent.config' です。 
    このファイルが見つからない場合、Unified Agent は 'whitesource-fs-agent.config' ファイルを検索します。

  • -detect フラグを使用する場合は、生成されたコンフィギュレーションファイルがある wss-generated-file.config 、それが明示的に記述する必要があります。 
    -c wss-generated-file.config

-d

String

スキャンするディレクトリやファイルのコンマ区切りのリスト

No

N/A

-f

String

ファイルリストパス

No

N/A

-v

String

Unified Agent にバージョンを問い合わせる

No

N/A

-archiveFastUnpack 

Boolean

アーカイブファイルの高速解凍

No

False

-requestFiles

String

オフライン要求ファイルへのパスのコンマ区切りリスト。 

パラメータ使用の優先度に関して、Unified Agent は CLI 引数を検索し、次に設定ファイルパラメータ(CLI に見つからない場合)、オフラインリクエストパラメータ(設定ファイルにない場合)を検索します。

複数のリクエストファイルが提供されている場合は、最初のオフラインリクエストのデータが使用されます。'projectName', 'projectToken' および 'projectVersion'は各リクエストファイルからフェッチされることに注意してください。

'-requestFiles' も使用されているときに '-d' が明示的に指定されている場合、Unified Agent はローカルフォルダ( '-d' が指す)をスキャンしません。代わりに、提供されたオフライン要求ファイルのみをスキャンします。このシナリオでは、'-d' は無視されます。

No

単一の要求ファイルが提供され、 CLI, Config および Offline 要求ファイルで 'productName' または 'productToken' のどちらの値も設定されていない場合、デフォルトの製品名は 'My Product' です。

-whiteSourceFolderPath 

String

'whiteSource'ディレクトリへのパス。WhiteSource フォルダーは、ポリシーを確認してオフラインファイルを作成するときに作成されます。パスは絶対パスでも相対パスでもかまいません。

No

'whitesource' フォルダのデフォルトの場所は、 Unified Agent が実行される作業ディレクトリです。

-requirementsFileIncludes 

(Pythonのみ)

String

依存関係をスキャンするファイルを指定する依存関係ファイル名のコンマ区切りリスト。

No

Requirements.txt

-noConfig

Boolean

Trueに設定すると、構成ファイルを使用せずにスキャンを実行できます。ただし、この場合、パラメーター-projectToken または-project 
および-apiKey は必須です。

明示的に指定されていない限り、デフォルトの wss.url パラメーター値はhttps://saas.whitesourcesoftware.com/agentです 

No

False

-detect



このパラメータが追加されると、Unified Agent はスキャンされたファイルを分析し、関連する設定パラメータを使用して新しい .config ファイルを作成します。新しい構成ファイルにはresolveDependencies 、検出されたパッケージマネージャーに応じたパラメーターが含ま れます。マニフェストファイルごとに、関連するパラメータをTrueに設定します。

使用法:  java -jar unified-agent.jar -detect 

たとえばbower.json 、プロジェクトフォルダーにファイルが見つかった 場合 bower.resolveDependencies 、新しく作成された構成ファイルではTrueに設定されます。

No

デフォルトでは、検出は Unified Agent jar が配置されている現在のディレクトリに基づいています。これを変更するには、-d パラメーターを追加し ます。

使用例:  java -jar unified-agent.jar -detect -d projectFolder

-help or -h

Boolean

Unified Agent は、CLI から使用できるパラメータを出力します。 

No



-logLevel

String

stdout に出力される最小ログレベルを指定します。

No

info

-proxy

String

次の形式のプロキシ情報:
scheme://<user>:<password>@host:port/

No



 

 

 

 

Back to top.