Reference Guide

ManualsBrandsDell ManualsActive System ManagerOpenManage Enterprise-Modular

771

772

773

774

775

776

777

778

779

780

Table Of Contents

OpenManage Enterprise Version 3.5 and OpenManage Enterprise - Modular Edition Version 1.30.10 RESTful API Guide
Contents
About this document
Overview
- RESTful application programming interface
- OData
- JSON data
- HTTPS communication
- OpenManage Enterprise – Modular Edition
- OpenManage Enterprise
Key integration concepts
- Base URI
  - OEM scheme
  - Redfish scheme
- Security
- Authentication
- Authorization
- Resource addressing
- Resource operations
- Security considerations
- Performance considerations
- Data filtering
- Data sorting
- Data pagination
- Request headers
- Response codes
- Response headers
Application settings
- Network
- Security and user management
- Security and certificate management
- Monitoring and alert notifications
Alerts
- Alert logs
- Alert policies
- Alert definitions
Configure
- Firmware
- Template Service
- Identity pools
- Network Configuration Service
Devices
- /api/DeviceService
  - GET method for DeviceService
- /api/DeviceService/Devices
  - GET method for Devices
- /api/DeviceService/Devices?$filter=Type eq 1000
  - GET method for device filter
- /api/DeviceService/Devices(Id)
  - GET method for Devices(Id)
- /api/DeviceService/Devices(Id)/InventoryDetails
  - GET method for InventoryDetails
    - Individual filters
- /api/DeviceService/Devices(Id)/InventoryDetails(InventoryType)
  - GET method for inventory details by inventory type
- /api/DeviceService/Devices(Id)/Settings('ReplicableChassisConfigurations')
  - PUT method to retrieve chassis time and alert destination settings
- /api/DeviceService/Devices(DEVICE_ID)/Settings('NetworkServices')
  - PUT method for network services settings
- /api/DeviceService/Devices(Device_ID)/Settings('LocalAccessConfiguration')
  - GET method for local access configuration
  - PUT method for local access configuration
- /api/DeviceService/Devices(Id)/HardwareLogs
  - GET method for HardwareLogs
- /api/DeviceService/Devices(Id)/SubSystemHealth
  - GET method for sub system health information
- /api/DeviceService/Devices(Id)/RecentActivity
  - GET method for RecentActivity
- /api/DeviceService/Devices(Id)/InventoryTypes
  - GET method for InventoryTypes
- /api/DeviceService/Devices(Id)/LogSeverities
  - GET method for LogSeverities
- /api/DeviceService/Devices(Id)/Settings
  - GET method for Settings
- /api/DeviceService/Devices(Id)/Settings('Type')
  - GET method for device settings by type
  - PUT method for device settings by type
- /api/DeviceService/Devices(Id)/Temperature
  - GET method for Temperature
- /api/DeviceService/Devices(Id)/BlinkStatus
  - GET method for LED blink status
- /api/DeviceService/Devices(Id)/PowerUsageByDevice
  - GET method for power usage by devices
- /api/DeviceService/Devices(Id)/DeviceBladeSlots
  - GET method for device blade slots
- /api/DeviceService/Devices(Id)/GraphicInfo
  - GET method for GraphicInfo
- /api/DeviceService/Devices(Id)/DeployRequired
  - GET method for deployment by device IDs
- /api/DeviceService/Devices(Id)/SystemUpTime
  - GET method for /api/DeviceService/Devices(Id)/SystemUpTime
- /api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.UploadFSDCertificate
  - POST method for uploading FSD certificate
- /api/DeviceService/PowerStates
  - GET method for PowerStates
- /api/DeviceService/DeviceStatuses
  - GET method for DeviceStatuses
- /api/DeviceService/DeviceType
  - GET method for DeviceType
- /api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.SetTermState
  - POST method for setting term state
- /api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.GetTermState
  - POST method for getting term state
- /api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.GetComputeIPs
  - POST method for /api/DeviceService/Actions/DeviceService/Devices(Id)Actions/DeviceService.GetComputeIPs
- /api/DeviceService/DeviceSummary
  - GET method for DeviceSummary
- /api/DeviceService/DeviceSummary(Type)
  - GET method for /api/DeviceService/DeviceSummary(Type)
- api/DeviceService/Actions/DeviceService.DevicesPrivilegesAction
  - POST method for api/DeviceService/Actions/DeviceService.DevicesPrivilegesAction
- /api/DeviceService/Actions/DeviceService.DevicesByPrivilegesAction
  - POST method for device privileges action
