From a5515051122ccbbb41f81a839960665c7156ea99 Mon Sep 17 00:00:00 2001 From: cs-harsh-sharma Date: Mon, 7 Aug 2023 16:38:17 +0530 Subject: [PATCH] Added docs --- ...FortinetFortimanagerJsonRpcConnectorDoc.md | 114 ++++++++++++++++++ fortinet-fortimanager-json-rpc/info.json | 2 +- 2 files changed, 115 insertions(+), 1 deletion(-) create mode 100644 docs/FortinetFortimanagerJsonRpcConnectorDoc.md diff --git a/docs/FortinetFortimanagerJsonRpcConnectorDoc.md b/docs/FortinetFortimanagerJsonRpcConnectorDoc.md new file mode 100644 index 0000000..bac98fe --- /dev/null +++ b/docs/FortinetFortimanagerJsonRpcConnectorDoc.md @@ -0,0 +1,114 @@ +## About the connector +The Fortinet FortiManager JSON RPC Connector is an advanced connector with freeform actions to use the JSON-RPC API directly. This connector puts the onus on the user to understand the FortiManager API. To use the connector that simplify actions please see the original Fortinet FortiManager Connector. +

This document provides information about the Fortinet FortiManager JSON RPC Connector, which facilitates automated interactions, with a Fortinet FortiManager JSON RPC server using FortiSOAR™ playbooks. Add the Fortinet FortiManager JSON RPC Connector as a step in FortiSOAR™ playbooks and perform automated operations with Fortinet FortiManager JSON RPC.

+### Version information + +Connector Version: 1.0.0 + + +Authored By: Fortinet CSE + +Certified: No +## Release Notes for version 1.0.0 +Following enhancements have been made to the Fortinet FortiManager JSON RPC Connector in version 1.0.0: + + +

This connector puts the onus on the user to understand the FMG API that can be found in the FNDN FortiAPI to use. To use the connector that simplify actions please see the original Fortinet Fortimanager Connector.

+## Installing the connector +

Use the Content Hub 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-fortinet-fortimanager-json-rpc
+ +## Prerequisites to configuring the connector +- You must have the credentials of Fortinet FortiManager JSON RPC server to which you will connect and perform automated operations. +- The FortiSOAR™ server should have outbound connectivity to port 443 on the Fortinet FortiManager JSON RPC server. + +## Minimum Permissions Required +- Not applicable + +## Configuring the connector +For the procedure to configure a connector, click [here](https://docs.fortinet.com/document/fortisoar/0.0.0/configuring-a-connector/1/configuring-a-connector) +### Configuration parameters +

In FortiSOAR™, on the Connectors page, click the Fortinet FortiManager JSON RPC connector row (if you are in the Grid view on the Connectors page) and in the Configurations tab enter the required configuration details:

+ + + + + + + +
ParameterDescription
HostnameIP address or Hostname of the Fortinet FortiManager endpoint server to which you will connect and perform the automated operations. +
UsernameUsername with JSON-RPC enabled to access the Fortinet FortiManager server to which you will connect and perform the automated operations. +
PasswordPassword to access the Fortinet FortiManager server to which you will connect and perform the automated operations. +
PortPort number used to access the Fortinet FortiManager server to which you will connect and perform the automated operations. By default, this is set to 443. +
Verify SSLSpecifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set to True.
Debug ConnectionOnly used with the json_rpc connections, and enables the debug. This can sometimes cause an I/O operation error since debugging involves printing responses, which writes to the integration.log file. +
Verbose JSONSetting this to true adds a verbose flag to the request, so that the integers are translated to the string represntation by Fortimanager. +
+## 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: + + + + + +
FunctionDescriptionAnnotation and Category
JSON RPC AddA Generic FMG Add action that lets you specify any valid URL and data objectjson_rpc_add
Investigation
JSON RPC SetA Generic FMG Set action that lets you specify any valid URL and data objectjson_rpc_set
Investigation
JSON RPC GetA Generic FMG Get action that lets you specify any valid URL and data objectjson_rpc_get
Investigation
JSON RPC ExecA Generic FMG Execute action that lets you specify any valid URL and data objectjson_rpc_execute
Investigation
JSON RPC DeleteA Generic FMG Delete action that lets you specify any valid URL and data objectjson_rpc_delete
Investigation
+### operation: JSON RPC Add +#### Input parameters +
ParameterDescription
URLThe url you wish to hit +
DataPass a json object for the data you want to send. +
+#### Output + + The output contains a non-dictionary value. +### operation: JSON RPC Set +#### Input parameters +
ParameterDescription
URLThe url you wish to hit +
DataPass a json object for the data you want to send. +
+#### Output + + The output contains a non-dictionary value. +### operation: JSON RPC Get +#### Input parameters +
ParameterDescription
URLThe url you wish to hit +
DataPass a json object for the data you want to send. +
+#### Output + + The output contains a non-dictionary value. +### operation: JSON RPC Exec +#### Input parameters +
ParameterDescription
URLThe url you wish to hit +
DataPass a json object for the data you want to send. +
Track TaskChecking this box will attempt to track a task if found, and wait to return the output until that task is complete +
+#### Output + + The output contains a non-dictionary value. +### operation: JSON RPC Delete +#### Input parameters +
ParameterDescription
URLThe url you wish to hit +
DataPass a json object for the data you want to send. +
+#### Output + + The output contains a non-dictionary value. +## Included playbooks +The `Sample - fortinet-fortimanager-json-rpc - 1.0.0` playbook collection comes bundled with the Fortinet FortiManager JSON RPC 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 Fortinet FortiManager JSON RPC connector. + +- JSON RPC Add +- JSON RPC Delete +- JSON RPC Exec +- JSON RPC Get +- JSON RPC Set + +**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. diff --git a/fortinet-fortimanager-json-rpc/info.json b/fortinet-fortimanager-json-rpc/info.json index caae037..b56d381 100644 --- a/fortinet-fortimanager-json-rpc/info.json +++ b/fortinet-fortimanager-json-rpc/info.json @@ -7,7 +7,7 @@ "cs_compatible": true, "version": "1.0.0", "category": "Centralized Security Management", - "help_online": "", + "help_online": "https://github.com/fortinet-fortisoar/connector-fortinet-fortimanager-json-rpc/blob/release/1.0.0/docs/FortinetFortimanagerJsonRpcConnectorDoc.md", "icon_small_name": "FortiManager_small.png", "icon_large_name": "FortiManager_medium.png", "configuration": {