application_qos¶
Overview¶
API to add, modify, delete, and get configuration for Application QoS
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- application_qos : Operations related to application_qos
Paths¶
POST operation for application_qos¶
POST /application_qos
Description¶
Use this operation to add the Application QoS
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | application_qos_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¶
- application_qos
Get operation for application_qos¶
GET /application_qos
Description¶
Use this operation to get the Application QoS settings
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | application_qos_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¶
- application_qos
PUT operation for application_qos¶
PUT /application_qos
Description¶
Use this operation to modify the Application QoS
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
application_qos_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | application_qos_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¶
- application_qos
DELETE operation for application_qos¶
DELETE /application_qos/{deletePathParam}
Description¶
Use this operation to delete the Application QoS
Parameters¶
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | deletePathParam required |
Object Primary Key for DELETE operation | object |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource delete added | application_qos_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¶
- application_qos
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
application¶
The Application is a pre-defined application, as specified in the Global - Applications section of this configuration.
Type : string
application_family¶
The Application Family Object is a user-defined application family
Type : string
application_id¶
The Application ID is a pre-defined application, as specified in the Global - Applications section of this configuration.
Type : integer
application_objects¶
The Application Object is a user-defined application, as specified in the Global - Applications section of this configuration.
Type : string
application_qos¶
| Name | Schema |
|---|---|
| application optional |
application |
| application_family optional |
application_family |
| application_id optional |
application_id |
| application_objects optional |
application_objects |
| destination_ip_address optional |
destination_ip_address |
| destination_port optional |
destination_port |
| dscp_tag optional |
dscp_tag |
| duplicate_packets_disable_depth optional |
duplicate_packets_disable_depth |
| duplicate_packets_disable_limit optional |
duplicate_packets_disable_limit |
| id optional |
id |
| ip_address optional |
ip_address |
| is_auto optional |
is_auto |
| lan_to_wan_class optional |
lan_to_wan_class |
| lan_to_wan_drop_depth optional |
lan_to_wan_drop_depth |
| lan_to_wan_drop_limit optional |
lan_to_wan_drop_limit |
| lan_to_wan_enable_red optional |
lan_to_wan_enable_red |
| match_type optional |
match_type |
| package_name optional |
package_name |
| persistent_impedance optional |
persistent_impedance |
| preferred_wan_link optional |
preferred_wan_link |
| priority optional |
priority |
| retransmit_lost_packets optional |
retransmit_lost_packets |
| site_name optional |
site_name |
| source_ip_address optional |
source_ip_address |
| source_port optional |
source_port |
| transmit_mode optional |
transmit_mode |
| virtual_path_name optional |
virtual_path_name |
| wan_to_lan_discard_late_resequenced_packets optional |
wan_to_lan_discard_late_resequenced_packets |
| 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 |
application_qos_delete_success_schema¶
| Name | Schema |
|---|---|
| application_qos optional |
application_qos |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
application_qos_post_success_schema¶
| Name | Schema |
|---|---|
| application_qos optional |
application_qos |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
application_qos_put_success_schema¶
| Name | Schema |
|---|---|
| application_qos optional |
application_qos |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
application_qos_request_schema¶
| Name | Schema |
|---|---|
| application_qos optional |
application_qos |
application_qos_response_schema¶
Type : < application_qos_response_schema > array
application_qos_response_schema
| Name | Schema |
|---|---|
| application optional |
application |
| application_family optional |
application_family |
| application_id optional |
application_id |
| application_objects optional |
application_objects |
| destination_ip_address optional |
destination_ip_address |
| destination_port optional |
destination_port |
| dscp_tag optional |
dscp_tag |
| duplicate_packets_disable_depth optional |
duplicate_packets_disable_depth |
| duplicate_packets_disable_limit optional |
duplicate_packets_disable_limit |
| id optional |
id |
| ip_address optional |
ip_address |
| is_auto optional |
is_auto |
| lan_to_wan_class optional |
lan_to_wan_class |
| lan_to_wan_drop_depth optional |
lan_to_wan_drop_depth |
| lan_to_wan_drop_limit optional |
lan_to_wan_drop_limit |
| lan_to_wan_enable_red optional |
lan_to_wan_enable_red |
| match_type optional |
match_type |
| package_name optional |
package_name |
| persistent_impedance optional |
persistent_impedance |
| preferred_wan_link optional |
preferred_wan_link |
| priority optional |
priority |
| retransmit_lost_packets optional |
retransmit_lost_packets |
| site_name optional |
site_name |
| source_ip_address optional |
source_ip_address |
| source_port optional |
source_port |
| transmit_mode optional |
transmit_mode |
| virtual_path_name optional |
virtual_path_name |
| wan_to_lan_discard_late_resequenced_packets optional |
wan_to_lan_discard_late_resequenced_packets |
| 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 |
destination_ip_address¶
The Destination IP Address and subnet mask that this rule will match
Type : string
destination_port¶
If set, the Destination Port or Port range (eg: 2345-2457) that this rule will match
Type : string
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 : enum (any, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, default, ef)
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
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
id¶
Object id for application qos
Type : integer
ip_address¶
The Source or Destination IP Address and subnet mask that this application will match
Type : string
is_auto¶
If set to true, it is a default Application QoS
Type : boolean
lan_to_wan_class¶
The Class that is to service traffic flows that match this application. The default is Class 9
Type : integer
lan_to_wan_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_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_enable_red¶
If enabled, Random Early Detection (RED) will discard packets uniformly when congestion is detected.
Type : boolean
match_type¶
The mechanism through which this application will be matched (Either a user-defined application, pre-defined applications or groupings of applications)
Type : enum (application_objects, application, application_family)
package_name¶
Package name to add application qos to
Type : string
persistent_impedance¶
Use the same path until wait time on the path is longer than the configured value
Type : integer
preferred_wan_link¶
The WAN link that flows should use first
Type : string
priority¶
Order of evaluation of the application rule
Type : integer
retransmit_lost_packets¶
If enabled, flows matching this application will be sent using reliable service to the remote appliance and any packets lost will be retransmitted
Type : boolean
site_name¶
Site name to which the application qos belongs
Type : string
source_ip_address¶
The Source IP Address and subnet mask that this application will match
Type : string
source_port¶
If set, the Source Port or Port range (eg: 2345-2457) that this rule will match
Type : string
transmit_mode¶
The method of transmitting and receiving packets
Type : enum (load_balance_paths, persistent_path, duplicate_paths)
virtual_path_name¶
virtual path name to which the application qos belongs to
Type : string
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 checkbox to discard, disable this checkbox to forward.
Type : boolean
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