config_editor_rules¶
Overview¶
API to add, modify, delete, and get configuration for Rules
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- config_editor_rules : Operations related to config_editor_rules
Paths¶
POST operation for config_editor_rules¶
POST /config_editor_rules
Description¶
Use this operation to add the Rules
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
config_editor_rules_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | config_editor_rules_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 |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- config_editor_rules
Get operation for config_editor_rules¶
GET /config_editor_rules
Description¶
Use this operation to get the Rules
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | config_editor_rules_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¶
- config_editor_rules
PUT operation for config_editor_rules¶
PUT /config_editor_rules
Description¶
Use this operation to modify the Rules
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | config_editor_rules_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 |
Produces¶
application/json
Tags¶
- config_editor_rules
DELETE operation for config_editor_rules¶
DELETE /config_editor_rules/{deletePathParam}
Description¶
Use this operation to delete the Rules
Parameters¶
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | deletePathParam required |
Object Primary Key for DELETE operation | object |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource delete added | config_editor_rules_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¶
- config_editor_rules
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
config_editor_rules¶
| Name | Schema |
|---|---|
| deep_packet_inspection_enable_passive_ftp_detection optional |
deep_packet_inspection_enable_passive_ftp_detection |
| id optional |
id |
| lan_to_wan_drop_general_large_packets_drop_depth optional |
lan_to_wan_drop_general_large_packets_drop_depth |
| lan_to_wan_drop_reassign_large_packets_drop_depth optional |
lan_to_wan_drop_reassign_large_packets_drop_depth |
| lan_to_wan_drop_tcp_standalone_ack_large_packets_drop_depth optional |
lan_to_wan_drop_tcp_standalone_ack_large_packets_drop_depth |
| lan_to_wan_general_class optional |
lan_to_wan_general_class |
| lan_to_wan_general_drop_depth optional |
lan_to_wan_general_drop_depth |
| lan_to_wan_general_drop_limit optional |
lan_to_wan_general_drop_limit |
| lan_to_wan_general_duplicate_packets_disable_depth optional |
lan_to_wan_general_duplicate_packets_disable_depth |
| lan_to_wan_general_duplicate_packets_disable_limit optional |
lan_to_wan_general_duplicate_packets_disable_limit |
| lan_to_wan_general_enable_red optional |
lan_to_wan_general_enable_red |
| lan_to_wan_general_large_packet_size_bytes optional |
lan_to_wan_general_large_packet_size_bytes |
| lan_to_wan_general_large_packets_drop_limit optional |
lan_to_wan_general_large_packets_drop_limit |
| lan_to_wan_reassign_class optional |
lan_to_wan_reassign_class |
| lan_to_wan_reassign_drop_depth optional |
lan_to_wan_reassign_drop_depth |
| lan_to_wan_reassign_drop_limit optional |
lan_to_wan_reassign_drop_limit |
| lan_to_wan_reassign_duplicate_packets_disable_depth optional |
lan_to_wan_reassign_duplicate_packets_disable_depth |
| lan_to_wan_reassign_duplicate_packets_disable_limit optional |
lan_to_wan_reassign_duplicate_packets_disable_limit |
| lan_to_wan_reassign_enable_red optional |
lan_to_wan_reassign_enable_red |
| lan_to_wan_reassign_large_packet_size_bytes optional |
lan_to_wan_reassign_large_packet_size_bytes |
| lan_to_wan_reassign_large_packets_drop_limit optional |
lan_to_wan_reassign_large_packets_drop_limit |
| lan_to_wan_reassign_size optional |
lan_to_wan_reassign_size |
| lan_to_wan_tcp_standalone_ack_class optional |
lan_to_wan_tcp_standalone_ack_class |
| lan_to_wan_tcp_standalone_ack_drop_depth optional |
lan_to_wan_tcp_standalone_ack_drop_depth |
| lan_to_wan_tcp_standalone_ack_drop_limit optional |
lan_to_wan_tcp_standalone_ack_drop_limit |
| lan_to_wan_tcp_standalone_ack_enable_red optional |
lan_to_wan_tcp_standalone_ack_enable_red |
| lan_to_wan_tcp_standalone_ack_large_packet_size_bytes optional |
lan_to_wan_tcp_standalone_ack_large_packet_size_bytes |
| lan_to_wan_tcp_standalone_ack_large_packets_drop_limit optional |
lan_to_wan_tcp_standalone_ack_large_packets_drop_limit |
| match_properties optional |
match_properties |
| package_name optional |
package_name |
| priority optional |
priority |
| rule_group_name optional |
rule_group_name |
| site_name optional |
site_name |
| virtual_path_name optional |
virtual_path_name |
| wan_enable_header_compression_gre optional |
wan_enable_header_compression_gre |
| wan_enable_header_compression_ip_tcp_udp optional |
wan_enable_header_compression_ip_tcp_udp |
| wan_enable_packet_aggregation optional |
wan_enable_packet_aggregation |
| wan_enable_tcp_termination optional |
wan_enable_tcp_termination |
| wan_override_service optional |
wan_override_service |
| wan_persistent_impedance optional |
wan_persistent_impedance |
| wan_preferred_wan_link optional |
wan_preferred_wan_link |
| wan_retransmit_lost_packets optional |
wan_retransmit_lost_packets |
| wan_to_lan_discard_late_resequenced_packets optional |
wan_to_lan_discard_late_resequenced_packets |
| wan_to_lan_dscp_tag optional |
wan_to_lan_dscp_tag |
| wan_to_lan_enable_packet_resequencing optional |
wan_to_lan_enable_packet_resequencing |
| wan_to_lan_resequence_hold_time optional |
wan_to_lan_resequence_hold_time |
| wan_track_performance optional |
wan_track_performance |
| wan_transmit_mode optional |
wan_transmit_mode |
config_editor_rules_delete_success_schema¶
| Name | Schema |
|---|---|
| config_editor_rules optional |
config_editor_rules |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
config_editor_rules_post_success_schema¶
| Name | Schema |
|---|---|
| config_editor_rules optional |
config_editor_rules |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
config_editor_rules_put_success_schema¶
| Name | Schema |
|---|---|
| config_editor_rules optional |
config_editor_rules |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
config_editor_rules_request_schema¶
| Name | Schema |
|---|---|
| config_editor_rules optional |
config_editor_rules |
config_editor_rules_response_schema¶
Type : < config_editor_rules_response_schema > array
config_editor_rules_response_schema
| Name | Schema |
|---|---|
| deep_packet_inspection_enable_passive_ftp_detection optional |
deep_packet_inspection_enable_passive_ftp_detection |
| id optional |
id |
| lan_to_wan_drop_general_large_packets_drop_depth optional |
lan_to_wan_drop_general_large_packets_drop_depth |
| lan_to_wan_drop_reassign_large_packets_drop_depth optional |
lan_to_wan_drop_reassign_large_packets_drop_depth |
| lan_to_wan_drop_tcp_standalone_ack_large_packets_drop_depth optional |
lan_to_wan_drop_tcp_standalone_ack_large_packets_drop_depth |
| lan_to_wan_general_class optional |
lan_to_wan_general_class |
| lan_to_wan_general_drop_depth optional |
lan_to_wan_general_drop_depth |
| lan_to_wan_general_drop_limit optional |
lan_to_wan_general_drop_limit |
| lan_to_wan_general_duplicate_packets_disable_depth optional |
lan_to_wan_general_duplicate_packets_disable_depth |
| lan_to_wan_general_duplicate_packets_disable_limit optional |
lan_to_wan_general_duplicate_packets_disable_limit |
| lan_to_wan_general_enable_red optional |
lan_to_wan_general_enable_red |
| lan_to_wan_general_large_packet_size_bytes optional |
lan_to_wan_general_large_packet_size_bytes |
| lan_to_wan_general_large_packets_drop_limit optional |
lan_to_wan_general_large_packets_drop_limit |
| lan_to_wan_reassign_class optional |
lan_to_wan_reassign_class |
| lan_to_wan_reassign_drop_depth optional |
lan_to_wan_reassign_drop_depth |
| lan_to_wan_reassign_drop_limit optional |
lan_to_wan_reassign_drop_limit |
| lan_to_wan_reassign_duplicate_packets_disable_depth optional |
lan_to_wan_reassign_duplicate_packets_disable_depth |
| lan_to_wan_reassign_duplicate_packets_disable_limit optional |
lan_to_wan_reassign_duplicate_packets_disable_limit |
| lan_to_wan_reassign_enable_red optional |
lan_to_wan_reassign_enable_red |
| lan_to_wan_reassign_large_packet_size_bytes optional |
lan_to_wan_reassign_large_packet_size_bytes |
| lan_to_wan_reassign_large_packets_drop_limit optional |
lan_to_wan_reassign_large_packets_drop_limit |
| lan_to_wan_reassign_size optional |
lan_to_wan_reassign_size |
| lan_to_wan_tcp_standalone_ack_class optional |
lan_to_wan_tcp_standalone_ack_class |
| lan_to_wan_tcp_standalone_ack_drop_depth optional |
lan_to_wan_tcp_standalone_ack_drop_depth |
| lan_to_wan_tcp_standalone_ack_drop_limit optional |
lan_to_wan_tcp_standalone_ack_drop_limit |
| lan_to_wan_tcp_standalone_ack_enable_red optional |
lan_to_wan_tcp_standalone_ack_enable_red |
| lan_to_wan_tcp_standalone_ack_large_packet_size_bytes optional |
lan_to_wan_tcp_standalone_ack_large_packet_size_bytes |
| lan_to_wan_tcp_standalone_ack_large_packets_drop_limit optional |
lan_to_wan_tcp_standalone_ack_large_packets_drop_limit |
| match_properties optional |
match_properties |
| package_name optional |
package_name |
| priority optional |
priority |
| rule_group_name optional |
rule_group_name |
| site_name optional |
site_name |
| virtual_path_name optional |
virtual_path_name |
| wan_enable_header_compression_gre optional |
wan_enable_header_compression_gre |
| wan_enable_header_compression_ip_tcp_udp optional |
wan_enable_header_compression_ip_tcp_udp |
| wan_enable_packet_aggregation optional |
wan_enable_packet_aggregation |
| wan_enable_tcp_termination optional |
wan_enable_tcp_termination |
| wan_override_service optional |
wan_override_service |
| wan_persistent_impedance optional |
wan_persistent_impedance |
| wan_preferred_wan_link optional |
wan_preferred_wan_link |
| wan_retransmit_lost_packets optional |
wan_retransmit_lost_packets |
| wan_to_lan_discard_late_resequenced_packets optional |
wan_to_lan_discard_late_resequenced_packets |
| wan_to_lan_dscp_tag optional |
wan_to_lan_dscp_tag |
| wan_to_lan_enable_packet_resequencing optional |
wan_to_lan_enable_packet_resequencing |
| wan_to_lan_resequence_hold_time optional |
wan_to_lan_resequence_hold_time |
| wan_track_performance optional |
wan_track_performance |
| wan_transmit_mode optional |
wan_transmit_mode |
deep_packet_inspection_enable_passive_ftp_detection¶
If enabled, processing decisions will be based upon user data. The rule will learn the port used for the FTP data transfer and apply the rule properties to the learned port
Type : boolean
id¶
Id of rule
Type : integer
lan_to_wan_drop_general_large_packets_drop_depth¶
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted.
Type : integer
lan_to_wan_drop_reassign_large_packets_drop_depth¶
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted.
Type : integer
lan_to_wan_drop_tcp_standalone_ack_large_packets_drop_depth¶
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted.
Type : integer
lan_to_wan_general_class¶
The Class that is to service traffic flows that match this application. The default is Class 9
Type : integer
lan_to_wan_general_drop_depth¶
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted (value is in bytes)
Type : integer
lan_to_wan_general_drop_limit¶
The maximum amount of estimated time that packets will have to wait in the class scheduler. If the estimated time exceeds this threshold, the packet will be discarded and statistics will be counted. Not valid for Bulk classes (Value is in ms)
Type : integer
lan_to_wan_general_duplicate_packets_disable_depth¶
The queue depth of the class scheduler at which point duplicate packets will not be generated (value is in bytes)
Type : integer
lan_to_wan_general_duplicate_packets_disable_limit¶
The amount of time a packet may wait in the queue before duplication is not performed, which prevents duplicate packets from consuming bandwidth when bandwidth is limited (value is in ms)
Type : integer
lan_to_wan_general_enable_red¶
If enabled, Random Early Detection (RED) will discard packets uniformly when congestion is detected.
Type : boolean
lan_to_wan_general_large_packet_size_bytes¶
Packets destined for this class which are larger than or equal to this size will follow large packet drop policy. Packets which are smaller than this size will follow small packet drop policy. If this size is set to 0, all packets will be treated as small packets.
Type : integer
lan_to_wan_general_large_packets_drop_limit¶
The maximum amount of estimated time that packets larger than or equal to the Large Packet Size will have to wait in the class scheduler. If the estimated time exceeds this threshold, the packet will be discarded and statistics will be counted. Not valid for Bulk classes.
Type : integer
lan_to_wan_reassign_class¶
The Class to which flows will be reassigned if the size specified is exceeded. If the default option is selected, packets will not be assigned to an alternate class based on packet size, and will continue to be mapped to the class specified in the General section.
Type : integer
lan_to_wan_reassign_drop_depth¶
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted
Type : integer
lan_to_wan_reassign_drop_limit¶
If the estimated time exceeds this threshold, the packet will be discarded and statistics will be counted. Not valid for Bulk classes.
Type : integer
lan_to_wan_reassign_duplicate_packets_disable_depth¶
The queue depth of the class scheduler at which point duplicate packets will not be generated (value is in bytes)
Type : integer
lan_to_wan_reassign_duplicate_packets_disable_limit¶
Designates the amount of time a packet may wait in the queue before duplication is not performed, which prevents duplicate packets from consuming bandwidth when bandwidth is limited.
Type : integer
lan_to_wan_reassign_enable_red¶
If enabled, Random Early Detection (RED) will discard packets uniformly when congestion is detected.
Type : boolean
lan_to_wan_reassign_large_packet_size_bytes¶
Packets destined for this class which are larger than or equal to this size will follow large packet drop policy. Packets which are smaller than this size will follow small packet drop policy. If this size is set to 0, all packets will be treated as small packets.
Type : integer
lan_to_wan_reassign_large_packets_drop_limit¶
If the estimated time exceeds this threshold, the packet will be discarded and statistics will be counted. Not valid for Bulk classes.
Type : integer
lan_to_wan_reassign_size¶
After a flow is established, if a packet that exceeds this size is detected on the LAN to WAN, then the flow will be moved to the class indicated
Type : integer
lan_to_wan_tcp_standalone_ack_class¶
The Class that will be used for standalone TCP ACKs. This has no effect on packets that are piggyback ACKs with payload. If the default option is selected, TCP Standalone ACKs will continue to be mapped to the class specified in the General section.
Type : integer
lan_to_wan_tcp_standalone_ack_drop_depth¶
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted
Type : integer
lan_to_wan_tcp_standalone_ack_drop_limit¶
If the estimated time exceeds this threshold, the packet will be discarded and statistics will be counted. Not valid for Bulk classes.
Type : integer
lan_to_wan_tcp_standalone_ack_enable_red¶
If enabled, Random Early Detection (RED) will discard packets uniformly when congestion is detected.
Type : boolean
lan_to_wan_tcp_standalone_ack_large_packet_size_bytes¶
Packets destined for this class which are larger than or equal to this size will follow large packet drop policy. Packets which are smaller than this size will follow small packet drop policy. If this size is set to 0, all packets will be treated as small packets.
Type : integer
lan_to_wan_tcp_standalone_ack_large_packets_drop_limit¶
If the estimated time exceeds this threshold, the packet will be discarded and statistics will be counted. Not valid for Bulk classes.
Type : integer
match_properties¶
Rule match properties
| Name | Description | Schema |
|---|---|---|
| destination_ip_address optional |
The Destination IP Address and subnet mask that this rule will match. Give IP Address with subnet | string |
| destination_port optional |
If set, the Destination Port or Port range (eg: 2345-2457) that this rule will match. | string |
| dscp optional |
The DSCP tag in the IP header that this rule will match. Default : "any" |
enum (any, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, default, ef) |
| protocol optional |
The Protocol Name that this filter will match. Default : "ANY" |
enum (FTP, SMTP, POP3, IMAP, HTTP, TELNET, ICMP, HTTPS, ALTHTTP, SSH, DNS, NTP, SNMP, SNMPTRAP, RPC, RDP, IPSEC, SIP, ICACGPUDP, ICAUDP, ICACGP, ICA, IPERF, CIFS, LDAP, NETBIOS, RTP, RTCP, DHCP, NFS, GRE, TCP, UDP, Number, ANY) |
| protocol_num optional |
The Protocol Number that this filter will match. | integer |
| rebind_flow_on_change optional |
If enabled, flows which are otherwise identical in terms of match criteria will be treated as separate if their DSCP fields differ. | boolean |
| routing_domain optional |
routing domain | string |
| source_ip_address optional |
The Source IP Address and subnet mask that this rule will match. Give IP Address with subnet | string |
| source_port optional |
If set, the Source or Destination Port or Port range (eg: 2345-2457) that this rule will match. | string |
| vlan_id optional |
The Ethernet VLAN tag that this rule will match. | integer |
package_name¶
Package name to add rule to
Type : string
priority¶
The order/precedence in which Rules are applied (automatically redistributed)
Type : integer
rule_group_name¶
A name given to a rule that will allow rule statistics to be summed in groups when they are displayed. All rule statistics for rules with the same Rule Group Name can be viewed together.
Type : string
site_name¶
Site name to which the rule belongs
Type : string
virtual_path_name¶
virtual path name to which the rule belongs to
Type : string
wan_enable_header_compression_gre¶
If enabled, header compression will be used for GRE packets
Type : boolean
wan_enable_header_compression_ip_tcp_udp¶
If enabled, header compression will be used for IP, TCP and UDP packets
Type : boolean
wan_enable_packet_aggregation¶
If enabled, small packets on this flow will be aggregated together into larger packets
Type : boolean
wan_enable_tcp_termination¶
Traffic for this flow will be TCP terminated locally to improve throughput, reducing the round-trip times for acknowledgement packets. If enabled, TCP Termination feature will be used on flows matching this rule. The default is off.
Type : string
wan_override_service¶
The destination service that flows should go to
Type : string
wan_persistent_impedance¶
Use the same path until wait time on the path is longer than the configured value
Type : integer
wan_preferred_wan_link¶
The WAN link that flows should use first
Type : boolean
wan_retransmit_lost_packets¶
If enabled, flows matching this rule will be sent using reliable service to the remote appliance and any packets lost will be retransmitted
Type : boolean
wan_to_lan_discard_late_resequenced_packets¶
After a packets sequence timer has expired for a dependent packet, and the packets were permitted to the LAN: If a late packet arrives at WAN to LAN, this property defines what is to be done with it. Enable this to discard, disable this to forward.
Type : boolean
wan_to_lan_dscp_tag¶
The DSCP tag that will be applied to packets that match this rule on WAN to LAN, before they are sent to the LAN
Type : string
wan_to_lan_enable_packet_resequencing¶
If enabled, traffic flows that match this application should be tagged for sequence order, and the packets should be reordered (if necessary) at the WAN to LAN appliance.
Type : boolean
wan_to_lan_resequence_hold_time¶
The maximum delay that a packet may be held awaiting re-sequence. When the timer expires the packet will be sent to the LAN without waiting any further for the pre-requisite sequence numbers (value is in ms)
Type : integer
wan_track_performance¶
If enabled, performance of a rule over time will be recorded in a session DB, including loss, latency, jitter and bandwidth used.
Type : integer
wan_transmit_mode¶
The method of transmitting and receiving packets
Type : enum (persistent_path, load_balanced_paths, duplicate_paths, override_service)