blob: 92f1eb5bcb381f23edb9a89655be7b1ab645e7e8 [file] [log] [blame]
Jason M. Billsea4aa752018-06-05 13:29:11 -07001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Ed Tanous530520e2019-01-02 13:41:37 -08004<!--# Redfish Schema: Port v1.1.1-->
Jason M. Billsea4aa752018-06-05 13:29:11 -07005<!--# -->
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 Tanous530520e2019-01-02 13:41:37 -08008<!--# Copyright 2014-2018 DMTF. -->
Jason M. Billsea4aa752018-06-05 13:29:11 -07009<!--# 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>
Ed Tanous530520e2019-01-02 13:41:37 -080017 <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>
Jason M. Billsea4aa752018-06-05 13:29:11 -070020 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
21 <edmx:Include Namespace="Resource"/>
22 <edmx:Include Namespace="Resource.v1_0_0"/>
23 </edmx:Reference>
24 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
25 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
26 </edmx:Reference>
27 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Endpoint_v1.xml">
28 <edmx:Include Namespace="Endpoint"/>
29 </edmx:Reference>
30 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Switch_v1.xml">
31 <edmx:Include Namespace="Switch"/>
32 </edmx:Reference>
33 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Measures.V1.xml">
34 <edmx:Include Namespace="Org.OData.Measures.V1" Alias="Measures"/>
35 </edmx:Reference>
36 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Protocol_v1.xml">
37 <edmx:Include Namespace="Protocol"/>
38 </edmx:Reference>
39
40 <edmx:DataServices>
41
42 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port">
43 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
44
45 <EntityType Name="Port" BaseType="Resource.v1_0_0.Resource" Abstract="true">
46 <Annotation Term="OData.Description" String="Port contains properties describing a port of a switch."/>
47 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent a simple switch port for a Redfish implementation."/>
Ed Tanous530520e2019-01-02 13:41:37 -080048 <Annotation Term="Capabilities.InsertRestrictions">
49 <Record>
50 <PropertyValue Property="Insertable" Bool="false"/>
51 </Record>
52 </Annotation>
53 <Annotation Term="Capabilities.UpdateRestrictions">
54 <Record>
55 <PropertyValue Property="Updatable" Bool="false"/>
56 </Record>
57 </Annotation>
58 <Annotation Term="Capabilities.DeleteRestrictions">
59 <Record>
60 <PropertyValue Property="Deletable" Bool="false"/>
61 </Record>
62 </Annotation>
63 <Annotation Term="Redfish.Uris">
64 <Collection>
65 <String>/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}</String>
66 </Collection>
67 </Annotation>
Jason M. Billsea4aa752018-06-05 13:29:11 -070068 </EntityType>
69
70 <Action Name="Reset" IsBound="true">
71 <Parameter Name="Port" Type="Port.v1_0_0.Actions"/>
72 <Parameter Name="ResetType" Type="Resource.ResetType">
73 <Annotation Term="OData.Description" String="The type of reset to be performed."/>
74 <Annotation Term="OData.LongDescription" String="This parameter shall define the type of reset to be performed. The service may accept a request without the parameter and perform an implementation specific default reset."/>
75 </Parameter>
76 <Annotation Term="OData.Description" String="This action is used to reset this port."/>
77 <Annotation Term="OData.LongDescription" String="This action shall perform a reset of this port."/>
78 </Action>
79
80 </Schema>
81
82 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_0">
83 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
84
Ed Tanous530520e2019-01-02 13:41:37 -080085 <EntityType Name="Port" BaseType="Port.Port">
86 <Property Name="Status" Type="Resource.Status" Nullable="false">
87 <Annotation Term="OData.Description" String="This property describes the status and health of the resource and its children."/>
88 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
89 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -070090 <Property Name="PortId" Type="Edm.String">
91 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
92 <Annotation Term="OData.Description" String="This is the label of this port on the physical switch package."/>
93 <Annotation Term="OData.LongDescription" String="The value of this property shall be the name of the switch port as indicated on the outside of the switch."/>
94 </Property>
95 <Property Name="PortProtocol" Type="Protocol.Protocol">
96 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
97 <Annotation Term="OData.Description" String="The protocol being sent over this port."/>
98 <Annotation Term="OData.LongDescription" String="The value of this property shall contain the protocol being sent over this port."/>
Ed Tanous530520e2019-01-02 13:41:37 -080099 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700100 <Property Name="PortType" Type="Port.v1_0_0.PortType">
101 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
102 <Annotation Term="OData.Description" String="This is the type of this port."/>
103 <Annotation Term="OData.LongDescription" String="The value of this property shall be the port type for this port."/>
104 </Property>
105 <Property Name="CurrentSpeedGbps" Type="Edm.Decimal">
106 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
107 <Annotation Term="OData.Description" String="The current speed of this port."/>
108 <Annotation Term="OData.LongDescription" String="The value of this property shall be the speed of this port currently negotiated and running."/>
109 <Annotation Term="Measures.Unit" String="Gbit/s"/>
110 </Property>
111 <Property Name="MaxSpeedGbps" Type="Edm.Decimal">
112 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
113 <Annotation Term="OData.Description" String="The maximum speed of this port as currently configured."/>
114 <Annotation Term="OData.LongDescription" String="The value of this property shall be the maximum speed of which this port is capable of being configured. If capable of auto-negotiation, the system shall attempt to negotiate at the maximum speed set."/>
115 <Annotation Term="Measures.Unit" String="Gbit/s"/>
116 </Property>
117 <Property Name="Width" Type="Edm.Int64">
118 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
119 <Annotation Term="OData.Description" String="The number of lanes, phys, or other physical transport links that this port contains."/>
120 <Annotation Term="OData.LongDescription" String="The value of this property shall be the number of physical transport links that this port contains."/>
121 </Property>
122 <Property Name="Links" Type="Port.v1_0_0.Links" Nullable="false">
123 <Annotation Term="OData.Description" String="Contains references to other resources that are related to this resource."/>
124 <Annotation Term="OData.LongDescription" String="The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource."/>
125 </Property>
126 <Property Name="Actions" Type="Port.v1_0_0.Actions" Nullable="false">
127 <Annotation Term="OData.Description" String="The available actions for this resource."/>
128 <Annotation Term="OData.LongDescription" String="The Actions property shall contain the available actions for this resource."/>
129 </Property>
130 </EntityType>
131
132 <ComplexType Name="Links" BaseType="Resource.Links">
133 <Annotation Term="OData.Description" String="Contains references to other resources that are related to this resource."/>
134 <Annotation Term="OData.LongDescription" String="This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource."/>
135 <NavigationProperty Name="AssociatedEndpoints" Type="Collection(Endpoint.Endpoint)">
136 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
137 <Annotation Term="OData.Description" String="An array of references to the endpoints that connect to the switch through this port."/>
138 <Annotation Term="OData.LongDescription" String="The value of this property shall be a reference to the resources that this port is associated with and shall reference a resource of type Endpoint."/>
139 <Annotation Term="OData.AutoExpandReferences"/>
140 </NavigationProperty>
141 <NavigationProperty Name="ConnectedSwitches" Type="Collection(Switch.Switch)">
142 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
143 <Annotation Term="OData.Description" String="An array of references to the switches that connect to the switch through this port."/>
144 <Annotation Term="OData.LongDescription" String="The value of this property shall be a reference to the resources that this port is associated with and shall reference a resource of type Switch."/>
145 <Annotation Term="OData.AutoExpandReferences"/>
146 </NavigationProperty>
147 <NavigationProperty Name="ConnectedSwitchPorts" Type="Collection(Port.Port)">
148 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
149 <Annotation Term="OData.Description" String="An array of references to the ports that connect to the switch through this port."/>
150 <Annotation Term="OData.LongDescription" String="The value of this property shall be a reference to the resources that this port is associated with and shall reference a resource of type Port."/>
151 <Annotation Term="OData.AutoExpandReferences"/>
152 </NavigationProperty>
153 </ComplexType>
154
155 <ComplexType Name="Actions">
156 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
157 <Annotation Term="OData.Description" String="The available actions for this resource."/>
158 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800159 <Property Name="Oem" Type="Port.v1_0_0.OemActions" Nullable="false">
160 <Annotation Term="OData.Description" String="This property contains the available OEM specific actions for this resource."/>
161 <Annotation Term="OData.LongDescription" String="This property shall contain any additional OEM actions for this resource."/>
162 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700163 </ComplexType>
164
165 <ComplexType Name="OemActions">
166 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
167 <Annotation Term="OData.Description" String="The available OEM specific actions for this resource."/>
168 <Annotation Term="OData.LongDescription" String="This type shall contain any additional OEM actions for this resource."/>
169 </ComplexType>
170
171 <EnumType Name="PortType">
172 <Member Name="UpstreamPort">
173 <Annotation Term="OData.Description" String="This port connects to a host device."/>
174 </Member>
175 <Member Name="DownstreamPort">
176 <Annotation Term="OData.Description" String="This port connects to a target device."/>
177 </Member>
178 <Member Name="InterswitchPort">
179 <Annotation Term="OData.Description" String="This port connects to another switch."/>
180 </Member>
181 <Member Name="ManagementPort">
182 <Annotation Term="OData.Description" String="This port connects to a switch manager."/>
183 </Member>
184 <Member Name="BidirectionalPort">
185 <Annotation Term="OData.Description" String="This port connects to any type of device."/>
186 </Member>
187 <Member Name="UnconfiguredPort">
188 <Annotation Term="OData.Description" String="This port has not yet been configured."/>
189 </Member>
190 </EnumType>
191 </Schema>
192
193 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_1">
194 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
195 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
196 <EntityType Name="Port" BaseType="Port.v1_0_0.Port"/>
197 </Schema>
198
199 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_2">
200 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
201 <Annotation Term="OData.Description" String="This version was created to remove the Nullable facet on NavigationProperties of type Collection."/>
202 <EntityType Name="Port" BaseType="Port.v1_0_1.Port"/>
203 </Schema>
204
205 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_3">
206 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
207 <Annotation Term="OData.Description" String="This version was created to change references to PortProtocol to use the unversioned definition. It was also created to correct the Descriptions and LongDescriptions used in the defined Actions."/>
208 <EntityType Name="Port" BaseType="Port.v1_0_2.Port"/>
209 </Schema>
210
Ed Tanous530520e2019-01-02 13:41:37 -0800211 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_4">
212 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
213 <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."/>
214 <EntityType Name="Port" BaseType="Port.v1_0_3.Port"/>
215 </Schema>
216
Jason M. Billsea4aa752018-06-05 13:29:11 -0700217 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_0">
218 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
219 <EntityType Name="Port" BaseType="Port.v1_0_3.Port">
Ed Tanous530520e2019-01-02 13:41:37 -0800220 <Property Name="Location" Type="Resource.Location" Nullable="false">
221 <Annotation Term="OData.Description" String="The Location of the port."/>
222 <Annotation Term="OData.LongDescription" String="This property shall contain location information of the associated port."/>
223 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700224 </EntityType>
225 </Schema>
226
Ed Tanous530520e2019-01-02 13:41:37 -0800227 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_1">
228 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
229 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/>
230 <EntityType Name="Port" BaseType="Port.v1_1_0.Port"/>
231 </Schema>
232
Jason M. Billsea4aa752018-06-05 13:29:11 -0700233 </edmx:DataServices>
234</edmx:Edmx>