blob: b2a6fbfad765694b2673b39724d1f8fe49c9929b [file] [log] [blame]
Gunnar Mills844b4152020-06-22 12:44:09 -05001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Gunnar Mills262d7d42021-01-20 16:28:41 -06004<!--# Redfish Schema: Aggregate v1.0.1 -->
Gunnar Mills844b4152020-06-22 12:44:09 -05005<!--# -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
7<!--# available at http://www.dmtf.org/standards/redfish -->
8<!--# Copyright 2014-2020 DMTF. -->
9<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10<!--################################################################################ -->
11<!---->
12<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13
14 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15 <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16 </edmx:Reference>
17 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
18 <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
19 </edmx:Reference>
20 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Measures.V1.xml">
21 <edmx:Include Namespace="Org.OData.Measures.V1" Alias="Measures"/>
22 </edmx:Reference>
23 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
24 <edmx:Include Namespace="Resource"/>
25 <edmx:Include Namespace="Resource.v1_0_0"/>
26 </edmx:Reference>
27 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
28 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
29 <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
30 </edmx:Reference>
31
32 <edmx:DataServices>
33
34 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Aggregate">
35 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
36
37 <EntityType Name="Aggregate" BaseType="Resource.v1_0_0.Resource" Abstract="true">
38 <Annotation Term="OData.Description" String="The Aggregate schema describes a grouping method for an aggregation service. Aggregates are formal groups of resources that are more persistent than ad hoc groupings."/>
39 <Annotation Term="OData.LongDescription" String="This resource shall represent an aggregation service grouping method for a Redfish implementation."/>
40 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
41 <Annotation Term="Capabilities.InsertRestrictions">
42 <Record>
43 <PropertyValue Property="Insertable" Bool="false"/>
44 </Record>
45 </Annotation>
46 <Annotation Term="Capabilities.UpdateRestrictions">
47 <Record>
48 <PropertyValue Property="Updatable" Bool="false"/>
49 </Record>
50 </Annotation>
51 <Annotation Term="Capabilities.DeleteRestrictions">
52 <Record>
53 <PropertyValue Property="Deletable" Bool="true"/>
54 </Record>
55 </Annotation>
56 <Annotation Term="Redfish.Uris">
57 <Collection>
58 <String>/redfish/v1/AggregationService/Aggregates/{AggregateId}</String>
59 </Collection>
60 </Annotation>
61 </EntityType>
62
63 <Action Name="Reset" IsBound="true">
64 <Annotation Term="OData.Description" String="This action is used to reset a collection of resources. For example, this could be an aggregate or a list of computer systems."/>
65 <Annotation Term="OData.LongDescription" String="This action shall perform a reset of a collection of resources."/>
66 <Parameter Name="Aggregate" Type="Aggregate.v1_0_0.Actions"/>
67 <Parameter Name="DelayBetweenBatchesInSeconds" Type="Edm.Int64">
68 <Annotation Term="OData.Description" String="The delay of the batches of elements being reset in seconds."/>
69 <Annotation Term="OData.LongDescription" String="This parameter shall contain the delay of the batches of elements being reset in seconds."/>
70 <Annotation Term="Validation.Minimum" Int="0"/>
71 <Annotation Term="Measures.Unit" String="s"/>
72 </Parameter>
73 <Parameter Name="BatchSize" Type="Edm.Int64">
74 <Annotation Term="OData.Description" String="The number of elements in each batch being reset."/>
75 <Annotation Term="OData.LongDescription" String="This parameter shall contain the number of elements in each batch simultaneously being issued a reset."/>
76 <Annotation Term="Validation.Minimum" Int="0"/>
77 </Parameter>
78 <Parameter Name="ResetType" Type="Resource.ResetType">
79 <Annotation Term="OData.Description" String="The type of reset."/>
80 <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."/>
81 </Parameter>
82 </Action>
83
84 <Action Name="SetDefaultBootOrder" IsBound="true">
85 <Annotation Term="OData.Description" String="This action is used to restore the boot order to the default state for the computer systems that are members of this aggregate."/>
86 <Annotation Term="OData.LongDescription" String="This action shall restore the boot order to the default state for the computer systems that are members of this aggregate."/>
87 <Parameter Name="Aggregate" Type="Aggregate.v1_0_0.Actions"/>
88 </Action>
89
90 <Action Name="AddElements" IsBound="true">
91 <Annotation Term="OData.Description" String="This action is used to add one or more resources to the aggregate."/>
92 <Annotation Term="OData.LongDescription" String="This action shall add one or more resources to the aggregate, resulting in that the resources are included in the Elements array of the aggregate."/>
93 <Parameter Name="Aggregate" Type="Aggregate.v1_0_0.Actions"/>
94 <Parameter Name="Elements" Type="Collection(Resource.Resource)" Nullable="false">
95 <Annotation Term="OData.Description" String="An array of resource links to add to the Elements array."/>
96 <Annotation Term="OData.LongDescription" String="This parameter shall contain an array of links to the specified resources to add to the aggregate's Elements array."/>
97 </Parameter>
98 </Action>
99
100 <Action Name="RemoveElements" IsBound="true">
101 <Annotation Term="OData.Description" String="This action is used to remove one or more resources from the aggregate."/>
102 <Annotation Term="OData.LongDescription" String="This action shall remove one or more resources from the aggregate, resulting in that the resources are removed from the Elements array of the aggregate."/>
103 <Parameter Name="Aggregate" Type="Aggregate.v1_0_0.Actions"/>
104 <Parameter Name="Elements" Type="Collection(Resource.Resource)" Nullable="false">
105 <Annotation Term="OData.Description" String="An array of resource links to remove from the Elements array."/>
106 <Annotation Term="OData.LongDescription" String="This parameter shall contain an array of links to the specified resources to remove from the aggregate's Elements array."/>
107 </Parameter>
108 </Action>
109 </Schema>
110
111 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Aggregate.v1_0_0">
112 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
113 <Annotation Term="Redfish.Release" String="2020.2"/>
114
115 <EntityType Name="Aggregate" BaseType="Aggregate.Aggregate">
116 <NavigationProperty Name="Elements" Type="Collection(Resource.Resource)">
117 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
118 <Annotation Term="OData.Description" String="The elements of this aggregate."/>
119 <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to the elements of this aggregate."/>
120 <Annotation Term="OData.AutoExpandReferences"/>
121 <Annotation Term="Redfish.Required"/>
122 <Annotation Term="Redfish.RequiredOnCreate"/>
123 </NavigationProperty>
124 <Property Name="ElementsCount" Type="Edm.Int64">
125 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
126 <Annotation Term="OData.Description" String="The number of entries in the Elements array."/>
127 <Annotation Term="OData.LongDescription" String="This property shall contain the number of entries in the Elements array."/>
128 <Annotation Term="Validation.Minimum" Int="0"/>
129 </Property>
130 <Property Name="Actions" Type="Aggregate.v1_0_0.Actions" Nullable="false">
131 <Annotation Term="OData.Description" String="The available actions for this resource."/>
132 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
133 </Property>
134 </EntityType>
135
136 <ComplexType Name="Actions">
137 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
138 <Annotation Term="OData.Description" String="The available actions for this resource."/>
139 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
140 <Property Name="Oem" Type="Aggregate.v1_0_0.OemActions" Nullable="false">
141 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
142 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
143 </Property>
144 </ComplexType>
145
146 <ComplexType Name="OemActions">
147 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
148 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
149 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
150 </ComplexType>
151 </Schema>
152
Gunnar Mills262d7d42021-01-20 16:28:41 -0600153 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Aggregate.v1_0_1">
154 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
155 <Annotation Term="OData.Description" String="This version was created specify 64-bit integers in OpenAPI."/>
156 <EntityType Name="Aggregate" BaseType="Aggregate.v1_0_0.Aggregate"/>
157 </Schema>
158
Gunnar Mills844b4152020-06-22 12:44:09 -0500159 </edmx:DataServices>
160</edmx:Edmx>