Fortinet white logo
Fortinet white logo

Cisco Firepower

Cisco Firepower v3.0.0

About the connector

Cisco Firepower is your administrative nerve center for managing critical Cisco network security solutions. It provides a complete and unified management of firewalls, application control, intrusion prevention, URL filtering, and advanced malware protection.

This document provides information about the Cisco Firepower connector, which facilitates automated interactions with Cisco Firepower using FortiSOAR™ playbooks. Add the Cisco Firepower connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving a list currently blocked networks on a Firepower Network Group Object and blocking or unblocking an IP address on a Firepower Network Group Object.

Version information

Connector Version: 3.0.0

Authored By: Fortinet

Certified: No

Release Notes for version 3.0.0

Following enhancements have been made to the Cisco Firepower Connector in version 3.0.0:

  • Added following new actions:
    • List Device
    • Assign Policy To Device
    • Delete Access Policy
  • Actions Block IP and Unblock IP now retrieve list of all devices with configuration changes, ready to be deployed. They also create a request for deploying configuration changes to the specified device.

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-cisco-firepower

Prerequisites to configuring the connector

  • You must have the URL of the Cisco Firepower server to which you will connect and perform automated operations, and the credentials (username-password pair) to access that server.
  • To access the FortiSOAR™ ensure that port 443 is open through the firewall for the FortiSOAR™ instance.

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Cisco Firepower 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 URL of the Cisco Firepower server to which you will connect and perform the automated operations.
Username Username to access the Cisco Firepower server to which you will connect and perform the automated operations.
Password Password to access the Cisco Firepower server to which you will connect and perform the automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified.
By default, this option is set as True.

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 onwards:

Function Description Annotation and Category
List Access Policy Retrieves a list and details of all access control policies from the Cisco Firepower server. get_policy
Investigation
Block IP Adds the IP addresses or networks that you have specified as blacklist items in the Network Group Object that you have specified on the Cisco Firepower server. block_ip
Containment
Unblock IP Removes the IP addresses or networks that you have specified as blacklist items from the Network Group Object that you have specified on the Cisco Firepower server. unblock_ip
Remediation
List Device Retrieves a list and details of all devices from the Cisco Firepower server. list_device
Investigation
Assign Policy To Device Assign specified policy to device(s) that you have specified on the Cisco Firepower server. assign_policy_to_device
Containment
Delete Access Policy Deletes an access control policy from the Cisco Firepower server based on the Policy ID specified. delete_access_policy
Investigation

operation: List Access Policy

Input parameters

Parameter Description
Domain Name (Optional) Specify the domain name for which to retrieve a list of policies from Cisco Firepower server.

NOTE: If you do not specify a domain, then by default this is set to Global.

Limit (Optional) Specify the maximum number of records to be retrieved per page from the Cisco Firepower server.

NOTE: By default, this is set to 10.

Offset (Optional) Specify the index of the first item to return from the search result, in the case of paginated results.

NOTE: By default, this is set to 0.

Output

The output contains the following populated JSON schema:

{
    "links": {
        "self": ""
    },
    "items": [
        {
            "type": "",
            "links": {
                "self": ""
            },
            "name": "",
            "id": ""
        }
    ],
    "paging": {
        "offset": "",
        "limit": "",
        "count": "",
        "pages": ""
    }
}

operation: Block IP

Input parameters

Parameter Description
Domain Name (Optional) Specify the domain name for which to block IP addresses or Networks on the Cisco Firepower server.

NOTE: If you do not specify a domain, then by default this is set to Global.

Network Group Object Specify the network group object in which to add the specified IP addresses or networks as blocked items on the Cisco Firepower server.
IP Address Specify the IP Address or network to add to the blocked list in the specified Network Group Object on the Cisco Firepower server.

NOTE: You can specify multiple IP addresses or networks in the list format. For example, [xx.xx.xx.1, xx.xx.xx.2, xx.xx.xx.3].

NOTE: If you have specified IP addresses or networks that already exist as blocked items in the Network Group Object that you have specified, then the Cisco Firepower connector does not perform any action, i.e., it skips adding the specified IP addresses or networks to the specified Network Group Object.

Output

The output contains the following populated JSON schema:

{
    "existing": [],
    "newly_added": [],
    "not_found": [],
    "removed": []
}

operation: Unblock IP

Input parameters

Parameter Description
Domain Name (Optional) Specify the domain name for which to unblock IP addresses or Networks on the Cisco Firepower server.

NOTE: If you do not specify a domain, then by default this is set to Global.

Network Group Object Specify the network group object from which to remove the specified IP addresses or networks as blocked items on the Cisco Firepower server.
IP Address Specify the IP Address or network to remove from the blocked list in the specified Network Group Object on the Cisco Firepower server.

