Skip to content

mpls_queue

Overview

MPLS queue objects

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP

Tags

  • mpls_queue : Operations related to mpls_queue

Paths

POST operation for mpls_queue

POST /mpls_queue

Description

Use this operation to add mpls queues

Responses

HTTP Code Description Schema
200 Resource successfully added mpls_queue_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

  • mpls_queue

Get operation for mpls_queue

GET /mpls_queue

Description

Use this operation to get the list of mpls queues

Responses

HTTP Code Description Schema
200 API Successfully executed mpls_queue_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

  • mpls_queue

PUT operation for mpls_queue

PUT /mpls_queue

Description

Use this operation to modify a mpls queue

Parameters

Type Name Schema
Body body
optional
mpls_queue_request_schema

Responses

HTTP Code Description Schema
200 Resource modified added mpls_queue_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

  • mpls_queue

DELETE operation for mpls_queue

DELETE /mpls_queue/{deletePathParam}

Description

Use this operation to delete a mpls queue

Parameters

Type Name Description Schema
Path deletePathParam
required
Object Primary Key for DELETE operation object

Responses

HTTP Code Description Schema
200 Resource delete added mpls_queue_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

  • mpls_queue

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

congestion_threshold

The amount of congestion (in microseconds) after which the MPLS Queue will throttle packet transmission to avoid further congestion

Type : integer

dscp_tag

The DSCP tag for the MPLS queue

Type : enum (DEFAULT, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, ef)

lan_to_wan_bulk_eligibility

Allows paths from this WAN Link to transmit bulk traffic. If disabled, these paths will still be considered eligible if no other paths are available

Type : boolean

lan_to_wan_interactive_eligibility

Allows paths from this WAN Link to transmit interactive traffic. If disabled, these paths will still be considered eligible if no other paths are available

Type : boolean

lan_to_wan_permitted_rate_kbps

The available or allowed rate for LAN to WAN traffic

Type : integer

lan_to_wan_realtime_eligibility

Allows paths from this WAN Link to transmit realtime traffic. If disabled, these paths will still be considered eligible if no other paths are available

Type : boolean

mpls_queue

Name Schema
congestion_threshold
optional
congestion_threshold
dscp_tag
optional
dscp_tag
lan_to_wan_bulk_eligibility
optional
lan_to_wan_bulk_eligibility
lan_to_wan_interactive_eligibility
optional
lan_to_wan_interactive_eligibility
lan_to_wan_permitted_rate_kbps
optional
lan_to_wan_permitted_rate_kbps
lan_to_wan_realtime_eligibility
optional
lan_to_wan_realtime_eligibility
mpls_queue_name
optional
mpls_queue_name
no_retag
optional
no_retag
package_name
optional
package_name
site_name
optional
site_name
tracking_ip_address
optional
tracking_ip_address
unmatched
optional
unmatched
wan_link_name
optional
wan_link_name
wan_to_lan_bulk_eligibility
optional
wan_to_lan_bulk_eligibility
wan_to_lan_interactive_eligibility
optional
wan_to_lan_interactive_eligibility
wan_to_lan_permitted_rate_kbps
optional
wan_to_lan_permitted_rate_kbps
wan_to_lan_realtime_eligibility
optional
wan_to_lan_realtime_eligibility

mpls_queue_delete_success_schema

Name Schema
mpls_queue
optional
mpls_queue

mpls_queue

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

mpls_queue_name

The name of the MPLS Queue

Type : string

mpls_queue_post_success_schema

Name Schema
mpls_queue
optional
mpls_queue

mpls_queue

Name Description Schema
message
optional
Example : "resource added succesfully" string

mpls_queue_put_success_schema

Name Schema
mpls_queue
optional
mpls_queue

mpls_queue

Name Description Schema
message
optional
Example : "resource modified succesfully" string

mpls_queue_request_schema

Name Schema
mpls_queue
optional
mpls_queue

mpls_queue_response_schema

Type : < mpls_queue_response_schema > array

mpls_queue_response_schema

Name Schema
congestion_threshold
optional
congestion_threshold
dscp_tag
optional
dscp_tag
lan_to_wan_bulk_eligibility
optional
lan_to_wan_bulk_eligibility
lan_to_wan_interactive_eligibility
optional
lan_to_wan_interactive_eligibility
lan_to_wan_permitted_rate_kbps
optional
lan_to_wan_permitted_rate_kbps
lan_to_wan_realtime_eligibility
optional
lan_to_wan_realtime_eligibility
mpls_queue_name
optional
mpls_queue_name
no_retag
optional
no_retag
package_name
optional
package_name
site_name
optional
site_name
tracking_ip_address
optional
tracking_ip_address
unmatched
optional
unmatched
wan_link_name
optional
wan_link_name
wan_to_lan_bulk_eligibility
optional
wan_to_lan_bulk_eligibility
wan_to_lan_interactive_eligibility
optional
wan_to_lan_interactive_eligibility
wan_to_lan_permitted_rate_kbps
optional
wan_to_lan_permitted_rate_kbps
wan_to_lan_realtime_eligibility
optional
wan_to_lan_realtime_eligibility

no_retag

If enabled, DCSP tags using unmatched Queue will not get retagged to the unmatched Queue tag for LAN to WAN intranet traffic

Type : boolean

package_name

Config package name using which the wan_links API operation should be performed.

Type : string

site_name

Site Name

Type : string

tracking_ip_address

A virtual IP address that can be pinged to determine the state of the MPLS Queue

Type : string

unmatched

If enabled, DSCP tags not matched by other MPLS Queues will use this queue

Type : boolean

wan_link_name

The WAN Link Name

Type : string

wan_to_lan_bulk_eligibility

Allows paths to this WAN Link to transmit bulk traffic. If disabled, these paths will still be considered eligible if no other paths are available

Type : boolean

wan_to_lan_interactive_eligibility

Allows paths to this WAN Link to transmit interactive traffic. If disabled, these paths will still be considered eligible if no other paths are available.

Type : boolean

wan_to_lan_permitted_rate_kbps

The available or allowed rate for WAN to LAN traffic

Type : integer

wan_to_lan_realtime_eligibility

Allows paths to this WAN Link to transmit realtime traffic. If disabled, these paths will still be considered eligible if no other paths are available.

Type : boolean