### GET Inventory Details - API Response Example Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/get-method-for-inventory-details-by-inventory-type_guid=guid-ef2dc80f-4dbb-488f-adc1-d9a0f0dbc51a&lang=en-us This example showcases a typical JSON response from the Dell OpenManage Enterprise API when requesting inventory details. It includes information such as version, installation date, status, and descriptions for various software and hardware components. ```json { "@odata.context": "/api/$metadata#DeviceService.InventoryDetail", "@odata.type": "#DeviceService.InventoryDetail", "@odata.id": "/api/DeviceService/Devices(10070)/InventoryDetails('deviceSoftware')", "InventoryType": "deviceSoftware", "InventoryInfo": [ { "Version": "1.0.5", "InstallationDate": "2020-11-12 20:42:29.000", "Status": "Installed", "SoftwareType": "FRMW", "VendorId": "", "SubDeviceId": "", "SubVendorId": "", "ComponentId": "27763", "PciDeviceId": "", "DeviceDescription": "System CPLD", "InstanceId": "DCIM:INSTALLED#803__CPLD.Embedded.1" }, { "Version": "0", "InstallationDate": "2020-11-12 20:42:29.000", "Status": "Installed", "SoftwareType": "APAC", "VendorId": "", "SubDeviceId": "", "SubVendorId": "", "ComponentId": "104684", "PciDeviceId": "", "DeviceDescription": "iDRAC Service Module Installer", "InstanceId": "DCIM:INSTALLED#802__ServiceModule.Embedded.1" }, { "Version": "15.00.14", "InstallationDate": "2020-11-19 18:08:37.000", "Status": "Installed", "SoftwareType": "FRMW", "VendorId": "1077", "SubDeviceId": "000F", "SubVendorId": "1077", "ComponentId": "0", "PciDeviceId": "8070", "DeviceDescription": "QLogic 2x25GE QL41262HMKR CNA - 34:80:0D:86:9A:AF", "InstanceId": "DCIM:INSTALLED#701__NIC.Mezzanine.1A-2-1" }, { "Version": "15.00.14", "InstallationDate": "2020-11-19 18:08:35.000", "Status": "Installed", "SoftwareType": "FRMW", "VendorId": "1077", "SubDeviceId": "000F", "SubVendorId": "1077", "ComponentId": "0", "PciDeviceId": "8070", "DeviceDescription": "QLogic 2x25GE QL41262HMKR CNA - 34:80:0D:86:9A:AE", "InstanceId": "DCIM:INSTALLED#701__NIC.Mezzanine.1A-1-1" }, { "Version": "0", "InstallationDate": "2020-11-12 20:42:29.000", "Status": "Installed", "SoftwareType": "APAC", "VendorId": "", "SubDeviceId": "", "SubVendorId": "", "ComponentId": "101734", "PciDeviceId": "", "DeviceDescription": "OS Collector", "InstanceId": "DCIM:INSTALLED#802__OSCollector.Embedded.1" }, { "Version": "2.4.8", "InstallationDate": "2020-11-12 20:42:43.000", "Status": "Installed", "SoftwareType": "BIOS", "VendorId": "", "SubDeviceId": "", "SubVendorId": "", "ComponentId": "159", "PciDeviceId": "", "DeviceDescription": "BIOS", "InstanceId": "DCIM:INSTALLED#741__BIOS.Setup.1-1" }, { "Version": "DL67", "InstallationDate": "2020-11-12 20:42:46.000", "Status": "Installed", "SoftwareType": "FRMW", "VendorId": "", "SubDeviceId": "", "SubVendorId": "", "ComponentId": "107334", "PciDeviceId": "", "DeviceDescription": "Disk 1 in Backplane 0 of Integrated RAID Controller 1", "InstanceId": "DCIM:INSTALLED#304_C_Disk.Bay.1:Enclosure.Internal.0-0:RAID.Integrated.1-1" }, { "Version": "DL67", "InstallationDate": "2020-11-12 20:42:45.000", "Status": "Installed", "SoftwareType": "FRMW", "VendorId": "", "SubDeviceId": "", "SubVendorId": "", "ComponentId": "107334", "PciDeviceId": "", "DeviceDescription": "Disk 0 in Backplane 0 of Integrated RAID Controller 1", "InstanceId": "DCIM:INSTALLED#304_C_Disk.Bay.0:Enclosure.Internal.0-0:RAID.Integrated.1-1" }, { "Version": "4.40.10.00", "InstallationDate": "2020-12-29 08:37:00.000", "Status": "Installed", "SoftwareType": "APAC", "VendorId": "", "SubDeviceId": "", "SubVendorId": "" } ] } ``` -------------------------------- ### Deployment using Boot to ISO Method Example (JSON) Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/post-method-for-templateservicedeploy_guid=guid-c3273b82-f90b-4de4-9090-d3abe1f0d3e0&lang=en-us This JSON object illustrates a request body for deploying a template using the Boot to ISO method via TemplateService.Deploy. It specifies ISO path, share details, and optional timeout settings. ```json { "Id": 51, "TargetIds": [10068], "NetworkBootIsoModel": { "BootToNetwork": true, "ShareType": "CIFS", "IsoPath": "/share/OS/Windows_Svrs_2019_English_StdDC_FPPOEM.iso", "IsoTimeout": 240 -->default "isoTimeoutUnit": -> 1: hours (default), 2 : minutes "ShareDetail": { "IpAddress": "100.97.203.77", "ShareName": "<>", "User": "sharuser", "Password": "dell_1234" } }, "Attributes": [], "Options": } ``` -------------------------------- ### Install and Grant Signed FSD Files Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/post-method-for-granting-signed-fsd-files_guid=guid-0e94b932-8770-44c2-ae2b-7a4d70ab8166&lang=en-us This method installs and grants signed FSD files, requiring APPLIANCE_SETUP privilege. It returns an operation name upon successful execution. ```json { "operationName": "string" } ``` -------------------------------- ### GET Method for License Collection (API Example) Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/get-method-for-license-collection_guid=guid-2c8e3e6b-7c9d-447b-bee6-c88c1e313c2e&lang=en-us This snippet demonstrates how to use the GET method to retrieve a collection of installed licenses from the Dell OpenManage Enterprise API. It shows the expected JSON response structure, including the overall data count and individual member identifiers. This is useful for inventory management and auditing. ```json { "@odata.id": "/redfish/v1/Oem/Dell/LicenseManager/LicenseCollection", "@odata.type": "#DellLicenseCollection.DellLicenseCollection", "Members": [ { "@odata.id": "/redfish/v1/Oem/Dell/LicenseManager/LicenseCollection/9207PA_abc" } ], "Members@odata.count": 1, "Name": "LicenseCollection" } ``` -------------------------------- ### POST Method for IOM Quick Deploy - API Example Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/post-method-for-quick-deploy-of-iom_guid=guid-ba316d42-43d9-4a0d-84bf-9f42ddd44c54&lang=en-us This snippet demonstrates the structure of a POST request to initiate a quick deploy task for IOM (Integrated Outlook Management) via the Dell OpenManage Enterprise API. It includes key parameters such as device ID, credentials, network configuration, and slot-specific settings. The API expects a JSON payload to define the deployment job. ```json { "JobName": "Quick Deploy Task", "JobDescription": "Quick Deploy Task", "Schedule": "startnow", "State": "Enabled", "JobType": { "Id": 42, "Name": "QuickDeploy_Task" }, "Params": [ { "Key": "operationName", "Value": "IOM_QUICK_DEPLOY" }, { "Key": "deviceId", "Value": "25041" }, { "Key": "rootCredential", "Value": "password" }, { "Key": "networkTypeV4", "Value": "Dhcp" }, { "Key": "protocolTypeV4", "Value": "true" }, { "Key": "subnetMaskV4", "Value": "" }, { "Key": "gatewayV4", "Value": "" }, { "Key": "networkTypeV6", "Value": "" }, { "Key": "protocolTypeV6", "Value": "" }, { "Key": "prefixLength", "Value": "" }, { "Key": "gatewayV6", "Value": "" }, { "Key": "slotId=1", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;" }, { "Key": "slotId=2", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;" }, { "Key": "slotId=3", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;" }, { "Key": "slotId=4", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;" }, { "Key": "slotId=5", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;" }, { "Key": "slotId=6", "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;" } ] } ``` -------------------------------- ### GET Attribute Details Example - JSON Response Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/get-method-for-attributedetails_guid=guid-703bcbb6-63ec-4cbd-bd76-cfb377170bf8&lang=en-us An example JSON response illustrating the structure for attribute details, typically returned by a GET method. It includes a ProfileId field. ```json { "ProfileId": 10079 } ``` -------------------------------- ### GET OpenIDConnect Provider by ID - OpenManage Enterprise API Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/get-method-for-connectionstatereasonsarg1_guid=guid-074a4231-851d-4140-8613-ddd1d045cb3e&lang=en-us Retrieves the configuration details for a specific OpenID Connect (OIDC) provider identified by its ID in OpenManage Enterprise. Useful for inspecting individual OIDC setups. ```http GET /api/AccountService/ExternalAccountProvider/OpenIDConnectProvider('ID') HTTP/1.1 Host: your_ome_ip Authorization: Basic YWRtaW46cGFzc3dvcmQ= ``` -------------------------------- ### Auto Deploy Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/apinetworkconfigurationservicenetworktypesid_guid=guid-984e5c50-0da6-417f-9918-ec63bd2c47b7&lang=en-us No description -------------------------------- ### Add License to License Collection (API) Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/post-method-for-license-collection_guid=guid-2317d728-11e0-4003-bea2-d93e6d2e684c&lang=en-us This method installs or imports a license into the Dell OpenManage Enterprise license collection. It requires APPLIANCE_SETUP privilege and returns HTTP status codes 201 (Created) or 400 (Bad Request). The example shows a successful request body. ```json { "@Message.ExtendedInfo": [ { "Message": "Successfully Completed Request", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "Base.1.5.Success", "RelatedProperties": [], "RelatedProperties@odata.count": 0, "Resolution": "None", "Severity": "OK" }, { "Message": "The operation successfully completed.", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "IDRAC.2.1.SYS413", "RelatedProperties": [], "RelatedProperties@odata.count": 0, "Resolution": "No response action is required.", "Severity": "Informational" } ] } ``` -------------------------------- ### GET System Resource Usage - Request Example Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/get-method-for-applicationservicesystemresourceusage_guid=guid-0d98e61a-c18c-4985-9961-12f5c62cfb22&lang=en-us This snippet shows an example of a GET request to retrieve system resource usage data, including CPU, memory, and disk utilization. The request specifies the OData context and ID for the ApplicationService.SystemResourceUsage endpoint. ```json { "@odata.context": "/api/$metadata#ApplicationService.SystemResourceUsage", "@odata.type": "#ApplicationService.SystemResourceUsage", "@odata.id": "/api/ApplicationService/SystemResourceUsage", "CpuUsage": 17.36, "MemoryUsage": 60.44, "DiskUsage": 1.41 } ``` -------------------------------- ### API Configuration Data Example (JSON) Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/post-method-for-viewing-hardware-certificate_guid=guid-73b485bb-f101-4305-b215-d755c606215e&lang=en-us This snippet shows example configuration data for an API, including public key, HMAC, and initial vector. It's typically used for secure communication and authentication within the Dell OpenManage Enterprise API. ```json { "PublicKey": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEHqgtz42wmzHr5IMGaJr723NYQC7A\nP4CfZO2JcNsw/upX7s/otqcuPYSwTdS008VJSQuz7Vk+8YP/MCEUanCJkg==\n-----END PUBLIC KEY-----", "Hmac": "hUee8Jpcjuj14W55E8cXdRVhuoKGL+c2TIaOI0z+xUk=", "InitialVector": "F3CAE7025A0B8EFD200E140746CE74A2" } ``` -------------------------------- ### GET /api/DeviceService/Devices(Id)/Settings Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/apidellconnectivityservice_guid=guid-ddc87a20-1972-4ec0-b390-627878b2d3d9&lang=en-us Retrieves all settings for a specific device. Gets a list of all settings. ```APIDOC ## GET /api/DeviceService/Devices(Id)/Settings ### Description Retrieves all settings for a specific device. ### Method GET ### Endpoint /api/DeviceService/Devices(Id)/Settings ### Parameters #### Path Parameters - **Id** (string) - Required - The ID of the device. ### Request Example ```json { } ``` ### Response #### Success Response (200) - **settings** (object) - An object containing all the settings. #### Response Example ```json { "network": {}, "power": {} } ``` ``` -------------------------------- ### Get Job Details by ID - Example Response Body Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/get-method-for-jobsid_guid=guid-94f797c1-9346-4f9a-af36-8bec9881dc18&lang=en-us This JSON object represents the example response body for a GET request to retrieve details of a specific job. It includes various attributes of the job such as its ID, name, schedule, status, and associated targets and parameters. ```json { "@odata.context": "/api/$metadata#JobService.Job/$entity", "@odata.type": "#JobService.Job", "@odata.id": "/api/JobService/Jobs(10016)", "Id": 10016, "JobName": "Default Inventory Task", "JobDescription": "Default Inventory Task", "NextRun": "2018-09-14 15:30:00.0", "LastRun": "2018-09-14 15:00:00.381", "StartTime": null, "EndTime": null, "Schedule": "0 0/30 * 1/1 * ? *", "State": "Enabled", "CreatedBy": "admin", "UpdatedBy": null, "Visible": false, "Editable": false, "Builtin": true, "Targets": [ { "JobId": 10016, "Id": 500, "Data": "All-Devices", "TargetType": { "Id": 6000, "Name": "GROUP" } } ], "Params": [ { "JobId": 10016, "Key": "defaultInventoryTask", "Value": "TRUE" } ], "LastRunStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2060, "Name": "Completed" }, "JobType": { "@odata.type": "#JobService.JobType", "Id": 8, "Name": "Inventory_Task", "Internal": false }, "JobStatus": { "@odata.type": "#JobService.JobStatus", "Id": 2020, "Name": "Scheduled" }, "ExecutionHistories@odata.navigationLink": "/api/JobService/Jobs(10016)/ExecutionHistories" } ``` -------------------------------- ### POST /redfish/v1/Oem/Dell/LicenseManager/LicenseCollection Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/apireportserviceactionsreportservicedeletereports_guid=guid-aa536af9-d1f5-4242-97ec-2015675eb445&lang=en-us Creates or installs a new license. Use this endpoint to add a license. ```APIDOC ## POST /redfish/v1/Oem/Dell/LicenseManager/LicenseCollection ### Description Creates or installs a new license. ### Method POST ### Endpoint /redfish/v1/Oem/Dell/LicenseManager/LicenseCollection ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **LicenseData** (string) - Required - The license data in a specific format. ### Request Example ```json { "LicenseData": "" } ``` ### Response #### Success Response (201) - **EntitlementID** (string) - The entitlement ID of the installed license. #### Response Example ```json { "EntitlementID": "67890" } ``` ``` -------------------------------- ### POST /redfish/v1/Oem/Dell/LicenseManager/LicenseCollection Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/get-method-for-jobtypesid_guid=guid-15a97174-909f-400a-9a98-be5e60b72a02&lang=en-us Creates a new license. ```APIDOC ## POST /redfish/v1/Oem/Dell/LicenseManager/LicenseCollection ### Description Creates a new license. ### Method POST ### Endpoint /redfish/v1/Oem/Dell/LicenseManager/LicenseCollection ### Parameters #### Path Parameters - **None** #### Query Parameters - **None** #### Request Body - **LicenseData** (string) - Required - The license data. ### Request Example { "LicenseData": "... " } ### Response #### Success Response (201) - **@odata.id** (string) - The URL of the newly created license. #### Response Example { "@odata.id": "/redfish/v1/Oem/Dell/LicenseManager/LicenseCollection/2" } ``` -------------------------------- ### GET Component Compliance Report - Example Response Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/get-method-for-component-compliance-reports_guid=guid-fba75631-92d6-4f4d-836e-9609dd163860&lang=en-us This snippet shows an example JSON response body for the GET method that returns the compliance report for a specific device component. It includes details about the component's version, current version, criticality, and compliance status. ```json { "@odata.context": "/api/$metadata#Collection(UpdateService.ComponentComplianceReport)", "@odata.count": 1, "value": [ { "@odata.type": "#UpdateService.ComponentComplianceReport", "@odata.id": "/api/UpdateService/Baselines(8)/DeviceComplianceReports(5)/ComponentComplianceReports(13)", "Id": 13, "Version": "Not updatable through catalog", "CurrentVersion": "10.5.0.7.745", "Path": "", "Name": "IOM Firmware", "Criticality": "Unknown", "UniqueIdentifier": "", "TargetIdentifier": "", "UpdateAction": "UNKNOWN", "SourceName": "IOM.Slot.A2", "PrerequisiteInfo": "", "ImpactAssessment": "", "Uri": "", "RebootRequired": false, "ComplianceStatus": "UNKNOWN", "ComplianceDependencies": [], "ComponentType": "FIRMWARE", "DependencyUpgradeRequired": false } ] } ``` -------------------------------- ### POST /redfish/v1/Oem/Dell/LicenseManager/LicenseCollection Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/apiquerysupportservicequerycontextsidquerysupportservicegetfiltersforcontext_guid=guid-e6b7fc0a-9b68-4657-8acb-3a757447bbbb&lang=en-us Posts a license to the License Collection. This action installs a new license. ```APIDOC ## POST /redfish/v1/Oem/Dell/LicenseManager/LicenseCollection ### Description Posts a license to the License Collection. ### Method POST ### Endpoint /redfish/v1/Oem/Dell/LicenseManager/LicenseCollection ### Parameters #### Path Parameters - **None** #### Query Parameters - **None** #### Request Body - **LicenseData** (string) - Required - The license data in the appropriate format. ### Request Example { "LicenseData": "" } ### Response #### Success Response (201) - **None** #### Response Example { "example": "" } ``` -------------------------------- ### GET /api/DellConnectivityService Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/apidellconnectivityservice_guid=guid-ddc87a20-1972-4ec0-b390-627878b2d3d9&lang=en-us Retrieves the Dell Connectivity Service information. Used for getting general information about the service. ```APIDOC ## GET /api/DellConnectivityService ### Description Retrieves Dell Connectivity Service information. ### Method GET ### Endpoint /api/DellConnectivityService ### Parameters ### Request Example ```json { } ``` ### Response #### Success Response (200) - **serviceInfo** (object) - Information about the Dell Connectivity Service. #### Response Example ```json { "serviceInfo": { "status": "running", "version": "1.0" } } ``` ``` -------------------------------- ### POST /api/devices/actions/SystemReseat Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/post-method-for-configserviceuploadnodeinfo_guid=guid-0e626bf5-457d-4c27-94a9-e974ed35f5c6&lang=en-us Performs a reseat operation for the entire system. ```APIDOC ## POST /api/devices/actions/SystemReseat ### Description Performs a reseat operation for the entire system. ### Method POST ### Endpoint /api/devices/actions/SystemReseat ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json {} ``` ### Response #### Success Response (200) - **message** (string) - A success message indicating the system reseat operation has started. #### Response Example ```json { "message": "System reseat operation initiated." } ``` ``` -------------------------------- ### GET /redfish/v1/Oem/Dell/LicenseManager/LicenseCollection Source: https://www.dell.com/support/manuals/en-ca/dell-openmanage-enterprise/ome_p_api_guide/apiaccountserviceexternalaccountprovideractionsexternalaccountprovider_guid=guid-f9516ab9-28d6-4a88-84b5-1aec19edcb0e&lang=en-us Retrieves a collection of licenses. This lists all installed licenses. ```APIDOC ## GET /redfish/v1/Oem/Dell/LicenseManager/LicenseCollection ### Description Retrieves a collection of licenses. ### Method GET ### Endpoint /redfish/v1/Oem/Dell/LicenseManager/LicenseCollection ### Parameters #### Path Parameters - **None** #### Query Parameters - **None** #### Request Body - **None** ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **Licenses** (array) - List of licenses. #### Response Example ```json { "Licenses": [ { "Id": "1", "Name": "iDRAC Enterprise License", "EntitlementId": "12345" } ] } ``` ```