Fortinet Document Library

Version:


Table of Contents

1.1.0
Copy Link

About the connector

Arbor APS provides DDoS mitigation technology that is proven in critical enterprise and government networks around the globe.

This document provides information about the Arbor APS connector, which facilitates automated interactions with Arbor APS using FortiSOAR™ playbooks. Add the Arbor APS connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving all DDoS alerts or alerts based on the search criteria you have specified from Arbor APS, or retrieving network summary reports using various filters you have specified from Arbor APS.

Version information

Connector Version: 1.1.0

Authored By: Fortinet

Certified: No

Release Notes for version 1.1.0

Following enhancements have been made to the Arbor APS Connector in version 1.1.0:

  • Removed all the operations from version 1.0.0
  • Added the following new operations and playbooks:

    • Get Alerts

    • Get Network Summary Report
    • Get Top Talker Report

Prerequisites to configuring the connector

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

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-arbor-aps

For the detailed procedure to install a connector, click here.

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™, on the connectors page, select the Arbor APS connector, and click Configure to configure the following parameters:

Parameter Description
Server URL URL of the Arbor APS server to which you will connect and perform automated operations.
API Key API key of the Arbor APS server to which you will connect and perform 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 Alerts Retrieves a list of all DDoS alerts or alerts based on the search criteria you have specified from Arbor APS. get_alert
Investigation
Get Network Summary Report Retrieves network summary reports using various filters you have specified from Arbor APS. get_report
Investigation
Get Top Talker Report Retrieves the top talkers external or internal reports based on the record ID, report type, and other search criteria you have specified from Arbor APS. get_report
Investigation

operation: Get Alerts

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
Search String Search criteria based on which you want to filter alerts on the alert pages in the Web UI of Arbor APS.
Limit Maximum number of alerts that this operation should return.

Output

The output contains a non-dictionary value.

operation: Get Network Summary Report

Input parameters

Parameter Description
Customer Name Name of the customer whose associated network summary reports you want to retrieve from Arbor APS. 
Start Time Start time from when you want to retrieve the network summary reports from Arbor APS.
End Time End time till when you want to retrieve the network summary reports from Arbor APS.
Unit Unit based on which you want to retrieve the network summary reports from Arbor APS.
Timeout Default time, in seconds, that the connector will wait to retrieve the network summary reports from Arbor APS before timing out.
By default, this is set to 30 seconds.
Limit Maximum number of network summary reports that this operation should return.
By default, this is set to 100.

Output

The output contains a non-dictionary value.

operation: Get Top Talker Report

Input parameters

Parameter Description
Record ID ID of the record whose associated top talkers you want to retrieve from Arbor APS.  
Report Type Type of record, external or internal, whose associated top talkers you want to retrieve from Arbor APS.
Start Time Start time from when you want to retrieve the top talkers external or internal reports from Arbor APS.
End Time End time till when you want to retrieve the top talkers external or internal reports from Arbor APS.
Unit Unit based on which you want to retrieve the top talkers external or internal reports from Arbor APS.
By default, this is set to bps.
Limit Maximum number of top talkers external or internal reports that this operation should return.
By default, this is set to 100.

Output

The output contains a non-dictionary value.

Included playbooks

The Sample - Arbor APS - 1.1.0 playbook collection comes bundled with the Arbor APS connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Arbor APS connector.

  • Get Alerts
  • Get Network Summary Report
  • Get Top Talker Report

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

Arbor APS provides DDoS mitigation technology that is proven in critical enterprise and government networks around the globe.

This document provides information about the Arbor APS connector, which facilitates automated interactions with Arbor APS using FortiSOAR™ playbooks. Add the Arbor APS connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving all DDoS alerts or alerts based on the search criteria you have specified from Arbor APS, or retrieving network summary reports using various filters you have specified from Arbor APS.

Version information

Connector Version: 1.1.0

Authored By: Fortinet

Certified: No

Release Notes for version 1.1.0

Following enhancements have been made to the Arbor APS Connector in version 1.1.0:

Prerequisites to configuring the connector

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-arbor-aps

For the detailed procedure to install a connector, click here.

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™, on the connectors page, select the Arbor APS connector, and click Configure to configure the following parameters:

Parameter Description
Server URL URL of the Arbor APS server to which you will connect and perform automated operations.
API Key API key of the Arbor APS server to which you will connect and perform 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 Alerts Retrieves a list of all DDoS alerts or alerts based on the search criteria you have specified from Arbor APS. get_alert
Investigation
Get Network Summary Report Retrieves network summary reports using various filters you have specified from Arbor APS. get_report
Investigation
Get Top Talker Report Retrieves the top talkers external or internal reports based on the record ID, report type, and other search criteria you have specified from Arbor APS. get_report
Investigation

operation: Get Alerts

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
Search String Search criteria based on which you want to filter alerts on the alert pages in the Web UI of Arbor APS.
Limit Maximum number of alerts that this operation should return.

Output

The output contains a non-dictionary value.

operation: Get Network Summary Report

Input parameters

Parameter Description
Customer Name Name of the customer whose associated network summary reports you want to retrieve from Arbor APS. 
Start Time Start time from when you want to retrieve the network summary reports from Arbor APS.
End Time End time till when you want to retrieve the network summary reports from Arbor APS.
Unit Unit based on which you want to retrieve the network summary reports from Arbor APS.
Timeout Default time, in seconds, that the connector will wait to retrieve the network summary reports from Arbor APS before timing out.
By default, this is set to 30 seconds.
Limit Maximum number of network summary reports that this operation should return.
By default, this is set to 100.

Output

The output contains a non-dictionary value.

operation: Get Top Talker Report

Input parameters

Parameter Description
Record ID ID of the record whose associated top talkers you want to retrieve from Arbor APS.  
Report Type Type of record, external or internal, whose associated top talkers you want to retrieve from Arbor APS.
Start Time Start time from when you want to retrieve the top talkers external or internal reports from Arbor APS.
End Time End time till when you want to retrieve the top talkers external or internal reports from Arbor APS.
Unit Unit based on which you want to retrieve the top talkers external or internal reports from Arbor APS.
By default, this is set to bps.
Limit Maximum number of top talkers external or internal reports that this operation should return.
By default, this is set to 100.

Output

The output contains a non-dictionary value.

Included playbooks

The Sample - Arbor APS - 1.1.0 playbook collection comes bundled with the Arbor APS connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Arbor APS 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.