Page is loading ...
OpenManage Enterprise Version 3.4 and
OpenManage Enterprise - Modular Edition
Version 1.20.00
RESTful API Guide
June 2020
Rev. A00
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 - 2020 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other
trademarks may be trademarks of their respective owners.
Chapter 1: About this document......................................................................................................17
Chapter 2: Overview...................................................................................................................... 19
RESTful application programming interface..................................................................................................................... 19
OData.....................................................................................................................................................................................19
JSON data.............................................................................................................................................................................19
HTTPS communication........................................................................................................................................................19
OpenManage Enterprise – Modular Edition.....................................................................................................................20
OpenManage Enterprise.....................................................................................................................................................20
Chapter 3: Key integration concepts............................................................................................... 21
Base URI................................................................................................................................................................................21
OEM scheme.................................................................................................................................................................. 21
Redfish scheme..............................................................................................................................................................23
Security.................................................................................................................................................................................23
Authentication......................................................................................................................................................................23
Authorization........................................................................................................................................................................24
Resource addressing...........................................................................................................................................................26
Resource operations............................................................................................................................................................27
Security considerations.......................................................................................................................................................27
Data filtering.........................................................................................................................................................................27
Data sorting..........................................................................................................................................................................28
Data pagination....................................................................................................................................................................28
Request headers..................................................................................................................................................................28
Response codes...................................................................................................................................................................29
Response headers............................................................................................................................................................... 29
Chapter 4: Application settings.......................................................................................................31
Network.................................................................................................................................................................................31
/api/ApplicationService/Network............................................................................................................................... 31
/api/ApplicationService/Network/WebServerConfiguration................................................................................. 32
/api/ApplicationService/Network/TimeConfiguration............................................................................................ 33
/api/ApplicationService/Network/TimeZones......................................................................................................... 34
/api/ApplicationService/Network/ProxyConfiguration...........................................................................................35
Security and user management.........................................................................................................................................36
/api/AccountService.................................................................................................................................................... 36
/api/AccountService/Accounts..................................................................................................................................39
/api/AccountService/Accounts(Id)............................................................................................................................ 41
/api/AccountService/Accounts(userId)/Permissions............................................................................................. 43
/api/AccountService/Actions/AccountService.GetPrivileges............................................................................... 44
/api/AccountService/Actions/AccountService.GetPrivilegesForUser................................................................. 44
/api/AccountService/Actions/AccountService.GetUserDetail..............................................................................45
/api/AccountService/Actions/AccountService.Enable...........................................................................................45
/api/AccountService/Actions/AccountService.Disable.......................................................................................... 46
Contents
Contents 3
/api/AccountService/Actions/AccountService.Delete........................................................................................... 46
/api/AccountService/Roles......................................................................................................................................... 47
/api/AccountService/Roles(Id)...................................................................................................................................47
/api/AccountService/ExternalAccountProvider.......................................................................................................48
/api/AccountService/ExternalAccountProvider/DirectoryServiceType...............................................................49
/api/AccountService/ExternalAccountProvider/ADAccountProvider..................................................................50
/api/AccountService/ExternalAccountProvider/ADAccountProvider(Id)............................................................ 51
/api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.TestADConnection....... 53
/api/AccountService/ExternalAccountProvider/LDAPAccountProvider.............................................................55
/api/AccountService/ExternalAccountProvider/LDAPAccountProvider(Id).......................................................57
/api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.TestLDAPConnection...59
/api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.SearchGroups................ 61
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.DeleteExternalAccountProvider..................................................................................62
/api/AccountService/Actions/AccountService.ImportExternalAccountProvider............................................... 62
Security and certificate management...............................................................................................................................64
/api/ApplicationService/Security............................................................................................................................... 64
/api/ApplicationService/Security/SecurityConfiguration....................................................................................... 64
/api/ApplicationService/Certificate........................................................................................................................... 65
/api/ApplicationService/Actions/ApplicationService.GenerateCSR..................................................................... 66
/api/ApplicationService/Actions/ApplicationService.UploadCertificate............................................................... 67
/api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.DSCertificate................. 67
Monitoring and alert notifications......................................................................................................................................68
api/AlertService/AlertDestinations/SNMPConfiguration........................................................................................68
api/AlertService/AlertDestinations/Actions/AlertDestinations.ApplySNMPConfig............................................ 69
/api/AlertService/AlertDestinations/SyslogConfiguration.......................................................................................71
api/AlertService/AlertDestinations/Actions/AlertDestinations.ApplySyslogConfig.............................................72
/api/AlertService/AlertDestinations/SMTPConfiguration...................................................................................... 73
/api/AlertService/AlertDestinations/Actions/AlertDestinations.SendTestTrap.................................................. 74
Chapter 5: Alerts.......................................................................................................................... 76
Alert logs...............................................................................................................................................................................76
/api/AlertService/Alerts...............................................................................................................................................76
/api/AlertService/Alerts?$filter=contains(UserName,'admin')..............................................................................78
/api/AlertService/Alerts?$filter=StatusType eq 2000............................................................................................78
/api/AlertService/Alerts?$filter=StatusType eq 1000............................................................................................ 82
/api/AlertService/Alerts?$filter=StatusType eq 1................................................................................................... 86
/api/AlertService/Alerts(Id)........................................................................................................................................ 87
/api/AlertService/AlertCategories..............................................................................................................................88
/api/AlertService/AlertCategories('Name').............................................................................................................. 89
/api/AlertService/AlertSeverities............................................................................................................................... 90
/api/AlertService/AlertSeverities(Id)..........................................................................................................................91
/api/AlertService/AlertStatuses................................................................................................................................. 92
/api/AlertService/AlertStatuses(Id)...........................................................................................................................92
/api/AlertService/AlertCatalogs................................................................................................................................. 93
/api/AlertService/AlertCatalogs(Id)...........................................................................................................................94
/api/AlertService/Events............................................................................................................................................ 95
/api/AlertService/Actions/AlertService.Acknowledge............................................................................................95
/api/AlertService/Actions/AlertService.Unacknowledge....................................................................................... 96
/api/AlertService/Actions/AlertService.RemoveAlerts...........................................................................................97
4
Contents
Alert policies......................................................................................................................................................................... 98
/api/AlertService/AlertPolicies................................................................................................................................... 98
/api/AlertService/AlertPolicies(Id)............................................................................................................................103
/api/AlertService/AlertPolicies(Arg1)/PolicyCriteria..............................................................................................109
/api/AlertService/AlertPolicies(Arg1)/PolicyCriteria(Arg2)...................................................................................110
/api/AlertService/AlertPolicies(Arg1)/PolicyActions............................................................................................... 111
/api/AlertService/AlertPolicies(Arg1)/PolicyActions(Arg2)...................................................................................112
/api/AlertService/AlertActionTemplates.................................................................................................................. 113
/api/AlertService/AlertActionTemplates(Id)............................................................................................................114
/api/AlertService/Actions/AlertService.EnableAlertPolicies..................................................................................114
/api/AlertService/Actions/AlertService.DisableAlertPolicies.................................................................................115
/api/AlertService/Actions/AlertService.RemoveAlertPolicies...............................................................................115
Alert definitions................................................................................................................................................................... 116
/api/AlertService/AlertMessageDefinitions..............................................................................................................116
/api/AlertService/AlertMessageDefinitions(Id)........................................................................................................117
/api/AlertService/AlertMessageDefinitionsCategories...........................................................................................118
/api/AlertService/AlertMessageDefinitionsCategories('Name')........................................................................... 119
Chapter 6: Configure................................................................................................................... 122
Firmware............................................................................................................................................................................. 122
/api/UpdateService/Catalogs....................................................................................................................................122
/api/UpdateService/Catalogs(Id).............................................................................................................................125
/api/UpdateService/Baselines...................................................................................................................................126
api/UpdateService/Baselines(Id).............................................................................................................................. 133
/api/UpdateService/Actions/UpdateService.GetBaselinesForDevices...............................................................135
api/UpdateService/FirmwareBaselineSummary......................................................................................................136
/api/UpdateService/Actions/UpdateService.CheckBaselinesAssociation..........................................................136
/api/UpdateService/ComplianceStatuses............................................................................................................... 136
/api/UpdateService/Baselines(Id)/DeviceComplianceReports............................................................................ 137
/api/UpdateService/Baselines(Id)/DeviceComplianceReports(Id)......................................................................138
/api/UpdateService/Actions/UpdateService.UploadFile.......................................................................................139
/api/UpdateService/Actions/UpdateService.RemoveFile.................................................................................... 140
/api/UpdateService/Actions/UpdateService.RefreshCatalogs............................................................................140
/api/UpdateService/Actions/UpdateService.RemoveCatalogs...........................................................................140
/api/UpdateService/Actions/UpdateService.RemoveBaselines...........................................................................141
/api/UpdateService/RollbackSoftwares...................................................................................................................141
/api/UpdateService/Actions/UpdateService.GetSingleDupDetails..................................................................... 142
/api/UpdateService/Actions/UpdateService.GetSingleDupReport.....................................................................142
/api/UpdateService/Actions/UpdateService.GetBaselinesReportByDeviceids.................................................144
/api/UpdateService/Actions/UpdateService.GetCertDetails...............................................................................145
Template Service............................................................................................................................................................... 145
/api/TemplateService/TemplateTypes.................................................................................................................... 145
/api/TemplateService/TemplateViewTypes............................................................................................................146
/api/TemplateService/Templates............................................................................................................................. 147
/api/TemplateService/Templates(Id).......................................................................................................................152
api/TemplateService/Templates(26)....................................................................................................................... 154
/api/TemplateService/Templates(Id)/Views..........................................................................................................156
/api/TemplateService/Templates(Id)/Views(Id)....................................................................................................157
/api/TemplateService/Templates(Id)/Views(Id)/AttributeViewDetails..............................................................158
/api/TemplateService/Templates(Id)/Views(Id)/AttributeViewDetails/TemplateEditInfoDetails...................161
Contents
5
/api/TemplateService/Templates(Id)/Views(Id)/DeviceAttributeViewDetails(Id)............................................163
/api/TemplateService/Templates(26)/Views(9)/DeviceAttributeViewDetails(10176).....................................168
/api/TemplateService/Actions/TemplateService.AssignIdentities...................................................................... 169
/api/TemplateService/Actions/TemplateService.GetAssignedIdentities............................................................169
/api/TemplateService/Actions/TemplateService.FreeReservedIdentities...........................................................171
/api/TemplateService/Actions/TemplateService.Clone.........................................................................................171
/api/TemplateService/Actions/TemplateService.Export...................................................................................... 172
/api/TemplateService/Actions/TemplateService.Import...................................................................................... 172
/api/TemplateService/Actions/TemplateService.Deploy...................................................................................... 174
/api/TemplateService/Actions/TemplateService.UpdateNetworkConfig...........................................................177
/api/TemplateService/Actions/TemplateService.RemoveBaseline..................................................................... 178
/api/TemplateService/Actions/TemplateService.Remediate .............................................................................. 178
Identity pools.......................................................................................................................................................................178
/api/IdentityPoolService/IdentityPools.................................................................................................................... 178
/api/IdentityPoolService/IdentityPools(Id)..............................................................................................................182
/api/IdentityPoolService/IdentityPools(Id)/UsageCounts.................................................................................... 184
/api/IdentityPoolService/IdentityPools(Id)/UsageIdentitySets............................................................................185
/api/IdentityPoolService/IdentityPoolsI(Id)/UsageIdentitySets(Id).................................................................... 186
/api/IdentityPoolService/IdentityPools(Id)/UsageIdentitySets(Id)/Details........................................................187
/api/IdentityPoolService/IdentityStates.................................................................................................................. 188
/api/IdentityPoolService/IdentityStates(Id)............................................................................................................188
/api/IdentityPoolService/Actions/IdentityPoolService.DeleteIdentityPools.......................................................189
Network Configuration Service........................................................................................................................................189
/api/NetworkConfigurationService/Networks........................................................................................................189
/api/NetworkConfigurationService/Networks(Id)..................................................................................................191
/api/NetworkConfigurationService/NetworkTypes...............................................................................................193
/api/NetworkConfigurationService/NetworkTypes(Id).........................................................................................194
/api/NetworkConfigurationService/QosTypes....................................................................................................... 194
/api/NetworkConfigurationService/QosTypes(Id).................................................................................................195
/api/NetworkConfigurationService/Actions/NetworkConfigurationService.RemoveNetworks.....................195
api/NetworkConfigurationService/Actions/NetworkConfigurationService.ImportVLANDefinitions...............196
api/NetworkConfigurationService/Actions/NetworkConfigurationService.ExportVLANDefinitions...............197
api/NetworkConfigurationService/Actions/NetworkConfigurationService.ValidateNetworkDefinitionFile... 197
Chapter 7: Devices.......................................................................................................................199
/api/DeviceService...........................................................................................................................................................200
GET method for DeviceService.................................................................................................................................200
/api/DeviceService/Devices...........................................................................................................................................200
GET method for Devices............................................................................................................................................200
/api/DeviceService/Devices?$filter=Type eq 1000.................................................................................................... 202
GET method for device filter..................................................................................................................................... 202
/api/DeviceService/Devices(Id).....................................................................................................................................207
GET method for Devices(Id)......................................................................................................................................207
/api/DeviceService/Devices(Id)/InventoryDetails...................................................................................................... 209
GET method for InventoryDetails............................................................................................................................. 209
/api/DeviceService/Devices(Id)/InventoryDetails(InventoryType)...........................................................................219
GET method for inventory details by inventory type.............................................................................................. 219
/api/DeviceService/Devices(Id)/Settings('ReplicableChassisConfigurations').......................................................220
PUT method to retrieve chassis time and alert destination settings....................................................................220
/api/DeviceService/Devices(Device_ID)/Settings('LocalAccessConfiguration')....................................................221
6
Contents
GET method for local access configuration..............................................................................................................221
/api/DeviceService/Devices(Id)/HardwareLogs......................................................................................................... 223
GET method for HardwareLogs................................................................................................................................ 223
/api/DeviceService/Devices(Id)/SubSystemHealth................................................................................................... 224
GET method for sub system health information..................................................................................................... 224
/api/DeviceService/Devices(Id)/RecentActivity.........................................................................................................225
GET method for RecentActivity................................................................................................................................225
/api/DeviceService/Devices(Id)/InventoryTypes........................................................................................................226
GET method for InventoryTypes...............................................................................................................................226
/api/DeviceService/Devices(Id)/LogSeverities...........................................................................................................226
GET method for LogSeverities..................................................................................................................................226
/api/DeviceService/Devices(Id)/Settings.................................................................................................................... 227
GET method for Settings........................................................................................................................................... 227
/api/DeviceService/Devices(Id)/Settings('Type').......................................................................................................227
GET method for device settings by type................................................................................................................. 228
PUT method for device settings by type................................................................................................................. 229
/api/DeviceService/Devices(Id)/Temperature.............................................................................................................231
GET method for Temperature....................................................................................................................................231
/api/DeviceService/Devices(Id)/BlinkStatus............................................................................................................... 232
GET method for LED blink status..............................................................................................................................232
/api/DeviceService/Devices(Id)/PowerUsageByDevice............................................................................................232
GET method for power usage by devices................................................................................................................232
/api/DeviceService/Devices(Id)/DeviceBladeSlots.....................................................................................................233
GET method for device blade slots...........................................................................................................................233
/api/DeviceService/Devices(Id)/GraphicInfo.............................................................................................................. 234
GET method for GraphicInfo..................................................................................................................................... 234
/api/DeviceService/Devices(Id)/DeployRequired....................................................................................................... 235
GET method for deployment by device IDs.............................................................................................................235
/api/DeviceService/Devices(Id)/SystemUpTime........................................................................................................235
GET method for /api/DeviceService/Devices(Id)/SystemUpTime.....................................................................235
/api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.UploadFSDCertificate............236
POST method for uploading FSD certificate...........................................................................................................236
/api/DeviceService/PowerStates..................................................................................................................................236
GET method for PowerStates...................................................................................................................................236
/api/DeviceService/DeviceStatuses..............................................................................................................................237
GET method for DeviceStatuses...............................................................................................................................237
/api/DeviceService/DeviceType.....................................................................................................................................237
GET method for DeviceType..................................................................................................................................... 237
/api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.SetTermState.........................238
POST method for setting term state........................................................................................................................238
/api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.GetTermState........................ 239
POST method for getting term state....................................................................................................................... 239
/api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.GetComputeIPs......................239
POST method for /api/DeviceService/Actions/DeviceService/Devices(Id)Actions/
DeviceService.GetComputeIPs............................................................................................................................. 239
/api/DeviceService/DeviceSummary............................................................................................................................ 240
GET method for DeviceSummary............................................................................................................................. 240
/api/DeviceService/DeviceSummary(Type).................................................................................................................242
GET method for /api/DeviceService/DeviceSummary(Type)............................................................................. 242
api/DeviceService/Actions/DeviceService.DevicesPrivilegesAction.........................................................................243
Contents
7
POST method for api/DeviceService/Actions/DeviceService.DevicesPrivilegesAction.................................. 243
/api/DeviceService/Actions/DeviceService.DevicesByPrivilegesAction..................................................................244
POST method for device privileges action...............................................................................................................244
/api/DeviceService/Actions/DeviceService.ExecuteAction...................................................................................... 244
POST method /api/DeviceService/Actions/DeviceService.ExecuteAction...................................................... 244
/api/DeviceService/DeviceSlotType............................................................................................................................. 244
GET method for DeviceSlotType.............................................................................................................................. 244
/api/DeviceService/DeviceSettingsMetadata............................................................................................................. 245
GET method for DeviceSettingsMetadata.............................................................................................................. 245
/api/DeviceService/GlobalExcludes...............................................................................................................................248
GET method for GlobalExcludes............................................................................................................................... 248
POST method for GlobalExcludes.............................................................................................................................249
/api/DeviceService/Actions/DeviceService.AddNetworkRange.............................................................................. 250
POST method for DeviceService.AddNetworkRange............................................................................................250
/api/DeviceService/Actions/DeviceService.EditNetworkRange.............................................................................. 250
POST method for DeviceService.EditNetworkRange............................................................................................250
/api/DeviceService/Actions/DeviceService.RemoveFromExclusion.........................................................................251
POST method for DeviceService.RemoveFromExclusion......................................................................................251
/api/DeviceService/Actions/DeviceService.ValidateExcludes................................................................................... 251
POST method for DeviceService.ValidateExcludes................................................................................................ 251
/api/DeviceService/Actions/DeviceService.RemoveDevices....................................................................................252
POST method for DeviceService.RemoveDevices.................................................................................................252
Chapter 8: Diagnostic.................................................................................................................. 253
/api/DeviceService/Devices(Id)/Actions/DeviceService.Diagnostic....................................................................... 253
POST method for DeviceService.Diagnostic...........................................................................................................253
Chapter 9: Groups.......................................................................................................................254
/api/GroupService/Groups............................................................................................................................................. 254
GET method for Groups.............................................................................................................................................254
/api/GroupService/Groups(Id).......................................................................................................................................256
GET method for Groups(Id)...................................................................................................................................... 256
PUT method for Groups(Id)...................................................................................................................................... 258
DELETE method for Groups(Id)................................................................................................................................259
/api/GroupService/Groups(Id)/Devices.......................................................................................................................259
GET method for Devices............................................................................................................................................259
/api/GroupService/Groups(Id)/GroupDevicesSummary............................................................................................ 261
GET method for GroupDevicesSummary................................................................................................................. 261
/api/GroupService/Groups(group id)/AllLeafDeviceSummaries...............................................................................262
GET method for AllLeafDeviceSummaries...............................................................................................................262
/api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000........................................281
Get method for AllLeafDeviceSummaries?$filter=Type eq 4000 ........................................................................ 281
/api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0 ...284
GET method for AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0....................................284
/api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&
$skip=0&$orderby=Identifier asc...............................................................................................................................288
GET method for AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0&
$orderby=Identifier asc.......................................................................................................................................... 288
/api/GroupService/Groups(Id)/SubGroups..................................................................................................................291
GET method for SubGroups.......................................................................................................................................291
8
Contents
/api/GroupService/Groups(Id)/GroupHierarchy.........................................................................................................293
GET method for GroupHierarchy..............................................................................................................................293
/api/GroupService/GroupTypes.................................................................................................................................... 293
GET method for GroupTypes.................................................................................................................................... 293
/api/GroupService/GroupTypes(Id).............................................................................................................................. 294
GET method for GroupTypes(Id)..............................................................................................................................294
/api/GroupService/MembershipTypes......................................................................................................................... 295
GET method for MembershipTypes......................................................................................................................... 295
/api/GroupService/MembershipTypes(Id)................................................................................................................... 296
GET method for MembershipTypes(Id)...................................................................................................................296
/api/GroupService/AllGroupsHierarchy........................................................................................................................ 296
GET method for AllGroupsHierarchy........................................................................................................................296
/api/GroupService/Actions/GroupService.AddMemberDevices...............................................................................297
POST method for GroupService.AddMemberDevices...........................................................................................297
/api/GroupService/Actions/GroupService.GroupsPrivilegesAction......................................................................... 297
POST method for GroupService.GroupsPrivilegesAction......................................................................................297
/api/GroupService/Actions/GroupService.GroupsByPrivilegesAction.....................................................................298
POST method for GroupService.GroupsByPrivilegesAction.................................................................................298
Chapter 10: Monitor.................................................................................................................... 299
Audit logs............................................................................................................................................................................299
/api/ApplicationService/AuditLogs.......................................................................................................................... 299
/api/ApplicationService/AuditLogs(Id)....................................................................................................................300
Jobs..................................................................................................................................................................................... 301
/api/JobService/Jobs.................................................................................................................................................301
/api/JobService/Jobs(Id)..........................................................................................................................................328
/api/JobService/JobStatuses...................................................................................................................................332
/api/JobService/JobStatuses(Id)............................................................................................................................ 333
/api/JobService/JobTypes........................................................................................................................................334
/api/JobService/JobTypes(Id)................................................................................................................................. 336
/api/JobService/Jobs(Id)/ExecutionHistories....................................................................................................... 336
/api/JobService/Jobs(Id)/ExecutionHistories(Id).................................................................................................338
/api/JobService/Actions/JobService.EnableJobs.................................................................................................339
/api/JobService/Actions/JobService.DisableJobs................................................................................................ 340
/api/JobService/Actions/JobService.RemoveJobs...............................................................................................341
/api/JobService/Actions/JobService.Schedule.....................................................................................................342
/api/JobService/Actions/JobService.RunJobs......................................................................................................342
/api/JobService/Actions/JobService.StopJobs.................................................................................................... 343
/api/JobService/Actions/JobService.Resume.......................................................................................................345
/api/JobService/Actions/JobService.ExecuteAction........................................................................................... 346
Chapter 11: Reset application........................................................................................................347
/api/ApplicationService/Actions/ApplicationService.ResetApplication.................................................................... 347
POST method for ResetApplication..........................................................................................................................347
Chapter 12: Console version......................................................................................................... 348
/api/ApplicationService/Info...........................................................................................................................................348
GET method for Info...................................................................................................................................................348
Contents
9
Chapter 13: Console capabilities................................................................................................... 349
/api/ApplicationService/Capabilities..............................................................................................................................349
GET method for Capabilities......................................................................................................................................349
Chapter 14: Search...................................................................................................................... 351
/api/SearchService/Actions/SearchService.Search................................................................................................... 351
POST method for SearchService.Search................................................................................................................. 351
Chapter 15: Session.....................................................................................................................353
/api/SessionService......................................................................................................................................................... 353
GET method for SessionService............................................................................................................................... 353
/api/SessionService/Sessions........................................................................................................................................ 354
GET method for Sessions.......................................................................................................................................... 354
POST method for Sessions........................................................................................................................................354
/api/SessionService/Sessions(Id)..................................................................................................................................355
GET method for Sessions(Id)....................................................................................................................................355
DELETE method for Sessions(Id)............................................................................................................................. 356
/api/SessionService/SessionConfiguration.................................................................................................................. 356
GET method for SessionConfiguration.....................................................................................................................356
/api/SessionService/Actions/SessionService.SessionConfigurationUpdate...........................................................358
POST method for SessionService.SessionConfigurationUpdate..........................................................................358
/api/SessionService/Actions/SessionService.Logoff................................................................................................. 359
POST method for session service log off................................................................................................................ 359
Chapter 16: APIs specific to OpenManage Enterprise – Modular Edition...........................................360
/api/ApplicationService/Settings...................................................................................................................................360
GET method for /api/ApplicationService/Settings................................................................................................360
/api/ApplicationService/Network/CurrentAddressConfiguration..............................................................................361
GET method for CurrentAddressConfiguration....................................................................................................... 361
/api/ApplicationService/Network/AddressConfiguration.......................................................................................... 362
GET method for AddressConfiguration....................................................................................................................362
PUT method for AddressConfiguration....................................................................................................................363
/api/ApplicationService/Actions/ApplicationService.GetConfiguration...................................................................365
POST method for ApplicationService.GetConfiguration....................................................................................... 365
/api/ApplicationService/Actions/ApplicationService.ApplyConfiguration................................................................375
POST method for ApplicationService.ApplyConfiguration.....................................................................................375
Brand.................................................................................................................................................................................. 385
/api/ApplicationService/Actions/ApplicationService.BrandInfo.......................................................................... 385
/api/ApplicationService/Actions/ApplicationService.ActivateBrand.................................................................. 386
Multichassis management................................................................................................................................................386
/api/ManagementDomainService.............................................................................................................................386
/api/ManagementDomainService/DiscoveredDomains........................................................................................ 392
/api/ManagementDomainService/ConfigurationTypes........................................................................................ 393
/api/ManagementDomainService/ConfigurationTypes(Id)..................................................................................395
/api/ManagementDomainService/Domains............................................................................................................395
/api/ManagementDomainService/Domains(Id)..................................................................................................... 399
/api/ManagementDomainService/PendingDomains............................................................................................. 400
/api/ManagementDomainService/PendingDomains(Id)........................................................................................401
10
Contents
/api/ManagementDomainService/Actions/ManagementDomainService.Domains.......................................... 402
/api/ManagementDomainService/Actions/ManagementDomainService.Join..................................................403
/api/ManagementDomainService/Actions/ManagementDomainService.Leave...............................................404
/api/ManagementDomainService/Actions/ManagementDomainService.Delete..............................................404
/api/ManagementDomainService/Actions/ManagementDomainService.DeleteGroup...................................405
/api/ManagementDomainService/GetSyncFailureAlertTimeoutValues..............................................................406
/api/ManagementDomainService/Actions/ManagementDomainService.ApproveJoin................................... 406
/api/ManagementDomainService/Actions/ManagementDomainService.AssignBackupLead.........................407
/api/ManagementDomainService/Actions/ManagementDomainService.ReassignBackupLead.................... 408
/api/ManagementDomainService/Actions/ManagementDomainService.UnassignBackupLead....................408
/api/ManagementDomainService/Actions/ManagementDomainService.PromoteBackupLead.................... 409
/api/ManagementDomainService/Actions/ManagementDomainService.RetireLead.......................................410
FIPS mode settings............................................................................................................................................................ 411
/api/ApplicationService/Security/SecurityConfiguration.......................................................................................411
Fabric management............................................................................................................................................................411
/api/NetworkService................................................................................................................................................... 411
/api/NetworkService/Fabrics....................................................................................................................................412
/api/NetworkService/FabricDesigns........................................................................................................................415
/api/NetworkService/Fabrics(Id)..............................................................................................................................417
/api/NetworkService/Fabrics(Id)/FabricDesigns...................................................................................................419
/api/NetworkService/Fabrics(Id)/ValidationErrors...............................................................................................420
/api/NetworkService/Fabrics(Id)/Uplinks.............................................................................................................. 423
/api/NetworkService/Fabrics(Id)/Uplinks(Id)........................................................................................................424
/api/NetworkService/Fabrics(Id)/Uplinks(Id)/Ports............................................................................................ 427
/api/NetworkService/Fabrics(Id)/Uplinks(Id)/Networks.................................................................................... 429
/api/NetworkService/Fabrics('Id')/NetworkService.GetApplicableUplinkNetworks........................................430
api/NetworkService/Fabrics(arg1)/NetworkService.GetApplicableUplinkUntaggedNetworks...................... 430
api/NetworkService/Fabrics(arg1)/Servers........................................................................................................... 430
/api/NetworkService/Fabrics(Id)/NetworkService.GetApplicableUplinkPorts.................................................435
api/NetworkService/Actions/NetworkService.UpdateServerUntaggedVLAN..................................................437
/api/NetworkService/Fabrics(Id)/Switches...........................................................................................................437
/api/NetworkService/Fabrics(arg1)/Actions/NetworkService.ReplaceSwitch................................................ 439
/api/NetworkService/Fabrics(Id)/Servers............................................................................................................. 439
/api/NetworkService/Fabrics(Id)/Topology...........................................................................................................442
/api/NetworkService/Fabrics(Id)/Topology/Nodes............................................................................................. 443
/api/NetworkService/Fabrics(Id)/Topology/Nodes(Id).......................................................................................444
/api/NetworkService/Actions/NetworkService.RemoveFabrics........................................................................ 445
/api/NetworkService/Actions/NetworkService.RemoveUplinks........................................................................ 446
/api/NetworkService/FabricDesigns(Id)/NetworkService.GetApplicableNodes.............................................. 447
/api/NetworkService/UplinkTypes.......................................................................................................................... 448
/api/NetworkService/NodeTypes............................................................................................................................449
/api/NetworkService/FabricActivityTypes............................................................................................................. 449
/api/NetworkService/FabricActivityStatuses........................................................................................................ 450
/api/NetworkService/FabricHealthStatuses...........................................................................................................451
/api/NetworkService/MultiChassisDomain............................................................................................................ 452
/api/NetworkService/MultiChassisDomain/Topology.......................................................................................... 452
/api/NetworkService/MultiChassisDomain/Topology/Nodes.............................................................................453
/api/NetworkService/MultiChassisDomain/Topology/Nodes(Id).......................................................................454
/api/NetworkService/MultiChassisDomain/Topology/Nodes(Id)/ChildNodes................................................ 454
/api/NetworkService/MultiChassisDomain/ValidationErrors...............................................................................456
Contents
11
/api/NetworkService/PortAdminStatuses..............................................................................................................458
/api/NetworkService/PortStatuses........................................................................................................................ 459
/api/NetworkService/PortBlinkStatuses................................................................................................................ 460
/api/NetworkService/PortRoles.............................................................................................................................. 460
api/NetworkService/ServerProfileBondingTechnologies...................................................................................... 461
api/NetworkService/ServerProfiles..........................................................................................................................461
api/NetworkService/ServerProfiles(Id)...................................................................................................................462
/api/NetworkService /ServerProfiles(arg1)............................................................................................................463
/api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles................................................................. 464
/api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2)......................................................466
/api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2)/Networks...................................467
api/NetworkService/ServerProfiles(Id)/ServerInterfaceProfiles........................................................................ 468
/api/NetworkService/Actions/NetworkService.ApplyServersInterfaceProfiles............................................... 468
/api/NetworkService/Actions/NetworkService.ModifyServerProfiles.............................................................. 469
/api/NetworkService/Actions/NetworkService.AddServerNetworks................................................................470
/api/NetworkService/Actions/NetworkService.DeleteServerNetworks............................................................ 471
/api/NetworkService/FeatureCapabilities............................................................................................................... 471
Port configuration in Fabrics............................................................................................................................................472
/api/JobService/Jobs................................................................................................................................................ 472
Storage management....................................................................................................................................................... 475
Assign enclosure.......................................................................................................................................................... 475
Clear enclosure assignment........................................................................................................................................476
Assign drives................................................................................................................................................................ 476
Clear drive assignment................................................................................................................................................477
Force-activate a SAS IOM......................................................................................................................................... 478
Clear configuration on SAS IOM................................................................................................................................479
Extract SAS IOM logs to NFS share.........................................................................................................................479
Extract SAS IOM logs to CIFS share........................................................................................................................480
Quick Deploy.......................................................................................................................................................................481
/api/JobService/Jobs.................................................................................................................................................481
Server NIC VLAN configuration...................................................................................................................................... 484
/api/NetworkService /ServerProfiles(arg1)........................................................................................................... 485
/api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles.................................................................486
/api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2)...................................................... 487
/api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2)/Networks...................................488
/api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2)/Networks (arg3).......................489
/api/NetworkService/Actions/NetworkService.ApplyServersInterfaceProfiles............................................... 489
Template Service.............................................................................................................................................................. 490
/api/TemplateService/Profiles................................................................................................................................. 490
/api/TemplateService/Profiles(Id)............................................................................................................................491
/api/TemplateService/ProfileState.......................................................................................................................... 491
/api/TemplateService/ProfileUsage........................................................................................................................ 492
/api/TemplateService/Actions/TemplateService.AttachProfile..........................................................................493
/api/TemplateService/Actions/TemplateService.AssociateProfile.....................................................................494
/api/TemplateService/Actions/TemplateService.UpdateProfile.........................................................................494
/api/TemplateService/Actions/TemplateService.MigrateProfile........................................................................495
/api/TemplateService/Actions/TemplateService.DetachProfile.........................................................................495
Chapter 17: APIs specific to OpenManage Enterprise..................................................................... 496
Application settings...........................................................................................................................................................496
12
Contents
Console update..................................................................................................................................................................496
/api/JobService/Jobs................................................................................................................................................496
/api/ConsoleUpdateService/Updates?$filter= Auto eq true............................................................................... 497
/api/ConsoleUpdateService/UpdateBundleInfo.....................................................................................................497
/api/ConsoleUpdateService/Actions/ConsoleUpdateService.DeleteUpgradeBundle......................................498
/api/ConsoleUpdateService/Actions/ConsoleUpdateService.DownloadBundle...............................................498
Mobile................................................................................................................................................................................. 499
/api/AlertService/MobileSubscriptions................................................................................................................... 499
/api/AlertService/SubscriptionNotificationService............................................................................................... 499
/api/AlertService/Actions/AlertService.CreateEditMobileSubscription.............................................................500
/api/AlertService/Actions/AlertService.DeleteMobileSubscription.................................................................... 500
/api/AlertService/Actions/AlertService.EnableSubscriptionNotificationService............................................... 501
/api/AlertService/Actions/AlertService.FilterAlertsByPolicy................................................................................501
Console Preferences........................................................................................................................................................ 502
/api/ApplicationService/Settings.............................................................................................................................502
/api/JobService/Jobs(10011)....................................................................................................................................503
/api/ApplicationService/Settings.............................................................................................................................504
/api/Console/UpdateConsoleSettings.................................................................................................................... 505
Alerts...................................................................................................................................................................................506
https://<IP>/api/ApplicationService/Settings...................................................................................................... 506
https://<IP>/api/AlertService/AlertDestinations/SMTPConfiguration.............................................................506
https://<IP>/api/AlertService/AlertDestinations/Actions/AlertDestinations.ApplySNMPConfig................. 507
https://<IP>/api/AlertService/AlertDestinations/Actions/AlertDestinations.ApplySyslogConfig ................ 507
Incoming Alerts..................................................................................................................................................................508
https://<IP>/api/ApplicationService/Settings...................................................................................................... 508
Warranty............................................................................................................................................................................ 509
https://<IP>/api/ApplicationService/Settings ..................................................................................................... 509
Network Configuration......................................................................................................................................................510
/api/ApplicationService/Network/AdapterConfigurations................................................................................... 510
/api/ApplicationService/Network/AdapterConfigurations('ens33')....................................................................512
/api/ApplicationService/Actions/Network.ConfigureNetworkAdapter...............................................................514
/api/NetworkConfigurationService/Actions/NetworkConfigurationService.ImportVLANFromTarget.......... 517
Configuration compliance................................................................................................................................................. 517
/api/TemplateService/Baselines .............................................................................................................................. 517
/ api/TemplateService/Baselines(ID)/DeviceConfigComplianceReports ...........................................................517
/api/TemplateService/Baselines(ID)/DeviceConfigComplianceReports(ID)/DeviceComplianceDetails .......518
Troubleshoot service......................................................................................................................................................... 518
/api/JobService/Jobs.................................................................................................................................................518
/api/TroubleshootService/Files................................................................................................................................520
/api/TroubleshootService/Actions/TroubleshootService.GetTroubleshootDocument.....................................521
/api/TroubleShootService/Actions/TroubleShootService.GetArchivedConsoleLogs.......................................521
/api/TroubleShootService/Actions/TroubleShootService.DeleteArchivedConsoleLogs................................. 522
Query support service...................................................................................................................................................... 522
/api/QuerySupportService/Queries.........................................................................................................................522
/api/QuerySupportService/Queries(Id).................................................................................................................. 523
/api/QuerySupportService/QueryContextSummaries.......................................................................................... 524
/api/QuerySupportService/QueryContextSummary(Id)...................................................................................... 525
/api/QuerySupportService/QueryContexts(Id).....................................................................................................525
/api/QuerySupportService/QueryContexts(Id)/QuerySupportService.GetFiltersForContext....................... 528
/api/QuerySupportService/OperatorInfo............................................................................................................... 530
Contents
13
/api/QuerySupportService/Filters........................................................................................................................... 533
/api/QuerySupportService/Filters(Id)..................................................................................................................... 534
Groups service...................................................................................................................................................................535
/api/GroupService/Groups....................................................................................................................................... 535
/api/GroupService/Groups(Id)/SubGroups(Id).....................................................................................................536
/api/GroupService/Groups(Id)/DeviceStatusSummary.......................................................................................536
/api/GroupService/Groups(Id)/EventStatusSummary.........................................................................................537
/api/GroupService/Groups(group id)/EventSeveritySummary?$filter=StatusType eq 2000........................537
/api/GroupService/Groups(group id)/EventSeveritySummary?$filter=StatusType eq 1000........................ 537
/api/GroupService/Groups(group id)/EventSeveritySummary$filter=StatusType eq 1..................................538
/api/GroupService/GroupAudits.............................................................................................................................. 538
/api/GroupService/Actions/GroupService.CreateGroup..................................................................................... 538
/api/GroupService/Actions/GroupService.UpdateGroup.................................................................................... 539
/api/GroupService/Actions/GroupService.Clone..................................................................................................539
/api/GroupService/Actions/GroupService.DeleteGroup......................................................................................539
/api/GroupService/Actions/GroupService.AddMemberDevices........................................................................ 540
/api/GroupService/Actions/GroupService.RemoveMemberDevices.................................................................540
/api/GroupService/Actions/GroupService.AddUserToGroups............................................................................ 541
Profiles.................................................................................................................................................................................541
/api/ProfileService/Profiles....................................................................................................................................... 541
/api/ProfileService/Profiles(arg)..............................................................................................................................542
/api/ProfileService/ProfileUsage............................................................................................................................. 542
/api/ProfileService/Profiles(arg1)/AttributeDetails...............................................................................................543
/api/ProfileService/Actions/ProfileService.Rename ............................................................................................543
/api/ProfileService/Actions/ProfileService.GetTargetSpecificAttributes..........................................................543
/api/ProfileService/Actions/ProfileService.GetIdentityAttributes...................................................................... 544
/api/ProfileService/Actions/ProfileService.AssignProfile.....................................................................................544
/api/ProfileService/Actions/ProfileService.AssignProfileForAutoDeploy.......................................................... 545
/api/ProfileService/Actions/ProfileService.SyncProfiles..................................................................................... 545
/api/ProfileService/Actions/ProfileService.MigrateProfile.................................................................................. 546
/api/ProfileService/Actions/ProfileService.UnassignProfiles.............................................................................. 546
/api/ProfileService/ProfileStates............................................................................................................................. 547
/api/ProfileService/Actions/ProfileService.Delete................................................................................................ 547
/api/ProfileService/Profiles(arg1)............................................................................................................................ 547
/api/ProfileService/Actions/ProfileService.GetInvalidTargetsForDeployTemplate.......................................... 548
/api/ProfileService/Actions/ProfileService.GetInvalidTargetsForAssignProfile................................................548
Devices............................................................................................................................................................................... 548
/api/DeviceService/HostKeys.................................................................................................................................. 548
/api/DeviceService/Actions/DeviceService.AddKeys.......................................................................................... 549
/api/DeviceService/Actions/DeviceService.ScanAndAddKeys...........................................................................550
/api/DeviceService/Actions/DeviceService.RemoveKeys...................................................................................550
/api/DeviceService/Actions/DeviceService.AddCredentialToDevice.................................................................550
Auto deploy.........................................................................................................................................................................551
/api/AutoDeployService/Targets..............................................................................................................................551
/api/AutoDeployService/Actions/AutoDeployService.Verify...............................................................................552
/api/AutoDeployService/Actions/AutoDeployService.Delete..............................................................................553
/api/AutoDeployService/AutoDeploy...................................................................................................................... 554
/api/AutoDeployService/AutoDeploy(AutoDeployId)............................................................................................554
Monitor...............................................................................................................................................................................555
Discovery service........................................................................................................................................................ 555
14
Contents
Server-initiated discovery.......................................................................................................................................... 564
Warranty service......................................................................................................................................................... 566
Report service............................................................................................................................................................. 568
MIB import service...................................................................................................................................................... 576
Plugin Manager..................................................................................................................................................................579
/api/PluginService/Plugins........................................................................................................................................579
/api/PluginService/Plugins('<PluginId>').................................................................................................................581
/api/PluginService/Plugins('<PluginId>')/AvailableVersionDetails.......................................................................581
/api/PluginService/Actions/PluginService.CheckPluginCompatibility................................................................582
/api/PluginService/Actions/PluginService.UpdateConsolePlugins..................................................................... 583
Power Metrics................................................................................................................................................................... 584
/api/MetricService/Metrics......................................................................................................................................584
/api/MetricService/TopEnergyConsumption.........................................................................................................586
/api/MetricService/EnergyConsumption................................................................................................................588
/api/MetricService/MetricTypes............................................................................................................................. 589
/api/MetricService/MetricsConsumption............................................................................................................... 591
/api/MetricService/Threshold..................................................................................................................................592
/api/MetricService/TopOffenders...........................................................................................................................593
/api/MetricService/Actions/MetricService.SaveThreshold.................................................................................594
Chapter 18: Redfish resource model..............................................................................................596
Redfish—ServiceRoot..................................................................................................................................................... 596
redfish/v1..................................................................................................................................................................... 596
redfish/v1/$metadata................................................................................................................................................ 597
redfish/v1/odata......................................................................................................................................................... 604
Redfish—SessionService.................................................................................................................................................605
/redfish/v1/SessionService.......................................................................................................................................605
/redfish/v1/SessionService/Sessions/Members...................................................................................................606
/redfish/v1/SessionService/Sessions/Members(Id)............................................................................................ 608
Redfish—Account Service.............................................................................................................................................. 608
/redfish/v1/AccountService..................................................................................................................................... 609
/redfish/v1/AccountService/Accounts/Members.................................................................................................612
/redfish/v1/AccountService/Accounts/Members(Id)...........................................................................................614
redfish/v1/AccountService/Roles/Members..........................................................................................................616
Redfish—Message Registry.............................................................................................................................................617
/redfish/v1/Registries.................................................................................................................................................617
GET method for Registry instance............................................................................................................................ 618
redfish/v1/MessageRegistryCollection/Members(<InstanceId>)........................................................................ 619
Redfish—Chassis.............................................................................................................................................................. 619
/redfish/v1/Chassis....................................................................................................................................................620
Redfish—Systems............................................................................................................................................................ 627
/redfish/v1/Systems.................................................................................................................................................. 627
redfish/v1/Systems/Members(id)............................................................................................................................627
redfish/v1/Systems/Members(id)/Processors......................................................................................................629
redfish/v1/Systems/Members(id)/Processors/Members(id).............................................................................629
redfish/v1/Systems/Members(id)/EthernetInterfaces........................................................................................ 630
redfish/v1/Systems/Members(id)/EthernetInterfaces/Members(id)................................................................ 631
redfish/v1/Systems/Members(id)/SimpleStorage.................................................................................................631
redfish/v1/Systems/Members(id)/SimpleStorage/Members............................................................................. 632
redfish/v1/Systems/Members(id)/SimpleStorage/Members(id)....................................................................... 633
Contents
15
redfish/v1/Systems/Members(id)/Actions/ComputerSystem.Reset................................................................ 633
Redfish—CompositionService........................................................................................................................................ 634
redfish/v1/CompositionService.................................................................................................................................634
redfish/v1/CompositionService/ResourceBlocks...................................................................................................634
redfish/v1/CompositionService/ResourceBlocks/Members(<InstanceId>)......................................................636
redfish/v1/CompositionService/ResourceZones................................................................................................... 637
redfish/v1/CompositionService/ResourceZones/Members(<InstanceId>).......................................................638
/redfish/v1/Systems/Members(<SystemId>)/Actions/ComputerSystem.AddResourceBlock..................... 638
/redfish/v1/Systems/Members(<SystemId>)/Actions/ComputerSystem.RemoveResourceBlock..............639
16 Contents
About this document
This document contains information about the resource models for OpenManage Enterprise and OpenManage Enterprise – Modular
Edition (OME–Modular). Each RESTful API specification includes the URI, method, parameters, request codes, and response codes. Some
of the APIs are available only in OME–Modular and do not work if used in OME–Modular and the opposite way.
Table 1. Supported REST API versions
Product Date of release What's new
OpenManage Enterprise 3.4 June 2020
• The following APIs are available from version
3.4:
â—‹ APIs to discover servers by using Server-
initiated discovery feature. For more
information, see Server-initiated discovery
on page 564.
â—‹ APIs to manage profiles. For more
information, see Profiles on page 541.
• The following APIs are not available from
version 3.4:
â—‹ See /api/TemplateService/Profiles on
page 490.
â—‹ See /api/TemplateService/Profiles(Id) on
page 491.
â—‹ See /api/TemplateService/ProfileState
on page 491.
â—‹ See /api/TemplateService/ProfileUsage
on page 492.
â—‹ See /api/TemplateService/Actions/
TemplateService.AttachProfile on page
493.
â—‹ See /api/TemplateService/Actions/
TemplateService.AssociateProfile on page
494.
â—‹ See /api/TemplateService/Actions/
TemplateService.UpdateProfile on page
494.
â—‹ See /api/TemplateService/Actions/
TemplateService.MigrateProfile on page
495.
â—‹ See /api/TemplateService/Actions/
TemplateService.DetachProfile on page
495.
OpenManage Enterprise –
Modular Edition 1.20.00
June 2020
• API updated to configure Forward Error
Configuration (FEC) for IOM ports and force
reset. For more information, see /api/
JobService/Jobs.
• Added a new filter option for fabrics. For
more information, see /api/
NetworkConfigurationService/Networks
and /api/NetworkService/Fabrics(Id)/
Servers
• New attributes added to APIs. For more
information, see /api/NetworkService/
1
About this document 17
Table 1. Supported REST API versions (continued)
Product Date of release What's new
Fabrics(Id)/Uplinks(Id) and /api/
ManagementDomainService
• APIs to validate, import, and export VLAN
definitions. For more information, see,
NetworkConfigurationService.
• API to log off from the current user session.
For more information, see /api/
SessionService/Actions/
SessionService.Logoff.
• APIs to update untagged network profiles to
an existing interface for one or more servers.
For more information, see Fabric
management.
• API for getting sync failure alert timeout
values. For more information, see /api/
ManagementDomainService/
GetSyncFailureAlertTimeoutValues
18 About this document
Overview
RESTful API support in OpenManage Enterprise,
OpenManage Enterprise and OME–Modular
OME–Modular supports RESTful API. Support for APIs has also been improved for OpenManage Enterprise. Improved support for APIs on
these products enhances the systems management capabilities. The RESTful interface is provided over HTTPS in JSON format based on
ODATA v4 usable by clients, scripts, and browser-based GUIs. The APIs enable you to build console management tools based on common
programming and scripting languages such as Python, Java, and C.
For more information about REST, see publically-available resources.
Topics:
• RESTful application programming interface
• OData
• JSON data
• HTTPS communication
• OpenManage Enterprise – Modular Edition
• OpenManage Enterprise
RESTful application programming interface
Representational State Transfer or REST is a software architectural style used within the World Wide Web. REST architectures are
commonly used for many IT solutions, including the definition of web-based APIs. Systems that adhere to REST practices are often
referred to as RESTful interfaces. RESTful interfaces use the HTTP methods—GET, POST, DELETE, and so on—that web browsers use
to access web pages.
OData
OData is an open protocol standard for the definition and exchange of information using RESTful APIs. When implementing a common
interface across multiple vendors, it is important to standardize the data formats. Standardizing the data formats ensure that the data
structures remain interchangeable between different manufacturers.
JSON data
Console API represents data using JSON. JSON is a lightweight data-interchange format that is readable and can also be easily parsed by
machines. JSON is based on a subset of the JavaScript Programming Language. JSON uses a text format that is language independent
but uses conventions familiar to programmers of the C-family of languages such as C, C++, C#, Java, JavaScript, PERL, and Python.
These properties make JSON an ideal data-interchange language.
HTTPS communication
The Hypertext Transfer Protocol or HTTP is an application protocol for distributed, collaborative, hypermedia information systems. HTTP
forms the foundation of data communication for the World Wide Web. Secure HTTP (HTTPS) is a secure version of HTTP where it
operates within a network connection encrypted by TLS or SSL. By enforcing HTTPS, the security of console management is significantly
enhanced.
2
Overview 19
OpenManage Enterprise – Modular Edition
OpenManage Enterprise – Modular Edition (OME–Modular) is the systems management software that runs on the Dell EMC PowerEdge
MX-series chassis. OME–Modular shares a common codebase with OpenManage Enterprise and delivers an agile, reliable, and
comprehensive platform to manage PowerEdge MX-series servers, storage, and networking products. OME–Modular boosts services
delivery and restores IT agility for growing businesses. A unified web and RESTful API interface manages all nodes including compute,
storage, and networking. OME–Modular helps reduce costs and learning curve, and consolidates multiple tools for ease of access and
monitoring. Simplified administration helps deploy and monitor at scale, from one to many chassis, with support for remote management.
Agile and intelligent automation of OME–Modular helps faster hardware deployments and reduces repetitive tasks for accelerated life
cycle management. Some of the key features of OME–Modular include:
• Capability to manage servers across multiple MX-series chassis
• Fast deployment with automatic chassis and node discovery
• Comprehensive RESTful API to automate multiple tasks and integrate with third-party tools
• Enhanced management with redundant OME-M module, touchscreen LCD, and OpenManage Mobile options for remote access
• Expanded management across all PowerEdge servers with OpenManage Enterprise
OpenManage Enterprise
OpenManage Enterprise is a hardware management and monitoring console that provides a comprehensive view of devices. These
devices include servers, chassis, network switches, and other third-party devices on the enterprise network. OpenManage Enterprise is
designed with a focus on simplicity, automation, and unification of data center management. Some of the key features of OpenManage
Enterprise include:
• Architecture is delivered as a virtual appliance—ESXi, Hyper-V, and KVM
• Engineered on CentOS with PostgreSQL database
• No operating system and database licenses are required
• End-to-end server life cycle management that includes inventory, monitoring, reporting, configuration, and deployment
• Northbound API that helps you automate and integrate with existing solutions
• Simplified discovery processes that enable devices to automatically register themselves with the console
• Intuitive interface that minimizes management steps
• Modernized dashboard that provides a clear view of alerts and options for performing corrective actions
• Access to warranty status
• Customized reporting capabilities
20
Overview
/