- /api/DeviceService/Actions/DeviceService.ExecuteAction
  - POST method /api/DeviceService/Actions/DeviceService.ExecuteAction
- /api/DeviceService/DeviceSlotType
  - GET method for DeviceSlotType
- /api/DeviceService/DeviceSettingsMetadata
  - GET method for DeviceSettingsMetadata
- /api/DeviceService/GlobalExcludes
  - GET method for GlobalExcludes
  - POST method for GlobalExcludes
- /api/DeviceService/Actions/DeviceService.AddNetworkRange
  - POST method for DeviceService.AddNetworkRange
- /api/DeviceService/Actions/DeviceService.EditNetworkRange
  - POST method for DeviceService.EditNetworkRange
- /api/DeviceService/Actions/DeviceService.RemoveFromExclusion
  - POST method for DeviceService.RemoveFromExclusion
- /api/DeviceService/Actions/DeviceService.ValidateExcludes
  - POST method for DeviceService.ValidateExcludes
- /api/DeviceService/Actions/DeviceService.RemoveDevices
  - POST method for DeviceService.RemoveDevices
Diagnostic
- /api/DeviceService/Devices(Id)/Actions/DeviceService.Diagnostic
  - POST method for DeviceService.Diagnostic
Groups
- /api/GroupService/Groups
  - GET method for Groups
- /api/GroupService/Groups(Id)
- /api/GroupService/Groups(Id)/Devices
  - GET method for Devices
- /api/GroupService/Groups(Id)/GroupDevicesSummary
  - GET method for GroupDevicesSummary
- /api/GroupService/Groups(group id)/AllLeafDeviceSummaries
  - GET method for AllLeafDeviceSummaries
- /api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000
  - Get method for AllLeafDeviceSummaries?$filter=Type eq 4000
- /api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0
  - GET method for AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0
- /api/GroupService/Groups(group id)/AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0&$orderby=Identifier asc
  - GET method for AllLeafDeviceSummaries?$filter=Type eq 4000&$top=25&$skip=0&$orderby=Identifier asc
- /api/GroupService/Groups(Id)/SubGroups
  - GET method for SubGroups
- /api/GroupService/Groups(Id)/GroupHierarchy
  - GET method for GroupHierarchy
- /api/GroupService/GroupTypes
  - GET method for GroupTypes
- /api/GroupService/GroupTypes(Id)
  - GET method for GroupTypes(Id)
- /api/GroupService/MembershipTypes
  - GET method for MembershipTypes
- /api/GroupService/MembershipTypes(Id)
  - GET method for MembershipTypes(Id)
- /api/GroupService/AllGroupsHierarchy
  - GET method for AllGroupsHierarchy
- /api/GroupService/Actions/GroupService.AddMemberDevices
  - POST method for GroupService.AddMemberDevices
- /api/GroupService/Actions/GroupService.GroupsPrivilegesAction
  - POST method for GroupService.GroupsPrivilegesAction
- /api/GroupService/Actions/GroupService.GroupsByPrivilegesAction
  - POST method for GroupService.GroupsByPrivilegesAction
Monitor
- Audit logs
  - /api/ApplicationService/AuditLogs
    - GET method for AuditLogs
    - /api/ApplicationService/AuditLogCategories
      - GET method for /api/ApplicationService/AuditLogCategories
  - /api/ApplicationService/AuditLogs(Id)
    - GET method for AuditLogs(Id)
- Jobs
Reset application
- /api/ApplicationService/Actions/ApplicationService.ResetApplication
  - POST method for ResetApplication
Console version
- /api/ApplicationService/Info
  - GET method for Info
Console capabilities
- /api/ApplicationService/Capabilities
  - GET method for Capabilities
Search
- /api/SearchService/Actions/SearchService.Search
  - POST method for SearchService.Search
Session
- /api/SessionService
  - GET method for SessionService
- /api/SessionService/Sessions
  - GET method for Sessions
  - POST method for Sessions
- /api/SessionService/Sessions(Id)
  - GET method for Sessions(Id)
  - DELETE method for Sessions(Id)
- /api/SessionService/CurrentUser
  - GET method for session details of current user
- /api/SessionService/SessionConfiguration
  - GET method for SessionConfiguration
- /api/SessionService/Actions/SessionService.SessionConfigurationUpdate
  - POST method for SessionService.SessionConfigurationUpdate
- /api/SessionService/Actions/SessionService.Logoff
  - POST method for session service log off
APIs specific to OpenManage Enterprise – Modular Edition
- /api/ApplicationService/Settings
  - GET method for /api/ApplicationService/Settings
  - POST method for /api/ApplicationService/Settings
