blob: 788d997f00785aa38baf1269b938af456e813419 [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 -->
Ed Tanouscb103132019-10-08 11:34:22 -07008<!--# Copyright 2014-2019 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>
Ed Tanouscb103132019-10-08 11:34:22 -070062 <String>/redfish/v1/JobService/Log</String>
63 <String>/redfish/v1/TelemetryService/LogService</String>
Ed Tanous530520e2019-01-02 13:41:37 -080064 </Collection>
65 </Annotation>
Jason M. Billsea4aa752018-06-05 13:29:11 -070066 </EntityType>
67
68 <Action Name="ClearLog" IsBound="true">
69 <Parameter Name="LogService" Type="LogService.v1_0_0.Actions"/>
Ed Tanouscb103132019-10-08 11:34:22 -070070 <Annotation Term="OData.Description" String="The action to clear the log for this Log Service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070071 <Annotation Term="OData.LongDescription" String="This action shall delete all entries found in the Entries collection for this Log Service."/>
72 </Action>
73
74 </Schema>
75
76 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_0">
77 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060078 <Annotation Term="Redfish.Release" String="1.0"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070079
80 <EntityType Name="LogService" BaseType="LogService.LogService">
Jason M. Billsea4aa752018-06-05 13:29:11 -070081 <Property Name="ServiceEnabled" Type="Edm.Boolean">
82 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -070083 <Annotation Term="OData.Description" String="An indication of whether this service is enabled."/>
84 <Annotation Term="OData.LongDescription" String="This property shall indicate whether this service is enabled."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070085 </Property>
86 <Property Name="MaxNumberOfRecords" Type="Edm.Int64" Nullable="false">
87 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -070088 <Annotation Term="OData.Description" String="The maximum number of log entries that this service can have."/>
89 <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 -070090 <Annotation Term="Validation.Minimum" Int="0"/>
91 </Property>
92 <Property Name="OverWritePolicy" Type="LogService.v1_0_0.OverWritePolicy" Nullable="false">
93 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
94 <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 -070095 <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 -070096 </Property>
97 <Property Name="DateTime" Type="Edm.DateTimeOffset">
98 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -070099 <Annotation Term="OData.Description" String="The current date and time, with UTC offset, that the Log Service uses to set or read time."/>
100 <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 -0700101 </Property>
102 <Property Name="DateTimeLocalOffset" Type="Edm.String">
103 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700104 <Annotation Term="OData.Description" String="The UTC offset that the current DateTime property value contains in the `+HH:MM` format."/>
105 <Annotation Term="OData.LongDescription" String="This property shall represent the UTC offset that the current DateTime property value contains."/>
106 <Annotation Term="Validation.Pattern" String="^([-+][0-1][0-9]:[0-5][0-9])$"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700107 </Property>
108 <NavigationProperty Name="Entries" Type="LogEntryCollection.LogEntryCollection" ContainsTarget="true" Nullable="false">
109 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700110 <Annotation Term="OData.Description" String="The link to the log entry collection."/>
111 <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 -0700112 <Annotation Term="OData.AutoExpandReferences"/>
113 </NavigationProperty>
114 <Property Name="Actions" Type="LogService.v1_0_0.Actions" Nullable="false">
Ed Tanouscb103132019-10-08 11:34:22 -0700115 <Annotation Term="OData.Description" String="The available actions for this Resource."/>
116 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this Resource."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700117 </Property>
Ed Tanous530520e2019-01-02 13:41:37 -0800118 <Property Name="Status" Type="Resource.Status" Nullable="false">
Ed Tanouscb103132019-10-08 11:34:22 -0700119 <Annotation Term="OData.Description" String="The status and health of the Resource and its subordinate or dependent Resources."/>
120 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the Resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800121 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700122 </EntityType>
123
124 <ComplexType Name="Actions">
125 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700126 <Annotation Term="OData.Description" String="The available actions for this Resource."/>
127 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this Resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800128 <Property Name="Oem" Type="LogService.v1_0_0.OemActions" Nullable="false">
Ed Tanouscb103132019-10-08 11:34:22 -0700129 <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/>
130 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this Resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800131 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700132 </ComplexType>
133
134 <ComplexType Name="OemActions">
135 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700136 <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/>
137 <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 -0700138 </ComplexType>
139
140 <EnumType Name="OverWritePolicy">
141 <Member Name="Unknown">
142 <Annotation Term="OData.Description" String="The overwrite policy is not known or is undefined."/>
143 </Member>
144 <Member Name="WrapsWhenFull">
Ed Tanouscb103132019-10-08 11:34:22 -0700145 <Annotation Term="OData.Description" String="When full, new entries to the log overwrite earlier entries."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700146 </Member>
147 <Member Name="NeverOverWrites">
Ed Tanouscb103132019-10-08 11:34:22 -0700148 <Annotation Term="OData.Description" String="When full, new entries to the log are discarded."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700149 </Member>
150 </EnumType>
151
152 </Schema>
153
154 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_2">
155 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
156 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
157 <EntityType Name="LogService" BaseType="LogService.v1_0_0.LogService"/>
158 </Schema>
159
160 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_3">
161 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
162 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
163 <EntityType Name="LogService" BaseType="LogService.v1_0_2.LogService"/>
164 </Schema>
165
166 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_4">
167 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
168 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
169 <EntityType Name="LogService" BaseType="LogService.v1_0_3.LogService"/>
170 </Schema>
171
172 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_5">
173 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700174 <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 -0700175 <EntityType Name="LogService" BaseType="LogService.v1_0_4.LogService"/>
176 </Schema>
177
Ed Tanous530520e2019-01-02 13:41:37 -0800178 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_6">
179 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
180 <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."/>
181 <EntityType Name="LogService" BaseType="LogService.v1_0_5.LogService"/>
182 </Schema>
183
Ed Tanouscb103132019-10-08 11:34:22 -0700184 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_7">
185 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
186 <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."/>
187 <EntityType Name="LogService" BaseType="LogService.v1_0_6.LogService"/>
188 </Schema>
189
190 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_0_8">
191 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
192 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
193 <EntityType Name="LogService" BaseType="LogService.v1_0_7.LogService"/>
194 </Schema>
195
Jason M. Billsea4aa752018-06-05 13:29:11 -0700196 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_0">
197 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600198 <Annotation Term="Redfish.Release" String="2017.3"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700199 <Annotation Term="OData.Description" String="This version was created to add LogPurpose and EntryType properties."/>
200 <EntityType Name="LogService" BaseType="LogService.v1_0_5.LogService">
201 <Property Name="LogEntryType" Type="LogService.v1_1_0.LogEntryTypes">
202 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700203 <Annotation Term="OData.Description" String="The format of the log entries."/>
204 <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 -0700205 </Property>
206 </EntityType>
207
208 <EnumType Name="LogEntryTypes">
209 <Member Name="Event">
Ed Tanouscb103132019-10-08 11:34:22 -0700210 <Annotation Term="OData.Description" String="The log contains Redfish-defined messages."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700211 </Member>
212 <Member Name="SEL">
213 <Annotation Term="OData.Description" String="The log contains legacy IPMI System Event Log (SEL) entries."/>
214 </Member>
215 <Member Name="Multiple">
Ed Tanouscb103132019-10-08 11:34:22 -0700216 <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 -0700217 </Member>
218 <Member Name="OEM">
219 <Annotation Term="OData.Description" String="The log contains entries in an OEM-defined format."/>
220 </Member>
221 </EnumType>
222 </Schema>
223
Ed Tanous530520e2019-01-02 13:41:37 -0800224 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_1">
225 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
226 <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."/>
227 <EntityType Name="LogService" BaseType="LogService.v1_1_0.LogService"/>
228 </Schema>
229
Ed Tanouscb103132019-10-08 11:34:22 -0700230 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_2">
231 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
232 <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."/>
233 <EntityType Name="LogService" BaseType="LogService.v1_1_1.LogService"/>
234 </Schema>
235
236 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="LogService.v1_1_3">
237 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
238 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
239 <EntityType Name="LogService" BaseType="LogService.v1_1_2.LogService"/>
240 </Schema>
241
Jason M. Billsea4aa752018-06-05 13:29:11 -0700242 </edmx:DataServices>
243</edmx:Edmx>