Skip to content

firewall_policy_template

Overview

API to add, modify, delete, and get configuration for Firewall policy templates

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP

Tags

  • firewall_policy_template : Operations related to firewall_policy_template

Paths

POST operation for firewall_policy_template

POST /firewall_policy_template

Description

Use this operation to add Firewall policy templates

Responses

HTTP Code Description Schema
200 Resource successfully added firewall_policy_template_post_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • firewall_policy_template

Get operation for firewall_policy_template

GET /firewall_policy_template

Description

Use this operation to get the Firewall policy templates

Responses

HTTP Code Description Schema
200 API Successfully executed firewall_policy_template_response_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • firewall_policy_template

PUT operation for firewall_policy_template

PUT /firewall_policy_template

Description

Use this operation to modify the Firewall policy templates

Parameters

Type Name Schema
Body body
optional
firewall_policy_template_request_schema

Responses

HTTP Code Description Schema
200 Resource modified added firewall_policy_template_put_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Consumes

  • application/json

Produces

  • application/json

Tags

  • firewall_policy_template

DELETE operation for firewall_policy_template

DELETE /firewall_policy_template/{deletePathParam}

Description

Use this operation to delete Firewall policy templates

Parameters

Type Name Description Schema
Path deletePathParam
required
Object Primary Key for DELETE operation object

Responses

HTTP Code Description Schema
200 Resource delete added firewall_policy_template_delete_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • firewall_policy_template

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

firewall_policy_template

Name Schema
firewall_policy_template_name
optional
firewall_policy_template_name
package_name
optional
package_name
post_appliance_policies
optional
post_appliance_policies
pre_appliance_policies
optional
pre_appliance_policies

firewall_policy_template_delete_success_schema

Name Schema
firewall_policy_template
optional
firewall_policy_template

firewall_policy_template

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

firewall_policy_template_name

Firewall policy template name

Type : string

firewall_policy_template_post_success_schema

Name Schema
firewall_policy_template
optional
firewall_policy_template

firewall_policy_template

Name Description Schema
message
optional
Example : "resource added succesfully" string

firewall_policy_template_put_success_schema

Name Schema
firewall_policy_template
optional
firewall_policy_template

firewall_policy_template

Name Description Schema
message
optional
Example : "resource modified succesfully" string

firewall_policy_template_request_schema

Name Schema
firewall_policy_template
optional
firewall_policy_template

firewall_policy_template_response_schema

Type : < firewall_policy_template_response_schema > array

firewall_policy_template_response_schema

Name Schema
firewall_policy_template_name
optional
firewall_policy_template_name
package_name
optional
package_name
post_appliance_policies
optional
post_appliance_policies
pre_appliance_policies
optional
pre_appliance_policies

package_name

Config package name using which the firewall policy template API operation should be performed.

Type : string

post_appliance_policies

Post appliance policies

Type : < post_appliance_policies > array

post_appliance_policies

Name Description Schema
action
optional
The Action to take for each packet matching the Filter.
Default : "allow"
enum (allow, drop, reject, count_and_continue)
allow_fragments
optional
To allow fragmented packets matching the Filter.
Default : true
boolean
application
optional
The Application used as match criteria for this Filter. string
application_family
optional
The Application used as match criteria for this Filter. string
application_objects
optional
The Application used as match criteria for this Filter.
Default : "any"
string
destination_ip_address
optional
The Destination IP Address and Subnet Mask that the Filter will match. string
destination_port
optional
The Destination Port or Port Range that the Filter will match. integer
destination_service_name
optional
The Destination service that the filter will match
Default : "any"
string
destination_service_type
optional
The Destination Service Type that the Filter will match.
Default : "any"
enum (any, local, virtual_path, internet, intranet, gre_tunnel, lan_ipsec_tunnel, ip_host, multicast)
from_zones
optional
Select to filter on the zone the packet originated from
Default : "any"
enum (any, default_lan_zone, internet_zone, untrusted_internet_zone)
ip_dscp
optional
The time, in seconds, to wait for new packets before closing a UDP session that has not seen traffic in both directions.
Default : "ANY"
enum (ANY, DEFAULT, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef)
ip_protocol_num
optional
The IP Protocol that the Filter will match. integer
log_connection_end
optional
To generate a log when a Connection matching this Filter is deleted.
Default : false
boolean
log_connection_start
optional
To generate a log when a new Connection is created by a packet matching this Filter.
Default : false
boolean
log_interval
optional
The time, in seconds, between logging the number of packets matching the filter (0 = disabled, valid settings are 60-600). integer
match_established
optional
To match incoming packets for a Connection to which outgoing packets were allowed.
Default : false
boolean
match_type
optional
The Application used as match criteria for this Filter.
Default : "any;"
enum (ip_protocol, application, application_family, application_objects)
priority
optional
read-only
The order/precedence in which Filters are applied (automatically redistributed). integer
reverse_also
optional
Click the checkbox to automatically add a copy of this Filter with the Source and Destination settings reversed.
Default : false
boolean
source_ip_address
optional
The Source IP Address and Subnet Mask that the Filter will match. string
source_port
optional
The Source Port or Port Range that the Filter will match. integer
source_service_name
optional
The Source service that the filter will match
Default : "any"
string
source_service_type
optional
The Source Service Type that the Filter will match.
Default : "any"
enum (any, local, virtual_path, internet, intranet, gre_tunnel, lan_ipsec_tunnel, ip_host, multicast)
to_zones
optional
Select to filter on the zone the packet is destined to
Default : "any"
enum (any, default_lan_zone, internet_zone, untrusted_internet_zone)
track_connection
optional
Whether or not to enable bidirectional connection state tracking for TCP, UDP and ICMP packets matching this Filter. This feature will block flows which appear illegitimate, due to asymmetric routing or failure of checksum, protocol specific validation -- proceed with caution if NetScaler SD-WAN is not fully inline.
Default : true
boolean

