Skip to main content

Cyware Orchestrate

Forcepoint NGFW SMC

App Vendor: Forcepoint

App Category: Network Security

Connector Version: 1.0.0

API Version: 6.10, 7.0

Note

This app is currently released as a beta version.

About App

The Forcepoint NGFW SMC API allows secure, automated management of Forcepoint Next Generation Firewalls, facilitating configuration, policy control, monitoring, and reporting to enhance operational efficiency and security.

The Forcepoint NGFW SMC app is configured with Orchestrate to perform the following actions:

Action Name

Description

Create IP List 

This action creates an IP list.

Get Policy 

This action retrieves the list of policies configured in Forcepoint NGFW SMC.

Get Policy Details 

This action retrieves the details of the policy configured in Forcepoint NGFW SMC.

Modify Rule in Policy 

This action modifies a rule in a policy that is configured in Forcepoint NGFW SMC.

Upload IP 

This action uploads IP addresses to the specified IP list.

Generic Action

This is a generic action used to make requests to any Forcepoint NGFW SMC endpoint.

Configuration Parameters

The following configuration parameters are required for the Forcepoint NGFW SMC app to communicate with the Forcepoint NGFW SMC enterprise application. The parameters can be configured by creating instances in the app.

Parameter

Description

Field Type

Required/Optional

Comments

Base URL 

Enter the base URL. 

Example: 

http://localhost:8082

Text

Required

API Version 

Enter the version of the Forcepoint firewall. 

Example: 

7.0

Text

Required

API Key 

Enter the API key to authenticate with Forcepoint NGFW SMC.

Password

Required

Timeout 

Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with Forcepoint NGFW SMC.

Integer

Optional

Allowed range:

15-120

Default value:

15

Verify 

Choose your preference to verify SSL or TLS while making requests. It is recommended to set this option to yes. Passing no may result in incorrectly establishing the connection.

Boolean

Optional

By default, verification is enabled.

Action: Create IP List

This action creates an IP address list.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Name 

Enter the name of the IP list to be created. 

Example: 

myiplist1

Text

Required

Element Type 

Enter the element type. 

Example: 

ip_list 

Text

Optional

Default value: 

ip_list

Comment 

Enter the description of the IP list. 

Example: 

my address list

Text

Required

Include Headers 

Enter true to include response headers.

Boolean

Optional

Action: Get Policy

This action retrieves the list of policies configured in Forcepoint NGFW SMC.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Filter 

Enter the filters to narrow down the response. 

Example: 

HQ Policy

Text

Optional

Element Type 

Enter the element type. 

Example: 

fw_policy

Text

Optional

Default value: 

fw_policy

Action: Get Policy Details

This action retrieves the details of the policy configured in Forcepoint NGFW SMC.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Policy ID

Enter the ID of the policy. 

Example: 

56

Integer

Required

You can retrieve this using the action Get Policy.

Element Type 

Enter the element type. 

Example: 

fw_policy

Text

Optional

Default value: 

fw_policy

Action: Modify Rule in Policy

This action modifies a rule in a policy that is configured in Forcepoint NGFW SMC.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Payload 

Enter the payload to modify the rule in the policy. 

Example: 

{“comment”:”Set logging default, set long timeout for SSH connections”}

Key Value

Required

Element Type 

Enter the element type. 

Example: 

fw_policy 

Text

Required

Default value: 

fw_policy

Policy Type 

Enter the type of the policy. 

Example: 

fw_ipv4_access_rules

Text

Required

Allowed value:

fw_ipv4_access_rules, fw_ipv6_access_rules, fw_ipv4_nat_rules, fw_ipv6_nat_rules

Rule Name 

Enter the rule name of the policy. 

Example: 

Rule @514.0

Text

Required

Action: Upload IP

This action uploads IP addresses to the specified IP list.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

IP Address 

Enter the list of IP addresses. 

Example: 

$LIST[11.11.11, 192.7.5.0]

List

Required

Element Type 

Enter the element type. 

Example: 

ip_list

Text

Optional

Default value: 

ip_list

List ID 

Enter the ID of the IP list where the IP addresses will be uploaded. 

Example: 

1704

Integer

Required

Action: Generic Action

This is a generic action used to make requests to any Forcepoint NGFW SMC endpoint.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Method 

Enter the HTTP method to make the request. 

Text

Required

Allowed values: 

GET, PUT, POST, DELETE

Endpoint 

Enter the endpoint to make the request. 

Example: 

/ip_list

Text

Required

Query Params 

Enter the query parameters to pass to the API.

Key Value

Optional

Payload 

Enter the payload to pass to the API.

Any

Optional

Extra Fields 

Enter the extra fields to pass to the API.

Key Value

Optional

Allowed keys:

payload_json, custom_output, download, filename, files, retry_wait, retry_count, response_type