BS ISO/IEC 30115-2:2022
$215.11
Information technology. Redfish scalable platforms management API specification – Redfish Schema Supplement v2021.1
Published By | Publication Date | Number of Pages |
BSI | 2022 | 756 |
PDF Catalog
PDF Pages | PDF Title |
---|---|
2 | undefined |
36 | 1 Overview 1.1 Who should read this document? 1.2 How can I provide feedback? 1.3 Where can I find more information? |
38 | 2 Using this guide 2.1 URI listings |
40 | 3 Common properties 3.1 Properties that all Redfish Schemas define 3.1.1 Properties 3.2 Frequently used properties |
41 | 3.2.1 Properties 3.3 Payload annotations 3.3.1 Property-level annotations 3.3.2 Properties |
42 | 3.3.3 Resource- or object-level annotations 3.3.4 Properties |
43 | 3.3.5 Property details 3.3.5.1 @Redfish.OperationApplyTime: |
44 | 4 Common objects 4.1 Actions 4.1.1 Properties 4.2 Capacity 4.2.1 Description 4.2.2 Properties |
45 | 4.3 Identifier 4.3.1 Description |
46 | 4.3.2 Properties 4.3.3 Property details 4.3.3.1 DurableNameFormat: |
47 | 4.4 IOStatistics 4.4.1 Description 4.4.2 Properties 4.5 IPv4Address 4.5.1 Description |
48 | 4.5.2 Properties 4.5.3 Property details 4.5.3.1 AddressOrigin: 4.6 IPv6Address 4.6.1 Description |
49 | 4.6.2 Properties 4.6.3 Property details 4.6.3.1 AddressOrigin: 4.6.3.2 AddressState: |
50 | 4.7 IPv6GatewayStaticAddress 4.7.1 Description 4.7.2 Properties 4.8 IPv6StaticAddress 4.8.1 Description 4.8.2 Properties |
51 | 4.9 Location 4.9.1 Description 4.9.2 Properties |
55 | 4.9.3 Property details 4.9.3.1 LocationType: 4.9.3.2 Orientation: 4.9.3.3 RackOffsetUnits: |
56 | 4.9.3.4 Reference: 4.10 Message 4.10.1 Description 4.10.2 Properties |
57 | 4.10.3 Property details 4.10.3.1 MessageSeverity: 4.11 Redundancy 4.11.1 Description 4.11.2 Properties |
58 | 4.11.3 Property details 4.11.3.1 Mode: |
59 | 4.12 RedundantGroup 4.12.1 Description 4.12.2 Properties 4.12.3 Property details 4.12.3.1 RedundancyType: |
60 | 4.13 ReplicaInfo 4.13.1 Description 4.13.2 Properties |
62 | 4.13.3 Property details 4.13.3.1 ConsistencyState: |
63 | 4.13.3.2 ConsistencyStatus: 4.13.3.3 ConsistencyType: 4.13.3.4 ReplicaFaultDomain: 4.13.3.5 ReplicaPriority: |
64 | 4.13.3.6 ReplicaProgressStatus: |
65 | 4.13.3.7 ReplicaReadOnlyAccess: 4.13.3.8 ReplicaRecoveryMode: 4.13.3.9 ReplicaRole: |
66 | 4.13.3.10 ReplicaState: |
67 | 4.13.3.11 ReplicaType: 4.13.3.12 ReplicaUpdateMode: 4.13.3.13 RequestedReplicaState: |
68 | 4.13.3.14 UndiscoveredElement: |
69 | 4.14 Schedule 4.14.1 Description 4.14.2 Properties 4.14.3 Property details 4.14.3.1 EnabledDaysOfWeek: |
70 | 4.14.3.2 EnabledMonthsOfYear: |
71 | 4.15 Status 4.15.1 Description 4.15.2 Properties |
72 | 4.15.3 Property details 4.15.3.1 Health: 4.15.3.2 HealthRollup: |
73 | 4.15.3.3 Severity: 4.15.3.4 State: |
75 | 5 Resource Collections 5.0.1 Properties |
76 | 5.1 Resource collection URIs in Redfish v1.6 and later |
88 | 6 Schema Reference Guide 6.1 AccelerationFunction 1.0.3 6.1.1 Description 6.1.2 URIs 6.1.3 Properties |
89 | 6.1.4 Property details 6.1.4.1 AccelerationFunctionType: |
90 | 6.1.5 Example response 6.2 AccountService 1.9.0 |
91 | 6.2.1 Description 6.2.2 URIs 6.2.3 Properties |
94 | 6.2.4 Property details 6.2.4.1 AccountProviderType: 6.2.4.2 Authentication: |
95 | 6.2.4.3 AuthenticationType: 6.2.4.4 ExternalAccountProvider: |
96 | 6.2.4.5 LDAPService: |
97 | 6.2.4.6 LocalAccountAuth: 6.2.4.7 PasswordExchangeProtocols: |
98 | 6.2.4.8 RestrictedPrivileges: 6.2.4.9 SupportedAccountTypes: |
99 | 6.2.4.10 TACACSplusService: 6.2.5 Example response |
101 | 6.3 ActionInfo 1.1.2 6.3.1 Description 6.3.2 Properties |
102 | 6.3.3 Property details 6.3.3.1 DataType: 6.3.4 Example response |
103 | 6.4 AddressPool 1.1.1 6.4.1 Description 6.4.2 URIs 6.4.3 Properties |
120 | 6.4.4 Property details 6.4.4.1 IPv4AddressRange: 6.4.5 Example response |
121 | 6.5 Aggregate 1.0.1 6.5.1 Description 6.5.2 URIs 6.5.3 Properties |
122 | 6.5.4 Actions 6.5.4.1 AddElements 6.5.4.2 RemoveElements |
123 | 6.5.4.3 Reset 6.5.4.4 SetDefaultBootOrder 6.5.5 Property details 6.5.5.1 ResetType: |
124 | 6.5.6 Example response |
125 | 6.6 AggregationService 1.0.1 6.6.1 Description 6.6.2 URIs 6.6.3 Properties |
126 | 6.6.4 Actions 6.6.4.1 Reset |
127 | 6.6.4.2 SetDefaultBootOrder 6.6.5 Property details 6.6.5.1 ResetType: |
128 | 6.6.6 Example response |
129 | 6.7 AggregationSource 1.1.0 6.7.1 Description 6.7.2 URIs 6.7.3 Properties |
131 | 6.7.4 Property details 6.7.4.1 AuthenticationProtocol: 6.7.4.2 EncryptionProtocol: 6.7.5 Example response |
132 | 6.8 Assembly 1.3.0 6.8.1 Description 6.8.2 URIs |
134 | 6.8.3 Properties |
135 | 6.8.4 Property details 6.8.4.1 PhysicalContext: |
137 | 6.8.5 Example response |
138 | 6.9 AttributeRegistry 1.3.6 6.9.1 Description 6.9.2 Properties |
143 | 6.9.3 Property details 6.9.3.1 MapFromCondition: 6.9.3.2 MapFromProperty: |
144 | 6.9.3.3 MapTerms: 6.9.3.4 MapToProperty: |
145 | 6.9.3.5 Type: 6.9.3.5.1 In RegistryEntries: Attributes: 6.9.3.5.2 In RegistryEntries: Dependencies: |
146 | 6.9.4 Example response |
148 | 6.10 Bios 1.2.0 6.10.1 Description 6.10.2 URIs 6.10.3 Properties |
149 | 6.10.4 Actions 6.10.4.1 ChangePassword |
150 | 6.10.4.2 ResetBios 6.10.5 Example response |
151 | 6.11 BootOption 1.0.4 6.11.1 Description 6.11.2 URIs |
152 | 6.11.3 Properties 6.11.4 Property details 6.11.4.1 Alias: |
153 | 6.11.5 Example response 6.12 Certificate 1.3.0 |
154 | 6.12.1 Description 6.12.2 URIs |
156 | 6.12.3 Properties |
158 | 6.12.4 Actions 6.12.4.1 Rekey (v1.1+) |
159 | 6.12.4.2 Renew (v1.1+) 6.12.5 Property details 6.12.5.1 CertificateType: |
160 | 6.12.5.2 KeyUsage: 6.12.6 Example response |
161 | 6.13 CertificateLocations 1.0.2 6.13.1 Description 6.13.2 URIs |
162 | 6.13.3 Properties 6.13.4 Example response 6.14 CertificateService 1.0.4 6.14.1 Description |
163 | 6.14.2 URIs 6.14.3 Properties 6.14.4 Actions 6.14.4.1 GenerateCSR |
166 | 6.14.4.2 ReplaceCertificate |
167 | 6.14.5 Property details 6.14.5.1 CertificateType: 6.14.5.2 KeyUsage: |
168 | 6.14.6 Example response 6.15 Chassis 1.16.0 6.15.1 Description 6.15.2 URIs |
169 | 6.15.3 Properties |
175 | 6.15.4 Actions 6.15.4.1 Reset |
176 | 6.15.5 Property details 6.15.5.1 ChassisType: |
177 | 6.15.5.2 EnvironmentalClass: 6.15.5.3 IndicatorLED: 6.15.5.4 IntrusionSensor: |
178 | 6.15.5.5 IntrusionSensorReArm: 6.15.5.6 PowerState: 6.15.5.7 ResetType: |
179 | 6.15.6 Example response |
181 | 6.16 Circuit 1.2.0 6.16.1 Description 6.16.2 URIs 6.16.3 Properties |
186 | 6.16.4 Actions 6.16.4.1 BreakerControl |
187 | 6.16.4.2 PowerControl 6.16.4.3 ResetMetrics 6.16.5 Property details 6.16.5.1 BreakerState: |
188 | 6.16.5.2 CircuitType: 6.16.5.3 ElectricalContext: |
189 | 6.16.5.4 IndicatorLED: 6.16.5.5 NominalVoltage: |
190 | 6.16.5.6 PhaseWiringType: |
191 | 6.16.5.7 PlugType: |
193 | 6.16.5.8 PowerRestorePolicy: 6.16.5.9 PowerState: 6.16.5.9.1 In Actions: BreakerControl: 6.16.5.9.2 In Actions: PowerControl, : 6.16.5.10 SensorCurrentExcerpt: |
194 | 6.16.5.11 SensorEnergykWhExcerpt: 6.16.5.12 SensorPowerExcerpt: |
195 | 6.16.5.13 SensorVoltageExcerpt: 6.16.5.14 VoltageType: 6.16.6 Example response |
197 | 6.17 CompositionReservation 1.0.0 6.17.1 Description 6.17.2 URIs |
198 | 6.17.3 Properties |
199 | 6.17.4 Property details 6.17.4.1 Expand: 6.17.4.2 StanzaType: |
200 | 6.18 CompositionService 1.2.0 6.18.1 Description 6.18.2 URIs 6.18.3 Properties |
201 | 6.18.4 Actions 6.18.4.1 Compose (v1.2+) |
206 | 6.18.5 Property details 6.18.5.1 Expand: 6.18.5.2 RequestFormat: 6.18.5.3 RequestType: |
207 | 6.18.5.4 StanzaType: 6.18.6 Example response |
208 | 6.19 ComputerSystem 1.15.0 6.19.1 Description 6.19.2 URIs 6.19.3 Properties |
220 | 6.19.4 Actions 6.19.4.1 AddResourceBlock (v1.6+) 6.19.4.2 RemoveResourceBlock (v1.6+) |
221 | 6.19.4.3 Reset 6.19.4.4 SetDefaultBootOrder (v1.5+) |
222 | 6.19.5 Property details 6.19.5.1 AliasBootOrder: 6.19.5.2 AutomaticRetryConfig: |
223 | 6.19.5.3 BootOrderPropertySelection: 6.19.5.4 BootSourceOverrideEnabled: 6.19.5.5 BootSourceOverrideMode: |
224 | 6.19.5.6 BootSourceOverrideTarget: 6.19.5.7 ConnectTypesSupported: |
225 | 6.19.5.8 HostingRoles: 6.19.5.9 IndicatorLED: 6.19.5.10 InterfaceType: |
226 | 6.19.5.11 InterfaceTypeSelection: 6.19.5.12 LastState: |
227 | 6.19.5.13 MemoryMirroring: 6.19.5.14 PowerMode: 6.19.5.15 PowerRestorePolicy: |
228 | 6.19.5.16 PowerState: 6.19.5.17 ResetType: |
229 | 6.19.5.18 SerialConsoleProtocol: 6.19.5.19 StopBootOnFault: |
230 | 6.19.5.20 SystemType: 6.19.5.21 TimeoutAction: 6.19.5.22 TrustedModuleRequiredToBoot: |
231 | 6.19.5.23 UUID: 6.19.5.23.1 Case sensitivity 6.19.5.23.2 Conversion of UUID format |
233 | 6.19.5.24 WarningAction: |
234 | 6.19.6 Example response |
236 | 6.20 Connection 1.1.0 |
237 | 6.20.1 Description 6.20.2 URIs 6.20.3 Properties |
239 | 6.20.4 Property details 6.20.4.1 AccessCapabilities: |
240 | 6.20.4.2 AccessState: 6.20.4.3 ConnectionType: 6.20.5 Example response |
241 | 6.21 ConnectionMethod 1.0.0 6.21.1 Description 6.21.2 URIs 6.21.3 Properties |
242 | 6.21.4 Property details 6.21.4.1 ConnectionMethodType: 6.21.5 Example response |
243 | 6.22 Drive 1.12.1 6.22.1 Description 6.22.2 URIs 6.22.3 Properties |
247 | 6.22.4 Actions 6.22.4.1 Reset (v1.7+) |
248 | 6.22.4.2 SecureErase 6.22.5 Property details 6.22.5.1 EncryptionAbility: 6.22.5.2 EncryptionStatus: |
249 | 6.22.5.3 HotspareReplacementMode: 6.22.5.4 HotspareType: 6.22.5.5 IndicatorLED: |
250 | 6.22.5.6 MediaType: 6.22.5.7 Protocol: |
252 | 6.22.5.8 ResetType: |
253 | 6.22.5.9 StatusIndicator: 6.22.6 Example response |
254 | 6.23 Endpoint 1.6.0 6.23.1 Description 6.23.2 URIs |
255 | 6.23.3 Properties |
258 | 6.23.4 Property details 6.23.4.1 EndpointProtocol: |
260 | 6.23.4.2 EntityRole: 6.23.4.3 EntityType: |
261 | 6.23.4.4 TransportProtocol: |
263 | 6.23.5 Example response |
264 | 6.24 EndpointGroup 1.3.2 6.24.1 Description 6.24.2 URIs |
265 | 6.24.3 Properties |
266 | 6.24.4 Property details 6.24.4.1 AccessState: 6.24.4.2 GroupType: |
267 | 6.24.5 Example response 6.25 EnvironmentMetrics 1.0.0 6.25.1 Description 6.25.2 URIs |
270 | 6.25.3 Properties |
271 | 6.25.4 Actions 6.25.4.1 ResetMetrics |
272 | 6.25.5 Property details 6.25.5.1 PhysicalContext: |
274 | 6.25.5.2 PhysicalSubContext: 6.25.6 Example response 6.26 EthernetInterface 1.6.4 |
275 | 6.26.1 Description 6.26.2 URIs 6.26.3 Properties |
279 | 6.26.4 Property details 6.26.4.1 EthernetInterfaceType: 6.26.4.2 FallbackAddress: |
280 | 6.26.4.3 LinkStatus: 6.26.4.4 OperatingMode: 6.26.5 Example response |
283 | 6.27 Event 1.6.1 6.27.1 Description 6.27.2 Properties |
285 | 6.27.3 Property details 6.27.3.1 EventType: 6.27.3.2 MessageSeverity: |
286 | 6.28 EventDestination 1.10.1 6.28.1 Description 6.28.2 URIs 6.28.3 Properties |
290 | 6.28.4 Actions 6.28.4.1 ResumeSubscription 6.28.5 Property details 6.28.5.1 AuthenticationProtocol: 6.28.5.2 DeliveryRetryPolicy: |
291 | 6.28.5.3 EncryptionProtocol: 6.28.5.4 EventFormatType: 6.28.5.5 EventTypes: |
292 | 6.28.5.6 LogFacilities: |
293 | 6.28.5.7 LowestSeverity: 6.28.5.8 Protocol: |
294 | 6.28.5.9 SubscriptionType: |
295 | 6.28.6 Example response 6.29 EventService 1.7.1 6.29.1 Description 6.29.2 URIs |
296 | 6.29.3 Properties |
298 | 6.29.4 Actions 6.29.4.1 SubmitTestEvent |
299 | 6.29.5 Property details 6.29.5.1 Authentication: 6.29.5.2 ConnectionProtocol: |
300 | 6.29.5.3 EventFormatTypes: 6.29.5.4 EventType: 6.29.5.5 EventTypesForSubscription: |
301 | 6.29.6 Example response |
302 | 6.30 ExternalAccountProvider 1.2.0 6.30.1 Description 6.30.2 URIs 6.30.3 Properties |
305 | 6.30.4 Property details 6.30.4.1 AccountProviderType: 6.30.4.2 AuthenticationType: |
306 | 6.30.4.3 PasswordExchangeProtocols: 6.30.5 Example response |
307 | 6.31 Fabric 1.2.2 6.31.1 Description 6.31.2 URIs 6.31.3 Properties |
308 | 6.31.4 Property details 6.31.4.1 FabricType: |
310 | 6.31.5 Example response |
311 | 6.32 FabricAdapter 1.0.0 6.32.1 Description 6.32.2 URIs 6.32.3 Properties |
314 | 6.32.4 Property details 6.32.4.1 MaxPCIeType: 6.32.4.2 PCIeType: 6.32.5 Example response |
317 | 6.33 Facility 1.1.0 6.33.1 Description 6.33.2 URIs 6.33.3 Properties |
319 | 6.33.4 Property details 6.33.4.1 FacilityType: 6.33.5 Example response |
320 | 6.34 Fan 1.1.0 6.34.1 Description |
321 | 6.34.2 URIs 6.34.3 Properties |
322 | 6.34.4 Property details 6.34.4.1 PhysicalContext: |
324 | 6.34.5 Example response |
325 | 6.35 GraphicsController 1.0.0 6.35.1 Description 6.35.2 URIs 6.35.3 Properties |
327 | 6.35.4 Example response |
328 | 6.36 HostInterface 1.3.0 6.36.1 Description 6.36.2 URIs 6.36.3 Properties |
331 | 6.36.4 Property details 6.36.4.1 AuthenticationModes: 6.36.4.2 HostInterfaceType: 6.36.5 Example response |
332 | 6.37 Job 1.0.7 6.37.1 Description |
333 | 6.37.2 URIs 6.37.3 Properties |
334 | 6.37.4 Property details 6.37.4.1 JobState: |
335 | 6.37.4.2 JobStatus: 6.37.5 Example response |
336 | 6.38 JobService 1.0.4 6.38.1 Description 6.38.2 URIs 6.38.3 Properties |
337 | 6.38.4 Example response |
338 | 6.39 JsonSchemaFile 1.1.4 6.39.1 Description 6.39.2 URIs 6.39.3 Properties |
339 | 6.39.4 Example response |
340 | 6.40 LogEntry 1.9.0 6.40.1 Description 6.40.2 URIs 6.40.3 Properties |
342 | 6.40.4 Property details 6.40.4.1 DiagnosticDataType: |
343 | 6.40.4.2 EntryCode: |
345 | 6.40.4.3 EntryType: 6.40.4.4 EventType: |
346 | 6.40.4.5 SensorType: |
348 | 6.40.4.6 Severity: 6.40.5 Example response |
349 | 6.41 LogService 1.2.0 6.41.1 Description 6.41.2 URIs 6.41.3 Properties |
350 | 6.41.4 Actions 6.41.4.1 ClearLog 6.41.4.2 CollectDiagnosticData (v1.2+) |
351 | 6.41.5 Property details 6.41.5.1 DiagnosticDataType: 6.41.5.2 LogEntryType: 6.41.5.3 LogFacilities: |
352 | 6.41.5.4 LowestSeverity: |
353 | 6.41.5.5 OverWritePolicy: 6.41.6 Example response |
354 | 6.42 Manager 1.12.0 6.42.1 Description 6.42.2 URIs 6.42.3 Properties |
359 | 6.42.4 Actions 6.42.4.1 ForceFailover |
360 | 6.42.4.2 ModifyRedundancySet 6.42.4.3 Reset |
361 | 6.42.4.4 ResetToDefaults (v1.8+) 6.42.5 Property details 6.42.5.1 ConnectTypesSupported: 6.42.5.1.1 In CommandShell: |
362 | 6.42.5.1.2 In GraphicalConsole: 6.42.5.1.3 In SerialConsole: 6.42.5.2 ManagerType: |
363 | 6.42.5.3 PowerState: 6.42.5.4 ResetType: 6.42.5.4.1 In Actions: Reset: |
364 | 6.42.5.4.2 In Actions: ResetToDefaults: 6.42.6 Example response |
366 | 6.43 ManagerAccount 1.8.0 6.43.1 Description 6.43.2 URIs 6.43.3 Properties |
369 | 6.43.4 Property details 6.43.4.1 AccountTypes: |
370 | 6.43.4.2 AuthenticationProtocol: 6.43.4.3 EncryptionProtocol: 6.43.5 Example response |
371 | 6.44 ManagerNetworkProtocol 1.7.0 6.44.1 Description 6.44.2 URIs 6.44.3 Properties |
375 | 6.44.4 Property details 6.44.4.1 AccessMode: 6.44.4.2 AuthenticationProtocol: |
376 | 6.44.4.3 CommunityAccessMode: 6.44.4.4 EncryptionProtocol: 6.44.4.5 NotifyIPv6Scope: |
377 | 6.44.4.6 Protocol: 6.44.5 Example response |
378 | 6.45 MediaController 1.2.0 6.45.1 Description 6.45.2 URIs 6.45.3 Properties |
380 | 6.45.4 Actions 6.45.4.1 Reset 6.45.5 Property details 6.45.5.1 MediaControllerType: 6.45.5.2 ResetType: |
381 | 6.45.6 Example response |
382 | 6.46 Memory 1.12.0 6.46.1 Description 6.46.2 URIs |
383 | 6.46.3 Properties |
389 | 6.46.4 Actions 6.46.4.1 DisablePassphrase |
390 | 6.46.4.2 OverwriteUnit (v1.6+) 6.46.4.3 Reset (v1.8+) 6.46.4.4 SecureEraseUnit |
391 | 6.46.4.5 SetPassphrase 6.46.4.6 UnlockUnit |
392 | 6.46.5 Property details 6.46.5.1 BaseModuleType: 6.46.5.2 ErrorCorrection: 6.46.5.3 MemoryClassification: |
393 | 6.46.5.4 MemoryDeviceType: |
394 | 6.46.5.5 MemoryMedia: 6.46.5.6 MemoryType: |
395 | 6.46.5.7 OperatingMemoryModes: 6.46.5.8 ResetType: |
396 | 6.46.5.9 SecurityState: 6.46.5.10 SecurityStates: |
397 | 6.46.6 Example response |
398 | 6.47 MemoryChunks 1.4.1 6.47.1 Description 6.47.2 URIs 6.47.3 Properties |
399 | 6.47.4 Property details 6.47.4.1 AddressRangeType: |
400 | 6.47.5 Example response |
401 | 6.48 MemoryDomain 1.3.0 6.48.1 Description 6.48.2 URIs 6.48.3 Properties |
402 | 6.48.4 Example response |
403 | 6.49 MemoryMetrics 1.4.1 6.49.1 Description 6.49.2 URIs |
404 | 6.49.3 Properties |
406 | 6.49.4 Actions 6.49.4.1 ClearCurrentPeriod 6.49.5 Example response |
407 | 6.50 MessageRegistry 1.4.2 6.50.1 Description 6.50.2 Properties |
409 | 6.50.3 Property details 6.50.3.1 ClearsIf: 6.50.3.2 MessageSeverity: |
410 | 6.50.3.3 ParamTypes: 6.50.4 Example response |
411 | 6.51 MessageRegistryFile 1.1.3 6.51.1 Description 6.51.2 URIs 6.51.3 Properties |
412 | 6.51.4 Example response 6.52 MetricDefinition 1.2.0 |
413 | 6.52.1 Description 6.52.2 URIs 6.52.3 Properties |
415 | 6.52.4 Property details 6.52.4.1 Calculable: 6.52.4.2 CalculationAlgorithm: |
416 | 6.52.4.3 Implementation: 6.52.4.4 MetricDataType: 6.52.4.5 MetricType: |
417 | 6.52.4.6 PhysicalContext: |
419 | 6.52.5 Example response 6.53 MetricReport 1.4.2 6.53.1 Description |
420 | 6.53.2 URIs 6.53.3 Properties |
421 | 6.53.4 Example response 6.54 MetricReportDefinition 1.4.1 |
422 | 6.54.1 Description 6.54.2 URIs 6.54.3 Properties |
424 | 6.54.4 Property details 6.54.4.1 CollectionFunction: |
425 | 6.54.4.2 CollectionTimeScope: 6.54.4.3 MetricReportDefinitionType: |
426 | 6.54.4.4 ReportActions: 6.54.4.5 ReportUpdates: 6.54.5 Example response |
427 | 6.55 NetworkAdapter 1.7.0 6.55.1 Description |
428 | 6.55.2 URIs 6.55.3 Properties |
432 | 6.55.4 Actions 6.55.4.1 ResetSettingsToDefault |
433 | 6.55.5 Property details 6.55.5.1 MaxPCIeType: 6.55.5.2 PCIeType: |
434 | 6.55.6 Example response |
435 | 6.56 NetworkAdapterMetrics 1.0.0 |
436 | 6.56.1 Description 6.56.2 URIs 6.56.3 Properties |
437 | 6.56.4 Example response 6.57 NetworkDeviceFunction 1.6.0 6.57.1 Description 6.57.2 URIs |
438 | 6.57.3 Properties |
445 | 6.57.4 Property details 6.57.4.1 AuthenticationMethod: 6.57.4.2 BootMode: |
446 | 6.57.4.3 IPAddressType: 6.57.4.4 NetDevFuncCapabilities: 6.57.4.5 NetDevFuncType: |
447 | 6.57.4.6 WWNSource: 6.57.5 Example response |
449 | 6.58 NetworkDeviceFunctionMetrics 1.0.0 6.58.1 Description 6.58.2 URIs 6.58.3 Properties |
450 | 6.59 NetworkInterface 1.2.1 6.59.1 Description 6.59.2 URIs |
451 | 6.59.3 Properties |
452 | 6.59.4 Example response 6.60 NetworkPort 1.4.1 (deprecated) 6.60.1 Description 6.60.2 URIs |
453 | 6.60.3 Properties |
455 | 6.60.4 Property details 6.60.4.1 ActiveLinkTechnology: 6.60.4.2 FCPortConnectionType: |
456 | 6.60.4.3 FlowControlConfiguration: 6.60.4.4 FlowControlStatus: 6.60.4.5 LinkNetworkTechnology: |
457 | 6.60.4.6 LinkStatus: 6.60.4.7 SupportedEthernetCapabilities: 6.60.5 Example response |
458 | 6.61 OperatingConfig 1.0.2 6.61.1 Description 6.61.2 URIs |
459 | 6.61.3 Properties |
460 | 6.61.4 Example response |
461 | 6.62 Outlet 1.1.1 6.62.1 Description 6.62.2 URIs 6.62.3 Properties |
465 | 6.62.4 Actions 6.62.4.1 PowerControl |
466 | 6.62.4.2 ResetMetrics 6.62.5 Property details 6.62.5.1 ElectricalContext: |
467 | 6.62.5.2 IndicatorLED: 6.62.5.3 NominalVoltage: |
468 | 6.62.5.4 OutletType: |
469 | 6.62.5.5 PhaseWiringType: 6.62.5.6 PowerRestorePolicy: |
470 | 6.62.5.7 PowerState: 6.62.5.7.1 In : 6.62.5.7.2 In Actions: PowerControl: 6.62.5.8 SensorCurrentExcerpt: |
471 | 6.62.5.9 SensorVoltageExcerpt: 6.62.5.10 VoltageType: 6.62.6 Example response |
473 | 6.63 OutletGroup 1.0.1 6.63.1 Description 6.63.2 URIs 6.63.3 Properties |
475 | 6.63.4 Actions 6.63.4.1 PowerControl |
476 | 6.63.4.2 ResetMetrics 6.63.5 Property details 6.63.5.1 PowerRestorePolicy: 6.63.5.2 PowerState: 6.63.5.2.1 In : |
477 | 6.63.5.2.2 In Actions: PowerControl: 6.63.6 Example response |
478 | 6.64 PCIeDevice 1.7.0 6.64.1 Description 6.64.2 URIs 6.64.3 Properties |
480 | 6.64.4 Property details 6.64.4.1 DeviceType: |
481 | 6.64.4.2 MaxPCIeType: 6.64.4.3 PCIeType: 6.64.5 Example response |
482 | 6.65 PCIeFunction 1.3.0 6.65.1 Description |
483 | 6.65.2 URIs 6.65.3 Properties |
485 | 6.65.4 Property details 6.65.4.1 DeviceClass: |
486 | 6.65.4.2 FunctionType: 6.65.5 Example response |
487 | 6.66 PCIeSlots 1.4.1 6.66.1 Description 6.66.2 URIs 6.66.3 Properties |
488 | 6.66.4 Property details 6.66.4.1 PCIeType: 6.66.4.2 SlotType: |
489 | 6.66.5 Example response |
490 | 6.67 Port 1.4.0 6.67.1 Description |
491 | 6.67.2 URIs 6.67.3 Properties |
499 | 6.67.4 Actions 6.67.4.1 Reset 6.67.5 Property details 6.67.5.1 ChassisIdSubtype: |
500 | 6.67.5.2 FiberConnectionType: 6.67.5.3 FlowControlConfiguration: 6.67.5.4 FlowControlStatus: |
501 | 6.67.5.5 LinkNetworkTechnology: 6.67.5.6 LinkState: 6.67.5.7 LinkStatus: 6.67.5.8 MediumType: |
502 | 6.67.5.9 PortConnectionType: 6.67.5.10 PortIdSubtype: |
503 | 6.67.5.11 PortMedium: 6.67.5.12 PortProtocol: |
505 | 6.67.5.13 PortType: 6.67.5.14 ResetType: |
506 | 6.67.5.15 SupportedEthernetCapabilities: 6.67.5.16 SupportedSFPTypes: 6.67.5.17 Type: |
507 | 6.67.6 Example response |
508 | 6.68 PortMetrics 1.1.0 6.68.1 Description 6.68.2 URIs 6.68.3 Properties |
512 | 6.68.4 Example response |
513 | 6.69 Power 1.7.1 (deprecated) 6.69.1 Description 6.69.2 URIs 6.69.3 Properties |
519 | 6.69.4 Actions 6.69.4.1 PowerSupplyReset (v1.6+) |
520 | 6.69.5 Property details 6.69.5.1 IndicatorLED: 6.69.5.2 InputType: 6.69.5.3 LimitException: |
521 | 6.69.5.4 LineInputVoltageType: 6.69.5.5 PhysicalContext: |
523 | 6.69.5.6 PowerSupplyType: 6.69.5.7 ResetType: |
524 | 6.69.6 Example response |
527 | 6.70 PowerDistribution 1.0.3 6.70.1 Description 6.70.2 URIs |
528 | 6.70.3 Properties |
532 | 6.70.4 Actions 6.70.4.1 TransferControl 6.70.5 Property details 6.70.5.1 EquipmentType: 6.70.5.2 TransferSensitivity: |
533 | 6.70.6 Example response |
534 | 6.71 PowerDistributionMetrics 1.1.0 6.71.1 Description 6.71.2 URIs 6.71.3 Properties |
535 | 6.71.4 Actions 6.71.4.1 ResetMetrics |
536 | 6.71.5 Example response 6.72 PowerDomain 1.0.1 |
537 | 6.72.1 Description 6.72.2 URIs 6.72.3 Properties |
538 | 6.72.4 Example response 6.73 PowerEquipment 1.0.0 6.73.1 Description |
539 | 6.73.2 URIs 6.73.3 Properties |
540 | 6.73.4 Example response 6.74 PowerSubsystem 1.0.0 6.74.1 Description 6.74.2 URIs |
541 | 6.74.3 Properties 6.74.4 Example response |
542 | 6.75 PowerSupply 1.1.0 6.75.1 Description 6.75.2 URIs 6.75.3 Properties |
545 | 6.75.4 Actions 6.75.4.1 Reset 6.75.5 Property details 6.75.5.1 InputNominalVoltageType: |
546 | 6.75.5.2 NominalVoltageType: |
547 | 6.75.5.3 PhaseWiringType: 6.75.5.4 PhysicalContext: |
549 | 6.75.5.5 PlugType: |
551 | 6.75.5.6 PowerSupplyType: |
552 | 6.75.5.7 ResetType: 6.75.6 Example response |
554 | 6.76 PowerSupplyMetrics 1.0.0 6.76.1 Description 6.76.2 URIs |
555 | 6.76.3 Properties |
559 | 6.76.4 Actions 6.76.4.1 ResetMetrics 6.76.5 Example response |
561 | 6.77 PrivilegeRegistry 1.1.4 6.77.1 Description 6.77.2 Properties |
566 | 6.77.3 Property details 6.77.3.1 PrivilegesUsed: |
567 | 6.77.4 Example response |
568 | 6.78 Processor 1.12.0 6.78.1 Description 6.78.2 URIs |
569 | 6.78.3 Properties |
579 | 6.78.4 Actions 6.78.4.1 Reset (v1.6+) 6.78.5 Property details 6.78.5.1 BaseSpeedPriorityState: 6.78.5.2 EffectiveFamily: |
580 | 6.78.5.3 EffectiveModel: 6.78.5.4 FpgaType: 6.78.5.5 IdentificationRegisters: 6.78.5.6 InstructionSet: |
581 | 6.78.5.7 InterfaceType: 6.78.5.8 MaxPCIeType: |
582 | 6.78.5.9 MemoryType: |
583 | 6.78.5.10 MicrocodeInfo: 6.78.5.11 Model: |
584 | 6.78.5.12 PCIeType: 6.78.5.13 ProcessorArchitecture: 6.78.5.14 ProcessorId: |
585 | 6.78.5.15 ProcessorType: 6.78.5.16 ResetType: |
586 | 6.78.5.17 Step: 6.78.5.18 TurboState: 6.78.5.19 VendorId: |
587 | 6.78.6 Example response |
588 | 6.79 ProcessorMetrics 1.2.1 6.79.1 Description 6.79.2 URIs |
589 | 6.79.3 Properties |
592 | 6.79.4 Actions 6.79.4.1 ClearCurrentPeriod (v1.2+) 6.79.5 Example response |
594 | 6.80 ResourceBlock 1.4.0 6.80.1 Description 6.80.2 URIs 6.80.3 Properties |
597 | 6.80.4 Property details 6.80.4.1 CompositionState: |
598 | 6.80.4.2 Pool: 6.80.4.3 ResourceBlockType: |
599 | 6.80.5 Example response |
600 | 6.81 Role 1.3.1 6.81.1 Description 6.81.2 URIs 6.81.3 Properties |
601 | 6.81.4 Property details 6.81.4.1 AssignedPrivileges: |
602 | 6.81.5 Example response 6.82 RouteEntry 1.0.1 6.82.1 Description 6.82.2 URIs |
603 | 6.82.3 Properties 6.82.4 Example response 6.83 RouteSetEntry 1.0.1 6.83.1 Description |
604 | 6.83.2 URIs 6.83.3 Properties 6.83.4 Example response 6.84 SecureBoot 1.1.0 |
605 | 6.84.1 Description 6.84.2 URIs 6.84.3 Properties 6.84.4 Actions 6.84.4.1 ResetKeys |
606 | 6.84.5 Property details 6.84.5.1 ResetKeysType: 6.84.5.2 SecureBootCurrentBoot: 6.84.5.3 SecureBootMode: |
607 | 6.84.6 Example response 6.85 SecureBootDatabase 1.0.1 6.85.1 Description 6.85.2 URIs |
608 | 6.85.3 Properties 6.85.4 Actions 6.85.4.1 ResetKeys |
609 | 6.85.5 Property details 6.85.5.1 ResetKeysType: 6.85.6 Example response 6.86 Sensor 1.3.0 |
610 | 6.86.1 Description 6.86.2 URIs 6.86.3 Properties |
614 | 6.86.4 Actions 6.86.4.1 ResetMetrics 6.86.5 Property details 6.86.5.1 Activation: |
615 | 6.86.5.2 ElectricalContext: |
616 | 6.86.5.3 Implementation: 6.86.5.4 PhysicalContext: |
618 | 6.86.5.5 PhysicalSubContext: 6.86.5.6 ReadingType: |
619 | 6.86.5.7 Threshold: |
620 | 6.86.5.8 VoltageType: 6.86.6 Example response |
621 | 6.87 SerialInterface 1.1.8 6.87.1 Description 6.87.2 URIs 6.87.3 Properties |
622 | 6.87.4 Property details 6.87.4.1 BitRate: 6.87.4.2 ConnectorType: |
623 | 6.87.4.3 DataBits: 6.87.4.4 FlowControl: 6.87.4.5 Parity: 6.87.4.6 PinOut: |
624 | 6.87.4.7 SignalType: 6.87.4.8 StopBits: 6.87.5 Example response |
625 | 6.88 ServiceRoot 1.10.0 6.88.1 Description 6.88.2 URIs 6.88.3 Properties |
630 | 6.88.4 Property details 6.88.4.1 idRef: 6.88.5 Example response |
631 | 6.89 Session 1.3.0 6.89.1 Description 6.89.2 URIs |
632 | 6.89.3 Properties 6.89.4 Property details 6.89.4.1 SessionType: |
633 | 6.89.5 Example response 6.90 SessionService 1.1.8 6.90.1 Description 6.90.2 URIs 6.90.3 Properties |
634 | 6.90.4 Example response 6.91 Signature 1.0.2 6.91.1 Description 6.91.2 URIs |
635 | 6.91.3 Properties 6.91.4 Property details 6.91.4.1 SignatureTypeRegistry: 6.91.5 Example response |
636 | 6.92 SimpleStorage 1.3.1 6.92.1 Description 6.92.2 URIs 6.92.3 Properties |
637 | 6.92.4 Example response |
638 | 6.93 SoftwareInventory 1.4.0 |
639 | 6.93.1 Description 6.93.2 URIs 6.93.3 Properties |
640 | 6.93.4 Example response |
641 | 6.94 Storage 1.10.1 6.94.1 Description 6.94.2 URIs 6.94.3 Properties |
646 | 6.94.4 Actions 6.94.4.1 SetEncryptionKey |
647 | 6.94.5 Property details 6.94.5.1 idRef: 6.94.5.2 MaxPCIeType: 6.94.5.3 PCIeType: |
648 | 6.94.5.4 SupportedControllerProtocols: |
649 | 6.94.5.5 SupportedDeviceProtocols: |
651 | 6.94.5.6 SupportedRAIDTypes: |
653 | 6.94.6 Example response |
654 | 6.95 StorageController 1.2.0 6.95.1 Description 6.95.2 URIs |
655 | 6.95.3 Properties |
661 | 6.95.4 Property details 6.95.4.1 AccessState: 6.95.4.2 ControllerType: 6.95.4.3 MaxPCIeType: |
662 | 6.95.4.4 PCIeType: 6.95.4.5 SupportedControllerProtocols: |
664 | 6.95.4.6 SupportedDeviceProtocols: |
666 | 6.95.4.7 SupportedRAIDTypes: |
667 | 6.95.5 Example response |
668 | 6.96 Switch 1.6.0 6.96.1 Description 6.96.2 URIs |
669 | 6.96.3 Properties |
671 | 6.96.4 Actions 6.96.4.1 Reset |
672 | 6.96.5 Property details 6.96.5.1 IndicatorLED: 6.96.5.2 PowerState: |
673 | 6.96.5.3 ResetType: 6.96.5.4 SupportedProtocols: |
675 | 6.96.5.5 SwitchType: |
677 | 6.96.6 Example response |
678 | 6.97 Task 1.5.1 6.97.1 Description |
679 | 6.97.2 URIs 6.97.3 Properties |
680 | 6.97.4 Property details 6.97.4.1 TaskState: |
681 | 6.97.4.2 TaskStatus: 6.97.5 Example response |
682 | 6.98 TaskService 1.2.0 6.98.1 Description 6.98.2 URIs 6.98.3 Properties |
683 | 6.98.4 Property details 6.98.4.1 CompletedTaskOverWritePolicy: 6.98.5 Example response 6.99 TelemetryService 1.3.1 |
684 | 6.99.1 Description 6.99.2 URIs 6.99.3 Properties |
685 | 6.99.4 Actions 6.99.4.1 ClearMetricReports (v1.3+) 6.99.4.2 ResetMetricReportDefinitionsToDefaults (v1.3+) 6.99.4.3 ResetTriggersToDefaults (v1.3+) |
686 | 6.99.4.4 SubmitTestMetricReport |
687 | 6.99.5 Property details 6.99.5.1 SupportedCollectionFunctions: 6.99.6 Example response |
688 | 6.100 Thermal 1.7.1 (deprecated) 6.100.1 Description 6.100.2 URIs 6.100.3 Properties |
693 | 6.100.4 Property details 6.100.4.1 DeltaPhysicalContext: |
695 | 6.100.4.2 IndicatorLED: 6.100.4.3 PhysicalContext: |
697 | 6.100.4.4 ReadingUnits: 6.100.5 Example response |
701 | 6.101 ThermalMetrics 1.0.0 6.101.1 Description 6.101.2 URIs 6.101.3 Properties |
702 | 6.101.4 Actions 6.101.4.1 ResetMetrics 6.101.5 Property details 6.101.5.1 PhysicalContext: |
704 | 6.101.5.2 PhysicalSubContext: |
705 | 6.101.5.3 SensorExcerpt: 6.101.6 Example response |
706 | 6.102 ThermalSubsystem 1.0.0 6.102.1 Description 6.102.2 URIs |
707 | 6.102.3 Properties 6.102.4 Example response |
708 | 6.103 Triggers 1.1.4 6.103.1 Description 6.103.2 URIs |
709 | 6.103.3 Properties |
711 | 6.103.4 Property details 6.103.4.1 Activation: 6.103.4.2 DiscreteTriggerCondition: 6.103.4.3 MetricType: 6.103.4.4 Severity: |
712 | 6.103.4.5 Threshold: 6.103.4.6 TriggerActions: 6.103.5 Example response |
713 | 6.104 UpdateService 1.9.0 6.104.1 Description 6.104.2 URIs |
714 | 6.104.3 Properties |
716 | 6.104.4 Actions 6.104.4.1 SimpleUpdate |
717 | 6.104.4.2 StartUpdate (v1.7+) 6.104.5 Property details 6.104.5.1 ApplyTime: |
718 | 6.104.5.2 TransferProtocol: 6.104.6 Example response |
719 | 6.105 USBController 1.0.0 6.105.1 Description 6.105.2 URIs |
720 | 6.105.3 Properties |
721 | 6.105.4 Example response 6.106 VCATEntry 1.0.1 |
722 | 6.106.1 Description 6.106.2 URIs 6.106.3 Properties 6.106.4 Example response |
723 | 6.107 VirtualMedia 1.4.0 6.107.1 Description 6.107.2 URIs |
724 | 6.107.3 Properties |
725 | 6.107.4 Actions 6.107.4.1 EjectMedia (v1.2+) 6.107.4.2 InsertMedia (v1.2+) |
726 | 6.107.5 Property details 6.107.5.1 ConnectedVia: 6.107.5.2 MediaTypes: 6.107.5.3 TransferMethod: |
727 | 6.107.5.4 TransferProtocolType: 6.107.6 Example response 6.108 VLanNetworkInterface 1.2.0 |
728 | 6.108.1 Description 6.108.2 URIs 6.108.3 Properties 6.108.4 Example response |
729 | 6.109 Volume 1.6.2 6.109.1 Description 6.109.2 URIs |
730 | 6.109.3 Properties |
736 | 6.109.4 Actions 6.109.4.1 AssignReplicaTarget (v1.4+) |
737 | 6.109.4.2 ChangeRAIDLayout (v1.5+) 6.109.4.3 CheckConsistency |
738 | 6.109.4.4 CreateReplicaTarget (v1.4+) 6.109.4.5 ForceEnable (v1.5+) 6.109.4.6 Initialize (v1.5+) |
739 | 6.109.4.7 RemoveReplicaRelationship (v1.4+) 6.109.4.8 ResumeReplication (v1.4+) |
740 | 6.109.4.9 ReverseReplicationRelationship (v1.4+) 6.109.4.10 SplitReplication (v1.4+) 6.109.4.11 SuspendReplication (v1.4+) |
741 | 6.109.5 Property details 6.109.5.1 AccessCapabilities: 6.109.5.2 EncryptionTypes: 6.109.5.3 idRef: 6.109.5.4 InitializeMethod: |
742 | 6.109.5.5 InitializeType: 6.109.5.6 ProvisioningPolicy: 6.109.5.7 RAIDType: |
744 | 6.109.5.8 ReadCachePolicy: 6.109.5.9 ReplicaType: 6.109.5.10 ReplicaUpdateMode: 6.109.5.11 VolumeType: |
745 | 6.109.5.12 VolumeUsage: 6.109.5.13 WriteCachePolicy: |
746 | 6.109.5.14 WriteCacheState: 6.109.5.15 WriteHoleProtectionPolicy: 6.109.6 Example response |
747 | 6.110 Zone 1.6.1 6.110.1 Description 6.110.2 URIs |
748 | 6.110.3 Properties |
749 | 6.110.4 Actions 6.110.4.1 AddEndpoint (v1.5+) |
750 | 6.110.4.2 RemoveEndpoint (v1.5+) 6.110.5 Property details 6.110.5.1 ExternalAccessibility: |
751 | 6.110.5.2 ZoneType: 6.110.6 Example response |
753 | 7 Redfish documentation generator |
754 | 8 ANNEX A |