- /api/ApplicationService/Network/CurrentAddressConfiguration
  - GET method for CurrentAddressConfiguration
- /api/ApplicationService/Network/AddressConfiguration
  - GET method for AddressConfiguration
  - PUT method for AddressConfiguration
- /api/ApplicationService/Actions/ApplicationService.GetConfiguration
  - POST method for ApplicationService.GetConfiguration
- /api/ApplicationService/Actions/ApplicationService.ApplyConfiguration
  - POST method for ApplicationService.ApplyConfiguration
- Brand
  - /api/ApplicationService/Actions/ApplicationService.BrandInfo
    - POST method for BrandInfo
  - /api/ApplicationService/Actions/ApplicationService.ActivateBrand
    - POST method for ActivateBrand
- Multichassis management
- FIPS mode settings
  - /api/ApplicationService/Security/SecurityConfiguration
    - GET method for SecurityConfiguration
- Fabric management
- Port configuration in Fabrics
  - /api/JobService/Jobs
- Storage management
- Quick Deploy
  - /api/JobService/Jobs
    - POST method for Quick-Deploy Jobs
- Server NIC VLAN configuration
- Template Service
APIs specific to OpenManage Enterprise
- Application settings
- Console update
- Mobile
- Console Preferences
- Alerts
- Incoming Alerts
  - https:///api/ApplicationService/Settings
    - POST method for Jobs
- Warranty
  - https:///api/ApplicationService/Settings
    - POST method for Warranty settings
- Network Configuration
- Configuration compliance
- Troubleshoot service
- Query support service
- Groups service
- Profiles
- Devices
- Auto deploy
- Monitor
- Plugin Manager
- Power Metrics
Redfish resource model
- Redfish—ServiceRoot
- Redfish—SessionService
- Redfish—Account Service
- Redfish—Message Registry
- Redfish—Chassis
  - /redfish/v1/Chassis
- Redfish—Systems
- Redfish—CompositionService
- Redfish—EventService
- Redfish—OpenManage Enterprise License Manager
- Redfish—Telemetry
- Managers
- Redfish—OpenID Connect Provider

/redfish/v1/Managers/Members('ChassisManager')/Actions/

Oem/DellManager.VerifyHWCertificate

This URI validates the hardware certificate.

POST method for viewing hardware certificate

This method displays the hardware certificate details.

Description Adds chassis to a chassis group.

Privilege DEVICE_CONFIGURATION

HTTP response

codes

200

Example request

body

{"Algorithm": "AES-128-CBC", "EncryptedChallenge": "HG17+s733PLOJX1dJ75iu9dt7xmspIcfEkvj2o5rqoddgnYa7uGcbW63sRyh0y8FGSx+/

cyOerONXVU0ORj3VkiLACFJFsVWUP9xB7/WAYcZjz3y0Z8iZeeaQ2zqCGAl1XRooHiougyrC10ipnjF0DDaQyecwKU4QC8XpXwVHRgWmOUWFOzQ+4iYPaRX2StIvdbgRV0DJma+wSUBiUj13VO7bK9hStJSeqU+gYjSwePDShgWuRiXNrUztomD/

IY5EWYlWd95AOMFap579f69cnTn9GJrIOecxCXtzxlVjiJgghulpGAVF92WTyyg7k4y5imo6BT6GiPIipSuQaK2jIYZbiXjRu2ikZUC2ALAd5RZRstZXTJg5QAthKqHqJv2evTqF89ZTR5HMVpARpILEWqjVskZ8ciAB4rHLS0qU6rM295B8ZlWbt+xfj9rtqOmyW7mquJe9DUPpHhz7syxLA==",

"Hmac": "gNlXYpgKP+hY3V5T9jqqxdp4BHe2p2xQdCMxgF3UKh8=", "InitialVector": "5cd9944a3ebd524856302c18325ac6c2", "KeyDerivationFunction":

"DellSHA256", "PublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEbWPqomKXrX7Ow79anOOAKh9lyS7BdKRjJ1excBd5acmPq8Ja3KlRzCtfnsbvANGh8o0FSEbT9axI57Mi3Aqrsg=="}

Example

response body

