CICD Utils v1.1.0

About the connector

CICD Utils provides out-of-the-box actions for the Continuous Delivery solution pack.

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

Version information

Connector Version: 1.1.0

FortiSOAR™ Version Tested on: 7.4.3-3294

Authored By: Fortinet

Certified: Yes

Release Notes for version 1.1.0

Following enhancements have been made to the CICD Utils Connector in version 1.1.0:

• Added following new actions:
  • Import FortiSOAR Template
  • Export FortiSOAR Template

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-cicd-utils

Prerequisites to configuring the connector

There are no prerequisites to configuring this connector.

Minimum Permissions Required

• Not applicable

Configuring the connector

This connector installs with the Continuous Delivery solution pack and requires no configurations to run.

Actions supported by the connector

The following automated operations can be included in playbooks and you can also use the annotations to access operations:

operation: Unzip Export Template

Input parameters

Output

The output contains the following populated JSON schema:

{
    "filenames": []
}

operation: Split Export Template

Input parameters

Output

The output contains the following populated JSON schema:

{
    "exportFileName": ""
}

operation: Export FortiSOAR Template

Input parameters

[
    {
        "file_path": "/info.json",
        "operations": [
        {
            "key_path": "contents.globalVariables",
            "key_type": "list",
            "key_to_compare": "name",
            "values_to_remove": [
            "Default_Email",
            "Server_fqhn"
            ]
        },
        {
            "key_path": "",
            "key_type": "dict",
            "keys_to_remove": [
            "exported_from",
            "date"
            ]
        }
        ]
    }
]

Output

The output contains the following populated JSON schema:

{
    "file_iri": ""
}

operation: Import FortiSOAR Template

Input parameters

Output

The output contains a non-dictionary value.

Included playbooks

The Sample - CICD Utils - 1.1.0 playbook collection comes bundled with the CICD Utils 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 CICD Utils connector.

• Split Export Template
• Unzip Export Template
• Export FortiSOAR Template
• Import FortiSOAR Template

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.

Detailing Ignore Keys Parameter

The Ignore Keys parameter in the action Export FortiSOAR Template requires data in a JSON Array format.

Following is a sample JSON content of the Ignore Keys parameter:

[
    {
        "file_path": "/info.json",
        "operations": [
        {
            "key_path": "contents.globalVariables",
            "key_type": "list",
            "key_to_compare": "name",
            "values_to_remove": [
            "Default_Email",
            "Server_fqhn"
            ]
        },
        {
            "key_path": "",
            "key_type": "dict",
            "keys_to_remove": [
            "exported_from",
            "date"
            ]
        }
        ]
    }
]

The following pointers explain how to use the Ignore Keys parameter for removal of unwanted JSON objects or lists:

• file_path: Specify the file path to edit.
• operations: List the operations to perform as JSON objects.
  • key_path: Specify the object to filter as a dot notation.
  • key_type: Specify either list or dict. list removes the entire object and specified keys; dict removes only the specified keys.

    For list key_type specify:

    • key_to_compare: Specify the key to compare
    • values_to_remove: Specify values corresponding to key contained in key_to_compare to remove the entire object
    • keys_to_remove: Removes these keys from the remaining objects in the list
    • keys_to_remove: Removes these keys from the JSON objects