virtual_path_default_set_application_qos¶
Overview¶
API to add, modify, delete, and get configuration for Virtual Path Default Set Application QoS
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- virtual_path_default_set_application_qos : Operations related to virtual_path_default_set_application_qos
Paths¶
POST operation for virtual_path_default_set_application_qos¶
POST /virtual_path_default_set_application_qos
Description¶
Use this operation to add the Virtual Path Default Set Application QoS
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | virtual_path_default_set_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¶
- virtual_path_default_set_application_qos
Get operation for virtual_path_default_set_application_qos¶
GET /virtual_path_default_set_application_qos
Description¶
Use this operation to get the Virtual Path Default Set Application QoS
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | virtual_path_default_set_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¶
- virtual_path_default_set_application_qos
PUT operation for virtual_path_default_set_application_qos¶
PUT /virtual_path_default_set_application_qos
Description¶
Use this operation to modify the Virtual Path Default Set Application QoS
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
virtual_path_default_set_application_qos_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | virtual_path_default_set_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¶
- virtual_path_default_set_application_qos
DELETE operation for virtual_path_default_set_application_qos¶
DELETE /virtual_path_default_set_application_qos/{deletePathParam}
Description¶
Use this operation to delete the Virtual Path Default Set 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 | virtual_path_default_set_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¶
- virtual_path_default_set_application_qos
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
id¶
Id for application qos
Type : integer
match_properties¶
Application QoS match properties
| Name | Description | Schema |
|---|---|---|
| application optional |
The Application is a pre-defined application, as specified in the Global - Applications section of this configuration. Default : "any" |
string |
| application_family optional |
The Application Family Object is a user-defined application family Default : "any" |
string |
| application_objects optional |
The Application Object is a user-defined application, as specified in the Global - Applications section of this configuration. Default : "any" |
string |
| 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 |
| match_type optional |
The mechanism through which this application will be matched (Either a user-defined application, pre-defined applications or groupings of applications) | enum (application_objects, application, application_family) |
| source_ip_address optional |
The Source IP Address and subnet mask that this application will match. Give IP Address with subnet | string |
| source_port optional |
If set, the Source Port or Port range (eg: 2345-2457) that this rule will match | string |
order¶
The order/precedence in which applications are matched (automatically redistributed)
Type : integer
package_name¶
Package name to add application qos to
Type : string
virtual_path_default_set_application_qos¶
| Name | Schema |
|---|---|
| id optional |
id |
| match_properties optional |
match_properties |
| order optional |
order |
| package_name optional |
package_name |
| virtual_path_default_set_name optional |
virtual_path_default_set_name |
| wan_properties optional |
wan_properties |
virtual_path_default_set_application_qos_delete_success_schema¶
| Name | Schema |
|---|---|
| virtual_path_default_set_application_qos optional |
virtual_path_default_set_application_qos |
virtual_path_default_set_application_qos
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
virtual_path_default_set_application_qos_post_success_schema¶
| Name | Schema |
|---|---|
| virtual_path_default_set_application_qos optional |
virtual_path_default_set_application_qos |
virtual_path_default_set_application_qos
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
virtual_path_default_set_application_qos_put_success_schema¶
| Name | Schema |
|---|---|
| virtual_path_default_set_application_qos optional |
virtual_path_default_set_application_qos |
virtual_path_default_set_application_qos
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
virtual_path_default_set_application_qos_request_schema¶
| Name | Schema |
|---|---|
| virtual_path_default_set_application_qos optional |
virtual_path_default_set_application_qos |
virtual_path_default_set_application_qos_response_schema¶
Type : < virtual_path_default_set_application_qos_response_schema > array
virtual_path_default_set_application_qos_response_schema
| Name | Schema |
|---|---|
| id optional |
id |
| match_properties optional |
match_properties |
| order optional |
order |
| package_name optional |
package_name |
| virtual_path_default_set_name optional |
virtual_path_default_set_name |
| wan_properties optional |
wan_properties |
virtual_path_default_set_name¶
Virtual path Default Set name using which the API operation should be performed.
Type : string
wan_properties¶
Application QoS WAN properties
| Name | Description | Schema |
|---|---|---|
| lan_to_wan_class_id optional |
The Class that is to service traffic flows that match this application. The default is Class 9 Default : "9" |
string |
| lan_to_wan_drop_depth optional |
If the queue depth exceeds this threshold, the packet will be discarded and statistics will be counted (value is in bytes) | integer |
| lan_to_wan_drop_limit optional |
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) | integer |
| lan_to_wan_duplicate_packets_disable_depth optional |
The queue depth of the class scheduler at which point duplicate packets will not be generated (value is in bytes) | integer |
| lan_to_wan_duplicate_packets_disable_limit optional |
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) | integer |
| lan_to_wan_enable_red optional |
If enabled, Random Early Detection (RED) will discard packets uniformly when congestion is detected. Default : false |
boolean |
| persistent_impedance optional |
Use the same path until wait time on the path is longer than the configured value | integer |
| retransmit_lost_packets optional |
If enabled, flows matching this application will be sent using reliable service to the remote appliance and any packets lost will be retransmitted Default : false |
boolean |
| rule_group_name optional |
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 Application Name can be viewed together. | string |
| transmit_mode optional |
The method of transmitting and receiving packets Default : "load_balance_paths" |
enum (load_balance_paths, persistent_paths, duplicate_paths) |
| wan_to_lan_discard_late_resequenced_packets optional |
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. Default : true |
boolean |
| wan_to_lan_dscp_tag optional |
The DSCP tag that will be applied to packets that match this rule on WAN to LAN, before they are sent to the LAN | enum (any, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, default, ef) |
| wan_to_lan_enable_packet_resequencing optional |
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. Default : false |
boolean |
| wan_to_lan_resequence_hold_time optional |
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) | integer |