NOTE: You can specify multiple IP addresses or networks in the list format. For example, [xx.xx.xx.1, xx.xx.xx.2, xx.xx.xx.3].

NOTE: If you have specified IP addresses or networks that do not exist as blocked items in the Network Group Object that you have specified, then the Cisco Firepower connector does not perform any action, i.e., it skips removing the specified IP addresses or networks from the specified Network Group Object.

Output

The output contains the following populated JSON schema:

{
    "existing": [],
    "newly_added": [],
    "not_found": [],
    "removed": []
}

operation: Delete Access Policy

Input parameters

Parameter Description
Domain Name (Optional) Specify the domain name from which to delete the policy on the Cisco Firepower server.

NOTE: If you do not specify a domain, then by default this is set to Global.

Policy ID Specify the policy ID to delete from the Cisco Firepower server.

Output

The output contains the following populated JSON schema:

{
    "links": {
        "self": ""
    },
    "items": [
        {
            "type": "",
            "links": {
                "self": ""
            },
            "name": "",
            "id": ""
        }
    ],
    "paging": {
        "offset": "",
        "limit": "",
        "count": "",
        "pages": ""
    }
}

operation: List Device

Input parameters

Parameter Description
Domain Name (Optional) Specify the domain name for which to retrieve the list of devices from the Cisco Firepower server.

NOTE: If you do not specify a domain, then by default this is set to Global.

Limit (Optional) Specify the maximum number of records to be retrieved per page from the Cisco Firepower server.

NOTE: By default, this is set to 10.

Offset (Optional) Specify the index of the first item to return from the search result, in the case of paginated results.

NOTE: By default, this is set to 0.

Output

The output contains the following populated JSON schema:

{
    "items": [],
    "links": {},
    "paging": {
        "pages": "",
        "count": "",
        "offset": "",
        "limit": ""
    }
}

operation: Assign Policy To Device

Input parameters

Parameter Description
Domain Name (Optional) Specify the domain name for which you want to assign the policy to specified device.

NOTE: If you do not specify a domain, then by default this is set to Global.

Policy Name Specify the policy name to assign to the device.
Policy ID Specify the policy ID to assign to the device.
Device ID Specify the device ID to which you want to assign the policy.

Output

The output contains a non-dictionary value.

Included playbooks

The Sample - Cisco Firepower - 3.0.0 playbook collection comes bundled with the Cisco Firepower connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Cisco Firepower connector.

  • Block IP
  • List Access Policy
  • Unblock IP
  • List Device
  • Assign Policy To Device
  • Delete Access Policy

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.

Previous
Next

Cisco Firepower v3.0.0

About the connector

Cisco Firepower is your administrative nerve center for managing critical Cisco network security solutions. It provides a complete and unified management of firewalls, application control, intrusion prevention, URL filtering, and advanced malware protection.

This document provides information about the Cisco Firepower connector, which facilitates automated interactions with Cisco Firepower using FortiSOAR™ playbooks. Add the Cisco Firepower connector as a step in FortiSOAR™ playbooks and perform automated operations, such as retrieving a list currently blocked networks on a Firepower Network Group Object and blocking or unblocking an IP address on a Firepower Network Group Object.

Version information

Connector Version: 3.0.0

Authored By: Fortinet

Certified: No

Release Notes for version 3.0.0

Following enhancements have been made to the Cisco Firepower Connector in version 3.0.0:

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-cisco-firepower

Prerequisites to configuring the connector

Configuring the connector

For the procedure to configure a connector, click here.

Configuration parameters

In FortiSOAR™, on the Connectors page, click the Cisco Firepower 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 URL of the Cisco Firepower server to which you will connect and perform the automated operations.
Username Username to access the Cisco Firepower server to which you will connect and perform the automated operations.
Password Password to access the Cisco Firepower server to which you will connect and perform the automated operations.
Verify SSL Specifies whether the SSL certificate for the server is to be verified.
By default, this option is set as True.

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 onwards:

Function Description Annotation and Category
List Access Policy Retrieves a list and details of all access control policies from the Cisco Firepower server. get_policy
Investigation
Block IP Adds the IP addresses or networks that you have specified as blacklist items in the Network Group Object that you have specified on the Cisco Firepower server. block_ip
Containment
Unblock IP Removes the IP addresses or networks that you have specified as blacklist items from the Network Group Object that you have specified on the Cisco Firepower server. unblock_ip
Remediation
List Device Retrieves a list and details of all devices from the Cisco Firepower server. list_device
Investigation
Assign Policy To Device Assign specified policy to device(s) that you have specified on the Cisco Firepower server. assign_policy_to_device
Containment
Delete Access Policy Deletes an access control policy from the Cisco Firepower server based on the Policy ID specified. delete_access_policy
Investigation

