Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / f263e09c81b798bcf123df8fb144499389e9cbd1 / . / static / redfish / v1 / schema / Port_v1.xml
blob: 83fec042380e1707f5c29875777cb12b2a507765 [file] [log] [blame]
George Liu7da1c582023-02-21 14:38:49 +0800[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Ed Tanousf263e092023-05-22 09:56:29 -0700[diff] [blame^]4<!--# Redfish Schema: Port v1.9.0 -->
George Liu7da1c582023-02-21 14:38:49 +0800[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 -->
Ed Tanousf263e092023-05-22 09:56:29 -0700[diff] [blame^]8<!--# Copyright 2014-2023 DMTF. -->
George Liu7da1c582023-02-21 14:38:49 +0800[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:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
27 </edmx:Reference>
28 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Endpoint_v1.xml">
29 <edmx:Include Namespace="Endpoint"/>
30 </edmx:Reference>
31 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Switch_v1.xml">
32 <edmx:Include Namespace="Switch"/>
33 </edmx:Reference>
34 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Measures.V1.xml">
35 <edmx:Include Namespace="Org.OData.Measures.V1" Alias="Measures"/>
36 </edmx:Reference>
37 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Protocol_v1.xml">
38 <edmx:Include Namespace="Protocol"/>
39 </edmx:Reference>
40 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/PortMetrics_v1.xml">
41 <edmx:Include Namespace="PortMetrics"/>
42 </edmx:Reference>
43 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RouteEntryCollection_v1.xml">
44 <edmx:Include Namespace="RouteEntryCollection"/>
45 </edmx:Reference>
46 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/VCATEntryCollection_v1.xml">
47 <edmx:Include Namespace="VCATEntryCollection"/>
48 </edmx:Reference>
49 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/NetworkDeviceFunction_v1.xml">
50 <edmx:Include Namespace="NetworkDeviceFunction"/>
51 </edmx:Reference>
52 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/EnvironmentMetrics_v1.xml">
53 <edmx:Include Namespace="EnvironmentMetrics"/>
54 </edmx:Reference>
55 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Cable_v1.xml">
56 <edmx:Include Namespace="Cable"/>
57 </edmx:Reference>
58 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/EthernetInterface_v1.xml">
59 <edmx:Include Namespace="EthernetInterface"/>
60 </edmx:Reference>
61
62 <edmx:DataServices>
63
64 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port">
65 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
66
67 <EntityType Name="Port" BaseType="Resource.v1_0_0.Resource" Abstract="true">
68 <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."/>
69 <Annotation Term="OData.LongDescription" String="This resource contains a simple port for a Redfish implementation."/>
70 <Annotation Term="Capabilities.InsertRestrictions">
71 <Record>
72 <PropertyValue Property="Insertable" Bool="false"/>
73 </Record>
74 </Annotation>
75 <Annotation Term="Capabilities.UpdateRestrictions">
76 <Record>
77 <PropertyValue Property="Updatable" Bool="true"/>
78 </Record>
79 </Annotation>
80 <Annotation Term="Capabilities.DeleteRestrictions">
81 <Record>
82 <PropertyValue Property="Deletable" Bool="false"/>
83 </Record>
84 </Annotation>
85 <Annotation Term="Redfish.Uris">
86 <Collection>
87 <String>/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}</String>
88 <String>/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}</String>
89 <String>/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Ports/{PortId}</String>
90 <String>/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}</String>
91 <String>/redfish/v1/Systems/{ComputerSystemId}/GraphicsControllers/{ControllerId}/Ports/{PortId}</String>
92 <String>/redfish/v1/Systems/{ComputerSystemId}/USBControllers/{ControllerId}/Ports/{PortId}</String>
93 <String>/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Ports/{PortId}</String>
94 <String>/redfish/v1/Chassis/{ChassisId}/MediaControllers/{MediaControllerId}/Ports/{PortId}</String>
95 <String>/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}</String>
96 <String>/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Ports/{PortId}</String>
97 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}</String>
98 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Ports/{PortId}</String>
99 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Ports/{PortId}</String>
100 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}</String>
101 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Ports/{PortId}</String>
102 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}</String>
103 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/GraphicsControllers/{ControllerId}/Ports/{PortId}</String>
104 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/USBControllers/{ControllerId}/Ports/{PortId}</String>
105 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Ports/{PortId}</String>
106 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}</String>
107 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Ports/{PortId}</String>
108 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Ports/{PortId}</String>
109 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}</String>
110 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Ports/{PortId}</String>
111 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}</String>
112 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/GraphicsControllers/{ControllerId}/Ports/{PortId}</String>
113 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/USBControllers/{ControllerId}/Ports/{PortId}</String>
114 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Ports/{PortId}</String>
115 <String>/redfish/v1/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}</String>
116 <String>/redfish/v1/Storage/{StorageId}/Controllers/{StorageControllerId}/Ports/{PortId}</String>
117 <String>/redfish/v1/Managers/{ManagerId}/USBPorts/{PortId}</String>
118 <String>/redfish/v1/Managers/{ManagerId}/DedicatedNetworkPorts/{PortId}</String>
119 </Collection>
120 </Annotation>
121 </EntityType>
122
123 <Action Name="Reset" IsBound="true">
124 <Annotation Term="OData.Description" String="This action resets this port."/>
125 <Annotation Term="OData.LongDescription" String="This action shall reset this port."/>
126 <Parameter Name="Port" Type="Port.v1_0_0.Actions"/>
127 <Parameter Name="ResetType" Type="Resource.ResetType">
128 <Annotation Term="OData.Description" String="The type of reset."/>
129 <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."/>
130 </Parameter>
131 </Action>
132
133 <Action Name="ResetPPB" IsBound="true">
134 <Annotation Term="OData.Description" String="This action resets the PCI-to-PCI bridge (PPB) for this port."/>
135 <Annotation Term="OData.LongDescription" String="This action shall reset the PCI-to-PCI bridge (PPB) for this port."/>
136 <Parameter Name="Port" Type="Port.v1_0_0.Actions"/>
137 <Annotation Term="Redfish.Revisions">
138 <Collection>
139 <Record>
140 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
141 <PropertyValue Property="Version" String="v1_8_0"/>
142 </Record>
143 </Collection>
144 </Annotation>
145 </Action>
146 </Schema>
147
148 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_0">
149 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
150 <Annotation Term="Redfish.Release" String="2016.2"/>
151
152 <EntityType Name="Port" BaseType="Port.Port">
153 <Property Name="Status" Type="Resource.Status" Nullable="false">
154 <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
155 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
156 </Property>
157 <Property Name="PortId" Type="Edm.String">
158 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
159 <Annotation Term="OData.Description" String="The label of this port on the physical package for this port."/>
160 <Annotation Term="OData.LongDescription" String="This property shall contain the name of the port as indicated on the device containing the port."/>
161 </Property>
162 <Property Name="PortProtocol" Type="Protocol.Protocol">
163 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
164 <Annotation Term="OData.Description" String="The protocol being sent over this port."/>
165 <Annotation Term="OData.LongDescription" String="This property shall contain the protocol being sent over this port."/>
166 </Property>
167 <Property Name="PortType" Type="Port.v1_0_0.PortType">
168 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
169 <Annotation Term="OData.Description" String="The type of this port."/>
170 <Annotation Term="OData.LongDescription" String="This property shall contain the port type for this port."/>
171 </Property>
172 <Property Name="CurrentSpeedGbps" Type="Edm.Decimal">
173 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
174 <Annotation Term="OData.Description" String="The current speed of this port."/>
175 <Annotation Term="OData.LongDescription" String="This property shall contain the speed of this port currently negotiated and running. This value includes overhead associated with the protocol."/>
176 <Annotation Term="Measures.Unit" String="Gbit/s"/>
177 </Property>
178 <Property Name="MaxSpeedGbps" Type="Edm.Decimal">
179 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
180 <Annotation Term="OData.Description" String="The maximum speed of this port as currently configured."/>
181 <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. This value includes overhead associated with the protocol."/>
182 <Annotation Term="Measures.Unit" String="Gbit/s"/>
183 </Property>
184 <Property Name="Width" Type="Edm.Int64">
185 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
186 <Annotation Term="OData.Description" String="The number of lanes, phys, or other physical transport links that this port contains."/>
187 <Annotation Term="OData.LongDescription" String="This property shall contain the number of physical transport links that this port contains."/>
188 </Property>
189 <Property Name="Links" Type="Port.v1_0_0.Links" Nullable="false">
190 <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/>
191 <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."/>
192 </Property>
193 <Property Name="Actions" Type="Port.v1_0_0.Actions" Nullable="false">
194 <Annotation Term="OData.Description" String="The available actions for this resource."/>
195 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
196 </Property>
197 </EntityType>
198
199 <ComplexType Name="Links" BaseType="Resource.Links">
200 <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/>
201 <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."/>
202 <NavigationProperty Name="AssociatedEndpoints" Type="Collection(Endpoint.Endpoint)">
203 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
204 <Annotation Term="OData.Description" String="An array of links to the endpoints at the other end of the link."/>
205 <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to resources of type Endpoint that represent the endpoints to which this port is connected."/>
206 <Annotation Term="OData.AutoExpandReferences"/>
207 </NavigationProperty>
208 <NavigationProperty Name="ConnectedSwitches" Type="Collection(Switch.Switch)">
209 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
210 <Annotation Term="OData.Description" String="An array of links to the switches at the other end of the link."/>
211 <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to resources of type Switch that represent the switches to which this port is connected."/>
212 <Annotation Term="OData.AutoExpandReferences"/>
213 </NavigationProperty>
214 <NavigationProperty Name="ConnectedSwitchPorts" Type="Collection(Port.Port)">
215 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
216 <Annotation Term="OData.Description" String="An array of links to the switch ports at the other end of the link."/>
217 <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to resources of type Port that represent the switch ports to which this port is connected."/>
218 <Annotation Term="OData.AutoExpandReferences"/>
219 </NavigationProperty>
220 </ComplexType>
221
222 <ComplexType Name="Actions">
223 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
224 <Annotation Term="OData.Description" String="The available actions for this resource."/>
225 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
226 <Property Name="Oem" Type="Port.v1_0_0.OemActions" Nullable="false">
227 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
228 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
229 </Property>
230 </ComplexType>
231
232 <ComplexType Name="OemActions">
233 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
234 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
235 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
236 </ComplexType>
237
238 <EnumType Name="PortType">
239 <Member Name="UpstreamPort">
240 <Annotation Term="OData.Description" String="This port connects to a host device."/>
241 </Member>
242 <Member Name="DownstreamPort">
243 <Annotation Term="OData.Description" String="This port connects to a target device."/>
244 </Member>
245 <Member Name="InterswitchPort">
246 <Annotation Term="OData.Description" String="This port connects to another switch."/>
247 </Member>
248 <Member Name="ManagementPort">
249 <Annotation Term="OData.Description" String="This port connects to a switch manager."/>
250 </Member>
251 <Member Name="BidirectionalPort">
252 <Annotation Term="OData.Description" String="This port connects to any type of device."/>
253 </Member>
254 <Member Name="UnconfiguredPort">
255 <Annotation Term="OData.Description" String="This port has not yet been configured."/>
256 </Member>
257 </EnumType>
258 </Schema>
259
260 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_1">
261 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
262 <Annotation Term="OData.Description" String="This version was created to show that annotations in previous namespaces were updated."/>
263 <EntityType Name="Port" BaseType="Port.v1_0_0.Port"/>
264 </Schema>
265
266 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_2">
267 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
268 <Annotation Term="OData.Description" String="This version was created to remove the Nullable facet on NavigationProperties of the Collection type."/>
269 <EntityType Name="Port" BaseType="Port.v1_0_1.Port"/>
270 </Schema>
271
272 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_3">
273 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
274 <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."/>
275 <EntityType Name="Port" BaseType="Port.v1_0_2.Port"/>
276 </Schema>
277
278 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_4">
279 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
280 <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."/>
281 <EntityType Name="Port" BaseType="Port.v1_0_3.Port"/>
282 </Schema>
283
284 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_5">
285 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
286 <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."/>
287 <EntityType Name="Port" BaseType="Port.v1_0_4.Port"/>
288 </Schema>
289
290 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_6">
291 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
292 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
293 <EntityType Name="Port" BaseType="Port.v1_0_5.Port"/>
294 </Schema>
295
296 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_7">
297 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
298 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
299 <EntityType Name="Port" BaseType="Port.v1_0_6.Port"/>
300 </Schema>
301
302 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_8">
303 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
304 <Annotation Term="OData.Description" String="This version was created specify 64-bit integers in OpenAPI."/>
305 <EntityType Name="Port" BaseType="Port.v1_0_7.Port"/>
306 </Schema>
307
308 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_9">
309 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
310 <Annotation Term="OData.Description" String="Clarified that speed properties include protocol overhead."/>
311 <EntityType Name="Port" BaseType="Port.v1_0_8.Port"/>
312 </Schema>
313
314 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_10">
315 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
316 <Annotation Term="OData.Description" String="This version was created to clarify the usage of the AssociatedEndpoints, ConnectedSwitches, and ConnectedSwitchPorts properties inside of Links."/>
317 <EntityType Name="Port" BaseType="Port.v1_0_9.Port"/>
318 </Schema>
319
320 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_0">
321 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
322 <Annotation Term="Redfish.Release" String="2017.3"/>
323
324 <EntityType Name="Port" BaseType="Port.v1_0_3.Port">
325 <Property Name="Location" Type="Resource.Location" Nullable="false">
326 <Annotation Term="OData.Description" String="The location of the port."/>
327 <Annotation Term="OData.LongDescription" String="This property shall contain location information of the associated port."/>
328 </Property>
329 </EntityType>
330 </Schema>
331
332 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_1">
333 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
334 <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."/>
335 <EntityType Name="Port" BaseType="Port.v1_1_0.Port"/>
336 </Schema>
337
338 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_2">
339 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
340 <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."/>
341 <EntityType Name="Port" BaseType="Port.v1_1_1.Port"/>
342 </Schema>
343
344 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_3">
345 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
346 <Annotation Term="OData.Description" String="This version was created to update descriptions that this schema defines."/>
347 <EntityType Name="Port" BaseType="Port.v1_1_2.Port"/>
348 </Schema>
349
350 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_4">
351 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
352 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
353 <EntityType Name="Port" BaseType="Port.v1_1_3.Port"/>
354 </Schema>
355
356 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_5">
357 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
358 <Annotation Term="OData.Description" String="This version was created specify 64-bit integers in OpenAPI."/>
359 <EntityType Name="Port" BaseType="Port.v1_1_4.Port"/>
360 </Schema>
361
362 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_6">
363 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
364 <Annotation Term="OData.Description" String="Clarified that speed properties include protocol overhead."/>
365 <EntityType Name="Port" BaseType="Port.v1_1_5.Port"/>
366 </Schema>
367
368 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_7">
369 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
370 <Annotation Term="OData.Description" String="This version was created to clarify the usage of the AssociatedEndpoints, ConnectedSwitches, and ConnectedSwitchPorts properties inside of Links."/>
371 <EntityType Name="Port" BaseType="Port.v1_1_6.Port"/>
372 </Schema>
373
374 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_2_0">
375 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
376 <Annotation Term="Redfish.Release" String="2019.4"/>
377
378 <EntityType Name="Port" BaseType="Port.v1_1_3.Port">
379 <Property Name="PortMedium" Type="Port.v1_2_0.PortMedium">
380 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
381 <Annotation Term="OData.Description" String="The physical connection medium for this port."/>
382 <Annotation Term="OData.LongDescription" String="This property shall contain the physical connection medium for this port."/>
383 </Property>
384 <Property Name="LinkNetworkTechnology" Type="Port.v1_2_0.LinkNetworkTechnology">
385 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
386 <Annotation Term="OData.Description" String="The link network technology capabilities of this port."/>
387 <Annotation Term="OData.LongDescription" String="This property shall contain a network technology capability of this port."/>
388 </Property>
389 <Property Name="InterfaceEnabled" Type="Edm.Boolean">
390 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
391 <Annotation Term="OData.Description" String="An indication of whether the interface is enabled."/>
392 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the interface is enabled."/>
393 </Property>
394 <Property Name="SignalDetected" Type="Edm.Boolean">
395 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
396 <Annotation Term="OData.Description" String="An indication of whether a signal is detected on this interface."/>
397 <Annotation Term="OData.LongDescription" String="This property shall indicate whether a signal that is appropriate for this link technology is detected for this port."/>
398 </Property>
399 <Property Name="LinkTransitionIndicator" Type="Edm.Int64" Nullable="false">
400 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
401 <Annotation Term="OData.Description" String="The number of link state transitions for this interface."/>
402 <Annotation Term="OData.LongDescription" String="This property shall contain the number of link state transitions for this interface."/>
403 </Property>
404 <Property Name="ActiveWidth" Type="Edm.Int64" Nullable="false">
405 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
406 <Annotation Term="OData.Description" String="The number of active lanes for this interface."/>
407 <Annotation Term="OData.LongDescription" String="This property shall contain the number of active lanes for this interface."/>
408 </Property>
409 <Property Name="LinkState" Type="Port.v1_2_0.LinkState" Nullable="false">
410 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
411 <Annotation Term="OData.Description" String="The desired link state for this interface."/>
412 <Annotation Term="OData.LongDescription" String="This property shall contain the desired link state for this interface."/>
413 </Property>
414 <Property Name="LinkStatus" Type="Port.v1_2_0.LinkStatus" Nullable="false">
415 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
416 <Annotation Term="OData.Description" String="The link status for this interface."/>
417 <Annotation Term="OData.LongDescription" String="This property shall contain the link status for this interface."/>
418 </Property>
419 <Property Name="GenZ" Type="Port.v1_2_0.GenZ" Nullable="false">
420 <Annotation Term="OData.Description" String="Gen-Z specific properties."/>
421 <Annotation Term="OData.LongDescription" String="This property shall contain Gen-Z specific properties for this interface."/>
422 </Property>
423 <NavigationProperty Name="Metrics" Type="PortMetrics.PortMetrics">
424 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
425 <Annotation Term="OData.Description" String="The link to the metrics associated with this port."/>
426 <Annotation Term="OData.LongDescription" String="This property shall contain a link to the metrics associated with this port."/>
427 <Annotation Term="OData.AutoExpandReferences"/>
428 </NavigationProperty>
429 </EntityType>
430
431 <ComplexType Name="GenZ">
432 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
433 <Annotation Term="OData.Description" String="This type defines Gen-Z specific port properties."/>
434 <Annotation Term="OData.LongDescription" String="This type shall contain Gen-Z specific port properties."/>
435 <NavigationProperty Name="LPRT" Type="RouteEntryCollection.RouteEntryCollection" Nullable="false">
436 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
437 <Annotation Term="OData.Description" String="The Linear Packet Relay Table for the port."/>
438 <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."/>
439 <Annotation Term="OData.AutoExpandReferences"/>
440 </NavigationProperty>
441 <NavigationProperty Name="MPRT" Type="RouteEntryCollection.RouteEntryCollection" Nullable="false">
442 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
443 <Annotation Term="OData.Description" String="the Multi-subnet Packet Relay Table for the port."/>
444 <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."/>
445 <Annotation Term="OData.AutoExpandReferences"/>
446 </NavigationProperty>
447 <NavigationProperty Name="VCAT" Type="VCATEntryCollection.VCATEntryCollection" Nullable="false">
448 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
449 <Annotation Term="OData.Description" String="the Virtual Channel Action Table for the port."/>
450 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type VCATEntryCollection."/>
451 <Annotation Term="OData.AutoExpandReferences"/>
452 </NavigationProperty>
453 </ComplexType>
454
455 <ComplexType Name="Links" BaseType="Port.v1_0_0.Links">
456 <NavigationProperty Name="ConnectedPorts" Type="Collection(Port.Port)">
457 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
458 <Annotation Term="OData.Description" String="An array of links to the remote device ports at the other end of the link."/>
459 <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to resources of type Port that represent the remote device ports to which this port is connected."/>
460 <Annotation Term="OData.AutoExpandReferences"/>
461 </NavigationProperty>
462 </ComplexType>
463
464 <EnumType Name="PortMedium">
465 <Member Name="Electrical">
466 <Annotation Term="OData.Description" String="This port has an electrical cable connection."/>
467 </Member>
468 <Member Name="Optical">
469 <Annotation Term="OData.Description" String="This port has an optical cable connection."/>
470 </Member>
471 </EnumType>
472
473 <EnumType Name="LinkState">
474 <Member Name="Enabled">
475 <Annotation Term="OData.Description" String="This link is enabled."/>
476 </Member>
477 <Member Name="Disabled">
478 <Annotation Term="OData.Description" String="This link is disabled."/>
479 </Member>
480 </EnumType>
481
482 <EnumType Name="LinkStatus">
483 <Member Name="LinkUp">
484 <Annotation Term="OData.Description" String="This link on this interface is up."/>
485 </Member>
486 <Member Name="Starting">
487 <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."/>
488 </Member>
489 <Member Name="Training">
490 <Annotation Term="OData.Description" String="This physical link on this interface is training."/>
491 </Member>
492 <Member Name="LinkDown">
493 <Annotation Term="OData.Description" String="The link on this interface is down."/>
494 </Member>
495 <Member Name="NoLink">
496 <Annotation Term="OData.Description" String="No physical link detected on this interface."/>
497 </Member>
498 </EnumType>
499
500 <EnumType Name="LinkNetworkTechnology">
501 <Member Name="Ethernet">
502 <Annotation Term="OData.Description" String="The port is capable of connecting to an Ethernet network."/>
503 </Member>
504 <Member Name="InfiniBand">
505 <Annotation Term="OData.Description" String="The port is capable of connecting to an InfiniBand network."/>
506 </Member>
507 <Member Name="FibreChannel">
508 <Annotation Term="OData.Description" String="The port is capable of connecting to a Fibre Channel network."/>
509 </Member>
510 <Member Name="GenZ">
511 <Annotation Term="OData.Description" String="The port is capable of connecting to a Gen-Z fabric."/>
512 </Member>
513 <Member Name="PCIe">
514 <Annotation Term="OData.Description" String="The port is capable of connecting to PCIe and CXL fabrics."/>
515 <Annotation Term="Redfish.Revisions">
516 <Collection>
517 <Record>
518 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
519 <PropertyValue Property="Version" String="v1_8_0"/>
520 </Record>
521 </Collection>
522 </Annotation>
523 </Member>
524 </EnumType>
525 </Schema>
526
527 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_2_1">
528 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
529 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
530 <EntityType Name="Port" BaseType="Port.v1_2_0.Port"/>
531 </Schema>
532
533 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_2_2">
534 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
535 <Annotation Term="OData.Description" String="This version was created to clarify the descriptions for the values of LinkStatus."/>
536 <EntityType Name="Port" BaseType="Port.v1_2_1.Port"/>
537 </Schema>
538
539 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_2_3">
540 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
541 <Annotation Term="OData.Description" String="This version was created specify 64-bit integers in OpenAPI."/>
542 <EntityType Name="Port" BaseType="Port.v1_2_2.Port"/>
543 </Schema>
544
545 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_2_4">
546 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
547 <Annotation Term="OData.Description" String="Clarified that speed properties include protocol overhead."/>
548 <EntityType Name="Port" BaseType="Port.v1_2_3.Port"/>
549 </Schema>
550
551 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_2_5">
552 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
553 <Annotation Term="OData.Description" String="This version was created to correct the permissions for LinkStatus."/>
554 <EntityType Name="Port" BaseType="Port.v1_2_4.Port"/>
555 </Schema>
556
557 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_2_6">
558 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
559 <Annotation Term="OData.Description" String="This version was created to clarify the usage of the AssociatedEndpoints, ConnectedSwitches, ConnectedSwitchPorts, and ConnectedPorts properties inside of Links."/>
560 <EntityType Name="Port" BaseType="Port.v1_2_5.Port"/>
561 </Schema>
562
563 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_3_0">
564 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
565 <Annotation Term="Redfish.Release" String="2020.3"/>
566
567 <EntityType Name="Port" BaseType="Port.v1_2_2.Port">
568 <Property Name="LocationIndicatorActive" Type="Edm.Boolean">
569 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
570 <Annotation Term="OData.Description" String="An indicator allowing an operator to physically locate this resource."/>
571 <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."/>
572 </Property>
573 <Property Name="MaxFrameSize" Type="Edm.Int64">
574 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
575 <Annotation Term="OData.Description" String="The maximum frame size supported by the port."/>
576 <Annotation Term="OData.LongDescription" String="This property shall contain the maximum frame size supported by the port."/>
577 <Annotation Term="Measures.Unit" String="By"/>
578 </Property>
579 <Property Name="LinkConfiguration" Type="Collection(Port.v1_3_0.LinkConfiguration)" Nullable="false">
580 <Annotation Term="OData.Description" String="The link configuration of this port."/>
581 <Annotation Term="OData.LongDescription" String="This property shall contain the static capabilities and configuration settings of the port."/>
582 </Property>
583 <Property Name="FibreChannel" Type="Port.v1_3_0.FibreChannelProperties">
584 <Annotation Term="OData.Description" String="Fibre Channel properties for this port."/>
585 <Annotation Term="OData.LongDescription" String="This property shall contain Fibre Channel-specific properties of the port."/>
586 </Property>
587 <Property Name="Ethernet" Type="Port.v1_3_0.EthernetProperties">
588 <Annotation Term="OData.Description" String="Ethernet properties for this port."/>
589 <Annotation Term="OData.LongDescription" String="This property shall contain Ethernet-specific properties of the port."/>
590 </Property>
591 </EntityType>
592
593 <ComplexType Name="FibreChannelProperties">
594 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
595 <Annotation Term="OData.Description" String="Fibre Channel-specific properties for a port."/>
596 <Annotation Term="OData.LongDescription" String="This type shall contain Fibre Channel-specific properties for a port."/>
597 <Property Name="PortConnectionType" Type="Port.v1_3_0.PortConnectionType">
598 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
599 <Annotation Term="OData.Description" String="The connection type of this port."/>
600 <Annotation Term="OData.LongDescription" String="This property shall contain the connection type for this port."/>
601 </Property>
602 <Property Name="NumberDiscoveredRemotePorts" Type="Edm.Int64">
603 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
604 <Annotation Term="OData.Description" String="The number of ports not on the associated device that the associated device has discovered through this port."/>
605 <Annotation Term="OData.LongDescription" String="This property shall contain the number of ports not on this associated device that this port has discovered."/>
606 </Property>
607 <Property Name="FabricName" Type="Edm.String">
608 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
609 <Annotation Term="OData.Description" String="The Fibre Channel Fabric Name provided by the switch."/>
610 <Annotation Term="OData.LongDescription" String="This property shall indicate the Fibre Channel Fabric Name provided by the switch."/>
611 </Property>
612 </ComplexType>
613
614 <ComplexType Name="EthernetProperties">
615 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
616 <Annotation Term="OData.Description" String="Ethernet-specific properties for a port."/>
617 <Annotation Term="OData.LongDescription" String="This type shall contain Ethernet-specific properties for a port."/>
618 <Property Name="SupportedEthernetCapabilities" Type="Collection(Port.v1_3_0.SupportedEthernetCapabilities)">
619 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
620 <Annotation Term="OData.Description" String="The set of Ethernet capabilities that this port supports."/>
621 <Annotation Term="OData.LongDescription" String="This property shall contain an array of Ethernet capabilities supported by this port."/>
622 <Annotation Term="Redfish.Revisions">
623 <Collection>
624 <Record>
625 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Deprecated"/>
626 <PropertyValue Property="Version" String="v1_5_0"/>
627 <PropertyValue Property="Description" String="This property has been deprecated in favor of individual fields for the various properties."/>
628 </Record>
629 </Collection>
630 </Annotation>
631 </Property>
632 <Property Name="FlowControlStatus" Type="Port.v1_3_0.FlowControl">
633 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
634 <Annotation Term="OData.Description" String="The 802.3x flow control behavior negotiated with the link partner for this port."/>
635 <Annotation Term="OData.LongDescription" String="This property shall contain the 802.3x flow control behavior negotiated with the link partner for this port."/>
636 </Property>
637 <Property Name="FlowControlConfiguration" Type="Port.v1_3_0.FlowControl">
638 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
639 <Annotation Term="OData.Description" String="The locally configured 802.3x flow control setting for this port."/>
640 <Annotation Term="OData.LongDescription" String="This property shall contain the locally configured 802.3x flow control setting for this port."/>
641 </Property>
642 </ComplexType>
643
644 <EnumType Name="PortConnectionType">
645 <Member Name="NotConnected">
646 <Annotation Term="OData.Description" String="This port is not connected."/>
647 </Member>
648 <Member Name="NPort">
649 <Annotation Term="OData.Description" String="This port connects through an N-Port to a switch."/>
650 </Member>
651 <Member Name="PointToPoint">
652 <Annotation Term="OData.Description" String="This port connects in a Point-to-point configuration."/>
653 </Member>
654 <Member Name="PrivateLoop">
655 <Annotation Term="OData.Description" String="This port connects in a private loop configuration."/>
656 </Member>
657 <Member Name="PublicLoop">
658 <Annotation Term="OData.Description" String="This port connects in a public configuration."/>
659 </Member>
660 <Member Name="Generic">
661 <Annotation Term="OData.Description" String="This port connection type is a generic fabric port."/>
662 </Member>
663 <Member Name="ExtenderFabric">
664 <Annotation Term="OData.Description" String="This port connection type is an extender fabric port."/>
665 </Member>
666 <Member Name="FPort">
667 <Annotation Term="OData.Description" String="This port connection type is a fabric port."/>
668 <Annotation Term="Redfish.Revisions">
669 <Collection>
670 <Record>
671 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
672 <PropertyValue Property="Version" String="v1_5_0"/>
673 </Record>
674 </Collection>
675 </Annotation>
676 </Member>
677 <Member Name="EPort">
678 <Annotation Term="OData.Description" String="This port connection type is an extender fabric port."/>
679 <Annotation Term="Redfish.Revisions">
680 <Collection>
681 <Record>
682 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
683 <PropertyValue Property="Version" String="v1_5_0"/>
684 </Record>
685 </Collection>
686 </Annotation>
687 </Member>
688 <Member Name="TEPort">
689 <Annotation Term="OData.Description" String="This port connection type is an trunking extender fabric port."/>
690 <Annotation Term="Redfish.Revisions">
691 <Collection>
692 <Record>
693 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
694 <PropertyValue Property="Version" String="v1_5_0"/>
695 </Record>
696 </Collection>
697 </Annotation>
698 </Member>
699 <Member Name="NPPort">
700 <Annotation Term="OData.Description" String="This port connection type is a proxy N port for N-Port virtualization."/>
701 <Annotation Term="Redfish.Revisions">
702 <Collection>
703 <Record>
704 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
705 <PropertyValue Property="Version" String="v1_5_0"/>
706 </Record>
707 </Collection>
708 </Annotation>
709 </Member>
710 <Member Name="GPort">
711 <Annotation Term="OData.Description" String="This port connection type is a generic fabric port."/>
712 <Annotation Term="Redfish.Revisions">
713 <Collection>
714 <Record>
715 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
716 <PropertyValue Property="Version" String="v1_5_0"/>
717 </Record>
718 </Collection>
719 </Annotation>
720 </Member>
721 <Member Name="NLPort">
722 <Annotation Term="OData.Description" String="This port connects in a node loop configuration."/>
723 <Annotation Term="Redfish.Revisions">
724 <Collection>
725 <Record>
726 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
727 <PropertyValue Property="Version" String="v1_5_0"/>
728 </Record>
729 </Collection>
730 </Annotation>
731 </Member>
732 <Member Name="FLPort">
733 <Annotation Term="OData.Description" String="This port connects in a fabric loop configuration."/>
734 <Annotation Term="Redfish.Revisions">
735 <Collection>
736 <Record>
737 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
738 <PropertyValue Property="Version" String="v1_5_0"/>
739 </Record>
740 </Collection>
741 </Annotation>
742 </Member>
743 <Member Name="EXPort">
744 <Annotation Term="OData.Description" String="This port connection type is an external fabric port."/>
745 <Annotation Term="Redfish.Revisions">
746 <Collection>
747 <Record>
748 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
749 <PropertyValue Property="Version" String="v1_5_0"/>
750 </Record>
751 </Collection>
752 </Annotation>
753 </Member>
754 <Member Name="UPort">
755 <Annotation Term="OData.Description" String="This port connection type is unassigned."/>
756 <Annotation Term="Redfish.Revisions">
757 <Collection>
758 <Record>
759 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
760 <PropertyValue Property="Version" String="v1_5_0"/>
761 </Record>
762 </Collection>
763 </Annotation>
764 </Member>
765 <Member Name="DPort">
766 <Annotation Term="OData.Description" String="This port connection type is a diagnostic port."/>
767 <Annotation Term="Redfish.Revisions">
768 <Collection>
769 <Record>
770 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
771 <PropertyValue Property="Version" String="v1_5_0"/>
772 </Record>
773 </Collection>
774 </Annotation>
775 </Member>
776 </EnumType>
777
778 <EnumType Name="SupportedEthernetCapabilities">
779 <Member Name="WakeOnLAN">
780 <Annotation Term="OData.Description" String="Wake on LAN (WoL) is supported on this port."/>
781 </Member>
782 <Member Name="EEE">
783 <Annotation Term="OData.Description" String="IEEE 802.3az Energy-Efficient Ethernet (EEE) is supported on this port."/>
784 </Member>
785 </EnumType>
786
787 <EnumType Name="FlowControl">
788 <Member Name="None">
789 <Annotation Term="OData.Description" String="No IEEE 802.3x flow control is enabled on this port."/>
790 </Member>
791 <Member Name="TX">
792 <Annotation Term="OData.Description" String="IEEE 802.3x flow control may be initiated by this station."/>
793 </Member>
794 <Member Name="RX">
795 <Annotation Term="OData.Description" String="IEEE 802.3x flow control may be initiated by the link partner."/>
796 </Member>
797 <Member Name="TX_RX">
798 <Annotation Term="OData.Description" String="IEEE 802.3x flow control may be initiated by this station or the link partner."/>
799 </Member>
800 </EnumType>
801
802 <ComplexType Name="LinkConfiguration">
803 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
804 <Annotation Term="OData.Description" String="Properties of the link for which this port is configured."/>
805 <Annotation Term="OData.LongDescription" String="This type shall contain properties of the link for which port has been configured."/>
806 <Property Name="CapableLinkSpeedGbps" Type="Collection(Edm.Decimal)">
807 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
808 <Annotation Term="OData.Description" String="The set of link speed capabilities of this port."/>
809 <Annotation Term="OData.LongDescription" String="This property shall contain all of the possible network link speed capabilities of this port. This value includes overhead associated with the protocol."/>
810 <Annotation Term="Measures.Unit" String="Gbit/s"/>
811 </Property>
812 <Property Name="ConfiguredNetworkLinks" Type="Collection(Port.v1_3_0.ConfiguredNetworkLink)">
813 <Annotation Term="OData.Description" String="The set of link speed and width pairs this port is configured to use for autonegotiation."/>
814 <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."/>
815 </Property>
816 <Property Name="AutoSpeedNegotiationCapable" Type="Edm.Boolean">
817 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
818 <Annotation Term="OData.Description" String="An indication of whether the port is capable of autonegotiating speed."/>
819 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the port is capable of autonegotiating speed."/>
820 </Property>
821 <Property Name="AutoSpeedNegotiationEnabled" Type="Edm.Boolean">
822 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
823 <Annotation Term="OData.Description" String="Controls whether this port is configured to enable autonegotiating speed."/>
824 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the port is configured to autonegotiate speed."/>
825 </Property>
826 </ComplexType>
827
828 <ComplexType Name="ConfiguredNetworkLink">
829 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
830 <Annotation Term="OData.Description" String="A set of link settings that a port is configured to use for autonegotiation."/>
831 <Annotation Term="OData.LongDescription" String="This type shall contain a set of link settings that a port is configured to use for autonegotiation."/>
832 <Property Name="ConfiguredLinkSpeedGbps" Type="Edm.Decimal">
833 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
834 <Annotation Term="OData.Description" String="The link speed per lane this port is configured to use for autonegotiation."/>
835 <Annotation Term="OData.LongDescription" String="This property shall contain the network link speed per lane this port is configured to allow for autonegotiation purposes. This value includes overhead associated with the protocol."/>
836 <Annotation Term="Measures.Unit" String="Gbit/s"/>
837 </Property>
838 <Property Name="ConfiguredWidth" Type="Edm.Int64">
839 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
840 <Annotation Term="OData.Description" String="The link width this port is configured to use for autonegotiation in conjunction with the link speed."/>
841 <Annotation Term="OData.LongDescription" String="This property shall contain the network link width this port is configured to use for autonegotiation purposes."/>
842 </Property>
843 </ComplexType>
844 </Schema>
845
846 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_3_1">
847 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
848 <Annotation Term="OData.Description" String="This version was created specify 64-bit integers in OpenAPI."/>
849 <EntityType Name="Port" BaseType="Port.v1_3_0.Port"/>
850 </Schema>
851
852 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_3_2">
853 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
854 <Annotation Term="OData.Description" String="Clarified that speed properties include protocol overhead."/>
855 <EntityType Name="Port" BaseType="Port.v1_3_1.Port"/>
856 </Schema>
857
858 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_3_3">
859 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
860 <Annotation Term="OData.Description" String="This version was created to correct the permissions for LinkStatus."/>
861 <EntityType Name="Port" BaseType="Port.v1_3_2.Port"/>
862 </Schema>
863
864 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_3_4">
865 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
866 <Annotation Term="OData.Description" String="This version was created to clarify the usage of the AssociatedEndpoints, ConnectedSwitches, ConnectedSwitchPorts, and ConnectedPorts properties inside of Links."/>
867 <EntityType Name="Port" BaseType="Port.v1_3_3.Port"/>
868 </Schema>
869
870 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_4_0">
871 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
872 <Annotation Term="Redfish.Release" String="2021.1"/>
873
874 <EntityType Name="Port" BaseType="Port.v1_3_2.Port">
875 <Property Name="FunctionMinBandwidth" Type="Collection(Port.v1_4_0.FunctionMinBandwidth)" Nullable="false">
876 <Annotation Term="OData.Description" String="An array of minimum bandwidth allocation percentages for the functions associated with this port."/>
877 <Annotation Term="OData.LongDescription" String="This property shall contain an array of minimum bandwidth percentage allocations for each of the functions associated with this port."/>
878 </Property>
879 <Property Name="FunctionMaxBandwidth" Type="Collection(Port.v1_4_0.FunctionMaxBandwidth)" Nullable="false">
880 <Annotation Term="OData.Description" String="An array of maximum bandwidth allocation percentages for the functions associated with this port."/>
881 <Annotation Term="OData.LongDescription" String="This property shall contain an array of maximum bandwidth allocation percentages for the functions associated with this port."/>
882 </Property>
883 <Property Name="SFP" Type="Port.v1_4_0.SFP">
884 <Annotation Term="OData.Description" String="The small form-factor pluggable (SFP) device associated with this port."/>
885 <Annotation Term="OData.LongDescription" String="This property shall contain data about the small form-factor pluggable (SFP) device currently occupying this port."/>
886 </Property>
887 <NavigationProperty Name="EnvironmentMetrics" Type="EnvironmentMetrics.EnvironmentMetrics" Nullable="false">
888 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
889 <Annotation Term="OData.Description" String="The link to the environment metrics for this port or any attached small form-factor pluggable (SFP) device."/>
890 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type EnvironmentMetrics that represents the environment metrics for this port or any attached small form-factor pluggable (SFP) device."/>
891 <Annotation Term="OData.AutoExpandReferences"/>
892 </NavigationProperty>
893 <Property Name="CurrentProtocolVersion" Type="Edm.String">
894 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
895 <Annotation Term="OData.Description" String="The protocol version being sent over this port."/>
896 <Annotation Term="OData.LongDescription" String="This property shall contain the protocol version being sent over this port. This property should only be used for protocols where the version and not the speed is of primary interest such as USB, DisplayPort, or HDMI."/>
897 </Property>
898 <Property Name="CapableProtocolVersions" Type="Collection(Edm.String)">
899 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
900 <Annotation Term="OData.Description" String="The protocol versions capable of being sent over this port."/>
901 <Annotation Term="OData.LongDescription" String="This property shall contain the protocol versions capable of being sent over this port. This property should only be used for protocols where the version and not the speed is of primary interest such as USB, DisplayPort, or HDMI."/>
902 </Property>
903 <Property Name="Enabled" Type="Edm.Boolean" Nullable="false">
904 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
905 <Annotation Term="OData.Description" String="An indication of whether this port is enabled."/>
906 <Annotation Term="OData.LongDescription" String="The value of this property shall indicate if this port is enabled. Disabling a port will disconnect any devices only connected to the system through this port."/>
907 </Property>
908 </EntityType>
909
910 <ComplexType Name="FunctionMinBandwidth">
911 <Annotation Term="OData.Description" String="A minimum bandwidth allocation percentage for a network device functions associated a port."/>
912 <Annotation Term="OData.LongDescription" String="This type shall describe a minimum bandwidth percentage allocation for a network device function associated with a port."/>
913 <NavigationProperty Name="NetworkDeviceFunction" Type="NetworkDeviceFunction.NetworkDeviceFunction" Nullable="false">
914 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
915 <Annotation Term="OData.Description" String="The link to the network device function associated with this bandwidth setting of this network port."/>
916 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type NetworkDeviceFunction that represents the network device function associated with this bandwidth setting of this network port."/>
917 <Annotation Term="OData.AutoExpandReferences"/>
918 </NavigationProperty>
919 <Property Name="AllocationPercent" Type="Edm.Int64">
920 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
921 <Annotation Term="OData.Description" String="The minimum bandwidth allocation percentage allocated to the corresponding network device function instance."/>
922 <Annotation Term="OData.LongDescription" String="This property shall contain the minimum bandwidth percentage allocation for the associated network device function. The sum total of all minimum percentages shall not exceed 100."/>
923 <Annotation Term="Measures.Unit" String="%"/>
924 </Property>
925 </ComplexType>
926
927 <ComplexType Name="FunctionMaxBandwidth">
928 <Annotation Term="OData.Description" String="A maximum bandwidth allocation percentage for a network device functions associated a port."/>
929 <Annotation Term="OData.LongDescription" String="This type shall describe a maximum bandwidth percentage allocation for a network device function associated with a port."/>
930 <NavigationProperty Name="NetworkDeviceFunction" Type="NetworkDeviceFunction.NetworkDeviceFunction" Nullable="false">
931 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
932 <Annotation Term="OData.Description" String="The link to the network device function associated with this bandwidth setting of this network port."/>
933 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type NetworkDeviceFunction that represents the network device function associated with this bandwidth setting of this network port."/>
934 <Annotation Term="OData.AutoExpandReferences"/>
935 </NavigationProperty>
936 <Property Name="AllocationPercent" Type="Edm.Int64">
937 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
938 <Annotation Term="OData.Description" String="The maximum bandwidth allocation percentage allocated to the corresponding network device function instance."/>
939 <Annotation Term="OData.LongDescription" String="This property shall contain the maximum bandwidth percentage allocation for the associated network device function."/>
940 <Annotation Term="Measures.Unit" String="%"/>
941 </Property>
942 </ComplexType>
943
944 <ComplexType Name="EthernetProperties" BaseType="Port.v1_3_0.EthernetProperties">
945 <Property Name="AssociatedMACAddresses" Type="Collection(Edm.String)">
946 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
947 <Annotation Term="Validation.Pattern" String="^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$"/>
948 <Annotation Term="OData.Description" String="An array of configured MAC addresses that are associated with this network port, including the programmed address of the lowest numbered network device function, the configured but not active address, if applicable, the address for hardware port teaming, or other network addresses."/>
949 <Annotation Term="OData.LongDescription" String="This property shall contain an array of configured MAC addresses that are associated with this network port, including the programmed address of the lowest numbered network device function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses."/>
950 </Property>
951 <Property Name="LLDPEnabled" Type="Edm.Boolean" Nullable="false">
952 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
953 <Annotation Term="OData.Description" String="Enable/disable LLDP for this port."/>
954 <Annotation Term="OData.LongDescription" String="This property shall contain the state indicating whether to enable LLDP for a port. If LLDP is disabled at the adapter level, this property shall be ignored."/>
955 </Property>
956 <Property Name="LLDPTransmit" Type="Port.v1_4_0.LLDPTransmit">
957 <Annotation Term="OData.Description" String="LLDP data being transmitted on this link."/>
958 <Annotation Term="OData.LongDescription" String="This property shall contain the LLDP data being transmitted on this link."/>
959 </Property>
960 <Property Name="LLDPReceive" Type="Port.v1_4_0.LLDPReceive">
961 <Annotation Term="OData.Description" String="LLDP data being received on this link."/>
962 <Annotation Term="OData.LongDescription" String="This property shall contain the LLDP data being received on this link."/>
963 </Property>
964 </ComplexType>
965
966 <ComplexType Name="FibreChannelProperties" BaseType="Port.v1_3_0.FibreChannelProperties">
967 <Property Name="AssociatedWorldWideNames" Type="Collection(Edm.String)">
968 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
969 <Annotation Term="OData.Description" String="An array of configured World Wide Names (WWN) that are associated with this network port, including the programmed address of the lowest numbered network device function, the configured but not active address, if applicable, the address for hardware port teaming, or other network addresses."/>
970 <Annotation Term="OData.LongDescription" String="This property shall contain an array of configured World Wide Names (WWN) that are associated with this network port, including the programmed address of the lowest numbered network device function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses."/>
971 <Annotation Term="Validation.Pattern" String="^([0-9A-Fa-f]{2}[:-]){7}([0-9A-Fa-f]{2})$"/>
972 </Property>
973 </ComplexType>
974
975 <ComplexType Name="LLDPTransmit">
976 <Annotation Term="OData.Description" String="Link Layer Data Protocol (LLDP) data being transmitted on this link."/>
977 <Annotation Term="OData.LongDescription" String="This type shall contain the LLDP data to be transmitted from this endpoint."/>
978 <Property Name="ChassisId" Type="Edm.String">
979 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
980 <Annotation Term="OData.Description" String="Link Layer Data Protocol (LLDP) chassis ID."/>
981 <Annotation Term="OData.LongDescription" String="This property shall contain the chassis ID to be transmitted from this endpoint. If no such chassis ID is to be transmitted, this value shall be an empty string."/>
982 </Property>
983 <Property Name="ChassisIdSubtype" Type="Port.v1_4_0.IEEE802IdSubtype">
984 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
985 <Annotation Term="OData.Description" String="The type of identifier used for the chassis ID."/>
986 <Annotation Term="OData.LongDescription" String="This property shall contain the IEEE 802.1AB-2009 chassis ID subtype to be transmitted from this endpoint. If no such chassis ID subtype is to be transmitted, this value shall be `NotTransmitted`."/>
987 </Property>
988 <Property Name="ManagementVlanId" Type="Edm.Int64">
989 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
990 <Annotation Term="Validation.Minimum" Int="0"/>
991 <Annotation Term="Validation.Maximum" Int="4095"/>
992 <Annotation Term="OData.Description" String="The management VLAN ID to be transmitted from this endpoint."/>
993 <Annotation Term="OData.LongDescription" String="This property shall contain the management VLAN ID to be transmitted from this endpoint. If no such port ID is to be transmitted, this value shall be `4095`."/>
994 </Property>
995 <Property Name="ManagementAddressIPv4" Type="Edm.String">
996 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
997 <Annotation Term="OData.Description" String="The IPv4 management address to be transmitted from this endpoint."/>
998 <Annotation Term="OData.LongDescription" String="This property shall contain the IPv4 management address to be transmitted from this endpoint. If no such management address is to be transmitted, this value shall be an empty string."/>
999 <Annotation Term="Validation.Pattern" String="(^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$)|(^$)"/>
1000 </Property>
1001 <Property Name="ManagementAddressIPv6" Type="Edm.String">
1002 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1003 <Annotation Term="OData.Description" String="The IPv6 management address to be transmitted from this endpoint."/>
1004 <Annotation Term="OData.LongDescription" String="This property shall contain the IPv6 management address to be transmitted from this endpoint. If no such management address is to be transmitted, this value shall be an empty string."/>
1005 </Property>
1006 <Property Name="ManagementAddressMAC" Type="Edm.String">
1007 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1008 <Annotation Term="Validation.Pattern" String="(^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$)|(^$)"/>
1009 <Annotation Term="OData.Description" String="The management MAC address to be transmitted from this endpoint."/>
1010 <Annotation Term="OData.LongDescription" String="This property shall contain the management MAC address to be transmitted from this endpoint. If no such management address is to be transmitted, this value shall be an empty string."/>
1011 </Property>
1012 <Property Name="PortId" Type="Edm.String">
1013 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1014 <Annotation Term="Validation.Pattern" String="(^([0-9A-F]{2})([:]([0-9A-F]){2}){0,63}$)|(^$)"/>
1015 <Annotation Term="OData.Description" String="A colon delimited string of hexadecimal octets identifying a port to be transmitted from this endpoint."/>
1016 <Annotation Term="OData.LongDescription" String="This property shall contain a colon delimited string of hexadecimal octets identifying the port for an LLDP endpoint. If no such port ID is to be transmitted, this value shall be an empty string."/>
1017 </Property>
1018 <Property Name="PortIdSubtype" Type="Port.v1_4_0.IEEE802IdSubtype">
1019 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1020 <Annotation Term="OData.Description" String="The port ID subtype to be transmitted from this endpoint."/>
1021 <Annotation Term="OData.LongDescription" String="This property shall contain the port ID subtype from IEEE 802.1AB-2009 Table 8-3 to be transmitted from this endpoint. If no such port ID subtype is to be transmitted, this value shall be `NotTransmitted`."/>
1022 </Property>
1023 </ComplexType>
1024
1025 <ComplexType Name="LLDPReceive">
1026 <Annotation Term="OData.Description" String="Link Layer Data Protocol (LLDP) data received from the remote partner across this link."/>
1027 <Annotation Term="OData.LongDescription" String="This type shall contain the LLDP data from the remote partner across this link."/>
1028 <Property Name="ChassisId" Type="Edm.String">
1029 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1030 <Annotation Term="OData.Description" String="Link Layer Data Protocol (LLDP) chassis ID received from the remote partner across this link."/>
1031 <Annotation Term="OData.LongDescription" String="This property shall contain the chassis ID received from the remote partner across this link. If no such chassis ID has been received, this property should not be present."/>
1032 </Property>
1033 <Property Name="ChassisIdSubtype" Type="Port.v1_4_0.IEEE802IdSubtype">
1034 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1035 <Annotation Term="OData.Description" String="The type of identifier used for the chassis ID received from the remote partner across this link."/>
1036 <Annotation Term="OData.LongDescription" String="This property shall contain the IEEE 802.1AB-2009 chassis ID subtype received from the remote partner across this link. If no such chassis ID subtype has been received, this property should not be present."/>
1037 </Property>
1038 <Property Name="ManagementVlanId" Type="Edm.Int64">
1039 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1040 <Annotation Term="Validation.Minimum" Int="0"/>
1041 <Annotation Term="Validation.Maximum" Int="4095"/>
1042 <Annotation Term="OData.Description" String="The management VLAN ID received from the remote partner across this link."/>
1043 <Annotation Term="OData.LongDescription" String="This property shall contain the management VLAN ID received from the remote partner across this link. If no such management VLAN ID has been received, this property should not be present."/>
1044 </Property>
1045 <Property Name="ManagementAddressIPv4" Type="Edm.String">
1046 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1047 <Annotation Term="OData.Description" String="The IPv4 management address received from the remote partner across this link."/>
1048 <Annotation Term="OData.LongDescription" String="This property shall contain the IPv4 management address received from the remote partner across this link. If no such management address has been received, this property should not be present."/>
1049 <Annotation Term="Validation.Pattern" String="^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$"/>
1050 </Property>
1051 <Property Name="ManagementAddressIPv6" Type="Edm.String">
1052 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1053 <Annotation Term="OData.Description" String="The IPv6 management address received from the remote partner across this link."/>
1054 <Annotation Term="OData.LongDescription" String="This property shall contain the IPv6 management address received from the remote partner across this link. If no such management address has been received, this property should not be present."/>
1055 <Annotation Term="Redfish.IPv6Format"/>
1056 </Property>
1057 <Property Name="ManagementAddressMAC" Type="Edm.String">
1058 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1059 <Annotation Term="Validation.Pattern" String="^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$"/>
1060 <Annotation Term="OData.Description" String="The management MAC address received from the remote partner across this link."/>
1061 <Annotation Term="OData.LongDescription" String="This property shall contain the management MAC address received from the remote partner across this link. If no such management address has been received, this property should not be present."/>
1062 </Property>
1063 <Property Name="PortId" Type="Edm.String">
1064 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1065 <Annotation Term="Validation.Pattern" String="^([0-9A-F]{2})([:]([0-9A-F]){2}){0,63}$"/>
1066 <Annotation Term="OData.Description" String="A colon delimited string of hexadecimal octets identifying a port."/>
1067 <Annotation Term="OData.LongDescription" String="This property shall contain a colon delimited string of hexadecimal octets identifying the port received from the remote partner across this link. If no such port ID has been received, this property should not be present."/>
1068 </Property>
1069 <Property Name="PortIdSubtype" Type="Port.v1_4_0.IEEE802IdSubtype">
1070 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1071 <Annotation Term="OData.Description" String="The port ID subtype received from the remote partner across this link."/>
1072 <Annotation Term="OData.LongDescription" String="This property shall contain the port ID subtype from IEEE 802.1AB-2009 Table 8-3 received from the remote partner across this link. If no such port ID subtype has been received, this property should not be present."/>
1073 </Property>
1074 </ComplexType>
1075
1076 <EnumType Name="IEEE802IdSubtype">
1077 <Member Name="ChassisComp">
1078 <Annotation Term="OData.Description" String="Chassis component, based in the value of entPhysicalAlias in RFC4133."/>
1079 </Member>
1080 <Member Name="IfAlias">
1081 <Annotation Term="OData.Description" String="Interface alias, based on the ifAlias MIB object."/>
1082 </Member>
1083 <Member Name="PortComp">
1084 <Annotation Term="OData.Description" String="Port component, based in the value of entPhysicalAlias in RFC4133."/>
1085 </Member>
1086 <Member Name="MacAddr">
Ed Tanousf263e092023-05-22 09:56:29 -0700[diff] [blame^]1087 <Annotation Term="OData.Description" String="MAC address, based on an agent detected unicast source address as defined in IEEE standard 802."/>
George Liu7da1c582023-02-21 14:38:49 +0800[diff] [blame]1088 </Member>
1089 <Member Name="NetworkAddr">
1090 <Annotation Term="OData.Description" String="Network address, based on an agent detected network address."/>
1091 </Member>
1092 <Member Name="IfName">
1093 <Annotation Term="OData.Description" String="Interface name, based on the ifName MIB object."/>
1094 </Member>
1095 <Member Name="AgentId">
1096 <Annotation Term="OData.Description" String="Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC3046."/>
1097 </Member>
1098 <Member Name="LocalAssign">
1099 <Annotation Term="OData.Description" String="Locally assigned, based on a alpha-numeric value locally assigned."/>
1100 </Member>
1101 <Member Name="NotTransmitted">
1102 <Annotation Term="OData.Description" String="No data to be sent to/received from remote partner."/>
1103 </Member>
1104 </EnumType>
1105
1106 <ComplexType Name="SFP">
1107 <Annotation Term="OData.Description" String="A small form-factor pluggable (SFP) device attached to a port."/>
1108 <Annotation Term="OData.LongDescription" String="This type shall describe a small form-factor pluggable (SFP) device attached to a port."/>
1109 <Property Name="Status" Type="Resource.Status" Nullable="false">
1110 <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
1111 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
1112 </Property>
1113 <Property Name="SupportedSFPTypes" Type="Collection(Port.v1_4_0.SFPType)">
1114 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1115 <Annotation Term="OData.Description" String="The types of SFP devices that can be attached to this port."/>
1116 <Annotation Term="OData.LongDescription" String="This property shall contain an array of SFP device types supported by this port."/>
1117 </Property>
1118 <Property Name="Type" Type="Port.v1_4_0.SFPType">
1119 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1120 <Annotation Term="OData.Description" String="The type of SFP device that is attached to this port."/>
1121 <Annotation Term="OData.LongDescription" String="This property shall contain the SFP device type currently attached to this port."/>
1122 </Property>
1123 <Property Name="Manufacturer" Type="Edm.String">
1124 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1125 <Annotation Term="OData.Description" String="The manufacturer of this SFP."/>
1126 <Annotation Term="OData.LongDescription" String="This property shall contain the name of the organization responsible for producing the SFP. This organization may be the entity from which the SFP is purchased, but this is not necessarily true."/>
1127 </Property>
1128 <Property Name="SerialNumber" Type="Edm.String">
1129 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1130 <Annotation Term="OData.Description" String="The serial number for this SFP."/>
1131 <Annotation Term="OData.LongDescription" String="This property shall contain a manufacturer-allocated number that identifies the SFP."/>
1132 </Property>
1133 <Property Name="PartNumber" Type="Edm.String">
1134 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1135 <Annotation Term="OData.Description" String="The part number for this SFP."/>
1136 <Annotation Term="OData.LongDescription" String="This property shall contain the manufacturer-provided part number for the SFP."/>
1137 </Property>
1138 <Property Name="MediumType" Type="Port.v1_4_0.MediumType">
1139 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1140 <Annotation Term="OData.Description" String="The medium type connected to this SFP."/>
1141 <Annotation Term="OData.LongDescription" String="This property shall contain the medium type used by the SFP."/>
1142 </Property>
1143 <Property Name="FiberConnectionType" Type="Port.v1_4_0.FiberConnectionType">
1144 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1145 <Annotation Term="OData.Description" String="The type of fiber connection currently used by this SFP."/>
1146 <Annotation Term="OData.LongDescription" String="This property shall contain the fiber connection type used by the SFP."/>
1147 </Property>
1148 </ComplexType>
1149
1150 <EnumType Name="SFPType">
1151 <Member Name="SFP">
1152 <Annotation Term="OData.Description" String="The SFP conforms to the SFF Specification for SFP."/>
1153 </Member>
1154 <Member Name="SFPPlus">
1155 <Annotation Term="OData.Description" String="The SFP conforms to the SFF Specification for SFP+."/>
1156 </Member>
1157 <Member Name="SFP28">
1158 <Annotation Term="OData.Description" String="The SFP conforms to the SFF Specification for SFP+ and IEEE 802.3by Specification."/>
1159 </Member>
1160 <Member Name="cSFP">
1161 <Annotation Term="OData.Description" String="The SFP conforms to the CSFP MSA Specification."/>
1162 </Member>
1163 <Member Name="SFPDD">
1164 <Annotation Term="OData.Description" String="The SFP conforms to the SFP-DD MSA Specification."/>
1165 </Member>
1166 <Member Name="QSFP">
1167 <Annotation Term="OData.Description" String="The SFP conforms to the SFF Specification for QSFP."/>
1168 </Member>
1169 <Member Name="QSFPPlus">
1170 <Annotation Term="OData.Description" String="The SFP conforms to the SFF Specification for QSFP+."/>
1171 </Member>
1172 <Member Name="QSFP14">
1173 <Annotation Term="OData.Description" String="The SFP conforms to the SFF Specification for QSFP14."/>
1174 </Member>
1175 <Member Name="QSFP28">
1176 <Annotation Term="OData.Description" String="The SFP conforms to the SFF Specification for QSFP28."/>
1177 </Member>
1178 <Member Name="QSFP56">
1179 <Annotation Term="OData.Description" String="The SFP conforms to the SFF Specification for QSFP56."/>
1180 </Member>
1181 <Member Name="MiniSASHD">
1182 <Annotation Term="OData.Description" String="The SFP conforms to the SFF Specification SFF-8644."/>
1183 </Member>
Ed Tanousf263e092023-05-22 09:56:29 -0700[diff] [blame^]1184 <Member Name="QSFPDD">
1185 <Annotation Term="OData.Description" String="The SFP conforms to the QSFP Double Density Specification."/>
1186 <Annotation Term="Redfish.Revisions">
1187 <Collection>
1188 <Record>
1189 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
1190 <PropertyValue Property="Version" String="v1_9_0"/>
1191 </Record>
1192 </Collection>
1193 </Annotation>
1194 </Member>
1195 <Member Name="OSFP">
1196 <Annotation Term="OData.Description" String="The SFP conforms to the OSFP Specification."/>
1197 <Annotation Term="Redfish.Revisions">
1198 <Collection>
1199 <Record>
1200 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
1201 <PropertyValue Property="Version" String="v1_9_0"/>
1202 </Record>
1203 </Collection>
1204 </Annotation>
1205 </Member>
George Liu7da1c582023-02-21 14:38:49 +0800[diff] [blame]1206 </EnumType>
1207
1208 <EnumType Name="MediumType">
1209 <Member Name="Copper">
1210 <Annotation Term="OData.Description" String="The medium connected is copper."/>
1211 </Member>
1212 <Member Name="FiberOptic">
1213 <Annotation Term="OData.Description" String="The medium connected is fiber optic."/>
1214 </Member>
1215 </EnumType>
1216
1217 <EnumType Name="FiberConnectionType">
1218 <Member Name="SingleMode">
1219 <Annotation Term="OData.Description" String="The connection is using single mode operation."/>
1220 </Member>
1221 <Member Name="MultiMode">
1222 <Annotation Term="OData.Description" String="The connection is using multi mode operation."/>
1223 </Member>
1224 </EnumType>
1225 </Schema>
1226
1227 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_4_1">
1228 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1229 <Annotation Term="OData.Description" String="This version was created to correct the permissions for LinkStatus."/>
1230 <EntityType Name="Port" BaseType="Port.v1_4_0.Port"/>
1231 </Schema>
1232
1233 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_4_2">
1234 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1235 <Annotation Term="OData.Description" String="This version was created to clarify the usage of the AssociatedEndpoints, ConnectedSwitches, ConnectedSwitchPorts, and ConnectedPorts properties inside of Links."/>
1236 <EntityType Name="Port" BaseType="Port.v1_4_1.Port"/>
1237 </Schema>
1238
1239 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_4_3">
1240 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1241 <Annotation Term="OData.Description" String="This version was created to correct regular expression patterns for LLDP transmit properties to allow for empty strings and to correct the description for LLDP receive properties to state they should be omitted rather than be empty strings."/>
1242 <EntityType Name="Port" BaseType="Port.v1_4_2.Port"/>
1243 </Schema>
1244
1245 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_5_0">
1246 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1247 <Annotation Term="Redfish.Release" String="2021.2"/>
1248 <Annotation Term="OData.Description" String="This version was created to add new values to the PortConnectionType property."/>
1249
1250 <EntityType Name="Port" BaseType="Port.v1_4_1.Port"/>
1251
1252 <ComplexType Name="EthernetProperties" BaseType="Port.v1_4_0.EthernetProperties">
1253 <Property Name="WakeOnLANEnabled" Type="Edm.Boolean">
1254 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1255 <Annotation Term="OData.Description" String="Indicates whether Wake on LAN (WoL) is enabled on this port."/>
1256 <Annotation Term="OData.LongDescription" String="This property shall indicate whether Wake on LAN (WoL) is enabled on this port."/>
1257 </Property>
1258 <Property Name="EEEEnabled" Type="Edm.Boolean">
1259 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1260 <Annotation Term="OData.Description" String="Indicates whether IEEE 802.3az Energy-Efficient Ethernet (EEE) is enabled on this port."/>
1261 <Annotation Term="OData.LongDescription" String="This property shall indicate whether IEEE 802.3az Energy-Efficient Ethernet (EEE) is enabled on this port."/>
1262 </Property>
1263 </ComplexType>
1264
1265 <ComplexType Name="Links" BaseType="Port.v1_2_0.Links">
1266 <NavigationProperty Name="Cables" Type="Collection(Cable.Cable)">
1267 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1268 <Annotation Term="OData.Description" String="An array of links to the cables connected to this port."/>
1269 <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to resources of type Cable that represent the cables connected to this port."/>
1270 <Annotation Term="OData.AutoExpandReferences"/>
1271 </NavigationProperty>
1272 </ComplexType>
1273 </Schema>
1274
1275 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_5_1">
1276 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1277 <Annotation Term="OData.Description" String="This version was created to clarify the usage of the AssociatedEndpoints, ConnectedSwitches, ConnectedSwitchPorts, and ConnectedPorts properties inside of Links."/>
1278 <EntityType Name="Port" BaseType="Port.v1_5_0.Port"/>
1279 </Schema>
1280
1281 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_5_2">
1282 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1283 <Annotation Term="OData.Description" String="This version was created to correct regular expression patterns for LLDP transmit properties to allow for empty strings and to correct the description for LLDP receive properties to state they should be omitted rather than be empty strings."/>
1284 <EntityType Name="Port" BaseType="Port.v1_5_1.Port"/>
1285 </Schema>
1286
1287 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_6_0">
1288 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1289 <Annotation Term="Redfish.Release" String="2021.4"/>
1290
1291 <EntityType Name="Port" BaseType="Port.v1_5_0.Port">
1292 <Property Name="InfiniBand" Type="Port.v1_6_0.InfiniBandProperties">
1293 <Annotation Term="OData.Description" String="InfiniBand properties for this port."/>
1294 <Annotation Term="OData.LongDescription" String="This property shall contain InfiniBand-specific properties of the port."/>
1295 </Property>
1296 </EntityType>
1297
1298 <ComplexType Name="InfiniBandProperties">
1299 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
1300 <Annotation Term="OData.Description" String="InfiniBand-specific properties for a port."/>
1301 <Annotation Term="OData.LongDescription" String="This type shall contain InfiniBand-specific properties for a port."/>
1302 <Property Name="AssociatedPortGUIDs" Type="Collection(Edm.String)">
1303 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1304 <Annotation Term="OData.Description" String="An array of configured port GUIDs that are associated with this network port, including the programmed address of the lowest numbered network device function, the configured but not active address, if applicable, the address for hardware port teaming, or other network addresses."/>
1305 <Annotation Term="OData.LongDescription" String="This property shall contain an array of configured port GUIDs that are associated with this network port, including the programmed address of the lowest numbered network device function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses."/>
1306 <Annotation Term="Validation.Pattern" String="^([0-9A-Fa-f]{4}[:-]){3}([0-9A-Fa-f]{4})$"/>
1307 </Property>
1308 <Property Name="AssociatedNodeGUIDs" Type="Collection(Edm.String)">
1309 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1310 <Annotation Term="OData.Description" String="An array of configured node GUIDs that are associated with this network port, including the programmed address of the lowest numbered network device function, the configured but not active address, if applicable, the address for hardware port teaming, or other network addresses."/>
1311 <Annotation Term="OData.LongDescription" String="This property shall contain an array of configured node GUIDs that are associated with this network port, including the programmed address of the lowest numbered network device function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses."/>
1312 <Annotation Term="Validation.Pattern" String="^([0-9A-Fa-f]{4}[:-]){3}([0-9A-Fa-f]{4})$"/>
1313 </Property>
1314 <Property Name="AssociatedSystemGUIDs" Type="Collection(Edm.String)">
1315 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1316 <Annotation Term="OData.Description" String="An array of configured system GUIDs that are associated with this network port, including the programmed address of the lowest numbered network device function, the configured but not active address, if applicable, the address for hardware port teaming, or other network addresses."/>
1317 <Annotation Term="OData.LongDescription" String="This property shall contain an array of configured system GUIDs that are associated with this network port, including the programmed address of the lowest numbered network device function, the configured but not active address if applicable, the address for hardware port teaming, or other network addresses."/>
1318 <Annotation Term="Validation.Pattern" String="^([0-9A-Fa-f]{4}[:-]){3}([0-9A-Fa-f]{4})$"/>
1319 </Property>
1320 </ComplexType>
1321 </Schema>
1322
1323 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_6_1">
1324 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1325 <Annotation Term="OData.Description" String="This version was created to clarify the usage of the AssociatedEndpoints, ConnectedSwitches, ConnectedSwitchPorts, and ConnectedPorts properties inside of Links."/>
1326 <EntityType Name="Port" BaseType="Port.v1_6_0.Port"/>
1327 </Schema>
1328
1329 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_6_2">
1330 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1331 <Annotation Term="OData.Description" String="This version was created to correct regular expression patterns for LLDP transmit properties to allow for empty strings and to correct the description for LLDP receive properties to state they should be omitted rather than be empty strings."/>
1332 <EntityType Name="Port" BaseType="Port.v1_6_1.Port"/>
1333 </Schema>
1334
1335 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_7_0">
1336 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1337 <Annotation Term="Redfish.Release" String="2022.2"/>
1338
1339 <EntityType Name="Port" BaseType="Port.v1_6_2.Port"/>
1340
1341 <ComplexType Name="Links" BaseType="Port.v1_5_0.Links">
1342 <NavigationProperty Name="EthernetInterfaces" Type="Collection(EthernetInterface.EthernetInterface)">
1343 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1344 <Annotation Term="OData.Description" String="The links to the Ethernet interfaces this port provides."/>
1345 <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to resources of type EthernetInterface that represent the Ethernet interfaces this port provides. This property shall not include Ethernet interfaces that are not directly associated to a physical port."/>
1346 <Annotation Term="OData.AutoExpandReferences"/>
1347 </NavigationProperty>
1348 </ComplexType>
1349 </Schema>
1350
1351 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_8_0">
1352 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1353 <Annotation Term="Redfish.Release" String="2022.3"/>
1354 <Annotation Term="OData.Description" String="This version was created to add `PCIe` to LinkNetworkTechnology."/>
1355
1356 <EntityType Name="Port" BaseType="Port.v1_7_0.Port">
1357 <Property Name="RemotePortId" Type="Edm.String">
1358 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1359 <Annotation Term="OData.Description" String="The identifier of the remote port to which this port is connected."/>
1360 <Annotation Term="OData.LongDescription" String="This property shall contain the identifier of the remote port, such as a switch or device, to which this port is connected."/>
1361 </Property>
1362 <Property Name="CXL" Type="Port.v1_8_0.CXL">
1363 <Annotation Term="OData.Description" String="CXL properties for this port."/>
1364 <Annotation Term="OData.LongDescription" String="This property shall contain CXL-specific properties for this port."/>
1365 </Property>
1366 </EntityType>
1367
1368 <ComplexType Name="LLDPTransmit" BaseType="Port.v1_4_0.LLDPTransmit">
1369 <Property Name="SystemName" Type="Edm.String">
1370 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1371 <Annotation Term="OData.Description" String="The system name to be transmitted from this endpoint."/>
1372 <Annotation Term="OData.LongDescription" String="This property shall contain the system name to be transmitted from this endpoint. If no such system name is to be transmitted, this value shall be an empty string."/>
1373 </Property>
1374 <Property Name="SystemDescription" Type="Edm.String">
1375 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1376 <Annotation Term="OData.Description" String="The system description to be transmitted from this endpoint."/>
1377 <Annotation Term="OData.LongDescription" String="This property shall contain the system description to be transmitted from this endpoint. If no such system description is to be transmitted, this value shall be an empty string."/>
1378 </Property>
1379 <Property Name="SystemCapabilities" Type="Collection(Port.v1_8_0.LLDPSystemCapabilities)">
1380 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1381 <Annotation Term="OData.Description" String="The system capabilities to be transmitted from this endpoint."/>
1382 <Annotation Term="OData.LongDescription" String="This property shall contain the system capabilities to be transmitted from this endpoint. If no such system capabilities are to be transmitted, this value shall be an empty array. If this property contains the value `None`, an empty set of system capabilities is transmitted from this endpoint."/>
1383 </Property>
1384 </ComplexType>
1385
1386 <ComplexType Name="LLDPReceive" BaseType="Port.v1_4_0.LLDPReceive">
1387 <Property Name="SystemName" Type="Edm.String">
1388 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1389 <Annotation Term="OData.Description" String="The system name received from the remote partner across this link."/>
1390 <Annotation Term="OData.LongDescription" String="This property shall contain the system name received from the remote partner across this link. If no such system name has been received, this property shall not be present."/>
1391 </Property>
1392 <Property Name="SystemDescription" Type="Edm.String">
1393 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1394 <Annotation Term="OData.Description" String="The system description received from the remote partner across this link."/>
1395 <Annotation Term="OData.LongDescription" String="This property shall contain the system description received from the remote partner across this link. If no such system description has been received, this property shall not be present."/>
1396 </Property>
1397 <Property Name="SystemCapabilities" Type="Collection(Port.v1_8_0.LLDPSystemCapabilities)">
1398 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1399 <Annotation Term="OData.Description" String="The system capabilities received from the remote partner across this link."/>
1400 <Annotation Term="OData.LongDescription" String="This property shall contain the system capabilities received from the remote partner across this link. If no such system capabilities have been received, this property shall not be present. This property shall not contain the value `None`."/>
1401 </Property>
1402 </ComplexType>
1403
1404 <EnumType Name="LLDPSystemCapabilities">
1405 <Member Name="None">
1406 <Annotation Term="OData.Description" String="The system capabilities are transmitted, but no capabilities are set."/>
1407 <Annotation Term="OData.LongDescription" String="This value shall indicate the system capabilities are transmitted, but no capabilities are set."/>
1408 </Member>
1409 <Member Name="Bridge">
1410 <Annotation Term="OData.Description" String="Bridge."/>
1411 <Annotation Term="OData.LongDescription" String="This value shall indicate the IEEE802.1AB-defined 'bridge' capability."/>
1412 </Member>
1413 <Member Name="DOCSISCableDevice">
1414 <Annotation Term="OData.Description" String="DOCSIS cable device."/>
1415 <Annotation Term="OData.LongDescription" String="This value shall indicate the IEEE802.1AB-defined 'DOCSIS cable device' capability."/>
1416 </Member>
1417 <Member Name="Other">
1418 <Annotation Term="OData.Description" String="Other."/>
1419 <Annotation Term="OData.LongDescription" String="This value shall indicate the IEEE802.1AB-defined 'other' capability."/>
1420 </Member>
1421 <Member Name="Repeater">
1422 <Annotation Term="OData.Description" String="Repeater."/>
1423 <Annotation Term="OData.LongDescription" String="This value shall indicate the IEEE802.1AB-defined 'repeater' capability."/>
1424 </Member>
1425 <Member Name="Router">
1426 <Annotation Term="OData.Description" String="Router."/>
1427 <Annotation Term="OData.LongDescription" String="This value shall indicate the IEEE802.1AB-defined 'router' capability."/>
1428 </Member>
1429 <Member Name="Station">
1430 <Annotation Term="OData.Description" String="Station."/>
1431 <Annotation Term="OData.LongDescription" String="This value shall indicate the IEEE802.1AB-defined 'station' capability."/>
1432 </Member>
1433 <Member Name="Telephone">
1434 <Annotation Term="OData.Description" String="Telephone."/>
1435 <Annotation Term="OData.LongDescription" String="This value shall indicate the IEEE802.1AB-defined 'telephone' capability."/>
1436 </Member>
1437 <Member Name="WLANAccessPoint">
1438 <Annotation Term="OData.Description" String="WLAN access point."/>
1439 <Annotation Term="OData.LongDescription" String="This value shall indicate the IEEE802.1AB-defined 'WLAN access point' capability."/>
1440 </Member>
1441 </EnumType>
1442
1443 <ComplexType Name="CXL">
1444 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
1445 <Annotation Term="OData.Description" String="CXL properties for a port."/>
1446 <Annotation Term="OData.LongDescription" String="This type shall contain CXL-specific properties for a port."/>
1447 <Property Name="CurrentPortConfigurationState" Type="Port.v1_8_0.CurrentPortConfigurationState">
1448 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1449 <Annotation Term="OData.Description" String="The current port configuration state."/>
1450 <Annotation Term="OData.LongDescription" String="This property shall contain the CXL Specification-defined 'Current Port Configuration State'."/>
1451 </Property>
1452 <Property Name="ConnectedDeviceMode" Type="Port.v1_8_0.ConnectedDeviceMode">
1453 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1454 <Annotation Term="OData.Description" String="The connected device mode."/>
1455 <Annotation Term="OData.LongDescription" String="This property shall contain the CXL Specification-defined 'Connected Device Mode'."/>
1456 </Property>
1457 <Property Name="ConnectedDeviceType" Type="Port.v1_8_0.ConnectedDeviceType">
1458 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1459 <Annotation Term="OData.Description" String="The connected device type."/>
1460 <Annotation Term="OData.LongDescription" String="This property shall contain the CXL Specification-defined 'Connected Device Type'."/>
1461 </Property>
1462 <Property Name="MaxLogicalDeviceCount" Type="Edm.Int64">
1463 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1464 <Annotation Term="OData.Description" String="The maximum number of logical devices supported."/>
1465 <Annotation Term="OData.LongDescription" String="This property shall contain the CXL Specification-defined 'Supported LD Count'."/>
1466 </Property>
1467 <Property Name="TemporaryThroughputReductionEnabled" Type="Edm.Boolean">
1468 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1469 <Annotation Term="OData.Description" String="Indicates whether temporary throughput reduction is enabled."/>
1470 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the CXL Specification-defined 'Temporary Throughput Reduction' mechanism is enabled."/>
1471 </Property>
1472 <Property Name="Congestion" Type="Port.v1_8_0.Congestion">
1473 <Annotation Term="OData.Description" String="The congestion properties for this CXL port."/>
1474 <Annotation Term="OData.LongDescription" String="This property shall contain the congestion properties for this CXL port."/>
1475 </Property>
1476 <Property Name="QoSTelemetryCapabilities" Type="Port.v1_8_0.QoSTelemetryCapabilities">
1477 <Annotation Term="OData.Description" String="The quality of service telemetry capabilities for this CXL port."/>
1478 <Annotation Term="OData.LongDescription" String="This property shall contain the quality of service telemetry capabilities for this CXL port."/>
1479 </Property>
1480 </ComplexType>
1481
1482 <ComplexType Name="Congestion">
1483 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
1484 <Annotation Term="OData.Description" String="The congestion properties for a CXL port."/>
1485 <Annotation Term="OData.LongDescription" String="This type shall contain the congestion properties for a CXL port."/>
1486 <Property Name="CongestionTelemetryEnabled" Type="Edm.Boolean">
1487 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1488 <Annotation Term="OData.Description" String="Indicates whether congestion telemetry collection is enabled for this port."/>
1489 <Annotation Term="OData.LongDescription" String="This property shall indicate whether congestion telemetry collection is enabled for this port."/>
1490 </Property>
1491 <Property Name="EgressModeratePercentage" Type="Edm.Int64">
1492 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1493 <Annotation Term="OData.Description" String="The threshold for moderate egress port congestion as a percentage."/>
1494 <Annotation Term="OData.LongDescription" String="This property shall contain the threshold for moderate egress port congestion for the CXL Specification-defined 'Egress Port Congestion' mechanism as a percentage."/>
1495 <Annotation Term="Measures.Unit" String="%"/>
1496 </Property>
1497 <Property Name="EgressSeverePercentage" Type="Edm.Int64">
1498 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1499 <Annotation Term="OData.Description" String="The threshold for severe egress port congestion as a percentage."/>
1500 <Annotation Term="OData.LongDescription" String="This property shall contain the CXL Specification-defined 'Egress Severe Percentage' as a percentage."/>
1501 <Annotation Term="Measures.Unit" String="%"/>
1502 </Property>
1503 <Property Name="BackpressureSampleInterval" Type="Edm.Int64">
1504 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1505 <Annotation Term="OData.Description" String="The interval for the CXL Specification-defined 'Egress Port Congestion' mechanism to take samples in nanoseconds."/>
1506 <Annotation Term="OData.LongDescription" String="This property shall contain the CXL Specification-defined 'Backpressure Sample Interval' in nanoseconds."/>
1507 </Property>
1508 <Property Name="MaxSustainedRequestCmpBias" Type="Edm.Int64">
1509 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1510 <Annotation Term="OData.Description" String="The estimated maximum sustained sum of requests and recent responses across the entire device, serving as the basis for the CXL Specification-defined 'QoS Limit Fraction'."/>
1511 <Annotation Term="OData.LongDescription" String="This property shall contain the CXL Specification-defined 'ReqCmpBasis'."/>
1512 </Property>
1513 <Property Name="CompletionCollectionInterval" Type="Edm.Int64">
1514 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
1515 <Annotation Term="OData.Description" String="The interval for the CXL Specification-defined 'Completion Counting' mechanism to collect the number of transmitted responses in a single counter in nanoseconds."/>
1516 <Annotation Term="OData.LongDescription" String="This property shall contain the CXL Specification-defined 'Completion Collection Interval' in nanoseconds."/>
1517 </Property>
1518 </ComplexType>
1519
1520 <ComplexType Name="QoSTelemetryCapabilities">
1521 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
1522 <Annotation Term="OData.Description" String="The quality of service telemetry capabilities for a CXL port."/>
1523 <Annotation Term="OData.LongDescription" String="This type shall contain the quality of service telemetry capabilities for a CXL port."/>
1524 <Property Name="EgressPortBackpressureSupported" Type="Edm.Boolean">
1525 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1526 <Annotation Term="OData.Description" String="Indicates whether the port supports the CXL Specification-defined 'Egress Port Backpressure' mechanism."/>
1527 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the port supports the CXL Specification-defined 'Egress Port Backpressure' mechanism."/>
1528 </Property>
1529 <Property Name="TemporaryThroughputReductionSupported" Type="Edm.Boolean">
1530 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
1531 <Annotation Term="OData.Description" String="Indicates whether the port supports the CXL Specification-defined 'Temporary Throughput Reduction' mechanism."/>
1532 <Annotation Term="OData.LongDescription" String="This property shall indicate whether the port supports the CXL Specification-defined 'Temporary Throughput Reduction' mechanism."/>
1533 </Property>
1534 </ComplexType>
1535
1536 <EnumType Name="CurrentPortConfigurationState">
1537 <Member Name="Disabled">
1538 <Annotation Term="OData.Description" String="Disabled."/>
1539 <Annotation Term="OData.LongDescription" String="This value shall indicate the port is disabled."/>
1540 </Member>
1541 <Member Name="BindInProgress">
1542 <Annotation Term="OData.Description" String="Bind in progress."/>
1543 <Annotation Term="OData.LongDescription" String="This value shall indicate a bind is in progress for the port."/>
1544 </Member>
1545 <Member Name="UnbindInProgress">
1546 <Annotation Term="OData.Description" String="Unbind in progress."/>
1547 <Annotation Term="OData.LongDescription" String="This value shall indicate an unbind is in progress for the port."/>
1548 </Member>
1549 <Member Name="DSP">
1550 <Annotation Term="OData.Description" String="Downstream port (DSP)."/>
1551 <Annotation Term="OData.LongDescription" String="This value shall indicate the port is enabled as a downstream port (DSP)."/>
1552 </Member>
1553 <Member Name="USP">
1554 <Annotation Term="OData.Description" String="Upstream port (USP)."/>
1555 <Annotation Term="OData.LongDescription" String="This value shall indicate the port is enabled as an upstream port (USP)."/>
1556 </Member>
1557 <Member Name="Reserved">
1558 <Annotation Term="OData.Description" String="Reserved."/>
1559 <Annotation Term="OData.LongDescription" String="This value shall indicate the port is in a reserved state."/>
1560 </Member>
1561 </EnumType>
1562
1563 <EnumType Name="ConnectedDeviceMode">
1564 <Member Name="Disconnected">
1565 <Annotation Term="OData.Description" String="The connection is not CXL or is disconnected."/>
1566 <Annotation Term="OData.LongDescription" String="This value shall indicate the connection is not CXL or is disconnected."/>
1567 </Member>
1568 <Member Name="RCD">
1569 <Annotation Term="OData.Description" String="Restricted CXL device (RCD)."/>
1570 <Annotation Term="OData.LongDescription" String="This value shall indicate the connected device mode is restricted CXL device (RCD)."/>
1571 </Member>
1572 <Member Name="CXL68BFlitAndVH">
1573 <Annotation Term="OData.Description" String="CXL 68B flit and VH."/>
1574 <Annotation Term="OData.LongDescription" String="This value shall indicate the connected device mode is CXL 68B flit and VH."/>
1575 </Member>
1576 <Member Name="Standard256BFlit">
1577 <Annotation Term="OData.Description" String="Standard 256B flit."/>
1578 <Annotation Term="OData.LongDescription" String="This value shall indicate the connected device mode is standard 256B flit."/>
1579 </Member>
1580 <Member Name="CXLLatencyOptimized256BFlit">
1581 <Annotation Term="OData.Description" String="CXL latency-optimized 256B flit."/>
1582 <Annotation Term="OData.LongDescription" String="This value shall indicate the connected device mode is CXL latency-optimized 256B flit."/>
1583 </Member>
1584 <Member Name="PBR">
1585 <Annotation Term="OData.Description" String="Port-based routing (PBR)."/>
1586 <Annotation Term="OData.LongDescription" String="This value shall indicate the connected device mode is port-based routing (PBR)."/>
1587 </Member>
1588 </EnumType>
1589
1590 <EnumType Name="ConnectedDeviceType">
1591 <Member Name="None">
1592 <Annotation Term="OData.Description" String="No device detected."/>
1593 <Annotation Term="OData.LongDescription" String="This value shall indicate no device is detected."/>
1594 </Member>
1595 <Member Name="PCIeDevice">
1596 <Annotation Term="OData.Description" String="PCIe device."/>
1597 <Annotation Term="OData.LongDescription" String="This value shall indicate the connected device is a PCIe device."/>
1598 </Member>
1599 <Member Name="Type1">
1600 <Annotation Term="OData.Description" String="CXL Type 1 device."/>
1601 <Annotation Term="OData.LongDescription" String="This value shall indicate the connected device is a CXL Type 1 device."/>
1602 </Member>
1603 <Member Name="Type2">
1604 <Annotation Term="OData.Description" String="CXL Type 2 device."/>
1605 <Annotation Term="OData.LongDescription" String="This value shall indicate the connected device is a CXL Type 2 device."/>
1606 </Member>
1607 <Member Name="Type3SLD">
1608 <Annotation Term="OData.Description" String="CXL Type 3 single logical device (SLD)."/>
1609 <Annotation Term="OData.LongDescription" String="This value shall indicate the connected device is a CXL Type 3 single logical device (SLD)."/>
1610 </Member>
1611 <Member Name="Type3MLD">
1612 <Annotation Term="OData.Description" String="CXL Type 3 multi-logical device (MLD)."/>
1613 <Annotation Term="OData.LongDescription" String="This value shall indicate the connected device is a CXL Type 3 multi-logical device (MLD)."/>
1614 </Member>
1615 </EnumType>
1616 </Schema>
1617
Ed Tanousf263e092023-05-22 09:56:29 -0700[diff] [blame^]1618 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_9_0">
1619 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
1620 <Annotation Term="Redfish.Release" String="2023.1"/>
1621 <Annotation Term="OData.Description" String="This version was created to add `QSFPDD` and `OSFP` as SFP types."/>
1622
1623 <EntityType Name="Port" BaseType="Port.v1_8_0.Port"/>
1624 </Schema>
1625
George Liu7da1c582023-02-21 14:38:49 +0800[diff] [blame]1626 </edmx:DataServices>
1627</edmx:Edmx>