Enhanced QoS REST API

• Description – configures QoS settings for physical and virtual ports. Through this feature, users can set specific values for guaranteed bandwidth, and assign a specific rate limit per SL. 

• Request URL – /ufmRest/resources/sl_qos/

• Main operations

  • Bandwidth Names

  • Get bandwidth names

  • Get a specific bandwidth name

  • Delete a specific bandwidth name

  • Update a specific bandwidth name

  • Add a new bandwidth name

  • Ports Rules

  • Get all ports rules

  • Get specific ports rules

  • Delete specific ports rules

  • Update specific ports rules

  • Add new ports rules

Bandwidth Names REST API

Get Bandwidth Names

• Description – get all saved bandwidth names (bandwidths values are in Mb/s)

• Request URL – GET /ufmRest/resources/sl_qos/names

• Request Content Type – application/json

• Response 

  {
    "bw1": 50,
    "bw2": 100,
    "bw4": 90,
    "bw5": 80
  }
  

• Status Codes

  • 200 – OK

Get Specific Bandwidth Name

• Description – get a specific bandwidth name

• Request URL – GET ufmRest/resources/sl_qos/names? name=bw1

• Request Content Type – application/json

• Response
  50

• Status Codes

  • 200 – OK

  • 404 – NOT FOUND

Delete Specific Bandwidth Name

• Description – deletes a specific bandwidth name

• Request URL – DELETE ufmRest/resources/sl_qos/names? name=bw1

• Request Content Type – application/json 

• Status Codes

  • 202 – NO CONTENT

  • 400 – BAD REQUEST

  • 404 – NOT FOUND

Update Specific Bandwidth Name

• Description – updates a specific bandwidth name (bandwidth values are in Mb/s)

• Request URL – PUT ufmRest/resources/sl_qos/names /<bw_name>

• Request Content Type – application/json

• Request Data – rate limit integer value:

  70

• Status Codes

  • 200 – OK

  • 400 – BAD REQUEST

  • 404 – NOT FOUND

Add New Bandwidth Name

• Description – adds a new bandwidth name

• Request URL – POST ufmRest/resources/sl_qos/names

• Request Content Type – application/json

• Request Data 

  {
    "bw1": 50,
    "bw2": 60,
    "bw3": 200,
    "bw4": 50
  }
  

• Status Codes

  • 201 – created

  • 400 – BAD REQUEST

Ports Rules REST API

Get All Ports Rules

• Description – get all configured physical and virtual ports rules

• Request URL – 

  • GET ufmRest/resources/sl_qos/rules – to get all physical ports rules

  • GET ufmRest/resources/sl_qos/vport_rules – to get all virtual ports rules

• Request Content Type – application/json

• Response

  {
    "rules": {
      "default": {
        "sl_list": {
          "1": "bw1",
          "3": "bw2",
          "all": "bw1"
        }
      },
      "2c90000000000025": {
        "sl_list": {
          "1": "bw2"
        }
      }
    }
  }
  

• Status Codes

  • 200 – OK

Get Specific Ports Rules

• Description – get Rules for specific physical or virtual ports

• Request URL – 

  • GET ufmRest/resources/sl_qos/rules?guid_list= default, 2c90000000025 – to get specific physical ports rules

  • GET ufmRest/resources/sl_qos/vport_rules?guid_list= default, 2c90000000025 – to get specific virtual ports rules

• Request Content Type – application/json

• Response

  {
    "rules": {
      "default": {
        "sl_list": {
          "1": "bw1",
          "3": "bw2",
          "all": "bw1"
        }
      },
      "2c90000000000025": {
        "sl_list": {
          "1": "bw2"
        }
      }
    }
  }
  

• Status Codes

  • 200 – OK

  • 400 – BAD REQUEST

  • 404 – NOT FOUND

Delete Specific Ports Rules

• Description – delete rules for specific physical or virtual ports

• Request URL – 

  • DELETE ufmRest/resources/sl_qos/rules?guid_list= default, 2c90000000025 – to delete physical ports rules

  • DELETE ufmRest/resources/sl_qos/vport_rules?guid_list= default, 2c90000000025 – to delete virtual ports rules

• Request Content Type – application/json

• Status Codes

  • 204 – NO CONTENT

  • 400 – BAD REQUEST

  • 404 – NOT FOUND

Update Specific Ports Rules

• Description – update rules for specific physical or virtual ports

• Request URL – 

  • PUT ufmRest/resources/sl_qos/rules/<guid> – to update specific physical port rules

  • PUT ufmRest/resources/sl_qos/vport_rules/<guid> – to update specific virtual port rules

• Request Content Type – application/json

• Request Data

  {
    "sl_list": {
      "3": "bw1",
      "3": "bw2",
      "all": "bw1"
    }
  }
  

• Status Codes

  • 200 – OK

  • 400 – BAD REQUEST

  • 404 – NOT FOUND

Add New Ports Rules

• Description – add new rules for specific physical or virtual ports

• Request URL – 

  • POST ufmRest/resources/sl_qos/rules – to add new physical ports rules

  • POST ufmRest/resources/sl_qos/vport_rules – to add new virtual ports rules

• Request Content Type – application/json

• Request Data

  {
    "rules": {
      "default": {
        "sl_list": {
          "1": "bw1",
          "3": "bw2",
          "all": "bw1"
        }
      },
      "2c90000000000025": {
        "sl_list": {
          "1": "bw2"
        }
      }
    }
  }
  

• Status Codes

  • 201 – created

  • 400 – BAD REQUEST

Last updated: July 30, 2020