Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / ae907c720c9fef0a6c0d27f931d2cf399e2a55f1 / . / static / redfish / v1 / schema / Port_v1.xml
blob: 2097fa8e1bb56e2165d7922ef41682a98aa823f4 [file] [log] [blame]
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]4<!--# Redfish Schema: Port v1.4.0 -->
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]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 -->
Gunnar Millsa778c022020-05-12 12:20:36 -0500[diff] [blame]8<!--# Copyright 2014-2020 DMTF. -->
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]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>
Gunnar Mills09b9d452020-02-11 13:27:39 -0600[diff] [blame]39 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/PortMetrics_v1.xml">
40 <edmx:Include Namespace="PortMetrics"/>
41 </edmx:Reference>
42 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RouteEntryCollection_v1.xml">
43 <edmx:Include Namespace="RouteEntryCollection"/>
44 </edmx:Reference>
45 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/VCATEntryCollection_v1.xml">
46 <edmx:Include Namespace="VCATEntryCollection"/>
47 </edmx:Reference>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]48 <edmx:DataServices>
Gunnar Mills09b9d452020-02-11 13:27:39 -0600[diff] [blame]49
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]50 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port">
51 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
52
53 <EntityType Name="Port" BaseType="Resource.v1_0_0.Resource" Abstract="true">
54 <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."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]55 <Annotation Term="OData.LongDescription" String="This resource contains a simple port for a Redfish implementation."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]56 <Annotation Term="Capabilities.InsertRestrictions">
57 <Record>
58 <PropertyValue Property="Insertable" Bool="false"/>
59 </Record>
60 </Annotation>
61 <Annotation Term="Capabilities.UpdateRestrictions">
62 <Record>
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]63 <PropertyValue Property="Updatable" Bool="true"/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]64 </Record>
65 </Annotation>
66 <Annotation Term="Capabilities.DeleteRestrictions">
67 <Record>
68 <PropertyValue Property="Deletable" Bool="false"/>
69 </Record>
70 </Annotation>
71 <Annotation Term="Redfish.Uris">
72 <Collection>
73 <String>/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}</String>
74 <String>/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}</String>
Gunnar Mills09b9d452020-02-11 13:27:39 -0600[diff] [blame]75 <String>/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}</String>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]76 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}</String>
77 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}</String>
78 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}</String>
79 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}</String>
Gunnar Mills09b9d452020-02-11 13:27:39 -0600[diff] [blame]80 <String>/redfish/v1/Chassis/{ChassisId}/MediaControllers/{MediaControllerId}/Ports/{PortId}</String>
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]81 <String>/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Ports/{PortId}</String>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]82 </Collection>
83 </Annotation>
84 </EntityType>
85
86 <Action Name="Reset" IsBound="true">
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]87 <Annotation Term="OData.Description" String="This action resets this port."/>
88 <Annotation Term="OData.LongDescription" String="This action shall reset this port."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]89 <Parameter Name="Port" Type="Port.v1_0_0.Actions"/>
90 <Parameter Name="ResetType" Type="Resource.ResetType">
91 <Annotation Term="OData.Description" String="The type of reset."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]92 <Annotation Term="OData.LongDescription" String="This parameter shall contain the type of reset. The service can accept a request without the parameter and perform an implementation specific default reset."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]93 </Parameter>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]94 </Action>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]95 </Schema>
96
97 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_0">
98 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
99 <Annotation Term="Redfish.Release" String="2016.2"/>
100
101 <EntityType Name="Port" BaseType="Port.Port">
102 <Property Name="Status" Type="Resource.Status" Nullable="false">
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]103 <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
104 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]105 </Property>
106 <Property Name="PortId" Type="Edm.String">
107 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
108 <Annotation Term="OData.Description" String="The label of this port on the physical package for this port."/>
109 <Annotation Term="OData.LongDescription" String="This property shall contain the name of the port as indicated on the device containing the port."/>
110 </Property>
111 <Property Name="PortProtocol" Type="Protocol.Protocol">
112 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
113 <Annotation Term="OData.Description" String="The protocol being sent over this port."/>
114 <Annotation Term="OData.LongDescription" String="This property shall contain the protocol being sent over this port."/>
115 </Property>
116 <Property Name="PortType" Type="Port.v1_0_0.PortType">
117 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
118 <Annotation Term="OData.Description" String="The type of this port."/>
119 <Annotation Term="OData.LongDescription" String="This property shall contain the port type for this port."/>
120 </Property>
121 <Property Name="CurrentSpeedGbps" Type="Edm.Decimal">
122 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
123 <Annotation Term="OData.Description" String="The current speed of this port."/>
124 <Annotation Term="OData.LongDescription" String="This property shall contain the speed of this port currently negotiated and running."/>
125 <Annotation Term="Measures.Unit" String="Gbit/s"/>
126 </Property>
127 <Property Name="MaxSpeedGbps" Type="Edm.Decimal">
128 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
129 <Annotation Term="OData.Description" String="The maximum speed of this port as currently configured."/>
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]130 <Annotation Term="OData.LongDescription" String="This property shall contain the maximum speed of which this port is capable of being configured. If capable of autonegotiation, the system shall attempt to negotiate at the maximum speed set."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]131 <Annotation Term="Measures.Unit" String="Gbit/s"/>
132 </Property>
133 <Property Name="Width" Type="Edm.Int64">
134 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
135 <Annotation Term="OData.Description" String="The number of lanes, phys, or other physical transport links that this port contains."/>
136 <Annotation Term="OData.LongDescription" String="This property shall contain the number of physical transport links that this port contains."/>
137 </Property>
138 <Property Name="Links" Type="Port.v1_0_0.Links" Nullable="false">
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]139 <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/>
140 <Annotation Term="OData.LongDescription" String="This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]141 </Property>
142 <Property Name="Actions" Type="Port.v1_0_0.Actions" Nullable="false">
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]143 <Annotation Term="OData.Description" String="The available actions for this resource."/>
144 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]145 </Property>
146 </EntityType>
147
148 <ComplexType Name="Links" BaseType="Resource.Links">
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]149 <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/>
150 <Annotation Term="OData.LongDescription" String="This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]151 <NavigationProperty Name="AssociatedEndpoints" Type="Collection(Endpoint.Endpoint)">
152 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
153 <Annotation Term="OData.Description" String="An array of links to the endpoints that connect through this port."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]154 <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to resources of type Endpoint with which this port is associated."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]155 <Annotation Term="OData.AutoExpandReferences"/>
156 </NavigationProperty>
157 <NavigationProperty Name="ConnectedSwitches" Type="Collection(Switch.Switch)">
158 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
159 <Annotation Term="OData.Description" String="An array of links to the switches that connect to the device through this port."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]160 <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to resources of type Switch with which this port is associated."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]161 <Annotation Term="OData.AutoExpandReferences"/>
162 </NavigationProperty>
163 <NavigationProperty Name="ConnectedSwitchPorts" Type="Collection(Port.Port)">
164 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
165 <Annotation Term="OData.Description" String="An array of links to the ports that connect to the switch through this port."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]166 <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to resources of type Port with which this port is associated."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]167 <Annotation Term="OData.AutoExpandReferences"/>
168 </NavigationProperty>
169 </ComplexType>
170
171 <ComplexType Name="Actions">
172 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]173 <Annotation Term="OData.Description" String="The available actions for this resource."/>
174 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]175 <Property Name="Oem" Type="Port.v1_0_0.OemActions" Nullable="false">
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]176 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
177 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]178 </Property>
179 </ComplexType>
180
181 <ComplexType Name="OemActions">
182 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]183 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
184 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]185 </ComplexType>
186
187 <EnumType Name="PortType">
188 <Member Name="UpstreamPort">
189 <Annotation Term="OData.Description" String="This port connects to a host device."/>
190 </Member>
191 <Member Name="DownstreamPort">
192 <Annotation Term="OData.Description" String="This port connects to a target device."/>
193 </Member>
194 <Member Name="InterswitchPort">
195 <Annotation Term="OData.Description" String="This port connects to another switch."/>
196 </Member>
197 <Member Name="ManagementPort">
198 <Annotation Term="OData.Description" String="This port connects to a switch manager."/>
199 </Member>
200 <Member Name="BidirectionalPort">
201 <Annotation Term="OData.Description" String="This port connects to any type of device."/>
202 </Member>
203 <Member Name="UnconfiguredPort">
204 <Annotation Term="OData.Description" String="This port has not yet been configured."/>
205 </Member>
206 </EnumType>
207 </Schema>
208
209 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_1">
210 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
211 <Annotation Term="OData.Description" String="This version was created to show that annotations in previous namespaces were updated."/>
212 <EntityType Name="Port" BaseType="Port.v1_0_0.Port"/>
213 </Schema>
214
215 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_2">
216 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
217 <Annotation Term="OData.Description" String="This version was created to remove the Nullable facet on NavigationProperties of the Collection type."/>
218 <EntityType Name="Port" BaseType="Port.v1_0_1.Port"/>
219 </Schema>
220
221 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_3">
222 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
223 <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."/>
224 <EntityType Name="Port" BaseType="Port.v1_0_2.Port"/>
225 </Schema>
226
227 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_4">
228 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
229 <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."/>
230 <EntityType Name="Port" BaseType="Port.v1_0_3.Port"/>
231 </Schema>
232
233 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_5">
234 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
235 <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."/>
236 <EntityType Name="Port" BaseType="Port.v1_0_4.Port"/>
237 </Schema>
238
239 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_6">
240 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
241 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
242 <EntityType Name="Port" BaseType="Port.v1_0_5.Port"/>
243 </Schema>
244
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]245 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_7">
246 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
247 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
248 <EntityType Name="Port" BaseType="Port.v1_0_6.Port"/>
249 </Schema>
250
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]251 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_0">
252 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
253 <Annotation Term="Redfish.Release" String="2017.3"/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]254
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]255 <EntityType Name="Port" BaseType="Port.v1_0_3.Port">
256 <Property Name="Location" Type="Resource.Location" Nullable="false">
257 <Annotation Term="OData.Description" String="The location of the port."/>
258 <Annotation Term="OData.LongDescription" String="This property shall contain location information of the associated port."/>
259 </Property>
260 </EntityType>
261 </Schema>
262
263 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_1">
264 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
265 <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."/>
266 <EntityType Name="Port" BaseType="Port.v1_1_0.Port"/>
267 </Schema>
268
269 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_2">
270 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
271 <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."/>
272 <EntityType Name="Port" BaseType="Port.v1_1_1.Port"/>
273 </Schema>
274
275 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_3">
276 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
277 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
278 <EntityType Name="Port" BaseType="Port.v1_1_2.Port"/>
279 </Schema>
280
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]281 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_4">
282 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
283 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
284 <EntityType Name="Port" BaseType="Port.v1_1_3.Port"/>
285 </Schema>
286
Gunnar Mills09b9d452020-02-11 13:27:39 -0600[diff] [blame]287 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_2_0">
288 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
289 <Annotation Term="Redfish.Release" String="2019.4"/>
290
291 <EntityType Name="Port" BaseType="Port.v1_1_3.Port">
292 <Property Name="PortMedium" Type="Port.v1_2_0.PortMedium">
293 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
294 <Annotation Term="OData.Description" String="The physical connection medium for this port."/>
295 <Annotation Term="OData.LongDescription" String="This property shall contain the physical connection medium for this port."/>
296 </Property>
297 <Property Name="LinkNetworkTechnology" Type="Port.v1_2_0.LinkNetworkTechnology">
298 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
299 <Annotation Term="OData.Description" String="The link network technology capabilities of this port."/>
300 <Annotation Term="OData.LongDescription" String="This property shall contain a network technology capability of this port."/>
301 </Property>
302 <Property Name="InterfaceEnabled" Type="Edm.Boolean">
303 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
304 <Annotation Term="OData.Description" String="An indication of whether the interface is enabled."/>
305 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the interface is enabled."/>
306 </Property>
307 <Property Name="SignalDetected" Type="Edm.Boolean">
308 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
309 <Annotation Term="OData.Description" String="An indication of whether a signal is detected on this interface."/>
310 <Annotation Term="OData.LongDescription" String="This property shall indicate whether a signal that is appropriate for this link technology is detected for this port."/>
311 </Property>
312 <Property Name="LinkTransitionIndicator" Type="Edm.Int64" Nullable="false">
313 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
314 <Annotation Term="OData.Description" String="The number of link state transitions for this interface."/>
315 <Annotation Term="OData.LongDescription" String="This property shall contain the number of link state transitions for this interface."/>
316 </Property>
317 <Property Name="ActiveWidth" Type="Edm.Int64" Nullable="false">
318 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
319 <Annotation Term="OData.Description" String="The number of active lanes for this interface."/>
320 <Annotation Term="OData.LongDescription" String="This property shall contain the number of active lanes for this interface."/>
321 </Property>
322 <Property Name="LinkState" Type="Port.v1_2_0.LinkState" Nullable="false">
323 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
324 <Annotation Term="OData.Description" String="The desired link state for this interface."/>
325 <Annotation Term="OData.LongDescription" String="This property shall contain the desired link state for this interface."/>
326 </Property>
327 <Property Name="LinkStatus" Type="Port.v1_2_0.LinkStatus" Nullable="false">
328 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
329 <Annotation Term="OData.Description" String="The desired link status for this interface."/>
330 <Annotation Term="OData.LongDescription" String="This property shall contain the desired link status for this interface."/>
331 </Property>
332 <Property Name="GenZ" Type="Port.v1_2_0.GenZ" Nullable="false">
333 <Annotation Term="OData.Description" String="Gen-Z specific properties."/>
334 <Annotation Term="OData.LongDescription" String="This property shall contain Gen-Z specific properties for this interface."/>
335 </Property>
336 <NavigationProperty Name="Metrics" Type="PortMetrics.PortMetrics">
337 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
338 <Annotation Term="OData.Description" String="The link to the metrics associated with this port."/>
339 <Annotation Term="OData.LongDescription" String="This property shall contain a link to the metrics associated with this port."/>
340 <Annotation Term="OData.AutoExpandReferences"/>
341 </NavigationProperty>
342 </EntityType>
343
344 <ComplexType Name="GenZ">
345 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
346 <Annotation Term="OData.Description" String="This type defines Gen-Z specific port properties."/>
347 <Annotation Term="OData.LongDescription" String="This type shall contain Gen-Z specific port properties."/>
348 <NavigationProperty Name="LPRT" Type="RouteEntryCollection.RouteEntryCollection" Nullable="false">
349 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
350 <Annotation Term="OData.Description" String="The Linear Packet Relay Table for the port."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]351 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type RouteEntryCollection, and shall represent the Gen-Z Core Specification-defined Linear Packet Relay Table for this port."/>
Gunnar Mills09b9d452020-02-11 13:27:39 -0600[diff] [blame]352 <Annotation Term="OData.AutoExpandReferences"/>
353 </NavigationProperty>
354 <NavigationProperty Name="MPRT" Type="RouteEntryCollection.RouteEntryCollection" Nullable="false">
355 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
356 <Annotation Term="OData.Description" String="the Multi-subnet Packet Relay Table for the port."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]357 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type RouteEntryCollection, and shall represent the Gen-Z Core Specification-defined Multi-subnet Packet Relay Table for this port."/>
Gunnar Mills09b9d452020-02-11 13:27:39 -0600[diff] [blame]358 <Annotation Term="OData.AutoExpandReferences"/>
359 </NavigationProperty>
360 <NavigationProperty Name="VCAT" Type="VCATEntryCollection.VCATEntryCollection" Nullable="false">
361 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
362 <Annotation Term="OData.Description" String="the Virtual Channel Action Table for the port."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]363 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type VCATEntryCollection."/>
Gunnar Mills09b9d452020-02-11 13:27:39 -0600[diff] [blame]364 <Annotation Term="OData.AutoExpandReferences"/>
365 </NavigationProperty>
366 </ComplexType>
367
368 <ComplexType Name="Links" BaseType="Port.v1_0_0.Links">
369 <NavigationProperty Name="ConnectedPorts" Type="Collection(Port.Port)">
370 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
371 <Annotation Term="OData.Description" String="An array of links to the remote ports connected to this port."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]372 <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to resources of type Port that represent the physical connections associated with this port."/>
Gunnar Mills09b9d452020-02-11 13:27:39 -0600[diff] [blame]373 <Annotation Term="OData.AutoExpandReferences"/>
374 </NavigationProperty>
375 </ComplexType>
376
377 <EnumType Name="PortMedium">
378 <Member Name="Electrical">
379 <Annotation Term="OData.Description" String="This port has an electrical cable connection."/>
380 </Member>
381 <Member Name="Optical">
382 <Annotation Term="OData.Description" String="This port has an optical cable connection."/>
383 </Member>
384 </EnumType>
385
386 <EnumType Name="LinkState">
387 <Member Name="Enabled">
388 <Annotation Term="OData.Description" String="This link is enabled."/>
389 </Member>
390 <Member Name="Disabled">
391 <Annotation Term="OData.Description" String="This link is disabled."/>
392 </Member>
393 </EnumType>
394
395 <EnumType Name="LinkStatus">
396 <Member Name="LinkUp">
397 <Annotation Term="OData.Description" String="This link on this interface is up."/>
398 </Member>
399 <Member Name="Starting">
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]400 <Annotation Term="OData.Description" String="This link on this interface is starting. A physical link has been established, but the port is not able to transfer data."/>
Gunnar Mills09b9d452020-02-11 13:27:39 -0600[diff] [blame]401 </Member>
402 <Member Name="Training">
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]403 <Annotation Term="OData.Description" String="This physical link on this interface is training."/>
Gunnar Mills09b9d452020-02-11 13:27:39 -0600[diff] [blame]404 </Member>
405 <Member Name="LinkDown">
406 <Annotation Term="OData.Description" String="The link on this interface is down."/>
407 </Member>
408 <Member Name="NoLink">
409 <Annotation Term="OData.Description" String="No physical link detected on this interface."/>
410 </Member>
411 </EnumType>
412
413 <EnumType Name="LinkNetworkTechnology">
414 <Member Name="Ethernet">
415 <Annotation Term="OData.Description" String="The port is capable of connecting to an Ethernet network."/>
416 </Member>
417 <Member Name="InfiniBand">
418 <Annotation Term="OData.Description" String="The port is capable of connecting to an InfiniBand network."/>
419 </Member>
420 <Member Name="FibreChannel">
421 <Annotation Term="OData.Description" String="The port is capable of connecting to a Fibre Channel network."/>
422 </Member>
423 <Member Name="GenZ">
424 <Annotation Term="OData.Description" String="The port is capable of connecting to a Gen-Z fabric."/>
425 </Member>
426 </EnumType>
427 </Schema>
428
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]429 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_2_1">
430 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
431 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
432 <EntityType Name="Port" BaseType="Port.v1_2_0.Port"/>
433 </Schema>
434
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]435 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_2_2">
436 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
437 <Annotation Term="OData.Description" String="This version was created to clarify the descriptions for the values of LinkStatus."/>
438 <EntityType Name="Port" BaseType="Port.v1_2_1.Port"/>
439 </Schema>
440
441 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_3_0">
442 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
443 <Annotation Term="Redfish.Release" String="2020.3"/>
444
445 <EntityType Name="Port" BaseType="Port.v1_2_2.Port">
446 <Property Name="LocationIndicatorActive" Type="Edm.Boolean">
447 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
448 <Annotation Term="OData.Description" String="An indicator allowing an operator to physically locate this resource."/>
449 <Annotation Term="OData.LongDescription" String="This property shall contain the state of the indicator used to physically identify or locate this resource. A write to this property shall update the value of IndicatorLED in this resource, if supported, to reflect the implementation of the locating function."/>
450 </Property>
451 <Property Name="MaxFrameSize" Type="Edm.Int64">
452 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
453 <Annotation Term="OData.Description" String="The maximum frame size supported by the port."/>
454 <Annotation Term="OData.LongDescription" String="This property shall contain the maximum frame size supported by the port."/>
455 <Annotation Term="Measures.Unit" String="By"/>
456 </Property>
457 <Property Name="LinkConfiguration" Type="Collection(Port.v1_3_0.LinkConfiguration)" Nullable="false">
458 <Annotation Term="OData.Description" String="The link configuration of this port."/>
459 <Annotation Term="OData.LongDescription" String="This property shall contain the static capabilities and configuration settings of the port."/>
460 </Property>
461 <Property Name="FibreChannel" Type="Port.v1_3_0.FibreChannelProperties">
462 <Annotation Term="OData.Description" String="Fibre Channel properties for this port."/>
463 <Annotation Term="OData.LongDescription" String="This property shall contain Fibre Channel-specific properties of the port."/>
464 </Property>
465 <Property Name="Ethernet" Type="Port.v1_3_0.EthernetProperties">
466 <Annotation Term="OData.Description" String="Ethernet properties for this port."/>
467 <Annotation Term="OData.LongDescription" String="This property shall contain Ethernet-specific properties of the port."/>
468 </Property>
469 </EntityType>
470
471 <ComplexType Name="FibreChannelProperties">
472 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
473 <Annotation Term="OData.Description" String="Fibre Channel-specific properties for a port."/>
474 <Annotation Term="OData.LongDescription" String="This type shall contain Fibre Channel-specific properties for a port."/>
475 <Property Name="PortConnectionType" Type="Port.v1_3_0.PortConnectionType">
476 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
477 <Annotation Term="OData.Description" String="The connection type of this port."/>
478 <Annotation Term="OData.LongDescription" String="This property shall contain the connection type for this port."/>
479 </Property>
480 <Property Name="NumberDiscoveredRemotePorts" Type="Edm.Int64">
481 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
482 <Annotation Term="OData.Description" String="The number of ports not on the associated device that the associated device has discovered through this port."/>
483 <Annotation Term="OData.LongDescription" String="This property shall contain the number of ports not on this associated device that this port has discovered."/>
484 </Property>
485 <Property Name="FabricName" Type="Edm.String">
486 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
487 <Annotation Term="OData.Description" String="The Fibre Channel Fabric Name provided by the switch."/>
488 <Annotation Term="OData.LongDescription" String="This property shall indicate the Fibre Channel Fabric Name provided by the switch."/>
489 </Property>
490 </ComplexType>
491
492 <ComplexType Name="EthernetProperties">
493 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
494 <Annotation Term="OData.Description" String="Ethernet-specific properties for a port."/>
495 <Annotation Term="OData.LongDescription" String="This type shall contain Ethernet-specific properties for a port."/>
496 <Property Name="SupportedEthernetCapabilities" Type="Collection(Port.v1_3_0.SupportedEthernetCapabilities)">
497 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
498 <Annotation Term="OData.Description" String="The set of Ethernet capabilities that this port supports."/>
499 <Annotation Term="OData.LongDescription" String="This property shall contain an array of Ethernet capabilities supported by this port."/>
500 </Property>
501 <Property Name="FlowControlStatus" Type="Port.v1_3_0.FlowControl">
502 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
503 <Annotation Term="OData.Description" String="The 802.3x flow control behavior negotiated with the link partner for this port."/>
504 <Annotation Term="OData.LongDescription" String="This property shall contain the 802.3x flow control behavior negotiated with the link partner for this port."/>
505 </Property>
506 <Property Name="FlowControlConfiguration" Type="Port.v1_3_0.FlowControl">
507 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
508 <Annotation Term="OData.Description" String="The locally configured 802.3x flow control setting for this port."/>
509 <Annotation Term="OData.LongDescription" String="This property shall contain the locally configured 802.3x flow control setting for this port."/>
510 </Property>
511 </ComplexType>
512
513 <EnumType Name="PortConnectionType">
514 <Member Name="NotConnected">
515 <Annotation Term="OData.Description" String="This port is not connected."/>
516 </Member>
517 <Member Name="NPort">
518 <Annotation Term="OData.Description" String="This port connects through an N-Port to a switch."/>
519 </Member>
520 <Member Name="PointToPoint">
521 <Annotation Term="OData.Description" String="This port connects in a Point-to-point configuration."/>
522 </Member>
523 <Member Name="PrivateLoop">
524 <Annotation Term="OData.Description" String="This port connects in a private loop configuration."/>
525 </Member>
526 <Member Name="PublicLoop">
527 <Annotation Term="OData.Description" String="This port connects in a public configuration."/>
528 </Member>
529 <Member Name="Generic">
530 <Annotation Term="OData.Description" String="This port connection type is a generic fabric port."/>
531 </Member>
532 <Member Name="ExtenderFabric">
533 <Annotation Term="OData.Description" String="This port connection type is an extender fabric port."/>
534 </Member>
535 </EnumType>
536
537 <EnumType Name="SupportedEthernetCapabilities">
538 <Member Name="WakeOnLAN">
539 <Annotation Term="OData.Description" String="Wake on LAN (WoL) is supported on this port." />
540 </Member>
541 <Member Name="EEE">
542 <Annotation Term="OData.Description" String="IEEE 802.3az Energy-Efficient Ethernet (EEE) is supported on this port." />
543 </Member>
544 </EnumType>
545
546 <EnumType Name="FlowControl">
547 <Member Name="None">
548 <Annotation Term="OData.Description" String="No IEEE 802.3x flow control is enabled on this port." />
549 </Member>
550 <Member Name="TX">
551 <Annotation Term="OData.Description" String="IEEE 802.3x flow control may be initiated by this station." />
552 </Member>
553 <Member Name="RX">
554 <Annotation Term="OData.Description" String="IEEE 802.3x flow control may be initiated by the link partner." />
555 </Member>
556 <Member Name="TX_RX">
557 <Annotation Term="OData.Description" String="IEEE 802.3x flow control may be initiated by this station or the link partner." />
558 </Member>
559 </EnumType>
560
561 <ComplexType Name="LinkConfiguration">
562 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
563 <Annotation Term="OData.Description" String="Properties of the link for which this port is configured."/>
564 <Annotation Term="OData.LongDescription" String="This type shall contain properties of the link for which port has been configured."/>
565 <Property Name="CapableLinkSpeedGbps" Type="Collection(Edm.Decimal)">
566 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
567 <Annotation Term="OData.Description" String="The set of link speed capabilities of this port."/>
568 <Annotation Term="OData.LongDescription" String="This property shall contain all of the possible network link speed capabilities of this port."/>
569 </Property>
570 <Property Name="ConfiguredNetworkLinks" Type="Collection(Port.v1_3_0.ConfiguredNetworkLink)">
571 <Annotation Term="OData.Description" String="The set of link speed and width pairs this port is configured to use for autonegotiation."/>
572 <Annotation Term="OData.LongDescription" String="This property shall contain the set of link speed and width pairs to which this port is restricted for autonegotiation purposes."/>
573 </Property>
574 <Property Name="AutoSpeedNegotiationCapable" Type="Edm.Boolean">
575 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
576 <Annotation Term="OData.Description" String="An indication of whether the port is capable of autonegotiating speed."/>
577 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the port is capable of autonegotiating speed."/>
578 </Property>
579 <Property Name="AutoSpeedNegotiationEnabled" Type="Edm.Boolean">
580 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
581 <Annotation Term="OData.Description" String="Controls whether this port is configured to enable autonegotiating speed."/>
582 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the port is configured to autonegotiate speed."/>
583 </Property>
584 </ComplexType>
585
586 <ComplexType Name="ConfiguredNetworkLink">
587 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
588 <Annotation Term="OData.Description" String="A set of link settings that a port is configured to use for autonegotiation."/>
589 <Annotation Term="OData.LongDescription" String="This type shall contain a set of link settings that a port is configured to use for autonegotiation."/>
590 <Property Name="ConfiguredLinkSpeedGbps" Type="Edm.Decimal">
591 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
592 <Annotation Term="OData.Description" String="The link speed per lane this port is configured to use for autonegotiation."/>
593 <Annotation Term="OData.LongDescription" String="This property shall contain the network link speed per lane this port is configured to allow for autonegotiation purposes."/>
594 </Property>
595 <Property Name="ConfiguredWidth" Type="Edm.Int64">
596 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
597 <Annotation Term="OData.Description" String="The link width this port is configured to use for autonegotiation in conjunction with the link speed."/>
598 <Annotation Term="OData.LongDescription" String="This property shall contain the network link width this port is configured to use for autonegotiation purposes."/>
599 </Property>
600 </ComplexType>
601 </Schema>
602
Ed Tanouscb103132019-10-08 11:34:22 -0700[diff] [blame]603 </edmx:DataServices>
604</edmx:Edmx>