{

"EncryptedResponse": "eHIEEKfMjUxuEo0aK+7QF4MdZJzxiPcCZewfGfXfI+8JQjAfhArbZxIHVZgmBFCEbrmei1NC0NRNRBb+u1mc/

aRVxn6fLfdWW+hjsnaERxt2KnA0HoykSKTe+6CQvxDyomBRgIi8rJwiqOAqkfeosrYa/6fA0vIySzALfUX+G8ZbHRRZaLo4QaPiJaFYfrgFYjFYMx8HG18mRg+19KNDAwR3/5ZSDbhsy8YN/FbHvqEKNCXUpGJ/3ITD+eEpMhBTlSW0jel/

6XJnCKgPAqL+q1j2NyyML+M/xESuRssnoTcXMt0l5Z0Nm6IkDgIQHFydoWOOH5wxSEQSFxVGN+mASekRZugDYGtgXAang4cNJgSYiHI8380hjyY2W3Mx8BM3tBN0I2JnDLbhtYJT9KtHcrnGT9QzJiwZGR9aKcwqGpL287bfnW7FNbM+C2oMvEmrwO/

ReAVJTT2N539WjuTzlZW/kPyiPW6tXkCyAjq2W6E2hV1MffJenw6+32paP63kXtD+99XJ4LygnpukHwH9t/cjuhMghCaa0cErvlamqRuokIdYg5oFGbQgVyLPIP9Dm8ygpp5HInm3Q9j/Cq1nt7gewn7EflD5eEt/

lKqJ1nqfvBae6gYByN81plehtnGTU3+kIKFbxkdbG/nEyG1ygADb502LjSP1GpvQEnvfKWsvr774zHziiX4m+208UYZ0NolXBW63UYjkGTBqIm3hmiOadNjHhhQ6A4KH1wbxxIgMktKts2/y8jr7/

xyCNhOX7nAu2EWkOlDSdo23/9Z+oaHRhCLM90YKmlze/H8ixEzGVgsOskXVCHQu7HSxHfAQkDqj37j9hvbEjco6Mh3Q6YDcYpPQB5/YHSqXaDtGKPfPJRNiyfWKGNgEUuUm7UxaK2ETYsvRxOBDDq2Mg72QCWfxiRZPuAPatScxfFw8bW6/

kUGk6htdG6DM/iokJfbkaLCokcZfAYvE6sSanMxbO+d9FUtJVr8s74mtf7ZmuTZra3DWssfdmFvntK9UzMmihFXNJMxUVIVwMXXW6i9ToyONii2ENjMTuA0xC8hGAkfwIHrPuSoCvllu9LTUhvHneJa0xDru3N3sHbHkjBXXp98vtg/

+IKIkAFzV6FSsj3gWalubkpVR5JdLwotQfPfFw1/YlJAgztzoPotMYVrC72iB+1M/aukEBjEwcu/YEkJaWInFSvrFsNmkZMOZ/zV/6vIJU02eqIrXoNZKqhj/QxNx9QLBuJy44RG/i2OfwIwmx2RODaSYhKkodAZzXriM2gocQmQVeBhlqpY2ytUbV1U7qgju/

8pa6s/QpMawLkWJv61uJWxJw4pWm8gpewK7t2b2VntEM8uzNfZybx1vZX4Yyf17qGHEgyJGp2lnDKLrYf20cMRFy2ZzDOVcRitKfcxI+XKCehQxpg8JMWFIv5ZWTeu3vHV0Rix/Pg+jk/On58aL4Mh8COw6dzUwy0NEMstsaY/

7Ecgi0E8CVKJnWseR0u3S3LujqTLbnoMIfD2RuZrM/JuixnISJYSlPQ8KmIF53s8p+jep0gL7Cyu1KomraPH9G1zA9j44+FO4+vKYUn7q2i+m2j/rcfcRVTi3CbUfQFVCsltgNsex37GFg5bOCcqqtYsE5jHDKIdfmml6nj+127Cco1/

Nd9oH0J+qvagghUQ7U/AMLLGRsQNuLhrpHKfCFA8pjoiqF7i8919egRpT6hcuFfliPfmfKwC7llZcs38JXXPzfLGq8Pk7vmYLVPK0u98iNnOVWmqAJs4/l3kLXyFJ5L7gwoDU5Q88qSi2+8gmT0ysnEiX3JzXGiILG/FG0qj0giHF/

O1f7R1FNgJrbP/RzStLNbEvgrjUUj6To0kh+TnqagLCeaG5VNpHHIqbmNdsUV7yHkYBf5/e+vPmnERzKHlMU5CtuxOOjl3UYgqwiclhkLrsTgVHDMzM4NZt3pNX6BwrbA2D2j8OmThgsAZ4vXVfV2S3Z1EX92Tffn5ndh/hGvyELi0BhOicSDly+ElU/

pkwKlvLU6yu3EJHYiXPSDBURdVT7UH457MbYyhTTpOnyvyGdwtejzfJnAghMYdGaVmaAvB1U0RpOf6fvwbeXcjrE05qlX8oP4KS1wfZzdsGGNNBSrdAe0eZzdvzPOGRhRtDEUReHwZW9ixz5KNJwFaoz9lFb+lLNsL+Eyl/8xTPDnsyvZEU1qM/

rMEF6muaAikFERD13oNuOOkhJwOrfytNk25qm+9phRdiCGE8reY4hF1ccLkOz+zwgZzOtZde4JZFOBSWm1c1WLu9BAwCWwA/4PGWBFKxLwqLZECDMtJlABYkgHXw8vQ2ieqptU1A6V25Xog9KJOsCeMs/Zg3cenKcr4q0XvpMsVuOG4b980Nuk6epOQlRVrxLUia/

c2ZjD7w9TmEkvNR5h+JCzENilXspOM1N8bsvzMyAJG87DtEghLDHYl2Sq6WpmRzE3YemI8NAFOEilq1qGUDSGh2dQuWjG9hfyZGb3aq39G9fQuCkzVWvHQ60lpebTpIAjIyyxlzsNKx+1d1q+JT2boJtANKuZhDIH+q75cmv2mGPf0MpmOEiB+DW3SQlQnngPyJiSsHcVzWEpbJHhFTGBM7FbfSmIVu/

U+DHUvDhROw6g8ZJw0McDdIw5UyrdtSqqiyGWWbpNCTCHJ+UF6v/0dwCxwxKmFwpxIs43yZGglneqAe7/hsAozSqqSMPEhsAgZz6XCbY8ap3SJPg+sn1hkKiKwIVG7K9U8FJJZ9vmy7QJQvFQqbJ6C0c7EzCYHKSaB3yx9VQtf5e/

DasAhQDTvGRwwWgRhTh+G6KAdB5+CXX1RYuWjBnnyHfF+gj3joDZiDaANN60IaZL8iYL1la4u6FBDtHwYwLPAGrTki3BJoTro4iuZmQ0dU8ZqH0XifdV4ahGvUOgN3tVMthsGdmixcCZ0/j/aB9Xwrh61hxdmaL3eXxUL5S+9dCS6TLcAYz+rzohTz1B07r/

73n5mK+rDs9WvsrsER46U24pfkzC8C0hc2pJ10nCKcffnLgVPrr9RLUuuMXfeXJ/+byyX0Dc5sU04rE8sC2i1hZsGRKR5G0AH5WgFy0GOD6wiemPCdjiIONFbJAsw8Pwh7YjJR2cX0044NztyXW+/U0SV+lsnaIVpqco9QwEQlMOcGUWSgs5W/

WkhdxWnUTVPOn3ppEklDzWhhjkZXhvgw3TLZt9BlpIMBKyOqFRavdqyeWSk/ebEsxYchk+9ZB4c6+BH2RmEuCv5s8VWa0OO8q+CUAqKioZ7/TIhxL+RaVXqUmDfTstmXa6dBKwKMYPVsWmhVqphq1mGq4II8jlk9rVNISxZV1uBiJCBGX4AX3gHwdfPN1Ln4+3+o3BwFckEWmPk/

4W51mPq6BKXqExPMgfWCUJGj4v+T9J8dcKLzofVsi+mPKXkrONBrw6sifQS6bFVvP4pM563rjBNhhU+V+JG1HUzvwdmqPsupOi65u92EsD25Zng9y7GStkhprVpChzJD8LRiU7sqMw6GD/

8z1ItjZLItBicM+P9n3kq6a0JXwEWUTe47kot2sfvj6sLM0jnsh6q5cOwLsXwdfDtYnLnbSZ0mbxBCBYgPbAkC3RcsFDuyxHR/h3dQf1eVoFYOgPGH1ARDybRDa3Pxmc5H2AOk0hZwZ4DFL4dr1ogurg==",

"PublicKey": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEHqgtz42wmzHr5IMGaJr723NYQC7A\nP4CfZO2JcNsw/upX7s/otqcuPYSwTdS008VJSQuz7Vk+8YP/MCEUanCJkg==\n-----END PUBLIC KEY-----",

"Hmac": "hUee8Jpcjuj14W55E8cXdRVhuoKGL+c2TIaOI0z+xUk=",

"InitialVector": "F3CAE7025A0B8EFD200E140746CE74A2"

}

Redfish resource model 779