Dell EMC OpenManage Enterprise 3.9 RESTful API Guide

PDF

GET method for DeviceComplianceReports

This method returns the compliance report for a specific baseline.

Description

Returns the compliance report for a baseline. The compliance report includes the URIs, /api/UpdateService/Baselines(Id)/DeviceComplianceReports(Id)/ComponentComplianceReports and /api/UpdateService/Baselines(Id)/DeviceComplianceReports(Id)/ComponentComplianceReports(Id), by default.

Privilege

VIEW

HTTP response codes

200

Example response body

{
    "@odata.context": "/api/$metadata#Collection(UpdateService.DeviceComplianceReport)",
    "@odata.count": 2,
    "value": [
        {
            "@odata.type": "#UpdateService.DeviceComplianceReport",
            "@odata.id": "/api/UpdateService/Baselines(8)/DeviceComplianceReports(4)",
            "Id": 4,
            "DeviceId": 10067,
            "ServiceTag": "CJ2J5Z2",
            "DeviceModel": "MX9116n Fabric Engine",
            "DeviceTypeName": "NETWORK_IOM",
            "DeviceName": "IOM-A1",
            "FirmwareStatus": "Unknown",
            "ComplianceStatus": "UNKNOWN",
            "DeviceTypeId": 4000,
            "RebootRequired": false,
            "DeviceFirmwareUpdateCapable": true,
            "DeviceUserFirmwareUpdateCapable": true,
            "ComponentComplianceReports": [
                {
                    "@odata.type": "#UpdateService.ComponentComplianceReport",
                    "Id": 12,
                    "Version": "Not updatable through catalog",
                    "CurrentVersion": "10.5.0.7.745",
                    "Path": "",
                    "Name": "IOM Firmware",
                    "Criticality": "Unknown",
                    "UniqueIdentifier": "",
                    "TargetIdentifier": "",
                    "UpdateAction": "UNKNOWN",
                    "SourceName": "IOM.Slot.A1",
                    "PrerequisiteInfo": "",
                    "ImpactAssessment": "",
                    "Uri": "",
                    "RebootRequired": false,
                    "ComplianceStatus": "UNKNOWN",
                    "ComplianceDependencies": [],
                    "ComponentType": "FIRMWARE",
                    "DependencyUpgradeRequired": false
                }
            ]
        },
        {
            "@odata.type": "#UpdateService.DeviceComplianceReport",
            "@odata.id": "/api/UpdateService/Baselines(8)/DeviceComplianceReports(5)",
            "Id": 5,
            "DeviceId": 10068,
            "ServiceTag": "CJ2J8Z2",
            "DeviceModel": "MX9116n Fabric Engine",
            "DeviceTypeName": "NETWORK_IOM",
            "DeviceName": "IOM-A2",
            "FirmwareStatus": "Unknown",
            "ComplianceStatus": "UNKNOWN",
            "DeviceTypeId": 4000,
            "RebootRequired": false,
            "DeviceFirmwareUpdateCapable": true,
            "DeviceUserFirmwareUpdateCapable": true,
            "ComponentComplianceReports": [
                {
                    "@odata.type": "#UpdateService.ComponentComplianceReport",
                    "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
                }
            ]
        }
    ]
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute	Description
DeviceId	Identifier for the device in the appliance.
ServiceTag	Service Tag of the device.
DeviceModel	Model of the device.
DeviceTypename	Type of device, such as server or chassis.
DeviceName	Name of the device.
FirmwareStatus	Shows if firmware compliance status. The possible options are: Critical Warning Download Ok Unknown
ComplianceStatus	Shows the compliance status. The possible options are: CRITICAL WARNING DOWNGRADE OK UNKNOWN
DeviceTypeId	Numeric value for the device type such as server(1000).
RebootRequired	Indicates if a reboot is required to make the device compliant.
Link	Link to the component compliance report, identifying the software components on the device and if they match up against the catalog.