Configuring the Management and Orchestration SQL Server for Dynamic and Static Port Connectivity (v8.9.0 and up)

Owned by David P (Deactivated)
Last updated: Jan 11, 2021 by Johannes Stark (Unlicensed)
3 min read

This instruction defines the procedure for configuring the Management & Orchestration SQL server for both static and dynamic port connectivity for CxSAST V8.9 RC6 and above.

Contents

Static Port Configuration

Prerequisites

The following perquisites apply:

  • For Windows authentication machine must be in a domain
  • SQL Server service is up and running
  • TCP/IP is enabled

Static Port Connection

The Management & Orchestration SQL server installation defines the port connection according to one of the following port connection arrangements:

  • Instanced SQL: <host>\<instance>,<port>
    • Examples:

localhost\sqlexpress,1435

10.0.0.10\sqlexpress,1435

.\sqlexpress,1435

10.0.0.10,1435

  • Non Instanced SQL: <host>,<port>
    • Examples:

localhost,1435

10.0.0.10,1435

.,1435

10.0.0.10,1435

Configure Static Port

To configure static port connectivity for the Management & Orchestration SQL Server:

  1. Go to the Computer Management (Start > Control Panel > System and Security > Administrative Tools > Computer Management).

  2. Select Services and Applications > SQL Server Configuration Manager > SQL Server Network Configuration > Protocols for <SQLSERVER>.

  3. Right click on TCP/IP, select Properties and click the IP Address tab.

  4. Select TCP Port under IPALL and define the port as defined in the Management & Orchestration SQL server installation (see Port Connection Arrangement).
  5. Click Apply and then OK to complete.
  6. Restart the SQL Browser service and then the SQL Server service.

If there are two instances of the SQL Server service, restart that the corresponding instance of SQL Browser service.

Dynamic Port Configuration

Prerequisites

The following perquisites apply:

  • For Windows authentication the machine must be in a domain
  • SQL Server and SQL Browser services are up and running.
If the SQL Brower service is already running, restart the SQL Server service again. If there are two instances of the SQL Server service, verify that the corresponding instance of the SQL Browser service is running.
  • TCP/IP is enabled

Dynamic Port Connection

The Management & Orchestration SQL server installation defines the port connection according to one of the following port connection arrangements:

  • Instanced SQL: <host>\<instance>
    • Examples:

localhost\sqlexpress

10.0.0.10\sqlexpress

.\sqlexpress

hostname\ sqlexpress

  • Non-instanced SQL: <host>,<port>
    • Examples:

localhost

10.0.0.10

.

hostname

For connection arrangements with unnamed instance and without port, <.>, <ip> or <host_name>, the default static port must be set (see Static Port Connection).

Configuring the Dynamic Port

To configure dynamic port connectivity for the Management & Orchestration SQL Server:

  1. Go to the Computer Management (Start > Control Panel > System and Security > Administrative Tools > Computer Management).

  2. Select Services and Applications > SQL Server Configuration Manager > SQL Server Network Configuration > Protocols for <SQLSERVER>.

  3. Right click on TCP/IP, select Properties and click the IP Address tab.

  4. Select TCP Dynamic Ports under IPALL and define the port as defined in the Management & Orchestration SQL server installation (see Port Connection Arrangement).
  5. Click Apply and then OK to complete.
  6. Restart the SQL Browser service and then the SQL Server service.
If there are two instances of the SQL Server service, restart that the corresponding instance of SQL Browser service.

Port Connection Test

The following command can be run to test the port connection:

jre\bin\java -cp "etl.jar;Libraries\mssql-jdbc-6.4.0.jre8.jar" -Djava.library.path="Libraries" com.checkmarx.sync.utl.mainflow.TestConnection 10.31.2.36 null null CxARM SQLEXPRESS
  • The command should be run from the folder where the etl.jar is located
  • You can provide “user” and “password” instead of “null” “null”.
  • 10.31.2.36 is the IP of the machine where the database is installed
  • SQLEXPRESS is the instance name (“null” can be supplied in unnamed instance)

M&O Connectivity Mitigation

  • Use Case: Machine not in domain + SQL windows authentication
    Mitigation: Use user + password authentication
  • Use Case: Dynamic port + SQL Browser service is turned off + SQL Server with named instance
    Mitigation: Configure static port, or turn SQL Browser on
  • Use Case: TCP/IP disabled
    Limitation: No solution, TCP/IP is a must