LogService

LogEntry 1.19.0⁠


Version	v1.19
Release	2025.2

Description⁠

The LogEntry schema defines the record format for a log. It is designed for Redfish event logs, OEM-specific log formats, and the IPMI System Event Log (SEL). The EntryType field indicates the type of log and the resource includes several additional properties dependent on the EntryType.

URIs⁠

/redfish/v1/Chassis/{ChassisId}/LogServices/{LogServiceId}/Entries/{LogEntryId}
/redfish/v1/Chassis/{ChassisId}/PCIeDevices/{PCIeDeviceId}/CXLLogicalDevices/{CXLLogicalDeviceId}/DeviceLog/Entries/{LogEntryId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/{LogServiceId}/Entries/{LogEntryId}
/redfish/v1/JobService/Log/Entries/{LogEntryId}
/redfish/v1/Managers/{ManagerId}/LogServices/{LogServiceId}/Entries/{LogEntryId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/{LogServiceId}/Entries/{LogEntryId}
/redfish/v1/Systems/{ComputerSystemId}/LogServices/{LogServiceId}/Entries/{LogEntryId}
/redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}/DeviceLog/Entries/{LogEntryId}
/redfish/v1/TelemetryService/LogService/Entries/{LogEntryId}

Properties⁠

Property	Type	Attributes	Notes
Actions (v1.2+) {}	object		The available actions for this resource.
AdditionalDataSizeBytes (v1.7+)	integer (By)	read-only (null)	The size of the additional data for this log entry.
AdditionalDataURI (v1.7+)	string (URI)	read-only (null)	The URI at which to access the additional data for this log entry, such as diagnostic data, image captures, or other files.
CPER (v1.15+) {	object		Details for a CPER section or record associated with this log entry.
NotificationType (v1.15+)	string (uuid)	read-only (null)	The CPER Notification Type for a CPER record.
Oem (v1.15+) {}	object		The OEM extension property. See the Resource schema for details on this property.
SectionType (v1.15+)	string (uuid)	read-only (null)	The CPER Section Type.
}
Created	string (date-time)	read-only	The date and time when the log entry was created.
CXLEntryType (v1.14+)	string (enum)	read-only	The specific CXL entry type. For the possible property values, see CXLEntryType in Property details.
DiagnosticData (v1.15+)	string	read-only (null)	A Base64-encoded set of diagnostic data associated with this log entry.
DiagnosticDataType (v1.7+)	string (enum)	read-only (null)	The type of data available in the `DiagnosticData` property or retrieved from the URI specified by the `AdditionalDataURI` property. For the possible property values, see DiagnosticDataType in Property details.
EntryCode	string (enum)	read-only (null)	The entry code for the log entry if the entry type is `SEL`. For the possible property values, see EntryCode in Property details.
EntryType	string (enum)	read-only required	The type of log entry. For the possible property values, see EntryType in Property details.
EventGroupId (v1.4+)	integer	read-only (null)	An identifier that correlates events with the same cause.
EventId (v1.1+)	string	read-only	The unique instance identifier for an event.
EventTimestamp (v1.1+)	string (date-time)	read-only	The date and time when the event occurred.
EventType (v1.1+, deprecated v1.4)	string (enum)	read-only	The type of event recorded in this log. For the possible property values, see EventType in Property details. Deprecated in v1.4 and later. This property has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the `RegistryPrefix` and `ResourceType` properties and not on the `EventType` property.
FirstOverflowTimestamp (v1.14+)	string (date-time)	read-only	The timestamp of the first overflow captured after this log entry.
GeneratorId (v1.5+)	string	read-only (null)	An identifier of the device that has generated the IPMI SEL Event Record.
LastOverflowTimestamp (v1.14+)	string (date-time)	read-only	The timestamp of the last overflow captured after this log entry.
Links {	object		The links to other resources that are related to this resource.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
OriginOfCondition {	object		The link to the resource that caused the log entry.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
}
RelatedItem (v1.12+) [ {	array		An array of links to resources associated with this log entry.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
RelatedLogEntries (v1.12+) [ {	array		An array of links to other log entries that are related to this log entry.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
}
Message	string	read-only (null)	The message of the log entry. This property decodes from the entry type. If the entry type is `Event`, this property contains a message. If the entry type is `SEL`, this property contains an SEL-specific message. If the entry type is `CXL`, this property contains a CXL event record. Otherwise, this property contains an OEM-specific log entry. In most cases, this property contains the actual log entry.
MessageArgs [ ]	array (string)	read-only	An array of message arguments that are substituted for the arguments in the message when looked up in the message registry.
MessageId	string	read-only	The `MessageId`, event data, or OEM-specific information. This property decodes from the entry type. If the entry type is `Event`, this property contains a Redfish Specification-defined `MessageId`. If the entry type is `SEL`, this property contains the Event Data. Otherwise, this property contains OEM-specific information.
Modified (v1.6+)	string (date-time)	read-only	The date and time when the log entry was last modified.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
OEMDiagnosticDataType (v1.7+)	string	read-only (null)	The OEM-defined type of data available in the `DiagnosticData` property or retrieved from the URI specified by the `AdditionalDataURI` property.
OemLogEntryCode (v1.3+)	string	read-only (null)	The OEM-specific entry code, if the `LogEntryCode` type is `OEM`.
OemRecordFormat	string	read-only (null)	The OEM-specific format of the entry. If the entry type is `Oem`, this property contains more information about the record format from the OEM.
OemSensorType (v1.3+)	string	read-only (null)	The OEM-specific sensor type if the sensor type is `OEM`.
Originator (v1.11+)	string	read-only	The source of the log entry.
OriginatorType (v1.11+)	string (enum)	read-only	The type of originator data. For the possible property values, see OriginatorType in Property details.
OverflowErrorCount (v1.14+)	integer	read-only	The count of overflow errors that occurred after this log entry.
PartNumber (v1.19+)	string	read-only (null)	The part number associated with the source of this log entry.
Persistency (v1.14+)	boolean	read-only	Indicates whether the log entry is persistent across a cold reset of the device.
Resolution (v1.9+)	string	read-only	Used to provide suggestions on how to resolve the situation that caused the log entry.
ResolutionSteps (v1.16+) [ { } ]	array (object)		The list of recommended steps to resolve the cause of the log entry. See the v1_0_1.v1_0_1 schema for details on this property.
Resolved (v1.8+)	boolean	read-write (null)	Indicates if the cause of the log entry has been resolved or repaired.
SensorNumber	integer	read-only (null)	The IPMI-defined sensor number.
SensorType	string (enum)	read-only (null)	The sensor type to which the log entry pertains if the entry type is `SEL`. For the possible property values, see SensorType in Property details.
SerialNumber (v1.19+)	string	read-only (null)	The serial number associated with the source of this log entry.
ServiceProviderNotified (v1.9+)	boolean	read-only (null)	Indicates if the log entry has been sent to the service provider.
Severity	string (enum)	read-only (null)	The severity of the log entry. For the possible property values, see Severity in Property details.
SpecificEventExistsInGroup (v1.13+)	boolean	read-only	Indicates this log entry is equivalent to a more specific log entry within the same `EventGroupId`.
UserAuthenticationSource (v1.17+)	string	read-only (null)	The source of authentication for the username property associated with the log entry.
Username (v1.17+)	string	read-only (null)	The username of the account associated with the log entry.

Property details⁠

CXLEntryType⁠

The specific CXL entry type.

string	Description
DynamicCapacity	A CXL Dynamic Capacity log entry.
Failure	A CXL failure log entry.
Fatal	A CXL fatal log entry.
Informational	A CXL informational log entry.
Warning	A CXL warning log entry.

DiagnosticDataType⁠

The type of data available in the DiagnosticData property or retrieved from the URI specified by the AdditionalDataURI property.

string	Description
CPER (v1.10+)	UEFI Common Platform Error Record.
CPERSection (v1.10+)	A Section of a UEFI Common Platform Error Record.
Device (v1.18+)	Device diagnostic data.
Manager	Manager diagnostic data.
OEM	OEM diagnostic data.
OS	Operating system (OS) diagnostic data.
PreOS	Pre-OS diagnostic data.

EntryCode⁠

The entry code for the log entry if the entry type is SEL.

string	Description
Assert	The condition has been asserted.
D0 Power State	The ACPI-defined D0 power state.
D1 Power State	The ACPI-defined D1 power state.
D2 Power State	The ACPI-defined D2 power state.
D3 Power State	The ACPI-defined D3 power state.
Deassert	The condition has been deasserted.
Device Disabled	A device has been disabled.
Device Enabled	A device has been enabled.
Device Inserted / Device Present	A device has been inserted or is present.
Device Removed / Device Absent	A device has been removed or is absent.
Fully Redundant	Indicates that full redundancy has been regained.
Informational	An informational event.
Install Error	An install error has been detected.
Limit Exceeded	A limit has been exceeded.
Limit Not Exceeded	A limit has not been exceeded.
Lower Critical — going high	The reading crossed the Lower Critical threshold while going high.
Lower Critical — going low	The reading crossed the Lower Critical threshold while going low.
Lower Non-critical — going high	The reading crossed the Lower Non-critical threshold while going high.
Lower Non-critical — going low	The reading crossed the Lower Non-critical threshold while going low.
Lower Non-recoverable — going high	The reading crossed the Lower Non-recoverable threshold while going high.
Lower Non-recoverable — going low	The reading crossed the Lower Non-recoverable threshold while going low.
Monitor	A monitor event.
Non-redundant:Insufficient Resources	Unit is non-redundant and has insufficient resources to maintain normal operation.
Non-redundant:Sufficient Resources from Insufficient Resources	Unit has regained minimum resources needed for normal operation.
Non-redundant:Sufficient Resources from Redundant	Redundancy has been lost but unit is functioning with minimum resources needed for normal operation.
OEM (v1.3+)	An OEM-defined event.
Performance Lags	Performance does not meet expectations.
Performance Met	Performance meets expectations.
Predictive Failure asserted	A Predictive Failure has been detected.
Predictive Failure deasserted	A Predictive Failure is no longer present.
Redundancy Degraded	Redundancy still exists, but at less than full level.
Redundancy Degraded from Fully Redundant	Unit has lost some redundant resource(s) but is still in a redundant state.
Redundancy Degraded from Non-redundant	Unit has regained some resource(s) and is redundant but not fully redundant.
Redundancy Lost	Entered any non-redundant state, including Non-redundant: Insufficient Resources.
State Asserted	The state has been asserted.
State Deasserted	The state has been deasserted.
Transition to Active	The state transitioned to active.
Transition to Busy	The state transitioned to busy.
Transition to Critical from less severe	A state has changed to Critical from less severe.
Transition to Critical from Non-recoverable	A state has changed to Critical from Non-recoverable.
Transition to Degraded	A state has transitioned to Degraded.
Transition to Idle	The state transitioned to idle.
Transition to In Test	A state has transitioned to In Test.
Transition to Non-Critical from more severe	A state has changed to Non-Critical from more severe.
Transition to Non-Critical from OK	A state has changed to Non-Critical from OK.
Transition to Non-recoverable	A state has changed to Non-recoverable.
Transition to Non-recoverable from less severe	A state has changed to Non-recoverable from less severe.
Transition to Off Duty	A state has transitioned to Off Duty.
Transition to Off Line	A state has transitioned to Off Line.
Transition to OK	A state has changed to OK.
Transition to On Line	A state has transitioned to On Line.
Transition to Power Off	A state has transitioned to Power Off.
Transition to Power Save	A state has transitioned to Power Save.
Transition to Running	A state has transitioned to Running.
Upper Critical — going high	The reading crossed the Upper Critical threshold while going high.
Upper Critical — going low	The reading crossed the Upper Critical threshold while going low.
Upper Non-critical — going high	The reading crossed the Upper Non-critical threshold while going high.
Upper Non-critical — going low	The reading crossed the Upper Non-critical threshold while going low.
Upper Non-recoverable — going high	The reading crossed the Upper Non-recoverable threshold while going high.
Upper Non-recoverable — going low	The reading crossed the Upper Non-recoverable threshold while going low.

EntryType⁠

The type of log entry.

string	Description
CXL (v1.14+)	A CXL log entry.
Event	A Redfish-defined message.
Oem	An entry in an OEM-defined format.
SEL	A legacy IPMI System Event Log (SEL) entry.

EventType⁠

The type of event recorded in this log.

string	Description
Alert	A condition requires attention.
MetricReport	The telemetry service is sending a metric report.
Other	Because `EventType` is deprecated as of Redfish Specification v1.6, the event is based on a registry or resource but not an `EventType`.
ResourceAdded	A resource has been added.
ResourceRemoved	A resource has been removed.
ResourceUpdated	A resource has been updated.
StatusChange	The status of a resource has changed.

OriginatorType⁠

The type of originator data.

string	Description
Client	A client of the service created this log entry.
Internal	A process running on the service created this log entry.
SupportingService	A process not running on the service but running on a supporting service, such as RDE implementations, UEFI, or host processes, created this log entry.

SensorType⁠

The sensor type to which the log entry pertains if the entry type is SEL.

string	Description
Add-in Card	A sensor for an add-in card.
BaseOSBoot/InstallationStatus	A sensor for a base OS boot or installation status event.
Battery	A sensor for a battery.
Boot Error	A sensor for a boot error event.
Button/Switch	A sensor for a button or switch.
Cable/Interconnect	A sensor for a cable or interconnect device type.
Chassis	A sensor for a chassis.
ChipSet	A sensor for a chipset.
CoolingDevice	A sensor for a cooling device.
Critical Interrupt	A sensor for a critical interrupt event.
Current	A current sensor.
Drive Slot/Bay	A sensor for a drive slot or bay.
Entity Presence	A sensor for an entity presence event.
Event Logging Disabled	A sensor for the event log.
Fan	A fan sensor.
FRUState	A sensor for a FRU state event.
LAN	A sensor for a LAN device.
Management Subsystem Health	A sensor for a management subsystem health event.
Memory	A sensor for a memory device.
Microcontroller/Coprocessor	A sensor for a microcontroller or coprocessor.
Module/Board	A sensor for a module or board.
Monitor ASIC/IC	A sensor for a monitor ASIC or IC.
OEM (v1.3+)	An OEM-defined sensor.
OS Stop/Shutdown	A sensor for an OS stop or shutdown event.
Other FRU	A sensor for another type of FRU.
Other Units-based Sensor	A sensor for a miscellaneous analog sensor.
Physical Chassis Security	A physical security sensor.
Platform Alert	A sensor for a platform alert event.
Platform Security Violation Attempt	A platform security sensor.
POST Memory Resize	A sensor for a POST memory resize event.
Power Supply / Converter	A sensor for a power supply or DC-to-DC converter.
PowerUnit	A sensor for a power unit.
Processor	A sensor for a processor.
Session Audit	A sensor for a session audit event.
Slot/Connector	A sensor for a slot or connector.
System ACPI PowerState	A sensor for an ACPI power state event.
System Event	A sensor for a system event.
System Firmware Progress	A sensor for a system firmware progress event.
SystemBoot/Restart	A sensor for a system boot or restart event.
Temperature	A temperature sensor.
Terminator	A sensor for a terminator.
Version Change	A sensor for a version change event.
Voltage	A voltage sensor.
Watchdog	A sensor for a watchdog event.

Severity⁠

The severity of the log entry.

string	Description
Critical	A critical condition that requires immediate attention.
OK	Informational or operating normally.
Warning	A condition that requires attention.

Example response⁠

{
    "@odata.type": "#LogEntry.v1_21_0.LogEntry",
    "Id": "1",
    "Name": "Log Entry 1",
    "EntryType": "Event",
    "Severity": "Critical",
    "Created": "2012-03-07T14:44:00Z",
    "Resolved": false,
    "Message": "Temperature threshold exceeded",
    "MessageId": "Contoso.1.0.TempAssert",
    "MessageArgs": [
        "42"
    ],
    "Links": {
        "OriginOfCondition": {
            "@odata.id": "/redfish/v1/Chassis/1U/Thermal"
        }
    },
    "@odata.id": "/redfish/v1/Systems/437XR1138R2/LogServices/Log1/Entries/1"
}

LogService 1.8.0⁠


Version	v1.8
Release	2025.1

Description⁠

The LogService schema contains properties for monitoring and configuring a log service. When the Id property contains DeviceLog, the log contains device-resident log entries that follow the physical device when moved from system-to-system, and not a replication or subset of a system event log.

URIs⁠

/redfish/v1/Chassis/{ChassisId}/LogServices/{LogServiceId}
/redfish/v1/Chassis/{ChassisId}/PCIeDevices/{PCIeDeviceId}/CXLLogicalDevices/{CXLLogicalDeviceId}/DeviceLog
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/{LogServiceId}
/redfish/v1/JobService/Log
/redfish/v1/Managers/{ManagerId}/LogServices/{LogServiceId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/{LogServiceId}
/redfish/v1/Systems/{ComputerSystemId}/LogServices/{LogServiceId}
/redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}/DeviceLog
/redfish/v1/TelemetryService/LogService

Properties⁠

Property	Type	Attributes	Notes
Actions {	object		The available actions for this resource.
#LogService.ClearLog {}	object		The action to clear the log for this log service. For more information, see the Actions section below.
#LogService.CollectDiagnosticData (v1.2+) {}	object		The action to collect the diagnostic data for the given type. When the diagnostic data is collected, a new log entry will be created and the additional data referenced by the new log entry will contain the diagnostic data. For more information, see the Actions section below.
#LogService.PushDiagnosticData (v1.6+) {}	object		The action to push an existing diagnostic data to a target URI. For more information, see the Actions section below.
}
AutoClearResolvedEntries (v1.7+)	string (enum)	read-write (null)	Indicates if this log service automatically clears the resolved log entries. For the possible property values, see AutoClearResolvedEntries in Property details.
AutoDSTEnabled (v1.3+)	boolean	read-write	An indication of whether the log service is configured for automatic Daylight Saving Time (DST) adjustment.
DateTime	string (date-time)	read-write (null)	The current date and time with UTC offset of the log service.
DateTimeLocalOffset	string	read-write (null)	The time offset from UTC that the `DateTime` property is in `+HH:MM` format.
DiagnosticDataDetails (v1.7+) [ {	array		The detailed information for the data collected with the `CollectDiagnosticData` action.
DiagnosticDataType (v1.7+)	string (enum)	read-only (null)	The type of diagnostic data to collect with the `CollectDiagnosticData` action. For the possible property values, see DiagnosticDataType in Property details.
EstimatedDuration (v1.7+)	string (duration)	read-only (null)	The estimated total time required to generate the data with the `CollectDiagnosticData` action.
EstimatedSizeBytes (v1.7+)	integer	read-only (null)	The estimated size of the data collected by `CollectDiagnosticData` action.
OEMDiagnosticDataType (v1.7+)	string	read-only (null)	The OEM-defined type of diagnostic data to collect with the `CollectDiagnosticData` action.
} ]
Entries {	object		The link to the log entry collection.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
}
LogEntryType (v1.1+)	string (enum)	read-only (null)	The format of the log entries. For the possible property values, see LogEntryType in Property details.
LogPurposes (v1.4+) [ ]	array (string (enum))	read-only (null)	The purposes of the log. For the possible property values, see LogPurposes in Property details.
MaxNumberOfRecords	integer	read-only	The maximum number of log entries that this service can have.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
OEMLogPurpose (v1.4+)	string	read-only (null)	The OEM-specified purpose of the log if `LogPurposes` contains `OEM`.
Overflow (v1.4+)	boolean	read-only	Indicates whether the log service has overflowed.
OverWritePolicy	string (enum)	read-only	The overwrite policy for this service that takes place when the log is full. For the possible property values, see OverWritePolicy in Property details.
Persistency (v1.4+)	boolean	read-only	Indicates whether the log service is persistent across a cold reset.
ServiceEnabled	boolean	read-write (null)	An indication of whether this service is enabled.
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
SyslogFilters (v1.2+) [ {	array		A list of syslog message filters to be logged locally.
LogFacilities (v1.2+) [ ]	array (string (enum))	read-write (null)	The types of programs that can log messages. For the possible property values, see LogFacilities in Property details.
LowestSeverity (v1.2+)	string (enum)	read-write (null)	The lowest severity level message that will be logged. For the possible property values, see LowestSeverity in Property details.
} ]

Actions⁠

ClearLog⁠

Description

The action to clear the log for this log service.

Action URI

{Base URI of target resource}/Actions/LogService.ClearLog

Action parameters

Parameter Name	Type	Attributes	Notes
LogEntriesETag (v1.3+)	string	optional	The ETag of the log entry collection within this log service. If the provided ETag does not match the current ETag of the log entry collection, the request is rejected.

Request Example

{
    "LogEntriesEtag": "W/\"2A90423A\""
}

CollectDiagnosticData (v1.2+)⁠

Description

The action to collect the diagnostic data for the given type. When the diagnostic data is collected, a new log entry will be created and the additional data referenced by the new log entry will contain the diagnostic data.

Action URI

{Base URI of target resource}/Actions/LogService.CollectDiagnosticData

Action parameters

Parameter Name	Type	Attributes	Notes
DiagnosticDataType	string (enum)	required	The type of diagnostic data to collect. For the possible property values, see DiagnosticDataType in Property details.
OEMDiagnosticDataType	string	optional	The OEM-defined type of diagnostic data to collect.
Password (v1.6+)	string	optional	The password to access the URI specified by the `TargetURI` parameter.
TargetDevice (v1.8+) {	object	optional	The link to the device to collect diagnostic data.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
}
TargetURI (v1.6+)	string (URI)	optional	The URI to access when sending the diagnostic data.
TransferProtocol (v1.6+)	string (enum)	optional	The network protocol that the service uses to send the diagnostic data. For the possible property values, see TransferProtocol in Property details.
UserName (v1.6+)	string	optional	The username to access the URI specified by the `TargetURI` parameter.

Request Example

{
    "DiagnosticDataType": "Manager"
}

PushDiagnosticData (v1.6+)⁠

Description

The action to push an existing diagnostic data to a target URI.

Action URI

{Base URI of target resource}/Actions/LogService.PushDiagnosticData

Action parameters

Parameter Name	Type	Attributes	Notes
AdditionalDataURI	string (URI)	required	The URI of the diagnostic data to transfer to the URI specified by the `TargetURI` parameter.
Password	string	optional	The password to access the URI specified by the `TargetURI` parameter.
TargetURI	string (URI)	required	The URI to access when sending the diagnostic data.
TransferProtocol	string (enum)	optional	The network protocol that the service uses to send the diagnostic data. For the possible property values, see TransferProtocol in Property details.
UserName	string	optional	The username to access the URI specified by the `TargetURI` parameter.

Request Example

{
    "AdditionalDataUri": "/redfish/v1/LogSerivce/Diags/10242023T132938.bin",
    "TargetURI": "https://192.168.24.34/receivedfiles/192-168-89-33_10242023T132938.bin",
    "UserName": "Admin",
    "Password": "FluffyBunny23",
    "TransferProtocol": "HTTPS"
}

Property details⁠

AutoClearResolvedEntries⁠

Indicates if this log service automatically clears the resolved log entries.

string	Description
ClearEventGroup	Automatically clears all resolved log entries and other entries within the same `EventGroupId`.
None	Do not automatically clear the resolved log entries.
RetainCauseResolutionEntries	Retains log entries of the original cause and the final resolution, but automatically clears other entries containing the intermediate results within the same `EventGroupId`.
UpdateCauseEntry	Updates log entries of the original cause, but automatically clears other entries within the same `EventGroupId`.

DiagnosticDataType⁠

The type of diagnostic data to collect.

string	Description
Device (v1.8+)	Device diagnostic data.
Manager	Manager diagnostic data.
OEM	OEM diagnostic data.
OS	Operating system (OS) diagnostic data.
PreOS	Pre-OS diagnostic data.

LogEntryType⁠

The format of the log entries.

string	Description
CXL (v1.5+)	The log contains CXL log entries.
Event	The log contains Redfish-defined messages.
Multiple	The log contains multiple log entry types and, therefore, the log service cannot guarantee a single entry type.
OEM	The log contains entries in an OEM-defined format.
SEL	The log contains legacy IPMI System Event Log (SEL) entries.

LogFacilities⁠

The types of programs that can log messages.

string	Description
Auth	Security/authentication messages.
Authpriv	Security/authentication messages.
Console	Log alert.
Cron	Clock daemon.
Daemon	System daemons.
FTP	FTP daemon.
Kern	Kernel messages.
Local0	Locally used facility 0.
Local1	Locally used facility 1.
Local2	Locally used facility 2.
Local3	Locally used facility 3.
Local4	Locally used facility 4.
Local5	Locally used facility 5.
Local6	Locally used facility 6.
Local7	Locally used facility 7.
LPR	Line printer subsystem.
Mail	Mail system.
News	Network news subsystem.
NTP	NTP subsystem.
Security	Log audit.
SolarisCron	Scheduling daemon.
Syslog	Messages generated internally by syslogd.
User	User-level messages.
UUCP	UUCP subsystem.

LogPurposes⁠

The purposes of the log.

string	Description
Diagnostic	The log provides information for diagnosing hardware or software issues, such as error conditions, sensor threshold trips, or exception cases.
ExternalEntity	The log exposes log entries provided by external entities, such as external users, system firmware, operating systems, or management applications.
OEM	The log is used for an OEM-defined purpose.
Operations	The log provides information about management operations that have a significant impact on the system, such as firmware updates, system resets, and storage volume creation.
Security	The log provides security-related information such as authentication, authorization, and data access logging required for security audits.
Telemetry	The log provides telemetry history, typically collected on a regular basis.

LowestSeverity⁠

The lowest severity level message that will be logged.

string	Description
Alert	A condition that should be corrected immediately, such as a corrupted system database.
All	A message of any severity.
Critical	Hard device errors.
Debug	Messages that contain information normally of use only when debugging a program.
Emergency	A panic condition.
Error	An Error.
Informational	Informational only.
Notice	Conditions that are not error conditions, but that might require special handling.
Warning	A Warning.

OverWritePolicy⁠

The overwrite policy for this service that takes place when the log is full.

string	Description
NeverOverWrites	When full, new entries to the log are discarded.
Unknown	The overwrite policy is not known or is undefined.
WrapsWhenFull	When full, new entries to the log overwrite earlier entries.

TransferProtocol⁠

The network protocol that the service uses to send the diagnostic data.

string	Description
CIFS	Common Internet File System (CIFS).
FTP	File Transfer Protocol (FTP).
HTTP	Hypertext Transfer Protocol (HTTP).
HTTPS	Hypertext Transfer Protocol Secure (HTTPS).
NFS	Network File System (NFS).
OEM	A manufacturer-defined protocol.
SCP	Secure Copy Protocol (SCP).
SFTP	SSH File Transfer Protocol (SFTP).
TFTP	Trivial File Transfer Protocol (TFTP).

Example response⁠

{
    "@odata.type": "#LogService.v1_9_0.LogService",
    "Id": "Log1",
    "Name": "System Log Service",
    "Description": "This log contains entries related to the operation of the host Computer System.",
    "MaxNumberOfRecords": 1000,
    "OverWritePolicy": "WrapsWhenFull",
    "DateTime": "2015-03-13T04:14:33+06:00",
    "DateTimeLocalOffset": "+06:00",
    "ServiceEnabled": true,
    "LogEntryType": "Event",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "Actions": {
        "#LogService.ClearLog": {
            "target": "/redfish/v1/Managers/1/LogServices/Log1/Actions/LogService.ClearLog"
        }
    },
    "Entries": {
        "@odata.id": "/redfish/v1/Managers/1/LogServices/Log1/Entries"
    },
    "@odata.id": "/redfish/v1/Managers/1/LogServices/Log1"
}

LogEntry 1.19.0⁠​

Description⁠​

URIs⁠​

Properties⁠​

Property details⁠​

CXLEntryType⁠​

DiagnosticDataType⁠​

EntryCode⁠​

EntryType⁠​

EventType⁠​

OriginatorType⁠​

SensorType⁠​

Severity⁠​

Example response⁠​

LogService 1.8.0⁠​

Description⁠​

URIs⁠​

Properties⁠​

Actions⁠​

ClearLog⁠​

CollectDiagnosticData (v1.2+)⁠​

PushDiagnosticData (v1.6+)⁠​

Property details⁠​

AutoClearResolvedEntries⁠​

DiagnosticDataType⁠​

LogEntryType⁠​

LogFacilities⁠​

LogPurposes⁠​

LowestSeverity⁠​

OverWritePolicy⁠​

TransferProtocol⁠​

Example response⁠​

LogEntry 1.19.0⁠

Description⁠

URIs⁠

Properties⁠

Property details⁠

CXLEntryType⁠

DiagnosticDataType⁠

EntryCode⁠

EntryType⁠

EventType⁠

OriginatorType⁠

SensorType⁠

Severity⁠

Example response⁠

LogService 1.8.0⁠

Description⁠

URIs⁠

Properties⁠

Actions⁠

ClearLog⁠

CollectDiagnosticData (v1.2+)⁠

PushDiagnosticData (v1.6+)⁠

Property details⁠

AutoClearResolvedEntries⁠

DiagnosticDataType⁠

LogEntryType⁠

LogFacilities⁠

LogPurposes⁠

LowestSeverity⁠

OverWritePolicy⁠

TransferProtocol⁠

Example response⁠