blob: b42b164873ab604cbe9233ef7a9caef2eed05f3d [file] [log] [blame]
Ed Tanous710adfc2017-10-24 17:04:52 -07001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
4<!--# Redfish Schema: Endpoint v1.0.1-->
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 -->
8<!--# Copyright 2014-2016 Distributed Management Task Force, Inc. (DMTF). -->
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.Measures.V1.xml">
18 <edmx:Include Namespace="Org.OData.Measures.V1" Alias="Measures"/>
19 </edmx:Reference>
20 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
21 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
22 <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
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:Include Namespace="Resource.v1_1_0"/>
28 </edmx:Reference>
29 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Redundancy_v1.xml">
30 <edmx:Include Namespace="Redundancy"/>
31 </edmx:Reference>
32 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Storage_v1.xml">
33 <edmx:Include Namespace="Storage"/>
34 </edmx:Reference>
35 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Drive_v1.xml">
36 <edmx:Include Namespace="Drive"/>
37 </edmx:Reference>
38 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Port_v1.xml">
39 <edmx:Include Namespace="Port"/>
40 </edmx:Reference>
41 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Chassis_v1.xml">
42 <edmx:Include Namespace="Chassis.v1_0_0"/>
43 </edmx:Reference>
44 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Storage_v1.xml">
45 <edmx:Include Namespace="Storage.v1_0_0"/>
46 </edmx:Reference>
47
48 <edmx:DataServices>
49
50 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Endpoint">
51
52 <EntityType Name="Endpoint" BaseType="Resource.v1_0_0.Resource">
53 <Annotation Term="OData.Description" String="This is the schema definition for the Endpoint resource. It represents the properties of an entity that sends or receives protocol defined messages over a transport."/>
54 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent a fabric endpoint for a Redfish implementation."/>
55 </EntityType>
56 </Schema>
57
58 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Endpoint.v1_0_0">
59
60 <EntityType Name="Endpoint" BaseType="Endpoint.Endpoint">
61 <Annotation Term="OData.Description" String="This is the schema definition for the Endpoint resource. It represents the properties of an entity that sends or receives protocol defined messages over a transport."/>
62 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent a fabric endpoint for a Redfish implementation."/>
63 <Property Name="Status" Type="Resource.Status"/>
64 <Property Name="EndpointProtocol" Type="Storage.v1_0_0.Protocol">
65 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
66 <Annotation Term="OData.Description" String="The protocol supported by this endpoint."/>
67 <Annotation Term="OData.LongDescription" String="The value of this property shall contain the protocol this endpoint uses to communicate with other endpoints on this fabric."/>
68 </Property>
69 <Property Name="ConnectedEntities" Type="Collection(Endpoint.v1_0_0.ConnectedEntity)">
70 <Annotation Term="OData.Description" String="All the entities connected to this endpoint."/>
71 <Annotation Term="OData.LongDescription" String="This value of this property shall contain all the entities which this endpoint allows access to."/>
72 </Property>
73 <Property Name="Identifiers" Type="Collection(Resource.v1_1_0.Identifier)">
74 <Annotation Term="OData.Description" String="Identifiers for this endpoint."/>
75 <Annotation Term="OData.LongDescription" String="Identifiers for this endpoint shall be unique in the context of other endpoints that can reached over the connected network."/>
76 </Property>
77
78 <Property Name="PciId" Type="Endpoint.v1_0_0.PciId">
79 <Annotation Term="OData.Description" String="The PCI ID of the endpoint."/>
80 <Annotation Term="OData.LongDescription" String="The value of this property shall be the PCI ID of the endpoint."/>
81 </Property>
82 <NavigationProperty Name="Redundancy" Type="Collection(Redundancy.Redundancy)" Nullable="false">
83 <Annotation Term="OData.Description" String="Redundancy information for the lower level endpoints supporting this endpoint."/>
84 <Annotation Term="OData.AutoExpand"/>
85 </NavigationProperty>
86 <Property Name="HostReservationMemoryBytes" Type="Edm.Int64">
87 <Annotation Term="Measures.Unit" String="By"/>
88 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
89 <Annotation Term="OData.Description" String="The amount of memory in Bytes that the Host should allocate to connect to this endpoint."/>
90 <Annotation Term="OData.LongDescription" String="The value of this property shall be the amount of memory in Bytes that the Host should allocate to connect to this endpoint."/>
91 </Property>
92
93 <Property Name="Links" Type="Endpoint.v1_0_0.Links" Nullable="false">
94 <Annotation Term="OData.Description" String="The links object contains the links to other resources that are related to this resource."/>
95 </Property>
96 <Property Name="Actions" Type="Endpoint.v1_0_0.Actions" Nullable="false">
97 <Annotation Term="OData.Description" String="The Actions object contains the available custom actions on this resource."/>
98 </Property>
99 </EntityType>
100
101 <ComplexType Name="Links" BaseType="Resource.Links">
102 <NavigationProperty Name="MutuallyExclusiveEndpoints" Type="Collection(Endpoint.Endpoint)">
103 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
104 <Annotation Term="OData.Description" String="An array of references to the endpoints that may not be used in zones if this endpoint is used in a zone."/>
105 <Annotation Term="OData.LongDescription" String="The value of this property shall be an array of references of type Endpoint that cannot be used in a zone if this endpoint is used in a zone."/>
106 <Annotation Term="OData.AutoExpandReferences"/>
107 </NavigationProperty>
108 <NavigationProperty Name="Ports" Type="Collection(Port.Port)">
109 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
110 <Annotation Term="OData.Description" String="An array of references to the the physical ports associated with this endpoint."/>
111 <Annotation Term="OData.LongDescription" String="The value of this property shall be an array of references of type Port that are utilized by this endpoint."/>
112 <Annotation Term="OData.AutoExpandReferences"/>
113 </NavigationProperty>
114 </ComplexType>
115
116 <ComplexType Name="Actions">
117 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
118 <Property Name="Oem" Type="Endpoint.v1_0_0.OemActions"/>
119 </ComplexType>
120
121 <ComplexType Name="OemActions">
122 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
123 </ComplexType>
124
125 <ComplexType Name="ConnectedEntity">
126 <Annotation Term="OData.Description" String="Represents a remote resource that is connected to the network accessible to this endpoint."/>
127 <Property Name="EntityType" Type="Endpoint.v1_0_0.EntityType">
128 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
129 <Annotation Term="OData.Description" String="The type of the connected entity."/>
130 <Annotation Term="OData.LongDescription" String="The value of this property shall indicate if type of connected entity."/>
131 </Property>
132 <Property Name="EntityRole" Type="Endpoint.v1_0_0.EntityRole">
133 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
134 <Annotation Term="OData.Description" String="The role of the connected entity."/>
135 <Annotation Term="OData.LongDescription" String="The value of this property shall indicate if the specified entity is an initiator, target, or both."/>
136 </Property>
137 <Property Name="EntityPciId" Type="Endpoint.v1_0_0.PciId">
138 <Annotation Term="OData.Description" String="The PCI ID of the connected entity."/>
139 <Annotation Term="OData.LongDescription" String="The value of this property shall be the PCI ID of the connected PCIe entity."/>
140 </Property>
141 <Property Name="PciFunctionNumber" Type="Edm.Int64">
142 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
143 <Annotation Term="OData.Description" String="The PCI ID of the connected entity."/>
144 <Annotation Term="OData.LongDescription" String="The value of this property shall be the PCI Function Number of the connected PCIe entity."/>
145 </Property>
146 <Property Name="PciClassCode" Type="Edm.String">
147 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
148 <Annotation Term="OData.Description" String="The Class Code and Subclass code of this PCIe function."/>
149 <Annotation Term="OData.LongDescription" String="The value of this property shall be the PCI Class Code and Subclass code of the PCIe device function."/>
150 <Annotation Term="Validation.Pattern" String="/0[xX](([a-fA-F]|[0-9]){2}){2}"/>
151 </Property>
152 <Property Name="Identifiers" Type="Collection(Resource.v1_1_0.Identifier)">
153 <Annotation Term="OData.Description" String="Identifiers for the remote entity."/>
154 <Annotation Term="OData.LongDescription" String="Identifiers for the remote entity shall be unique in the context of other resources that can reached over the connected network."/>
155 </Property>
156 <NavigationProperty Name="EntityLink" Type="Resource.Resource">
157 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
158 <Annotation Term="OData.Description" String="A link to the associated entity."/>
159 <Annotation Term="OData.LongDescription" String="This property shall be a reference to an entity of the type specified by the description of the value of the EntityType property."/>
160 </NavigationProperty>
161
162 <Property Name="Oem" Type="Resource.Oem">
163 </Property>
164 </ComplexType>
165
166 <EnumType Name="EntityType">
167 <Member Name="StorageInitiator">
168 <Annotation Term="OData.Description" String="The entity is a storage initator. The EntityLink property (if present) should be a Storage.StorageController entity."/>
169 </Member>
170 <Member Name="RootComplex">
171 <Annotation Term="OData.Description" String="The entity is a PCI(e) root complex. The EntityLink property (if present) should be a ComputerSystem.ComputerSystem entity."/>
172 </Member>
173 <Member Name="NetworkController">
174 <Annotation Term="OData.Description" String="The entity is a network controller. The EntityLink property (if present) should be an EthernetInterface.EthernetInterface entity."/>
175 </Member>
176 <Member Name="Drive">
177 <Annotation Term="OData.Description" String="The entity is a disk drive. The EntityLink property (if present) should be a Drive.Drive entity."/>
178 </Member>
179 <Member Name="StorageExpander">
180 <Annotation Term="OData.Description" String="The entity is a storage expander. The EntityLink property (if present) should be a Chassis.Chassis entity."/>
181 </Member>
182 <Member Name="DisplayController">
183 <Annotation Term="OData.Description" String="The entity is a display controller."/>
184 </Member>
185 <Member Name="Bridge">
186 <Annotation Term="OData.Description" String="The entity is a PCI(e) bridge."/>
187 </Member>
188 <Member Name="Processor">
189 <Annotation Term="OData.Description" String="The entity is a processor device."/>
190 </Member>
191 </EnumType>
192
193 <EnumType Name="EntityRole">
194 <Member Name="Initiator">
195 <Annotation Term="OData.Description" String="The entity is acting as an initiator."/>
196 </Member>
197 <Member Name="Target">
198 <Annotation Term="OData.Description" String="The entity is acting as a target."/>
199 </Member>
200 <Member Name="Both">
201 <Annotation Term="OData.Description" String="The entity is acting as both an initiator and a target."/>
202 </Member>
203 </EnumType>
204
205 <ComplexType Name="PciId">
206 <Property Name="DeviceId" Type="Edm.String">
207 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
208 <Annotation Term="OData.Description" String="The Device ID of this PCIe function."/>
209 <Annotation Term="OData.LongDescription" String="The value of this property shall be the PCI Subsystem Vendor ID of the PCIe device function."/>
210 <Annotation Term="Validation.Pattern" String="/0[xX](([a-fA-F]|[0-9]){2}){2}"/>
211 </Property>
212 <Property Name="VendorId" Type="Edm.String">
213 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
214 <Annotation Term="OData.Description" String="The Vendor ID of this PCIe function."/>
215 <Annotation Term="OData.LongDescription" String="The value of this property shall be the PCI Vendor ID of the PCIe device function."/>
216 <Annotation Term="Validation.Pattern" String="/0[xX](([a-fA-F]|[0-9]){2}){2}"/>
217 </Property>
218 <Property Name="SubsystemId" Type="Edm.String">
219 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
220 <Annotation Term="OData.Description" String="The Subsystem ID of this PCIe function."/>
221 <Annotation Term="OData.LongDescription" String="The value of this property shall be the PCI Subsystem Vendor ID of the PCIe device function."/>
222 <Annotation Term="Validation.Pattern" String="/0[xX](([a-fA-F]|[0-9]){2}){2}"/>
223 </Property>
224 <Property Name="SubsystemVendorId" Type="Edm.String">
225 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
226 <Annotation Term="OData.Description" String="The Subsystem Vendor ID of this PCIe function."/>
227 <Annotation Term="OData.LongDescription" String="The value of this property shall be the PCI Subsystem Vendor ID of the PCIe device function."/>
228 <Annotation Term="Validation.Pattern" String="/0[xX](([a-fA-F]|[0-9]){2}){2}"/>
229 </Property>
230 </ComplexType>
231
232 </Schema>
233
234 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Endpoint.v1_0_1">
235 <Annotation Term="OData.Description" String="This version was created to add explicit Permissions annotations to all properties for clarity."/>
236 <EntityType Name="Endpoint" BaseType="Endpoint.v1_0_0.Endpoint"/>
237 </Schema>
238
239 </edmx:DataServices>
240</edmx:Edmx>