Modify the JDBC URL Connection Parameters in Omnissa Access

You can modify the JDBC connection URL parameters in Omnissa Access to update the database server hostname, port number, or database name. This is typically required when migrating to a new database server, changing database ports for security compliance, or updating database configurations.

Prerequisites

• Root access to the Omnissa Access appliance.
• The new database connection parameters, such as hostname, port, and database name.
• Database server accessibility from the Omnissa Access appliance on the new port

Understanding the JDBC URL Structure

The JDBC URL string in Omnissa Access follows the format specific to your database type:

Microsoft SQL Server

jdbc:sqlserver://hostname:port;databaseName=database_name

PostgreSQL

jdbc:postgresql://hostname:port/database_name

Connection Parameter Locations

• hostname: The FQDN or IP address of your database server
• port: The TCP port number
  • Default is 1433 for SQL Server.
  • Default is 5432 for PostgreSQL.
• database_name: The name of the Omnissa Access database

Example JDBC URLs

• SQL Server with custom port: jdbc:sqlserver://dbserver.example.com:14330;databaseName=saasdb
• PostgreSQL with default port: jdbc:postgresql://dbserver.example.com:5432/saasdb

Procedure

1. Using an SSH client, log in to the Omnissa Access appliance as the root user.

2. (Optional) Verify database connectivity before making changes:

   /usr/local/horizon/bin/dbConnCheck '<jdbc_url>' '<db_username>' '<encrypted_password>'
   

   Where:

   • <jdbc_url> is your current JDBC connection string from the runtime-config.properties file.
   • <db_username> is your database username (typically horizon).
   • <encrypted_password> is the encrypted password from the secure.datastore.jdbc.password parameter.
     
     A successful connection displays: SUCCESS: Connection verified.

3. Open the runtime configuration file for editing.
   For example:

   vi /usr/local/horizon/conf/runtime-config.properties
   

4. Locate the JDBC URL parameter.
   The parameter name varies by database type:
   

   • For the main datastore: datastore.jdbc.url=
   • For the SAAS datastore: saas.datastore.jdbc.url=

5. Modify the JDBC URL string to update the connection parameters:

   • To change the port number:
     • Locate the port number after the hostname (Example :1433).
     • Replace with your new port number (Example :14330).
       
       
   • To change the hostname:
     • Replace the hostname portion with the new server FQDN or IP address.
       
       
   • To change the database name, update the appropriate database name, as such:
     • SQL Server: the databaseName= parameter
     • PostgreSQL: the database name after the final /
       
       Example of Change:
       
       From:

   datastore.jdbc.url=jdbc:sqlserver://oldserver.example.com:1433;databaseName=saasdb
   

   To:

   datastore.jdbc.url=jdbc:sqlserver://newserver.example.com:14330;databaseName=saasdb
   

6. Verify that the complete JDBC URL is correct, including the following details:

   • Protocol prefix (jdbc:sqlserver:// or jdbc:postgresql://)
   • Correct hostname or IP address
   • Correct port number
   • Correct database name
   • Proper syntax for your database type

7. If you're also changing the database password, update the password parameter in the same file:

   secure.datastore.jdbc.password=encrypted_password
   

   Note: See Manually Update External Database Password and Update the JDBC Password Property in Omnissa Access for password encryption instructions.

8. Save the runtime-config.properties file.

9. Before restarting, verify network connectivity to the new database server and port:

   telnet new_hostname new_port_number
   

   Or:
   

   nc -zv new_hostname new_port_number
   

10. Restart the Omnissa Access service to apply changes:

service horizon-workspace restart

11. Verify the service starts successfully by checking the service status:

    service horizon-workspace status
    

12. Monitor the log files for any connection errors:

    tail -f /opt/vmware/horizon/workspace/logs/horizon.log
    

13. For clustered deployments, repeat all the preceding steps in this procedure on all nodes in your Omnissa Access cluster.
    

Verification

1. Log in to the Omnissa Access admin console.
2. Navigate to the Dashboard to verify system health.
3. Confirm that database connectivity is working properly.
4. Test user authentication and resource access.

Troubleshooting

If the service fails to start after making changes:

• Verify the JDBC URL syntax is correct for your database type.
• Confirm firewall rules allow connectivity on the new port.
• Check that the database server is listening on the specified port.
• Review /opt/vmware/horizon/workspace/logs/horizon.log for specific error messages.
• Verify database credentials are still valid.

Related Topics

• Manually Update External Database Password and Update the JDBC Password Property in Omnissa Access
• Manage Omnissa Access External Database Settings
• Create the Omnissa Access Service Database