blob: 0eca03facec18b7deaffe40914d04af1986dbe66 [file] [log] [blame]
Jason M. Billsea4aa752018-06-05 13:29:11 -07001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Ed Tanouscb103132019-10-08 11:34:22 -07004<!--# Redfish Schema: LogService v1.1.3 -->
Jason M. Billsea4aa752018-06-05 13:29:11 -07005<!--# -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
7<!--# available at http://www.dmtf.org/standards/redfish -->
Gunnar Millsa778c022020-05-12 12:20:36 -05008<!--# Copyright 2014-2020 DMTF. -->
Jason M. Billsea4aa752018-06-05 13:29:11 -07009<!--# 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">
Ed Tanouscb103132019-10-08 11:34:22 -070038 <Annotation Term="OData.Description" String="The LogService schema contains properties for monitoring and configuring a Log Service."/>
39 <Annotation Term="OData.LongDescription" String="This Resource shall represent a Log Service for a Redfish implementation."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070040 <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"/>
Ed Tanouscb103132019-10-08 11:34:22 -070048 <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 -070049 </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 -080056 <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 -060061 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/{LogServiceId}</String>
Gunnar Mills09b9d452020-02-11 13:27:39 -060062 <String>/redfish/v1/Chassis/{ChassisId}/LogServices/{LogServiceId}</String>
Ed Tanouscb103132019-10-08 11:34:22 -070063 <String>/redfish/v1/JobService/Log</String>
64 <String>/redfish/v1/TelemetryService/LogService</String>
Ed Tanous530520e2019-01-02 13:41:37 -080065 </Collection>
66 </Annotation>
Jason M. Billsea4aa752018-06-05 13:29:11 -070067 </EntityType>
68
69 <Action Name="ClearLog" IsBound="true">
70 <Parameter Name="LogService" Type="LogService.v1_0_0.Actions"/>
Ed Tanouscb103132019-10-08 11:34:22 -070071 <Annotation Term="OData.Description" String="The action to clear the log for this Log Service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070072 <Annotation Term="OData.LongDescription" String="This action shall delete all entries found in the Entries collection for this Log Service."/>
73 </Action>
74
75 </Schema>
76
77 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_0">
78 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060079 <Annotation Term="Redfish.Release" String="1.0"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070080
81 <EntityType Name="LogService" BaseType="LogService.LogService">
Jason M. Billsea4aa752018-06-05 13:29:11 -070082 <Property Name="ServiceEnabled" Type="Edm.Boolean">
83 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -070084 <Annotation Term="OData.Description" String="An indication of whether this service is enabled."/>
85 <Annotation Term="OData.LongDescription" String="This property shall indicate whether this service is enabled."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070086 </Property>
87 <Property Name="MaxNumberOfRecords" Type="Edm.Int64" Nullable="false">
88 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -070089 <Annotation Term="OData.Description" String="The maximum number of log entries that this service can have."/>
90 <Annotation Term="OData.LongDescription" String="This property shall contain the maximum number of LogEntry Resources in the Entries collection for this service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070091 <Annotation Term="Validation.Minimum" Int="0"/>
92 </Property>
93 <Property Name="OverWritePolicy" Type="LogService.v1_0_0.OverWritePolicy" Nullable="false">
94 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
95 <Annotation Term="OData.Description" String="The overwrite policy for this service that takes place when the log is full."/>
Ed Tanouscb103132019-10-08 11:34:22 -070096 <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 -070097 </Property>
98 <Property Name="DateTime" Type="Edm.DateTimeOffset">
99 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700100 <Annotation Term="OData.Description" String="The current date and time, with UTC offset, that the Log Service uses to set or read time."/>
101 <Annotation Term="OData.LongDescription" String="This property shall represent the current DateTime value, with UTC offset, in Redfish Timestamp format that the Log Service uses to set or read time."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700102 </Property>
103 <Property Name="DateTimeLocalOffset" Type="Edm.String">
104 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700105 <Annotation Term="OData.Description" String="The UTC offset that the current DateTime property value contains in the `+HH:MM` format."/>
106 <Annotation Term="OData.LongDescription" String="This property shall represent the UTC offset that the current DateTime property value contains."/>
107 <Annotation Term="Validation.Pattern" String="^([-+][0-1][0-9]:[0-5][0-9])$"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700108 </Property>
109 <NavigationProperty Name="Entries" Type="LogEntryCollection.LogEntryCollection" ContainsTarget="true" Nullable="false">
110 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700111 <Annotation Term="OData.Description" String="The link to the log entry collection."/>
112 <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 -0700113 <Annotation Term="OData.AutoExpandReferences"/>
114 </NavigationProperty>
115 <Property Name="Actions" Type="LogService.v1_0_0.Actions" Nullable="false">
Ed Tanouscb103132019-10-08 11:34:22 -0700116 <Annotation Term="OData.Description" String="The available actions for this Resource."/>
117 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this Resource."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700118 </Property>
Ed Tanous530520e2019-01-02 13:41:37 -0800119 <Property Name="Status" Type="Resource.Status" Nullable="false">
Ed Tanouscb103132019-10-08 11:34:22 -0700120 <Annotation Term="OData.Description" String="The status and health of the Resource and its subordinate or dependent Resources."/>
121 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the Resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800122 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700123 </EntityType>
124
125 <ComplexType Name="Actions">
126 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700127 <Annotation Term="OData.Description" String="The available actions for this Resource."/>
128 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this Resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800129 <Property Name="Oem" Type="LogService.v1_0_0.OemActions" Nullable="false">
Ed Tanouscb103132019-10-08 11:34:22 -0700130 <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/>
131 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this Resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800132 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700133 </ComplexType>
134
135 <ComplexType Name="OemActions">
136 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700137 <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/>
138 <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 -0700139 </ComplexType>
140
141 <EnumType Name="OverWritePolicy">
142 <Member Name="Unknown">
143 <Annotation Term="OData.Description" String="The overwrite policy is not known or is undefined."/>
144 </Member>
145 <Member Name="WrapsWhenFull">
Ed Tanouscb103132019-10-08 11:34:22 -0700146 <Annotation Term="OData.Description" String="When full, new entries to the log overwrite earlier entries."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700147 </Member>
148 <Member Name="NeverOverWrites">
Ed Tanouscb103132019-10-08 11:34:22 -0700149 <Annotation Term="OData.Description" String="When full, new entries to the log are discarded."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700150 </Member>
151 </EnumType>
152
153 </Schema>
154
155 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_2">
156 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
157 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
158 <EntityType Name="LogService" BaseType="LogService.v1_0_0.LogService"/>
159 </Schema>
160
161 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_3">
162 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
163 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
164 <EntityType Name="LogService" BaseType="LogService.v1_0_2.LogService"/>
165 </Schema>
166
167 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_4">
168 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
169 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
170 <EntityType Name="LogService" BaseType="LogService.v1_0_3.LogService"/>
171 </Schema>
172
173 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_5">
174 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700175 <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 -0700176 <EntityType Name="LogService" BaseType="LogService.v1_0_4.LogService"/>
177 </Schema>
178
Ed Tanous530520e2019-01-02 13:41:37 -0800179 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_6">
180 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
181 <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."/>
182 <EntityType Name="LogService" BaseType="LogService.v1_0_5.LogService"/>
183 </Schema>
184
Ed Tanouscb103132019-10-08 11:34:22 -0700185 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_7">
186 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
187 <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."/>
188 <EntityType Name="LogService" BaseType="LogService.v1_0_6.LogService"/>
189 </Schema>
190
191 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_8">
192 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
193 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
194 <EntityType Name="LogService" BaseType="LogService.v1_0_7.LogService"/>
195 </Schema>
196
Jason M. Billsea4aa752018-06-05 13:29:11 -0700197 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_0">
198 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600199 <Annotation Term="Redfish.Release" String="2017.3"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700200 <Annotation Term="OData.Description" String="This version was created to add LogPurpose and EntryType properties."/>
201 <EntityType Name="LogService" BaseType="LogService.v1_0_5.LogService">
202 <Property Name="LogEntryType" Type="LogService.v1_1_0.LogEntryTypes">
203 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700204 <Annotation Term="OData.Description" String="The format of the log entries."/>
205 <Annotation Term="OData.LongDescription" String="This property shall represent the EntryType of all LogEntry Resources contained in the Entries collection. If the service cannot determine or guarantee a single EntryType for all LogEntry Resources, this property's value shall be `Multiple`."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700206 </Property>
207 </EntityType>
208
209 <EnumType Name="LogEntryTypes">
210 <Member Name="Event">
Ed Tanouscb103132019-10-08 11:34:22 -0700211 <Annotation Term="OData.Description" String="The log contains Redfish-defined messages."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700212 </Member>
213 <Member Name="SEL">
214 <Annotation Term="OData.Description" String="The log contains legacy IPMI System Event Log (SEL) entries."/>
215 </Member>
216 <Member Name="Multiple">
Ed Tanouscb103132019-10-08 11:34:22 -0700217 <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 -0700218 </Member>
219 <Member Name="OEM">
220 <Annotation Term="OData.Description" String="The log contains entries in an OEM-defined format."/>
221 </Member>
222 </EnumType>
223 </Schema>
224
Ed Tanous530520e2019-01-02 13:41:37 -0800225 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_1">
226 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
227 <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."/>
228 <EntityType Name="LogService" BaseType="LogService.v1_1_0.LogService"/>
229 </Schema>
230
Ed Tanouscb103132019-10-08 11:34:22 -0700231 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_2">
232 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
233 <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."/>
234 <EntityType Name="LogService" BaseType="LogService.v1_1_1.LogService"/>
235 </Schema>
236
237 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_3">
238 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
239 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
240 <EntityType Name="LogService" BaseType="LogService.v1_1_2.LogService"/>
241 </Schema>
242
Jason M. Billsea4aa752018-06-05 13:29:11 -0700243 </edmx:DataServices>
244</edmx:Edmx>