Fortinet Document Library

Version:


Table of Contents

1.0.0
Copy Link

About the connector

Use the SCP connector to send files and directories to a remote machine and receive files and directories from a remote machine.

Version information

Connector Version: 1.0.0

FortiSOAR™ Version Tested on: 4.12.1-253

Authored By: Fortinet

Certified: Yes 

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-scp

For the detailed procedure to install a connector, click here

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

No configurations are required for this connector.

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
Send File Sends files or directories to a remote machine. send_file
Miscellaneous
Receive File Receives files or directories from a remote machine. receive_file
Miscellaneous

operation: Send File

Input parameters

Parameter Description
Hostname Hostname or IP address of the remote machine to which you want to send files or directories.
Username Username of the remote machine to which you want to send files or directories.
Password Password of the remote machine to which you want to send files or directories.
Filename Path of the file from which you want to transfer file or directories to the remote machine.
This could be a single path or a list of paths from where you want to transfer file or directories.
You must select the Recursive option, i.e., set it to True, if you want to transfer directories.
Remote Path Path in which the remote host will receive the files or directories.
Recursive Select the Recursive option, i.e., set it to True, if you want to transfer files and directories recursively.
Preserve Times Select the Preserve Times option, to preserve mtime and atime of the transferred files and directories.

Output

The output contains the following populated JSON schema:

     "message": "" 
}

operation: Receive File

Input parameters

Parameter Description
Hostname Hostname or IP address of the remote machine from which you want to receive files or directories.
Username Username of the remote machine from which you want to receive files or directories.
Password Password of the remote machine from which you want to receive files or directories.
Local Path Local path in which you want to receive files or directories.
Remote Path Path to retrieve files or directories from the remote host.
Note: Since this path is evaluated by SCP on the remote host, shell wildcards and environment variables can be used.
Recursive Select the Recursive option, i.e., set it to True, if you want to transfer files and directories recursively.
Preserve Times Select the Preserve Times option, to preserve mtime and atime of the transferred files and directories.

Output

The output contains the following populated JSON schema:

     "message": "" 
}

Included playbooks

The Sample - SCP - 1.0.0 playbook collection comes bundled with the SCP 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 SCP connector.

  • Receive File
  • Send File

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

Use the SCP connector to send files and directories to a remote machine and receive files and directories from a remote machine.

Version information

Connector Version: 1.0.0

FortiSOAR™ Version Tested on: 4.12.1-253

Authored By: Fortinet

Certified: Yes 

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-scp

For the detailed procedure to install a connector, click here

Configuring the connector

For the procedure to configure a connector, click here

Configuration parameters

No configurations are required for this connector.

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
Send File Sends files or directories to a remote machine. send_file
Miscellaneous
Receive File Receives files or directories from a remote machine. receive_file
Miscellaneous

operation: Send File

Input parameters

Parameter Description
Hostname Hostname or IP address of the remote machine to which you want to send files or directories.
Username Username of the remote machine to which you want to send files or directories.
Password Password of the remote machine to which you want to send files or directories.
Filename Path of the file from which you want to transfer file or directories to the remote machine.
This could be a single path or a list of paths from where you want to transfer file or directories.
You must select the Recursive option, i.e., set it to True, if you want to transfer directories.
Remote Path Path in which the remote host will receive the files or directories.
Recursive Select the Recursive option, i.e., set it to True, if you want to transfer files and directories recursively.
Preserve Times Select the Preserve Times option, to preserve mtime and atime of the transferred files and directories.

Output

The output contains the following populated JSON schema:

     "message": "" 
}

operation: Receive File

Input parameters

Parameter Description
Hostname Hostname or IP address of the remote machine from which you want to receive files or directories.
Username Username of the remote machine from which you want to receive files or directories.
Password Password of the remote machine from which you want to receive files or directories.
Local Path Local path in which you want to receive files or directories.
Remote Path Path to retrieve files or directories from the remote host.
Note: Since this path is evaluated by SCP on the remote host, shell wildcards and environment variables can be used.
Recursive Select the Recursive option, i.e., set it to True, if you want to transfer files and directories recursively.
Preserve Times Select the Preserve Times option, to preserve mtime and atime of the transferred files and directories.

Output

The output contains the following populated JSON schema:

     "message": "" 
}

Included playbooks

The Sample - SCP - 1.0.0 playbook collection comes bundled with the SCP 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 SCP 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.