summaryrefslogtreecommitdiff
path: root/static/redfish/v1/schema/SerialInterface_v1.xml
blob: 63d65f90a56520dddf741a7cbe421b692d0b41b4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
<?xml version="1.0" encoding="UTF-8"?>
<!---->
<!--################################################################################       -->
<!--# Redfish Schema:  SerialInterface  v1.1.3-->
<!--#                                                                                      -->
<!--# For a detailed change log, see the README file contained in the DSP8010 bundle,      -->
<!--# available at http://www.dmtf.org/standards/redfish                                   -->
<!--# Copyright 2014-2018 DMTF.                                                            -->
<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
<!--################################################################################       -->
<!---->
<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">

  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
    <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
    <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
    <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
  </edmx:Reference>
  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
    <edmx:Include Namespace="Resource.v1_0_0"/>
  </edmx:Reference>

  <edmx:DataServices>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>

      <EntityType Name="SerialInterface" BaseType="Resource.v1_0_0.Resource" Abstract="true">
        <Annotation Term="OData.Description" String="This resource describes an asynchronous serial interface, such as an RS-232 interface, available to a system or device."/>
        <Annotation Term="OData.LongDescription" String="This resource shall be used to represent serial resources as part of the Redfish specification."/>
        <Annotation Term="Capabilities.InsertRestrictions">
          <Record>
            <PropertyValue Property="Insertable" Bool="false"/>
          </Record>
        </Annotation>
        <Annotation Term="Capabilities.UpdateRestrictions">
          <Record>
            <PropertyValue Property="Updatable" Bool="true"/>
            <Annotation Term="OData.Description" String="A Serial Interface can be updated to enable or disable it or to change the configuration."/>
          </Record>
        </Annotation>
        <Annotation Term="Capabilities.DeleteRestrictions">
          <Record>
            <PropertyValue Property="Deletable" Bool="false"/>
          </Record>
        </Annotation>
        <Annotation Term="Redfish.Uris">
          <Collection>
            <String>/redfish/v1/Managers/{ManagerId}/SerialInterfaces/{SerialInterfaceId}</String>
          </Collection>
        </Annotation>
      </EntityType>

    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface.v1_0_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="1.0"/>

      <EntityType Name="SerialInterface" BaseType="SerialInterface.SerialInterface">
        <Annotation Term="OData.Description" String="This schema defines an asynchronous serial interface resource."/>
        <Annotation Term="OData.LongDescription" String="This resource shall be used to represent serial resources as part of the Redfish specification."/>
        <Property Name="InterfaceEnabled" Type="Edm.Boolean">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="This indicates whether this interface is enabled."/>
          <Annotation Term="OData.LongDescription" String="The value of this property shall be a boolean indicating whether this interface is enabled."/>
        </Property>
        <Property Name="SignalType" Type="SerialInterface.v1_0_0.SignalType" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The type of signal used for the communication connection - RS232 or RS485."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate the type of serial signalling that will be utilized for the serial connection."/>
        </Property>
        <Property Name="BitRate" Type="SerialInterface.v1_0_0.BitRate" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The receive and transmit rate of data flow, typically in bits-per-second (bps), over the serial connection."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate the transmit and receive speed of the serial connection."/>
        </Property>
        <Property Name="Parity" Type="SerialInterface.v1_0_0.Parity" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The type of parity used by the sender and receiver in order to detect errors over the serial connection."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate parity information for a serial connection."/>
        </Property>
        <Property Name="DataBits" Type="SerialInterface.v1_0_0.DataBits" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The number of data bits that will follow the start bit over the serial connection."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate number of data bits for the serial connection."/>
        </Property>
        <Property Name="StopBits" Type="SerialInterface.v1_0_0.StopBits" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The period of time before the next start bit is transmitted."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate the stop bits for the serial connection."/>
        </Property>
        <Property Name="FlowControl" Type="SerialInterface.v1_0_0.FlowControl" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
          <Annotation Term="OData.Description" String="The type of flow control, if any, that will be imposed on the serial connection."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate the flow control mechanism for the serial connection."/>
        </Property>
        <Property Name="ConnectorType" Type="SerialInterface.v1_0_0.ConnectorType" Nullable="false">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The type of connector used for this interface."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate the type of phyiscal connector used for this serial connection."/>
        </Property>
        <Property Name="PinOut" Type="SerialInterface.v1_0_0.PinOut">
          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
          <Annotation Term="OData.Description" String="The physical pin configuration needed for a serial connector."/>
          <Annotation Term="OData.LongDescription" String="This property shall indicate the physical pin out for the serial connection."/>
        </Property>
      </EntityType>

      <EnumType Name="SignalType">
        <Member Name="Rs232">
          <Annotation Term="OData.Description" String="The serial interface follows RS232."/>
        </Member>
        <Member Name="Rs485">
          <Annotation Term="OData.Description" String="The serial interface follows RS485."/>
        </Member>
      </EnumType>

      <TypeDefinition Name="BitRate" UnderlyingType="Edm.String">
        <Annotation Term="Redfish.Enumeration">
          <Collection>
            <Record>
              <PropertyValue Property="Member" String="1200"/>
              <Annotation Term="OData.Description" String="A bit rate of 1200bps."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="2400"/>
              <Annotation Term="OData.Description" String="A bit rate of 2400bps."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="4800"/>
              <Annotation Term="OData.Description" String="A bit rate of 4800bps."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="9600"/>
              <Annotation Term="OData.Description" String="A bit rate of 9600bps."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="19200"/>
              <Annotation Term="OData.Description" String="A bit rate of 19200bps."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="38400"/>
              <Annotation Term="OData.Description" String="A bit rate of 38400bps."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="57600"/>
              <Annotation Term="OData.Description" String="A bit rate of 57600bps."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="115200"/>
              <Annotation Term="OData.Description" String="A bit rate of 115200bps."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="230400"/>
              <Annotation Term="OData.Description" String="A bit rate of 230400bps."/>
            </Record>
          </Collection>
        </Annotation>
      </TypeDefinition>

      <EnumType Name="Parity">
        <Member Name="None">
          <Annotation Term="OData.Description" String="No parity bit."/>
        </Member>
        <Member Name="Even">
          <Annotation Term="OData.Description" String="An even parity bit."/>
        </Member>
        <Member Name="Odd">
          <Annotation Term="OData.Description" String="An odd parity bit."/>
        </Member>
        <Member Name="Mark">
          <Annotation Term="OData.Description" String="A mark parity bit."/>
        </Member>
        <Member Name="Space">
          <Annotation Term="OData.Description" String="A space parity bit."/>
        </Member>
      </EnumType>

      <TypeDefinition Name="DataBits" UnderlyingType="Edm.String">
        <Annotation Term="Redfish.Enumeration">
          <Collection>
            <Record>
              <PropertyValue Property="Member" String="5"/>
              <Annotation Term="OData.Description" String="5 bits of data following the start bit."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="6"/>
              <Annotation Term="OData.Description" String="6 bits of data following the start bit."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="7"/>
              <Annotation Term="OData.Description" String="7 bits of data following the start bit."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="8"/>
              <Annotation Term="OData.Description" String="8 bits of data following the start bit."/>
            </Record>
          </Collection>
        </Annotation>
      </TypeDefinition>

      <TypeDefinition Name="StopBits" UnderlyingType="Edm.String">
        <Annotation Term="Redfish.Enumeration">
          <Collection>
            <Record>
              <PropertyValue Property="Member" String="1"/>
              <Annotation Term="OData.Description" String="1 stop bit following the data bits."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="2"/>
              <Annotation Term="OData.Description" String="2 stop bits following the data bits."/>
            </Record>
          </Collection>
        </Annotation>
      </TypeDefinition>

      <EnumType Name="FlowControl">
        <Member Name="None">
          <Annotation Term="OData.Description" String="No flow control imposed."/>
        </Member>
        <Member Name="Software">
          <Annotation Term="OData.Description" String="XON/XOFF in-band flow control imposed."/>
        </Member>
        <Member Name="Hardware">
          <Annotation Term="OData.Description" String="Out of band flow control imposed."/>
        </Member>
      </EnumType>

      <EnumType Name="PinOut">
        <Member Name="Cisco">
          <Annotation Term="OData.Description" String="The Cisco pin configuration."/>
        </Member>
        <Member Name="Cyclades">
          <Annotation Term="OData.Description" String="The Cyclades pin configuration."/>
        </Member>
        <Member Name="Digi">
          <Annotation Term="OData.Description" String="The Digi pin configuration."/>
        </Member>
      </EnumType>

      <TypeDefinition Name="ConnectorType" UnderlyingType="Edm.String">
        <Annotation Term="Redfish.Enumeration">
          <Collection>
            <Record>
              <PropertyValue Property="Member" String="RJ45"/>
              <Annotation Term="OData.Description" String="An RJ45 connector."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="RJ11"/>
              <Annotation Term="OData.Description" String="An RJ11 connector."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="DB9 Female"/>
              <Annotation Term="OData.Description" String="A DB9 Female connector."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="DB9 Male"/>
              <Annotation Term="OData.Description" String="A DB9 Male connector."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="DB25 Female"/>
              <Annotation Term="OData.Description" String="A DB25 Female connector."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="DB25 Male"/>
              <Annotation Term="OData.Description" String="A DB25 Male connector."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="USB"/>
              <Annotation Term="OData.Description" String="A USB connector."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="mUSB"/>
              <Annotation Term="OData.Description" String="A mUSB connector."/>
            </Record>
            <Record>
              <PropertyValue Property="Member" String="uUSB"/>
              <Annotation Term="OData.Description" String="A uUSB connector."/>
            </Record>
          </Collection>
        </Annotation>
      </TypeDefinition>

    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface.v1_0_2">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
      <EntityType Name="SerialInterface" BaseType="SerialInterface.v1_0_0.SerialInterface"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface.v1_0_3">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
      <EntityType Name="SerialInterface" BaseType="SerialInterface.v1_0_2.SerialInterface"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface.v1_0_4">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to correct the ConnectorType enum values to match orginal publication."/>
      <EntityType Name="SerialInterface" BaseType="SerialInterface.v1_0_3.SerialInterface"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface.v1_0_5">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to add descriptions to various enum values."/>
      <EntityType Name="SerialInterface" BaseType="SerialInterface.v1_0_4.SerialInterface"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface.v1_0_6">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <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."/>
      <EntityType Name="SerialInterface" BaseType="SerialInterface.v1_0_5.SerialInterface"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface.v1_1_0">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="Redfish.Release" String="2017.1"/>
      <EntityType Name="SerialInterface" BaseType="SerialInterface.v1_0_3.SerialInterface">
        <Property Name="Actions" Type="SerialInterface.v1_1_0.Actions" Nullable="false">
          <Annotation Term="OData.Description" String="The available actions for this resource."/>
          <Annotation Term="OData.LongDescription" String="The Actions property shall contain the available actions for this resource."/>
        </Property>
      </EntityType>

      <ComplexType Name="Actions">
        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
        <Annotation Term="OData.Description" String="The available actions for this resource."/>
        <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
        <Property Name="Oem" Type="SerialInterface.v1_1_0.OemActions" Nullable="false">
          <Annotation Term="OData.Description" String="This property contains the available OEM specific actions for this resource."/>
          <Annotation Term="OData.LongDescription" String="This property shall contain any additional OEM actions for this resource."/>
        </Property>
      </ComplexType>

      <ComplexType Name="OemActions">
        <Annotation Term="OData.AdditionalProperties" Bool="true"/>
        <Annotation Term="OData.Description" String="The available OEM specific actions for this resource."/>
        <Annotation Term="OData.LongDescription" String="This type shall contain any additional OEM actions for this resource."/>
      </ComplexType>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface.v1_1_1">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to correct the ConnectorType enum values to match orginal publication."/>
      <EntityType Name="SerialInterface" BaseType="SerialInterface.v1_1_0.SerialInterface"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface.v1_1_2">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <Annotation Term="OData.Description" String="This version was created to add descriptions to various enum values."/>
      <EntityType Name="SerialInterface" BaseType="SerialInterface.v1_1_1.SerialInterface"/>
    </Schema>

    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface.v1_1_3">
      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
      <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."/>
      <EntityType Name="SerialInterface" BaseType="SerialInterface.v1_1_2.SerialInterface"/>
    </Schema>

  </edmx:DataServices>
</edmx:Edmx>