Unified Agent Configuration for Native Integrations

This page is relevant only for customers using Azure DevOps Services integration or Repo integrations.

Overview

This page describes the Unified Agent configuration parameters used when running a scan via either the Azure DevOps Services integration or Repo integrations.

Ignored Configuration File Parameters

This section contains a list of all Unified Agent configuration sections (including their parameters) that are ignored when running a scan via the Azure DevOps Services integration or Repo integrations.

Organization Vitals
Policies
General
- except for commandTimeout which can be set
Scan Modes
SCM Settings

Configuration File Parameters

Unless explicitly specified in this section, the default value for each Unified Agent configuration parameter is taken from the Unified Agent Configuration Parameters page.

Package Manager Dependency Resolvers

Except for the below parameters, configuration parameters and their default value used in this integration can be found here.

Java

Maven

maven.aggregateModules=true
maven.ignoreSourceFiles=true
maven.ignoreMvnTreeErrors=true
maven.ignoredScopes=<empty> (by default, no scopes are ignored)

Gradle

gradle.aggregateModules=true
gradle.ignoreSourceFiles=true

JavaScript

NPM + Yarn

npm.runPreStep=true
npm.ignoreNpmLsErrors=true
npm.includeDevDependencies=true
npm.identifyByNameAndVersion=true

Bower

bower.runPreStep=true
bower.ignoreSourceFiles=true

C#

NuGet

nuget.runPreStep=true

Paket

paket.runPreStep=true

Python

python.ignorePipInstallErrors=true
python.installVirtualenv=true
python.resolveSetupFiles=true
python.runPipenvPreStep=true
python.IgnorePipenvInstallErrors=true
python.runPoetryPreStep=true

Go

go.collectDependenciesAtRuntime=true
go.ignoreSourceFiles=true

Scala

sbt.runPreStep=true

R

r.runPreStep=true
r.cranMirrorUrl=https://cloud.r-project.org/

PHP

php.runPreStep=true

Ruby

ruby.installMissingGems=true
ruby.runBundleInstall=true

Objective C, Swift

CocoaPods

cocoapods.runPreStep=true

Elixir, Erlang

Hex

hex.runPreStep=true

Haskell

haskell.runPreStep=true
haskell.ignorePreStepErrors=true

Note: The aggregateModules option is always set to true for the repository integrations, as they only map to one project, and the repo integration cannot create multiple projects per scan.

When a scan is completed for each branch defined in your baseBranches parameter, a Mend project is created for that branch with the integration name prefix. For example, a completed scan with Mend for GitHub.com will be created as “GH_” prefix.

Includes/Excludes Glob Patterns

Except for the below parameters, configuration parameters and their default value used in this integration can be found here.

includes=**/*c **/*cc **/*cp **/*cpp **/*cxx **/*c++ **/*h **/*hh **/*hpp **/*hxx **/*h++ **/*m **/*mm **/*pch **/*c# **/*cs **/*csharp **/*go **/*goc **/*js **/*pl **/*plx **/*pm **/*ph **/*cgi **/*fcgi **/*pod **/*psgi **/*al **/*perl **/*t **/*pl6 **/*p6m **/*p6l **/*pm6 **/*nqp **/*6pl **/*6pm **/*p6 **/*php **/*py **/*rb **/*swift **/*java **/*clj **/*cljx **/*cljs **/*cljc **/*jar **/*egg **/*dll **/*tar.gz **/*tgz **/*zip **/*whl **/*gem **/*apk **/*air **/*dmg **/*exe **/*gem **/*gzip **/*msi **/*nupkg **/*swc **/*swf **/tar.bz2 **/pkg.tar.xz **/(u)?deb **/(a)?rpm
excludes=*/., **/node_modules, **/src/test, **/testdata, **/*sources.jar, **/*javadoc.jar

Archive Properties

Except for the below parameters, configuration parameters and their default value used in this integration can be found here.

archiveExtractionDepth=0
archiveIncludes=**/*war **/*ear **/*zip **/*whl **/*tar.gz **/*tgz **/*tar **/*car
archiveExcludes=**/*sources.jar **/*javadoc.jar /tests/

Environment Variables

The Unified Agent can be configured in the Scanner of the repository integrations using the convention explained here.