API Guide

ManualsBrandsDell ManualsActive System ManagerOpenManage Enterprise-Modular

221

222

223

224

225

226

227

228

229

230

Table Of Contents

OpenManage Enterprise Version 3.5 and OpenManage Enterprise - Modular Edition Version 1.30.00 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(Device_ID)/InventoryDetails('deviceManagement')
  - GET method for device inventory details
- /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

"IscsiSettings":

{

"Mac":

{

"IdentityCount": 65,

"StartingMacAddress": "YGBgYGAA"

"InitiatorConfig":

{

"IqnPrefix": "Iqn.MyIqnPrefix"

}

"FcoeSettings":

{

"Mac":

{

"IdentityCount": 75,

"StartingMacAddress": "cHBwcHAA"

}

"FcSettings":

{

"Wwnn":

{

"IdentityCount": 85,

"StartingAddress": "IACAgICAgAA="

"Wwpn":

{

"IdentityCount": 85,

"StartingAddress": "IAGAgICAgAA="

}

Table 97. Attributes

Attribute name Description

ID Iopool Id

Name Name of the Iopool

Description Definition for the Iopool

EthernetSettings- MAC

IdentityCount Number of Identities

Starting MAC address Initial MAC Address

FcSettings

WWPN worldwide port names

IdentityCount IdentityCount

Starting WWPN address Initial WWPN Address

WWNN worldwide Node names

Starting WWNN address Initial WWNN Address

DELETE method for IdentityPools(Id)

This method deletes an identity pool.

Description

Deletes an identity pool.

Privilege TEMPLATE_MANAGEMENT

228 Configure