application_qos
application_qos
Configuration Editor for API to add, modify, delete, and get configuration for Application QoS resource.
Read/write properties
match_type <String>
The mechanism through which this application will be matched (Either a user-defined application, pre-defined applications or groupings of applications). Possible values = [application_object,application,application_family]
destination_port <String>
If set, the Destination Port or Port range (eg: 2345-2457) that this rule will match.
application_objects <String>
The Application Object is a user-defined application, as specified in the Global - Applications section of this configuration..
source_port <String>
If set, the Source Port or Port range (eg: 2345-2457) that this rule will match.
virtual_path_name <String>
virtual path name to which the application qos belongs to.
retransmit_lost_packets <Boolean>
If enabled, flows matching this application will be sent using reliable service to the remote appliance and any packets lost will be retransmitted.
destination_ip_address <String>
The Destination IP Address and subnet mask that this rule will match.
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_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).
lan_2_wan_class <Integer>
The Class that is to service traffic flows that match this application. The default is Class 9.
is_auto <Boolean>
If set to true, it is a default Application QoS.
transmit_mode <String>
The method of transmitting and receiving packets. Possible values = [load_balance_paths,persistent_path,duplicate_paths]
id <Integer>
Object id for application qos.
lan_2_wan_drop_depth <Integer>
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted (value is in bytes).
site_name <String>
Site name to which the application qos belongs.
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).
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).
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.
application_family <String>
The Application Family Object is a user-defined application family.
source_ip_address <String>
The Source IP Address and subnet mask that this application will match.
persistent_impedance <Integer>
Use the same path until wait time on the path is longer than the configured value.
package_name <String>
Package name to add application qos to.
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).
preferred_wan_link <String>
The WAN link that flows should use first.
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 checkbox to discard, disable this checkbox to forward..
lan_2_wan_enable_red <Boolean>
If enabled, Random Early Detection (RED) will discard packets uniformly when congestion is detected..
Read only properties
priority <Integer>
Order of evaluation of the application rule.
Operations
[add]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/application_qos
Description: Use this operation to add the Application QoS
HTTP Method: POST
Request Payload: JSON
{"application_qos": { "match_type":<String_value> , "destination_port":<String_value> , "application_objects":<String_value> , "source_port":<String_value> , "virtual_path_name":<String_value> , "retransmit_lost_packets":<Boolean_value> , "destination_ip_address":<String_value> , "wan_2_lan_enable_packet_resequencing":<Boolean_value> , "lan_2_wan_drop_limit":<Integer_value> , "lan_2_wan_class":<Integer_value> , "is_auto":<Boolean_value> , "transmit_mode":<String_value> , "id":<Integer_value> , "lan_2_wan_drop_depth":<Integer_value> , "site_name":<String_value> , "wan_2_lan_resequence_hold_time":<Integer_value> , "duplicate_packets_disable_depth":<Integer_value> , "dscp_tag":<String_value> , "application_family":<String_value> , "source_ip_address":<String_value> , "persistent_impedance":<Integer_value> , "package_name":<String_value> , "duplicate_packets_disable_limit":<Integer_value> , "preferred_wan_link":<String_value> , "wan_2_lan_discard_late_resequenced_packets":<Boolean_value> , "lan_2_wan_enable_red":<Boolean_value> }}
Response Payload: JSON
{ "application_qos":{ "priority":<Integer_value>
, "match_type":<String_value> , "destination_port":<String_value> , "application_objects":<String_value> , "source_port":<String_value> , "virtual_path_name":<String_value> , "retransmit_lost_packets":<Boolean_value> , "destination_ip_address":<String_value> , "wan_2_lan_enable_packet_resequencing":<Boolean_value> , "lan_2_wan_drop_limit":<Integer_value> , "lan_2_wan_class":<Integer_value> , "is_auto":<Boolean_value> , "transmit_mode":<String_value> , "id":<Integer_value> , "lan_2_wan_drop_depth":<Integer_value> , "site_name":<String_value> , "wan_2_lan_resequence_hold_time":<Integer_value> , "duplicate_packets_disable_depth":<Integer_value> , "dscp_tag":<String_value> , "application_family":<String_value> , "source_ip_address":<String_value> , "persistent_impedance":<Integer_value> , "package_name":<String_value> , "duplicate_packets_disable_limit":<Integer_value> , "preferred_wan_link":<String_value> , "wan_2_lan_discard_late_resequenced_packets":<Boolean_value> , "lan_2_wan_enable_red":<Boolean_value> }]}
[delete]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/application_qos/
Description: Use this operation to delete the Application QoS
HTTP Method: DELETE
Response Payload: JSON
{ "errorcode": 0, "message": "Done", "severity": <String;_value> }
[get (all)]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/application_qos/package_name=<package_name>
Description: Use this operation to get the Application QoS settings
HTTP Method: GET
Response Payload: JSON
{"application_qos":[{ "priority":<Integer_value>
, "match_type":<String_value> , "destination_port":<String_value> , "application_objects":<String_value> , "source_port":<String_value> , "virtual_path_name":<String_value> , "retransmit_lost_packets":<Boolean_value> , "destination_ip_address":<String_value> , "wan_2_lan_enable_packet_resequencing":<Boolean_value> , "lan_2_wan_drop_limit":<Integer_value> , "lan_2_wan_class":<Integer_value> , "is_auto":<Boolean_value> , "transmit_mode":<String_value> , "id":<Integer_value> , "lan_2_wan_drop_depth":<Integer_value> , "site_name":<String_value> , "wan_2_lan_resequence_hold_time":<Integer_value> , "duplicate_packets_disable_depth":<Integer_value> , "dscp_tag":<String_value> , "application_family":<String_value> , "source_ip_address":<String_value> , "persistent_impedance":<Integer_value> , "package_name":<String_value> , "duplicate_packets_disable_limit":<Integer_value> , "preferred_wan_link":<String_value> , "wan_2_lan_discard_late_resequenced_packets":<Boolean_value> , "lan_2_wan_enable_red":<Boolean_value> }]}
[modify]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/application_qos
Description: Use this operation to modify the Application QoS
HTTP Method: PUT
Request Payload: JSON
{"application_qos":{ "match_type":<String_value> , "destination_port":<String_value> , "application_objects":<String_value> , "source_port":<String_value> , "virtual_path_name":<String_value> , "retransmit_lost_packets":<Boolean_value> , "destination_ip_address":<String_value> , "wan_2_lan_enable_packet_resequencing":<Boolean_value> , "lan_2_wan_drop_limit":<Integer_value> , "lan_2_wan_class":<Integer_value> , "is_auto":<Boolean_value> , "transmit_mode":<String_value> , "id":<Integer_value> , "lan_2_wan_drop_depth":<Integer_value> , "site_name":<String_value> , "wan_2_lan_resequence_hold_time":<Integer_value> , "duplicate_packets_disable_depth":<Integer_value> , "dscp_tag":<String_value> , "application_family":<String_value> , "source_ip_address":<String_value> , "persistent_impedance":<Integer_value> , "package_name":<String_value> , "duplicate_packets_disable_limit":<Integer_value> , "preferred_wan_link":<String_value> , "wan_2_lan_discard_late_resequenced_packets":<Boolean_value> , "lan_2_wan_enable_red":<Boolean_value> }}
Response Payload: JSON
{ "application_qos":[{ "priority":<Integer_value>
, "match_type":<String_value> , "destination_port":<String_value> , "application_objects":<String_value> , "source_port":<String_value> , "virtual_path_name":<String_value> , "retransmit_lost_packets":<Boolean_value> , "destination_ip_address":<String_value> , "wan_2_lan_enable_packet_resequencing":<Boolean_value> , "lan_2_wan_drop_limit":<Integer_value> , "lan_2_wan_class":<Integer_value> , "is_auto":<Boolean_value> , "transmit_mode":<String_value> , "id":<Integer_value> , "lan_2_wan_drop_depth":<Integer_value> , "site_name":<String_value> , "wan_2_lan_resequence_hold_time":<Integer_value> , "duplicate_packets_disable_depth":<Integer_value> , "dscp_tag":<String_value> , "application_family":<String_value> , "source_ip_address":<String_value> , "persistent_impedance":<Integer_value> , "package_name":<String_value> , "duplicate_packets_disable_limit":<Integer_value> , "preferred_wan_link":<String_value> , "wan_2_lan_discard_late_resequenced_packets":<Boolean_value> , "lan_2_wan_enable_red":<Boolean_value> }]}