IVR configuration reference

Descriptions of the values on the IVR Configuration page, the fields on each setup step, the columns of the datasource list, and the configuration statuses.

Configuration statuses

Table 1. Status of the Integrated Vulnerability Management card
Status Meaning
Not Configured The setup has not run, or it ran and at least one of the background processes that it started did not complete. Selecting the card opens the setup so that you can correct the values and run it again.
Configured The setup ran and every background process completed successfully. Selecting the card opens View Configuration.

Steps of the setup

The IVR Configuration page runs the setup as four steps. A stepper at the top of the page shows the current step. There is no server configuration step; the IVR service sets those values itself.

Table 2. Setup steps
Step What you supply
1. Database Configuration The database that IVR writes its schema into, given either as individual values or as a DSN connection string, and the name of the schema to create.
2. Application configuration The options that the IVR service runs with, including the web protocol, the local web server port, the cross-origin policy, the Windows service option, and the proxy settings.
3. Scanner Datasource configuration The first scanner that IVR imports vulnerability findings from.
4. Summary Nothing. The step lists every value that you entered so that you can review it before you complete the setup.

Cancel and Next appear at the foot of each step. Verify Connection appears on the steps that connect to another system, and tests the values that you entered before you continue.

Server configuration panel

The IVR service sets these values. The panel reports them and offers no Edit control.

Table 3. Server configuration values
Value Description
IVR Server address Host name or IP address of the server that runs the IVR service.
Basic Auth port Port on which the service accepts basic authentication.
mTLS port Port on which the service accepts mutual TLS authentication.
SANs Subject alternative names on the certificate that the service presents.

Application configuration panel

Select Edit on the panel to change these values. The panel labels each value with the key that the IVR service uses.

Table 4. Application configuration values
Key in the panel Field in the setup Description
webProtocol Web protocol Protocol that the IVR service serves on, for example https.
localWebServerPort Local web server port Port that the IVR web server listens on.
cors CORS allowed origins Origins that are permitted to call the service across origins. A value of * permits all origins.
windowsService Install the application as a Windows Service Reports whether IVR is installed as a Windows service. Installing it as a service requires administrative privileges.
isProxyEnabled Setup proxy Reports whether IVR reaches the scanner through a proxy. When false, the remaining proxy values are empty.
proxyServerHost Proxy server host Host name or IP address of the proxy. Required when the proxy is enabled.
proxyServerPort Proxy server port Port that the proxy listens on. Required when the proxy is enabled.
proxyUsername Proxy server username User name that IVR authenticates to the proxy with. The matching password is stored but not displayed.

Database Configuration panel

Select Edit on the panel to change these values.

Table 5. Database configuration values
Key in the panel Field in the setup Description
dbType Database Type Type of the database server that holds the BigFix UI database. The list offers Microsoft SQL Server and Provide your own DSN. The remaining fields on the step change to match your choice.
dbHost SQL Server Host name or IP address of the database server.
dbPort SQL Server Port Port that the database server listens on.
dbUser Database User User that IVR connects to the database as. This user must hold the privilege to create a schema. The matching password, Database User Password, is stored but not displayed.
dbName Database Name Name of the existing BigFix UI database that IVR writes its schema into.
schemaName Database Schema Name Schema that the setup creates inside the BigFix UI database to hold the IVR data.
dsn DSN The connection string that IVR uses. BigFix UI assembles it from the other values, or uses the ADO.NET connection string that you supply when you select Provide your own DSN in Database Type. Only Microsoft SQL Server DSN strings are supported, and the database must already exist.
Important: The setup creates a new schema inside the existing BigFix UI database. It does not create a database.

When you select Provide your own DSN, the step shows only the DSN and Database Schema Name fields. The page gives two example strings, one using SQL Server authentication and one using Windows authentication.

Scanner datasource fields

These fields appear on the Scanner Datasource configuration step and when you select Add datasource on View Configuration. All of them are required.

Table 6. Datasource fields for Tenable IO
Field Description
Create a New Datasource Type of scanner to connect to. The fields below it change to match the type that you select.
Tenable cloud url URL of your Tenable instance, for example https://cloud.tenable.com.
Tenable access key Access key of the Tenable account that IVR reads with. Generate it in Tenable, from the API keys section of your user profile.
Tenable secret key Secret key that pairs with the access key. Generated at the same time and in the same place.
Alias Name that identifies this datasource in the datasource list.
Verify connection Calls the scanner with the values that you entered and reports whether the connection succeeded.

Datasource list

Table 7. Columns of the Datasource list
Column Description
Type Scanner type of the connection, for example TENABLE IO.
Target URL of the scanner instance that IVR imports from.
Alias Identifier of the connection.
Action Holds an edit control, which reopens the datasource fields, and a delete control, which removes the connection.

Select Add datasource above the list to connect another scanner.

Messages

Table 8. Messages that the configuration can return
Message Where it appears What to do
A message reporting that a background process stopped unexpectedly and directing you to the BigFix UI and IVR logs. The IVR Configuration page, after you select Finish. Review the logs, correct any values that they identify, and select Finish again to restart the service.
IVR unavailable – Something went wrong, please contact your administrator. An IVR page under Resolve. Confirm that the application shows as Configured in Application Configuration and that the IVR service is running.