Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / e9cc1bc93c4ad9662c93e2a98d4c787e2dbf9f07 / . / static / redfish / v1 / schema / LogService_v1.xml
blob: fa29642a677a8629cb3650b8000d6cd0148a5e3c [file] [log] [blame]
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Ed Tanouse9cc1bc2023-09-21 11:15:30 -0700[diff] [blame^]4<!--# Redfish Schema: LogService v1.5.1 -->
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]5<!--# -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
7<!--# available at http://www.dmtf.org/standards/redfish -->
Ed Tanousf263e092023-05-22 09:56:29 -0700[diff] [blame]8<!--# Copyright 2014-2023 DMTF. -->
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]9<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10<!--################################################################################ -->
11<!---->
12<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13
14 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15 <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16 </edmx:Reference>
17 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
18 <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
19 </edmx:Reference>
20 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
21 <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
22 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
23 </edmx:Reference>
24 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
25 <edmx:Include Namespace="Resource"/>
26 <edmx:Include Namespace="Resource.v1_0_0"/>
27 </edmx:Reference>
28 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/LogEntryCollection_v1.xml">
29 <edmx:Include Namespace="LogEntryCollection"/>
30 </edmx:Reference>
31
32 <edmx:DataServices>
33
34 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService">
35 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
36
37 <EntityType Name="LogService" BaseType="Resource.v1_0_0.Resource" Abstract="true">
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]38 <Annotation Term="OData.Description" String="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."/>
39 <Annotation Term="OData.LongDescription" String="This resource shall represent a log service for a Redfish implementation. When the Id property contains `DeviceLog`, the log shall contain log entries that migrate with the device."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]40 <Annotation Term="Capabilities.InsertRestrictions">
41 <Record>
42 <PropertyValue Property="Insertable" Bool="false"/>
43 </Record>
44 </Annotation>
45 <Annotation Term="Capabilities.UpdateRestrictions">
46 <Record>
47 <PropertyValue Property="Updatable" Bool="true"/>
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]48 <Annotation Term="OData.Description" String="The date and time properties can be updated for a log service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]49 </Record>
50 </Annotation>
51 <Annotation Term="Capabilities.DeleteRestrictions">
52 <Record>
53 <PropertyValue Property="Deletable" Bool="false"/>
54 </Record>
55 </Annotation>
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]56 <Annotation Term="Redfish.Uris">
57 <Collection>
58 <String>/redfish/v1/Managers/{ManagerId}/LogServices/{LogServiceId}</String>
59 <String>/redfish/v1/Systems/{ComputerSystemId}/LogServices/{LogServiceId}</String>
60 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/{LogServiceId}</String>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600[diff] [blame]61 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/{LogServiceId}</String>
Gunnar Mills09b9d452020-02-11 13:27:39 -0600[diff] [blame]62 <String>/redfish/v1/Chassis/{ChassisId}/LogServices/{LogServiceId}</String>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]63 <String>/redfish/v1/JobService/Log</String>
64 <String>/redfish/v1/TelemetryService/LogService</String>
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]65 <String>/redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}/DeviceLog</String>
Ed Tanousa8d8f9d2023-01-26 13:57:00 -0800[diff] [blame]66 <String>/redfish/v1/Chassis/{ChassisId}/PCIeDevices/{PCIeDeviceId}/CXLLogicalDevices/{CXLLogicalDeviceId}/DeviceLog</String>
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]67 </Collection>
68 </Annotation>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]69 </EntityType>
70
71 <Action Name="ClearLog" IsBound="true">
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]72 <Annotation Term="OData.Description" String="The action to clear the log for this log service."/>
73 <Annotation Term="OData.LongDescription" String="This action shall delete all entries found in the LogEntryCollection resource for this log service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]74 <Parameter Name="LogService" Type="LogService.v1_0_0.Actions"/>
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]75 <Parameter Name="LogEntriesETag" Type="Edm.String">
76 <Annotation Term="OData.Description" String="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."/>
77 <Annotation Term="OData.LongDescription" String="This parameter shall contain the ETag of the LogEntryCollection resource for this log service. If the client-provided ETag does not match the current ETag of the LogEntryCollection resource for this log service, the service shall return the HTTP 428 (Precondition Required) status code to reject the request."/>
78 <Annotation Term="Redfish.Revisions">
79 <Collection>
80 <Record>
81 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
82 <PropertyValue Property="Version" String="v1_3_0"/>
83 </Record>
84 </Collection>
85 </Annotation>
86 </Parameter>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]87 </Action>
88
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]89 <Action Name="CollectDiagnosticData" IsBound="true">
Ed Tanoused761212022-09-23 15:03:29 -0700[diff] [blame]90 <Annotation Term="OData.Description" String="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."/>
91 <Annotation Term="OData.LongDescription" String="This action shall collect the diagnostic data for the given type. The `Location` header in the response shall contain a URI to a resource of type LogEntry that contains the diagnostic data. The AdditionalDataURI property in the referenced LogEntry resource shall contain the URI to download the diagnostic data."/>
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]92 <Parameter Name="LogService" Type="LogService.v1_0_0.Actions"/>
93 <Parameter Name="DiagnosticDataType" Type="LogService.v1_2_0.LogDiagnosticDataTypes" Nullable="false">
94 <Annotation Term="OData.Description" String="The type of diagnostic data to collect."/>
95 <Annotation Term="OData.LongDescription" String="This parameter shall contain the type of diagnostic data to collect."/>
96 </Parameter>
97 <Parameter Name="OEMDiagnosticDataType" Type="Edm.String">
98 <Annotation Term="OData.Description" String="The OEM-defined type of diagnostic data to collect."/>
99 <Annotation Term="OData.LongDescription" String="This parameter shall contain the OEM-defined type of diagnostic data to collect. This parameter shall be required if DiagnosticDataType is `OEM`."/>
100 </Parameter>
101 <Annotation Term="Redfish.Revisions">
102 <Collection>
103 <Record>
104 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
105 <PropertyValue Property="Version" String="v1_2_0"/>
106 </Record>
107 </Collection>
108 </Annotation>
109 </Action>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]110 </Schema>
111
112 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_0">
113 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600[diff] [blame]114 <Annotation Term="Redfish.Release" String="1.0"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]115
116 <EntityType Name="LogService" BaseType="LogService.LogService">
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]117 <Property Name="ServiceEnabled" Type="Edm.Boolean">
118 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]119 <Annotation Term="OData.Description" String="An indication of whether this service is enabled."/>
120 <Annotation Term="OData.LongDescription" String="This property shall indicate whether this service is enabled."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]121 </Property>
122 <Property Name="MaxNumberOfRecords" Type="Edm.Int64" Nullable="false">
123 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]124 <Annotation Term="OData.Description" String="The maximum number of log entries that this service can have."/>
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]125 <Annotation Term="OData.LongDescription" String="This property shall contain the maximum number of LogEntry resources in the LogEntryCollection resource for this service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]126 <Annotation Term="Validation.Minimum" Int="0"/>
127 </Property>
128 <Property Name="OverWritePolicy" Type="LogService.v1_0_0.OverWritePolicy" Nullable="false">
129 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
130 <Annotation Term="OData.Description" String="The overwrite policy for this service that takes place when the log is full."/>
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]131 <Annotation Term="OData.LongDescription" String="This property shall indicate the policy of the log service when the MaxNumberOfRecords has been reached."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]132 </Property>
133 <Property Name="DateTime" Type="Edm.DateTimeOffset">
134 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]135 <Annotation Term="OData.Description" String="The current date and time with UTC offset of the log service."/>
136 <Annotation Term="OData.LongDescription" String="This property shall contain the current date and time with UTC offset of the log service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]137 </Property>
138 <Property Name="DateTimeLocalOffset" Type="Edm.String">
139 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]140 <Annotation Term="OData.Description" String="The time offset from UTC that the DateTime property is in `+HH:MM` format."/>
141 <Annotation Term="OData.LongDescription" String="This property shall contain the offset from UTC time that the DateTime property contains. If both DateTime and DateTimeLocalOffset are provided in modification requests, services shall apply DateTimeLocalOffset after DateTime is applied."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]142 <Annotation Term="Validation.Pattern" String="^([-+][0-1][0-9]:[0-5][0-9])$"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]143 </Property>
144 <NavigationProperty Name="Entries" Type="LogEntryCollection.LogEntryCollection" ContainsTarget="true" Nullable="false">
145 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]146 <Annotation Term="OData.Description" String="The link to the log entry collection."/>
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]147 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type LogEntryCollection."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]148 <Annotation Term="OData.AutoExpandReferences"/>
149 </NavigationProperty>
150 <Property Name="Actions" Type="LogService.v1_0_0.Actions" Nullable="false">
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]151 <Annotation Term="OData.Description" String="The available actions for this resource."/>
152 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]153 </Property>
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]154 <Property Name="Status" Type="Resource.Status" Nullable="false">
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]155 <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
156 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]157 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]158 </EntityType>
159
160 <ComplexType Name="Actions">
161 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]162 <Annotation Term="OData.Description" String="The available actions for this resource."/>
163 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]164 <Property Name="Oem" Type="LogService.v1_0_0.OemActions" Nullable="false">
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]165 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
166 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]167 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]168 </ComplexType>
169
170 <ComplexType Name="OemActions">
171 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]172 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
173 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]174 </ComplexType>
175
176 <EnumType Name="OverWritePolicy">
177 <Member Name="Unknown">
178 <Annotation Term="OData.Description" String="The overwrite policy is not known or is undefined."/>
179 </Member>
180 <Member Name="WrapsWhenFull">
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]181 <Annotation Term="OData.Description" String="When full, new entries to the log overwrite earlier entries."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]182 </Member>
183 <Member Name="NeverOverWrites">
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]184 <Annotation Term="OData.Description" String="When full, new entries to the log are discarded."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]185 </Member>
186 </EnumType>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]187 </Schema>
188
189 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_2">
190 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
191 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
192 <EntityType Name="LogService" BaseType="LogService.v1_0_0.LogService"/>
193 </Schema>
194
195 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_3">
196 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
197 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
198 <EntityType Name="LogService" BaseType="LogService.v1_0_2.LogService"/>
199 </Schema>
200
201 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_4">
202 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
203 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
204 <EntityType Name="LogService" BaseType="LogService.v1_0_3.LogService"/>
205 </Schema>
206
207 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_5">
208 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]209 <Annotation Term="OData.Description" String="This version was created to correct the short and long descriptions in the defined actions."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]210 <EntityType Name="LogService" BaseType="LogService.v1_0_4.LogService"/>
211 </Schema>
212
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]213 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_6">
214 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
215 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/>
216 <EntityType Name="LogService" BaseType="LogService.v1_0_5.LogService"/>
217 </Schema>
218
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]219 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_7">
220 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
221 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/>
222 <EntityType Name="LogService" BaseType="LogService.v1_0_6.LogService"/>
223 </Schema>
224
225 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_8">
226 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
227 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
228 <EntityType Name="LogService" BaseType="LogService.v1_0_7.LogService"/>
229 </Schema>
230
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]231 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_9">
232 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
233 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
234 <EntityType Name="LogService" BaseType="LogService.v1_0_8.LogService"/>
235 </Schema>
236
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]237 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_0">
238 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600[diff] [blame]239 <Annotation Term="Redfish.Release" String="2017.3"/>
Gunnar Mills262d7d42021-01-20 16:28:41 -0600[diff] [blame]240 <Annotation Term="OData.Description" String="This version was created to add LogEntryType property."/>
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]241
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]242 <EntityType Name="LogService" BaseType="LogService.v1_0_5.LogService">
243 <Property Name="LogEntryType" Type="LogService.v1_1_0.LogEntryTypes">
244 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]245 <Annotation Term="OData.Description" String="The format of the log entries."/>
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]246 <Annotation Term="OData.LongDescription" String="This property shall contain the value for the EntryType property of all LogEntry resources contained in the LogEntryCollection resource for this log service. If the service cannot determine or guarantee a single EntryType value for all LogEntry resources, this property shall contain the value `Multiple`."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]247 </Property>
248 </EntityType>
249
250 <EnumType Name="LogEntryTypes">
251 <Member Name="Event">
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]252 <Annotation Term="OData.Description" String="The log contains Redfish-defined messages."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]253 </Member>
254 <Member Name="SEL">
255 <Annotation Term="OData.Description" String="The log contains legacy IPMI System Event Log (SEL) entries."/>
256 </Member>
257 <Member Name="Multiple">
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]258 <Annotation Term="OData.Description" String="The log contains multiple log entry types and, therefore, the log service cannot guarantee a single entry type."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]259 </Member>
260 <Member Name="OEM">
261 <Annotation Term="OData.Description" String="The log contains entries in an OEM-defined format."/>
262 </Member>
Ed Tanouse9cc1bc2023-09-21 11:15:30 -0700[diff] [blame^]263 <Member Name="CXL">
264 <Annotation Term="OData.Description" String="The log contains CXL log entries."/>
265 <Annotation Term="Redfish.Revisions">
266 <Collection>
267 <Record>
268 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
269 <PropertyValue Property="Version" String="v1_5_0"/>
270 </Record>
271 </Collection>
272 </Annotation>
273 </Member>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]274 </EnumType>
275 </Schema>
276
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame]277 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_1">
278 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
279 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/>
280 <EntityType Name="LogService" BaseType="LogService.v1_1_0.LogService"/>
281 </Schema>
282
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]283 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_2">
284 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
285 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/>
286 <EntityType Name="LogService" BaseType="LogService.v1_1_1.LogService"/>
287 </Schema>
288
289 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_3">
290 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
291 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
292 <EntityType Name="LogService" BaseType="LogService.v1_1_2.LogService"/>
293 </Schema>
294
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]295 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_4">
296 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
297 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
298 <EntityType Name="LogService" BaseType="LogService.v1_1_3.LogService"/>
299 </Schema>
300
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]301 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_2_0">
302 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
303 <Annotation Term="Redfish.Release" String="2020.3"/>
304 <Annotation Term="OData.Description" String="This version was created to add local syslog support and the CollectDiagnosticData action."/>
305
306 <EntityType Name="LogService" BaseType="LogService.v1_1_3.LogService">
307 <Property Name="SyslogFilters" Type="Collection(LogService.v1_2_0.SyslogFilter)">
308 <Annotation Term="OData.Description" String="A list of syslog message filters to be logged locally."/>
309 <Annotation Term="OData.LongDescription" String="This property shall describe all desired syslog messages to be logged locally. If this property contains an empty array, all messages shall be logged."/>
310 </Property>
311 </EntityType>
312
313 <ComplexType Name="SyslogFilter">
314 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
315 <Annotation Term="OData.Description" String="A syslog filter."/>
316 <Annotation Term="OData.LongDescription" String="This type shall contain the filter for a syslog message. The filter shall describe the desired syslog message to be enabled locally."/>
317 <Property Name="LowestSeverity" Type="LogService.v1_2_0.SyslogSeverity">
318 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
319 <Annotation Term="OData.Description" String="The lowest severity level message that will be logged."/>
320 <Annotation Term="OData.LongDescription" String="This property shall contain the lowest syslog severity level that will be logged. The service shall log all messages equal to or greater than the value in this property. The value `All` shall indicate all severities."/>
321 </Property>
322 <Property Name="LogFacilities" Type="Collection(LogService.v1_2_0.SyslogFacility)">
323 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
324 <Annotation Term="OData.Description" String="The types of programs that can log messages."/>
325 <Annotation Term="OData.LongDescription" String="This property shall contain the types of programs that can log messages. If this property contains an empty array or is absent, all facilities shall be indicated."/>
326 </Property>
327 </ComplexType>
328
329 <EnumType Name="SyslogSeverity">
330 <Annotation Term="OData.Description" String="The syslog severity is an application-specific rating used to describe the urgency of the message."/>
331 <Annotation Term="OData.LongDescription" String="This type shall specify the syslog severity levels as an application-specific rating used to describe the urgency of the message. `Emergency` should be reserved for messages indicating the system is unusable and `Debug` should only be used when debugging a program. Severity values are described in RFC5424."/>
332 <Member Name="Emergency">
333 <Annotation Term="OData.Description" String="A panic condition."/>
334 </Member>
335 <Member Name="Alert">
336 <Annotation Term="OData.Description" String="A condition that should be corrected immediately, such as a corrupted system database."/>
337 </Member>
338 <Member Name="Critical">
339 <Annotation Term="OData.Description" String="Hard device errors."/>
340 </Member>
341 <Member Name="Error">
342 <Annotation Term="OData.Description" String="An Error."/>
343 </Member>
344 <Member Name="Warning">
345 <Annotation Term="OData.Description" String="A Warning."/>
346 </Member>
347 <Member Name="Notice">
Ed Tanouse9cc1bc2023-09-21 11:15:30 -0700[diff] [blame^]348 <Annotation Term="OData.Description" String="Conditions that are not error conditions, but that might require special handling."/>
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]349 </Member>
350 <Member Name="Informational">
351 <Annotation Term="OData.Description" String="Informational only."/>
352 </Member>
353 <Member Name="Debug">
354 <Annotation Term="OData.Description" String="Messages that contain information normally of use only when debugging a program."/>
355 </Member>
356 <Member Name="All">
357 <Annotation Term="OData.Description" String="A message of any severity."/>
358 </Member>
359 </EnumType>
360
361 <EnumType Name="SyslogFacility">
362 <Annotation Term="OData.Description" String="The syslog facility code is an enumeration of program types."/>
363 <Annotation Term="OData.LongDescription" String="This type shall specify the syslog facility codes as program types. Facility values are described in the RFC5424."/>
364 <Member Name="Kern">
365 <Annotation Term="OData.Description" String="Kernel messages."/>
366 </Member>
367 <Member Name="User">
368 <Annotation Term="OData.Description" String="User-level messages."/>
369 </Member>
370 <Member Name="Mail">
371 <Annotation Term="OData.Description" String="Mail system."/>
372 </Member>
373 <Member Name="Daemon">
374 <Annotation Term="OData.Description" String="System daemons."/>
375 </Member>
376 <Member Name="Auth">
377 <Annotation Term="OData.Description" String="Security/authentication messages."/>
378 </Member>
379 <Member Name="Syslog">
380 <Annotation Term="OData.Description" String="Messages generated internally by syslogd."/>
381 </Member>
382 <Member Name="LPR">
383 <Annotation Term="OData.Description" String="Line printer subsystem."/>
384 </Member>
385 <Member Name="News">
386 <Annotation Term="OData.Description" String="Network news subsystem."/>
387 </Member>
388 <Member Name="UUCP">
389 <Annotation Term="OData.Description" String="UUCP subsystem."/>
390 </Member>
391 <Member Name="Cron">
392 <Annotation Term="OData.Description" String="Clock daemon."/>
393 </Member>
394 <Member Name="Authpriv">
395 <Annotation Term="OData.Description" String="Security/authentication messages."/>
396 </Member>
397 <Member Name="FTP">
398 <Annotation Term="OData.Description" String="FTP daemon."/>
399 </Member>
400 <Member Name="NTP">
401 <Annotation Term="OData.Description" String="NTP subsystem."/>
402 </Member>
403 <Member Name="Security">
404 <Annotation Term="OData.Description" String="Log audit."/>
405 </Member>
406 <Member Name="Console">
407 <Annotation Term="OData.Description" String="Log alert."/>
408 </Member>
409 <Member Name="SolarisCron">
410 <Annotation Term="OData.Description" String="Scheduling daemon."/>
411 </Member>
412 <Member Name="Local0">
413 <Annotation Term="OData.Description" String="Locally used facility 0."/>
414 </Member>
415 <Member Name="Local1">
416 <Annotation Term="OData.Description" String="Locally used facility 1."/>
417 </Member>
418 <Member Name="Local2">
419 <Annotation Term="OData.Description" String="Locally used facility 2."/>
420 </Member>
421 <Member Name="Local3">
422 <Annotation Term="OData.Description" String="Locally used facility 3."/>
423 </Member>
424 <Member Name="Local4">
425 <Annotation Term="OData.Description" String="Locally used facility 4."/>
426 </Member>
427 <Member Name="Local5">
428 <Annotation Term="OData.Description" String="Locally used facility 5."/>
429 </Member>
430 <Member Name="Local6">
431 <Annotation Term="OData.Description" String="Locally used facility 6."/>
432 </Member>
433 <Member Name="Local7">
434 <Annotation Term="OData.Description" String="Locally used facility 7."/>
435 </Member>
436 </EnumType>
437
438 <EnumType Name="LogDiagnosticDataTypes">
439 <Member Name="Manager">
440 <Annotation Term="OData.Description" String="Manager diagnostic data."/>
441 </Member>
442 <Member Name="PreOS">
443 <Annotation Term="OData.Description" String="Pre-OS diagnostic data."/>
444 </Member>
445 <Member Name="OS">
446 <Annotation Term="OData.Description" String="Operating system (OS) diagnostic data."/>
447 </Member>
448 <Member Name="OEM">
449 <Annotation Term="OData.Description" String="OEM diagnostic data."/>
450 </Member>
451 </EnumType>
452 </Schema>
453
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]454 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_2_1">
455 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
456 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
457 <EntityType Name="LogService" BaseType="LogService.v1_2_0.LogService"/>
458 </Schema>
459
Ed Tanoused761212022-09-23 15:03:29 -0700[diff] [blame]460 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_2_2">
461 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
462 <Annotation Term="OData.Description" String="This version was created to add behavioral descriptions to the CollectDiagnosticData action."/>
463 <EntityType Name="LogService" BaseType="LogService.v1_2_1.LogService"/>
464 </Schema>
465
Ed Tanouse9cc1bc2023-09-21 11:15:30 -0700[diff] [blame^]466 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_2_3">
467 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
468 <Annotation Term="OData.Description" String="This version was created to remove normative language from non-normative descriptions."/>
469 <EntityType Name="LogService" BaseType="LogService.v1_2_2.LogService"/>
470 </Schema>
471
Gunnar Mills9d424662021-09-22 21:56:16 -0500[diff] [blame]472 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_3_0">
473 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
474 <Annotation Term="Redfish.Release" String="2021.2"/>
475 <Annotation Term="OData.Description" String="This version was created to add the LogEntriesETag parameter to the ClearLog action."/>
476
477 <EntityType Name="LogService" BaseType="LogService.v1_2_1.LogService">
478 <Property Name="AutoDSTEnabled" Type="Edm.Boolean" Nullable="false">
479 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
480 <Annotation Term="OData.Description" String="An indication of whether the log service is configured for automatic Daylight Saving Time (DST) adjustment."/>
481 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the log service is configured for automatic Daylight Saving Time (DST) adjustment. DST adjustment shall not modify the timestamp of existing log entries."/>
482 </Property>
483 </EntityType>
484 </Schema>
485
Ed Tanoused761212022-09-23 15:03:29 -0700[diff] [blame]486 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_3_1">
487 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
488 <Annotation Term="OData.Description" String="This version was created to add behavioral descriptions to the CollectDiagnosticData action."/>
489 <EntityType Name="LogService" BaseType="LogService.v1_3_0.LogService"/>
490 </Schema>
491
Ed Tanouse9cc1bc2023-09-21 11:15:30 -0700[diff] [blame^]492 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_3_2">
493 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
494 <Annotation Term="OData.Description" String="This version was created to remove normative language from non-normative descriptions."/>
495 <EntityType Name="LogService" BaseType="LogService.v1_3_1.LogService"/>
496 </Schema>
497
Ed Tanousa8d8f9d2023-01-26 13:57:00 -0800[diff] [blame]498 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_4_0">
499 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
500 <Annotation Term="Redfish.Release" String="2022.3"/>
501
502 <EntityType Name="LogService" BaseType="LogService.v1_3_1.LogService">
503 <Property Name="LogPurposes" Type="Collection(LogService.v1_4_0.LogPurpose)">
504 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
505 <Annotation Term="OData.Description" String="The purposes of the log."/>
506 <Annotation Term="OData.LongDescription" String="This property shall contain the purposes of the log."/>
507 </Property>
508 <Property Name="OEMLogPurpose" Type="Edm.String">
509 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
510 <Annotation Term="OData.Description" String="The OEM-specified purpose of the log if LogPurposes contains `OEM`."/>
511 <Annotation Term="OData.LongDescription" String="This property shall contain the OEM-specified purpose of the log if LogPurposes contains `OEM`."/>
512 </Property>
513 <Property Name="Persistency" Type="Edm.Boolean" Nullable="false">
514 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
515 <Annotation Term="OData.Description" String="Indicates whether the log service is persistent across a cold reset."/>
516 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the log service is persistent across a cold reset of the device."/>
517 </Property>
518 <Property Name="Overflow" Type="Edm.Boolean" Nullable="false">
519 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
520 <Annotation Term="OData.Description" String="Indicates whether the log service has overflowed."/>
521 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the log service has overflowed and is no longer able to store new logs."/>
522 </Property>
523 </EntityType>
524
525 <EnumType Name="LogPurpose">
526 <Member Name="Diagnostic">
527 <Annotation Term="OData.Description" String="The log provides information for diagnosing hardware or software issues, such as error conditions, sensor threshold trips, or exception cases."/>
528 </Member>
529 <Member Name="Operations">
530 <Annotation Term="OData.Description" String="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."/>
531 </Member>
532 <Member Name="Security">
533 <Annotation Term="OData.Description" String="The log provides security-related information such as authentication, authorization, and data access logging required for security audits."/>
534 </Member>
535 <Member Name="Telemetry">
536 <Annotation Term="OData.Description" String="The log provides telemetry history, typically collected on a regular basis."/>
537 </Member>
538 <Member Name="ExternalEntity">
539 <Annotation Term="OData.Description" String="The log exposes log entries provided by external entities, such as external users, system firmware, operating systems, or management applications."/>
540 </Member>
541 <Member Name="OEM">
542 <Annotation Term="OData.Description" String="The log is used for an OEM-defined purpose."/>
543 </Member>
544 </EnumType>
545 </Schema>
546
Ed Tanouse9cc1bc2023-09-21 11:15:30 -0700[diff] [blame^]547 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_4_1">
548 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
549 <Annotation Term="OData.Description" String="This version was created to remove normative language from non-normative descriptions."/>
550 <EntityType Name="LogService" BaseType="LogService.v1_4_0.LogService"/>
551 </Schema>
552
553 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_5_0">
554 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
555 <Annotation Term="Redfish.Release" String="2023.2"/>
556 <Annotation Term="OData.Description" String="This version was created to add `CXL` to LogEntryType."/>
557
558 <EntityType Name="LogService" BaseType="LogService.v1_4_0.LogService"/>
559 </Schema>
560
561 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_5_1">
562 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
563 <Annotation Term="OData.Description" String="This version was created to remove normative language from non-normative descriptions."/>
564 <EntityType Name="LogService" BaseType="LogService.v1_5_0.LogService"/>
565 </Schema>
566
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame]567 </edmx:DataServices>
568</edmx:Edmx>