White Papers

OpenManage Essentials-Specific Resource Model
16 REST API Guide–OpenManage Essentials
Attribute Name
Description
Name
Name of the device group
Description
A short description of the device group
AddDevices
List of DeviceIDs to be added to the group
RemoveDevices
List of DeviceIDs to be removed from the group
The payload for this PUT operation is as follows:
<RESTDeviceGroupEntry>
<Name>Group 2</Name>
<Description>This is new group description</Description>
<AddDevices>
<int>4</int>
<int>5</int>
<int>6</int>
</AddDevices>
<RemoveDevices>
<int>1</int>
<int>2</int>
<int>3</int>
</RemoveDevices>
</RESTDeviceGroupEntry>
User can add the devices already discovered in OME to a custom group. User cannot add devices to any other
types of groups other than custom group. All devices meant to be added will be added to the specified group if
devices bearing those IDs exist in OME. Those devices which are meant to be removed from the group will be
removed from the group. If the user enters device IDs which are invalid, an error response will be returned only
for those IDs and remaining devices will be added/removed to/from the group. If the fields for
groupname/description is not empty then those values will overwrite current name and description of the
specified group subjected to data validation. If a group other than the specified group has the mentioned group
name then modify operation fails and an appropriate error will be thrown. User will not be able to modify query
driven groups or groups having subgroups with this API.
Only OmeAdministrators and OmePowerUsers will have the permission to add devices to group provided they
also have local admin privilege. In case of insufficient permissions, the operation will fail and returns an error
message. Users not having local admin privilege will encounter a generic ‘Access is denied’ error.
2.1.4 Delete Devices Group
The following URI allows user to delete a custom device group.
<BASE_URI>/DeviceGroups/{groupid}
Operation: DELETE
This operation deletes the specified custom group if it exists in OME. If the specified group is not present in
OME, a corresponding error is returned. Any groups other than custom groups cannot be deleted.
Only OmeAdministrators, OmePowerUsers, and OmeSiteAdministrators will have the permission to delete a
custom device group, provided they also have the local admin privilege. In case of insufficient permissions, the
operation will fail and returns an error message. Users not having local admin privilege will get a generic ‘Access
is denied’ error.