Parameters for Installing CxSAST in Silent Mode

/?

Opens the help dialog.

/install /uninstall /quiet

Installs or uninstalls CxSAST silently (Install is the default). Displays no GUI and no prompts. By default, GUI and all prompts are displayed.

ACCEPT_EULA=

Y: Accept

N: Don't accept (default)

Sets the EULA (End User License Agreement) variable. It must be set to Y to run the installation.

CX_JAVA_HOME=

Path to the JRE folder

For example C:\openjdk-8u242-b08-jre, C:\Program Files\Java\jre1.8.0_241 or C:\Program Files\Java\jdk1.8.0_241\jre. Refer to Java in the Prerequisites section of the installation guide for additional information and instructions on making the required Java version available.

INSTALLFOLDER=

Folder where the installation files reside

Default: C:\Program Files\Checkmarx

For example INSTALLFOLDER=”D:\TEMP DIR”, INSTALLFOLDER=D:\TEMP.

MANAGER=

1: Install (default)

0: Remove/do not install

Sets the Manager component variable:

WEB=

1: Install (default)

0: Remove/do not install

Sets the Web component variable.

ENGINE=

1: Install (default)

0: Remove/do not install

Sets the Engine component variable

AUDIT=

1: Install (default)

0: Remove/do not install

Sets Audit component variable.

LOGON_SERVICE_ACCOUNT=

<username>

Sets the Windows service account for the Checkmarx services (for example, LOGON_SERVICE_ACCOUNT=DOMAIN\username).

LOGON_SERVICE_PASSWORD=

<password>

Sets the Windows service account password used by the Checkmarx service account (for example, LOGON_SERVICE_PASSWORD=12345).

BI=

1: Install (default)

0: Remove\do not install

Sets the BI component (CxARM) variable.

This parameter has been deprecated in v9.6.0. Since v9.6.0 does not have the M&O (CxARM) inside the installer, it can only be updated from a previous version.

ACCESSCONTROL=

1: Install (default)

0: Remove\do not install

Sets the Access Control component variable.

VALIDATED_ACCESSCONTROL_MIGRATION=

Y: Yes

N: No

Sets the Access Control Migration manual validation.

ACTIVEMQ=

1: Install (default)

0: Remove\do not not install

Sets Active MQ component variable.

INSTALLSHORTCUTS=

1: Install shortcuts (default)

0: Do not install shortcuts

Sets application shortcuts variable.

SQLAUTH=

1: SQL authentication

0: Windows authentication (default)

Sets the SQL authentication mode for CxSAST:

SQLSERVER=

server location

Sets the SQL server address and instance for CxSAST (e.g., SQLSERVER= localhost\SQLEXPRESS)

SQLUSER=

user name

Sets the SQL user credential for CxSAST (e.g., SQLUSER=sa)

SQLPWD=

password

Sets the SQL password credential for CxSAST (e.g., SQLPWD=12345)

CXSAST_ADDRESS=

http://localhost:80 (default)

Sets the CxSAST URL address. It also validates that the defined URL address is reachable.

MQHTTPPORT=

61616 (default)

Sets the MQ Admin console port definition.

MQMANAGERHTTPPORT=

8161 (default)

Sets the MQ operational port definition.

RIHTTPPORT=

8082 (default)

Sets the Remediation Intelligence port definition.

TOMCATHTTPPORT=

8080 (default)

Sets the Apache Tomcat HTTP port definition.

TOMCATHTTPSPORT=

8443 (default)

Sets the Apache Tomcat HTTPS port definition.

CXARM_SQLAUTH=

0: Windows authentication (default)

1: SQL authentication

Sets the SQL authentication mode for CxARM.

CXARM_DB_HOST=

location

Sets the SQL server address and instance for CxARM (e.g., CXARM_DB_HOST=localhost\SQLEXPRESS)

CXARM_DB_USER=

user name

Sets the SQL user credential for CxARM (e.g., CXARM_DB_USER=sa)

CXARM_DB_PASSWORD=

password

Sets the SQL password credential for CxARM (e.g., CXARM_DB_PASSWORD=12345)

LIC=

The path to the license file

Sets the license path (e.g., LIC="C:\Users\Administrator\Documents\ license_file_ID_string _license.cxl").

PORT=

8081 (default for Access Control)

80 (default for CxSAST)

Sets the port definition.

ENGINE_TLS_ENABLE=

true: TLS enabled

false: TLS disabled (default)

Enables/disables the encryption protocol TLS. If set to true, TLS is enabled, and additional manual configuration is required.

Set ENGINE_TLS_ENABLE=true and manually configure TLS once the installation is complete.

ENGINE_SERVICE_END_POINT=

http://<fqdn>:8088 (default)

URL of the CxEngine host. This URL contains the following components: http://<engine name>.<location.domain>:<port number>and could be for example something like http://engine1.checkmarx.com:8088

ENGINE_HTTP_PORT=

8088 (default)

Sets the port used by CxEngine.

ENGINE_SETTINGS_FILE=

The path to the engine settings file (JSON)

Sets the path to the JSON file.

ENGINE_FIREWALL_RULE=

1: Enabled (firewall rules apply)

0: Disabled

Defines whether firewall rules apply.

ENGINE_CERTIFICATE_SUBJECT_NAME=

CN=CxEngine (default)

Defines the name of the certificate for the TLS engine.

ENGINE_MESSAGE_QUEUE_DISABLE=

None (default)

Defines the engine message queue.

ENGINE_MESSAGE_QUEUE_TTL=

60 (default)

Sets the TTL of the message queue.

ENGINE_EA_ENABLED_QUEUES=

ResultQueue;IncrementalFilesQueue (default)

Defines the Engine EA-enabled queues.

ENGINE_EA_PUBLISHING_METHOD=

MessageQueue (default)

Defines the method of publishing scan results.

RECONFIGURE_ENGINE=

1: Reconfigure CxEngine

Reconfigures CxEngine. For additional customized ENGINE parameters, refer to Reconfiguring Access Control and CxEngine.

RECONFIGURE_ACCESS_CONTROL=

1: Reconfigure Access Control

Reconfigures Access Control related environment variables. For additional information on reconfiguring Access Control, refer to Reconfiguring Access Control and CxEngine.