Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

The BluVector system is a high-performance, network-based intrusion detection and network visibility platform that utilizes machine learning methodologies and a variety of advanced analysis modules for detecting malware across enterprise gateway links.

This document provides information about the BluVector connector, which facilitates automated interactions, with an BluVector server using FortiSOAR™ playbooks. Add the BluVector connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving information of all events or specific events from BluVector.

 

Version information

Connector Version: 1.0.0

Compatibility with FortiSOAR™ Versions: 4.10.3-161 and later

Compatibility with BluVector Versions: 3.1.2 and later

 

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-bluvector

 

Prerequisites to configuring the connector

  • You must have the URL of BluVector server to which you will connect and perform the automated operations and the API token configured for your account to access that server.
  • To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Configuring the connector

For the procedure to configure a connector, click here.

 

Configuration parameters

In FortiSOAR™, on the Connectors page, select the BluVector connector and click Configure to configure the following parameters:

 

Parameter Description
Server URL URL of the BluVector server to which you will connect and perform the automated operations.
API token API token configured for your account to access the BluVector server to which you will connect and perform the automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

 

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:

 

Function Description Annotation and Category
Get All Events Retrieves a list along with the its details for all the events from BluVector. You can optionally filter the results and retrieve a list of events based on the input parameters you have specified. get_events
Investigation
Get Event Information Retrieves detailed information about an event from BluVector, based on the event ID you have specified. event_information
Investigation

 

operation: Get All Events

Input parameters

Note: All the input parameters are optional. However, if you do not specify any parameter, then no filter criteria is applied and an unfiltered list is returned.

 

Parameter Description
Record Limit Maximum number of records to be retrieved from BluVector.
By default, this is set to 10.
Days Back Time duration for which you want to retrieve a list along with details of all the events from BluVector. For example, if you choose Last 24 Hours, then the details of all the events recorded in the last 24 hours will be retrieved from BluVector.
You can choose from the following options: Last 24 Hours, Last 3 Days, Last 5 Days, Last 7 Days, Last 15 Days, Last 25 Days, Last 30 Days, Last 50 Days, Last 60 Days, Last 90 Days, Last 120 Days, and Last 180 Days.
Note: By default this option is set to Last 15 Days.
Important: If you specify the Days Back value, then this takes precedence over the value that you set for the DateTime field (From) parameter.
From DateTime from when you want to retrieve the list of events from BluVector.
To DateTime till when you want to retrieve the list of events from BluVector.

 

Output

The JSON output contains a list along with its details for all the events or specific event(s) (based on the filter criteria you have specified) retrieved from BluVector.

Following image displays a sample output:

 

Sample output of the Get All Events operation

 

operation: Get Event Information

Input parameters

 

Parameter Description
Scan ID ID of event for which you want to retrieve information from BluVector.

 

Output

The JSON output contains detailed information about the event retrieved from BluVector, based on the event ID you have specified.

Following image displays a sample output:

 

Sample output of the Get Event Information operation

 

Included playbooks

The Sample - BluVector - 1.0.0 playbook collection comes bundled with the BluVector connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the BluVector connector.

  • Get All Events
  • Get Event Information

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection, since the sample playbook collection gets deleted during connector upgrade and delete.

 

About the connector

The BluVector system is a high-performance, network-based intrusion detection and network visibility platform that utilizes machine learning methodologies and a variety of advanced analysis modules for detecting malware across enterprise gateway links.

This document provides information about the BluVector connector, which facilitates automated interactions, with an BluVector server using FortiSOAR™ playbooks. Add the BluVector connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving information of all events or specific events from BluVector.

 

Version information

Connector Version: 1.0.0

Compatibility with FortiSOAR™ Versions: 4.10.3-161 and later

Compatibility with BluVector Versions: 3.1.2 and later

 

Installing the connector

All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:

yum install cyops-connector-bluvector

 

Prerequisites to configuring the connector

Configuring the connector

For the procedure to configure a connector, click here.

 

Configuration parameters

In FortiSOAR™, on the Connectors page, select the BluVector connector and click Configure to configure the following parameters:

 

Parameter Description
Server URL URL of the BluVector server to which you will connect and perform the automated operations.
API token API token configured for your account to access the BluVector server to which you will connect and perform the automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True.

 

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:

 

Function Description Annotation and Category
Get All Events Retrieves a list along with the its details for all the events from BluVector. You can optionally filter the results and retrieve a list of events based on the input parameters you have specified. get_events
Investigation
Get Event Information Retrieves detailed information about an event from BluVector, based on the event ID you have specified. event_information
Investigation

 

operation: Get All Events

Input parameters

Note: All the input parameters are optional. However, if you do not specify any parameter, then no filter criteria is applied and an unfiltered list is returned.

 

Parameter Description
Record Limit Maximum number of records to be retrieved from BluVector.
By default, this is set to 10.
Days Back Time duration for which you want to retrieve a list along with details of all the events from BluVector. For example, if you choose Last 24 Hours, then the details of all the events recorded in the last 24 hours will be retrieved from BluVector.
You can choose from the following options: Last 24 Hours, Last 3 Days, Last 5 Days, Last 7 Days, Last 15 Days, Last 25 Days, Last 30 Days, Last 50 Days, Last 60 Days, Last 90 Days, Last 120 Days, and Last 180 Days.
Note: By default this option is set to Last 15 Days.
Important: If you specify the Days Back value, then this takes precedence over the value that you set for the DateTime field (From) parameter.
From DateTime from when you want to retrieve the list of events from BluVector.
To DateTime till when you want to retrieve the list of events from BluVector.

 

Output

The JSON output contains a list along with its details for all the events or specific event(s) (based on the filter criteria you have specified) retrieved from BluVector.

Following image displays a sample output:

 

Sample output of the Get All Events operation

 

operation: Get Event Information

Input parameters

 

Parameter Description
Scan ID ID of event for which you want to retrieve information from BluVector.

 

Output

The JSON output contains detailed information about the event retrieved from BluVector, based on the event ID you have specified.

Following image displays a sample output:

 

Sample output of the Get Event Information operation

 

Included playbooks

The Sample - BluVector - 1.0.0 playbook collection comes bundled with the BluVector connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the BluVector connector.

Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection, since the sample playbook collection gets deleted during connector upgrade and delete.