2. Dell
  3. PowerEdge MX7000
PowerEdge MX7000

Dell PowerEdge MX7000, OpenManage Enterprise-Modular Owner's manual

  • Hello! I am an AI chatbot trained to assist you with the Dell PowerEdge MX7000 Owner's manual. I’ve already reviewed the document and can help you find the information you need or explain it in simple terms. Just ask your questions, and providing more details will help me assist you more effectively!
OpenManage Enterprise Version 3.5 and
OpenManage Enterprise - Modular Edition
Version 1.30.00
RESTful API Guide
April 2021
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 -2021 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.
Revision history
Date Document revision Description of changes
April 2021 A00 Updates for new features and
enhancements
Revision history 3
Revision history..........................................................................................................................................................................3
Chapter 1: About this document...................................................................................................19
Chapter 2: Overview....................................................................................................................22
RESTful application programming interface............................................................................................................... 22
OData................................................................................................................................................................................... 22
JSON data...........................................................................................................................................................................22
HTTPS communication.................................................................................................................................................... 22
OpenManage Enterprise – Modular Edition................................................................................................................23
Importing licenses using APIs................................................................................................................................... 23
Exporting licenses using APIs................................................................................................................................... 23
Deleting licenses using APIs......................................................................................................................................23
OpenManage Enterprise.................................................................................................................................................. 23
Chapter 3: Key integration concepts........................................................................................... 25
Base URI.............................................................................................................................................................................. 25
OEM scheme................................................................................................................................................................ 25
Redfish scheme............................................................................................................................................................27
Security................................................................................................................................................................................28
Authentication....................................................................................................................................................................28
Authorization...................................................................................................................................................................... 29
Resource addressing........................................................................................................................................................ 32
Resource operations.........................................................................................................................................................32
Security considerations....................................................................................................................................................33
Performance considerations ..........................................................................................................................................33
Data filtering....................................................................................................................................................................... 33
Data sorting........................................................................................................................................................................ 33
Data pagination.................................................................................................................................................................. 34
Request headers................................................................................................................................................................34
Response codes.................................................................................................................................................................34
Response headers............................................................................................................................................................. 35
Chapter 4: Application settings................................................................................................... 37
Network............................................................................................................................................................................... 37
/api/ApplicationService/Network........................................................................................................................... 37
/api/ApplicationService/Network/WebServerConfiguration.......................................................................... 38
/api/ApplicationService/Network/TimeConfiguration...................................................................................... 39
/api/ApplicationService/Network/TimeZones.................................................................................................... 40
/api/ApplicationService/Network/ProxyConfiguration..................................................................................... 41
Security and user management..................................................................................................................................... 42
/api/AccountService.................................................................................................................................................. 42
/api/AccountService/Accounts.............................................................................................................................. 46
/api/AccountService/Accounts(Id)....................................................................................................................... 49
/api/AccountService/Accounts(userId)/Permissions....................................................................................... 52
Contents
4 Contents
/api/AccountService/Actions/AccountService.GetPrivileges........................................................................ 52
/api/AccountService/Actions/AccountService.GetPrivilegesForUser......................................................... 53
/api/AccountService/Actions/AccountService.GetUserDetail.......................................................................53
/api/AccountService/Actions/AccountService.Enable.....................................................................................54
/api/AccountService/Actions/AccountService.Disable....................................................................................54
/api/AccountService/Actions/AccountService.Delete.....................................................................................55
/api/AccountService/Roles..................................................................................................................................... 55
/api/AccountService/Roles(Id)...............................................................................................................................56
/api/AccountService/ExternalAccountProvider................................................................................................. 57
/api/AccountService/ExternalAccountProvider/DirectoryServiceType.......................................................58
/api/AccountService/ExternalAccountProvider/ADAccountProvider.......................................................... 58
/api/AccountService/ExternalAccountProvider/ADAccountProvider(Id)................................................... 60
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.TestADConnection.................................................................................................. 62
/api/AccountService/ExternalAccountProvider/LDAPAccountProvider..................................................... 64
/api/AccountService/ExternalAccountProvider/LDAPAccountProvider(Id).............................................. 66
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.TestLDAPConnection............................................................................................. 68
/api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.SearchGroups.....70
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.DeleteExternalAccountProvider............................................................................71
/api/AccountService/Actions/AccountService.ImportExternalAccountProvider....................................... 71
/api/AccountService/ExternalAccountProvider/OpenIDConnectProvider..................................................73
/api/AccountService/ExternalAccountProvider/OpenIDConnectProvider('OIDCProviderID')...............73
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.EnableOIDCProviders..............................................................................................74
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.DisableOIDCProviders.............................................................................................75
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.DeleteOIDCProviders..............................................................................................75
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.TestOIDCProvider................................................................................................... 76
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.TestOIDCProviderRegistrationStatus.................................................................76
Security and certificate management...........................................................................................................................77
/api/ApplicationService/Security............................................................................................................................77
/api/ApplicationService/Security/SecurityConfiguration.................................................................................77
/api/ApplicationService/Certificate....................................................................................................................... 78
/api/ApplicationService/Actions/ApplicationService.GenerateCSR..............................................................79
/api/ApplicationService/Actions/ApplicationService.UploadCertificate...................................................... 80
/api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.DSCertificate......80
Monitoring and alert notifications.................................................................................................................................. 81
api/AlertService/AlertDestinations/SNMPConfiguration..................................................................................81
api/AlertService/AlertDestinations/Actions/AlertDestinations.ApplySNMPConfig...................................82
/api/AlertService/AlertDestinations/SyslogConfiguration...............................................................................84
api/AlertService/AlertDestinations/Actions/AlertDestinations.ApplySyslogConfig.................................. 85
/api/AlertService/AlertDestinations/SMTPConfiguration............................................................................... 86
/api/AlertService/AlertDestinations/Actions/AlertDestinations.SendTestTrap.........................................88
Chapter 5: Alerts.........................................................................................................................89
Alert logs............................................................................................................................................................................. 89
Contents
5
/api/AlertService/Alerts........................................................................................................................................... 89
/api/AlertService/Alerts?$filter=contains(UserName,'admin').......................................................................91
/api/AlertService/Alerts?$filter=StatusType eq 2000......................................................................................91
/api/AlertService/Alerts?$filter=StatusType eq 1000......................................................................................95
/api/AlertService/Alerts?$filter=StatusType eq 1............................................................................................. 99
/api/AlertService/Alerts(Id)...................................................................................................................................100
/api/AlertService/AlertCategories........................................................................................................................ 101
/api/AlertService/AlertCategories('Name')....................................................................................................... 129
/api/AlertService/AlertSeverities......................................................................................................................... 130
/api/AlertService/AlertSeverities(Id)................................................................................................................... 131
/api/AlertService/AlertStatuses............................................................................................................................ 131
/api/AlertService/AlertStatuses(Id).....................................................................................................................132
/api/AlertService/AlertCatalogs............................................................................................................................132
/api/AlertService/AlertCatalogs(Id).....................................................................................................................134
/api/AlertService/Events........................................................................................................................................ 134
/api/AlertService/Actions/AlertService.Acknowledge....................................................................................135
/api/AlertService/Actions/AlertService.Unacknowledge............................................................................... 136
/api/AlertService/Actions/AlertService.RemoveAlerts...................................................................................137
Alert policies......................................................................................................................................................................138
/api/AlertService/AlertPolicies..............................................................................................................................138
/api/AlertService/AlertPolicies(Id)....................................................................................................................... 143
/api/AlertService/AlertPolicies(Arg1)/PolicyCriteria....................................................................................... 149
/api/AlertService/AlertPolicies(Arg1)/PolicyCriteria(Arg2)...........................................................................150
/api/AlertService/AlertPolicies(Arg1)/PolicyActions........................................................................................151
/api/AlertService/AlertPolicies(Arg1)/PolicyActions(Arg2)...........................................................................152
/api/AlertService/AlertActionTemplates.............................................................................................................153
/api/AlertService/AlertActionTemplates(Id)......................................................................................................154
/api/AlertService/Actions/AlertService.EnableAlertPolicies......................................................................... 155
/api/AlertService/Actions/AlertService.DisableAlertPolicies........................................................................ 155
/api/AlertService/Actions/AlertService.RemoveAlertPolicies...................................................................... 155
Alert definitions................................................................................................................................................................ 156
/api/AlertService/AlertMessageDefinitions....................................................................................................... 156
/api/AlertService/AlertMessageDefinitions(Id).................................................................................................157
/api/AlertService/AlertMessageDefinitionsCategories................................................................................... 158
/api/AlertService/AlertMessageDefinitionsCategories('Name')...................................................................159
Chapter 6: Configure................................................................................................................. 162
Firmware............................................................................................................................................................................ 162
/api/UpdateService/Catalogs................................................................................................................................162
/api/UpdateService/Catalogs(Id).........................................................................................................................165
/api/UpdateService/Baselines...............................................................................................................................166
api/UpdateService/Baselines(Id).......................................................................................................................... 172
/api/UpdateService/Actions/UpdateService.GetBaselinesForDevices.......................................................174
api/UpdateService/FirmwareBaselineSummary.................................................................................................174
/api/UpdateService/Actions/UpdateService.CheckBaselinesAssociation................................................. 175
/api/UpdateService/ComplianceStatuses.......................................................................................................... 175
/api/UpdateService/Baselines(Id)/DeviceComplianceReports..................................................................... 176
/api/UpdateService/Baselines(Id)/DeviceComplianceReports(Id).............................................................. 178
/api/UpdateService/Baselines(Id)/DeviceComplianceReports(Id)/ComponentComplianceReports.. 179
6
Contents
/api/UpdateService/Baselines(Id)/DeviceComplianceReports(Id)/
ComponentComplianceReports(Id)...................................................................................................................180
/api/UpdateService/Actions/UpdateService.UploadFile.................................................................................181
/api/UpdateService/Actions/UpdateService.RemoveFile...............................................................................181
/api/UpdateService/Actions/UpdateService.RefreshCatalogs.................................................................... 182
/api/UpdateService/Actions/UpdateService.RemoveCatalogs....................................................................182
/api/UpdateService/Actions/UpdateService.RemoveBaselines................................................................... 183
/api/UpdateService/RollbackSoftwares............................................................................................................. 183
/api/UpdateService/Actions/UpdateService.GetSingleDupDetails............................................................. 184
/api/UpdateService/Actions/UpdateService.GetSingleDupReport............................................................. 184
/api/UpdateService/Actions/UpdateService.GetBaselinesReportByDeviceids........................................186
/api/UpdateService/Actions/UpdateService.GetCertDetails........................................................................188
Template Service............................................................................................................................................................. 189
/api/TemplateService/TemplateTypes................................................................................................................189
/api/TemplateService/TemplateViewTypes.......................................................................................................190
/api/TemplateService/Templates..........................................................................................................................191
/api/TemplateService/Templates(Id).................................................................................................................. 196
api/TemplateService/Templates(26)................................................................................................................... 198
/api/TemplateService/Templates(Id)/Views....................................................................................................200
/api/TemplateService/Templates(Id)/Views(Id).............................................................................................. 201
/api/TemplateService/Templates(Id)/Views(Id)/AttributeViewDetails.....................................................202
/api/TemplateService/Templates(Id)/Views(Id)/AttributeViewDetails/TemplateEditInfoDetails......205
/api/TemplateService/Templates(Id)/Views(Id)/DeviceAttributeViewDetails(Id)................................. 207
/api/TemplateService/Templates(26)/Views(9)/DeviceAttributeViewDetails(10176)...........................212
/api/TemplateService/Actions/TemplateService.AssignIdentities...............................................................213
/api/TemplateService/Actions/TemplateService.GetAssignedIdentities................................................... 213
/api/TemplateService/Actions/TemplateService.FreeReservedIdentities.................................................215
/api/TemplateService/Actions/TemplateService.Clone................................................................................. 216
/api/TemplateService/Actions/TemplateService.Export............................................................................... 216
/api/TemplateService/Actions/TemplateService.Import................................................................................217
/api/TemplateService/Actions/TemplateService.Deploy............................................................................... 219
/api/TemplateService/Actions/TemplateService.UpdateNetworkConfig.................................................. 221
/api/TemplateService/Actions/TemplateService.RemoveBaseline.............................................................222
/api/TemplateService/Actions/TemplateService.Remediate ...................................................................... 223
Identity pools....................................................................................................................................................................223
/api/IdentityPoolService/IdentityPools...............................................................................................................223
/api/IdentityPoolService/IdentityPools(Id)........................................................................................................226
/api/IdentityPoolService/IdentityPools(Id)/UsageCounts............................................................................ 229
/api/IdentityPoolService/IdentityPools(Id)/UsageIdentitySets................................................................... 230
/api/IdentityPoolService/IdentityPoolsI(Id)/UsageIdentitySets(Id)............................................................ 231
/api/IdentityPoolService/IdentityPools(Id)/UsageIdentitySets(Id)/Details.............................................. 231
/api/IdentityPoolService/IdentityStates.............................................................................................................232
/api/IdentityPoolService/IdentityStates(Id)......................................................................................................233
/api/IdentityPoolService/Actions/IdentityPoolService.DeleteIdentityPools............................................. 233
Network Configuration Service................................................................................................................................... 234
/api/NetworkConfigurationService/Networks..................................................................................................234
/api/NetworkConfigurationService/Networks(Id)...........................................................................................236
/api/NetworkConfigurationService/NetworkTypes........................................................................................ 238
/api/NetworkConfigurationService/NetworkTypes(Id)................................................................................. 239
/api/NetworkConfigurationService/QosTypes................................................................................................. 239
Contents
7
/api/NetworkConfigurationService/QosTypes(Id).......................................................................................... 240
/api/NetworkConfigurationService/Actions/NetworkConfigurationService.RemoveNetworks..........240
api/NetworkConfigurationService/Actions/NetworkConfigurationService.ImportVLANDefinitions... 241
api/NetworkConfigurationService/Actions/NetworkConfigurationService.ExportVLANDefinitions.. 242
api/NetworkConfigurationService/Actions/
NetworkConfigurationService.ValidateNetworkDefinitionFile................................................................... 242
/api/NetworkConfigurationService/ReplicableChassisSettings................................................................... 243
Chapter 7: Devices.................................................................................................................... 244
/api/DeviceService........................................................................................................................................................ 245
GET method for DeviceService.............................................................................................................................245
/api/DeviceService/Devices........................................................................................................................................245
GET method for Devices.........................................................................................................................................245
/api/DeviceService/Devices?$filter=Type eq 1000.............................................................................................. 270
GET method for device filter..................................................................................................................................270
/api/DeviceService/Devices(Id).................................................................................................................................276
GET method for Devices(Id).................................................................................................................................. 276
/api/DeviceService/Devices(Id)/InventoryDetails.................................................................................................278
GET method for InventoryDetails..........................................................................................................................278
/api/DeviceService/Devices(Id)/InventoryDetails(InventoryType).................................................................. 307
GET method for inventory details by inventory type....................................................................................... 307
/api/DeviceService/Devices(Device_ID)/InventoryDetails('deviceManagement')........................................ 311
GET method for device inventory details............................................................................................................. 311
/api/DeviceService/Devices(Id)/Settings('ReplicableChassisConfigurations').............................................. 312
PUT method to retrieve chassis time and alert destination settings............................................................ 312
/api/DeviceService/Devices(DEVICE_ID)/Settings('NetworkServices').........................................................313
PUT method for network services settings........................................................................................................ 313
/api/DeviceService/Devices(Device_ID)/Settings('LocalAccessConfiguration').......................................... 313
GET method for local access configuration........................................................................................................ 313
PUT method for local access configuration........................................................................................................ 314
/api/DeviceService/Devices(Id)/HardwareLogs.................................................................................................... 316
GET method for HardwareLogs............................................................................................................................. 316
/api/DeviceService/Devices(Id)/SubSystemHealth.............................................................................................. 317
GET method for sub system health information................................................................................................ 317
/api/DeviceService/Devices(Id)/RecentActivity....................................................................................................318
GET method for RecentActivity.............................................................................................................................318
/api/DeviceService/Devices(Id)/InventoryTypes.................................................................................................. 319
GET method for InventoryTypes........................................................................................................................... 319
/api/DeviceService/Devices(Id)/LogSeverities...................................................................................................... 319
GET method for LogSeverities............................................................................................................................... 319
/api/DeviceService/Devices(Id)/Settings...............................................................................................................320
GET method for Settings........................................................................................................................................320
/api/DeviceService/Devices(Id)/Settings('Type')................................................................................................ 320
GET method for device settings by type............................................................................................................. 321
PUT method for device settings by type............................................................................................................ 322
/api/DeviceService/Devices(Id)/Temperature.......................................................................................................324
GET method for Temperature................................................................................................................................324
/api/DeviceService/Devices(Id)/BlinkStatus......................................................................................................... 325
GET method for LED blink status......................................................................................................................... 325
/api/DeviceService/Devices(Id)/PowerUsageByDevice..................................................................................... 325
8
Contents
GET method for power usage by devices...........................................................................................................325
/api/DeviceService/Devices(Id)/DeviceBladeSlots.............................................................................................. 326
GET method for device blade slots...................................................................................................................... 326
/api/DeviceService/Devices(Id)/GraphicInfo......................................................................................................... 327
GET method for GraphicInfo.................................................................................................................................. 327
/api/DeviceService/Devices(Id)/DeployRequired................................................................................................. 328
GET method for deployment by device IDs........................................................................................................328
/api/DeviceService/Devices(Id)/SystemUpTime.................................................................................................. 328
GET method for /api/DeviceService/Devices(Id)/SystemUpTime............................................................. 328
/api/DeviceService/Actions/DeviceService/Devices(Id)Actions/
DeviceService.UploadFSDCertificate.................................................................................................................... 329
POST method for uploading FSD certificate......................................................................................................329
/api/DeviceService/PowerStates.............................................................................................................................. 329
GET method for PowerStates............................................................................................................................... 329
/api/DeviceService/DeviceStatuses......................................................................................................................... 330
GET method for DeviceStatuses...........................................................................................................................330
/api/DeviceService/DeviceType................................................................................................................................ 330
GET method for DeviceType..................................................................................................................................330
/api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.SetTermState...............331
POST method for setting term state....................................................................................................................331
/api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.GetTermState............. 332
POST method for getting term state...................................................................................................................332
/api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.GetComputeIPs...........332
POST method for /api/DeviceService/Actions/DeviceService/Devices(Id)Actions/
DeviceService.GetComputeIPs..........................................................................................................................332
/api/DeviceService/DeviceSummary........................................................................................................................ 332
GET method for DeviceSummary..........................................................................................................................332
/api/DeviceService/DeviceSummary(Type)........................................................................................................... 335
GET method for /api/DeviceService/DeviceSummary(Type)...................................................................... 335
api/DeviceService/Actions/DeviceService.DevicesPrivilegesAction................................................................ 336
POST method for api/DeviceService/Actions/DeviceService.DevicesPrivilegesAction........................ 336
/api/DeviceService/Actions/DeviceService.DevicesByPrivilegesAction......................................................... 336
POST method for device privileges action......................................................................................................... 336
/api/DeviceService/Actions/DeviceService.ExecuteAction................................................................................337
POST method /api/DeviceService/Actions/DeviceService.ExecuteAction.............................................. 337
/api/DeviceService/DeviceSlotType......................................................................................................................... 337
GET method for DeviceSlotType...........................................................................................................................337
/api/DeviceService/DeviceSettingsMetadata........................................................................................................ 338
GET method for DeviceSettingsMetadata..........................................................................................................338
/api/DeviceService/GlobalExcludes........................................................................................................................... 341
GET method for GlobalExcludes............................................................................................................................ 341
POST method for GlobalExcludes.........................................................................................................................342
/api/DeviceService/Actions/DeviceService.AddNetworkRange....................................................................... 343
POST method for DeviceService.AddNetworkRange......................................................................................343
/api/DeviceService/Actions/DeviceService.EditNetworkRange....................................................................... 343
POST method for DeviceService.EditNetworkRange......................................................................................343
/api/DeviceService/Actions/DeviceService.RemoveFromExclusion................................................................ 344
POST method for DeviceService.RemoveFromExclusion...............................................................................344
/api/DeviceService/Actions/DeviceService.ValidateExcludes........................................................................... 344
POST method for DeviceService.ValidateExcludes..........................................................................................344
Contents
9
/api/DeviceService/Actions/DeviceService.RemoveDevices.............................................................................345
POST method for DeviceService.RemoveDevices........................................................................................... 345
Chapter 8: Diagnostic................................................................................................................346
/api/DeviceService/Devices(Id)/Actions/DeviceService.Diagnostic............................................................... 346
POST method for DeviceService.Diagnostic......................................................................................................346
Chapter 9: Groups..................................................................................................................... 347
/api/GroupService/Groups.......................................................................................................................................... 347
GET method for Groups.......................................................................................................................................... 347
/api/GroupService/Groups(Id)...................................................................................................................................349
GET method for Groups(Id)................................................................................................................................... 349
PUT method for Groups(Id)....................................................................................................................................351
DELETE method for Groups(Id)............................................................................................................................ 352
/api/GroupService/Groups(Id)/Devices.................................................................................................................. 352
GET method for Devices.........................................................................................................................................352
/api/GroupService/Groups(Id)/GroupDevicesSummary..................................................................................... 354
GET method for GroupDevicesSummary............................................................................................................ 354
/api/GroupService/Groups(group id)/AllLeafDeviceSummaries....................................................................... 355
GET method for AllLeafDeviceSummaries..........................................................................................................355
/api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000............................. 374
Get method for AllLeafDeviceSummaries?$filter=Type eq 4000 ................................................................ 374
/api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq
4000&$top=25&$skip=0 .........................................................................................................................................377
GET method for AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0...........................377
/api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq
4000&$top=25&$skip=0&$orderby=Identifier asc........................................................................................... 381
GET method for AllLeafDeviceSummaries?$filter=Type eq
4000&$top=25&$skip=0&$orderby=Identifier asc......................................................................................381
/api/GroupService/Groups(Id)/SubGroups............................................................................................................ 384
GET method for SubGroups...................................................................................................................................384
/api/GroupService/Groups(Id)/GroupHierarchy................................................................................................... 386
GET method for GroupHierarchy.......................................................................................................................... 386
/api/GroupService/GroupTypes.................................................................................................................................387
GET method for GroupTypes................................................................................................................................. 387
/api/GroupService/GroupTypes(Id)..........................................................................................................................388
GET method for GroupTypes(Id).......................................................................................................................... 388
/api/GroupService/MembershipTypes..................................................................................................................... 388
GET method for MembershipTypes..................................................................................................................... 388
/api/GroupService/MembershipTypes(Id).............................................................................................................. 389
GET method for MembershipTypes(Id).............................................................................................................. 389
/api/GroupService/AllGroupsHierarchy................................................................................................................... 390
GET method for AllGroupsHierarchy....................................................................................................................390
/api/GroupService/Actions/GroupService.AddMemberDevices....................................................................... 390
POST method for GroupService.AddMemberDevices.....................................................................................390
/api/GroupService/Actions/GroupService.GroupsPrivilegesAction.................................................................. 391
POST method for GroupService.GroupsPrivilegesAction................................................................................391
/api/GroupService/Actions/GroupService.GroupsByPrivilegesAction............................................................. 391
POST method for GroupService.GroupsByPrivilegesAction...........................................................................391
10
Contents
Chapter 10: Monitor.................................................................................................................. 393
Audit logs.......................................................................................................................................................................... 393
/api/ApplicationService/AuditLogs......................................................................................................................393
/api/ApplicationService/AuditLogs(Id)...............................................................................................................394
Jobs....................................................................................................................................................................................395
/api/JobService/Jobs............................................................................................................................................. 395
/api/JobService/Jobs(Id).......................................................................................................................................423
/api/JobService/JobStatuses............................................................................................................................... 427
/api/JobService/JobStatuses(Id)........................................................................................................................ 428
/api/JobService/JobTypes.................................................................................................................................... 429
/api/JobService/JobTypes(Id).............................................................................................................................. 431
/api/JobService/Jobs(Id)/ExecutionHistories.................................................................................................. 431
/api/JobService/Jobs(Id)/ExecutionHistories(Id)...........................................................................................433
/api/JobService/Actions/JobService.EnableJobs........................................................................................... 435
/api/JobService/Actions/JobService.DisableJobs.......................................................................................... 435
/api/JobService/Actions/JobService.RemoveJobs........................................................................................ 436
/api/JobService/Actions/JobService.Schedule............................................................................................... 437
/api/JobService/Actions/JobService.RunJobs................................................................................................ 437
/api/JobService/Actions/JobService.StopJobs...............................................................................................438
/api/JobService/Actions/JobService.Resume.................................................................................................. 441
/api/JobService/Actions/JobService.ExecuteAction...................................................................................... 441
Chapter 11: Reset application.....................................................................................................443
/api/ApplicationService/Actions/ApplicationService.ResetApplication........................................................... 443
POST method for ResetApplication..................................................................................................................... 443
Chapter 12: Console version...................................................................................................... 444
/api/ApplicationService/Info....................................................................................................................................... 444
GET method for Info................................................................................................................................................ 444
Chapter 13: Console capabilities................................................................................................ 445
/api/ApplicationService/Capabilities......................................................................................................................... 445
GET method for Capabilities.................................................................................................................................. 445
Chapter 14: Search.................................................................................................................... 447
/api/SearchService/Actions/SearchService.Search.............................................................................................447
POST method for SearchService.Search............................................................................................................447
Chapter 15: Session...................................................................................................................449
/api/SessionService.......................................................................................................................................................449
GET method for SessionService........................................................................................................................... 449
/api/SessionService/Sessions.................................................................................................................................... 450
GET method for Sessions....................................................................................................................................... 450
POST method for Sessions..................................................................................................................................... 451
/api/SessionService/Sessions(Id)..............................................................................................................................452
GET method for Sessions(Id)................................................................................................................................ 452
DELETE method for Sessions(Id)......................................................................................................................... 452
/api/SessionService/CurrentUser............................................................................................................................. 453
Contents
11
GET method for session details of current user................................................................................................453
/api/SessionService/SessionConfiguration............................................................................................................. 453
GET method for SessionConfiguration................................................................................................................ 453
/api/SessionService/Actions/SessionService.SessionConfigurationUpdate.................................................. 455
POST method for SessionService.SessionConfigurationUpdate.................................................................. 455
/api/SessionService/Actions/SessionService.Logoff...........................................................................................455
POST method for session service log off........................................................................................................... 455
Chapter 16: APIs specific to OpenManage Enterprise – Modular Edition.................................... 457
/api/ApplicationService/Settings...............................................................................................................................457
GET method for /api/ApplicationService/Settings..........................................................................................457
POST method for /api/ApplicationService/Settings.......................................................................................458
/api/ApplicationService/Network/CurrentAddressConfiguration..................................................................... 458
GET method for CurrentAddressConfiguration.................................................................................................458
/api/ApplicationService/Network/AddressConfiguration................................................................................... 460
GET method for AddressConfiguration............................................................................................................... 460
PUT method for AddressConfiguration................................................................................................................461
/api/ApplicationService/Actions/ApplicationService.GetConfiguration.......................................................... 463
POST method for ApplicationService.GetConfiguration................................................................................. 463
/api/ApplicationService/Actions/ApplicationService.ApplyConfiguration....................................................... 473
POST method for ApplicationService.ApplyConfiguration..............................................................................473
Brand..................................................................................................................................................................................483
/api/ApplicationService/Actions/ApplicationService.BrandInfo...................................................................483
/api/ApplicationService/Actions/ApplicationService.ActivateBrand.......................................................... 484
Multichassis management.............................................................................................................................................484
/api/ManagementDomainService......................................................................................................................... 484
/api/ManagementDomainService/DiscoveredDomains.................................................................................. 490
/api/ManagementDomainService/ConfigurationTypes................................................................................... 491
/api/ManagementDomainService/ConfigurationTypes(Id)........................................................................... 493
/api/ManagementDomainService/Domains.......................................................................................................493
/api/ManagementDomainService/Domains(Id)................................................................................................ 497
/api/ManagementDomainService/PendingDomains........................................................................................498
/api/ManagementDomainService/PendingDomains(Id)................................................................................. 499
/api/ManagementDomainService/Actions/ManagementDomainService.Domains................................. 500
/api/ManagementDomainService/Actions/ManagementDomainService.Join.......................................... 501
/api/ManagementDomainService/Actions/ManagementDomainService.Leave...................................... 502
/api/ManagementDomainService/Actions/ManagementDomainService.Delete..................................... 502
/api/ManagementDomainService/Actions/ManagementDomainService.DeleteGroup..........................503
/api/ManagementDomainService/GetSyncFailureAlertTimeoutValues......................................................504
/api/ManagementDomainService/Actions/ManagementDomainService.ApproveJoin.......................... 504
/api/ManagementDomainService/Actions/ManagementDomainService.AssignBackupLead.............. 505
/api/ManagementDomainService/Actions/ManagementDomainService.ReassignBackupLead..........506
/api/ManagementDomainService/Actions/ManagementDomainService.UnassignBackupLead..........507
/api/ManagementDomainService/Actions/ManagementDomainService.PromoteBackupLead...........507
/api/ManagementDomainService/Actions/ManagementDomainService.RetireLead............................. 508
FIPS mode settings........................................................................................................................................................ 509
/api/ApplicationService/Security/SecurityConfiguration..............................................................................509
Fabric management........................................................................................................................................................509
api/NetworkService/Actions/NetworkService.CreateFabric....................................................................... 509
/api/NetworkService/Actions/NetworkService.UpdateFabric..................................................................... 510
12
Contents
/api/NetworkService/Actions/NetworkService.DeleteFabrics.....................................................................510
/api/NetworkService.................................................................................................................................................511
/api/NetworkService/Fabrics................................................................................................................................ 512
/api/NetworkService/FabricDesigns................................................................................................................... 515
/api/NetworkService/Fabrics(Id)......................................................................................................................... 517
/api/NetworkService/Fabrics(Id)/FabricDesign...............................................................................................519
/api/NetworkService/FabricDesigns(arg1)........................................................................................................520
/api/NetworkService/Fabrics(Id)/ValidationErrors......................................................................................... 521
/api/NetworkService/Fabrics(Id)/Uplinks.........................................................................................................524
/api/NetworkService/Fabrics(Id)/Uplinks(Id)..................................................................................................525
/api/NetworkService/Fabrics(Id)/Uplinks(Id)/Ports......................................................................................528
/api/NetworkService/PortFECCapabilities....................................................................................................... 530
/api/NetworkService/Fabrics(Id)/Uplinks(Id)/Networks.............................................................................. 531
/api/NetworkService/Fabrics('Id')/NetworkService.GetApplicableUplinkNetworks..............................532
api/NetworkService/Fabrics(arg1)/NetworkService.GetApplicableUplinkUntaggedNetworks............532
api/NetworkService/Fabrics(arg1)/Servers......................................................................................................533
/api/NetworkService/Fabrics(Id)/NetworkService.GetApplicableUplinkPorts........................................ 537
api/NetworkService/Actions/NetworkService.UpdateServerUntaggedVLAN.........................................539
/api/NetworkService/Fabrics(Id)/Switches..................................................................................................... 540
/api/NetworkService/Fabrics(arg1)/Actions/NetworkService.GetUnallocatedSwitches......................541
/api/NetworkService/Fabrics(arg1)/Actions/NetworkService.ReplaceSwitch....................................... 542
/api/NetworkService/Fabrics(Id)/Servers........................................................................................................543
/api/NetworkService/Fabrics(Id)/Topology..................................................................................................... 546
/api/NetworkService/Fabrics(Id)/Topology/Nodes....................................................................................... 546
/api/NetworkService/Fabrics(Id)/Topology/Nodes(Id)................................................................................ 547
/api/NetworkService/Actions/NetworkService.RemoveFabrics.................................................................549
/api/NetworkService/Actions/NetworkService.RemoveUplinks.................................................................549
/api/NetworkService/FabricDesigns(Id)/NetworkService.GetApplicableNodes......................................551
/api/NetworkService/UplinkTypes...................................................................................................................... 552
/api/NetworkService/NodeTypes........................................................................................................................552
/api/NetworkService/FabricActivityTypes........................................................................................................553
/api/NetworkService/FabricActivityStatuses...................................................................................................554
/api/NetworkService/FabricHealthStatuses.....................................................................................................555
/api/NetworkService/MultiChassisDomain....................................................................................................... 556
/api/NetworkService/MultiChassisDomain/Topology.................................................................................... 556
/api/NetworkService/MultiChassisDomain/Topology/Nodes...................................................................... 557
/api/NetworkService/MultiChassisDomain/Topology/Nodes(Id)............................................................... 558
/api/NetworkService/MultiChassisDomain/Topology/Nodes(Id)/ChildNodes........................................558
/api/NetworkService/MultiChassisDomain/ValidationErrors....................................................................... 559
/api/NetworkService/PortAdminStatuses.........................................................................................................562
/api/NetworkService/PortStatuses.................................................................................................................... 563
/api/NetworkService/PortBlinkStatuses........................................................................................................... 563
/api/NetworkService/PortRoles.......................................................................................................................... 564
api/NetworkService/ServerProfileBondingTechnologies...............................................................................565
api/NetworkService/ServerProfiles.................................................................................................................... 565
api/NetworkService/ServerProfiles(Id)..............................................................................................................566
/api/NetworkService /ServerProfiles(arg1)...................................................................................................... 567
/api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles.........................................................568
/api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2).............................................570
/api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2)/Networks......................... 571
Contents
13
api/NetworkService/ServerProfiles(Id)/ServerInterfaceProfiles................................................................ 572
/api/NetworkService/Actions/NetworkService.ApplyServersInterfaceProfiles...................................... 572
/api/NetworkService/Actions/NetworkService.ModifyServerProfiles...................................................... 573
/api/NetworkService/Actions/NetworkService.AddServerNetworks........................................................ 574
/api/NetworkService/Actions/NetworkService.DeleteServerNetworks................................................... 575
/api/NetworkService/FeatureCapabilities......................................................................................................... 575
NetworkService/Fabrics(arg1)/Multicast...........................................................................................................576
api/NetworkService/Fabrics(arg1)/Multicast/MulticastNetworks..............................................................577
api/NetworkService/MulticastApplicableNetworks......................................................................................... 578
Port configuration in Fabrics........................................................................................................................................579
/api/JobService/Jobs............................................................................................................................................. 579
Storage management.....................................................................................................................................................582
Assign enclosure........................................................................................................................................................583
Clear enclosure assignment....................................................................................................................................583
Assign drives.............................................................................................................................................................. 584
Clear drive assignment............................................................................................................................................ 585
Force-activate a SAS IOM......................................................................................................................................586
Clear configuration on SAS IOM........................................................................................................................... 586
Extract SAS IOM logs to NFS share.....................................................................................................................587
Extract SAS IOM logs to CIFS share................................................................................................................... 588
Quick Deploy.................................................................................................................................................................... 589
/api/JobService/Jobs............................................................................................................................................. 589
Server NIC VLAN configuration.................................................................................................................................. 592
/api/NetworkService /ServerProfiles(arg1)...................................................................................................... 592
/api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles.........................................................594
/api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2).............................................595
/api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2)/Networks........................ 595
/api/NetworkService /ServerProfiles(arg1)/ServerInterfaceProfiles(arg2)/Networks (arg3)........... 596
/api/NetworkService/Actions/NetworkService.ApplyServersInterfaceProfiles...................................... 597
Template Service............................................................................................................................................................ 598
/api/TemplateService/Profiles............................................................................................................................. 598
/api/TemplateService/Profiles(Id)...................................................................................................................... 599
/api/TemplateService/ProfileState..................................................................................................................... 599
/api/TemplateService/ProfileUsage....................................................................................................................600
/api/TemplateService/Actions/TemplateService.AttachProfile................................................................... 601
/api/TemplateService/Actions/TemplateService.AssociateProfile.............................................................602
/api/TemplateService/Actions/TemplateService.UpdateProfile................................................................. 602
/api/TemplateService/Actions/TemplateService.MigrateProfile................................................................ 603
/api/TemplateService/Actions/TemplateService.DetachProfile..................................................................603
TemplateService/AttributeRegistryDetail...........................................................................................................604
Chapter 17: APIs specific to OpenManage Enterprise................................................................ 605
Application settings........................................................................................................................................................605
Console update................................................................................................................................................................605
/api/JobService/Jobs............................................................................................................................................. 605
/api/ConsoleUpdateService/Updates?$filter= Auto eq true........................................................................606
/api/ConsoleUpdateService/UpdateBundleInfo...............................................................................................606
/api/ConsoleUpdateService/Actions/ConsoleUpdateService.DeleteUpgradeBundle............................ 607
/api/ConsoleUpdateService/Actions/ConsoleUpdateService.DownloadBundle...................................... 607
/api/ConsoleUpdateService/LastUpdateResult............................................................................................... 608
14
Contents
Mobile................................................................................................................................................................................ 608
/api/AlertService/MobileSubscriptions.............................................................................................................. 608
/api/AlertService/SubscriptionNotificationService......................................................................................... 609
/api/AlertService/Actions/AlertService.CreateEditMobileSubscription.....................................................610
/api/AlertService/Actions/AlertService.DeleteMobileSubscription............................................................. 610
/api/AlertService/Actions/AlertService.EnableSubscriptionNotificationService..................................... 610
/api/AlertService/Actions/AlertService.FilterAlertsByPolicy......................................................................... 611
Console Preferences.......................................................................................................................................................612
/api/ApplicationService/Settings..........................................................................................................................612
/api/JobService/Jobs(10011).................................................................................................................................613
/api/ApplicationService/Settings..........................................................................................................................614
/api/Console/UpdateConsoleSettings.................................................................................................................615
Alerts.................................................................................................................................................................................. 616
https://<IP>/api/ApplicationService/Settings................................................................................................. 616
https://<IP>/api/AlertService/AlertDestinations/SMTPConfiguration..................................................... 616
https://<IP>/api/AlertService/AlertDestinations/Actions/AlertDestinations.ApplySNMPConfig.......617
https://<IP>/api/AlertService/AlertDestinations/Actions/AlertDestinations.ApplySyslogConfig ..... 617
Incoming Alerts.................................................................................................................................................................618
https://<IP>/api/ApplicationService/Settings................................................................................................. 618
Warranty............................................................................................................................................................................ 619
https://<IP>/api/ApplicationService/Settings ................................................................................................ 619
Network Configuration.................................................................................................................................................. 620
/api/ApplicationService/Network/AdapterConfigurations............................................................................620
/api/ApplicationService/Network/AdapterConfigurations('ens33')........................................................... 622
/api/ApplicationService/Actions/Network.ConfigureNetworkAdapter......................................................624
/api/NetworkConfigurationService/Actions/
NetworkConfigurationService.ImportVLANFromTarget............................................................................. 627
Configuration compliance..............................................................................................................................................627
/api/TemplateService/Baselines ......................................................................................................................... 627
/api/TemplateService/Baselines(ID) ..................................................................................................................628
/ api/TemplateService/Baselines(ID)/DeviceConfigComplianceReports ................................................. 628
/api/TemplateService/Baselines(ID)/DeviceConfigComplianceReports(ID)/
DeviceComplianceDetails ...................................................................................................................................629
Troubleshoot service......................................................................................................................................................629
/api/JobService/Jobs............................................................................................................................................. 629
/api/TroubleshootService/Files.............................................................................................................................631
/api/TroubleshootService/Actions/TroubleshootService.GetTroubleshootDocument.......................... 632
/api/TroubleShootService/Actions/TroubleShootService.GetArchivedConsoleLogs............................ 633
/api/TroubleShootService/Actions/TroubleShootService.DeleteArchivedConsoleLogs....................... 633
Query support service................................................................................................................................................... 633
/api/QuerySupportService/Queries.....................................................................................................................633
/api/QuerySupportService/Queries(Id)..............................................................................................................634
/api/QuerySupportService/QueryContextSummaries.................................................................................... 635
/api/QuerySupportService/QueryContextSummary(Id)................................................................................ 636
/api/QuerySupportService/QueryContexts(Id)................................................................................................636
/api/QuerySupportService/QueryContexts(Id)/QuerySupportService.GetFiltersForContext............ 639
/api/QuerySupportService/OperatorInfo...........................................................................................................642
/api/QuerySupportService/Filters....................................................................................................................... 644
/api/QuerySupportService/Filters(Id)................................................................................................................ 645
Groups service.................................................................................................................................................................646
Contents
15
/api/GroupService/Groups....................................................................................................................................646
/api/GroupService/Groups(Id)/SubGroups(Id)................................................................................................647
/api/GroupService/Groups(Id)/DeviceStatusSummary.................................................................................647
/api/GroupService/Groups(Id)/EventStatusSummary.................................................................................. 648
/api/GroupService/Groups(group id)/EventSeveritySummary?$filter=StatusType eq 2000.............649
/api/GroupService/Groups(group id)/EventSeveritySummary?$filter=StatusType eq 1000..............649
/api/GroupService/Groups(group id)/EventSeveritySummary$filter=StatusType eq 1........................649
/api/GroupService/GroupAudits.......................................................................................................................... 649
/api/GroupService/Actions/GroupService.CreateGroup.............................................................................. 650
/api/GroupService/Actions/GroupService.UpdateGroup..............................................................................650
/api/GroupService/Actions/GroupService.Clone.............................................................................................651
/api/GroupService/Actions/GroupService.DeleteGroup................................................................................ 651
/api/GroupService/Actions/GroupService.AddMemberDevices................................................................. 652
/api/GroupService/Actions/GroupService.RemoveMemberDevices..........................................................652
/api/GroupService/Actions/GroupService.AddUserToGroups.................................................................... 652
Profiles...............................................................................................................................................................................653
/api/ProfileService/Profiles...................................................................................................................................653
/api/ProfileService/Profiles(arg)......................................................................................................................... 654
/api/ProfileService/ProfileUsage......................................................................................................................... 654
/api/ProfileService/Profiles(arg1)/AttributeDetails........................................................................................ 655
/api/ProfileService/Actions/ProfileService.Rename ..................................................................................... 655
/api/ProfileService/Actions/ProfileService.GetTargetSpecificAttributes................................................ 655
/api/ProfileService/Actions/ProfileService.GetIdentityAttributes..............................................................656
/api/ProfileService/Actions/ProfileService.AssignProfile............................................................................. 656
/api/ProfileService/Actions/ProfileService.AssignProfileForAutoDeploy..................................................657
/api/ProfileService/Actions/ProfileService.SyncProfiles.............................................................................. 657
/api/ProfileService/Actions/ProfileService.MigrateProfile...........................................................................658
/api/ProfileService/Actions/ProfileService.UnassignProfiles.......................................................................658
/api/ProfileService/ProfileStates........................................................................................................................ 659
/api/ProfileService/Actions/ProfileService.Delete......................................................................................... 659
/api/ProfileService/Profiles(arg1)....................................................................................................................... 660
/api/ProfileService/Actions/ProfileService.GetInvalidTargetsForDeployTemplate................................ 660
/api/ProfileService/Actions/ProfileService.GetInvalidTargetsForAssignProfile......................................660
Devices...............................................................................................................................................................................661
/api/DeviceService/HostKeys............................................................................................................................... 661
/api/DeviceService/Actions/DeviceService.AddKeys.....................................................................................661
/api/DeviceService/Actions/DeviceService.ScanAndAddKeys....................................................................662
/api/DeviceService/Actions/DeviceService.RemoveKeys............................................................................ 662
/api/DeviceService/Actions/DeviceService.AddCredentialToDevice.........................................................663
Auto deploy...................................................................................................................................................................... 663
/api/AutoDeployService/Targets......................................................................................................................... 663
/api/AutoDeployService/Actions/AutoDeployService.Verify........................................................................664
/api/AutoDeployService/Actions/AutoDeployService.Delete.......................................................................665
/api/AutoDeployService/AutoDeploy..................................................................................................................666
/api/AutoDeployService/AutoDeploy(AutoDeployId)..................................................................................... 666
Monitor.............................................................................................................................................................................. 667
Discovery service...................................................................................................................................................... 667
Server-initiated discovery....................................................................................................................................... 676
Warranty service....................................................................................................................................................... 679
Report service........................................................................................................................................................... 680
16
Contents
MIB import service....................................................................................................................................................688
Plugin Manager................................................................................................................................................................692
/api/PluginService/Plugins.................................................................................................................................... 692
/api/PluginService/Plugins('<PluginId>')...........................................................................................................693
/api/PluginService/Plugins('<PluginId>')/AvailableVersionDetails.............................................................. 694
/api/PluginService/Actions/PluginService.CheckPluginCompatibility........................................................695
/api/PluginService/Actions/PluginService.UpdateConsolePlugins............................................................. 696
Power Metrics................................................................................................................................................................. 697
/api/MetricService/Metrics...................................................................................................................................697
/api/MetricService/TopEnergyConsumption....................................................................................................699
/api/MetricService/EnergyConsumption............................................................................................................ 701
/api/MetricService/MetricTypes......................................................................................................................... 702
/api/MetricService/MetricsConsumption.......................................................................................................... 704
/api/MetricService/Threshold.............................................................................................................................. 705
/api/MetricService/TopOffenders.......................................................................................................................706
/api/MetricService/Actions/MetricService.SaveThreshold.......................................................................... 707
Chapter 18: Redfish resource model.......................................................................................... 709
Redfish—ServiceRoot................................................................................................................................................... 709
redfish/v1....................................................................................................................................................................709
redfish/v1/$metadata.............................................................................................................................................. 710
redfish/v1/odata........................................................................................................................................................ 718
Redfish—SessionService...............................................................................................................................................719
/redfish/v1/SessionService.................................................................................................................................... 719
/redfish/v1/SessionService/Sessions/Members............................................................................................. 720
/redfish/v1/SessionService/Sessions/Members(Id)....................................................................................... 721
Redfish—Account Service........................................................................................................................................... 722
/redfish/v1/AccountService.................................................................................................................................. 722
/redfish/v1/AccountService/Accounts/Members...........................................................................................725
/redfish/v1/AccountService/Accounts/Members(Id).................................................................................... 727
redfish/v1/AccountService/Roles/Members.................................................................................................... 730
Redfish—Message Registry..........................................................................................................................................731
/redfish/v1/Registries.............................................................................................................................................. 731
GET method for Registry instance........................................................................................................................732
redfish/v1/MessageRegistryCollection/Members(<InstanceId>)................................................................ 733
Redfish—Chassis............................................................................................................................................................733
/redfish/v1/Chassis..................................................................................................................................................733
Redfish—Systems........................................................................................................................................................... 741
/redfish/v1/Systems.................................................................................................................................................741
redfish/v1/Systems/Members(id)........................................................................................................................ 741
redfish/v1/Systems/Members(id)/Processors.................................................................................................743
redfish/v1/Systems/Members(id)/Processors/Members(id)...................................................................... 744
redfish/v1/Systems/Members(id)/EthernetInterfaces.................................................................................. 745
redfish/v1/Systems/Members(id)/EthernetInterfaces/Members(id)........................................................746
redfish/v1/Systems/Members(id)/SimpleStorage.......................................................................................... 746
redfish/v1/Systems/Members(id)/SimpleStorage/Members.......................................................................747
redfish/v1/Systems/Members(id)/SimpleStorage/Members(id)................................................................ 748
redfish/v1/Systems/Members(id)/Actions/ComputerSystem.Reset.........................................................748
Redfish—CompositionService..................................................................................................................................... 749
redfish/v1/CompositionService.............................................................................................................................749
Contents
17
redfish/v1/CompositionService/ResourceBlocks............................................................................................. 749
redfish/v1/CompositionService/ResourceBlocks/Members(<InstanceId>).............................................. 751
redfish/v1/CompositionService/ResourceZones..............................................................................................752
redfish/v1/CompositionService/ResourceZones/Members(<InstanceId>)...............................................753
/redfish/v1/Systems/Members(<SystemId>)/Actions/ComputerSystem.AddResourceBlock........... 754
/redfish/v1/Systems/Members(<SystemId>)/Actions/ComputerSystem.RemoveResourceBlock....754
Redfish—EventService................................................................................................................................................. 755
/redfish/v1/EventService.......................................................................................................................................755
/redfish/v1/EventService/Actions/EventService.SubmitTestEvent.......................................................... 756
/redfish/v1/EventService/SSE.............................................................................................................................757
/redfish/v1/EventService/Subscriptions........................................................................................................... 758
/redfish/v1/EventService/Subscriptions/<ID>................................................................................................ 760
Redfish—OpenManage Enterprise License Manager............................................................................................760
/redfish/v1/Oem/Dell/LicenseManager............................................................................................................. 760
/redfish/v1/Oem/Dell/LicenseManager/LicenseCollection........................................................................... 761
/redfish/v1/Oem/Dell/LicenseManager/LicenseCollection/<EntitlementID>..........................................762
/redfish/v1/Oem/Dell/LicenseManager/Actions/DellLicenseManagementService.ExportLicense.... 763
Redfish—Telemetry....................................................................................................................................................... 764
/redfish/v1/TelemetryService............................................................................................................................... 764
/redfish/v1/TelemetryService/MetricDefinitions.............................................................................................766
/redfish/v1/TelemetryService/MetricDefinitions/ID.......................................................................................768
/redfish/v1/TelemetryService/MetricReports..................................................................................................769
/redfish/v1/TelemetryService/MetricReports/ID............................................................................................769
/redfish/v1/TelemetryService/MetricReportDefinitions................................................................................ 769
/redfish/v1/TelemetryService/Triggers..............................................................................................................775
/redfish/v1/TelemetryService/Triggers/ID....................................................................................................... 776
Managers...........................................................................................................................................................................777
/redfish/v1/CertificateService.............................................................................................................................. 777
/redfish/v1/CertificateService/CertificateLocations...................................................................................... 777
/redfish/v1/Managers/Members('ChassisManager')/Oem/Dell/HWCertificate.....................................778
/redfish/v1/Managers/Members('ChassisManager')/Actions/Oem/
DellManager.VerifyHWCertificate.....................................................................................................................779
Redfish—OpenID Connect Provider.......................................................................................................................... 780
/api/AccountService/ExternalAccountProvider/OpenIDConnectProvider............................................... 780
/api/AccountService/ExternalAccountProvider/OpenIDConnectProvider(‘OIDCProviderID’)............780
/api/AccountService/ExternalAccountProvider /OpenIDConnectProvider(‘ID’)..................................... 781
/api/AccountService/ExternalAccountProvider/OpenIDConnectProviders.............................................. 781
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.EnableOIDCProviders............................................................................................781
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.TestOIDCProvider................................................................................................. 782
/api/AccountService/ExternalAccountProvider/Actions/ExternalAccountProvider.
DisableOIDCProviders.......................................................................................................................................... 782
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.DeleteOIDCProviders............................................................................................783
/api/AccountService/ExternalAccountProvider/Actions/
ExternalAccountProvider.TestOIDCProviderRegistrationStatus.............................................................. 783
18
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 – Modular Edition
1.30.00
April 2021
The following APIs are added in this release:
● /api/NetworkConfigurationService/
ReplicableChassisSettings
● /api/SessionService/CurrentUser
● /redfish/v1/TelemetryService/
MetricReportDefinitions
● /redfish/v1/EventService
● /redfish/v1/SSE
● /redfish/v1/TelemetryService/Triggers
● api/NetworkService/MulticastApplicableNetworks
● /api/NetworkService/Fabrics(arg1)/Multicast
● api/NetworkService/Fabrics(arg1)/Multicast/
MulticastNetworks
● /redfish/v1/Oem/Dell/LicenseManager
● /redfish/v1/Managers/
Members('ChassisManager')/Oem/Dell/HWCertificate
● /redfish/v1/Managers/Members('ChassisManager')/
Actions/Oem/DellManager.VerifyHWCertificate
● /api/AccountService/ExternalAccountProvider/
OpenIDConnectProvider
● /api/AccountService/ExternalAccountProvider/
OpenIDConnectProvider(‘OIDCProviderID’)
● /api/AccountService/ExternalAccountProvider/
OpenIDConnectProviders
● /api/AccountService/ExternalAccountProvider /
OpenIDConnectProvider(‘ID’)
● /api/AccountService/
ExternalAccountProvider/Actions/
ExternalAccountProvider.EnableOIDCProviders
● /api/AccountService/
ExternalAccountProvider/Actions/
ExternalAccountProvider.DisableOIDCProviders
● /api/AccountService/ExternalAccountProvider/
Actions/
ExternalAccountProvider.DeleteOIDCProviders
● /api/AccountService/ExternalAccountProvider/
Actions/ExternalAccountProvider.TestOIDCProvider
● /api/AccountService/ExternalAccountProvider/
Actions/
ExternalAccountProvider.TestOIDCProviderRegistratio
nStatus
The following APIs are not supported from this release:
● /api/TemplateService/Profiles
1
About this document 19
Table 1. Supported REST API versions (continued)
Product Date of release What's new
● /api/TemplateService/Profiles(Id)
● /api/TemplateService/Templates(Id)/Views(Id)/
AttributeViewDetails/TemplateEditInfoDetails
● /api/TemplateService/Actions/
TemplateService.DetachProfile
● /api/TemplateService/ProfileState
● /api/TemplateService/ProfileUsage
The ODATA Specification follows RFC 3986 for URL
semantics. According to this specification, percent encode
the space in URLs to “%20” and do not use the plus (+)
sign.
OpenManage Enterprise 3.5 December 2020 The following APIs are added:
● /api/TemplateService/Baselines(ID) on page 628
● POST method for Baselines on page 627
OpenManage Enterprise 3.5 November 2020
● API to retrieve information about the last attempted
console upgrade. See /api/ConsoleUpdateService/
LastUpdateResult on page 608.
● APIs to add, delete, modify, and test OpenID Connect
(OIDC) provider information.
○ /api/AccountService/ExternalAccountProvider/
OpenIDConnectProvider on page 73
○ /api/AccountService/ExternalAccountProvider/
OpenIDConnectProvider('OIDCProviderID') on
page 73
○ /api/AccountService/
ExternalAccountProvider/Actions/
ExternalAccountProvider.DeleteOIDCProviders
on page 75
○ /api/AccountService/
ExternalAccountProvider/Actions/
ExternalAccountProvider.DisableOIDCProviders
on page 75
○ /api/AccountService/
ExternalAccountProvider/Actions/
ExternalAccountProvider.EnableOIDCProviders
on page 74
○ /api/AccountService/
ExternalAccountProvider/Actions/
ExternalAccountProvider.TestOIDCProvider
on page 76
○ /api/AccountService/ExternalAccountProvider/
Actions/
ExternalAccountProvider.TestOIDCProviderRegistr
ationStatus on page 76
OpenManage Enterprise – Modular Edition
1.20.10
August 2020
● APIs to fetch compliance report
of device components. For more
information, see /api/UpdateService/Baselines(Id)/
DeviceComplianceReports.
● APIs to fetch component compliance reports by
Id. For more information, see /api/UpdateService/
Baselines(Id)/DeviceComplianceReports(Id)/
ComponentComplianceReports.
● Added a compliance status option, "Unknown".
For details, see /api/UpdateService/Baselines(Id)/
DeviceComplianceReports, /api/UpdateService/
Baselines(Id)/DeviceComplianceReports(Id)/
20 About this document
/