Hub Server Properties

User authentication methods for accessing the HVR Hub System.

Available authentication methods are:

• password: User is authenticated by their username and password.
• login_token: User is authenticated by one-time login token.

Example JSON to allow both authentication methods:

Authentication_Method={"password":true,"login_token":"true"}

The default behavior when this property is not defined is password authentication.

This is a map property that can store multiple values.

Application ID used to obtain Microsoft Entra ID (formerly Azure Active Directory) access token.

Secret key of the Azure_OAuth2_Client_Id .

URL used for obtaining the bearer token with credential token.

This property is required only if the SqlServer_Authentication_Method is set to CLIENT_CREDS.

Ensure that you are using the OAuth 2.0 endpoint. The URL path should include v2.0. The format for the endpoint URL is https://login.microsoftonline.com/tenant/oauth2/v2.0/token

URL used for obtaining the bearer token with credential token.

Hostname or IP-address of the server on which the database is running.

For Db2 for i, this is the hostname or IP-address of the Db2 for i system.

Name of the database.

For Db2 for i, this is the named database in Db2 for i. It could be on another (independent) auxiliary storage pool (IASP). The user profile's default setting will be used when no value is specified. Specifying *SYSBAS will connect a user to the SYSBAS database.

For Azure SQL Database, this is the user name and host name of the Azure SQL Database server. The format to be used is username@hostname.

When using "Db2 client or Db2 server or Db2 Connect", the name of the Db2 instance must be specified.

When using "Db2 client or Db2 server or Db2 Connect" the directory path of the Db2 installation must be specified.

Port number for HVR Hub Server when HTTP protocol is used.

This is a discovered property that stores the directory path of HVR_CONFIG for the HVR Hub Server.

This is a discovered property that stores the directory path of HVR_HOME for the HVR Hub Server.

This is a discovered property that stores the version of the HVR installed in the HVR Hub Server.

This is a discovered property that stores the unique identifier (fingerprint) of the server on which the HVR Hub Server is installed.

This is a discovered property that stores the name of the operating system on which the HVR Hub Server is installed/running.

This discovered property is set to true if the hvrmanagedpassword file exists in the HVR_CONFIG/plugin/authentication directory.

This is a discovered property that stores the name of the HVR platform used for installing the HVR Hub Server.

Valid values for version are:

• TLSv1_3: TLS version 1.3
• TLSv1_2default: TLS version 1.2
• TLSv1_2_WEAK_CIPHERSSince v6.1.0/20: TLS version 1.2 with weak ciphers enabled
• TLSv1_1: TLS version 1.1
• TLSv1_0: TLS version 1.0

Directory path where the ODBC Driver Manager Library is installed. This property is applicable only for Linux/Unix operating system.

Directory path where the odbc.ini and odbcinst.ini files are located. This property is applicable only for Linux/Unix operating system.

For a default installation, these files are available at /etc directory and do not need to be specified using this property. However, when UnixODBC is installed in for example /opt/unixodbc the value for this field would be /opt/unixodbc/etc.

For Azure SQL Database, the odbcinst.ini file should contain information about the Azure SQL Database ODBC Driver under the heading [ODBC Driverversionfor SQL Server].

For Db2 for i, the odbcinst.ini file should contain information about the IBM i Access Client Solutions ODBC Driver under the heading [IBM i Access ODBC Driver 64-bit].

For Redshift, the odbcinst.ini file should contain information about the Amazon Redshift ODBC Driver under the heading [Amazon Redshift (x64)].

For SAP HANA, the odbcinst.ini file should contain information about the HANA ODBC Driver under heading [HDBODBC] or [HDBODBC32].

For Snowflake, the odbcinst.ini file should contain information about the Snowflake ODBC Driver under the heading [SnowflakeDSIIDriver].

Connection string for connecting to the Oracle database using TNS (Transparent Network Substrate).

The format for the connection string is host:port/service_name.

Setup mode for the HVR Hub Server.

Authentication method for connecting HVR to Azure SQL database.

Available options for method are:

• CLIENT_CREDSSince v6.1.0/4: Authenticate using the Azure SQL access token.

• USER_PASS: Authenticate using the username and password.

• AZURE_ADSince v6.1.0/5: Authenticate using the Azure SQL active directory (AD).

Name of the server (host) on which SQL Server is running and the Port number or the instance name of SQL Server.

The following formats are supported for this property:

• server_name : Specify only the server name and HVR will automatically use the default port to connect to the server on which SQL Server is running.
  Example: myserver
• server_name,port_number : Specify the server name and port number separated by a comma (,) to connect to the server on which SQL Server is running.
  This format is required when using custom port for connection or when SqlServer_Native_Replicator_Connection is defined.
  Example: myserver,1435
• server_name\server_instance_name : Specify the server name and server instance name separated by a backslash (\) to connect to the server on which SQL Server is running.
  This format is not supported on Linux.
  Example: myserver\HVR6048

Directory path where the Teradata TPT Library is installed.

Example: /opt/teradata/client/16.10/odbc_64/lib

Shut down HVR Hub Server worker after it has reached the age of secs seconds.

The default is 3600 seconds (60 minutes).

A worker is a process used by the HVR Hub Server to execute the REST calls.

Sets one or more environment variables for hub server workers.

The value of the Worker_Environment is a JSON string and can be used to set multiple environment variables at once.

In case the Worker_Environment property is changed, the hub server recognizes the changes and all new workers being used adhere to the newly configured environment variables.

Example:

hvrhubserverconfig Worker_Environment='{"HVR_SQL_TRACE":"1","HVR_PROC_TRACE":"2"}'

This is a map property that can store multiple values.

Shut down HVR Hub Server worker after it has remained idle for secs seconds.

The default is 10 seconds.

For optimal performance, the HVR Hub Server workers actively cache the repository database contents, which is crucial for large systems. If a new worker replaces the terminated one, a significant amount of time is required to rebuild that cache. Consequently, worker termination proves to be resource-intensive. Therefore, introducing a grace period before forceful termination helps conserve system resources.

Maximum number of workers that HVR Hub Server spawns at the same time.

Threshold after which the HVR Hub Server worker slows down spawning of workers.