OpenManage Enterprise–Tech Release REST API Guide
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your product. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. © 2018 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Contents 1 Introduction................................................................................................................................. 4 2 Key integration concepts.............................................................................................................. 5 Base URI................................................................................................................................................................................. 5 Security......................
1 Introduction This guide provides information for integrating with OpenManage Enterprise Representational State Transfer (REST) APIs. It provides examples of using REST to perform common tasks based on integration use cases with other products such as OpenManage Mobile, Repository Manager, and the Dell Software group portfolio. This guide is not intended to be an introduction to REST.
2 Key integration concepts This section covers key integration concepts that are applicable to all of the use cases that are addressed in the next section.
The returning header will contain the x-auth-token: connection →Keep-Alive content-length →268 content-type →application/json; odata.metadata=minimal date →Tue, 05 Sep 2017 11:55:29 GMT keep-alive →timeout=5, max=150 location →/api/SessionService/Sessions('e1817fe6-97e5-4ea0-88a9-d865c7302152') odata-version →4.
/SessionService/Sessions?$skip=1&$top=2& (To get the list of sessions by skipping to the 2nd session, and returning the top 3 ) Data pagination Data pagination can be accomplished by providing additional information in the GET request corresponding to a chunk of data.
Request header Description PUT 202 – Accepted (operation pending) 204 – Success (operation complete) DELETE 202 – Accepted (operation pending) 204 – Success (operation complete) Failure codes Invalid parameter 400 – Invalid parameter Authorization 401 – Authorization failure Permission denied 403 – Permission denied Not found 404 – Resource not found Invalid request method 405 – Invalid request method Internal server error 500 – Internal server error Service unavailable 503 – Service unav
Response header Description Example format as defined by RFC 7231 Date/ Time Formats). Odata-version What version of Odata that is used. Odata: 4.0 Location Used in redirection, or when a new resource has been created.
3 OpenManage Enterprise–Specific resource model The following sub-sections represent a subset of the use cases that OpenManage Enterprise supports. The REST API support and the operation support will be incrementally refined based on consumer feedback over multiple OpenManage Enterprise releases.
} ] } "JobProgress": "100", "JobStatusId": 2060, "JobNextRun": null, "UpdatedBy": "admin", "LastUpdateTime": "2017-11-01 20:26:15.987", "DiscoveryConfigGroupId": 1, "DiscoveryConfigExpectedDeviceCount": 1, "DiscoveryConfigDiscoveredDeviceCount": 1, "DiscoveryConfigEmailRecipient": null, "DiscoveredDevicesByType": [ { "DeviceType": "SERVER", "Count": 1 } ] Table 5. Attributes Attribute name Description JobId ID of job.
"DiscoveryConfigId":331105536, "DiscoveryConfigDescription":"", "DiscoveryConfigStatus":"", "DiscoveryConfigTargets":[ { "DiscoveryConfigTargetId":0, "NetworkAddressDetail":"10.35.0.0-10.35.0.255", "AddressType":30, "Disabled":false, "Exclude":false } ], "ConnectionProfileId":0, "ConnectionProfile":"{\"profileName\":\"\",\"profileDescription\":\"\",\"type \":\"DISCOVERY\",\"credentials\":[{\"id\":0,\"type\":\"WSMAN\",\"authType\":\"Basic \",\"modified\":false,\"credentials\":{\"username\":\"root\",\"passwor
} } "ExecutionSequence": 0 ], "DiscoveryConfigTasks": [], "Schedule": { "RunNow": false, "RunLater": false, "Recurring": null, "Cron": "startnow", "StartTime": null, "EndTime": null }, "TrapDestination": false, "ChassisIdentifier": null POST Usage Example 2: Create Discovery Task wirh RUN LATER schedule.
{ "DiscoveryConfigTargetId": 0, "NetworkAddressDetail": "10.35.0.0", "SubnetMask": null, "AddressType": 3, "Disabled": false, "Exclude": false } ], "ConnectionProfileId": 0, "ConnectionProfile": "{\"profileName\":\"\",\"profileDescription\":\"\",\"type \":\"DISCOVERY\",\"credentials\":[{\"id\":0,\"type\":\"WSMAN\",\"authType\":\"Basic \",\"modified\":false,\"credentials\":{\"username\":\"root\",\"password\":\"calvin\",\"caCheck \":false,\"cnCheck\":false,\"port\":443,\"retries\":3,\"timeout\":60,\"isHttp
"Cron":"0 26 19 * * ? *", "StartTime":"", "EndTime":"" } }, "CreateGroup":true, "TrapDestination":false Output: { "DiscoveryConfigGroupId": 5, "DiscoveryConfigGroupName": "Discovery-2017111313254545", "DiscoveryConfigGroupDescription": "Discovery-2017111313254545", "DiscoveryStatusEmailRecipient": null, "DiscoveryConfigParentGroupId": 0, "CreateGroup": true, "DiscoveryConfigModels": [ { "DiscoveryConfigId": 1113132545, "DiscoveryConfigDescription": "", "DiscoveryConfigStatus": "", "DiscoveryConfigTargets
"DiscoveryConfigTargets":[ { "DiscoveryConfigTargetId":0, "NetworkAddressDetail":"10.0.0.0", "AddressType":30, "Disabled":false, "Exclude":false } ], "ConnectionProfileId":0, "ConnectionProfile":"{\"profileName\":\"\",\"profileDescription\":\"\",\"type \":\"DISCOVERY\",\"credentials\":[{\"id\":0,\"type\":\"VMWARE\",\"authType\":\"Basic \",\"modified\":false,\"credentials\":{\"username\":\"test\",\"password\":\"test\",\"caCheck \":false,\"cnCheck\":false,\"port\":443,\"retries\":3,\"timeout\":60,\"isHttp \":
\",\"modified\":false,\"credentials\":{\"username\":\"test\",\"password\":\"test\",\"caCheck \":false,\"cnCheck\":false,\"port\":443,\"retries\":3,\"timeout\":60,\"isHttp \":false,\"keepAlive\":false}},{\"id\":0,\"type\":\"WSMAN\",\"authType\":\"Basic\",\"modified \":false,\"credentials\":{\"username\":\"teste\",\"password\":\"test\",\"caCheck \":false,\"cnCheck\":false,\"port\":443,\"retries\":3,\"timeout\":60,\"isHttp \":false,\"keepAlive\":false}},{\"id\":0,\"type\":\"SNMP\",\"authType\":\"Basic\",\"modi
Returns the discovery ranges parsed from csv. Privilege DISCOVERY_MANAGEMENT HTTP Response Codes 201 GET Usage Examples URL /api/DiscoveryConfigService/Actions/DiscoveryConfigService.RemoveDiscoveryGroup Input: (File Name placed in /tmp location) range valid6c13fcaa-6d08-4749-9903-04fca07d0ee2.csv Output: { } "FileError": [ { "LineNumber": 5, "ErrorCode": "E_INVALID_IP_ADDRESS", "Line": "10-.0.0.0-10.1.0.0,,255.255.0.0," } ], "AddressModel": [ { "NetworkAddress": "10.255.2.
Table 6.
}, { }] } "StartDate": "0001-01-01 00:00:00.000", "EndDate": "0001-01-01 00:00:00.000", "DaysRemaining": 0, "Timestamp": "2017-11-15 00:00:00.000" "@odata.id": "/api/WarrantyService/Warranties(7764)", "Id": 7764, "DeviceId": 4914, "DeviceModel": "PowerEdge R630", "DeviceIdentifier": "BWYWP22", "DeviceType": 1000, "CountryLookupCode": "US", "CustomerNumber": 52052241, "LocalChannel": "01", "OrderNumber": 720529326, "SystemShipDate": "2014-11-17 00:00:00.
VIEW HTTP Response Codes 200 GET Usage Examples Input: Output: { "@odata.context": "/api/$metadata#Collection(ReportService.ReportDef)", "@odata.count": 2, "value": [ { "@odata.id": "/api/ReportService/ReportDefs(3264)", "Id": 3264, "Name": "Alert Counts per Device Report", "Description": "This report contains alert counts per severity and totals per Device.
}, { }, { "Name": "Count Info", "Width": 20, "Sequence": 8 "Id": 1008, "Name": "Count Total", "Width": 20, "Sequence": 9 } ], "FilterGroupId": 0, "QsmQuery": false, "ReportResults": { "@odata.id": "/api/ReportService/ReportDefs(3264)/ReportResults" } "@odata.id": "/api/ReportService/ReportDefs(3314)", "Id": 3314, "Name": "Alerts Weekly Report", "Description": "This report contains critical and warning alerts received over the last 7 days.
}, { }, { }, { }, { } }] "Sequence": 7 "Id": 1107, "Name": "Message", "Width": 60, "Sequence": 8 "Id": 1108, "Name": "Message Id", "Width": 20, "Sequence": 9 "Id": 1109, "Name": "Category", "Width": 20, "Sequence": 10 "Id": 1110, "Name": "Subcategory", "Width": 30, "Sequence": 11 } ], "FilterGroupId": 0, "QsmQuery": false, "ReportResults": { "@odata.id": "/api/ReportService/ReportDefs(3314)/ReportResults" } Table 7.
HTTP Response Codes 201 POST Usage Examples Input: { "Name":"Report test", "Description":"", "ColumnNames":[ { "Width":20, "Sequence":0, "Name":"Device Name" }, { "Width":20, "Sequence":1, "Name":"Device Model" }, { "Width":20, "Sequence":2, "Name":"Device Service Tag" } ], "FilterGroupId":64, "QueryDefRequest":{ "ContextId":5, "ResultFields":[ { "FieldId":421 }, { "FieldId":423 }, { "FieldId":424 } ], "SortFields":[ { "FieldId":421, "SortDir":0 } ] } } Output: 12064 PUT Description Update a Report Privileg
}, { }, { "Width":20, "Sequence":0, "Name":"Alert Message" "Width":20, "Sequence":1, "Name":"Alert Message ID" "Width":20, "Sequence":2, "Name":"Alert Severity" } ], "FilterGroupId":64, "QueryDefRequest":{ "ContextId":5, "ResultFields":[ { "FieldId":689 }, { "FieldId":692 }, { "FieldId":691 } ], "SortFields":[ } } ] 2.3.2 /api/ReportService/Actions/ReportService.
GET Usage Examples Input: Output: { "@odata.context": "/api/$metadata#ReportService.ReportResult/$entity", "@odata.
2.3.4 /api/ReportService/ReportDefs(Id)/ReportResults/ResultRows GET Description Get Rows of Report Results Privilege VIEW HTTP Response Codes 200 GET Usage Examples Input: Output: { "@odata.context": "/api/$metadata#Collection(ReportService.ReportResultRow)", "@odata.
HTTP Response Codes 200 POST Usage Examples Input: [19114] 2.3.6 /api/ReportService/Actions/ReportService.DownloadReport POST Description Download Reports Privilege VIEW HTTP Response Codes 200 POST Usage Examples Input: {"ReportDefId":2864,"Format":"csv"} Output: { "FilePath": "/var/log/dell/omc/reports/Alert Counts per Device Report.csv" } Groups service 2.4.1 /api/GroupService/Groups GET Description Get the groups Privilege VIEW HTTP Response Codes 200 GET Usage Examples Input: Output: { "@odata.
} }] "TypeId": 2000, "MembershipTypeId": 24, "Devices": [ { "@odata.id": "/api/GroupService/Groups(1214)/Devices" } ], "AllLeafDevices": [ { "@odata.id": "/api/GroupService/Groups(1214)/AllLeafDevices" } ], "GroupHierarchy": [ { "@odata.id": "/api/GroupService/Groups(1214)/GroupHierarchy" } ], "SubGroups": [ { "@odata.id": "/api/GroupService/Groups(1214)/SubGroups" } ], "GroupDevicesSummary": [ { "@odata.id": "/api/GroupService/Groups(1214)/GroupDevicesSummary" } ], "GroupQuery": [ { "@odata.
}, { }, { } } ] "Count": 2 "StatusType": 2000, "Count": 30 "StatusType": 1000, "Count": 12 2.4.3 /api/GroupService/Groups(groupId)/EventStatusSummary GET Description Get Event Status counts per status value Privilege VIEW HTTP Response Codes 200 GET Usage Examples Input: Output: { "@odata.context": "/api/$metadata#Collection(GroupService.StatusSummary)", "@odata.count": 2, "value": [ { "StatusType": 16, "Count": 184 }, { "StatusType": 8, "Count": 3 } ] } 2.4.
"AuditId": 61, "Id": 9114, "Name": "disc-226-10", "Description": "Discovery: disc-226-10", "GlobalStatus": 4000, "ParentId": 1764, "CreationTime": "2017-11-29 17:52:41.423", "UpdatedTime": "2017-11-29 20:25:00.373", "CreatedBy": "system", "UpdatedBy": "", "Visible": true, "DefinitionId": 9064, "DefinitionDescription": "Discovery: disc-226-10", "TypeId": 4000, "MembershipTypeId": 12, "GroupOperation": 1, "GroupHierarchyOperation": 1, "AuditDateTime": "2017-11-29 17:52:41.
}] } "Value":"2000", "RightParen": false } Output: 19264 2.4.6 /api/GroupService/Actions/GroupService.
GROUP_MANAGEMENT HTTP Response Codes 200 POST Usage Examples Input: { "Id":19164, "Name":"s1 Clone", "Description":"", "ParentId":1914 } Output: 39564 2.4.8 /api/GroupService/Actions/GroupService.AddMemberDevices POST Description Add devices to a group Privilege GROUP_MANAGEMENT HTTP Response Codes 204 POST Usage Examples Input: { "GroupId": 8814, "MemberDeviceIds": [5064] } 2.4.9 /api/GroupService/Actions/GroupService.
HTTP Response Codes 204 POST Usage Examples Input: { "UserId":39614, "GroupIds":[ 19214, 12641 ] } 2.4.11 /api/GroupService/Actions/GroupService.DeleteGroup POST Description Delete a group Privilege GROUP_MANAGEMENT HTTP Response Codes 204 POST Usage Examples Input: { "GroupIds": [ 39564 ] } Device service 2.5.1 /api/DeviceService/GlobalExcludes GET Description Get the Globally excluded ranges Privilege VIEW HTTP Response Codes 200 GET Usage Examples Input: Output: { "@odata.
}, { } ] } ] } "@odata.id": "/api/DeviceService/GlobalExcludes(2)", "Id": 2, "Identifier": "Exclude-2017112215233131", "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 2, "NetworkAddress": "10.36.0.0-10.36.0.10", "Subnet": null } ] 2.5.2 /api/DeviceService/GlobalExcludes POST Description Globally exclude devices Privilege APPLIANCE_SETUP HTTP Response Codes 201 POST Usage Examples Input: { "DeviceIds":[ 2464, 2614, 2514 ] } Output: True 2.5.3 /api/DeviceService/Actions/DeviceService.
} ] 2.5.4 /api/DeviceService/Actions/DeviceService.EditNetworkRange POST Description Edit ranges in Global Exclusion Privilege APPLIANCE_SETUP HTTP Response Codes 204 POST Usage Examples Input: { "Id": 4, "Identifier": "IPRange2", "DeviceType": 0, "GlobalExcludeDetails": [ { "Id": 0, "NetworkAddress": "10.37.0.101-10.37.0.255" } ] } 2.5.5 /api/DeviceService/Actions/DeviceService.
{ ] } "Id":0, "NetworkAddress":"10.35.0.0" } OutPut : { "NetworkAddress": [] } POST Usage Examples : Invalid Range Input: { "Id":0, "Identifier":"Exclude-2017112215503232", "DeviceType":0, "GlobalExcludeDetails":[ { "Id":0, "NetworkAddress":"10.35.0.*" } ] } OutPut : { "NetworkAddress": [ "10.35.0.*" ] } QuerySupport service 2.6.
}, { }, { } } ] "Description": null, "BaseCategoryId": 2 "@odata.id": "/api/QuerySupportService/QueryContextSummaries(2)", "Id": 2, "Name": "Devices", "Description": null, "BaseCategoryId": 1 "@odata.id": "/api/QuerySupportService/QueryContextSummaries(3)", "Id": 3, "Name": "Servers", "Description": null, "BaseCategoryId": 1 2.6.
}, { }, { }, { }, { "Name": "Task Start Time", "TableId": 3, "Description": null, "FieldTypeId": 3, "StrMaxLen": 0, "EnumOpts": [] "Id": 13, "Name": "Task Last Update Time", "TableId": 3, "Description": null, "FieldTypeId": 3, "StrMaxLen": 0, "EnumOpts": [] "Id": 14, "Name": "Task Executed By", "TableId": 3, "Description": null, "FieldTypeId": 1, "StrMaxLen": 255, "EnumOpts": [] "Id": 11, "Name": "Task End Time", "TableId": 3, "Description": null, "FieldTypeId": 3, "StrMaxLen": 0, "EnumOpts": [] "Id": 1
}, { }, { }, { }, { }, { }, { }, { 40 ] } "Id": 2100, "Name": "Aborted" "Id": 2101, "Name": "Paused" "Id": 2102, "Name": "Stopped" "Id": 2103, "Name": "Canceled" "Id": 15, "Name": "Task Detail Start Time", "TableId": 4, "Description": null, "FieldTypeId": 3, "StrMaxLen": 0, "EnumOpts": [] "Id": 16, "Name": "Task Detail End Time", "TableId": 4, "Description": null, "FieldTypeId": 3, "StrMaxLen": 0, "EnumOpts": [] "Id": 17, "Name": "Task Status", "TableId": 4, "Description": null, "FieldTypeId": 4, "S
{ }, { }, { }, { }, { }, { }, { }, { }, { ] } "Id": 2090, "Name": "Warning" "Id": 2100, "Name": "Aborted" "Id": 2101, "Name": "Paused" "Id": 2102, "Name": "Stopped" "Id": 2103, "Name": "Canceled" "Id": 18, "Name": "Task Detail Key", "TableId": 4, "Description": null, "FieldTypeId": 1, "StrMaxLen": 255, "EnumOpts": [] "Id": 1, "Name": "Task Name", "TableId": 1, "Description": null, "FieldTypeId": 1, "StrMaxLen": 255, "EnumOpts": [] "Id": 2, "Name": "Task Description", "TableId": 1, "Description": nul
{ }, { }, { }, { }, { }, { }, { }, { }, { 42 ] } "Id": 2060, "Name": "Completed" "Id": 2070, "Name": "Failed" "Id": 2080, "Name": "New" "Id": 2090, "Name": "Warning" "Id": 2100, "Name": "Aborted" "Id": 2101, "Name": "Paused" "Id": 2102, "Name": "Stopped" "Id": 2103, "Name": "Canceled" "Id": 6, "Name": "Task Type", "TableId": 1, "Description": null, "FieldTypeId": 4, "StrMaxLen": 0, "EnumOpts": [ { "Id": 14, "Name": "Single Update Report" }, { "Id": 16, "Name": "Debug Logs" }, { "Id": 17, "Name": "Memb
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, "Id": 23, "Name": "Device Config" "Id": 24, "Name": "Onboarding Task" "Id": 25, "Name": "Password Rotation Task" "Id": 26, "Name": "ConfigDrift Monitor Task" "Id": 27, "Name": "Console Update Execution" "Id": 28, "Name": "Console Update" "Id": 1, "Name": "Alert Subscription" "Id": 2, "Name": "Compliance" "Id": 3, "Name": "Device Action" "Id": 29, "Name": "Discovery" "Id": 4, "Name": "Update" "Id": 5, "Name": "Healt
{ }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { 44 ] } "Id": 12, "Name": "Repository" "Id": 13, "Name": "Rollback Software" "Id": 15, "Name": "Subscription Poller" "Id": 30, "Name": "Diagnostic" "Id": 31, "Name": "Report" "Id": 32, "Name": "MobileSubscription Task" "Id": 33, "Name": "Purge" "Id": 34, "Name": "Device Config Purge Task" "Id": 35, "Name": "Warranty" "Id": 36, "Name": "ConsoleUpdateEmail Task" "Id": 3, "Name": "Task Next Run", "TableId": 1, "Description": null, "FieldTypeI
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, { } ] } ] } "Id": 2030, "Name": "Queued" "Id": 2040, "Name": "Starting" "Id": 2050, "Name": "Running" "Id": 2060, "Name": "Completed" "Id": 2070, "Name": "Failed" "Id": 2080, "Name": "No Schedule" "Id": 2090, "Name": "Warning" "Id": 2100, "Name": "Aborted" "Id": 2101, "Name": "Paused" "Id": 2102, "Name": "Stopped" "Id": 2103, "Name": "Canceled" "Id": 5, "Name": "Task Enabled", "TableId": 1, "Description": null, "FieldTypeId": 5, "StrMaxLen":
Privilege VIEW HTTP Response Codes 200 GET Usage Examples Output: { "@odata.context": "/api/$metadata#QuerySupportService.OperatorInfo/$entity", "@odata.
}, { }, { }, { }, { } ] } "FieldTypeId": null, "Name": "String", "OperatorIds": [ 1, 2, 3, 4, 5, 6, 11, 12, 7, 8, 9, 10 ] "FieldTypeId": null, "Name": "Number", "OperatorIds": [ 1, 2, 3, 4, 5, 6, 9, 10 ] "FieldTypeId": null, "Name": "Date-Time", "OperatorIds": [ 1, 2, 13, 14, 9, 10 ] "FieldTypeId": null, "Name": "Enum", "OperatorIds": [ 1, 2, 9, 10 ] "FieldTypeId": null, "Name": "Boolean", "OperatorIds": [ 1, 2, 9, 10 ] 2.6.4 /api/QuerySupportService/QueryContexts(contextId)/QuerySupportService.
Privilege VIEW HTTP Response Codes 200 POST Usage Examples Input: {"contextId":2} Output: [ { "Id": 15, "Name": "Dell Compellent Arrays", "UsageId": 1, "FilterText": "", "ContextId": 2 }, { "Id": 12, "Name": "Dell iDRAC Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 }, { "Id": 9, "Name": "Dell Networking Switches", "UsageId": 1, "FilterText": "", "ContextId": 2 }, { "Id": 10, "Name": "Fibre Channel Switches", "UsageId": 1, "FilterText": "", "ContextId": 2 }, { "Id": 19, "Name": "HCI Appliances", "
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { }, "FilterText": "", "ContextId": 2 "Id": 8, "Name": "Network Devices", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 24, "Name": "Non-Dell Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 22, "Name": "OEM Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 4, "Name": "PowerEdge Chassis", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 5, "Name": "PowerEdge FX2", "UsageId": 1, "FilterText": "", "ContextId": 2 "
{ }, { }, { ] } "Id": 20, "Name": "VxRAIL", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 23, "Name": "Windows Servers", "UsageId": 1, "FilterText": "", "ContextId": 2 "Id": 21, "Name": "XC", "UsageId": 1, "FilterText": "", "ContextId": 2 2.6.5 /api/QuerySupportService/Filters(filterId) GET Description Get detailed information for a specific query filter. Privilege VIEW HTTP Response Codes 200 POST Usage Examples Output: { "@odata.context": "/api/$metadata#QuerySupportService.
Privilege VIEW HTTP Response Codes 200 Sample Json Output { "@odata.context": "/api/$metadata#Collection(MIBImportService.GetTrapsPayload)", "@odata.count": 1894, "value": [{ "EnterpriseOid": ".1.3.6.1.4.1.674.10892.1", "EventDefinition": { "Name": "alertBatteryNormal", "EventCategory": { "Id": 1000, "EventCategoryName": "System Health" }, "EventCatalog": { "EventCatalogId": 1000, "Name": "OMSA", "ReleaseVersion": "7.4.
"Id": 1000, "EventCategoryName": "System Health" }, "EventDefinitionId": 1004542258, "EventSubCategory": { "Description": "Removable Flash media events", "Name": "vFlash Event", "Id": 4500, "Prefix": "RFM" }, "EventType": { "EventTypeId": 1001, "Name": "SNMP", "Description": "SNMP event" }, "Name": "test new", "Description": "test description", "Severity": { "Description": "Critical", "Name": "Critical", "Id": 16 } }] }, "FormatString": "$3", "GenericTrapId": 6, "SnmpEventId": 1142, "SpecificTrapId": 575
"EventSubCategory": null, "EventType": { "EventTypeId": 1001, "Name": "SNMP", "Description": "SNMP event" }, "Name": "apcUserScheduleViolationCleared", "Description": "INFORMATIONAL: User schedule violation has been cleared.\n The first argument is the host device serial number.\n The second argument is the host device name.\n The third argument is the host device location.\n The fourth argument is the door identifier, (1=front, 2=rear).
2.7.6 /api/MIBImportService/MIBImportService/EventCatalogs GET GET Event Catalogs Privilege VIEW HTTP Response Codes 200 Sample Json Output { "@odata.context": "/api/$metadata#Collection(MIBImportService.MIBEventCatalog)", "@odata.count": 46, "value": [{ "@odata.id": "/api/MIBImportService/EventCatalogs(1001)", "BuiltIn": true, "EventCatalogId": 1001, "CatalogName": "iDRAC", "InternalName": "IDRAC-MIB-SMIv2", "ReleaseVersion": "v3.3" }] } 2.7.
"Id":0, "JobName":"tsr0", "JobDescription":"tsr", "Schedule":"startnow", "State":"Enabled", "JobType":{ "Id":27, "Name":"Diagnostic_Task" }, "Params":[ { "Key":"deviceTypes", "Value":"1000" }, { "Key":"operationName", "Value":"SERVER_EXECUTE_TSR" }, { "Key":"fileName", "Value":"tsrAmitHarWareData0" }, { "Key":"OPERATION_NAME", "Value":"SERVER_EXECUTE_TSR" }, { "Key":"ShareType", "Value":"2" }, { "Key":"DataSelectorArrayIn", "Value":"[3]" }, { "Key":"ScheduledStartTime", "Value":"TIME_NOW" } ], "Targets":[ {
"Id":2080, "Name":"New" } }, "Targets":[ { "JobId":12214, "Id":4214, "Data":"", "TargetType":{ "Id":1000, "Name":"DEVICE" } } ], "Params":[ { "JobId":12214, "Key":"ScheduledStartTime", "Value":"TIME_NOW" }, { "JobId":12214, "Key":"DataSelectorArrayIn", "Value":"[3]" }, { "JobId":12214, "Key":"ShareType", "Value":"2" }, { "JobId":12214, "Key":"OPERATION_NAME", "Value":"SERVER_EXECUTE_TSR" }, { "JobId":12214, "Key":"fileName", "Value":"tsrAmitHarWareData0" }, { "JobId":12214, "Key":"operationName", "Value":
{ }, { }, { }, { }, { }, { }, { } "Key":"fileName", "Value":"FinalTest" "Key":"operationName", "Value":"SERVER_DIAGNOSTIC" "Key":"OPERATION_NAME", "Value":"SERVER_DIAGNOSTIC" "Key":"ShareType", "Value":"2" "Key":"RunMode", "Value":"0" "Key":"RebootJobType", "Value":"2" "Key":"ScheduledStartTime", "Value":"TIME_NOW" } ], "Targets":[ { "Id":4214, "Data":"", "TargetType":{ "Id":4214, "Name":"SERVER" } } ] Output: { "Id":12314, "JobName":"DiagnosticTest", "JobDescription":"DiagnosticTest", "NextRun":null, "
} } } "Id":1000, "Name":"DEVICE" ], "Params":[ { "JobId":12314, "Key":"ScheduledStartTime", "Value":"TIME_NOW" }, { "JobId":12314, "Key":"RebootJobType", "Value":"2" }, { "JobId":12314, "Key":"RunMode", "Value":"0" }, { "JobId":12314, "Key":"ShareType", "Value":"2" }, { "JobId":12314, "Key":"OPERATION_NAME", "Value":"SERVER_DIAGNOSTIC" }, { "JobId":12314, "Key":"operationName", "Value":"SERVER_DIAGNOSTIC" }, { "JobId":12314, "Key":"fileName", "Value":"FinalTest" }, { "JobId":12314, "Key":"deviceTypes",
Filter name Description DeviceOperation ‘SERVER_DIAGNOSTIC’ to get diagnostic files. ‘SERVER_EXECUTE_TSR’ to get TSR files. Output { "@odata.context":"/api/$metadata#Collection(TroubleshootService.FileResponseModel)", "@odata.count":2, "value":[ { "DeviceId":4214, "DeviceOperation":"SERVER_EXECUTE_TSR", "JobId":0, "FileName":"testAmit.zip", "FilePath":"/shared/dell/omc/cifs/idrac/1234567/SERVER_EXECUTE_TSR/testAmit/ testAmit.
HTTP Response Codes 200 GET Usage Examples Output: { "@odata.context": "/api/$metadata#Collection(TemplateService.TemplateTypeModel)", "@odata.count": 4, "value": [ { "@odata.id": "/api/TemplateService/TemplateTypes(0)", "Id": 0, "Name": "None", "ConfigurationSections": [] }, { "@odata.id": "/api/TemplateService/TemplateTypes(2)", "Id": 2, "Name": "Server", "ConfigurationSections": [] }, { "@odata.
}, { }, { } ] } "Description": "Deployment" "@odata.id": "/api/TemplateService/TemplateViewTypes(3)", "Id": 3, "Description": "Inventory" "@odata.id": "/api/TemplateService/TemplateViewTypes(4)", "Id": 4, "Description": "Sample" 2.9.3 /api/TemplateService/Templates GET Description Get the templates. Privilege VIEW HTTP Response Codes 200 GET Usage Examples Output: { "@odata.context": "/api/$metadata#Collection(TemplateService.Template)", "@odata.count": 8, "value": [ { "@odata.
}, { }, { }, { 62 "CreatedBy": "system", "CreationTime": "2017-11-30 19:02:11.200378", "LastUpdatedBy": null, "LastUpdatedTime": "2017-11-30 19:02:11.200378", "Views": [ { "@odata.id": "/api/TemplateService/Templates(2)/Views" } ] "@odata.
}, { }, { ", }, { "Views": [ { "@odata.id": "/api/TemplateService/Templates(5)/Views" } ] "@odata.id": "/api/TemplateService/Templates(6)", "Id": 6, "Name": "iDRAC 14G Enable Power Profile for Database", "Description": "Tune workload for Power Optimized Database ", "SourceDeviceId": 0, "TypeId": 2, "ViewTypeId": 4, "TaskId": 0, "HasIdentityAttributes": false, "Status": 0, "IdentityPoolId": 0, "IsBuiltIn": true, "CreatedBy": "system", "CreationTime": "2017-11-30 19:02:11.
} } ] ] } POST Description Create a template. Privilege DEVICE_CONFIGURATION HTTP Response Codes 200 POST Usage Examples: Create a template Input: { "Name": "Test Create", "TypeId": 2, "ViewTypeId": 2, "SourceDeviceId": 5514, "Fqdds": "idrac,system,nic,lifecycleController,eventFilters" } Output: ID of template. 2.9.4/api/TemplateService/Templates(templateId) GET Description Get a template by TemplateID. Privilege VIEW HTTP Response Codes 200 GET Usage Examples Output: { "@odata.
} ] PUT Description Update a template. Privilege DEVICE_CONFIGURATION HTTP Response Codes 200 PUT Usage Examples: Update a template Input: { “Id": 17, "Name": "Test Create Renamed" } Output: ID of template. PUT Usage Examples: Update a compliance template attriubtes Input: { "Id": 12, "Name": "Example Compliance Template", "Attributes": [{ "Id": 3592, "Value": "Test OS Name", "IsIgnored": false }] } Output: ID of template. DELETE Description Delete a template.
"@odata.id": "/api/TemplateService/Templates(10)/Views(1)", "Id": 1, "Name": "TemplateSpecific", "Description": "The hierarchy consists of template specific component classes, groups (from the attribute registry) and attributes.", "AttributeViewDetails": { "@odata.id": "/api/TemplateService/Templates(10)/Views(1)/ AttributeViewDetails" }, "DeviceAttributeViewDetails": [ { "@odata.id": "/api/TemplateService/Templates(10)/Views(1)/ DeviceAttributeViewDetails" } ] }, { "@odata.
"@odata.id": "/api/TemplateService/Templates(10)/Views(1)", "Id": 1, "Name": "DefaultModel", "Description": "The default hierarchical model of a template. The hierarchy consists of component classes, groups (from the attribute registry) and attributes.", "AttributeViewDetails": { "@odata.id": "/api/TemplateService/Templates(10)/Views(1)/AttributeViewDetails" }, "DeviceAttributeViewDetails": [ { "@odata.id": "/api/TemplateService/Templates(10)/Views(1)/ DeviceAttributeViewDetails" } ] } 2.9.
}, { }, { }, { }, { }, { Restart", }, { }, { 68 "AttributeId": 3563, "CustomId": 0, "AttributeEditInfoId": 1858, "DisplayName": "LCAttributes 1 Provisioning Server", "Description": null, "Value": null, "IsReadOnly": false, "IsIgnored": false "AttributeId": 3559, "CustomId": 0, "AttributeEditInfoId": 1644, "DisplayName": "LCAttributes 1 Part Firmware Update", "Description": null, "Value": "Match firmware of replaced part", "IsReadOnly": false, "IsIgnored": false "AttributeId": 3558, "CustomId": 0, "
}, { ] } "AttributeEditInfoId": 1860, "DisplayName": "LCAttributes 1 Automatic Update Feature", "Description": null, "Value": "Disabled", "IsReadOnly": false, "IsIgnored": false "AttributeId": 3566, "CustomId": 0, "AttributeEditInfoId": 1861, "DisplayName": "LCAttributes 1 Automatic Backup Feature", "Description": null, "Value": "Disabled", "IsReadOnly": false, "IsIgnored": false } ], "Attributes": [] } ], "TemplateEditInfoDetails": { "@odata.
"Description": "Specify the iSCSI Qualified Name (IQN) of the eighth iSCSI storage target.", "IsReadOnly": false, "IsSecure": false, "TextMinLength": 0, "TextMaxLength": 223, "ValueMin": 0, "ValueMax": 0, "DependencyText": null, "OptionSetId": 0, "DefaultOptionId": 0 }, { "Id": 2875, "DataType": 18, "Description": "Specify the iSCSI Qualified Name (IQN) of the fifth iSCSI storage target.
} ] 2.9.9 /api/TemplateService/Templates(tempalteId)/Views(idView)/DeviceAttributeViewDetails(deviceId) GET Description Get a template view’s device attribute details (device specific attributes) by TemplateID, ViewID and DeviceID. Privilege VIEW HTTP Response Codes 200 GET Usage Examples Output: { "@odata.context": "/api/$metadata#TemplateService.AttributeViewDetail/$entity", "@odata.
}, { ] }, { }, { 72 } "IsReadOnly": false, "IsIgnored": false "AttributeId": 0, "CustomId": 43, "AttributeEditInfoId": 0, "DisplayName": "Vlan UnTagged", "Description": null, "Value": "0", "IsReadOnly": false, "IsIgnored": false } ], "Attributes": [] "GroupNameId": 1, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId": 2, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3350, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Mi
] }, { }, { } "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX Bandwidth", "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false } ], "Attributes": [] "GroupNameId": 1, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId": 4, "DisplayName": "Partition ", "SubAttributeGroups": [], "Attributes": [ { "AttributeId": 3388, "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX Bandwidth", "Description": null, "Va
}, { }, { ] }, { }, { 74 } "IsReadOnly": false, "IsIgnored": false "AttributeId": 0, "CustomId": 47, "AttributeEditInfoId": 0, "DisplayName": "Vlan Tagged", "Description": null, "Value": null, "IsReadOnly": false, "IsIgnored": false "AttributeId": 0, "CustomId": 47, "AttributeEditInfoId": 0, "DisplayName": "Vlan UnTagged", "Description": null, "Value": "0", "IsReadOnly": false, "IsIgnored": false } ], "Attributes": [] "GroupNameId": 2, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId":
}, { ] }, { "CustomId": 0, "AttributeEditInfoId": 2969, "DisplayName": "Partition n Minimum TX Bandwidth", "Description": null, "Value": "20", "IsReadOnly": false, "IsIgnored": false } "AttributeId": 3504, "CustomId": 0, "AttributeEditInfoId": 2968, "DisplayName": "Partition n Maximum TX Bandwidth", "Description": null, "Value": "100", "IsReadOnly": false, "IsIgnored": false } ], "Attributes": [] "GroupNameId": 2, "DisplayName": "Port ", "SubAttributeGroups": [ { "GroupNameId": 4, "DisplayName": "Part
Description Clone a template. Privilege DEVICE_CONFIGURATION HTTP Response Codes 200 POST Usage Examples: Clone a template Input: { "SourceTemplateId": 11, "NewTemplateName": "Example Test Clone" } Output: ID of cloned template. 2.9.11/api/TemplateService/Actions/TemplateService.Export POST Description Export a template.
DEVICE_CONFIGURATION HTTP Response Codes 200 POST Usage Examples : Import a template Input: { "Name": "Import Test", "Type": 2, "Content": "\r \n \r\n Enabled\r\n Disabled\r\n
\">Enabled\r\n 115200\r\n Administrator\r\n 10\r\n 255\r\n Enabled\r\n public\r\n SNMPv1\r\n
"BootToNetwork": true, "ShareType": "CIFS", "IsoPath": "bootToIsoPath.iso", "ShareDetail": { "IpAddress": "1.2.3.4", "ShareName": "1.2.3.4", "User": "bootToIsoUsername", "Password": "bootToIsoPassword" } } }, "Attributes": [], "Options": { "ShutdownType": 0, "TimeToWaitBeforeShutdown": 300, "EndHostPowerState": 1 }, "Schedule": { "RunNow": true, "RunLater": false } Output: Id of created task. /api/TemplateService/Actions/TemplateService.
}, { }, { }, { }, { }, { }, { }, { }, { }, { }, { } "Value": "100", "IsIgnored": false "Id": 3388, "Value": "30", "IsIgnored": false "Id": 3389, "Value": "100", "IsIgnored": false "Id": 3431, "Value": "20", "IsIgnored": false "Id": 3432, "Value": "100", "IsIgnored": false "Id": 3484, "Value": "30", "IsIgnored": false "Id": 3485, "Value": "100", "IsIgnored": false "Id": 3503, "Value": "20", "IsIgnored": false "Id": 3504, "Value": "100", "IsIgnored": false "Id": 3522, "Value": "30", "IsIgnored": fa
GET Usage Examples Input: Output: { "@odata.context": "/api/$metadata#Collection(TemplateService.Baseline)", "@odata.count": 2, "value": [ { "@odata.
}, "DeviceConfigComplianceReports": [ { "@odata.id": "/api/TemplateService/Baselines(1)/ DeviceConfigComplianceReports" } ] } ] } POST Description Create or update a baseline.
} Output: { "Id": 0, "Name": "Example Group Compliance Baseline - Renamed", "Description": null, "LastRun": null, "TemplateId": 12, "TemplateName": null, "TemplateType": 0, "TaskId": 0, "ConfigComplianceSummary": null, "BaselineTargets": [{ "Id": 1164, "Type": { "Id": 1000, "Name": "Group" } }] } 2.9.16 /api/TemplateService/Baselines(baselineId) GET Description Get the configuration compliance baseline by BaselineID. Privilege VIEW HTTP Response Codes 200 GET Usage Examples Input: Output: { "@odata.
} }, "DeviceConfigComplianceReports": [ { "@odata.id": "/api/TemplateService/Baselines(1)/DeviceConfigComplianceReports" } ] DELETE Description Delete a baseline. Privilege DEVICE_CONFIGURATION HTTP Response Codes 204 2.9.17 /api/TemplateService/Baselines(baselineId)/DeviceConfigComplianceReports GET Description Get the configuration compliance baseline device report by BaselineID. Privilege VIEW HTTP Response Codes 200 GET Usage Examples Input: Output: { "@odata.
} ] 2.9.18 /api/TemplateService/Baselines(baselineId)/DeviceConfigComplianceReports(deviceId)/DeviceComplianceDetails GET Description Get the configuration compliance baseline device compliance details report by BaselineID and DeviceID. Privilege VIEW HTTP Response Codes 200 GET Usage Examples Input: Output: { "@odata.context": "/api/$metadata#TemplateService.DeviceComplianceDetail/$entity", "@odata.
the compliance template." }, { "Value": null, "ExpectedValue": "Enabled", "ComplianceStatus": 1, "ComplianceReason": "All attributes on the target device(s) match "AttributeId": 3584, "CustomId": 0, "DisplayName": "ServerPwr 1 Power Cap Value", "Description": null, "Value": null, "ExpectedValue": "227", "ComplianceStatus": 1, "ComplianceReason": "All attributes on the target device(s) match the compliance template.
{ "GroupNameId": 6, "DisplayName": "Unknown", "ComplianceStatus": 1, "ComplianceReason": "All attributes on the target device(s) match the compliance template.", "ComplianceSubAttributeGroups": [], "Attributes": [ { "AttributeId": 3582, "CustomId": 0, "DisplayName": "ThermalSettings 1 ThirdPartyPCIFanResponse", "Description": null, "Value": null, "ExpectedValue": "Enabled", "ComplianceStatus": 1, "ComplianceReason": "All attributes on the target device(s) match the compliance template.
Restart", the compliance template." }, { the compliance template." }, { the compliance template." }, { the compliance template." }, { the compliance template." }, { the compliance template.
the compliance template.
