blob: 1ff45a6c2c5a12e288a0e54628867fa33d4b641d [file] [log] [blame]
Carson Labrado8b2521a2023-02-18 02:33:14 +00001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Gunnar Mills2ae81db2024-01-31 14:25:11 -06004<!--# Redfish Schema: AggregationSource v1.4.0 -->
Carson Labrado8b2521a2023-02-18 02:33:14 +00005<!--# -->
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 -07008<!--# Copyright 2014-2023 DMTF. -->
Carson Labrado8b2521a2023-02-18 02:33:14 +00009<!--# 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/ConnectionMethod_v1.xml">
29 <edmx:Include Namespace="ConnectionMethod"/>
30 </edmx:Reference>
31 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/KeyCollection_v1.xml">
32 <edmx:Include Namespace="KeyCollection"/>
33 </edmx:Reference>
34 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Key_v1.xml">
35 <edmx:Include Namespace="Key"/>
36 </edmx:Reference>
37
38 <edmx:DataServices>
39
40 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AggregationSource">
41 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
42
43 <EntityType Name="AggregationSource" BaseType="Resource.v1_0_0.Resource" Abstract="true">
44 <Annotation Term="OData.Description" String="The AggregationSource schema is used to represent the source of information for a subset of the resources provided by a Redfish service. It can be thought of as a provider of information. As such, most such interfaces have requirements to support the gathering of information like address and account used to access the information."/>
45 <Annotation Term="OData.LongDescription" String="This resource shall represent an aggregation source for a Redfish implementation."/>
46 <Annotation Term="Capabilities.InsertRestrictions">
47 <Record>
48 <PropertyValue Property="Insertable" Bool="false"/>
49 </Record>
50 </Annotation>
51 <Annotation Term="Capabilities.UpdateRestrictions">
52 <Record>
53 <PropertyValue Property="Updatable" Bool="true"/>
54 </Record>
55 </Annotation>
56 <Annotation Term="Capabilities.DeleteRestrictions">
57 <Record>
58 <PropertyValue Property="Deletable" Bool="true"/>
59 </Record>
60 </Annotation>
61 <Annotation Term="Redfish.Uris">
62 <Collection>
63 <String>/redfish/v1/AggregationService/AggregationSources/{AggregationSourceId}</String>
64 </Collection>
65 </Annotation>
66 </EntityType>
67
68 <Action Name="GenerateSSHIdentityKeyPair" IsBound="true">
Gunnar Mills2ae81db2024-01-31 14:25:11 -060069 <Annotation Term="OData.Description" String="This action generates a new SSH identity key-pair to be used with this aggregation source. The generated public key is stored in the Key resource referenced by the PublicIdentityKey property in SSHSettings. Any existing key-pair is deleted and replaced by the new key-pair."/>
Carson Labrado8b2521a2023-02-18 02:33:14 +000070 <Annotation Term="OData.LongDescription" String="This action shall generate a new SSH identity key-pair to be used with this aggregation source. The service shall store the generated public key in the Key resource referenced by the PublicIdentityKey property in SSHSettings. If the aggregation source already has an associated SSH identity key-pair, the service shall delete the key-pair and replace it with the new key-pair."/>
71 <Parameter Name="AggregationSource" Type="AggregationSource.v1_0_0.Actions"/>
Gunnar Mills2ae81db2024-01-31 14:25:11 -060072 <Parameter Name="KeyType" Type="Key.SSHKeyType" Nullable="false">
Carson Labrado8b2521a2023-02-18 02:33:14 +000073 <Annotation Term="OData.Description" String="The type of SSH key."/>
74 <Annotation Term="OData.LongDescription" String="This parameter shall contain the type of SSH key."/>
75 </Parameter>
76 <Parameter Name="KeyLength" Type="Edm.Int64">
77 <Annotation Term="OData.Description" String="The length of the SSH key, in bits, if the KeyType parameter contains `RSA`."/>
Gunnar Mills2ae81db2024-01-31 14:25:11 -060078 <Annotation Term="OData.LongDescription" String="This parameter shall contain the length of the SSH key, in bits. This parameter shall be required if the KeyType parameter contains `RSA` and shall be rejected for other values."/>
Carson Labrado8b2521a2023-02-18 02:33:14 +000079 </Parameter>
Gunnar Mills2ae81db2024-01-31 14:25:11 -060080 <Parameter Name="Curve" Type="Key.ECDSACurveType">
Carson Labrado8b2521a2023-02-18 02:33:14 +000081 <Annotation Term="OData.Description" String="The curve to use with the SSH key if the KeyType parameter contains `ECDSA`."/>
Gunnar Mills2ae81db2024-01-31 14:25:11 -060082 <Annotation Term="OData.LongDescription" String="This parameter shall contain the curve to use with the SSH key. This parameter shall be required if the KeyType parameter contains `ECDSA` and shall be rejected for other values."/>
Carson Labrado8b2521a2023-02-18 02:33:14 +000083 </Parameter>
84 <Annotation Term="Redfish.Revisions">
85 <Collection>
86 <Record>
87 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
88 <PropertyValue Property="Version" String="v1_3_0"/>
89 </Record>
90 </Collection>
91 </Annotation>
92 </Action>
93
94 <Action Name="RemoveSSHIdentityKeyPair" IsBound="true">
95 <Annotation Term="OData.Description" String="This action removes the SSH identity key-pair used with this aggregation source."/>
96 <Annotation Term="OData.LongDescription" String="This action shall remove the private SSH identity key-pair used with this aggregation source."/>
97 <Parameter Name="AggregationSource" Type="AggregationSource.v1_0_0.Actions"/>
98 <Annotation Term="Redfish.Revisions">
99 <Collection>
100 <Record>
101 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
102 <PropertyValue Property="Version" String="v1_3_0"/>
103 </Record>
104 </Collection>
105 </Annotation>
106 </Action>
107 </Schema>
108
109 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AggregationSource.v1_0_0">
110 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
111 <Annotation Term="Redfish.Release" String="2020.2"/>
112
113 <EntityType Name="AggregationSource" BaseType="AggregationSource.AggregationSource">
114 <Property Name="HostName" Type="Edm.String">
115 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
116 <Annotation Term="OData.Description" String="The URI of the system to be accessed."/>
117 <Annotation Term="OData.LongDescription" String="This property shall contain the URI of the system to be aggregated. This property shall not be required when the aggregation source is configured to only receive notifications from the aggregated system and the AggregationType property contains the value `NotificationsOnly`."/>
118 <Annotation Term="OData.IsURL"/>
119 </Property>
120 <Property Name="UserName" Type="Edm.String">
121 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
122 <Annotation Term="OData.Description" String="The user name for accessing the aggregation source."/>
123 <Annotation Term="OData.LongDescription" String="This property shall contain the user name for accessing the aggregation source."/>
124 </Property>
125 <Property Name="Password" Type="Edm.String">
126 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Write"/>
127 <Annotation Term="OData.Description" String="The password for accessing the aggregation source. The value is `null` in responses."/>
128 <Annotation Term="OData.LongDescription" String="This property shall contain a password for accessing the aggregation source. The value shall be `null` in responses."/>
129 </Property>
130 <Property Name="Links" Type="AggregationSource.v1_0_0.Links" Nullable="false">
131 <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/>
132 <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."/>
133 </Property>
134 <Property Name="Actions" Type="AggregationSource.v1_0_0.Actions" Nullable="false">
135 <Annotation Term="OData.Description" String="The available actions for this resource."/>
136 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
137 </Property>
138 </EntityType>
139
140 <ComplexType Name="Links" BaseType="Resource.Links">
141 <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/>
142 <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."/>
143 <NavigationProperty Name="ConnectionMethod" Type="ConnectionMethod.ConnectionMethod">
144 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
145 <Annotation Term="OData.Description" String="An array of links to the connection methods used to contact this aggregation source."/>
146 <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to resources of type ConnectionMethod that are used to connect to the aggregation source."/>
147 <Annotation Term="OData.AutoExpandReferences"/>
148 </NavigationProperty>
149 <NavigationProperty Name="ResourcesAccessed" Type="Collection(Resource.Resource)">
150 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
151 <Annotation Term="OData.Description" String="An array links to the resources added to the service through this aggregation source. It is recommended that this be the minimal number of properties needed to find the resources that would be lost when the aggregation source is deleted."/>
Gunnar Mills2ae81db2024-01-31 14:25:11 -0600152 <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to the resources added to the service through the aggregation source. It is recommended that this be the minimal number of properties needed to find the resources that would be lost when the aggregation source is deleted. For example, this could be the pointers to the members of the root-level collections or the manager of a BMC."/>
Carson Labrado8b2521a2023-02-18 02:33:14 +0000153 <Annotation Term="OData.AutoExpandReferences"/>
154 </NavigationProperty>
155 </ComplexType>
156
157 <ComplexType Name="Actions">
158 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
159 <Annotation Term="OData.Description" String="The available actions for this resource."/>
160 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
161 <Property Name="Oem" Type="AggregationSource.v1_0_0.OemActions" Nullable="false">
162 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
163 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
164 </Property>
165 </ComplexType>
166
167 <ComplexType Name="OemActions">
168 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
169 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
170 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
171 </ComplexType>
172 </Schema>
173
174 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AggregationSource.v1_0_1">
175 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
176 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
177 <EntityType Name="AggregationSource" BaseType="AggregationSource.v1_0_0.AggregationSource"/>
178 </Schema>
179
Gunnar Mills2ae81db2024-01-31 14:25:11 -0600180 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AggregationSource.v1_0_2">
181 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
182 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
183 <EntityType Name="AggregationSource" BaseType="AggregationSource.v1_0_1.AggregationSource"/>
184 </Schema>
185
Carson Labrado8b2521a2023-02-18 02:33:14 +0000186 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AggregationSource.v1_1_0">
187 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
188 <Annotation Term="Redfish.Release" String="2020.4"/>
189 <Annotation Term="OData.Description" String="This version was created to add SNMP settings to the AggregationSource."/>
190
191 <EntityType Name="AggregationSource" BaseType="AggregationSource.v1_0_0.AggregationSource">
192 <Property Name="SNMP" Type="AggregationSource.v1_1_0.SNMPSettings">
193 <Annotation Term="OData.Description" String="SNMP settings of the aggregation source."/>
194 <Annotation Term="OData.LongDescription" String="This property shall contain the SNMP settings of the aggregation source."/>
195 </Property>
196 </EntityType>
197
198 <ComplexType Name="SNMPSettings">
199 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
200 <Annotation Term="OData.Description" String="Settings for an SNMP aggregation source."/>
201 <Annotation Term="OData.LongDescription" String="This type shall contain the settings for an SNMP aggregation source."/>
202 <Property Name="AuthenticationKey" Type="Edm.String">
203 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Write"/>
204 <Annotation Term="OData.Description" String="The secret authentication key for SNMPv3."/>
205 <Annotation Term="OData.LongDescription" String="This property shall contain the key for SNMPv3 authentication. The value shall be `null` in responses. This property accepts a passphrase or a hex-encoded key. If the string starts with `Passphrase:`, the remainder of the string shall be the passphrase and shall be converted to the key as described in the 'Password to Key Algorithm' section of RFC3414. If the string starts with `Hex:`, then the remainder of the string shall be the key encoded in hexadecimal notation. If the string starts with neither, the full string shall be a passphrase and shall be converted to the key as described in the 'Password to Key Algorithm' section of RFC3414. The passphrase can contain any printable characters except for the double quotation mark."/>
206 <Annotation Term="Validation.Pattern" String="(^[ !#-~]+$)|(^Passphrase:[ ^[ !#-~]+$)|(^Hex:[0-9A-Fa-f]{24,96})|(^\*+$)"/>
207 </Property>
208 <Property Name="AuthenticationProtocol" Type="AggregationSource.v1_1_0.SNMPAuthenticationProtocols">
209 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
210 <Annotation Term="OData.Description" String="The authentication protocol for SNMPv3."/>
211 <Annotation Term="OData.LongDescription" String="This property shall contain the SNMPv3 authentication protocol."/>
212 </Property>
213 <Property Name="EncryptionKey" Type="Edm.String">
214 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Write"/>
215 <Annotation Term="OData.Description" String="The secret authentication key for SNMPv3."/>
216 <Annotation Term="OData.LongDescription" String="This property shall contain the key for SNMPv3 encryption. The value shall be `null` in responses. This property accepts a passphrase or a hex-encoded key. If the string starts with `Passphrase:`, the remainder of the string shall be the passphrase and shall be converted to the key as described in the 'Password to Key Algorithm' section of RFC3414. If the string starts with `Hex:`, then the remainder of the string shall be the key encoded in hexadecimal notation. If the string starts with neither, the full string shall be a passphrase and shall be converted to the key as described in the 'Password to Key Algorithm' section of RFC3414. The passphrase can contain any printable characters except for the double quotation mark."/>
217 <Annotation Term="Validation.Pattern" String="(^[A-Za-z0-9]+$)|(^\*+$)"/>
218 </Property>
219 <Property Name="EncryptionProtocol" Type="AggregationSource.v1_1_0.SNMPEncryptionProtocols">
220 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
221 <Annotation Term="OData.Description" String="The encryption protocol for SNMPv3."/>
222 <Annotation Term="OData.LongDescription" String="This property shall contain the SNMPv3 encryption protocol."/>
223 </Property>
224 <Property Name="AuthenticationKeySet" Type="Edm.Boolean" Nullable="false">
225 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
226 <Annotation Term="OData.Description" String="Indicates if the AuthenticationKey property is set."/>
227 <Annotation Term="OData.LongDescription" String="This property shall contain `true` if a valid value was provided for the AuthenticationKey property. Otherwise, the property shall contain `false`."/>
228 </Property>
229 <Property Name="EncryptionKeySet" Type="Edm.Boolean" Nullable="false">
230 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
231 <Annotation Term="OData.Description" String="Indicates if the EncryptionKey property is set."/>
232 <Annotation Term="OData.LongDescription" String="This property shall contain `true` if a valid value was provided for the EncryptionKey property. Otherwise, the property shall contain `false`."/>
233 </Property>
234 </ComplexType>
235
236 <EnumType Name="SNMPAuthenticationProtocols">
237 <Member Name="None">
238 <Annotation Term="OData.Description" String="No authentication."/>
239 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication is not required."/>
240 </Member>
241 <Member Name="CommunityString">
242 <Annotation Term="OData.Description" String="Trap community string authentication."/>
243 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication using SNMP community strings and the value of TrapCommunity."/>
244 </Member>
245 <Member Name="HMAC_MD5">
246 <Annotation Term="OData.Description" String="HMAC-MD5-96 authentication."/>
247 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication conforms to the RFC3414-defined HMAC-MD5-96 authentication protocol."/>
248 </Member>
249 <Member Name="HMAC_SHA96">
250 <Annotation Term="OData.Description" String="HMAC-SHA-96 authentication."/>
251 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication conforms to the RFC3414-defined HMAC-SHA-96 authentication protocol."/>
252 </Member>
253 <Member Name="HMAC128_SHA224">
254 <Annotation Term="OData.Description" String="HMAC-128-SHA-224 authentication."/>
255 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication for SNMPv3 access conforms to the RFC7860-defined usmHMAC128SHA224AuthProtocol."/>
256 </Member>
257 <Member Name="HMAC192_SHA256">
258 <Annotation Term="OData.Description" String="HMAC-192-SHA-256 authentication."/>
259 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication for SNMPv3 access conforms to the RFC7860-defined usmHMAC192SHA256AuthProtocol."/>
260 </Member>
261 <Member Name="HMAC256_SHA384">
262 <Annotation Term="OData.Description" String="HMAC-256-SHA-384 authentication."/>
263 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication for SNMPv3 access conforms to the RFC7860-defined usmHMAC256SHA384AuthProtocol."/>
264 </Member>
265 <Member Name="HMAC384_SHA512">
266 <Annotation Term="OData.Description" String="HMAC-384-SHA-512 authentication."/>
267 <Annotation Term="OData.LongDescription" String="This value shall indicate authentication for SNMPv3 access conforms to the RFC7860-defined usmHMAC384SHA512AuthProtocol."/>
268 </Member>
269 </EnumType>
270
271 <EnumType Name="SNMPEncryptionProtocols">
272 <Member Name="None">
273 <Annotation Term="OData.Description" String="No encryption."/>
274 <Annotation Term="OData.LongDescription" String="This value shall indicate there is no encryption."/>
275 </Member>
276 <Member Name="CBC_DES">
277 <Annotation Term="OData.Description" String="CBC-DES encryption."/>
278 <Annotation Term="OData.LongDescription" String="This value shall indicate encryption conforms to the RFC3414-defined CBC-DES encryption protocol."/>
279 </Member>
280 <Member Name="CFB128_AES128">
281 <Annotation Term="OData.Description" String="CFB128-AES-128 encryption."/>
Gunnar Mills2ae81db2024-01-31 14:25:11 -0600282 <Annotation Term="OData.LongDescription" String="This value shall indicate encryption conforms to the RFC3826-defined CFB128-AES-128 encryption protocol."/>
283 </Member>
284 <Member Name="CFB128_AES192">
285 <Annotation Term="OData.Description" String="CFB128-AES-192 encryption."/>
286 <Annotation Term="OData.LongDescription" String="This value shall indicate encryption conforms to the CFB128-AES-192 encryption protocol, extended from RFC3826."/>
287 <Annotation Term="Redfish.Revisions">
288 <Collection>
289 <Record>
290 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
291 <PropertyValue Property="Version" String="v1_4_0"/>
292 </Record>
293 </Collection>
294 </Annotation>
295 </Member>
296 <Member Name="CFB128_AES256">
297 <Annotation Term="OData.Description" String="CFB128-AES-256 encryption."/>
298 <Annotation Term="OData.LongDescription" String="This value shall indicate encryption conforms to the CFB128-AES-256 encryption protocol, extended from RFC3826."/>
299 <Annotation Term="Redfish.Revisions">
300 <Collection>
301 <Record>
302 <PropertyValue Property="Kind" EnumMember="Redfish.RevisionKind/Added"/>
303 <PropertyValue Property="Version" String="v1_4_0"/>
304 </Record>
305 </Collection>
306 </Annotation>
Carson Labrado8b2521a2023-02-18 02:33:14 +0000307 </Member>
308 </EnumType>
309 </Schema>
310
311 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AggregationSource.v1_1_1">
312 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
313 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
314 <EntityType Name="AggregationSource" BaseType="AggregationSource.v1_1_0.AggregationSource"/>
315 </Schema>
316
Gunnar Mills2ae81db2024-01-31 14:25:11 -0600317 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AggregationSource.v1_1_2">
318 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
319 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
320 <EntityType Name="AggregationSource" BaseType="AggregationSource.v1_1_1.AggregationSource"/>
321 </Schema>
322
Carson Labrado8b2521a2023-02-18 02:33:14 +0000323 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AggregationSource.v1_2_0">
324 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
325 <Annotation Term="Redfish.Release" String="2021.3"/>
326
327 <EntityType Name="AggregationSource" BaseType="AggregationSource.v1_1_0.AggregationSource">
328 <Property Name="AggregationType" Type="AggregationSource.v1_2_0.AggregationType" Nullable="false">
329 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
330 <Annotation Term="OData.Description" String="The type of aggregation used towards the aggregation source."/>
331 <Annotation Term="OData.LongDescription" String="This property shall contain the type of aggregation used for the connection method towards the aggregation source. If this property is not present, the value shall be assumed to be `Full`."/>
332 </Property>
333 </EntityType>
334
335 <EnumType Name="AggregationType">
336 <Member Name="NotificationsOnly">
337 <Annotation Term="OData.Description" String="Only notifications are aggregated."/>
338 <Annotation Term="OData.LongDescription" String="This value shall indicate that the aggregator is only aggregating notifications or events from the aggregation source according to the connection method used. This value shall not be used with connection methods that do not include notifications."/>
339 </Member>
340 <Member Name="Full">
341 <Annotation Term="OData.Description" String="Full aggregation according to connection method."/>
342 <Annotation Term="OData.LongDescription" String="This value shall indicate that the aggregator is performing full aggregation according to the connection method without any limitation such as only receiving notifications."/>
343 </Member>
344 </EnumType>
345
346 <ComplexType Name="SNMPSettings" BaseType="AggregationSource.v1_1_0.SNMPSettings">
347 <Property Name="TrapCommunity" Type="Edm.String">
348 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Write"/>
349 <Annotation Term="OData.Description" String="The SNMP trap community string."/>
350 <Annotation Term="OData.LongDescription" String="This property shall contain the SNMP trap community string. The value shall be `null` in responses. Services may provide a common trap community if not specified by the client when creating the aggregation source."/>
351 </Property>
352 </ComplexType>
353 </Schema>
354
355 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AggregationSource.v1_2_1">
356 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
357 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
358 <EntityType Name="AggregationSource" BaseType="AggregationSource.v1_2_0.AggregationSource"/>
359 </Schema>
360
Gunnar Mills2ae81db2024-01-31 14:25:11 -0600361 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AggregationSource.v1_2_2">
362 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
363 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
364 <EntityType Name="AggregationSource" BaseType="AggregationSource.v1_2_1.AggregationSource"/>
365 </Schema>
366
Carson Labrado8b2521a2023-02-18 02:33:14 +0000367 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AggregationSource.v1_3_0">
368 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
369 <Annotation Term="Redfish.Release" String="2022.3"/>
370
371 <EntityType Name="AggregationSource" BaseType="AggregationSource.v1_2_0.AggregationSource">
372 <Property Name="SSHSettings" Type="AggregationSource.v1_3_0.SSHSettingsType">
373 <Annotation Term="OData.Description" String="Settings for an aggregation source using SSH as part of the associated connection method."/>
374 <Annotation Term="OData.LongDescription" String="This property shall contain the settings for an aggregation source using SSH as part of the associated connection method."/>
375 </Property>
376 <Property Name="Status" Type="Resource.Status" Nullable="false">
377 <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
378 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
379 </Property>
380 </EntityType>
381
382 <ComplexType Name="SSHSettingsType">
383 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
384 <Annotation Term="OData.Description" String="Settings for an aggregation source using SSH as part of the associated connection method."/>
385 <Annotation Term="OData.LongDescription" String="This type shall contain the settings for an aggregation source using SSH as part of the associated connection method."/>
386 <Property Name="UserAuthenticationMethod" Type="AggregationSource.v1_3_0.UserAuthenticationMethod">
387 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
388 <Annotation Term="OData.Description" String="The client user authentication method."/>
389 <Annotation Term="OData.LongDescription" String="This property shall contain the client user authentication method."/>
390 </Property>
391 <Property Name="PresentedPublicHostKeyTimestamp" Type="Edm.DateTimeOffset">
392 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
393 <Annotation Term="OData.Description" String="The date and time when the key referenced by the PresentedPublicHostKey property was last updated."/>
394 <Annotation Term="OData.LongDescription" String="This property shall contain the date and time when the key referenced by the PresentedPublicHostKey property was last updated."/>
395 </Property>
396 <NavigationProperty Name="TrustedPublicHostKeys" Type="KeyCollection.KeyCollection" ContainsTarget="true" Nullable="false">
397 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
398 <Annotation Term="OData.Description" String="A link to the trusted public host keys of the remote service corresponding to the aggregation source. These trusted public host keys are used for authentication of the remote service with SSH. An SSH public host key of the remote service can be added to this collection to allow for public key-based SSH authentication."/>
399 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type KeyCollection that represents the trusted public host keys of the remote service corresponding to the aggregation source. If the associated connection method specifies SSH tunneling, the service shall compare the public host key presented by the remote service with members of this collection to determine if the remote service can be trusted. If the remote service cannot be trusted, the State property within Status shall contain `Disabled` and the service shall not connect to the remote service."/>
400 </NavigationProperty>
401 <NavigationProperty Name="PresentedPublicHostKey" Type="Key.Key" ContainsTarget="true" Nullable="false">
402 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
403 <Annotation Term="OData.Description" String="A link to the last public host key presented by the remote service corresponding to the aggregation source. A client that trusts this public host key can add the public host key to the TrustedPublicHostKeys collection to allow SSH communication with the aggregation source."/>
404 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type Key that represents the last public host key presented by the remote service corresponding to the aggregation source. This property shall not be present if a public host key has not yet been presented by the remote service."/>
405 </NavigationProperty>
406 <NavigationProperty Name="PublicIdentityKey" Type="Key.Key" ContainsTarget="true" Nullable="false">
407 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
408 <Annotation Term="OData.Description" String="A link to the public key that is used with the aggregation source when the authentication method is configured to use a public key. The GenerateSSHIdentityKeyPair and RemoveSSHIdentityKeyPair are used to update the key for this aggregation source."/>
409 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type Key that represents the public key that is used with the aggregation source when UserAuthenticationMethod contains `PublicKey`. This property shall not be present if a key-pair is not available. The State property within Status shall contain `Disabled` if a key-pair is not available and UserAuthenticationMethod contains `PublicKey`."/>
410 </NavigationProperty>
411 </ComplexType>
412
413 <EnumType Name="UserAuthenticationMethod">
414 <Member Name="PublicKey">
415 <Annotation Term="OData.Description" String="SSH user authentication with a public key."/>
416 <Annotation Term="OData.LongDescription" String="This value shall indicate SSH user authentication with a public key specified by the PublicIdentityKey property in SSHSettings."/>
417 </Member>
418 <Member Name="Password">
419 <Annotation Term="OData.Description" String="SSH user authentication with a password."/>
420 <Annotation Term="OData.LongDescription" String="This value shall indicate SSH user authentication with a password specified by the Password property."/>
421 </Member>
422 </EnumType>
Carson Labrado8b2521a2023-02-18 02:33:14 +0000423 </Schema>
424
425 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AggregationSource.v1_3_1">
426 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
427 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
428 <EntityType Name="AggregationSource" BaseType="AggregationSource.v1_3_0.AggregationSource"/>
429 </Schema>
430
Gunnar Mills2ae81db2024-01-31 14:25:11 -0600431 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AggregationSource.v1_3_2">
432 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
433 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
434 <EntityType Name="AggregationSource" BaseType="AggregationSource.v1_3_1.AggregationSource"/>
435 </Schema>
436
437 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AggregationSource.v1_4_0">
438 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
439 <Annotation Term="Redfish.Release" String="2023.3"/>
440 <Annotation Term="OData.Description" String="This version was created to add `CFB128_AES192` and `CFB128_AES256` to SNMPEncryptionProtocols."/>
441
442 <EntityType Name="AggregationSource" BaseType="AggregationSource.v1_3_2.AggregationSource"/>
443 </Schema>
444
Carson Labrado8b2521a2023-02-18 02:33:14 +0000445 </edmx:DataServices>
446</edmx:Edmx>