Fortinet Document Library

Version:


Table of Contents

2.0.0
Copy Link

About the connector

MxToolbox offers network diagnostic and lookup tools.

This document provides information about the MxToolbox connector, which facilitates automated interactions with MxToolbox using FortiSOAR™ playbooks. Add the MxToolbox connector as a step in FortiSOAR™ playbooks and perform automated operations, such as making an API call to retrieve records from MxToolbox based on the investigation method you have specified.

Version information

Connector Version: 2.0.0

FortiSOAR™ Version Tested on: 5.1.0-464

Authored By: Fortinet

Certified: Yes

Release Notes for version 2.0.0

Following enhancements have been made to the MxToolbox connector  in version 2.0.0:

  • Version 2.0.0 of the MxToolbox is released as a certified connector.
  • Added additional parameters to the API Method input parameter based on the investigation method you have specified in the Get MxToolbox Records action.

Installing the connector

From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root user to install connectors:

yum install cyops-connector-mxtoolbox

Prerequisites to configuring the connector

  • You must have the URL of MxToolbox server to which you will connect and perform automated operations and the API key configured for your account to access the MxToolbox endpoint.
  • 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, click the MxToolbox connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details: 

Parameter Description
Server URL URL of the MxToolbox server to which you will connect and perform automated operations.
API Key API key that is configured for your account to access the MxToolbox endpoint.
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 and onwards:

Function Description Annotation and Category
Get MxToolbox Records Makes an API call and retrieves records from MxToolbox based on the investigation method you have specified. get_mxtoolbox_records
Investigation

operation: Get MxToolbox Records

Input parameters

Parameter Description
API Method API method based on which you want to retrieve records from MxToolbox. You can choose from the following investigation methods: Lookup, Monitor, or Usage. The Usage API method retrieves the number of consumed requests and the number of maximum allowed requests. 
  • If you use Lookup, then you must specify the following additional parameters:
    • Lookup Types: Select the lookup type based on which you want to retrieve records from MxToolbox. 
    • Lookup Value: Specify the value of the lookup associated with the lookup type you have specified.
    • Port: Port number associated with the lookup type you have specified.
  • If you use Monitor, then you must specify the following additional parameters:
    • Monitor Types: Select the monitor type based on which you want to retrieve records from MxToolbox. 
    • Monitor Value: Specify the value of the monitor associated with the monitor type you have specified.
    • Tags: Tags associated with the monitor type you have specified.

Output

The output contains the following populated JSON schema:
{
     "request_status": "",
     "result": ""
}

Included playbooks

The Sample - MXToolbox - 2.0.0 playbook collection comes bundled with the MxToolbox connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in CyOPsTM after importing the MxToolbox connector.

  • Get MxToolbox Records

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

MxToolbox offers network diagnostic and lookup tools.

This document provides information about the MxToolbox connector, which facilitates automated interactions with MxToolbox using FortiSOAR™ playbooks. Add the MxToolbox connector as a step in FortiSOAR™ playbooks and perform automated operations, such as making an API call to retrieve records from MxToolbox based on the investigation method you have specified.

Version information

Connector Version: 2.0.0

FortiSOAR™ Version Tested on: 5.1.0-464

Authored By: Fortinet

Certified: Yes

Release Notes for version 2.0.0

Following enhancements have been made to the MxToolbox connector  in version 2.0.0:

Installing the connector

From FortiSOAR™ 5.0.0 onwards, use the Connector Store to install the connector. For the detailed procedure to install a connector, click here.
You can also use the yum command to install connectors. Connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and run the yum command as a root user to install connectors:

yum install cyops-connector-mxtoolbox

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, click the MxToolbox connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details: 

Parameter Description
Server URL URL of the MxToolbox server to which you will connect and perform automated operations.
API Key API key that is configured for your account to access the MxToolbox endpoint.
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 and onwards:

Function Description Annotation and Category
Get MxToolbox Records Makes an API call and retrieves records from MxToolbox based on the investigation method you have specified. get_mxtoolbox_records
Investigation

operation: Get MxToolbox Records

Input parameters

Parameter Description
API Method API method based on which you want to retrieve records from MxToolbox. You can choose from the following investigation methods: Lookup, Monitor, or Usage. The Usage API method retrieves the number of consumed requests and the number of maximum allowed requests. 
  • If you use Lookup, then you must specify the following additional parameters:
    • Lookup Types: Select the lookup type based on which you want to retrieve records from MxToolbox. 
    • Lookup Value: Specify the value of the lookup associated with the lookup type you have specified.
    • Port: Port number associated with the lookup type you have specified.
  • If you use Monitor, then you must specify the following additional parameters:
    • Monitor Types: Select the monitor type based on which you want to retrieve records from MxToolbox. 
    • Monitor Value: Specify the value of the monitor associated with the monitor type you have specified.
    • Tags: Tags associated with the monitor type you have specified.

Output

The output contains the following populated JSON schema:
{
     "request_status": "",
     "result": ""
}

Included playbooks

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