blob: c58a6e837db505352589684534f23d69431fee46 [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"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060084 <Annotation Term="Redfish.Release" String="2016.2"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070085
Ed Tanous530520e2019-01-02 13:41:37 -080086 <EntityType Name="Port" BaseType="Port.Port">
87 <Property Name="Status" Type="Resource.Status" Nullable="false">
88 <Annotation Term="OData.Description" String="This property describes the status and health of the resource and its children."/>
89 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
90 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -070091 <Property Name="PortId" Type="Edm.String">
92 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
93 <Annotation Term="OData.Description" String="This is the label of this port on the physical switch package."/>
94 <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."/>
95 </Property>
96 <Property Name="PortProtocol" Type="Protocol.Protocol">
97 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
98 <Annotation Term="OData.Description" String="The protocol being sent over this port."/>
99 <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 -0800100 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700101 <Property Name="PortType" Type="Port.v1_0_0.PortType">
102 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
103 <Annotation Term="OData.Description" String="This is the type of this port."/>
104 <Annotation Term="OData.LongDescription" String="The value of this property shall be the port type for this port."/>
105 </Property>
106 <Property Name="CurrentSpeedGbps" Type="Edm.Decimal">
107 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
108 <Annotation Term="OData.Description" String="The current speed of this port."/>
109 <Annotation Term="OData.LongDescription" String="The value of this property shall be the speed of this port currently negotiated and running."/>
110 <Annotation Term="Measures.Unit" String="Gbit/s"/>
111 </Property>
112 <Property Name="MaxSpeedGbps" Type="Edm.Decimal">
113 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
114 <Annotation Term="OData.Description" String="The maximum speed of this port as currently configured."/>
115 <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."/>
116 <Annotation Term="Measures.Unit" String="Gbit/s"/>
117 </Property>
118 <Property Name="Width" Type="Edm.Int64">
119 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
120 <Annotation Term="OData.Description" String="The number of lanes, phys, or other physical transport links that this port contains."/>
121 <Annotation Term="OData.LongDescription" String="The value of this property shall be the number of physical transport links that this port contains."/>
122 </Property>
123 <Property Name="Links" Type="Port.v1_0_0.Links" Nullable="false">
124 <Annotation Term="OData.Description" String="Contains references to other resources that are related to this resource."/>
125 <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."/>
126 </Property>
127 <Property Name="Actions" Type="Port.v1_0_0.Actions" Nullable="false">
128 <Annotation Term="OData.Description" String="The available actions for this resource."/>
129 <Annotation Term="OData.LongDescription" String="The Actions property shall contain the available actions for this resource."/>
130 </Property>
131 </EntityType>
132
133 <ComplexType Name="Links" BaseType="Resource.Links">
134 <Annotation Term="OData.Description" String="Contains references to other resources that are related to this resource."/>
135 <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."/>
136 <NavigationProperty Name="AssociatedEndpoints" Type="Collection(Endpoint.Endpoint)">
137 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
138 <Annotation Term="OData.Description" String="An array of references to the endpoints that connect to the switch through this port."/>
139 <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."/>
140 <Annotation Term="OData.AutoExpandReferences"/>
141 </NavigationProperty>
142 <NavigationProperty Name="ConnectedSwitches" Type="Collection(Switch.Switch)">
143 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
144 <Annotation Term="OData.Description" String="An array of references to the switches that connect to the switch through this port."/>
145 <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."/>
146 <Annotation Term="OData.AutoExpandReferences"/>
147 </NavigationProperty>
148 <NavigationProperty Name="ConnectedSwitchPorts" Type="Collection(Port.Port)">
149 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
150 <Annotation Term="OData.Description" String="An array of references to the ports that connect to the switch through this port."/>
151 <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."/>
152 <Annotation Term="OData.AutoExpandReferences"/>
153 </NavigationProperty>
154 </ComplexType>
155
156 <ComplexType Name="Actions">
157 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
158 <Annotation Term="OData.Description" String="The available actions for this resource."/>
159 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800160 <Property Name="Oem" Type="Port.v1_0_0.OemActions" Nullable="false">
161 <Annotation Term="OData.Description" String="This property contains the available OEM specific actions for this resource."/>
162 <Annotation Term="OData.LongDescription" String="This property shall contain any additional OEM actions for this resource."/>
163 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700164 </ComplexType>
165
166 <ComplexType Name="OemActions">
167 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
168 <Annotation Term="OData.Description" String="The available OEM specific actions for this resource."/>
169 <Annotation Term="OData.LongDescription" String="This type shall contain any additional OEM actions for this resource."/>
170 </ComplexType>
171
172 <EnumType Name="PortType">
173 <Member Name="UpstreamPort">
174 <Annotation Term="OData.Description" String="This port connects to a host device."/>
175 </Member>
176 <Member Name="DownstreamPort">
177 <Annotation Term="OData.Description" String="This port connects to a target device."/>
178 </Member>
179 <Member Name="InterswitchPort">
180 <Annotation Term="OData.Description" String="This port connects to another switch."/>
181 </Member>
182 <Member Name="ManagementPort">
183 <Annotation Term="OData.Description" String="This port connects to a switch manager."/>
184 </Member>
185 <Member Name="BidirectionalPort">
186 <Annotation Term="OData.Description" String="This port connects to any type of device."/>
187 </Member>
188 <Member Name="UnconfiguredPort">
189 <Annotation Term="OData.Description" String="This port has not yet been configured."/>
190 </Member>
191 </EnumType>
192 </Schema>
193
194 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_1">
195 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
196 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
197 <EntityType Name="Port" BaseType="Port.v1_0_0.Port"/>
198 </Schema>
199
200 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_2">
201 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
202 <Annotation Term="OData.Description" String="This version was created to remove the Nullable facet on NavigationProperties of type Collection."/>
203 <EntityType Name="Port" BaseType="Port.v1_0_1.Port"/>
204 </Schema>
205
206 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_3">
207 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
208 <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."/>
209 <EntityType Name="Port" BaseType="Port.v1_0_2.Port"/>
210 </Schema>
211
Ed Tanous530520e2019-01-02 13:41:37 -0800212 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_0_4">
213 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
214 <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."/>
215 <EntityType Name="Port" BaseType="Port.v1_0_3.Port"/>
216 </Schema>
217
Jason M. Billsea4aa752018-06-05 13:29:11 -0700218 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_0">
219 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600220 <Annotation Term="Redfish.Release" String="2017.3"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700221 <EntityType Name="Port" BaseType="Port.v1_0_3.Port">
Ed Tanous530520e2019-01-02 13:41:37 -0800222 <Property Name="Location" Type="Resource.Location" Nullable="false">
223 <Annotation Term="OData.Description" String="The Location of the port."/>
224 <Annotation Term="OData.LongDescription" String="This property shall contain location information of the associated port."/>
225 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700226 </EntityType>
227 </Schema>
228
Ed Tanous530520e2019-01-02 13:41:37 -0800229 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Port.v1_1_1">
230 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
231 <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."/>
232 <EntityType Name="Port" BaseType="Port.v1_1_0.Port"/>
233 </Schema>
234
Jason M. Billsea4aa752018-06-05 13:29:11 -0700235 </edmx:DataServices>
236</edmx:Edmx>