Skip to main content

Cyware Orchestrate

Cisco Firepower Threat Defense (FTD)

App Vendor: Cisco

App Category: Network Security

Connector Version: 1.0.0

API Version: 1.0.0

About App

Cisco Firepower Threat Defense (FTD) is an integrative software combining Cisco ASA and Firepower features into one inclusive system. The Cisco Firepower Threat Defense (FTD) app enables security teams to integrate with the enterprise version of Cisco Firepower Threat Defense (FTD) software to manage access policies.

The Cisco Firepower Threat Defense (FTD) app is configured with the Orchestrate application to perform the following actions:

Action Name

Description

Create Access Rule

This action creates an access rule in the Cisco FTD application.

Edit Access Policy

This action updates an access policy in the Cisco FTD application.

Edit Access Rule

This action updates an access rule in the Cisco FTD application.

Get List of Access Policies

This action retrieves a list of access policies from the Cisco FTD application.

Get a List of Access Rules

This action retrieves a list of access rules from the Cisco FTD application.

Get Access Policy Details

This action retrieves access policy details from the Cisco FTD application.

Get Access Rule Details

This action retrieves access rule details from the Cisco FTD application.

Configuration Parameters

The following configuration parameters are required for the Cisco Firepower Threat Defense (FTD) app to communicate with the Cisco Firepower Threat Defense (FTD) enterprise application. The parameters can be configured by creating instances in the app.

Parameter

Description

Field Type

Required/Optional

Comments

FTD Server

Enter the Cisco FTD server fully qualified domain name.

Example:

"https://<ftp_server>:<port>"

Text

Required

FTD server fully qualified domain name format:

"https://<ftp_server>:<port>"

Username

Enter the username.

Example:

"sample username"

Text

Required

Password

Enter the password.

Example:

"sample password"

Password

Required

SSL Verify

Optional preference to either verify or skip the SSL certificate verification.

Example:

"False"

Boolean

Optional

Allowed values:

  • True

  • False

Default value: "False"

Action: Create Access Rule

This action creates an access rule in the Cisco FTD application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Access Policy ID

Enter the access policy ID.

Example:

"sample id"

Text

Required

You can retrieve the access policy ID using the Get list of access policies action.

Rule Name

Enter the rule name.

Example:

"sample rule name"

Text

Required

You can retrieve the rule name using the Get a list of access rules action.

Rule Type

Enter the rule type.

Example:

"sample rule type"

Text

Required

Query Params

Enter the query parameters in key-value pairs.

Key Value

Optional

Extra Params

Enter the list of extra parameters in key-value pairs.

Example:

{ "ruleAction": "PERMIT", "eventLogAction": "LOG_FLOW_END" }

Key Value

Optional

Allowed keys:

  • sourceZones

  • destinationZones

  • sourceNetworks

  • destinationNetworks

  • sourcePorts

  • destinationPorts

  • rulePosition

  • ruleAction

  • eventLogAction

  • identitySources

  • users

  • embeddedAppFilter

  • urlFilter

  • intrusionPolicy

  • filePolicy

  • logFiles

  • syslogServer

  • hitCount

Example Request

[
    {
        "access_policy_id": "sample id",
        "rule_name": "sample rule name",
        "rule_type": "sample rule type",
        "extra_params":{
            "ruleAction":  "PERMIT", 
            "eventLogAction": "LOG_FLOW_END"
        }
    }
]
Action: Edit Access Policy

This action updates an access policy in the Cisco FTD application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Access Policy ID

Enter the access policy ID.

Example:

"sample id"

Text

Required

You can retrieve the access policy ID using the Get list of access policies action.

Policy Name

Enter the policy name.

Example:

"sample policy name"

Text

Required

You can retrieve the policy name using the Get access policy details action.

Policy Type

Enter the policy type.

Example:

"sample policy type"

Text

Required

Extra Params

Enter the list of extra parameters in key-value pairs.

Example:

{

"securityIntelligence": {

"id": "string",

"name": "string",

"type": "string",

"version": "string"

},

"sslPolicy": {

"id": "string",

"name": "string",

"type": "string",

"version": "string"

}

}

Key Value

Optional

Allowed keys:

  • version

  • defaultAction

  • sslPolicy

  • identityPolicySetting

  • securityIntelligence

