Changing the Server Name, IP or Port for Checkmarx Components (v9.0.0 to v9.2.0)

Owned by Johannes Stark (Unlicensed)
Last updated: Jan 31, 2021
2 min read

Additional components have been introduced to CxSAST (since v9.0) that include Access Control, Management & Orchestration, and ActiveMQ. The definition values for these components are saved in the database (CxDB) as {Protocol}://{FQDN}:{Port}. Fully Qualified Domain Name (FQDN) is the complete domain name for the host and consists of the hostname and the domain name (e.g. http://mqserver.company.com:5555). If you want to rename the server, change the IP or change the port, you will need to change the key value definitions in the relevant database tables.

Changing the Server Name, IP Address or Port

Changing the server name, IP or port for Checkmarx Components can be performed via the relevant database table and then through the Web Portal. These steps can be performed manually for each server:

 1. Insert the new server definitions into the Domain Name System (DNS).

 2. Open MS SQL Server Management Studio and connect to the SQL server.

 3. Go to  Databases > CxDB > Tables > dbo.CxComponentConfiguration ...

 ,,,To update the following database key values
  • ActiveMessageQueueURL- {Protocol}://{Server Name, IP}:{Port}
  • CxARMPolicyURL - {Protocol}://{Server Name, IP}:{Port}
  • CxARMURL - {Protocol}://{Server Name, IP}:{Port}
  • IdentityAuthority - {Protocol}://{Server Name, IP}:{Port}/CxRestAPI/auth
  • EX_SOURCE_PATH - {dir}:\{CxSrc folder}
  • SOURCE_PATH - {dir}:\{CxSRC folder}
  • WebServer - {Protocol}://{Server Name, IP}:{Port}

 4. Go to Databases > CxDB > Tables > CxARM > dbo.DBSources and also update the DB_HOST database key value.

 5. For each server, update the following

 The server name, the IP address or the port in the relevant configuration file
  • For CxManagers/Web Portals:
    • Go to C:\Program Files\Checkmarx\CheckmarxWebPortal\Web, open the web.config file for editing and using the Search tool, search for ‘CxWSResolver.CxWSResolver’ and update accordingly.
    • Go to C:\Program Files\Checkmarx\Configuration, open the DBConnectionData.config file for editing and using the Search tool, search for ‘Data Source’ and update accordingly.
  • For Management and Orchestration (if installed):
    • Go to C:\Program Files\Checkmarx\Checkmarx Risk Management\Config, open the db.properties file for editing and using the Search tool, search for ‘DB_HOST’ and update accordingly.
  • For CxEngines:
    • Go to C:\Program Files\Checkmarx\Checkmarx Engine Server, open the CxSourceAnalyzerEngine.WinService.exe.config file for editing and using the Search tool, search for ‘baseAddress’ and update accordingly.

 6. To update the Java version or the Java path, apply the correct Java settings as follows:

 7. Right-click  This PC and select Properties to display the System information and settings.

 8. Go to Advanced System Settings to open the System Properties dialog box.

 9. If not already open, open the Advanced tab.

 10. On the Advanced tab, click Environment Variables... to open the Environment Variables dialog box.

 11. Navigate to CX_JAVA_HOME to point to where the JRE folder is located, for example C:\Program Files\Java\jdk1.8.0_241\jre.

 12. Update the Load Balancer configuration file (e.g. Nginx.conf) accordingly.

 13. Update Access Control...

 By configuring the appsettings.json file (<dir>:\Program Files\Checkmarx\Checkmarx Access Control\appsettings.json)

Update ExternalListenUrls to reflect IIS configured bindings:

http(s)://*(port)
e.g. "ExternalListenUrls": "https://*:433"

If more than one binding is configured, use the following syntax:

http(s)://*(port);http(s)://*(port)
e.g. "ExternalListenUrls": "https://*:433;https://*:123"

 14. Restart all Cx Windows Services and the IIS.

 15. Log in to the Web Portal and manually update the CxEngine Server name, IP or port according to these instructions.

 16. If required, update the IP Address in the TCP/IP Properties in the SQL Server Configuration Manager as illustrated in this example.