NVIDIA SHARP Resource Allocation REST API

NVIDIA UFM Enterprise REST API Guide v6.9.0
Warning

SHARPv2 must be running (enable_sharp = true) and the NVIDIA Scalable Hierarchical Aggregation and Reduction Protocol (SHARP)™ allocation parameter must be enabled (enable_sharp_alloction = true) for this API to trigger resource (GUID) allocations and deallocations within SHARP. .

  • Description – configures NVIDIA SHARP allocations (reservations)

  • Request URL – GET /ufmRest/resources/sharp/reservations

  • Main Operations

    • Set GUIDs for PKey in UFM actions API

    • Set GUIDs for PKey in PKey GUID API

    • Get all reservations

    • Get all reservations brief (Pkey/Tenant only)

    • Get specific PKey/tenant reservation

  • Description – sets GUIDs for PKEY using UFM Actions API

  • Request URL – POST /ufmRest/actions/set_guids_for_pkey

  • Request Content Type – Application/json

  • Response

    Copy
    Copied!
                

    { "pkey": "0x1", "index0": false, "ip_over_ib": true, "guids": [ "f452140300383a02" ] }

  • Note: An empty GUID list deallocates GUIDs for the specified PKey.

  • Status Codes

    • 200 – OK

    • 400 – BAD_REQUEST

    • 403 – FORBIDDEN

    • 404 – NOT_FOUND

  • Description – sets GUIDs for PKEY using PKey GUID API

  • Request URL – PUT /ufmRest/resources/pkeys/set_guids_for_pkey

  • Request Content Type – Application/json

  • Response

    Copy
    Copied!
                

    { "pkey": "0x11", "index0": false, "ip_over_ib": true, "membership": "full", "guids": [ "248a0703008a850a" ] }

  • Status Codes

    • 200 – OK

    • 400 – BAD_REQUEST

    • 403 – FORBIDDEN

    • 404 – NOT_FOUND

  • Description – retrieves all SHARP allocations

  • Request URL – GET /ufmRest/resources/sharp/reservations

  • Request Content Type – Application/json

  • Response

    Copy
    Copied!
                

    { "0x1": { "guids": [ "e41d2d03000c6761" ] }, "0x77ff": { "guids": [ "e41d2d03000c6761" } }

  • Status Codes

    • 200 – OK

    • 400 – BAD_REQUEST

    • 403 – FORBIDDEN

    • 404 – NOT_FOUND

  • Description – retrieves SHARP allocations showing PKey only

  • Request URL – GET /ufmRest/resources/sharp/reservations?brief=true

  • Request Content Type – Application/json

  • Response

    Copy
    Copied!
                

    [ "0x1", "0x77ff",   ]

  • Description – retrieves SHARP allocations for specific PKey

  • Request URL – GET /ufmRest/resources/sharp/reservations/<reservation_id>

  • Request Content Type – Application/json

  • Response

    Copy
    Copied!
                

    { "0x1": { "guids": [ "e41d2d03000c6761" ] } }

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