pre_appliance_policies

Pre appliance policies

Type : < pre_appliance_policies > array

pre_appliance_policies

Name Description Schema
action
optional
The Action to take for each packet matching the Filter.
Default : "allow"
enum (allow, drop, reject, count_and_continue)
allow_fragments
optional
To allow fragmented packets matching the Filter.
Default : true
boolean
application
optional
The Application used as match criteria for this Filter. string
application_family
optional
The Application used as match criteria for this Filter. string
application_objects
optional
The Application used as match criteria for this Filter.
Default : "any"
string
destination_ip_address
optional
The Destination IP Address and Subnet Mask that the Filter will match. string
destination_port
optional
The Destination Port or Port Range that the Filter will match. integer
destination_service_name
optional
The Destination service that the filter will match
Default : "any"
string
destination_service_type
optional
The Destination Service Type that the Filter will match.
Default : "any"
enum (any, local, virtual_path, internet, intranet, gre_tunnel, lan_ipsec_tunnel, ip_host, multicast)
from_zones
optional
Select to filter on the zone the packet originated from
Default : "any"
enum (any, default_lan_zone, internet_zone, untrusted_internet_zone)
ip_dscp
optional
The time, in seconds, to wait for new packets before closing a UDP session that has not seen traffic in both directions.
Default : "ANY"
enum (ANY, DEFAULT, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef)
ip_protocol_num
optional
The IP Protocol that the Filter will match. integer
log_connection_end
optional
To generate a log when a Connection matching this Filter is deleted.
Default : false
boolean
log_connection_start
optional
To generate a log when a new Connection is created by a packet matching this Filter.
Default : false
boolean
log_interval
optional
The time, in seconds, between logging the number of packets matching the filter (0 = disabled, valid settings are 60-600). integer
match_established
optional
To match incoming packets for a Connection to which outgoing packets were allowed.
Default : false
boolean
match_type
optional
The Application used as match criteria for this Filter.
Default : "any;"
enum (ip_protocol, application, application_family, application_objects)
priority
optional
read-only
The order/precedence in which Filters are applied (automatically redistributed). integer
reverse_also
optional
Click the checkbox to automatically add a copy of this Filter with the Source and Destination settings reversed.
Default : false
boolean
source_ip_address
optional
The Source IP Address and Subnet Mask that the Filter will match. string
source_port
optional
The Source Port or Port Range that the Filter will match. integer
source_service_name
optional
The Source service that the filter will match
Default : "any"
string
source_service_type
optional
The Source Service Type that the Filter will match.
Default : "any"
enum (any, local, virtual_path, internet, intranet, gre_tunnel, lan_ipsec_tunnel, ip_host, multicast)
to_zones
optional
Select to filter on the zone the packet is destined to
Default : "any"
enum (any, default_lan_zone, internet_zone, untrusted_internet_zone)
track_connection
optional
Whether or not to enable bidirectional connection state tracking for TCP, UDP and ICMP packets matching this Filter. This feature will block flows which appear illegitimate, due to asymmetric routing or failure of checksum, protocol specific validation -- proceed with caution if NetScaler SD-WAN is not fully inline.
Default : true
boolean