Example Request

[
    {
        "access_policy_id": "sample id",
        "policy_name": "sample policy name",
        "policy_type": "sample policy type",
        "extra_params":{
            "securityIntelligence": {
                "id": "string",
                "name": "string",
                "type": "string",
                "version": "string"
              },
            "sslPolicy": {
                "id": "string",
                "name": "string",
                "type": "string",
                "version": "string"
              }
        }
    }
]
Action: Edit Access Rule

This action updates an access rule in the Cisco FTD application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Access Policy ID

Enter the access policy ID.

Example:

"sample id"

Text

Required

You can retrieve the access policy ID using the Get list of access policies action.

Access Rule ID

Enter the access rule ID.

Example:

"sample rule id"

Text

Required

You can retrieve the rule name using the Get a list of access rules action.

Rule Name

Enter the rule name.

Example:

"sample rule name"

Text

Required

You can retrieve the rule name using the Get access rule details action.

Rule Type

Enter the rule type.

Example:

"sample rule type"

Text

Required

Query Params

Enter the query parameters in key-value pairs.

Key Value

Optional

Extra Params

Enter the extra parameters in key-value pairs.

Example:

{ "ruleAction": "PERMIT", "eventLogAction": "LOG_FLOW_END" }

Key Value

Optional

Allowed keys:

  • sourceZones

  • destinationZones

  • sourceNetworks

  • destinationNetworks

  • sourcePorts

  • destinationPorts

  • rulePosition

  • ruleAction

  • eventLogAction

  • identitySources

  • users

  • embeddedAppFilter

  • urlFilter

  • intrusionPolicy

  • filePolicy

  • logFiles

  • syslogServer

  • hitCount

Example Request

[
    {
        "access_policy_id": "sample id",
        "rule_name": "sample rule name",
        "rule_type": "sample rule type",
        "access_rule_id": "sample rule id",
        "extra_params":{
            "ruleAction":  "PERMIT", 
            "eventLogAction": "LOG_FLOW_END"
        }
    }
]
Action: Get List of Access Policies

This action retrieves a list of access policies from the Cisco FTD application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Query Params

Enter the query parameters in key-value pairs.

Example:

{ "offset": 10, "limit": "sample limit" }

Key Value

Optional

Allowed keys:

  • offset(int)

  • sort(int)

  • limit(str)

  • filter(str)

Example Request

[
    {
       "params":{
            "offset":  10, 
            "limit": "sample limit"
        }
    }
]
Action: Get a List of Access Rules

This action retrieves a list of access rules from the Cisco FTD application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Access Policy ID

Enter the access policy ID.

Example:

"sample id"

Text

Required

You can retrieve the access policy ID using the Get list of access policies action.

Query Params

Enter the query parameters in key-value pairs.

Example:

{ "offset": 10, "limit": "sample limit" }

Key Value

Optional

Allowed keys:

  • offset(int)

  • limit(int)

  • sort(str)

  • filter(str)

  • includehitcounts(bool)

Example Request

[
    {
        "access_policy_id": "sample id",
        "params":{
            "offset":  10, 
            "limit": "sample limit"
        }
    }
]
Action: Get Access Policy Details

This action retrieves access policy details from the Cisco FTD application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Access Policy ID

Enter the access policy ID.

Example:

"sample id"

Text

Required

You can retrieve the access policy ID using the Get list of access policies action.

Example Request

[
    {
        "access_policy_id": "sample id"
    }
]
Action: Get Access Rule Details

This action retrieves access rule details from the Cisco FTD application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Access Policy ID

Enter the access policy ID.

Example:

"sample id"

Text

Required

You can retrieve the access policy ID using the Get list of access policies action.

Rule ID

Enter the rule ID.

Example:

"access_rule_id": "sample rule id"

Text

Required

You can retrieve the rule ID using the Get a list of access rules action.

Query Params

Enter the query parameters in key-value pairs.

Example:

{ "includehitcounts": "True" }

Key Value

Optional

Allowed key: includehitcounts (bool)

Example Request

[
    {
        "access_policy_id": "sample id",
        "access_rule_id": "sample rule id",
        "extra_params":{
            "includehitcounts":  "True"
        }
    }
]