About the connector
GoAnywhere MFT is a secure file transfer solution that organizations use to exchange their data safely. The solution helps organizations automate their data transfers, centralize file transfer activity, and monitor file transfers and user access. This connector facilitates automated operation related to File Transfer Summary, Active Sessions Details, and Completed Jobs Summary.
This document provides information about the GoAnywhere Connector, which facilitates automated interactions with a GoAnywhere server using FortiSOAR™ playbooks. Add the GoAnywhere Connector as a step in FortiSOAR™ playbooks and perform automated operations with GoAnywhere.
Version information
Connector Version: 1.0.0
FortiSOAR™ Version Tested on: 7.2.2-1098 and later
GoAnywhere Version Tested on: 7.1.1
Authored By: Fortinet
Certified: Yes
Installing the connector
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 as a root user to install the connector:
yum install cyops-connector-goanywhere
Prerequisites to configuring the connector
- You must have the URL of the GoAnywhere server to connect and perform automated operations and credentials to access that server.
- The FortiSOAR™ server should have outbound connectivity to port 443 on the GoAnywhere server.
Minimum Permissions Required
You must have admin privileges with following roles:
- Auditor
- Job Manager
- Project Executor
- Product Administrator
Configuring the connector
For the procedure to configure a connector, click here
Configuration parameters
In FortiSOAR™, on the Connectors page, click the GoAnywhere 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 |
Specify the URL of the GoAnywhere server to connect and perform automated operations. |
| Username |
Specify the username to access the GoAnywhere server to connect and perform automated operations. |
| Password |
Specify the password to access the GoAnywhere server to connect and perform automated operations. |
| Verify SSL |
Specifies whether the SSL certificate for the server is to be verified.
By default, this option is set to True. |
Actions supported by the connector
The following automated operations can be included in playbooks and you can also use the annotations to access following operations:
| Function |
Description |
Annotation and Category |
| Get File Transfer Summary |
Retrieves the file transfers and their summary details for a specified service from GoAnywhere based on the GoAnywhere module, date range, and grouping criteria specified. |
get_file_transfer_summary
Investigation |
| Get Active Sessions Details |
Retrieves details for each active session from GoAnywhere based on the session type you have specified. |
get_active_sessions_details
Investigation |
| Get Completed Jobs Summary |
Retrieves the count of completed jobs from GoAnywhere based on the date range, grouping criteria, and job status that you have specified. |
get_completed_jobs_summary
Investigation |
operation: Get File Transfer Summary
Input parameters
| Parameter |
Description |
| Module |
(Optional) Specify the GoAnywhere modules to include in the file transfer statistics from the following available options:
- AS2
- FTP
- FTPS
- SFTP
- GoFast
- GoDrive
- Projects
- AS4
- PeSIT
- Secure Folders
- Secure Forms
- Triggers
- Secure Mail
|
| Date Range |
(Optional) Specify the date range of file transfers from the following available options:
- Today
- Yesterday
- Last 7 Days
- Last 30 Days
- Last 90 Days
- Last 180 Days
- Last 365 Days
|
| Group By |
(Optional) Specify the criteria to group the statistics from the following available options:
- Hour
- Day Of Week
- Day Of Month
- Month
|
Output
The output contains the following populated JSON schema:
{
"label": "",
"count": ""
}
operation: Get Active Sessions Details
Input parameters
| Parameter |
Description |
| Services |
(Optional) Specify the GoAnywhere services returned, from the following available options:
- HTTPS Sessions
- FTP Sessions
- FTPS Sessions
- SFTP Sessions
- AS2 Sessions
- GoFast Sessions
- Agent Sessions
- Admin Sessions
- AS4
- PeSIT
|
| Limit |
(Optional) Specify the maximum count of records that you want this operation to fetch from GoAnywhere. |
Output
The output contains the following populated JSON schema:
{
"service": "",
"userName": "",
"remoteAddress": "",
"gateway": "",
"localAddress": "",
"localPort": "",
"bytesSent": "",
"bytesReceived": ""
}
operation: Get Completed Jobs Summary
Input parameters
| Parameter |
Description |
| Date Range |
(Optional) Specify the date range of job statistics from the following available options:
- Today
- Yesterday
- Last 7 Days
- Last 30 Days
- Last 90 Days
- Last 180 Days
- Last 365 Days
|
| Group By |
(Optional) Specify the criteria to group the statistics from the following available options:
- Hour
- Day Of Week
- Day Of Month
- Month
|
| Status |
(Optional) Specify the criteria to filter the results by job status from the following available options:
|
Output
The output contains the following populated JSON schema:
{
"label": "",
"count": ""
}
Included playbooks
The Sample - GoAnywhere - 1.0.0 playbook collection comes bundled with the GoAnywhere 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 GoAnywhere connector.
- Get Active Sessions Details
- Get Completed Jobs Summary
- Get File Transfer Summary
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.
