mpls_queue_obj
mpls_queue_obj
Configuration Editor for MPLS queue objects resource.
Read/write properties
wan_2_lan_permitted_rate_kbps <Integer>
The available or allowed rate for WAN to LAN traffic.
dscp_tag <String>
The DSCP tag for the MPLS queue. Possible values = [DEFAULT,af11,af12,af13,af21,af22,af23,af31,af32,af33,af41,af42,af43,cs1,cs2,cs3,cs4,cs5,cs6,cs7,ef]
wan_2_lan_realtime_eligibility <Boolean>
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..
congestion_threshold <Integer>
The amount of congestion (in microseconds) after which the MPLS Queue will throttle packet transmission to avoid further congestion.
unmatched <Boolean>
If enabled, DSCP tags not matched by other MPLS Queues will use this queue.
lan_2_wan_interactive_eligibility <Boolean>
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.
tracking_ip_address <String>
A virtual IP address that can be pinged to determine the state of the MPLS Queue.
mpls_queue_name <String>
The name of the MPLS Queue. Minimum length = 1 Maximum length = 32
lan_2_wan_realtime_eligibility <Boolean>
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.
wan_2_lan_interactive_eligibility <Boolean>
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..
wan_2_lan_bulk_eligibility <Boolean>
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.
lan_2_wan_bulk_eligibility <Boolean>
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.
lan_2_wan_permitted_rate_kbps <Integer>
The available or allowed rate for LAN to WAN traffic.
no_retag <Boolean>
If enabled, DCSP tags using unmatched Queue will not get retagged to the unmatched Queue tag for LAN to WAN intranet traffic.
Read only properties
Operations
[add]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/mpls_queue_obj
Description: Use this operation to add mpls queues
HTTP Method: POST
Request Payload: JSON
{"mpls_queue_obj": { "wan_2_lan_permitted_rate_kbps":<Integer_value> , "dscp_tag":<String_value> , "wan_2_lan_realtime_eligibility":<Boolean_value> , "congestion_threshold":<Integer_value> , "unmatched":<Boolean_value> , "lan_2_wan_interactive_eligibility":<Boolean_value> , "tracking_ip_address":<String_value> , "mpls_queue_name":<String_value> , "lan_2_wan_realtime_eligibility":<Boolean_value> , "wan_2_lan_interactive_eligibility":<Boolean_value> , "wan_2_lan_bulk_eligibility":<Boolean_value> , "lan_2_wan_bulk_eligibility":<Boolean_value> , "lan_2_wan_permitted_rate_kbps":<Integer_value> , "no_retag":<Boolean_value> }}
Response Payload: JSON
{ "mpls_queue_obj":{ "wan_2_lan_permitted_rate_kbps":<Integer_value>
, "dscp_tag":<String_value> , "wan_2_lan_realtime_eligibility":<Boolean_value> , "congestion_threshold":<Integer_value> , "unmatched":<Boolean_value> , "lan_2_wan_interactive_eligibility":<Boolean_value> , "tracking_ip_address":<String_value> , "mpls_queue_name":<String_value> , "lan_2_wan_realtime_eligibility":<Boolean_value> , "wan_2_lan_interactive_eligibility":<Boolean_value> , "wan_2_lan_bulk_eligibility":<Boolean_value> , "lan_2_wan_bulk_eligibility":<Boolean_value> , "lan_2_wan_permitted_rate_kbps":<Integer_value> , "no_retag":<Boolean_value> }]}
[delete]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/mpls_queue_obj/mpls_queue_name=<String>
Description: Use this operation to delete a mpls queue
HTTP Method: DELETE
Response Payload: JSON
{ "errorcode": 0, "message": "Done", "severity": <String;_value> }
[get (all)]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/mpls_queue_obj
Description: Use this operation to get the list of mpls queues
HTTP Method: GET
Response Payload: JSON
{"mpls_queue_obj":[{ "wan_2_lan_permitted_rate_kbps":<Integer_value>
, "dscp_tag":<String_value> , "wan_2_lan_realtime_eligibility":<Boolean_value> , "congestion_threshold":<Integer_value> , "unmatched":<Boolean_value> , "lan_2_wan_interactive_eligibility":<Boolean_value> , "tracking_ip_address":<String_value> , "mpls_queue_name":<String_value> , "lan_2_wan_realtime_eligibility":<Boolean_value> , "wan_2_lan_interactive_eligibility":<Boolean_value> , "wan_2_lan_bulk_eligibility":<Boolean_value> , "lan_2_wan_bulk_eligibility":<Boolean_value> , "lan_2_wan_permitted_rate_kbps":<Integer_value> , "no_retag":<Boolean_value> }]}
[modify]{}
URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/mpls_queue_obj
Description: Use this operation to modify a mpls queue
HTTP Method: PUT
Request Payload: JSON
{"mpls_queue_obj":{ "wan_2_lan_permitted_rate_kbps":<Integer_value> , "dscp_tag":<String_value> , "wan_2_lan_realtime_eligibility":<Boolean_value> , "congestion_threshold":<Integer_value> , "unmatched":<Boolean_value> , "lan_2_wan_interactive_eligibility":<Boolean_value> , "tracking_ip_address":<String_value> , "mpls_queue_name":<String_value> , "lan_2_wan_realtime_eligibility":<Boolean_value> , "wan_2_lan_interactive_eligibility":<Boolean_value> , "wan_2_lan_bulk_eligibility":<Boolean_value> , "lan_2_wan_bulk_eligibility":<Boolean_value> , "lan_2_wan_permitted_rate_kbps":<Integer_value> , "no_retag":<Boolean_value> }}
Response Payload: JSON
{ "mpls_queue_obj":[{ "wan_2_lan_permitted_rate_kbps":<Integer_value>
, "dscp_tag":<String_value> , "wan_2_lan_realtime_eligibility":<Boolean_value> , "congestion_threshold":<Integer_value> , "unmatched":<Boolean_value> , "lan_2_wan_interactive_eligibility":<Boolean_value> , "tracking_ip_address":<String_value> , "mpls_queue_name":<String_value> , "lan_2_wan_realtime_eligibility":<Boolean_value> , "wan_2_lan_interactive_eligibility":<Boolean_value> , "wan_2_lan_bulk_eligibility":<Boolean_value> , "lan_2_wan_bulk_eligibility":<Boolean_value> , "lan_2_wan_permitted_rate_kbps":<Integer_value> , "no_retag":<Boolean_value> }]}