Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 86a0851afa06adb728c00658bbf8cd8608bd8ff3 / . / static / redfish / v1 / schema / Port_v1.xml
blob: 2efdb8f801cd1f00a5aaa315f7b5b36607a9904f [file] [log] [blame]
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
4<!--# Redfish Schema: Port v1.1.3 -->
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-2019 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.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/Resource_v1.xml">
21 <edmx:Include Namespace="Resource"/>
22 <edmx:Include Namespace="Resource.v1_0_0"/>
23 </edmx:Reference>
24 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
25 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
26 </edmx:Reference>
27 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Endpoint_v1.xml">
28 <edmx:Include Namespace="Endpoint"/>
29 </edmx:Reference>
30 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Switch_v1.xml">
31 <edmx:Include Namespace="Switch"/>
32 </edmx:Reference>
33 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Measures.V1.xml">
34 <edmx:Include Namespace="Org.OData.Measures.V1" Alias="Measures"/>
35 </edmx:Reference>
36 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Protocol_v1.xml">
37 <edmx:Include Namespace="Protocol"/>
38 </edmx:Reference>
39
40 <edmx:DataServices>
41
42 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port">
43 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
44
45 <EntityType Name="Port" BaseType="Resource.v1_0_0.Resource" Abstract="true">
46 <Annotation Term="OData.Description" String="The Port schema contains properties that describe a port of a switch, controller, chassis, or any other device that could be connected to another entity."/>
47 <Annotation Term="OData.LongDescription" String="This Resource contains a simple port for a Redfish implementation."/>
48 <Annotation Term="Capabilities.InsertRestrictions">
49 <Record>
50 <PropertyValue Property="Insertable" Bool="false"/>
51 </Record>
52 </Annotation>
53 <Annotation Term="Capabilities.UpdateRestrictions">
54 <Record>
55 <PropertyValue Property="Updatable" Bool="false"/>
56 </Record>
57 </Annotation>
58 <Annotation Term="Capabilities.DeleteRestrictions">
59 <Record>
60 <PropertyValue Property="Deletable" Bool="false"/>
61 </Record>
62 </Annotation>
63 <Annotation Term="Redfish.Uris">
64 <Collection>
65 <String>/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}</String>
66 <String>/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}</String>
67 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}</String>
68 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}</String>
69 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}</String>
70 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}</String>
71 </Collection>
72 </Annotation>
73 </EntityType>
74
75 <Action Name="Reset" IsBound="true">
76 <Parameter Name="Port" Type="Port.v1_0_0.Actions"/>
77 <Parameter Name="ResetType" Type="Resource.ResetType">
78 <Annotation Term="OData.Description" String="The type of reset."/>
79 <Annotation Term="OData.LongDescription" String="This parameter shall contain the type of reset. The Service may accept a request without the parameter and perform an implementation specific default reset."/>
80 </Parameter>
81 <Annotation Term="OData.Description" String="This action resets this port."/>
82 <Annotation Term="OData.LongDescription" String="This action shall reset this port."/>
83 </Action>
84
85 </Schema>
86
87 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_0">
88 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
89 <Annotation Term="Redfish.Release" String="2016.2"/>
90
91 <EntityType Name="Port" BaseType="Port.Port">
92 <Property Name="Status" Type="Resource.Status" Nullable="false">
93 <Annotation Term="OData.Description" String="The status and health of the Resource and its subordinate or dependent Resources."/>
94 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the Resource."/>
95 </Property>
96 <Property Name="PortId" Type="Edm.String">
97 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
98 <Annotation Term="OData.Description" String="The label of this port on the physical package for this port."/>
99 <Annotation Term="OData.LongDescription" String="This property shall contain the name of the port as indicated on the device containing the port."/>
100 </Property>
101 <Property Name="PortProtocol" Type="Protocol.Protocol">
102 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
103 <Annotation Term="OData.Description" String="The protocol being sent over this port."/>
104 <Annotation Term="OData.LongDescription" String="This property shall contain the protocol being sent over this port."/>
105 </Property>
106 <Property Name="PortType" Type="Port.v1_0_0.PortType">
107 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
108 <Annotation Term="OData.Description" String="The type of this port."/>
109 <Annotation Term="OData.LongDescription" String="This property shall contain the port type for this port."/>
110 </Property>
111 <Property Name="CurrentSpeedGbps" Type="Edm.Decimal">
112 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
113 <Annotation Term="OData.Description" String="The current speed of this port."/>
114 <Annotation Term="OData.LongDescription" String="This property shall contain the speed of this port currently negotiated and running."/>
115 <Annotation Term="Measures.Unit" String="Gbit/s"/>
116 </Property>
117 <Property Name="MaxSpeedGbps" Type="Edm.Decimal">
118 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
119 <Annotation Term="OData.Description" String="The maximum speed of this port as currently configured."/>
120 <Annotation Term="OData.LongDescription" String="This property shall contain the maximum speed of which this port is capable of being configured. If capable of auto-negotiation, the system shall attempt to negotiate at the maximum speed set."/>
121 <Annotation Term="Measures.Unit" String="Gbit/s"/>
122 </Property>
123 <Property Name="Width" Type="Edm.Int64">
124 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
125 <Annotation Term="OData.Description" String="The number of lanes, phys, or other physical transport links that this port contains."/>
126 <Annotation Term="OData.LongDescription" String="This property shall contain the number of physical transport links that this port contains."/>
127 </Property>
128 <Property Name="Links" Type="Port.v1_0_0.Links" Nullable="false">
129 <Annotation Term="OData.Description" String="The links to other Resources that are related to this Resource."/>
130 <Annotation Term="OData.LongDescription" String="The Redfish Specification-described Links Property shall contain links to Resources related to but not subordinate to this Resource."/>
131 </Property>
132 <Property Name="Actions" Type="Port.v1_0_0.Actions" Nullable="false">
133 <Annotation Term="OData.Description" String="The available actions for this Resource."/>
134 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this Resource."/>
135 </Property>
136 </EntityType>
137
138 <ComplexType Name="Links" BaseType="Resource.Links">
139 <Annotation Term="OData.Description" String="The links to other Resources that are related to this Resource."/>
140 <Annotation Term="OData.LongDescription" String="The Redfish Specification-described type shall contain links to Resources related to but not subordinate to this Resource."/>
141 <NavigationProperty Name="AssociatedEndpoints" Type="Collection(Endpoint.Endpoint)">
142 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
143 <Annotation Term="OData.Description" String="An array of links to the endpoints that connect through this port."/>
144 <Annotation Term="OData.LongDescription" String="This property shall contain a link to the Resources of the Endpoint type with which this port is associated."/>
145 <Annotation Term="OData.AutoExpandReferences"/>
146 </NavigationProperty>
147 <NavigationProperty Name="ConnectedSwitches" Type="Collection(Switch.Switch)">
148 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
149 <Annotation Term="OData.Description" String="An array of links to the switches that connect to the device through this port."/>
150 <Annotation Term="OData.LongDescription" String="This property shall contain a link to the Resources of the Switch type with which this port is associated."/>
151 <Annotation Term="OData.AutoExpandReferences"/>
152 </NavigationProperty>
153 <NavigationProperty Name="ConnectedSwitchPorts" Type="Collection(Port.Port)">
154 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
155 <Annotation Term="OData.Description" String="An array of links to the ports that connect to the switch through this port."/>
156 <Annotation Term="OData.LongDescription" String="This property shall contain a link to the Resources of the Port type with which this port is associated."/>
157 <Annotation Term="OData.AutoExpandReferences"/>
158 </NavigationProperty>
159 </ComplexType>
160
161 <ComplexType Name="Actions">
162 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
163 <Annotation Term="OData.Description" String="The available actions for this Resource."/>
164 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this Resource."/>
165 <Property Name="Oem" Type="Port.v1_0_0.OemActions" Nullable="false">
166 <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/>
167 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this Resource."/>
168 </Property>
169 </ComplexType>
170
171 <ComplexType Name="OemActions">
172 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
173 <Annotation Term="OData.Description" String="The available OEM-specific actions for this Resource."/>
174 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this Resource."/>
175 </ComplexType>
176
177 <EnumType Name="PortType">
178 <Member Name="UpstreamPort">
179 <Annotation Term="OData.Description" String="This port connects to a host device."/>
180 </Member>
181 <Member Name="DownstreamPort">
182 <Annotation Term="OData.Description" String="This port connects to a target device."/>
183 </Member>
184 <Member Name="InterswitchPort">
185 <Annotation Term="OData.Description" String="This port connects to another switch."/>
186 </Member>
187 <Member Name="ManagementPort">
188 <Annotation Term="OData.Description" String="This port connects to a switch manager."/>
189 </Member>
190 <Member Name="BidirectionalPort">
191 <Annotation Term="OData.Description" String="This port connects to any type of device."/>
192 </Member>
193 <Member Name="UnconfiguredPort">
194 <Annotation Term="OData.Description" String="This port has not yet been configured."/>
195 </Member>
196 </EnumType>
197 </Schema>
198
199 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_1">
200 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
201 <Annotation Term="OData.Description" String="This version was created to show that annotations in previous namespaces were updated."/>
202 <EntityType Name="Port" BaseType="Port.v1_0_0.Port"/>
203 </Schema>
204
205 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_2">
206 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
207 <Annotation Term="OData.Description" String="This version was created to remove the Nullable facet on NavigationProperties of the Collection type."/>
208 <EntityType Name="Port" BaseType="Port.v1_0_1.Port"/>
209 </Schema>
210
211 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_3">
212 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
213 <Annotation Term="OData.Description" String="This version was created to change PortProtocol to use the unversioned definition, and correct the short and long descriptions in the defined actions."/>
214 <EntityType Name="Port" BaseType="Port.v1_0_2.Port"/>
215 </Schema>
216
217 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_4">
218 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
219 <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."/>
220 <EntityType Name="Port" BaseType="Port.v1_0_3.Port"/>
221 </Schema>
222
223 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_5">
224 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
225 <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. It also clarifies several descriptions."/>
226 <EntityType Name="Port" BaseType="Port.v1_0_4.Port"/>
227 </Schema>
228
229 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_6">
230 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
231 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
232 <EntityType Name="Port" BaseType="Port.v1_0_5.Port"/>
233 </Schema>
234
235 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_0">
236 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
237 <Annotation Term="Redfish.Release" String="2017.3"/>
238 <EntityType Name="Port" BaseType="Port.v1_0_3.Port">
239 <Property Name="Location" Type="Resource.Location" Nullable="false">
240 <Annotation Term="OData.Description" String="The location of the port."/>
241 <Annotation Term="OData.LongDescription" String="This property shall contain location information of the associated port."/>
242 </Property>
243 </EntityType>
244 </Schema>
245
246 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_1">
247 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
248 <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."/>
249 <EntityType Name="Port" BaseType="Port.v1_1_0.Port"/>
250 </Schema>
251
252 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_2">
253 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
254 <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. It also clarifies several descriptions."/>
255 <EntityType Name="Port" BaseType="Port.v1_1_1.Port"/>
256 </Schema>
257
258 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_3">
259 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
260 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
261 <EntityType Name="Port" BaseType="Port.v1_1_2.Port"/>
262 </Schema>
263
264 </edmx:DataServices>
265</edmx:Edmx>