config_editor_rules
config_editor_rules
Configuration Editor for API to add, modify, delete, and get configuration for Rules resource.
Read/write properties
lan_2_wan_general_duplicate_packets_disable_depth <Integer>
The queue depth of the class scheduler at which point duplicate packets will not be generated (value is in bytes).
lan_2_wan_reassign_duplicate_packets_disable_depth <Integer>
The queue depth of the class scheduler at which point duplicate packets will not be generated (value is in bytes).
lan_2_wan_drop_tcp_standalone_ack_large_packets_drop_depth <Integer>
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted..
lan_2_wan_drop_general_large_packets_drop_depth <Integer>
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted..
lan_2_wan_general_duplicate_packets_disable_limit <Integer>
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).
lan_2_wan_reassign_large_packets_drop_limit <Integer>
If the estimated time exceeds this threshold, the packet will be discarded and statistics will be counted. Not valid for Bulk classes..
lan_2_wan_general_class <Integer>
The Class that is to service traffic flows that match this application. The default is Class 9.
wan_enable_packet_aggregation <Boolean>
If enabled, small packets on this flow will be aggregated together into larger packets.
wan_2_lan_enable_packet_resequencing <Boolean>
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..
lan_2_wan_tcp_standalone_ack_large_packets_drop_limit <Integer>
If the estimated time exceeds this threshold, the packet will be discarded and statistics will be counted. Not valid for Bulk classes..
lan_2_wan_general_large_packet_size_bytes <Integer>
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..
lan_2_wan_tcp_standalone_ack_drop_limit <Integer>
If the estimated time exceeds this threshold, the packet will be discarded and statistics will be counted. Not valid for Bulk classes..
deep_packet_inspection_enable_passive_ftp_detection <Boolean>
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.
id <Integer>
Id of rule.
rule_group_name <String>
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.. Possible values = [FTP,SMTP,POP3,IMAP,HTTP,TELNET,ICMP,HTTPS,ALTHTTP,SSH,DNS,SNMP,NTP,SNMPTRAP,RDP,IPSEC,RPC,SIP,ICACGPPUDP,ICAUDP,ICACGP,ICA,IPERF,CIFS,LDAP,NETBIOS,GRE,TCP,UDP,Number,RTP,RTCP,DHCP,NFS]
wan_transmit_mode <String>
The method of transmitting and receiving packets. Possible values = [persistent_path,load_balanced_paths,duplicate_paths,override_service]
wan_2_lan_resequence_hold_time <Integer>
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).
lan_2_wan_reassign_class <Integer>
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..
lan_2_wan_general_drop_depth <Integer>
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted (value is in bytes).
lan_2_wan_general_drop_limit <Integer>
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).
wan_enable_header_compression_gre <Boolean>
If enabled, header compression will be used for GRE packets.
wan_2_lan_discard_late_resequenced_packets <Boolean>
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..
wan_override_service <String>
The destination service that flows should go to.
lan_2_wan_tcp_standalone_ack_large_packet_size_bytes <Integer>
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..
lan_2_wan_drop_reassign_large_packets_drop_depth <Integer>
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted..
wan_preferred_wan_link <Boolean>
The WAN link that flows should use first.
lan_2_wan_reassign_drop_depth <Integer>
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted.
lan_2_wan_reassign_large_packet_size_bytes <Integer>
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..
wan_enable_tcp_termination <String>
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..
wan_enable_header_compression_ip_tcp_udp <Boolean>
If enabled, header compression will be used for IP, TCP and UDP packets.
lan_2_wan_general_enable_red <Boolean>
If enabled, Random Early Detection (RED) will discard packets uniformly when congestion is detected..
virtual_path_name <String>
virtual path name to which the rule belongs to.
lan_2_wan_general_large_packets_drop_limit <Integer>
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..
wan_2_lan_dscp_tag <String>
The DSCP tag that will be applied to packets that match this rule on WAN to LAN, before they are sent to the LAN.
wan_persistent_impedance <Integer>
Use the same path until wait time on the path is longer than the configured value.
lan_2_wan_reassign_enable_red <Boolean>
If enabled, Random Early Detection (RED) will discard packets uniformly when congestion is detected..
site_name <String>
Site name to which the rule belongs.
lan_2_wan_tcp_standalone_ack_drop_depth <Integer>
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted.
wan_track_performance <Integer>
If enabled, performance of a rule over time will be recorded in a session DB, including loss, latency, jitter and bandwidth used..
lan_2_wan_reassign_drop_limit <Integer>
If the estimated time exceeds this threshold, the packet will be discarded and statistics will be counted. Not valid for Bulk classes..
lan_2_wan_reassign_size <Integer>
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.
package_name <String>
Package name to add rule to.
wan_retransmit_lost_packets <Boolean>
If enabled, flows matching this rule will be sent using reliable service to the remote appliance and any packets lost will be retransmitted.
lan_2_wan_reassign_duplicate_packets_disable_limit <Integer>
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..
lan_2_wan_tcp_standalone_ack_enable_red <Boolean>
If enabled, Random Early Detection (RED) will discard packets uniformly when congestion is detected..
lan_2_wan_tcp_standalone_ack_class <Integer>
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..
Read only properties
priority <Integer>
The order/precedence in which Rules are applied (automatically redistributed).
Operations
[add]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/config_editor_rules
Description: Use this operation to add the Rules
HTTP Method: POST
Request Payload: JSON
{"config_editor_rules": { "lan_2_wan_general_duplicate_packets_disable_depth":<Integer_value> , "lan_2_wan_reassign_duplicate_packets_disable_depth":<Integer_value> , "lan_2_wan_drop_tcp_standalone_ack_large_packets_drop_depth":<Integer_value> , "lan_2_wan_drop_general_large_packets_drop_depth":<Integer_value> , "lan_2_wan_general_duplicate_packets_disable_limit":<Integer_value> , "lan_2_wan_reassign_large_packets_drop_limit":<Integer_value> , "lan_2_wan_general_class":<Integer_value> , "wan_enable_packet_aggregation":<Boolean_value> , "wan_2_lan_enable_packet_resequencing":<Boolean_value> , "lan_2_wan_tcp_standalone_ack_large_packets_drop_limit":<Integer_value> , "lan_2_wan_general_large_packet_size_bytes":<Integer_value> , "lan_2_wan_tcp_standalone_ack_drop_limit":<Integer_value> , "deep_packet_inspection_enable_passive_ftp_detection":<Boolean_value> , "id":<Integer_value> , "rule_group_name":<String_value> , "wan_transmit_mode":<String_value> , "wan_2_lan_resequence_hold_time":<Integer_value> , "lan_2_wan_reassign_class":<Integer_value> , "lan_2_wan_general_drop_depth":<Integer_value> , "lan_2_wan_general_drop_limit":<Integer_value> , "wan_enable_header_compression_gre":<Boolean_value> , "wan_2_lan_discard_late_resequenced_packets":<Boolean_value> , "wan_override_service":<String_value> , "lan_2_wan_tcp_standalone_ack_large_packet_size_bytes":<Integer_value> , "lan_2_wan_drop_reassign_large_packets_drop_depth":<Integer_value> , "wan_preferred_wan_link":<Boolean_value> , "lan_2_wan_reassign_drop_depth":<Integer_value> , "lan_2_wan_reassign_large_packet_size_bytes":<Integer_value> , "wan_enable_tcp_termination":<String_value> , "wan_enable_header_compression_ip_tcp_udp":<Boolean_value> , "lan_2_wan_general_enable_red":<Boolean_value> , "virtual_path_name":<String_value> , "lan_2_wan_general_large_packets_drop_limit":<Integer_value> , "wan_2_lan_dscp_tag":<String_value> , "wan_persistent_impedance":<Integer_value> , "lan_2_wan_reassign_enable_red":<Boolean_value> , "site_name":<String_value> , "lan_2_wan_tcp_standalone_ack_drop_depth":<Integer_value> , "wan_track_performance":<Integer_value> , "lan_2_wan_reassign_drop_limit":<Integer_value> , "lan_2_wan_reassign_size":<Integer_value> , "package_name":<String_value> , "wan_retransmit_lost_packets":<Boolean_value> , "lan_2_wan_reassign_duplicate_packets_disable_limit":<Integer_value> , "lan_2_wan_tcp_standalone_ack_enable_red":<Boolean_value> , "lan_2_wan_tcp_standalone_ack_class":<Integer_value> }}
Response Payload: JSON
{ "config_editor_rules":{ "priority":<Integer_value>
, "lan_2_wan_general_duplicate_packets_disable_depth":<Integer_value> , "lan_2_wan_reassign_duplicate_packets_disable_depth":<Integer_value> , "lan_2_wan_drop_tcp_standalone_ack_large_packets_drop_depth":<Integer_value> , "lan_2_wan_drop_general_large_packets_drop_depth":<Integer_value> , "lan_2_wan_general_duplicate_packets_disable_limit":<Integer_value> , "lan_2_wan_reassign_large_packets_drop_limit":<Integer_value> , "lan_2_wan_general_class":<Integer_value> , "wan_enable_packet_aggregation":<Boolean_value> , "wan_2_lan_enable_packet_resequencing":<Boolean_value> , "lan_2_wan_tcp_standalone_ack_large_packets_drop_limit":<Integer_value> , "lan_2_wan_general_large_packet_size_bytes":<Integer_value> , "lan_2_wan_tcp_standalone_ack_drop_limit":<Integer_value> , "deep_packet_inspection_enable_passive_ftp_detection":<Boolean_value> , "id":<Integer_value> , "rule_group_name":<String_value> , "wan_transmit_mode":<String_value> , "wan_2_lan_resequence_hold_time":<Integer_value> , "lan_2_wan_reassign_class":<Integer_value> , "lan_2_wan_general_drop_depth":<Integer_value> , "lan_2_wan_general_drop_limit":<Integer_value> , "wan_enable_header_compression_gre":<Boolean_value> , "wan_2_lan_discard_late_resequenced_packets":<Boolean_value> , "wan_override_service":<String_value> , "lan_2_wan_tcp_standalone_ack_large_packet_size_bytes":<Integer_value> , "lan_2_wan_drop_reassign_large_packets_drop_depth":<Integer_value> , "wan_preferred_wan_link":<Boolean_value> , "lan_2_wan_reassign_drop_depth":<Integer_value> , "lan_2_wan_reassign_large_packet_size_bytes":<Integer_value> , "wan_enable_tcp_termination":<String_value> , "wan_enable_header_compression_ip_tcp_udp":<Boolean_value> , "lan_2_wan_general_enable_red":<Boolean_value> , "virtual_path_name":<String_value> , "lan_2_wan_general_large_packets_drop_limit":<Integer_value> , "wan_2_lan_dscp_tag":<String_value> , "wan_persistent_impedance":<Integer_value> , "lan_2_wan_reassign_enable_red":<Boolean_value> , "site_name":<String_value> , "lan_2_wan_tcp_standalone_ack_drop_depth":<Integer_value> , "wan_track_performance":<Integer_value> , "lan_2_wan_reassign_drop_limit":<Integer_value> , "lan_2_wan_reassign_size":<Integer_value> , "package_name":<String_value> , "wan_retransmit_lost_packets":<Boolean_value> , "lan_2_wan_reassign_duplicate_packets_disable_limit":<Integer_value> , "lan_2_wan_tcp_standalone_ack_enable_red":<Boolean_value> , "lan_2_wan_tcp_standalone_ack_class":<Integer_value> }]}
[delete]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/config_editor_rules/
Description: Use this operation to delete the Rules
HTTP Method: DELETE
Response Payload: JSON
{ "errorcode": 0, "message": "Done", "severity": <String;_value> }
[get (all)]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/config_editor_rules/package_name=<package_name>
Description: Use this operation to get the Rules
HTTP Method: GET
Response Payload: JSON
{"config_editor_rules":[{ "priority":<Integer_value>
, "lan_2_wan_general_duplicate_packets_disable_depth":<Integer_value> , "lan_2_wan_reassign_duplicate_packets_disable_depth":<Integer_value> , "lan_2_wan_drop_tcp_standalone_ack_large_packets_drop_depth":<Integer_value> , "lan_2_wan_drop_general_large_packets_drop_depth":<Integer_value> , "lan_2_wan_general_duplicate_packets_disable_limit":<Integer_value> , "lan_2_wan_reassign_large_packets_drop_limit":<Integer_value> , "lan_2_wan_general_class":<Integer_value> , "wan_enable_packet_aggregation":<Boolean_value> , "wan_2_lan_enable_packet_resequencing":<Boolean_value> , "lan_2_wan_tcp_standalone_ack_large_packets_drop_limit":<Integer_value> , "lan_2_wan_general_large_packet_size_bytes":<Integer_value> , "lan_2_wan_tcp_standalone_ack_drop_limit":<Integer_value> , "deep_packet_inspection_enable_passive_ftp_detection":<Boolean_value> , "id":<Integer_value> , "rule_group_name":<String_value> , "wan_transmit_mode":<String_value> , "wan_2_lan_resequence_hold_time":<Integer_value> , "lan_2_wan_reassign_class":<Integer_value> , "lan_2_wan_general_drop_depth":<Integer_value> , "lan_2_wan_general_drop_limit":<Integer_value> , "wan_enable_header_compression_gre":<Boolean_value> , "wan_2_lan_discard_late_resequenced_packets":<Boolean_value> , "wan_override_service":<String_value> , "lan_2_wan_tcp_standalone_ack_large_packet_size_bytes":<Integer_value> , "lan_2_wan_drop_reassign_large_packets_drop_depth":<Integer_value> , "wan_preferred_wan_link":<Boolean_value> , "lan_2_wan_reassign_drop_depth":<Integer_value> , "lan_2_wan_reassign_large_packet_size_bytes":<Integer_value> , "wan_enable_tcp_termination":<String_value> , "wan_enable_header_compression_ip_tcp_udp":<Boolean_value> , "lan_2_wan_general_enable_red":<Boolean_value> , "virtual_path_name":<String_value> , "lan_2_wan_general_large_packets_drop_limit":<Integer_value> , "wan_2_lan_dscp_tag":<String_value> , "wan_persistent_impedance":<Integer_value> , "lan_2_wan_reassign_enable_red":<Boolean_value> , "site_name":<String_value> , "lan_2_wan_tcp_standalone_ack_drop_depth":<Integer_value> , "wan_track_performance":<Integer_value> , "lan_2_wan_reassign_drop_limit":<Integer_value> , "lan_2_wan_reassign_size":<Integer_value> , "package_name":<String_value> , "wan_retransmit_lost_packets":<Boolean_value> , "lan_2_wan_reassign_duplicate_packets_disable_limit":<Integer_value> , "lan_2_wan_tcp_standalone_ack_enable_red":<Boolean_value> , "lan_2_wan_tcp_standalone_ack_class":<Integer_value> }]}
[modify]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/config_editor_rules
Description: Use this operation to modify the Rules
HTTP Method: PUT
Request Payload: JSON
{"config_editor_rules":{ "lan_2_wan_general_duplicate_packets_disable_depth":<Integer_value> , "lan_2_wan_reassign_duplicate_packets_disable_depth":<Integer_value> , "lan_2_wan_drop_tcp_standalone_ack_large_packets_drop_depth":<Integer_value> , "lan_2_wan_drop_general_large_packets_drop_depth":<Integer_value> , "lan_2_wan_general_duplicate_packets_disable_limit":<Integer_value> , "lan_2_wan_reassign_large_packets_drop_limit":<Integer_value> , "lan_2_wan_general_class":<Integer_value> , "wan_enable_packet_aggregation":<Boolean_value> , "wan_2_lan_enable_packet_resequencing":<Boolean_value> , "lan_2_wan_tcp_standalone_ack_large_packets_drop_limit":<Integer_value> , "lan_2_wan_general_large_packet_size_bytes":<Integer_value> , "lan_2_wan_tcp_standalone_ack_drop_limit":<Integer_value> , "deep_packet_inspection_enable_passive_ftp_detection":<Boolean_value> , "id":<Integer_value> , "rule_group_name":<String_value> , "wan_transmit_mode":<String_value> , "wan_2_lan_resequence_hold_time":<Integer_value> , "lan_2_wan_reassign_class":<Integer_value> , "lan_2_wan_general_drop_depth":<Integer_value> , "lan_2_wan_general_drop_limit":<Integer_value> , "wan_enable_header_compression_gre":<Boolean_value> , "wan_2_lan_discard_late_resequenced_packets":<Boolean_value> , "wan_override_service":<String_value> , "lan_2_wan_tcp_standalone_ack_large_packet_size_bytes":<Integer_value> , "lan_2_wan_drop_reassign_large_packets_drop_depth":<Integer_value> , "wan_preferred_wan_link":<Boolean_value> , "lan_2_wan_reassign_drop_depth":<Integer_value> , "lan_2_wan_reassign_large_packet_size_bytes":<Integer_value> , "wan_enable_tcp_termination":<String_value> , "wan_enable_header_compression_ip_tcp_udp":<Boolean_value> , "lan_2_wan_general_enable_red":<Boolean_value> , "virtual_path_name":<String_value> , "lan_2_wan_general_large_packets_drop_limit":<Integer_value> , "wan_2_lan_dscp_tag":<String_value> , "wan_persistent_impedance":<Integer_value> , "lan_2_wan_reassign_enable_red":<Boolean_value> , "site_name":<String_value> , "lan_2_wan_tcp_standalone_ack_drop_depth":<Integer_value> , "wan_track_performance":<Integer_value> , "lan_2_wan_reassign_drop_limit":<Integer_value> , "lan_2_wan_reassign_size":<Integer_value> , "package_name":<String_value> , "wan_retransmit_lost_packets":<Boolean_value> , "lan_2_wan_reassign_duplicate_packets_disable_limit":<Integer_value> , "lan_2_wan_tcp_standalone_ack_enable_red":<Boolean_value> , "lan_2_wan_tcp_standalone_ack_class":<Integer_value> }}
Response Payload: JSON
{ "config_editor_rules":[{ "priority":<Integer_value>
, "lan_2_wan_general_duplicate_packets_disable_depth":<Integer_value> , "lan_2_wan_reassign_duplicate_packets_disable_depth":<Integer_value> , "lan_2_wan_drop_tcp_standalone_ack_large_packets_drop_depth":<Integer_value> , "lan_2_wan_drop_general_large_packets_drop_depth":<Integer_value> , "lan_2_wan_general_duplicate_packets_disable_limit":<Integer_value> , "lan_2_wan_reassign_large_packets_drop_limit":<Integer_value> , "lan_2_wan_general_class":<Integer_value> , "wan_enable_packet_aggregation":<Boolean_value> , "wan_2_lan_enable_packet_resequencing":<Boolean_value> , "lan_2_wan_tcp_standalone_ack_large_packets_drop_limit":<Integer_value> , "lan_2_wan_general_large_packet_size_bytes":<Integer_value> , "lan_2_wan_tcp_standalone_ack_drop_limit":<Integer_value> , "deep_packet_inspection_enable_passive_ftp_detection":<Boolean_value> , "id":<Integer_value> , "rule_group_name":<String_value> , "wan_transmit_mode":<String_value> , "wan_2_lan_resequence_hold_time":<Integer_value> , "lan_2_wan_reassign_class":<Integer_value> , "lan_2_wan_general_drop_depth":<Integer_value> , "lan_2_wan_general_drop_limit":<Integer_value> , "wan_enable_header_compression_gre":<Boolean_value> , "wan_2_lan_discard_late_resequenced_packets":<Boolean_value> , "wan_override_service":<String_value> , "lan_2_wan_tcp_standalone_ack_large_packet_size_bytes":<Integer_value> , "lan_2_wan_drop_reassign_large_packets_drop_depth":<Integer_value> , "wan_preferred_wan_link":<Boolean_value> , "lan_2_wan_reassign_drop_depth":<Integer_value> , "lan_2_wan_reassign_large_packet_size_bytes":<Integer_value> , "wan_enable_tcp_termination":<String_value> , "wan_enable_header_compression_ip_tcp_udp":<Boolean_value> , "lan_2_wan_general_enable_red":<Boolean_value> , "virtual_path_name":<String_value> , "lan_2_wan_general_large_packets_drop_limit":<Integer_value> , "wan_2_lan_dscp_tag":<String_value> , "wan_persistent_impedance":<Integer_value> , "lan_2_wan_reassign_enable_red":<Boolean_value> , "site_name":<String_value> , "lan_2_wan_tcp_standalone_ack_drop_depth":<Integer_value> , "wan_track_performance":<Integer_value> , "lan_2_wan_reassign_drop_limit":<Integer_value> , "lan_2_wan_reassign_size":<Integer_value> , "package_name":<String_value> , "wan_retransmit_lost_packets":<Boolean_value> , "lan_2_wan_reassign_duplicate_packets_disable_limit":<Integer_value> , "lan_2_wan_tcp_standalone_ack_enable_red":<Boolean_value> , "lan_2_wan_tcp_standalone_ack_class":<Integer_value> }]}