Upon updating and saving the config.json files, the Qualys, Jira, and proxy passwords are encrypted and replaced with a static text.
Files saved from Linux editors like Vim, VI etc may not trigger the Jira connector due to limitations from the Watcher service. We recommend using tools like Winscp to make updates to the file. Otherwise, restart the Jira Connector Container after updating on your preferred editor.
When the config.json file is saved, both containerized services - Qualys client service and Jira client service begin reading and performing the actions mentioned in Jira Connector Services.Keep the 'Knowledgebase' profile active to pull the knowledgebase data into redis DB. No need to configure 'projectKey' and 'ticketingScheme' for Knowledgebase profile because Knowledgebase profile pull the additional details to create the Tickets in Jira Instance.
We recommend not removing any input field from the json file. If a field has no value leave it empty like this -"filter" : ""
Parameter |
Descriptions |
---|---|
active |
Set this parameter to true or false to allow/disallow creating tickets for that profile. |
frequencyInMinutes |
Set the interval (in minutes) for Qualys client service to make periodic API calls to fetch data from the Qualys platform. |
filter |
You can set filters to fetch specific data from the Qualys platform. For Host Detection, the filters must be provided in a URL-encoded format. For WAS, the filters must be provided using escape for double For example "{\"ServiceRequest\":{\"preferences\":{\"verbose\":\"true\"} ,\"filters\":{\"Criteria\":[{\"field\":\"qid\",\"operator\" :\"NOT EQUALS\",\"value\":\"0\"}]}}}" quotes.
For Host Detection, default filters are |
projectKey |
Set the project key from your Jira instance under which the tickets are to be created. |
ticketingScheme |
You can choose between inputs 1-8 for this parameter. Each number denotes the respective ticketing schemes. Refer to Understanding Ticketing Schemes to get a better understanding of ticketing schemes. We do not create tickets for Knowledgebase. We only use the knowledgebase data to fetch a few fields for detection tickets such as diagnosis or solution. |
batchSize |
This parameter is only applicable for KnowledgeBase. Define the batch of QIDs to be fetched by KnowledgeBase APIs in a call. The default value is 500. |
hostAssetApiFilter |
This parameter is only applicable for Host Detection. Define filters for Host List values such as show_trurisk and truncation_limit. truncation_limit can only be set with this parameter. If set using the ‘filter’ parameter, the input is ignored. |
numberOfThreadsForJiraClient (for ver 1.3.1 and below) |
This parameter is not applicablle with version 1.3.2. This parameter enables the Jira Client to run in multi-threading mode. Specify the number of threads to run the Jira Client on. The default value is 2, and you can set the value up to 10. |
numberOfConcurrentTask |
This parameter enables the Jira Client to run in multi-threading mode for each profile. Speed up the ticketing process by specifying the number of threads on which to run the Jira Client. Each profile can have its own value. The default value is 2 for each profile, and you can set the value up to 5. |
JiraTicketAction |
This parameter is only applicable to CS Images. Select the action for the Jira Client to perform when a new vulnerable image is discovered. The create action closes the existing ticket and creates a new ticket for every discovery. The update action updates an existing ticket. |
logLevel |
Set the log levels (TRACE, DEBUG, INFO, WARN, ERROR) to determine what information should be logged for each profile. For example, set it to 'Error' to log all the errors occurring exclusively under this ticketing scheme profile. The type of logs you receive for each log level:
The default level is 'Info'. |
createTicketsOnlyForRunningContainer |
This parameter lets you prioritize security concerns by concentrating on running containers, which pose a greater threat than dormant images. If an image has no connection to any running container, the Jira connector skips generating a ticket for that image. Set this parameter to true on a CS-Image profile to only create tickets for running containers. The default value is false. |
numberOfRetriesForJiraApiCall |
This parameter determines the number of times the Jira client should retry connection when in a 429 error state. The default retry count is 3. |
numberOfRetriesForQualysApiCall |
This parameter determines the number of times the Qualys client should retry connection when the Jira Connector reaches the API rate limit. The default retry count is 3. |
connectionRequestTimeOut |
This parameter is only in use till Jira Connector version 1.3.1.1. The timeout parameter allows the Jira client to exit from waiting for a response indefinitely during a 429 error state. Provide the value in minutes. The default value is 5 minutes. |
responseTimeout |
The timeout parameter allows the Qualys Client and Jira Client to exit waiting for a response indefinitely during a 429 error state. Provide the value in minutes. The default value is 5 minutes. |
frequencyToProcessOutputFiles |
This parameter defines how frequently the Jira connector must scan output files to create or update tickets. Provide the value in minutes. The default value is 5 minutes. |