Groups REST API

NVIDIA UFM Enterprise REST API Guide v6.10.0
  • Description – these interfaces allow users to retrieve information on groups, create, delete, and update groups

  • Request URL – GET /ufmRest/app/groups

  • Main operations

    • Get all groups

    • Get a group using its name

    • Update a group using its name

    • Delete a group using its name

    • Create a group

    • Add members to a group

    • Remove members from a group

  • Description – retrieve information on groups

  • Request URL – GET /ufmRest/resources/groups

  • Request Content Type – Application/json

  • Response

    Copy
    Copied!
                

    [ { "description": "grp222", "type": "Rack", "severity": "Info", "name": "grp2" },   { "description": "grp111", "type": "Rack", "severity": "Info", "name": "grp1" } ]

  • Possible Filters

    • Type – filters by type. Example:

      Copy
      Copied!
                  

      /ufmRest/resources/groups?type=Rack

      Possible values: “Rack”, “General”, “Port”

    • Members – adds members to the response. Example:

      Copy
      Copied!
                  

      ufmRest/resources/groups?type=Rack&members=true

    • extend_members

      Copy
      Copied!
                  

      /resources/groups?members=true&extend_members=true

    • device_id

      Copy
      Copied!
                  

      /resources/groups?device_id=0008f10001085600

  • Response:

    Copy
    Copied!
                

    [ { "description": "grp222", "type": "Rack", "severity":"Info", "members": [ "0002c90300a7ccf0", "0002c9030060dc20"], "name": "grp2" },   { "description": "grp111", "type": "Rack", "severity": "Info", "members": [ "0002c903007e50a0" ], "name": "grp1" } ]

  • Status Codes

    • 200 – OK

  • Description – Retrieve information on a group using its name

  • Request URL – GET ufmRest/resources/groups/<group_name>

  • Request Content Type – Application/json

  • Response

    Copy
    Copied!
                

    [ { "description": "grp111", "type": "Rack", "severity": "Info", "name": "grp1" } ]

  • Possible Filters

  • Members – adds members to the response. Example:

    Copy
    Copied!
                

    /ufmRest/resources/groups/grp1?members=true

  • Status Codes

    • 200 – OK

  • Description – update a group using its name

  • Request URL – PUT ufmRest/resources/groups/<group_name>

  • Request Content Type – Application/json

  • Request Data

    Copy
    Copied!
                

    { "description*": "new_desc" }

    Warning

    *This is the only attribute that can be updated.

  • Status Codes

    • 200 – OK

    • 400 – BAD REQUEST

  • Description – delete a group using its name

  • Request URL – DELETE ufmRest/resources/groups/<group_name>

  • Request Content Type – Application/json

  • Request Data – N/A

  • Status Codes

    • 202 – accepted

  • Description – create a new group

  • Request URL – POST ufmRest/resources/groups/

  • Request Content Type – Application/json

  • Request Data

    Copy
    Copied!
                

    { "description*": "new_desc", "type**": "group_type", "name***": "group_name" }

    Warning

    * Optional attribute.

    ** Mandatory attribute. Can only be “Rack” or “General”, “Port”.

    *** Mandatory attribute.

  • Status Codes

    • 201 – created with the link to the group object

    • 400 – BAD REQUEST

  • Description – add members to an existing group

  • Request URL – POST /ufmRest/resources/groups/<group_name>/members

  • Request Content Type – Application/json

  • Request Data

    Copy
    Copied!
                

    { "object_ids": ["0002c90300a7ccf0", "0002c9030060dc20"] }

  • Status Codes

    • 202 – accepted

    • 400 – BAD REQUEST

  • Description – remove members from an existing group

  • Request URL – DELETE /ufmRest/resources/groups/<group_name>/members

  • Request Content Type – Application/json

  • Request Data

    Copy
    Copied!
                

    { "object_ids": ["0002c90300a7ccf0", "0002c9030060dc20"] }

  • Note – to remove all members of a group, the object_ids argument in the request data can be left empty

  • Status Codes

    • 202 – accepted

  • Description – allows user to apply software upgrade action on group of switches or firmware upgrade action on group of hosts.

  • Request URL – POST /ufmRestV2/actions

  • Request Content Type – Application/json

  • Request Data null
  • Status Codes

    • 202 – accepted

    • 400 – bad request

    • 404 – not found

© Copyright 2023, NVIDIA. Last updated on Sep 5, 2023.