operation: List Access Policy

Input parameters

Parameter Description
Domain Name (Optional) Specify the domain name for which to retrieve a list of policies from Cisco Firepower server.

NOTE: If you do not specify a domain, then by default this is set to Global.

Limit (Optional) Specify the maximum number of records to be retrieved per page from the Cisco Firepower server.

NOTE: By default, this is set to 10.

Offset (Optional) Specify the index of the first item to return from the search result, in the case of paginated results.

NOTE: By default, this is set to 0.

Output

The output contains the following populated JSON schema:

{
    "links": {
        "self": ""
    },
    "items": [
        {
            "type": "",
            "links": {
                "self": ""
            },
            "name": "",
            "id": ""
        }
    ],
    "paging": {
        "offset": "",
        "limit": "",
        "count": "",
        "pages": ""
    }
}

operation: Block IP

Input parameters

Parameter Description
Domain Name (Optional) Specify the domain name for which to block IP addresses or Networks on the Cisco Firepower server.

NOTE: If you do not specify a domain, then by default this is set to Global.

Network Group Object Specify the network group object in which to add the specified IP addresses or networks as blocked items on the Cisco Firepower server.
IP Address Specify the IP Address or network to add to the blocked list in the specified Network Group Object on the Cisco Firepower server.

NOTE: You can specify multiple IP addresses or networks in the list format. For example, [xx.xx.xx.1, xx.xx.xx.2, xx.xx.xx.3].

NOTE: If you have specified IP addresses or networks that already exist as blocked items in the Network Group Object that you have specified, then the Cisco Firepower connector does not perform any action, i.e., it skips adding the specified IP addresses or networks to the specified Network Group Object.

Output

The output contains the following populated JSON schema:

{
    "existing": [],
    "newly_added": [],
    "not_found": [],
    "removed": []
}

operation: Unblock IP

Input parameters

Parameter Description
Domain Name (Optional) Specify the domain name for which to unblock IP addresses or Networks on the Cisco Firepower server.

NOTE: If you do not specify a domain, then by default this is set to Global.

Network Group Object Specify the network group object from which to remove the specified IP addresses or networks as blocked items on the Cisco Firepower server.
IP Address Specify the IP Address or network to remove from the blocked list in the specified Network Group Object on the Cisco Firepower server.

NOTE: You can specify multiple IP addresses or networks in the list format. For example, [xx.xx.xx.1, xx.xx.xx.2, xx.xx.xx.3].

NOTE: If you have specified IP addresses or networks that do not exist as blocked items in the Network Group Object that you have specified, then the Cisco Firepower connector does not perform any action, i.e., it skips removing the specified IP addresses or networks from the specified Network Group Object.

Output

The output contains the following populated JSON schema:

{
    "existing": [],
    "newly_added": [],
    "not_found": [],
    "removed": []
}

operation: Delete Access Policy

Input parameters

Parameter Description
Domain Name (Optional) Specify the domain name from which to delete the policy on the Cisco Firepower server.

NOTE: If you do not specify a domain, then by default this is set to Global.

Policy ID Specify the policy ID to delete from the Cisco Firepower server.

Output

The output contains the following populated JSON schema:

{
    "links": {
        "self": ""
    },
    "items": [
        {
            "type": "",
            "links": {
                "self": ""
            },
            "name": "",
            "id": ""
        }
    ],
    "paging": {
        "offset": "",
        "limit": "",
        "count": "",
        "pages": ""
    }
}

operation: List Device

Input parameters

Parameter Description
Domain Name (Optional) Specify the domain name for which to retrieve the list of devices from the Cisco Firepower server.

NOTE: If you do not specify a domain, then by default this is set to Global.

Limit (Optional) Specify the maximum number of records to be retrieved per page from the Cisco Firepower server.

NOTE: By default, this is set to 10.

Offset (Optional) Specify the index of the first item to return from the search result, in the case of paginated results.

NOTE: By default, this is set to 0.

Output

The output contains the following populated JSON schema:

{
    "items": [],
    "links": {},
    "paging": {
        "pages": "",
        "count": "",
        "offset": "",
        "limit": ""
    }
}

operation: Assign Policy To Device

Input parameters

Parameter Description
Domain Name (Optional) Specify the domain name for which you want to assign the policy to specified device.

NOTE: If you do not specify a domain, then by default this is set to Global.

Policy Name Specify the policy name to assign to the device.
Policy ID Specify the policy ID to assign to the device.
Device ID Specify the device ID to which you want to assign the policy.

Output

The output contains a non-dictionary value.

Included playbooks

The Sample - Cisco Firepower - 3.0.0 playbook collection comes bundled with the Cisco Firepower connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the Cisco Firepower 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.

Previous
Next