FortiSOAR™ provides you with a number of pre-installed connectors or built-ins, such as the SSH or Database connectors that you can use within FortiSOAR™ playbooks, as a connector step, and perform automated operations. These connectors are bundled and named based on the type of operations the connectors can perform. For example, the Database connector would contain actions that you can perform with respect to the database like querying the database. It is easy to extend and enhance these connectors.
Apart from the FortiSOAR™ Built-in connectors, Fortinet also provides a number of connectors for popular integrations like SIEMs, such as FortiSIEM, Splunk, etc., and Ticketing systems such as Jira. You can see a list of published connectors on the FortiSOAR Connectors Documentation site.
The process of installing, configuring, and using connectors is defined in the Introduction to connectors chapter in the "Connectors Guide", which is part of the FortiSOAR™ documentation or see the Installing a connector and Configuring a connector articles.
FortiSOAR™ Built-in connectors are upgraded by default with a FortiSOAR™ upgrade. Use the Content Hub to upgrade your connectors to the latest version, in case you want to only upgrade the connectors and not FortiSOAR™. For more information on the connector store, see the Introduction to connectors chapter and see the FortiSOAR Built-in connectors article.
Important: Before you upgrade your FortiSOAR™ version, it is highly recommended that you take a backup of your FortiSOAR™ Built-in connector's (SSH, IMAP, Database, etc.) configuration since the configuration of your FortiSOAR™ Built-in connectors might be reset if there are changes to the configuration parameters across versions.
Use this connector to connect to different servers and execute commands or python scripts on those servers.
Connector Version: 2.1.2
Authored By: Fortinet.
Certified: Yes
Following enhancements have been made to the SSH connector in version 2.1.2:
NOTE: For more information on previous releases of the SSH connector, see the SSH Connector v2.1.1 document.
In FortiSOAR™, on the Content Hub (or Connector Store) page, click the Manage tab, and then click the SSH connector card. On the connector popup, click the Configurations tab to enter the required configuration details.
| Parameter | Description |
|---|---|
| Host | Specify the Hostname of the server to which you will connect and execute commands or python scripts. |
| Port | Specify the Port number used for connecting to the server. |
| Username | Specify the username to access the server to which you will connect and execute commands or python scripts. |
| Password | Specify the password to access the server to which you will connect and execute commands or python scripts. |
| Private Key | Specify the private key to access the server to which you will connect and execute commands or python scripts. |
| Super User Password | Specify the password of the 'Super User' to access the server to which you will connect and execute commands or python scripts. |
| Timeout | Specify the timeout value after which the connection to the server is dropped. |
The following automated operations can be included in playbooks:
| Function | Description |
|---|---|
| Execute remote command | Executes the specified command as part of your playbooks on the server you have specified in the 'Configuration' parameters. |
| Execute a python script | Executes the specified python script as part of your playbooks on the server you have specified in the 'Configuration' parameters. |
| Parameter | Description |
|---|---|
| Command | Enter the command that you want to run as part of the playbook on the remote server you have specified in the 'Configuration' parameters. |
| Allowed exit codes | Specify a list of non-standard exit codes to be allowed from the remote command. The default values are: '0': standard success exit code '-1': remote command not returning any exit code. |
| Run as super user | Select this option to run the remote command as the 'Super User' you have specified in the 'Configuration' parameters. |
| Parameter | Description |
|---|---|
| Script | Enter the python script that you want to run as part of the playbook on the remote server you have specified in the 'Configuration' parameters. |
| Python version | Enter the python version that you want to use to run the specified script. By default, it is set to '2'. |
FortiSOAR™ provides you with a number of pre-installed connectors or built-ins, such as the SSH or Database connectors that you can use within FortiSOAR™ playbooks, as a connector step, and perform automated operations. These connectors are bundled and named based on the type of operations the connectors can perform. For example, the Database connector would contain actions that you can perform with respect to the database like querying the database. It is easy to extend and enhance these connectors.
Apart from the FortiSOAR™ Built-in connectors, Fortinet also provides a number of connectors for popular integrations like SIEMs, such as FortiSIEM, Splunk, etc., and Ticketing systems such as Jira. You can see a list of published connectors on the FortiSOAR Connectors Documentation site.
The process of installing, configuring, and using connectors is defined in the Introduction to connectors chapter in the "Connectors Guide", which is part of the FortiSOAR™ documentation or see the Installing a connector and Configuring a connector articles.
FortiSOAR™ Built-in connectors are upgraded by default with a FortiSOAR™ upgrade. Use the Content Hub to upgrade your connectors to the latest version, in case you want to only upgrade the connectors and not FortiSOAR™. For more information on the connector store, see the Introduction to connectors chapter and see the FortiSOAR Built-in connectors article.
Important: Before you upgrade your FortiSOAR™ version, it is highly recommended that you take a backup of your FortiSOAR™ Built-in connector's (SSH, IMAP, Database, etc.) configuration since the configuration of your FortiSOAR™ Built-in connectors might be reset if there are changes to the configuration parameters across versions.
Use this connector to connect to different servers and execute commands or python scripts on those servers.
Connector Version: 2.1.2
Authored By: Fortinet.
Certified: Yes
Following enhancements have been made to the SSH connector in version 2.1.2:
NOTE: For more information on previous releases of the SSH connector, see the SSH Connector v2.1.1 document.
In FortiSOAR™, on the Content Hub (or Connector Store) page, click the Manage tab, and then click the SSH connector card. On the connector popup, click the Configurations tab to enter the required configuration details.
| Parameter | Description |
|---|---|
| Host | Specify the Hostname of the server to which you will connect and execute commands or python scripts. |
| Port | Specify the Port number used for connecting to the server. |
| Username | Specify the username to access the server to which you will connect and execute commands or python scripts. |
| Password | Specify the password to access the server to which you will connect and execute commands or python scripts. |
| Private Key | Specify the private key to access the server to which you will connect and execute commands or python scripts. |
| Super User Password | Specify the password of the 'Super User' to access the server to which you will connect and execute commands or python scripts. |
| Timeout | Specify the timeout value after which the connection to the server is dropped. |
The following automated operations can be included in playbooks:
| Function | Description |
|---|---|
| Execute remote command | Executes the specified command as part of your playbooks on the server you have specified in the 'Configuration' parameters. |
| Execute a python script | Executes the specified python script as part of your playbooks on the server you have specified in the 'Configuration' parameters. |
| Parameter | Description |
|---|---|
| Command | Enter the command that you want to run as part of the playbook on the remote server you have specified in the 'Configuration' parameters. |
| Allowed exit codes | Specify a list of non-standard exit codes to be allowed from the remote command. The default values are: '0': standard success exit code '-1': remote command not returning any exit code. |
| Run as super user | Select this option to run the remote command as the 'Super User' you have specified in the 'Configuration' parameters. |
| Parameter | Description |
|---|---|
| Script | Enter the python script that you want to run as part of the playbook on the remote server you have specified in the 'Configuration' parameters. |
| Python version | Enter the python version that you want to use to run the specified script. By default, it is set to '2'. |
