Enhanced QoS REST API

NVIDIA UFM Enterprise REST API Guide v6.9.0
  • 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

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

    Copy
    Copied!
                

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

  • Status Codes

    • 200 – OK

  • 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

  • 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

  • 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

  • Description – adds a new bandwidth name

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

  • Request Content Type – application/json

  • Request Data

    Copy
    Copied!
                

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

  • Status Codes

    • 201 – created

    • 400 – BAD REQUEST

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

    Copy
    Copied!
                

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

  • Status Codes

    • 200 – OK

  • 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

    Copy
    Copied!
                

    { "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

  • 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

  • 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

    Copy
    Copied!
                

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

  • Status Codes

    • 200 – OK

    • 400 – BAD REQUEST

    • 404 – NOT FOUND

  • 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

    Copy
    Copied!
                

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

  • Status Codes

    • 201 – created

    • 400 – BAD REQUEST

© Copyright 2023, NVIDIA. Last updated on May 23, 2023.