Forcepoint NGFW
App Vendor: Forcepoint
App Category: Network Security
Connector Version: 1.0.0
API Version: 6.3.0
About App
Forcepoint Next Generation Firewall (NGFW) blocks malicious attacks and prevents the theft of data and intellectual property while increasing the efficiency of your operations.
The Forcepoint NGFW app is configured with the Orchestrate application to perform the following actions:
Action Name | Description |
|---|---|
Block IP Address | This action blocks the specified IP address. |
Add IP Address and URL to a Category | This action adds IP addresses or URLs to the specified category. |
Create Traceroute | This action traces a route to the specified destination IP address. |
Get Bandwidth Stats | This action retrieves bandwidth stats. |
Get Network Information | This action retrieves network information such as DNS and hosts connected. |
Ping Host | This action pings a host with the specified IP address. |
Configuration Parameters
The following configuration parameters are required for the Forcepoint NGFW app to communicate with the Forcepoint NGFW enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Domain | Enter the domain name or the server IP address. Example:
| Text | Required | |
Port | Enter the port number. Example: "8082" | Text | Required | |
Username | Enter the username. Example: "admin" | Text | Required | |
Password | Enter the password. Example: password | Password | Required | |
Verify | Enter if you want to verify TLS credentials. Example: True | Boolean | Required | Allowed values:
|
Action: Block IP Address
This action blocks the specified IP address.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
IP Address | Enter the IP address you want to block. Example: "12.34. 56.78" | Text | Required | |
Group | Enter the group name. Example: "group_01" | Text | Required | |
Comments | Enter the reason you are blocking the IP address. Example: "unknown IP" | Text | Optional |
Example Request
[
{
"ip_address": "12.34. 56.78",
"group": "group_01",
"comments": "unknown IP"
}
]Action: Add IP Address and URL to a Category
This action adds IP addresses or URLs to the specified category.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Category ID | Enter the category ID. Example: "12345" | Text | Required | |
Category Name | Enter the category name. Example: "quarantine" | Text | Required | |
IP Address | Enter the IP addresses you want to add to the category. Enter values as an array. Example: ["167.34.15.117"] | List | Optional | Optional if values are passed against the URL parameter. |
URLs | Enter the URLs you want to add to the category. Enter values as an array. Example: ["http://www.test1.com/test1"] | List | Required | Optional if values are passed against the IP Address parameter. |
Example Request
[
{
"category_id": "12345",
"category_name": "quarantine",
"ips": [
"167.34.15.117",
"167.34.16.118-167.34.16.120",
"2045:1221:1231::1331",
"24.56.8.0/23",
"55AF:F451::/32"
],
"urls": [
"http://www.test1.com/test1",
"http://www.test1.com/test2",
"http://www.test1.com/test3"
]
}
]Action: Create Traceroute
This action traces a route to the specified destination IP address.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Destination IP | Enter the destination IP address. Example: "192.158.1.38" | Text | Required |
Example Request
[
{
"destination_ip": "12.34.56.78"
}
]Action: Get Bandwidth Stats
This action retrieves bandwidth stats.
Action Input Parameters
This action does not require any input parameters.
Action: Get Network Information
This action retrieves network information such as DNS and hosts connected.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Module | Enter the module name. Example: "module_01" | Text | Required |
Example Request
[
{
"module": "module_01"
}
]Action: Ping Host
This action pings a host with the specified IP address.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Destination IP | Enter the destination IP address. Example: "192.158.1.38" | Text | Required |
Example Request
[
{
"destination_ip": "192.158.1.38"
}
]