DSP2046 2023.1
Uploaded by
saiakkinaDSP2046 2023.1
Uploaded by
saiakkinaDocument Identifier: DSP2046
Date: 2023-04-06
Version: 2023.1
Redfish Resource and Schema Guide
Supersedes: 2022.3
Document Class: Informational
Document Status: Published
Document Language: en-US
Redfish Resource and Schema Guide DSP2046
Copyright Notice
Copyright © 2019-2023 DMTF. All rights reserved.
DMTF is a not-for-profit association of industry members dedicated to promoting enterprise
and systems management and interoperability. Members and non-members may reproduce
DMTF specifications and documents, provided that correct attribution is given. As DMTF
specifications may be revised from time to time, the particular version and release date
should always be noted.
Implementation of certain elements of this standard or proposed standard may be subject
to third party patent rights, including provisional patent rights (herein "patent rights").
DMTF makes no representations to users of the standard as to the existence of such rights,
and is not responsible to recognize, disclose, or identify any or all such third party patent
right, owners or claimants, nor for any incomplete or inaccurate identification or disclosure
of such rights, owners or claimants. DMTF shall have no liability to any party, in any
manner or circumstance, under any legal theory whatsoever, for failure to recognize,
disclose, or identify any such third party patent rights, or for such party's reliance on the
standard or incorporation thereof in its product, protocols or testing procedures. DMTF
shall have no liability to any party implementing such standard, whether such
implementation is foreseeable or not, nor to any patent owner or claimant, and shall have
no liability or responsibility for costs or losses incurred if a standard is withdrawn or
modified after publication, and shall be indemnified and held harmless by any party
implementing the standard from any and all claims of infringement by a patent owner for
such implementations.
For information about patents held by third-parties which have notified DMTF that, in their
opinion, such patent may relate to or impact implementations of DMTF standards, visit
http://www.dmtf.org/about/policies/disclosures.php.
This document's normative language is English. Translation into other languages is
permitted.
2 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
CONTENTS
1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.1 Who should read this document?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.2 How can I provide feedback? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.3 Where can I find more information? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
1.4 Related documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2 Using this guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.1 URI listings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
3 Common properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.1 Properties that all Redfish schemas define . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.2 Frequently used properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3.3 Payload annotations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
4 Common objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4.1 Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4.2 Capacity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
4.3 Condition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.4 Identifier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.5 IOStatistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
4.6 IPv4Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.7 IPv6Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
4.8 IPv6GatewayStaticAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.9 IPv6StaticAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.10 Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.11 Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
4.12 Redundancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
4.13 RedundantGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
4.14 ReplicaInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
4.15 Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
4.16 Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
5 Resource collections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
5.1 Collection capabilities annotation (#CollectionCapabilities) . . . . . . . . . . . . . . . . . . . 52
5.2 Resource collection URIs in Redfish v1.6 and later . . . . . . . . . . . . . . . . . . . . . . . . . . 54
6 Reference Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
6.1 AccelerationFunction 1.0.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
6.2 AccountService 1.13.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
6.3 ActionInfo 1.3.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
6.4 AddressPool 1.2.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
6.5 Aggregate 1.0.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
6.6 AggregationService 1.0.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
6.7 AggregationSource 1.3.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
6.8 AllowDeny 1.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
6.9 Assembly 1.4.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Version 2023.1 Published 3
Redfish Resource and Schema Guide DSP2046
6.10 AttributeRegistry 1.3.6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
6.11 Battery 1.2.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
6.12 BatteryMetrics 1.0.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
6.13 Bios 1.2.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
6.14 BootOption 1.0.4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
6.15 Cable 1.2.1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
6.16 Certificate 1.7.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
6.17 CertificateLocations 1.0.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
6.18 CertificateService 1.0.4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
6.19 Chassis 1.23.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
6.20 Circuit 1.7.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
6.21 ComponentIntegrity 1.2.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
6.22 CompositionReservation 1.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
6.23 CompositionService 1.2.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
6.24 ComputerSystem 1.20.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
6.25 Connection 1.2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
6.26 ConnectionMethod 1.1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
6.27 Control 1.3.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
6.28 CoolantConnector 1.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
6.29 CoolingLoop 1.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
6.30 CoolingUnit 1.0.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
6.31 CXLLogicalDevice 1.0.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 304
6.32 Drive 1.17.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
6.33 DriveMetrics 1.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
6.34 Endpoint 1.8.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
6.35 EndpointGroup 1.3.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
6.36 EnvironmentMetrics 1.3.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
6.37 EthernetInterface 1.10.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
6.38 Event 1.8.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
6.39 EventDestination 1.13.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363
6.40 EventService 1.10.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
6.41 ExternalAccountProvider 1.6.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
6.42 Fabric 1.3.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
6.43 FabricAdapter 1.5.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
6.44 Facility 1.4.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
6.45 Fan 1.4.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
6.46 Filter 1.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
6.47 GraphicsController 1.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
6.48 Heater 1.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
6.49 HeaterMetrics 1.0.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
6.50 HostInterface 1.3.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
6.51 Job 1.2.1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433
6.52 JobService 1.0.4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
4 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.53 JsonSchemaFile 1.1.4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
6.54 Key 1.2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
6.55 KeyPolicy 1.0.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
6.56 KeyService 1.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
6.57 LeakDetection 1.0.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449
6.58 LeakDetector 1.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454
6.59 License 1.1.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
6.60 LicenseService 1.1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
6.61 LogEntry 1.15.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
6.62 LogService 1.4.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
6.63 Manager 1.18.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484
6.64 ManagerAccount 1.10.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
6.65 ManagerDiagnosticData 1.2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
6.66 ManagerNetworkProtocol 1.9.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
6.67 MediaController 1.3.0 (deprecated) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
6.68 Memory 1.17.1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 520
6.69 MemoryChunks 1.5.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 543
6.70 MemoryDomain 1.5.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
6.71 MemoryMetrics 1.7.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
6.72 MessageRegistry 1.6.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
6.73 MessageRegistryFile 1.1.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
6.74 MetricDefinition 1.3.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
6.75 MetricReport 1.5.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 568
6.76 MetricReportDefinition 1.4.3. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
6.77 NetworkAdapter 1.9.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 576
6.78 NetworkAdapterMetrics 1.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
6.79 NetworkDeviceFunction 1.9.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
6.80 NetworkDeviceFunctionMetrics 1.1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
6.81 NetworkInterface 1.2.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
6.82 NetworkPort 1.4.1 (deprecated) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
6.83 OperatingConfig 1.0.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
6.84 Outlet 1.4.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
6.85 OutletGroup 1.1.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
6.86 PCIeDevice 1.11.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
6.87 PCIeFunction 1.5.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639
6.88 PCIeSlots 1.5.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
6.89 Port 1.9.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
6.90 PortMetrics 1.4.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
6.91 Power 1.7.1 (deprecated) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 680
6.92 PowerDistribution 1.3.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695
6.93 PowerDistributionMetrics 1.3.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 702
6.94 PowerDomain 1.2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 705
6.95 PowerEquipment 1.2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 708
Version 2023.1 Published 5
Redfish Resource and Schema Guide DSP2046
6.96 PowerSubsystem 1.1.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 710
6.97 PowerSupply 1.5.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 712
6.98 PowerSupplyMetrics 1.1.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726
6.99 PrivilegeRegistry 1.1.4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736
6.100 Processor 1.18.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 743
6.101 ProcessorMetrics 1.6.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 764
6.102 Pump 1.0.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 771
6.103 RegisteredClient 1.1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 776
6.104 Reservoir 1.0.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 778
6.105 ResourceBlock 1.4.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 783
6.106 Role 1.3.1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 790
6.107 RouteEntry 1.0.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 792
6.108 RouteSetEntry 1.0.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 794
6.109 SecureBoot 1.1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 796
6.110 SecureBootDatabase 1.0.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 799
6.111 SecurityPolicy 1.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 801
6.112 Sensor 1.7.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 808
6.113 SerialInterface 1.1.8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 821
6.114 ServiceConditions 1.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 825
6.115 ServiceRoot 1.16.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 827
6.116 Session 1.6.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 835
6.117 SessionService 1.1.8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 837
6.118 Signature 1.0.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 838
6.119 SimpleStorage 1.3.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 840
6.120 SoftwareInventory 1.9.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 842
6.121 Storage 1.15.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 846
6.122 StorageController 1.7.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 862
6.123 StorageControllerMetrics 1.0.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 883
6.124 Switch 1.9.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 887
6.125 SwitchMetrics 1.0.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 898
6.126 Task 1.7.1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 900
6.127 TaskService 1.2.0. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 904
6.128 TelemetryService 1.3.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 906
6.129 Thermal 1.7.1 (deprecated) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 911
6.130 ThermalEquipment 1.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 924
6.131 ThermalMetrics 1.2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 925
6.132 ThermalSubsystem 1.2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 931
6.133 Triggers 1.3.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 934
6.134 TrustedComponent 1.1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 939
6.135 UpdateService 1.11.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 942
6.136 USBController 1.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 948
6.137 VCATEntry 1.0.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 950
6.138 VirtualMedia 1.6.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 952
6 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.139 VLanNetworkInterface 1.3.0 (deprecated) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 957
6.140 Volume 1.9.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 959
6.141 Zone 1.6.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 985
7 Redfish documentation generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 991
8 ANNEX A (informative) Change log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 992
Version 2023.1 Published 7
Redfish Resource and Schema Guide DSP2046
1 Overview
The Redfish standard comprises a set of specifications maintained by the Redfish Forum, a working
group within DMTF. The standard defines a protocol that uses RESTful interfaces to provide access to
data and operations associated with the management of systems and networks. One of the strengths
of the Redfish protocol is that it works with a wide range of servers: from stand-alone servers to rack-
mount and bladed environments to large-scale data centers and cloud environments.
The Redfish standard addresses several key issues for infrastructures that require scalability. Large
infrastructures often consist of many simple servers of different makes and types. This hyper-scale
usage model requires a new approach to systems management. The Redfish protocol addresses these
needs by providing a standard protocol based on out-of-band systems management.
With these goals in mind, the Redfish protocol was designed as an open-industry standard to meet
scalability requirements in multi-vendor deployments. It easily integrates with commonly used tools,
using RESTful interfaces to perform operations and using JSON for data payloads.
1.1 Who should read this document?
This document is useful to people are consumers of the Redfish interface and want to understand the
Redfish data model. These users might not be developing Redfish-enabled software.
1.2 How can I provide feedback?
Feedback on all Redfish specifications and documents is encouraged. Feedback can be directed to
DMTF and the Redfish Forum by the following means:
• Redfish User Forum: http://www.redfishforum.com User forum monitored by DMTF Redfish
Forum personnel to answer questions about any Redfish-related topics.
• DMTF Feedback Portal: https://www.dmtf.org/standards/feedback Formal submission portal for
enhancements or proposals to DMTF and the Redfish Forum.
1.3 Where can I find more information?
The following web sites provide more information about the Redfish standard:
• Redfish Developer Hub
Resources for developers who use Redfish to build applications. Contains an interactive schema
explorer, hosted schema, and other links.
8 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
• Redfish Specification Forum
DMTF Redfish-monitored user forum. Answers questions about Redfish-related topics.
• DMTF GitHub repositories
Open source tools and libraries for working with Redfish.
• Redfish standards
Schemas, specifications, mockups, white papers, FAQ, educational material, and more.
• DMTF Redfish Forum
Working group that maintains the Redfish standard. Site lists member companies, future work and
schedules, charter, and information about joining.
1.4 Related documents
The following documents are part of the Redfish development effort. They can be accessed or
downloaded from DMTF's Redfish Standards web site: http://www.dmtf.org/standards/redfish
• DSP0218 - Platform Level Data Model (PLDM) for Redfish Device Enablement Specification - Binary-
encoded JSON (BEJ) and dictionary-based mapping of Redfish schemas and properties into PLDM
messages.
• DSP0266 - Redfish Specification - Main Redfish Specification.
• DSP0268 - Redfish Data Model Specification - Normative descriptions and additional text for every
schema defined in DSP8010 and example payloads for every resource.
• DSP0270 - Redfish Host Interface Specification - "In-band" or "OS-based" Redfish host interface.
• DSP0272 - Redfish Interoperability Profiles Specification - Structure and JSON document that is
used to define and publish an interoperability profile that checks an implementation's
conformance to a defined minimum set of functionality.
• DSP2043 - Redfish Mockups Bundle - Set of mockups that can be used as sample output from
GETs from a Redfish service. Informative in nature, it was used to develop the schema. A person
can set up an NGINX or similar server and configure it to output JSON format and then use this
directory for demonstration purposes.
• DSP2044 - Redfish White Paper - Non-normative document helping those new to Redfish
understand how to interact with the Redfish service and understand common functions and tasks.
• DSP2046 - Redfish Resource and Schema Guide - Informative documentation regarding common
Redfish resource properties and a listing of properties that can be found in each of the Redfish
resources.
• DSP2053 - Redfish Property Guide - Informative documentation providing an index to individual
Version 2023.1 Published 9
Redfish Resource and Schema Guide DSP2046
property definitions across all Redfish schema.
• DSP2065 - Redfish Message Registry Guide - Informative documentation providing details
regarding the messages defined in Redfish standard message registries.
• DSP8010 - Redfish Schema - Redfish schema definitions. These files are normative in nature and
are normatively referenced by the Redfish Specification. The three schema formats are CSDL
(OData Common Schema Definition Language format, which is in XML), JSON Schema, and
OpenAPI schema. These schema definitions should be functionally equivalent, thus specifying the
schema in two different languages.
• DSP8011 - Redfish Standard Registries - Redfish registry definitions. This bundle of Redfish
registries includes message registries used for Redfish-defined messages including events and
privilege maps.
• DSP8013 - Redfish Interoperability Profiles Bundle - Bundle of published Redfish interoperability
profile documents and supporting schema and sample documents used for creating profiles.
10 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
2 Using this guide
Every Redfish response consists of a JSON payload containing properties that are strictly defined by a
schema for that resource. The schema that defines a resource can be determined from the value of
the @odata.type property returned in every Redfish response. This guide details the definitions for
every Redfish standard schema.
Each schema section contains:
• The name, current version, and description of the schema.
• The release history of the schema. Lists each minor schema version and the DSP8010 release
bundle that included it.
• List of the possible URIs where schema-defined resources can appear in a Redfish service following
specification version v1.6 or later. See URI listings.
• Table that defines each property. Shows additional details for those properties when needed.
• List of available actions defined for the schema.
• Example JSON payload for a resource using the schema.
The property-level details include:
Column Purpose
The case-sensitive name of the JSON property as it appears in the JSON payload.
Property name Lists the schema version in parentheses when properties were added to or deprecated
in the schema after the initial v1.0.0 release.
The JSON data types for the property, which can include boolean, number, string, or
object.
Type The string (enum) tag identifies enumerated strings.
Number types that use units specify the units.
Designates whether:
• The property is read-only or read-write, if supported by the implementation.
Attributes
• The service might return a null value if the property value is temporarily
unavailable.
Version 2023.1 Published 11
Redfish Resource and Schema Guide DSP2046
Column Purpose
The description of the property, as copied directly from the schema's definition of the
Description property.
2.1 URI listings
The Redfish Specification v1.6.0 added mandatory support for the OpenAPI Specification v3.0. As part
of this support, the URIs for every Redfish resource are defined to appear at known, fixed locations.
Resource collections also appear at fixed locations, with the members of each collection appearing at
URIs constructed by using a fixed path structure, with appropriate path segments equal to the value of
Id properties of members along the path.
Support for v1.6.0 and OpenAPI can be determined by comparing the value of the RedfishVersion
property in the service root ( /redfish/v1/ ). Services that report a 1.6.0 or higher value, such as
1.6.1 or 1.7.0 , adhere to the URI definitions.
The URI listings do not apply to Redfish services that support specification versions earlier than v1.6.0.
For those services, clients must use the hypermedia features of the API to discover hyperlinks from the
service root to each resource. While services typically match the URIs listed in this document for many
of their resources, this match is not guaranteed and results in errors.
12 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
3 Common properties
3.1 Properties that all Redfish schemas define
The following properties are defined for inclusion in every Redfish schema, and therefore may be
encountered in any response payload. They are documented here in this guide to avoid repetition in
the Reference guide property tables.
Note: Several of these properties are payload annotations but appear here because they are
required for all Redfish resources.
3.1.1 Properties
Property Type Attributes Notes
string
@odata.context read-only The OData description of a payload.
(URI)
@odata.etag string read-only The current ETag of the resource.
string read-only
@odata.id The unique identifier for a resource.
(URI) required
read-only
@odata.type string The type of a resource.
required
The description of this resource. Used for commonality in the schema
Description string read-only
definitions.
read-only The unique identifier for this resource within the collection of similar
Id string
required resources.
read-only
Name string The name of the resource or array member.
required
The manufacturer- or provider-specific extension moniker that divides the
Oem {} object
Oem object into sections.
3.2 Frequently used properties
In addition, the following properties are frequently defined in Redfish schemas. Their definition and
usage is the same throughout the Redfish data model.
Version 2023.1 Published 13
Redfish Resource and Schema Guide DSP2046
3.2.1 Properties
Property Type Attributes Notes
Actions {} object The Redfish actions available for this Resource.
The links associated with the Resource, as defined by that Resource's schema
definition. All associated reference properties defined for a Resource are
Links {} object
nested under the Links property. Find all directly referenced, or subordinate,
Resource properties from the root of the Resource.
An array of links. Each link points to a Resource or part of a Resource as
defined by that Resource's schema. This representation is not intended to be a
strong linking methodology like other references. Instead, it shows a
RelatedItem relationship between elements or subelements in disparate parts of the
array
[{ service. For example, fans might be in one area of the system and processors
in another. The relationship between the two might not be obvious. This
property can show that one is related to the other. In this example, it might
indicate that a specific fan cools a specific processor.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
3.3 Payload annotations
Payload annotations are a mechanism in which a service provides additional information about a given
property or object. Redfish limits usage of these annotations to OData core terms, Redfish extensions,
or Redfish messages.
3.3.1 Property-level annotations
A payload annotation for a single property takes the form of an additional property named
[email protected] , where Property is the JSON property being annotated, Schema is the schema
file where the definition for the annotation is found, and Term is the name of the annotation.
14 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
3.3.2 Properties
Property Type Attributes Notes
The additional information for a set of message structures for a
@Message.ExtendedInfo property. These messages can be useful when a property is null
object
{} due to an error condition and the service wants to convey why the
property is null .
@odata.count integer read-only The number of items in a collection.
@Redfish.AllowableValues array The string values that a service accepts for a property or action
read-only
[] (string) parameter.
In the following example, the property ResetType is annotated with the Redfish schema-defined
AllowableValues term. Redfish is an alias for RedfishExtensions . This term indicates to the client that
the service supports the values On and ForceOff for ResetType .
{
"[email protected]": [
"On",
"ForceOff"
]
}
3.3.3 Resource-level or object-level annotations
A payload annotation for an entire Resource or a JSON object takes the @Schema.Term form, where
Schema is the schema file where the definition is found and Term is the name of the annotation. These
payload annotations are used to provide further information about the object itself.
3.3.4 Properties
Property Type Attributes Notes
string The URI to an ActionInfo Resource, which describes the
@Redfish.ActionInfo read-only
(URI) parameters that this Action instance supports.
The reference to the Resource that represents the POST
@Redfish.CollectionCapabilities {} object capabilities of a collection. For property details, see
CollectionCapabilities.
Version 2023.1 Published 15
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The maintenance window configuration that defines
@Redfish.MaintenanceWindow {} object when to apply settings or operations to a Resource. For
property details, see MaintenanceWindow.
The client's requested apply time to complete a create,
string delete, or action operation. For the possible property
@Redfish.OperationApplyTime read-write
(enum) values, see @Redfish.OperationApplyTime in Property
details.
An indication of whether a client can request a specific
@Redfish.OperationApplyTimeSupport apply time for a create, delete, or action operation for a
object
{} Resource through the OperationApplyTime term. For
property details, see OperationApplyTimeSupport.
The reference to the Resource that represents the
@Redfish.Settings {} object settings to apply to this object. For property details, see
Settings.
The configuration settings that define when to apply
@Redfish.SettingsApplyTime {} object the settings to a Resource. For property details, see
PreferredApplyTime.
3.3.5 Property details
3.3.5.1 @Redfish.OperationApplyTime
The client's requested apply time to complete a create, delete, or action operation.
string Description
The requested operation is applied within the administrator-specified maintenance
AtMaintenanceWindowStart
window.
The requested operation is applied immediately. This value might result in an immediate
Immediate
host reset, manager reset, or other side effects.
The requested operation is applied after a reset but within the administrator-specified
InMaintenanceWindowOnReset
maintenance window.
OnReset The requested operation is applied on a reset.
The requested operation is applied when the StartUpdate action of the update service is
OnStartUpdateRequest
invoked.
This example annotates the object with the Redfish schema-defined action info term. Redfish is an
16 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
alias for RedfishExtensions . This term indicates that the client can find more information about the
#ComputerSystem.Reset action at the /redfish/v1/Systems/1/ResetActionInfo URI:
{
"#ComputerSystem.Reset": {
"target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset",
"@Redfish.ActionInfo": "/redfish/v1/Systems/1/ResetActionInfo"
}
}
Version 2023.1 Published 17
Redfish Resource and Schema Guide DSP2046
4 Common objects
Redfish schemas frequently define the following JSON objects. Like the individual common properties
listed above, these objects share a common definition that is shown here to avoid repetition in the
Reference guide property tables.
4.1 Actions
The Actions object contains the available for a resource.
4.1.1 Properties
Property Type Attributes Notes
#{action name} { object A single Redfish action.
@Redfish.ActionInfo string read-only The URI for an ActionInfo Resource that describes this action.
target string read-only The target URI for the POST operation to invoke the action.
4.2 Capacity
4.2.1 Description
This is the schema definition for the Capacity of a device. It represents the properties for capacity for
any data store.
4.2.2 Properties
Property Type Attributes Notes
Data { object The capacity information relating to the user data.
integer read-write The number of bytes currently allocated by the storage system in this
AllocatedBytes
(bytes) (null) data store for this data type.
18 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
integer read-only
ConsumedBytes The number of bytes consumed in this data store for this data type.
(bytes) (null)
integer read-write The number of bytes the storage system guarantees can be allocated in
GuaranteedBytes
(bytes) (null) this data store for this data type.
integer read-write The maximum number of bytes that can be allocated in this data store
ProvisionedBytes
(bytes) (null) for this data type.
read-only
IsThinProvisioned boolean Marks that the capacity is not necessarily fully allocated.
(null)
Metadata { object The capacity information relating to metadata.
integer read-write The number of bytes currently allocated by the storage system in this
AllocatedBytes
(bytes) (null) data store for this data type.
integer read-only
ConsumedBytes The number of bytes consumed in this data store for this data type.
(bytes) (null)
integer read-write The number of bytes the storage system guarantees can be allocated in
GuaranteedBytes
(bytes) (null) this data store for this data type.
integer read-write The maximum number of bytes that can be allocated in this data store
ProvisionedBytes
(bytes) (null) for this data type.
Snapshot { object The capacity information relating to snapshot or backup data.
integer read-write The number of bytes currently allocated by the storage system in this
AllocatedBytes
(bytes) (null) data store for this data type.
integer read-only
ConsumedBytes The number of bytes consumed in this data store for this data type.
(bytes) (null)
integer read-write The number of bytes the storage system guarantees can be allocated in
GuaranteedBytes
(bytes) (null) this data store for this data type.
integer read-write The maximum number of bytes that can be allocated in this data store
ProvisionedBytes
(bytes) (null) for this data type.
Version 2023.1 Published 19
Redfish Resource and Schema Guide DSP2046
4.3 Condition
4.3.1 Description
A condition that requires attention.
4.3.2 Properties
Property Type Attributes Notes
The link to the log entry created for this condition. See the LogEntry
LogEntry { object
schema for details on this property.
Link to a LogEntry resource. See the Links section and the LogEntry
@odata.id string read-only
schema for details.
Message string read-only The human-readable message for this condition.
array An array of message arguments that are substituted for the arguments in
MessageArgs [ ] read-only
(string) the message when looked up in the message registry.
read-only
MessageId string The identifier for the message.
required
OriginOfCondition
object A link to the resource or object that originated the condition.
{
string
@odata.id read-only The unique identifier for a resource.
(URI)
Resolution
string read-only Suggestions on how to resolve the condition.
(v1.14+)
string The severity of the condition. For the possible property values, see
Severity read-only
(enum) Severity in Property details.
string
Timestamp read-only The time the condition occurred.
(date-time)
20 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
4.3.3 Property details
4.3.3.1 Severity
The severity of the condition.
string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.
4.4 Identifier
4.4.1 Description
Any additional identifiers for a resource.
4.4.2 Properties
Property Type Attributes Notes
DurableName read-only
string The world-wide, persistent name of the resource.
(v1.1+) (null)
DurableNameFormat string read-only The format of the durable name property. For the possible property
(v1.1+) (enum) (null) values, see DurableNameFormat in Property details.
4.4.3 Property details
4.4.3.1 DurableNameFormat
The format of the durable name property.
string Description
EUI The IEEE-defined 64-bit Extended Unique Identifier (EUI).
Version 2023.1 Published 21
Redfish Resource and Schema Guide DSP2046
string Description
FC_WWN The Fibre Channel (FC) World Wide Name (WWN).
GCXLID (v1.15+) The globally unique CXL logical device identifier (GCXLID).
iQN The iSCSI Qualified Name (iQN).
MACAddress (v1.14+) The media access control address (MAC address).
NAA The Name Address Authority (NAA) format.
NGUID (v1.10+) The Namespace Globally Unique Identifier (NGUID).
NQN (v1.6+) The NVMe Qualified Name (NQN).
NSID (v1.6+, deprecated The NVM Namespace Identifier (NSID). Deprecated in v1.12 and later. This value has been
v1.12) deprecated due to its non-uniqueness and NGUID should be used.
UUID The Universally Unique Identifier (UUID).
4.5 IOStatistics
4.5.1 Description
The properties of this type represent IO statistics.
4.5.2 Properties
Property Type Attributes Notes
integer read-write
NonIORequests Count of non IO requests.
({tot}) (null)
read-write
NonIORequestTime string The time that the resource is busy processing write requests.
(null)
integer read-write
ReadHitIORequests Count of read IO requests satisfied from memory.
({tot}) (null)
integer read-write
ReadIOKiBytes Number of kibibytes read.
(KiBy) (null)
integer read-write
ReadIORequests Count of read IO requests.
({tot}) (null)
22 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write
ReadIORequestTime string The time that the resource is busy processing read requests.
(null)
integer read-write
WriteHitIORequests Count of write IO requests coalesced into memory.
({tot}) (null)
integer read-write
WriteIOKiBytes Number of kibibytes written.
(KiBy) (null)
integer read-write
WriteIORequests Count of write IO requests.
({tot}) (null)
read-write
WriteIORequestTime string The time that the resource is busy processing write requests.
(null)
4.6 IPv4Address
4.6.1 Description
This type describes an IPv4 address.
4.6.2 Properties
Property Type Attributes Notes
read-write
Address string The IPv4 address.
(null)
string read-only This indicates how the address was determined. For the possible property
AddressOrigin
(enum) (null) values, see AddressOrigin in Property details.
read-write
Gateway string The IPv4 gateway for this address.
(null)
Oem {} object See the Oem object definition in the Common properties section.
read-write
SubnetMask string The IPv4 subnet mask.
(null)
Version 2023.1 Published 23
Redfish Resource and Schema Guide DSP2046
4.6.3 Property details
4.6.3.1 AddressOrigin
This indicates how the address was determined.
string Description
BOOTP A BOOTP service-provided address.
DHCP A DHCPv4 service-provided address.
IPv4LinkLocal The address is valid for only this network segment, or link.
Static A user-configured static address.
4.7 IPv6Address
4.7.1 Description
This type describes an IPv6 address.
4.7.2 Properties
Property Type Attributes Notes
read-write
Address string The IPv6 address.
(null)
string read-only This indicates how the address was determined. For the possible property
AddressOrigin
(enum) (null) values, see AddressOrigin in Property details.
string read-only The current RFC4862-defined state of this address. For the possible property
AddressState
(enum) (null) values, see AddressState in Property details.
Oem {} object See the Oem object definition in the Common properties section.
read-only
PrefixLength integer The IPv6 address prefix Length.
(null)
24 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
4.7.3 Property details
4.7.3.1 AddressOrigin
This indicates how the address was determined.
string Description
DHCPv6 A DHCPv6 service-provided address.
LinkLocal The address is valid for only this network segment, or link.
SLAAC A stateless autoconfiguration (SLAAC) service-provided address.
Static A static user-configured address.
4.7.3.2 AddressState
The current RFC4862-defined state of this address.
string Description
This address is currently within its valid lifetime but is now outside its RFC4862-defined
Deprecated
preferred lifetime.
This address has failed Duplicate Address Detection (DAD) testing, as defined in RFC4862,
Failed
section 5.4, and is not currently in use.
Preferred This address is currently within both its RFC4862-defined valid and preferred lifetimes.
This address is currently undergoing Duplicate Address Detection (DAD) testing, as defined in
Tentative
RFC4862, section 5.4.
4.8 IPv6GatewayStaticAddress
4.8.1 Description
This type represents a single IPv6 static address to be assigned on a network interface.
Version 2023.1 Published 25
Redfish Resource and Schema Guide DSP2046
4.8.2 Properties
Property Type Attributes Notes
read-write
Address
string required A valid IPv6 address.
(v1.1+)
(null)
Oem (v1.1+)
object See the Oem object definition in the Common properties section.
{}
PrefixLength read-write
integer The IPv6 network prefix length, in bits, for this address.
(v1.1+) (null)
4.9 IPv6StaticAddress
4.9.1 Description
This type represents a single IPv6 static address to be assigned on a network interface.
4.9.2 Properties
Property Type Attributes Notes
read-write
Address string required A valid IPv6 address.
(null)
Oem {} object See the Oem object definition in the Common properties section.
read-write
PrefixLength integer required The prefix length, in bits, of this IPv6 address.
(null)
4.10 Location
4.10.1 Description
The location of a resource.
26 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
4.10.2 Properties
Property Type Attributes Notes
number read-write
AltitudeMeters (v1.6+) The altitude of the resource in meters.
(meters) (null)
Contacts (v1.7+) [ { array An array of contact information.
read-write
ContactName (v1.7+) string Name of this contact.
(null)
read-write
EmailAddress (v1.7+) string Email address for this contact.
(null)
read-write
PhoneNumber (v1.7+) string Phone number for this contact.
(null)
}]
The location of the resource. Deprecated in v1.5 and later. This
read-only
Info (v1.1+, deprecated v1.5 string property has been deprecated in favor of the PostalAddress,
(null)
Placement, and PartLocation properties.
The format of the Info property. Deprecated in v1.5 and later. This
InfoFormat (v1.1+, read-only
string property has been deprecated in favor of the PostalAddress,
deprecated v1.5 (null)
Placement, and PartLocation properties.
number read-write
Latitude (v1.6+) The latitude of the resource.
(deg) (null)
number read-write
Longitude (v1.6+) The longitude of the resource in degrees.
(deg) (null)
Oem (v1.1+) { object See the Oem object definition in the Common properties section.
Property names follow regular expression pattern "^[A-Za-
(pattern) {} object
z0-9_]+$"
PartLocation (v1.5+) { object The part location for a resource within an enclosure.
The number that represents the location of the part. For example,
LocationOrdinalValue read-only
integer if LocationType is Slot and this unit is in slot 2, the
(v1.5+) (null)
LocationOrdinalValue is 2 .
string read-only The type of location of the part. For the possible property values,
LocationType (v1.5+)
(enum) (null) see LocationType in Property details.
Version 2023.1 Published 27
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The orientation for the ordering of the slot enumeration used by
string read-only
Orientation (v1.5+) the LocationOrdinalValue property. For the possible property
(enum) (null)
values, see Orientation in Property details.
The reference point for the part location. Provides guidance about
string read-only
Reference (v1.5+) the general location of the part. For the possible property values,
(enum) (null)
see Reference in Property details.
read-only The label of the part location, such as a silk-screened name or a
ServiceLabel (v1.5+) string
(null) printed label.
Human readable string to enable differentiation between
PartLocationContext read-only PartLocation value for parts in the same enclosure, which might
string
(v1.16+) (null) include hierarchical information of containing PartLocation values
for the part.
Placement (v1.3+) { object A place within the addressed location.
read-write
AdditionalInfo (v1.7+) string Area designation or other additional info.
(null)
read-write
Rack (v1.3+) string The name of a rack location within a row.
(null)
read-write
RackOffset (v1.3+) integer The vertical location of the item, in terms of RackOffsetUnits.
(null)
RackOffsetUnits string read-write The type of rack units in use. For the possible property values, see
(v1.3+) (enum) (null) RackOffsetUnits in Property details.
read-write
Row (v1.3+) string The name of the row.
(null)
PostalAddress (v1.3+) { object The postal address of the addressed resource.
read-write
AdditionalCode (v1.3+) string The additional code.
(null)
read-write
AdditionalInfo (v1.7+) string The room designation or other additional information.
(null)
read-write
Building (v1.3+) string The name of the building.
(null)
read-write
City (v1.3+) string City, township, or shi (JP).
(null)
28 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write
Community (v1.3+) string The postal community name.
(null)
read-write
Country (v1.3+) string The country.
(null)
read-write
District (v1.3+) string A county, parish, gun (JP), or district (IN).
(null)
read-write
Division (v1.3+) string City division, borough, city district, ward, or chou (JP).
(null)
read-write
Floor (v1.3+) string The floor.
(null)
The GPS coordinates of the part. Deprecated in v1.6 and later. This
GPSCoords (v1.3+, read-write
string property has been deprecated in favor of the Longitude and
deprecated v1.6 (null)
Latitude properties.
read-write
HouseNumber (v1.3+) integer The numeric portion of house number.
(null)
HouseNumberSuffix read-write
string The house number suffix.
(v1.3+) (null)
read-write
Landmark (v1.3+) string The landmark.
(null)
LeadingStreetDirection read-write
string A leading street direction.
(v1.3+) (null)
The room designation or other additional information. Deprecated
Location (v1.3+, read-write
string in v1.7 and later. This property has been deprecated in favor of the
deprecated v1.7 (null)
AdditionalInfo property.
read-write
Name (v1.3+) string The name.
(null)
read-write
Neighborhood (v1.3+) string Neighborhood or block.
(null)
read-write
PlaceType (v1.3+) string The description of the type of place that is addressed.
(null)
read-write
POBox (v1.3+) string The post office box (PO box).
(null)
read-write
PostalCode (v1.3+) string The postal code or zip code.
(null)
Version 2023.1 Published 29
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-write
Road (v1.3+) string The primary road or street.
(null)
read-write
RoadBranch (v1.3+) string The road branch.
(null)
RoadPostModifier read-write
string The road post-modifier.
(v1.3+) (null)
RoadPreModifier read-write
string The road pre-modifier.
(v1.3+) (null)
read-write
RoadSection (v1.3+) string The road section.
(null)
read-write
RoadSubBranch (v1.3+) string The road sub branch.
(null)
read-write
Room (v1.3+) string The name or number of the room.
(null)
read-write
Seat (v1.3+) string The seat, such as the desk, cubicle, or workstation.
(null)
read-write
Street (v1.3+) string Street name.
(null)
read-write
StreetSuffix (v1.3+) string Avenue, Platz, Street, Circle.
(null)
read-write
Territory (v1.3+) string A top-level subdivision within a country.
(null)
TrailingStreetSuffix read-write
string A trailing street suffix.
(v1.3+) (null)
read-write
Unit (v1.3+) string The name or number of the apartment unit or suite.
(null)
4.10.3 Property details
4.10.3.1 LocationType
The type of location of the part.
30 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Backplane (v1.12+) A backplane.
Bay A bay.
Connector A connector or port.
Embedded (v1.13+) Embedded within a part.
Slot A slot.
Socket A socket.
4.10.3.2 Orientation
The orientation for the ordering of the slot enumeration used by the LocationOrdinalValue property.
string Description
BackToFront The ordering for the LocationOrdinalValue is back to front.
BottomToTop The ordering for LocationOrdinalValue is bottom to top.
FrontToBack The ordering for LocationOrdinalValue is front to back.
LeftToRight The ordering for the LocationOrdinalValue is left to right.
RightToLeft The ordering for the LocationOrdinalValue is right to left.
TopToBottom The ordering for the LocationOrdinalValue is top to bottom.
4.10.3.3 RackOffsetUnits
The type of rack units in use.
string Description
EIA_310 A rack unit that is equal to 1.75 in (44.45 mm).
OpenU A rack unit that is equal to 48 mm (1.89 in).
4.10.3.4 Reference
The reference point for the part location. Provides guidance about the general location of the part.
Version 2023.1 Published 31
Redfish Resource and Schema Guide DSP2046
string Description
Bottom The part is in the bottom of the unit.
Front The part is in the front of the unit.
Left The part is on the left side of of the unit.
Middle The part is in the middle of the unit.
Rear The part is in the rear of the unit.
Right The part is on the right side of the unit.
Top The part is in the top of the unit.
4.11 Message
4.11.1 Description
The message that the Redfish service returns.
4.11.2 Properties
Property Type Attributes Notes
Message string read-only The human-readable message.
array An array of message arguments that are substituted for the arguments in
MessageArgs [ ] read-only
(string) the message when looked up in the message registry.
read-only
MessageId string The identifier for the message.
required
MessageSeverity string The severity of the message. For the possible property values, see
read-only
(v1.1+) (enum) MessageSeverity in Property details.
Oem {} object See the Oem object definition in the Common properties section.
RelatedProperties array
read-only A set of properties described by the message.
[] (string)
Used to provide suggestions on how to resolve the situation that caused
Resolution string read-only
the message.
32 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The severity of the message. Deprecated in v1.1 and later. This property
Severity
string read-only has been deprecated in favor of MessageSeverity, which ties the values to
(deprecated v1.1)
the enumerations defined for the Health property within Status.
4.11.3 Property details
4.11.3.1 MessageSeverity
The severity of the message.
string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.
4.12 Redundancy
4.12.1 Description
The common redundancy definition and structure used in other Redfish schemas.
4.12.2 Properties
Property Type Attributes Notes
string read-only
@odata.id The unique identifier for a resource.
(URI) required
Actions (v1.2+) {} object The available actions for this resource.
read-only The maximum number of members allowable for this particular
MaxNumSupported integer
(null) redundancy group.
read-only
MemberId string The unique identifier for the member within an array.
required
Version 2023.1 Published 33
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
The minimum number of members needed for this group to be
MinNumNeeded integer required
redundant.
(null)
read-write
string The redundancy mode of the group. For the possible property values,
Mode required
(enum) see Mode in Property details.
(null)
read-only
Name string The name of the resource or array member.
required
Oem {} object See the Oem object definition in the Common properties section.
RedundancyEnabled read-write
boolean An indication of whether redundancy is enabled.
(v1.1+) (null)
RedundancySet [ { array required The links to components of this redundancy set.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
The status and health of the resource and its subordinate or dependent
Status {} object required
resources. For property details, see Status.
4.12.3 Property details
4.12.3.1 Mode
The redundancy mode of the group.
string Description
Failure of one unit automatically causes a standby or offline unit in the redundancy set to
Failover
take over its functions.
Multiple units are available and active such that normal operation will continue if one or more
N+m
units fail.
The subsystem is not configured in a redundancy mode, either due to configuration or the
NotRedundant (v1.3+)
functionality has been disabled by the user.
Multiple units contribute or share such that operation will continue, but at a reduced
Sharing
capacity, if one or more units fail.
34 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
One or more spare units are available to take over the function of a failed unit, but takeover
Sparing
is not automatic.
4.13 RedundantGroup
4.13.1 Description
The redundancy information for the devices in a redundancy group.
4.13.2 Properties
Property Type Attributes Notes
MaxSupportedInGroup read-only
integer The maximum number of devices supported in this redundancy group.
(v1.4+) (null)
read-only
MinNeededInGroup The minimum number of devices needed for this group to be
integer required
(v1.4+) redundant.
(null)
RedundancyGroup
array required The links to the devices included in this redundancy group.
(v1.4+) [ {
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
read-write
RedundancyType string The redundancy mode of the group. For the possible property values,
required
(v1.4+) (enum) see RedundancyType in Property details.
(null)
The status and health of the resource and its subordinate or
Status (v1.4+) {} object required
dependent resources. For property details, see Status.
4.13.3 Property details
4.13.3.1 RedundancyType
The redundancy mode of the group.
Version 2023.1 Published 35
Redfish Resource and Schema Guide DSP2046
string Description
Failure of one unit automatically causes a standby or offline unit in the redundancy set to
Failover
take over its functions.
The subsystem is not configured in a redundancy mode, either due to configuration or the
NotRedundant
functionality has been disabled by the user.
Multiple units are available and active such that normal operation will continue if one or more
NPlusM
units fail.
Multiple units contribute or share such that operation will continue, but at a reduced
Sharing
capacity, if one or more units fail.
One or more spare units are available to take over the function of a failed unit, but takeover
Sparing
is not automatic.
4.14 ReplicaInfo
4.14.1 Description
Defines the characteristics of a replica of a source.
4.14.2 Properties
Property Type Attributes Notes
read-only
ConsistencyEnabled boolean True if consistency is enabled.
(null)
string read-only The current state of consistency. For the possible property
ConsistencyState
(enum) (null) values, see ConsistencyState in Property details.
string read-only The current status of consistency. For the possible property
ConsistencyStatus
(enum) (null) values, see ConsistencyStatus in Property details.
Indicates the consistency type used by the source and its
string read-only
ConsistencyType associated target group. For the possible property values, see
(enum) (null)
ConsistencyType in Property details.
DataProtectionLineOfService A pointer to the DataProtection line of service element that
object
(v1.1+) { describes this replica.
string
@odata.id read-only The unique identifier for a resource.
(URI)
36 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only If true, the storage array tells host to stop sending data to
FailedCopyStopsHostIO boolean
(null) source element if copying to a remote element fails.
integer read-only Specifies the percent of the work completed to reach
PercentSynced
(%) (null) synchronization.
RemoteSourceReplica read-only ReplicaFaultDomain describes the fault domain (local or remote)
string
(v1.4+) (null) of the replica relationship.
Deprecated - Use Source Replica. The resource that is the source
Replica { object
of this replica.
string
@odata.id read-only The unique identifier for a resource.
(URI)
ReplicaFaultDomain describes the fault domain (local or remote)
string read-only
ReplicaFaultDomain (v1.3+) of the replica relationship. For the possible property values, see
(enum) (null)
ReplicaFaultDomain in Property details.
The priority of background copy engine I/O to be managed
string read-only relative to host I/O operations during a sequential background
ReplicaPriority
(enum) (null) copy operation. For the possible property values, see
ReplicaPriority in Property details.
The status of the session with respect to Replication activity. For
string read-only
ReplicaProgressStatus the possible property values, see ReplicaProgressStatus in
(enum) (null)
Property details.
This property specifies whether the source, the target, or both
string read-only
ReplicaReadOnlyAccess elements are read only to the host. For the possible property
(enum) (null)
values, see ReplicaReadOnlyAccess in Property details.
Describes whether the copy operation continues after a broken
string read-only
ReplicaRecoveryMode link is restored. For the possible property values, see
(enum) (null)
ReplicaRecoveryMode in Property details.
string read-only The source or target role of this replica. For the possible property
ReplicaRole
(enum) (null) values, see ReplicaRole in Property details.
integer read-only Applies to Adaptive mode and it describes maximum number of
ReplicaSkewBytes
(bytes) (null) bytes the SyncedElement (target) can be out of sync.
ReplicaState describes the state of the relationship with respect
string read-only
ReplicaState to Replication activity. For the possible property values, see
(enum) (null)
ReplicaState in Property details.
ReplicaType describes the intended outcome of the replication.
string read-only
ReplicaType For the possible property values, see ReplicaType in Property
(enum) (null)
details.
Version 2023.1 Published 37
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Describes whether the target elements will be updated
string read-only
ReplicaUpdateMode synchronously or asynchronously. For the possible property
(enum) (null)
values, see ReplicaUpdateMode in Property details.
The last requested or desired state for the relationship. For the
string read-only
RequestedReplicaState possible property values, see RequestedReplicaState in Property
(enum) (null)
details.
The URI to the source replica when located on a different
SourceReplica (v1.2+) { object
Swordfish service instance.
string
@odata.id read-only The unique identifier for a resource.
(URI)
read-only
SyncMaintained boolean Synchronization is maintained.
(null)
This property specifies whether the source, the target, or both
string read-only elements involved in a copy operation are undiscovered. For the
UndiscoveredElement
(enum) (null) possible property values, see UndiscoveredElement in Property
details.
Specifies when point-in-time copy was taken or when the
string read-only
WhenActivated replication relationship is activated, reactivated, resumed or re-
(%) (null)
established.
string read-only
WhenDeactivated Specifies when the replication relationship is deactivated.
(%) (null)
string read-only
WhenEstablished Specifies when the replication relationship is established.
(%) (null)
string read-only
WhenSuspended Specifies when the replication relationship is suspended.
(%) (null)
read-only
WhenSynced string The point in time that the Elements were synchronized.
(null)
string read-only
WhenSynchronized Specifies when the replication relationship is synchronized.
(%) (null)
4.14.3 Property details
4.14.3.1 ConsistencyState
The current state of consistency.
38 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Consistent Consistent.
Inconsistent Not consistent.
4.14.3.2 ConsistencyStatus
The current status of consistency.
string Description
Consistent Consistent.
Disabled Consistency disabled.
InError Consistency error.
InProgress Becoming consistent.
4.14.3.3 ConsistencyType
Indicates the consistency type used by the source and its associated target group.
string Description
SequentiallyConsistent Sequentially consistent.
4.14.3.4 ReplicaFaultDomain
ReplicaFaultDomain describes the fault domain (local or remote) of the replica relationship.
string Description
Local Local indicates that the source and target replicas are contained within a single fault domain.
Remote Remote indicates that the source and target replicas are in separate fault domains.
4.14.3.5 ReplicaPriority
The priority of background copy engine I/O to be managed relative to host I/O operations during a
sequential background copy operation.
Version 2023.1 Published 39
Redfish Resource and Schema Guide DSP2046
string Description
High Copy engine I/O has higher priority than host I/O.
Low Copy engine I/O lower priority than host I/O.
Same Copy engine I/O has the same priority as host I/O.
Urgent Copy operation to be performed as soon as possible, regardless of the host I/O requests.
4.14.3.6 ReplicaProgressStatus
The status of the session with respect to Replication activity.
string Description
Aborting Abort in progress.
Completed The request is completed. Data flow is idle.
Detaching Detach in progress.
Dormant Indicates that the data flow is inactive, suspended or quiesced.
FailingBack Undoing the result of failover.
FailingOver In the process of switching source and target.
Fracturing Fracture in progress.
Initializing In the process of establishing source/replica relationship and the data flow has not started.
Applies to groups with element pairs with different statuses. Generally, the individual
Mixed
statuses need to be examined.
Pending The flow of data has stopped momentarily due to limited bandwidth or a busy system.
Preparing Preparation in progress.
The requested operation has completed, however, the synchronization relationship needs to
RequiresActivate
be activated before further copy operations can be issued.
The requested operation has completed, however, the synchronization relationship needs to
RequiresDetach
be detached before further copy operations can be issued.
The requested operation has completed, however, the synchronization relationship needs to
RequiresFracture
be fractured before further copy operations can be issued.
The requested operation has completed, however, the synchronization relationship needs to
RequiresResume
be resumed before further copy operations can be issued.
40 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
The requested operation has completed, however, the synchronization relationship needs to
RequiresResync
be resynced before further copy operations can be issued.
The requested operation has completed, however, the synchronization relationship needs to
RequiresSplit
be split before further copy operations can be issued.
Restoring Restore in progress.
Resyncing Resync in progress.
Splitting Split in progress.
Suspending The copy operation is in the process of being suspended.
Synchronizing Sync in progress.
Terminating The relationship is in the process of terminating.
4.14.3.7 ReplicaReadOnlyAccess
This property specifies whether the source, the target, or both elements are read only to the host.
string Description
Both Both the source and the target elements are read only to the host.
ReplicaElement The replica element.
SourceElement The source element.
4.14.3.8 ReplicaRecoveryMode
Describes whether the copy operation continues after a broken link is restored.
string Description
Automatic Copy operation resumes automatically.
ReplicaState is set to Suspended after the link is restored. It is required to issue the Resume
Manual
operation to continue.
4.14.3.9 ReplicaRole
The source or target role of this replica.
Version 2023.1 Published 41
Redfish Resource and Schema Guide DSP2046
string Description
Source The source element.
Target The target element.
4.14.3.10 ReplicaState
ReplicaState describes the state of the relationship with respect to Replication activity.
string Description
The copy operation is aborted with the Abort operation. Use the Resync Replica operation to
Aborted
restart the copy operation.
The relationship is non-functional due to errors in the source, the target, the path between
Broken
the two or space constraints.
Failedover Reads and writes are sent to the target element. Source element is not reachable.
Fractured Target is split from the source.
Inactive Data flow has stopped, writes to source element will not be sent to target element.
The link to enable replication is established and source/replica elements are associated, but
Initialized
the data flow has not started.
The array is unable to determine the state of the replication relationship, for example, after
Invalid the connection is restored; however, either source or target elements have an unknown
status.
Applies to the ReplicaState of GroupSynchronized. It indicates the StorageSynchronized
Mixed
relationships of the elements in the groups have different ReplicaState values.
State of replication relationship can not be determined, for example, due to a connection
Partitioned
problem.
Prepared Initialization is completed, however, the data flow has not started.
Restored It indicates the source element was restored from the target element.
The target has been modified and is no longer synchronized with the source element or the
Skewed
point-in-time view.
The target element was gracefully (or systematically) split from its source element --
Split
consistency is guaranteed.
Data flow between the source and target elements has stopped. Writes to source element are
Suspended
held until the relationship is Resumed.
42 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Synchronized For the Mirror, Snapshot, or Clone replication, the target represents a copy of the source.
Unsynchronized Not all the source element data has been copied to the target element.
4.14.3.11 ReplicaType
ReplicaType describes the intended outcome of the replication.
string Description
Clone Create a point in time, full copy the source.
Mirror Create and maintain a copy of the source.
Snapshot Create a point in time, virtual copy of the source.
TokenizedClone Create a token based clone.
4.14.3.12 ReplicaUpdateMode
Describes whether the target elements will be updated synchronously or asynchronously.
string Description
Active Active-Active (i.e. bidirectional) synchronous updates.
Adaptive Allows implementation to switch between synchronous and asynchronous modes.
Asynchronous Asynchronous updates.
Synchronous Synchronous updates.
4.14.3.13 RequestedReplicaState
The last requested or desired state for the relationship.
string Description
The copy operation is aborted with the Abort operation. Use the Resync Replica operation to
Aborted
restart the copy operation.
Version 2023.1 Published 43
Redfish Resource and Schema Guide DSP2046
string Description
The relationship is non-functional due to errors in the source, the target, the path between
Broken
the two or space constraints.
Failedover Reads and writes are sent to the target element. Source element is not reachable.
Fractured Target is split from the source.
Inactive Data flow has stopped, writes to source element will not be sent to target element.
The link to enable replication is established and source/replica elements are associated, but
Initialized
the data flow has not started.
The array is unable to determine the state of the replication relationship, for example, after
Invalid the connection is restored; however, either source or target elements have an unknown
status.
Applies to the ReplicaState of GroupSynchronized. It indicates the StorageSynchronized
Mixed
relationships of the elements in the groups have different ReplicaState values.
State of replication relationship can not be determined, for example, due to a connection
Partitioned
problem.
Prepared Initialization is completed, however, the data flow has not started.
Restored It indicates the source element was restored from the target element.
The target has been modified and is no longer synchronized with the source element or the
Skewed
point-in-time view.
The target element was gracefully (or systematically) split from its source element --
Split
consistency is guaranteed.
Data flow between the source and target elements has stopped. Writes to source element are
Suspended
held until the relationship is Resumed.
Synchronized For the Mirror, Snapshot, or Clone replication, the target represents a copy of the source.
Unsynchronized Not all the source element data has been copied to the target element.
4.14.3.14 UndiscoveredElement
This property specifies whether the source, the target, or both elements involved in a copy operation
are undiscovered.
string Description
ReplicaElement The replica element is undiscovered.
44 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
SourceElement The source element is undiscovered.
4.15 Schedule
4.15.1 Description
Schedule a series of occurrences.
4.15.2 Properties
Property Type Attributes Notes
array
EnabledDaysOfMonth Days of the month when scheduled occurrences are enabled. 0
(integer, read-write
[] indicates that every day of the month is enabled.
null)
Days of the week when scheduled occurrences are enabled, for
array
EnabledDaysOfWeek [ read-write enabled days of the month and months of the year. If not present, all
(string
] (null) days of the week are enabled. For the possible property values, see
(enum))
EnabledDaysOfWeek in Property details.
array
EnabledIntervals
(string, read-write Intervals when scheduled occurrences are enabled.
(v1.1+) [ ]
null)
array The months of the year when scheduled occurrences are enabled. If
EnabledMonthsOfYear read-write
(string not present, all months of the year are enabled. For the possible
[] (null)
(enum)) property values, see EnabledMonthsOfYear in Property details.
string read-write
InitialStartTime The date and time when the initial occurrence is scheduled to occur.
(date-time) (null)
string read-write
Lifetime The time after provisioning when the schedule as a whole expires.
(duration) (null)
read-write
MaxOccurrences integer The maximum number of scheduled occurrences.
(null)
read-write
Name string The schedule name.
(null)
string read-write
RecurrenceInterval The duration between consecutive occurrences.
(duration) (null)
Version 2023.1 Published 45
Redfish Resource and Schema Guide DSP2046
4.15.3 Property details
4.15.3.1 EnabledDaysOfWeek
Days of the week when scheduled occurrences are enabled, for enabled days of the month and
months of the year. If not present, all days of the week are enabled.
string Description
Every Every day of the week.
Friday Friday.
Monday Monday.
Saturday Saturday.
Sunday Sunday.
Thursday Thursday.
Tuesday Tuesday.
Wednesday Wednesday.
4.15.3.2 EnabledMonthsOfYear
The months of the year when scheduled occurrences are enabled. If not present, all months of the
year are enabled.
string Description
April April.
August August.
December December.
Every Every month of the year.
February February.
January January.
July July.
June June.
46 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
March March.
May May.
November November.
October October.
September September.
4.16 Status
4.16.1 Description
The status and health of a resource and its children.
4.16.2 Properties
Property Type Attributes Notes
Conditions (v1.11+) [
array Conditions in this resource that require attention.
{
The link to the log entry created for this condition. See the LogEntry
LogEntry { object
schema for details on this property.
Link to a LogEntry resource. See the Links section and the LogEntry
@odata.id string read-only
schema for details.
Message string read-only The human-readable message for this condition.
array An array of message arguments that are substituted for the arguments
MessageArgs [ ] read-only
(string) in the message when looked up in the message registry.
read-only
MessageId string The identifier for the message.
required
OriginOfCondition
object A link to the resource or object that originated the condition.
{
string
@odata.id read-only The unique identifier for a resource.
(URI)
Version 2023.1 Published 47
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Resolution
string read-only Suggestions on how to resolve the condition.
(v1.14+)
string The severity of the condition. For the possible property values, see
Severity read-only
(enum) Severity in Property details.
string
Timestamp read-only The time the condition occurred.
(date-time)
}]
The health state of this resource in the absence of its dependent
string read-only
Health resources. For the possible property values, see Health in Property
(enum) (null)
details.
string read-only The overall health state from the view of this resource. For the possible
HealthRollup
(enum) (null) property values, see HealthRollup in Property details.
Oem { object See the Oem object definition in the Common properties section.
(pattern) {} object Property names follow regular expression pattern "^[A-Za-z0-9_]+$"
string read-only The known state of the resource, such as, enabled. For the possible
State
(enum) (null) property values, see State in Property details.
4.16.3 Property details
4.16.3.1 Health
The health state of this resource in the absence of its dependent resources.
string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.
4.16.3.2 HealthRollup
The overall health state from the view of this resource.
48 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Methods used to determine the value of this property can vary between different architectures and
requirements of the underlying product. This property does not necessarily surface the most degraded
health from all subordinate resources. For example, if a PowerSupply resource contains Critical for
its Health property, but belongs to a redundancy group that is still able to power the parent Chassis
resource, the Chassis resource could report Warning for the HealthRollup property, depending on the
redundancy policy for the Chassis resource. Using the same PowerSupply example, the
ComputerSystem resource associated with this Chassis resource could degrade its HealthRollup , even
though the PowerSupply resource is not subordinate to the ComputerSystem resource. In this case, the
ComputerSystem resource is dependent on the PowerSupply , but are in two different resource
hierarchies.
string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.
4.16.3.3 Severity
The severity of the condition.
string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.
4.16.3.4 State
The known state of the resource, such as, enabled.
string Description
This function or device is not currently present or detected. This resource represents a
Absent
capability or an available location where a device can be installed.
Deferring (v1.2+) The element does not process any commands but queues new requests.
Disabled This function or resource is disabled.
Version 2023.1 Published 49
Redfish Resource and Schema Guide DSP2046
string Description
Enabled This function or resource is enabled.
This function or resource is undergoing testing, or is in the process of capturing information
InTest
for debugging.
Qualified (v1.9+) The element quality is within the acceptable range of operation.
Quiesced (v1.2+) The element is enabled but only processes a restricted set of commands.
StandbyOffline This function or resource is enabled but awaits an external action to activate it.
This function or resource is part of a redundancy set and awaits a failover or other external
StandbySpare
action to activate it.
Starting This function or resource is starting.
UnavailableOffline (v1.1+) This function or resource is present but cannot be used.
Updating (v1.2+) The element is updating and might be unavailable or degraded.
50 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
5 Resource collections
A resource collection is a core concept in Redfish. A resource collection is a group of like resources
where the number of instances in the group can shrink or grow depending on the scope of the Redfish
service or the configuration of the devices being managed. Every resource collection contains the
same set of supported properties, and all contain Collection in the name of their schema. Every
resource linked in the Members array within a resource collection will have the same resource type with
the same major version, but can vary in minor or errata schema versions.
The properties of a resource collection are:
5.0.1 Properties
Property Type Attributes Notes
string
@odata.context read-only The OData description of a payload.
(URI)
string read-only
@odata.id The unique identifier for a resource.
(URI) required
read-only
@odata.type string The type of a resource.
required
read-only The description of this resource. Used for commonality in the
Description string
(null) schema definitions.
Members [ { array required The members of this collection.
string The link to a Resource instance, which is a member of this
@odata.id read-only
(URI) collection.
}]
[email protected] integer read-only The number of items in a collection.
string
[email protected] read-only The URI to the resource containing the next set of partial members.
(URI)
read-only
Name string The name of the resource or array member.
required
The manufacturer- or provider-specific extension moniker that
Oem {} object
divides the Oem object into sections.
As shown in the following example, a Redfish service may provide management functionality for
Version 2023.1 Published 51
Redfish Resource and Schema Guide DSP2046
several ComputerSystem resources, and therefore a ComputerSystemCollection resource is provided. This
example shows a service with four ComputerSystem instances inside the Members array.
{
"@odata.type": "#ComputerSystemCollection.ComputerSystemCollection",
"Name": "Computer System Collection",
"[email protected]": 4,
"Members": [
{
"@odata.id": "/redfish/v1/Systems/529QB9450R6"
},
{
"@odata.id": "/redfish/v1/Systems/529QB9451R6"
},
{
"@odata.id": "/redfish/v1/Systems/529QB9452R6"
},
{
"@odata.id": "/redfish/v1/Systems/529QB9453R6"
}
],
"@odata.id": "/redfish/v1/Systems"
}
5.1 Collection capabilities annotation
(#CollectionCapabilities)
This annotation is used to inform the client how to form the request body for a create (POST) operation
to a given collection based on a specified use case, which will result in a new member being added to
the given collection.
5.1.1 Properties
Property Type Attributes Notes
Capabilities [ { array The list of capabilities supported by this resource.
The link to the resource the client can issue a GET request
CapabilitiesObject { object required against to understand how to form a POST request for a
collection.
string
@odata.id read-only The unique identifier for a resource.
(URI)
52 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Links { object required The links to other resources that are related to this resource.
Oem {} object The OEM extension property. For property details, see Oem.
RelatedItem [ { array An array of links to resources associated with this capability.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
[email protected] integer read-only The number of items in a collection.
The link to the collection that this capabilities structure is
TargetCollection { object required
describing.
string
@odata.id read-only The unique identifier for a resource.
(URI)
The use case in which a client can issue a POST request to
string read-only
UseCase the collection. For the possible property values, see UseCase
(enum) required
in Property details.
}]
MaxMembers (v1.2+) integer read-only The maximum number of members allowed in this collection.
5.1.2 Property details
5.1.2.1 UseCase
The use case in which a client can issue a POST request to the collection.
string Description
This capability describes a client creating a new computer system resource
ComputerSystemComposition
from a set of disaggregated hardware.
ComputerSystemConstrainedComposition This capability describes a client creating a new computer system resource
(v1.1+) from a set of constraints.
This capability describes a client creating a new resource block from a set of
ResourceBlockComposition (v1.3+)
other resource blocks.
Version 2023.1 Published 53
Redfish Resource and Schema Guide DSP2046
string Description
ResourceBlockConstrainedComposition This capability describes a client creating a new resource block from a set of
(v1.3+) constraints.
This capability describes a client creating a new volume resource as part of an
VolumeCreation
existing storage subsystem.
5.1.3 Example collection capabilities annotation
{
"@Redfish.CollectionCapabilities": {
"@odata.type": "#CollectionCapabilities.v1_1_0.CollectionCapabilities",
"Capabilities": [
{
"CapabilitiesObject": {
"@odata.id": "/redfish/v1/Systems/Capabilities"
},
"UseCase": "ComputerSystemComposition",
"Links": {
"TargetCollection": {
"@odata.id": "/redfish/v1/Systems"
}
}
},
{
"CapabilitiesObject": {
"@odata.id": "/redfish/v1/Systems/ConstrainedCompositionCapabilities"
},
"UseCase": "ComputerSystemConstrainedComposition",
"Links": {
"TargetCollection": {
"@odata.id": "/redfish/v1/Systems"
}
}
}
]
},
...
}
5.2 Resource collection URIs in Redfish v1.6 and later
The following table lists all Redfish-defined resource collections and the URIs where they can appear.
Note: The URIs listed are valid for Redfish services that conform to the Redfish Specification
54 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
v1.6.0 or higher. Services built on earlier specification versions might use different URIs, which
must be discovered by following the hyperlinks from the service root ( /redfish/v1/ ).
Collection Type URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/
{ProcessorId}/AccelerationFunctions
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/Processors/{ProcessorId}/AccelerationFunctions
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/
AccelerationFunctionCollection
AccelerationFunctions
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}/AccelerationFunctions
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/
AccelerationFunctions
AddressPoolCollection /redfish/v1/Fabrics/{FabricId}/AddressPools
AggregateCollection /redfish/v1/AggregationService/Aggregates
AggregationSourceCollection /redfish/v1/AggregationService/AggregationSources
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/
NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/
{NetworkInterfaceId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/
NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny
AllowDenyCollection
/redfish/v1/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/
{NetworkInterfaceId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions/
{NetworkDeviceFunctionId}/AllowDeny
/redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/
NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny
BatteryCollection /redfish/v1/Chassis/{ChassisId}/PowerSubsystem/Batteries
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/BootOptions
BootOptionCollection /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
BootOptions
/redfish/v1/Systems/{ComputerSystemId}/BootOptions
CableCollection /redfish/v1/Cables
Version 2023.1 Published 55
Redfish Resource and Schema Guide DSP2046
Collection Type URIs
/redfish/v1/AccountService/Accounts/{ManagerAccountId}/Certificates
/redfish/v1/AccountService/ActiveDirectory/Certificates
/redfish/v1/AccountService/ExternalAccountProviders/{ExternalAccountProviderId}/
Certificates
/redfish/v1/AccountService/LDAP/Certificates
/redfish/v1/AccountService/MultiFactorAuth/ClientCertificate/Certificates
/redfish/v1/AccountService/MultiFactorAuth/SecurID/Certificates
/redfish/v1/Chassis/{ChassisId}/Certificates
/redfish/v1/Chassis/{ChassisId}/Drives/{DriveId}/Certificates
/redfish/v1/Chassis/{ChassisId}/Memory/{MemoryId}/Certificates
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Certificates
/redfish/v1/Chassis/{ChassisId}/TrustedComponents/{TrustedComponentId}/
Certificates
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}/
Certificates
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Memory/
{MemoryId}/Certificates
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/
{ProcessorId}/Certificates
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/
{StorageId}/Controllers/{StorageControllerId}/Certificates
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/
{StorageId}/Drives/{DriveId}/Certificates
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/
CertificateCollection {StorageId}/StorageControllers/{StorageControllerId}/Certificates
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/Boot/Certificates
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/Certificates
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/KeyManagement/KMIPCertificates
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/Memory/{MemoryId}/Certificates
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/Processors/{ProcessorId}/Certificates
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/SecureBoot/SecureBootDatabases/{DatabaseId}/Certificates
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/
Certificates
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/Certificates
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/
Certificates
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/Certificates
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/ClientCertificates
56 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Collection Type URIs
/redfish/v1/EventService/Subscriptions/{EventDestinationId}/Certificates
/redfish/v1/EventService/Subscriptions/{EventDestinationId}/ClientCertificates
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Certificates
/redfish/v1/Managers/{ManagerId}/Certificates
/redfish/v1/Managers/{ManagerId}/NetworkProtocol/HTTPS/Certificates
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/Accounts/
{ManagerAccountId}/Certificates
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/ActiveDirectory/Certificates
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/ExternalAccountProviders/
{ExternalAccountProviderId}/Certificates
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/LDAP/Certificates
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/MultiFactorAuth/
ClientCertificate/Certificates
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/MultiFactorAuth/SecurID/
Certificates
/redfish/v1/Managers/{ManagerId}/SecurityPolicy/SPDM/RevokedCertificates
/redfish/v1/Managers/{ManagerId}/SecurityPolicy/SPDM/TrustedCertificates
/redfish/v1/Managers/{ManagerId}/SecurityPolicy/TLS/Client/RevokedCertificates
/redfish/v1/Managers/{ManagerId}/SecurityPolicy/TLS/Client/TrustedCertificates
/redfish/v1/Managers/{ManagerId}/SecurityPolicy/TLS/Server/RevokedCertificates
/redfish/v1/Managers/{ManagerId}/SecurityPolicy/TLS/Server/TrustedCertificates
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}/Certificates
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/Certificates
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Certificates
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/
{StorageControllerId}/Certificates
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/{DriveId}/
Certificates
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/
StorageControllers/{StorageControllerId}/Certificates
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Boot/
Certificates
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Certificates
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
KeyManagement/KMIPCertificates
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Memory/{MemoryId}/Certificates
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}/Certificates
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
SecureBoot/SecureBootDatabases/{DatabaseId}/Certificates
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/
{StorageId}/Controllers/{StorageControllerId}/Certificates
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/
{StorageId}/Drives/{DriveId}/Certificates
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/
{StorageId}/StorageControllers/{StorageControllerId}/Certificates
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Version 2023.1 Published 57
Redfish Resource and Schema Guide DSP2046
Collection Type URIs
VirtualMedia/{VirtualMediaId}/Certificates
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
VirtualMedia/{VirtualMediaId}/ClientCertificates
/redfish/v1/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates
/redfish/v1/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates
/redfish/v1/Systems/{ComputerSystemId}/Boot/Certificates
/redfish/v1/Systems/{ComputerSystemId}/Certificates
/redfish/v1/Systems/{ComputerSystemId}/KeyManagement/KMIPCertificates
/redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}/Certificates
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Certificates
/redfish/v1/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases/
{DatabaseId}/Certificates
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/
{StorageControllerId}/Certificates
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/
Certificates
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/
{StorageControllerId}/Certificates
/redfish/v1/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/Certificates
/redfish/v1/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/
ClientCertificates
/redfish/v1/UpdateService/ClientCertificates
/redfish/v1/UpdateService/RemoteServerCertificates
ChassisCollection /redfish/v1/Chassis
/redfish/v1/PowerEquipment/ElectricalBuses/{PowerDistributionId}/Branches
/redfish/v1/PowerEquipment/ElectricalBuses/{PowerDistributionId}/Mains
/redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}/Branches
/redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}/Mains
/redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}/Subfeeds
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/Branches
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/Mains
/redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Branches
CircuitCollection
/redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Mains
/redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}/Branches
/redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}/Feeders
/redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}/Mains
/redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}/Subfeeds
/redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Branches
/redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Feeders
/redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Mains
ComponentIntegrityCollection /redfish/v1/ComponentIntegrity
CompositionReservationCollection /redfish/v1/CompositionService/CompositionReservations
ComputerSystemCollection /redfish/v1/Systems
58 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Collection Type URIs
/redfish/v1/Fabrics/{FabricId}/Connections
ConnectionCollection
/redfish/v1/Storage/{StorageId}/Connections
ConnectionMethodCollection /redfish/v1/AggregationService/ConnectionMethods
ControlCollection /redfish/v1/Chassis/{ChassisId}/Controls
/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/CoolantConnectors
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/PrimaryCoolantConnectors
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/SecondaryCoolantConnectors
/redfish/v1/ThermalEquipment/CoolingLoops/{CoolingUnitId}/
PrimaryCoolantConnectors
/redfish/v1/ThermalEquipment/CoolingLoops/{CoolingUnitId}/
SecondaryCoolantConnectors
CoolantConnectorCollection /redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/
PrimaryCoolantConnectors
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/
SecondaryCoolantConnectors
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/
PrimaryCoolantConnectors
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/
SecondaryCoolantConnectors
CoolingLoopCollection /redfish/v1/ThermalEquipment/CoolingLoops
/redfish/v1/ThermalEquipment/CDUs
CoolingUnitCollection /redfish/v1/ThermalEquipment/HeatExchangers
/redfish/v1/ThermalEquipment/ImmersionUnits
CXLLogicalDeviceCollection /redfish/v1/Chassis/{ChassisId}/PCIeDevices/{PCIeDeviceId}/CXLLogicalDevices
Version 2023.1 Published 59
Redfish Resource and Schema Guide DSP2046
Collection Type URIs
/redfish/v1/Chassis/{ChassisId}/Drives
/redfish/v1/Storage/{StorageId}/FileSystems/{FileSystemId}/CapacitySources/
{CapacitySourceId}/ProvidingDrives
/redfish/v1/Storage/{StorageId}/StoragePools/{StoragePoolId}/CapacitySources/
{CapacitySourceId}/ProvidingDrives
/redfish/v1/Storage/{StorageId}/Volumes/{VolumeId}/CapacitySources/
{CapacitySourceId}/ProvidingDrives
/redfish/v1/StorageServices/{StorageServiceId}/Drives
/redfish/v1/StorageServices/{StorageServiceId}/FileSystems/{FileSystemId}/
CapacitySources/{CapacitySourceId}/ProvidingDrives
DriveCollection
/redfish/v1/StorageServices/{StorageServiceId}/StoragePools/{StoragePoolId}/
CapacitySources/{CapacitySourceId}/ProvidingDrives
/redfish/v1/StorageServices/{StorageServiceId}/Volumes/{VolumeId}/CapacitySources/
{CapacitySourceId}/ProvidingDrives
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/FileSystems/
{FileSystemId}/CapacitySources/{CapacitySourceId}/ProvidingDrives
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StoragePools/
{StoragePoolId}/CapacitySources/{CapacitySourceId}/ProvidingDrives
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/{VolumeId}/
CapacitySources/{CapacitySourceId}/ProvidingDrives
/redfish/v1/Fabrics/{FabricId}/Endpoints
EndpointCollection /redfish/v1/Storage/{StorageId}/Endpoints
/redfish/v1/StorageServices/{StorageServiceId}/Endpoints
/redfish/v1/Fabrics/{FabricId}/EndpointGroups
/redfish/v1/Storage/{StorageId}/EndpointGroups
EndpointGroupCollection
/redfish/v1/StorageServices/{StorageServiceId}/EndpointGroups
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/EndpointGroups
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/
NetworkDeviceFunctions/{NetworkDeviceFunctionId}/EthernetInterfaces
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/EthernetInterfaces
/redfish/v1/Managers/{ManagerId}/EthernetInterfaces
EthernetInterfaceCollection
/redfish/v1/Managers/{ManagerId}/HostInterfaces/{HostInterfaceId}/
HostEthernetInterfaces
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
EthernetInterfaces
/redfish/v1/Systems/{ComputerSystemId}/EthernetInterfaces
EventDestinationCollection /redfish/v1/EventService/Subscriptions
/redfish/v1/AccountService/ExternalAccountProviders
ExternalAccountProviderCollection
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/ExternalAccountProviders
60 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Collection Type URIs
/redfish/v1/Chassis/{ChassisId}/FabricAdapters
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/FabricAdapters
FabricAdapterCollection
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters
FabricCollection /redfish/v1/Fabrics
FacilityCollection /redfish/v1/Facilities
FanCollection /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Fans
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Filters
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Pumps/{PumpId}/Filters
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Reservoirs/{ReservoirId}/Filters
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Filters
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Pumps/{PumpId}/
Filters
FilterCollection /redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Reservoirs/
{ReservoirId}/Filters
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Filters
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Pumps/{PumpId}/
Filters
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Reservoirs/
{ReservoirId}/Filters
GraphicsControllerCollection /redfish/v1/Systems/{ComputerSystemId}/GraphicsControllers
HeaterCollection /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Heaters
HostInterfaceCollection /redfish/v1/Managers/{ManagerId}/HostInterfaces
/redfish/v1/JobService/Jobs
JobCollection
/redfish/v1/JobService/Jobs/{JobId}/Steps
JsonSchemaFileCollection /redfish/v1/JsonSchemas
/redfish/v1/AccountService/Accounts/{ManagerAccountId}/Keys
/redfish/v1/AggregationService/AggregationSources/{AggregationSourceId}/
TrustedPublicHostKeys
KeyCollection
/redfish/v1/KeyService/NVMeoFSecrets
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/Accounts/
{ManagerAccountId}/Keys
KeyPolicyCollection /redfish/v1/KeyService/NVMeoFKeyPolicies
Version 2023.1 Published 61
Redfish Resource and Schema Guide DSP2046
Collection Type URIs
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/LeakDetection/LeakDetectors
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/LeakDetection/
LeakDetectorCollection LeakDetectors/
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/LeakDetection/
LeakDetectors
LicenseCollection /redfish/v1/LicenseService/Licenses
/redfish/v1/Chassis/{ChassisId}/LogServices/{LogServiceId}/Entries
/redfish/v1/Chassis/{ChassisId}/PCIeDevices/{PCIeDeviceId}/CXLLogicalDevices/
{CXLLogicalDeviceId}/DeviceLog/Entries
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/LogServices/{LogServiceId}/Entries
/redfish/v1/JobService/Log/Entries
LogEntryCollection
/redfish/v1/Managers/{ManagerId}/LogServices/{LogServiceId}/Entries
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
LogServices/{LogServiceId}/Entries
/redfish/v1/Systems/{ComputerSystemId}/LogServices/{LogServiceId}/Entries
/redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}/DeviceLog/Entries
/redfish/v1/TelemetryService/LogService/Entries
/redfish/v1/Chassis/{ChassisId}/LogServices
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/LogServices
LogServiceCollection /redfish/v1/Managers/{ManagerId}/LogServices
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
LogServices
/redfish/v1/Systems/{ComputerSystemId}/LogServices
/redfish/v1/AccountService/Accounts
ManagerAccountCollection
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/Accounts
ManagerCollection /redfish/v1/Managers
MediaControllerCollection /redfish/v1/Chassis/{ChassisId}/MediaControllers
/redfish/v1/Chassis/{ChassisId}/MemoryDomains/{MemoryDomainId}/MemoryChunks
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/MemoryDomains/{MemoryDomainId}/MemoryChunks
MemoryChunksCollection /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
MemoryDomains/{MemoryDomainId}/MemoryChunks
/redfish/v1/Systems/{ComputerSystemId}/MemoryDomains/{MemoryDomainId}/
MemoryChunks
/redfish/v1/Chassis/{ChassisId}/Memory
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
MemoryCollection {ComputerSystemId}/Memory
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory
/redfish/v1/Systems/{ComputerSystemId}/Memory
62 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Collection Type URIs
/redfish/v1/Chassis/{ChassisId}/MemoryDomains
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/MemoryDomains
MemoryDomainCollection
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
MemoryDomains
/redfish/v1/Systems/{ComputerSystemId}/MemoryDomains
MessageRegistryCollection
MessageRegistryFileCollection /redfish/v1/Registries
MetricDefinitionCollection /redfish/v1/TelemetryService/MetricDefinitions
MetricReportCollection /redfish/v1/TelemetryService/MetricReports
MetricReportDefinitionCollection /redfish/v1/TelemetryService/MetricReportDefinitions
NetworkAdapterCollection /redfish/v1/Chassis/{ChassisId}/NetworkAdapters
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/
NetworkDeviceFunctions
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/
{NetworkInterfaceId}/NetworkDeviceFunctions
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/
NetworkDeviceFunctionCollection NetworkDeviceFunctions
/redfish/v1/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/
{NetworkInterfaceId}/NetworkDeviceFunctions
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions
/redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/
NetworkDeviceFunctions
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/NetworkInterfaces
NetworkInterfaceCollection /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
NetworkInterfaces
/redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkPorts
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/
{NetworkInterfaceId}/NetworkPorts
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts
NetworkPortCollection /redfish/v1/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/
{NetworkInterfaceId}/NetworkPorts
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts
/redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/
NetworkPorts
Version 2023.1 Published 63
Redfish Resource and Schema Guide DSP2046
Collection Type URIs
OperatingConfigCollection /redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/OperatingConfigs
/redfish/v1/PowerEquipment/ElectricalBuses/{PowerDistributionId}/Outlets
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/Outlets
OutletCollection
/redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Outlets
/redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Outlets
/redfish/v1/PowerEquipment/ElectricalBuses/{PowerDistributionId}/OutletGroups
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/OutletGroups
OutletGroupCollection
/redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/OutletGroups
/redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/OutletGroups
/redfish/v1/Chassis/{ChassisId}/PCIeDevices
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/PCIeDevices
PCIeDeviceCollection
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
PCIeDevices
/redfish/v1/Systems/{ComputerSystemId}/PCIeDevices
/redfish/v1/Chassis/{ChassisId}/PCIeDevices/{PCIeDeviceId}/PCIeFunctions
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/PCIeDevices/{PCIeDeviceId}/PCIeFunctions
PCIeFunctionCollection
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
PCIeDevices/{PCIeDeviceId}/PCIeFunctions
/redfish/v1/Systems/{ComputerSystemId}/PCIeDevices/{PCIeDeviceId}/PCIeFunctions
64 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Collection Type URIs
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports
/redfish/v1/Chassis/{ChassisId}/MediaControllers/{MediaControllerId}/Ports
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Ports
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/
{NetworkInterfaceId}/Ports
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/
{ProcessorId}/Ports
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/
{StorageId}/Controllers/{StorageControllerId}/Ports
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/
{StorageId}/StorageControllers/{StorageControllerId}/Ports
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/GraphicsControllers/{ControllerId}/Ports
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/Ports
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/Processors/{ProcessorId}/Ports
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Ports
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/
Ports
PortCollection /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/USBControllers/{ControllerId}/Ports
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports
/redfish/v1/Managers/{ManagerId}/DedicatedNetworkPorts
/redfish/v1/Managers/{ManagerId}/SharedNetworkPorts
/redfish/v1/Managers/{ManagerId}/USBPorts
/redfish/v1/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/
{NetworkInterfaceId}/Ports
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Ports
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/
{StorageControllerId}/Ports
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/
StorageControllers/{StorageControllerId}/Ports
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/Ports
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
GraphicsControllers/{ControllerId}/Ports
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
NetworkInterfaces/{NetworkInterfaceId}/Ports
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}/Ports
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/
{StorageId}/Controllers/{StorageControllerId}/Ports
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/
{StorageId}/StorageControllers/{StorageControllerId}/Ports
Version 2023.1 Published 65
Redfish Resource and Schema Guide DSP2046
Collection Type URIs
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
USBControllers/{ControllerId}/Ports
/redfish/v1/Storage/{StorageId}/Controllers/{StorageControllerId}/Ports
/redfish/v1/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports
/redfish/v1/Systems/{ComputerSystemId}/GraphicsControllers/{ControllerId}/Ports
/redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/
Ports
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Ports
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/
{StorageControllerId}/Ports
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/
{StorageControllerId}/Ports
/redfish/v1/Systems/{ComputerSystemId}/USBControllers/{ControllerId}/Ports
/redfish/v1/PowerEquipment/ElectricalBuses
/redfish/v1/PowerEquipment/FloorPDUs
/redfish/v1/PowerEquipment/PowerShelves
PowerDistributionCollection
/redfish/v1/PowerEquipment/RackPDUs
/redfish/v1/PowerEquipment/Switchgear
/redfish/v1/PowerEquipment/TransferSwitches
PowerDomainCollection /redfish/v1/Facilities/{FacilityId}/PowerDomains
/redfish/v1/Chassis/{ChassisId}/PowerSubsystem/PowerSupplies
PowerSupplyCollection
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/PowerSupplies
66 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Collection Type URIs
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/
{ProcessorId}/SubProcessors
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/
{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors
/redfish/v1/Chassis/{ChassisId}/Processors
/redfish/v1/Chassis/{ChassisId}/Processors/{ProcessorId}/SubProcessors
/redfish/v1/Chassis/{ChassisId}/Processors/{ProcessorId}/SubProcessors/
{ProcessorId2}/SubProcessors
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/
{ProcessorId}/SubProcessors
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/
{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/Processors
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors
ProcessorCollection
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/
SubProcessors
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/
SubProcessors
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/
SubProcessors/{ProcessorId2}/SubProcessors
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}/SubProcessors
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors
/redfish/v1/Systems/{ComputerSystemId}/Processors
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/
{ProcessorId2}/SubProcessors
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Pumps
PumpCollection /redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Pumps
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Pumps
RegisteredClientCollection /redfish/v1/RegisteredClients
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Reservoirs
ReservoirCollection /redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Reservoirs
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Reservoirs
/redfish/v1/CompositionService/ActivePool
/redfish/v1/CompositionService/FreePool
ResourceBlockCollection
/redfish/v1/CompositionService/ResourceBlocks
/redfish/v1/ResourceBlocks
Version 2023.1 Published 67
Redfish Resource and Schema Guide DSP2046
Collection Type URIs
/redfish/v1/AccountService/Roles
RoleCollection
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/Roles
68 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Collection Type URIs
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/GenZ/MSDT
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/GenZ/SSDT
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/MSDT
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/
LPRT
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/
MPRT
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/SSDT
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/GenZ/MSDT
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/GenZ/SSDT
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/MSDT
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/LPRT
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/MPRT
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT
RouteEntryCollection /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/SSDT
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/GenZ/LPRT
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/GenZ/MPRT
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/LPRT
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/MPRT
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/GenZ/MSDT
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/GenZ/SSDT
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/MSDT
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/LPRT
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/MPRT
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/SSDT
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/GenZ/
MSDT
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/GenZ/
Version 2023.1 Published 69
Redfish Resource and Schema Guide DSP2046
Collection Type URIs
SSDT
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/MSDT
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/
{PortId}/GenZ/LPRT
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/
{PortId}/GenZ/MPRT
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/
{PortId}/LPRT
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/
{PortId}/MPRT
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/SSDT
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/MSDT/{MSDTId}/
RouteSet
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT/
{LPRTId}/RouteSet
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT/
{MPRTId}/RouteSet
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/SSDT/{SSDTId}/
RouteSet
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/LPRT/{LPRTId}/
RouteSet
RouteSetEntryCollection
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/MPRT/{MPRTId}/
RouteSet
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/MSDT/
{MSDTId}/RouteSet
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/
{PortId}/LPRT/{LPRTId}/RouteSet
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/
{PortId}/MPRT/{MPRTId}/RouteSet
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/SSDT/
{SSDTId}/RouteSet
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/SecureBoot/SecureBootDatabases
SecureBootDatabaseCollection /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
SecureBoot/SecureBootDatabases
/redfish/v1/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases
/redfish/v1/Chassis/{ChassisId}/Sensors
/redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}/Sensors
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/Sensors
SensorCollection
/redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Sensors
/redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}/Sensors
/redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Sensors
SerialInterfaceCollection /redfish/v1/Managers/{ManagerId}/SerialInterfaces
SessionCollection /redfish/v1/SessionService/Sessions
70 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Collection Type URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/SecureBoot/SecureBootDatabases/{DatabaseId}/Signatures
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
SignatureCollection
SecureBoot/SecureBootDatabases/{DatabaseId}/Signatures
/redfish/v1/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases/
{DatabaseId}/Signatures
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/SimpleStorage
SimpleStorageCollection /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
SimpleStorage
/redfish/v1/Systems/{ComputerSystemId}/SimpleStorage
/redfish/v1/UpdateService/FirmwareInventory
SoftwareInventoryCollection
/redfish/v1/UpdateService/SoftwareInventory
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/Storage
StorageCollection /redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage
/redfish/v1/Storage
/redfish/v1/Systems/{ComputerSystemId}/Storage
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/
{StorageId}/Controllers
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/Storage/{StorageId}/Controllers
StorageControllerCollection /redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/
{StorageId}/Controllers
/redfish/v1/Storage/{StorageId}/Controllers
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers
SwitchCollection /redfish/v1/Fabrics/{FabricId}/Switches
/redfish/v1/TaskService/Tasks
TaskCollection
/redfish/v1/TaskService/Tasks/{TaskId}/SubTasks
TriggersCollection /redfish/v1/TelemetryService/Triggers
TrustedComponentCollection /redfish/v1/Chassis/{ChassisId}/TrustedComponents
USBControllerCollection /redfish/v1/Systems/{ComputerSystemId}/USBControllers
Version 2023.1 Published 71
Redfish Resource and Schema Guide DSP2046
Collection Type URIs
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/GenZ/REQ-VCAT
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/GenZ/RSP-VCAT
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/
VCAT
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/VCAT
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/REQ-VCAT
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/RSP-VCAT
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{SystemId}/FabricAdapters/{FabricAdapterId}/GenZ/REQ-VCAT
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{SystemId}/FabricAdapters/{FabricAdapterId}/GenZ/RSP-VCAT
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{SystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/VCAT
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{SystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/VCAT
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{SystemId}/FabricAdapters/{FabricAdapterId}/REQ-VCAT
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{SystemId}/FabricAdapters/{FabricAdapterId}/RSP-VCAT
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/GenZ/VCAT
VCATEntryCollection
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/VCAT
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/
{FabricAdapterId}/GenZ/REQ-VCAT
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/
{FabricAdapterId}/GenZ/RSP-VCAT
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/
{FabricAdapterId}/Ports/{PortId}/GenZ/VCAT
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/
{FabricAdapterId}/Ports/{PortId}/VCAT
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/
{FabricAdapterId}/REQ-VCAT
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/
{FabricAdapterId}/RSP-VCAT
/redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/GenZ/REQ-VCAT
/redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/GenZ/RSP-VCAT
/redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/
GenZ/VCAT
/redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/VCAT
/redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/REQ-VCAT
/redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/RSP-VCAT
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/VirtualMedia
/redfish/v1/Managers/{ManagerId}/VirtualMedia
VirtualMediaCollection
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
VirtualMedia
/redfish/v1/Systems/{ComputerSystemId}/VirtualMedia
72 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Collection Type URIs
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/
NetworkDeviceFunctions/{NetworkDeviceFunctionId}/Ethernet/VLANs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/EthernetInterfaces/
{EthernetInterfaceId}/VLANs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs
VLanNetworkInterfaceCollection /redfish/v1/Managers/{ManagerId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs
/redfish/v1/ResourceBlocks/{ResourceBlockId}/EthernetInterfaces/
{EthernetInterfaceId}/VLANs
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
EthernetInterfaces/{EthernetInterfaceId}/VLANs
/redfish/v1/Systems/{ComputerSystemId}/EthernetInterfaces/{EthernetInterfaceId}/
VLANs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/
{StorageId}/Volumes
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/
{ComputerSystemId}/Storage/{StorageId}/Volumes
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Volumes
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/
{StorageId}/Volumes
/redfish/v1/Storage/{StorageId}/ConsistencyGroups/{ConsistencyGroupId}/Volumes
/redfish/v1/Storage/{StorageId}/FileSystems/{FileSystemId}/CapacitySources/
{CapacitySourceId}/ProvidingVolumes
/redfish/v1/Storage/{StorageId}/StoragePools/{StoragePoolId}/AllocatedVolumes
/redfish/v1/Storage/{StorageId}/StoragePools/{StoragePoolId}/CapacitySources/
{CapacitySourceId}/ProvidingVolumes
/redfish/v1/Storage/{StorageId}/Volumes
/redfish/v1/StorageServices/{StorageServiceId}/ConsistencyGroups/
{ConsistencyGroupId}/Volumes
/redfish/v1/StorageServices/{StorageServiceId}/FileSystems/{FileSystemId}/
VolumeCollection
CapacitySources/{CapacitySourceId}/ProvidingVolumes
/redfish/v1/StorageServices/{StorageServiceId}/StoragePools/{StoragePoolId}/
AllocatedVolumes
/redfish/v1/StorageServices/{StorageServiceId}/StoragePools/{StoragePoolId}/
CapacitySources/{CapacitySourceId}/ProvidingVolumes
/redfish/v1/StorageServices/{StorageServiceId}/Volumes
/redfish/v1/StorageServices/{StorageServiceId}/Volumes/{VolumeId}/CapacitySources/
{CapacitySourceId}/ProvidingVolumes
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/ConsistencyGroups/
{ConsistencyGroupId}/Volumes
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/FileSystems/
{FileSystemId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StoragePools/
{StoragePoolId}/AllocatedVolumes
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StoragePools/
{StoragePoolId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes
Version 2023.1 Published 73
Redfish Resource and Schema Guide DSP2046
Collection Type URIs
/redfish/v1/CompositionService/ResourceZones
ZoneCollection
/redfish/v1/Fabrics/{FabricId}/Zones
74 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6 Reference Guide
To produce this guide, DMTF's Redfish Documentation Generator merges DMTF's Redfish Schema
Bundle (DSP8010) contents with supplemental text.
6.1 AccelerationFunction 1.0.3
Version v1.0
Release 2018.3
6.1.1 Description
The AccelerationFunction schema describes an acceleration function that a processor implements. This
can include functions such as audio processing, compression, encryption, packet inspection, packet
switching, scheduling, or video processing.
6.1.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/
AccelerationFunctions/{AccelerationFunctionId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}/AccelerationFunctions/{AccelerationFunctionId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/AccelerationFunctions/
{AccelerationFunctionId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/
{ProcessorId}/AccelerationFunctions/{AccelerationFunctionId}
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/AccelerationFunctions/
{AccelerationFunctionId}
6.1.3 Properties
Property Type Attributes Notes
string read-only The acceleration function type. For the possible property values,
AccelerationFunctionType
(enum) (null) see AccelerationFunctionType in Property details.
Version 2023.1 Published 75
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
FpgaReconfigurationSlots array An array of the reconfiguration slot identifiers of the FPGA that this
read-only
[] (string) acceleration function occupies.
Links { object The links to other Resources that are related to this Resource.
An array of links to the endpoints that connect to this acceleration
Endpoints [ { array
function.
Link to a Endpoint resource. See the Links section and the Endpoint
@odata.id string read-only
schema for details.
}]
Oem {} object See the Oem object definition in the Common properties section.
An array of links to the PCIeFunctions associated with this
PCIeFunctions [ { array
acceleration function.
Link to a PCIeFunction resource. See the Links section and the
@odata.id string read-only
PCIeFunction schema for details.
}]
Manufacturer string read-only The acceleration function code manufacturer.
integer
PowerWatts read-only The acceleration function power consumption, in watts.
(Watts)
The status and health of the Resource and its subordinate or
Status {} object
dependent Resources. For property details, see Status.
string read-only
UUID The UUID for this acceleration function.
(uuid) (null)
Version string read-only The acceleration function version.
6.1.4 Property details
6.1.4.1 AccelerationFunctionType
The acceleration function type.
string Description
AudioProcessing An audio processing function.
76 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Compression A compression function.
Encryption An encryption function.
OEM An OEM-defined acceleration function.
PacketInspection A packet inspection function.
PacketSwitch A packet switch function.
Scheduler A scheduler function.
VideoProcessing A video processing function.
6.1.5 Example response
{
"@odata.type": "#AccelerationFunction.v1_0_3.AccelerationFunction",
"Id": "Compression",
"Name": "Compression Accelerator",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"FpgaReconfigurationSlots": [
"AFU0"
],
"AccelerationFunctionType": "Compression",
"Manufacturer": "Intel (R) Corporation",
"Version": "Green Compression Type 1 v.1.00.86",
"PowerWatts": 15,
"Links": {
"Endpoints": [],
"PCIeFunctions": []
},
"@odata.id": "/redfish/v1/Systems/1/Processors/FPGA1/AccelerationFunctions/Compression"
}
6.2 AccountService 1.13.0
Version v1.13 v1.12 v1.11 v1.10 v1.9 v1.8 v1.7 v1.6 v1.5 v1.4 v1.3 ...
Release 2023.1 2022.3 2022.1 2021.2 2021.1 2020.4 2019.4 2019.2 2019.1 2018.3 2018.1 ...
Version 2023.1 Published 77
Redfish Resource and Schema Guide DSP2046
6.2.1 Description
The AccountService schema defines an account service. The properties are common to, and enable
management of, all user accounts. The properties include the password requirements and control
features, such as account lockout. Properties and actions in this service specify general behavior that
should be followed for typical accounts, however implementations may override these behaviors for
special accounts or situations to avoid denial of service or other deadlock situations.
6.2.2 URIs
/redfish/v1/AccountService
/redfish/v1/Managers/{ManagerId}/RemoteAccountService
6.2.3 Properties
Property Type Attributes Notes
The period of time, in seconds, between the last
failed login attempt and the reset of the lockout
integer
AccountLockoutCounterResetAfter read-write threshold counter. This value must be less than or
(seconds)
equal to the AccountLockoutDuration value. A reset
sets the counter to 0 .
An indication of whether the threshold counter is
reset after AccountLockoutCounterResetAfter
expires. If true , it is reset. If false , only a
successful login resets the threshold counter and if
AccountLockoutCounterResetEnabled
boolean read-write the user reaches the AccountLockoutThreshold
(v1.5+)
limit, the account will be locked out indefinitely and
only an administrator-issued reset clears the
threshold counter. If this property is absent, the
default is true .
The period of time, in seconds, that an account is
locked after the number of failed login attempts
reaches the account lockout threshold, within the
integer read-write period between the last failed login attempt and
AccountLockoutDuration
(seconds) (null) the reset of the lockout threshold counter. If this
value is 0 , no lockout will occur. If the
AccountLockoutCounterResetEnabled value is
false , this property is ignored.
The number of allowed failed login attempts before
read-write
AccountLockoutThreshold integer a user account is locked for a specified duration. If
(null)
0 , the account is never locked.
78 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The collection of manager accounts. Contains a link
Accounts { object
to a resource.
Link to Collection of ManagerAccount. See the
@odata.id string read-only
ManagerAccount schema for details.
The first Active Directory external account provider
that this account service supports. For more
ActiveDirectory (v1.3+) {} object
information about this property, see
ExternalAccountProvider in Property Details.
AdditionalExternalAccountProviders The additional external account providers that this
object
(v1.3+) { account service uses. Contains a link to a resource.
Link to Collection of ExternalAccountProvider. See
@odata.id string read-only
the ExternalAccountProvider schema for details.
The number of authorization failures per account
AuthFailureLoggingThreshold integer read-write that are allowed before the failed attempt is logged
to the manager log.
The first LDAP external account provider that this
account service supports. For more information
LDAP (v1.3+) {} object
about this property, see ExternalAccountProvider in
Property Details.
An indication of how the service uses the accounts
collection within this account service as part of
string
LocalAccountAuth (v1.3+) read-write authentication. The enumerated values describe
(enum)
the details for each mode. For the possible property
values, see LocalAccountAuth in Property details.
The maximum password length for this account
MaxPasswordLength integer read-write
service.
The minimum password length for this account
MinPasswordLength integer read-write
service.
The multi-factor authentication settings that this
MultiFactorAuth (v1.12+) { object
(null) account service supports.
The settings related to client certificate
ClientCertificate (v1.12+) { object
(null) authentication schemes such as mTLS or CAC/PIV.
The client certificate attribute to map to a user. For
CertificateMappingAttribute string read-write
the possible property values, see
(v1.12+) (enum) (null)
CertificateMappingAttribute in Property details.
Version 2023.1 Published 79
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The link to a collection of CA certificates used to
Certificates (v1.12+) { object validate client certificates. Contains a link to a
resource.
Link to Collection of Certificate. See the Certificate
@odata.id string read-only
schema for details.
read-write An indication of whether client certificate
Enabled (v1.12+) boolean
(null) authentication is enabled.
RespondToUnauthenticatedClients read-write An indication of whether the service responds to
boolean
(v1.12+) (null) clients that do not successfully authenticate.
The settings related to Google Authenticator multi-
GoogleAuthenticator (v1.12+) { object
(null) factor authentication.
read-write An indication of whether multi-factor authentication
Enabled (v1.12+) boolean
(null) with Google Authenticator is enabled.
The secret key to use when communicating with
read-write
SecretKey (v1.12+) string the Google Authenticator server. This property is
(null)
null in responses.
SecretKeySet (v1.12+) boolean read-only Indicates if the SecretKey property is set.
The settings related to Microsoft Authenticator
MicrosoftAuthenticator (v1.12+) { object
(null) multi-factor authentication.
read-write An indication of whether multi-factor authentication
Enabled (v1.12+) boolean
(null) with Microsoft Authenticator is enabled.
The secret key to use when communicating with
read-write
SecretKey (v1.12+) string the Microsoft Authenticator server. This property is
(null)
null in responses.
SecretKeySet (v1.12+) boolean read-only Indicates if the SecretKey property is set.
The settings related to RSA SecurID multi-factor
SecurID (v1.12+) { object
(null) authentication.
The link to a collection of server certificates for the
Certificates (v1.12+) { object RSA SecurID server referenced by the ServerURI
property. Contains a link to a resource.
80 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to Collection of Certificate. See the Certificate
@odata.id string read-only
schema for details.
read-write The client ID to use when communicating with the
ClientId (v1.12+) string
(null) RSA SecurID server.
The client secret to use when communicating with
read-write
ClientSecret (v1.12+) string the RSA SecurID server. This property is null in
(null)
responses.
ClientSecretSet (v1.12+) boolean read-only Indicates if the ClientSecret property is set.
read-write An indication of whether multi-factor authentication
Enabled (v1.12+) boolean
(null) with RSA SecurID is enabled.
string read-write
ServerURI (v1.12+) The URI of the RSA SecurID server.
(URI) (null)
The first OAuth 2.0 external account provider that
this account service supports. For more information
OAuth2 (v1.10+) {} object
(null) about this property, see ExternalAccountProvider in
Property Details.
read-write The number of days before account passwords in
PasswordExpirationDays (v1.9+) integer
(null) this account service will expire.
The link to the mapping of the privileges required to
complete a requested operation on a URI
PrivilegeMap (v1.1+) { object associated with this service. See the
PrivilegeRegistry schema for details on this
property.
Link to a PrivilegeRegistry resource. See the Links
@odata.id string read-only section and the PrivilegeRegistry schema for
details.
array
RestrictedOemPrivileges (v1.8+) [ ] read-only The set of restricted OEM privileges.
(string)
array The set of restricted Redfish privileges. For the
RestrictedPrivileges (v1.8+) [ ] (string read-only possible property values, see RestrictedPrivileges in
(enum)) Property details.
Version 2023.1 Published 81
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The collection of Redfish roles. Contains a link to a
Roles { object
resource.
Link to Collection of Role. See the Role schema for
@odata.id string read-only
details.
An indication of whether the account service is
enabled. If true , it is enabled. If false , it is
disabled and users cannot be created, deleted, or
modified, and new sessions cannot be started.
read-write
ServiceEnabled boolean However, established sessions might still continue
(null)
to run. Any service, such as the session service,
that attempts to access the disabled account
service fails. However, this does not affect HTTP
Basic Authentication connections.
The status and health of the resource and its
Status {} object subordinate or dependent resources. For property
details, see Status.
array The account types supported by the service. For the
SupportedAccountTypes (v1.8+) [ ] (string read-only possible property values, see
(enum)) SupportedAccountTypes in Property details.
array
SupportedOEMAccountTypes (v1.8+) [ ] read-only The OEM account types supported by the service.
(string)
The first TACACS+ external account provider that
this account service supports. For more information
TACACSplus (v1.8+) {} object
(null) about this property, see ExternalAccountProvider in
Property Details.
6.2.4 Property details
6.2.4.1 AccountProviderType
The type of external account provider to which this service connects.
string Description
ActiveDirectoryService An external Active Directory service.
LDAPService A generic external LDAP service.
82 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
OAuth2 (v1.10+) An external OAuth 2.0 service.
OEM An OEM-specific external authentication or directory service.
RedfishService An external Redfish service.
TACACSplus (v1.8+) An external TACACS+ service.
6.2.4.2 Authentication
The information required to authenticate to the external service.
read-
AuthenticationType string The type of authentication used to connect to the external account provider. For
write
(v1.3+) (enum) the possible property values, see AuthenticationType in Property details.
(null)
read-
EncryptionKey
string write Specifies the encryption key.
(v1.8+)
(null)
read-
EncryptionKeySet
boolean only Indicates if the EncryptionKey property is set.
(v1.8+)
(null)
read-
KerberosKeytab The Base64-encoded version of the Kerberos keytab for this service. A PATCH or
string write
(v1.3+) PUT operation writes the keytab. This property is null in responses.
(null)
Oem (v1.3+) {} object See the Oem object definition in the Common properties section.
read-
The password for this service. A PATCH or PUT request writes the password. This
Password (v1.3+) string write
property is null in responses.
(null)
read-
The token for this service. A PATCH or PUT operation writes the token. This
Token (v1.3+) string write
property is null in responses.
(null)
read-
Username (v1.3+) string The user name for the service.
write
6.2.4.3 AuthenticationType
The type of authentication used to connect to the external account provider.
Version 2023.1 Published 83
Redfish Resource and Schema Guide DSP2046
string Description
KerberosKeytab A Kerberos keytab.
OEM An OEM-specific authentication mechanism.
Token An opaque authentication token.
UsernameAndPassword A user name and password combination.
6.2.4.4 BypassTypes
The types of multi-factor authentication this account or role mapping is allowed to bypass.
string Description
All Bypass all multi-factor authentication types.
ClientCertificate Bypass client certificate authentication.
GoogleAuthenticator Bypass Google Authenticator.
MicrosoftAuthenticator Bypass Microsoft Authenticator.
OEM Bypass OEM-defined multi-factor authentication.
SecurID Bypass RSA SecurID.
6.2.4.5 CertificateMappingAttribute
The client certificate attribute to map to a user.
string Description
CommonName Match the Common Name (CN) field in the provided certificate to the username.
UserPrincipalName Match the User Principal Name (UPN) field in the provided certificate to the username.
Whole Match the whole certificate.
6.2.4.6 ExternalAccountProvider
The external account provider services that can provide accounts for this manager to use for
authentication.
84 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
The type of external account provider to which this service connects. For the
AccountProviderType read-
string possible property values, see AccountProviderType in Property details.
(v1.3+, deprecated only
(enum) Deprecated in v1.5 and later. This property is deprecated because the account
v1.5 (null)
provider type is known when used in the LDAP and ActiveDirectory objects.
Authentication The authentication information for the external account provider. For more
object
(v1.3+) {} information about this property, see Authentication in Property Details.
The link to a collection of certificates that the external account provider uses.
Certificates (v1.4+) { object
Contains a link to a resource.
read-
@odata.id string Link to Collection of Certificate. See the Certificate schema for details.
only
LDAPService (v1.3+) The additional mapping information needed to parse a generic LDAP service. For
object
{} more information about this property, see LDAPService in Property Details.
OAuth2Service The additional information needed to parse an OAuth 2.0 service. For more
object
(v1.10+) {} (null) information about this property, see OAuth2Service in Property Details.
read-
PasswordSet (v1.7+) boolean Indicates if the Password property is set.
only
read-
Priority (v1.8+) integer write The authentication priority for the external account provider.
(null)
RemoteRoleMapping The mapping rules to convert the external account providers account
array
(v1.3+) [ { information to the local Redfish role.
read-
LocalRole (v1.3+) string write The name of the local Redfish role to which to map the remote user or group.
(null)
MFABypass
object The multi-factor authentication bypass settings.
(v1.12+) { (null)
array read-
BypassTypes The types of multi-factor authentication this account or role mapping is allowed
(string write
(v1.12+) [ ] to bypass. For the possible property values, see BypassTypes in Property details.
(enum)) (null)
Oem (v1.3+) {} object See the Oem object definition in the Common properties section.
read-
RemoteGroup The name of the remote group, or the remote role in the case of a Redfish
string write
(v1.3+) service, that maps to the local Redfish role to which this entity links.
(null)
Version 2023.1 Published 85
Redfish Resource and Schema Guide DSP2046
read-
RemoteUser The name of the remote user that maps to the local Redfish role to which this
string write
(v1.3+) entity links.
(null)
}]
read-
The number of times to retry connecting to an address in the ServiceAddresses
Retries (v1.13+) integer write
property before attempting the next address in the array.
(null)
array The addresses of the user account providers to which this external account
ServiceAddresses read-
(string, provider links. The format of this field depends on the type of external account
(v1.3+) [ ] write
null) provider.
read-
ServiceEnabled
boolean write An indication of whether this service is enabled.
(v1.3+)
(null)
TACACSplusService The additional information needed to parse a TACACS+ services. For more
object
(v1.8+) {} (null) information about this property, see TACACSplusService in Property Details.
read-
TimeoutSeconds The period of time, in seconds, this account service will wait for a response from
integer write
(v1.13+) an address of a user account provider before timing out.
(null)
6.2.4.7 LDAPService
The settings required to parse a generic LDAP service.
Oem (v1.3+) {} object See the Oem object definition in the Common properties section.
SearchSettings (v1.3+) { object The required settings to search an external LDAP service.
array
BaseDistinguishedNames read-
(string, The base distinguished names to use to search an external LDAP service.
(v1.3+) [ ] write
null)
read-
GroupNameAttribute
string write The attribute name that contains the LDAP group name entry.
(v1.3+)
(null)
read-
The attribute name that contains the groups for a user on the LDAP user
GroupsAttribute (v1.3+) string write
entry.
(null)
read-
SSHKeyAttribute (v1.11+) string write The attribute name that contains the LDAP user's SSH public key entry.
(null)
86 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
read-
UsernameAttribute
string write The attribute name that contains the LDAP user name entry.
(v1.3+)
(null)
6.2.4.8 LocalAccountAuth
An indication of how the service uses the accounts collection within this account service as part of
authentication. The enumerated values describe the details for each mode.
string Description
The service never authenticates users based on the account service-defined accounts
Disabled
collection.
Enabled The service authenticates users based on the account service-defined accounts collection.
The service authenticates users based on the account service-defined accounts collection
Fallback
only if any external account providers are currently unreachable.
The service first authenticates users based on the account service-defined accounts
LocalFirst (v1.6+) collection. If authentication fails, the service authenticates by using external account
providers.
6.2.4.9 Mode
The mode of operation for token validation.
string Description
Discovery OAuth 2.0 service information for token validation is downloaded by the service.
OAuth 2.0 service information for token validation is configured by a client. Clients should
Offline
configure the Issuer and OAuthServiceSigningKeys properties for this mode.
6.2.4.10 OAuth2Service
Various settings to parse an OAuth 2.0 service.
array read-
Audience (v1.10+) [ ] The allowable audience strings of the Redfish service.
(string) only
Version 2023.1 Published 87
Redfish Resource and Schema Guide DSP2046
read-
The issuer string of the OAuth 2.0 service. Clients should configure this
Issuer (v1.10+) string write
property if Mode contains Offline .
(null)
string read- The mode of operation for token validation. For the possible property values,
Mode (v1.10+)
(enum) write see Mode in Property details.
read-
OAuthServiceSigningKeys The Base64-encoded signing keys of the issuer of the OAuth 2.0 service.
string write
(v1.10+) Clients should configure this property if Mode contains Offline .
(null)
Oem (v1.13+) {} object See the Oem object definition in the Common properties section.
6.2.4.11 PasswordExchangeProtocols
Indicates the allowed TACACS+ password exchange protocols.
string Description
ASCII The ASCII Login method.
CHAP The CHAP Login method.
MSCHAPv1 The MS-CHAP v1 Login method.
MSCHAPv2 The MS-CHAP v2 Login method.
PAP The PAP Login method.
6.2.4.12 RestrictedPrivileges
The set of restricted Redfish privileges.
string Description
Administrator for storage subsystems and storage systems found in the storage
AdministrateStorage
collection and storage system collection respectively.
Administrator for systems found in the systems collection. Able to manage boot
AdministrateSystems
configuration, keys, and certificates for systems.
ConfigureComponents Can configure components that this service manages.
ConfigureCompositionInfrastructure Can view and configure composition service resources.
ConfigureManager Can configure managers.
88 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Can change the password for the current user account, log out of their own sessions,
ConfigureSelf and perform operations on resources they created. Services will need to be aware of
resource ownership to map this privilege to an operation from a particular user.
ConfigureUsers Can configure users and their accounts.
Login Can log in to the service and read resources.
NoAuth Authentication is not required.
Operator for storage backup functionality for storage subsystems and storage
OperateStorageBackup
systems found in the storage collection and storage system collection respectively.
Operator for systems found in the systems collection. Able to perform resets and
OperateSystems
configure interfaces.
6.2.4.13 SupportedAccountTypes
The account types supported by the service.
string Description
Allow access to the host's console, which could be connected through Telnet, SSH, or other
HostConsole
protocol.
IPMI Allow access to the Intelligent Platform Management Interface service.
KVMIP Allow access to a Keyboard-Video-Mouse over IP session.
Allow access to the manager's console, which could be connected through Telnet, SSH, SM
ManagerConsole
CLP, or other protocol.
OEM OEM account type. See the OEMAccountTypes property.
Redfish Allow access to the Redfish service.
SNMP Allow access to SNMP services.
VirtualMedia Allow access to control virtual media.
Allow access to a web user interface session, such as a graphical interface or another web-
WebUI
based protocol.
6.2.4.14 TACACSplusService
Various settings to parse a TACACS+ service.
Version 2023.1 Published 89
Redfish Resource and Schema Guide DSP2046
AuthorizationService read-
string The TACACS+ service authorization argument.
(v1.13+) write
Oem (v1.13+) {} object See the Oem object definition in the Common properties section.
array read- Indicates the allowed TACACS+ password exchange protocols. For the
PasswordExchangeProtocols
(string write possible property values, see PasswordExchangeProtocols in Property
(v1.8+) [ ]
(enum)) (null) details.
read-
PrivilegeLevelArgument Indicates the name of the TACACS+ argument name in an authorization
string write
(v1.8+) request.
(null)
6.2.5 Example response
{
"@odata.type": "#AccountService.v1_13_0.AccountService",
"Id": "AccountService",
"Name": "Account Service",
"Description": "Local Manager Account Service",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"ServiceEnabled": true,
"AuthFailureLoggingThreshold": 3,
"MinPasswordLength": 8,
"AccountLockoutThreshold": 5,
"AccountLockoutDuration": 30,
"AccountLockoutCounterResetAfter": 30,
"AccountLockoutCounterResetEnabled": true,
"Accounts": {
"@odata.id": "/redfish/v1/AccountService/Accounts"
},
"Roles": {
"@odata.id": "/redfish/v1/AccountService/Roles"
},
"LocalAccountAuth": "Enabled",
"LDAP": {
"AccountProviderType": "LDAPService",
"ServiceEnabled": false,
"ServiceAddresses": [
"ldaps://ldap.example.org:636"
],
"Authentication": {
"AuthenticationType": "UsernameAndPassword",
"Username": "cn=Manager,dc=example,dc=org",
"Password": null
90 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
},
"LDAPService": {
"SearchSettings": {
"BaseDistinguishedNames": [
"dc=example,dc=org"
],
"UsernameAttribute": "uid",
"GroupsAttribute": "memberof"
}
},
"RemoteRoleMapping": [
{
"RemoteUser": "cn=Manager,dc=example,dc=org",
"LocalRole": "Administrator"
},
{
"RemoteGroup": "cn=Admins,ou=Groups,dc=example,dc=org",
"LocalRole": "Administrator"
},
{
"RemoteGroup": "cn=PowerUsers,ou=Groups,dc=example,dc=org",
"LocalRole": "Operator"
},
{
"RemoteGroup": "(cn=*)",
"LocalRole": "ReadOnly"
}
]
},
"ActiveDirectory": {
"AccountProviderType": "ActiveDirectoryService",
"ServiceEnabled": true,
"ServiceAddresses": [
"ad1.example.org",
"ad2.example.org",
null,
null
],
"Authentication": {
"AuthenticationType": "KerberosKeytab",
"KerberosKeytab": null
},
"RemoteRoleMapping": [
{
"RemoteGroup": "Administrators",
"LocalRole": "Administrator"
},
{
"RemoteUser": "DOMAIN\\Bob",
"LocalRole": "Operator"
Version 2023.1 Published 91
Redfish Resource and Schema Guide DSP2046
},
{
"RemoteGroup": "PowerUsers",
"LocalRole": "Operator"
},
{
"RemoteGroup": "Everybody",
"LocalRole": "ReadOnly"
}
]
},
"AdditionalExternalAccountProviders": {
"@odata.id": "/redfish/v1/AccountService/ExternalAccountProviders"
},
"@odata.id": "/redfish/v1/AccountService"
}
6.3 ActionInfo 1.3.0
Version v1.3 v1.2 v1.1 v1.0
Release 2022.2 2021.2 2018.2 2016.2
6.3.1 Description
The ActionInfo schema defines the supported parameters and other information for a Redfish action.
Supported parameters can differ among vendors and even among resource instances. This data can
ensure that action requests from applications contain supported parameters.
6.3.2 Properties
Property Type Attributes Notes
Parameters [ { array The list of parameters included in the specified Redfish action.
array The allowable numeric values or duration values, inclusive ranges of
AllowableNumbers
(string, read-only values, and incremental step values for this parameter as applied to
(v1.3+) [ ]
null) this action target.
AllowablePattern read-only The allowable pattern for this parameter as applied to this action
string
(v1.3+) (null) target.
92 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
array
The allowable values for this parameter as applied to this action
AllowableValues [ ] (string, read-only
target.
null)
ArraySizeMaximum read-only
integer The maximum number of array elements allowed for this parameter.
(v1.2+) (null)
ArraySizeMinimum read-only
integer The minimum number of array elements required for this parameter.
(v1.2+) (null)
string read-only The JSON property type for this parameter. For the possible property
DataType
(enum) (null) values, see DataType in Property details.
MaximumValue read-only
number The maximum supported value for this parameter.
(v1.1+) (null)
MinimumValue read-only
number The minimum supported value for this parameter.
(v1.1+) (null)
read-only
Name string The name of the parameter for this action.
required
read-only
ObjectDataType string The data type of an object-based parameter.
(null)
An indication of whether the parameter is required to complete this
Required boolean read-only
action.
}]
6.3.3 Property details
6.3.3.1 DataType
The JSON property type for this parameter.
string Description
Boolean A boolean.
Number A number.
NumberArray An array of numbers.
Object An embedded JSON object.
ObjectArray An array of JSON objects.
Version 2023.1 Published 93
Redfish Resource and Schema Guide DSP2046
string Description
String A string.
StringArray An array of strings.
6.3.4 Example response
{
"@odata.type": "#ActionInfo.v1_3_0.ActionInfo",
"Id": "ResetActionInfo",
"Name": "Reset Action Info",
"Parameters": [
{
"Name": "ResetType",
"Required": true,
"DataType": "String",
"AllowableValues": [
"On",
"ForceOff",
"GracefulShutdown",
"GracefulRestart",
"ForceRestart",
"Nmi",
"ForceOn",
"PushPowerButton"
]
}
],
"@odata.id": "/redfish/v1/Systems/1/ResetActionInfo"
}
6.4 AddressPool 1.2.2
Version v1.2 v1.1 v1.0
Release 2021.2 2020.3 2019.4
6.4.1 Description
The schema definition of an address pool and its configuration.
94 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.4.2 URIs
/redfish/v1/Fabrics/{FabricId}/AddressPools/{AddressPoolId}
6.4.3 Properties
Property Type Attributes Notes
The Ethernet related properties for this
Ethernet (v1.1+) { object
address pool.
Bidirectional Forwarding Detection (BFD)
BFDSingleHopOnly (v1.1+) { object
(null) related properties for this Ethernet fabric.
read-write Bidirectional Forwarding Detection (BFD)
DemandModeEnabled (v1.1+) boolean
(null) Demand Mode status.
read-write Desired Bidirectional Forwarding Detection
DesiredMinTxIntervalMilliseconds (v1.1+) integer
(null) (BFD) minimal transmit interval.
read-write Bidirectional Forwarding Detection (BFD)
KeyChain (v1.1+) string
(null) Key Chain name.
read-write Bidirectional Forwarding Detection (BFD)
LocalMultiplier (v1.1+) integer
(null) multiplier value.
Meticulous MD5 authentication of the
read-write
MeticulousModeEnabled (v1.1+) boolean Bidirectional Forwarding Detection (BFD)
(null)
session.
read-write Bidirectional Forwarding Detection (BFD)
RequiredMinRxIntervalMilliseconds (v1.1+) integer
(null) receive value.
read-write Bidirectional Forwarding Detection (BFD)
SourcePort (v1.1+) integer
(null) source port.
BGP Ethernet Virtual Private Network
BGPEvpn (v1.1+) { object (EVPN) related properties for this Ethernet
(null)
fabric.
read-write
AnycastGatewayIPAddress (v1.1+) string The anycast gateway IPv4 address.
(null)
read-write
AnycastGatewayMACAddress (v1.1+) string The anycast gateway MAC address.
(null)
Version 2023.1 Published 95
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-write Address Resolution Protocol (ARP) proxy
ARPProxyEnabled (v1.1+) boolean
(null) status.
read-write Address Resolution Protocol (ARP)
ARPSupressionEnabled (v1.1+) boolean
(null) suppression status.
The Ethernet Segment Identifier (ESI)
ESINumberRange (v1.1+) { object
(null) number range for the fabric.
Lower Ethernet Segment Identifier (ESI)
Lower (v1.1+) integer read-write
number.
Upper Ethernet Segment Identifier (ESI)
Upper (v1.1+) integer read-write
number.
The Ethernet Virtual Private Network
EVINumberRange (v1.1+) { object (EVPN) Instance number (EVI) number
(null)
range for the fabric.
Lower Ethernet Virtual Private Network
Lower (v1.1+) integer read-write
(EVPN) Instance (EVI) number.
Upper Ethernet Virtual Private Network
Upper (v1.1+) integer read-write
(EVPN) Instance (EVI) number.
read-write
GatewayIPAddress (v1.1+) string The gateway IPv4 address.
(null)
GatewayIPAddressRange (v1.2+) { object The IPv4 address range for gateways.
(null)
read-write
Lower (v1.2+) string The lower IPv4 address.
(null)
read-write
Upper (v1.2+) string The upper IPv4 address.
(null)
read-write Network Discovery Protocol (NDP) proxy
NDPProxyEnabled (v1.1+) boolean
(null) status.
read-write Network Discovery Protocol (NDP)
NDPSupressionEnabled (v1.1+) boolean
(null) suppression status.
RouteDistinguisherAdministratorSubfield read-write The Route Distinguisher (RD) Administrator
string
(v1.2+) (null) subfield.
96 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The Route Distinguisher (RD) number range
RouteDistinguisherRange (v1.1+) { object
(null) for the fabric.
Lower (v1.1+) integer read-write Lower Route Distinguisher (RD) number.
Upper (v1.1+) integer read-write Upper Route Distinguisher (RD) number.
read-write The Route Target (RT) Administrator
RouteTargetAdministratorSubfield (v1.2+) string
(null) Subfield.
The Route Target (RT) number range for the
RouteTargetRange (v1.1+) { object
(null) fabric.
read-write
Lower (v1.1+) integer Lower Route Target (RT) number.
(null)
read-write
Upper (v1.1+) integer Upper Route Target (RT) number.
(null)
read-write
UnderlayMulticastEnabled (v1.1+) boolean Underlay multicast status.
(null)
UnknownUnicastSuppressionEnabled read-write
boolean Suppression of unknown unicast packets.
(v1.1+) (null)
Virtual LAN (VLAN) tag related address
VLANIdentifierAddressRange (v1.1+) { object range applicable to this Ethernet fabric or
(null)
for end host subnets.
read-write
Lower (v1.1+) integer Virtual LAN (VLAN) tag lower value.
(null)
read-write
Upper (v1.1+) integer Virtual LAN (VLAN) tag upper value.
(null)
External BGP (eBGP) related properties for
EBGP (v1.1+) { object
(null) this Ethernet fabric.
read-write Allow duplicate Autonomous System (AS)
AllowDuplicateASEnabled (v1.1+) boolean
(null) path.
Version 2023.1 Published 97
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Option to override an Autonomous System
read-write
AllowOverrideASEnabled (v1.1+) boolean (AS) number with the AS number of the
(null)
sending peer .
read-write Compare Multi Exit Discriminator (MED)
AlwaysCompareMEDEnabled (v1.1+) boolean
(null) status.
ASNumberRange (v1.1+) { object Autonomous System (AS) number range.
(null)
Lower (v1.1+) integer read-write Lower Autonomous System (AS) number.
Upper (v1.1+) integer read-write Upper Autonomous System (AS) number.
read-write
BGPLocalPreference (v1.1+) integer Local preference value.
(null)
Border Gateway Protocol (BGP) neighbor
BGPNeighbor (v1.1+) { object
(null) related properties.
read-write Border Gateway Protocol (BGP) neighbor
Address (v1.1+) string
(null) address.
read-write
AllowOwnASEnabled (v1.1+) boolean Allow own Autonomous System (AS) status.
(null)
The Classless Inter-Domain Routing (CIDR)
value used for neighbor communication.
CIDR (v1.2+) integer read-write
This is the number of ones before the first
zero in the subnet mask.
read-write Border Gateway Protocol (BGP) retry timer
ConnectRetrySeconds (v1.1+) integer
(null) in seconds.
An indication of whether BGP neighbor
Enabled (v1.2+) boolean read-write
communication is enabled.
read-write Border Gateway Protocol (BGP) hold timer
HoldTimeSeconds (v1.1+) integer
(null) in seconds.
read-write Border Gateway Protocol (BGP) Keepalive
KeepaliveIntervalSeconds (v1.1+) integer
(null) timer in seconds.
read-write
LocalAS (v1.1+) integer Local Autonomous System (AS) number.
(null)
read-write Border Gateway Protocol (BGP) neighbor
LogStateChangesEnabled (v1.1+) boolean
(null) log state change status.
98 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Border Gateway Protocol (BGP) max prefix
MaxPrefix (v1.1+) { object
(null) properties.
read-write
MaxPrefixNumber (v1.1+) integer Maximum prefix number.
(null)
read-write Border Gateway Protocol (BGP) restart
RestartTimerSeconds (v1.1+) integer
(null) timer in seconds.
ShutdownThresholdPercentage number read-write
Shutdown threshold status.
(v1.1+) (%) (null)
ThresholdWarningOnlyEnabled read-write
boolean Threshold warning only status.
(v1.1+) (null)
MinimumAdvertisementIntervalSeconds read-write Minimum Border Gateway Protocol (BGP)
integer
(v1.1+) (null) advertisement interval in seconds.
read-write Border Gateway Protocol (BGP) passive
PassiveModeEnabled (v1.1+) boolean
(null) mode status.
read-write
PathMTUDiscoveryEnabled (v1.1+) boolean Path MTU discovery status.
(null)
read-write
PeerAS (v1.1+) integer Peer Autonomous System (AS) number.
(null)
read-write Replace Border Gateway Protocol (BGP)
ReplacePeerASEnabled (v1.1+) boolean
(null) peer Autonomous System (AS) status.
read-write
TCPMaxSegmentSizeBytes (v1.1+) integer TCP max segment size in Bytes.
(null)
read-write Border Gateway Protocol (BGP) treat as
TreatAsWithdrawEnabled (v1.1+) boolean
(null) withdraw status.
Border Gateway Protocol (BGP) route
BGPRoute (v1.1+) { object
(null) related properties.
read-write
AdvertiseInactiveRoutesEnabled (v1.1+) boolean Advertise inactive route status.
(null)
read-write
DistanceExternal (v1.1+) integer Route distance for external routes.
(null)
read-write
DistanceInternal (v1.1+) integer Route distance for internal routes.
(null)
Version 2023.1 Published 99
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-write
DistanceLocal (v1.1+) integer Route distance for local routes.
(null)
ExternalCompareRouterIdEnabled read-write
boolean Compare router id status.
(v1.1+) (null)
read-write
FlapDampingEnabled (v1.1+) boolean Route flap dampening status.
(null)
read-write
SendDefaultRouteEnabled (v1.1+) boolean Send default route status.
(null)
read-write
BGPWeight (v1.1+) integer BGP weight attribute.
(null)
GracefulRestart (v1.1+) { object Graceful restart related properties.
(null)
read-write Border Gateway Protocol (BGP) graceful
GracefulRestartEnabled (v1.1+) boolean
(null) restart status.
read-write
HelperModeEnabled (v1.1+) boolean Graceful restart helper mode status.
(null)
read-write
StaleRoutesTimeSeconds (v1.1+) integer Stale route timer in seconds.
(null)
read-write
TimeSeconds (v1.1+) integer Graceful restart timer in seconds.
(null)
read-write
MED (v1.1+) integer BGP Multi Exit Discriminator (MED) value.
(null)
read-write
MultihopEnabled (v1.1+) boolean External BGP (eBGP) multihop status.
(null)
read-write External BGP (eBGP) multihop Time to Live
MultihopTTL (v1.1+) integer
(null) (TTL) value.
MultiplePaths (v1.1+) { object Multiple path related properties.
(null)
read-write
MaximumPaths (v1.1+) integer Maximum paths number.
(null)
read-write Border Gateway Protocol (BGP) multiple
UseMultiplePathsEnabled (v1.1+) boolean
(null) paths status.
100 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write This property shall indicate whether
SendCommunityEnabled (v1.1+) boolean
(null) community attributes are sent.
IPv4 and Virtual LAN (VLAN) related
IPv4 (v1.1+) { object
(null) addressing for this Ethernet fabric.
read-write
AnycastGatewayIPAddress (v1.1+) string The anycast gateway IPv4 address.
(null)
read-write
AnycastGatewayMACAddress (v1.1+) string The anycast gateway MAC address.
(null)
The Dynamic Host Configuration Protocol
DHCP (v1.1+) { object (DHCP) related addressing for this Ethernet
(null)
fabric.
Dynamic Host Configuration Protocol
read-write
DHCPInterfaceMTUBytes (v1.1+) integer (DHCP) interface Maximum Transmission
(null)
Unit (MTU).
read-write Dynamic Host Configuration Protocol
DHCPRelayEnabled (v1.1+) boolean
(null) (DHCP) relay status.
array The Dynamic Host Configuration Protocol
DHCPServer (v1.1+) [ ] (string, read-write (DHCP) IPv4 addresses for this Ethernet
null) fabric.
read-write Indicates if host subnets should be
DistributeIntoUnderlayEnabled (v1.1+) boolean
(null) distributed into the fabric underlay.
read-write The Domain Name Service (DNS) domain
DNSDomainName (v1.1+) string
(null) name for this Ethernet fabric.
array
The Domain Name Service (DNS) servers
DNSServer (v1.1+) [ ] (string, read-write
for this Ethernet fabric.
null)
External BGP (eBGP) related addressing for
this Ethernet fabric. For more information
EBGPAddressRange (v1.1+) {} object
(null) about this property, see IPv4AddressRange
in Property Details.
Version 2023.1 Published 101
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link related IPv4 addressing for this
Ethernet fabric typically applied to
connections between spine and leaf
FabricLinkAddressRange (v1.1+) {} object
(null) Ethernet switches. For more information
about this property, see IPv4AddressRange
in Property Details.
read-write
GatewayIPAddress (v1.1+) string The gateway IPv4 address.
(null)
IPv4 related host subnet addressing for
physical device endpoints that connect to
HostAddressRange (v1.1+) {} object this Ethernet fabric. For more information
(null)
about this property, see IPv4AddressRange
in Property Details.
Internal BGP (iBGP) related addressing for
this Ethernet fabric. For more information
IBGPAddressRange (v1.1+) {} object
(null) about this property, see IPv4AddressRange
in Property Details.
Loopback related IPv4 addressing for this
Ethernet fabric. For more information about
LoopbackAddressRange (v1.1+) {} object
(null) this property, see IPv4AddressRange in
Property Details.
Management related addressing for this
Ethernet fabric. For more information about
ManagementAddressRange (v1.1+) {} object
(null) this property, see IPv4AddressRange in
Property Details.
read-write
NativeVLAN (v1.1+) integer The untagged Virtual LAN (VLAN) ID value.
(null)
read-write The Network Time Protocol (NTP) offset
NTPOffsetHoursMinutes (v1.1+) integer
(null) configuration.
array
The Network Time Protocol (NTP) servers
NTPServer (v1.1+) [ ] (string, read-write
for this Ethernet fabric.
null)
read-write The Network Time Protocol (NTP) timezone
NTPTimezone (v1.1+) string
(null) for this Ethernet fabric.
The MAC address range for systems in this
SystemMACRange (v1.2+) { object
(null) subnet.
read-write
Lower (v1.2+) string The lower system MAC address.
(null)
102 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write
Upper (v1.2+) string The upper system MAC address.
(null)
Virtual LAN (VLAN) tag related addressing
VLANIdentifierAddressRange (v1.1+) { object for this Ethernet fabric or for end host
(null)
networks.
read-write
Lower (v1.1+) integer Virtual LAN (VLAN) tag lower value.
(null)
read-write
Upper (v1.1+) integer Virtual LAN (VLAN) tag upper value.
(null)
Multi Protocol eBGP (MP eBGP) related
MultiProtocolEBGP (v1.1+) { object
(null) properties for this Ethernet fabric.
read-write Allow duplicate Autonomous System (AS)
AllowDuplicateASEnabled (v1.1+) boolean
(null) path.
Option to override an Autonomous System
read-write
AllowOverrideASEnabled (v1.1+) boolean (AS) number with the AS number of the
(null)
sending peer .
read-write Compare Multi Exit Discriminator (MED)
AlwaysCompareMEDEnabled (v1.1+) boolean
(null) status.
ASNumberRange (v1.1+) { object Autonomous System (AS) number range.
(null)
Lower (v1.1+) integer read-write Lower Autonomous System (AS) number.
Upper (v1.1+) integer read-write Upper Autonomous System (AS) number.
read-write
BGPLocalPreference (v1.1+) integer Local preference value.
(null)
Border Gateway Protocol (BGP) neighbor
BGPNeighbor (v1.1+) { object
(null) related properties.
read-write Border Gateway Protocol (BGP) neighbor
Address (v1.1+) string
(null) address.
Version 2023.1 Published 103
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-write
AllowOwnASEnabled (v1.1+) boolean Allow own Autonomous System (AS) status.
(null)
The Classless Inter-Domain Routing (CIDR)
value used for neighbor communication.
CIDR (v1.2+) integer read-write
This is the number of ones before the first
zero in the subnet mask.
read-write Border Gateway Protocol (BGP) retry timer
ConnectRetrySeconds (v1.1+) integer
(null) in seconds.
An indication of whether BGP neighbor
Enabled (v1.2+) boolean read-write
communication is enabled.
read-write Border Gateway Protocol (BGP) hold timer
HoldTimeSeconds (v1.1+) integer
(null) in seconds.
read-write Border Gateway Protocol (BGP) Keepalive
KeepaliveIntervalSeconds (v1.1+) integer
(null) timer in seconds.
read-write
LocalAS (v1.1+) integer Local Autonomous System (AS) number.
(null)
read-write Border Gateway Protocol (BGP) neighbor
LogStateChangesEnabled (v1.1+) boolean
(null) log state change status.
Border Gateway Protocol (BGP) max prefix
MaxPrefix (v1.1+) { object
(null) properties.
read-write
MaxPrefixNumber (v1.1+) integer Maximum prefix number.
(null)
read-write Border Gateway Protocol (BGP) restart
RestartTimerSeconds (v1.1+) integer
(null) timer in seconds.
ShutdownThresholdPercentage number read-write
Shutdown threshold status.
(v1.1+) (%) (null)
ThresholdWarningOnlyEnabled read-write
boolean Threshold warning only status.
(v1.1+) (null)
MinimumAdvertisementIntervalSeconds read-write Minimum Border Gateway Protocol (BGP)
integer
(v1.1+) (null) advertisement interval in seconds.
read-write Border Gateway Protocol (BGP) passive
PassiveModeEnabled (v1.1+) boolean
(null) mode status.
read-write
PathMTUDiscoveryEnabled (v1.1+) boolean Path MTU discovery status.
(null)
104 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write
PeerAS (v1.1+) integer Peer Autonomous System (AS) number.
(null)
read-write Replace Border Gateway Protocol (BGP)
ReplacePeerASEnabled (v1.1+) boolean
(null) peer Autonomous System (AS) status.
read-write
TCPMaxSegmentSizeBytes (v1.1+) integer TCP max segment size in Bytes.
(null)
read-write Border Gateway Protocol (BGP) treat as
TreatAsWithdrawEnabled (v1.1+) boolean
(null) withdraw status.
Border Gateway Protocol (BGP) route
BGPRoute (v1.1+) { object
(null) related properties.
read-write
AdvertiseInactiveRoutesEnabled (v1.1+) boolean Advertise inactive route status.
(null)
read-write
DistanceExternal (v1.1+) integer Route distance for external routes.
(null)
read-write
DistanceInternal (v1.1+) integer Route distance for internal routes.
(null)
read-write
DistanceLocal (v1.1+) integer Route distance for local routes.
(null)
ExternalCompareRouterIdEnabled read-write
boolean Compare router id status.
(v1.1+) (null)
read-write
FlapDampingEnabled (v1.1+) boolean Route flap dampening status.
(null)
read-write
SendDefaultRouteEnabled (v1.1+) boolean Send default route status.
(null)
read-write
BGPWeight (v1.1+) integer BGP weight attribute.
(null)
GracefulRestart (v1.1+) { object Graceful restart related properties.
(null)
read-write Border Gateway Protocol (BGP) graceful
GracefulRestartEnabled (v1.1+) boolean
(null) restart status.
read-write
HelperModeEnabled (v1.1+) boolean Graceful restart helper mode status.
(null)
Version 2023.1 Published 105
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-write
StaleRoutesTimeSeconds (v1.1+) integer Stale route timer in seconds.
(null)
read-write
TimeSeconds (v1.1+) integer Graceful restart timer in seconds.
(null)
read-write
MED (v1.1+) integer BGP Multi Exit Discriminator (MED) value.
(null)
read-write
MultihopEnabled (v1.1+) boolean External BGP (eBGP) multihop status.
(null)
read-write External BGP (eBGP) multihop Time to Live
MultihopTTL (v1.1+) integer
(null) (TTL) value.
MultiplePaths (v1.1+) { object Multiple path related properties.
(null)
read-write
MaximumPaths (v1.1+) integer Maximum paths number.
(null)
read-write Border Gateway Protocol (BGP) multiple
UseMultiplePathsEnabled (v1.1+) boolean
(null) paths status.
read-write This property shall indicate whether
SendCommunityEnabled (v1.1+) boolean
(null) community attributes are sent.
Multi Protocol iBGP (MP iBGP) related
MultiProtocolIBGP (v1.1+) { object
(null) properties for this Ethernet fabric.
ASNumberRange (v1.1+) { object Autonomous System (AS) number range.
(null)
Lower (v1.1+) integer read-write Lower Autonomous System (AS) number.
Upper (v1.1+) integer read-write Upper Autonomous System (AS) number.
Border Gateway Protocol (BGP) neighbor
BGPNeighbor (v1.1+) { object
(null) related properties.
read-write Border Gateway Protocol (BGP) neighbor
Address (v1.1+) string
(null) address.
106 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write
AllowOwnASEnabled (v1.1+) boolean Allow own Autonomous System (AS) status.
(null)
The Classless Inter-Domain Routing (CIDR)
value used for neighbor communication.
CIDR (v1.2+) integer read-write
This is the number of ones before the first
zero in the subnet mask.
read-write Border Gateway Protocol (BGP) retry timer
ConnectRetrySeconds (v1.1+) integer
(null) in seconds.
An indication of whether BGP neighbor
Enabled (v1.2+) boolean read-write
communication is enabled.
read-write Border Gateway Protocol (BGP) hold timer
HoldTimeSeconds (v1.1+) integer
(null) in seconds.
read-write Border Gateway Protocol (BGP) Keepalive
KeepaliveIntervalSeconds (v1.1+) integer
(null) timer in seconds.
read-write
LocalAS (v1.1+) integer Local Autonomous System (AS) number.
(null)
read-write Border Gateway Protocol (BGP) neighbor
LogStateChangesEnabled (v1.1+) boolean
(null) log state change status.
Border Gateway Protocol (BGP) max prefix
MaxPrefix (v1.1+) { object
(null) properties.
read-write
MaxPrefixNumber (v1.1+) integer Maximum prefix number.
(null)
read-write Border Gateway Protocol (BGP) restart
RestartTimerSeconds (v1.1+) integer
(null) timer in seconds.
ShutdownThresholdPercentage number read-write
Shutdown threshold status.
(v1.1+) (%) (null)
ThresholdWarningOnlyEnabled read-write
boolean Threshold warning only status.
(v1.1+) (null)
MinimumAdvertisementIntervalSeconds read-write Minimum Border Gateway Protocol (BGP)
integer
(v1.1+) (null) advertisement interval in seconds.
read-write Border Gateway Protocol (BGP) passive
PassiveModeEnabled (v1.1+) boolean
(null) mode status.
read-write
PathMTUDiscoveryEnabled (v1.1+) boolean Path MTU discovery status.
(null)
Version 2023.1 Published 107
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-write
PeerAS (v1.1+) integer Peer Autonomous System (AS) number.
(null)
read-write Replace Border Gateway Protocol (BGP)
ReplacePeerASEnabled (v1.1+) boolean
(null) peer Autonomous System (AS) status.
read-write
TCPMaxSegmentSizeBytes (v1.1+) integer TCP max segment size in Bytes.
(null)
read-write Border Gateway Protocol (BGP) treat as
TreatAsWithdrawEnabled (v1.1+) boolean
(null) withdraw status.
Border Gateway Protocol (BGP) route
BGPRoute (v1.1+) { object
(null) related properties.
read-write
AdvertiseInactiveRoutesEnabled (v1.1+) boolean Advertise inactive route status.
(null)
read-write
DistanceExternal (v1.1+) integer Route distance for external routes.
(null)
read-write
DistanceInternal (v1.1+) integer Route distance for internal routes.
(null)
read-write
DistanceLocal (v1.1+) integer Route distance for local routes.
(null)
ExternalCompareRouterIdEnabled read-write
boolean Compare router id status.
(v1.1+) (null)
read-write
FlapDampingEnabled (v1.1+) boolean Route flap dampening status.
(null)
read-write
SendDefaultRouteEnabled (v1.1+) boolean Send default route status.
(null)
GracefulRestart (v1.1+) { object Graceful restart related properties.
(null)
read-write Border Gateway Protocol (BGP) graceful
GracefulRestartEnabled (v1.1+) boolean
(null) restart status.
read-write
HelperModeEnabled (v1.1+) boolean Graceful restart helper mode status.
(null)
read-write
StaleRoutesTimeSeconds (v1.1+) integer Stale route timer in seconds.
(null)
108 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write
TimeSeconds (v1.1+) integer Graceful restart timer in seconds.
(null)
MultiplePaths (v1.1+) { object Multiple path related properties.
(null)
read-write
MaximumPaths (v1.1+) integer Maximum paths number.
(null)
read-write Border Gateway Protocol (BGP) multiple
UseMultiplePathsEnabled (v1.1+) boolean
(null) paths status.
read-write This property shall indicate whether
SendCommunityEnabled (v1.1+) boolean
(null) community attributes are sent.
The Gen-Z related properties for this
GenZ { object
address pool.
read-write The Access Key required for this address
AccessKey string
(null) pool.
read-write The maximum value for the Component
MaxCID integer
(null) Identifier (CID).
read-write The maximum value for the Subnet
MaxSID integer
(null) Identifier (SID).
read-write The minimum value for the Component
MinCID integer
(null) Identifier (CID).
read-write The minimum value for the Subnet
MinSID integer
(null) Identifier (SID).
The links to other resources that are
Links { object
related to this resource.
An array of links to the endpoints that this
Endpoints [ { array
address pool contains.
Version 2023.1 Published 109
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to a Endpoint resource. See the Links
@odata.id string read-write section and the Endpoint schema for
details.
}]
See the Oem object definition in the
Oem {} object
Common properties section.
An array of links to the zones that this
Zones [ { array
address pool contains.
Link to a Zone resource. See the Links
@odata.id string read-write
section and the Zone schema for details.
}]
The status and health of the resource and
Status {} object its subordinate or dependent resources. For
property details, see Status.
6.4.4 Property details
6.4.4.1 IPv4AddressRange
IPv4 related address range for an Ethernet fabric.
read-write
Lower (v1.1+) string Lower IPv4 network address.
(null)
read-write
Upper (v1.1+) string Upper IPv4 network address.
(null)
6.4.5 Example response
{
"@odata.type": "#AddressPool.v1_2_2.AddressPool",
"Id": "AP1",
"Name": "Address Pool 1",
"Description": "Address Pool 1",
"Status": {
110 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"State": "Enabled",
"Health": "OK"
},
"GenZ": {
"MinCID": 1,
"MaxCID": 4096,
"MinSID": 100,
"MaxSID": 8192,
"AccessKey": "0x1A"
},
"Links": {
"Endpoints": [
{
"@odata.id": "/redfish/v1/Fabrics/GenZ/Endpoints/1"
}
]
},
"@odata.id": "/redfish/v1/Fabrics/GenZ/AddressPools/AP1"
}
6.5 Aggregate 1.0.1
Version v1.0
Release 2020.2
6.5.1 Description
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.
6.5.2 URIs
/redfish/v1/AggregationService/Aggregates/{AggregateId}
6.5.3 Properties
Property Type Attributes Notes
Elements [ { array required The elements of this aggregate.
Version 2023.1 Published 111
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
read-only
ElementsCount integer The number of entries in the Elements array.
(null)
6.5.4 Actions
6.5.4.1 AddElements
Description
This action is used to add one or more resources to the aggregate.
Action URI
{Base URI of target resource}/Actions/Aggregate.AddElements
Action parameters
Parameter
Type Attributes Notes
Name
Elements [ { array required An array of resource links to add to the Elements array.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
Request Example
{
"Elements": [
{
"@odata.id": "/redfish/v1/Systems/cluster-node7"
},
{
"@odata.id": "node8.intranet.contoso.com/redfish/v1/Systems/1"
}
112 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
]
}
6.5.4.2 RemoveElements
Description
This action is used to remove one or more resources from the aggregate.
Action URI
{Base URI of target resource}/Actions/Aggregate.RemoveElements
Action parameters
Parameter
Type Attributes Notes
Name
Elements [ { array required An array of resource links to remove from the Elements array.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
Request Example
{
"Elements": [
{
"@odata.id": "node8.intranet.contoso.com/redfish/v1/Systems/1"
}
]
}
6.5.4.3 Reset
Description
This action is used to reset a collection of resources. For example, this could be an aggregate or a list
of computer systems.
Version 2023.1 Published 113
Redfish Resource and Schema Guide DSP2046
Action URI
{Base URI of target resource}/Actions/Aggregate.Reset
Action parameters
Parameter Name Type Attributes Notes
BatchSize integer optional The number of elements in each batch being reset.
integer The delay of the batches of elements being reset in
DelayBetweenBatchesInSeconds optional
(seconds) seconds.
string The type of reset. For the possible property values, see
ResetType optional
(enum) ResetType in Property details.
Request Example
{
"ResetType": "ForceRestart",
"BatchSize": 5,
"DelayBetweenBatchesInSeconds": 30
}
6.5.4.4 SetDefaultBootOrder
Description
This action is used to restore the boot order to the default state for the computer systems that are
members of this aggregate.
Action URI
{Base URI of target resource}/Actions/Aggregate.SetDefaultBootOrder
Action parameters
This action takes no parameters.
6.5.5 Property details
6.5.5.1 ResetType
The type of reset.
114 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
ForceOn Turn on the unit immediately.
ForceRestart Shut down immediately and non-gracefully and restart the system.
GracefulRestart Shut down gracefully and restart the system.
GracefulShutdown Shut down gracefully and power off.
Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal
Nmi
operations, complete diagnostic actions, and, typically, halt the system.
On Turn on the unit.
Pause execution on the unit but do not remove power. This is typically a feature of virtual
Pause
machine hypervisors.
Power cycle the unit. Behaves like a full power removal, followed by a power restore to the
PowerCycle
resource.
PushPowerButton Simulate the pressing of the physical power button on this unit.
Resume execution on the paused unit. This is typically a feature of virtual machine
Resume
hypervisors.
Write the state of the unit to disk before powering off. This allows for the state to be restored
Suspend
when powered back on.
6.5.6 Example response
{
"@odata.type": "#Aggregate.v1_0_1.Aggregate",
"Id": "Aggregate1",
"Name": "Aggregate One",
"ElementsCount": 2,
"Elements": [
{
"@odata.id": "/redfish/v1/Systems/cluster-node3"
},
{
"@odata.id": "/redfish/v1/Systems/cluster-node4"
}
],
"Actions": {
"#Aggregate.Reset": {
"target": "/redfish/v1/AggregationService/Aggregates/Aggregate1/Actions/Aggregate.Reset",
Version 2023.1 Published 115
Redfish Resource and Schema Guide DSP2046
"@Redfish.ActionInfo": "/redfish/v1/AggregationService/Aggregates/Aggregate1/ResetActionInfo"
},
"#Aggregate.SetDefaultBootOrder": {
"target": "/redfish/v1/AggregationService/Aggregates/Aggregate1/Actions/Aggregate.SetDefaultBootOrder",
"@Redfish.ActionInfo": "/redfish/v1/AggregationService/Aggregates/Aggregate1/SetDefaultBootOrderActionI
},
"#Aggregate.AddElements": {
"target": "/redfish/v1/AggregationService/Aggregates/Aggregate1/Actions/Aggregate.AddElements",
"@Redfish.ActionInfo": "/redfish/v1/AggregationService/Aggregates/Aggregate1/AddElementsActionInfo"
},
"#Aggregate.RemoveElements": {
"target": "/redfish/v1/AggregationService/Aggregates/Aggregate1/Actions/Aggregate.RemoveElements",
"@Redfish.ActionInfo": "/redfish/v1/AggregationService/Aggregates/Aggregate1/RemoveElementsActionInfo"
}
},
"@odata.id": "/redfish/v1/AggregationService/Aggregates/Aggregate1"
}
6.6 AggregationService 1.0.2
Version v1.0
Release 2020.2
6.6.1 Description
The AggregationService schema contains properties for managing aggregation operations, either on
ad hoc combinations of resources or on defined sets of resources called aggregates. Access points
define the properties needed to access the entity being aggregated and connection methods describe
the protocol or other semantics of the connection.
6.6.2 URIs
/redfish/v1/AggregationService
6.6.3 Properties
Property Type Attributes Notes
The link to the collection of aggregates associated with this service.
Aggregates { object
Contains a link to a resource.
116 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
@odata.id string read-only Link to Collection of Aggregate. See the Aggregate schema for details.
AggregationSources The link to the collection of aggregation sources associated with this
object
{ service. Contains a link to a resource.
Link to Collection of AggregationSource. See the AggregationSource
@odata.id string read-only
schema for details.
ConnectionMethods The link to the collection of connection methods associated with this
object
{ service. Contains a link to a resource.
Link to Collection of ConnectionMethod. See the ConnectionMethod
@odata.id string read-only
schema for details.
read-write
ServiceEnabled boolean An indication of whether the aggregation service is enabled.
(null)
The status and health of the resource and its subordinate or dependent
Status {} object
resources. For property details, see Status.
6.6.4 Actions
6.6.4.1 Reset
Description
This action is used to reset a set of resources. For example this could be a list of computer systems.
Action URI
{Base URI of target resource}/Actions/AggregationService.Reset
Action parameters
Parameter Name Type Attributes Notes
BatchSize integer optional The number of elements in each batch being reset.
Version 2023.1 Published 117
Redfish Resource and Schema Guide DSP2046
Parameter Name Type Attributes Notes
integer The delay of the batches of elements being reset in
DelayBetweenBatchesInSeconds optional
(seconds) seconds.
string The type of reset. For the possible property values, see
ResetType optional
(enum) ResetType in Property details.
TargetURIs [ { array required An array of links to the resources being reset.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
Request Example
{
"ResetType": "ForceRestart",
"BatchSize": 1,
"DelayBetweenBatchesInSeconds": 30,
"TargetURIs": [
{
"@odata.id": "/redfish/v1/Systems/cluster-node3"
},
{
"@odata.id": "/redfish/v1/Systems/cluster-node4"
},
{
"@odata.id": "node7.intranet.contoso.com/redfish/v1/Systems/1"
}
]
}
6.6.4.2 SetDefaultBootOrder
Description
This action is used to restore the boot order to the default state for the specified computer systems.
Action URI
{Base URI of target resource}/Actions/AggregationService.SetDefaultBootOrder
Action parameters
118 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Parameter
Type Attributes Notes
Name
Systems [ { array required The computer systems to restore.
Link to a ComputerSystem resource. See the Links section and the
@odata.id string read-only
ComputerSystem schema for details.
}]
Request Example
{
"Systems": [
{
"@odata.id": "/redfish/v1/Systems/cluster-node3"
},
{
"@odata.id": "/redfish/v1/Systems/cluster-node4"
},
{
"@odata.id": "node7.intranet.contoso.com/redfish/v1/Systems/1"
}
]
}
6.6.5 Property details
6.6.5.1 ResetType
The type of reset.
string Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
ForceOn Turn on the unit immediately.
ForceRestart Shut down immediately and non-gracefully and restart the system.
GracefulRestart Shut down gracefully and restart the system.
GracefulShutdown Shut down gracefully and power off.
Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal
Nmi
operations, complete diagnostic actions, and, typically, halt the system.
Version 2023.1 Published 119
Redfish Resource and Schema Guide DSP2046
string Description
On Turn on the unit.
Pause execution on the unit but do not remove power. This is typically a feature of virtual
Pause
machine hypervisors.
Power cycle the unit. Behaves like a full power removal, followed by a power restore to the
PowerCycle
resource.
PushPowerButton Simulate the pressing of the physical power button on this unit.
Resume execution on the paused unit. This is typically a feature of virtual machine
Resume
hypervisors.
Write the state of the unit to disk before powering off. This allows for the state to be restored
Suspend
when powered back on.
6.6.6 Example response
{
"@odata.type": "#AggregationService.v1_0_2.AggregationService",
"Id": "AggregationService",
"Description": "Aggregation Service",
"Name": "Aggregation Service",
"ServiceEnabled": true,
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"State": "Enabled"
},
"Aggregates": {
"@odata.id": "/redfish/v1/AggregationService/Aggregates"
},
"AggregationSources": {
"@odata.id": "/redfish/v1/AggregationService/AggregationSources"
},
"ConnectionMethods": {
"@odata.id": "/redfish/v1/AggregationService/ConnectionMethods"
},
"Actions": {
"#AggregationService.Reset": {
"target": "/redfish/v1/AggregationService/Actions/AggregationService.Reset",
"@Redfish.ActionInfo": "/redfish/v1/AggregationService/ResetActionInfo"
},
"#AggregationService.SetDefaultBootOrder": {
"target": "/redfish/v1/AggregationService/Actions/AggregationService.SetDefaultBootOrder",
"@Redfish.ActionInfo": "/redfish/v1/AggregationService/SetDefaultBootOrderActionInfo"
}
120 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
},
"@odata.id": "/redfish/v1/AggregationService/"
}
6.7 AggregationSource 1.3.1
Version v1.3 v1.2 v1.1 v1.0
Release 2022.3 2021.3 2020.4 2020.2
6.7.1 Description
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.
6.7.2 URIs
/redfish/v1/AggregationService/AggregationSources/{AggregationSourceId}
6.7.3 Properties
Property Type Attributes Notes
The type of aggregation used towards the aggregation
string
AggregationType (v1.2+) read-write source. For the possible property values, see
(enum)
AggregationType in Property details.
string read-write
HostName The URI of the system to be accessed.
(URI) (null)
The links to other resources that are related to this
Links { object
resource.
An array of links to the connection methods used to
ConnectionMethod { object contact this aggregation source. See the
(null)
ConnectionMethod schema for details on this property.
Link to a ConnectionMethod resource. See the Links
@odata.id string read-only
section and the ConnectionMethod schema for details.
Version 2023.1 Published 121
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
See the Oem object definition in the Common
Oem {} object
properties section.
An array links to the resources added to the service
through this aggregation source. It is recommended
ResourcesAccessed [ { array that this be the minimal number of properties needed
to find the resources that would be lost when the
aggregation source is deleted.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
read-write The password for accessing the aggregation source.
Password string
(null) The value is null in responses.
SNMP (v1.1+) { object SNMP settings of the aggregation source.
(null)
read-write
AuthenticationKey (v1.1+) string The secret authentication key for SNMPv3.
(null)
AuthenticationKeySet (v1.1+) boolean read-only Indicates if the AuthenticationKey property is set.
The authentication protocol for SNMPv3. For the
string read-write
AuthenticationProtocol (v1.1+) possible property values, see AuthenticationProtocol in
(enum) (null)
Property details.
read-write
EncryptionKey (v1.1+) string The secret authentication key for SNMPv3.
(null)
EncryptionKeySet (v1.1+) boolean read-only Indicates if the EncryptionKey property is set.
The encryption protocol for SNMPv3. For the possible
string read-write
EncryptionProtocol (v1.1+) property values, see EncryptionProtocol in Property
(enum) (null)
details.
read-write
TrapCommunity (v1.2+) string The SNMP trap community string.
(null)
Settings for an aggregation source using SSH as part of
SSHSettings (v1.3+) { object
(null) the associated connection method.
122 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
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
PresentedPublicHostKey (v1.3+) { object the public host key to the TrustedPublicHostKeys
collection to allow SSH communication with the
aggregation source. See the Key schema for details on
this property.
Link to a Key resource. See the Links section and the
@odata.id string read-only
Key schema for details.
string
PresentedPublicHostKeyTimestamp read-only The date and time when the key referenced by the
(date-
(v1.3+) (null) PresentedPublicHostKey property was last updated.
time)
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
PublicIdentityKey (v1.3+) { object GenerateSSHIdentityKeyPair and
RemoveSSHIdentityKeyPair are used to update the key
for this aggregation source. See the Key schema for
details on this property.
Link to a Key resource. See the Links section and the
@odata.id string read-only
Key schema for details.
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
TrustedPublicHostKeys (v1.3+) { object 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. Contains a link to a resource.
Link to Collection of Key. See the Key schema for
@odata.id string read-only
details.
The client user authentication method. For the possible
string read-write
UserAuthenticationMethod (v1.3+) property values, see UserAuthenticationMethod in
(enum) (null)
Property details.
Version 2023.1 Published 123
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The status and health of the resource and its
Status (v1.3+) {} object subordinate or dependent resources. For property
details, see Status.
read-write
UserName string The user name for accessing the aggregation source.
(null)
6.7.4 Actions
6.7.4.1 GenerateSSHIdentityKeyPair (v1.3+)
Description
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 replace by the new key-pair.
Action URI
{Base URI of target resource}/Actions/AggregationSource.GenerateSSHIdentityKeyPair
Action parameters
Parameter
Type Attributes Notes
Name
string The curve to use with the SSH key if the KeyType parameter contains ECDSA .
Curve optional
(enum) For the possible property values, see Curve in Property details.
KeyLength integer optional The length of the SSH key, in bits, if the KeyType parameter contains RSA .
string The type of SSH key. For the possible property values, see KeyType in Property
KeyType required
(enum) details.
Request Example
{
"KeyType": "Ed25519"
}
124 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.7.4.2 RemoveSSHIdentityKeyPair (v1.3+)
Description
This action removes the SSH identity key-pair used with this aggregation source.
Action URI
{Base URI of target resource}/Actions/AggregationSource.RemoveSSHIdentityKeyPair
Action parameters
This action takes no parameters.
6.7.5 Property details
6.7.5.1 AggregationType
The type of aggregation used towards the aggregation source.
string Description
Full Full aggregation according to connection method.
NotificationsOnly Only notifications are aggregated.
6.7.5.2 AuthenticationProtocol
The authentication protocol for SNMPv3.
string Description
CommunityString Trap community string authentication.
HMAC128_SHA224 HMAC-128-SHA-224 authentication.
HMAC192_SHA256 HMAC-192-SHA-256 authentication.
HMAC256_SHA384 HMAC-256-SHA-384 authentication.
HMAC384_SHA512 HMAC-384-SHA-512 authentication.
HMAC_MD5 HMAC-MD5-96 authentication.
Version 2023.1 Published 125
Redfish Resource and Schema Guide DSP2046
string Description
HMAC_SHA96 HMAC-SHA-96 authentication.
None No authentication.
6.7.5.3 Curve
The curve to use with the SSH key if the KeyType parameter contains ECDSA .
string Description
NISTB233 NIST B-233.
NISTB409 NIST B-409.
NISTK163 NIST K-163.
NISTK233 NIST K-233.
NISTK283 NIST K-283.
NISTK409 NIST K-409.
NISTP192 NIST P-192.
NISTP224 NIST P-224.
NISTP256 NIST P-256.
NISTP384 NIST P-384.
NISTP521 NIST P-521.
NISTT571 NIST T-571.
6.7.5.4 EncryptionProtocol
The encryption protocol for SNMPv3.
string Description
CBC_DES CBC-DES encryption.
CFB128_AES128 CFB128-AES-128 encryption.
None No encryption.
126 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.7.5.5 KeyType
The type of SSH key.
string Description
DSA DSA.
ECDSA ECDSA.
Ed25519 Ed25519.
RSA RSA.
6.7.5.6 UserAuthenticationMethod
The client user authentication method.
string Description
Password SSH user authentication with a password.
PublicKey SSH user authentication with a public key.
6.7.6 Example response
{
"@odata.type": "#AggregationSource.v1_3_1.AggregationSource",
"Id": "AggregationSource1",
"Name": "AggregationSource One",
"HostName": "https://Someserver.Contoso.com/redfish/v1",
"UserName": "root",
"Password": null,
"Links": {
"ConnectionMethod": {
"@odata.id": "/redfish/v1/AggregationService/ConnectionMethods/ConnectionMethod1"
},
"ResourcesAccessed": [
{
"@odata.id": "/redfish/v1/Managers/1"
}
]
},
"@odata.id": "/redfish/v1/AggregationService/AggregationSources/AggregationSource1"
Version 2023.1 Published 127
Redfish Resource and Schema Guide DSP2046
6.8 AllowDeny 1.0.0
Version v1.0
Release 2021.2
6.8.1 Description
The AllowDeny schema represents a set of allow or deny configurations.
6.8.2 URIs
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions/
{NetworkDeviceFunctionId}/AllowDeny/{AllowDenyId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/
{NetworkInterfaceId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny/{AllowDenyId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/
AllowDeny/{AllowDenyId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}/
NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny/{AllowDenyId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/
{NetworkInterfaceId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny/{AllowDenyId}
/redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/
NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny/{AllowDenyId}
6.8.3 Properties
Property Type Attributes Notes
string read-write Indicates the type of permission. For the possible property values, see
AllowType
(enum) (null) AllowType in Property details.
read-write The TCP, UDP, or other destination port to which this rule begins to
DestinationPortLower integer
(null) application, inclusive.
128 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write The TCP, UDP, or other destination port to which this rule ends
DestinationPortUpper integer
(null) application, inclusive.
string read-write Indicates the direction of the data to which this permission applies. For
Direction
(enum) (null) the possible property values, see Direction in Property details.
read-write The IANA protocol number to which this permission applies. For TCP,
IANAProtocolNumber integer
(null) this is 6 . For UDP, this is 17 .
read-write
IPAddressLower string The lower IP address to which this permission applies.
(null)
The type of IP address populated in the IPAddressLower and
string read-write
IPAddressType IPAddressUpper properties. For the possible property values, see
(enum) (null)
IPAddressType in Property details.
read-write
IPAddressUpper string The upper IP address to which this permission applies.
(null)
read-write The TCP, UDP, or other source port to which this rule begins application,
SourcePortLower integer
(null) inclusive.
read-write The TCP, UDP or other source port to which this rule ends application,
SourcePortUpper integer
(null) inclusive.
read-write
StatefulSession boolean Indicates if this is a permission that only applies to stateful connection.
(null)
6.8.4 Property details
6.8.4.1 AllowType
Indicates the type of permission.
string Description
Allow Indicates that traffic that matches the criteria in this resource shall be permitted.
Deny Indicates that traffic that matches the criteria in this resource shall not be permitted.
6.8.4.2 Direction
Indicates the direction of the data to which this permission applies.
Version 2023.1 Published 129
Redfish Resource and Schema Guide DSP2046
string Description
Indicates that this limit is enforced on packets and bytes transmitted by the network device
Egress
function.
Indicates that this limit is enforced on packets and bytes received by the network device
Ingress
function.
6.8.4.3 IPAddressType
The type of IP address populated in the IPAddressLower and IPAddressUpper properties.
string Description
IPv4 IPv4 addressing is used for all IP-fields in this object.
IPv6 IPv6 addressing is used for all IP-fields in this object.
6.8.5 Example response
{
"@odata.type": "#AllowDeny.v1_0_0.AllowDeny",
"Id": "AllowDeny Rule 1",
"Name": "Allow Rule 1",
"Direction": "Ingress",
"AllowType": "Allow",
"StatefulSession": true,
"IPAddressType": "IPv4",
"IPAddressLower": "192.168.1.1",
"IPAddressUpper": "192.168.1.100",
"IANAProtocolNumber": 6,
"SourcePortLower": 5,
"SourcePortUpper": 65535,
"DestinationPortLower": 5,
"DestinationPortUpper": 65535,
"@odata.id": "/redfish/v1/Chassis/Card1/NetworkAdapters/Slot1/NetworkDeviceFunctions/SC2KP1F0/AllowDeny/Rule1"
}
6.9 Assembly 1.4.0
Version v1.4 v1.3 v1.2 v1.1 v1.0
130 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Release 2022.2 2020.3 2018.2 2018.1 2017.3
6.9.1 Description
The Assembly schema defines an assembly. Assembly information contains details about a device,
such as part number, serial number, manufacturer, and production date. It also provides access to the
original data for the assembly.
6.9.2 URIs
/redfish/v1/Chassis/{ChassisId}/Assembly
/redfish/v1/Chassis/{ChassisId}/Drives/{DriveId}/Assembly
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Assembly
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/{ProcessorId}/
Assembly
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/{ProcessorId}/
SubProcessors/{ProcessorId2}/Assembly
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/{ProcessorId}/
SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}/Assembly
/redfish/v1/Chassis/{ChassisId}/PCIeDevices/{PCIeDeviceId}/Assembly
/redfish/v1/Chassis/{ChassisId}/Power/PowerSupplies/{PowerSupplyId}/Assembly
/redfish/v1/Chassis/{ChassisId}/PowerSubsystem/Batteries/{BatteryId}/Assembly
/redfish/v1/Chassis/{ChassisId}/PowerSubsystem/PowerSupplies/{PowerSupplyId}/Assembly
/redfish/v1/Chassis/{ChassisId}/Thermal/Fans/{FanId}/Assembly
/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Fans/{FanId}/Assembly
/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Heaters/{HeaderId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/
SubProcessors/{ProcessorId2}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/
SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/
{StorageControllerId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/
{DriveId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/
StorageControllers/{StorageControllerId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Memory/{MemoryId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Version 2023.1 Published 131
Redfish Resource and Schema Guide DSP2046
Processors/{ProcessorId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/Controllers/{StorageControllerId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/Drives/{DriveId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/StorageControllers/{StorageControllerId}/Assembly
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/PowerSupplies/{PowerSupplyId}/
Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors/
{ProcessorId2}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors/
{ProcessorId2}/SubProcessors/{ProcessorId3}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{StorageControllerId}/
Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/{DriveId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/
{StorageControllerId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory/{MemoryId}/
Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/
{ProcessorId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/
{ProcessorId}/SubProcessors/{ProcessorId2}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/
{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
Controllers/{StorageControllerId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
Drives/{DriveId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
StorageControllers/{StorageControllerId}/Assembly
/redfish/v1/Storage/{StorageId}/Controllers/{StorageControllerId}/Assembly
/redfish/v1/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Assembly
/redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}/Assembly
/redfish/v1/Systems/{ComputerSystemId}/PCIeDevices/{PCIeDeviceId}/Assembly
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Assembly
132 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/
Assembly
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/
SubProcessors/{ProcessorId3}/Assembly
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/
Assembly
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/Assembly
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/
{StorageControllerId}/Assembly
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Assembly
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Filters/{FilterId}/Assembly
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Pumps/{PumpId}/Assembly
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Pumps/{PumpId}/Filters/{FilterId}/Assembly
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Reservoirs/{ReservoirId}/Assembly
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Reservoirs/{ReservoirId}/Filters/{FilterId}/
Assembly
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Assembly
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Filters/{FilterId}/Assembly
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Pumps/{PumpId}/Assembly
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Pumps/{PumpId}/Filters/{FilterId}/
Assembly
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Reservoirs/{ReservoirId}/Assembly
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Reservoirs/{ReservoirId}/Filters/
{FilterId}/Assembly
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Assembly
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Filters/{FilterId}/Assembly
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Pumps/{PumpId}/Assembly
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Pumps/{PumpId}/Filters/{FilterId}/
Assembly
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Reservoirs/{ReservoirId}/Assembly
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Reservoirs/{ReservoirId}/Filters/
{FilterId}/Assembly
6.9.3 Properties
Property Type Attributes Notes
Assemblies [ { array The assembly records.
string read-only
@odata.id The unique identifier for a resource.
(URI) required
Actions {} object The available actions for this Resource.
Version 2023.1 Published 133
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
string read-only The URI at which to access an image of the assembly
BinaryDataURI
(URI) (null) information.
read-only
Description string The description of the assembly.
(null)
read-only
EngineeringChangeLevel string The engineering change level of the assembly.
(null)
Location (v1.3+) {} object The location of the assembly. For property details, see Location.
LocationIndicatorActive read-write An indicator allowing an operator to physically locate this
boolean
(v1.3+) (null) resource.
read-only
MemberId string The unique identifier for the member within an array.
required
read-only
Model string The model number of the assembly.
(null)
read-only
Name string The name of the assembly.
(null)
Oem {} object See the Oem object definition in the Common properties section.
read-only
PartNumber string The part number of the assembly.
(null)
string The area or device to which the assembly data applies. For the
PhysicalContext (v1.2+) read-only
(enum) possible property values, see PhysicalContext in Property details.
read-only
Producer string The producer or manufacturer of the assembly.
(null)
string
read-only
ProductionDate (date- The production date of the assembly.
(null)
time)
An indication of whether the component associated this assembly
read-only
Replaceable (v1.4+) boolean can be independently replaced as allowed by the vendor's
(null)
replacement policy.
read-only
SerialNumber (v1.2+) string The serial number of the assembly.
(null)
read-only
SKU string The SKU of the assembly.
(null)
read-only
SparePartNumber string The spare part number of the assembly.
(null)
134 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The status and health of the Resource and its subordinate or
Status (v1.1+) {} object
dependent Resources. For property details, see Status.
read-only
Vendor string The vendor of the assembly.
(null)
read-only
Version string The hardware version of the assembly.
(null)
}]
6.9.4 Property details
6.9.4.1 PhysicalContext
The area or device to which the assembly data applies.
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
Version 2023.1 Published 135
Redfish Resource and Schema Guide DSP2046
string Description
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
GPU A graphics processor (GPU).
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
StorageBay Within a storage bay.
136 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
6.9.5 Example response
{
"@odata.type": "#Assembly.v1_4_0.Assembly",
"Id": "Assembly",
"Name": "System-related Assembly data",
"Assemblies": [
{
"@odata.id": "/redfish/v1/Chassis/1/Assembly#/Assemblies/0",
"MemberId": "0",
"Name": "System Board",
"Description": "PCA System Board",
"Model": "345TTT",
"PartNumber": "923943",
"SparePartNumber": "55-434",
"SKU": "55ZZATR",
"SerialNumber": "345394834",
"Vendor": "Contoso",
"ProductionDate": "2017-04-01T14:55:33+03:00",
"Producer": "Contoso Supply Co.",
"Version": "1.44B",
"EngineeringChangeLevel": "9",
"BinaryDataURI": "/dumpster/434",
"Oem": {
"Contoso": {
"Region": "C",
"Packaging": "Retail"
}
}
},
{
"@odata.id": "/redfish/v1/Chassis/1/Assembly#/Assemblies/1",
"MemberId": "1",
Version 2023.1 Published 137
Redfish Resource and Schema Guide DSP2046
"Name": "Fan Controller",
"Description": "PCA Fan Controller",
"Model": "F58AS",
"PartNumber": "3434-149",
"Vendor": "Contoso",
"Version": "2.4.481",
"BinaryDataURI": "/dumpster/422",
"Status": {
"State": "Enabled",
"Health": "Warning"
}
}
],
"@odata.id": "/redfish/v1/Chassis/1/Assembly"
}
6.10 AttributeRegistry 1.3.6
Version v1.3 v1.2 v1.1 v1.0
Release 2018.3 2018.1 2017.1 2016.1
6.10.1 Description
The AttributeRegistry schema contains a set of key-value pairs that represent the structure of an
attribute registry. It includes mechanisms for building user interfaces, or menus, allowing consistent
navigation of the contents. The attribute registry is specific to an implementation or product. The
attributes and property names are not standardized.
6.10.2 Properties
Property Type Attributes Notes
read-only The RFC5646-conformant language code for the attribute
Language string
required registry.
read-only The organization or company that publishes this attribute
OwningEntity string
required registry.
The list of all attributes and their metadata for this
RegistryEntries { object
component.
138 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
An array of attributes and their possible values in the
Attributes [ { array
attribute registry.
read-only
AttributeName string The unique name for the attribute.
required
string,
read-only
CurrentValue boolean, The placeholder of the current value for the attribute.
(null)
number
string,
read-only
DefaultValue boolean, The default value for the attribute.
(null)
number
read-only The user-readable display string for the attribute in the
DisplayName string
(null) defined language.
read-only The ascending order, as a number, in which this attribute
DisplayOrder integer
(null) appears relative to other attributes.
An indication of whether this attribute is grayed out. A
read-only
GrayOut boolean grayed-out attribute is not active and is grayed out in user
(null)
interfaces but the attribute value can be modified.
read-only
HelpText string The help text for the attribute.
(null)
read-only An indication of whether this attribute is hidden in user
Hidden boolean
(null) interfaces.
An indication of whether this attribute is immutable.
read-only
Immutable boolean Immutable attributes shall not be modified and typically
(null)
reflect a hardware state.
read-only An indication of whether this attribute is unique for this
IsSystemUniqueProperty boolean
(null) system and should not be replicated.
read-only
LowerBound integer The lower limit for an integer attribute.
(null)
read-only
MaxLength integer The maximum character length of a string attribute.
(null)
read-only
MenuPath string The path that describes the menu hierarchy of this attribute.
(null)
read-only
MinLength integer The minimum character length of the string attribute.
(null)
See the Oem object definition in the Common properties
Oem (v1.3+) {} object
section.
Version 2023.1 Published 139
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
An indication of whether this attribute is read-only. A read-
read-only
ReadOnly boolean only attribute cannot be modified, and should be grayed out
(null)
in user interfaces.
read-only An indication of whether a system or device reset is required
ResetRequired (v1.2+) boolean
(null) for this attribute value change to take effect.
The amount to increment or decrement an integer attribute
read-only
ScalarIncrement integer each time a user requests a value change. The 0 value
(null)
indicates a free-form numeric user-input attribute.
string The attribute type. For the possible property values, see Type
Type read-only
(enum) in Property details.
read-only
UefiDevicePath (v1.2+) string The UEFI device path that qualifies this attribute.
(null)
UefiKeywordName
string read-only The UEFI keyword string for this attribute.
(v1.2+)
UefiNamespaceId (v1.2+) string read-only The UEFI namespace ID for the attribute.
read-only
UpperBound integer The upper limit for an integer attribute.
(null)
An array of the possible values for enumerated attribute
Value [ { array
values.
read-only A user-readable display string of the value for the attribute in
ValueDisplayName string
(null) the defined language.
read-only
ValueName string The unique value name for the attribute.
required
}]
A valid regular expression, according to the Perl regular
read-only
ValueExpression string expression dialect, that validates the attribute value. Applies
(null)
to only string and integer attributes.
read-only
WarningText string The warning text for the attribute.
(null)
An indication of whether this attribute is write-only. A write-
read-only
WriteOnly boolean only attribute reverts to its initial value after settings are
(null)
applied.
}]
Dependencies [ { array An array of dependencies of attributes on this component.
140 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The dependency expression for one or more attributes in this
Dependency { object
attribute registry.
An array of the map-from conditions for a mapping
MapFrom [ { array
dependency.
MapFromAttribute string read-only The attribute to use to evaluate this dependency expression.
The condition to use to evaluate this dependency expression.
string
MapFromCondition read-only For the possible property values, see MapFromCondition in
(enum)
Property details.
The metadata property for the attribute that the
string MapFromAttribute property specifies to use to evaluate this
MapFromProperty read-only
(enum) dependency expression. For the possible property values, see
MapFromProperty in Property details.
string,
read-only
MapFromValue boolean, The value to use to evaluate this dependency expression.
(null)
number
The logical term that combines two or more map-from
string conditions in this dependency expression. For example, AND
MapTerms read-only
(enum) for logical AND, or OR for logical OR. For the possible
property values, see MapTerms in Property details.
}]
The AttributeName of the attribute that is affected by this
MapToAttribute string read-only
dependency expression.
The metadata property for the attribute that contains the
string map-from condition that evaluates this dependency
MapToProperty read-only
(enum) expression. For the possible property values, see
MapToProperty in Property details.
string,
read-only The value that the map-to property changes to if the
MapToValue boolean,
(null) dependency expression evaluates to true .
number
The AttributeName of the attribute whose change triggers
DependencyFor string read-only
the evaluation of this dependency expression.
string The type of the dependency structure. For the possible
Type read-only
(enum) property values, see Type in Property details.
}]
Version 2023.1 Published 141
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
An array for the attributes menus and their hierarchy in the
Menus [ { array
attribute registry.
read-only The user-readable display string of this menu in the defined
DisplayName string
(null) language.
read-only The ascending order, as a number, in which this menu
DisplayOrder integer
(null) appears relative to other menus.
read-only An indication of whether this menu is grayed out. A grayed-
GrayOut boolean
(null) only menu is not accessible in user interfaces.
read-only An indication of whether this menu is hidden in user
Hidden (v1.3+) boolean
(null) interfaces.
MenuName string read-only The unique name string of this menu.
read-only The path to the menu names that describes this menu
MenuPath string
(null) hierarchy relative to other menus.
See the Oem object definition in the Common properties
Oem (v1.3+) {} object
section.
An indication of whether this menu is read-only. A read-only
read-only
ReadOnly boolean menu, its properties, and sub-menus are not accessible in
(null)
user interfaces.
}]
read-only
RegistryVersion string The attribute registry version.
required
SupportedSystems [ { array An array of systems that this attribute registry supports.
read-only
FirmwareVersion (v1.1+) string Firmware version.
(null)
read-only The product name of the computer system to which this
ProductName string
(null) attribute registry applies.
read-only
SystemId string The ID of the systems to which this attribute registry applies.
(null)
}]
142 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.10.3 Property details
6.10.3.1 MapFromCondition
The condition to use to evaluate this dependency expression.
string Description
EQU The logical operation for 'Equal'.
GEQ The logical operation for 'Greater than or Equal'.
GTR The logical operation for 'Greater than'.
LEQ The logical operation for 'Less than or Equal'.
LSS The logical operation for 'Less than'.
NEQ The logical operation for 'Not Equal'.
6.10.3.2 MapFromProperty
The metadata property for the attribute that the MapFromAttribute property specifies to use to
evaluate this dependency expression.
string Description
CurrentValue The dependency on an attribute's CurrentValue.
DefaultValue The dependency on an attribute's DefaultValue.
GrayOut The dependency on an attribute's GrayOut state.
Hidden The dependency on an attribute's Hidden state.
LowerBound The dependency on an attribute's LowerBound.
MaxLength The dependency on an attribute's MaxLength.
MinLength The dependency on an attribute's MinLength.
ReadOnly The dependency on an attribute's ReadOnly state.
ScalarIncrement The dependency on an attribute's ScalarIncrement.
UpperBound The dependency on an attribute's UpperBound.
Version 2023.1 Published 143
Redfish Resource and Schema Guide DSP2046
string Description
WriteOnly The dependency on an attribute's WriteOnly state.
6.10.3.3 MapTerms
The logical term that combines two or more map-from conditions in this dependency expression. For
example, AND for logical AND, or OR for logical OR.
string Description
AND The operation used for logical 'AND' of dependency terms.
OR The operation used for logical 'OR' of dependency terms.
6.10.3.4 MapToProperty
The metadata property for the attribute that contains the map-from condition that evaluates this
dependency expression.
string Description
CurrentValue The dependency that affects an attribute's CurrentValue.
DefaultValue The dependency that affects an attribute's DefaultValue.
DisplayName The dependency that affects an attribute's DisplayName.
DisplayOrder The dependency that affects an attribute's DisplayName.
GrayOut The dependency that affects an attribute's GrayOut state.
HelpText The dependency that affects an attribute's HelpText.
Hidden The dependency that affects an attribute's Hidden state.
Immutable The dependency that affects an attribute's Immutable state.
LowerBound The dependency that affects an attribute's LowerBound.
MaxLength The dependency that affects an attribute's MaxLength.
MinLength The dependency that affects an attribute's MinLength.
ReadOnly The dependency that affects an attribute's ReadOnly state.
ScalarIncrement The dependency that affects an attribute's ScalarIncrement.
144 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
UpperBound The dependency that affects an attribute's UpperBound.
ValueExpression The dependency that affects an attribute's ValueExpression.
WarningText The dependency that affects an attribute's WarningText.
WriteOnly The dependency that affects an attribute's WriteOnly state.
6.10.3.5 Type
6.10.3.5.1 In RegistryEntries: Attributes:
The attribute type.
string Description
Boolean A flag with a true or false value.
Enumeration A list of the known possible enumerated values.
Integer An integer value.
Password Password values that do not appear as plain text. The value shall be null in responses.
String Free-form text in their values.
6.10.3.5.2 In RegistryEntries: Dependencies:
The type of the dependency structure.
string Description
A simple mapping dependency. If the condition evaluates to true , the attribute or state
Map
changes to the mapped value.
6.10.4 Example response
{
"@odata.type": "#AttributeRegistry.v1_3_6.AttributeRegistry",
"Description": "This registry defines a representation of BIOS Attribute instances",
"Id": "BiosAttributeRegistryG9000.v1_0_0",
Version 2023.1 Published 145
Redfish Resource and Schema Guide DSP2046
"Language": "en",
"Name": "G9000 BIOS Attribute Registry",
"OwningEntity": "Contoso",
"RegistryVersion": "1.0.0",
"SupportedSystems": [
{
"ProductName": "Contoso Server GLH9000",
"SystemId": "G9000",
"FirmwareVersion": "v1.00 (06/02/2014)"
}
],
"RegistryEntries": {
"Attributes": [
{
"CurrentValue": null,
"DisplayName": "Embedded NIC 1 Boot",
"DisplayOrder": 5,
"HelpText": "Select this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC.
"MenuPath": "./SystemOptions/NetworkBootOptions",
"AttributeName": "NicBoot1",
"ReadOnly": false,
"Hidden": false,
"Type": "Enumeration",
"Value": [
{
"ValueDisplayName": "Network Boot",
"ValueName": "NetworkBoot"
},
{
"ValueDisplayName": "Disabled",
"ValueName": "Disabled"
}
],
"WarningText": "Important: When enabling network boot support for an embedded NIC, the NIC boot opt
},
{
"CurrentValue": null,
"DisplayName": "Embedded SATA Configuration",
"DisplayOrder": 74,
"HelpText": "Important: Select this option to configure the embedded chipset SATA controller.",
"MenuPath": "./SystemOptions/SataOptions",
"AttributeName": "EmbeddedSata",
"ReadOnly": false,
"Hidden": false,
"Type": "Enumeration",
"Value": [
{
"ValueDisplayName": "Enable SATA AHCI Support",
"ValueName": "Ahci"
},
146 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
{
"ValueDisplayName": "Enable Software RAID Support",
"ValueName": "Raid"
}
],
"WarningText": "Important: Software RAID is not supported when the Boot Mode is configured in Legac
}
],
"Dependencies": [
{
"Dependency": {
"MapFrom": [
{
"MapFromAttribute": "BootMode",
"MapFromCondition": "EQU",
"MapFromProperty": "CurrentValue",
"MapFromValue": "LegacyBios"
}
],
"MapToAttribute": "EmbeddedSata",
"MapToProperty": "ReadOnly",
"MapToValue": true
},
"DependencyFor": "EmbeddedSata",
"Type": "Map"
}
],
"Menus": [
{
"DisplayName": "BIOS Configuration",
"DisplayOrder": 1,
"MenuPath": "./",
"MenuName": "BiosMainMenu",
"Hidden": false,
"ReadOnly": false
},
{
"DisplayName": "System Options",
"DisplayOrder": 2,
"MenuPath": "./SystemOptions",
"MenuName": "SystemOptions",
"Hidden": false,
"ReadOnly": false
}
]
}
}
Version 2023.1 Published 147
Redfish Resource and Schema Guide DSP2046
6.11 Battery 1.2.1
Version v1.2 v1.1
Release 2022.2 2021.2
6.11.1 Description
The Battery schema describes a battery unit, such as those used to provide systems with power
during a power loss event. It also describes the location, such as a slot, socket, or bay, where a unit
can be installed, by populating a resource instance with an absent state if a unit is not present.
6.11.2 URIs
/redfish/v1/Chassis/{ChassisId}/PowerSubsystem/Batteries/{BatteryId}
6.11.3 Properties
Property Type Attributes Notes
The link to the assembly associated with this battery. See the
Assembly { object
Assembly schema for details on this property.
Link to a Assembly resource. See the Links section and the
@odata.id string read-only
Assembly schema for details.
number read-only
CapacityActualAmpHours The actual maximum capacity of this battery in amp-hours.
(A.h) (null)
number read-only
CapacityActualWattHours The actual maximum capacity of this battery in watt-hours.
(W.h) (null)
number read-only
CapacityRatedAmpHours The rated maximum capacity of this battery in amp-hours.
(A.h) (null)
number read-only
CapacityRatedWattHours The rated maximum capacity of this battery in watt-hours.
(W.h) (null)
string read-only The charge state of this battery. For the possible property values,
ChargeState
(enum) (null) see ChargeState in Property details.
148 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only
FirmwareVersion string The firmware version for this battery.
(null)
read-only An indication of whether this device can be inserted or removed
HotPluggable boolean
(null) while the equipment is in operation.
Links (v1.1+) { object The links to other resources that are related to this resource.
An array of links to the memory devices to which this battery
Memory (v1.1+) [ { array
provides power during a power loss event.
Link to a Memory resource. See the Links section and the Memory
@odata.id string read-only
schema for details.
}]
Oem {} object See the Oem object definition in the Common properties section.
StorageControllers An array of links to the storage controllers to which this battery
array
(v1.1+) [ { provides power during a power loss event.
Link to a StorageController resource. See the Links section and the
@odata.id string read-only
StorageController schema for details.
}]
Location {} object The location of the battery. For property details, see Location.
read-write
LocationIndicatorActive boolean An indicator allowing an operator to physically locate this resource.
(null)
read-only
Manufacturer string The manufacturer of this battery.
(null)
number read-only
MaxChargeRateAmps The maximum charge rate of this battery in amps.
(A) (null)
number read-only
MaxChargeVoltage The maximum charge voltage of this battery.
(Volts) (null)
number read-only
MaxDischargeRateAmps The maximum discharge rate of this battery in amps.
(A) (null)
The link to the battery metrics resource associated with this battery.
Metrics { object
See the BatteryMetrics schema for details on this property.
Link to a BatteryMetrics resource. See the Links section and the
@odata.id string read-only
BatteryMetrics schema for details.
Version 2023.1 Published 149
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
Model string The model number for this battery.
(null)
read-only
PartNumber string The part number for this battery.
(null)
string
read-only
ProductionDate (date- The production or manufacturing date of this battery.
(null)
time)
read-only An indication of whether this component can be independently
Replaceable (v1.2+) boolean
(null) replaced as allowed by the vendor's replacement policy.
read-only
SerialNumber string The serial number for this battery.
(null)
read-only
SparePartNumber string The spare part number for this battery.
(null)
The state of health (percent) of this battery. This object is an
object
StateOfHealthPercent { excerpt of the Sensor resource located at the URI shown in
(excerpt)
DataSourceUri.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
read-only
Version string The hardware version of this battery.
(null)
6.11.4 Actions
6.11.4.1 Calibrate
Description
This action performs a self-calibration, or learn cycle, of the battery.
Action URI
150 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
{Base URI of target resource}/Actions/Battery.Calibrate
Action parameters
This action takes no parameters.
6.11.4.2 Reset
Description
This action resets the battery.
Action URI
{Base URI of target resource}/Actions/Battery.Reset
Action parameters
Parameter
Type Attributes Notes
Name
string The type of reset. For the possible property values, see ResetType in Property
ResetType optional
(enum) details.
Request Example
{
"ResetType": "PowerCycle"
}
6.11.4.3 SelfTest
Description
This action performs a self-test of the battery.
Action URI
{Base URI of target resource}/Actions/Battery.SelfTest
Action parameters
This action takes no parameters.
Version 2023.1 Published 151
Redfish Resource and Schema Guide DSP2046
6.11.5 Property details
6.11.5.1 ChargeState
The charge state of this battery.
string Description
Charging The battery is charging.
Discharging The battery is discharging.
Idle The battery is idle.
6.11.5.2 ResetType
The type of reset.
string Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
ForceOn Turn on the unit immediately.
ForceRestart Shut down immediately and non-gracefully and restart the system.
GracefulRestart Shut down gracefully and restart the system.
GracefulShutdown Shut down gracefully and power off.
Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal
Nmi
operations, complete diagnostic actions, and, typically, halt the system.
On Turn on the unit.
Pause execution on the unit but do not remove power. This is typically a feature of virtual
Pause
machine hypervisors.
Power cycle the unit. Behaves like a full power removal, followed by a power restore to the
PowerCycle
resource.
PushPowerButton Simulate the pressing of the physical power button on this unit.
Resume execution on the paused unit. This is typically a feature of virtual machine
Resume
hypervisors.
152 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Write the state of the unit to disk before powering off. This allows for the state to be restored
Suspend
when powered back on.
6.11.6 Example response
{
"@odata.type": "#Battery.v1_2_1.Battery",
"Id": "Module1",
"Name": "Battery 1",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Actions": {
"#Battery.SelfTest": {
"target": "/redfish/v1/Chassis/1U/PowerSubsystem/Batteries/Module1/Actions/Battery.SelfTest"
},
"#Battery.Calibrate": {
"target": "/redfish/v1/Chassis/1U/PowerSubsystem/Batteries/Module1/Actions/Battery.Calibrate"
}
},
"Location": {
"PartLocation": {
"ServiceLabel": "Battery 1",
"LocationType": "Bay",
"LocationOrdinalValue": 0
}
},
"Model": "RKS-440DC",
"Manufacturer": "Contoso Power",
"FirmwareVersion": "1.00",
"Version": "A05",
"ProductionDate": "2019-10-01T06:00:00Z",
"SerialNumber": "3488247",
"PartNumber": "23456-133",
"SparePartNumber": "93284-133",
"LocationIndicatorActive": false,
"HotPluggable": true,
"CapacityRatedWattHours": 20,
"CapacityActualWattHours": 19.41,
"MaxDischargeRateAmps": 10,
"StateOfHealthPercent": {
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/Battery1StateOfHealth",
"Reading": 91
},
"ChargeState": "Idle",
Version 2023.1 Published 153
Redfish Resource and Schema Guide DSP2046
"Metrics": {
"@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/Batteries/Module1/Metrics"
},
"@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/Batteries/Module1"
}
6.12 BatteryMetrics 1.0.1
Version v1.0
Release 2021.2
6.12.1 Description
The BatteryMetrics schema contains definitions for the metrics of a battery unit.
6.12.2 URIs
/redfish/v1/Chassis/{ChassisId}/PowerSubsystem/Batteries/{BatteryId}/Metrics
6.12.3 Properties
Property Type Attributes Notes
array The cell voltages (V) for this battery. This object is an excerpt of the
CellVoltages [ {
(excerpt) Sensor resource located at the URI shown in DataSourceUri.
read-only
CrestFactor (v1.1+) number The crest factor for this sensor.
(null)
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
read-only
THDPercent (v1.1+) number The total harmonic distortion (THD).
(null)
}]
154 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The amount of charge available (percent) in this battery. For more
ChargePercent {} object information about this property, see SensorExcerpt in Property
Details.
read-only
DischargeCycles number The number of discharges this battery sustained.
(null)
object The input current (A) for this battery. This object is an excerpt of the
InputCurrentAmps {
(excerpt) Sensor resource located at the URI shown in DataSourceUri.
read-only
CrestFactor (v1.1+) number The crest factor for this sensor.
(null)
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
read-only
THDPercent (v1.1+) number The total harmonic distortion (THD).
(null)
object The input voltage (V) for this battery. This object is an excerpt of the
InputVoltage {
(excerpt) Sensor resource located at the URI shown in DataSourceUri.
read-only
CrestFactor (v1.1+) number The crest factor for this sensor.
(null)
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
read-only
THDPercent (v1.1+) number The total harmonic distortion (THD).
(null)
array The output currents (A) for this battery. This object is an excerpt of
OutputCurrentAmps [ {
(excerpt) the Sensor resource located at the URI shown in DataSourceUri.
read-only
CrestFactor (v1.1+) number The crest factor for this sensor.
(null)
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
Version 2023.1 Published 155
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
Reading number The sensor value.
(null)
read-only
THDPercent (v1.1+) number The total harmonic distortion (THD).
(null)
}]
array The output voltages (V) for this battery. This object is an excerpt of
OutputVoltages [ {
(excerpt) the Sensor resource located at the URI shown in DataSourceUri.
read-only
CrestFactor (v1.1+) number The crest factor for this sensor.
(null)
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
read-only
THDPercent (v1.1+) number The total harmonic distortion (THD).
(null)
}]
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
StoredChargeAmpHours The charge (Ah) stored in this battery. For more information about
object
{} this property, see SensorExcerpt in Property Details.
StoredEnergyWattHours The energy (Wh) stored in this battery. For more information about
object
{} this property, see SensorExcerpt in Property Details.
The temperature (C) for this battery. For more information about this
TemperatureCelsius {} object
property, see SensorExcerpt in Property Details.
6.12.4 Property details
6.12.4.1 SensorExcerpt
The Sensor schema describes a sensor and its properties. This object is an excerpt of the Sensor
resource located at the URI shown in DataSourceUri.
156 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
read-
string
DataSourceUri only The link to the resource that provides the data for this sensor.
(URI)
(null)
read-
Reading number only The sensor value.
(null)
6.12.5 Example response
{
"@odata.type": "#BatteryMetrics.v1_0_1.BatteryMetrics",
"Id": "Metrics",
"Name": "Metrics for Battery 1",
"DischargeCycles": 8.67,
"InputVoltage": {
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/Battery1InputVoltage",
"Reading": 12.22
},
"InputCurrentAmps": {
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/Battery1InputCurrent",
"Reading": 0
},
"OutputVoltages": [
{
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/Battery1OutputVoltage",
"Reading": 12.22
}
],
"OutputCurrentAmps": [
{
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/Battery1OutputCurrent",
"Reading": 0
}
],
"StoredEnergyWattHours": {
"Reading": 19.41
},
"TemperatureCelsius": {
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/Battery1Temp",
"Reading": 33
},
"ChargePercent": {
"Reading": 100
},
"CellVoltages": [
{
"Reading": 3.44
Version 2023.1 Published 157
Redfish Resource and Schema Guide DSP2046
},
{
"Reading": 3.45
},
{
"Reading": 3.43
},
{
"Reading": 3.43
},
{
"Reading": 3.45
},
{
"Reading": 3.44
},
{
"Reading": 3.43
},
{
"Reading": 3.44
}
],
"@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/Batteries/Module1/Metrics"
}
6.13 Bios 1.2.1
Version v1.2 v1.1 v1.0
Release 2021.1 2019.2 2016.1
6.13.1 Description
The Bios schema contains properties related to the BIOS attribute registry. The attribute registry
describes the system-specific BIOS attributes and actions for changing to BIOS settings. Changes to
the BIOS typically require a system reset before they take effect. It is likely that a client finds the
@Redfish.Settings term in this resource, and if it is found, the client makes requests to change BIOS
settings by modifying the resource identified by the @Redfish.Settings term.
6.13.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
158 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Bios
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Bios
/redfish/v1/Systems/{ComputerSystemId}/Bios
6.13.3 Properties
Property Type Attributes Notes
read-only The resource ID of the attribute registry that has the system-
AttributeRegistry string
(null) specific information about a BIOS resource.
The list of BIOS attributes specific to the manufacturer or
Attributes { object
provider.
string,
read-write Property names follow regular expression pattern "^[A-Za-z][A-
(pattern) boolean,
(null) Za-z0-9_]+$"
number
Links (v1.1+) { object The links to other resources that are related to this resource.
The link to the software inventory that represents the active
ActiveSoftwareImage
object BIOS firmware image. See the SoftwareInventory schema for
(v1.1+) {
details on this property.
Link to a SoftwareInventory resource. See the Links section and
@odata.id string read-write
the SoftwareInventory schema for details.
Oem {} object See the Oem object definition in the Common properties section.
SoftwareImages (v1.1+) [
array The images that are associated with this BIOS.
{
Link to a SoftwareInventory resource. See the Links section and
@odata.id string read-only
the SoftwareInventory schema for details.
}]
ResetBiosToDefaultsPending read-only An indication of whether there is a pending request to reset the
boolean
(v1.2+) (null) BIOS attributes to default values.
Version 2023.1 Published 159
Redfish Resource and Schema Guide DSP2046
6.13.4 Actions
6.13.4.1 ChangePassword
Description
This action changes a BIOS password.
Action URI
{Base URI of target resource}/Actions/Bios.ChangePassword
Action parameters
Parameter Name Type Attributes Notes
NewPassword string required The new BIOS password.
OldPassword string required The existing BIOS password.
PasswordName string required The name of the BIOS password to change.
Request Example
{
"OldPassword": "secret123",
"NewPassword": "B3tterS3cur1tY!",
"PasswordName": "Admin"
}
6.13.4.2 ResetBios
Description
This action resets the BIOS attributes to default.
Action URI
{Base URI of target resource}/Actions/Bios.ResetBios
Action parameters
This action takes no parameters.
160 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.13.5 Example response
{
"@odata.type": "#Bios.v1_2_1.Bios",
"Id": "BIOS",
"Name": "BIOS Configuration Current Settings",
"AttributeRegistry": "BiosAttributeRegistryP89.v1_0_0",
"Attributes": {
"AdminPhone": "",
"BootMode": "Uefi",
"EmbeddedSata": "Raid",
"NicBoot1": "NetworkBoot",
"NicBoot2": "Disabled",
"PowerProfile": "MaxPerf",
"ProcCoreDisable": 0,
"ProcHyperthreading": "Enabled",
"ProcTurboMode": "Enabled",
"UsbControl": "UsbEnabled"
},
"@Redfish.Settings": {
"@odata.type": "#Settings.v1_3_5.Settings",
"ETag": "9234ac83b9700123cc32",
"Messages": [
{
"MessageId": "Base.1.0.SettingsFailed",
"RelatedProperties": [
"/Attributes/ProcTurboMode"
]
}
],
"SettingsObject": {
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Bios/Settings"
},
"Time": "2016-03-07T14:44.30-05:00"
},
"Actions": {
"#Bios.ResetBios": {
"target": "/redfish/v1/Systems/437XR1138R2/Bios/Actions/Bios.ResetBios"
},
"#Bios.ChangePassword": {
"target": "/redfish/v1/Systems/437XR1138R2/Bios/Actions/Bios.ChangePassword"
}
},
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Bios"
}
Version 2023.1 Published 161
Redfish Resource and Schema Guide DSP2046
6.14 BootOption 1.0.4
Version v1.0
Release 2017.3
6.14.1 Description
The BootOption schema reports information about a single boot option in a system. It represents the
properties of a bootable device available in the system.
6.14.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
BootOptions/{BootOptionId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/BootOptions/
{BootOptionId}
/redfish/v1/Systems/{ComputerSystemId}/BootOptions/{BootOptionId}
6.14.3 Properties
Property Type Attributes Notes
string read-only The alias of this boot source. For the possible property values, see Alias
Alias
(enum) (null) in Property details.
An indication of whether the boot option is enabled. If true , it is
read-write enabled. If false , the boot option that the boot order array on the
BootOptionEnabled boolean
(null) computer system contains is skipped. In the UEFI context, this property
shall influence the load option active flag for the boot option.
read-only
BootOptionReference string required The unique boot option.
(null)
read-only The user-readable display name of the boot option that appears in the
DisplayName string
(null) boot order list in the user interface.
An array of links to resources or objects associated with this boot
RelatedItem [ { array
option.
string
@odata.id read-only The unique identifier for a resource.
(URI)
162 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
}]
read-only
UefiDevicePath string The UEFI device path to access this UEFI boot option.
(null)
6.14.4 Property details
6.14.4.1 Alias
The alias of this boot source.
string Description
BiosSetup Boot to the BIOS setup utility.
Cd Boot from the CD or DVD.
Diags Boot to the manufacturer's diagnostics program.
Floppy Boot from the floppy disk drive.
Hdd Boot from a hard drive.
None Boot from the normal boot device.
Pxe Boot from the Pre-Boot EXecution (PXE) environment.
Recovery Boot to a system-designated recovery process or image.
RemoteDrive Boot from a remote drive, such as an iSCSI target.
SDCard Boot from an SD card.
UefiBootNext Boot to the UEFI device that the BootNext property specifies.
UefiHttp Boot from a UEFI HTTP network location.
UefiShell Boot to the UEFI Shell.
UefiTarget Boot to the UEFI device specified in the UefiTargetBootSourceOverride property.
Usb Boot from a system BIOS-specified USB device.
Utilities Boot to the manufacturer's utilities program or programs.
Version 2023.1 Published 163
Redfish Resource and Schema Guide DSP2046
6.14.5 Example response
{
"@odata.type": "#BootOption.v1_0_4.BootOption",
"Id": "1",
"Name": "Boot Option",
"Description": "UEFI Boot Option",
"BootOptionReference": "Boot0000",
"DisplayName": "Windows Boot Manager",
"UefiDevicePath": "PciRoot(0x0)/Pci(0x1,0x0)/Pci(0x0,0x0)/Scsi(0x0,0x0)/HD(2,GPT,B02BF459-8975-4222-A1C4-17915C
"Alias": "Hdd",
"RelatedItem": [
{
"@odata.id": "/redfish/v1/Systems/1/SimpleStorage/1"
}
],
"@odata.id": "/redfish/v1/Systems/1/BootOptions/1"
}
6.15 Cable 1.2.1
Version v1.2 v1.1 v1.0
Release 2021.4 2021.3 2021.2
6.15.1 Description
The Cable schema contains properties that describe a cable connecting endpoints of a chassis, port, or
any other cable-compatible endpoint.
6.15.2 URIs
/redfish/v1/Cables/{CableId}
6.15.3 Properties
Property Type Attributes Notes
The link to the assembly associated with this cable. See the
Assembly { object
Assembly schema for details on this property.
164 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to a Assembly resource. See the Links section and the
@odata.id string read-only
Assembly schema for details.
read-write
AssetTag string The user-assigned asset tag for this cable.
(null)
string read-write The identifier for the downstream resource. For the possible
CableClass
(enum) (null) property values, see CableClass in Property details.
string The user-reported status of this resource. For the possible
CableStatus read-write
(enum) property values, see CableStatus in Property details.
read-write
CableType string The type of this cable.
(null)
array The connector types this cable supports. For the possible
DownstreamConnectorTypes
(string read-write property values, see DownstreamConnectorTypes in Property
[]
(enum)) details.
read-write
DownstreamName string The identifier for the downstream resource.
(null)
read-write
LengthMeters number The length of the cable in meters.
(null)
Links { object The links to other resources that are related to this resource.
An array of links to the downstream chassis connected to this
DownstreamChassis [ { array
cable.
Link to a Chassis resource. See the Links section and the Chassis
@odata.id string read-write
schema for details.
}]
An array of links to the downstream ports connected to this
DownstreamPorts [ { array
cable.
Link to a Port resource. See the Links section and the Port
@odata.id string read-write
schema for details.
}]
DownstreamResources [ An array of links to the downstream resources connected to this
array
{ cable.
string
@odata.id read-only The unique identifier for a resource.
(URI)
Version 2023.1 Published 165
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
}]
Oem {} object See the Oem object definition in the Common properties section.
UpstreamChassis [ { array An array of links to the upstream chassis connected to this cable.
Link to a Chassis resource. See the Links section and the Chassis
@odata.id string read-write
schema for details.
}]
UpstreamPorts [ { array An array of links to the upstream ports connected to this cable.
Link to a Port resource. See the Links section and the Port
@odata.id string read-write
schema for details.
}]
An array of links to the upstream resources connected to this
UpstreamResources [ { array
cable.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
Location {} object The location of the assembly. For property details, see Location.
read-write
Manufacturer string The manufacturer of this cable.
(null)
read-write
Model string The model number of the cable.
(null)
read-write
PartNumber string The part number for this cable.
(null)
read-write
SerialNumber string The serial number for this cable.
(null)
read-write
SKU string The SKU for this cable.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
array The connector types this cable supports. For the possible
UpstreamConnectorTypes [ ] (string read-write property values, see UpstreamConnectorTypes in Property
(enum)) details.
166 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write
UpstreamName string The identifier for the downstream resource.
(null)
read-write
UserDescription string The description of this cable.
(null)
UserLabel (v1.1+) string read-write A user-assigned label.
read-write
Vendor string The manufacturer of this cable.
(null)
6.15.4 Property details
6.15.4.1 CableClass
The identifier for the downstream resource.
string Description
Fabric This cable is used for connecting to a fabric.
Fan This cable is used for connecting to a fan system.
General This cable is used for providing general connectivity.
Network This cable is used for connecting to a networking system.
PCIe This cable is used for connecting to a PCIe endpoint.
Power This cable is used for connecting to a power system.
Serial This cable is used for connecting to a serial endpoint.
Storage This cable is used for connecting to a storage system.
USB This cable is used for connecting to a USB endpoint.
Video This cable is used for connecting to a video system.
6.15.4.2 CableStatus
The user-reported status of this resource.
Version 2023.1 Published 167
Redfish Resource and Schema Guide DSP2046
string Description
Degraded The cable is degraded.
Disabled The cable is disabled.
Failed The cable has failed.
Normal The cable is operating normally.
SetByService The cable status is set by the service.
Testing The cable is under test.
6.15.4.3 DownstreamConnectorTypes
The connector types this cable supports.
string Description
ACPower This cable connects to a AC power connector.
CDFP This cable connects to a CDFP connector.
DB9 This cable connects to a DB9 connector.
DCPower This cable connects to a DC power connector.
DisplayPort This cable connects to a DisplayPort power connector.
HDMI This cable connects to an HDMI connector.
ICI This cable connects to an ICI connector.
IPASS This cable connects to an IPASS connector.
OSFP This cable connects to a OSFP connector.
PCIe This cable connects to a PCIe connector.
Proprietary This cable connects to a proprietary connector.
QSFP This cable connects to a QSFP connector.
RJ45 This cable connects to an RJ45 connector.
SATA This cable connects to a SATA connector.
SCSI This cable connects to a SCSI connector.
SFP This cable connects to a SFP connector.
168 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
SFPPlus This cable connects to a SFPPlus connector.
SlimSAS This cable connects to a SlimSAS connector.
USBA This cable connects to a USB-A connector.
USBC This cable connects to a USB-C connector.
6.15.4.4 UpstreamConnectorTypes
The connector types this cable supports.
string Description
ACPower This cable connects to a AC power connector.
CDFP This cable connects to a CDFP connector.
DB9 This cable connects to a DB9 connector.
DCPower This cable connects to a DC power connector.
DisplayPort This cable connects to a DisplayPort power connector.
HDMI This cable connects to an HDMI connector.
ICI This cable connects to an ICI connector.
IPASS This cable connects to an IPASS connector.
OSFP This cable connects to a OSFP connector.
PCIe This cable connects to a PCIe connector.
Proprietary This cable connects to a proprietary connector.
QSFP This cable connects to a QSFP connector.
RJ45 This cable connects to an RJ45 connector.
SATA This cable connects to a SATA connector.
SCSI This cable connects to a SCSI connector.
SFP This cable connects to a SFP connector.
SFPPlus This cable connects to a SFPPlus connector.
SlimSAS This cable connects to a SlimSAS connector.
Version 2023.1 Published 169
Redfish Resource and Schema Guide DSP2046
string Description
USBA This cable connects to a USB-A connector.
USBC This cable connects to a USB-C connector.
6.15.5 Example response
{
"@odata.type": "#Cable.v1_2_1.Cable",
"Id": "hdmi_dp",
"Name": "HDMI to DP Cable",
"UserDescription": "HDMI to DisplayPort Cable",
"UpstreamName": "HDMI0",
"DownstreamName": "Video Out",
"CableType": "HDMI",
"LengthMeters": 0.1,
"CableClass": "Video",
"UpstreamConnectorTypes": [
"HDMI"
],
"DownstreamConnectorTypes": [
"DisplayPort"
],
"Links": {
"UpstreamChassis": [
{
"@odata.id": "/redfish/v1/Chassis/bmc"
}
]
},
"PartNumber": "934AMS02X",
"Manufacturer": "Cable Co.",
"SerialNumber": "2345791",
"Vendor": "Cablestore",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"CableStatus": "Normal",
"@odata.id": "/redfish/v1/Cables/hdmi_dp"
}
170 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.16 Certificate 1.7.0
Version v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2023.1 2022.1 2021.3 2021.2 2021.1 2020.1 2019.1 2018.3
6.16.1 Description
The Certificate schema describes a certificate that proves the identify of a component, account, or
service.
6.16.2 URIs
/redfish/v1/AccountService/Accounts/{ManagerAccountId}/Certificates/{CertificateId}
/redfish/v1/AccountService/ActiveDirectory/Certificates/{CertificateId}
/redfish/v1/AccountService/ExternalAccountProviders/{ExternalAccountProviderId}/Certificates/
{CertificateId}
/redfish/v1/AccountService/LDAP/Certificates/{CertificateId}
/redfish/v1/AccountService/MultiFactorAuth/ClientCertificate/Certificates/{CertificateId}
/redfish/v1/AccountService/MultiFactorAuth/SecurID/Certificates/{CertificateId}
/redfish/v1/Chassis/{ChassisId}/Certificates/{CertificateId}
/redfish/v1/Chassis/{ChassisId}/Drives/{DriveId}/Certificates/{CertificateId}
/redfish/v1/Chassis/{ChassisId}/Memory/{MemoryId}/Certificates/{CertificateId}
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Certificates/{CertificateId}
/redfish/v1/Chassis/{ChassisId}/TrustedComponents/{TrustedComponentId}/Certificates/
{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}/Certificates/
{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/Certificates/
{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/
Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/
{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/
{DriveId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/
StorageControllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Boot/Certificates/{CertificateId}
Version 2023.1 Published 171
Redfish Resource and Schema Guide DSP2046
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
KeyManagement/KMIPCertificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Memory/{MemoryId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
SecureBoot/SecureBootDatabases/{DatabaseId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/Drives/{DriveId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
VirtualMedia/{VirtualMediaId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
VirtualMedia/{VirtualMediaId}/ClientCertificates/{CertificateId}
/redfish/v1/EventService/Subscriptions/{EventDestinationId}/Certificates/{CertificateId}
/redfish/v1/EventService/Subscriptions/{EventDestinationId}/ClientCertificates/{CertificateId}
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Certificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/Certificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/NetworkProtocol/HTTPS/Certificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/Accounts/{ManagerAccountId}/Certificates/
{CertificateId}
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/ActiveDirectory/Certificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/ExternalAccountProviders/
{ExternalAccountProviderId}/Certificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/LDAP/Certificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/MultiFactorAuth/ClientCertificate/
Certificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/MultiFactorAuth/SecurID/Certificates/
{CertificateId}
/redfish/v1/Managers/{ManagerId}/SecurityPolicy/SPDM/RevokedCertificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/SecurityPolicy/SPDM/TrustedCertificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/SecurityPolicy/TLS/Client/RevokedCertificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/SecurityPolicy/TLS/Client/TrustedCertificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/SecurityPolicy/TLS/Server/RevokedCertificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/SecurityPolicy/TLS/Server/TrustedCertificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Certificates/{CertificateId}
172 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{StorageControllerId}/
Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/{DriveId}/Certificates/
{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/
{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Boot/Certificates/
{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Certificates/
{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/KeyManagement/
KMIPCertificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory/{MemoryId}/
Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/
{ProcessorId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SecureBoot/
SecureBootDatabases/{DatabaseId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
Controllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
Drives/{DriveId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
StorageControllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/VirtualMedia/
{VirtualMediaId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/VirtualMedia/
{VirtualMediaId}/ClientCertificates/{CertificateId}
/redfish/v1/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/Boot/Certificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/Certificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/KeyManagement/KMIPCertificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}/Certificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Certificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases/{DatabaseId}/
Certificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/
Certificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/Certificates/
{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/
{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/Certificates/{CertificateId}
Version 2023.1 Published 173
Redfish Resource and Schema Guide DSP2046
/redfish/v1/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/ClientCertificates/
{CertificateId}
/redfish/v1/UpdateService/ClientCertificates/{CertificateId}
/redfish/v1/UpdateService/RemoteServerCertificates/{CertificateId}
6.16.3 Properties
Property Type Attributes Notes
read-only
required
CertificateString string The string for the certificate.
on create
(null)
read-only
string required The format of the certificate. For the possible property
CertificateType
(enum) on create values, see CertificateType in Property details.
(null)
array The types or purposes for this certificate. For the possible
read-only
CertificateUsageTypes (v1.4+) [ ] (string property values, see CertificateUsageTypes in Property
(null)
(enum)) details.
Fingerprint (v1.3+) string read-only The fingerprint of the certificate.
FingerprintHashAlgorithm (v1.3+) string read-only The hash algorithm for the fingerprint of the certificate.
Issuer { object The issuer of the certificate.
array
AdditionalCommonNames
(string, read-only Additional common names of the entity.
(v1.6+) [ ]
null)
array
AdditionalOrganizationalUnits
(string, read-only Additional organizational units of the entity.
(v1.6+) [ ]
null)
array
AlternativeNames (v1.7+) [ ] (string, read-only The additional host names of the entity.
null)
City string read-only The city or locality of the organization of the entity.
CommonName string read-only The common name of the entity.
Country string read-only The country of the organization of the entity.
read-only
DisplayString (v1.6+) string A human-readable string for this identifier.
(null)
174 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
array
DomainComponents (v1.6+) [ ] (string, read-only The domain components of the entity.
null)
read-only The email address of the contact within the organization of
Email string
(null) the entity.
Organization string read-only The name of the organization of the entity.
The name of the unit or division of the organization of the
OrganizationalUnit string read-only
entity.
The state, province, or region of the organization of the
State string read-only
entity.
array The key usage extension, which defines the purpose of the
read-only
KeyUsage [ ] (string public keys in this certificate. For the possible property
(null)
(enum)) values, see KeyUsage in Property details.
Links (v1.4+) { object The links to other resources that are related to this resource.
Issuer (v1.4+) { object A link to the certificate of the CA that issued this certificate.
(null)
@odata.id string read-write Link to another Certificate resource.
See the Oem object definition in the Common properties
Oem {} object
section.
An array of links to certificates that were issued by the CA
Subjects (v1.4+) [ { array
that is represented by this certificate.
@odata.id string read-write Link to another Certificate resource.
}]
SerialNumber (v1.3+) string read-only The serial number of the certificate.
The algorithm used for creating the signature of the
SignatureAlgorithm (v1.3+) string read-only
certificate.
SPDM (v1.5+) { object SPDM-related information for the certificate.
(null)
Version 2023.1 Published 175
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
SlotId (v1.5+) integer Slot identifier of the certificate.
(null)
Subject { object The subject of the certificate.
array
AdditionalCommonNames
(string, read-only Additional common names of the entity.
(v1.6+) [ ]
null)
array
AdditionalOrganizationalUnits
(string, read-only Additional organizational units of the entity.
(v1.6+) [ ]
null)
array
AlternativeNames (v1.7+) [ ] (string, read-only The additional host names of the entity.
null)
City string read-only The city or locality of the organization of the entity.
CommonName string read-only The common name of the entity.
Country string read-only The country of the organization of the entity.
read-only
DisplayString (v1.6+) string A human-readable string for this identifier.
(null)
array
DomainComponents (v1.6+) [ ] (string, read-only The domain components of the entity.
null)
read-only The email address of the contact within the organization of
Email string
(null) the entity.
Organization string read-only The name of the organization of the entity.
The name of the unit or division of the organization of the
OrganizationalUnit string read-only
entity.
The state, province, or region of the organization of the
State string read-only
entity.
string read-only
UefiSignatureOwner (v1.2+) The UEFI signature owner for this certificate.
(uuid) (null)
string
ValidNotAfter (date- read-only The date when the certificate is no longer valid.
time)
176 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
string
ValidNotBefore (date- read-only The date when the certificate becomes valid.
time)
6.16.4 Actions
6.16.4.1 Rekey (v1.1+)
Description
This action generates a new key-pair for a certificate and produces a certificate signing request.
Action URI
{Base URI of target resource}/Actions/Certificate.Rekey
Action parameters
Parameter Name Type Attributes Notes
The challenge password to apply to the certificate for revocation
ChallengePassword string optional
requests.
The length of the key, in bits, if needed based on the KeyPairAlgorithm
KeyBitLength integer optional
parameter value.
The curve ID to use with the key, if needed based on the
KeyCurveId string optional
KeyPairAlgorithm parameter value.
KeyPairAlgorithm string optional The type of key-pair for use with signing algorithms.
Response Payload
Certificate
object required The link to the certificate being rekeyed.
(v1.1+) {
read-
@odata.id string Link to another Certificate resource.
only
Version 2023.1 Published 177
Redfish Resource and Schema Guide DSP2046
read-
CSRString
string only The string for the certificate signing request.
(v1.1+)
required
Request Example
{
"KeyPairAlgorithm": "TPM_ALG_RSA",
"KeyBitLength": 4096
}
Response Example
{
"CSRString": "-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----",
"Certificate": {
"@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates/1"
}
}
6.16.4.2 Renew (v1.1+)
Description
This action generates a certificate signing request by using the existing information and key-pair of the
certificate.
Action URI
{Base URI of target resource}/Actions/Certificate.Renew
Action parameters
Parameter Name Type Attributes Notes
The challenge password to apply to the certificate for revocation
ChallengePassword string optional
requests.
Response Payload
178 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Certificate
object required The link to the certificate being renewed.
(v1.1+) {
read-
@odata.id string Link to another Certificate resource.
only
read-
CSRString
string only The string for the certificate signing request.
(v1.1+)
required
Request Example
{
"ChallengePassword": "p4ssw0rd"
}
Response Example
{
"CSRString": "-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----",
"Certificate": {
"@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates/1"
}
}
6.16.5 Property details
6.16.5.1 CertificateType
The format of the certificate.
string Description
PEM A Privacy Enhanced Mail (PEM)-encoded single certificate.
PEMchain (v1.4+) A Privacy Enhanced Mail (PEM)-encoded certificate chain.
Version 2023.1 Published 179
Redfish Resource and Schema Guide DSP2046
string Description
PKCS7 A Privacy Enhanced Mail (PEM)-encoded PKCS7 certificate.
6.16.5.2 CertificateUsageTypes
The types or purposes for this certificate.
string Description
BIOS This certificate is a BIOS certificate like those associated with UEFI.
This certificate is a device type certificate like those associated with SPDM and other
Device
standards.
This certificate is a platform type certificate like those associated with SPDM and other
Platform
standards.
SSH This certificate is used for SSH.
User This certificate is a user certificate like those associated with a manager account.
Web This certificate is a web or HTTPS certificate like those used for event destinations.
6.16.5.3 KeyUsage
The key usage extension, which defines the purpose of the public keys in this certificate.
string Description
ClientAuthentication TLS WWW client authentication.
CodeSigning Signs downloadable executable code.
CRLSigning Verifies signatures on certificate revocation lists (CRLs).
DataEncipherment Directly enciphers raw user data without an intermediate symmetric cipher.
DecipherOnly Deciphers data while performing a key agreement.
DigitalSignature Verifies digital signatures, other than signatures on certificates and CRLs.
EmailProtection Email protection.
EncipherOnly Enciphers data while performing a key agreement.
KeyAgreement Key agreement.
180 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
KeyCertSign Verifies signatures on public key certificates.
KeyEncipherment Enciphers private or secret keys.
Verifies digital signatures, other than signatures on certificates and CRLs, and provides a non-
NonRepudiation
repudiation service that protects against the signing entity falsely denying some action.
OCSPSigning Signs OCSP responses.
ServerAuthentication TLS WWW server authentication.
Timestamping Binds the hash of an object to a time.
6.16.6 Example response
{
"@odata.type": "#Certificate.v1_7_0.Certificate",
"Id": "1",
"Name": "HTTPS Certificate",
"CertificateString": "-----BEGIN CERTIFICATE-----\nMIIFsTCC [*truncated*] GXG5zljlu\n-----END CERTIFICATE-----"
"CertificateType": "PEM",
"Issuer": {
"Country": "US",
"State": "Oregon",
"City": "Portland",
"Organization": "Contoso",
"OrganizationalUnit": "ABC",
"CommonName": "manager.contoso.org"
},
"Subject": {
"Country": "US",
"State": "Oregon",
"City": "Portland",
"Organization": "Contoso",
"OrganizationalUnit": "ABC",
"CommonName": "manager.contoso.org"
},
"ValidNotBefore": "2018-09-07T13:22:05Z",
"ValidNotAfter": "2019-09-07T13:22:05Z",
"KeyUsage": [
"KeyEncipherment",
"ServerAuthentication"
],
"SerialNumber": "5d:7a:d8:df:f6:fc:c1:b3:ca:fe:fb:cc:38:f3:01:64:51:ea:05:cb",
"Fingerprint": "A6:E9:D2:5C:DC:52:DA:4B:3B:14:97:F3:A4:53:D9:99:A1:0B:56:41",
"FingerprintHashAlgorithm": "TPM_ALG_SHA1",
"SignatureAlgorithm": "sha256WithRSAEncryption",
Version 2023.1 Published 181
Redfish Resource and Schema Guide DSP2046
"@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates/1"
}
6.17 CertificateLocations 1.0.2
Version v1.0
Release 2018.3
6.17.1 Description
The CertificateLocations schema describes a Resource that an administrator can use in order to locate
all certificates installed on a given service.
6.17.2 URIs
/redfish/v1/CertificateService/CertificateLocations
6.17.3 Properties
Property Type Attributes Notes
Links { object The links to other Resources that are related to this Resource.
Certificates [
array An array of links to the certificates installed on this service.
{
Link to a Certificate resource. See the Links section and the Certificate
@odata.id string read-only
schema for details.
}]
Oem {} object See the Oem object definition in the Common properties section.
6.17.4 Example response
182 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"@odata.type": "#CertificateLocations.v1_0_2.CertificateLocations",
"Id": "CertificateLocations",
"Name": "Certificate Locations",
"Links": {
"Certificates": [
{
"@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates/1"
}
]
},
"@odata.id": "/redfish/v1/CertificateService/CertificateLocations"
}
6.18 CertificateService 1.0.4
Version v1.0
Release 2018.3
6.18.1 Description
The CertificateService schema describes a certificate service that represents the actions available to
manage certificates and links to the certificates.
6.18.2 URIs
/redfish/v1/CertificateService
6.18.3 Properties
Property Type Attributes Notes
CertificateLocations The information about the location of certificates. See the
object
{ CertificateLocations schema for details on this property.
Link to a CertificateLocations resource. See the Links section and the
@odata.id string read-only
CertificateLocations schema for details.
Version 2023.1 Published 183
Redfish Resource and Schema Guide DSP2046
6.18.4 Actions
6.18.4.1 GenerateCSR
Description
This action makes a certificate signing request.
Action URI
{Base URI of target resource}/Actions/CertificateService.GenerateCSR
Action parameters
Parameter Name Type Attributes Notes
AlternativeNames [ array
optional The additional host names of the component to secure.
] (string)
The link to the certificate collection where the certificate is installed
CertificateCollection
object required after the certificate authority (CA) signs the certificate. Contains a
{
link to a resource.
@odata.id string read-only Link to Collection of Certificate. See the Certificate schema for details.
The challenge password to apply to the certificate for revocation
ChallengePassword string optional
requests.
City string required The city or locality of the organization making the request.
CommonName string required The fully qualified domain name of the component to secure.
ContactPerson string optional The name of the user making the request.
Country string required The two-letter country code of the organization making the request.
The email address of the contact within the organization making the
Email string optional
request.
GivenName string optional The given name of the user making the request.
Initials string optional The initials of the user making the request.
The length of the key, in bits, if needed based on the
KeyBitLength integer optional
KeyPairAlgorithm parameter value.
184 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Parameter Name Type Attributes Notes
The curve ID to use with the key, if needed based on the
KeyCurveId string optional
KeyPairAlgorithm parameter value.
KeyPairAlgorithm string optional The type of key-pair for use with signing algorithms.
array
The usage of the key contained in the certificate. For the possible
KeyUsage [ ] (string read-write
property values, see KeyUsage in Property details.
(enum))
Organization string required The name of the organization making the request.
The name of the unit or division of the organization making the
OrganizationalUnit string required
request.
State string required The state, province, or region of the organization making the request.
Surname string optional The surname of the user making the request.
UnstructuredName string optional The unstructured name of the subject.
Response Payload
CertificateCollection The link to the certificate collection where the certificate is installed. Contains
object required
{ a link to a resource.
read-
@odata.id string Link to Collection of Certificate. See the Certificate schema for details.
only
read-
CSRString string only The string for the certificate signing request.
required
Request Example
{
"Country": "US",
"State": "Oregon",
"City": "Portland",
"Organization": "Contoso",
"OrganizationalUnit": "ABC",
Version 2023.1 Published 185
Redfish Resource and Schema Guide DSP2046
"CommonName": "manager.contoso.org",
"AlternativeNames": [
"manager.contoso.org",
"manager.contoso.com",
"manager.contoso.us"
],
"Email": "[email protected]",
"KeyPairAlgorithm": "TPM_ALG_RSA",
"KeyBitLength": 4096,
"KeyUsage": [
"KeyEncipherment",
"ServerAuthentication"
],
"CertificateCollection": {
"@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates"
}
}
Response Example
{
"CSRString": "-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----",
"CertificateCollection": {
"@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates"
}
}
6.18.4.2 ReplaceCertificate
Description
This action replaces a certificate.
Action URI
{Base URI of target resource}/Actions/CertificateService.ReplaceCertificate
Action parameters
Parameter Name Type Attributes Notes
CertificateString string required The string for the certificate.
186 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Parameter Name Type Attributes Notes
string The format of the certificate. For the possible property values, see
CertificateType required
(enum) CertificateType in Property details.
The link to the certificate that is being replaced. See the Certificate
CertificateUri { object required
schema for details on this property.
Link to a Certificate resource. See the Links section and the Certificate
@odata.id string read-only
schema for details.
Request Example
{
"CertificateUri": {
"@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates/1"
},
"CertificateString": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
"CertificateType": "PEM"
}
6.18.5 Property details
6.18.5.1 CertificateType
The format of the certificate.
string Description
PEM A Privacy Enhanced Mail (PEM)-encoded single certificate.
PEMchain A Privacy Enhanced Mail (PEM)-encoded certificate chain.
PKCS7 A Privacy Enhanced Mail (PEM)-encoded PKCS7 certificate.
6.18.5.2 KeyUsage
The usage of the key contained in the certificate.
Version 2023.1 Published 187
Redfish Resource and Schema Guide DSP2046
string Description
ClientAuthentication TLS WWW client authentication.
CodeSigning Signs downloadable executable code.
CRLSigning Verifies signatures on certificate revocation lists (CRLs).
DataEncipherment Directly enciphers raw user data without an intermediate symmetric cipher.
DecipherOnly Deciphers data while performing a key agreement.
DigitalSignature Verifies digital signatures, other than signatures on certificates and CRLs.
EmailProtection Email protection.
EncipherOnly Enciphers data while performing a key agreement.
KeyAgreement Key agreement.
KeyCertSign Verifies signatures on public key certificates.
KeyEncipherment Enciphers private or secret keys.
Verifies digital signatures, other than signatures on certificates and CRLs, and provides a non-
NonRepudiation
repudiation service that protects against the signing entity falsely denying some action.
OCSPSigning Signs OCSP responses.
ServerAuthentication TLS WWW server authentication.
Timestamping Binds the hash of an object to a time.
6.18.6 Example response
{
"@odata.type": "#CertificateService.v1_0_4.CertificateService",
"Id": "CertificateService",
"Name": "Certificate Service",
"Actions": {
"#CertificateService.GenerateCSR": {
"target": "/redfish/v1/CertificateService/Actions/CertificateService.GenerateCSR",
"@Redfish.ActionInfo": "/redfish/v1/CertificateService/GenerateCSRActionInfo"
},
"#CertificateService.ReplaceCertificate": {
"target": "/redfish/v1/CertificateService/Actions/CertificateService.ReplaceCertificate",
"@Redfish.ActionInfo": "/redfish/v1/CertificateService/ReplaceCertificateActionInfo"
}
},
"CertificateLocations": {
188 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"@odata.id": "/redfish/v1/CertificateService/CertificateLocations"
},
"@odata.id": "/redfish/v1/CertificateService"
}
6.19 Chassis 1.23.0
Version v1.23 v1.22 v1.21 v1.20 v1.19 v1.18 v1.17 v1.16 v1.15 v1.14 v1.13 ...
Release 2023.1 2022.3 2022.2 2022.1 2021.4 2021.3 2021.2 2021.1 2020.4 2020.3 2020.2 ...
6.19.1 Description
The Chassis schema represents the physical components of a system. This resource represents the
sheet-metal confined spaces and logical zones such as racks, enclosures, chassis and all other
containers. Subsystems, such as sensors, that operate outside of a system's data plane are linked
either directly or indirectly through this resource. A subsystem that operates outside of a system's
data plane are not accessible to software that runs on the system. It also describes the location, such
as a slot, socket, or bay, where a unit can be installed, by populating a resource instance with an
absent state if a unit is not present.
6.19.2 URIs
/redfish/v1/Chassis/{ChassisId}
6.19.3 Properties
Property Type Attributes Notes
The link to the assembly associated with this chassis. See the
Assembly (v1.6+) { object
Assembly schema for details on this property.
Link to a Assembly resource. See the Links section and the
@odata.id string read-only
Assembly schema for details.
read-write
AssetTag string The user-assigned asset tag of this chassis.
(null)
Version 2023.1 Published 189
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The link to a collection of certificates for device identity and
Certificates (v1.15+) { object
attestation. Contains a link to a resource.
Link to Collection of Certificate. See the Certificate schema for
@odata.id string read-only
details.
string read-only The type of physical form factor of the chassis. For the possible
ChassisType
(enum) required property values, see ChassisType in Property details.
The link to the collection of controls located in this chassis.
Controls (v1.17+) { object
Contains a link to a resource.
@odata.id string read-only Link to Collection of Control. See the Control schema for details.
number read-only
DepthMm (v1.4+) The depth of the chassis.
(mm) (null)
The link to the collection of drives within this chassis. Contains a
Drives (v1.14+) { object
link to a resource.
@odata.id string read-only Link to Collection of Drive. See the Drive schema for details.
array
ElectricalSourceManagerURIs (URI) The URIs of the management interfaces for the upstream
read-write
(v1.18+) [ ] (string, electrical source connections for this chassis.
null)
array
ElectricalSourceNames The names of the upstream electrical sources, such as circuits
(string, read-write
(v1.18+) [ ] or outlets, connected to this chassis.
null)
The ASHRAE Environmental Class for this chassis. For the
string read-write
EnvironmentalClass (v1.9+) possible property values, see EnvironmentalClass in Property
(enum) (null)
details.
EnvironmentMetrics (v1.15+) The link to the environment metrics for this chassis. See the
object
{ EnvironmentMetrics schema for details on this property.
Link to a EnvironmentMetrics resource. See the Links section
@odata.id string read-only
and the EnvironmentMetrics schema for details.
190 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The link to the collection of fabric adapters located in this
FabricAdapters (v1.20+) { object chassis that provide access to fabric-related resource pools.
Contains a link to a resource.
Link to Collection of FabricAdapter. See the FabricAdapter
@odata.id string read-only
schema for details.
number read-only
HeightMm (v1.4+) The height of the chassis.
(mm) (null)
read-only An indication of whether this component can be inserted or
HotPluggable (v1.21+) boolean
(null) removed while the equipment is in operation.
The state of the indicator LED, which identifies the chassis. For
IndicatorLED (deprecated string read-write the possible property values, see IndicatorLED in Property
v1.14) (enum) (null) details. Deprecated in v1.14 and later. This property has been
deprecated in favor of the LocationIndicatorActive property.
Links { object The links to other resources that are related to this resource.
Cables (v1.17+) [ { array An array of links to the cables connected to this chassis.
Link to a Cable resource. See the Links section and the Cable
@odata.id string read-only
schema for details.
}]
An array of links to the computer systems that this chassis
ComputerSystems [ { array
directly and wholly contains.
Link to a ComputerSystem resource. See the Links section and
@odata.id string read-only
the ComputerSystem schema for details.
}]
ConnectedCoolingLoops
array An array of links to cooling loops connected to this chassis.
(v1.23+) [ {
Link to a CoolingLoop resource. See the Links section and the
@odata.id string read-write
CoolingLoop schema for details.
}]
ContainedBy { object The link to the chassis that contains this chassis.
@odata.id string read-write Link to another Chassis resource.
Version 2023.1 Published 191
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Contains [ { array An array of links to any other chassis that this chassis has in it.
@odata.id string read-write Link to another Chassis resource.
}]
An array of links to resources or objects that cool this chassis.
Normally, the link is for either a chassis or a specific set of fans.
CooledBy (deprecated
array Deprecated in v1.20 and later. This property has been
v1.20) [ {
deprecated in favor of the Fans link property, and details
provided in the ThermalSubsystem resource.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
An arrays of links to cooling unit functionality contained in this
CoolingUnits (v1.23+) [ { array
chassis.
Link to a CoolingUnit resource. See the Links section and the
@odata.id string read-write
CoolingUnit schema for details.
}]
Drives (v1.2+) [ { array An array of links to the drives located in this chassis.
Link to a Drive resource. See the Links section and the Drive
@odata.id string read-only
schema for details.
}]
The link to the facility that contains this chassis. See the Facility
Facility (v1.11+) { object
schema for details on this property.
Link to a Facility resource. See the Links section and the Facility
@odata.id string read-write
schema for details.
Fans (v1.20+) [ { array An array of links to the fans that cool this chassis.
Link to a Fan resource. See the Links section and the Fan
@odata.id string read-only
schema for details.
}]
An array of links to the managers responsible for managing this
ManagedBy [ { array
chassis.
192 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to a Manager resource. See the Links section and the
@odata.id string read-only
Manager schema for details.
}]
ManagersInChassis
array An array of links to the managers located in this chassis.
(v1.2+) [ {
Link to a Manager resource. See the Links section and the
@odata.id string read-only
Manager schema for details.
}]
See the Oem object definition in the Common properties
Oem {} object
section.
An array of links to the PCIe devices located in this chassis.
PCIeDevices (v1.4+, Deprecated in v1.10 and later. This property has been
array
deprecated v1.10 [ { deprecated in favor of the PCIeDevices resource collection in the
root of this resource.
Link to a PCIeDevice resource. See the Links section and the
@odata.id string read-only
PCIeDevice schema for details.
}]
A link to power distribution functionality contained in this
PowerDistribution
object chassis. See the PowerDistribution schema for details on this
(v1.20+) { (null)
property.
Link to a PowerDistribution resource. See the Links section and
@odata.id string read-only
the PowerDistribution schema for details.
An array of links to resources or objects that power this chassis.
Normally, the link is for either a chassis or a specific set of
PoweredBy (deprecated power supplies. Deprecated in v1.20 and later. This property has
array
v1.20) [ { been deprecated in favor of the PowerOutlets and
PowerSupplies link properties, and details provided in the
PowerSubsystem resource.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
An array of links to the outlets that provide power to this
PowerOutlets (v1.18+) [ { array
chassis.
Version 2023.1 Published 193
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to a Outlet resource. See the Links section and the Outlet
@odata.id string read-write
schema for details.
}]
PowerSupplies (v1.20+) [ An array of links to the power supplies that provide power to this
array
{ chassis.
Link to a PowerSupply resource. See the Links section and the
@odata.id string read-only
PowerSupply schema for details.
}]
Processors (v1.9+) [ { array An array of links to the processors located in this chassis.
Link to a Processor resource. See the Links section and the
@odata.id string read-only
Processor schema for details.
}]
ResourceBlocks (v1.5+) [ { array An array of links to the resource blocks located in this chassis.
Link to a ResourceBlock resource. See the Links section and the
@odata.id string read-only
ResourceBlock schema for details.
}]
An array of links to the storage subsystems connected to or
Storage (v1.2+) [ { array
inside this chassis.
Link to a Storage resource. See the Links section and the
@odata.id string read-only
Storage schema for details.
}]
Switches (v1.7+) [ { array An array of links to the switches located in this chassis.
Link to a Switch resource. See the Links section and the Switch
@odata.id string read-only
schema for details.
}]
Location (v1.2+) {} object The location of the chassis. For property details, see Location.
LocationIndicatorActive read-write An indicator allowing an operator to physically locate this
boolean
(v1.14+) (null) resource.
The link to the logs for this chassis. Contains a link to a
LogServices { object
resource.
194 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to Collection of LogService. See the LogService schema for
@odata.id string read-only
details.
read-only
Manufacturer string The manufacturer of this chassis.
(null)
number read-only
MaxPowerWatts (v1.12+) The upper bound of the total power consumed by the chassis.
(Watts) (null)
An array of DSP0274-defined measurement blocks. Deprecated
Measurements (v1.15+,
array in v1.19 and later. This property has been deprecated in favor of
deprecated v1.19 [ {
the ComponentIntegrity resource.
Link to a MeasurementBlock resource. See the Links section and
@odata.id string read-only
the SoftwareInventory schema for details.
}]
The link to the collection of media controllers located in this
MediaControllers (v1.11+, chassis. Contains a link to a resource. Deprecated in v1.20 and
object
deprecated v1.20 { later. This property has been deprecated in favor of
FabricAdapters.
Link to Collection of MediaController. See the MediaController
@odata.id string read-only
schema for details.
The link to the collection of memory located in this chassis that
Memory (v1.11+) { object belong to fabric-related resource pools. Contains a link to a
resource.
Link to Collection of Memory. See the Memory schema for
@odata.id string read-only
details.
The link to the collection of memory domains located in this
MemoryDomains (v1.11+) { object chassis that belong to fabric-related resource pools. Contains a
link to a resource.
Link to Collection of MemoryDomain. See the MemoryDomain
@odata.id string read-only
schema for details.
number read-only
MinPowerWatts (v1.12+) The lower bound of the total power consumed by the chassis.
(Watts) (null)
Version 2023.1 Published 195
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
Model string The model number of the chassis.
(null)
The link to the collection of network adapters associated with
NetworkAdapters (v1.4+) { object
this chassis. Contains a link to a resource.
Link to Collection of NetworkAdapter. See the NetworkAdapter
@odata.id string read-only
schema for details.
read-only
PartNumber string The part number of the chassis.
(null)
The link to the collection of PCIe devices located in this chassis.
PCIeDevices (v1.10+) { object
Contains a link to a resource.
Link to Collection of PCIeDevice. See the PCIeDevice schema for
@odata.id string read-only
details.
The link to the PCIe slot properties for this chassis. See the
PCIeSlots (v1.8+) { object
PCIeSlots schema for details on this property.
Link to a PCIeSlots resource. See the Links section and the
@odata.id string read-only
PCIeSlots schema for details.
PhysicalSecurity (v1.1+) { object The physical security state of the chassis.
The physical security state of the chassis, such as if hardware
string read-write
IntrusionSensor (v1.1+) intrusion is detected. For the possible property values, see
(enum) (null)
IntrusionSensor in Property details.
A numerical identifier to represent the physical security sensor.
IntrusionSensorNumber read-only Deprecated in v1.22 and later. This property has been
integer
(v1.1+, deprecated v1.22 (null) deprecated in order to allow for multiple physical sensors to
construct this object.
The policy that describes how the physical security state of the
IntrusionSensorReArm string read-only
chassis returns to a normal state. For the possible property
(v1.1+) (enum) (null)
values, see IntrusionSensorReArm in Property details.
196 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The link to the power properties, or power supplies, power
policies, and sensors, for this chassis. See the Power schema for
Power (deprecated v1.15) { object details on this property. Deprecated in v1.15 and later. This link
has been deprecated in favor of the PowerSubsystem link
property.
Link to a Power resource. See the Links section and the Power
@odata.id string read-only
schema for details.
read-only Indicates that the chassis receives power from the containing
PoweredByParent (v1.20+) boolean
(null) chassis.
string read-only The current power state of the chassis. For the possible property
PowerState (v1.0.1+)
(enum) (null) values, see PowerState in Property details.
The link to the power subsystem properties for this chassis. See
PowerSubsystem (v1.15+) { object
the PowerSubsystem schema for details on this property.
Link to a PowerSubsystem resource. See the Links section and
@odata.id string read-only
the PowerSubsystem schema for details.
The link to the collection of processors located in this chassis
Processors (v1.22+) { object that belong to fabric-related resource pools. Contains a link to a
resource.
Link to Collection of Processor. See the Processor schema for
@odata.id string read-only
details.
read-only An indication of whether this component can be independently
Replaceable (v1.21+) boolean
(null) replaced as allowed by the vendor's replacement policy.
The link to the collection of sensors located in the equipment
Sensors (v1.9+) { object
and sub-components. Contains a link to a resource.
@odata.id string read-only Link to Collection of Sensor. See the Sensor schema for details.
read-only
SerialNumber string The serial number of the chassis.
(null)
read-only
SKU string The SKU of the chassis.
(null)
Version 2023.1 Published 197
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
SparePartNumber (v1.16+) string The spare part number of the chassis.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
The link to the thermal properties, such as fans, cooling, and
sensors, for this chassis. See the Thermal schema for details on
Thermal (deprecated v1.15) { object
this property. Deprecated in v1.15 and later. This link has been
deprecated in favor of the ThermalSubsystem link property.
Link to a Thermal resource. See the Links section and the
@odata.id string read-only
Thermal schema for details.
Indicates the thermal management path through the chassis.
string read-only
ThermalDirection (v1.20+) For the possible property values, see ThermalDirection in
(enum) (null)
Property details.
ThermalManagedByParent read-only Indicates that the chassis is thermally managed by the parent
boolean
(v1.20+) (null) chassis.
The link to the thermal subsystem properties for this chassis.
ThermalSubsystem (v1.15+) { object
See the ThermalSubsystem schema for details on this property.
Link to a ThermalSubsystem resource. See the Links section and
@odata.id string read-only
the ThermalSubsystem schema for details.
TrustedComponents (v1.21+) The link to the trusted components in this chassis. Contains a
object
{ link to a resource.
Link to Collection of TrustedComponent. See the
@odata.id string read-only
TrustedComponent schema for details.
string read-only
UUID (v1.7+) The UUID for this chassis.
(uuid) (null)
read-only
Version (v1.21+) string The hardware version of this chassis.
(null)
number read-only
WeightKg (v1.4+) The weight of the chassis.
(kg) (null)
number read-only
WidthMm (v1.4+) The width of the chassis.
(mm) (null)
198 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.19.4 Actions
6.19.4.1 Reset
Description
This action resets the chassis. Additionally, it could reset systems or other contained resources
depending on the ResetType used to invoke this action.
Action URI
{Base URI of target resource}/Actions/Chassis.Reset
Action parameters
Parameter
Type Attributes Notes
Name
string The type of reset. For the possible property values, see ResetType in Property
ResetType optional
(enum) details.
Request Example
{
"ResetType": "ForceRestart"
}
6.19.5 Property details
6.19.5.1 ChassisType
The type of physical form factor of the chassis.
string Description
An enclosed or semi-enclosed, typically vertically-oriented, system chassis that must be
Blade
plugged into a multi-system chassis to function normally.
Card A loose device or circuit board intended to be installed in a system or other enclosure.
Cartridge A small self-contained system intended to be plugged into a multi-system chassis.
Version 2023.1 Published 199
Redfish Resource and Schema Guide DSP2046
string Description
Component A small chassis, card, or device that contains devices for a particular subsystem or function.
An enclosed or semi-enclosed, typically horizontally-oriented, system chassis that can be slid
Drawer
into a multi-system chassis.
Enclosure A generic term for a chassis that does not fit any other description.
Expansion A chassis that expands the capabilities or capacity of another chassis.
HeatExchanger (v1.23+) A heat exchanger.
ImmersionTank (v1.23+) An immersion cooling tank.
IPBasedDrive (v1.3+) A chassis in a drive form factor with IP-based network connections.
A small, typically removable, chassis or card that contains devices for a particular subsystem
Module
or function.
Other A chassis that does not fit any of these definitions.
Pod A collection of equipment racks in a large, likely transportable, container.
Rack An equipment rack, typically a 19-inch wide freestanding unit.
RackGroup (v1.4+) A group of racks that form a single entity or share infrastructure.
RackMount A single-system chassis designed specifically for mounting in an equipment rack.
Row A collection of equipment racks.
An enclosed or semi-enclosed, typically horizontally-oriented, system chassis that must be
Shelf
plugged into a multi-system chassis to function normally.
Sidecar A chassis that mates mechanically with another chassis to expand its capabilities or capacity.
An enclosed or semi-enclosed, system chassis that must be plugged into a multi-system
Sled
chassis to function normally similar to a blade type chassis.
StandAlone A single, free-standing system, commonly called a tower or desktop chassis.
StorageEnclosure (v1.6+) A chassis that encloses storage.
A logical division or portion of a physical chassis that contains multiple devices or systems
Zone
that cannot be physically separated.
6.19.5.2 EnvironmentalClass
The ASHRAE Environmental Class for this chassis.
200 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
A1 ASHRAE Environmental Class 'A1'.
A2 ASHRAE Environmental Class 'A2'.
A3 ASHRAE Environmental Class 'A3'.
A4 ASHRAE Environmental Class 'A4'.
6.19.5.3 IndicatorLED
The state of the indicator LED, which identifies the chassis.
string Description
Blinking The indicator LED is blinking.
Lit The indicator LED is lit.
Off The indicator LED is off.
Unknown (deprecated The state of the indicator LED cannot be determined. Deprecated in v1.2 and later. This value
v1.2) has been deprecated in favor of returning null if the state is unknown.
6.19.5.4 IntrusionSensor
The physical security state of the chassis, such as if hardware intrusion is detected.
string Description
A door, lock, or other mechanism protecting the internal system hardware from being
HardwareIntrusion
accessed is detected to be in an insecure state.
Normal No physical security condition is detected at this time.
TamperingDetected Physical tampering of the monitored entity is detected.
6.19.5.5 IntrusionSensorReArm
The policy that describes how the physical security state of the chassis returns to a normal state.
Version 2023.1 Published 201
Redfish Resource and Schema Guide DSP2046
string Description
The sensor is automatically restored to the normal state when no security condition is
Automatic
detected.
Manual A user is required to clear the sensor to restore it to the normal state.
6.19.5.6 PowerState
The current power state of the chassis.
string Description
The resource is powered off. The components within the resource might continue to have
Off
AUX power.
On The resource is powered on.
Paused The resource is paused.
A temporary state between on and off. The components within the resource can take time to
PoweringOff
process the power off action.
A temporary state between off and on. The components within the resource can take time to
PoweringOn
process the power on action.
6.19.5.7 ResetType
The type of reset.
string Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
ForceOn Turn on the unit immediately.
ForceRestart Shut down immediately and non-gracefully and restart the system.
GracefulRestart Shut down gracefully and restart the system.
GracefulShutdown Shut down gracefully and power off.
Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal
Nmi
operations, complete diagnostic actions, and, typically, halt the system.
On Turn on the unit.
202 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Pause execution on the unit but do not remove power. This is typically a feature of virtual
Pause
machine hypervisors.
Power cycle the unit. Behaves like a full power removal, followed by a power restore to the
PowerCycle
resource.
PushPowerButton Simulate the pressing of the physical power button on this unit.
Resume execution on the paused unit. This is typically a feature of virtual machine
Resume
hypervisors.
Write the state of the unit to disk before powering off. This allows for the state to be restored
Suspend
when powered back on.
6.19.5.8 ThermalDirection
Indicates the thermal management path through the chassis.
string Description
BackToFront A chassis with the air intake in the back and exhaust out the front.
FrontToBack A chassis with the air intake in the front and exhaust out the back.
Sealed A sealed chassis with no air pathway.
TopExhaust A chassis with air exhaust on the top.
6.19.6 Example response
{
"@odata.type": "#Chassis.v1_23_0.Chassis",
"Id": "1U",
"Name": "Computer System Chassis",
"ChassisType": "RackMount",
"AssetTag": "Chicago-45Z-2381",
"Manufacturer": "Contoso",
"Model": "3500RX",
"SKU": "8675309",
"SerialNumber": "437XR1138R2",
"PartNumber": "224071-J23",
"PowerState": "On",
"LocationIndicatorActive": true,
"Location": {
Version 2023.1 Published 203
Redfish Resource and Schema Guide DSP2046
"Placement": {
"Row": "North",
"Rack": "WEB43",
"RackOffsetUnits": "EIA_310",
"RackOffset": 12
}
},
"Status": {
"State": "Enabled",
"Health": "OK"
},
"HeightMm": 44.45,
"WidthMm": 431.8,
"DepthMm": 711,
"WeightKg": 15.31,
"EnvironmentalClass": "A3",
"Sensors": {
"@odata.id": "/redfish/v1/Chassis/1U/Sensors"
},
"PowerSubsystem": {
"@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem"
},
"ThermalSubsystem": {
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem"
},
"EnvironmentMetrics": {
"@odata.id": "/redfish/v1/Chassis/1U/EnvironmentMetrics"
},
"Links": {
"ComputerSystems": [
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2"
}
],
"ManagedBy": [
{
"@odata.id": "/redfish/v1/Managers/BMC"
}
],
"ManagersInChassis": [
{
"@odata.id": "/redfish/v1/Managers/BMC"
}
]
},
"@odata.id": "/redfish/v1/Chassis/1U"
}
204 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.20 Circuit 1.7.0
Version v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.2 2022.1 2021.4 2021.3 2021.2 2020.4 2020.3 2019.4
6.20.1 Description
This is the schema definition for an electrical circuit.
6.20.2 URIs
/redfish/v1/PowerEquipment/ElectricalBuses/{PowerDistributionId}/Branches/{CircuitId}
/redfish/v1/PowerEquipment/ElectricalBuses/{PowerDistributionId}/Mains/{CircuitId}
/redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}/Branches/{CircuitId}
/redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}/Mains/{CircuitId}
/redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}/Subfeeds/{CircuitId}
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/Branches/{CircuitId}
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/Mains/{CircuitId}
/redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Branches/{CircuitId}
/redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Mains/{CircuitId}
/redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}/Branches/{CircuitId}
/redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}/Feeders/{CircuitId}
/redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}/Mains/{CircuitId}
/redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}/Subfeeds/{CircuitId}
/redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Branches/{CircuitId}
/redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Feeders/{CircuitId}
/redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Mains/{CircuitId}
6.20.3 Properties
Property Type Attributes Notes
string read-only The state of the over current protection device. For the possible
BreakerState
(enum) (null) property values, see BreakerState in Property details.
string read-only The type of circuit. For the possible property values, see
CircuitType
(enum) (null) CircuitType in Property details.
ConfigurationLocked (v1.5+) boolean read-write Indicates whether the configuration is locked.
Version 2023.1 Published 205
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-write
CriticalCircuit boolean Designates if this is a critical circuit.
(null)
The current (A) for this single phase circuit. For more information
CurrentAmps {} object about this property, see SensorCurrentExcerpt in Property
Details.
array
ElectricalConsumerNames An array of names of downstream devices that are powered by
(string, read-write
(v1.4+) [ ] this circuit.
null)
string read-only The combination of current-carrying conductors. For the possible
ElectricalContext
(enum) (null) property values, see ElectricalContext in Property details.
ElectricalSourceManagerURI string The URI of the management interface for the upstream electrical
read-write
(v1.4+) (URI) source connection for this circuit.
ElectricalSourceName The name of the upstream electrical source, such as a circuit or
string read-write
(v1.4+) outlet, connected to this circuit.
The energy (kWh) for this circuit. For more information about this
EnergykWh {} object
property, see SensorEnergykWhExcerpt in Property Details.
The frequency (Hz) for this circuit. For more information about
FrequencyHz {} object
this property, see SensorExcerpt in Property Details.
The state of the indicator LED, which identifies the circuit. For the
IndicatorLED (deprecated string read-write possible property values, see IndicatorLED in Property details.
v1.1) (enum) (null) Deprecated in v1.1 and later. This property has been deprecated
in favor of the LocationIndicatorActive property.
Links { object The links to other resources that are related to this resource.
BranchCircuit { object A reference to the branch circuit related to this circuit.
(null)
@odata.id string read-only Link to another Circuit resource.
DistributionCircuits
array An array of links to the circuits powered by this circuit.
(v1.4+) [ {
@odata.id string read-write Link to another Circuit resource.
}]
Oem {} object See the Oem object definition in the Common properties section.
Outlets [ { array An array of references to the outlets contained by this circuit.
206 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to a Outlet resource. See the Links section and the Outlet
@odata.id string read-only
schema for details.
}]
A link to the power outlet that provides power to this circuit. See
PowerOutlet (v1.4+) { object
(null) the Outlet schema for details on this property.
Link to a Outlet resource. See the Links section and the Outlet
@odata.id string read-write
schema for details.
SourceCircuit (v1.4+) { object A link to the circuit that provides power to this circuit.
(null)
@odata.id string read-write Link to another Circuit resource.
LocationIndicatorActive read-write An indicator allowing an operator to physically locate this
boolean
(v1.1+) (null) resource.
string read-only The nominal voltage for this circuit. For the possible property
NominalVoltage
(enum) (null) values, see NominalVoltage in Property details.
The number of ungrounded current-carrying conductors (phases)
string read-only
PhaseWiringType and the total number of conductors (wires). For the possible
(enum) (null)
property values, see PhaseWiringType in Property details.
string read-only The type of plug according to NEMA, IEC, or regional standards.
PlugType
(enum) (null) For the possible property values, see PlugType in Property details.
PolyPhaseCurrentAmps { object The current readings for this circuit.
(null)
Line 1 current (A). For more information about this property, see
Line1 {} object
SensorCurrentExcerpt in Property Details.
Line 2 current (A). For more information about this property, see
Line2 {} object
SensorCurrentExcerpt in Property Details.
Line 3 current (A). For more information about this property, see
Line3 {} object
SensorCurrentExcerpt in Property Details.
Neutral line current (A). For more information about this property,
Neutral {} object
see SensorCurrentExcerpt in Property Details.
Version 2023.1 Published 207
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
PolyPhaseEnergykWh { object The energy readings for this circuit.
(null)
The Line 1 to Line 2 energy (kWh) for this circuit. For more
Line1ToLine2 {} object information about this property, see SensorEnergykWhExcerpt in
Property Details.
The Line 1 to Neutral energy (kWh) for this circuit. For more
Line1ToNeutral {} object information about this property, see SensorEnergykWhExcerpt in
Property Details.
The Line 2 to Line 3 energy (kWh) for this circuit. For more
Line2ToLine3 {} object information about this property, see SensorEnergykWhExcerpt in
Property Details.
The Line 2 to Neutral energy (kWh) for this circuit. For more
Line2ToNeutral {} object information about this property, see SensorEnergykWhExcerpt in
Property Details.
The Line 3 to Line 1 energy (kWh) for this circuit. For more
Line3ToLine1 {} object information about this property, see SensorEnergykWhExcerpt in
Property Details.
The Line 3 to Neutral energy (kWh) for this circuit. For more
Line3ToNeutral {} object information about this property, see SensorEnergykWhExcerpt in
Property Details.
PolyPhasePowerWatts { object The power readings for this circuit.
(null)
The Line 1 to Line 2 power (W) for this circuit. For more
Line1ToLine2 {} object information about this property, see SensorPowerExcerpt in
Property Details.
The Line 1 to Neutral power (W) for this circuit. For more
Line1ToNeutral {} object information about this property, see SensorPowerExcerpt in
Property Details.
The Line 2 to Line 3 power (W) for this circuit. For more
Line2ToLine3 {} object information about this property, see SensorPowerExcerpt in
Property Details.
The Line 2 to Neutral power (W) for this circuit. For more
Line2ToNeutral {} object information about this property, see SensorPowerExcerpt in
Property Details.
The Line 3 to Line 1 power (W) for this circuit. For more
Line3ToLine1 {} object information about this property, see SensorPowerExcerpt in
Property Details.
208 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The Line 3 to Neutral power (W) for this circuit. For more
Line3ToNeutral {} object information about this property, see SensorPowerExcerpt in
Property Details.
PolyPhaseVoltage { object The voltage readings for this circuit.
(null)
The Line 1 to Line 2 voltage (V) for this circuit. For more
Line1ToLine2 {} object information about this property, see SensorVoltageExcerpt in
Property Details.
The Line 1 to Neutral voltage (V) for this circuit. For more
Line1ToNeutral {} object information about this property, see SensorVoltageExcerpt in
Property Details.
The Line 2 to Line 3 voltage (V) for this circuit. For more
Line2ToLine3 {} object information about this property, see SensorVoltageExcerpt in
Property Details.
The Line 2 to Neutral voltage (V) for this circuit. For more
Line2ToNeutral {} object information about this property, see SensorVoltageExcerpt in
Property Details.
The Line 3 to Line 1 voltage (V) for this circuit. For more
Line3ToLine1 {} object information about this property, see SensorVoltageExcerpt in
Property Details.
The Line 3 to Neutral voltage (V) for this circuit. For more
Line3ToNeutral {} object information about this property, see SensorVoltageExcerpt in
Property Details.
PowerControlLocked (v1.5+) boolean read-write Indicates whether power control requests are locked.
read-write The number of seconds to delay power on after a PowerControl
PowerCycleDelaySeconds number
(null) action to cycle power. Zero seconds indicates no delay.
read-only
PowerEnabled boolean Indicates if the circuit can be powered.
(null)
PowerLoadPercent (v1.3+) The power load (percent) for this circuit. For more information
object
{} about this property, see SensorExcerpt in Property Details.
read-write The number of seconds to delay power off after a PowerControl
PowerOffDelaySeconds number
(null) action. Zero seconds indicates no delay to power off.
Version 2023.1 Published 209
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The number of seconds to delay power up after a power cycle or
read-write
PowerOnDelaySeconds number a PowerControl action. Zero seconds indicates no delay to power
(null)
up.
read-write The number of seconds to delay power on after power has been
PowerRestoreDelaySeconds number
(null) restored. Zero seconds indicates no delay.
The desired power state of the circuit when power is restored
string
PowerRestorePolicy read-write after a power loss. For the possible property values, see
(enum)
PowerRestorePolicy in Property details.
string read-only The power state of the circuit. For the possible property values,
PowerState
(enum) (null) see PowerState in Property details.
PowerStateInTransition Indicates whether the power state is undergoing a delayed
boolean read-only
(v1.5+) transition.
The power (W) for this circuit. For more information about this
PowerWatts {} object
property, see SensorPowerExcerpt in Property Details.
number read-only
RatedCurrentAmps The rated maximum current allowed for this circuit.
(A) (null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
The current imbalance (percent) between phases. For more
UnbalancedCurrentPercent
object information about this property, see SensorExcerpt in Property
(v1.5+) {}
Details.
The voltage imbalance (percent) between phases. For more
UnbalancedVoltagePercent
object information about this property, see SensorExcerpt in Property
(v1.5+) {}
Details.
UserLabel (v1.4+) string read-write A user-assigned label.
The voltage (V) for this single phase circuit. For more information
Voltage {} object about this property, see SensorVoltageExcerpt in Property
Details.
string read-only The type of voltage applied to the circuit. For the possible
VoltageType
(enum) (null) property values, see VoltageType in Property details.
6.20.4 Actions
6.20.4.1 BreakerControl
Description
210 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
This action attempts to reset the circuit breaker.
Action URI
{Base URI of target resource}/Actions/Circuit.BreakerControl
Action parameters
Parameter
Type Attributes Notes
Name
string The desired power state of the circuit if the breaker is reset successfully. For
PowerState optional
(enum) the possible property values, see PowerState in Property details.
Request Example
{
"PowerState": "On"
}
6.20.4.2 PowerControl
Description
This action turns the circuit on or off.
Action URI
{Base URI of target resource}/Actions/Circuit.PowerControl
Action parameters
Parameter
Type Attributes Notes
Name
string The desired power state of the circuit. For the possible property values, see
PowerState optional
(enum) PowerState in Property details.
Request Example
Version 2023.1 Published 211
Redfish Resource and Schema Guide DSP2046
"PowerState": "Off"
}
6.20.4.3 ResetMetrics
Description
This action resets metrics related to this circuit.
Action URI
{Base URI of target resource}/Actions/Circuit.ResetMetrics
Action parameters
This action takes no parameters.
6.20.5 Property details
6.20.5.1 BreakerState
The state of the over current protection device.
string Description
Normal The breaker is powered on.
Off The breaker is off.
Tripped The breaker has been tripped.
6.20.5.2 CircuitType
The type of circuit.
string Description
Branch A branch (output) circuit.
Bus (v1.3+) An electrical bus circuit.
Feeder A feeder (output) circuit.
212 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Mains A mains input or utility circuit.
Subfeed A subfeed (output) circuit.
6.20.5.3 ElectricalContext
The combination of current-carrying conductors.
string Description
Line1 The circuits that share the L1 current-carrying conductor.
Line1ToLine2 The circuit formed by L1 and L2 current-carrying conductors.
Line1ToNeutral The circuit formed by L1 and neutral current-carrying conductors.
Line1ToNeutralAndL1L2 The circuit formed by L1, L2, and neutral current-carrying conductors.
Line2 The circuits that share the L2 current-carrying conductor.
Line2ToLine3 The circuit formed by L2 and L3 current-carrying conductors.
Line2ToNeutral The circuit formed by L2 and neutral current-carrying conductors.
Line2ToNeutralAndL1L2 The circuit formed by L1, L2, and Neutral current-carrying conductors.
Line2ToNeutralAndL2L3 The circuits formed by L2, L3, and neutral current-carrying conductors.
Line3 The circuits that share the L3 current-carrying conductor.
Line3ToLine1 The circuit formed by L3 and L1 current-carrying conductors.
Line3ToNeutral The circuit formed by L3 and neutral current-carrying conductors.
Line3ToNeutralAndL3L1 The circuit formed by L3, L1, and neutral current-carrying conductors.
LineToLine The circuit formed by two current-carrying conductors.
LineToNeutral The circuit formed by a line and neutral current-carrying conductor.
Neutral The grounded current-carrying return circuit of current-carrying conductors.
Total The circuit formed by all current-carrying conductors.
6.20.5.4 IndicatorLED
The state of the indicator LED, which identifies the circuit.
Version 2023.1 Published 213
Redfish Resource and Schema Guide DSP2046
string Description
Blinking The indicator LED is blinking.
Lit The indicator LED is lit.
Off The indicator LED is off.
6.20.5.5 NominalVoltage
The nominal voltage for this circuit.
string Description
AC100To127V (v1.6+) AC 100-127V nominal.
AC100To240V AC 100-240V nominal.
AC100To277V AC 100-277V nominal.
AC120V AC 120V nominal.
AC200To240V AC 200-240V nominal.
AC200To277V AC 200-277V nominal.
AC208V AC 208V nominal.
AC230V AC 230V nominal.
AC240AndDC380V AC 200-240V and DC 380V.
AC240V AC 240V nominal.
AC277AndDC380V AC 200-277V and DC 380V.
AC277V AC 277V nominal.
AC400V AC 400V or 415V nominal.
AC480V AC 480V nominal.
DC12V (v1.7+) DC 12V nominal.
DC16V (v1.7+) DC 16V nominal.
DC1_8V (v1.7+) DC 1.8V nominal.
DC240V DC 240V nominal.
DC380V High Voltage DC (380V).
214 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
DC3_3V (v1.7+) DC 3.3V nominal.
DC48V (v1.2+) DC 48V nominal.
DC5V (v1.7+) DC 5V nominal.
DC9V (v1.7+) DC 9V nominal.
DCNeg48V -48V DC.
6.20.5.6 PhaseWiringType
The number of ungrounded current-carrying conductors (phases) and the total number of conductors
(wires).
string Description
OneOrTwoPhase3Wire Single or Two-Phase / 3-Wire (Line1, Line2 or Neutral, Protective Earth).
OnePhase3Wire Single-phase / 3-Wire (Line1, Neutral, Protective Earth).
ThreePhase4Wire Three-phase / 4-Wire (Line1, Line2, Line3, Protective Earth).
ThreePhase5Wire Three-phase / 5-Wire (Line1, Line2, Line3, Neutral, Protective Earth).
TwoPhase3Wire Two-phase / 3-Wire (Line1, Line2, Protective Earth).
TwoPhase4Wire Two-phase / 4-Wire (Line1, Line2, Neutral, Protective Earth).
6.20.5.7 PlugType
The type of plug according to NEMA, IEC, or regional standards.
string Description
California_CS8265 California Standard CS8265 (Single-phase 250V; 50A; 2P3W).
California_CS8365 California Standard CS8365 (Three-phase 250V; 50A; 3P4W).
Field_208V_3P4W_60A Field-wired; Three-phase 200-250V; 60A; 3P4W.
Field_400V_3P5W_32A Field-wired; Three-phase 200-240/346-415V; 32A; 3P5W.
IEC_60309_316P6 IEC 60309 316P6 (Single-phase 200-250V; 16A; 1P3W; Blue, 6-hour).
Version 2023.1 Published 215
Redfish Resource and Schema Guide DSP2046
string Description
IEC_60309_332P6 IEC 60309 332P6 (Single-phase 200-250V; 32A; 1P3W; Blue, 6-hour).
IEC_60309_363P6 IEC 60309 363P6 (Single-phase 200-250V; 63A; 1P3W; Blue, 6-hour).
IEC_60309_460P9 IEC 60309 460P9 (Three-phase 200-250V; 60A; 3P4W; Blue; 9-hour).
IEC_60309_516P6 IEC 60309 516P6 (Three-phase 200-240/346-415V; 16A; 3P5W; Red; 6-hour).
IEC_60309_532P6 IEC 60309 532P6 (Three-phase 200-240/346-415V; 32A; 3P5W; Red; 6-hour).
IEC_60309_560P9 IEC 60309 560P9 (Three-phase 120-144/208-250V; 60A; 3P5W; Blue; 9-hour).
IEC_60309_563P6 IEC 60309 563P6 (Three-phase 200-240/346-415V; 63A; 3P5W; Red; 6-hour).
IEC_60320_C14 IEC C14 (Single-phase 250V; 10A; 1P3W).
IEC_60320_C20 IEC C20 (Single-phase 250V; 16A; 1P3W).
NEMA_5_15P NEMA 5-15P (Single-phase 125V; 15A; 1P3W).
NEMA_5_20P NEMA 5-20P (Single-phase 125V; 20A; 1P3W).
NEMA_6_15P NEMA 6-15P (Single-phase 250V; 15A; 2P3W).
NEMA_6_20P NEMA 6-20P (Single-phase 250V; 20A; 2P3W).
NEMA_L14_20P NEMA L14-20P (Split-phase 125/250V; 20A; 2P4W).
NEMA_L14_30P NEMA L14-30P (Split-phase 125/250V; 30A; 2P4W).
NEMA_L15_20P NEMA L15-20P (Three-phase 250V; 20A; 3P4W).
NEMA_L15_30P NEMA L15-30P (Three-phase 250V; 30A; 3P4W).
NEMA_L21_20P NEMA L21-20P (Three-phase 120/208V; 20A; 3P5W).
NEMA_L21_30P NEMA L21-30P (Three-phase 120/208V; 30A; 3P5W).
NEMA_L22_20P NEMA L22-20P (Three-phase 277/480V; 20A; 3P5W).
NEMA_L22_30P NEMA L22-30P (Three-phase 277/480V; 30A; 3P5W).
NEMA_L5_15P NEMA L5-15P (Single-phase 125V; 15A; 1P3W).
NEMA_L5_20P NEMA L5-20P (Single-phase 125V; 20A; 1P3W).
NEMA_L5_30P NEMA L5-30P (Single-phase 125V; 30A; 1P3W).
NEMA_L6_15P NEMA L6-15P (Single-phase 250V; 15A; 2P3W).
NEMA_L6_20P NEMA L6-20P (Single-phase 250V; 20A; 2P3W).
216 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
NEMA_L6_30P NEMA L6-30P (Single-phase 250V; 30A; 2P3W).
6.20.5.8 PowerRestorePolicy
The desired power state of the circuit when power is restored after a power loss.
string Description
AlwaysOff Always remain powered off when external power is applied.
AlwaysOn Always power on when external power is applied.
LastState Return to the last power state (on or off) when external power is applied.
6.20.5.9 PowerState
6.20.5.9.1 In top level:
The power state of the circuit.
string Description
The resource is powered off. The components within the resource might continue to have
Off
AUX power.
On The resource is powered on.
Paused The resource is paused.
A temporary state between on and off. The components within the resource can take time to
PoweringOff
process the power off action.
A temporary state between off and on. The components within the resource can take time to
PoweringOn
process the power on action.
6.20.5.9.2 In Actions: BreakerControl, Actions: PowerControl:
The desired power state of the circuit if the breaker is reset successfully.
Version 2023.1 Published 217
Redfish Resource and Schema Guide DSP2046
string Description
Off Power off.
On Power on.
PowerCycle (v1.5+) Power cycle.
6.20.5.10 SensorCurrentExcerpt
The Sensor schema describes a sensor and its properties. This object is an excerpt of the Sensor
resource located at the URI shown in DataSourceUri.
read-
CrestFactor
number only The crest factor for this sensor.
(v1.1+)
(null)
read-
string
DataSourceUri only The link to the resource that provides the data for this sensor.
(URI)
(null)
read-
Reading number only The sensor value.
(null)
read-
THDPercent
number only The total harmonic distortion (THD).
(v1.1+)
(null)
6.20.5.11 SensorEnergykWhExcerpt
The Sensor schema describes a sensor and its properties. This object is an excerpt of the Sensor
resource located at the URI shown in DataSourceUri.
read-
ApparentkVAh number
only Apparent energy (kVAh).
(v1.5+) (kV.A.h)
(null)
read-
string
DataSourceUri only The link to the resource that provides the data for this sensor.
(URI)
(null)
read-
LifetimeReading
number only The total accumulation value for this sensor.
(v1.1+)
(null)
218 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
read-
ReactivekVARh number
only Reactive energy (kVARh).
(v1.5+) (kV.A.h)
(null)
read-
Reading number only The sensor value.
(null)
string read-
SensorResetTime (date- only The date and time when the time-based properties were last reset.
time) (null)
6.20.5.12 SensorExcerpt
The Sensor schema describes a sensor and its properties. This object is an excerpt of the Sensor
resource located at the URI shown in DataSourceUri.
read-
string
DataSourceUri only The link to the resource that provides the data for this sensor.
(URI)
(null)
read-
Reading number only The sensor value.
(null)
6.20.5.13 SensorPowerExcerpt
The Sensor schema describes a sensor and its properties. This object is an excerpt of the Sensor
resource located at the URI shown in DataSourceUri.
read-
number
ApparentVA only The product of voltage and current for an AC circuit, in volt-ampere units.
(V.A)
(null)
read-
string
DataSourceUri only The link to the resource that provides the data for this sensor.
(URI)
(null)
read-
PhaseAngleDegrees
number only The phase angle (degrees) between the current and voltage waveforms.
(v1.5+)
(null)
read-
PowerFactor number only The power factor for this sensor.
(null)
Version 2023.1 Published 219
Redfish Resource and Schema Guide DSP2046
read-
number The square root of the difference term of squared apparent VA and squared power
ReactiveVAR only
(V.A) (Reading) for a circuit, in VAR units.
(null)
read-
Reading number only The sensor value.
(null)
6.20.5.14 SensorVoltageExcerpt
The Sensor schema describes a sensor and its properties. This object is an excerpt of the Sensor
resource located at the URI shown in DataSourceUri.
read-
CrestFactor
number only The crest factor for this sensor.
(v1.1+)
(null)
read-
string
DataSourceUri only The link to the resource that provides the data for this sensor.
(URI)
(null)
read-
Reading number only The sensor value.
(null)
read-
THDPercent
number only The total harmonic distortion (THD).
(v1.1+)
(null)
6.20.5.15 VoltageType
The type of voltage applied to the circuit.
string Description
AC Alternating Current (AC) circuit.
DC Direct Current (DC) circuit.
6.20.6 Example response
220 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"@odata.type": "#Circuit.v1_7_0.Circuit",
"Id": "A",
"Name": "Branch Circuit A",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"CircuitType": "Branch",
"PhaseWiringType": "TwoPhase3Wire",
"NominalVoltage": "AC200To240V",
"RatedCurrentAmps": 16,
"BreakerState": "Normal",
"PolyPhaseVoltage": {
"Line1ToNeutral": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/VoltageAL1N",
"Reading": 118.2
},
"Line1ToLine2": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/VoltageAL1L2",
"Reading": 203.5
}
},
"CurrentAmps": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/CurrentA",
"Reading": 5.19
},
"PolyPhaseCurrentAmps": {
"Line1": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/CurrentA",
"Reading": 5.19
}
},
"PowerWatts": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/PowerA",
"Reading": 937.4,
"ApparentVA": 937.4,
"ReactiveVAR": 0,
"PowerFactor": 1
},
"PolyPhasePowerWatts": {
"Line1ToNeutral": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/PowerA1",
"Reading": 937.4,
"PeakReading": 1000.5,
"ApparentVA": 937.4,
"ReactiveVAR": 0,
"PowerFactor": 1
}
},
"FrequencyHz": {
Version 2023.1 Published 221
Redfish Resource and Schema Guide DSP2046
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/FrequencyA",
"Reading": 60
},
"EnergykWh": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/EnergyA",
"Reading": 325675
},
"Links": {
"Outlets": [
{
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Outlets/A1"
},
{
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Outlets/A2"
},
{
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Outlets/A3"
}
]
},
"Actions": {
"#Circuit.BreakerControl": {
"target": "/redfish/v1/PowerEquipment/RackPDUs/1/Branches/A/Circuit.BreakerControl"
},
"#Outlet.ResetMetrics": {
"target": "/redfish/v1/PowerEquipment/RackPDUs/1/Branches/A/Circuit.ResetMetrics"
}
},
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Branches/A"
}
6.21 ComponentIntegrity 1.2.1
Version v1.2 v1.1 v1.0
Release 2022.2 2022.1 2021.4
6.21.1 Description
The ComponentIntegrity resource provides critical and pertinent security information about a specific
device, system, software element, or other managed entity.
222 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.21.2 URIs
/redfish/v1/ComponentIntegrity/{ComponentIntegrityId}
6.21.3 Properties
Property Type Attributes Notes
An indication of whether security protocols are
ComponentIntegrityEnabled boolean read-write
enabled for the component.
The type of security technology for the
string read-only
ComponentIntegrityType component. For the possible property values, see
(enum) required
ComponentIntegrityType in Property details.
read-only
ComponentIntegrityTypeVersion string The version of the security technology.
required
string
read-only The date and time when information for the
LastUpdated (date-
(null) component was last updated.
time)
The links to other resources that are related to
Links { object
this resource.
An array of links to resources that the target
ComponentsProtected [ { array
component protects.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
See the Oem object definition in the Common
Oem {} object
properties section.
Integrity information about the SPDM Responder
SPDM { object
as reported by an SPDM Requester.
Information about communication between the
ComponentCommunication { object
(null) SPDM Requester and SPDM Responder.
The active sessions or communication channels
Sessions [ { array
between two components.
Version 2023.1 Published 223
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The identifier for an active session or
read-only
SessionId integer communication channel between two
(null)
components.
The type of session or communication channel
string read-only between two components. For the possible
SessionType
(enum) (null) property values, see SessionType in Property
details.
}]
Identity authentication information about the
IdentityAuthentication { object
(null) SPDM Requester and SPDM Responder.
Authentication information of the identity of the
RequesterAuthentication { object
(null) SPDM Requester.
A link to the certificate that represents the
identify of the SPDM Requester provided in
ProvidedCertificate { object
mutual authentication. See the Certificate
schema for details on this property.
Link to a Certificate resource. See the Links
@odata.id string read-only
section and the Certificate schema for details.
Authentication information of the identity of the
ResponderAuthentication { object
(null) SPDM Responder.
A link to the certificate that represents the
ComponentCertificate { object identify of the component. See the Certificate
schema for details on this property.
Link to a Certificate resource. See the Links
@odata.id string read-only
section and the Certificate schema for details.
The status of the verification of the identity of the
string read-only
VerificationStatus component. For the possible property values, see
(enum) (null)
VerificationStatus in Property details.
224 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Measurement information about the SPDM
MeasurementSet { object
(null) Responder.
Measurements [ { array Measurements from an SPDM Responder.
string
read-only The date and time when information for the
LastUpdated (date-
(null) measurement was last updated.
time)
read-only
Measurement string The measurement data.
(null)
read-only The hash algorithm used to compute the
MeasurementHashAlgorithm string
(null) measurement.
read-only
MeasurementIndex integer The index of the measurement.
(null)
The type or characteristics of the data that this
string read-only measurement represents. For the possible
MeasurementType
(enum) (null) property values, see MeasurementType in
Property details.
See the Oem object definition in the Common
Oem {} object
properties section.
read-only Indicates whether this measurement is part of
PartofSummaryHash boolean
(null) the measurement summary.
read-only The security version number the measurement
SecurityVersionNumber (v1.1+) string
(null) represents.
}]
The measurement specification negotiated
string read-only between the SPDM Requester and SPDM
MeasurementSpecification
(enum) (null) Responder. For the possible property values, see
MeasurementSpecification in Property details.
read-only
MeasurementSummary string The measurement summary data.
(null)
read-only The hash algorithm used to compute the
MeasurementSummaryHashAlgorithm string
(null) measurement summary.
The type of measurement summary. For the
string read-only
MeasurementSummaryType possible property values, see
(enum) (null)
MeasurementSummaryType in Property details.
See the Oem object definition in the Common
Oem {} object
properties section.
Version 2023.1 Published 225
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The link to the the component that is reporting
Requester { object required the integrity information of the target
component.
string
@odata.id read-only The unique identifier for a resource.
(URI)
The status and health of the resource and its
Status {} object subordinate or dependent resources. For property
details, see Status.
read-only The link to the the component whose integrity
TargetComponentURI string
required that this resource reports.
Integrity information about the Trusted Platform
TPM { object
Module (TPM).
ComponentCommunication { object Information about communication with the TPM.
(null)
The active sessions or communication channels
Sessions [ { array
between two components.
The identifier for an active session or
read-only
SessionId integer communication channel between two
(null)
components.
The type of session or communication channel
string read-only between two components. For the possible
SessionType
(enum) (null) property values, see SessionType in Property
details.
}]
Identity authentication information about the
IdentityAuthentication { object
(null) TPM.
A link to the certificate that represents the
ComponentCertificate { object identify of the component. See the Certificate
schema for details on this property.
Link to a Certificate resource. See the Links
@odata.id string read-only
section and the Certificate schema for details.
226 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The status of the verification of the identity of the
string read-only
VerificationStatus component. For the possible property values, see
(enum) (null)
VerificationStatus in Property details.
MeasurementSet { object Measurement information from the TPM.
(null)
Measurements [ { array Measurements from a TPM.
string
read-only The date and time when information for the
LastUpdated (date-
(null) measurement was last updated.
time)
read-only
Measurement string The measurement data.
(null)
read-only The hash algorithm used to compute the
MeasurementHashAlgorithm string
(null) measurement.
read-only The Platform Configuration Register (PCR) bank
PCR integer
(null) of the measurement.
}]
The maximum number of bytes that can be
read-only
NonceSizeBytesMaximum (v1.2+) integer specified in the Nonce parameter of the
(null)
TPMGetSignedMeasurements action.
6.21.4 Actions
6.21.4.1 SPDMGetSignedMeasurements
Description
This action generates an SPDM cryptographic signed statement over the given nonce and
measurements of the SPDM Responder.
Action URI
{Base URI of target resource}/Actions/ComponentIntegrity.SPDMGetSignedMeasurements
Version 2023.1 Published 227
Redfish Resource and Schema Guide DSP2046
Action parameters
Parameter Name Type Attributes Notes
MeasurementIndices array
optional An array of indices that identify the measurement blocks to sign.
[] (integer)
A 32-byte hex-encoded string that is signed with the measurements.
Nonce string optional
The value should be unique.
The slot identifier for the certificate containing the private key to
SlotId integer optional
generate the signature over the measurements.
Response Payload
A link to the certificate corresponding to the SPDM slot identifier that can be
Certificate { object used to validate the signature. See the Certificate schema for details on this
property.
read- Link to a Certificate resource. See the Links section and the Certificate
@odata.id string
only schema for details.
read-
The hashing algorithm used for generating the cryptographic signed
HashingAlgorithm string only
statement.
required
Oem {} object See the Oem object definition in the Common properties section.
read- A Privacy Enhanced Mail (PEM)-encoded public key that can be used to
PublicKey string
only validate the signature.
read-
SignedMeasurements string only Base64 encoded cryptographic signed statement generated by the signer.
required
read-
The asymmetric signing algorithm used for generating the cryptographic
SigningAlgorithm string only
signed statement.
required
read-
The SPDM version used by the SPDM Responder to generate the
Version string only
cryptographic signed statement.
required
Request Example
228 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
{
"Nonce": "4f2359ee609824d33d35c2968b6c56b702a692ab0d8a441f25c7d81fbe833a78",
"SlotId": 0,
"MeasurementIndices": [
0,
1,
2
]
}
Response Example
{
"@odata.type": "#ComponentIntegrity.v1_0_0.SPDMGetSignedMeasurementsResponse",
"Version": "1.1",
"HashingAlgorithm": "SHA256",
"SigningAlgorithm": "TPM_ALG_RSAPSS_3072",
"SignedMeasurements": "EeAQx8PJWv9CbeGdmlPaARrrMw... TRUNCATED (TYPICALLY KB or MB)",
"Certificate": {
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Certificates/SScert"
}
}
6.21.4.2 TPMGetSignedMeasurements (v1.2+)
Description
This action generates a TPM cryptographic signed statement over the given nonce and PCRs of the
TPM for TPM 2.0 devices.
Action URI
{Base URI of target resource}/Actions/ComponentIntegrity.TPMGetSignedMeasurements
Action parameters
Parameter
Type Attributes Notes
Name
The URI for the certificate that represents the TPM attestation key. See the
Certificate { object required
Certificate schema for details on this property.
Link to a Certificate resource. See the Links section and the Certificate
@odata.id string read-only
schema for details.
Version 2023.1 Published 229
Redfish Resource and Schema Guide DSP2046
Parameter
Type Attributes Notes
Name
A set of bytes as a hex-encoded string that is signed with the
Nonce string optional
measurements. The value should be unique.
PCRSelection string required An object that identify the PCRs to sign.
Scheme string required The signing scheme to use for the TPM attestation key.
Response Payload
Oem (v1.2+) {} object See the Oem object definition in the Common properties section.
read-
SignedMeasurements The Base64-encoded cryptographic signed statement generated by the
string only
(v1.2+) signer.
required
Request Example
{
"Nonce": "4f2359ee609824d33d35c2968b6c56b702a692ab0d8a441f25c7d81fbe833a78",
"Certificate": {
"@odata.id": "/redfish/v1/Chassis/1/TrustedComponents/TPM1/Certificates/1"
},
"Scheme": "MzI5NDg=",
"PCRSelection": "MjM3NDA4MjM5ODQ="
}
Response Example
{
"SignedMeasurements": "EeAQx8PJWv9CbeGdmlPaARrrMw... TRUNCATED (TYPICALLY KB or MB)"
}
230 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.21.5 Property details
6.21.5.1 ComponentIntegrityType
The type of security technology for the component.
string Description
OEM OEM-specific.
SPDM Security Protocol and Data Model (SPDM) protocol.
TPM Trusted Platform Module (TPM).
6.21.5.2 MeasurementSpecification
The measurement specification negotiated between the SPDM Requester and SPDM Responder.
string Description
DMTF DMTF.
6.21.5.3 MeasurementSummaryType
The type of measurement summary.
string Description
All The measurement summary covers all measurements in SPDM.
TCB The measurement summary covers the TCB.
6.21.5.4 MeasurementType
The type or characteristics of the data that this measurement represents.
string Description
FirmwareConfiguration Firmware configuration, such as configurable firmware policy.
Version 2023.1 Published 231
Redfish Resource and Schema Guide DSP2046
string Description
HardwareConfiguration Hardware configuration, such as straps.
ImmutableROM Immutable ROM.
MeasurementManifest Measurement Manifest.
MutableFirmware Mutable firmware or any mutable code.
MutableFirmwareSecurityVersionNumber Mutable firmware security version number.
MutableFirmwareVersion Mutable firmware version.
6.21.5.5 SessionType
The type of session or communication channel between two components.
string Description
AuthenticatedOnly An established session where only authentication is protecting the communication.
An established session where both encryption and authentication are protecting the
EncryptedAuthenticated
communication.
Plain A plain text session without any protection.
6.21.5.6 VerificationStatus
The status of the verification of the identity of the component.
string Description
Failed Unsuccessful verification.
Success Successful verification.
6.21.6 Example response
{
"@odata.type": "#ComponentIntegrity.v1_2_1.ComponentIntegrity",
"Id": "TPM-0",
"Description": "TPM physically attached to a GPU.",
232 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"Status": {
"Health": "OK",
"State": "Enabled"
},
"ComponentIntegrityType": "TPM",
"ComponentIntegrityTypeVersion": "1.2.0",
"ComponentIntegrityEnabled": true,
"LastUpdated": "2021-11-02T14:09:54-07:00",
"TargetComponentURI": "/redvish/v1/Systems/437XR1138R2#/TrustedModules/0",
"Links": {
"ComponentsProtected": [
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2/GraphicsControllers/GPU1"
}
]
},
"TPM": {
"MeasurementSet": {
"Measurements": [
{
"PCR": 1,
"Measurement": "h6spEuxbyOtGhP35UoGhTcVX3iRaZQGDw4Yk5oQcabw=",
"LastUpdated": "2021-10-31T20:14:27-07:00",
"MeasurementHashAlgorithm": "TPM_ALG_SHA256"
},
{
"PCR": 3,
"Measurement": "GnbzS4ToNQb+Y7SxXw4AvRDTf4SzO5eeAlAlDca28AA=",
"LastUpdated": "2021-10-31T20:14:27-07:00",
"MeasurementHashAlgorithm": "TPM_ALG_SHA256"
},
{
"PCR": 1,
"Measurement": "pLJa5Dyh8CDYFZ1WNOrsiSG1eyCPBlre42CD7CTywg7VkcC4afw4ZG3gQxi2XEFCt5jxz6tN1/cbx/D
"LastUpdated": "2021-10-31T20:14:27-07:00",
"MeasurementHashAlgorithm": "TPM_ALG_SHA512"
},
{
"PCR": 3,
"Measurement": "GBgEucATV8omirTmYqY+vvbbisHR1jBKfVAEK1XSifBHnnIYXopsc0NExURDSSyPjO21NrPqnwiq5Lh
"LastUpdated": "2021-10-31T20:14:27-07:00",
"MeasurementHashAlgorithm": "TPM_ALG_SHA512"
}
]
},
"IdentityAuthentication": {
"VerificationStatus": "Success",
"ComponentCertificate": {
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Certificates/TPMcert"
}
Version 2023.1 Published 233
Redfish Resource and Schema Guide DSP2046
},
"ComponentCommunication": {
"Sessions": [
{
"SessionId": 4556,
"SessionType": "Plain"
}
]
}
},
"@odata.id": "/redfish/v1/ComponentIntegrity/TPM-0"
}
6.22 CompositionReservation 1.0.0
Version v1.0
Release 2021.1
6.22.1 Description
The CompositionReservation schema contains reservation information related to the Compose action
defined in the CompositionService resource when the of RequestType parameter contains the value
PreviewReserve .
6.22.2 URIs
/redfish/v1/CompositionService/CompositionReservations/{CompositionReservationId}
6.22.3 Properties
Property Type Attributes Notes
Client string read-only The client that owns the reservation.
The manifest document processed by the service that resulted in
Manifest { object
this reservation.
read-write
Description string The description of this manifest.
(null)
234 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The expansion control for references in manifest responses, similar
string read-write
Expand to the $expand=. query parameter. For the possible property values,
(enum) (null)
see Expand in Property details.
An array of stanzas that describe the requests specified by this
Stanzas [ { array
manifest.
read-write
OEMStanzaType string The OEM-defined type of stanza.
(null)
Request {} object The request details for the stanza.
(null)
Response {} object The response details for the stanza.
(null)
read-write The identifier of the stanza. This is a unique identifier specified by
StanzaId string
(null) the client and is not used by the service.
string read-write The type of stanza. For the possible property values, see StanzaType
StanzaType
(enum) (null) in Property details.
}]
string
read-write
Timestamp (date- The date and time when the manifest was created.
(null)
time)
string
ReservationTime (date- read-only The date time the service created the reservation.
time)
ReservedResourceBlocks
array The array of links to the reserved resource blocks.
[{
Link to a ResourceBlock resource. See the Links section and the
@odata.id string read-only
ResourceBlock schema for details.
}]
6.22.4 Property details
6.22.4.1 Expand
The expansion control for references in manifest responses, similar to the $expand=. query parameter.
Version 2023.1 Published 235
Redfish Resource and Schema Guide DSP2046
string Description
All Expand all subordinate references.
None Do not expand any references.
Expand relevant subordinate references. Relevant references are those that are tied to a
Relevant
constrained composition request, such as a request for a quantity of processors.
6.22.4.2 StanzaType
The type of stanza.
string Description
A stanza that describes the desired end state for a composed resource block. The resources
ComposeResource
consumed by the composed resource block are moved to the active pool.
A stanza that describes the desired end state for computer system composition operation.
ComposeSystem
The resources consumed by the composed computer system are moved to the active pool.
A stanza that references a composed resource block to decompose and return resources to
DecomposeResource
the free pool.
A stanza that references a computer system to decompose and return resources to the free
DecomposeSystem
pool.
OEM A stanza that describes an OEM-specific request.
RegisterResourceBlock A stanza that references a resource, such as a computer system, in order to create a
(v1.1+) resource block that references the resource and add it to the free pool.
6.22.5 Example response
{
"@odata.type": "#CompositionReservation.v1_0_0.CompositionReservation",
"Id": "1",
"Name": "Composition Reservation 1",
"ReservationTime": "2019-08-22T10:35:16+06:00",
"Client": "VCF1001",
"ReservedResourceBlocks": [
{
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/BladeServer-2"
}
],
"Manifest": {
236 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"Description": "Description for this Manifest document.",
"Timestamp": "2019-08-22T10:35:16+06:00",
"Expand": "None",
"Stanzas": [
{
"StanzaType": "ComposeSystem",
"StanzaId": "Compute1",
"Request": {
"Links": {
"ResourceBlocks": [
{
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/BladeServer-2"
}
]
}
}
}
]
},
"@odata.id": "/redfish/v1/CompositionService/CompositionReservations/1"
}
6.23 CompositionService 1.2.1
Version v1.2 v1.1 v1.0
Release 2021.1 2018.2 2017.1
6.23.1 Description
The CompositionService schema describes a composition service and its properties and links to the
resources available for composition.
6.23.2 URIs
/redfish/v1/CompositionService
Version 2023.1 Published 237
Redfish Resource and Schema Guide DSP2046
6.23.3 Properties
Property Type Attributes Notes
The link to the collection of resource blocks within the active pool.
Resource blocks in the active pool are contributing to at least one
ActivePool (v1.2+) { object
composed resource as a result of a composition request. Contains a
link to a resource.
Link to Collection of ResourceBlock. See the ResourceBlock schema
@odata.id string read-only
for details.
AllowOverprovisioning read-write An indication of whether this service is allowed to overprovision a
boolean
(v1.1+) (null) composition relative to the composition request.
read-only An indication of whether a client can request that a specific
AllowZoneAffinity (v1.1+) boolean
(null) resource zone fulfill a composition request.
CompositionReservations The link to the collection of reservations with the composition
object
(v1.2+) { reservation collection. Contains a link to a resource.
Link to Collection of CompositionReservation. See the
@odata.id string read-only
CompositionReservation schema for details.
The link to the collection of resource blocks within the free pool.
FreePool (v1.2+) { object Resource blocks in the free pool are not contributing to any
composed resources. Contains a link to a resource.
Link to Collection of ResourceBlock. See the ResourceBlock schema
@odata.id string read-only
for details.
The length of time a composition reservation is held before the
ReservationDuration string read-write
service deletes the reservation marks any related resource blocks
(v1.2+) (duration) (null)
as no longer reserved.
The resource blocks available on the service. Contains a link to a
ResourceBlocks { object
resource.
Link to Collection of ResourceBlock. See the ResourceBlock schema
@odata.id string read-only
for details.
The resource zones available on the service. Contains a link to a
ResourceZones { object
resource.
238 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
@odata.id string read-only Link to Collection of Zone. See the Zone schema for details.
read-write
ServiceEnabled boolean An indication of whether this service is enabled.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
6.23.4 Actions
6.23.4.1 Compose (v1.2+)
Description
This action performs a set of operations specified by a manifest.
Action URI
{Base URI of target resource}/Actions/CompositionService.Compose
Action parameters
Parameter Name Type Attributes Notes
Manifest { object optional The manifest containing the compose operation request.
read-write
Description string The description of this manifest.
(null)
The expansion control for references in manifest responses, similar
string read-write
Expand to the $expand=. query parameter. For the possible property
(enum) (null)
values, see Expand in Property details.
An array of stanzas that describe the requests specified by this
Stanzas [ { array
manifest.
read-write
OEMStanzaType string The OEM-defined type of stanza.
(null)
Request {} object The request details for the stanza.
(null)
Version 2023.1 Published 239
Redfish Resource and Schema Guide DSP2046
Parameter Name Type Attributes Notes
Response {} object The response details for the stanza.
(null)
read-write The identifier of the stanza. This is a unique identifier specified by
StanzaId string
(null) the client and is not used by the service.
string read-write The type of stanza. For the possible property values, see
StanzaType
(enum) (null) StanzaType in Property details.
}]
string
read-write
Timestamp (date- The date and time when the manifest was created.
(null)
time)
string The format of the request. For the possible property values, see
RequestFormat required
(enum) RequestFormat in Property details.
string The type of request. For the possible property values, see
RequestType required
(enum) RequestType in Property details.
The identifier of the composition reservation if applying a
reservation. The value for this parameter is obtained from the
ReservationId string optional
response of a Compose action where the RequestType parameter
contains the value PreviewReserve .
Response Payload
Manifest (v1.2+) { object The manifest containing the compose operation response.
read-
Description string write The description of this manifest.
(null)
read- The expansion control for references in manifest responses, similar to the
string
Expand write $expand=. query parameter. For the possible property values, see Expand
(enum)
(null) in Property details.
Stanzas [ { array An array of stanzas that describe the requests specified by this manifest.
read-
OEMStanzaType string write The OEM-defined type of stanza.
(null)
240 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Request {} object The request details for the stanza.
(null)
Response {} object The response details for the stanza.
(null)
read-
The identifier of the stanza. This is a unique identifier specified by the
StanzaId string write
client and is not used by the service.
(null)
read-
string The type of stanza. For the possible property values, see StanzaType in
StanzaType write
(enum) Property details.
(null)
}]
string read-
Timestamp (date- write The date and time when the manifest was created.
time) (null)
read-
string The format of the request. For the possible property values, see
RequestFormat (v1.2+) only
(enum) RequestFormat in Property details.
required
read-
string The type of request. For the possible property values, see RequestType in
RequestType (v1.2+) only
(enum) Property details.
required
read-
ReservationId (v1.2+) string The identifier of the composition reservation that was created.
only
Request Example
{
"RequestFormat": "Manifest",
"RequestType": "Apply",
"Manifest": {
"Description": "Specific composition example",
"Timestamp": "2019-08-22T10:35:16+06:00",
"Expand": "None",
"Stanzas": [
{
"StanzaType": "ComposeSystem",
"StanzaId": "Compute1",
"Request": {
"Links": {
Version 2023.1 Published 241
Redfish Resource and Schema Guide DSP2046
"ResourceBlocks": [
{
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/BladeServer-1"
},
{
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/NVMe-TargetsAppliance-1
},
{
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/NetworkCard1"
}
]
}
}
}
]
}
}
Response Example
{
"RequestFormat": "Manifest",
"RequestType": "Apply",
"Manifest": {
"Description": "Specific composition example",
"Timestamp": "2019-08-22T10:35:16+06:00",
"Expand": "None",
"Stanzas": [
{
"StanzaType": "ComposeSystem",
"StanzaId": "Compute1",
"Request": {
"Links": {
"ResourceBlocks": [
{
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/BladeServer-1"
},
{
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/NVMe-TargetsAppliance-1
},
{
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/NetworkCard1"
}
]
}
},
"Response": {
"@odata.id": "/redfish/v1/Systems/ComposedCompute1",
242 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"@odata.type": "#ComputerSystem.v1_14_0.ComputerSystem",
"Id": "ComposedCompute1",
"Name": "Computer system composed from Compute1",
"Processors": {
"@odata.id": "/redfish/v1/Systems/ComposedCompute1/Processors"
},
"Memory": {
"@odata.id": "/redfish/v1/Systems/ComposedCompute1/Memory"
},
"NetworkInterfaces": {
"@odata.id": "/redfish/v1/Systems/ComposedCompute1/NetworkInterfaces"
},
"Storage": {
"@odata.id": "/redfish/v1/Systems/ComposedCompute1/Storage"
},
"Links": {
"ResourceBlocks": [
{
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/BladeServer-1"
},
{
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/NVMe-TargetsAppliance-1
},
{
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/NetworkCard1"
}
]
}
}
}
]
}
}
6.23.5 Property details
6.23.5.1 Expand
The expansion control for references in manifest responses, similar to the $expand=. query parameter.
string Description
All Expand all subordinate references.
None Do not expand any references.
Version 2023.1 Published 243
Redfish Resource and Schema Guide DSP2046
string Description
Expand relevant subordinate references. Relevant references are those that are tied to a
Relevant
constrained composition request, such as a request for a quantity of processors.
6.23.5.2 RequestFormat
The format of the request.
string Description
Manifest The request body contains a manifest.
6.23.5.3 RequestType
The type of request.
string Description
Apply Perform the requested operations specified by the manifest and modify resources as needed.
Preview Preview the outcome of the operations specified by the manifest.
PreviewReserve Preview the outcome of the operations specified by the manifest and reserve resources.
6.23.5.4 StanzaType
The type of stanza.
string Description
A stanza that describes the desired end state for a composed resource block. The resources
ComposeResource
consumed by the composed resource block are moved to the active pool.
A stanza that describes the desired end state for computer system composition operation.
ComposeSystem
The resources consumed by the composed computer system are moved to the active pool.
A stanza that references a composed resource block to decompose and return resources to
DecomposeResource
the free pool.
A stanza that references a computer system to decompose and return resources to the free
DecomposeSystem
pool.
244 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
OEM A stanza that describes an OEM-specific request.
RegisterResourceBlock A stanza that references a resource, such as a computer system, in order to create a
(v1.1+) resource block that references the resource and add it to the free pool.
6.23.6 Example response
{
"@odata.type": "#CompositionService.v1_2_1.CompositionService",
"Id": "CompositionService",
"Name": "Composition Service",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"ServiceEnabled": true,
"AllowOverprovisioning": true,
"AllowZoneAffinity": true,
"ResourceBlocks": {
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks"
},
"ResourceZones": {
"@odata.id": "/redfish/v1/CompositionService/ResourceZones"
},
"@odata.id": "/redfish/v1/CompositionService"
}
6.24 ComputerSystem 1.20.1
Version v1.20 v1.19 v1.18 v1.17 v1.16 v1.15 v1.14 v1.13 v1.12 v1.11 v1.10 ...
Release 2022.3 2022.2 2022.1 2021.4 2021.2 2021.1 2020.4 2020.3 2020.2 2020.1 2019.4 ...
6.24.1 Description
The ComputerSystem schema represents a computer or system instance and the software-visible
resources, or items within the data plane, such as memory, CPU, and other devices that it can access.
Details of those resources or subsystems are also linked through this resource.
Version 2023.1 Published 245
Redfish Resource and Schema Guide DSP2046
6.24.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}
/redfish/v1/Systems/{ComputerSystemId}
6.24.3 Properties
Property Type Attributes Notes
read-write The user-definable tag that can track this computer
AssetTag string
(null) system for inventory or other client purposes.
The link to the BIOS settings associated with this
Bios (v1.1+) { object system. See the Bios schema for details on this
property.
Link to a Bios resource. See the Links section and the
@odata.id string read-only
Bios schema for details.
read-only The version of the system BIOS or primary system
BiosVersion string
(null) firmware.
Boot { object The boot settings for this system.
Ordered array of boot source aliases representing the
array
read-write persistent boot order associated with this computer
AliasBootOrder (v1.6+) [ ] (string
(null) system. For the possible property values, see
(enum))
AliasBootOrder in Property details.
read-write The number of attempts the system will automatically
AutomaticRetryAttempts (v1.11+) integer
(null) retry booting.
The configuration of how the system retries booting
string read-write
AutomaticRetryConfig (v1.11+) automatically. For the possible property values, see
(enum) (null)
AutomaticRetryConfig in Property details.
The BootOptionReference of the Boot Option to
read-write
BootNext (v1.5+) string perform a one-time boot from when
(null)
BootSourceOverrideTarget is UefiBootNext .
The link to the collection of the UEFI boot options
BootOptions (v1.5+) { object associated with this computer system. Contains a link
to a resource.
Link to Collection of BootOption. See the BootOption
@odata.id string read-only
schema for details.
246 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
An array of BootOptionReference strings that
represent the persistent boot order for with this
computer system. Changes to the boot order typically
array require a system reset before they take effect. It is
BootOrder (v1.5+) [ ] (string, read-write likely that a client finds the @Redfish.Settings term in
null) this resource, and if it is found, the client makes
requests to change boot order settings by modifying
the resource identified by the @Redfish.Settings
term.
The name of the boot order property that the system
BootOrderPropertySelection string read-write uses for the persistent boot order. For the possible
(v1.6+) (enum) (null) property values, see BootOrderPropertySelection in
Property details.
The state of the boot source override feature. For the
string read-write
BootSourceOverrideEnabled possible property values, see
(enum) (null)
BootSourceOverrideEnabled in Property details.
The BIOS boot mode to use when the system boots
string read-write from the BootSourceOverrideTarget boot source. For
BootSourceOverrideMode (v1.1+)
(enum) (null) the possible property values, see
BootSourceOverrideMode in Property details.
The current boot source to use at the next boot
instead of the normal boot device, if
string read-write
BootSourceOverrideTarget BootSourceOverrideEnabled does not contain
(enum) (null)
Disabled . For the possible property values, see
BootSourceOverrideTarget in Property details.
The link to a collection of certificates used for booting
Certificates (v1.7+) { object through HTTPS by this computer system. Contains a
link to a resource.
Link to Collection of Certificate. See the Certificate
@odata.id string read-only
schema for details.
string read-write The URI to boot from when BootSourceOverrideTarget
HttpBootUri (v1.9+)
(URI) (null) is set to UefiHttp .
RemainingAutomaticRetryAttempts read-only
integer The number of remaining automatic retry boots.
(v1.11+) (null)
If the boot should stop on a fault. For the possible
string read-write
StopBootOnFault (v1.15+) property values, see StopBootOnFault in Property
(enum) (null)
details.
Version 2023.1 Published 247
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The Trusted Module boot requirement. For the
TrustedModuleRequiredToBoot string read-write
possible property values, see
(v1.14+) (enum) (null)
TrustedModuleRequiredToBoot in Property details.
read-write The UEFI device path of the device from which to boot
UefiTargetBootSourceOverride string
(null) when BootSourceOverrideTarget is UefiTarget .
BootProgress (v1.13+) { object This object describes the last boot progress state.
(null)
read-only The number of seconds the system spent booting to
LastBootTimeSeconds (v1.18+) number
(null) the operating system during the last boot.
string read-only The last boot progress state. For the possible property
LastState (v1.13+)
(enum) (null) values, see LastState in Property details.
string
read-only The date and time when the last boot state was
LastStateTime (v1.13+) (date-
(null) updated.
time)
See the Oem object definition in the Common
Oem (v1.13+) {} object
properties section.
read-only The OEM-specific last state, if the LastState type is
OemLastState (v1.13+) string
(null) OEM .
The link to a collection of certificates for device
Certificates (v1.14+) { object
identity and attestation. Contains a link to a resource.
Link to Collection of Certificate. See the Certificate
@odata.id string read-only
schema for details.
Information about the composition capabilities and
Composition (v1.18+) { object
(null) state of the computer system.
array The composition use cases in which this computer
read-only
UseCases (v1.18+) [ ] (string system can participate. For the possible property
(null)
(enum)) values, see UseCases in Property details.
The link to the collection of Ethernet interfaces
EthernetInterfaces { object associated with this system. Contains a link to a
resource.
248 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to Collection of EthernetInterface. See the
@odata.id string read-only
EthernetInterface schema for details.
The link to the collection of fabric adapters associated
FabricAdapters (v1.10+) { object
with this system. Contains a link to a resource.
Link to Collection of FabricAdapter. See the
@odata.id string read-only
FabricAdapter schema for details.
The information about the graphical console (KVM-IP)
GraphicalConsole (v1.13+) { object
service of this system.
This property enumerates the graphical console
array
connection types that the implementation allows. For
ConnectTypesSupported (v1.13+) [ ] (string read-only
the possible property values, see
(enum))
ConnectTypesSupported in Property details.
The maximum number of service sessions, regardless
MaxConcurrentSessions (v1.13+) integer read-only
of protocol, that this system can support.
read-write
Port (v1.13+) integer The protocol port.
(null)
An indication of whether the service is enabled for
ServiceEnabled (v1.13+) boolean read-write
this system.
The link to a collection of graphics controllers that can
GraphicsControllers (v1.15+) { object output video for this system. Contains a link to a
resource.
Link to Collection of GraphicsController. See the
@odata.id string read-only
GraphicsController schema for details.
HostedServices (v1.2+) { object The services that this computer system supports.
See the Oem object definition in the Common
Oem (v1.2+) {} object
properties section.
The link to a collection of storage services that this
StorageServices (v1.2+) { object
computer system supports.
string
@odata.id read-only The unique identifier for a resource.
(URI)
Version 2023.1 Published 249
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
array The hosting roles that this computer system supports.
HostingRoles (v1.2+) [ ] (string read-only For the possible property values, see HostingRoles in
(enum)) Property details.
read-write
HostName string The DNS host name, without any domain information.
(null)
HostWatchdogTimer (v1.5+) { object The host watchdog timer functionality for this system.
An indication of whether a user has enabled the host
watchdog timer functionality. This property indicates
read-write
only that a user has enabled the timer. To activate the
FunctionEnabled (v1.5+) boolean required
timer, installation of additional host-based software is
(null)
necessary; an update to this property does not initiate
the timer.
See the Oem object definition in the Common
Oem (v1.5+) {} object
properties section.
The status and health of the resource and its
Status (v1.5+) {} object subordinate or dependent resources. For property
details, see Status.
read-write The action to perform when the watchdog timer
string
TimeoutAction (v1.5+) required reaches its timeout value. For the possible property
(enum)
(null) values, see TimeoutAction in Property details.
The action to perform when the watchdog timer is
close to reaching its timeout value. This action
string read-write typically occurs from three to ten seconds before to
WarningAction (v1.5+)
(enum) (null) the timeout value, but the exact timing is dependent
on the implementation. For the possible property
values, see WarningAction in Property details.
The idle power saver settings of the computer
IdlePowerSaver (v1.16+) { object
(null) system.
Enabled (v1.16+) boolean read-write An indication of whether idle power saver is enabled.
The duration in seconds the computer system is
integer read-write
EnterDwellTimeSeconds (v1.16+) below the EnterUtilizationPercent value before the idle
(seconds) (null)
power save is activated.
number read-write The percentage of utilization that the computer
EnterUtilizationPercent (v1.16+)
(%) (null) system shall be lower than to enter idle power save.
250 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The duration in seconds the computer system is
integer read-write
ExitDwellTimeSeconds (v1.16+) above the ExitUtilizationPercent value before the idle
(seconds) (null)
power save is stopped.
number read-write The percentage of utilization that the computer
ExitUtilizationPercent (v1.16+)
(%) (null) system shall be higher than to exit idle power save.
The state of the indicator LED, which identifies the
system. For the possible property values, see
string read-write
IndicatorLED (deprecated v1.13) IndicatorLED in Property details. Deprecated in v1.13
(enum) (null)
and later. This property has been deprecated in favor
of the LocationIndicatorActive property.
The key management settings of the computer
KeyManagement (v1.16+) { object
(null) system.
The link to a collection of server certificates for the
KMIPCertificates (v1.16+) { object servers referenced by the KMIPServers property.
Contains a link to a resource.
Link to Collection of Certificate. See the Certificate
@odata.id string read-only
schema for details.
The KMIP servers to which this computer system is
KMIPServers (v1.16+) [ { array
subscribed.
read-write
Address (v1.16+) string The KMIP server address.
(null)
string read-write
CacheDuration (v1.20+) The duration the system caches KMIP data.
(duration) (null)
The cache policy to control how KMIP data is cached.
string read-write
CachePolicy (v1.20+) For the possible property values, see CachePolicy in
(enum) (null)
Property details.
read-write The password to access the KMIP server. The value is
Password (v1.16+) string
(null) null in responses.
read-write
Port (v1.16+) integer The KMIP server port.
(null)
read-write
Username (v1.16+) string The username to access the KMIP server.
(null)
}]
Version 2023.1 Published 251
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
string
The date and time when the system was last reset or
LastResetTime (v1.12+) (date- read-only
rebooted.
time)
The links to other resources that are related to this
Links { object
resource.
An array of links to the chassis that contains this
Chassis [ { array
system.
Link to a Chassis resource. See the Links section and
@odata.id string read-only
the Chassis schema for details.
}]
An array of links to ComputerSystems that are
ConsumingComputerSystems
array realized, in whole or in part, from this
(v1.5+) [ {
ComputerSystem.
@odata.id string read-only Link to another ComputerSystem resource.
}]
An array of links to resources or objects that that cool
CooledBy [ { array this computer system. Normally, the link is for either
a chassis or a specific set of fans.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
An array of links to the endpoints that connect to this
Endpoints (v1.2+) [ { array
system.
Link to a Endpoint resource. See the Links section and
@odata.id string read-only
the Endpoint schema for details.
}]
An array of links to the managers responsible for this
ManagedBy [ { array
system.
Link to a Manager resource. See the Links section and
@odata.id string read-only
the Manager schema for details.
}]
252 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
See the Oem object definition in the Common
Oem {} object
properties section.
The network device functions to which this system
OffloadedNetworkDeviceFunctions
array performs offload computation, such as with a
(v1.17+) [ {
SmartNIC.
Link to a NetworkDeviceFunction resource. See the
@odata.id string read-only Links section and the NetworkDeviceFunction schema
for details.
}]
An array of links to resources or objects that power
PoweredBy [ { array this computer system. Normally, the link is for either
a chassis or a specific set of power supplies.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
An array of links to the resource blocks that are used
ResourceBlocks (v1.4+) [ { array
in this computer system.
Link to a ResourceBlock resource. See the Links
@odata.id string read-write
section and the ResourceBlock schema for details.
}]
An array of links to ComputerSystems that contribute,
SupplyingComputerSystems (v1.5+)
array in whole or in part, to the implementation of this
[{
ComputerSystem.
@odata.id string read-only Link to another ComputerSystem resource.
}]
An array of links to the trusted components for this
TrustedComponents (v1.19+) [ { array
system.
Link to a TrustedComponent resource. See the Links
@odata.id string read-only section and the TrustedComponent schema for
details.
}]
read-write An indicator allowing an operator to physically locate
LocationIndicatorActive (v1.13+) boolean
(null) this resource.
Version 2023.1 Published 253
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The link to the collection of log services associated
LogServices { object
with this system. Contains a link to a resource.
Link to Collection of LogService. See the LogService
@odata.id string read-only
schema for details.
read-only
Manufacturer string The manufacturer or OEM of this system.
(null)
An indication of whether the system is in
manufacturing mode. Manufacturing mode is a
read-only
ManufacturingMode (v1.18+) boolean special boot mode, not normally available to end
(null)
users, that modifies features and settings for use
while the system is being manufactured and tested.
An array of DSP0274-defined measurement blocks.
Measurements (v1.14+, deprecated Deprecated in v1.17 and later. This property has been
array
v1.17 [ { deprecated in favor of the ComponentIntegrity
resource.
Link to a MeasurementBlock resource. See the Links
@odata.id string read-only
section and the SoftwareInventory schema for details.
}]
The link to the collection of memory associated with
Memory (v1.1+) { object
this system. Contains a link to a resource.
Link to Collection of Memory. See the Memory schema
@odata.id string read-only
for details.
The link to the collection of memory domains
MemoryDomains (v1.2+) { object associated with this system. Contains a link to a
resource.
Link to Collection of MemoryDomain. See the
@odata.id string read-only
MemoryDomain schema for details.
MemorySummary { object The central memory of the system in general detail.
The ability and type of memory mirroring that this
string read-only
MemoryMirroring (v1.1+) computer system supports. For the possible property
(enum) (null)
values, see MemoryMirroring in Property details.
254 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The link to the metrics associated with all memory in
Metrics (v1.8+) { object this system. See the MemoryMetrics schema for
details on this property.
Link to a MemoryMetrics resource. See the Links
@odata.id string read-only
section and the MemoryMetrics schema for details.
The status and health of the resource and its
subordinate or dependent resources. For property
details, see Status. Deprecated in v1.16 and later.
Status (deprecated v1.16) {} object
This property has been deprecated in favor of the
Conditions property within Status in the root of this
resource.
number read-only The total configured operating system-accessible
TotalSystemMemoryGiB
(GiBy) (null) memory (RAM), measured in GiB.
TotalSystemPersistentMemoryGiB number read-only The total configured, system-accessible persistent
(v1.4+) (GiBy) (null) memory, measured in GiB.
read-only The product name for this system, without the
Model string
(null) manufacturer name.
The link to the collection of Network Interfaces
NetworkInterfaces (v1.3+) { object associated with this system. Contains a link to a
resource.
Link to Collection of NetworkInterface. See the
@odata.id string read-only
NetworkInterface schema for details.
read-only
PartNumber string The part number for this system.
(null)
The link to a collection of PCIe devices that this
PCIeDevices (v1.2+) [ { array
computer system uses.
Link to a PCIeDevice resource. See the Links section
@odata.id string read-only
and the PCIeDevice schema for details.
}]
The link to a collection of PCIe functions that this
PCIeFunctions (v1.2+) [ { array
computer system uses.
Version 2023.1 Published 255
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to a PCIeFunction resource. See the Links section
@odata.id string read-only
and the PCIeFunction schema for details.
}]
The number of seconds to delay power on after a
read-write
PowerCycleDelaySeconds (v1.13+) number Reset action requesting PowerCycle . Zero seconds
(null)
indicates no delay.
The power mode setting of the computer system. For
string read-write
PowerMode (v1.15+) the possible property values, see PowerMode in
(enum) (null)
Property details.
read-write The number of seconds to delay power off during a
PowerOffDelaySeconds (v1.13+) number
(null) reset. Zero seconds indicates no delay to power off.
The number of seconds to delay power on after a
read-write
PowerOnDelaySeconds (v1.13+) number power cycle or during a reset. Zero seconds indicates
(null)
no delay to power up.
The desired power state of the system when power is
string
PowerRestorePolicy (v1.6+) read-write restored after a power loss. For the possible property
(enum)
values, see PowerRestorePolicy in Property details.
The current power state of the system. For the
string read-only
PowerState possible property values, see PowerState in Property
(enum) (null)
details.
The link to the collection of processors associated
Processors { object
with this system. Contains a link to a resource.
Link to Collection of Processor. See the Processor
@odata.id string read-only
schema for details.
ProcessorSummary { object The central processors of the system in general detail.
read-only
CoreCount (v1.14+) integer The number of processor cores in the system.
(null)
read-only
Count integer The number of physical processors in the system.
(null)
read-only
LogicalProcessorCount (v1.5+) integer The number of logical processors in the system.
(null)
The link to the metrics associated with all processors
Metrics (v1.7+) { object in this system. See the ProcessorMetrics schema for
details on this property.
256 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to a ProcessorMetrics resource. See the Links
@odata.id string read-only
section and the ProcessorMetrics schema for details.
read-only The processor model for the primary or majority of
Model string
(null) processors in this system.
The status and health of the resource and its
subordinate or dependent resources. For property
details, see Status. Deprecated in v1.16 and later.
Status (deprecated v1.16) {} object
This property has been deprecated in favor of the
Conditions property within Status in the root of this
resource.
An indication of whether threading is enabled on all
ThreadingEnabled (v1.15+) boolean read-write
processors in this system.
The link to a collection of redundancy entities. Each
entity specifies a kind and level of redundancy and a
array collection, or redundancy set, of other computer
Redundancy (v1.5+) [ { } ]
(object) systems that provide the specified redundancy to this
computer system. For property details, see
Redundancy.
The link to the UEFI Secure Boot associated with this
SecureBoot (v1.1+) { object system. See the SecureBoot schema for details on
this property.
Link to a SecureBoot resource. See the Links section
@odata.id string read-only
and the SecureBoot schema for details.
SerialConsole (v1.13+) { object The serial console services that this system provides.
The connection details for an IPMI Serial-over-LAN
IPMI (v1.13+) {} object service. For more information about this property, see
SerialConsoleProtocol in Property Details.
The maximum number of service sessions, regardless
MaxConcurrentSessions (v1.13+) integer read-only
of protocol, that this system can support.
The connection details for an SSH serial console
SSH (v1.13+) {} object service. For more information about this property, see
SerialConsoleProtocol in Property Details.
Version 2023.1 Published 257
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The connection details for a Telnet serial console
Telnet (v1.13+) {} object service. For more information about this property, see
SerialConsoleProtocol in Property Details.
read-only
SerialNumber string The serial number for this system.
(null)
The link to the collection of storage devices
SimpleStorage { object associated with this system. Contains a link to a
resource.
Link to Collection of SimpleStorage. See the
@odata.id string read-only
SimpleStorage schema for details.
read-only
SKU string The manufacturer SKU for this system.
(null)
The status and health of the resource and its
Status {} object subordinate or dependent resources. For property
details, see Status.
The link to the collection of storage devices
Storage (v1.1+) { object associated with this system. Contains a link to a
resource.
Link to Collection of Storage. See the Storage schema
@odata.id string read-only
for details.
read-only
SubModel (v1.5+) string The sub-model for this system.
(null)
The type of computer system that this resource
string
SystemType read-only represents. For the possible property values, see
(enum)
SystemType in Property details.
An array of trusted modules in the system.
TrustedModules (v1.1+, deprecated Deprecated in v1.19 and later. This property has been
array
v1.19 [ { deprecated in favor of the TrustedComponents
property in Links.
read-only
FirmwareVersion (v1.1+) string The firmware version of this Trusted Module.
(null)
read-only The second firmware version of this Trusted Module, if
FirmwareVersion2 (v1.3+) string
(null) applicable.
258 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The interface type of the Trusted Module. For the
string read-only
InterfaceType (v1.1+) possible property values, see InterfaceType in
(enum) (null)
Property details.
The interface type selection supported by this Trusted
string read-only
InterfaceTypeSelection (v1.3+) Module. For the possible property values, see
(enum) (null)
InterfaceTypeSelection in Property details.
See the Oem object definition in the Common
Oem (v1.1+) {} object
properties section.
The status and health of the resource and its
Status (v1.1+) {} object subordinate or dependent resources. For property
details, see Status.
}]
The link to a collection of USB controllers for this
USBControllers (v1.15+) { object
system. Contains a link to a resource.
Link to Collection of USBController. See the
@odata.id string read-only
USBController schema for details.
string read-only The UUID for this system. For more information about
UUID
(uuid) (null) this property, see Property details.
The link to the virtual media services for this system.
VirtualMedia (v1.13+) { object
Contains a link to a resource.
Link to Collection of VirtualMedia. See the
@odata.id string read-only
VirtualMedia schema for details.
The information about the virtual media service of
VirtualMediaConfig (v1.13+) { object
this system.
read-write
Port (v1.13+) integer The protocol port.
(null)
An indication of whether the service is enabled for
ServiceEnabled (v1.13+) boolean read-write
this system.
Version 2023.1 Published 259
Redfish Resource and Schema Guide DSP2046
6.24.4 Actions
6.24.4.1 AddResourceBlock (v1.6+)
Description
This action adds a resource block to a system.
Action URI
{Base URI of target resource}/Actions/ComputerSystem.AddResourceBlock
Action parameters
Parameter Name Type Attributes Notes
ComputerSystemETag string optional The current ETag of the system.
The resource block to add to the system. See the ResourceBlock
ResourceBlock { object required
schema for details on this property.
Link to a ResourceBlock resource. See the Links section and the
@odata.id string read-only
ResourceBlock schema for details.
ResourceBlockETag string optional The current ETag of the resource block to add to the system.
Request Example
{
"ResourceBlock": {
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/Offload-GPU1"
},
"ResourceBlockETag": "W/\"19472363938\"",
"ComputerSystemETag": "W/\"99374369273\""
}
6.24.4.2 RemoveResourceBlock (v1.6+)
Description
This action removes a resource block from a system.
260 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Action URI
{Base URI of target resource}/Actions/ComputerSystem.RemoveResourceBlock
Action parameters
Parameter Name Type Attributes Notes
ComputerSystemETag string optional The current ETag of the system.
The resource block to remove from the system. See the
ResourceBlock { object required
ResourceBlock schema for details on this property.
Link to a ResourceBlock resource. See the Links section and the
@odata.id string read-only
ResourceBlock schema for details.
ResourceBlockETag string optional The current ETag of the resource block to remove from the system.
Request Example
{
"ResourceBlock": {
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/Offload-GPU1"
},
"ResourceBlockETag": "W/\"19472363938\"",
"ComputerSystemETag": "W/\"99374369273\""
}
6.24.4.3 Reset
Description
This action resets the system.
Action URI
{Base URI of target resource}/Actions/ComputerSystem.Reset
Action parameters
Version 2023.1 Published 261
Redfish Resource and Schema Guide DSP2046
Parameter
Type Attributes Notes
Name
string The type of reset. For the possible property values, see ResetType in Property
ResetType optional
(enum) details.
Request Example
{
"ResetType": "ForceRestart"
}
6.24.4.4 SetDefaultBootOrder (v1.5+)
Description
This action sets the BootOrder to the default settings.
Action URI
{Base URI of target resource}/Actions/ComputerSystem.SetDefaultBootOrder
Action parameters
This action takes no parameters.
6.24.5 Property details
6.24.5.1 AliasBootOrder
Ordered array of boot source aliases representing the persistent boot order associated with this
computer system.
string Description
BiosSetup Boot to the BIOS setup utility.
Cd Boot from the CD or DVD.
Diags Boot to the manufacturer's diagnostics program.
Floppy Boot from the floppy disk drive.
262 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Hdd Boot from a hard drive.
None Boot from the normal boot device.
Pxe Boot from the Pre-Boot EXecution (PXE) environment.
Recovery Boot to a system-designated recovery process or image.
RemoteDrive Boot from a remote drive, such as an iSCSI target.
SDCard Boot from an SD card.
UefiBootNext Boot to the UEFI device that the BootNext property specifies.
UefiHttp Boot from a UEFI HTTP network location.
UefiShell Boot to the UEFI Shell.
UefiTarget Boot to the UEFI device specified in the UefiTargetBootSourceOverride property.
Usb Boot from a system BIOS-specified USB device.
Utilities Boot to the manufacturer's utilities program or programs.
6.24.5.2 AutomaticRetryConfig
The configuration of how the system retries booting automatically.
string Description
Disabled Disable automatic retrying of booting.
RetryAlways Always automatically retry booting.
RetryAttempts Automatic retrying of booting is based on a specified retry count.
6.24.5.3 BootOrderPropertySelection
The name of the boot order property that the system uses for the persistent boot order.
string Description
AliasBootOrder The system uses the AliasBootOrder property to specify the persistent boot order.
BootOrder The system uses the BootOrder property to specify the persistent boot order.
Version 2023.1 Published 263
Redfish Resource and Schema Guide DSP2046
6.24.5.4 BootSourceOverrideEnabled
The state of the boot source override feature.
string Description
The system boots to the target specified in the BootSourceOverrideTarget property until this
Continuous
property is Disabled .
Disabled The system boots normally.
On its next boot cycle, the system boots one time to the boot source override target. Then,
Once
the BootSourceOverrideEnabled value is reset to Disabled .
6.24.5.5 BootSourceOverrideMode
The BIOS boot mode to use when the system boots from the BootSourceOverrideTarget boot source.
string Description
Legacy The system boots in non-UEFI boot mode to the boot source override target.
UEFI The system boots in UEFI boot mode to the boot source override target.
6.24.5.6 BootSourceOverrideTarget
The current boot source to use at the next boot instead of the normal boot device, if
BootSourceOverrideEnabled does not contain Disabled .
string Description
BiosSetup Boot to the BIOS setup utility.
Cd Boot from the CD or DVD.
Diags Boot to the manufacturer's diagnostics program.
Floppy Boot from the floppy disk drive.
Hdd Boot from a hard drive.
None Boot from the normal boot device.
Pxe Boot from the Pre-Boot EXecution (PXE) environment.
264 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Recovery (v1.19+) Boot to a system-designated recovery process or image.
RemoteDrive (v1.2+) Boot from a remote drive, such as an iSCSI target.
SDCard (v1.1+) Boot from an SD card.
UefiBootNext (v1.5+) Boot to the UEFI device that the BootNext property specifies.
UefiHttp (v1.1+) Boot from a UEFI HTTP network location.
UefiShell Boot to the UEFI Shell.
UefiTarget Boot to the UEFI device specified in the UefiTargetBootSourceOverride property.
Usb Boot from a system BIOS-specified USB device.
Utilities Boot to the manufacturer's utilities program or programs.
6.24.5.7 CachePolicy
The cache policy to control how KMIP data is cached.
string Description
The system caches KMIP data after first use for the duration specified by the CacheDuration
AfterFirstUse
property.
None The system does not cache KMIP data.
6.24.5.8 ConnectTypesSupported
This property enumerates the graphical console connection types that the implementation allows.
string Description
The controller supports a graphical console connection through a KVM-IP (redirection of
KVMIP
Keyboard, Video, Mouse over IP) protocol.
OEM The controller supports a graphical console connection through an OEM-specific protocol.
6.24.5.9 HostingRoles
The hosting roles that this computer system supports.
Version 2023.1 Published 265
Redfish Resource and Schema Guide DSP2046
string Description
Appliance The system hosts functionality that supports the system acting as an appliance.
ApplicationServer The system hosts functionality that supports general purpose applications.
BareMetalServer The system hosts functionality that supports the system acting as a bare metal server.
ContainerServer The system hosts functionality that supports the system acting as a container server.
StorageServer The system hosts functionality that supports the system acting as a storage server.
Switch The system hosts functionality that supports the system acting as a switch.
VirtualMachineServer The system hosts functionality that supports the system acting as a virtual machine server.
6.24.5.10 IndicatorLED
The state of the indicator LED, which identifies the system.
string Description
Blinking The indicator LED is blinking.
Lit The indicator LED is lit.
Off The indicator LED is off.
Unknown (deprecated The state of the indicator LED cannot be determined. Deprecated in v1.1 and later. This value
v1.1) has been deprecated in favor of returning null if the state is unknown.
6.24.5.11 InterfaceType
The interface type of the Trusted Module.
string Description
TCM1_0 Trusted Cryptography Module (TCM) 1.0.
TPM1_2 Trusted Platform Module (TPM) 1.2.
TPM2_0 Trusted Platform Module (TPM) 2.0.
6.24.5.12 InterfaceTypeSelection
The interface type selection supported by this Trusted Module.
266 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
The TrustedModule supports switching InterfaceType through platform software, such as a
BiosSetting
BIOS configuration attribute.
FirmwareUpdate The TrustedModule supports switching InterfaceType through a firmware update.
None The TrustedModule does not support switching the InterfaceType.
OemMethod The TrustedModule supports switching InterfaceType through an OEM proprietary mechanism.
6.24.5.13 LastState
The last boot progress state.
string Description
BusInitializationStarted The system has started initializing the buses.
MemoryInitializationStarted The system has started initializing the memory.
None The system is not booting.
OEM A boot progress state in an OEM-defined format.
OSBootStarted The operating system has started booting.
OSRunning The operating system is running.
PCIResourceConfigStarted The system has started initializing the PCI resources.
PrimaryProcessorInitializationStarted The system has started initializing the primary processor.
SecondaryProcessorInitializationStarted The system has started initializing the remaining processors.
SetupEntered (v1.15+) The system has entered the setup utility.
SystemHardwareInitializationComplete The system has completed initializing all hardware.
6.24.5.14 MemoryMirroring
The ability and type of memory mirroring that this computer system supports.
string Description
DIMM The system supports DIMM mirroring at the DIMM level. Individual DIMMs can be mirrored.
Version 2023.1 Published 267
Redfish Resource and Schema Guide DSP2046
string Description
The system supports a hybrid mirroring at the system and DIMM levels. Individual DIMMs can
Hybrid
be mirrored.
None The system does not support DIMM mirroring.
The system supports DIMM mirroring at the system level. Individual DIMMs are not paired for
System
mirroring in this mode.
6.24.5.15 PowerMode
The power mode setting of the computer system.
string Description
The system performs at the highest speeds while utilization is high and performs at reduced
BalancedPerformance
speeds when the utilization is low.
MaximumPerformance The system performs at the highest speeds possible.
OEM The system power mode is OEM-defined.
OSControlled The system power mode is controlled by the operating system.
PowerSaving The system performs at reduced speeds to save power.
Static The system power mode is static.
6.24.5.16 PowerRestorePolicy
The desired power state of the system when power is restored after a power loss.
string Description
AlwaysOff The system always remains powered off when power is applied.
AlwaysOn The system always powers on when power is applied.
LastState The system returns to its last on or off power state when power is applied.
6.24.5.17 PowerState
The current power state of the system.
268 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
The resource is powered off. The components within the resource might continue to have
Off
AUX power.
On The resource is powered on.
Paused The resource is paused.
A temporary state between on and off. The components within the resource can take time to
PoweringOff
process the power off action.
A temporary state between off and on. The components within the resource can take time to
PoweringOn
process the power on action.
6.24.5.18 ResetType
The type of reset.
string Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
ForceOn Turn on the unit immediately.
ForceRestart Shut down immediately and non-gracefully and restart the system.
GracefulRestart Shut down gracefully and restart the system.
GracefulShutdown Shut down gracefully and power off.
Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal
Nmi
operations, complete diagnostic actions, and, typically, halt the system.
On Turn on the unit.
Pause execution on the unit but do not remove power. This is typically a feature of virtual
Pause
machine hypervisors.
Power cycle the unit. Behaves like a full power removal, followed by a power restore to the
PowerCycle
resource.
PushPowerButton Simulate the pressing of the physical power button on this unit.
Resume execution on the paused unit. This is typically a feature of virtual machine
Resume
hypervisors.
Write the state of the unit to disk before powering off. This allows for the state to be restored
Suspend
when powered back on.
Version 2023.1 Published 269
Redfish Resource and Schema Guide DSP2046
6.24.5.19 SerialConsoleProtocol
The information about a serial console service that this system provides.
read-
ConsoleEntryCommand The command string passed to the service to select or enter the system's
string only
(v1.13+) serial console.
(null)
read-
HotKeySequenceDisplay
string only The hotkey sequence available for the user to exit the serial console session.
(v1.13+)
(null)
read-
Port (v1.13+) integer write The protocol port.
(null)
read-
ServiceEnabled (v1.13+) boolean An indication of whether the service is enabled for this system.
write
SharedWithManagerCLI read- Indicates whether the serial console service is shared with access to the
boolean
(v1.13+) only manager's command-line interface (CLI).
6.24.5.20 StopBootOnFault
If the boot should stop on a fault.
string Description
AnyFault The system should stop the boot on any fault.
Never The system performs any normal recovery actions during boot if a fault occurs.
6.24.5.21 SystemType
The type of computer system that this resource represents.
string Description
Composed (v1.4+) A computer system constructed by binding resource blocks together.
A computer system that performs the functions of a data processing unit, such as a
DPU (v1.16+)
SmartNIC.
OS An operating system instance.
270 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Physical A computer system.
PhysicallyPartitioned A hardware-based partition of a computer system.
Virtual A virtual machine instance running on this system.
VirtuallyPartitioned A virtual or software-based partition of a computer system.
6.24.5.22 TimeoutAction
The action to perform when the watchdog timer reaches its timeout value.
string Description
None No action taken.
OEM Perform an OEM-defined action.
PowerCycle Power cycle the system.
PowerDown Power down the system.
ResetSystem Reset the system.
6.24.5.23 TrustedModuleRequiredToBoot
The Trusted Module boot requirement.
string Description
Disabled No Trusted Module requirement to boot.
Required A functional Trusted Module is required to boot.
6.24.5.24 UseCases
The composition use cases in which this computer system can participate.
Version 2023.1 Published 271
Redfish Resource and Schema Guide DSP2046
string Description
This computer system supports expandable system composition and is associated with a
ExpandableSystem
resource block.
This computer system supports being registered as a resource block in order for it to
ResourceBlockCapable
participate in composition requests.
6.24.5.25 UUID
The UUID for this system.
The UUID property contains a value that represents the universal unique identifier number (UUID) of a
system.
The UUID property is a string data type. The format of the string is the 36-character string format
specified in RFC4122: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx". Each x represents a hexadecimal
digit (0-f).
Regarding the case of the hex values, RFC4122 specifies that the hex values should be lowercase
characters. Most modern scripting languages typically also represent hex values in lowercase
characters following the RFC. However, dmidecode, WMI and some Redfish implementations currently
use uppercase characters for UUID on output.
6.24.5.26 WarningAction
The action to perform when the watchdog timer is close to reaching its timeout value. This action
typically occurs from three to ten seconds before to the timeout value, but the exact timing is
dependent on the implementation.
string Description
DiagnosticInterrupt Raise a (typically non-maskable) Diagnostic Interrupt.
MessagingInterrupt Raise a legacy IPMI messaging interrupt.
None No action taken.
OEM Perform an OEM-defined action.
SCI Raise an interrupt using the ACPI System Control Interrupt (SCI).
SMI Raise a Systems Management Interrupt (SMI).
272 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.24.6 Example response
{
"@odata.type": "#ComputerSystem.v1_20_1.ComputerSystem",
"Id": "437XR1138R2",
"Name": "WebFrontEnd483",
"SystemType": "Physical",
"AssetTag": "Chicago-45Z-2381",
"Manufacturer": "Contoso",
"Model": "3500RX",
"SKU": "8675309",
"SerialNumber": "437XR1138R2",
"PartNumber": "224071-J23",
"Description": "Web Front End node",
"UUID": "38947555-7742-3448-3784-823347823834",
"HostName": "web483",
"Status": {
"State": "Enabled",
"Health": "OK",
"HealthRollup": "OK"
},
"HostingRoles": [
"ApplicationServer"
],
"LocationIndicatorActive": false,
"PowerState": "On",
"Boot": {
"BootSourceOverrideEnabled": "Once",
"BootSourceOverrideTarget": "Pxe",
"[email protected]": [
"None",
"Pxe",
"Cd",
"Usb",
"Hdd",
"BiosSetup",
"Utilities",
"Diags",
"SDCard",
"UefiTarget"
],
"BootSourceOverrideMode": "UEFI",
"UefiTargetBootSourceOverride": "/0x31/0x33/0x01/0x01"
},
"TrustedModules": [
{
"FirmwareVersion": "1.13b",
"InterfaceType": "TPM1_2",
"Status": {
Version 2023.1 Published 273
Redfish Resource and Schema Guide DSP2046
"State": "Enabled",
"Health": "OK"
}
}
],
"Oem": {
"Contoso": {
"@odata.type": "#Contoso.ComputerSystem",
"ProductionLocation": {
"FacilityName": "PacWest Production Facility",
"Country": "USA"
}
},
"Chipwise": {
"@odata.type": "#Chipwise.ComputerSystem",
"Style": "Executive"
}
},
"BiosVersion": "P79 v1.33 (02/28/2015)",
"ProcessorSummary": {
"Count": 2,
"Model": "Multi-Core Intel(R) Xeon(R) processor 7xxx Series"
},
"MemorySummary": {
"TotalSystemMemoryGiB": 96,
"TotalSystemPersistentMemoryGiB": 0,
"MemoryMirroring": "None"
},
"Bios": {
"@odata.id": "/redfish/v1/Systems/437XR1138R2/BIOS"
},
"Processors": {
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Processors"
},
"Memory": {
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Memory"
},
"EthernetInterfaces": {
"@odata.id": "/redfish/v1/Systems/437XR1138R2/EthernetInterfaces"
},
"SimpleStorage": {
"@odata.id": "/redfish/v1/Systems/437XR1138R2/SimpleStorage"
},
"LogServices": {
"@odata.id": "/redfish/v1/Systems/437XR1138R2/LogServices"
},
"Links": {
"Chassis": [
{
"@odata.id": "/redfish/v1/Chassis/1U"
274 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
}
],
"ManagedBy": [
{
"@odata.id": "/redfish/v1/Managers/BMC"
}
]
},
"Actions": {
"#ComputerSystem.Reset": {
"target": "/redfish/v1/Systems/437XR1138R2/Actions/ComputerSystem.Reset",
"[email protected]": [
"On",
"ForceOff",
"GracefulShutdown",
"GracefulRestart",
"ForceRestart",
"Nmi",
"ForceOn",
"PushPowerButton"
]
},
"Oem": {
"#Contoso.Reset": {
"target": "/redfish/v1/Systems/437XR1138R2/Oem/Contoso/Actions/Contoso.Reset"
}
}
},
"@odata.id": "/redfish/v1/Systems/437XR1138R2"
}
6.25 Connection 1.2.0
Version v1.2 v1.1 v1.0
Release 2023.1 2021.1 2020.3
6.25.1 Description
The Connection schema describes the access permissions endpoints, or groups of endpoints, have
with other resources in the service.
Version 2023.1 Published 275
Redfish Resource and Schema Guide DSP2046
6.25.2 URIs
/redfish/v1/Fabrics/{FabricId}/Connections/{ConnectionId}
6.25.3 Properties
Property Type Attributes Notes
The permission keys required to access the specified
ConnectionKeys (v1.1+) { object
resources for this connection.
The CHAP-specific permission key information for this
CHAP (v1.2+) { object
(null) connection.
read-write The password for CHAP authentication. The value is null
CHAPPassword (v1.2+) string
(null) in responses.
read-write
CHAPUsername (v1.2+) string The username for CHAP authentication.
(null)
InitiatorCHAPPassword read-write The initiator shared secret for mutual (2-way) CHAP
string
(v1.2+) (null) authentication. The value is null in responses.
InitiatorCHAPUsername read-write The initiator username for mutual (2-way) CHAP
string
(v1.2+) (null) authentication.
read-write The target shared secret for mutual (2-way) CHAP
TargetCHAPPassword (v1.2+) string
(null) authentication. The value is null in responses.
The DHCHAP-specific permission key information for this
DHCHAP (v1.2+) { object
(null) connection.
LocalDHCHAPAuthSecret read-write The local DHCHAP authentication secret. The value is
string
(v1.2+) (null) null in responses.
PeerDHCHAPAuthSecret read-write The peer DHCHAP authentication secret. The value is
string
(v1.2+) (null) null in responses.
The Gen-Z-specific permission key information for this
GenZ (v1.1+) { object
(null) connection.
AccessKey (v1.1+) string read-write The Access Key for this connection.
RKeyDomainCheckingEnabled Indicates whether Region Key domain checking is
boolean read-write
(v1.1+) enabled for this connection.
276 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
RKeyReadOnlyKey (v1.1+) string read-write The read-only Region Key for this connection.
RKeyReadWriteKey (v1.1+) string read-write The read-write Region Key for this connection.
The type of resources this connection specifies. For the
string read-only
ConnectionType possible property values, see ConnectionType in Property
(enum) (null)
details.
The links to other resources that are related to this
Links { object
resource.
An array of links to the initiator endpoint groups that are
InitiatorEndpointGroups [ { array
associated with this connection.
Link to a EndpointGroup resource. See the Links section
@odata.id string read-write
and the EndpointGroup schema for details.
}]
An array of links to the initiator endpoints that are
InitiatorEndpoints [ { array
associated with this connection.
Link to a Endpoint resource. See the Links section and
@odata.id string read-write
the Endpoint schema for details.
}]
See the Oem object definition in the Common properties
Oem {} object
section.
An array of links to the target endpoint groups that are
TargetEndpointGroups [ { array
associated with this connection.
Link to a EndpointGroup resource. See the Links section
@odata.id string read-write
and the EndpointGroup schema for details.
}]
An array of links to the target endpoints that are
TargetEndpoints [ { array
associated with this connection.
Link to a Endpoint resource. See the Links section and
@odata.id string read-write
the Endpoint schema for details.
}]
Version 2023.1 Published 277
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The set of memory chunks and access capabilities
MemoryChunkInfo (v1.1+) [ { array
specified for this connection.
array Supported IO access capabilities. For the possible
read-write
AccessCapabilities (v1.1+) [ ] (string property values, see AccessCapabilities in Property
(null)
(enum)) details.
string read-write The access state for this connection. For the possible
AccessState (v1.1+)
(enum) (null) property values, see AccessState in Property details.
The specified memory chunk. See the MemoryChunks
MemoryChunk (v1.1+) { object
(null) schema for details on this property.
Link to a MemoryChunks resource. See the Links section
@odata.id string read-write
and the MemoryChunks schema for details.
}]
The status and health of the resource and its subordinate
Status {} object
or dependent resources. For property details, see Status.
The set of volumes and access capabilities specified for
VolumeInfo [ { array
this connection.
array Supported IO access capabilities. For the possible
read-write
AccessCapabilities [ ] (string property values, see AccessCapabilities in Property
(null)
(enum)) details.
string read-write The access state for this connection. For the possible
AccessState
(enum) (null) property values, see AccessState in Property details.
read-write The initiator-visible logical unit number (LUN) assigned to
LUN (v1.2+) integer
(null) this volume.
Volume { object The specified volume.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
278 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.25.4 Property details
6.25.4.1 AccessCapabilities
Supported IO access capabilities.
string Description
Read Endpoints are allowed to perform reads from the specified resource.
Write Endpoints are allowed to perform writes to the specified resource.
6.25.4.2 AccessState
The access state for this connection.
string Description
NonOptimized The resource is in an active and non-optimized state.
Optimized The resource is in an active and optimized state.
Standby The resource is in a standby state.
Transitioning The resource is transitioning to a new state.
Unavailable The resource is in an unavailable state.
6.25.4.3 ConnectionType
The type of resources this connection specifies.
string Description
Memory A connection to memory related resources.
Storage A connection to storage related resources, such as volumes.
Version 2023.1 Published 279
Redfish Resource and Schema Guide DSP2046
6.25.5 Example response
{
"@odata.type": "#Connection.v1_2_0.Connection",
"Id": "1",
"Name": "Connection info for host 1",
"ConnectionType": "Storage",
"VolumeInfo": [
{
"AccessCapabilities": [
"Read",
"Write"
],
"Volume": {
"@odata.id": "/redfish/v1/Storage/NVMeoF/Volumes/1"
}
},
{
"AccessCapabilities": [
"Read",
"Write"
],
"Volume": {
"@odata.id": "/redfish/v1/Storage/NVMeoF/Volumes/3"
}
}
],
"Links": {
"InitiatorEndpoints": [
{
"@odata.id": "/redfish/v1/Fabrics/NVMeoF/Endpoints/Initiator1"
}
]
},
"@odata.id": "/redfish/v1/Fabrics/NVMeoF/Connections/1"
}
6.26 ConnectionMethod 1.1.0
Version v1.1 v1.0
Release 2022.3 2020.2
280 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.26.1 Description
The ConnectionMethod schema describes the protocol, provider, or other method used to
communicate to a given access point for a Redfish aggregation service.
6.26.2 URIs
/redfish/v1/AggregationService/ConnectionMethods/{ConnectionMethodId}
6.26.3 Properties
Property Type Attributes Notes
string read-only The type of connection method. For the possible property values,
ConnectionMethodType
(enum) (null) see ConnectionMethodType in Property details.
read-only
ConnectionMethodVariant string The variant of connection method.
(null)
Links { object The links to other resources that are related to this resource.
AggregationSources [
array An array of links to the access points using this connection method.
{
Link to a AggregationSource resource. See the Links section and
@odata.id string read-only
the AggregationSource schema for details.
}]
Oem {} object See the Oem object definition in the Common properties section.
string read-only The tunneling protocol used for this connection method. For the
TunnelingProtocol (v1.1+)
(enum) (null) possible property values, see TunnelingProtocol in Property details.
6.26.4 Property details
6.26.4.1 ConnectionMethodType
The type of connection method.
Version 2023.1 Published 281
Redfish Resource and Schema Guide DSP2046
string Description
IPMI15 IPMI 1.5 connection method.
IPMI20 IPMI 2.0 connection method.
NETCONF NETCONF connection method.
OEM OEM connection method.
Redfish Redfish connection method.
SNMP SNMP connection method.
6.26.4.2 TunnelingProtocol
The tunneling protocol used for this connection method.
string Description
OEM OEM tunneling.
SSH SSH tunneling.
6.26.5 Example response
{
"@odata.type": "#ConnectionMethod.v1_1_0.ConnectionMethod",
"Id": "ConnectionMethod1",
"Name": "ConnectionMethod One",
"ConnectionMethodType": "Redfish",
"ConnectionMethodVariant": "Contoso",
"Links": {
"AggregationSources": [
{
"@odata.id": "/redfish/v1/AggregationService/AggregationSources/AggregationSource1"
}
]
},
"@odata.id": "/redfish/v1/AggregationService/ConnectionMethods/ConnectionMethod1"
}
282 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.27 Control 1.3.0
Version v1.3 v1.2 v1.1 v1.0
Release 2023.1 2022.2 2021.4 2021.2
6.27.1 Description
The Control schema describes a control point and its properties.
6.27.2 URIs
/redfish/v1/Chassis/{ChassisId}/Controls/{ControlId}
6.27.3 Properties
Property Type Attributes Notes
number read-only
Accuracy The estimated percent error of measured versus actual values.
(%) (null)
read-only
AllowableMax number The maximum possible setting for this control.
(null)
read-only
AllowableMin number The minimum possible setting for this control.
(null)
array
AllowableNumericValues [
(number, read-only The supported values for the set point.
]
null)
AssociatedSensors [ { array An array of links to the sensors associated with this control.
Link to a Sensor resource. See the Links section and the Sensor
@odata.id string read-only
schema for details.
}]
read-write The time delay in seconds before the control will activate once the
ControlDelaySeconds number
(null) value has deviated from the set point.
ControlLoop { object The control loop details.
(null)
Version 2023.1 Published 283
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
string
read-only
CoefficientUpdateTime (date- The date and time that the control loop coefficients were changed.
(null)
time)
read-write
Differential number The differential coefficient.
(null)
read-write
Integral number The integral coefficient.
(null)
read-write
Proportional number The proportional coefficient.
(null)
string read-write The current operating mode of the control. For the possible
ControlMode
(enum) (null) property values, see ControlMode in Property details.
string read-only The type of control. For the possible property values, see
ControlType
(enum) (null) ControlType in Property details.
read-write The maximum deviation from the set point allowed before the
DeadBand number
(null) control will activate.
read-only
DefaultSetPoint (v1.3+) number The default set point of the control.
(null)
string read-only The implementation of the control. For the possible property
Implementation
(enum) (null) values, see Implementation in Property details.
read-only
Increment number The smallest increment supported for the set point.
(null)
The location information for this control. For property details, see
Location {} object
Location.
string read-only The area or device to which this control applies. For the possible
PhysicalContext
(enum) (null) property values, see PhysicalContext in Property details.
The usage or location within a device to which this control applies.
string read-only
PhysicalSubContext For the possible property values, see PhysicalSubContext in
(enum) (null)
Property details.
RelatedItem [ { array An array of links to resources that this control services.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
284 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The sensor reading associated with this control. This object is an
object
Sensor { excerpt of the Sensor resource located at the URI shown in
(excerpt)
DataSourceUri.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
read-write
SetPoint number The desired set point of the control.
(null)
string read-only The set point type used to operate the control. For the possible
SetPointType
(enum) (null) property values, see SetPointType in Property details.
read-only
SetPointUnits string The units of the set point.
(null)
string
read-only
SetPointUpdateTime (date- The date and time that the set point was changed.
(null)
time)
read-write
SettingMax number The maximum set point in the allowed range.
(null)
read-write
SettingMin number The minimum set point in the allowed range.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
6.27.4 Actions
6.27.4.1 ResetToDefaults (v1.2+)
Description
The action resets the values of writable properties to factory defaults.
Action URI
{Base URI of target resource}/Actions/Control.ResetToDefaults
Action parameters
Version 2023.1 Published 285
Redfish Resource and Schema Guide DSP2046
This action takes no parameters.
6.27.5 Property details
6.27.5.1 ControlMode
The current operating mode of the control.
string Description
Automatic Automatically adjust control to meet the set point.
Disabled The control has been disabled.
Manual No automatic adjustments are made to the control.
Override User override of the automatic set point value.
6.27.5.2 ControlType
The type of control.
string Description
Frequency Frequency (Hz) control.
FrequencyMHz (v1.1+) Frequency (MHz) control.
Power Power (W) control or power limit.
Pressure (v1.1+, Pressure (kPa) control. Deprecated in v1.3 and later. This value has been deprecated in favor
deprecated v1.3) of PressurekPa for units consistency with the equivalent Sensor resource ReadingType value.
PressurekPa (v1.3+) Pressure (kPa) control.
Temperature Temperature (C) control or thermostat.
Valve (v1.3+) Valve (% open) control.
6.27.5.3 Implementation
The implementation of the control.
286 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Direct The set point directly affects the control value.
Monitored A physical control that cannot be adjusted through this interface.
Programmable The set point can be adjusted through this interface.
6.27.5.4 PhysicalContext
The area or device to which this control applies.
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Version 2023.1 Published 287
Redfish Resource and Schema Guide DSP2046
string Description
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
GPU A graphics processor (GPU).
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
StorageBay Within a storage bay.
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
Transformer A transformer.
TrustedModule A trusted module.
288 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
6.27.5.5 PhysicalSubContext
The usage or location within a device to which this control applies.
string Description
Input The input.
Output The output.
6.27.5.6 SetPointType
The set point type used to operate the control.
string Description
Range Control uses a range of values.
Single Control uses a single set point.
6.27.6 Example response
{
"@odata.type": "#Control.v1_3_0.Control",
"Id": "PowerLimit",
"Name": "System Power Limit",
"PhysicalContext": "Chassis",
"ControlType": "Power",
"ControlMode": "Automatic",
"SetPoint": 500,
"SetPointUnits": "W",
"AllowableMax": 1000,
"AllowableMin": 150,
"Sensor": {
"Reading": 374,
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/TotalPower"
},
Version 2023.1 Published 289
Redfish Resource and Schema Guide DSP2046
"Status": {
"Health": "OK",
"State": "Enabled"
},
"@odata.id": "/redfish/v1/Chassis/1U/Controls/PowerLimit"
}
6.28 CoolantConnector 1.0.0
Version v1.0
Release 2023.1
6.28.1 Description
This schema describes a liquid coolant connector, including any associated instrumentation.
6.28.2 URIs
/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/CoolantConnectors/{CoolantConnectorId}
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/PrimaryCoolantConnectors/
{CoolantConnectorId}
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/SecondaryCoolantConnectors/
{CoolantConnectorId}
/redfish/v1/ThermalEquipment/CoolingLoops/{CoolingUnitId}/PrimaryCoolantConnectors/
{CoolantConnectorId}
/redfish/v1/ThermalEquipment/CoolingLoops/{CoolingUnitId}/SecondaryCoolantConnectors/
{CoolantConnectorId}
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/PrimaryCoolantConnectors/
{CoolantConnectorId}
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/SecondaryCoolantConnectors/
{CoolantConnectorId}
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/PrimaryCoolantConnectors/
{CoolantConnectorId}
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/SecondaryCoolantConnectors/
{CoolantConnectorId}
290 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.28.3 Properties
Property Type Attributes Notes
Details about the coolant used in this unit. See the CoolingLoop
Coolant { object
schema for details on this property.
Link to a Coolant resource. See the Links section and the
@odata.id string read-only
CoolingLoop schema for details.
string read-only The type of coolant connector. For the possible property values,
CoolantConnectorType
(enum) (null) see CoolantConnectorType in Property details.
read-write
CoolingLoopName string The name of the cooling loop attached to this interface.
(null)
string read-write
CoolingManagerURI The link to the application that manages the cooling loop.
(URI) (null)
The differential pressure (kPa). For more information about this
DeltaPressurekPa {} object
property, see SensorExcerpt in Property Details.
DeltaTemperatureCelsius The differential temperature (C). For more information about this
object
{} property, see SensorExcerpt in Property Details.
The liquid flow (L/min). For more information about this property,
FlowLitersPerMinute {} object
see SensorExcerpt in Property Details.
The heat removed (kW) through this connector. For more
HeatRemovedkW {} object information about this property, see SensorExcerpt in Property
Details.
Links { object The links to other resources that are related to this resource.
ConnectedChassis [ { array Any array of links to chassis at the other end of the connection.
Link to a Chassis resource. See the Links section and the Chassis
@odata.id string read-write
schema for details.
}]
ConnectedCoolingLoop A link to the cooling loop at the other end of the connection. See
object
{ (null) the CoolingLoop schema for details on this property.
Link to a CoolingLoop resource. See the Links section and the
@odata.id string read-write
CoolingLoop schema for details.
Version 2023.1 Published 291
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
ConnectedCoolingUnit A link to the cooling unit at the other end of the connection. See
object
{ (null) the CoolingUnit schema for details on this property.
Link to a CoolingUnit resource. See the Links section and the
@odata.id string read-write
CoolingUnit schema for details.
Oem {} object See the Oem object definition in the Common properties section.
read-write
LocationIndicatorActive boolean An indicator allowing an operator to physically locate this resource.
(null)
number read-only
RatedFlowLitersPerMinute The rated liquid flow (L/min) for this loop interface.
(L/min) (null)
number read-only
RatedFlowPressurekPa The pressure (kPa) at which the rated liquid flow is valid.
(kPa) (null)
number read-only
RatedPressurekPa The rated pressure (kPa) for this connector.
(kPa) (null)
The return pressure (kPa). For more information about this
ReturnPressurekPa {} object
property, see SensorExcerpt in Property Details.
ReturnTemperatureCelsius The return temperature (C). For more information about this
object
{} property, see SensorExcerpt in Property Details.
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
The supply pressure (kPa). For more information about this
SupplyPressurekPa {} object
property, see SensorExcerpt in Property Details.
SupplyTemperatureCelsius The supply temperature (C). For more information about this
object
{} property, see SensorExcerpt in Property Details.
6.28.4 Property details
6.28.4.1 CoolantConnectorType
The type of coolant connector.
292 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Closed A closed or self-contained loop.
Inline An inline connection or measurement point.
Pair A connection pair.
Return A return or outflow connection.
Supply A supply or intake connection.
6.28.4.2 SensorExcerpt
The Sensor schema describes a sensor and its properties. This object is an excerpt of the Sensor
resource located at the URI shown in DataSourceUri.
read-
string
DataSourceUri only The link to the resource that provides the data for this sensor.
(URI)
(null)
read-
Reading number only The sensor value.
(null)
6.28.5 Example response
{
"@odata.type": "#CoolantConnector.v1_0_0.CoolantConnector",
"Id": "A",
"Name": "Rack Cooling Loop A",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"CoolantConnectorType": "Pair",
"RatedFlowLitersPerMinute": 30,
"FlowLitersPerMinute": {
"Reading": 24.3
},
"SupplyTemperatureCelsius": {
"Reading": 14.8
},
"ReturnTemperatureCelsius": {
"Reading": 38.2
},
Version 2023.1 Published 293
Redfish Resource and Schema Guide DSP2046
"DeltaTemperatureCelsius": {
"Reading": 23.4
},
"SupplyPressurekPa": {
"Reading": 426.6
},
"ReturnPressurekPa": {
"Reading": 409.9
},
"DeltaPressurekPa": {
"Reading": 31.7
},
"Links": {
"ConnectedCoolingLoop": {
"@odata.id": "/redfish/v1/ThermalEquipment/CoolingLoops/Rack4"
}
},
"@odata.id": "/redfish/v1/ThermalEquipment/CDUs/1/SecondaryCoolantConnectors/A"
}
6.29 CoolingLoop 1.0.0
Version v1.0
Release 2023.1
6.29.1 Description
This schema describes a cooling loop. A cooling loop might be any coolant-carrying vessel, such as
facility-level pipe work, an immersion cooling tank, or a manifold. A loop might describe its connectors
and instrumentation, but does not generally include active cooling components or subsystems.
6.29.2 URIs
/redfish/v1/ThermalEquipment/CoolingLoops/{CoolingLoopId}
294 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.29.3 Properties
Property Type Attributes Notes
array
ConsumingEquipmentNames [ An array of names of downstream devices that receive coolant
(string, read-write
] from this cooling loop.
null)
Coolant { object The coolant details for this cooling loop.
read-write
AdditiveName string The name of the additive.
(null)
number read-write
AdditivePercent The percent additives contained in the coolant.
(%) (null)
string read-write The type of coolant. For the possible property values, see
CoolantType
(enum) (null) CoolantType in Property details.
number read-write
DensityKgPerCubicMeter The density (kg/m^3) of the coolant.
(kg/m3) (null)
read-write
RatedServiceHours number The rated hours of service life for this coolant.
(null)
string
read-write
ServicedDate (date- The date the coolant was last serviced.
(null)
time)
read-write
ServiceHours number The hours of service this coolant has provided.
(null)
number read-write
SpecificHeatkJoulesPerKgK The specific heat capacity (kJ/(kg*K)) of the coolant.
(kJ/kg/K) (null)
The coolant capacity filled (percent). This object is an excerpt
object
CoolantLevelPercent { of the Sensor resource located at the URI shown in
(excerpt)
DataSourceUri.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
Version 2023.1 Published 295
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The status of the coolant level in this cooling loop. For the
string read-only
CoolantLevelStatus possible property values, see CoolantLevelStatus in Property
(enum) (null)
details.
string read-only The quality of the coolant. For the possible property values, see
CoolantQuality
(enum) (null) CoolantQuality in Property details.
string read-write
CoolingManagerURI The link to the application that manages the cooling loop.
(URI) (null)
Links { object The links to other resources that are related to this resource.
A link to the chassis that contains this equipment. See the
Chassis { object
(null) Chassis schema for details on this property.
Link to a Chassis resource. See the Links section and the
@odata.id string read-only
Chassis schema for details.
A link to the facility that contains this equipment. See the
Facility { object
Facility schema for details on this property.
Link to a Facility resource. See the Links section and the Facility
@odata.id string read-only
schema for details.
An array of links to the managers responsible for managing this
ManagedBy [ { array
equipment.
Link to a Manager resource. See the Links section and the
@odata.id string read-only
Manager schema for details.
}]
See the Oem object definition in the Common properties
Oem {} object
section.
read-write An indicator allowing an operator to physically locate this
LocationIndicatorActive boolean
(null) resource.
A link to the primary coolant connectors for this equipment.
PrimaryCoolantConnectors { object
Contains a link to a resource.
Link to Collection of CoolantConnector. See the
@odata.id string read-only
CoolantConnector schema for details.
296 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
number read-only
RatedFlowLitersPerMinute The rated liquid flow (L/min) for this cooling loop.
(L/min) (null)
number read-only
RatedPressurekPa The rated pressure (kPa) for this cooling loop.
(kPa) (null)
SecondaryCoolantConnectors A link to the secondary coolant connectors for this equipment.
object
{ Contains a link to a resource.
Link to Collection of CoolantConnector. See the
@odata.id string read-only
CoolantConnector schema for details.
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
array
An array of names of upstream devices that supply coolant to
SupplyEquipmentNames [ ] (string, read-write
this cooling loop.
null)
UserLabel string read-write A user-assigned label.
6.29.4 Property details
6.29.4.1 CoolantLevelStatus
The status of the coolant level in this cooling loop.
string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.
6.29.4.2 CoolantQuality
The quality of the coolant.
string Description
Critical A critical condition requires immediate attention.
Version 2023.1 Published 297
Redfish Resource and Schema Guide DSP2046
string Description
OK Normal.
Warning A condition requires attention.
6.29.4.3 CoolantType
The type of coolant.
string Description
Dielectric Dielectric fluid.
Fluorocarbon Fluorocarbon-based.
Hydrocarbon Hydrocarbon-based.
Water Water or glycol mixture, including additives.
6.29.5 Example response
{
"@odata.type": "#CoolingLoop.v1_0_0.CoolingLoop",
"Id": "BuildingChiller",
"Name": "Feed from building chiller",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"UserLabel": "Building Chiller",
"Coolant": {
"CoolantType": "Water",
"AdditiveName": "Generic cooling water biocide",
"AdditivePercent": 0
},
"CoolantLevelStatus": "OK",
"CoolantQuality": "OK",
"CoolantLevelPercent": {
"Reading": 95
},
"SupplyEquipmentNames": [
"Chiller"
],
"ConsumingEquipmentNames": [
"Rack #1 CDU",
298 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"Rack #2 CDU",
"Rack #3 CDU",
"Rack #4 CDU"
],
"@odata.id": "/redfish/v1/ThermalEquipment/CoolingLoops/BuildingChiller"
}
6.30 CoolingUnit 1.0.0
Version v1.0
Release 2023.1
6.30.1 Description
This is the schema definition for a cooling distribution component or unit, such as a cooling distribution
unit (CDU) or a heat exchanger.
6.30.2 URIs
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}
6.30.3 Properties
Property Type Attributes Notes
The link to the assembly associated with this cooling unit. See
Assembly { object
the Assembly schema for details on this property.
Link to a Assembly resource. See the Links section and the
@odata.id string read-only
Assembly schema for details.
read-write
AssetTag string The user-assigned asset tag for this equipment.
(null)
Details about the coolant used in this unit. See the CoolingLoop
Coolant { object
schema for details on this property.
Version 2023.1 Published 299
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to a Coolant resource. See the Links section and the
@odata.id string read-only
CoolingLoop schema for details.
read-only
CoolingCapacityWatts integer The cooling capacity (W) of this equipment.
(null)
The link to the environment metrics for this equipment. See the
EnvironmentMetrics { object
EnvironmentMetrics schema for details on this property.
Link to a EnvironmentMetrics resource. See the Links section
@odata.id string read-only
and the EnvironmentMetrics schema for details.
string read-only The type of equipment this resource represents. For the possible
EquipmentType
(enum) required property values, see EquipmentType in Property details.
array The redundancy information for the groups of filters in this unit.
FilterRedundancy [ { } ]
(object) For property details, see RedundantGroup.
A link to the filters for this equipment. Contains a link to a
Filters { object
resource.
@odata.id string read-only Link to Collection of Filter. See the Filter schema for details.
FirmwareVersion string read-only The firmware version of this equipment.
A link to the leak detection components associated with this
LeakDetection { object equipment. See the LeakDetection schema for details on this
property.
Link to a LeakDetection resource. See the Links section and the
@odata.id string read-only
LeakDetection schema for details.
Links { object The links to other resources that are related to this resource.
Chassis [ { array An array of links to the chassis that contain this equipment.
Link to a Chassis resource. See the Links section and the
@odata.id string read-only
Chassis schema for details.
}]
A link to the facility that contains this equipment. See the
Facility { object
Facility schema for details on this property.
300 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to a Facility resource. See the Links section and the Facility
@odata.id string read-only
schema for details.
An array of links to the managers responsible for managing this
ManagedBy [ { array
equipment.
Link to a Manager resource. See the Links section and the
@odata.id string read-only
Manager schema for details.
}]
See the Oem object definition in the Common properties
Oem {} object
section.
The location of the equipment. For property details, see
Location {} object
Location.
read-only
Manufacturer string The manufacturer of this equipment.
(null)
read-only
Model string The product model number of this equipment.
(null)
read-only
PartNumber string The part number for this equipment.
(null)
A link to the primary coolant connectors for this equipment.
PrimaryCoolantConnectors { object
Contains a link to a resource.
Link to Collection of CoolantConnector. See the
@odata.id string read-only
CoolantConnector schema for details.
string
read-only
ProductionDate (date- The production or manufacturing date of this equipment.
(null)
time)
array The redundancy information for the groups of pumps in this unit.
PumpRedundancy [ { } ]
(object) For property details, see RedundantGroup.
A link to the pumps for this equipment. Contains a link to a
Pumps { object
resource.
@odata.id string read-only Link to Collection of Pump. See the Pump schema for details.
Version 2023.1 Published 301
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
A link to the reservoirs for this equipment. Contains a link to a
Reservoirs { object
resource.
Link to Collection of Reservoir. See the Reservoir schema for
@odata.id string read-only
details.
SecondaryCoolantConnectors A link to the secondary coolant connectors for this equipment.
object
{ Contains a link to a resource.
Link to Collection of CoolantConnector. See the
@odata.id string read-only
CoolantConnector schema for details.
read-only
SerialNumber string The serial number for this equipment.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
UserLabel string read-write A user-assigned label.
read-only
Version string The hardware version of this equipment.
(null)
6.30.4 Property details
6.30.4.1 EquipmentType
The type of equipment this resource represents.
string Description
CDU A cooling distribution unit.
HeatExchanger A heat exchanger.
ImmersionUnit An immersion cooling unit.
6.30.5 Example response
302 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"@odata.type": "#CoolingUnit.v1_0_0.CoolingUnit",
"Id": "1",
"EquipmentType": "CDU",
"Name": "Rack #4 Cooling Distribution Unit",
"FirmwareVersion": "3.2.0",
"Version": "1.03b",
"ProductionDate": "2020-12-24T08:00:00Z",
"Manufacturer": "Contoso",
"Model": "BRRR4000",
"SerialNumber": "29347ZT536",
"PartNumber": "ICE-9",
"AssetTag": "PDX5-92381",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Location": {
"Placement": {
"Row": "North 1"
}
},
"PrimaryCoolantConnectors": {
"@odata.id": "/redfish/v1/ThermalEquipment/CDUs/1/PrimaryCoolantConnectors"
},
"SecondaryCoolantConnectors": {
"@odata.id": "/redfish/v1/ThermalEquipment/CDUs/1/SecondaryCoolantConnectors"
},
"Pumps": {
"@odata.id": "/redfish/v1/ThermalEquipment/CDUs/1/Pumps"
},
"Filters": {
"@odata.id": "/redfish/v1/ThermalEquipment/CDUs/1/Filters"
},
"EnvironmentMetrics": {
"@odata.id": "/redfish/v1/ThermalEquipment/CDUs/1/EnvironmentMetrics"
},
"LeakDetection": {
"@odata.id": "/redfish/v1/ThermalEquipment/CDUs/1/LeakDetection"
},
"Links": {
"Facility": {
"@odata.id": "/redfish/v1/Facilities/Room237"
}
},
"@odata.id": "/redfish/v1/ThermalEquipment/CDUs/1"
}
Version 2023.1 Published 303
Redfish Resource and Schema Guide DSP2046
6.31 CXLLogicalDevice 1.0.0
Version v1.0
Release 2022.3
6.31.1 Description
The schema definition for the CXLLogicalDevice resource. It represents the properties of a CXL logical
device within PCIe device.
6.31.2 URIs
/redfish/v1/Chassis/{ChassisId}/PCIeDevices/{PCIeDeviceId}/CXLLogicalDevices/{CXLLogicalDeviceId}
6.31.3 Properties
Property Type Attributes Notes
array The durable names for the CXL logical
Identifiers [ { } ]
(object) device. For property details, see Identifier.
The links to other resources that are related
Links { object
to this resource.
An array of links to the endpoints
Endpoints [ { array
associated with this CXL logical device.
Link to a Endpoint resource. See the Links
@odata.id string read-only section and the Endpoint schema for
details.
}]
An array of links to the memory chunks
MemoryChunks [ { array
owned by this CXL logical device.
Link to a MemoryChunks resource. See the
@odata.id string read-only Links section and the MemoryChunks
schema for details.
}]
304 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
An array of links to the memory domains
MemoryDomains [ { array
associated with this CXL logical device.
Link to a MemoryDomain resource. See the
@odata.id string read-only Links section and the MemoryDomain
schema for details.
}]
See the Oem object definition in the
Oem {} object
Common properties section.
An array of links to the PCIe functions
PCIeFunctions [ { array
assigned to this CXL logical device.
Link to a PCIeFunction resource. See the
@odata.id string read-only Links section and the PCIeFunction schema
for details.
}]
The link to the log service associated with
Log { object this CXL logical device. See the LogService
schema for details on this property.
Link to a LogService resource. See the Links
@odata.id string read-only section and the LogService schema for
details.
integer The memory region size defined in this CXL
MemorySizeMiB read-only
(mebibytes) logical device.
The quality of service configuration for this
QoS { object
CXL logical device.
read-write The bandwidth allocated for this CXL logical
AllocatedBandwidth integer
(null) device in multiples of 256.
integer read-write The bandwidth limit to this CXL logical
LimitPercent
(%) (null) device as a percentage.
The quality of service telemetry capabilities
QoSTelemetryCapabilities { object
for this CXL logical device.
Version 2023.1 Published 305
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Indicates whether the device supports the
read-only
EgressPortBackpressureSupported boolean CXL Specification-defined 'Egress Port
(null)
Backpressure' mechanism.
Indicates whether the device supports the
read-only
TemporaryThroughputReductionSupported boolean CXL Specification-defined 'Temporary
(null)
Throughput Reduction' mechanism.
The semantics supported by this CXL logical
array
device. For the possible property values,
SemanticsSupported [ ] (string read-only
see SemanticsSupported in Property
(enum))
details.
The status and health of the resource and
Status {} object its subordinate or dependent resources. For
property details, see Status.
6.31.4 Property details
6.31.4.1 SemanticsSupported
The semantics supported by this CXL logical device.
string Description
CXLcache CXL caching protocol semantic.
CXLio CXL I/O semantic.
CXLmem CXL memory access semantic.
6.31.5 Example response
{
"@odata.type": "#CXLLogicalDevice.v1_0_0.CXLLogicalDevice",
"Id": "1",
"Name": "CXL Logical Device Type 1",
"Description": "Locally attached CXL Logical Device Type 1",
"Status": {
"State": "Enabled",
"Health": "OK",
306 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"HealthRollup": "OK"
},
"Identifiers": [
{
"DurableName": "4C-1D-96-FF-FE-DD-D8-35:0001",
"DurableNameFormat": "GCXLID"
}
],
"SemanticsSupported": [
"CXLio",
"CXLcache"
],
"Links": {
"PCIeFunctions": [
{
"@odata.id": "/redfish/v1/Chassis/CXL1/PCIeDevices/1/PCIeFunctions/1"
}
]
},
"@odata.id": "/redfish/v1/Chassis/CXL1/PCIeDevices/1/CXLLogicalDevices/1"
}
6.32 Drive 1.17.0
Version v1.17 v1.16 v1.15 v1.14 v1.13 v1.12 v1.11 v1.10 v1.9 v1.8 v1.7 ...
Release 2023.1 2022.3 2022.1 2021.4 2021.2 2020.4 2020.3 2020.2 2019.4 2019.3 2019.2 ...
6.32.1 Description
The Drive schema represents a single physical drive for a system, including links to associated
volumes. It also describes the location, such as a slot, socket, or bay, where a unit can be installed, by
populating a resource instance with an absent state if a unit is not present.
6.32.2 URIs
/redfish/v1/Chassis/{ChassisId}/Drives/{DriveId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/
{DriveId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/Drives/{DriveId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}
Version 2023.1 Published 307
Redfish Resource and Schema Guide DSP2046
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/{DriveId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
Drives/{DriveId}
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}
6.32.3 Properties
Property Type Attributes Notes
The link to the assembly associated with this drive. See the
Assembly (v1.3+) { object
Assembly schema for details on this property.
Link to a Assembly resource. See the Links section and the
@odata.id string read-only
Assembly schema for details.
read-write
AssetTag string The user-assigned asset tag for this drive.
(null)
integer read-only
BlockSizeBytes The size, in bytes, of the smallest addressable unit, or block.
(bytes) (null)
number read-only The speed, in gigabit per second (Gbit/s), at which this drive
CapableSpeedGbs
(Gbit/s) (null) can communicate to a storage controller in ideal conditions.
integer read-only
CapacityBytes The size, in bytes, of this drive.
(bytes) (null)
The link to a collection of certificates for device identity and
Certificates (v1.12+) { object
attestation. Contains a link to a resource.
Link to Collection of Certificate. See the Certificate schema
@odata.id string read-only
for details.
The form factor of the drive inserted in this slot. For the
string read-only
DriveFormFactor (v1.16+) possible property values, see DriveFormFactor in Property
(enum) (null)
details.
string read-only The encryption ability of this drive. For the possible property
EncryptionAbility
(enum) (null) values, see EncryptionAbility in Property details.
string read-only The status of the encryption of this drive. For the possible
EncryptionStatus
(enum) (null) property values, see EncryptionStatus in Property details.
The link to the environment metrics for this drive. See the
EnvironmentMetrics (v1.12+) { object
EnvironmentMetrics schema for details on this property.
308 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to a EnvironmentMetrics resource. See the Links section
@odata.id string read-only
and the EnvironmentMetrics schema for details.
read-only An indication of whether this drive currently predicts a failure
FailurePredicted boolean
(null) in the near future.
read-only
FirmwareVersion (v1.17+) string The firmware version for this drive.
(null)
The replacement mode for the hot spare drive. For the
HotspareReplacementMode string read-write
possible property values, see HotspareReplacementMode in
(v1.5+) (enum) (null)
Property details.
The type of hot spare that this drive serves as. For the
string read-write
HotspareType possible property values, see HotspareType in Property
(enum) (null)
details.
array The durable names for the drive. For property details, see
Identifiers [ { } ]
(object) Identifier.
The state of the indicator LED, that identifies the drive. For
the possible property values, see IndicatorLED in Property
string read-write
IndicatorLED (deprecated v1.11) details. Deprecated in v1.11 and later. This property has
(enum) (null)
been deprecated in favor of the LocationIndicatorActive
property.
Links { object The links to other resources that are related to this resource.
The link to the software inventory that represents the active
ActiveSoftwareImage
object drive firmware image. See the SoftwareInventory schema for
(v1.16+) {
details on this property.
Link to a SoftwareInventory resource. See the Links section
@odata.id string read-write
and the SoftwareInventory schema for details.
The link to the chassis that contains this drive. See the
Chassis (v1.2+) { object
Chassis schema for details on this property.
Link to a Chassis resource. See the Links section and the
@odata.id string read-only
Chassis schema for details.
Endpoints (v1.1+) [ { array An array of links to the endpoints that connect to this drive.
Link to a Endpoint resource. See the Links section and the
@odata.id string read-only
Endpoint schema for details.
Version 2023.1 Published 309
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
}]
NetworkDeviceFunctions An array of links to the network device functions that provide
array
(v1.14+) [ { network connectivity for this drive.
Link to a NetworkDeviceFunction resource. See the Links
@odata.id string read-only
section and the NetworkDeviceFunction schema for details.
}]
See the Oem object definition in the Common properties
Oem {} object
section.
An array of links to the PCIe functions that the drive
PCIeFunctions (v1.6+) [ { array
produces.
Link to a PCIeFunction resource. See the Links section and
@odata.id string read-only
the PCIeFunction schema for details.
}]
SoftwareImages (v1.16+) [ { array The images that are associated with this drive.
Link to a SoftwareInventory resource. See the Links section
@odata.id string read-only
and the SoftwareInventory schema for details.
}]
A link to the storage subsystem to which this drive belongs.
Storage (v1.13+) { object
See the Storage schema for details on this property.
Link to a Storage resource. See the Links section and the
@odata.id string read-only
Storage schema for details.
An array of links to the storage pools to which this drive
StoragePools (v1.8+) [ { array
belongs.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
An array of links to the volumes that this drive either wholly
Volumes [ { array
or only partially contains.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
310 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The location of the drive. For property details, see Location.
array Deprecated in v1.4 and later. This property has been
Location (deprecated v1.4) [ { } ]
(object) deprecated in favor of the singular property PhysicalLocation
found in Drive.v1_4_0.
LocationIndicatorActive read-write An indicator allowing an operator to physically locate this
boolean
(v1.11+) (null) resource.
read-only
Manufacturer string The manufacturer of this drive.
(null)
An array of DSP0274-defined measurement blocks.
Measurements (v1.12+,
array Deprecated in v1.14 and later. This property has been
deprecated v1.14 [ {
deprecated in favor of the ComponentIntegrity resource.
Link to a MeasurementBlock resource. See the Links section
@odata.id string read-only
and the SoftwareInventory schema for details.
}]
string read-only The type of media contained in this drive. For the possible
MediaType
(enum) (null) property values, see MediaType in Property details.
The link to the metrics associated with this drive. See the
Metrics (v1.17+) { object
(null) DriveMetrics schema for details on this property.
Link to a DriveMetrics resource. See the Links section and
@odata.id string read-only
the DriveMetrics schema for details.
read-only
Model string The model number for the drive.
(null)
read-only An indication of whether the drive is accessible from multiple
Multipath (v1.9+) boolean
(null) paths.
number read-only The speed, in gigabit per second (Gbit/s), at which this drive
NegotiatedSpeedGbs
(Gbit/s) (null) currently communicates to the storage controller.
Operations (v1.1+) [ { array The operations currently running on the Drive.
The link to the task associated with the operation, if any. See
AssociatedTask (v1.1+) { object
the Task schema for details on this property.
Link to a Task resource. See the Links section and the Task
@odata.id string read-only
schema for details.
Version 2023.1 Published 311
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
string read-only The type of the operation. For the possible property values,
Operation (v1.17+)
(enum) (null) see Operation in Property details.
The name of the operation. Deprecated in v1.17 and later.
OperationName (v1.1+, read-only This property is deprecated in favor of the Operation
string
deprecated v1.17 (null) property using the OperationType enumeration defined in the
Volume schema.
PercentageComplete integer read-only
The percentage of the operation that has been completed.
(v1.1+) (%) (null)
}]
read-only
PartNumber string The part number for this drive.
(null)
PhysicalLocation (v1.4+) {} object The location of the drive. For property details, see Location.
number read-only The percentage of reads and writes that are predicted to be
PredictedMediaLifeLeftPercent
(%) (null) available for the media.
The protocol that this drive currently uses to communicate to
string read-only
Protocol the storage controller. For the possible property values, see
(enum) (null)
Protocol in Property details.
read-write An indication of whether the drive is prepared by the system
ReadyToRemove (v1.10+) boolean
(null) for removal.
The revision of this drive. For SCSI-based drives, this is the
read-only version of the drive from the 'Inquiry' command, which can
Revision string
(null) be the firmware or hardware version. For other types of
drives, this is the hardware version.
number read-only The rotation speed of this drive, in revolutions per minute
RotationSpeedRPM
({rev}/min) (null) (RPM).
read-only
SerialNumber string The serial number for this drive.
(null)
read-only
SKU string The SKU for this drive.
(null)
array
SlotCapableProtocols (v1.16+) read-only The drive protocols capable in this slot. For the possible
(string
[] (null) property values, see SlotCapableProtocols in Property details.
(enum))
string read-only The form factor of the slot. For the possible property values,
SlotFormFactor (v1.16+)
(enum) (null) see SlotFormFactor in Property details.
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
312 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The state of the status indicator, which communicates status
string read-write
StatusIndicator information about this drive. For the possible property
(enum) (null)
values, see StatusIndicator in Property details.
read-write
WriteCacheEnabled (v1.7+) boolean An indication of whether the drive write cache is enabled.
(null)
6.32.4 Actions
6.32.4.1 Reset (v1.7+)
Description
This action resets this drive.
Action URI
{Base URI of target resource}/Actions/Drive.Reset
Action parameters
Parameter
Type Attributes Notes
Name
string The type of reset. For the possible property values, see ResetType in Property
ResetType optional
(enum) details.
Request Example
{
"ResetType": "On"
}
6.32.4.2 SecureErase
Description
This action securely erases the contents of the drive.
Action URI
Version 2023.1 Published 313
Redfish Resource and Schema Guide DSP2046
{Base URI of target resource}/Actions/Drive.SecureErase
Action parameters
Parameter Name Type Attributes Notes
OverwritePasses The number of times to overwrite the drive if performing an overwrite
integer optional
(v1.15+) type of sanitization.
SanitizationType string The type of data sanitization to perform. For the possible property
optional
(v1.15+) (enum) values, see SanitizationType in Property details.
Request Example
{
"SanitizationType": "CryptographicErase"
}
6.32.5 Property details
6.32.5.1 DriveFormFactor
The form factor of the drive inserted in this slot.
string Description
Drive2_5 A 2.5 inch drive.
Drive3_5 A 3.5 inch drive.
EDSFF_1U_Long An EDSFF 1U Long (E1.L) drive.
EDSFF_1U_Short An EDSFF 1U Short (E1.S) drive.
EDSFF_E3_Long An EDSFF E3 Long (E3.L) drive.
EDSFF_E3_Short An EDSFF E3 Short (E3.S) drive.
M2_22110 An M.2 22110 drive.
M2_2230 An M.2 2230 drive.
M2_2242 An M.2 2242 drive.
M2_2260 An M.2 2260 drive.
314 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
M2_2280 An M.2 2280 drive.
OEM An OEM-defined form factor.
PCIeHalfLength A half length PCIe add in card.
PCIeSlotFullLength A full length PCIe add in card.
PCIeSlotLowProfile A low profile PCIe add in card.
U2 A U.2 drive.
6.32.5.2 EncryptionAbility
The encryption ability of this drive.
string Description
None The drive is not capable of self-encryption.
Other The drive is capable of self-encryption through some other means.
The drive is capable of self-encryption per the Trusted Computing Group's Self Encrypting
SelfEncryptingDrive
Drive Standard.
6.32.5.3 EncryptionStatus
The status of the encryption of this drive.
string Description
The drive is currently encrypted, the data is not accessible to the user, and the system
Foreign
requires user intervention to expose the data.
The drive is currently encrypted and the data is not accessible to the user. However, the
Locked
system can unlock the drive automatically.
Unecrypted (deprecated The drive is not currently encrypted. Deprecated in v1.1 and later. This value has been
v1.1) deprecated in favor of Unencrypted.
Unencrypted (v1.1+) The drive is not currently encrypted.
Unlocked The drive is currently encrypted but the data is accessible to the user in unencrypted form.
Version 2023.1 Published 315
Redfish Resource and Schema Guide DSP2046
6.32.5.4 HotspareReplacementMode
The replacement mode for the hot spare drive.
string Description
The hot spare drive that is commissioned due to a drive failure remains as a data drive and
NonRevertible
does not revert to a hot spare if the failed drive is replaced.
The hot spare drive that is commissioned due to a drive failure reverts to a hot spare after
Revertible
the failed drive is replaced and rebuilt.
6.32.5.5 HotspareType
The type of hot spare that this drive serves as.
string Description
The drive is serving as a hot spare for all other drives in this storage domain that are
Chassis
contained in the same chassis.
The drive is serving as a hot spare for a user-defined set of drives or volumes. Clients cannot
Dedicated specify this value when modifying the HotspareType property. This value is reported as a
result of configuring the spare drives within a volume.
Global The drive is serving as a hot spare for all other drives in this storage domain.
None The drive is not a hot spare.
6.32.5.6 IndicatorLED
The state of the indicator LED, that identifies the drive.
string Description
Blinking The indicator LED is blinking.
Lit The indicator LED is lit.
Off The indicator LED is off.
316 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.32.5.7 MediaType
The type of media contained in this drive.
string Description
HDD The drive media type is traditional magnetic platters.
SMR The drive media type is shingled magnetic recording.
SSD The drive media type is solid state or flash memory.
6.32.5.8 Operation
The type of the operation.
string Description
ChangeRAIDType A ChangeRAIDType operation is being performed.
CheckConsistency A CheckConsistency operation is being performed.
Compress A Compress operation is being performed.
Decrypt A Decrypt operation is being performed.
Deduplicate A Deduplicate operation is being performed.
Delete A Delete operation is being performed.
Encrypt An Encrypt operation is being performed.
Format A Format operation is being performed.
Initialize An Initialize operation is being performed.
Rebuild A Rebuild operation is being performed.
Replicate A Replicate operation is being performed.
Resize A Resize operation is being performed.
Sanitize A Sanitize operation is being performed.
6.32.5.9 Protocol
The protocol that this drive currently uses to communicate to the storage controller.
Version 2023.1 Published 317
Redfish Resource and Schema Guide DSP2046
string Description
AHCI Advanced Host Controller Interface (AHCI).
CXL Compute Express Link.
DisplayPort DisplayPort.
DVI DVI.
Ethernet Ethernet.
FC Fibre Channel.
FCoE Fibre Channel over Ethernet (FCoE).
FCP Fibre Channel Protocol for SCSI.
FICON FIbre CONnection (FICON).
FTP File Transfer Protocol (FTP).
GenZ GenZ.
HDMI HDMI.
HTTP Hypertext Transport Protocol (HTTP).
HTTPS Hypertext Transfer Protocol Secure (HTTPS).
I2C Inter-Integrated Circuit Bus.
InfiniBand InfiniBand.
iSCSI Internet SCSI.
iWARP Internet Wide Area RDMA Protocol (iWARP).
MultiProtocol Multiple Protocols.
NFSv3 Network File System (NFS) version 3.
NFSv4 Network File System (NFS) version 4.
NVLink NVLink.
NVMe Non-Volatile Memory Express (NVMe).
NVMeOverFabrics NVMe over Fabrics.
OEM OEM-specific.
PCIe PCI Express.
318 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
RoCE RDMA over Converged Ethernet Protocol.
RoCEv2 RDMA over Converged Ethernet Protocol Version 2.
SAS Serial Attached SCSI.
SATA Serial AT Attachment.
SFTP SSH File Transfer Protocol (SFTP).
SMB Server Message Block (SMB). Also known as the Common Internet File System (CIFS).
TCP Transmission Control Protocol (TCP).
TFTP Trivial File Transfer Protocol (TFTP).
UDP User Datagram Protocol (UDP).
UHCI Universal Host Controller Interface (UHCI).
USB Universal Serial Bus (USB).
VGA VGA.
6.32.5.10 ResetType
The type of reset.
string Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
ForceOn Turn on the unit immediately.
ForceRestart Shut down immediately and non-gracefully and restart the system.
GracefulRestart Shut down gracefully and restart the system.
GracefulShutdown Shut down gracefully and power off.
Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal
Nmi
operations, complete diagnostic actions, and, typically, halt the system.
On Turn on the unit.
Pause execution on the unit but do not remove power. This is typically a feature of virtual
Pause
machine hypervisors.
Version 2023.1 Published 319
Redfish Resource and Schema Guide DSP2046
string Description
Power cycle the unit. Behaves like a full power removal, followed by a power restore to the
PowerCycle
resource.
PushPowerButton Simulate the pressing of the physical power button on this unit.
Resume execution on the paused unit. This is typically a feature of virtual machine
Resume
hypervisors.
Write the state of the unit to disk before powering off. This allows for the state to be restored
Suspend
when powered back on.
6.32.5.11 SanitizationType
The type of data sanitization to perform.
string Description
Delete all logical block addresses, including those that are not currently mapping to active
BlockErase
addresses, but leaving the data on the drive.
Erase the target data's encryption key leaving only the ciphertext on the drive. For more
CryptographicErase
information, see NIST800-88 and ISO/IEC 27040.
Overwrite Overwrite data by writing an implementation specific pattern onto all sectors of the drive.
6.32.5.12 SlotCapableProtocols
The drive protocols capable in this slot.
string Description
AHCI Advanced Host Controller Interface (AHCI).
CXL Compute Express Link.
DisplayPort DisplayPort.
DVI DVI.
Ethernet Ethernet.
FC Fibre Channel.
FCoE Fibre Channel over Ethernet (FCoE).
320 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
FCP Fibre Channel Protocol for SCSI.
FICON FIbre CONnection (FICON).
FTP File Transfer Protocol (FTP).
GenZ GenZ.
HDMI HDMI.
HTTP Hypertext Transport Protocol (HTTP).
HTTPS Hypertext Transfer Protocol Secure (HTTPS).
I2C Inter-Integrated Circuit Bus.
InfiniBand InfiniBand.
iSCSI Internet SCSI.
iWARP Internet Wide Area RDMA Protocol (iWARP).
MultiProtocol Multiple Protocols.
NFSv3 Network File System (NFS) version 3.
NFSv4 Network File System (NFS) version 4.
NVLink NVLink.
NVMe Non-Volatile Memory Express (NVMe).
NVMeOverFabrics NVMe over Fabrics.
OEM OEM-specific.
PCIe PCI Express.
RoCE RDMA over Converged Ethernet Protocol.
RoCEv2 RDMA over Converged Ethernet Protocol Version 2.
SAS Serial Attached SCSI.
SATA Serial AT Attachment.
SFTP SSH File Transfer Protocol (SFTP).
SMB Server Message Block (SMB). Also known as the Common Internet File System (CIFS).
TCP Transmission Control Protocol (TCP).
Version 2023.1 Published 321
Redfish Resource and Schema Guide DSP2046
string Description
TFTP Trivial File Transfer Protocol (TFTP).
UDP User Datagram Protocol (UDP).
UHCI Universal Host Controller Interface (UHCI).
USB Universal Serial Bus (USB).
VGA VGA.
6.32.5.13 SlotFormFactor
The form factor of the slot.
string Description
Drive2_5 A 2.5 inch drive.
Drive3_5 A 3.5 inch drive.
EDSFF_1U_Long An EDSFF 1U Long (E1.L) drive.
EDSFF_1U_Short An EDSFF 1U Short (E1.S) drive.
EDSFF_E3_Long An EDSFF E3 Long (E3.L) drive.
EDSFF_E3_Short An EDSFF E3 Short (E3.S) drive.
M2_22110 An M.2 22110 drive.
M2_2230 An M.2 2230 drive.
M2_2242 An M.2 2242 drive.
M2_2260 An M.2 2260 drive.
M2_2280 An M.2 2280 drive.
OEM An OEM-defined form factor.
PCIeHalfLength A half length PCIe add in card.
PCIeSlotFullLength A full length PCIe add in card.
PCIeSlotLowProfile A low profile PCIe add in card.
U2 A U.2 drive.
322 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.32.5.14 StatusIndicator
The state of the status indicator, which communicates status information about this drive.
string Description
Fail The drive has failed.
Hotspare The drive has been marked to automatically rebuild and replace a failed drive.
InACriticalArray The array to which this drive belongs has been degraded.
InAFailedArray The array to which this drive belongs has failed.
OK The drive is OK.
PredictiveFailureAnalysis The drive still works but is predicted to fail soon.
Rebuild The drive is being rebuilt.
6.32.6 Example response
{
"@odata.type": "#Drive.v1_17_0.Drive",
"Id": "3D58ECBC375FD9F2",
"Name": "Drive Sample",
"LocationIndicatorActive": true,
"Model": "C123",
"Revision": "100A",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"CapacityBytes": 899527000000,
"FailurePredicted": false,
"Protocol": "SAS",
"MediaType": "HDD",
"Manufacturer": "Contoso",
"SerialNumber": "1234568",
"PartNumber": "C123-1111",
"Identifiers": [
{
"DurableNameFormat": "NAA",
"DurableName": "32ADF365C6C1B7BD"
}
],
"HotspareType": "None",
Version 2023.1 Published 323
Redfish Resource and Schema Guide DSP2046
"EncryptionAbility": "SelfEncryptingDrive",
"EncryptionStatus": "Unlocked",
"RotationSpeedRPM": 15000,
"BlockSizeBytes": 512,
"CapableSpeedGbs": 12,
"NegotiatedSpeedGbs": 12,
"Links": {
"Volumes": [
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Volumes/2"
},
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Volumes/3"
}
]
},
"Actions": {
"#Drive.SecureErase": {
"target": "/redfish/v1/Systems/437XR1138R2/Storage/1/Drives/3D58ECBC375FD9F2/Actions/Drive.SecureErase"
}
},
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Drives/3D58ECBC375FD9F2"
}
6.33 DriveMetrics 1.0.0
Version v1.0
Release 2023.1
6.33.1 Description
The usage and health statistics for a drive.
6.33.2 URIs
/redfish/v1/Chassis/{ChassisId}/Drives/{DriveId}/Metrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}/Metrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/
{DriveId}/Metrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/Drives/{DriveId}/Metrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}/Metrics
324 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/{DriveId}/Metrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
Drives/{DriveId}/Metrics
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/Metrics
6.33.3 Properties
Property Type Attributes Notes
read-only
BadBlockCount integer The total number of bad blocks reported by the drive.
(null)
read-only The number of the correctable read errors for the lifetime of
CorrectableIOReadErrorCount integer
(null) the drive.
read-only The number of the correctable write errors for the lifetime of
CorrectableIOWriteErrorCount integer
(null) the drive.
The NVMe SMART metrics for the drive. See the
NVMeSMART { object
StorageControllerMetrics schema for details on this property.
Link to a NVMeSMARTMetrics resource. See the Links section
@odata.id string read-only
and the StorageControllerMetrics schema for details.
read-only
PowerOnHours number The number of power-on hours for the lifetime of the drive.
(null)
read-only The number of the uncorrectable read errors for the lifetime
UncorrectableIOReadErrorCount integer
(null) of the drive.
read-only The number of the uncorrectable write errors for the lifetime
UncorrectableIOWriteErrorCount integer
(null) of the drive.
6.33.4 Example response
{
"@odata.type": "#DriveMetrics.v1_0_0.DriveMetrics",
"Id": "Metrics",
"Name": "Drive Metrics",
"CorrectableIOReadErrorCount": 184,
"UncorrectableIOReadErrorCount": 0,
"CorrectableIOWriteErrorCount": 18,
"UncorrectableIOWriteErrorCount": 0,
"BadBlockCount": 123098,
"PowerOnHours": 3,
Version 2023.1 Published 325
Redfish Resource and Schema Guide DSP2046
"NVMeSMART": {
"CriticalWarnings": {
"PMRUnreliable": false,
"PowerBackupFailed": false,
"MediaInReadOnly": false,
"OverallSubsystemDegraded": false,
"SpareCapacityWornOut": false
},
"CompositeTemperatureCelsius": 34,
"AvailableSparePercent": 50,
"AvailableSpareThresholdPercent": 30,
"PercentageUsed": 50,
"EGCriticalWarningSummary": {
"NamespacesInReadOnlyMode": false,
"ReliabilityDegraded": false,
"SpareCapacityUnderThreshold": false
},
"DataUnitsRead": 0,
"DataUnitsWritten": 0,
"HostReadCommands": 0,
"HostWriteCommands": 0,
"ControllerBusyTimeMinutes": 20,
"PowerCycles": 49,
"PowerOnHours": 3,
"UnsafeShutdowns": 4,
"MediaAndDataIntegrityErrors": 0,
"NumberOfErrorInformationLogEntries": 100,
"WarningCompositeTempTimeMinutes": 0,
"CriticalCompositeTempTimeMinutes": 0,
"TemperatureSensorsCelsius": [
34,
34,
34,
34,
34,
35,
33,
32
],
"ThermalMgmtTemp1TransitionCount": 10,
"ThermalMgmtTemp2TransitionCount": 2,
"ThermalMgmtTemp1TotalTimeSeconds": 20,
"ThermalMgmtTemp2TotalTimeSeconds": 42
},
"@odata.id": "/redfish/v1/Chassis/StorageEnclosure1/Drives/0THGR0KP/Metrics"
}
326 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.34 Endpoint 1.8.0
Version v1.8 v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.3 2022.1 2021.1 2020.3 2019.4 2018.3 2018.2 2017.3 2016.2
6.34.1 Description
The Endpoint schema contains the properties of an endpoint resource that represents the properties of
an entity that sends or receives protocol-defined messages over a transport.
6.34.2 URIs
/redfish/v1/Fabrics/{FabricId}/Endpoints/{EndpointId}
/redfish/v1/Storage/{StorageId}/Endpoints/{EndpointId}
/redfish/v1/StorageServices/{StorageServiceId}/Endpoints/{EndpointId}
6.34.3 Properties
Property Type Attributes Notes
ConnectedEntities [ { array All the entities connected to this endpoint.
EntityLink { object The link to the associated entity.
string
@odata.id read-only The unique identifier for a resource.
(URI)
EntityPciId { object The PCI ID of the connected entity.
read-only The Class Code, Subclass, and Programming Interface code of
ClassCode (v1.2+) string
(null) this PCIe function.
read-only
DeviceId string The Device ID of this PCIe function.
(null)
read-only
FunctionNumber (v1.2+) integer The PCI ID of the connected entity.
(null)
read-only
SubsystemId string The Subsystem ID of this PCIe function.
(null)
Version 2023.1 Published 327
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
SubsystemVendorId string The Subsystem Vendor ID of this PCIe function.
(null)
read-only
VendorId string The Vendor ID of this PCIe function.
(null)
string read-only The role of the connected entity. For the possible property
EntityRole
(enum) (null) values, see EntityRole in Property details.
string read-only The type of the connected entity. For the possible property
EntityType
(enum) (null) values, see EntityType in Property details.
GenZ (v1.4+) { object The Gen-Z related properties for the entity.
(null)
The Access Key for the entity. Deprecated in v1.6 and later.
AccessKey (v1.4+, read-write
string This property has been deprecated in favor of the
deprecated v1.6 (null)
ConnectionKeys property in the Connection resource.
GCID (v1.4+) { object The Global Component ID (GCID) for the entity.
(null)
read-write
CID (v1.4+) string The component identifier portion of the GCID for the entity.
(null)
read-write
SID (v1.4+) string The subnet identifier portion of the GCID for the entity.
(null)
The Region Key for the entity. Deprecated in v1.6 and later.
RegionKey (v1.4+, read-write
string This property has been deprecated in favor of the
deprecated v1.6 (null)
ConnectionKeys property in the Connection resource.
array Identifiers for the remote entity. For property details, see
Identifiers [ { } ]
(object) Identifier.
See the Oem object definition in the Common properties
Oem {} object
section.
The Class Code, Subclass, and Programming Interface code of
PciClassCode (deprecated read-only this PCIe function. Deprecated in v1.2 and later. This property
string
v1.2) (null) has been deprecated in favor of the ClassCode property inside
the EntityPciId object.
328 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The PCI ID of the connected entity. Deprecated in v1.2 and
PciFunctionNumber read-only
integer later. This property has been deprecated in favor of the
(deprecated v1.2) (null)
FunctionNumber property inside the EntityPciId object.
}]
string read-only The protocol supported by this endpoint. For the possible
EndpointProtocol
(enum) (null) property values, see EndpointProtocol in Property details.
integer read-only The amount of memory in bytes that the host should allocate
HostReservationMemoryBytes
(bytes) (null) to connect to this endpoint.
array
Identifiers [ { } ] Identifiers for this endpoint. For property details, see Identifier.
(object)
An array of details for each IP transport supported by this
IPTransportDetails (v1.1+) [ { array endpoint. The array structure can model multiple IP addresses
for this endpoint.
The IPv4 addresses assigned to the endpoint. For property
IPv4Address (v1.1+) {} object
details, see IPv4Address.
The IPv6 addresses assigned to the endpoint. For property
IPv6Address (v1.1+) {} object
details, see IPv6Address.
Port (v1.1+) number read-only The UDP or TCP port number used by the endpoint.
string The protocol used by the connection entity. For the possible
TransportProtocol (v1.1+) read-only
(enum) property values, see TransportProtocol in Property details.
}]
Links { object The links to other resources that are related to this resource.
An array of links to the address pools associated with this
AddressPools (v1.4+) [ { array
endpoint.
Link to a AddressPool resource. See the Links section and the
@odata.id string read-write
AddressPool schema for details.
}]
An array of links to the switch ports or remote device ports at
ConnectedPorts (v1.4+) [ { array
the other end of the link.
Link to a Port resource. See the Links section and the Port
@odata.id string read-only
schema for details.
}]
Connections (v1.5+) [ { array The connections to which this endpoint belongs.
Version 2023.1 Published 329
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to a Connection resource. See the Links section and the
@odata.id string read-only
Connection schema for details.
}]
An array of links to the device ports that this endpoint
LocalPorts (v1.7+) [ { array
represents.
Link to a Port resource. See the Links section and the Port
@odata.id string read-only
schema for details.
}]
MutuallyExclusiveEndpoints An array of links to the endpoints that cannot be used in zones
array
[{ if this endpoint is in a zone.
@odata.id string read-only Link to another Endpoint resource.
}]
When NetworkDeviceFunction resources are present, this
NetworkDeviceFunction
array array contains links to the network device functions that
(v1.1+) [ {
connect to this endpoint.
Link to a NetworkDeviceFunction resource. See the Links
@odata.id string read-only
section and the NetworkDeviceFunction schema for details.
}]
See the Oem object definition in the Common properties
Oem {} object
section.
An array of links to the physical ports associated with this
endpoint. Deprecated in v1.7 and later. This property has been
Ports (deprecated v1.7) [ { array
deprecated in favor of the ConnectedPorts and LocalPorts
properties to clarify the semantics of each port referenced.
Link to a Port resource. See the Links section and the Port
@odata.id string read-only
schema for details.
}]
Zones (v1.6+) [ { array The zones to which this endpoint belongs.
Link to a Zone resource. See the Links section and the Zone
@odata.id string read-only
schema for details.
}]
330 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
PciId { object The PCI ID of the endpoint.
read-only The Class Code, Subclass, and Programming Interface code of
ClassCode (v1.2+) string
(null) this PCIe function.
read-only
DeviceId string The Device ID of this PCIe function.
(null)
read-only
FunctionNumber (v1.2+) integer The PCI ID of the connected entity.
(null)
read-only
SubsystemId string The Subsystem ID of this PCIe function.
(null)
read-only
SubsystemVendorId string The Subsystem Vendor ID of this PCIe function.
(null)
read-only
VendorId string The Vendor ID of this PCIe function.
(null)
Redundancy information for the lower-level endpoints
array
Redundancy [ { } ] supporting this endpoint. For property details, see
(object)
Redundancy.
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
6.34.4 Property details
6.34.4.1 EndpointProtocol
The protocol supported by this endpoint.
string Description
AHCI Advanced Host Controller Interface (AHCI).
CXL Compute Express Link.
DisplayPort DisplayPort.
DVI DVI.
Ethernet Ethernet.
Version 2023.1 Published 331
Redfish Resource and Schema Guide DSP2046
string Description
FC Fibre Channel.
FCoE Fibre Channel over Ethernet (FCoE).
FCP Fibre Channel Protocol for SCSI.
FICON FIbre CONnection (FICON).
FTP File Transfer Protocol (FTP).
GenZ GenZ.
HDMI HDMI.
HTTP Hypertext Transport Protocol (HTTP).
HTTPS Hypertext Transfer Protocol Secure (HTTPS).
I2C Inter-Integrated Circuit Bus.
InfiniBand InfiniBand.
iSCSI Internet SCSI.
iWARP Internet Wide Area RDMA Protocol (iWARP).
MultiProtocol Multiple Protocols.
NFSv3 Network File System (NFS) version 3.
NFSv4 Network File System (NFS) version 4.
NVLink NVLink.
NVMe Non-Volatile Memory Express (NVMe).
NVMeOverFabrics NVMe over Fabrics.
OEM OEM-specific.
PCIe PCI Express.
RoCE RDMA over Converged Ethernet Protocol.
RoCEv2 RDMA over Converged Ethernet Protocol Version 2.
SAS Serial Attached SCSI.
SATA Serial AT Attachment.
SFTP SSH File Transfer Protocol (SFTP).
332 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
SMB Server Message Block (SMB). Also known as the Common Internet File System (CIFS).
TCP Transmission Control Protocol (TCP).
TFTP Trivial File Transfer Protocol (TFTP).
UDP User Datagram Protocol (UDP).
UHCI Universal Host Controller Interface (UHCI).
USB Universal Serial Bus (USB).
VGA VGA.
6.34.4.2 EntityRole
The role of the connected entity.
string Description
The entity can both send and receive commands, messages, and other requests to or from
Both
other entities on the fabric.
The entity sends commands, messages, or other types of requests to other entities on the
Initiator
fabric, but cannot receive commands from other entities.
The entity receives commands, messages, or other types of requests from other entities on
Target
the fabric, but cannot send commands to other entities.
6.34.4.3 EntityType
The type of the connected entity.
string Description
AccelerationFunction
The entity is an acceleration function realized through a device, such as an FPGA.
(v1.3+)
Bridge The entity is a PCI(e) bridge.
CXLDevice (v1.8+) The entity is a CXL logical device.
DisplayController The entity is a display controller.
Drive The entity is a drive.
Version 2023.1 Published 333
Redfish Resource and Schema Guide DSP2046
string Description
FabricBridge (v1.4+) The entity is a fabric bridge.
Manager (v1.5+) The entity is a manager.
MediaController (v1.4+) The entity is a media controller.
Memory (v1.8+) The entity is a memory device.
MemoryChunk (v1.4+) The entity is a memory chunk.
NetworkController The entity is a network controller.
Processor The entity is a processor.
RootComplex The entity is a PCI(e) root complex.
StorageExpander The entity is a storage expander.
StorageInitiator The entity is a storage initiator.
StorageSubsystem (v1.6+) The entity is a storage subsystem.
Switch (v1.4+) The entity is a switch, not an expander. Use Expander for expanders.
Volume (v1.1+) The entity is a volume.
6.34.4.4 TransportProtocol
The protocol used by the connection entity.
string Description
AHCI Advanced Host Controller Interface (AHCI).
CXL Compute Express Link.
DisplayPort DisplayPort.
DVI DVI.
Ethernet Ethernet.
FC Fibre Channel.
FCoE Fibre Channel over Ethernet (FCoE).
FCP Fibre Channel Protocol for SCSI.
FICON FIbre CONnection (FICON).
334 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
FTP File Transfer Protocol (FTP).
GenZ GenZ.
HDMI HDMI.
HTTP Hypertext Transport Protocol (HTTP).
HTTPS Hypertext Transfer Protocol Secure (HTTPS).
I2C Inter-Integrated Circuit Bus.
InfiniBand InfiniBand.
iSCSI Internet SCSI.
iWARP Internet Wide Area RDMA Protocol (iWARP).
MultiProtocol Multiple Protocols.
NFSv3 Network File System (NFS) version 3.
NFSv4 Network File System (NFS) version 4.
NVLink NVLink.
NVMe Non-Volatile Memory Express (NVMe).
NVMeOverFabrics NVMe over Fabrics.
OEM OEM-specific.
PCIe PCI Express.
RoCE RDMA over Converged Ethernet Protocol.
RoCEv2 RDMA over Converged Ethernet Protocol Version 2.
SAS Serial Attached SCSI.
SATA Serial AT Attachment.
SFTP SSH File Transfer Protocol (SFTP).
SMB Server Message Block (SMB). Also known as the Common Internet File System (CIFS).
TCP Transmission Control Protocol (TCP).
TFTP Trivial File Transfer Protocol (TFTP).
UDP User Datagram Protocol (UDP).
Version 2023.1 Published 335
Redfish Resource and Schema Guide DSP2046
string Description
UHCI Universal Host Controller Interface (UHCI).
USB Universal Serial Bus (USB).
VGA VGA.
6.34.5 Example response
{
"@odata.type": "#Endpoint.v1_8_0.Endpoint",
"Id": "Drive1",
"Name": "SAS Drive",
"Description": "The SAS Drive in Enclosure 2 Bay 0",
"EndpointProtocol": "SAS",
"ConnectedEntities": [
{
"EntityType": "Drive",
"EntityRole": "Target",
"Identifiers": [
{
"DurableNameFormat": "NAA",
"DurableName": "32ADF365C6C1B7C3"
}
]
}
],
"Links": {
"MutuallyExclusiveEndpoints": [
{
"@odata.id": "/redfish/v1/Fabrics/SAS/Endpoints/Enclosure2"
}
],
"ConnectedPorts": [
{
"@odata.id": "/redfish/v1/Fabrics/SAS/Switches/Switch1/Ports/8"
},
{
"@odata.id": "/redfish/v1/Fabrics/SAS/Switches/Switch2/Ports/8"
}
]
},
"@odata.id": "/redfish/v1/Fabrics/SAS/Endpoints/Drive1"
}
336 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.35 EndpointGroup 1.3.2
Version v1.3 v1.2 v1.1 v1.0
Release 2020.3 WIP v1.1.0 WIP v1.0.5 TP v1.0.3
6.35.1 Description
The EndpointGroup schema describes group of endpoints that are managed as a unit.
6.35.2 URIs
/redfish/v1/Fabrics/{FabricId}/EndpointGroups/{EndpointGroupId}
/redfish/v1/Storage/{StorageId}/EndpointGroups/{EndpointGroupId}
/redfish/v1/StorageServices/{StorageServiceId}/EndpointGroups/{EndpointGroupId}
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/EndpointGroups/{EndpointGroupId}
6.35.3 Properties
Property Type Attributes Notes
The access state for this group. For the possible property
string read-write values, see AccessState in Property details. Deprecated in v1.3
AccessState (deprecated v1.3)
(enum) (null) and later. This property has been deprecated in favor of the
AccessState property in the connection resource.
The endpoints in this endpoint group. Deprecated in v1.3 and
Endpoints (deprecated v1.3) [ { array later. This property has been deprecated in favor of the
Endpoints property within Links.
Link to a Endpoint resource. See the Links section and the
@odata.id string read-write
Endpoint schema for details.
}]
string read-write The endpoint group type. For the possible property values, see
GroupType
(enum) (null) GroupType in Property details.
The durable name for the endpoint group. For property details,
Identifier {} object
see Identifier.
Links { object The links to other resources that are related to this resource.
Connections (v1.3+) [ { array The connections to which this endpoint group belongs.
Version 2023.1 Published 337
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to a Connection resource. See the Links section and the
@odata.id string read-only
Connection schema for details.
}]
Endpoints (v1.3+) [ { array The endpoints in this endpoint group.
Link to a Endpoint resource. See the Links section and the
@odata.id string read-write
Endpoint schema for details.
}]
See the Oem object definition in the Common properties
Oem {} object
section.
An indication if access to the resources through the endpoint
read-write group is preferred. Deprecated in v1.2 and later. This property
Preferred (deprecated v1.2) boolean
(null) has been deprecated in favor of the AccessState property in
the connection resource.
read-write
TargetEndpointGroupIdentifier integer The SCSI-defined identifier for this group.
(null)
6.35.4 Property details
6.35.4.1 AccessState
The access state for this group.
string Description
NonOptimized The endpoints are in an active and non-optimized state.
Optimized The endpoints are in an active and optimized state.
Standby The endpoints are in a standby state.
Transitioning The endpoints are transitioning to a new state.
Unavailable The endpoints are in an unavailable state.
6.35.4.2 GroupType
The endpoint group type.
338 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
The group contains the client (initiator) endpoints. Deprecated in v1.3 and later. This value
Client (deprecated v1.3)
has been deprecated in favor of Initiator .
Initiator (v1.3+) The group contains the initiator endpoints.
The group contains the server (target) endpoints. Deprecated in v1.3 and later. This value
Server (deprecated v1.3)
has been deprecated in favor of Target .
Target (v1.3+) The group contains the target endpoints.
6.35.5 Example response
{
"@odata.type": "#EndpointGroup.v1_3_2.EndpointGroup",
"Id": "1",
"Name": "Endpoint group for all initiators",
"GroupType": "Initiator",
"Links": {
"Endpoints": [
{
"@odata.id": "/redfish/v1/Fabrics/NVMeoF/Endpoints/Initiator1"
},
{
"@odata.id": "/redfish/v1/Fabrics/NVMeoF/Endpoints/Initiator2"
}
],
"Connections": [
{
"@odata.id": "/redfish/v1/Fabrics/NVMeoF/Connections/3"
}
]
},
"@odata.id": "/redfish/v1/Fabrics/NVMeoF/EndpointGroups/1"
}
6.36 EnvironmentMetrics 1.3.0
Version v1.3 v1.2 v1.1 v1.0
Release 2022.2 2021.4 2021.2 2020.4
Version 2023.1 Published 339
Redfish Resource and Schema Guide DSP2046
6.36.1 Description
The EnvironmentMetrics schema represents the environmental metrics of a device.
6.36.2 URIs
/redfish/v1/Chassis/{ChassisId}/Drives/{DriveId}/EnvironmentMetrics
/redfish/v1/Chassis/{ChassisId}/EnvironmentMetrics
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/EnvironmentMetrics
/redfish/v1/Chassis/{ChassisId}/MediaControllers/{MediaControllerId}/EnvironmentMetrics
/redfish/v1/Chassis/{ChassisId}/MediaControllers/{MediaControllerId}/Ports/{PortId}/
EnvironmentMetrics
/redfish/v1/Chassis/{ChassisId}/Memory/{MemoryId}/EnvironmentMetrics
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/EnvironmentMetrics
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Ports/{PortId}/
EnvironmentMetrics
/redfish/v1/Chassis/{ChassisId}/PCIeDevices/{PCIeDeviceId}/EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}/
EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/
EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/
EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Ports/
{PortId}/EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/
{ControllerId}/EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/
{StorageControllerId}/Ports/{PortId}/EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/
{DriveId}/EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/
StorageControllers/{StorageControllerId}/Ports/{PortId}/EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/Ports/{PortId}/EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
GraphicsControllers/{ControllerId}/Ports/{PortId}/EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Memory/{MemoryId}/EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
PCIeDevices/{PCIeDeviceId}/EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
340 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Processors/{ProcessorId}/EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}/Ports/{PortId}/EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/Controllers/{ControllerId}/EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/Controllers/{StorageControllerId}/Ports/{PortId}/EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/Drives/{DriveId}/EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}/EnvironmentMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
USBControllers/{ControllerId}/Ports/{PortId}/EnvironmentMetrics
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/EnvironmentMetrics
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/EnvironmentMetrics
/redfish/v1/Facilities/{FacilityId}/AmbientMetrics
/redfish/v1/Facilities/{FacilityId}/EnvironmentMetrics
/redfish/v1/Managers/{ManagerId}/DedicatedNetworkPorts/{PortId}/EnvironmentMetrics
/redfish/v1/Managers/{ManagerId}/USBPorts/{PortId}/EnvironmentMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}/EnvironmentMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/EnvironmentMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/EnvironmentMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Ports/{PortId}/
EnvironmentMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{ControllerId}/
EnvironmentMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{StorageControllerId}/
Ports/{PortId}/EnvironmentMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/{DriveId}/
EnvironmentMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/
{StorageControllerId}/Ports/{PortId}/EnvironmentMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/
{FabricAdapterId}/Ports/{PortId}/EnvironmentMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/GraphicsControllers/
{ControllerId}/Ports/{PortId}/EnvironmentMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory/{MemoryId}/
EnvironmentMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/PCIeDevices/
{PCIeDeviceId}/EnvironmentMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/
{ProcessorId}/EnvironmentMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/
{ProcessorId}/Ports/{PortId}/EnvironmentMetrics
Version 2023.1 Published 341
Redfish Resource and Schema Guide DSP2046
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
Controllers/{ControllerId}/EnvironmentMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
Controllers/{StorageControllerId}/Ports/{PortId}/EnvironmentMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
Drives/{DriveId}/EnvironmentMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
StorageControllers/{StorageControllerId}/Ports/{PortId}/EnvironmentMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/USBControllers/
{ControllerId}/Ports/{PortId}/EnvironmentMetrics
/redfish/v1/Storage/{StorageId}/Controllers/{ControllerId}/EnvironmentMetrics
/redfish/v1/Storage/{StorageId}/Controllers/{StorageControllerId}/Ports/{PortId}/EnvironmentMetrics
/redfish/v1/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}/
EnvironmentMetrics
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/
EnvironmentMetrics
/redfish/v1/Systems/{ComputerSystemId}/GraphicsControllers/{ControllerId}/Ports/{PortId}/
EnvironmentMetrics
/redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}/EnvironmentMetrics
/redfish/v1/Systems/{ComputerSystemId}/PCIeDevices/{PCIeDeviceId}/EnvironmentMetrics
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/EnvironmentMetrics
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Ports/{PortId}/
EnvironmentMetrics
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{ControllerId}/
EnvironmentMetrics
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/
Ports/{PortId}/EnvironmentMetrics
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/EnvironmentMetrics
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/
{StorageControllerId}/Ports/{PortId}/EnvironmentMetrics
/redfish/v1/Systems/{ComputerSystemId}/USBControllers/{ControllerId}/Ports/{PortId}/
EnvironmentMetrics
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/EnvironmentMetrics
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/EnvironmentMetrics
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/EnvironmentMetrics
6.36.3 Properties
Property Type Attributes Notes
AbsoluteHumidity Absolute humidity (g/cu m). For more information about this property,
object
(v1.2+) {} see SensorExcerpt in Property Details.
342 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
DewPointCelsius The dew point temperature (C). For more information about this
object
(v1.1+) {} property, see SensorExcerpt in Property Details.
Energy consumption (J). For more information about this property, see
EnergyJoules (v1.2+) {} object
SensorExcerpt in Property Details.
object Energy consumption (kWh). This object is an excerpt of the Sensor
EnergykWh {
(excerpt) resource located at the URI shown in DataSourceUri.
ApparentkVAh number read-only
Apparent energy (kVAh).
(v1.5+) (kV.A.h) (null)
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
LifetimeReading read-only
number The total accumulation value for this sensor.
(v1.1+) (null)
ReactivekVARh number read-only
Reactive energy (kVARh).
(v1.5+) (kV.A.h) (null)
read-only
Reading number The sensor value.
(null)
string read-only
SensorResetTime The date and time when the time-based properties were last reset.
(date-time) (null)
array Fan speeds (percent). This object is an excerpt of the Sensor resource
FanSpeedsPercent [ {
(excerpt) located at the URI shown in DataSourceUri.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
DeviceName (v1.2+) string The name of the device.
(null)
string read-only The area or device to which this sensor measurement applies. For the
PhysicalContext
(enum) (null) possible property values, see PhysicalContext in Property details.
The usage or location within a device to which this sensor
string read-only
PhysicalSubContext measurement applies. For the possible property values, see
(enum) (null)
PhysicalSubContext in Property details.
read-only
Reading number The sensor value.
(null)
number read-only
SpeedRPM (v1.2+) The rotational speed.
({rev}/min) (null)
Version 2023.1 Published 343
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
}]
Humidity (percent). For more information about this property, see
HumidityPercent {} object
SensorExcerpt in Property Details.
PowerLimitWatts object Power limit (W). This object is an excerpt of the Control resource
(v1.1+) { (excerpt) located at the URI shown in DataSourceUri.
read-only
AllowableMax number The maximum possible setting for this control.
(null)
read-only
AllowableMin number The minimum possible setting for this control.
(null)
string read-write The current operating mode of the control. For the possible property
ControlMode
(enum) (null) values, see ControlMode in Property details.
string read-only
DataSourceUri The link to the resource that provides the data for this control.
(URI) (null)
DefaultSetPoint read-only
number The default set point of the control.
(v1.3+) (null)
read-only
Reading number The reading of the sensor associated with this control.
(null)
read-only
ReadingUnits string The units of the sensor reading associated with this control.
(null)
read-write
SetPoint number The desired set point of the control.
(null)
PowerLoadPercent The power load (percent) for this device. For more information about
object
(v1.1+) {} this property, see SensorExcerpt in Property Details.
object Power consumption (W). This object is an excerpt of the Sensor
PowerWatts {
(excerpt) resource located at the URI shown in DataSourceUri.
number read-only The product of voltage and current for an AC circuit, in volt-ampere
ApparentVA
(V.A) (null) units.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
PhaseAngleDegrees read-only The phase angle (degrees) between the current and voltage
number
(v1.5+) (null) waveforms.
read-only
PowerFactor number The power factor for this sensor.
(null)
344 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
number read-only The square root of the difference term of squared apparent VA and
ReactiveVAR
(V.A) (null) squared power (Reading) for a circuit, in VAR units.
read-only
Reading number The sensor value.
(null)
Temperature (Celsius). For more information about this property, see
TemperatureCelsius {} object
SensorExcerpt in Property Details.
6.36.4 Actions
6.36.4.1 ResetMetrics
Description
This action resets the summary metrics related to this equipment.
Action URI
{Base URI of target resource}/Actions/EnvironmentMetrics.ResetMetrics
Action parameters
This action takes no parameters.
6.36.4.2 ResetToDefaults (v1.3+)
Description
The action resets the values of writable properties to factory defaults.
Action URI
{Base URI of target resource}/Actions/EnvironmentMetrics.ResetToDefaults
Action parameters
This action takes no parameters.
Version 2023.1 Published 345
Redfish Resource and Schema Guide DSP2046
6.36.5 Property details
6.36.5.1 ControlMode
The current operating mode of the control.
string Description
Automatic Automatically adjust control to meet the set point.
Disabled The control has been disabled.
Manual No automatic adjustments are made to the control.
Override User override of the automatic set point value.
6.36.5.2 PhysicalContext
The area or device to which this sensor measurement applies.
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
ComputeBay Within a compute bay.
346 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
GPU A graphics processor (GPU).
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
Version 2023.1 Published 347
Redfish Resource and Schema Guide DSP2046
string Description
StorageBay Within a storage bay.
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
6.36.5.3 PhysicalSubContext
The usage or location within a device to which this sensor measurement applies.
string Description
Input The input.
Output The output.
6.36.5.4 SensorExcerpt
The Sensor schema describes a sensor and its properties. This object is an excerpt of the Sensor
resource located at the URI shown in DataSourceUri.
read-
string
DataSourceUri only The link to the resource that provides the data for this sensor.
(URI)
(null)
read-
Reading number only The sensor value.
(null)
348 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.36.6 Example response
{
"@odata.type": "#EnvironmentMetrics.v1_3_0.EnvironmentMetrics",
"Name": "Processor Environment Metrics",
"TemperatureCelsius": {
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/CPU1Temp",
"Reading": 44
},
"PowerWatts": {
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/CPU1Power",
"Reading": 12.87
},
"FanSpeedsPercent": [
{
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/CPUFan1",
"DeviceName": "CPU #1 Fan Speed",
"Reading": 80
}
],
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Processors/1/EnvironmentMetrics"
}
6.37 EthernetInterface 1.10.0
Version v1.10 v1.9 v1.8 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2023.1 2022.2 2021.2 2020.1 2019.1 2017.3 2017.1 2016.3 2016.2 1.0
6.37.1 Description
The EthernetInterface schema represents a single, logical Ethernet interface or network interface
controller (NIC).
6.37.2 URIs
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions/
{NetworkDeviceFunctionId}/EthernetInterfaces/{EthernetInterfaceId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/EthernetInterfaces/
{EthernetInterfaceId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
EthernetInterfaces/{EthernetInterfaceId}
Version 2023.1 Published 349
Redfish Resource and Schema Guide DSP2046
/redfish/v1/Managers/{ManagerId}/EthernetInterfaces/{EthernetInterfaceId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/EthernetInterfaces/{EthernetInterfaceId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/EthernetInterfaces/
{EthernetInterfaceId}
/redfish/v1/Systems/{ComputerSystemId}/EthernetInterfaces/{EthernetInterfaceId}
6.37.3 Properties
Property Type Attributes Notes
read-write An indication of whether the speed and duplex are automatically
AutoNeg boolean
(null) negotiated and configured on this interface.
DHCPv4 (v1.4+) { object DHCPv4 configuration for this interface.
read-write An indication of whether DHCP v4 is enabled on this Ethernet
DHCPEnabled (v1.4+) boolean
(null) interface.
string read-write DHCPv4 fallback address method for this interface. For the
FallbackAddress (v1.5+)
(enum) (null) possible property values, see FallbackAddress in Property details.
read-write An indication of whether this interface uses DHCP v4-supplied
UseDNSServers (v1.4+) boolean
(null) DNS servers.
read-write An indication of whether this interface uses a DHCP v4-supplied
UseDomainName (v1.4+) boolean
(null) domain name.
read-write An indication of whether this interface uses a DHCP v4-supplied
UseGateway (v1.4+) boolean
(null) gateway.
read-write An indication of whether the interface uses DHCP v4-supplied
UseNTPServers (v1.4+) boolean
(null) NTP servers.
read-write An indication of whether the interface uses DHCP v4-supplied
UseStaticRoutes (v1.4+) boolean
(null) static routes.
DHCPv6 (v1.4+) { object DHCPv6 configuration for this interface.
Determines the DHCPv6 operating mode for this interface. For
string read-write
OperatingMode (v1.4+) the possible property values, see OperatingMode in Property
(enum) (null)
details.
read-write An indication of whether the interface uses DHCP v6-supplied
UseDNSServers (v1.4+) boolean
(null) DNS servers.
read-write An indication of whether this interface uses a DHCP v6-supplied
UseDomainName (v1.4+) boolean
(null) domain name.
350 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write An indication of whether the interface uses DHCP v6-supplied
UseNTPServers (v1.4+) boolean
(null) NTP servers.
An indication of whether the interface uses DHCP v6 rapid
read-write commit mode for stateful mode address assignments. Do not
UseRapidCommit (v1.4+) boolean
(null) enable this option in networks where more than one DHCP v6
server is configured to provide address assignments.
EthernetInterfaceType string read-only The type of interface. For the possible property values, see
(v1.6+) (enum) (null) EthernetInterfaceType in Property details.
read-write The complete, fully qualified domain name that DNS obtains for
FQDN string
(null) this interface.
read-write An indication of whether full-duplex mode is enabled on the
FullDuplex boolean
(null) Ethernet connection for this interface.
read-write
HostName string The DNS host name, without any domain information.
(null)
read-write
InterfaceEnabled boolean An indication of whether this interface is enabled.
(null)
array The IPv4 addresses currently in use by this interface. For
IPv4Addresses [ { } ]
(object) property details, see IPv4Address.
The IPv4 static addresses assigned to this interface. See
IPv4StaticAddresses (v1.4+) array
IPv4Addresses for the addresses in use by this interface. For
[{}] (object) (null)
property details, see IPv4Address.
array The IPv6 addresses currently in use by this interface. For
IPv6Addresses [ { } ]
(object) property details, see IPv6Address.
An array that represents the RFC6724-defined address selection
IPv6AddressPolicyTable [ { array
policy table.
read-write
Label integer The IPv6 label, as defined in RFC6724, section 2.1.
(null)
read-write
Precedence integer The IPv6 precedence, as defined in RFC6724, section 2.1.
(null)
read-write
Prefix string The IPv6 address prefix, as defined in RFC6724, section 2.1.
(null)
}]
read-only
IPv6DefaultGateway string The IPv6 default gateway address in use on this interface.
(null)
Version 2023.1 Published 351
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The IPv6 static addresses assigned to this interface. See
array
IPv6StaticAddresses [ { } ] IPv6Addresses for the addresses in use by this interface. For
(object) (null)
property details, see IPv6StaticAddress.
IPv6StaticDefaultGateways array The IPv6 static default gateways for this interface. For property
(v1.4+) [ { } ] (object) (null) details, see IPv6GatewayStaticAddress v1.1.3).
required
Links (v1.1+) { object The links to other resources that are related to this resource.
on create
AffiliatedInterfaces The links to the Ethernet interfaces that are affiliated with this
array
(v1.10+) [ { interface, such as a VLAN or a team that uses this interface.
@odata.id string read-only Link to another EthernetInterface resource.
}]
The link to the chassis that contains this Ethernet interface. See
Chassis (v1.3+) { object
the Chassis schema for details on this property.
Link to a Chassis resource. See the Links section and the Chassis
@odata.id string read-only
schema for details.
An array of links to the endpoints that connect to this Ethernet
Endpoints (v1.1+) [ { array
interface.
Link to a Endpoint resource. See the Links section and the
@odata.id string read-only
Endpoint schema for details.
}]
The link to a Host Interface that is associated with this Ethernet
HostInterface (v1.2+) { object interface. See the HostInterface schema for details on this
property.
Link to a HostInterface resource. See the Links section and the
@odata.id string read-only
HostInterface schema for details.
The link to the parent network device function and is only used
when representing one of the VLANs on that network device
function, such as is done in Unix. See the NetworkDeviceFunction
NetworkDeviceFunction
object schema for details on this property. Deprecated in v1.7 and later.
(v1.6+, deprecated v1.7 { (null)
This property has been deprecated in favor of
NetworkDeviceFunctions as each EthernetInterface could
represent more than one NetworkDeviceFunction.
352 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to a NetworkDeviceFunction resource. See the Links section
@odata.id string read-only
and the NetworkDeviceFunction schema for details.
NetworkDeviceFunctions The link to the network device functions that comprise this
array
(v1.7+) [ { Ethernet interface.
Link to a NetworkDeviceFunction resource. See the Links section
@odata.id string read-only
and the NetworkDeviceFunction schema for details.
}]
Oem {} object See the Oem object definition in the Common properties section.
Ports (v1.9+) [ { array The links to the ports providing this Ethernet interface.
Link to a Port resource. See the Links section and the Port
@odata.id string read-only
schema for details.
}]
RelatedInterfaces required The links to the Ethernet interfaces that comprise this Ethernet
array
(v1.9+) [ { on create interface.
@odata.id string read-write Link to another EthernetInterface resource.
}]
string read-only The link status of this interface, or port. For the possible property
LinkStatus (v1.1+)
(enum) (null) values, see LinkStatus in Property details.
read-write The currently configured MAC address of the interface, or logical
MACAddress string
(null) port.
read-only The maximum number of static IPv6 addresses that can be
MaxIPv6StaticAddresses integer
(null) configured on this interface.
read-write The currently configured maximum transmission unit (MTU), in
MTUSize integer
(null) bytes, on this interface.
array
NameServers [ ] read-only The DNS servers in use on this interface.
(string)
read-only
PermanentMACAddress string The permanent MAC address assigned to this interface, or port.
(null)
integer read-write
SpeedMbps The current speed, in Mbit/s, of this interface.
(Mbit/s) (null)
Version 2023.1 Published 353
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
StatelessAddressAutoConfig Stateless address autoconfiguration (SLAAC) parameters for this
object
(v1.4+) { interface.
IPv4AutoConfigEnabled read-write An indication of whether IPv4 stateless address autoconfiguration
boolean
(v1.4+) (null) (SLAAC) is enabled for this interface.
IPv6AutoConfigEnabled read-write An indication of whether IPv6 stateless address autoconfiguration
boolean
(v1.4+) (null) (SLAAC) is enabled for this interface.
array
StaticNameServers (v1.4+) [
(string, read-write The statically-defined set of DNS server IPv4 and IPv6 addresses.
]
null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
string read-write The team mode for this interface. For the possible property
TeamMode (v1.9+)
(enum) (null) values, see TeamMode in Property details.
read-only
UefiDevicePath string The UEFI device path for this interface.
(null)
If this network interface supports more than one VLAN, this
VLAN { object property is absent. VLAN collections appear in the Links property
of this resource.
read-write An indication of whether this VLAN is tagged or untagged for this
Tagged (v1.3+) boolean
(null) interface.
read-write
required An indication of whether this VLAN is enabled for this VLAN
VLANEnable boolean
on create network interface.
(null)
read-write
required
VLANId integer The ID for this VLAN.
on create
(null)
read-write
VLANPriority (v1.2+) integer The priority for this VLAN.
(null)
354 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The link to a collection of VLANs, which applies only if the
interface supports more than one VLAN. If this property applies,
the VLANEnabled and VLANId properties do not apply. Contains a
VLANs (deprecated v1.7) { object
link to a resource. Deprecated in v1.7 and later. This property has
been deprecated in favor of newer methods indicating multiple
VLANs.
Link to Collection of VLanNetworkInterface. See the
@odata.id string read-only
VLanNetworkInterface schema for details.
6.37.4 Property details
6.37.4.1 EthernetInterfaceType
The type of interface.
string Description
Physical A physical Ethernet interface.
Virtual A virtual Ethernet interface.
6.37.4.2 FallbackAddress
DHCPv4 fallback address method for this interface.
string Description
AutoConfig Fall back to an autoconfigured address.
None Continue attempting DHCP without a fallback address.
Static Fall back to a static address specified by IPv4StaticAddresses.
6.37.4.3 LinkStatus
The link status of this interface, or port.
Version 2023.1 Published 355
Redfish Resource and Schema Guide DSP2046
string Description
LinkDown No link is detected on this interface, but the interface is connected.
LinkUp The link is available for communication on this interface.
NoLink No link or connection is detected on this interface.
6.37.4.4 OperatingMode
Determines the DHCPv6 operating mode for this interface.
string Description
Disabled DHCPv6 is disabled.
Enabled (v1.8+) DHCPv6 is enabled.
DHCPv6 stateful mode. Deprecated in v1.8 and later. This property has been deprecated in
Stateful (deprecated v1.8) favor of Enabled . The control between 'stateful' and 'stateless' is managed by the DHCP
server and not the client.
DHCPv6 stateless mode. Deprecated in v1.8 and later. This property has been deprecated in
Stateless (deprecated v1.8) favor of Enabled . The control between 'stateful' and 'stateless' is managed by the DHCP
server and not the client.
6.37.4.5 TeamMode
The team mode for this interface.
string Description
One interface in the team is active and the others are kept in standby until a failure
ActiveBackup
occurs.
Packets are transmitted and received based upon the current load of each interface in
AdaptiveLoadBalancing
the team.
AdaptiveTransmitLoadBalancing Packets are transmitted based upon the current load of each interface in the team.
Broadcast Packets are transmitted on all interfaces in the team.
IEEE802_3ad The interfaces in the team create an IEEE802.3ad link aggregation group.
None No teaming.
RoundRobin Packets are transmitted in sequential order from the teamed interfaces.
356 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
XOR Transmitting is determined based upon a hash policy.
6.37.5 Example response
{
"@odata.type": "#EthernetInterface.v1_10_0.EthernetInterface",
"Id": "1",
"Name": "Ethernet Interface",
"Description": "Manager NIC 1",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"LinkStatus": "LinkUp",
"PermanentMACAddress": "12:44:6A:3B:04:11",
"MACAddress": "12:44:6A:3B:04:11",
"SpeedMbps": 1000,
"AutoNeg": true,
"FullDuplex": true,
"MTUSize": 1500,
"HostName": "web483",
"FQDN": "web483.contoso.com",
"NameServers": [
"names.contoso.com"
],
"IPv4Addresses": [
{
"Address": "192.168.0.10",
"SubnetMask": "255.255.252.0",
"AddressOrigin": "DHCP",
"Gateway": "192.168.0.1"
}
],
"DHCPv4": {
"DHCPEnabled": true,
"UseDNSServers": true,
"UseGateway": true,
"UseNTPServers": false,
"UseStaticRoutes": true,
"UseDomainName": true
},
"DHCPv6": {
"OperatingMode": "Enabled",
"UseDNSServers": true,
"UseDomainName": false,
"UseNTPServers": false,
Version 2023.1 Published 357
Redfish Resource and Schema Guide DSP2046
"UseRapidCommit": false
},
"StatelessAddressAutoConfig": {
"IPv4AutoConfigEnabled": false,
"IPv6AutoConfigEnabled": true
},
"IPv4StaticAddresses": [
{
"Address": "192.168.88.130",
"SubnetMask": "255.255.0.0",
"Gateway": "192.168.0.1"
}
],
"IPv6AddressPolicyTable": [
{
"Prefix": "::1/128",
"Precedence": 50,
"Label": 0
}
],
"MaxIPv6StaticAddresses": 1,
"IPv6StaticAddresses": [
{
"Address": "fc00:1234::a:b:c:d",
"PrefixLength": 64
}
],
"IPv6StaticDefaultGateways": [
{
"Address": "fe80::fe15:b4ff:fe97:90cd",
"PrefixLength": 64
}
],
"IPv6DefaultGateway": "fe80::214:c1ff:fe4c:5c4d",
"IPv6Addresses": [
{
"Address": "fe80::1ec1:deff:fe6f:1e24",
"PrefixLength": 64,
"AddressOrigin": "SLAAC",
"AddressState": "Preferred"
},
{
"Address": "fc00:1234::a:b:c:d",
"PrefixLength": 64,
"AddressOrigin": "Static",
"AddressState": "Preferred"
},
{
"Address": "2001:1:3:5::100",
"PrefixLength": 64,
358 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"AddressOrigin": "DHCPv6",
"AddressState": "Preferred"
},
{
"Address": "2002:2:5::1ec1:deff:fe6f:1e24",
"PrefixLength": 64,
"AddressOrigin": "SLAAC",
"AddressState": "Preferred"
}
],
"StaticNameServers": [
"192.168.150.1",
"fc00:1234:200:2500"
],
"VLAN": {
"VLANEnable": true,
"VLANId": 101
},
"@odata.id": "/redfish/v1/Systems/437XR1138R2/EthernetInterfaces/12446A3B0411"
}
6.38 Event 1.8.0
Version v1.8 v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2023.1 2021.2 2020.3 2020.2 2019.1 2018.2 2017.1 2016.1 1.0
6.38.1 Description
The Event schema describes the JSON payload received by an event destination, which has subscribed
to event notification, when events occur. This resource contains data about events, including
descriptions, severity, and a message identifier to a message registry that can be accessed for further
information.
6.38.2 Properties
Property Type Attributes Notes
A context can be supplied at subscription time. This property is
Context (v1.1+) string read-only
the context value supplied by the subscriber.
Version 2023.1 Published 359
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Each event in this array has a set of properties that describe
Events [ { array required the event. Because this is an array, more than one event can
be sent simultaneously.
Actions (v1.2+) {} object The available actions for this resource.
AdditionalDataSizeBytes integer read-only
The size of the additional data for this event.
(v1.8+) (bytes) (null)
string read-only The URI at which to access the additional data for the event,
AdditionalDataURI (v1.8+)
(URI) (null) such as diagnostic data, image captures, or other files.
A context can be supplied at subscription time. This property is
the context value supplied by the subscriber. Deprecated in
v1.1 and later. Events are triggered independently from
Context (deprecated v1.1) string read-only
subscriptions to those events. This property has been
deprecated in favor of the Context property found at the root
level of the object.
CPER (v1.8+) { object Details for a CPER section or record associated with this event.
string read-only
NotificationType (v1.8+) The CPER Notification Type for a CPER record.
(uuid) (null)
See the Oem object definition in the Common properties
Oem (v1.8+) {} object
section.
string read-only
SectionType (v1.8+) The CPER Section Type.
(uuid) (null)
read-only A Base64-encoded set of diagnostic data associated with this
DiagnosticData (v1.8+) string
(null) event.
The type of data available in the DiagnosticData property or
string read-only retrieved from the URI specified by the AdditionalDataURI
DiagnosticDataType (v1.8+)
(enum) (null) property. For the possible property values, see
DiagnosticDataType in Property details.
The identifier that correlates events with the same root cause.
EventGroupId (v1.3+) integer read-only
If 0 , no other event is related to this event.
EventId string read-only The unique instance identifier of an event.
string
EventTimestamp (date- read-only The time the event occurred.
time)
360 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The type of event. For the possible property values, see
EventType in Property details. Deprecated in v1.3 and later.
string read-only This property has been deprecated. Starting with Redfish
EventType (deprecated v1.3)
(enum) required Specification v1.6 (Event v1.3), subscriptions are based on the
RegistryPrefix and ResourceType properties and not on the
EventType property.
The link to a log entry if an entry was created for this event.
LogEntry (v1.7+) { object
See the LogEntry schema for details on this property.
Link to a LogEntry resource. See the Links section and the
@odata.id string read-only
LogEntry schema for details.
read-only
MemberId string The unique identifier for the member within an array.
required
Message string read-only The human-readable event message.
An array of message arguments that are substituted for the
array
MessageArgs [ ] read-only arguments in the message when looked up in the message
(string)
registry.
read-only
MessageId string The identifier for the message.
required
string The severity of the message in this event. For the possible
MessageSeverity (v1.5+) read-only
(enum) property values, see MessageSeverity in Property details.
See the Oem object definition in the Common properties
Oem {} object
section.
A link to the resource or object that originated the condition
OriginOfCondition { object
that caused the event to be generated.
string
@odata.id read-only The unique identifier for a resource.
(URI)
The severity of the event. Deprecated in v1.5 and later. This
property has been deprecated in favor of MessageSeverity,
Severity (deprecated v1.5) string read-only
which ties the values to the enumerations defined for the
Health property within Status.
SpecificEventExistsInGroup Indicates this event is equivalent to a more specific event in
boolean read-only
(v1.6+) this Event Group.
}]
Version 2023.1 Published 361
Redfish Resource and Schema Guide DSP2046
6.38.3 Property details
6.38.3.1 DiagnosticDataType
The type of data available in the DiagnosticData property or retrieved from the URI specified by the
AdditionalDataURI property.
string Description
CPER UEFI Common Platform Error Record.
CPERSection A Section of a UEFI Common Platform Error Record.
Manager Manager diagnostic data.
OEM OEM diagnostic data.
OS Operating system (OS) diagnostic data.
PreOS Pre-OS diagnostic data.
6.38.3.2 EventType
The type of event.
string Description
Alert A condition requires attention.
MetricReport (v1.3+) The telemetry service is sending a metric report.
Because EventType is deprecated as of Redfish Specification v1.6, the event is based on a
Other (v1.4+)
registry or resource but not an EventType.
ResourceAdded A resource has been added.
ResourceRemoved A resource has been removed.
ResourceUpdated A resource has been updated.
StatusChange The status of a resource has changed.
6.38.3.3 MessageSeverity
The severity of the message in this event.
362 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.
6.38.4 Example response
{
"@odata.type": "#Event.v1_7_0.Event",
"Id": "1",
"Name": "Event Array",
"Context": "ContosoWebClient",
"Events": [
{
"EventType": "Other",
"EventId": "4593",
"Severity": "Warning",
"Message": "A cable has been removed from network adapter '1' port '1'.",
"MessageId": "NetworkDevice.1.0.CableRemoved",
"MessageArgs": [
"1",
"1"
],
"OriginOfCondition": {
"@odata.id": "/redfish/v1/Systems/1/EthernetInterfaces/1"
},
"LogEntry": {
"@odata.id": "/redfish/v1/Managers/BMC/LogServices/EventLog/Entries/532"
}
}
]
}
6.39 EventDestination 1.13.1
Version v1.13 v1.12 v1.11 v1.10 v1.9 v1.8 v1.7 v1.6 v1.5 v1.4 v1.3 ...
Release 2022.3 2022.1 2021.2 2020.4 2020.3 2020.1 2019.3 2019.2 2019.1 2018.2 2018.1 ...
Version 2023.1 Published 363
Redfish Resource and Schema Guide DSP2046
6.39.1 Description
The EventDestination schema defines the target of an event subscription, including the event types
and context to provide to the target in the event payload.
6.39.2 URIs
/redfish/v1/EventService/Subscriptions/{EventDestinationId}
6.39.3 Properties
Property Type Attributes Notes
The link to a collection of server certificates for the server
Certificates (v1.9+) { object referenced by the Destination property. Contains a link to a
resource.
Link to Collection of Certificate. See the Certificate schema for
@odata.id string read-only
details.
The link to a collection of client identity certificates provided to the
ClientCertificates (v1.11+)
object server referenced by the Destination property. Contains a link to a
{
resource.
Link to Collection of Certificate. See the Certificate schema for
@odata.id string read-only
details.
read-write
A client-supplied string that is stored with the event destination
Context string required
subscription.
(null)
The subscription delivery retry policy for events, where the
DeliveryRetryPolicy string read-write
subscription type is RedfishEvent. For the possible property values,
(v1.6+) (enum) (null)
see DeliveryRetryPolicy in Property details.
read-only
string
Destination required The URI of the destination event receiver.
(URI)
on create
The content types of the message that are sent to the
string read-only
EventFormatType (v1.4+) EventDestination. For the possible property values, see
(enum) (null)
EventFormatType in Property details.
364 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The types of events that are sent to the destination. For the
possible property values, see EventTypes in Property details.
Deprecated in v1.5 and later. This property has been deprecated.
array Starting with Redfish Specification v1.6 (Event v1.3), subscriptions
EventTypes (deprecated
(string read-only are based on the RegistryPrefix and ResourceType properties and
v1.5) [ ]
(enum)) not on the EventType property. Use EventFormatType to create
subscriptions for metric reports. If the subscription does not
include this property, the service shall use a single element with a
default of Other .
array
ExcludeMessageIds
(string, read-only The list of MessageIds that are not sent to this event destination.
(v1.12+) [ ]
null)
array
ExcludeRegistryPrefixes The list of prefixes for the message registries that contain the
(string, read-only
(v1.12+) [ ] MessageIds that are not sent to this event destination.
null)
HeartbeatIntervalMinutes read-only
integer Interval for sending heartbeat events to the destination in minutes.
(v1.11+) (null)
An array of settings for HTTP headers, such as authorization
HttpHeaders [ { array information. This array is null or an empty array in responses. An
empty array is the preferred return value on read operations.
(pattern) string read-write Property names follow regular expression pattern "^[^:\\s]+$"
}]
An indication of whether the events subscribed to will also include
IncludeOriginOfCondition read-only
boolean the entire resource or object referenced the OriginOfCondition
(v1.8+) (null)
property in the event payload.
array
MessageIds (v1.1+) [ ] (string, read-only The list of MessageIds that are sent to this event destination.
null)
A list of metric report definitions for which the service only sends
MetricReportDefinitions related metric reports. If this property is absent or the array is
array
(v1.6+) [ { empty, metric reports that originate from any metric report
definition are sent to the subscriber.
Link to a MetricReportDefinition resource. See the Links section
@odata.id string read-only
and the MetricReportDefinition schema for details.
}]
OEMProtocol (v1.9+) string read-only The OEM-defined protocol type of the event connection.
OEMSubscriptionType
string read-only The OEM-defined subscription type for events.
(v1.9+)
Version 2023.1 Published 365
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
OriginResources (v1.1+) [ The array of resources for which the service sends only related
array
{ events.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
read-only
string The protocol type of the event connection. For the possible
Protocol required
(enum) property values, see Protocol in Property details.
on create
array
The list of prefixes for the message registries that contain the
RegistryPrefixes (v1.4+) [ ] (string, read-only
MessageIds that are sent to this event destination.
null)
array The list of resource type values (schema names) that correspond
ResourceTypes (v1.4+) [ ] (string, read-only to the OriginOfCondition. The version and full namespace should
null) not be specified.
read-only
SendHeartbeat (v1.11+) boolean Send a heartbeat event periodically to the destination.
(null)
array
read-only The list of severities that are sent to this event destination. For the
Severities (v1.13+) [ ] (string
(null) possible property values, see Severities in Property details.
(enum))
SNMP (v1.7+) { object Settings for an SNMP event destination.
AuthenticationKey read-write
string The secret authentication key for SNMPv3.
(v1.7+) (null)
AuthenticationKeySet
boolean read-only Indicates if the AuthenticationKey property is set.
(v1.10+)
AuthenticationProtocol string read-write The authentication protocol for SNMPv3. For the possible property
(v1.7+) (enum) (null) values, see AuthenticationProtocol in Property details.
read-write
EncryptionKey (v1.7+) string The secret authentication key for SNMPv3.
(null)
EncryptionKeySet
boolean read-only Indicates if the EncryptionKey property is set.
(v1.10+)
EncryptionProtocol string read-write The encryption protocol for SNMPv3. For the possible property
(v1.7+) (enum) (null) values, see EncryptionProtocol in Property details.
read-write
TrapCommunity (v1.7+) string The SNMP trap community string.
(null)
366 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
This property shall contain the status of the subscription. For
Status (v1.6+) {} object
property details, see Status.
An indication of whether the subscription is for events in the
OriginResources array and its subordinate resources. If true and
the OriginResources array is specified, the subscription is for
events in the OriginResources array and its subordinate resources.
SubordinateResources read-only
boolean Note that resources associated through the Links section are not
(v1.4+) (null)
considered subordinate. If false and the OriginResources array is
specified, the subscription shall be for events in the
OriginResources array only. If the OriginResources array is not
present, this property shall have no relevance.
read-only
string The subscription type for events. For the possible property values,
SubscriptionType (v1.3+) required
(enum) see SubscriptionType in Property details.
(null)
A list of filters applied to syslog messages before sending to a
SyslogFilters (v1.9+) [ { array remote syslog server. An empty list indicates all syslog messages
are sent.
array
read-write The types of programs that can log messages. For the possible
LogFacilities (v1.9+) [ ] (string
(null) property values, see LogFacilities in Property details.
(enum))
string read-write The lowest severity level message that will be forwarded. For the
LowestSeverity (v1.9+)
(enum) (null) possible property values, see LowestSeverity in Property details.
}]
An indication of whether the service will verify the certificate of the
read-write
VerifyCertificate (v1.9+) boolean server referenced by the Destination property prior to sending the
(null)
event.
6.39.4 Actions
6.39.4.1 ResumeSubscription
Description
This action resumes a suspended event subscription.
Action URI
{Base URI of target resource}/Actions/EventDestination.ResumeSubscription
Action parameters
Version 2023.1 Published 367
Redfish Resource and Schema Guide DSP2046
Parameter Name Type Attributes Notes
DeliverBufferedEventDuration string The maximum age of buffered events that should be
optional
(v1.12+) (duration) delivered when resuming the subscription.
Request Example
{
"DeliverBufferedEventDuration": "PT8H"
}
6.39.4.2 SuspendSubscription (v1.12+)
Description
This action suspends an event subscription.
Action URI
{Base URI of target resource}/Actions/EventDestination.SuspendSubscription
Action parameters
This action takes no parameters.
6.39.5 Property details
6.39.5.1 AuthenticationProtocol
The authentication protocol for SNMPv3.
string Description
CommunityString Trap community string authentication.
HMAC128_SHA224 (v1.10+) HMAC-128-SHA-224 authentication.
HMAC192_SHA256 (v1.10+) HMAC-192-SHA-256 authentication.
HMAC256_SHA384 (v1.10+) HMAC-256-SHA-384 authentication.
HMAC384_SHA512 (v1.10+) HMAC-384-SHA-512 authentication.
368 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
HMAC_MD5 HMAC-MD5-96 authentication.
HMAC_SHA96 HMAC-SHA-96 authentication.
None No authentication.
6.39.5.2 DeliveryRetryPolicy
The subscription delivery retry policy for events, where the subscription type is RedfishEvent.
string Description
The subscription is not suspended or terminated, and attempts at delivery of future events
RetryForever
shall continue regardless of the number of retries.
The subscription is not suspended or terminated, and attempts at delivery of future events
RetryForeverWithBackoff
shall continue regardless of the number of retries, but issued over time according to a
(v1.10+)
service-defined backoff algorithm.
SuspendRetries The subscription is suspended after the maximum number of retries is reached.
TerminateAfterRetries The subscription is terminated after the maximum number of retries is reached.
6.39.5.3 EncryptionProtocol
The encryption protocol for SNMPv3.
string Description
CBC_DES CBC-DES encryption.
CFB128_AES128 CFB128-AES-128 encryption.
None No encryption.
6.39.5.4 EventFormatType
The content types of the message that are sent to the EventDestination.
Version 2023.1 Published 369
Redfish Resource and Schema Guide DSP2046
string Description
Event The subscription destination receives an event payload.
MetricReport The subscription destination receives a metric report.
6.39.5.5 EventTypes
The types of events that are sent to the destination.
string Description
Alert A condition requires attention.
MetricReport The telemetry service is sending a metric report.
Because EventType is deprecated as of Redfish Specification v1.6, the event is based on a
Other
registry or resource but not an EventType.
ResourceAdded A resource has been added.
ResourceRemoved A resource has been removed.
ResourceUpdated A resource has been updated.
StatusChange The status of a resource has changed.
6.39.5.6 LogFacilities
The types of programs that can log messages.
string Description
Auth Security/authentication messages.
Authpriv Security/authentication messages.
Console Log alert.
Cron Clock daemon.
Daemon System daemons.
FTP FTP daemon.
Kern Kernel messages.
370 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Local0 Locally used facility 0.
Local1 Locally used facility 1.
Local2 Locally used facility 2.
Local3 Locally used facility 3.
Local4 Locally used facility 4.
Local5 Locally used facility 5.
Local6 Locally used facility 6.
Local7 Locally used facility 7.
LPR Line printer subsystem.
Mail Mail system.
News Network news subsystem.
NTP NTP subsystem.
Security Log audit.
SolarisCron Scheduling daemon.
Syslog Messages generated internally by syslogd.
User User-level messages.
UUCP UUCP subsystem.
6.39.5.7 LowestSeverity
The lowest severity level message that will be forwarded.
string Description
Alert A condition that should be corrected immediately, such as a corrupted system database.
All A message of any severity.
Critical Hard device errors.
Debug Messages that contain information normally of use only when debugging a program.
Emergency A panic condition.
Version 2023.1 Published 371
Redfish Resource and Schema Guide DSP2046
string Description
Error An Error.
Informational Informational only.
Notice Conditions that are not error conditions, but that may require special handling.
Warning A Warning.
6.39.5.8 Protocol
The protocol type of the event connection.
string Description
Kafka (v1.13+) The destination follows the Kafka protocol for event notifications.
OEM (v1.9+) The destination follows an OEM protocol for event notifications.
Redfish The destination follows the Redfish Specification for event notifications.
SMTP (v1.7+) The destination follows the SMTP specification for event notifications.
SNMPv1 (v1.7+) The destination follows the SNMPv1 protocol for event notifications.
SNMPv2c (v1.7+) The destination follows the SNMPv2c protocol for event notifications.
SNMPv3 (v1.7+) The destination follows the SNMPv3 protocol for event notifications.
SyslogRELP (v1.9+) The destination follows syslog RELP for event notifications.
SyslogTCP (v1.9+) The destination follows syslog TCP-based for event notifications.
SyslogTLS (v1.9+) The destination follows syslog TLS-based for event notifications.
SyslogUDP (v1.9+) The destination follows syslog UDP-based for event notifications.
6.39.5.9 Severities
The list of severities that are sent to this event destination.
string Description
Critical A critical condition requires immediate attention.
OK Normal.
372 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Warning A condition requires attention.
6.39.5.10 SubscriptionType
The subscription type for events.
string Description
OEM (v1.9+) The subscription is an OEM subscription.
The subscription follows the Redfish Specification for event notifications. To send an event
RedfishEvent
notification, a service sends an HTTP POST to the subscriber's destination URI.
SNMPInform (v1.7+) The subscription follows versions 2 and 3 of SNMP Inform for event notifications.
SNMPTrap (v1.7+) The subscription follows the various versions of SNMP Traps for event notifications.
SSE The subscription follows the HTML5 server-sent event definition for event notifications.
Syslog (v1.9+) The subscription sends Syslog messages for event notifications.
6.39.6 Example response
{
"@odata.type": "#EventDestination.v1_13_1.EventDestination",
"Id": "1",
"Name": "WebUser3 subscribes to all Redfish events",
"Destination": "http://www.dnsname.com/Destination1",
"SubscriptionType": "RedfishEvent",
"DeliveryRetryPolicy": "TerminateAfterRetries",
"RegistryPrefixes": [],
"MessageIds": [],
"OriginResources": [],
"ResourceTypes": [],
"Status": {
"State": "Enabled"
},
"Actions": {
"#EventDestination.ResumeSubscription": {
"target": "/redfish/v1/EventService/Subscriptions/1/Actions/EventDestination.ResumeSubscription"
}
},
"Context": "WebUser3",
"Protocol": "Redfish",
Version 2023.1 Published 373
Redfish Resource and Schema Guide DSP2046
"@odata.id": "/redfish/v1/EventService/Subscriptions/1"
}
6.40 EventService 1.10.0
Version v1.10 v1.9 v1.8 v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2023.1 2022.3 2022.1 2020.2 2020.1 2019.3 2019.2 2019.1 2018.2 2018.1 1.0
6.40.1 Description
The EventService schema contains properties for managing event subscriptions and generates the
events sent to subscribers. The resource has links to the actual collection of subscriptions, which are
called event destinations.
6.40.2 URIs
/redfish/v1/EventService
6.40.3 Properties
Property Type Attributes Notes
The number of times that the POST of an event is retried
before the subscription terminates. This retry occurs at
the service level, which means that the HTTP POST to the
DeliveryRetryAttempts integer read-write
event destination fails with an HTTP 4XX or 5XX status
code or an HTTP timeout occurs this many times before
the event destination subscription terminates.
integer The interval, in seconds, between retry attempts for
DeliveryRetryIntervalSeconds read-write
(seconds) sending any event.
array The content types of the message that this service can
read-only
EventFormatTypes (v1.2+) [ ] (string send to the event destination. For the possible property
(null)
(enum)) values, see EventFormatTypes in Property details.
374 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The types of events to which a client can subscribe. For
the possible property values, see
EventTypesForSubscription in Property details.
array
EventTypesForSubscription Deprecated in v1.3 and later. This property has been
(string read-only
(deprecated v1.3) [ ] deprecated. Starting with Redfish Specification v1.6
(enum))
(Event v1.3), subscriptions are based on the
RegistryPrefix and ResourceType properties and not on
the EventType property.
An indication of whether the service supports filtering by
ExcludeMessageId (v1.8+) boolean read-only
the ExcludeMessageIds property.
An indication of whether the service supports filtering by
ExcludeRegistryPrefix (v1.8+) boolean read-only
the ExcludeRegistryPrefixes property.
An indication of whether the service supports including
IncludeOriginOfConditionSupported read-only
boolean the resource payload of the origin of condition in the
(v1.6+) (null)
event payload.
The list of the prefixes of the message registries that can
be used for the RegistryPrefixes or
array
ExcludeRegistryPrefixes properties on a subscription. If
RegistryPrefixes (v1.2+) [ ] (string, read-only
this property is absent or contains an empty array, the
null)
service does not support RegistryPrefix-based
subscriptions.
The list of @odata.type values, or schema names, that
array can be specified in the ResourceTypes array in a
ResourceTypes (v1.2+) [ ] (string, read-only subscription. If this property is absent or contains an
null) empty array, the service does not support resource type-
based subscriptions.
string The link to a URI for receiving Server-Sent Event
ServerSentEventUri (v1.1+) read-only
(URI) representations for the events that this service generates.
An indication of whether this service is enabled. If false ,
read-write events are no longer published, new SSE connections
ServiceEnabled boolean
(null) cannot be established, and existing SSE connections are
terminated.
array The list of severities that can be specified in the
read-only
Severities (v1.9+) [ ] (string Severities array in a subscription. For the possible
(null)
(enum)) property values, see Severities in Property details.
SMTP (v1.5+) { object Settings for SMTP event delivery.
The authentication method for the SMTP server. For the
string read-write
Authentication (v1.5+) possible property values, see Authentication in Property
(enum) (null)
details.
Version 2023.1 Published 375
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The connection type to the outgoing SMTP server. For the
string read-write
ConnectionProtocol (v1.5+) possible property values, see ConnectionProtocol in
(enum) (null)
Property details.
read-write
FromAddress (v1.5+) string The 'from' email address of the outgoing email.
(null)
read-write The password for authentication with the SMTP server.
Password (v1.5+) string
(null) The value is null in responses.
PasswordSet (v1.9+) boolean read-only Indicates if the Password property is set.
read-write
Port (v1.5+) integer The destination SMTP port.
(null)
read-write
ServerAddress (v1.5+) string The address of the SMTP server.
(null)
read-write
ServiceEnabled (v1.5+) boolean An indication if SMTP for event delivery is enabled.
(null)
read-write
Username (v1.5+) string The username for authentication with the SMTP server.
(null)
SSEFilterPropertiesSupported The set of properties that are supported in the $filter
object
(v1.2+) { query parameter for the ServerSentEventUri.
An indication of whether the service supports filtering by
EventFormatType (v1.2+) boolean read-only
the EventFormatType property.
An indication of whether the service supports filtering by
the EventTypes property. Deprecated in v1.3 and later.
EventType (v1.2+, deprecated This property has been deprecated. Starting with Redfish
boolean read-only
v1.3 Specification v1.6 (Event v1.3), subscriptions are based
on the RegistryPrefix and ResourceType properties and
not on the EventType property.
An indication of whether the service supports filtering by
MessageId (v1.2+) boolean read-only
the MessageIds property.
An indication of whether the service supports filtering by
MetricReportDefinition (v1.2+) boolean read-only
the MetricReportDefinitions property.
An indication of whether the service supports filtering by
OriginResource (v1.2+) boolean read-only
the OriginResources property.
An indication of whether the service supports filtering by
RegistryPrefix (v1.2+) boolean read-only
the RegistryPrefixes property.
376 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
An indication of whether the service supports filtering by
ResourceType (v1.2+) boolean read-only
the ResourceTypes property.
An indication of whether the service supports filtering by
SubordinateResources (v1.4+) boolean read-only
the SubordinateResources property.
The status and health of the resource and its subordinate
Status {} object
or dependent resources. For property details, see Status.
An indication of whether the service supports the
SubordinateResourcesSupported read-only
boolean SubordinateResources property on both event
(v1.2+) (null)
subscriptions and generated events.
The link to a collection of event destinations. Contains a
Subscriptions { object
link to a resource.
Link to Collection of EventDestination. See the
@odata.id string read-only
EventDestination schema for details.
6.40.4 Actions
6.40.4.1 SubmitTestEvent
Description
This action generates a test event.
Action URI
{Base URI of target resource}/Actions/EventService.SubmitTestEvent
Action parameters
Parameter Name Type Attributes Notes
EventGroupId
integer optional The group identifier for the event.
(v1.3+)
EventId string optional The ID for the event to add.
Version 2023.1 Published 377
Redfish Resource and Schema Guide DSP2046
Parameter Name Type Attributes Notes
string
EventTimestamp optional The date and time for the event to add.
(date-time)
The type for the event to add. For the possible property values, see
EventType in Property details. Deprecated in v1.3 and later. This
EventType string
optional parameter has been deprecated. Starting with Redfish Specification
(deprecated v1.3) (enum)
v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and
ResourceType properties and not on the EventType property.
Message string optional The human-readable message for the event to add.
array
MessageArgs [ ] optional An array of message arguments for the event to add.
(string)
MessageId string required The MessageId for the event to add.
MessageSeverity string The severity for the event to add. For the possible property values, see
optional
(v1.10+) (enum) MessageSeverity in Property details.
string The URL in the OriginOfCondition property of the event to add. It is not
OriginOfCondition optional
(URI) a reference object.
Severity string optional The severity for the event to add.
Request Example
{
"EventId": "5",
"EventTimestamp": "2016-01-10T18:02:00Z",
"Severity": "Critical",
"Message": "Fan 2 crossed Lower Fatal Threshold; fans are no longer redundant",
"MessageId": "Event.1.0.FanWayTooSlow",
"MessageArgs": [
"2"
],
"OriginOfCondition": "/redfish/v1/Chassis/MultiBladeEncl/Thermal"
}
6.40.4.2 TestEventSubscription (v1.10+)
Description
This action generates a test event using the pre-defined test message.
Action URI
378 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
{Base URI of target resource}/Actions/EventService.TestEventSubscription
Action parameters
This action takes no parameters.
6.40.5 Property details
6.40.5.1 Authentication
The authentication method for the SMTP server.
string Description
AutoDetect Auto-detect.
CRAM_MD5 CRAM-MD5 authentication.
LOGIN authentication. Deprecated in v1.7 and later. This value has been deprecated in favor
Login (deprecated v1.7)
of Plain , which supersedes the LOGIN authentication method for SASL.
None No authentication.
Plain PLAIN authentication.
6.40.5.2 ConnectionProtocol
The connection type to the outgoing SMTP server.
string Description
AutoDetect Auto-detect.
None Clear text.
StartTLS StartTLS.
TLS_SSL TLS/SSL.
6.40.5.3 EventFormatTypes
The content types of the message that this service can send to the event destination.
Version 2023.1 Published 379
Redfish Resource and Schema Guide DSP2046
string Description
Event The subscription destination receives an event payload.
MetricReport The subscription destination receives a metric report.
6.40.5.4 EventType
The type for the event to add.
string Description
Alert A condition requires attention.
MetricReport The telemetry service is sending a metric report.
Because EventType is deprecated as of Redfish Specification v1.6, the event is based on a
Other
registry or resource but not an EventType.
ResourceAdded A resource has been added.
ResourceRemoved A resource has been removed.
ResourceUpdated A resource has been updated.
StatusChange The status of a resource has changed.
6.40.5.5 EventTypesForSubscription
The types of events to which a client can subscribe.
string Description
Alert A condition requires attention.
MetricReport The telemetry service is sending a metric report.
Because EventType is deprecated as of Redfish Specification v1.6, the event is based on a
Other
registry or resource but not an EventType.
ResourceAdded A resource has been added.
ResourceRemoved A resource has been removed.
ResourceUpdated A resource has been updated.
StatusChange The status of a resource has changed.
380 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.40.5.6 MessageSeverity
The severity for the event to add.
string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.
6.40.5.7 Severities
The list of severities that can be specified in the Severities array in a subscription.
string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.
6.40.6 Example response
{
"@odata.type": "#EventService.v1_10_0.EventService",
"Id": "EventService",
"Name": "Event Service",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"ServiceEnabled": true,
"DeliveryRetryAttempts": 3,
"DeliveryRetryIntervalSeconds": 60,
"EventTypesForSubscription": [
"StatusChange",
"ResourceUpdated",
"ResourceAdded",
"ResourceRemoved",
"Alert",
"Other"
Version 2023.1 Published 381
Redfish Resource and Schema Guide DSP2046
],
"ServerSentEventUri": "/redfish/v1/EventService/SSE",
"SSEFilterPropertiesSupported": {
"EventType": true,
"MetricReportDefinition": false,
"RegistryPrefix": true,
"ResourceType": true,
"EventFormatType": false,
"MessageId": true,
"OriginResource": true,
"SubordinateResources": true
},
"Subscriptions": {
"@odata.id": "/redfish/v1/EventService/Subscriptions"
},
"Actions": {
"#EventService.SubmitTestEvent": {
"target": "/redfish/v1/EventService/Actions/EventService.SubmitTestEvent",
"@Redfish.ActionInfo": "/redfish/v1/EventService/SubmitTestEventActionInfo"
}
},
"@odata.id": "/redfish/v1/EventService"
}
6.41 ExternalAccountProvider 1.6.0
Version v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2023.1 2022.3 2022.1 2021.2 2020.4 2018.3 2018.1
6.41.1 Description
The ExternalAccountProvider schema represents a remote service that provides accounts for this
manager to use for authentication.
6.41.2 URIs
/redfish/v1/AccountService/ExternalAccountProviders/{ExternalAccountProviderId}
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/ExternalAccountProviders/
{ExternalAccountProviderId}
382 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.41.3 Properties
Property Type Attributes Notes
read-only
The type of external account provider to which this service
string required
AccountProviderType connects. For the possible property values, see
(enum) on create
AccountProviderType in Property details.
(null)
The authentication information for the external account
Authentication { object
provider.
The type of authentication used to connect to the external
string read-write
AuthenticationType account provider. For the possible property values, see
(enum) (null)
AuthenticationType in Property details.
read-write
EncryptionKey (v1.2+) string Specifies the encryption key.
(null)
read-only
EncryptionKeySet (v1.2+) boolean Indicates if the EncryptionKey property is set.
(null)
The Base64-encoded version of the Kerberos keytab for this
read-write
KerberosKeytab string service. A PATCH or PUT operation writes the keytab. This
(null)
property is null in responses.
See the Oem object definition in the Common properties
Oem {} object
section.
read-write The password for this service. A PATCH or PUT request writes
Password string
(null) the password. This property is null in responses.
read-write The token for this service. A PATCH or PUT operation writes
Token string
(null) the token. This property is null in responses.
Username string read-write The user name for the service.
The link to a collection of certificates that the external
Certificates (v1.1+) { object
account provider uses. Contains a link to a resource.
Link to Collection of Certificate. See the Certificate schema
@odata.id string read-only
for details.
The additional mapping information needed to parse a
LDAPService { object
generic LDAP service.
Version 2023.1 Published 383
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
See the Oem object definition in the Common properties
Oem {} object
section.
SearchSettings { object The required settings to search an external LDAP service.
array
BaseDistinguishedNames The base distinguished names to use to search an external
(string, read-write
[] LDAP service.
null)
read-write
GroupNameAttribute string The attribute name that contains the LDAP group name entry.
(null)
read-write The attribute name that contains the groups for a user on the
GroupsAttribute string
(null) LDAP user entry.
read-write The attribute name that contains the LDAP user's SSH public
SSHKeyAttribute (v1.4+) string
(null) key entry.
read-write
UsernameAttribute string The attribute name that contains the LDAP user name entry.
(null)
Links { object The links to other resources that are related to this resource.
See the Oem object definition in the Common properties
Oem {} object
section.
The additional information needed to parse an OAuth 2.0
OAuth2Service (v1.3+) { object
(null) service.
array
Audience (v1.3+) [ ] read-only The allowable audience strings of the Redfish service.
(string)
read-write The issuer string of the OAuth 2.0 service. Clients should
Issuer (v1.3+) string
(null) configure this property if Mode contains Offline .
string The mode of operation for token validation. For the possible
Mode (v1.3+) read-write
(enum) property values, see Mode in Property details.
The Base64-encoded signing keys of the issuer of the OAuth
OAuthServiceSigningKeys read-write
string 2.0 service. Clients should configure this property if Mode
(v1.3+) (null)
contains Offline .
See the Oem object definition in the Common properties
Oem (v1.6+) {} object
section.
384 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write
Priority (v1.2+) integer The authentication priority for the external account provider.
(null)
The mapping rules to convert the external account providers
RemoteRoleMapping [ { array
account information to the local Redfish role.
read-write The name of the local Redfish role to which to map the
LocalRole string
(null) remote user or group.
The multi-factor authentication bypass settings. See the
MFABypass (v1.5+) { object
(null) AccountService schema for details on this property.
Link to a MFABypass resource. See the Links section and the
@odata.id string read-only
AccountService schema for details.
See the Oem object definition in the Common properties
Oem {} object
section.
The name of the remote group, or the remote role in the case
read-write
RemoteGroup string of a Redfish service, that maps to the local Redfish role to
(null)
which this entity links.
read-write The name of the remote user that maps to the local Redfish
RemoteUser string
(null) role to which this entity links.
}]
The number of times to retry connecting to an address in the
read-write
Retries (v1.6+) integer ServiceAddresses property before attempting the next
(null)
address in the array.
array The addresses of the user account providers to which this
ServiceAddresses [ ] (string, read-write external account provider links. The format of this field
null) depends on the type of external account provider.
read-write
ServiceEnabled boolean An indication of whether this service is enabled.
(null)
The additional information needed to parse a TACACS+
TACACSplusService (v1.2+) { object
(null) services.
AuthorizationService (v1.6+) string read-write The TACACS+ service authorization argument.
See the Oem object definition in the Common properties
Oem (v1.6+) {} object
section.
Version 2023.1 Published 385
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
array Indicates the allowed TACACS+ password exchange protocols.
PasswordExchangeProtocols read-write
(string For the possible property values, see
(v1.2+) [ ] (null)
(enum)) PasswordExchangeProtocols in Property details.
PrivilegeLevelArgument read-write Indicates the name of the TACACS+ argument name in an
string
(v1.2+) (null) authorization request.
The period of time, in seconds, this account service will wait
read-write
TimeoutSeconds (v1.6+) integer for a response from an address of a user account provider
(null)
before timing out.
6.41.4 Property details
6.41.4.1 AccountProviderType
The type of external account provider to which this service connects.
string Description
ActiveDirectoryService An external Active Directory service.
LDAPService A generic external LDAP service.
OAuth2 (v1.3+) An external OAuth 2.0 service.
OEM An OEM-specific external authentication or directory service.
RedfishService An external Redfish service.
TACACSplus (v1.3+) An external TACACS+ service.
6.41.4.2 AuthenticationType
The type of authentication used to connect to the external account provider.
string Description
KerberosKeytab A Kerberos keytab.
OEM An OEM-specific authentication mechanism.
Token An opaque authentication token.
386 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
UsernameAndPassword A user name and password combination.
6.41.4.3 Mode
The mode of operation for token validation.
string Description
Discovery OAuth 2.0 service information for token validation is downloaded by the service.
OAuth 2.0 service information for token validation is configured by a client. Clients should
Offline
configure the Issuer and OAuthServiceSigningKeys properties for this mode.
6.41.4.4 PasswordExchangeProtocols
Indicates the allowed TACACS+ password exchange protocols.
string Description
ASCII The ASCII Login method.
CHAP The CHAP Login method.
MSCHAPv1 The MS-CHAP v1 Login method.
MSCHAPv2 The MS-CHAP v2 Login method.
PAP The PAP Login method.
6.41.5 Example response
{
"@odata.type": "#ExternalAccountProvider.v1_6_0.ExternalAccountProvider",
"Id": "ExternalRedfishService",
"Name": "Remote Redfish Service",
"Description": "Remote Redfish Service providing additional Accounts to this Redfish Service",
"AccountProviderType": "RedfishService",
"ServiceAddresses": [
"http://redfish.dmtf.org/redfish/v1/AccountService"
],
"Authentication": {
Version 2023.1 Published 387
Redfish Resource and Schema Guide DSP2046
"AuthenticationType": "Token",
"Token": null
},
"RemoteRoleMapping": [
{
"RemoteGroup": "Admin",
"LocalRole": "Administrator"
},
{
"RemoteGroup": "Operator",
"LocalRole": "Operator"
},
{
"RemoteGroup": "ReadOnly",
"LocalRole": "ReadOnly"
}
],
"@odata.id": "/redfish/v1/AccountService/ExternalAccountProviders/ExternalRedfishService"
}
6.42 Fabric 1.3.0
Version v1.3 v1.2 v1.1 v1.0
Release 2021.4 2020.3 2019.4 2016.2
6.42.1 Description
The Fabric schema represents a simple fabric consisting of one or more switches, zero or more
endpoints, and zero or more zones.
6.42.2 URIs
/redfish/v1/Fabrics/{FabricId}
6.42.3 Properties
Property Type Attributes Notes
AddressPools The collection of links to the address pools that this fabric contains. Contains
object
(v1.1+) { a link to a resource.
388 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
@odata.id string read-only Link to Collection of AddressPool. See the AddressPool schema for details.
Connections The collection of links to the connections that this fabric contains. Contains
object
(v1.2+) { a link to a resource.
@odata.id string read-only Link to Collection of Connection. See the Connection schema for details.
EndpointGroups The collection of links to the endpoint groups that this fabric contains.
object
(v1.2+) { Contains a link to a resource.
Link to Collection of EndpointGroup. See the EndpointGroup schema for
@odata.id string read-only
details.
The collection of links to the endpoints that this fabric contains. Contains a
Endpoints { object
link to a resource.
@odata.id string read-only Link to Collection of Endpoint. See the Endpoint schema for details.
string read-only The protocol being sent over this fabric. For the possible property values,
FabricType
(enum) (null) see FabricType in Property details.
Links { object The links to other resources that are related to this resource.
Oem {} object See the Oem object definition in the Common properties section.
read-only
MaxZones integer The maximum number of zones the switch can currently configure.
(null)
The status and health of the resource and its subordinate or dependent
Status {} object
resources. For property details, see Status.
The collection of links to the switches that this fabric contains. Contains a
Switches { object
link to a resource.
@odata.id string read-only Link to Collection of Switch. See the Switch schema for details.
string read-write
UUID (v1.3+) The UUID for this fabric.
(uuid) (null)
Version 2023.1 Published 389
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The collection of links to the zones that this fabric contains. Contains a link
Zones { object
to a resource.
@odata.id string read-only Link to Collection of Zone. See the Zone schema for details.
6.42.4 Property details
6.42.4.1 FabricType
The protocol being sent over this fabric.
string Description
AHCI Advanced Host Controller Interface (AHCI).
CXL Compute Express Link.
DisplayPort DisplayPort.
DVI DVI.
Ethernet Ethernet.
FC Fibre Channel.
FCoE Fibre Channel over Ethernet (FCoE).
FCP Fibre Channel Protocol for SCSI.
FICON FIbre CONnection (FICON).
FTP File Transfer Protocol (FTP).
GenZ GenZ.
HDMI HDMI.
HTTP Hypertext Transport Protocol (HTTP).
HTTPS Hypertext Transfer Protocol Secure (HTTPS).
I2C Inter-Integrated Circuit Bus.
InfiniBand InfiniBand.
iSCSI Internet SCSI.
390 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
iWARP Internet Wide Area RDMA Protocol (iWARP).
MultiProtocol Multiple Protocols.
NFSv3 Network File System (NFS) version 3.
NFSv4 Network File System (NFS) version 4.
NVLink NVLink.
NVMe Non-Volatile Memory Express (NVMe).
NVMeOverFabrics NVMe over Fabrics.
OEM OEM-specific.
PCIe PCI Express.
RoCE RDMA over Converged Ethernet Protocol.
RoCEv2 RDMA over Converged Ethernet Protocol Version 2.
SAS Serial Attached SCSI.
SATA Serial AT Attachment.
SFTP SSH File Transfer Protocol (SFTP).
SMB Server Message Block (SMB). Also known as the Common Internet File System (CIFS).
TCP Transmission Control Protocol (TCP).
TFTP Trivial File Transfer Protocol (TFTP).
UDP User Datagram Protocol (UDP).
UHCI Universal Host Controller Interface (UHCI).
USB Universal Serial Bus (USB).
VGA VGA.
6.42.5 Example response
{
"@odata.type": "#Fabric.v1_3_0.Fabric",
"Id": "SAS",
"Name": "SAS Fabric",
Version 2023.1 Published 391
Redfish Resource and Schema Guide DSP2046
"FabricType": "SAS",
"Description": "A SAS Fabric with redundant switches connected to two initiators",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Zones": {
"@odata.id": "/redfish/v1/Fabrics/SAS/Zones"
},
"Endpoints": {
"@odata.id": "/redfish/v1/Fabrics/SAS/Endpoints"
},
"Switches": {
"@odata.id": "/redfish/v1/Fabrics/SAS/Switches"
},
"@odata.id": "/redfish/v1/Fabrics/SAS"
}
6.43 FabricAdapter 1.5.1
Version v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.3 2022.2 2022.1 2021.3 2021.2 2019.4
6.43.1 Description
A fabric adapter represents the physical fabric adapter capable of connecting to an interconnect
fabric. Examples include, but are not limited to, Ethernet, NVMe over Fabrics, Gen-Z, and SAS fabric
adapters.
6.43.2 URIs
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/
{FabricAdapterId}
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}
392 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.43.3 Properties
Property Type Attributes Notes
read-only
ASICManufacturer string The manufacturer name for the ASIC of this fabric adapter.
(null)
read-only
ASICPartNumber string The part number for the ASIC on this fabric adapter.
(null)
read-only
ASICRevisionIdentifier string The revision identifier for the ASIC on this fabric adapter.
(null)
string The configured fabric type of this fabric adapter. For the possible
FabricType (v1.3+) read-write
(enum) property values, see FabricType in Property details.
array An array of fabric types supported by this fabric adapter. For the
FabricTypeCapabilities
(string read-only possible property values, see FabricTypeCapabilities in Property
(v1.3+) [ ]
(enum)) details.
read-only
FirmwareVersion string The firmware version of this fabric adapter.
(null)
GenZ { object The Gen-Z specific properties for this fabric adapter.
The Multi Subnet Destination Table for the component. Contains a link
MSDT { object
to a resource.
Link to Collection of RouteEntry. See the RouteEntry schema for
@odata.id string read-only
details.
array
PIDT [ ] (string, read-write An array of table entry values for the Packet Injection Delay Table.
null)
The Requestor Virtual Channel Action Table for the component.
RequestorVCAT { object
Contains a link to a resource.
Link to Collection of VCATEntry. See the VCATEntry schema for
@odata.id string read-only
details.
The Responder Virtual Channel Action Table for the component.
ResponderVCAT { object
Contains a link to a resource.
Link to Collection of VCATEntry. See the VCATEntry schema for
@odata.id string read-only
details.
Version 2023.1 Published 393
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
array
RITable [ ] (string, read-write An array of table entry values for the Responder Interface Table.
null)
The Single Subnet Destination Table for the component. Contains a
SSDT { object
link to a resource.
Link to Collection of RouteEntry. See the RouteEntry schema for
@odata.id string read-only
details.
Links { object The links to other resources that are related to this resource.
An array of links to the endpoints that represent the logical fabric
Endpoints [ { array
connection to this fabric adapter.
Link to a Endpoint resource. See the Links section and the Endpoint
@odata.id string read-only
schema for details.
}]
MemoryDomains An array of links to the memory domains associated with this fabric
array
(v1.3+) [ { adapter.
Link to a MemoryDomain resource. See the Links section and the
@odata.id string read-write
MemoryDomain schema for details.
}]
Oem {} object See the Oem object definition in the Common properties section.
PCIeDevices (v1.2+) An array of links to the PCIe devices associated with this fabric
array
[{ adapter.
Link to a PCIeDevice resource. See the Links section and the
@odata.id string read-only
PCIeDevice schema for details.
}]
Processors (v1.5+) [ An array of links to the processors that this fabric adapter provides to
array
{ a fabric.
Link to a Processor resource. See the Links section and the Processor
@odata.id string read-only
schema for details.
}]
394 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Location (v1.1+) {} object The location of the fabric adapter. For property details, see Location.
LocationIndicatorActive read-write
boolean An indicator allowing an operator to physically locate this resource.
(v1.4+) (null)
read-only
Manufacturer string The manufacturer or OEM of this fabric adapter.
(null)
read-only
Model string The model string for this fabric adapter.
(null)
read-only
PartNumber string The part number for this fabric adapter.
(null)
PCIeInterface { object The PCIe interface details for this fabric adapter.
read-only
LanesInUse (v1.3+) integer The number of PCIe lanes in use by this device.
(null)
read-only
MaxLanes (v1.3+) integer The number of PCIe lanes supported by this device.
(null)
MaxPCIeType string read-only The highest version of the PCIe specification supported by this device.
(v1.3+) (enum) (null) For the possible property values, see MaxPCIeType in Property details.
Oem (v1.3+) {} object See the Oem object definition in the Common properties section.
string read-only The version of the PCIe specification in use by this device. For the
PCIeType (v1.3+)
(enum) (null) possible property values, see PCIeType in Property details.
The link to the collection of ports that exist on the fabric adapter.
Ports { object
Contains a link to a resource.
@odata.id string read-only Link to Collection of Port. See the Port schema for details.
read-only
SerialNumber string The serial number for this fabric adapter.
(null)
read-only
SKU string The manufacturer SKU for this fabric adapter.
(null)
read-only
SparePartNumber string The spare part number for this fabric adapter.
(null)
Version 2023.1 Published 395
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
string read-only
UUID The UUID for this fabric adapter.
(uuid) (null)
6.43.4 Property details
6.43.4.1 FabricType
The configured fabric type of this fabric adapter.
string Description
AHCI Advanced Host Controller Interface (AHCI).
CXL Compute Express Link.
DisplayPort DisplayPort.
DVI DVI.
Ethernet Ethernet.
FC Fibre Channel.
FCoE Fibre Channel over Ethernet (FCoE).
FCP Fibre Channel Protocol for SCSI.
FICON FIbre CONnection (FICON).
FTP File Transfer Protocol (FTP).
GenZ GenZ.
HDMI HDMI.
HTTP Hypertext Transport Protocol (HTTP).
HTTPS Hypertext Transfer Protocol Secure (HTTPS).
I2C Inter-Integrated Circuit Bus.
InfiniBand InfiniBand.
iSCSI Internet SCSI.
396 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
iWARP Internet Wide Area RDMA Protocol (iWARP).
MultiProtocol Multiple Protocols.
NFSv3 Network File System (NFS) version 3.
NFSv4 Network File System (NFS) version 4.
NVLink NVLink.
NVMe Non-Volatile Memory Express (NVMe).
NVMeOverFabrics NVMe over Fabrics.
OEM OEM-specific.
PCIe PCI Express.
RoCE RDMA over Converged Ethernet Protocol.
RoCEv2 RDMA over Converged Ethernet Protocol Version 2.
SAS Serial Attached SCSI.
SATA Serial AT Attachment.
SFTP SSH File Transfer Protocol (SFTP).
SMB Server Message Block (SMB). Also known as the Common Internet File System (CIFS).
TCP Transmission Control Protocol (TCP).
TFTP Trivial File Transfer Protocol (TFTP).
UDP User Datagram Protocol (UDP).
UHCI Universal Host Controller Interface (UHCI).
USB Universal Serial Bus (USB).
VGA VGA.
6.43.4.2 FabricTypeCapabilities
An array of fabric types supported by this fabric adapter.
string Description
AHCI Advanced Host Controller Interface (AHCI).
Version 2023.1 Published 397
Redfish Resource and Schema Guide DSP2046
string Description
CXL Compute Express Link.
DisplayPort DisplayPort.
DVI DVI.
Ethernet Ethernet.
FC Fibre Channel.
FCoE Fibre Channel over Ethernet (FCoE).
FCP Fibre Channel Protocol for SCSI.
FICON FIbre CONnection (FICON).
FTP File Transfer Protocol (FTP).
GenZ GenZ.
HDMI HDMI.
HTTP Hypertext Transport Protocol (HTTP).
HTTPS Hypertext Transfer Protocol Secure (HTTPS).
I2C Inter-Integrated Circuit Bus.
InfiniBand InfiniBand.
iSCSI Internet SCSI.
iWARP Internet Wide Area RDMA Protocol (iWARP).
MultiProtocol Multiple Protocols.
NFSv3 Network File System (NFS) version 3.
NFSv4 Network File System (NFS) version 4.
NVLink NVLink.
NVMe Non-Volatile Memory Express (NVMe).
NVMeOverFabrics NVMe over Fabrics.
OEM OEM-specific.
PCIe PCI Express.
RoCE RDMA over Converged Ethernet Protocol.
398 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
RoCEv2 RDMA over Converged Ethernet Protocol Version 2.
SAS Serial Attached SCSI.
SATA Serial AT Attachment.
SFTP SSH File Transfer Protocol (SFTP).
SMB Server Message Block (SMB). Also known as the Common Internet File System (CIFS).
TCP Transmission Control Protocol (TCP).
TFTP Trivial File Transfer Protocol (TFTP).
UDP User Datagram Protocol (UDP).
UHCI Universal Host Controller Interface (UHCI).
USB Universal Serial Bus (USB).
VGA VGA.
6.43.4.3 MaxPCIeType
The highest version of the PCIe specification supported by this device.
string Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.
6.43.4.4 PCIeType
The version of the PCIe specification in use by this device.
string Description
Gen1 A PCIe v1.0 slot.
Version 2023.1 Published 399
Redfish Resource and Schema Guide DSP2046
string Description
Gen2 A PCIe v2.0 slot.
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.
6.43.5 Example response
{
"@odata.type": "#FabricAdapter.v1_5_1.FabricAdapter",
"Id": "Bridge",
"Name": "Gen-Z Bridge",
"Manufacturer": "Contoso",
"Model": "Gen-Z Bridge Model X",
"PartNumber": "975999-001",
"SparePartNumber": "152111-A01",
"SKU": "Contoso 2-port Gen-Z Bridge",
"SerialNumber": "2M220100SL",
"ASICRevisionIdentifier": "A0",
"ASICPartNumber": "53312",
"ASICManufacturer": "Contoso",
"FirmwareVersion": "7.4.10",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Ports": {
"@odata.id": "/redfish/v1/Systems/GenZ-example/FabricAdapters/1/Ports"
},
"PCIeInterface": {
"MaxPCIeType": "Gen4",
"MaxLanes": 64,
"PCIeType": "Gen4",
"LanesInUse": 64
},
"UUID": "45724775-ed3b-2214-1313-9865200c1cc1",
"Links": {
"Endpoints": [
{
"@odata.id": "/redfish/v1/Fabrics/GenZ/Endpoints/3"
}
]
},
"GenZ": {
"SSDT": {
400 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"@odata.id": "/redfish/v1/Systems/GenZ-example/FabricAdapters/1/SSDT"
},
"MSDT": {
"@odata.id": "/redfish/v1/Systems/GenZ-example/FabricAdapters/1/MSDT"
},
"RequestorVCAT": {
"@odata.id": "/redfish/v1/Systems/GenZ-example/FabricAdapters/1/REQ-VCAT"
},
"ResponderVCAT": {
"@odata.id": "/redfish/v1/Systems/GenZ-example/FabricAdapters/1/RSP-VCAT"
},
"RITable": [
"0x12",
"0x3E",
"0x12",
"0x3E",
"0x12",
"0x3E",
"0x12",
"0x3E",
"0x12",
"0x3E",
"0x12",
"0x3E",
"0x12",
"0x3E",
"0x12",
"0x3E"
],
"PIDT": [
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
Version 2023.1 Published 401
Redfish Resource and Schema Guide DSP2046
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568",
"0x12234568"
]
},
"@odata.id": "/redfish/v1/Systems/GenZ-example/FabricAdapters/1"
}
6.44 Facility 1.4.0
Version v1.4 v1.3 v1.2 v1.1 v1.0
Release 2023.1 2021.3 2021.2 2020.4 2019.4
6.44.1 Description
The Facility schema represents the physical location containing equipment, such as a room, building,
or campus.
6.44.2 URIs
/redfish/v1/Facilities/{FacilityId}
6.44.3 Properties
Property Type Attributes Notes
AmbientMetrics (v1.1+) The link to the ambient environment metrics for this facility. See the
object
{ EnvironmentMetrics schema for details on this property.
Link to a EnvironmentMetrics resource. See the Links section and the
@odata.id string read-only
EnvironmentMetrics schema for details.
402 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
EnvironmentMetrics The link to the environment metrics for this facility. See the
object
(v1.1+) { EnvironmentMetrics schema for details on this property.
Link to a EnvironmentMetrics resource. See the Links section and the
@odata.id string read-only
EnvironmentMetrics schema for details.
string read-only The type of location this resource represents. For the possible
FacilityType
(enum) required property values, see FacilityType in Property details.
Links { object The links to other resources that are related to this resource.
CDUs (v1.4+) [ { array An array of links to the cooling distribution units in this facility.
Link to a CoolingUnit resource. See the Links section and the
@odata.id string read-write
CoolingUnit schema for details.
}]
ContainedByFacility
object The link to the facility that contains this facility.
{
@odata.id string read-write Link to another Facility resource.
ContainsChassis [ { array An array of links to outermost chassis contained within this facility.
Link to a Chassis resource. See the Links section and the Chassis
@odata.id string read-write
schema for details.
}]
ContainsFacilities [
array An array of links to other facilities contained within this facility.
{
@odata.id string read-write Link to another Facility resource.
}]
CoolingLoops
array An array of links to the cooling loops in this facility.
(v1.4+) [ {
Link to a CoolingLoop resource. See the Links section and the
@odata.id string read-write
CoolingLoop schema for details.
}]
Version 2023.1 Published 403
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
ElectricalBuses
array An array of links to the electrical buses in this facility.
(v1.3+) [ {
Link to a PowerDistribution resource. See the Links section and the
@odata.id string read-write
PowerDistribution schema for details.
}]
FloorPDUs [ { array An array of links to the floor power distribution units in this facility.
Link to a PowerDistribution resource. See the Links section and the
@odata.id string read-write
PowerDistribution schema for details.
}]
ImmersionUnits
array An array of links to the immersion cooling units in this facility.
(v1.4+) [ {
Link to a CoolingUnit resource. See the Links section and the
@odata.id string read-write
CoolingUnit schema for details.
}]
An array of links to the managers responsible for managing this
ManagedBy [ { array
facility.
Link to a Manager resource. See the Links section and the Manager
@odata.id string read-only
schema for details.
}]
Oem {} object See the Oem object definition in the Common properties section.
PowerShelves
array An array of links to the power shelves in this facility.
(v1.2+) [ {
Link to a PowerDistribution resource. See the Links section and the
@odata.id string read-write
PowerDistribution schema for details.
}]
An array of links to the rack-level power distribution units in this
RackPDUs [ { array
facility.
Link to a PowerDistribution resource. See the Links section and the
@odata.id string read-write
PowerDistribution schema for details.
}]
Switchgear [ { array An array of links to the switchgear in this facility.
404 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to a PowerDistribution resource. See the Links section and the
@odata.id string read-write
PowerDistribution schema for details.
}]
TransferSwitches [
array An array of links to the transfer switches in this facility.
{
Link to a PowerDistribution resource. See the Links section and the
@odata.id string read-write
PowerDistribution schema for details.
}]
Location {} object The location of the facility. For property details, see Location.
PowerDomains { object Link to the power domains in this facility. Contains a link to a resource.
Link to Collection of PowerDomain. See the PowerDomain schema for
@odata.id string read-only
details.
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
6.44.4 Property details
6.44.4.1 FacilityType
The type of location this resource represents.
string Description
Building A structure with a roof and walls.
Floor A floor inside of a building.
Room A room inside of a building or floor.
Site A small area consisting of several buildings.
Version 2023.1 Published 405
Redfish Resource and Schema Guide DSP2046
6.44.5 Example response
{
"@odata.type": "#Facility.v1_4_0.Facility",
"Id": "Room237",
"Name": "Room #237, 2nd Floor",
"FacilityType": "Room",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Location": {
"PostalAddress": {
"Country": "US",
"Territory": "OR",
"City": "Portland",
"Street": "1001 SW 5th Avenue",
"HouseNumber": 1100,
"Name": "DMTF, Inc.",
"PostalCode": "97204",
"Floor": "2",
"Room": "237"
}
},
"PowerDomains": {
"@odata.id": "/redfish/v1/Facilities/Room237/PowerDomains"
},
"Links": {
"ContainedByFacility": {
"@odata.id": "/redfish/v1/Facilities/Building"
},
"RackPDUs": [
{
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1"
}
]
},
"@odata.id": "/redfish/v1/Facilities/Room237"
}
6.45 Fan 1.4.0
Version v1.4 v1.3 v1.2 v1.1 v1.0
Release 2023.1 2022.2 2022.1 2021.1 2020.4
406 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.45.1 Description
The Fan schema describes a cooling fan unit for a computer system or similar devices contained within
a chassis. It also describes the location, such as a slot, socket, or bay, where a unit can be installed, by
populating a resource instance with an absent state if a unit is not present.
6.45.2 URIs
/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Fans/{FanId}
6.45.3 Properties
Property Type Attributes Notes
The link to the assembly associated with this fan. See the Assembly
Assembly { object
schema for details on this property.
Link to a Assembly resource. See the Links section and the Assembly
@odata.id string read-only
schema for details.
integer read-only
FanDiameterMm (v1.4+) The diameter of the fan assembly in millimeters.
(mm) (null)
read-only An indication of whether this device can be inserted or removed
HotPluggable boolean
(null) while the equipment is in operation.
Links (v1.2+) { object The links to other resources that are related to this resource.
CoolingChassis
array An array of links to the chassis that are directly cooled by this fan.
(v1.2+) [ {
Link to a Chassis resource. See the Links section and the Chassis
@odata.id string read-only
schema for details.
}]
Oem {} object See the Oem object definition in the Common properties section.
Location {} object The location of the fan. For property details, see Location.
read-write
LocationIndicatorActive boolean An indicator allowing an operator to physically locate this resource.
(null)
Version 2023.1 Published 407
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
Manufacturer string The manufacturer of this fan.
(null)
read-only
Model string The model number for this fan.
(null)
read-only
PartNumber string The part number for this fan.
(null)
string The area or device associated with this fan. For the possible property
PhysicalContext read-only
(enum) values, see PhysicalContext in Property details.
object Power consumption (W). This object is an excerpt of the Sensor
PowerWatts (v1.1+) {
(excerpt) resource located at the URI shown in DataSourceUri.
number read-only The product of voltage and current for an AC circuit, in volt-ampere
ApparentVA
(V.A) (null) units.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
PhaseAngleDegrees read-only The phase angle (degrees) between the current and voltage
number
(v1.5+) (null) waveforms.
read-only
PowerFactor number The power factor for this sensor.
(null)
number read-only The square root of the difference term of squared apparent VA and
ReactiveVAR
(V.A) (null) squared power (Reading) for a circuit, in VAR units.
read-only
Reading number The sensor value.
(null)
read-only An indication of whether this component can be independently
Replaceable (v1.3+) boolean
(null) replaced as allowed by the vendor's replacement policy.
read-only
SerialNumber string The serial number for this fan.
(null)
read-only
SparePartNumber string The spare part number for this fan.
(null)
object The fan speed (percent). This object is an excerpt of the Sensor
SpeedPercent {
(excerpt) resource located at the URI shown in DataSourceUri.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
408 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only
Reading number The sensor value.
(null)
number read-only
SpeedRPM (v1.2+) The rotational speed.
({rev}/min) (null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
6.45.4 Property details
6.45.4.1 PhysicalContext
The area or device associated with this fan.
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
Version 2023.1 Published 409
Redfish Resource and Schema Guide DSP2046
string Description
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
GPU A graphics processor (GPU).
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
StorageBay Within a storage bay.
410 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
6.45.5 Example response
{
"@odata.type": "#Fan.v1_4_0.Fan",
"Id": "Bay1",
"Name": "Fan Bay 1",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"PhysicalContext": "Chassis",
"Model": "RKS-440DC",
"Manufacturer": "Contoso Fans",
"PartNumber": "23456-133",
"SparePartNumber": "93284-133",
"LocationIndicatorActive": true,
"HotPluggable": true,
"SpeedPercent": {
"Reading": 45,
"SpeedRPM": 2200,
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/FanBay1"
},
"Location": {
"PartLocation": {
"ServiceLabel": "Chassis Fan Bay 1",
"LocationType": "Bay",
"LocationOrdinalValue": 0
}
},
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/Fans/Bay1"
}
Version 2023.1 Published 411
Redfish Resource and Schema Guide DSP2046
6.46 Filter 1.0.0
Version v1.0
Release 2023.1
6.46.1 Description
The Filter schema describes a filter unit for a cooling system or similar device.
6.46.2 URIs
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Filters/{FilterId}
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Pumps/{PumpId}/Filters/{FilterId}
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Reservoirs/{ReservoirId}/Filters/{FilterId}
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Filters/{FilterId}
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Pumps/{PumpId}/Filters/{FilterId}
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Reservoirs/{ReservoirId}/Filters/
{FilterId}
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Filters/{FilterId}
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Pumps/{PumpId}/Filters/{FilterId}
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Reservoirs/{ReservoirId}/Filters/
{FilterId}
6.46.3 Properties
Property Type Attributes Notes
The link to the assembly associated with this filter. See the Assembly
Assembly { object
schema for details on this property.
Link to a Assembly resource. See the Links section and the Assembly
@odata.id string read-only
schema for details.
read-only An indication of whether this device can be inserted or removed while
HotPluggable boolean
(null) the equipment is in operation.
Location {} object The location of the filter. For property details, see Location.
412 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write
LocationIndicatorActive boolean An indicator allowing an operator to physically locate this resource.
(null)
read-only
Manufacturer string The manufacturer of this filter.
(null)
read-only
Model string The model number for this filter.
(null)
read-only
PartNumber string The part number for this filter.
(null)
string The area or device associated with this filter. For the possible
PhysicalContext read-only
(enum) property values, see PhysicalContext in Property details.
read-only
RatedServiceHours number The rated hours of service life for this filter.
(null)
read-only An indication of whether this component can be independently
Replaceable boolean
(null) replaced as allowed by the vendor's replacement policy.
read-only
SerialNumber string The serial number for this filter.
(null)
string
read-write
ServicedDate (date- The date this filter was put into service.
(null)
time)
read-write
ServiceHours number The hours of service this filter has provided.
(null)
read-only
SparePartNumber string The spare part number for this filter.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
UserLabel string read-write A user-assigned label.
6.46.4 Property details
6.46.4.1 PhysicalContext
The area or device associated with this filter.
Version 2023.1 Published 413
Redfish Resource and Schema Guide DSP2046
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
GPU A graphics processor (GPU).
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
414 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
StorageBay Within a storage bay.
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
6.46.5 Example response
{
"@odata.type": "#Filter.v1_0_0.Filter",
"Id": "1",
"Name": "Cooling Loop Filter",
Version 2023.1 Published 415
Redfish Resource and Schema Guide DSP2046
"ServicedDate": "2020-12-24T08:00:00Z",
"ServiceHours": 5791,
"RatedServiceHours": 10000,
"Manufacturer": "Contoso",
"Model": "MyCoffee",
"PartNumber": "Cone4",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Location": {
"Placement": {
"Row": "North 1"
}
},
"@odata.id": "/redfish/v1/ThermalEquipment/CDUs/1/Filters/1"
}
6.47 GraphicsController 1.0.0
Version v1.0
Release 2021.1
6.47.1 Description
The GraphicsController schema defines a graphics controller that can be used to drive one or more
display devices.
6.47.2 URIs
/redfish/v1/Systems/{ComputerSystemId}/GraphicsControllers/{ControllerId}
6.47.3 Properties
Property Type Attributes Notes
read-write
AssetTag string The user-assigned asset tag for this graphics controller.
(null)
416 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only The version of the graphics controller BIOS or primary graphics controller
BiosVersion string
(null) firmware.
read-only The version of the graphics controller driver loaded in the operating
DriverVersion string
(null) system.
Links { object The links to other resources that are related to this resource.
Oem {} object See the Oem object definition in the Common properties section.
A link to the PCIe device that represents this graphics controller. See the
PCIeDevice { object
(null) PCIeDevice schema for details on this property.
Link to a PCIeDevice resource. See the Links section and the PCIeDevice
@odata.id string read-only
schema for details.
An array of links to the processors that are a part of this graphics
Processors [ { array
controller.
Link to a Processor resource. See the Links section and the Processor
@odata.id string read-only
schema for details.
}]
Location {} object The location of the graphics controller. For property details, see Location.
read-only
Manufacturer string The manufacturer of this graphics controller.
(null)
read-only
Model string The product model number of this graphics controller.
(null)
read-only
PartNumber string The part number for this graphics controller.
(null)
Ports { object The ports of the graphics controller. Contains a link to a resource.
@odata.id string read-only Link to Collection of Port. See the Port schema for details.
read-only
SerialNumber string The serial number for this graphics controller.
(null)
read-only
SKU string The SKU for this graphics controller.
(null)
Version 2023.1 Published 417
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
SparePartNumber string The spare part number of the graphics controller.
(null)
The status and health of the resource and its subordinate or dependent
Status {} object
resources. For property details, see Status.
6.47.4 Example response
{
"@odata.type": "#GraphicsController.v1_0_0.GraphicsController",
"Id": "GPU1",
"Name": "Contoso Graphics Controller 1",
"AssetTag": "",
"Manufacturer": "Contoso",
"Model": "GPU1",
"SKU": "80937",
"SerialNumber": "2M220100SL",
"PartNumber": "G37891",
"SparePartNumber": "G37890",
"BiosVersion": "90.02.17.00.7D",
"DriverVersion": "27.21.14.6079 (Contoso 460.79) DCH / Win 10 64",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Location": {
"PartLocation": {
"ServiceLabel": "Slot 1",
"LocationOrdinalValue": 1,
"LocationType": "Slot",
"Orientation": "LeftToRight",
"Reference": "Rear"
}
},
"Ports": {
"@odata.id": "/redfish/v1/Systems/1/GraphicsControllers/GPU1/Ports"
},
"Links": {
"Processors": [
{
"@odata.id": "/redfish/v1/Systems/1/Processors/GPU"
}
]
},
"@odata.id": "/redfish/v1/Systems/1/GraphicsControllers/GPU1"
}
418 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.48 Heater 1.0.0
Version v1.0
Release 2022.3
6.48.1 Description
The Heater schema describes a heating unit for devices contained within a chassis.
6.48.2 URIs
/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Heaters/{HeaterId}
6.48.3 Properties
Property Type Attributes Notes
The link to the assembly associated with this heater. See the
Assembly { object
Assembly schema for details on this property.
Link to a Assembly resource. See the Links section and the Assembly
@odata.id string read-only
schema for details.
read-only An indication of whether this device can be inserted or removed while
HotPluggable boolean
(null) the equipment is in operation.
Links { object The links to other resources that are related to this resource.
Managers [ { array An array of links to the managers heated by this heater.
Link to a Manager resource. See the Links section and the Manager
@odata.id string read-only
schema for details.
}]
Memory [ { array An array of links to the memory devices heated by this heater.
Link to a Memory resource. See the Links section and the Memory
@odata.id string read-only
schema for details.
}]
Version 2023.1 Published 419
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
NetworkAdapters [
array An array of links to the network adapters heated by this heater.
{
Link to a NetworkAdapter resource. See the Links section and the
@odata.id string read-only
NetworkAdapter schema for details.
}]
Oem {} object See the Oem object definition in the Common properties section.
Processors [ { array An array of links to the processors heated by this heater.
Link to a Processor resource. See the Links section and the Processor
@odata.id string read-only
schema for details.
}]
StorageControllers [
array An array of links to the storage controllers heated by this heater.
{
Link to a StorageController resource. See the Links section and the
@odata.id string read-only
StorageController schema for details.
}]
Location {} object The location of the heater. For property details, see Location.
read-write
LocationIndicatorActive boolean An indicator allowing an operator to physically locate this resource.
(null)
read-only
Manufacturer string The manufacturer of this heater.
(null)
The link to the heater metrics resource associated with this heater.
Metrics { object
See the HeaterMetrics schema for details on this property.
Link to a HeaterMetrics resource. See the Links section and the
@odata.id string read-only
HeaterMetrics schema for details.
read-only
Model string The model number for this heater.
(null)
read-only
PartNumber string The part number for this heater.
(null)
string The area or device associated with this heater. For the possible
PhysicalContext read-only
(enum) property values, see PhysicalContext in Property details.
420 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only
SerialNumber string The serial number for this heater.
(null)
read-only
SparePartNumber string The spare part number for this heater.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
6.48.4 Property details
6.48.4.1 PhysicalContext
The area or device associated with this heater.
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
CPU A processor (CPU).
Version 2023.1 Published 421
Redfish Resource and Schema Guide DSP2046
string Description
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
GPU A graphics processor (GPU).
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
StorageBay Within a storage bay.
StorageDevice A storage device.
422 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
SystemBoard The system board (PCB).
Transceiver A transceiver.
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
6.48.5 Example response
{
"@odata.type": "#Heater.v1_0_0.Heater",
"Id": "CPU1Heater",
"Description": "Heater for CPU1",
"Name": "Heater 1",
"PhysicalContext": "CPU",
"Manufacturer": "Contoso Heaters",
"Model": "CPUHeater",
"SerialNumber": "SNDHM0123456789",
"PartNumber": "12345-123",
"SparePartNumber": "54321-321",
"LocationIndicatorActive": false,
"HotPluggable": true,
"Status": {
"Health": "OK",
"State": "Enabled"
},
"Links": {
"Processors": [
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Processors/CPU1"
}
]
},
"Metrics": {
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/Heaters/CPU1Heater/Metrics"
},
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/Heaters/CPU1Heater"
}
Version 2023.1 Published 423
Redfish Resource and Schema Guide DSP2046
6.49 HeaterMetrics 1.0.0
Version v1.0
Release 2022.3
6.49.1 Description
The HeaterMetrics schema contains definitions for the metrics of a heater.
6.49.2 URIs
/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Heaters/{HeaderId}/Metrics
6.49.3 Properties
Property Type Attributes Notes
object Power consumption (W). This object is an excerpt of the
PowerWatts {
(excerpt) Sensor resource located at the URI shown in DataSourceUri.
number read-only The product of voltage and current for an AC circuit, in volt-
ApparentVA
(V.A) (null) ampere units.
string read-only The link to the resource that provides the data for this
DataSourceUri
(URI) (null) sensor.
read-only The phase angle (degrees) between the current and voltage
PhaseAngleDegrees (v1.5+) number
(null) waveforms.
read-only
PowerFactor number The power factor for this sensor.
(null)
number read-only The square root of the difference term of squared apparent
ReactiveVAR
(V.A) (null) VA and squared power (Reading) for a circuit, in VAR units.
read-only
Reading number The sensor value.
(null)
read-only The total number of seconds the heater was active while the
PrePowerOnHeatingTimeSeconds integer
(null) device it heats was powered off.
424 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only The total number of seconds the heater was active while the
RuntimeHeatingTimeSeconds integer
(null) device it heats was powered on.
The temperatures (Celsius) from all related sensors for this
array
TemperatureReadingsCelsius [ { device. This object is an excerpt of the Sensor resource
(excerpt)
located at the URI shown in DataSourceUri.
string read-only The link to the resource that provides the data for this
DataSourceUri
(URI) (null) sensor.
read-only
DeviceName (v1.2+) string The name of the device.
(null)
The area or device to which this sensor measurement
string read-only
PhysicalContext applies. For the possible property values, see
(enum) (null)
PhysicalContext in Property details.
The usage or location within a device to which this sensor
string read-only
PhysicalSubContext measurement applies. For the possible property values, see
(enum) (null)
PhysicalSubContext in Property details.
read-only
Reading number The sensor value.
(null)
}]
6.49.4 Actions
6.49.4.1 ResetMetrics
Description
This action resets the summary metrics related to this equipment.
Action URI
{Base URI of target resource}/Actions/HeaterMetrics.ResetMetrics
Action parameters
This action takes no parameters.
Version 2023.1 Published 425
Redfish Resource and Schema Guide DSP2046
6.49.5 Property details
6.49.5.1 PhysicalContext
The area or device to which this sensor measurement applies.
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
426 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
GPU A graphics processor (GPU).
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
StorageBay Within a storage bay.
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
Version 2023.1 Published 427
Redfish Resource and Schema Guide DSP2046
6.49.5.2 PhysicalSubContext
The usage or location within a device to which this sensor measurement applies.
string Description
Input The input.
Output The output.
6.49.6 Example response
{
"@odata.type": "#HeaterMetrics.v1_0_0.HeaterMetrics",
"Id": "HeaterMetrics",
"Description": "Heater Metrics for CPU1 Heater",
"Name": "CPU1 Heater Metrics",
"PrePowerOnHeatingTimeSeconds": 600,
"RuntimeHeatingTimeSeconds": 3600,
"PowerWatts": {
"Reading": 200.3
},
"TemperatureReadingsCelsius": [
{
"DeviceName": "Heater Average Temperature",
"Reading": 2.5
}
],
"Actions": {
"#HeaterMetrics.ResetMetrics": {
"target": "/redfish/v1/Chassis/1U/ThermalSubsystem/Heaters/CPU1Heater/Metrics/HeaterMetrics.ResetMetric
}
},
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/Heaters/CPU1Heater/Metrics"
}
6.50 HostInterface 1.3.0
Version v1.3 v1.2 v1.1 v1.0
Release 2020.3 2018.2 2017.1 2016.3
428 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.50.1 Description
The properties associated with a Host Interface. A Host Interface is a connection between host
software and a Redfish Service.
6.50.2 URIs
/redfish/v1/Managers/{ManagerId}/HostInterfaces/{HostInterfaceId}
6.50.3 Properties
Property Type Attributes Notes
array The authentication modes available on this interface. For the
AuthenticationModes [ ] (string read-write possible property values, see AuthenticationModes in
(enum)) Property details.
AuthNoneRoleId (v1.2+) string read-write The role when no authentication on this interface is used.
CredentialBootstrapping (v1.3+)
object The credential bootstrapping settings for this interface.
{
read-write An indication of whether credential bootstrapping is enabled
EnableAfterReset (v1.3+) boolean
(null) after a reset for this interface.
read-write An indication of whether credential bootstrapping is enabled
Enabled (v1.3+) boolean
(null) for this interface.
The role used for the bootstrap account created for this
RoleId (v1.3+) string read-write
interface.
An indication of whether external entities can access this
interface. External entities are non-host entities. For example,
read-only if the host and manager are connected through a switch and
ExternallyAccessible boolean
(null) the switch also exposes an external port on the system,
external clients can also use the interface, and this property
value is true .
An indication of whether this firmware authentication is
FirmwareAuthEnabled read-write enabled for this interface. Deprecated in v1.3 and later. This
boolean
(deprecated v1.3) (null) property has been deprecated in favor of newer methods of
negotiating credentials.
Version 2023.1 Published 429
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The Role used for firmware authentication on this interface.
FirmwareAuthRoleId (deprecated Deprecated in v1.3 and later. This property has been
string read-write
v1.3) deprecated in favor of newer methods of negotiating
credentials.
A link to the collection of network interface controllers or
HostEthernetInterfaces { object cards (NICs) that a computer system uses to communicate
with this Host Interface. Contains a link to a resource.
Link to Collection of EthernetInterface. See the
@odata.id string read-only
EthernetInterface schema for details.
string read-only The Host Interface type for this interface. For the possible
HostInterfaceType
(enum) (null) property values, see HostInterfaceType in Property details.
read-write
InterfaceEnabled boolean An indication of whether this interface is enabled.
(null)
An indication of whether this kernel authentication is enabled
KernelAuthEnabled (deprecated read-write for this interface. Deprecated in v1.3 and later. This property
boolean
v1.3) (null) has been deprecated in favor of newer methods of
negotiating credentials.
The Role used for kernel authentication on this interface.
KernelAuthRoleId (deprecated Deprecated in v1.3 and later. This property has been
string read-write
v1.3) deprecated in favor of newer methods of negotiating
credentials.
Links { object The links to other Resources that are related to this Resource.
The link to the Redfish Role that contains the privileges on
AuthNoneRole (v1.2+) { object this Host Interface when no authentication is performed. See
the Role schema for details on this property.
Link to a Role resource. See the Links section and the Role
@odata.id string read-only
schema for details.
An array of links to the computer systems connected to this
ComputerSystems [ { array
Host Interface.
Link to a ComputerSystem resource. See the Links section
@odata.id string read-only
and the ComputerSystem schema for details.
}]
430 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The link to the role that contains the privileges for the
CredentialBootstrappingRole
object bootstrap account created for this interface. See the Role
(v1.3+) {
schema for details on this property.
Link to a Role resource. See the Links section and the Role
@odata.id string read-only
schema for details.
The link to the Redfish Role that has firmware authentication
privileges on this Host Interface. See the Role schema for
FirmwareAuthRole
object details on this property. Deprecated in v1.3 and later. This
(deprecated v1.3) {
property has been deprecated in favor of newer methods of
negotiating credentials.
Link to a Role resource. See the Links section and the Role
@odata.id string read-only
schema for details.
The link to the Redfish Role defining privileges for this Host
Interface when using kernel authentication. See the Role
KernelAuthRole (deprecated
object schema for details on this property. Deprecated in v1.3 and
v1.3) {
later. This property has been deprecated in favor of newer
methods of negotiating credentials.
Link to a Role resource. See the Links section and the Role
@odata.id string read-only
schema for details.
See the Oem object definition in the Common properties
Oem {} object
section.
A link to a single network interface controllers or cards (NIC)
that this manager uses for network communication with this
ManagerEthernetInterface { object
Host Interface. See the EthernetInterface schema for details
on this property.
Link to a EthernetInterface resource. See the Links section
@odata.id string read-only
and the EthernetInterface schema for details.
A link to the network services and their settings that the
manager controls. In this property, clients find configuration
NetworkProtocol { object
options for the network and network services. See the
ManagerNetworkProtocol schema for details on this property.
Version 2023.1 Published 431
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to a ManagerNetworkProtocol resource. See the Links
@odata.id string read-only
section and the ManagerNetworkProtocol schema for details.
The status and health of the Resource and its subordinate or
Status {} object
dependent Resources. For property details, see Status.
6.50.4 Property details
6.50.4.1 AuthenticationModes
The authentication modes available on this interface.
string Description
AuthNone Requests without any sort of authentication are allowed.
BasicAuth Requests using HTTP Basic Authentication are allowed.
OemAuth Requests using OEM authentication mechanisms are allowed.
RedfishSessionAuth Requests using Redfish Session Authentication are allowed.
6.50.4.2 HostInterfaceType
The Host Interface type for this interface.
string Description
NetworkHostInterface This interface is a Network Host Interface.
6.50.5 Example response
{
"@odata.type": "#HostInterface.v1_3_0.HostInterface",
"Id": "1",
"Name": "Host Interface",
"Description": "Management Host Interface",
"HostInterfaceType": "NetworkHostInterface",
432 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"Status": {
"State": "Enabled",
"Health": "OK"
},
"InterfaceEnabled": true,
"ExternallyAccessible": false,
"AuthenticationModes": [
"AuthNone",
"BasicAuth",
"RedfishSessionAuth",
"OemAuth"
],
"CredentialBootstrapping": {
"EnableAfterReset": true,
"Enabled": true,
"RoleId": "User"
},
"HostEthernetInterfaces": {
"@odata.id": "/redfish/v1/Managers/BMC/HostInterfaces/1/HostEthernetInterfaces"
},
"ManagerEthernetInterface": {
"@odata.id": "/redfish/v1/Managers/BMC/EthernetInterfaces/ToHost"
},
"NetworkProtocol": {
"@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol"
},
"Links": {
"ComputerSystems": [
{
"@odata.id": "/redfish/v1/Systems/ORD144"
}
],
"CredentialBootstrappingRole": {
"@odata.id": "/redfish/v1/AccountService/Roles/User"
}
},
"@odata.id": "/redfish/v1/Managers/BMC/HostInterfaces/1"
}
6.51 Job 1.2.1
Version v1.2 v1.1 v1.0
Release 2022.3 2022.1 2018.2
Version 2023.1 Published 433
Redfish Resource and Schema Guide DSP2046
6.51.1 Description
The Job schema contains information about a job that a Redfish job service schedules or executes.
Clients create jobs to describe a series of operations that occur at periodic intervals.
6.51.2 URIs
/redfish/v1/JobService/Jobs/{JobId}
/redfish/v1/JobService/Jobs/{JobId}/Steps/{JobId2}
6.51.3 Properties
Property Type Attributes Notes
CreatedBy string read-only The person or program that created this job entry.
string
EndTime read-only The date and time when the job was completed.
(date-time)
EstimatedDuration string read-only
The estimated total time required to complete the job.
(v1.1+) (duration) (null)
An indication of whether the contents of the payload should be hidden
from view after the job has been created. If true , responses do not
HidePayload boolean read-only
return the payload. If false , responses return the payload. If this
property is not present when the job is created, the default is false .
string The state of the job. For the possible property values, see JobState in
JobState read-write
(enum) Property details.
string The status of the job. For the possible property values, see JobStatus in
JobStatus read-only
(enum) Property details.
Links (v1.2+) { object Contains references to other resources that are related to this resource.
CreatedResources An array of URIs referencing the resources created as the result of this
array
(v1.2+) [ { job.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
Oem {} object See the Oem object definition in the Common properties section.
434 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write
MaxExecutionTime string The maximum amount of time the job is allowed to execute.
(null)
array An array of messages associated with the job. For property details, see
Messages [ { } ]
(object) Message.
Payload { object The HTTP and JSON request payload details for this job.
array
HttpHeaders [ ] read-only An array of HTTP headers in this job.
(string)
HttpOperation string read-only The HTTP operation that executes this job.
JsonBody string read-only The JSON payload to use in the execution of this job.
string
TargetUri read-only The link to the target for this job.
(URI)
integer read-only
PercentComplete The completion percentage of this job.
(%) (null)
Schedule {} object The schedule settings for this job. For property details, see Schedule.
string
StartTime read-only The date and time when the job was started or is scheduled to start.
(date-time)
array
StepOrder [ ] read-only The serialized execution order of the job steps.
(string)
The link to a collection of steps for this job. Contains a link to a
Steps { object
resource.
@odata.id string read-only Link to Collection of Job. See the Job schema for details.
6.51.4 Property details
6.51.4.1 JobState
The state of the job.
string Description
Cancelled Job was cancelled.
Version 2023.1 Published 435
Redfish Resource and Schema Guide DSP2046
string Description
Completed Job was completed.
Continue Job is to resume operation.
Exception Job has stopped due to an exception condition.
Interrupted Job has been interrupted.
New A new job.
Pending Job is pending and has not started.
Running Job is running normally.
Service Job is running as a service.
Starting Job is starting.
Stopping Job is in the process of stopping.
Suspended Job has been suspended.
UserIntervention Job is waiting for user intervention.
6.51.4.2 JobStatus
The status of the job.
string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.
6.51.5 Example response
{
"@odata.type": "#Job.v1_2_1.Job",
"Id": "RebootRack",
"Name": "Scheduled Nightly Reboot of the rack",
"JobStatus": "OK",
"JobState": "Running",
"StartTime": "2018-04-01T00:01+6:00",
436 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"PercentComplete": 24,
"Schedule": {
"Lifetime": "P4Y",
"InitialStartTime": "2018-01-01T01:00:00+06:00",
"RecurrenceInterval": "P1D",
"EnabledDaysOfWeek": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday"
]
},
"Steps": {
"@odata.id": "/redfish/v1/JobService/Jobs/RebootRack/Steps"
},
"StepOrder": [
"Red",
"Orange",
"Yellow",
"Green",
"Blue",
"Indigo",
"Violet"
],
"@odata.id": "/redfish/v1/JobService/Jobs/RebootRack"
}
6.52 JobService 1.0.4
Version v1.0
Release 2018.2
6.52.1 Description
The JobService schema contains properties for scheduling and execution of operations, represents the
properties for the job service itself, and has links to jobs managed by the job service.
6.52.2 URIs
/redfish/v1/JobService
Version 2023.1 Published 437
Redfish Resource and Schema Guide DSP2046
6.52.3 Properties
Property Type Attributes Notes
string read-only
DateTime The current date and time setting for the job service.
(date-time) (null)
Jobs { object The links to the jobs collection. Contains a link to a resource.
@odata.id string read-only Link to Collection of Job. See the Job schema for details.
The link to a log service that the job service uses. This service can be a
dedicated log service or a pointer a log service under another resource,
Log { object
such as a manager. See the LogService schema for details on this
property.
Link to a LogService resource. See the Links section and the LogService
@odata.id string read-only
schema for details.
ServiceCapabilities
object The supported capabilities of this job service implementation.
{
read-only
MaxJobs integer The maximum number of jobs supported.
(null)
read-only
MaxSteps integer The maximum number of job steps supported.
(null)
read-only
Scheduling boolean An indication of whether scheduling of jobs is supported.
(null)
read-write
ServiceEnabled boolean An indication of whether this service is enabled.
(null)
The status and health of the resource and its subordinate or dependent
Status {} object
resources. For property details, see Status.
6.52.4 Example response
{
"@odata.type": "#JobService.v1_0_4.JobService",
"Id": "JobService",
438 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"Name": "Job Service",
"DateTime": "2018-06-13T04:14+06:00",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"ServiceEnabled": true,
"ServiceCapabilities": {
"MaxJobs": 100,
"MaxSteps": 50,
"Scheduling": true
},
"Jobs": {
"@odata.id": "/redfish/v1/JobService/Jobs"
},
"Log": {
"@odata.id": "/redfish/v1/JobService/Log"
},
"Actions": {
"Oem": {
"#Contoso.EasyButton": {
"target": "/redfish/v1/JobService/Contoso.EasyButton",
"@Redfish.ActionInfo": "/redfish/v1/JobService/EasyButtonActionInfo"
}
}
},
"@odata.id": "/redfish/v1/JobService"
}
6.53 JsonSchemaFile 1.1.4
Version v1.1 v1.0
Release 2017.1 1.0
6.53.1 Description
The JsonSchemaFile schema contains the properties that describe the locations, as URIs, of a Redfish
Schema definition that a Redfish Service implements or references.
6.53.2 URIs
/redfish/v1/JsonSchemas/{JsonSchemaFileId}
Version 2023.1 Published 439
Redfish Resource and Schema Guide DSP2046
6.53.3 Properties
Property Type Attributes Notes
array read-only
Languages [ ] The RFC5646-conformant language codes for the available schemas.
(string) required
Location [ { array required Location information for this schema file.
The name of the file in the archive, if the schema is hosted on the service
ArchiveFile string read-only
in an archive file.
string The link to an archive file, if the schema is hosted on the service in an
ArchiveUri read-only
(URI) archive file.
Language string read-only The language code for the schema file.
string
PublicationUri read-only The link to publicly available (canonical) URI for schema.
(URI)
string
Uri read-only The link to locally available URI for schema.
(URI)
}]
read-only
Schema string The @odata.type name this schema describes.
required
6.53.4 Example response
{
"@odata.type": "#JsonSchemaFile.v1_1_4.JsonSchemaFile",
"Id": "Chassis.v1_11_0",
"Name": "Chassis Schema File",
"Description": "Chassis Schema File Location",
"Languages": [
"en"
],
"Schema": "#Chassis.v1_11_0.Chassis",
"Location": [
{
"Language": "en",
"ArchiveUri": "/Schemas.gz",
"PublicationUri": "http://redfish.dmtf.org/schemas/v1/Chassis.v1_11_0.json",
"ArchiveFile": "Chassis.v1_11_0.json"
},
{
440 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"Language": "zh",
"ArchiveUri": "/Schemas.zh.gz",
"PublicationUri": "http://schemas.contoso.com/Chassis.v1_11_0.zh.json",
"ArchiveFile": "Chassis.v1_11_0.zh.json"
},
{
"Language": "xy",
"Uri": "/redfish/v1/JsonSchemas/Chassis.v1_11_0.xy.json",
"PublicationUri": "http://schemas.contoso.com/Chassis.v1_11_0.xy.json"
}
],
"@odata.id": "/redfish/v1/JsonSchemas/Chassis.v1_11_0"
}
6.54 Key 1.2.0
Version v1.2 v1.1 v1.0
Release 2022.3 2022.1 2021.2
6.54.1 Description
The Key schema describes sensitive data for accessing devices or services.
6.54.2 URIs
/redfish/v1/AccountService/Accounts/{ManagerAccountId}/Keys/{KeyId}
/redfish/v1/AggregationService/AggregationSources/{AggregationSourceId}/PresentedPublicHostKey
/redfish/v1/AggregationService/AggregationSources/{AggregationSourceId}/PublicIdentityKey
/redfish/v1/AggregationService/AggregationSources/{AggregationSourceId}/TrustedPublicHostKeys/
{KeyId}
/redfish/v1/KeyService/NVMeoFSecrets/{KeyId}
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/Accounts/{ManagerAccountId}/Keys/
{KeyId}
Version 2023.1 Published 441
Redfish Resource and Schema Guide DSP2046
6.54.3 Properties
Property Type Attributes Notes
read-only
required
KeyString string The string for the key.
on create
(null)
read-only
string required The format of the key. For the possible property values, see
KeyType
(enum) on create KeyType in Property details.
(null)
NVMeoF { object NVMe-oF specific properties.
(null)
read-write
HostKeyId string The identifier of the host key paired with this target key.
(null)
read-only
required The NVMe Qualified Name (NQN) of the host or target subsystem
NQN string
on create associated with this key.
(null)
read-only
OEMSecurityProtocolType string The OEM security protocol that this key uses.
(null)
array The secure hash algorithms allowed with the usage of this key.
read-only
SecureHashAllowList [ ] (string For the possible property values, see SecureHashAllowList in
(null)
(enum)) Property details.
string read-only The security protocol that this key uses. For the possible
SecurityProtocolType
(enum) (null) property values, see SecurityProtocolType in Property details.
SSH (v1.2+) { object SSH specific properties.
(null)
read-only
Fingerprint (v1.2+) string A fingerprint of the key.
(null)
read-write
UserDescription (v1.1+) string A user-defined string to describe this key.
(null)
442 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.54.4 Property details
6.54.4.1 KeyType
The format of the key.
string Description
NVMeoF An NVMe-oF key.
SSH (v1.1+) An SSH public key.
6.54.4.2 SecureHashAllowList
The secure hash algorithms allowed with the usage of this key.
string Description
SHA256 SHA-256.
SHA384 SHA-384.
SHA512 SHA-512.
6.54.4.3 SecurityProtocolType
The security protocol that this key uses.
string Description
Diffie-Hellman Hashed Message Authentication Code Challenge Handshake Authentication
DHHC
Protocol (DH-HMAC-CHAP).
OEM OEM.
TLS_PSK Transport Layer Security Pre-Shared Key (TLS PSK).
6.54.5 Example response
Version 2023.1 Published 443
Redfish Resource and Schema Guide DSP2046
"@odata.type": "#Key.v1_2_0.Key",
"Id": "0",
"Name": "NVMeoF key 0, target subsystem",
"KeyType": "NVMeoF",
"KeyString": "DHHC-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n:",
"NVMeoF": {
"NQN": "nqn.corp.com:nvme:target-subsystem-0001",
"SecurityProtocolType": "DHHC",
"HostKeyId": "1",
"SecureHashAllowList": [
"SHA384",
"SHA512"
]
},
"@odata.id": "/redfish/v1/KeyService/NVMeoFSecrets/0"
}
6.55 KeyPolicy 1.0.0
Version v1.0
Release 2021.2
6.55.1 Description
The KeyPolicy schema describes settings for how keys are allowed to be used for accessing devices or
services.
6.55.2 URIs
/redfish/v1/KeyService/NVMeoFKeyPolicies/{KeyPolicyId}
6.55.3 Properties
Property Type Attributes Notes
read-write
IsDefault boolean Indicates if this is the default key policy.
(null)
444 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only
string required The type of key policy. For the possible property values, see
KeyPolicyType
(enum) on create KeyPolicyType in Property details.
(null)
NVMeoF { object NVMe-oF specific properties.
(null)
array
read-write The cipher suites that this key policy allows. For the possible
CipherSuiteAllowList [ ] (string
(null) property values, see CipherSuiteAllowList in Property details.
(enum))
array The Diffie-Hellman (DH) groups that this key policy allows.
read-write
DHGroupAllowList [ ] (string For the possible property values, see DHGroupAllowList in
(null)
(enum)) Property details.
array
OEMSecurityProtocolAllowList
(string, read-write The OEM security protocols that this key policy allows.
[]
null)
array The secure hash algorithms that this key policy allows. For
read-write
SecureHashAllowList [ ] (string the possible property values, see SecureHashAllowList in
(null)
(enum)) Property details.
array The security protocols that this key policy allows. For the
read-write
SecurityProtocolAllowList [ ] (string possible property values, see SecurityProtocolAllowList in
(null)
(enum)) Property details.
array The security transports that this key policy allows. For the
read-write
SecurityTransportAllowList [ ] (string possible property values, see SecurityTransportAllowList in
(null)
(enum)) Property details.
6.55.4 Property details
6.55.4.1 CipherSuiteAllowList
The cipher suites that this key policy allows.
string Description
TLS_AES_128_GCM_SHA256 TLS_AES_128_GCM_SHA256.
TLS_AES_256_GCM_SHA384 TLS_AES_256_GCM_SHA384.
Version 2023.1 Published 445
Redfish Resource and Schema Guide DSP2046
6.55.4.2 DHGroupAllowList
The Diffie-Hellman (DH) groups that this key policy allows.
string Description
FFDHE2048 2048-bit Diffie-Hellman (DH) group.
FFDHE3072 3072-bit Diffie-Hellman (DH) group.
FFDHE4096 4096-bit Diffie-Hellman (DH) group.
FFDHE6144 6144-bit Diffie-Hellman (DH) group.
FFDHE8192 8192-bit Diffie-Hellman (DH) group.
6.55.4.3 KeyPolicyType
The type of key policy.
string Description
NVMeoF An NVMe-oF key policy.
6.55.4.4 SecureHashAllowList
The secure hash algorithms that this key policy allows.
string Description
SHA256 SHA-256.
SHA384 SHA-384.
SHA512 SHA-512.
6.55.4.5 SecurityProtocolAllowList
The security protocols that this key policy allows.
446 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Diffie-Hellman Hashed Message Authentication Code Challenge Handshake Authentication
DHHC
Protocol (DH-HMAC-CHAP).
OEM OEM.
TLS_PSK Transport Layer Security Pre-Shared Key (TLS PSK).
6.55.4.6 SecurityTransportAllowList
The security transports that this key policy allows.
string Description
TLSv2 Transport Layer Security (TLS) v2.
TLSv3 Transport Layer Security (TLS) v3.
6.55.5 Example response
{
"@odata.type": "#KeyPolicy.v1_0_0.KeyPolicy",
"Id": "0",
"Name": "Default NVMeoF Key Policy",
"IsDefault": true,
"KeyPolicyType": "NVMeoF",
"NVMeoF": {
"SecurityTransportAllowList": [
"TLSv2",
"TLSv3"
],
"CipherSuiteAllowList": [
"TLS_AES_128_GCM_SHA256",
"TLS_AES_256_GCM_SHA384"
],
"SecurityProtocolAllowList": [
"DHHC",
"TLS_PSK"
],
"DHGroupAllowList": [
"FFDHE2048",
"FFDHE3072",
"FFDHE4096",
"FFDHE6144",
"FFDHE8192"
Version 2023.1 Published 447
Redfish Resource and Schema Guide DSP2046
],
"SecureHashAllowList": [
"SHA384",
"SHA512"
]
},
"@odata.id": "/redfish/v1/KeyService/NVMeoFKeyPolicies/0"
}
6.56 KeyService 1.0.0
Version v1.0
Release 2021.2
6.56.1 Description
The KeyService schema describes a key service that represents the actions available to manage keys.
6.56.2 URIs
/redfish/v1/KeyService
6.56.3 Properties
Property Type Attributes Notes
NVMeoFKeyPolicies The NVMe-oF key policies maintained by this service. Contains a link to a
object
{ resource.
@odata.id string read-only Link to Collection of KeyPolicy. See the KeyPolicy schema for details.
The NVMe-oF keys maintained by this service. Contains a link to a
NVMeoFSecrets { object
resource.
@odata.id string read-only Link to Collection of Key. See the Key schema for details.
448 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.56.4 Example response
{
"@odata.type": "#KeyService.v1_0_0.KeyService",
"Id": "KeyService",
"Name": "Key Service",
"NVMeoFSecrets": {
"@odata.id": "/redfish/v1/KeyService/NVMeoFSecrets"
},
"NVMeoFKeyPolicies": {
"@odata.id": "/redfish/v1/KeyService/NVMeoFKeyPolicies"
},
"@odata.id": "/redfish/v1/KeyService"
}
6.57 LeakDetection 1.0.0
Version v1.0
Release 2023.1
6.57.1 Description
The LeakDetection schema contains definitions for reporting leaks in liquid cooling systems or other
equipment.
6.57.2 URIs
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/LeakDetection
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/LeakDetection
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/LeakDetection
6.57.3 Properties
Property Type Attributes Notes
LeakDetectorGroups [ { array The groups of leak detection equipment.
Version 2023.1 Published 449
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The leak detection states from all related leak detection devices in
array
Detectors [ { this group. This object is an excerpt of the LeakDetector resource
(excerpt)
located at the URI shown in DataSourceUri.
string read-only The link to the resource that provides the data for this leak
DataSourceUri
(URI) (null) detector.
string read-only The state of the leak detector. For the possible property values,
DetectorState
(enum) (null) see DetectorState in Property details.
string read-only The area or device to which this leak detector applies. For the
PhysicalContext
(enum) (null) possible property values, see PhysicalContext in Property details.
The usage or location within a device to which this leak detector
string read-only
PhysicalSubContext applies. For the possible property values, see PhysicalSubContext
(enum) (null)
in Property details.
}]
GroupName string read-only The name of this leak detector group.
object Humidity (percent). This object is an excerpt of the Sensor
HumidityPercent {
(excerpt) resource located at the URI shown in DataSourceUri.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
}]
The link to the collection of leak detectors within this subsystem.
LeakDetectors { object
Contains a link to a resource.
Link to Collection of LeakDetector. See the LeakDetector schema
@odata.id string read-only
for details.
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
450 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.57.4 Property details
6.57.4.1 DetectorState
The state of the leak detector.
string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.
6.57.4.2 PhysicalContext
The area or device to which this leak detector applies.
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
Version 2023.1 Published 451
Redfish Resource and Schema Guide DSP2046
string Description
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
GPU A graphics processor (GPU).
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
StorageBay Within a storage bay.
452 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
6.57.4.3 PhysicalSubContext
The usage or location within a device to which this leak detector applies.
string Description
Input The input.
Output The output.
6.57.5 Example response
{
"@odata.type": "#LeakDetection.v1_0_0.LeakDetection",
"Id": "LeakDetection",
"Name": "Leak Detection Systems",
"Status": {
"State": "Enabled",
"Health": "OK",
"Conditions": []
},
"LeakDetectorGroups": [
{
"GroupName": "Detectors under and around the CDU",
"HumidityPercent": {
"Reading": 45
},
"Detectors": [
{
"DataSourceUri": "/redfish/v1/ThermalEquipment/CDUs/1/LeakDetection/LeakDetectors/Moisture",
Version 2023.1 Published 453
Redfish Resource and Schema Guide DSP2046
"DeviceName": "Moisture-type Leak Detector",
"DetectorState": "OK"
},
{
"DeviceName": "Leak Detection Rope 1",
"DetectorState": "OK"
},
{
"DataSourceUri": "/redfish/v1/ThermalEquipment/CDUs/1/LeakDetection/LeakDetectors/Overflow",
"DeviceName": "Overflow Float Switch",
"DetectorState": "OK"
}
]
}
],
"LeakDetectors": {
"@odata.id": "/redfish/v1/ThermalEquipment/CDUs/1/LeakDetection/LeakDetectors"
},
"@odata.id": "/redfish/v1/ThermalEquipment/CDUs/1/LeakDetection"
}
6.58 LeakDetector 1.0.0
Version v1.0
Release 2023.1
6.58.1 Description
The LeakDetector schema describes a state-based or digital value leak detector and its properties.
6.58.2 URIs
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/LeakDetection/LeakDetectors/{LeakDetectorId}
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/LeakDetection/LeakDetectors/
{LeakDetectorId}
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/LeakDetection/LeakDetectors/
{LeakDetectorId}
454 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.58.3 Properties
Property Type Attributes Notes
string read-only The state of the leak detector. For the possible property values, see
DetectorState
(enum) (null) DetectorState in Property details.
string read-only The type of leak detection sensor. For the possible property values, see
LeakDetectorType
(enum) (null) LeakDetectorType in Property details.
The location information for this leak detector. For property details, see
Location {} object
Location.
read-only
Manufacturer string The manufacturer of this leak detector.
(null)
read-only
Model string The model number of the leak detector.
(null)
read-only
PartNumber string The part number of the leak detector.
(null)
string read-only The area or device to which this leak detector applies. For the possible
PhysicalContext
(enum) (null) property values, see PhysicalContext in Property details.
The usage or location within a device to which this leak detector applies.
string read-only
PhysicalSubContext For the possible property values, see PhysicalSubContext in Property
(enum) (null)
details.
read-only
SensingFrequency number The time interval between readings of the physical leak detector.
(null)
read-only
SerialNumber string The serial number of the leak detector.
(null)
read-only
SKU string The SKU of the leak detector.
(null)
read-only
SparePartNumber string The spare part number of the leak detector.
(null)
The status and health of the resource and its subordinate or dependent
Status {} object
resources. For property details, see Status.
6.58.4 Property details
6.58.4.1 DetectorState
The state of the leak detector.
Version 2023.1 Published 455
Redfish Resource and Schema Guide DSP2046
string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.
6.58.4.2 LeakDetectorType
The type of leak detection sensor.
string Description
FloatSwitch A float switch.
Moisture A moisture sensor.
6.58.4.3 PhysicalContext
The area or device to which this leak detector applies.
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
456 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
GPU A graphics processor (GPU).
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Version 2023.1 Published 457
Redfish Resource and Schema Guide DSP2046
string Description
Room The room.
StorageBay Within a storage bay.
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
6.58.4.4 PhysicalSubContext
The usage or location within a device to which this leak detector applies.
string Description
Input The input.
Output The output.
6.58.5 Example response
{
"@odata.type": "#LeakDetector.v1_0_0.LeakDetector",
"Id": "Moisture",
"Name": "Moisture-type Leak Detector",
"LeakDetectorType": "Moisture",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"DetectorState": "OK",
"PartNumber": "3493-A44",
"SerialNumber": "916239",
"Manufacturer": "Contoso Water Detection Systems",
"Model": "Depends 3000",
458 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"Location": {
"PartLocation": {
"Reference": "Bottom",
"ServiceLabel": "Leak Detector"
}
},
"PhysicalContext": "Chassis",
"@odata.id": "/redfish/v1/ThermalEquipment/CDUs/1/LeakDetection/LeakDetectors/Moisture"
}
6.59 License 1.1.1
Version v1.1 v1.0
Release 2022.3 2021.3
6.59.1 Description
The License schema describes a license for a feature.
6.59.2 URIs
/redfish/v1/LicenseService/Licenses/{LicenseId}
6.59.3 Properties
Property Type Attributes Notes
string read-only The authorization scope of the license. For the possible property
AuthorizationScope
(enum) (null) values, see AuthorizationScope in Property details.
Contact { object The contact of the license.
read-only
ContactName string Name of this contact.
(null)
read-only
EmailAddress string Email address for this contact.
(null)
read-only
PhoneNumber string Phone number for this contact.
(null)
Version 2023.1 Published 459
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
string
DownloadURI read-only The URI at which to download the license file.
(URI)
read-only
EntitlementId string The entitlement identifier for this license.
(null)
string read-only
ExpirationDate The date and time when the license expires.
(date-time) (null)
read-only
GracePeriodDays integer The grace days of this license.
(null)
string read-only
InstallDate The date and time when the license was installed.
(date-time) (null)
string read-only
LicenseInfoURI The URI at which more information about this license can be obtained.
(URI) (null)
string read-only This indicates the origin of the license. For the possible property
LicenseOrigin
(enum) (null) values, see LicenseOrigin in Property details.
read-only
required
LicenseString string The Base64-encoded string of the license.
on create
(null)
string read-only The type of the license. For the possible property values, see
LicenseType
(enum) (null) LicenseType in Property details.
Links { object The links to other resources that are related to this resource.
AuthorizedDevices
array An array of links to the devices authorized by the license.
[{
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
Oem {} object See the Oem object definition in the Common properties section.
TargetServices
array An array of links to the managers where the license is installed.
(v1.1+) [ {
Link to a Manager resource. See the Links section and the Manager
@odata.id string read-only
schema for details.
}]
460 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only
Manufacturer string The manufacturer or producer of this license.
(null)
read-only
MaxAuthorizedDevices integer The maximum number of devices authorized by the license.
(null)
read-only
PartNumber string The part number for this license.
(null)
string read-only
RemainingDuration The remaining usage duration before the license expires.
(duration) (null)
read-only
RemainingUseCount integer The remaining usage count before the license expires.
(null)
read-only
Removable boolean An indication of whether the license is removable.
(null)
read-only
SerialNumber string The serial number for this license.
(null)
read-only
SKU string The SKU for this license.
(null)
Status {} object The status of the license. For property details, see Status.
6.59.4 Property details
6.59.4.1 AuthorizationScope
The authorization scope of the license.
string Description
The license authorizes functionality to a number of devices, but not restricted to specific
Capacity
device instances.
Device The license authorizes functionality for specific device instances.
Service The license authorizes functionality to a service.
6.59.4.2 LicenseOrigin
This indicates the origin of the license.
Version 2023.1 Published 461
Redfish Resource and Schema Guide DSP2046
string Description
BuiltIn A license was provided with the product.
Installed A license installed by user.
6.59.4.3 LicenseType
The type of the license.
string Description
Production A license for use in production environments.
Prototype A prototype version of license.
Trial A trial license.
6.59.5 Example response
{
"@odata.type": "#License.v1_1_1.License",
"Id": "KVM",
"Name": "Blade KVM-IP License 3-Pack",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"EntitlementId": "LIC20180820LDLM5C",
"LicenseType": "Production",
"Removable": false,
"LicenseOrigin": "BuiltIn",
"AuthorizationScope": "Device",
"GracePeriodDays": 60,
"Manufacturer": "Contoso",
"InstallDate": "2020-08-20T20:13:44Z",
"ExpirationDate": "2022-08-20T20:13:43Z",
"Links": {
"AuthorizedDevices": [
{
"@odata.id": "/redfish/v1/Managers/Blade1"
},
{
"@odata.id": "/redfish/v1/Managers/Blade4"
},
{
462 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"@odata.id": "/redfish/v1/Managers/Blade5"
}
]
},
"Contact": {
"ContactName": "Bob Johnson",
"EmailAddress": "[email protected]"
},
"DownloadURI": "/dumpster/license111",
"LicenseInfoURI": "http://shop.contoso.com/licenses/blade-kvm",
"@odata.id": "/redfish/v1/LicenseService/Licenses/KVM"
}
6.60 LicenseService 1.1.0
Version v1.1 v1.0
Release 2022.3 2021.3
6.60.1 Description
The LicenseService schema describes the license service and the properties for the service itself with
a link to the collection of licenses. The license service also provides methods for installing licenses in a
Redfish service.
6.60.2 URIs
/redfish/v1/LicenseService
6.60.3 Properties
Property Type Attributes Notes
The number of days prior to a license expiration that a warning
read-write
LicenseExpirationWarningDays integer message is sent. A value of zero indicates no warning message
(null)
is sent.
The link to the collection of licenses. Contains a link to a
Licenses { object
(null) resource.
Version 2023.1 Published 463
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to Collection of License. See the License schema for
@odata.id string read-only
details.
read-write
ServiceEnabled boolean An indication of whether this service is enabled.
(null)
6.60.4 Actions
6.60.4.1 Install
Description
This action installs one or more licenses from a remote file.
Action URI
{Base URI of target resource}/Actions/LicenseService.Install
Action parameters
Parameter Name Type Attributes Notes
AuthorizedDevices
array optional An array of links to the devices to be authorized by the license.
(v1.1+) [ {
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
LicenseFileURI string required The URI of the license file to install.
The password to access the URI specified by the LicenseFileURI
Password string optional
parameter.
TargetServices
array optional An array of links to the managers where the license will be installed.
(v1.1+) [ {
Link to a Manager resource. See the Links section and the Manager
@odata.id string read-only
schema for details.
}]
464 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Parameter Name Type Attributes Notes
The network protocol that the license service uses to retrieve the
license file located at the URI provided in LicenseFileURI. This
string
TransferProtocol optional parameter is ignored if the URI provided in LicenseFileURI contains a
(enum)
scheme. For the possible property values, see TransferProtocol in
Property details.
The user name to access the URI specified by the LicenseFileURI
Username string optional
parameter.
Request Example
{
"LicenseFileURI": "ftp://licensing.contoso.org/bmc_kvmip_8RS247MKRQ8027.bin",
"Username": "operations",
"Password": "Pa55w0rd"
}
6.60.5 Property details
6.60.5.1 TransferProtocol
The network protocol that the license service uses to retrieve the license file located at the URI
provided in LicenseFileURI. This parameter is ignored if the URI provided in LicenseFileURI contains a
scheme.
string Description
CIFS Common Internet File System (CIFS).
FTP File Transfer Protocol (FTP).
HTTP Hypertext Transfer Protocol (HTTP).
HTTPS Hypertext Transfer Protocol Secure (HTTPS).
NFS Network File System (NFS).
OEM A manufacturer-defined protocol.
SCP Secure Copy Protocol (SCP).
SFTP Secure File Transfer Protocol (SFTP).
TFTP Trivial File Transfer Protocol (TFTP).
Version 2023.1 Published 465
Redfish Resource and Schema Guide DSP2046
6.60.6 Example response
{
"@odata.type": "#LicenseService.v1_1_0.LicenseService",
"Name": "License Service",
"ServiceEnabled": true,
"LicenseExpirationWarningDays": 14,
"Actions": {
"#LicenseService.Install": {
"target": "/redfish/v1/LicenseService/Actions/LicenseService.Install",
"@Redfish.ActionInfo": "/redfish/v1/LicenseService/InstallActionInfo"
}
},
"Licenses": {
"@odata.id": "/redfish/v1/LicenseService/Licenses"
},
"@odata.id": "/redfish/v1/LicenseService"
}
6.61 LogEntry 1.15.0
Version v1.15 v1.14 v1.13 v1.12 v1.11 v1.10 v1.9 v1.8 v1.7 v1.6 v1.5 ...
Release 2023.1 2022.3 2022.2 2022.1 2021.4 2021.3 2021.1 2020.4 2020.3 2020.1 2019.3 ...
6.61.1 Description
The LogEntry schema defines the record format for a log. It is designed for Redfish event logs, OEM-
specific log formats, and the IPMI System Event Log (SEL). The EntryType field indicates the type of log
and the resource includes several additional properties dependent on the EntryType.
6.61.2 URIs
/redfish/v1/Chassis/{ChassisId}/LogServices/{LogServiceId}/Entries/{LogEntryId}
/redfish/v1/Chassis/{ChassisId}/PCIeDevices/{PCIeDeviceId}/CXLLogicalDevices/
{CXLLogicalDeviceId}/DeviceLog/Entries/{LogEntryId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
LogServices/{LogServiceId}/Entries/{LogEntryId}
/redfish/v1/JobService/Log/Entries/{LogEntryId}
/redfish/v1/Managers/{ManagerId}/LogServices/{LogServiceId}/Entries/{LogEntryId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/
466 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
{LogServiceId}/Entries/{LogEntryId}
/redfish/v1/Systems/{ComputerSystemId}/LogServices/{LogServiceId}/Entries/{LogEntryId}
/redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}/DeviceLog/Entries/{LogEntryId}
/redfish/v1/TelemetryService/LogService/Entries/{LogEntryId}
6.61.3 Properties
Property Type Attributes Notes
AdditionalDataSizeBytes integer read-only
The size of the additional data for this log entry.
(v1.7+) (bytes) (null)
string read-only The URI at which to access the additional data for this log entry,
AdditionalDataURI (v1.7+)
(URI) (null) such as diagnostic data, image captures, or other files.
CPER (v1.15+) { object Details for a CPER section or record associated with this log entry.
NotificationType string read-only
The CPER Notification Type for a CPER record.
(v1.15+) (uuid) (null)
Oem (v1.15+) {} object See the Oem object definition in the Common properties section.
string read-only
SectionType (v1.15+) The CPER Section Type.
(uuid) (null)
string
Created (date- read-only The date and time when the log entry was created.
time)
string The specific CXL entry type. For the possible property values, see
CXLEntryType (v1.14+) read-only
(enum) CXLEntryType in Property details.
read-only A Base64-encoded set of diagnostic data associated with this log
DiagnosticData (v1.15+) string
(null) entry.
The type of data available in the DiagnosticData property or
string read-only retrieved from the URI specified by the AdditionalDataURI
DiagnosticDataType (v1.7+)
(enum) (null) property. For the possible property values, see DiagnosticDataType
in Property details.
string read-only The entry code for the log entry if the entry type is SEL . For the
EntryCode
(enum) (null) possible property values, see EntryCode in Property details.
string read-only The type of log entry. For the possible property values, see
EntryType
(enum) required EntryType in Property details.
read-only
EventGroupId (v1.4+) integer An identifier that correlates events with the same cause.
(null)
Version 2023.1 Published 467
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
EventId (v1.1+) string read-only The unique instance identifier for an event.
string
EventTimestamp (v1.1+) (date- read-only The date and time when the event occurred.
time)
The type of event recorded in this log. For the possible property
values, see EventType in Property details. Deprecated in v1.4 and
EventType (v1.1+, string later. This property has been deprecated. Starting with Redfish
read-only
deprecated v1.4 (enum) Specification v1.6 (Event v1.3), subscriptions are based on the
RegistryPrefix and ResourceType properties and not on the
EventType property.
string
FirstOverflowTimestamp
(date- read-only The timestamp of the first overflow captured after this log entry.
(v1.14+)
time)
read-only An identifier of the device that has generated the IPMI SEL Event
GeneratorId (v1.5+) string
(null) Record.
string
LastOverflowTimestamp
(date- read-only The timestamp of the last overflow captured after this log entry.
(v1.14+)
time)
Links { object The links to other resources that are related to this resource.
Oem {} object See the Oem object definition in the Common properties section.
OriginOfCondition { object The link to the resource that caused the log entry.
string
@odata.id read-only The unique identifier for a resource.
(URI)
RelatedItem (v1.12+) [ { array An array of links to resources associated with this log entry.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
RelatedLogEntries An array of links to other log entries that are related to this log
array
(v1.12+) [ { entry.
@odata.id string read-only Link to another LogEntry resource.
}]
468 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The message of the log entry. This property decodes from the
entry type. If the entry type is Event , this property contains a
message. If the entry type is SEL , this property contains an SEL-
read-only
Message string specific message. If the entry type is CXL , this property contains a
(null)
CXL event record. Otherwise, this property contains an OEM-
specific log entry. In most cases, this property contains the actual
log entry.
array
MessageArgs [ ] read-only The arguments for the message.
(string)
The MessageId, event data, or OEM-specific information. This
property decodes from the entry type. If the entry type is Event ,
MessageId string read-only this property contains a Redfish Specification-defined MessageId.
If the entry type is SEL , this property contains the Event Data.
Otherwise, this property contains OEM-specific information.
string
Modified (v1.6+) (date- read-only The date and time when the log entry was last modified.
time)
The OEM-defined type of data available in the DiagnosticData
OEMDiagnosticDataType read-only
string property or retrieved from the URI specified by the
(v1.7+) (null)
AdditionalDataURI property.
read-only
OemLogEntryCode (v1.3+) string The OEM-specific entry code, if the LogEntryCode type is OEM .
(null)
The OEM-specific format of the entry. If the entry type is Oem , this
read-only
OemRecordFormat string property contains more information about the record format from
(null)
the OEM.
read-only
OemSensorType (v1.3+) string The OEM-specific sensor type if the sensor type is OEM .
(null)
Originator (v1.11+) string read-only The source of the log entry.
string The type of originator data. For the possible property values, see
OriginatorType (v1.11+) read-only
(enum) OriginatorType in Property details.
OverflowErrorCount
integer read-only The count of overflow errors that occurred after this log entry.
(v1.14+)
Indicates whether the log entry is persistent across a cold reset of
Persistency (v1.14+) boolean read-only
the device.
Used to provide suggestions on how to resolve the situation that
Resolution (v1.9+) string read-only
caused the log entry.
Version 2023.1 Published 469
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-write Indicates if the cause of the log entry has been resolved or
Resolved (v1.8+) boolean
(null) repaired.
read-only
SensorNumber integer The IPMI-defined sensor number.
(null)
The sensor type to which the log entry pertains if the entry type is
string read-only
SensorType SEL . For the possible property values, see SensorType in Property
(enum) (null)
details.
ServiceProviderNotified read-only
boolean Indicates if the log entry has been sent to the service provider.
(v1.9+) (null)
string read-only The severity of the log entry. For the possible property values, see
Severity
(enum) (null) Severity in Property details.
SpecificEventExistsInGroup Indicates this log entry is equivalent to a more specific log entry
boolean read-only
(v1.13+) within the same EventGroupId.
6.61.4 Property details
6.61.4.1 CXLEntryType
The specific CXL entry type.
string Description
DynamicCapacity A CXL Dynamic Capacity log entry.
Failure A CXL failure log entry.
Fatal A CXL fatal log entry.
Informational A CXL informational log entry.
Warning A CXL warning log entry.
6.61.4.2 DiagnosticDataType
The type of data available in the DiagnosticData property or retrieved from the URI specified by the
AdditionalDataURI property.
470 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
CPER (v1.10+) UEFI Common Platform Error Record.
CPERSection (v1.10+) A Section of a UEFI Common Platform Error Record.
Manager Manager diagnostic data.
OEM OEM diagnostic data.
OS Operating system (OS) diagnostic data.
PreOS Pre-OS diagnostic data.
6.61.4.3 EntryCode
The entry code for the log entry if the entry type is SEL .
string Description
Assert The condition has been asserted.
D0 Power State The ACPI-defined D0 power state.
D1 Power State The ACPI-defined D1 power state.
D2 Power State The ACPI-defined D2 power state.
D3 Power State The ACPI-defined D3 power state.
Deassert The condition has been deasserted.
Device Disabled A device has been disabled.
Device Enabled A device has been enabled.
Device Inserted / Device
A device has been inserted or is present.
Present
Device Removed / Device
A device has been removed or is absent.
Absent
Fully Redundant Indicates that full redundancy has been regained.
Informational An informational event.
Install Error An install error has been detected.
Limit Exceeded A limit has been exceeded.
Limit Not Exceeded A limit has not been exceeded.
Version 2023.1 Published 471
Redfish Resource and Schema Guide DSP2046
string Description
Lower Critical - going high The reading crossed the Lower Critical threshold while going high.
Lower Critical - going low The reading crossed the Lower Critical threshold while going low.
Lower Non-critical - going
The reading crossed the Lower Non-critical threshold while going high.
high
Lower Non-critical - going
The reading crossed the Lower Non-critical threshold while going low.
low
Lower Non-recoverable -
The reading crossed the Lower Non-recoverable threshold while going high.
going high
Lower Non-recoverable -
The reading crossed the Lower Non-recoverable threshold while going low.
going low
Monitor A monitor event.
Non-redundant:Insufficient
Unit is non-redundant and has insufficient resources to maintain normal operation.
Resources
Non-redundant:Sufficient
Resources from Insufficient Unit has regained minimum resources needed for normal operation.
Resources
Non-redundant:Sufficient Redundancy has been lost but unit is functioning with minimum resources needed for normal
Resources from Redundant operation.
OEM (v1.3+) An OEM-defined event.
Performance Lags Performance does not meet expectations.
Performance Met Performance meets expectations.
Predictive Failure asserted A Predictive Failure has been detected.
Predictive Failure
A Predictive Failure is no longer present.
deasserted
Redundancy Degraded Redundancy still exists, but at less than full level.
Redundancy Degraded
Unit has lost some redundant resource(s) but is still in a redundant state.
from Fully Redundant
Redundancy Degraded
Unit has regained some resource(s) and is redundant but not fully redundant.
from Non-redundant
Redundancy Lost Entered any non-redundant state, including Non-redundant: Insufficient Resources.
State Asserted The state has been asserted.
472 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
State Deasserted The state has been deasserted.
Transition to Active The state transitioned to active.
Transition to Busy The state transitioned to busy.
Transition to Critical from
A state has changed to Critical from less severe.
less severe
Transition to Critical from
A state has changed to Critical from Non-recoverable.
Non-recoverable
Transition to Degraded A state has transitioned to Degraded.
Transition to Idle The state transitioned to idle.
Transition to In Test A state has transitioned to In Test.
Transition to Non-Critical
A state has changed to Non-Critical from more severe.
from more severe
Transition to Non-Critical
A state has changed to Non-Critical from OK.
from OK
Transition to Non-
A state has changed to Non-recoverable.
recoverable
Transition to Non-
recoverable from less A state has changed to Non-recoverable from less severe.
severe
Transition to Off Duty A state has transitioned to Off Duty.
Transition to Off Line A state has transitioned to Off Line.
Transition to OK A state has changed to OK.
Transition to On Line A state has transitioned to On Line.
Transition to Power Off A state has transitioned to Power Off.
Transition to Power Save A state has transitioned to Power Save.
Transition to Running A state has transitioned to Running.
Upper Critical - going high The reading crossed the Upper Critical threshold while going high.
Upper Critical - going low The reading crossed the Upper Critical threshold while going low.
Upper Non-critical - going
The reading crossed the Upper Non-critical threshold while going high.
high
Version 2023.1 Published 473
Redfish Resource and Schema Guide DSP2046
string Description
Upper Non-critical - going
The reading crossed the Upper Non-critical threshold while going low.
low
Upper Non-recoverable -
The reading crossed the Upper Non-recoverable threshold while going high.
going high
Upper Non-recoverable -
The reading crossed the Upper Non-recoverable threshold while going low.
going low
6.61.4.4 EntryType
The type of log entry.
string Description
CXL (v1.14+) A CXL log entry.
Event A Redfish-defined message.
Oem An entry in an OEM-defined format.
SEL A legacy IPMI System Event Log (SEL) entry.
6.61.4.5 EventType
The type of event recorded in this log.
string Description
Alert A condition requires attention.
MetricReport The telemetry service is sending a metric report.
Because EventType is deprecated as of Redfish Specification v1.6, the event is based on a
Other
registry or resource but not an EventType.
ResourceAdded A resource has been added.
ResourceRemoved A resource has been removed.
ResourceUpdated A resource has been updated.
StatusChange The status of a resource has changed.
474 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.61.4.6 OriginatorType
The type of originator data.
string Description
Client A client of the service created this log entry.
Internal A process running on the service created this log entry.
A process not running on the service but running on a supporting service, such as RDE
SupportingService
implementations, UEFI, or host processes, created this log entry.
6.61.4.7 SensorType
The sensor type to which the log entry pertains if the entry type is SEL .
string Description
Add-in Card A sensor for an add-in card.
BaseOSBoot/
A sensor for a base OS boot or installation status event.
InstallationStatus
Battery A sensor for a battery.
Boot Error A sensor for a boot error event.
Button/Switch A sensor for a button or switch.
Cable/Interconnect A sensor for a cable or interconnect device type.
Chassis A sensor for a chassis.
ChipSet A sensor for a chipset.
CoolingDevice A sensor for a cooling device.
Critical Interrupt A sensor for a critical interrupt event.
Current A current sensor.
Drive Slot/Bay A sensor for a drive slot or bay.
Entity Presence A sensor for an entity presence event.
Event Logging Disabled A sensor for the event log.
Version 2023.1 Published 475
Redfish Resource and Schema Guide DSP2046
string Description
Fan A fan sensor.
FRUState A sensor for a FRU state event.
LAN A sensor for a LAN device.
Management Subsystem
A sensor for a management subsystem health event.
Health
Memory A sensor for a memory device.
Microcontroller/
A sensor for a microcontroller or coprocessor.
Coprocessor
Module/Board A sensor for a module or board.
Monitor ASIC/IC A sensor for a monitor ASIC or IC.
OEM (v1.3+) An OEM-defined sensor.
OS Stop/Shutdown A sensor for an OS stop or shutdown event
Other FRU A sensor for another type of FRU.
Other Units-based Sensor A sensor for a miscellaneous analog sensor.
Physical Chassis Security A physical security sensor.
Platform Alert A sensor for a platform alert event.
Platform Security Violation
A platform security sensor.
Attempt
POST Memory Resize A sensor for a POST memory resize event.
Power Supply / Converter A sensor for a power supply or DC-to-DC converter.
PowerUnit A sensor for a power unit.
Processor A sensor for a processor.
Session Audit A sensor for a session audit event.
Slot/Connector A sensor for a slot or connector.
System ACPI PowerState A sensor for an ACPI power state event.
System Event A sensor for a system event.
System Firmware Progress A sensor for a system firmware progress event.
SystemBoot/Restart A sensor for a system boot or restart event.
476 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Temperature A temperature sensor.
Terminator A sensor for a terminator.
Version Change A sensor for a version change event.
Voltage A voltage sensor.
Watchdog A sensor for a watchdog event.
6.61.4.8 Severity
The severity of the log entry.
string Description
Critical A critical condition that requires immediate attention.
OK Informational or operating normally.
Warning A condition that requires attention.
6.61.5 Example response
{
"@odata.type": "#LogEntry.v1_15_0.LogEntry",
"Id": "1",
"Name": "Log Entry 1",
"EntryType": "Event",
"Severity": "Critical",
"Created": "2012-03-07T14:44:00Z",
"Resolved": false,
"Message": "Temperature threshold exceeded",
"MessageId": "Contoso.1.0.TempAssert",
"MessageArgs": [
"42"
],
"Links": {
"OriginOfCondition": {
"@odata.id": "/redfish/v1/Chassis/1U/Thermal"
}
},
"@odata.id": "/redfish/v1/Systems/437XR1138R2/LogServices/Log1/Entries/1"
}
Version 2023.1 Published 477
Redfish Resource and Schema Guide DSP2046
6.62 LogService 1.4.0
Version v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.3 2021.2 2020.3 2017.3 1.0
6.62.1 Description
The LogService schema contains properties for monitoring and configuring a log service. When the Id
property contains DeviceLog , the log contains device-resident log entries that follow the physical
device when moved from system-to-system, and not a replication or subset of a system event log.
6.62.2 URIs
/redfish/v1/Chassis/{ChassisId}/LogServices/{LogServiceId}
/redfish/v1/Chassis/{ChassisId}/PCIeDevices/{PCIeDeviceId}/CXLLogicalDevices/
{CXLLogicalDeviceId}/DeviceLog
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
LogServices/{LogServiceId}
/redfish/v1/JobService/Log
/redfish/v1/Managers/{ManagerId}/LogServices/{LogServiceId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/
{LogServiceId}
/redfish/v1/Systems/{ComputerSystemId}/LogServices/{LogServiceId}
/redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}/DeviceLog
/redfish/v1/TelemetryService/LogService
6.62.3 Properties
Property Type Attributes Notes
AutoDSTEnabled An indication of whether the log service is configured for automatic
boolean read-write
(v1.3+) Daylight Saving Time (DST) adjustment.
string read-write
DateTime The current date and time with UTC offset of the log service.
(date-time) (null)
read-write The time offset from UTC that the DateTime property is in +HH:MM
DateTimeLocalOffset string
(null) format.
Entries { object The link to the log entry collection. Contains a link to a resource.
478 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
@odata.id string read-only Link to Collection of LogEntry. See the LogEntry schema for details.
string read-only The format of the log entries. For the possible property values, see
LogEntryType (v1.1+)
(enum) (null) LogEntryType in Property details.
array
LogPurposes (v1.4+) [ read-only The purposes of the log. For the possible property values, see
(string
] (null) LogPurposes in Property details.
(enum))
MaxNumberOfRecords integer read-only The maximum number of log entries that this service can have.
OEMLogPurpose read-only
string The OEM-specified purpose of the log if LogPurposes contains OEM .
(v1.4+) (null)
Overflow (v1.4+) boolean read-only Indicates whether the log service has overflowed.
The overwrite policy for this service that takes place when the log is
string
OverWritePolicy read-only full. For the possible property values, see OverWritePolicy in Property
(enum)
details.
Persistency (v1.4+) boolean read-only Indicates whether the log service is persistent across a cold reset.
read-write
ServiceEnabled boolean An indication of whether this service is enabled.
(null)
The status and health of the resource and its subordinate or dependent
Status {} object
resources. For property details, see Status.
SyslogFilters (v1.2+) [
array A list of syslog message filters to be logged locally.
{
array
LogFacilities read-write The types of programs that can log messages. For the possible
(string
(v1.2+) [ ] (null) property values, see LogFacilities in Property details.
(enum))
LowestSeverity string read-write The lowest severity level message that will be logged. For the possible
(v1.2+) (enum) (null) property values, see LowestSeverity in Property details.
}]
6.62.4 Actions
6.62.4.1 ClearLog
Description
The action to clear the log for this log service.
Version 2023.1 Published 479
Redfish Resource and Schema Guide DSP2046
Action URI
{Base URI of target resource}/Actions/LogService.ClearLog
Action parameters
Parameter Name Type Attributes Notes
The ETag of the log entry collection within this log service. If the provided
LogEntriesETag
string optional ETag does not match the current ETag of the log entry collection, the
(v1.3+)
request is rejected.
Request Example
{
"LogEntriesEtag": "W/\"2A90423A\""
}
6.62.4.2 CollectDiagnosticData (v1.2+)
Description
The action to collect the diagnostic data for the given type. When the diagnostic data is collected, a
new log entry will be created and the additional data referenced by the new log entry will contain the
diagnostic data.
Action URI
{Base URI of target resource}/Actions/LogService.CollectDiagnosticData
Action parameters
Parameter Name Type Attributes Notes
string The type of diagnostic data to collect. For the possible property
DiagnosticDataType required
(enum) values, see DiagnosticDataType in Property details.
OEMDiagnosticDataType string optional The OEM-defined type of diagnostic data to collect.
Request Example
480 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
{
"DiagnosticDataType": "Manager"
}
6.62.5 Property details
6.62.5.1 DiagnosticDataType
The type of diagnostic data to collect.
string Description
Manager Manager diagnostic data.
OEM OEM diagnostic data.
OS Operating system (OS) diagnostic data.
PreOS Pre-OS diagnostic data.
6.62.5.2 LogEntryType
The format of the log entries.
string Description
Event The log contains Redfish-defined messages.
The log contains multiple log entry types and, therefore, the log service cannot guarantee a
Multiple
single entry type.
OEM The log contains entries in an OEM-defined format.
SEL The log contains legacy IPMI System Event Log (SEL) entries.
6.62.5.3 LogFacilities
The types of programs that can log messages.
Version 2023.1 Published 481
Redfish Resource and Schema Guide DSP2046
string Description
Auth Security/authentication messages.
Authpriv Security/authentication messages.
Console Log alert.
Cron Clock daemon.
Daemon System daemons.
FTP FTP daemon.
Kern Kernel messages.
Local0 Locally used facility 0.
Local1 Locally used facility 1.
Local2 Locally used facility 2.
Local3 Locally used facility 3.
Local4 Locally used facility 4.
Local5 Locally used facility 5.
Local6 Locally used facility 6.
Local7 Locally used facility 7.
LPR Line printer subsystem.
Mail Mail system.
News Network news subsystem.
NTP NTP subsystem.
Security Log audit.
SolarisCron Scheduling daemon.
Syslog Messages generated internally by syslogd.
User User-level messages.
UUCP UUCP subsystem.
6.62.5.4 LogPurposes
The purposes of the log.
482 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
The log provides information for diagnosing hardware or software issues, such as error
Diagnostic
conditions, sensor threshold trips, or exception cases.
The log exposes log entries provided by external entities, such as external users, system
ExternalEntity
firmware, operating systems, or management applications.
OEM The log is used for an OEM-defined purpose.
The log provides information about management operations that have a significant impact on
Operations
the system, such as firmware updates, system resets, and storage volume creation.
The log provides security-related information such as authentication, authorization, and data
Security
access logging required for security audits.
Telemetry The log provides telemetry history, typically collected on a regular basis.
6.62.5.5 LowestSeverity
The lowest severity level message that will be logged.
string Description
Alert A condition that should be corrected immediately, such as a corrupted system database.
All A message of any severity.
Critical Hard device errors.
Debug Messages that contain information normally of use only when debugging a program.
Emergency A panic condition.
Error An Error.
Informational Informational only.
Notice Conditions that are not error conditions, but that may require special handling.
Warning A Warning.
6.62.5.6 OverWritePolicy
The overwrite policy for this service that takes place when the log is full.
Version 2023.1 Published 483
Redfish Resource and Schema Guide DSP2046
string Description
NeverOverWrites When full, new entries to the log are discarded.
Unknown The overwrite policy is not known or is undefined.
WrapsWhenFull When full, new entries to the log overwrite earlier entries.
6.62.6 Example response
{
"@odata.type": "#LogService.v1_4_0.LogService",
"Id": "Log1",
"Name": "System Log Service",
"Description": "This log contains entries related to the operation of the host Computer System.",
"MaxNumberOfRecords": 1000,
"OverWritePolicy": "WrapsWhenFull",
"DateTime": "2015-03-13T04:14:33+06:00",
"DateTimeLocalOffset": "+06:00",
"ServiceEnabled": true,
"LogEntryType": "Event",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Actions": {
"#LogService.ClearLog": {
"target": "/redfish/v1/Managers/1/LogServices/Log1/Actions/LogService.ClearLog"
}
},
"Entries": {
"@odata.id": "/redfish/v1/Managers/1/LogServices/Log1/Entries"
},
"@odata.id": "/redfish/v1/Managers/1/LogServices/Log1"
}
6.63 Manager 1.18.0
Version v1.18 v1.17 v1.16 v1.15 v1.14 v1.13 v1.12 v1.11 v1.10 v1.9 v1.8 ...
Release 2023.1 2022.3 2022.2 2022.1 2021.4 2021.2 2021.1 2020.4 2020.3 2020.2 2020.1 ...
484 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.63.1 Description
In Redfish, a manager is a systems management entity that can implement or provide access to a
Redfish service. Examples of managers are BMCs, enclosure managers, management controllers, and
other subsystems that are assigned manageability functions. An implementation can have multiple
managers, which might be directly accessible through a Redfish-defined interface.
6.63.2 URIs
/redfish/v1/Managers/{ManagerId}
6.63.3 Properties
Property Type Attributes Notes
AdditionalFirmwareVersions
object The additional firmware versions of the manager.
(v1.15+) {
read-only The bootloader version contained in this software, such as U-Boot
Bootloader (v1.7+) string
(null) or UEFI.
read-only
Kernel (v1.7+) string The kernel version contained in this software.
(null)
read-only The microcode version contained in this software, such as
Microcode (v1.7+) string
(null) processor microcode.
Oem (v1.7+) {} object See the Oem object definition in the Common properties section.
read-only
OSDistribution (v1.8+) string The operating system name of this software.
(null)
An indication of whether the manager is configured for automatic
AutoDSTEnabled (v1.4+) boolean read-write
Daylight Saving Time (DST) adjustment.
The link to a collection of certificates for device identity and
Certificates (v1.13+) { object
attestation. Contains a link to a resource.
Link to Collection of Certificate. See the Certificate schema for
@odata.id string read-only
details.
CommandShell { object The command shell service that this manager provides.
Version 2023.1 Published 485
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
array This property enumerates the command shell connection types
ConnectTypesSupported
(string read-only that the implementation allows. For the possible property values,
[]
(enum)) see ConnectTypesSupported in Property details.
The maximum number of service sessions, regardless of protocol,
MaxConcurrentSessions integer read-only
that this manager can support.
ServiceEnabled boolean read-write An indication of whether the service is enabled for this manager.
string
read-write
DateTime (date- The current date and time with UTC offset of the manager.
(null)
time)
read-write The time offset from UTC that the DateTime property is in +HH:MM
DateTimeLocalOffset string
(null) format.
DedicatedNetworkPorts The dedicated network ports of the manager. Contains a link to a
object
(v1.16+) { resource.
@odata.id string read-only Link to Collection of Port. See the Port schema for details.
The link to a collection of NICs that this manager uses for
EthernetInterfaces { object
network communication. Contains a link to a resource.
Link to Collection of EthernetInterface. See the EthernetInterface
@odata.id string read-only
schema for details.
read-only
FirmwareVersion string The firmware version of this manager.
(null)
The information about the graphical console service of this
GraphicalConsole { object
manager.
array This property enumerates the graphical console connection types
ConnectTypesSupported
(string read-only that the implementation allows. For the possible property values,
[]
(enum)) see ConnectTypesSupported in Property details.
The maximum number of service sessions, regardless of protocol,
MaxConcurrentSessions integer read-only
that this manager can support.
ServiceEnabled boolean read-write An indication of whether the service is enabled for this manager.
486 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The link to a collection of host interfaces that this manager uses
for local host communication. Clients can find host interface
HostInterfaces (v1.3+) { object
configuration options and settings in this navigation property.
Contains a link to a resource.
Link to Collection of HostInterface. See the HostInterface schema
@odata.id string read-only
for details.
string
LastResetTime (v1.9+) (date- read-only The date and time when the manager was last reset or rebooted.
time)
Links { object The links to other resources that are related to this resource.
The link to the software inventory resource that represents the
ActiveSoftwareImage
object active firmware image for this manager. See the
(v1.6+) {
SoftwareInventory schema for details on this property.
Link to a SoftwareInventory resource. See the Links section and
@odata.id string read-write
the SoftwareInventory schema for details.
The array of links to the managers responsible for managing this
ManagedBy (v1.9+) [ { array
manager.
@odata.id string read-only Link to another Manager resource.
}]
ManagerForChassis [ { array An array of links to the chassis this manager controls.
Link to a Chassis resource. See the Links section and the Chassis
@odata.id string read-only
schema for details.
}]
ManagerForManagers An array of links to the managers that are managed by this
array
(v1.9+) [ { manager.
@odata.id string read-only Link to another Manager resource.
}]
ManagerForServers [ { array An array of links to the systems that this manager controls.
Link to a ComputerSystem resource. See the Links section and
@odata.id string read-only
the ComputerSystem schema for details.
Version 2023.1 Published 487
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
}]
ManagerForSwitches
array An array of links to the switches that this manager controls.
(v1.4+) [ {
Link to a Switch resource. See the Links section and the Switch
@odata.id string read-only
schema for details.
}]
ManagerInChassis The link to the chassis where this manager is located. See the
object
(v1.1+) { Chassis schema for details on this property.
Link to a Chassis resource. See the Links section and the Chassis
@odata.id string read-only
schema for details.
Oem {} object See the Oem object definition in the Common properties section.
The network port currently used by this manager. This allows
selection of shared or dedicated ports for managers that support
SelectedNetworkPort
object one or the other. For managers that always have their dedicated
(v1.18+) { (null)
port enabled this allows the selection of which shared port to use.
See the Port schema for details on this property.
Link to a Port resource. See the Links section and the Port
@odata.id string read-write
schema for details.
SoftwareImages (v1.6+) [
array The images that are associated with this manager.
{
Link to a SoftwareInventory resource. See the Links section and
@odata.id string read-only
the SoftwareInventory schema for details.
}]
Location (v1.11+) {} object The location of the manager. For property details, see Location.
LocationIndicatorActive read-write An indicator allowing an operator to physically locate this
boolean
(v1.11+) (null) resource.
The link to a collection of logs that the manager uses. Contains a
LogServices { object
link to a resource.
Link to Collection of LogService. See the LogService schema for
@odata.id string read-only
details.
488 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
ManagerDiagnosticData The diagnostic data for this manager. See the
object
(v1.14+) { (null) ManagerDiagnosticData schema for details on this property.
Link to a ManagerDiagnosticData resource. See the Links section
@odata.id string read-only
and the ManagerDiagnosticData schema for details.
string The type of manager that this resource represents. For the
ManagerType read-only
(enum) possible property values, see ManagerType in Property details.
read-only
Manufacturer (v1.7+) string The manufacturer of this manager.
(null)
An array of DSP0274-defined measurement blocks. Deprecated in
Measurements (v1.13+,
array v1.14 and later. This property has been deprecated in favor of the
deprecated v1.14 [ {
ComponentIntegrity resource.
Link to a MeasurementBlock resource. See the Links section and
@odata.id string read-only
the SoftwareInventory schema for details.
}]
read-only The model information of this manager, as defined by the
Model string
(null) manufacturer.
The link to the network services and their settings that the
NetworkProtocol { object manager controls. See the ManagerNetworkProtocol schema for
details on this property.
Link to a ManagerNetworkProtocol resource. See the Links section
@odata.id string read-only
and the ManagerNetworkProtocol schema for details.
read-only
PartNumber (v1.7+) string The part number of the manager.
(null)
string read-only The current power state of the manager. For the possible
PowerState (v1.2+)
(enum) (null) property values, see PowerState in Property details.
array The redundancy information for the managers of this system. For
Redundancy [ { } ]
(object) property details, see Redundancy.
The link to the account service resource for the remote manager
RemoteAccountService
object that this resource represents. See the AccountService schema for
(v1.5+) {
details on this property.
Version 2023.1 Published 489
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to a AccountService resource. See the Links section and the
@odata.id string read-only
AccountService schema for details.
RemoteRedfishServiceUri string read-only The URI of the Redfish service root for the remote manager that
(v1.5+) (URI) (null) this resource represents.
The security policy settings for this manager. See the
SecurityPolicy (v1.16+) { object
(null) SecurityPolicy schema for details on this property.
Link to a SecurityPolicy resource. See the Links section and the
@odata.id string read-only
SecurityPolicy schema for details.
The serial console service that this manager provides.
SerialConsole (deprecated Deprecated in v1.10 and later. This property has been deprecated
object
v1.10) { in favor of the SerialConsole property in the ComputerSystem
resource.
array This property enumerates the serial console connection types
ConnectTypesSupported
(string read-only that the implementation allows. For the possible property values,
[]
(enum)) see ConnectTypesSupported in Property details.
The maximum number of service sessions, regardless of protocol,
MaxConcurrentSessions integer read-only
that this manager can support.
ServiceEnabled boolean read-write An indication of whether the service is enabled for this manager.
The link to a collection of serial interfaces that this manager uses
SerialInterfaces { object for serial and console communication. Contains a link to a
resource.
Link to Collection of SerialInterface. See the SerialInterface
@odata.id string read-only
schema for details.
read-only
SerialNumber (v1.7+) string The serial number of the manager.
(null)
string read-only
ServiceEntryPointUUID The UUID of the Redfish service that is hosted by this manager.
(uuid) (null)
ServiceIdentification read-write
string A product instance identifier displayed in the Redfish service root.
(v1.15+) (null)
490 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
SharedNetworkPorts The shared network ports of the manager. Contains a link to a
object
(v1.16+) { resource.
@odata.id string read-only Link to Collection of Port. See the Port schema for details.
read-only
SparePartNumber (v1.11+) string The spare part number of the manager.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
TimeZoneName (v1.10+) string read-write The time zone of the manager.
USBPorts (v1.12+) { object The USB ports of the manager. Contains a link to a resource.
@odata.id string read-only Link to Collection of Port. See the Port schema for details.
string read-only
UUID The UUID for this manager.
(uuid) (null)
read-only
Version (v1.17+) string The hardware version of this manager.
(null)
The link to the Virtual Media services for this particular manager.
VirtualMedia (deprecated Contains a link to a resource. Deprecated in v1.10 and later. This
object
v1.10) { property has been deprecated in favor of the VirtualMedia
property in the ComputerSystem resource.
Link to Collection of VirtualMedia. See the VirtualMedia schema
@odata.id string read-only
for details.
6.63.4 Actions
6.63.4.1 ForceFailover
Description
The ForceFailover action forces a failover of this manager to the manager used in the parameter.
Action URI
{Base URI of target resource}/Actions/Manager.ForceFailover
Version 2023.1 Published 491
Redfish Resource and Schema Guide DSP2046
Action parameters
Parameter Name Type Attributes Notes
NewManager { object required The manager to which to fail over.
@odata.id string read-only Link to another Manager resource.
Request Example
{
"NewManager": [
{
"@odata.id": "/redfish/v1/Managers/3"
}
]
}
6.63.4.2 ModifyRedundancySet
Description
The ModifyRedundancySet operation adds members to or removes members from a redundant group
of managers.
Action URI
{Base URI of target resource}/Actions/Manager.ModifyRedundancySet
Action parameters
Parameter
Type Attributes Notes
Name
Add [ { array optional An array of managers to add to the redundancy set.
@odata.id string read-only Link to another Manager resource.
}]
Remove [ { array optional An array of managers to remove from the redundancy set.
@odata.id string read-only Link to another Manager resource.
492 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Parameter
Type Attributes Notes
Name
}]
Request Example
{
"Add": [
{
"@odata.id": "/redfish/v1/Managers/4"
}
]
}
6.63.4.3 Reset
Description
The reset action resets/reboots the manager.
Action URI
{Base URI of target resource}/Actions/Manager.Reset
Action parameters
Parameter
Type Attributes Notes
Name
string The type of reset. For the possible property values, see ResetType in Property
ResetType optional
(enum) details.
Request Example
{
"ResetType": "ForceRestart"
}
Version 2023.1 Published 493
Redfish Resource and Schema Guide DSP2046
6.63.4.4 ResetToDefaults (v1.8+)
Description
The reset action resets the manager settings to factory defaults. This can cause the manager to reset.
Action URI
{Base URI of target resource}/Actions/Manager.ResetToDefaults
Action parameters
Parameter
Type Attributes Notes
Name
string The type of reset to defaults. For the possible property values, see ResetType
ResetType required
(enum) in Property details.
Request Example
{
"ResetType": "PreserveNetworkAndUsers"
}
6.63.5 Property details
6.63.5.1 ConnectTypesSupported
6.63.5.1.1 In CommandShell:
This property enumerates the command shell connection types that the implementation allows.
string Description
The controller supports a command shell connection through the IPMI Serial Over LAN (SOL)
IPMI
protocol.
Oem The controller supports a command shell connection through an OEM-specific protocol.
SSH The controller supports a command shell connection through the SSH protocol.
Telnet The controller supports a command shell connection through the Telnet protocol.
494 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.63.5.1.2 In GraphicalConsole:
This property enumerates the graphical console connection types that the implementation allows.
string Description
The controller supports a graphical console connection through a KVM-IP (redirection of
KVMIP
Keyboard, Video, Mouse over IP) protocol.
Oem The controller supports a graphical console connection through an OEM-specific protocol.
6.63.5.1.3 In SerialConsole:
This property enumerates the serial console connection types that the implementation allows.
string Description
The controller supports a serial console connection through the IPMI Serial Over LAN (SOL)
IPMI
protocol.
Oem The controller supports a serial console connection through an OEM-specific protocol.
SSH The controller supports a serial console connection through the SSH protocol.
Telnet The controller supports a serial console connection through the Telnet protocol.
6.63.5.2 ManagerType
The type of manager that this resource represents.
string Description
A controller that provides management functions for a particular subsystem or group of
AuxiliaryController
devices.
BMC A controller that provides management functions for a single computer system.
A controller that provides management functions for a chassis or group of devices or
EnclosureManager
systems.
ManagementController A controller that primarily monitors or manages the operation of a device or system.
RackManager A controller that provides management functions for a whole or part of a rack.
Service (v1.4+) A software-based service that provides management functions.
Version 2023.1 Published 495
Redfish Resource and Schema Guide DSP2046
6.63.5.3 PowerState
The current power state of the manager.
string Description
The resource is powered off. The components within the resource might continue to have
Off
AUX power.
On The resource is powered on.
Paused The resource is paused.
A temporary state between on and off. The components within the resource can take time to
PoweringOff
process the power off action.
A temporary state between off and on. The components within the resource can take time to
PoweringOn
process the power on action.
6.63.5.4 ResetType
6.63.5.4.1 In Actions: Reset:
The type of reset.
string Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
ForceOn Turn on the unit immediately.
ForceRestart Shut down immediately and non-gracefully and restart the system.
GracefulRestart Shut down gracefully and restart the system.
GracefulShutdown Shut down gracefully and power off.
Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal
Nmi
operations, complete diagnostic actions, and, typically, halt the system.
On Turn on the unit.
Pause execution on the unit but do not remove power. This is typically a feature of virtual
Pause
machine hypervisors.
Power cycle the unit. Behaves like a full power removal, followed by a power restore to the
PowerCycle
resource.
496 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
PushPowerButton Simulate the pressing of the physical power button on this unit.
Resume execution on the paused unit. This is typically a feature of virtual machine
Resume
hypervisors.
Write the state of the unit to disk before powering off. This allows for the state to be restored
Suspend
when powered back on.
6.63.5.4.2 In Actions: ResetToDefaults:
The type of reset to defaults.
string Description
PreserveNetwork Reset all settings except network settings to factory defaults.
PreserveNetworkAndUsers Reset all settings except network and local user names/passwords to factory defaults.
ResetAll Reset all settings to factory defaults.
6.63.6 Example response
{
"@odata.type": "#Manager.v1_18_0.Manager",
"Id": "BMC",
"Name": "Manager",
"ManagerType": "BMC",
"Description": "Contoso BMC",
"ServiceEntryPointUUID": "92384634-2938-2342-8820-489239905423",
"UUID": "58893887-8974-2487-2389-841168418919",
"Model": "Joo Janta 200",
"FirmwareVersion": "4.4.6521",
"DateTime": "2015-03-13T04:14:33+06:00",
"DateTimeLocalOffset": "+06:00",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"PowerState": "On",
"GraphicalConsole": {
"ServiceEnabled": true,
"MaxConcurrentSessions": 2,
"ConnectTypesSupported": [
"KVMIP"
Version 2023.1 Published 497
Redfish Resource and Schema Guide DSP2046
]
},
"CommandShell": {
"ServiceEnabled": true,
"MaxConcurrentSessions": 4,
"ConnectTypesSupported": [
"Telnet",
"SSH"
]
},
"HostInterfaces": {
"@odata.id": "/redfish/v1/Managers/9/HostInterfaces"
},
"NetworkProtocol": {
"@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol"
},
"EthernetInterfaces": {
"@odata.id": "/redfish/v1/Managers/BMC/NICs"
},
"SerialInterfaces": {
"@odata.id": "/redfish/v1/Managers/BMC/SerialInterfaces"
},
"LogServices": {
"@odata.id": "/redfish/v1/Managers/BMC/LogServices"
},
"VirtualMedia": {
"@odata.id": "/redfish/v1/Systems/437XR1138R2/VirtualMedia"
},
"Links": {
"ManagerForServers": [
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2"
}
],
"ManagerForChassis": [
{
"@odata.id": "/redfish/v1/Chassis/1U"
}
],
"ManagerInChassis": {
"@odata.id": "/redfish/v1/Chassis/1U"
}
},
"Actions": {
"#Manager.Reset": {
"target": "/redfish/v1/Managers/BMC/Actions/Manager.Reset",
"[email protected]": [
"ForceRestart",
"GracefulRestart"
]
498 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
}
},
"@odata.id": "/redfish/v1/Managers/BMC"
}
6.64 ManagerAccount 1.10.0
Version v1.10 v1.9 v1.8 v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.3 2022.1 2021.1 2020.4 2020.1 2019.4 2019.3 2019.1 2018.3 2017.1 1.0
6.64.1 Description
The ManagerAccount schema defines the user accounts that are owned by a manager. Changes to a
manager account might affect the current Redfish service connection if this manager is responsible for
the Redfish service.
6.64.2 URIs
/redfish/v1/AccountService/Accounts/{ManagerAccountId}
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/Accounts/{ManagerAccountId}
6.64.3 Properties
Property Type Attributes Notes
string
read-write Indicates the date and time when this account expires. If null , the
AccountExpiration (v1.8+) (date-
(null) account never expires.
time)
array read-write The list of services in the manager that the account is allowed to
AccountTypes (v1.4+) [ ] (string required access. For the possible property values, see AccountTypes in
(enum)) (null) Property details.
The link to a collection of user identity certificates for this account.
Certificates (v1.2+) { object
Contains a link to a resource.
Link to Collection of Certificate. See the Certificate schema for
@odata.id string read-only
details.
Version 2023.1 Published 499
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
An indication of whether an account is enabled. An administrator
can disable it without deleting the user information. If true , the
Enabled boolean read-write
account is enabled and the user can log in. If false , the account is
disabled and, in the future, the user cannot log in.
HostBootstrapAccount An indication of whether this account is a bootstrap account for the
boolean read-only
(v1.8+) host interface.
The link to the collection of keys that can be used to authenticate
this account. For example, an SSH public key could be added to
Keys (v1.9+) { object
this collection to allow for SSH public key authentication. Contains
a link to a resource.
@odata.id string read-only Link to Collection of Key. See the Key schema for details.
Links { object The links to other resources that are related to this resource.
Oem {} object See the Oem object definition in the Common properties section.
The link to the Redfish role that defines the privileges for this
Role { object
account. See the Role schema for details on this property.
Link to a Role resource. See the Links section and the Role schema
@odata.id string read-only
for details.
An indication of whether the account service automatically locked
the account because the lockout threshold was exceeded. To
Locked boolean read-write manually unlock the account before the lockout duration period, an
administrator can change the property to false to clear the
lockout condition.
The multi-factor authentication bypass settings for this account.
MFABypass (v1.10+) { object
(null) See the AccountService schema for details on this property.
Link to a MFABypass resource. See the Links section and the
@odata.id string read-only
AccountService schema for details.
array
OEMAccountTypes (v1.4+)
(string, read-write The OEM account types.
[]
null)
500 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write
required The password. Use this property with a PATCH or PUT to write the
Password string
on create password for the account. This property is null in responses.
(null)
An indication of whether the service requires that the password for
PasswordChangeRequired read-write
boolean this account be changed before further access to the account is
(v1.3+) (null)
allowed.
string
PasswordExpiration read-write Indicates the date and time when this account password expires. If
(date-
(v1.6+) (null) null , the account password never expires.
time)
read-write
RoleId string required The role for this account.
on create
SNMP (v1.4+) { object The SNMP settings for this account.
(null)
AuthenticationKey read-write
string The secret authentication key for SNMPv3.
(v1.4+) (null)
AuthenticationKeySet
boolean read-only Indicates if the AuthenticationKey property is set.
(v1.5+)
AuthenticationProtocol string read-write The authentication protocol for SNMPv3. For the possible property
(v1.4+) (enum) (null) values, see AuthenticationProtocol in Property details.
read-write
EncryptionKey (v1.4+) string The secret encryption key used in SNMPv3.
(null)
EncryptionKeySet
boolean read-only Indicates if the EncryptionKey property is set.
(v1.5+)
EncryptionProtocol string read-write The encryption protocol for SNMPv3. For the possible property
(v1.4+) (enum) (null) values, see EncryptionProtocol in Property details.
read-write Indicates if the service needs to use the account types exactly as
StrictAccountTypes (v1.7+) boolean
(null) specified when the account is created or updated.
read-write
UserName string required The user name for the account.
on create
Version 2023.1 Published 501
Redfish Resource and Schema Guide DSP2046
6.64.4 Property details
6.64.4.1 AccountTypes
The list of services in the manager that the account is allowed to access.
string Description
Allow access to the host's console, which could be connected through Telnet, SSH, or other
HostConsole
protocol.
IPMI Allow access to the Intelligent Platform Management Interface service.
KVMIP Allow access to a Keyboard-Video-Mouse over IP session.
Allow access to the manager's console, which could be connected through Telnet, SSH, SM
ManagerConsole
CLP, or other protocol.
OEM OEM account type. See the OEMAccountTypes property.
Redfish Allow access to the Redfish service.
SNMP Allow access to SNMP services.
VirtualMedia Allow access to control virtual media.
Allow access to a web user interface session, such as a graphical interface or another web-
WebUI
based protocol.
6.64.4.2 AuthenticationProtocol
The authentication protocol for SNMPv3.
string Description
HMAC128_SHA224 (v1.7+) HMAC-128-SHA-224 authentication.
HMAC192_SHA256 (v1.7+) HMAC-192-SHA-256 authentication.
HMAC256_SHA384 (v1.7+) HMAC-256-SHA-384 authentication.
HMAC384_SHA512 (v1.7+) HMAC-384-SHA-512 authentication.
HMAC_MD5 HMAC-MD5-96 authentication.
HMAC_SHA96 HMAC-SHA-96 authentication.
502 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
None No authentication.
6.64.4.3 EncryptionProtocol
The encryption protocol for SNMPv3.
string Description
CBC_DES CBC-DES encryption.
CFB128_AES128 CFB128-AES-128 encryption.
None No encryption.
6.64.5 Example response
{
"@odata.type": "#ManagerAccount.v1_10_0.ManagerAccount",
"Id": "1",
"Name": "User Account",
"Description": "User Account",
"Enabled": true,
"Password": null,
"PasswordChangeRequired": false,
"AccountTypes": [
"Redfish"
],
"UserName": "Administrator",
"RoleId": "Administrator",
"Locked": false,
"Links": {
"Role": {
"@odata.id": "/redfish/v1/AccountService/Roles/Administrator"
}
},
"@odata.id": "/redfish/v1/AccountService/Accounts/1"
}
Version 2023.1 Published 503
Redfish Resource and Schema Guide DSP2046
6.65 ManagerDiagnosticData 1.2.0
Version v1.2 v1.1
Release 2022.3 2021.4
6.65.1 Description
The ManagerDiagnosticData schema defines internal diagnostic data for a manager. It contains
information that might be used by vendors to collect debug information about the manager. Clients
should not make decisions for raising alerts, creating service events, or other actions based on
information in this resource.
6.65.2 URIs
/redfish/v1/Managers/{ManagerId}/ManagerDiagnosticData
6.65.3 Properties
Property Type Attributes Notes
BootTimeStatistics { object The boot time statistics of the manager.
read-only The number of seconds the manager spent in the firmware
FirmwareTimeSeconds number
(null) stage.
read-only The number of seconds the manager spent in the initrd boot
InitrdTimeSeconds number
(null) stage.
read-only The number of seconds the manager spent in the kernel
KernelTimeSeconds number
(null) stage.
read-only The number of seconds the manager spent in the loader
LoaderTimeSeconds number
(null) stage.
read-only The number of seconds the manager spent in the user space
UserSpaceTimeSeconds number
(null) boot stage.
integer read-only The available storage space on this manager in kibibytes
FreeStorageSpaceKiB
(KiBy) (null) (KiB).
I2CBuses [ { array The statistics of the I2C buses.
504 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only
BusErrorCount integer The number of bus errors on this I2C bus.
(null)
I2CBusName string read-only The name of the I2C bus.
read-only
NACKCount integer The number of NACKs on this I2C bus.
(null)
read-only
TotalTransactionCount integer The total number of transactions on this I2C bus.
(null)
}]
MemoryECCStatistics { object The memory ECC statistics of the manager.
read-only
CorrectableECCErrorCount integer The number of the correctable errors since reset.
(null)
read-only
UncorrectableECCErrorCount integer The number of the uncorrectable errors since reset.
(null)
MemoryStatistics { object The memory statistics of the manager.
integer read-only The amount of memory available in bytes for starting new
AvailableBytes
(bytes) (null) processes without swapping.
integer read-only The amount of memory used in bytes by kernel buffers, page
BuffersAndCacheBytes
(bytes) (null) caches, and slabs.
integer read-only
FreeBytes The amount of free memory in bytes.
(bytes) (null)
integer read-only
SharedBytes The amount of shared memory in bytes.
(bytes) (null)
integer read-only
TotalBytes The total amount of memory in bytes.
(bytes) (null)
integer read-only
UsedBytes The amount of used memory in bytes.
(bytes) (null)
ProcessorStatistics { object The processor statistics of the manager.
number read-only
KernelPercent The percentage of CPU time spent in kernel mode.
(%) (null)
Version 2023.1 Published 505
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
number read-only
UserPercent The percentage of CPU time spent in user mode.
(%) (null)
ServiceRootUptimeSeconds read-only The wall-clock time the service root hosted by this manager
number
(v1.2+) (null) has been running in seconds.
TopProcesses [ { array The statistics of the top processes of this manager.
CommandLine string read-only The command line of this process.
read-only
KernelTimeSeconds number The number of seconds this process executed in kernel space.
(null)
integer read-only
ResidentSetSizeBytes The resident set size of this process in bytes.
(bytes) (null)
RestartAfterFailureCount read-only
integer The number of times this process has restarted unexpectedly.
(v1.1+) (null)
read-only
RestartCount (v1.1+) integer The number of times this process has restarted.
(null)
read-only
UptimeSeconds (v1.1+) number The wall-clock time this process has been running in seconds.
(null)
read-only
UserTimeSeconds number The number of seconds this process executed in user space.
(null)
}]
6.65.4 Actions
6.65.4.1 ResetMetrics
Description
Resets time intervals or counted values of the diagnostic data for this manager.
Action URI
{Base URI of target resource}/Actions/ManagerDiagnosticData.ResetMetrics
Action parameters
This action takes no parameters.
506 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.65.5 Example response
{
"@odata.type": "#ManagerDiagnosticData.v1_2_0.ManagerDiagnosticData",
"Id": "ManagerDiagnosticData",
"Name": "Manager Diagnostic Data",
"I2CBuses": [
{
"I2CBusName": "i2c-0",
"TotalTransactionCount": 10000,
"BusErrorCount": 12,
"NACKCount": 34
},
{
"I2CBusName": "i2c-1",
"TotalTransactionCount": 20000,
"BusErrorCount": 56,
"NACKCount": 78
}
],
"MemoryStatistics": {
"TotalBytes": 1013052000,
"UsedBytes": 45084000,
"FreeBytes": 894820000,
"SharedBytes": 19864000,
"BuffersAndCacheBytes": 73148000,
"AvailableBytes": 928248000
},
"ProcessorStatistics": {
"KernelPercent": 12.34,
"UserPercent": 23.45
},
"TopProcesses": [
{
"CommandLine": "dbus-broker",
"UserTimeSeconds": 14400,
"KernelTimeSeconds": 10800,
"ResidentSetSizeBytes": 2300000
},
{
"CommandLine": "swampd",
"UserTimeSeconds": 13200,
"KernelTimeSeconds": 8441,
"ResidentSetSizeBytes": 8883000
},
{
"CommandLine": "ipmid",
"UserTimeSeconds": 13100,
"KernelTimeSeconds": 6650,
Version 2023.1 Published 507
Redfish Resource and Schema Guide DSP2046
"ResidentSetSizeBytes": 23400000
},
{
"CommandLine": "phosphor-hwmon-readd -i iface1",
"UserTimeSeconds": 5100,
"KernelTimeSeconds": 3200,
"ResidentSetSizeBytes": 564000
}
],
"BootTimeStatistics": {
"FirmwareTimeSeconds": 42.3,
"LoaderTimeSeconds": 12.3,
"KernelTimeSeconds": 33.1,
"InitrdTimeSeconds": 3.2,
"UserSpaceTimeSeconds": 81.1
},
"MemoryECCStatistics": {
"CorrectableECCErrorCount": 1,
"UncorrectableECCErrorCount": 2
},
"@odata.id": "/redfish/v1/Managers/BMC/ManagerDiagnosticData"
}
6.66 ManagerNetworkProtocol 1.9.1
Version v1.9 v1.8 v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.2 2021.2 2020.4 2020.1 2019.3 2018.3 2018.2 2017.1 2016.3 1.0
6.66.1 Description
The network service settings for the manager.
6.66.2 URIs
/redfish/v1/Managers/{ManagerId}/NetworkProtocol
508 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.66.3 Properties
Property Type Attributes Notes
The settings for this manager's DHCPv4 protocol support.
DHCP (v1.1+) {} object For more information about this property, see Protocol in
Property Details.
The settings for this manager's DHCPv6 protocol support.
DHCPv6 (v1.3+) {} object For more information about this property, see Protocol in
Property Details.
The fully qualified domain name for the manager obtained
read-only
FQDN string by DNS including the host name and top-level domain
(null)
name.
read-only The DNS host name of this manager, without any domain
HostName string
(null) information.
The settings for this manager's HTTP protocol support. For
HTTP {} object more information about this property, see Protocol in
Property Details.
HTTPS { object The settings for this manager's HTTPS protocol support.
The link to a collection of certificates used for HTTPS by
Certificates (v1.4+) { object
this manager. Contains a link to a resource.
Link to Collection of Certificate. See the Certificate schema
@odata.id string read-only
for details.
read-write
Port integer The protocol port.
(null)
read-write
ProtocolEnabled boolean An indication of whether the protocol is enabled.
(null)
The settings for this manager's IPMI-over-LAN protocol
IPMI {} object support. For more information about this property, see
Protocol in Property Details.
The settings for this manager's KVM-IP protocol support
that apply to all system instances controlled by this
KVMIP {} object
manager. For more information about this property, see
Protocol in Property Details.
NTP (v1.2+) { object The settings for this manager's NTP protocol support.
Version 2023.1 Published 509
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
array
NetworkSuppliedServers The NTP servers supplied by other network protocols to
(string, read-only
(v1.9+) [ ] this manager.
null)
array
Indicates to which user-supplied NTP servers this manager
NTPServers (v1.2+) [ ] (string, read-write
is subscribed.
null)
read-write
Port integer The protocol port.
(null)
read-write
ProtocolEnabled boolean An indication of whether the protocol is enabled.
(null)
Proxy (v1.8+) { object The HTTP/HTTPS proxy information for this manager.
(null)
Enabled (v1.8+) boolean read-write Indicates if the manager uses the proxy server.
array
ExcludeAddresses (v1.8+) [ ] (string, read-write Addresses that do not require the proxy server to access.
null)
read-write The password for the proxy. The value is null in
Password (v1.8+) string
(null) responses.
PasswordSet (v1.8+) boolean read-only Indicates if the Password property is set.
string read-write The URI used to access a proxy auto-configuration (PAC)
ProxyAutoConfigURI (v1.8+)
(URI) (null) file.
string The URI of the proxy server, including the scheme and any
ProxyServerURI (v1.8+) read-write
(URI) non-default port value.
Username (v1.8+) string read-write The username for the proxy.
The settings for this manager's Remote Desktop Protocol
RDP (v1.3+) {} object support. For more information about this property, see
Protocol in Property Details.
The settings for this manager's Remote Frame Buffer
protocol support, which can support VNC. For more
RFB (v1.3+) {} object
information about this property, see Protocol in Property
Details.
SNMP { object The settings for this manager's SNMP support.
510 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The authentication protocol used for SNMP access to this
string read-write
AuthenticationProtocol (v1.5+) manager. For the possible property values, see
(enum) (null)
AuthenticationProtocol in Property details.
The access level of the SNMP community. For the possible
string read-write
CommunityAccessMode (v1.5+) property values, see CommunityAccessMode in Property
(enum) (null)
details.
CommunityStrings (v1.5+) [ { array The SNMP community strings.
string read-write The access level of the SNMP community. For the possible
AccessMode (v1.5+)
(enum) (null) property values, see AccessMode in Property details.
read-write
CommunityString (v1.5+) string The SNMP community string.
(null)
read-write
Name (v1.5+) string The name of the SNMP community.
(null)
}]
read-write
EnableSNMPv1 (v1.5+) boolean Indicates if access via SNMPv1 is enabled.
(null)
read-write
EnableSNMPv2c (v1.5+) boolean Indicates if access via SNMPv2c is enabled.
(null)
read-write
EnableSNMPv3 (v1.5+) boolean Indicates if access via SNMPv3 is enabled.
(null)
The encryption protocol used for SNMPv3 access to this
string read-write
EncryptionProtocol (v1.5+) manager. For the possible property values, see
(enum) (null)
EncryptionProtocol in Property details.
EngineId (v1.5+) { object The engine ID.
(null)
read-write
ArchitectureId (v1.6+) string The architecture identifier.
(null)
EnterpriseSpecificMethod read-write
string The enterprise specific method.
(v1.5+) (null)
read-only
PrivateEnterpriseId (v1.5+) string The private enterprise ID.
(null)
read-write
HideCommunityStrings (v1.5+) boolean Indicates if the community strings should be hidden.
(null)
Version 2023.1 Published 511
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-write
Port integer The protocol port.
(null)
read-write
ProtocolEnabled boolean An indication of whether the protocol is enabled.
(null)
SSDP { object The settings for this manager's SSDP support.
The IPv6 scope for multicast NOTIFY messages for SSDP.
string read-write
NotifyIPv6Scope For the possible property values, see NotifyIPv6Scope in
(enum) (null)
Property details.
The time interval, in seconds, between transmissions of
integer read-write
NotifyMulticastIntervalSeconds the multicast NOTIFY ALIVE message from this service for
(seconds) (null)
SSDP.
read-write The time-to-live hop count for SSDP multicast NOTIFY
NotifyTTL integer
(null) messages.
read-write
Port integer The protocol port.
(null)
read-write
ProtocolEnabled boolean An indication of whether the protocol is enabled.
(null)
The settings for this manager's Secure Shell (SSH) protocol
SSH {} object support. For more information about this property, see
Protocol in Property Details.
The status and health of the Resource and its subordinate
Status {} object
or dependent Resources. For property details, see Status.
The settings for this manager's Telnet protocol support. For
Telnet {} object more information about this property, see Protocol in
Property Details.
The settings for this manager's virtual media support that
apply to all system instances controlled by this manager.
VirtualMedia {} object
For more information about this property, see Protocol in
Property Details.
512 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.66.4 Property details
6.66.4.1 AccessMode
The access level of the SNMP community.
string Description
Full READ-WRITE access mode.
Limited READ-ONLY access mode.
6.66.4.2 AuthenticationProtocol
The authentication protocol used for SNMP access to this manager.
string Description
Account Authentication is determined by account settings.
CommunityString SNMP community string authentication.
HMAC128_SHA224 (v1.7+) HMAC-128-SHA-224 authentication.
HMAC192_SHA256 (v1.7+) HMAC-192-SHA-256 authentication.
HMAC256_SHA384 (v1.7+) HMAC-256-SHA-384 authentication.
HMAC384_SHA512 (v1.7+) HMAC-384-SHA-512 authentication.
HMAC_MD5 HMAC-MD5-96 authentication.
HMAC_SHA96 HMAC-SHA-96 authentication.
6.66.4.3 CommunityAccessMode
The access level of the SNMP community.
string Description
Full READ-WRITE access mode.
Limited READ-ONLY access mode.
Version 2023.1 Published 513
Redfish Resource and Schema Guide DSP2046
6.66.4.4 EncryptionProtocol
The encryption protocol used for SNMPv3 access to this manager.
string Description
Account Encryption is determined by account settings.
CBC_DES CBC-DES encryption.
CFB128_AES128 CFB128-AES-128 encryption.
None No encryption.
6.66.4.5 NotifyIPv6Scope
The IPv6 scope for multicast NOTIFY messages for SSDP.
string Description
Link SSDP NOTIFY messages are sent to addresses in the IPv6 local link scope.
Organization SSDP NOTIFY messages are sent to addresses in the IPv6 local organization scope.
Site SSDP NOTIFY messages are sent to addresses in the IPv6 local site scope.
6.66.4.6 Protocol
The settings for a network protocol associated with a manager.
read-
Port integer write The protocol port.
(null)
read-
ProtocolEnabled boolean write An indication of whether the protocol is enabled.
(null)
6.66.5 Example response
514 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"@odata.type": "#ManagerNetworkProtocol.v1_9_1.ManagerNetworkProtocol",
"Id": "NetworkProtocol",
"Name": "Manager Network Protocol",
"Description": "Manager Network Service",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"HostName": "web483-bmc",
"FQDN": "web483-bmc.dmtf.org",
"HTTP": {
"ProtocolEnabled": true,
"Port": 80
},
"HTTPS": {
"ProtocolEnabled": true,
"Port": 443
},
"IPMI": {
"ProtocolEnabled": true,
"Port": 623
},
"SSH": {
"ProtocolEnabled": true,
"Port": 22
},
"SNMP": {
"ProtocolEnabled": true,
"Port": 161
},
"VirtualMedia": {
"ProtocolEnabled": true,
"Port": 17988
},
"SSDP": {
"ProtocolEnabled": true,
"Port": 1900,
"NotifyMulticastIntervalSeconds": 600,
"NotifyTTL": 5,
"NotifyIPv6Scope": "Site"
},
"Telnet": {
"ProtocolEnabled": true,
"Port": 23
},
"KVMIP": {
"ProtocolEnabled": true,
"Port": 5288
},
"@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol"
Version 2023.1 Published 515
Redfish Resource and Schema Guide DSP2046
6.67 MediaController 1.3.0 (deprecated)
Version v1.3 Deprecated v1.2 Deprecated v1.1 v1.0
Release 2022.1 2021.1 2020.2 2019.4
This schema has been deprecated and use in new implementations is discouraged except to retain
compatibility with existing products. This schema has been deprecated in favor of the FabricAdapter
schema.
6.67.1 Description
The MediaController schema contains the definition of the media controller and its configuration.
6.67.2 URIs
/redfish/v1/Chassis/{ChassisId}/MediaControllers/{MediaControllerId}
6.67.3 Properties
Property Type Attributes Notes
EnvironmentMetrics The link to the environment metrics for this media controller. See the
object
(v1.2+) { EnvironmentMetrics schema for details on this property.
Link to a EnvironmentMetrics resource. See the Links section and the
@odata.id string read-only
EnvironmentMetrics schema for details.
Links { object The links to other resources that are related to this resource.
Endpoints [ { array An array of links to the endpoints that connect to this media controller.
Link to a Endpoint resource. See the Links section and the Endpoint
@odata.id string read-only
schema for details.
}]
516 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
MemoryDomains An array of links to the memory domains associated with this media
array
[{ controller.
Link to a MemoryDomain resource. See the Links section and the
@odata.id string read-only
MemoryDomain schema for details.
}]
Oem {} object See the Oem object definition in the Common properties section.
read-only
Manufacturer string The manufacturer of this media controller.
(null)
string read-only The type of media controller. For the possible property values, see
MediaControllerType
(enum) (null) MediaControllerType in Property details.
read-only
Model string The model of this media controller.
(null)
read-only
PartNumber string The part number of this media controller.
(null)
The link to the collection of ports associated with this media controller.
Ports { object
Contains a link to a resource.
@odata.id string read-only Link to Collection of Port. See the Port schema for details.
read-only
SerialNumber string The serial number of this media controller.
(null)
The status and health of the resource and its subordinate or dependent
Status {} object
resources. For property details, see Status.
string read-only
UUID (v1.1+) The UUID for this media controller.
(uuid) (null)
6.67.4 Actions
6.67.4.1 Reset
Description
This action resets this media controller.
Version 2023.1 Published 517
Redfish Resource and Schema Guide DSP2046
Action URI
{Base URI of target resource}/Actions/MediaController.Reset
Action parameters
Parameter
Type Attributes Notes
Name
string The type of reset. For the possible property values, see ResetType in Property
ResetType optional
(enum) details.
Request Example
{
"ResetType": "ForceRestart"
}
6.67.5 Property details
6.67.5.1 MediaControllerType
The type of media controller.
string Description
Memory The media controller is for memory.
6.67.5.2 ResetType
The type of reset.
string Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
ForceOn Turn on the unit immediately.
ForceRestart Shut down immediately and non-gracefully and restart the system.
GracefulRestart Shut down gracefully and restart the system.
518 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
GracefulShutdown Shut down gracefully and power off.
Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal
Nmi
operations, complete diagnostic actions, and, typically, halt the system.
On Turn on the unit.
Pause execution on the unit but do not remove power. This is typically a feature of virtual
Pause
machine hypervisors.
Power cycle the unit. Behaves like a full power removal, followed by a power restore to the
PowerCycle
resource.
PushPowerButton Simulate the pressing of the physical power button on this unit.
Resume execution on the paused unit. This is typically a feature of virtual machine
Resume
hypervisors.
Write the state of the unit to disk before powering off. This allows for the state to be restored
Suspend
when powered back on.
6.67.6 Example response
{
"@odata.type": "#MediaController.v1_3_0.MediaController",
"Id": "MediaController1",
"Name": "Media Controller 1",
"MediaControllerType": "Memory",
"Manufacturer": "Contoso",
"Model": "Contoso MediaController",
"SerialNumber": "2M220100SL",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"UUID": "41784113-ed6b-2284-1414-916520dc1dd1",
"Ports": {
"@odata.id": "/redfish/v1/Chassis/GenZ/MediaControllers/1/Ports"
},
"Actions": {
"#MediaController.Reset": {
"target": "/redfish/v1/Chassis/GenZ/MediaControllers/1/Actions/MediaController.Reset",
"[email protected]": [
"ForceRestart"
]
}
},
Version 2023.1 Published 519
Redfish Resource and Schema Guide DSP2046
"Links": {
"Endpoints": [
{
"@odata.id": "/redfish/v1/Fabrics/GenZ/Endpoints/1"
}
],
"MemoryDomains": [
{
"@odata.id": "/redfish/v1/Chassis/GenZ/MemoryDomains/1"
}
]
},
"@odata.id": "/redfish/v1/Chassis/GenZ/MediaControllers/1"
}
6.68 Memory 1.17.1
Version v1.17 v1.16 v1.15 v1.14 v1.13 v1.12 v1.11 v1.10 v1.9 v1.8 v1.7 ...
Release 2022.3 2022.2 2022.1 2021.4 2021.2 2021.1 2020.4 2020.3 2019.4 2019.2 2018.3 ...
6.68.1 Description
The Memory schema represents a memory device, such as a DIMM, and its configuration. It also
describes the location, such as a slot, socket, or bay, where a unit can be installed, by populating a
resource instance with an absent state if a unit is not present.
6.68.2 URIs
/redfish/v1/Chassis/{ChassisId}/Memory/{MemoryId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Memory/{MemoryId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory/{MemoryId}
/redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}
520 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.68.3 Properties
Property Type Attributes Notes
integer read-only The boundary that memory regions are
AllocationAlignmentMiB (v1.2+)
(mebibytes) (null) allocated on, measured in mebibytes (MiB).
integer read-only The size of the smallest unit of allocation for
AllocationIncrementMiB (v1.2+)
(mebibytes) (null) a memory region in mebibytes (MiB).
array
AllowedSpeedsMHz [ ] (MHz) read-only Speeds supported by this memory device.
(integer)
The link to the assembly resource associated
Assembly (v1.4+) { object with this memory device. See the Assembly
schema for details on this property.
Link to a Assembly resource. See the Links
@odata.id string read-only
section and the Assembly schema for details.
The base module type of the memory device.
string read-only
BaseModuleType For the possible property values, see
(enum) (null)
BaseModuleType in Property details.
read-only
BusWidthBits integer The bus width, in bits.
(null)
integer read-only Total size of the cache portion memory in
CacheSizeMiB (v1.4+)
(mebibytes) (null) MiB.
integer read-only
CapacityMiB Memory capacity in mebibytes (MiB).
(mebibytes) (null)
The link to a collection of certificates for
Certificates (v1.11+) { object device identity and attestation. Contains a
link to a resource.
Link to Collection of Certificate. See the
@odata.id string read-only
Certificate schema for details.
An indication of whether the configuration of
read-only
ConfigurationLocked (v1.7+) boolean this memory device is locked and cannot be
(null)
altered.
CXL (v1.17+) { object CXL properties for this memory device.
Version 2023.1 Published 521
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
integer The size of the label storage area in bytes of
LabelStorageSizeBytes (v1.17+) read-only
(bytes) this memory device.
integer Total device non-volatile capacity in MiB. The
StagedNonVolatileSizeMiB (v1.17+) read-write
(mebibytes) value shall be in multiples of 256MiB.
Total device non-volatile capacity in MiB
integer
StagedVolatileSizeMiB (v1.17+) read-write staged for next activation. This value shall be
(mebibytes)
in multiples of 256 MiB.
read-only
DataWidthBits integer Data width in bits.
(null)
Device ID. Deprecated in v1.3 and later. This
read-only
DeviceID (deprecated v1.3) string property has been deprecated in favor of
(null)
ModuleProductID.
Location of the memory device in the
read-only platform. Deprecated in v1.9 and later. This
DeviceLocator (deprecated v1.9) string
(null) property has been deprecated in favor of the
ServiceLabel property within Location.
An indication of whether this memory is
Enabled (v1.12+) boolean read-write
enabled.
The link to the environment metrics for this
EnvironmentMetrics (v1.11+) { object memory. See the EnvironmentMetrics schema
for details on this property.
Link to a EnvironmentMetrics resource. See
@odata.id string read-only the Links section and the EnvironmentMetrics
schema for details.
Error correction scheme supported for this
string read-only memory device. For the possible property
ErrorCorrection
(enum) (null) values, see ErrorCorrection in Property
details.
read-only
FirmwareApiVersion string Version of API supported by the firmware.
(null)
read-only Revision of firmware on the memory
FirmwareRevision string
(null) controller.
522 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Function classes by the memory device.
Deprecated in v1.3 and later. This property
array has been deprecated in favor of
FunctionClasses (deprecated v1.3) [ ] read-only
(string) OperatingMemoryModes at the root of the
resource, or MemoryClassification found
within RegionSet.
HealthData (v1.17+) { object The health data of this memory device.
number read-only The current health of the memory device as a
PredictedMediaLifeLeftPercent (v1.17+)
(%) (null) percentage.
read-only An indication of whether rank spare is
IsRankSpareEnabled boolean
(null) enabled for this memory device.
read-only An indication of whether a spare device is
IsSpareDeviceEnabled boolean
(null) enabled for this memory device.
The links to other resources that are related
Links (v1.2+) { object
to this resource.
The batteries that provide power to this
Batteries (v1.15+) [ { array
memory device during a power loss event.
Link to a Battery resource. See the Links
@odata.id string read-only
section and the Battery schema for details.
}]
The link to the chassis that contains this
Chassis (v1.2+) { object memory device. See the Chassis schema for
details on this property.
Link to a Chassis resource. See the Links
@odata.id string read-only
section and the Chassis schema for details.
An array of links to the endpoints associated
Endpoints (v1.17+) [ { array
with this memory.
Link to a Endpoint resource. See the Links
@odata.id string read-only
section and the Endpoint schema for details.
}]
An array of memory chunks providing media
MemoryMediaSources (v1.17+) [ { array
for this memory.
Version 2023.1 Published 523
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to a MemoryChunks resource. See the
@odata.id string read-only Links section and the MemoryChunks schema
for details.
}]
See the Oem object definition in the Common
Oem {} object
properties section.
An array of links to the processors associated
Processors (v1.11+) [ { array
with this memory device.
Link to a Processor resource. See the Links
@odata.id string read-only
section and the Processor schema for details.
}]
The location of the memory device. For
Location (v1.4+) {} object
property details, see Location.
read-write An indicator allowing an operator to
LocationIndicatorActive (v1.10+) boolean
(null) physically locate this resource.
The link to the log service associated with
Log (v1.13+) { object this memory. See the LogService schema for
details on this property.
Link to a LogService resource. See the Links
@odata.id string read-only section and the LogService schema for
details.
integer read-only
LogicalSizeMiB (v1.4+) Total size of the logical memory in MiB.
(mebibytes) (null)
read-only
Manufacturer string The memory device manufacturer.
(null)
array
Set of maximum power budgets supported by
MaxTDPMilliWatts [ ] (milliWatts) read-only
the memory device in milliwatts.
(integer)
An array of DSP0274-defined measurement
blocks. Deprecated in v1.14 and later. This
Measurements (v1.11+, deprecated v1.14 [ { array
property has been deprecated in favor of the
ComponentIntegrity resource.
524 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to a MeasurementBlock resource. See
@odata.id string read-only the Links section and the SoftwareInventory
schema for details.
}]
Type details of the memory device. For the
string read-only
MemoryDeviceType possible property values, see
(enum) (null)
MemoryDeviceType in Property details.
Memory connection information to sockets
MemoryLocation { object
and memory controllers.
read-only The channel number to which the memory
Channel integer
(null) device is connected.
read-only The memory controller number to which the
MemoryController integer
(null) memory device is connected.
read-only The slot number to which the memory device
Slot integer
(null) is connected.
read-only The socket number to which the memory
Socket integer
(null) device is connected.
array Media of this memory device. For the
MemoryMedia [ ] (string read-only possible property values, see MemoryMedia
(enum)) in Property details.
MemorySubsystemControllerManufacturerID read-only The manufacturer ID of the memory
string
(v1.3+) (null) subsystem controller of this memory device.
MemorySubsystemControllerProductID read-only The product ID of the memory subsystem
string
(v1.3+) (null) controller of this memory device.
The type of memory device. For the possible
string read-only
MemoryType property values, see MemoryType in Property
(enum) (null)
details.
The link to the metrics associated with this
Metrics { object memory device. See the MemoryMetrics
schema for details on this property.
Link to a MemoryMetrics resource. See the
@odata.id string read-only Links section and the MemoryMetrics schema
for details.
Version 2023.1 Published 525
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
Model (v1.11+) string The product model number of this device.
(null)
read-only
ModuleManufacturerID (v1.3+) string The manufacturer ID of this memory device.
(null)
read-only
ModuleProductID (v1.3+) string The product ID of this memory device.
(null)
integer The total non-volatile memory capacity in
NonVolatileSizeLimitMiB (v1.17+) read-write
(mebibytes) mebibytes (MiB).
integer read-only Total size of the non-volatile portion memory
NonVolatileSizeMiB (v1.4+)
(mebibytes) (null) in MiB.
array Memory modes supported by the memory
OperatingMemoryModes [ ] (string read-only device. For the possible property values, see
(enum)) OperatingMemoryModes in Property details.
integer read-only Operating speed of the memory device in
OperatingSpeedMhz
(MHz) (null) MHz or MT/s as appropriate.
Range of allowed operating speeds (MHz).
object This object is an excerpt of the Control
OperatingSpeedRangeMHz (v1.13+) {
(excerpt) resource located at the URI shown in
DataSourceUri.
read-only The maximum possible setting for this
AllowableMax number
(null) control.
read-only
AllowableMin number The minimum possible setting for this control.
(null)
array
AllowableNumericValues [ ] (number, read-only The supported values for the set point.
null)
The current operating mode of the control.
string read-write
ControlMode For the possible property values, see
(enum) (null)
ControlMode in Property details.
string read-only The link to the resource that provides the
DataSourceUri
(URI) (null) data for this control.
read-only The reading of the sensor associated with
Reading number
(null) this control.
read-only The units of the sensor reading associated
ReadingUnits string
(null) with this control.
526 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write
SettingMax number The maximum set point in the allowed range.
(null)
read-write
SettingMin number The minimum set point in the allowed range.
(null)
read-only
PartNumber string The product part number of this device.
(null)
read-only Total number of persistent regions this
PersistentRegionNumberLimit (v1.2+) integer
(null) memory device can support.
integer read-only Total size of persistent regions in mebibytes
PersistentRegionSizeLimitMiB
(mebibytes) (null) (MiB).
integer read-only Maximum size of a single persistent region in
PersistentRegionSizeMaxMiB (v1.2+)
(mebibytes) (null) mebibytes (MiB).
The maximum number of media error records
PoisonListMaxMediaErrorRecords (v1.17+) integer read-write
this device can track in its poison list.
PowerManagementPolicy { object Power management policy information.
integer read-only
AveragePowerBudgetMilliWatts Average power budget, in milliwatts.
(milliWatts) (null)
integer read-only
MaxTDPMilliWatts Maximum TDP in milliwatts.
(milliWatts) (null)
integer read-only
PeakPowerBudgetMilliWatts Peak power budget, in milliwatts.
(milliWatts) (null)
read-only An indication of whether the power
PolicyEnabled boolean
(null) management policy is enabled.
read-only Number of ranks available in the memory
RankCount integer
(null) device.
Memory regions information within the
Regions [ { array
memory device.
read-only An indication of whether the master
MasterPassphraseEnabled (v1.17+) boolean
(null) passphrase is enabled for this region.
Version 2023.1 Published 527
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The classification of memory that the
string read-only memory region occupies. For the possible
MemoryClassification
(enum) (null) property values, see MemoryClassification in
Property details.
Offset within the memory that corresponds to
integer read-only
OffsetMiB the start of this memory region in mebibytes
(mebibytes) (null)
(MiB).
read-only An indication of whether the passphrase is
PassphraseEnabled (v1.5+) boolean
(null) enabled for this region.
An indication of whether the state of the
passphrase for this region is enabled.
read-only
PassphraseState (deprecated v1.5) boolean Deprecated in v1.5 and later. This property
(null)
has been deprecated in favor of
PassphraseEnabled found within RegionSet.
read-only Unique region ID representing a specific
RegionId string
(null) region within the memory device.
integer read-only Size of this memory region in mebibytes
SizeMiB
(mebibytes) (null) (MiB).
}]
SecurityCapabilities { object Security capabilities of the memory device.
An indication of whether this memory device
read-only
ConfigurationLockCapable (v1.7+) boolean supports the locking, or freezing, of the
(null)
configuration.
read-only An indication of whether this memory device
DataLockCapable (v1.7+) boolean
(null) supports data locking.
read-only Maximum number of passphrases supported
MaxPassphraseCount integer
(null) for this memory device.
read-only An indication of whether the memory device
PassphraseCapable boolean
(null) is passphrase capable.
The maximum number of incorrect
read-only
PassphraseLockLimit (v1.7+) integer passphrase attempts allowed before memory
(null)
device is locked.
528 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Security states supported by the memory
device. For the possible property values, see
SecurityStates in Property details.
array
Deprecated in v1.7 and later. This property
SecurityStates (deprecated v1.7) [ ] (string read-only
has been deprecated in favor of using the
(enum))
individual PassphraseCapable,
DataLockCapable and
ConfigurationLockCapable properties.
The current security state of this memory
string read-write
SecurityState (v1.7+) device. For the possible property values, see
(enum) (null)
SecurityState in Property details.
SecurityStates (v1.17+) { object The security states of this memory device.
MasterPassphraseAttemptCountReached read-only An indication of whether an incorrect master
boolean
(v1.17+) (null) passphrase attempt count has been reached.
UserPassphraseAttemptCountReached read-only An indication of whether an incorrect user
boolean
(v1.17+) (null) passphrase attempt count has been reached.
read-only
SerialNumber string The product serial number of this device.
(null)
read-only Number of unused spare devices available in
SpareDeviceCount integer
(null) the memory device.
read-only
SparePartNumber (v1.11+) string The spare part number of the memory.
(null)
The status and health of the resource and its
Status (v1.1+) {} object subordinate or dependent resources. For
property details, see Status.
Subsystem device ID. Deprecated in v1.3 and
read-only later. This property has been deprecated in
SubsystemDeviceID (deprecated v1.3) string
(null) favor of
MemorySubsystemControllerProductID.
SubSystem vendor ID. Deprecated in v1.3
read-only and later. This property has been deprecated
SubsystemVendorID (deprecated v1.3) string
(null) in favor of
MemorySubsystemControllerManufacturerID.
Vendor ID. Deprecated in v1.3 and later. This
read-only
VendorID (deprecated v1.3) string property has been deprecated in favor of
(null)
ModuleManufacturerID.
Version 2023.1 Published 529
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only Total number of volatile regions this memory
VolatileRegionNumberLimit (v1.2+) integer
(null) device can support.
integer read-only Total size of volatile regions in mebibytes
VolatileRegionSizeLimitMiB
(mebibytes) (null) (MiB).
integer read-only Maximum size of a single volatile region in
VolatileRegionSizeMaxMiB (v1.2+)
(mebibytes) (null) mebibytes (MiB).
integer The total volatile memory capacity in
VolatileSizeLimitMiB (v1.17+) read-write
(mebibytes) mebibytes (MiB).
integer read-only Total size of the volatile portion memory in
VolatileSizeMiB (v1.4+)
(mebibytes) (null) MiB.
6.68.4 Actions
6.68.4.1 DisableMasterPassphrase (v1.17+)
Description
Disables the master passphrase for given region.
Action URI
{Base URI of target resource}/Actions/Memory.DisableMasterPassphrase
Action parameters
Parameter
Type Attributes Notes
Name
Passphrase string required The master passphrase for the specified region.
RegionId string required The memory region ID to which to disable the master passphrase.
Request Example
{
"Passphrase": "FluffyBunny",
"RegionId": 2
}
530 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.68.4.2 DisablePassphrase
Description
Disable passphrase for given regions.
Action URI
{Base URI of target resource}/Actions/Memory.DisablePassphrase
Action parameters
Parameter
Type Attributes Notes
Name
Passphrase string required Passphrase for doing the operation.
RegionId string required The memory region ID to which to apply this action.
Request Example
{
"Passphrase": "FluffyBunny",
"RegionId": 2
}
6.68.4.3 FreezeSecurityState (v1.17+)
Description
Freezes the security state of the memory device.
Action URI
{Base URI of target resource}/Actions/Memory.FreezeSecurityState
Action parameters
This action takes no parameters.
Version 2023.1 Published 531
Redfish Resource and Schema Guide DSP2046
6.68.4.4 InjectPersistentPoison (v1.17+)
Description
Injects poison to a specific persistent memory address in the memory device.
Action URI
{Base URI of target resource}/Actions/Memory.InjectPersistentPoison
Action parameters
Parameter Name Type Attributes Notes
The device persistent physical address in which to perform a poison
PhysicalAddress string required
injection as a hex-encoded string.
Request Example
{
"PhysicalAddress": "0x8000000"
}
6.68.4.5 OverwriteUnit (v1.6+)
Description
This contains the action for securely erasing given regions using the NIST SP800-88 Purge: Overwrite.
Action URI
{Base URI of target resource}/Actions/Memory.OverwriteUnit
Action parameters
Parameter
Type Attributes Notes
Name
Passphrase string required Passphrase for doing the operation.
RegionId string required The memory region ID to which to apply this action.
532 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Request Example
{
"Passphrase": "FluffyBunny",
"RegionId": 2
}
6.68.4.6 Reset (v1.8+)
Description
This action resets this memory device.
Action URI
{Base URI of target resource}/Actions/Memory.Reset
Action parameters
Parameter
Type Attributes Notes
Name
string The type of reset. For the possible property values, see ResetType in Property
ResetType optional
(enum) details.
Request Example
{
"ResetType": "ForceRestart"
}
6.68.4.7 ResetToDefaults (v1.16+)
Description
The action resets the values of writable properties to factory defaults.
Action URI
{Base URI of target resource}/Actions/Memory.ResetToDefaults
Action parameters
Version 2023.1 Published 533
Redfish Resource and Schema Guide DSP2046
This action takes no parameters.
6.68.4.8 ScanMedia (v1.17+)
Description
Scans the media of the memory device.
Action URI
{Base URI of target resource}/Actions/Memory.ScanMedia
Action parameters
Parameter Name Type Attributes Notes
The length of the target region to scan in bytes from the physical
Length integer required
address.
NoEventLog boolean optional Indicates whether events related to the media scan are not logged.
PhysicalAddress string required The starting device physical address to scan as a hex-encoded string.
Request Example
{
"PhysicalAddress": "0x8000000",
"Length": 2097152
}
6.68.4.9 SecureEraseUnit
Description
This contains the action for securely erasing given regions using the NIST SP800-88 Purge:
Cryptographic Erase.
Action URI
{Base URI of target resource}/Actions/Memory.SecureEraseUnit
Action parameters
534 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Parameter
Type Attributes Notes
Name
Passphrase string required Passphrase for doing the operation.
RegionId string required The memory region ID to which to apply this action.
Request Example
{
"Passphrase": "FluffyBunny",
"RegionId": 2
}
6.68.4.10 SetMasterPassphrase (v1.17+)
Description
Sets the master passphrase for the given region.
Action URI
{Base URI of target resource}/Actions/Memory.SetMasterPassphrase
Action parameters
Parameter
Type Attributes Notes
Name
Passphrase string required The master passphrase to set for the specified region.
RegionId string required The memory region ID to which to apply the master passphrase.
Request Example
{
"Passphrase": "FluffyBunny",
"RegionId": 2
}
Version 2023.1 Published 535
Redfish Resource and Schema Guide DSP2046
6.68.4.11 SetPassphrase
Description
Set passphrase for the given regions.
Action URI
{Base URI of target resource}/Actions/Memory.SetPassphrase
Action parameters
Parameter
Type Attributes Notes
Name
Passphrase string required Passphrase for doing the operation.
RegionId string required The memory region ID to which to apply this action.
Request Example
{
"Passphrase": "FluffyBunny",
"RegionId": 2
}
6.68.4.12 UnlockUnit
Description
This contains the action for unlocking given regions.
Action URI
{Base URI of target resource}/Actions/Memory.UnlockUnit
Action parameters
Parameter
Type Attributes Notes
Name
Passphrase string required The passphrase required to complete the operation.
536 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Parameter
Type Attributes Notes
Name
RegionId string required The memory region ID to which to apply this action.
Request Example
{
"Passphrase": "FluffyBunny",
"RegionId": 2
}
6.68.5 Property details
6.68.5.1 BaseModuleType
The base module type of the memory device.
string Description
Die (v1.7+) A die within a package.
LRDIMM Load Reduced.
Mini_RDIMM Mini_RDIMM.
Mini_UDIMM Mini_UDIMM.
RDIMM Registered DIMM.
SO_DIMM SO_DIMM.
SO_DIMM_16b SO_DIMM_16b.
SO_DIMM_32b SO_DIMM_32b.
SO_RDIMM_72b SO_RDIMM_72b.
SO_UDIMM_72b SO_UDIMM_72b.
UDIMM UDIMM.
6.68.5.2 ControlMode
The current operating mode of the control.
Version 2023.1 Published 537
Redfish Resource and Schema Guide DSP2046
string Description
Automatic Automatically adjust control to meet the set point.
Disabled The control has been disabled.
Manual No automatic adjustments are made to the control.
Override User override of the automatic set point value.
6.68.5.3 ErrorCorrection
Error correction scheme supported for this memory device.
string Description
AddressParity Address parity errors can be corrected.
MultiBitECC Multibit data errors can be corrected by ECC.
NoECC No ECC available.
SingleBitECC Single bit data errors can be corrected by ECC.
6.68.5.4 MemoryClassification
The classification of memory that the memory region occupies.
string Description
Block Block-accessible memory.
ByteAccessiblePersistent Byte-accessible persistent memory.
Volatile Volatile memory.
6.68.5.5 MemoryDeviceType
Type details of the memory device.
string Description
DDR DDR.
538 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
DDR2 DDR2.
DDR2_SDRAM DDR2 SDRAM.
DDR2_SDRAM_FB_DIMM DDR2 SDRAM FB_DIMM.
DDR2_SDRAM_FB_DIMM_PROBE DDR2 SDRAM FB_DIMM PROBE.
DDR3 DDR3.
DDR3_SDRAM DDR3 SDRAM.
DDR4 DDR4.
DDR4_SDRAM DDR4 SDRAM.
DDR4E_SDRAM DDR4E SDRAM.
DDR5 (v1.11+) Double data rate type five synchronous dynamic random-access memory.
DDR_SDRAM DDR SDRAM.
DDR_SGRAM DDR SGRAM.
EDO EDO.
FastPageMode Fast Page Mode.
GDDR (v1.11+) Synchronous graphics random-access memory.
GDDR2 (v1.11+) Double data rate type two synchronous graphics random-access memory.
GDDR3 (v1.11+) Double data rate type three synchronous graphics random-access memory.
GDDR4 (v1.11+) Double data rate type four synchronous graphics random-access memory.
GDDR5 (v1.11+) Double data rate type five synchronous graphics random-access memory.
GDDR5X (v1.11+) Double data rate type five X synchronous graphics random-access memory.
GDDR6 (v1.11+) Double data rate type six synchronous graphics random-access memory.
HBM (v1.7+) High Bandwidth Memory.
HBM2 (v1.7+) The second generation of High Bandwidth Memory.
HBM2E (v1.17+) An updated version of the second generation of High Bandwidth Memory.
HBM3 (v1.11+) The third generation of High Bandwidth Memory.
Logical (v1.4+) Logical device, such as when the memory is fabric-attached.
Version 2023.1 Published 539
Redfish Resource and Schema Guide DSP2046
string Description
LPDDR3_SDRAM LPDDR3 SDRAM.
LPDDR4_SDRAM LPDDR4 SDRAM.
OEM (v1.11+) OEM-defined.
PipelinedNibble Pipelined Nibble.
ROM ROM.
SDRAM SDRAM.
6.68.5.6 MemoryMedia
Media of this memory device.
string Description
DRAM DRAM media.
Intel3DXPoint Intel 3D XPoint media.
NAND NAND media.
Proprietary Proprietary media.
6.68.5.7 MemoryType
The type of memory device.
string Description
DRAM The memory device is comprised of volatile memory.
IntelOptane (v1.6+) The memory device is an Intel Optane Persistent Memory Module.
NVDIMM_F The memory device is comprised of non-volatile memory.
NVDIMM_N The memory device is comprised of volatile memory backed by non-volatile memory.
NVDIMM_P The memory device is comprised of a combination of non-volatile and volatile memory.
540 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.68.5.8 OperatingMemoryModes
Memory modes supported by the memory device.
string Description
Block Block-accessible system memory.
PMEM Persistent memory, byte-accessible through system address space.
Volatile Volatile memory.
6.68.5.9 ResetType
The type of reset.
string Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
ForceOn Turn on the unit immediately.
ForceRestart Shut down immediately and non-gracefully and restart the system.
GracefulRestart Shut down gracefully and restart the system.
GracefulShutdown Shut down gracefully and power off.
Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal
Nmi
operations, complete diagnostic actions, and, typically, halt the system.
On Turn on the unit.
Pause execution on the unit but do not remove power. This is typically a feature of virtual
Pause
machine hypervisors.
Power cycle the unit. Behaves like a full power removal, followed by a power restore to the
PowerCycle
resource.
PushPowerButton Simulate the pressing of the physical power button on this unit.
Resume execution on the paused unit. This is typically a feature of virtual machine
Resume
hypervisors.
Write the state of the unit to disk before powering off. This allows for the state to be restored
Suspend
when powered back on.
Version 2023.1 Published 541
Redfish Resource and Schema Guide DSP2046
6.68.5.10 SecurityState
The current security state of this memory device.
string Description
Disabled Secure mode is disabled.
Enabled Secure mode is enabled and access to the data is allowed.
Secure state is frozen and cannot be modified until reset. Deprecated in v1.7 and later. This
Frozen (deprecated v1.7) value has been deprecated in favor of using the ConfigurationLocked to indicate that the
configuration has been frozen.
Locked Secure mode is enabled and access to the data is locked.
Passphraselimit Number of attempts to unlock the memory exceeded limit.
Secure mode is enabled and access to the data is unlocked. Deprecated in v1.7 and later.
Unlocked (deprecated v1.7)
This value has been deprecated in favor of 'Enabled' to indicate normal security operation.
6.68.5.11 SecurityStates
Security states supported by the memory device.
string Description
Disabled Secure mode is disabled.
Enabled Secure mode is enabled and access to the data is allowed.
Frozen Secure state is frozen and cannot be modified until reset.
Locked Secure mode is enabled and access to the data is locked.
Passphraselimit Number of attempts to unlock the memory exceeded limit.
Unlocked Secure mode is enabled and access to the data is unlocked.
6.68.6 Example response
{
"@odata.type": "#Memory.v1_17_1.Memory",
"Name": "Regular Memory",
542 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"Id": "1",
"RankCount": 1,
"MaxTDPMilliWatts": [
12000
],
"CapacityMiB": 8192,
"DataWidthBits": 64,
"BusWidthBits": 72,
"ErrorCorrection": "MultiBitECC",
"MemoryLocation": {
"Socket": 1,
"MemoryController": 1,
"Channel": 1,
"Slot": 1
},
"MemoryType": "DRAM",
"MemoryDeviceType": "DDR4",
"BaseModuleType": "RDIMM",
"MemoryMedia": [
"DRAM"
],
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Metrics": {
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Memory/1/MemoryMetrics"
},
"EnvironmentMetrics": {
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Memory/1/EnvironmentMetrics"
},
"Location": {
"PartLocation": {
"ServiceLabel": "Socket 1_A",
"LocationType": "Socket",
"LocationOrdinalValue": 0
}
},
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Memory/1"
}
6.69 MemoryChunks 1.5.0
Version v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.3 2020.3 2019.4 2017.3 2017.1 2016.2
Version 2023.1 Published 543
Redfish Resource and Schema Guide DSP2046
6.69.1 Description
The schema definition of a memory chunk and its configuration.
6.69.2 URIs
/redfish/v1/Chassis/{ChassisId}/MemoryDomains/{MemoryDomainId}/MemoryChunks/
{MemoryChunksId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
MemoryDomains/{MemoryDomainId}/MemoryChunks/{MemoryChunksId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/MemoryDomains/
{MemoryDomainId}/MemoryChunks/{MemoryChunksId}
/redfish/v1/Systems/{ComputerSystemId}/MemoryDomains/{MemoryDomainId}/MemoryChunks/
{MemoryChunksId}
6.69.3 Properties
Property Type Attributes Notes
AddressRangeOffsetMiB integer read-only
Offset of the memory chunk in the address range in MiB.
(v1.3+) (mebibytes) (null)
read-only
string Memory type of this memory chunk. For the possible property
AddressRangeType required
(enum) values, see AddressRangeType in Property details.
(null)
read-write
DisplayName (v1.4+) string A user-configurable string to name the memory chunk.
(null)
InterleaveSets [ { array The interleave sets for the memory chunk.
Memory { object Describes a memory device of the interleave set.
string
@odata.id read-only The unique identifier for a resource.
(URI)
read-only
MemoryLevel integer Level of the interleave set for multi-level tiered memory.
(null)
integer read-only Offset within the DIMM that corresponds to the start of this
OffsetMiB
(mebibytes) (null) memory region, measured in mebibytes (MiB).
read-only
RegionId string DIMM region identifier.
(null)
544 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
integer read-only
SizeMiB Size of this memory region measured in mebibytes (MiB).
(mebibytes) (null)
}]
read-only An indication of whether memory mirroring is enabled for this
IsMirrorEnabled boolean
(null) memory chunk.
read-only An indication of whether sparing is enabled for this memory
IsSpare boolean
(null) chunk.
Links (v1.3+) { object The links to other resources that are related to this resource.
CXLLogicalDevices An array of links to the CXL logical devices associated with this
array
(v1.5+) [ { memory chunk.
Link to a CXLLogicalDevice resource. See the Links section and
@odata.id string read-only
the CXLLogicalDevice schema for details.
}]
An array of links to the endpoints that connect to this memory
Endpoints (v1.3+) [ { array
chunk.
Link to a Endpoint resource. See the Links section and the
@odata.id string read-only
Endpoint schema for details.
}]
Oem {} object See the Oem object definition in the Common properties section.
The location of the memory media for this memory chunk. For
string read-write
MediaLocation (v1.5+) the possible property values, see MediaLocation in Property
(enum) (null)
details.
integer read-only
MemoryChunkSizeMiB Size of the memory chunk measured in mebibytes (MiB).
(mebibytes) (null)
The requested operational state of this memory chunk. For the
RequestedOperationalState string read-write
possible property values, see RequestedOperationalState in
(v1.5+) (enum) (null)
Property details.
The status and health of the resource and its subordinate or
Status (v1.2+) {} object
dependent resources. For property details, see Status.
Version 2023.1 Published 545
Redfish Resource and Schema Guide DSP2046
6.69.4 Property details
6.69.4.1 AddressRangeType
Memory type of this memory chunk.
string Description
Block Block accessible memory.
PMEM Byte accessible persistent memory.
Volatile Volatile memory.
6.69.4.2 MediaLocation
The location of the memory media for this memory chunk.
string Description
Local The memory chunk was created using local media.
The memory chunk was created using both local media and remote media accessible through
Mixed
a fabric.
Remote The memory chunk was created using remote media accessible through a fabric.
6.69.4.3 RequestedOperationalState
The requested operational state of this memory chunk.
string Description
Memory chunk cannot be used. Consumers of this memory chunk should perform cleanup
Offline
operations as needed to prepare for the removal of this memory chunk.
Online Memory chunk can be used.
546 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.69.5 Example response
{
"@odata.type": "#MemoryChunks.v1_5_0.MemoryChunks",
"Name": "Memory Chunk - Whole System",
"Id": "1",
"MemoryChunkSizeMiB": 32768,
"AddressRangeType": "Volatile",
"IsMirrorEnabled": false,
"IsSpare": false,
"InterleaveSets": [
{
"Memory": {
"@odata.id": "/redfish/v1/Systems/2/Memory/1"
}
},
{
"Memory": {
"@odata.id": "/redfish/v1/Systems/2/Memory/2"
}
},
{
"Memory": {
"@odata.id": "/redfish/v1/Systems/2/Memory/3"
}
},
{
"Memory": {
"@odata.id": "/redfish/v1/Systems/2/Memory/4"
}
}
],
"@Redfish.Settings": {
"@odata.type": "#Settings.v1_3_5.Settings",
"SettingsObject": {
"@odata.id": "/redfish/v1/Systems/2/MemoryDomains/1/MemoryChunks/1/SD"
},
"Time": "2012-03-07T14:44.30-05:00",
"ETag": "someetag",
"Messages": [
{
"MessageId": "Base.1.0.Success"
}
]
},
"@odata.id": "/redfish/v1/Systems/2/MemoryDomains/1/MemoryChunks/1"
}
Version 2023.1 Published 547
Redfish Resource and Schema Guide DSP2046
6.70 MemoryDomain 1.5.0
Version v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.3 2022.1 2019.4 2017.1 2016.3 2016.2
6.70.1 Description
The MemoryDomain schema describes a memory domain and its configuration. Memory domains
indicate to the client which memory, or DIMMs, can be grouped together in memory chunks to
represent addressable memory.
6.70.2 URIs
/redfish/v1/Chassis/{ChassisId}/MemoryDomains/{MemoryDomainId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
MemoryDomains/{MemoryDomainId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/MemoryDomains/
{MemoryDomainId}
/redfish/v1/Systems/{ComputerSystemId}/MemoryDomains/{MemoryDomainId}
6.70.3 Properties
Property Type Attributes Notes
read-only An indication of whether this memory domain supports the
AllowsBlockProvisioning boolean
(null) provisioning of blocks of memory.
read-only An indication of whether this memory domain supports the
AllowsMemoryChunkCreation boolean
(null) creation of memory chunks.
read-only An indication of whether this memory domain supports the
AllowsMirroring (v1.1+) boolean
(null) creation of memory chunks with mirroring enabled.
read-only An indication of whether this memory domain supports the
AllowsSparing (v1.1+) boolean
(null) creation of memory chunks with sparing enabled.
InterleavableMemorySets [ { array The interleave sets for the memory chunk.
MemorySet [ { array The set of memory for a particular interleave set.
Link to a Memory resource. See the Links section and the
@odata.id string read-only
Memory schema for details.
548 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
}]
}]
Links (v1.3+) { object The links to other Resources that are related to this Resource.
CXLLogicalDevices (v1.5+) An array of links to the CXL logical devices associated with this
array
[{ memory domain.
Link to a CXLLogicalDevice resource. See the Links section and
@odata.id string read-only
the CXLLogicalDevice schema for details.
}]
An array of links to the fabric adapters that present this
FabricAdapters (v1.5+) [ { array
memory domain to a fabric.
Link to a FabricAdapter resource. See the Links section and the
@odata.id string read-only
FabricAdapter schema for details.
}]
An array of links to the media controllers for this memory
MediaControllers (v1.3+,
array domain. Deprecated in v1.4 and later. This property has been
deprecated v1.4 [ {
deprecated in favor of the FabricAdapters property.
Link to a MediaController resource. See the Links section and
@odata.id string read-only
the MediaController schema for details.
}]
See the Oem object definition in the Common properties
Oem {} object
section.
An array of links to the PCIe functions representing this
PCIeFunctions (v1.5+) [ { array
memory domain.
Link to a PCIeFunction resource. See the Links section and the
@odata.id string read-only
PCIeFunction schema for details.
}]
MemoryChunkIncrementMiB integer read-only The incremental size, from the minimum size, allowed for a
(v1.5+) (mebibytes) (null) memory chunk within this domain in mebibytes (MiB).
The link to the collection of memory chunks associated with
MemoryChunks { object
this memory domain. Contains a link to a resource.
Version 2023.1 Published 549
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to Collection of MemoryChunks. See the MemoryChunks
@odata.id string read-only
schema for details.
integer read-only
MemorySizeMiB (v1.5+) The total size of the memory domain in mebibytes (MiB).
(mebibytes) (null)
MinMemoryChunkSizeMiB integer read-only The minimum size allowed for a memory chunk within this
(v1.5+) (mebibytes) (null) domain in mebibytes (MiB).
The status and health of the resource and its subordinate or
Status (v1.5+) {} object
dependent resources. For property details, see Status.
6.70.4 Example response
{
"@odata.type": "#MemoryDomain.v1_5_0.MemoryDomain",
"Name": "Memory Domain - Whole System Mirroring Only",
"Id": "1",
"MemoryChunks": {
"@odata.id": "/redfish/v1/Systems/4/MemoryDomains/1/MemoryChunks"
},
"AllowsMemoryChunkCreation": false,
"AllowsBlockProvisioning": false,
"InterleavableMemorySets": [
{
"MemorySet": [
{
"@odata.id": "/redfish/v1/Systems/2/Memory/1"
},
{
"@odata.id": "/redfish/v1/Systems/2/Memory/2"
},
{
"@odata.id": "/redfish/v1/Systems/2/Memory/3"
},
{
"@odata.id": "/redfish/v1/Systems/2/Memory/4"
}
]
}
],
"@odata.id": "/redfish/v1/Systems/2/MemoryDomains/1"
}
550 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.71 MemoryMetrics 1.7.0
Version v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2023.1 2022.3 2022.1 2020.3 2020.1 2019.2 2016.2 2016.1
6.71.1 Description
The usage and health statistics for a memory device or system memory summary.
6.71.2 URIs
/redfish/v1/Chassis/{ChassisId}/Memory/{MemoryId}/MemoryMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/
MemoryMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/
MemorySummary/MemoryMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Memory/{MemoryId}/MemoryMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
MemorySummary/MemoryMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}/MemorySummary/MemoryMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/MemoryMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/MemorySummary/
MemoryMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory/{MemoryId}/
MemoryMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/MemorySummary/
MemoryMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/
{ProcessorId}/MemorySummary/MemoryMetrics
/redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}/MemoryMetrics
/redfish/v1/Systems/{ComputerSystemId}/MemorySummary/MemoryMetrics
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/MemorySummary/MemoryMetrics
Version 2023.1 Published 551
Redfish Resource and Schema Guide DSP2046
6.71.3 Properties
Property Type Attributes Notes
number read-only
BandwidthPercent (v1.2+) The memory bandwidth utilization as a percentage.
(%) (null)
integer read-only
BlockSizeBytes The block size, in bytes.
(bytes) (null)
number read-only
CapacityUtilizationPercent (v1.7+) The memory capacity utilization as a percentage.
(%) (null)
read-only The number of corrected errors in persistent
CorrectedPersistentErrorCount (v1.6+) integer
(null) memory.
read-only
CorrectedVolatileErrorCount (v1.6+) integer The number of corrected errors in volatile memory.
(null)
The memory metrics since the last reset or
CurrentPeriod { object
ClearCurrentPeriod action.
read-only
BlocksRead integer The number of blocks read since reset.
(null)
read-only
BlocksWritten integer The number of blocks written since reset.
(null)
read-only
CorrectableECCErrorCount (v1.4+) integer The number of the correctable errors since reset.
(null)
IndeterminateCorrectableErrorCount read-only The number of indeterminate correctable errors
integer
(v1.5+) (null) since reset.
IndeterminateUncorrectableErrorCount read-only The number of indeterminate uncorrectable errors
integer
(v1.5+) (null) since reset.
read-only
UncorrectableECCErrorCount (v1.4+) integer The number of the uncorrectable errors since reset.
(null)
CXL (v1.6+) { object The memory metrics specific to CXL devices.
(null)
The conditions that would generate an alert to the
AlertCapabilities (v1.6+) { object
(null) CXL Fabric Manager or host.
read-only Indicates whether correctable ECC errors generate
CorrectableECCError (v1.6+) boolean
(null) an alert to the CXL Fabric Manager or host.
552 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only Indicates whether spare block conditions generate
SpareBlock (v1.6+) boolean
(null) an alert to the CXL Fabric Manager or host.
read-only Indicates whether temperature conditions generate
Temperature (v1.6+) boolean
(null) an alert to the CXL Fabric Manager or host.
Indicates whether uncorrectable ECC errors
read-only
UncorrectableECCError (v1.6+) boolean generate an alert to the CXL Fabric Manager or
(null)
host.
read-only The number of shutdowns while outstanding writes
DirtyShutdownCount (v1.6+) integer
(null) have not completed to persistent memory.
HealthData { object The health information of the memory.
AlarmTrips { object Alarm trip information about the memory.
read-only An indication of whether an address parity error
AddressParityError boolean
(null) was detected that a retry could not correct.
read-only An indication of whether the correctable error
CorrectableECCError boolean
(null) threshold crossing alarm trip was detected.
read-only An indication of whether the spare block capacity
SpareBlock boolean
(null) crossing alarm trip was detected.
read-only An indication of whether a temperature threshold
Temperature boolean
(null) alarm trip was detected.
read-only An indication of whether the uncorrectable error
UncorrectableECCError boolean
(null) threshold alarm trip was detected.
read-only
DataLossDetected boolean An indication of whether data loss was detected.
(null)
read-only An indication of whether the last shutdown
LastShutdownSuccess boolean
(null) succeeded.
read-only An indication of whether performance has
PerformanceDegraded boolean
(null) degraded.
number read-only The percentage of reads and writes that are
PredictedMediaLifeLeftPercent (v1.1+)
(%) (null) predicted to still be available for the media.
Version 2023.1 Published 553
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
number read-only
RemainingSpareBlockPercentage The remaining spare blocks, as a percentage.
(%) (null)
LifeTime { object The memory metrics for the lifetime of the memory.
read-only The number of blocks read for the lifetime of the
BlocksRead integer
(null) memory.
read-only The number of blocks written for the lifetime of the
BlocksWritten integer
(null) memory.
read-only The number of the correctable errors for the
CorrectableECCErrorCount (v1.4+) integer
(null) lifetime of the memory.
IndeterminateCorrectableErrorCount read-only The number of indeterminate correctable errors for
integer
(v1.5+) (null) the lifetime of the memory.
IndeterminateUncorrectableErrorCount read-only The number of indeterminate uncorrectable errors
integer
(v1.5+) (null) for the lifetime of the memory.
read-only The number of the uncorrectable errors for the
UncorrectableECCErrorCount (v1.4+) integer
(null) lifetime of the memory.
integer read-only Operating speed of memory in MHz or MT/s as
OperatingSpeedMHz (v1.3+)
(MHz) (null) appropriate.
6.71.4 Actions
6.71.4.1 ClearCurrentPeriod
Description
This action sets the CurrentPeriod property's values to 0.
Action URI
{Base URI of target resource}/Actions/MemoryMetrics.ClearCurrentPeriod
Action parameters
This action takes no parameters.
554 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.71.5 Example response
{
"@odata.type": "#MemoryMetrics.v1_7_0.MemoryMetrics",
"Name": "Memory Metrics",
"Id": "Metrics",
"BlockSizeBytes": 4096,
"CurrentPeriod": {
"BlocksRead": 0,
"BlocksWritten": 0
},
"LifeTime": {
"BlocksRead": 0,
"BlocksWritten": 0
},
"HealthData": {
"RemainingSpareBlockPercentage": 50,
"LastShutdownSuccess": true,
"DataLossDetected": false,
"PerformanceDegraded": false,
"AlarmTrips": {
"Temperature": true,
"SpareBlock": false,
"UncorrectableECCError": false,
"CorrectableECCError": false
}
},
"Actions": {
"#MemoryMetrics.ClearCurrentPeriod": {
"target": "/redfish/v1/Systems/1/Memory/1/Actions/MemoryMetrics.ClearCurrentPeriod"
}
},
"@odata.id": "/redfish/v1/Systems/1/Memory/1/MemoryMetrics"
}
6.72 MessageRegistry 1.6.0
Version v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.3 2021.3 2020.1 2019.1 2018.2 2017.1 1.0
Version 2023.1 Published 555
Redfish Resource and Schema Guide DSP2046
6.72.1 Description
The MessageRegistry schema describes all message registries. It represents the properties for the
message registries themselves.
6.72.2 Properties
Property Type Attributes Notes
read-only The RFC5646-conformant language code for the message
Language string
required registry.
Messages { object required The message keys contained in the message registry.
Property names follow regular expression pattern "[A-Za-
(pattern) { object
z0-9]+"
array
ArgDescriptions (v1.3+) [
(string, read-only The MessageArg descriptions, in order, used for this message.
]
null)
array
ArgLongDescriptions The MessageArg normative descriptions, in order, used for
(string, read-only
(v1.3+) [ ] this message.
null)
The clearing logic associated with this message. The
ClearingLogic (v1.2+) { object properties within indicate that what messages are cleared by
this message as well as under what conditions.
read-only An indication of whether all prior conditions and messages are
ClearsAll (v1.2+) boolean
(null) cleared, provided the ClearsIf condition is met.
string read-only The condition when the event is cleared. For the possible
ClearsIf (v1.2+)
(enum) (null) property values, see ClearsIf in Property details.
array
ClearsMessage The array of MessageIds that this message clears when the
(string, read-only
(v1.2+) [ ] other conditions are met.
null)
read-only
Deprecated (v1.5+) string The reason the message has been deprecated.
(null)
read-only
Description string A short description of how and when to use this message.
required
read-only
LongDescription (v1.3+) string The normative language that describes this message's usage.
(null)
556 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
array
MapsToGeneralMessages The general or less-specific messages related to this
(string, read-only
(v1.6+) [ ] message.
null)
read-only
Message string The actual message.
required
read-only
string The severity of the message. For the possible property values,
MessageSeverity (v1.4+) required
(enum) see MessageSeverity in Property details.
(null)
read-only
NumberOfArgs integer The number of arguments in the message.
required
See the Oem object definition in the Common properties
Oem {} object
section.
array
The MessageArg types, in order, for the message. For the
ParamTypes [ ] (string read-only
possible property values, see ParamTypes in Property details.
(enum))
read-only
ReplacedBy (v1.6+) string The message identifier that replaces this message.
(null)
read-only Used to provide suggestions on how to resolve the situation
Resolution string
required that caused the error.
The severity of the message. Deprecated in v1.4 and later.
read-only This property has been deprecated in favor of
Severity (deprecated v1.4) string
required MessageSeverity, which ties the values to the enumerations
defined for the Health property within Status.
read-only
VersionAdded (v1.5+) string The registry version which added this message.
(null)
VersionDeprecated read-only
string The registry version when the the message was deprecated.
(v1.5+) (null)
read-only The organization or company that publishes this message
OwningEntity string
required registry.
read-only The single-word prefix that is used in forming and decoding
RegistryPrefix string
required MessageIds.
read-only The message registry version in the middle portion of a
RegistryVersion string
required MessageId.
Version 2023.1 Published 557
Redfish Resource and Schema Guide DSP2046
6.72.3 Property details
6.72.3.1 ClearsIf
The condition when the event is cleared.
string Description
This enumeration shall describe when the message for an event is cleared by the other
SameOriginOfCondition messages in the ClearingLogic property, provided the OriginOfCondition for both events are
the same.
6.72.3.2 MessageSeverity
The severity of the message.
string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.
6.72.3.3 ParamTypes
The MessageArg types, in order, for the message.
string Description
number The argument is a number.
string The argument is a string.
6.72.4 Example response
{
"@odata.type": "#MessageRegistry.v1_3_1.MessageRegistry",
"Id": "Basic.1.2.0",
"Name": "Simple Message Registry",
558 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"Language": "en",
"Description": "Collection of Basic messages for numerous use cases",
"RegistryPrefix": "Basic",
"RegistryVersion": "1.2.0",
"OwningEntity": "Contoso",
"Messages": {
"Success": {
"Description": "Indicates that all conditions of a successful operation have been met.",
"Message": "Successfully Completed Request",
"Severity": "OK",
"NumberOfArgs": 0,
"Resolution": "None"
},
"GeneralError": {
"Description": "Indicates that a general error has occurred.",
"Message": "A general error has occurred. See ExtendedInfo for more information.",
"Severity": "Critical",
"NumberOfArgs": 0,
"Resolution": "See ExtendedInfo for more information."
},
"ResourceAtUriUnauthorized": {
"Description": "Indicates that the attempt to access the resource/file/image at the URI was unauthorize
"Message": "While accessing the resource at %1, the service received an authorization error %2.",
"Severity": "Critical",
"NumberOfArgs": 2,
"ParamTypes": [
"string",
"string"
],
"Resolution": "Ensure that the appropriate access is provided for the service in order for it to access
}
}
}
6.73 MessageRegistryFile 1.1.3
Version v1.1 v1.0
Release 2017.1 2016.1
6.73.1 Description
The MessageRegistryFile schema describes the Message Registry file locator Resource.
Version 2023.1 Published 559
Redfish Resource and Schema Guide DSP2046
6.73.2 URIs
/redfish/v1/Registries/{MessageRegistryFileId}
6.73.3 Properties
Property Type Attributes Notes
array read-only The RFC5646-conformant language codes for the available Message
Languages [ ]
(string) required Registries.
Location [ { array required The location information for this Message Registry file.
If the service hosts the Message Registry in an archive file, the name of the
ArchiveFile string read-only
file within the archive.
string If the Message Registry is hosted on the service in an archive file, the link
ArchiveUri read-only
(URI) to the archive file.
Language string read-only The language code for the Message Registry file.
string
PublicationUri read-only The link to publicly available (canonical) URI for the Message Registry.
(URI)
string
Uri read-only The link to locally available URI for the Message Registry.
(URI)
}]
The registry name and its major and minor versions. This registry can be
read-only
Registry string any type of registry, such as a Message Registry, Privilege Registry, or
required
Attribute Registry.
6.73.4 Example response
{
"@odata.type": "#MessageRegistryFile.v1_1_3.MessageRegistryFile",
"Id": "Base.1.0.0",
"Name": "Base Message Registry File",
"Description": "Base Message Registry File locations",
"Languages": [
"en"
],
"Registry": "Base.1.0",
"Location": [
{
560 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"Language": "en",
"ArchiveUri": "/FileRepo/Registries.gz",
"PublicationUri": "http://redfish.dmtf.org/registries/v1/Base.1.0.0.json",
"ArchiveFile": "Base.1.0.0.json"
},
{
"Language": "zh",
"ArchiveUri": "/FileRepo/Registries.zh.gz",
"PublicationUri": "http://redfish.dmtf.org/registries/v1/zh/Base.1.0.0.zh.json",
"ArchiveFile": "Base.1.0.0.zh.json"
}
],
"@odata.id": "/redfish/v1/Registries/Base.1.0.0"
}
6.74 MetricDefinition 1.3.2
Version v1.3 v1.2 v1.1 v1.0
Release 2022.1 2021.1 2020.3 2018.2
6.74.1 Description
The MetricDefinition schema describes the metadata information for a metric.
6.74.2 URIs
/redfish/v1/TelemetryService/MetricDefinitions/{MetricDefinitionId}
6.74.3 Properties
Property Type Attributes Notes
read-only
Accuracy number The estimated percent error of measured versus actual values.
(null)
string read-write An indication of whether the metric can be used in a calculation. For
Calculable
(enum) (null) the possible property values, see Calculable in Property details.
The calculation that is performed on a source metric to obtain the
string read-only
CalculationAlgorithm metric being defined. For the possible property values, see
(enum) (null)
CalculationAlgorithm in Property details.
Version 2023.1 Published 561
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
CalculationParameters [ The metric properties that are part of a calculation that this metric
array
{ definition defines.
The URI with wildcards and property identifiers of the metric
read-only property that stores the result of the calculation. If the URI has
ResultMetric string
(null) wildcards, the wildcards are substituted as specified in the
Wildcards property.
The URI with wildcards and property identifiers of the metric
read-only property used as the input into the calculation. If the URI has
SourceMetric string
(null) wildcards, the wildcards are substituted as specified in the
Wildcards property.
}]
string read-write
CalculationTimeInterval The time interval over which the metric calculation is performed.
(duration) (null)
read-only
Calibration number The calibration offset added to the metric reading.
(null)
array
DiscreteValues [ ] (string, read-write This array property specifies possible values of a discrete metric.
null)
string read-only The implementation of the metric. For the possible property values,
Implementation
(enum) (null) see Implementation in Property details.
read-write An indication of whether the metric values are linear versus non-
IsLinear boolean
(null) linear.
array
LogicalContexts (v1.3+) [ The logical contexts related to the metric. For the possible property
(string read-only
] values, see LogicalContexts in Property details.
(enum))
read-only
MaxReadingRange number Maximum value for metric reading.
(null)
string read-write The data type of the metric. For the possible property values, see
MetricDataType
(enum) (null) MetricDataType in Property details.
array
The list of URIs with wildcards and property identifiers that this
(URI)
MetricProperties [ ] read-write metric definition defines. If a URI has wildcards, the wildcards are
(string,
substituted as specified in the Wildcards property.
null)
string read-write The type of metric. For the possible property values, see MetricType
MetricType
(enum) (null) in Property details.
read-only
MinReadingRange number Minimum value for metric reading.
(null)
562 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
OEMCalculationAlgorithm read-only The OEM-defined calculation that is performed on a source metric to
string
(v1.1+) (null) obtain the metric being defined.
string read-only The physical context of the metric. For the possible property values,
PhysicalContext
(enum) (null) see PhysicalContext in Property details.
read-only
Precision integer Number of significant digits in the metric reading.
(null)
string read-write
SensingInterval The time interval between when a metric is updated.
(duration) (null)
string read-only
TimestampAccuracy The accuracy of the timestamp.
(duration) (null)
read-write
Units string The units of measure for this metric.
(null)
The wildcards and their substitution values for the entries in the
Wildcards [ { array
MetricProperties array property.
read-only
Name string The string used as a wildcard.
(null)
array
Values [ ] (string, read-only An array of values to substitute for the wildcard.
null)
}]
6.74.4 Property details
6.74.4.1 Calculable
An indication of whether the metric can be used in a calculation.
string Description
NonCalculatable No calculations should be performed on the metric reading.
NonSummable The sum of the metric reading across multiple instances is not meaningful.
Summable The sum of the metric reading across multiple instances is meaningful.
Version 2023.1 Published 563
Redfish Resource and Schema Guide DSP2046
6.74.4.2 CalculationAlgorithm
The calculation that is performed on a source metric to obtain the metric being defined.
string Description
Average The metric is calculated as the average metric reading over a sliding time interval.
Maximum The metric is calculated as the maximum metric reading over during a time interval.
Minimum The metric is calculated as the minimum metric reading over a sliding time interval.
OEM (v1.1+) The metric is calculated as specified by an OEM.
6.74.4.3 Implementation
The implementation of the metric.
string Description
The metric is implemented by applying a calculation on another metric property. The
Calculated
calculation is specified in the CalculationAlgorithm property.
DigitalMeter The metric is implemented as digital meter.
PhysicalSensor The metric is implemented as a physical sensor.
The metric is implemented by applying a calculation on one or more metric properties. The
Synthesized
calculation is not provided.
6.74.4.4 LogicalContexts
The logical contexts related to the metric.
string Description
Capacity Capacity related logical context.
Environment Environment related logical context.
Network Network related logical context.
Performance Performance related logical context.
Security Security related logical context.
564 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Storage Storage related logical context.
6.74.4.5 MetricDataType
The data type of the metric.
string Description
Boolean The JSON boolean definition.
DateTime The JSON string definition with the date-time format.
Decimal The JSON decimal definition.
Enumeration The JSON string definition with a set of defined enumerations.
Integer The JSON integer definition.
String The JSON string definition.
6.74.4.6 MetricType
The type of metric.
string Description
The metric is a countdown metric. The metric reading is a non-negative integer that
Countdown decreases monotonically. When a counter reaches its minimum, the value resets to preset
value and resumes counting down.
The metric is a counter metric. The metric reading is a non-negative integer that increases
Counter monotonically. When a counter reaches its maximum, the value resets to 0 and resumes
counting.
The metric is a discrete metric. The metric value is discrete. The possible values are listed in
Discrete
the DiscreteValues property.
The metric is a gauge metric. The metric value is a real number. When the metric value
Gauge
reaches the gauge's extrema, it stays at that value, until the reading falls within the extrema.
Numeric The metric is a numeric metric. The metric value is any real number.
The metric is a non-discrete string metric. The metric reading is a non-discrete string that
String (v1.2+)
displays some non-discrete, non-numeric data.
Version 2023.1 Published 565
Redfish Resource and Schema Guide DSP2046
6.74.4.7 PhysicalContext
The physical context of the metric.
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
GPU A graphics processor (GPU).
566 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
StorageBay Within a storage bay.
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
Version 2023.1 Published 567
Redfish Resource and Schema Guide DSP2046
6.74.5 Example response
{
"@odata.type": "#MetricDefinition.v1_3_2.MetricDefinition",
"Id": "PowerConsumedWatts",
"Name": "Power Consumed Watts Metric Definition",
"MetricType": "Numeric",
"Implementation": "PhysicalSensor",
"PhysicalContext": "PowerSupply",
"MetricDataType": "Decimal",
"Units": "W",
"Precision": 4,
"Accuracy": 1,
"Calibration": 2,
"MinReadingRange": 0,
"MaxReadingRange": 50,
"SensingInterval": "PT1S",
"TimestampAccuracy": "PT1S",
"Wildcards": [
{
"Name": "ChassisID",
"Values": [
"1"
]
}
],
"MetricProperties": [
"/redfish/v1/Chassis/{ChassisID}/Power#/PowerControl/0/PowerConsumedWatts"
],
"@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/PowerConsumedWatts"
}
6.75 MetricReport 1.5.0
Version v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.2 2020.2 2019.4 2019.2 2018.3 2018.2
6.75.1 Description
The MetricReport schema represents a set of collected metrics.
568 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.75.2 URIs
/redfish/v1/TelemetryService/MetricReports/{MetricReportId}
6.75.3 Properties
Property Type Attributes Notes
A context can be supplied at subscription time. This property is the
Context (v1.4+) string read-only
context value supplied by the subscriber.
MetricReportDefinition The link to the definition of this metric report. See the
object
{ MetricReportDefinition schema for details on this property.
Link to a MetricReportDefinition resource. See the Links section and
@odata.id string read-only
the MetricReportDefinition schema for details.
MetricValues [ { array An array of metric values for the metered items of this metric report.
The link to the metric definition for this metric. See the
MetricDefinition MetricDefinition schema for details on this property. Deprecated in
object
(deprecated v1.5) { v1.5 and later. This property has been deprecated in favor of the
MetricId property.
Link to a MetricDefinition resource. See the Links section and the
@odata.id string read-only
MetricDefinition schema for details.
read-only The metric definitions identifier that contains additional information
MetricId string
(null) for the source metric.
string read-only
MetricProperty The URI for the property from which this metric is derived.
(URI) (null)
read-only
MetricValue string The metric value, as a string.
(null)
Oem (v1.2+) {} object See the Oem object definition in the Common properties section.
The date and time when the metric is obtained. A management
string read-only application can establish a time series of metric data by retrieving the
Timestamp
(date-time) (null) instances of metric value and sorting them according to their
timestamp.
}]
Version 2023.1 Published 569
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The current sequence identifier for this metric report. Deprecated in
ReportSequence
string read-only v1.3 and later. This property has been deprecated due to specification
(deprecated v1.3)
changes with regards to Server-Sent Events.
The time associated with the metric report in its entirety. The time of
string read-only
Timestamp (v1.1+) the metric report can be relevant when the time of individual metrics
(date-time) (null)
are minimally different.
6.75.4 Example response
{
"@odata.type": "#MetricReport.v1_5_0.MetricReport",
"Id": "AvgPlatformPowerUsage",
"Name": "Average Platform Power Usage metric report",
"MetricReportDefinition": {
"@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions/AvgPlatformPowerUsage"
},
"MetricValues": [
{
"MetricId": "AverageConsumedWatts",
"MetricValue": "100",
"Timestamp": "2016-11-08T12:25:00-05:00",
"MetricProperty": "/redfish/v1/Chassis/Tray_1/Power#/0/PowerConsumedWatts"
},
{
"MetricId": "AverageConsumedWatts",
"MetricValue": "94",
"Timestamp": "2016-11-08T13:25:00-05:00",
"MetricProperty": "/redfish/v1/Chassis/Tray_1/Power#/0/PowerConsumedWatts"
},
{
"MetricId": "AverageConsumedWatts",
"MetricValue": "100",
"Timestamp": "2016-11-08T14:25:00-05:00",
"MetricProperty": "/redfish/v1/Chassis/Tray_1/Power#/0/PowerConsumedWatts"
}
],
"@odata.id": "/redfish/v1/TelemetryService/MetricReports/AvgPlatformPowerUsage"
}
6.76 MetricReportDefinition 1.4.3
Version v1.4 v1.3 v1.2 v1.1 v1.0
570 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Release 2020.4 2019.2 2019.1 2018.3 2018.2
6.76.1 Description
The MetricReportDefinition schema describes set of metrics that are collected into a metric report.
6.76.2 URIs
/redfish/v1/TelemetryService/MetricReportDefinitions/{MetricReportDefinitionId}
6.76.3 Properties
Property Type Attributes Notes
The maximum number of entries that can be appended to a
AppendLimit integer read-only metric report. When the metric report reaches its limit, its
behavior is dictated by the ReportUpdates property.
Links (v1.2+) { object The links to other resources that are related to this resource.
See the Oem object definition in the Common properties
Oem {} object
section.
The triggers that cause this metric report definition to
Triggers (v1.2+) [ { array generate a new metric report upon a trigger occurrence when
the TriggerActions property contains RedfishMetricReport .
Link to a Triggers resource. See the Links section and the
@odata.id string read-only
Triggers schema for details.
}]
array The list of URIs with wildcards and property identifiers to
(URI) include in the metric report. If a URI has wildcards, the
MetricProperties [ ] read-write
(string, wildcards are substituted as specified in the Wildcards
null) property.
The most recent metric report produced by this metric report
MetricReport { object definition. See the MetricReport schema for details on this
property.
Link to a MetricReport resource. See the Links section and the
@odata.id string read-only
MetricReport schema for details.
Version 2023.1 Published 571
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
MetricReportDefinitionEnabled read-write An indication of whether the generation of new metric reports
boolean
(v1.2+) (null) is enabled.
Specifies when the metric report is generated. For the possible
string read-write
MetricReportDefinitionType property values, see MetricReportDefinitionType in Property
(enum) (null)
details.
The interval at which to send the complete metric report
because the Redfish client wants refreshed metric data even
MetricReportHeartbeatInterval string read-write when the data has not changed. This property value is always
(v1.2+) (duration) (null) greater than the recurrence interval of a metric report, and it
only applies when the SuppressRepeatedMetricValue property
is true .
The list of metrics to include in the metric report. The metrics
Metrics [ { array
may include calculations to apply to metric properties.
string read-write
CollectionDuration The duration over which the function is computed.
(duration) (null)
Specifies the function to perform on each of the metric
properties listed in the MetricProperties property or the metric
string read-write properties specified in the MetricDefinition referenced by the
CollectionFunction
(enum) (null) MetricId property. If not specified, calculations are not
performed on the metric properties. For the possible property
values, see CollectionFunction in Property details.
The scope of time over which the function is applied. For the
string read-write
CollectionTimeScope possible property values, see CollectionTimeScope in Property
(enum) (null)
details.
read-write The metric definition identifier that contains the metric
MetricId string
(null) properties to include in the metric report.
array The list of URIs with wildcards and property identifiers to
(URI) include in the metric report. If a URI has wildcards, the
MetricProperties [ ] read-write
(string, wildcards are substituted as specified in the Wildcards
null) property.
See the Oem object definition in the Common properties
Oem (v1.4+) {} object
section.
}]
array The set of actions to perform when a metric report is
ReportActions [ ] (string read-write generated. For the possible property values, see ReportActions
(enum)) in Property details.
string read-write
ReportTimespan (v1.3+) The maximum timespan that a metric report can cover.
(duration) (null)
572 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The behavior for how subsequent metric reports are handled in
relationship to an existing metric report created from the
string
ReportUpdates read-write metric report definition. Namely, whether to overwrite,
(enum)
append, or create a metric report. For the possible property
values, see ReportUpdates in Property details.
The schedule for generating the metric report. For property
Schedule {} object
details, see Schedule.
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
An indication of whether any metrics are suppressed from the
generated metric report. If true , any metric that equals the
same value in the previously generated metric report is
SuppressRepeatedMetricValue read-write suppressed from the current report. Also, duplicate metrics are
boolean
(v1.2+) (null) suppressed. If false , no metrics are suppressed from the
current report. The current report may contain no metrics if all
metrics equal the values in the previously generated metric
report.
The set of wildcards and their substitution values for the
Wildcards [ { array
entries in the MetricProperties property.
array An array of values to substitute for the wildcard. Deprecated in
Keys (deprecated v1.1) [ ] (string, read-write v1.1 and later. This property has been deprecated in favor of
null) using the property Values.
read-write
Name string The string used as a wildcard.
(null)
array
Values (v1.1+) [ ] (string, read-write An array of values to substitute for the wildcard.
null)
}]
6.76.4 Property details
6.76.4.1 CollectionFunction
Specifies the function to perform on each of the metric properties listed in the MetricProperties
property or the metric properties specified in the MetricDefinition referenced by the MetricId property.
If not specified, calculations are not performed on the metric properties.
Version 2023.1 Published 573
Redfish Resource and Schema Guide DSP2046
string Description
Average The metric is calculated as the average metric reading over a duration.
Maximum The metric is calculated as the maximum metric reading over a duration.
Minimum The metric is calculated as the minimum metric reading over a duration.
Summation The metric is calculated as the sum of the values over a duration.
6.76.4.2 CollectionTimeScope
The scope of time over which the function is applied.
string Description
The corresponding metric values apply to a time interval. On the corresponding metric value
Interval instances, the Timestamp property value in the metric report specifies the end of the time
interval and the CollectionDuration property specifies its duration.
The corresponding metric values apply to a point in time. On the corresponding metric value
Point
instances, the Timestamp property value in the metric report specifies the point in time.
The corresponding metric values apply to a time interval that began at the startup of the
measured resource. On the corresponding metric value instances, the Timestamp property
StartupInterval
value in the metric report shall specifies the end of the time interval. The CollectionDuration
property value specifies the duration between the startup of resource and timestamp.
6.76.4.3 MetricReportDefinitionType
Specifies when the metric report is generated.
string Description
OnChange The metric report is generated when any of the metric values change.
OnRequest The metric report is generated when a HTTP GET is performed on the specified metric report.
Periodic The metric report is generated at a periodic time interval, specified in the Schedule property.
6.76.4.4 ReportActions
The set of actions to perform when a metric report is generated.
574 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
LogToMetricReportsCollection Record the occurrence to the metric report collection.
RedfishEvent Send a Redfish event message containing the metric report.
6.76.4.5 ReportUpdates
The behavior for how subsequent metric reports are handled in relationship to an existing metric
report created from the metric report definition. Namely, whether to overwrite, append, or create a
metric report.
string Description
New information is appended to the metric report. The service stops adding entries when the
AppendStopsWhenFull
metric report has reached its maximum capacity.
New information is appended to the metric report. The metric report entries are overwritten
AppendWrapsWhenFull
with new entries when the metric report has reached its maximum capacity.
A new metric report is created, whose identifier is a service-defined identifier concatenated
NewReport
with the timestamp.
Overwrite Overwrite the metric report.
6.76.5 Example response
{
"@odata.type": "#MetricReportDefinition.v1_4_3.MetricReportDefinition",
"Id": "PlatformPowerUsage",
"Name": "Transmit and Log Platform Power Usage",
"MetricReportDefinitionType": "Periodic",
"Schedule": {
"RecurrenceInterval": "PT1H"
},
"ReportActions": [
"RedfishEvent",
"LogToMetricReportsCollection"
],
"ReportUpdates": "AppendWrapsWhenFull",
"AppendLimit": 256,
"MetricReport": {
"@odata.id": "/redfish/v1/TelemetryService/MetricReports/PlatformPowerUsage"
},
"Status": {
Version 2023.1 Published 575
Redfish Resource and Schema Guide DSP2046
"State": "Enabled"
},
"Wildcards": [
{
"Name": "PWild",
"Values": [
"0"
]
},
{
"Name": "TWild",
"Values": [
"Tray_1",
"Tray_2"
]
}
],
"MetricProperties": [
"/redfish/v1/Chassis/{TWild}/Power#/PowerControl/{PWild}/PowerConsumedWatts"
],
"@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions/PlatformPowerUsage"
}
6.77 NetworkAdapter 1.9.0
Version v1.9 v1.8 v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2021.4 2021.2 2021.1 2020.4 2020.3 2020.2 2019.2 2018.2 2017.3 2016.3
6.77.1 Description
The NetworkAdapter schema represents a physical network adapter capable of connecting to a
computer network. Examples include but are not limited to Ethernet, Fibre Channel, and converged
network adapters.
6.77.2 URIs
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}
576 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.77.3 Properties
Property Type Attributes Notes
The link to the assembly resource associated with this
Assembly (v1.1+) { object adapter. See the Assembly schema for details on this
property.
Link to a Assembly resource. See the Links section and
@odata.id string read-only
the Assembly schema for details.
The link to a collection of certificates for device
Certificates (v1.6+) { object
identity and attestation. Contains a link to a resource.
Link to Collection of Certificate. See the Certificate
@odata.id string read-only
schema for details.
The set of network controllers ASICs that make up this
Controllers [ { array
NetworkAdapter.
ControllerCapabilities { object The capabilities of this controller.
DataCenterBridging { object Data center bridging (DCB) for this controller.
read-only An indication of whether this controller is capable of
Capable boolean
(null) data center bridging (DCB).
read-only The maximum number of physical functions available
NetworkDeviceFunctionCount integer
(null) on this controller.
read-only
NetworkPortCount integer The number of physical ports on this controller.
(null)
NPAR (v1.2+) { object NIC Partitioning (NPAR) capabilities for this controller.
read-only An indication of whether the controller supports NIC
NparCapable (v1.2+) boolean
(null) function partitioning.
read-write An indication of whether NIC function partitioning is
NparEnabled (v1.2+) boolean
(null) active on this controller.
N_Port ID Virtualization (NPIV) capabilities for this
NPIV { object
controller.
Version 2023.1 Published 577
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The maximum number of N_Port ID Virtualization
read-only
MaxDeviceLogins integer (NPIV) logins allowed simultaneously from all ports on
(null)
this controller.
The maximum number of N_Port ID Virtualization
read-only
MaxPortLogins integer (NPIV) logins allowed per physical port on this
(null)
controller.
VirtualizationOffload { object Virtualization offload for this controller.
Single-root input/output virtualization (SR-IOV)
SRIOV { object
capabilities.
An indication of whether this controller supports single
read-only
SRIOVVEPACapable boolean root input/output virtualization (SR-IOV) in Virtual
(null)
Ethernet Port Aggregator (VEPA) mode.
VirtualFunction { object The virtual function of the controller.
read-only The maximum number of virtual functions supported
DeviceMaxCount integer
(null) by this controller.
The minimum number of virtual functions that can be
read-only
MinAssignmentGroupSize integer allocated or moved between physical functions for this
(null)
controller.
read-only The maximum number of virtual functions supported
NetworkPortMaxCount integer
(null) per network port for this controller.
read-only
FirmwarePackageVersion string The version of the user-facing firmware package.
(null)
array The durable names for the network adapter controller.
Identifiers (v1.3+) [ { } ]
(object) For property details, see Identifier.
The links to other resources that are related to this
Links { object
resource.
An array of links to the network device functions
NetworkDeviceFunctions [ { array
associated with this network controller.
578 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to a NetworkDeviceFunction resource. See the
@odata.id string read-only Links section and the NetworkDeviceFunction schema
for details.
}]
An array of links to the network ports associated with
NetworkPorts (deprecated v1.5) [ this network controller. Deprecated in v1.5 and later.
array
{ This property has been deprecated in favor of the Ports
property.
Link to a NetworkPort resource. See the Links section
@odata.id string read-only
and the NetworkPort schema for details.
}]
See the Oem object definition in the Common
Oem {} object
properties section.
An array of links to the PCIe devices associated with
PCIeDevices [ { array
this network controller.
Link to a PCIeDevice resource. See the Links section
@odata.id string read-only
and the PCIeDevice schema for details.
}]
An array of links to the ports associated with this
Ports (v1.5+) [ { array
network controller.
Link to a Port resource. See the Links section and the
@odata.id string read-only
Port schema for details.
}]
The location of the network adapter controller. For
Location (v1.1+) {} object
property details, see Location.
PCIeInterface (v1.2+) { object The PCIe interface details for this controller.
read-only
LanesInUse (v1.3+) integer The number of PCIe lanes in use by this device.
(null)
read-only
MaxLanes (v1.3+) integer The number of PCIe lanes supported by this device.
(null)
The highest version of the PCIe specification supported
string read-only
MaxPCIeType (v1.3+) by this device. For the possible property values, see
(enum) (null)
MaxPCIeType in Property details.
Version 2023.1 Published 579
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
See the Oem object definition in the Common
Oem (v1.3+) {} object
properties section.
The version of the PCIe specification in use by this
string read-only
PCIeType (v1.3+) device. For the possible property values, see PCIeType
(enum) (null)
in Property details.
}]
The link to the environment metrics for this network
EnvironmentMetrics (v1.7+) { object adapter. See the EnvironmentMetrics schema for
details on this property.
Link to a EnvironmentMetrics resource. See the Links
@odata.id string read-only section and the EnvironmentMetrics schema for
details.
array The durable names for the network adapter. For
Identifiers (v1.4+) [ { } ]
(object) property details, see Identifier.
LLDPEnabled (v1.7+) boolean read-write Enable or disable LLDP globally for an adapter.
The location of the network adapter. For property
Location (v1.4+) {} object
details, see Location.
read-only
Manufacturer string The manufacturer or OEM of this network adapter.
(null)
An array of DSP0274-defined measurement blocks.
Measurements (v1.6+, deprecated v1.9 [ Deprecated in v1.9 and later. This property has been
array
{ deprecated in favor of the ComponentIntegrity
resource.
Link to a MeasurementBlock resource. See the Links
@odata.id string read-only
section and the SoftwareInventory schema for details.
}]
The link to the metrics associated with this adapter.
Metrics (v1.7+) { object See the NetworkAdapterMetrics schema for details on
(null)
this property.
Link to a NetworkAdapterMetrics resource. See the
@odata.id string read-only Links section and the NetworkAdapterMetrics schema
for details.
580 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only
Model string The model string for this network adapter.
(null)
The link to the collection of network device functions
NetworkDeviceFunctions { object associated with this network adapter. Contains a link to
a resource.
Link to Collection of NetworkDeviceFunction. See the
@odata.id string read-only
NetworkDeviceFunction schema for details.
The link to the collection of network ports associated
with this network adapter. Contains a link to a
NetworkPorts (deprecated v1.5) { object
resource. Deprecated in v1.5 and later. This property
has been deprecated in favor of the Ports property.
Link to Collection of NetworkPort. See the NetworkPort
@odata.id string read-only
schema for details.
read-only
PartNumber string Part number for this network adapter.
(null)
The link to the collection of ports associated with this
Ports (v1.5+) { object
network adapter. Contains a link to a resource.
Link to Collection of Port. See the Port schema for
@odata.id string read-only
details.
The link to the collection of offload processors
Processors (v1.8+) { object contained in this network adapter. Contains a link to a
resource.
Link to Collection of Processor. See the Processor
@odata.id string read-only
schema for details.
read-only
SerialNumber string The serial number for this network adapter.
(null)
read-only
SKU string The manufacturer SKU for this network adapter.
(null)
The status and health of the resource and its
Status {} object subordinate or dependent resources. For property
details, see Status.
Version 2023.1 Published 581
Redfish Resource and Schema Guide DSP2046
6.77.4 Actions
6.77.4.1 ResetSettingsToDefault
Description
This action is to clear the settings back to factory defaults.
Action URI
{Base URI of target resource}/Actions/NetworkAdapter.ResetSettingsToDefault
Action parameters
This action takes no parameters.
6.77.5 Property details
6.77.5.1 MaxPCIeType
The highest version of the PCIe specification supported by this device.
string Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.
6.77.5.2 PCIeType
The version of the PCIe specification in use by this device.
string Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
582 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.
6.77.6 Example response
{
"@odata.type": "#NetworkAdapter.v1_9_0.NetworkAdapter",
"Id": "9fa725a1",
"Name": "Network Adapter View",
"Manufacturer": "Contoso",
"Model": "599TPS-T",
"SKU": "Contoso TPS-Net 2-Port Base-T",
"SerialNumber": "003BFLRT00023234",
"PartNumber": "975421-B20",
"Ports": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/Ports"
},
"NetworkDeviceFunctions": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/NetworkDeviceFunctions"
},
"Controllers": [
{
"FirmwarePackageVersion": "7.4.10",
"Links": {
"PCIeDevices": [
{
"@odata.id": "/redfish/v1/Systems/1/PCIeDevices/NIC"
}
],
"Ports": [
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/Ports/1"
}
],
"NetworkDeviceFunctions": [
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/NetworkDeviceFunctions/1111111
}
]
},
"ControllerCapabilities": {
"NetworkPortCount": 2,
"NetworkDeviceFunctionCount": 8,
"DataCenterBridging": {
Version 2023.1 Published 583
Redfish Resource and Schema Guide DSP2046
"Capable": true
},
"VirtualizationOffload": {
"VirtualFunction": {
"DeviceMaxCount": 256,
"NetworkPortMaxCount": 128,
"MinAssignmentGroupSize": 4
},
"SRIOV": {
"SRIOVVEPACapable": true
}
},
"NPIV": {
"MaxDeviceLogins": 4,
"MaxPortLogins": 2
},
"NPAR": {
"NparCapable": true,
"NparEnabled": false
}
},
"PCIeInterface": {
"PCIeType": "Gen2",
"MaxPCIeType": "Gen3",
"LanesInUse": 1,
"MaxLanes": 4
},
"Location": {
"PartLocation": {
"ServiceLabel": "Slot 1",
"LocationType": "Slot",
"LocationOrdinalValue": 0,
"Reference": "Rear",
"Orientation": "LeftToRight"
}
}
}
],
"Actions": {
"#NetworkAdapter.ResetSettingsToDefault": {
"target": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/Actions/NetworkAdapter.ResetSettingsToDefault
}
},
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1"
}
584 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.78 NetworkAdapterMetrics 1.0.0
Version v1.0
Release 2021.1
6.78.1 Description
The NetworkAdapterMetrics schema contains usage and health statistics for a network adapter.
6.78.2 URIs
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Metrics
6.78.3 Properties
Property Type Attributes Notes
number read-only
CPUCorePercent The device CPU core utilization as a percentage.
(%) (null)
number read-only
HostBusRXPercent The host bus, such as PCIe, RX utilization as a percentage.
(%) (null)
number read-only
HostBusTXPercent The host bus, such as PCIe, TX utilization as a percentage.
(%) (null)
integer read-only
NCSIRXBytes The total number of NC-SI bytes received since reset.
(bytes) (null)
read-only
NCSIRXFrames integer The total number of NC-SI frames received since reset.
(null)
integer read-only
NCSITXBytes The total number of NC-SI bytes sent since reset.
(bytes) (null)
read-only
NCSITXFrames integer The total number of NC-SI frames sent since reset.
(null)
integer read-only
RXBytes The total number of bytes received since reset.
(bytes) (null)
read-only
RXMulticastFrames integer The total number of good multicast frames received since reset.
(null)
Version 2023.1 Published 585
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
RXUnicastFrames integer The total number of good unicast frames received since reset.
(null)
integer read-only
TXBytes The total number of bytes transmitted since reset.
(bytes) (null)
read-only
TXMulticastFrames integer The total number of good multicast frames transmitted since reset.
(null)
read-only
TXUnicastFrames integer The total number of good unicast frames transmitted since reset.
(null)
6.78.4 Example response
{
"@odata.type": "#NetworkAdapterMetrics.v1_0_0.NetworkAdapterMetrics",
"Id": "NetworkAdapterMetrics",
"Name": "Network Adapter Metrics",
"HostBusRXPercent": 35.53,
"HostBusTXPercent": 14.17,
"CPUCorePercent": 8.35,
"NCSIRXFrames": 0,
"NCSITXFrames": 0,
"NCSIRXBytes": 0,
"NCSITXBytes": 0,
"RXBytes": 7754199970,
"RXMulticastFrames": 1941,
"RXUnicastFrames": 27193387,
"TXBytes": 9436506547,
"TXMulticastFrames": 153,
"TXUnicastFrames": 18205770,
"@odata.id": "/redfish/v1/Chassis/1U/NetworkAdapters/Slot1/Metrics"
}
6.79 NetworkDeviceFunction 1.9.0
Version v1.9 v1.8 v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.2 2021.4 2021.2 2021.1 2020.3 2020.1 2018.2 2017.3 2017.1 2016.3
586 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.79.1 Description
The NetworkDeviceFunction schema represents a logical interface that a network adapter exposes.
6.79.2 URIs
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions/
{NetworkDeviceFunctionId}
6.79.3 Properties
Property Type Attributes Notes
The link to the collection of allow and deny permissions
AllowDeny (v1.7+) { object for packets leaving and arriving to this network device
function. Contains a link to a resource.
Link to Collection of AllowDeny. See the AllowDeny
@odata.id string read-only
schema for details.
AssignablePhysicalNetworkPorts An array of physical ports to which this network device
array
(v1.5+) [ { function can be assigned.
Link to a Port resource. See the Links section and the Port
@odata.id string read-only
schema for details.
}]
An array of physical ports to which this network device
AssignablePhysicalPorts (deprecated function can be assigned. Deprecated in v1.5 and later.
array
v1.5) [ { This property has been deprecated in favor of the
AssignablePhysicalNetworkPorts property.
Link to a NetworkPort resource. See the Links section and
@odata.id string read-only
the NetworkPort schema for details.
}]
The boot mode configured for this network device
string read-write
BootMode function. For the possible property values, see BootMode
(enum) (null)
in Property details.
read-write An indication of whether the network device function is
DeviceEnabled boolean
(null) enabled.
Version 2023.1 Published 587
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The Ethernet capabilities, status, and configuration values
Ethernet { object
for this network device function.
The Ethernet interface collection that represents all the
EthernetInterfaces (v1.7+) { object Ethernet Interfaces on this network device function.
(null)
Contains a link to a resource.
Link to Collection of EthernetInterface. See the
@odata.id string read-only
EthernetInterface schema for details.
read-write
MACAddress string The currently configured MAC address.
(null)
read-write The maximum transmission unit (MTU) configured for this
MTUSize integer
(null) network device function.
read-only The largest maximum transmission unit (MTU) size
MTUSizeMaximum (v1.5+) integer
(null) supported for this network device function.
read-only
PermanentMACAddress string The permanent MAC address assigned to this function.
(null)
The VLAN information for this interface. If this network
VLAN (v1.3+) { object interface supports more than one VLAN, this property is
not present.
read-write An indication of whether this VLAN is tagged or untagged
Tagged (v1.3+) boolean
(null) for this interface.
read-write
required An indication of whether this VLAN is enabled for this
VLANEnable boolean
on create VLAN network interface.
(null)
read-write
required
VLANId integer The ID for this VLAN.
on create
(null)
read-write
VLANPriority (v1.2+) integer The priority for this VLAN.
(null)
588 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The link to a collection of VLANs. This property is used
only if the interface supports more than one VLAN.
Contains a link to a resource. Deprecated in v1.7 and
VLANs (v1.3+, deprecated v1.7 { object
later. This property has been deprecated in favor of
representing multiple VLANs as EthernetInterface
resources.
Link to Collection of VLanNetworkInterface. See the
@odata.id string read-only
VLanNetworkInterface schema for details.
The Fibre Channel capabilities, status, and configuration
FibreChannel { object
values for this network device function.
read-write An indication of whether the FCoE Initialization Protocol
AllowFIPVLANDiscovery boolean
(null) (FIP) populates the FCoE VLAN ID.
An array of Fibre Channel boot targets configured for this
BootTargets [ { array
network device function.
read-write The relative priority for this entry in the boot targets
BootPriority integer
(null) array.
read-write The logical unit number (LUN) ID from which to boot on
LUNID string
(null) the device to which the corresponding WWPN refers.
read-write
WWPN string The World Wide Port Name (WWPN) from which to boot.
(null)
}]
read-only
FCoEActiveVLANId integer The active FCoE VLAN ID.
(null)
read-write
FCoELocalVLANId integer The locally configured FCoE VLAN ID.
(null)
read-only The Fibre Channel ID that the switch assigns for this
FibreChannelId (v1.3+) string
(null) interface.
read-only The permanent World Wide Node Name (WWNN) address
PermanentWWNN string
(null) assigned to this function.
read-only The permanent World Wide Port Name (WWPN) address
PermanentWWPN string
(null) assigned to this function.
read-write The currently configured World Wide Node Name (WWNN)
WWNN string
(null) address of this function.
Version 2023.1 Published 589
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The configuration source of the World Wide Names (WWN)
string read-write for this World Wide Node Name (WWNN) and World Wide
WWNSource
(enum) (null) Port Name (WWPN) connection. For the possible property
values, see WWNSource in Property details.
read-write The currently configured World Wide Port Name (WWPN)
WWPN string
(null) address of this function.
The HTTP and HTTPS boot capabilities, status, and
HTTPBoot (v1.9+) { object
configuration values for this network device function.
string read-write The URI of the boot media loaded with this network
BootMediaURI (v1.9+)
(URI) (null) device function.
The InfiniBand capabilities, status, and configuration
InfiniBand (v1.5+) { object
values for this network device function.
read-write The maximum transmission unit (MTU) configured for this
MTUSize (v1.5+) integer
(null) network device function.
read-only This is the currently configured node GUID of the network
NodeGUID (v1.5+) string
(null) device function.
read-only The permanent node GUID assigned to this network
PermanentNodeGUID (v1.5+) string
(null) device function.
read-only The permanent port GUID assigned to this network device
PermanentPortGUID (v1.5+) string
(null) function.
read-only The permanent system GUID assigned to this network
PermanentSystemGUID (v1.5+) string
(null) device function.
read-only The currently configured port GUID of the network device
PortGUID (v1.5+) string
(null) function.
array
The maximum transmission unit (MTU) sizes supported for
SupportedMTUSizes (v1.5+) [ ] (integer, read-only
this network device function.
null)
read-only This is the currently configured system GUID of the
SystemGUID (v1.5+) string
(null) network device function.
The iSCSI boot capabilities, status, and configuration
iSCSIBoot { object
values for this network device function.
590 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The iSCSI boot authentication method for this network
string read-write
AuthenticationMethod device function. For the possible property values, see
(enum) (null)
AuthenticationMethod in Property details.
read-write
CHAPSecret string The shared secret for CHAP authentication.
(null)
read-write
CHAPUsername string The user name for CHAP authentication.
(null)
read-write
InitiatorDefaultGateway string The IPv6 or IPv4 iSCSI boot default gateway.
(null)
read-write
InitiatorIPAddress string The IPv6 or IPv4 address of the iSCSI initiator.
(null)
read-write
InitiatorName string The iSCSI initiator name.
(null)
read-write
InitiatorNetmask string The IPv6 or IPv4 netmask of the iSCSI boot initiator.
(null)
The type of IP address being populated in the iSCSIBoot IP
string read-write
IPAddressType address fields. For the possible property values, see
(enum) (null)
IPAddressType in Property details.
An indication of whether the iSCSI boot initiator uses
read-write
IPMaskDNSViaDHCP boolean DHCP to obtain the initiator name, IP address, and
(null)
netmask.
read-write
MutualCHAPSecret string The CHAP secret for two-way CHAP authentication.
(null)
read-write
MutualCHAPUsername string The CHAP user name for two-way CHAP authentication.
(null)
read-write The IPv6 or IPv4 address of the primary DNS server for
PrimaryDNS string
(null) the iSCSI boot initiator.
read-write The logical unit number (LUN) for the primary iSCSI boot
PrimaryLUN integer
(null) target.
read-write
PrimaryTargetIPAddress string The IPv4 or IPv6 address for the primary iSCSI boot target.
(null)
read-write
PrimaryTargetName string The name of the iSCSI primary boot target.
(null)
read-write
PrimaryTargetTCPPort integer The TCP port for the primary iSCSI boot target.
(null)
Version 2023.1 Published 591
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-write
PrimaryVLANEnable boolean An indication of whether the primary VLAN is enabled.
(null)
read-write The 802.1q VLAN ID to use for iSCSI boot from the
PrimaryVLANId integer
(null) primary target.
read-write An indication of whether IPv6 router advertisement is
RouterAdvertisementEnabled boolean
(null) enabled for the iSCSI boot target.
read-write The IPv6 or IPv4 address of the secondary DNS server for
SecondaryDNS string
(null) the iSCSI boot initiator.
read-write The logical unit number (LUN) for the secondary iSCSI
SecondaryLUN integer
(null) boot target.
read-write The IPv4 or IPv6 address for the secondary iSCSI boot
SecondaryTargetIPAddress string
(null) target.
read-write
SecondaryTargetName string The name of the iSCSI secondary boot target.
(null)
read-write
SecondaryTargetTCPPort integer The TCP port for the secondary iSCSI boot target.
(null)
read-write
SecondaryVLANEnable boolean An indication of whether the secondary VLAN is enabled.
(null)
read-write The 802.1q VLAN ID to use for iSCSI boot from the
SecondaryVLANId integer
(null) secondary target.
read-write An indication of whether the iSCSI boot target name, LUN,
TargetInfoViaDHCP boolean
(null) IP address, and netmask should be obtained from DHCP.
The byte and packet limits for this network device
Limits (v1.7+) [ { array
function.
read-write The maximum number of bytes per second in a burst for
BurstBytesPerSecond (v1.7+) integer
(null) this network device function.
read-write The maximum number of packets per second in a burst
BurstPacketsPerSecond (v1.7+) integer
(null) for this network device function.
Indicates the direction of the data to which this limit
string read-write
Direction (v1.7+) applies. For the possible property values, see Direction in
(enum) (null)
Property details.
SustainedBytesPerSecond read-write The maximum number of sustained bytes per second for
integer
(v1.7+) (null) this network device function.
592 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
SustainedPacketsPerSecond read-write The maximum number of sustained packets per second
integer
(v1.7+) (null) for this network device function.
}]
The links to other resources that are related to this
Links { object
resource.
An array of links to endpoints associated with this network
Endpoints (v1.2+) [ { array
device function.
Link to a Endpoint resource. See the Links section and the
@odata.id string read-only
Endpoint schema for details.
}]
The link to a virtual Ethernet interface that was created
when one of the network device function VLANs is
represented as a virtual NIC for the purpose of showing
the IP address associated with that VLAN. See the
EthernetInterface (v1.4+,
object EthernetInterface schema for details on this property.
deprecated v1.7 {
Deprecated in v1.7 and later. This property has been
deprecated in favor of EthernetInterfaces as each
NetworkDeviceFunction could have more than one
EthernetInterface.
Link to a EthernetInterface resource. See the Links section
@odata.id string read-only
and the EthernetInterface schema for details.
The links to Ethernet interfaces that were created when
one of the network device function VLANs is represented
EthernetInterfaces (v1.7+) [ { array
as a virtual NIC for the purpose of showing the IP address
associated with that VLAN.
Link to a EthernetInterface resource. See the Links section
@odata.id string read-only
and the EthernetInterface schema for details.
}]
See the Oem object definition in the Common properties
Oem {} object
section.
The processors that perform offload computation for this
OffloadProcessors (v1.7+) [ { array
network function, such as with a SmartNIC.
Link to a Processor resource. See the Links section and
@odata.id string read-only
the Processor schema for details.
}]
Version 2023.1 Published 593
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The system that performs offload computation for this
OffloadSystem (v1.7+) { object network function, such as with a SmartNIC. See the
ComputerSystem schema for details on this property.
Link to a ComputerSystem resource. See the Links section
@odata.id string read-only
and the ComputerSystem schema for details.
The link to the PCIe function associated with this network
PCIeFunction { object device function. See the PCIeFunction schema for details
on this property.
Link to a PCIeFunction resource. See the Links section and
@odata.id string read-only
the PCIeFunction schema for details.
The physical port to which this network device function is
PhysicalNetworkPortAssignment
object currently assigned. See the Port schema for details on this
(v1.5+) {
property.
Link to a Port resource. See the Links section and the Port
@odata.id string read-only
schema for details.
The physical port to which this network device function is
currently assigned. See the NetworkPort schema for
PhysicalPortAssignment (v1.3+,
object details on this property. Deprecated in v1.5 and later. This
deprecated v1.5 {
property has been deprecated in favor of the
PhysicalNetworkPortAssignment property.
Link to a NetworkPort resource. See the Links section and
@odata.id string read-only
the NetworkPort schema for details.
read-only The number of virtual functions that are available for this
MaxVirtualFunctions integer
(null) network device function.
The link to the metrics associated with this network
Metrics (v1.6+) { object function. See the NetworkDeviceFunctionMetrics schema
(null)
for details on this property.
Link to a NetworkDeviceFunctionMetrics resource. See the
@odata.id string read-only Links section and the NetworkDeviceFunctionMetrics
schema for details.
594 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
array An array of capabilities for this network device function.
read-only
NetDevFuncCapabilities [ ] (string For the possible property values, see
(null)
(enum)) NetDevFuncCapabilities in Property details.
The configured capability of this network device function.
string read-write
NetDevFuncType For the possible property values, see NetDevFuncType in
(enum) (null)
Property details.
The physical port to which this network device function is
currently assigned. See the Port schema for details on this
PhysicalNetworkPortAssignment property. Deprecated in v1.8 and later. This property has
object
(v1.5+, deprecated v1.8 { been deprecated in favor of
PhysicalNetworkPortAssignment within Links to avoid
loops on expand.
Link to a Port resource. See the Links section and the Port
@odata.id string read-only
schema for details.
The physical port to which this network device function is
currently assigned. See the NetworkPort schema for
PhysicalPortAssignment (deprecated
object details on this property. Deprecated in v1.3 and later. This
v1.3) {
property has been deprecated and moved to the Links
property to avoid loops on expand.
Link to a NetworkPort resource. See the Links section and
@odata.id string read-only
the NetworkPort schema for details.
read-write Indicates if Source Address Validation Improvement (SAVI)
SAVIEnabled (v1.7+) boolean
(null) is enabled for this network device function.
The status and health of the resource and its subordinate
Status {} object
or dependent resources. For property details, see Status.
An indication of whether single root input/output
read-only
VirtualFunctionsEnabled boolean virtualization (SR-IOV) virtual functions are enabled for
(null)
this network device function.
6.79.4 Property details
6.79.4.1 AuthenticationMethod
The iSCSI boot authentication method for this network device function.
Version 2023.1 Published 595
Redfish Resource and Schema Guide DSP2046
string Description
CHAP iSCSI Challenge Handshake Authentication Protocol (CHAP) authentication is used.
MutualCHAP iSCSI Mutual Challenge Handshake Authentication Protocol (CHAP) authentication is used.
None No iSCSI authentication is used.
6.79.4.2 BootMode
The boot mode configured for this network device function.
string Description
Disabled Do not indicate to UEFI/BIOS that this device is bootable.
Boot this device by using the embedded Fibre Channel support and configuration. Only
FibreChannel
applicable if the NetDevFuncType is FibreChannel .
Boot this device by using the embedded Fibre Channel over Ethernet (FCoE) boot support and
FibreChannelOverEthernet
configuration. Only applicable if the NetDevFuncType is FibreChannelOverEthernet .
Boot this device by using the embedded HTTP/HTTPS support. Only applicable if the
HTTP (v1.9+)
NetDevFuncType is Ethernet .
Boot this device by using the embedded iSCSI boot support and configuration. Only
iSCSI
applicable if the NetDevFuncType is iSCSI or Ethernet .
Boot this device by using the embedded PXE support. Only applicable if the NetDevFuncType
PXE
is Ethernet or InfiniBand .
6.79.4.3 Direction
Indicates the direction of the data to which this limit applies.
string Description
Indicates that this limit is enforced on packets and bytes transmitted by the network device
Egress
function.
Indicates that this limit is enforced on packets and bytes received by the network device
Ingress
function.
None Indicates that this limit not enforced.
596 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.79.4.4 IPAddressType
The type of IP address being populated in the iSCSIBoot IP address fields.
string Description
IPv4 IPv4 addressing is used for all IP-fields in this object.
IPv6 IPv6 addressing is used for all IP-fields in this object.
6.79.4.5 NetDevFuncCapabilities
An array of capabilities for this network device function.
string Description
Disabled Neither enumerated nor visible to the operating system.
Ethernet Appears to the operating system as an Ethernet device.
FibreChannel Appears to the operating system as a Fibre Channel device.
FibreChannelOverEthernet Appears to the operating system as an FCoE device.
InfiniBand Appears to the operating system as an InfiniBand device.
iSCSI Appears to the operating system as an iSCSI device.
6.79.4.6 NetDevFuncType
The configured capability of this network device function.
string Description
Disabled Neither enumerated nor visible to the operating system.
Ethernet Appears to the operating system as an Ethernet device.
FibreChannel Appears to the operating system as a Fibre Channel device.
FibreChannelOverEthernet Appears to the operating system as an FCoE device.
InfiniBand (v1.5+) Appears to the operating system as an InfiniBand device.
iSCSI Appears to the operating system as an iSCSI device.
Version 2023.1 Published 597
Redfish Resource and Schema Guide DSP2046
6.79.4.7 WWNSource
The configuration source of the World Wide Names (WWN) for this World Wide Node Name (WWNN)
and World Wide Port Name (WWPN) connection.
string Description
ConfiguredLocally The set of FC/FCoE boot targets was applied locally through API or UI.
ProvidedByFabric The set of FC/FCoE boot targets was applied by the Fibre Channel fabric.
6.79.5 Example response
{
"@odata.type": "#NetworkDeviceFunction.v1_9_0.NetworkDeviceFunction",
"Id": "111111111100",
"Name": "Network Device Function View",
"NetDevFuncType": "Ethernet",
"DeviceEnabled": true,
"NetDevFuncCapabilities": [
"Ethernet",
"FibreChannel"
],
"Ethernet": {
"PermanentMACAddress": "00:0C:29:9A:98:ED",
"MACAddress": "00:0C:29:9A:98:ED",
"MTUSize": 1500,
"VLAN": {
"VLANEnable": true,
"VLANId": 101
}
},
"iSCSIBoot": {
"IPAddressType": "IPv4",
"InitiatorIPAddress": "16.0.11.6",
"InitiatorName": "iqn.2005-03.com.acme:database-server",
"InitiatorDefaultGateway": "169.0.16.1",
"InitiatorNetmask": "255.255.252.0",
"TargetInfoViaDHCP": false,
"PrimaryTargetName": "iqn.2005-03.com.acme:image-server",
"PrimaryTargetIPAddress": "169.0.15.1",
"PrimaryTargetTCPPort": 3260,
"PrimaryLUN": 5,
"PrimaryVLANEnable": true,
"PrimaryVLANId": 1001,
"PrimaryDNS": "16.0.10.21",
598 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"SecondaryTargetName": "iqn.2005-03.com.acme:image-server",
"SecondaryTargetIPAddress": "16.0.11.5",
"SecondaryTargetTCPPort": 3260,
"SecondaryLUN": 5,
"SecondaryVLANEnable": true,
"SecondaryVLANId": 1002,
"SecondaryDNS": "169.0.10.22",
"IPMaskDNSViaDHCP": false,
"RouterAdvertisementEnabled": false,
"AuthenticationMethod": "CHAP",
"CHAPUsername": "yosemite",
"CHAPSecret": "usrpasswd",
"MutualCHAPUsername": "yosemite",
"MutualCHAPSecret": "usrpasswd"
},
"FibreChannel": {
"PermanentWWPN": "10:00:B0:5A:DD:BB:74:E0",
"PermanentWWNN": "10:00:B0:5A:DD:BB:A1:B3",
"WWPN": "10:00:B0:5A:DD:BB:74:E0",
"WWNN": "10:00:B0:5A:DD:C4:D3:BB",
"WWNSource": "ConfiguredLocally",
"FCoELocalVLANId": 1001,
"AllowFIPVLANDiscovery": true,
"FCoEActiveVLANId": 2001,
"BootTargets": [
{
"WWPN": "10:00:B0:5A:DD:BB:74:FA",
"LUNID": "3",
"BootPriority": 0
}
]
},
"AssignablePhysicalNetworkPorts": [
{
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/Ports/1"
}
],
"BootMode": "Disabled",
"VirtualFunctionsEnabled": true,
"MaxVirtualFunctions": 16,
"Links": {
"PCIeFunction": {
"@odata.id": "/redfish/v1/Systems/1/PCIeDevices/NIC/PCIeFunctions/1"
},
"PhysicalNetworkPortAssignment": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/Ports/1"
}
},
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/NetworkDeviceFunctions/111111111100"
}
Version 2023.1 Published 599
Redfish Resource and Schema Guide DSP2046
6.80 NetworkDeviceFunctionMetrics 1.1.0
Version v1.1 v1.0
Release 2021.2 2021.1
6.80.1 Description
The NetworkDeviceFunctionMetrics schema contains usage and health statistics for a network function
of a network adapter.
6.80.2 URIs
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions/
{NetworkDeviceFunctionId}/Metrics
6.80.3 Properties
Property Type Attributes Notes
Ethernet { object The network function metrics specific to Ethernet adapters.
read-only
NumOffloadedIPv4Conns integer The total number of offloaded TCP/IPv4 connections.
(null)
read-only
NumOffloadedIPv6Conns integer The total number of offloaded TCP/IPv6 connections.
(null)
FibreChannel (v1.1+) { object The network function metrics specific to Fibre Channel adapters.
PortLoginAccepts read-only
integer The total number of port login (PLOGI) accept (ACC) responses.
(v1.1+) (null)
read-only
PortLoginRejects (v1.1+) integer The total number of port login (PLOGI) reject (RJT) responses.
(null)
PortLoginRequests read-only
integer The total number of port login (PLOGI) requests transmitted.
(v1.1+) (null)
RXCongestionFPINs read-only The total number of Congestion Fabric Performance Impact
integer
(v1.1+) (null) Notifications (FPINs) received.
600 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only The total number of Delivery Fabric Performance Impact
RXDeliveryFPINs (v1.1+) integer
(null) Notifications (FPINs) received.
read-only
RXExchanges (v1.1+) integer The total number of Fibre Channel exchanges received.
(null)
RXLinkIntegrityFPINs read-only The total number of Link Integrity Fabric Performance Impact
integer
(v1.1+) (null) Notifications (FPINs) received.
RXPeerCongestionFPINs read-only The total number of Peer Congestion Fabric Performance Impact
integer
(v1.1+) (null) Notifications (FPINs) received.
read-only
RXSequences (v1.1+) integer The total number of Fibre Channel sequences received.
(null)
TXCongestionFPINs read-only The total number of Congestion Fabric Performance Impact
integer
(v1.1+) (null) Notifications (FPINs) sent.
read-only The total number of Delivery Fabric Performance Impact
TXDeliveryFPINs (v1.1+) integer
(null) Notifications (FPINs) sent.
read-only
TXExchanges (v1.1+) integer The total number of Fibre Channel exchanges transmitted.
(null)
TXLinkIntegrityFPINs read-only The total number of Link Integrity Fabric Performance Impact
integer
(v1.1+) (null) Notifications (FPINs) sent.
TXPeerCongestionFPINs read-only The total number of Peer Congestion Fabric Performance Impact
integer
(v1.1+) (null) Notifications (FPINs) sent.
read-only
TXSequences (v1.1+) integer The total number of Fibre Channel sequences transmitted.
(null)
number read-only
RXAvgQueueDepthPercent The average RX queue depth as the percentage.
(%) (null)
integer read-only
RXBytes The total number of bytes received on a network function.
(bytes) (null)
read-only
RXFrames integer The total number of frames received on a network function.
(null)
read-only The total number of good multicast frames received on a network
RXMulticastFrames integer
(null) function since reset.
read-only
RXQueuesEmpty boolean Whether nothing is in a network function's RX queues to DMA.
(null)
Version 2023.1 Published 601
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
RXQueuesFull integer The number of RX queues that are full.
(null)
read-only The total number of good unicast frames received on a network
RXUnicastFrames integer
(null) function since reset.
number read-only
TXAvgQueueDepthPercent The average TX queue depth as the percentage.
(%) (null)
integer read-only
TXBytes The total number of bytes sent on a network function.
(bytes) (null)
read-only
TXFrames integer The total number of frames sent on a network function.
(null)
read-only The total number of good multicast frames transmitted on a
TXMulticastFrames integer
(null) network function since reset.
read-only
TXQueuesEmpty boolean Whether all TX queues for a network function are empty.
(null)
read-only
TXQueuesFull integer The number of TX queues that are full.
(null)
read-only The total number of good unicast frames transmitted on a
TXUnicastFrames integer
(null) network function since reset.
6.80.4 Example response
{
"@odata.type": "#NetworkDeviceFunctionMetrics.v1_1_0.NetworkDeviceFunctionMetrics",
"Id": "NetworkDeviceFunctionMetrics",
"Name": "Network Device Function Metrics",
"TXAvgQueueDepthPercent": 13.7,
"RXAvgQueueDepthPercent": 21.2,
"RXFrames": 27193387,
"RXBytes": 7754199970,
"RXUnicastFrames": 26193387,
"RXMulticastFrames": 1000000,
"TXFrames": 18205770,
"TXBytes": 9436506547,
"TXUnicastFrames": 17205770,
"TXMulticastFrames": 1000000,
"TXQueuesEmpty": false,
"RXQueuesEmpty": false,
"TXQueuesFull": 0,
"RXQueuesFull": 0,
602 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"Ethernet": {
"NumOffloadedIPv4Conns": 0,
"NumOffloadedIPv6Conns": 0
},
"@odata.id": "/redfish/v1/Chassis/1U/NetworkAdapters/Slot1/NetworkDeviceFunctions/SC2KP1F0/Metrics"
}
6.81 NetworkInterface 1.2.1
Version v1.2 v1.1 v1.0
Release 2020.3 2017.1 2016.3
6.81.1 Description
The NetworkInterface schema describes links to the network adapters, network ports, and network
device functions, and represents the functionality available to the containing system.
6.81.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/
{NetworkInterfaceId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
NetworkInterfaces/{NetworkInterfaceId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/
{NetworkInterfaceId}
/redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}
6.81.3 Properties
Property Type Attributes Notes
Links { object The links to other resources that are related to this resource.
The link to the network adapter that contains this network interface.
NetworkAdapter { object
See the NetworkAdapter schema for details on this property.
Link to a NetworkAdapter resource. See the Links section and the
@odata.id string read-only
NetworkAdapter schema for details.
Version 2023.1 Published 603
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Oem {} object See the Oem object definition in the Common properties section.
NetworkDeviceFunctions The link to the network device functions associated with this network
object
{ interface. Contains a link to a resource.
Link to Collection of NetworkDeviceFunction. See the
@odata.id string read-only
NetworkDeviceFunction schema for details.
The link to the network ports associated with this network interface.
NetworkPorts
object Contains a link to a resource. Deprecated in v1.2 and later. This
(deprecated v1.2) {
property has been deprecated in favor of the Ports property.
Link to Collection of NetworkPort. See the NetworkPort schema for
@odata.id string read-only
details.
The link to the ports associated with this network interface. Contains
Ports (v1.2+) { object
a link to a resource.
@odata.id string read-only Link to Collection of Port. See the Port schema for details.
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
6.81.4 Example response
{
"@odata.type": "#NetworkInterface.v1_2_1.NetworkInterface",
"Id": "9fa725a1",
"Name": "Network Device View",
"NetworkPorts": {
"@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces/9fd725a1/NetworkPorts"
},
"NetworkDeviceFunctions": {
"@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces/9fd725a1/NetworkDeviceFunctions"
},
"Links": {
"NetworkAdapter": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1"
604 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
}
},
"@odata.id": "/redfish/v1/Systems/1/NetworkInterfaces/9fd725a1"
}
6.82 NetworkPort 1.4.1 (deprecated)
Version v1.4 Deprecated v1.3 v1.2 v1.1 v1.0
Release 2020.4 2020.3 2018.2 2017.1 2016.3
This schema has been deprecated and use in new implementations is discouraged except to retain
compatibility with existing products. This schema has been deprecated in favor of the Port schema.
6.82.1 Description
The NetworkPort schema describes a network port, which is a discrete physical port that can connect
to a network.
6.82.2 URIs
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkPorts/{NetworkPortId}
6.82.3 Properties
Property Type Attributes Notes
string read-write Network port active link technology. For the possible property
ActiveLinkTechnology
(enum) (null) values, see ActiveLinkTechnology in Property details.
An array of configured MAC or WWN network addresses that
are associated with this network port, including the
array
AssociatedNetworkAddresses [ programmed address of the lowest numbered network device
(string, read-only
] function, the configured but not active address, if applicable,
null)
the address for hardware port teaming, or other network
addresses.
integer read-write
CurrentLinkSpeedMbps (v1.2+) Network port current link speed.
(Mbit/s) (null)
Version 2023.1 Published 605
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-write An indication of whether IEEE 802.3az Energy-Efficient
EEEEnabled boolean
(null) Ethernet (EEE) is enabled for this network port.
read-only
FCFabricName (v1.2+) string The FC Fabric Name provided by the switch.
(null)
string read-only The connection type of this port. For the possible property
FCPortConnectionType (v1.2+)
(enum) (null) values, see FCPortConnectionType in Property details.
The locally configured 802.3x flow control setting for this
string read-write
FlowControlConfiguration network port. For the possible property values, see
(enum) (null)
FlowControlConfiguration in Property details.
The 802.3x flow control behavior negotiated with the link
string read-only
FlowControlStatus partner for this network port (Ethernet-only). For the possible
(enum) (null)
property values, see FlowControlStatus in Property details.
The status of the link between this port and its link partner.
string read-only
LinkStatus For the possible property values, see LinkStatus in Property
(enum) (null)
details.
integer read-only
MaxFrameSize (v1.2+) The maximum frame size supported by the port.
(bytes) (null)
An array of maximum bandwidth allocation percentages for
NetDevFuncMaxBWAlloc [ { array
the network device functions associated with this port.
integer read-write The maximum bandwidth allocation percentage allocated to
MaxBWAllocPercent
(%) (null) the corresponding network device function instance.
The link to the network device function associated with this
NetworkDeviceFunction { object bandwidth setting of this network port. See the
NetworkDeviceFunction schema for details on this property.
Link to a NetworkDeviceFunction resource. See the Links
@odata.id string read-only
section and the NetworkDeviceFunction schema for details.
}]
An array of minimum bandwidth allocation percentages for
NetDevFuncMinBWAlloc [ { array
the network device functions associated with this port.
integer read-write The minimum bandwidth allocation percentage allocated to
MinBWAllocPercent
(%) (null) the corresponding network device function instance.
The link to the network device function associated with this
NetworkDeviceFunction { object bandwidth setting of this network port. See the
NetworkDeviceFunction schema for details on this property.
606 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to a NetworkDeviceFunction resource. See the Links
@odata.id string read-only
section and the NetworkDeviceFunction schema for details.
}]
NumberDiscoveredRemotePorts read-only The number of ports not on this adapter that this port has
integer
(v1.2+) (null) discovered.
read-only
PhysicalPortNumber string The physical port number label for this port.
(null)
read-only The largest maximum transmission unit (MTU) that can be
PortMaximumMTU integer
(null) configured for this network port.
read-only An indication of whether the port has detected enough signal
SignalDetected boolean
(null) on enough lanes to establish a link.
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
array The set of Ethernet capabilities that this port supports. For the
SupportedEthernetCapabilities read-only
(string possible property values, see SupportedEthernetCapabilities
[] (null)
(enum)) in Property details.
SupportedLinkCapabilities [ { array The link capabilities of this port.
AutoSpeedNegotiation read-only An indication of whether the port is capable of
boolean
(v1.2+) (null) autonegotiating speed.
array
CapableLinkSpeedMbps
(integer, read-only The set of link speed capabilities of this port.
(v1.2+) [ ]
null)
The link network technology capabilities of this port. For the
string read-only
LinkNetworkTechnology possible property values, see LinkNetworkTechnology in
(enum) (null)
Property details.
The speed of the link in Mbit/s when this link network
LinkSpeedMbps (deprecated integer read-only technology is active. Deprecated in v1.2 and later. This
v1.2) (Mbit/s) (null) property has been deprecated in favor of the
CapableLinkSpeedMbps.
}]
read-only
VendorId (v1.2+) string The vendor Identification for this port.
(null)
read-write An indication of whether Wake on LAN (WoL) is enabled for
WakeOnLANEnabled boolean
(null) this network port.
Version 2023.1 Published 607
Redfish Resource and Schema Guide DSP2046
6.82.4 Property details
6.82.4.1 ActiveLinkTechnology
Network port active link technology.
string Description
Ethernet The port is capable of connecting to an Ethernet network.
FibreChannel The port is capable of connecting to a Fibre Channel network.
InfiniBand The port is capable of connecting to an InfiniBand network.
6.82.4.2 FCPortConnectionType
The connection type of this port.
string Description
ExtenderFabric This port connection type is an extender fabric port.
Generic This port connection type is a generic fabric port.
NotConnected This port is not connected.
NPort This port connects through an N-port to a switch.
PointToPoint This port connects in a point-to-point configuration.
PrivateLoop This port connects in a private loop configuration.
PublicLoop This port connects in a public configuration.
6.82.4.3 FlowControlConfiguration
The locally configured 802.3x flow control setting for this network port.
string Description
None No IEEE 802.3x flow control is enabled on this port.
RX The link partner can initiate IEEE 802.3x flow control.
608 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
TX This station can initiate IEEE 802.3x flow control.
TX_RX This station or the link partner can initiate IEEE 802.3x flow control.
6.82.4.4 FlowControlStatus
The 802.3x flow control behavior negotiated with the link partner for this network port (Ethernet-only).
string Description
None No IEEE 802.3x flow control is enabled on this port.
RX The link partner can initiate IEEE 802.3x flow control.
TX This station can initiate IEEE 802.3x flow control.
TX_RX This station or the link partner can initiate IEEE 802.3x flow control.
6.82.4.5 LinkNetworkTechnology
The link network technology capabilities of this port.
string Description
Ethernet The port is capable of connecting to an Ethernet network.
FibreChannel The port is capable of connecting to a Fibre Channel network.
InfiniBand The port is capable of connecting to an InfiniBand network.
6.82.4.6 LinkStatus
The status of the link between this port and its link partner.
string Description
Down The port is enabled but link is down.
This link on this interface is starting. A physical link has been established, but the port is not
Starting (v1.3+)
able to transfer data.
Version 2023.1 Published 609
Redfish Resource and Schema Guide DSP2046
string Description
Training (v1.3+) This physical link on this interface is training.
Up The port is enabled and link is good (up).
6.82.4.7 SupportedEthernetCapabilities
The set of Ethernet capabilities that this port supports.
string Description
EEE IEEE 802.3az Energy-Efficient Ethernet (EEE) is supported on this port.
WakeOnLAN Wake on LAN (WoL) is supported on this port.
6.82.5 Example response
{
"@odata.type": "#NetworkPort.v1_4_1.NetworkPort",
"Id": "1",
"Name": "Network Port View",
"PhysicalPortNumber": "1",
"LinkStatus": "Up",
"SupportedLinkCapabilities": [
{
"AutoSpeedNegotiation": true,
"LinkNetworkTechnology": "Ethernet",
"CapableLinkSpeedMbps": [
10,
100,
10000
]
}
],
"ActiveLinkTechnology": "Ethernet",
"SupportedEthernetCapabilities": [
"WakeOnLAN",
"EEE"
],
"NetDevFuncMinBWAlloc": [
{
"NetworkDeviceFunction": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/NetworkDeviceFunctions/111111111100"
},
"MinBWAllocPercent": 25
610 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
}
],
"NetDevFuncMaxBWAlloc": [
{
"NetworkDeviceFunction": {
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/NetworkDeviceFunctions/111111111100"
},
"MaxBWAllocPercent": 100
}
],
"AssociatedNetworkAddresses": [
"00:0C:29:9A:98:ED",
"00:0C:29:9A:98:EF"
],
"EEEEnabled": true,
"WakeOnLANEnabled": true,
"PortMaximumMTU": 1500,
"FlowControlStatus": "None",
"FlowControlConfiguration": "None",
"SignalDetected": true,
"@odata.id": "/redfish/v1/Chassis/1/NetworkAdapters/9fd725a1/NetworkPorts/1"
}
6.83 OperatingConfig 1.0.2
Version v1.0
Release 2020.2
6.83.1 Description
The OperatingConfig schema specifies a configuration that can be used when the processor is
operational.
6.83.2 URIs
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/OperatingConfigs/
{OperatingConfigId}
Version 2023.1 Published 611
Redfish Resource and Schema Guide DSP2046
6.83.3 Properties
Property Type Attributes Notes
integer read-only
BaseSpeedMHz The base (nominal) clock speed of the processor in MHz.
(MHz) (null)
The clock speed for sets of cores when the configuration is
BaseSpeedPrioritySettings [ { array
operational.
integer read-only
BaseSpeedMHz The clock speed to configure the set of cores in MHz.
(MHz) (null)
read-only
CoreCount integer The number of cores to configure with a specified speed.
(null)
array
The identifier of the cores to configure with the specified
CoreIDs [ ] (integer, read-only
speed.
null)
}]
integer read-only
MaxJunctionTemperatureCelsius The maximum temperature of the junction in degrees Celsius.
(Celsius) (null)
integer read-only The maximum clock speed to which the processor can be
MaxSpeedMHz
(MHz) (null) configured in MHz.
integer read-only
TDPWatts The thermal design point of the processor in watts.
(Watts) (null)
read-only
TotalAvailableCoreCount integer The number of cores in the processor that can be configured.
(null)
The turbo profiles for the processor. A turbo profile is the
TurboProfile [ { array maximum turbo clock speed as a function of the number of
active cores.
read-only The number of active cores to be configured with the
ActiveCoreCount integer
(null) specified maximum clock speed.
integer read-only The maximum turbo clock speed that correspond to the
MaxSpeedMHz
(MHz) (null) number of active cores in MHz.
}]
612 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.83.4 Example response
{
"@odata.type": "#OperatingConfig.v1_0_2.OperatingConfig",
"Id": "0",
"Name": "Processor Profile",
"TotalAvailableCoreCount": 28,
"TDPWatts": 150,
"BaseSpeedMHz": 2500,
"MaxSpeedMHz": 4100,
"MaxJunctionTemperatureCelsius": 90,
"TurboProfile": [
{
"ActiveCoreCount": 2,
"MaxSpeedMHz": 4100
},
{
"ActiveCoreCount": 4,
"MaxSpeedMHz": 4000
},
{
"ActiveCoreCount": 8,
"MaxSpeedMHz": 3800
},
{
"ActiveCoreCount": 28,
"MaxSpeedMHz": 3200
}
],
"BaseSpeedPrioritySettings": [
{
"CoreCount": 8,
"CoreIDs": [
0,
2,
3,
4,
5,
6,
7,
8
],
"BaseSpeedMHz": 2900
},
{
"CoreCount": 20,
"BaseSpeedMHz": 2200
}
],
Version 2023.1 Published 613
Redfish Resource and Schema Guide DSP2046
"@odata.id": "/redfish/v1/Systems/operating-config-example/Processors/CPU1/OperatingConfigs/0"
}
6.84 Outlet 1.4.1
Version v1.4 v1.3 v1.2 v1.1 v1.0
Release 2021.4 2021.3 2021.2 2020.3 2019.4
6.84.1 Description
The Outlet schema contains definition for an electrical outlet.
6.84.2 URIs
/redfish/v1/PowerEquipment/ElectricalBuses/{PowerDistributionId}/Outlets/{OutletId}
/redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}/Outlets/{OutletId}
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/Outlets/{OutletId}
/redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Outlets/{OutletId}
/redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Outlets/{OutletId}
6.84.3 Properties
Property Type Attributes Notes
ConfigurationLocked
boolean read-write Indicates whether the configuration is locked.
(v1.4+)
The current (A) for this single phase outlet. For more information
CurrentAmps {} object
about this property, see SensorCurrentExcerpt in Property Details.
array
ElectricalConsumerNames An array of names of downstream devices that are powered by
(string, read-write
(v1.3+) [ ] this outlet.
null)
string read-only The combination of current-carrying conductors. For the possible
ElectricalContext
(enum) (null) property values, see ElectricalContext in Property details.
object The energy (kWh) for this outlet. This object is an excerpt of the
EnergykWh {
(excerpt) Sensor resource located at the URI shown in DataSourceUri.
614 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
number read-only
ApparentkVAh (v1.5+) Apparent energy (kVAh).
(kV.A.h) (null)
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
LifetimeReading (v1.1+) number The total accumulation value for this sensor.
(null)
number read-only
ReactivekVARh (v1.5+) Reactive energy (kVARh).
(kV.A.h) (null)
read-only
Reading number The sensor value.
(null)
string
read-only The date and time when the time-based properties were last
SensorResetTime (date-
(null) reset.
time)
object The frequency (Hz) for this outlet. This object is an excerpt of the
FrequencyHz {
(excerpt) Sensor resource located at the URI shown in DataSourceUri.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
The state of the indicator LED, which identifies the outlet. For the
IndicatorLED (deprecated string read-write possible property values, see IndicatorLED in Property details.
v1.1) (enum) (null) Deprecated in v1.1 and later. This property has been deprecated
in favor of the LocationIndicatorActive property.
Links { object The links to other resources that are related to this resource.
A reference to the branch circuit related to this outlet. See the
BranchCircuit { object
(null) Circuit schema for details on this property.
Link to a Circuit resource. See the Links section and the Circuit
@odata.id string read-only
schema for details.
Chassis (v1.3+) [ { array Any array of links to chassis connected to this outlet.
Link to a Chassis resource. See the Links section and the Chassis
@odata.id string read-write
schema for details.
Version 2023.1 Published 615
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
}]
DistributionCircuits
array An array of links to mains or input circuits powered by this outlet.
(v1.3+) [ {
Link to a Circuit resource. See the Links section and the Circuit
@odata.id string read-write
schema for details.
}]
Oem {} object See the Oem object definition in the Common properties section.
PowerSupplies (v1.3+) [
array An array of links to the power supplies connected to this outlet.
{
Link to a PowerSupply resource. See the Links section and the
@odata.id string read-write
PowerSupply schema for details.
}]
LocationIndicatorActive read-write An indicator allowing an operator to physically locate this
boolean
(v1.1+) (null) resource.
string read-only The nominal voltage for this outlet. For the possible property
NominalVoltage
(enum) (null) values, see NominalVoltage in Property details.
The type of receptacle according to NEMA, IEC, or regional
string read-only
OutletType standards. For the possible property values, see OutletType in
(enum) (null)
Property details.
The number of ungrounded current-carrying conductors (phases)
string read-only
PhaseWiringType and the total number of conductors (wires). For the possible
(enum) (null)
property values, see PhaseWiringType in Property details.
PolyPhaseCurrentAmps { object The current readings for this outlet.
(null)
Line 1 current (A). For more information about this property, see
Line1 {} object
SensorCurrentExcerpt in Property Details.
Line 2 current (A). For more information about this property, see
Line2 {} object
SensorCurrentExcerpt in Property Details.
Line 3 current (A). For more information about this property, see
Line3 {} object
SensorCurrentExcerpt in Property Details.
Neutral line current (A). For more information about this property,
Neutral {} object
see SensorCurrentExcerpt in Property Details.
616 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
PolyPhaseVoltage { object The voltage readings for this outlet.
(null)
The Line 1 to Line 2 voltage (V) for this outlet. For more
Line1ToLine2 {} object information about this property, see SensorVoltageExcerpt in
Property Details.
The Line 1 to Neutral voltage (V) for this outlet. For more
Line1ToNeutral {} object information about this property, see SensorVoltageExcerpt in
Property Details.
The Line 2 to Line 3 voltage (V) for this outlet. For more
Line2ToLine3 {} object information about this property, see SensorVoltageExcerpt in
Property Details.
The Line 2 to Neutral voltage (V) for this outlet. For more
Line2ToNeutral {} object information about this property, see SensorVoltageExcerpt in
Property Details.
The Line 3 to Line 1 voltage (V) for this outlet. For more
Line3ToLine1 {} object information about this property, see SensorVoltageExcerpt in
Property Details.
The Line 3 to Neutral voltage (V) for this outlet. For more
Line3ToNeutral {} object information about this property, see SensorVoltageExcerpt in
Property Details.
PowerControlLocked (v1.4+) boolean read-write Indicates whether power control requests are locked.
read-write The number of seconds to delay power on after a PowerControl
PowerCycleDelaySeconds number
(null) action to cycle power. Zero seconds indicates no delay.
read-only
PowerEnabled boolean Indicates if the outlet can be powered.
(null)
object The power load (percent) for this outlet. This object is an excerpt
PowerLoadPercent (v1.2+) {
(excerpt) of the Sensor resource located at the URI shown in DataSourceUri.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
Version 2023.1 Published 617
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-write The number of seconds to delay power off after a PowerControl
PowerOffDelaySeconds number
(null) action. Zero seconds indicates no delay to power off.
The number of seconds to delay power up after a power cycle or
read-write
PowerOnDelaySeconds number a PowerControl action. Zero seconds indicates no delay to power
(null)
up.
read-write The number of seconds to delay power on after power has been
PowerRestoreDelaySeconds number
(null) restored. Zero seconds indicates no delay.
The desired power state of the outlet when power is restored
string
PowerRestorePolicy read-write after a power loss. For the possible property values, see
(enum)
PowerRestorePolicy in Property details.
string read-only The power state of the outlet. For the possible property values,
PowerState
(enum) (null) see PowerState in Property details.
PowerStateInTransition Indicates whether the power state is undergoing a delayed
boolean read-only
(v1.4+) transition.
object The power (W) for this outlet. This object is an excerpt of the
PowerWatts {
(excerpt) Sensor resource located at the URI shown in DataSourceUri.
number read-only The product of voltage and current for an AC circuit, in volt-
ApparentVA
(V.A) (null) ampere units.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
PhaseAngleDegrees read-only The phase angle (degrees) between the current and voltage
number
(v1.5+) (null) waveforms.
read-only
PowerFactor number The power factor for this sensor.
(null)
number read-only The square root of the difference term of squared apparent VA
ReactiveVAR
(V.A) (null) and squared power (Reading) for a circuit, in VAR units.
read-only
Reading number The sensor value.
(null)
number read-only
RatedCurrentAmps The rated maximum current allowed for this outlet.
(A) (null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
UserLabel (v1.3+) string read-write A user-assigned label.
618 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The voltage (V) for this single phase outlet. For more information
Voltage {} object
about this property, see SensorVoltageExcerpt in Property Details.
string read-only The type of voltage applied to the outlet. For the possible
VoltageType
(enum) (null) property values, see VoltageType in Property details.
6.84.4 Actions
6.84.4.1 PowerControl
Description
This action turns the outlet on or off.
Action URI
{Base URI of target resource}/Actions/Outlet.PowerControl
Action parameters
Parameter
Type Attributes Notes
Name
string The desired power state of the outlet. For the possible property values, see
PowerState optional
(enum) PowerState in Property details.
Request Example
{
"PowerState": "PowerCycle"
}
6.84.4.2 ResetMetrics
Description
This action resets metrics related to this outlet.
Action URI
Version 2023.1 Published 619
Redfish Resource and Schema Guide DSP2046
{Base URI of target resource}/Actions/Outlet.ResetMetrics
Action parameters
This action takes no parameters.
6.84.5 Property details
6.84.5.1 ElectricalContext
The combination of current-carrying conductors.
string Description
Line1 The circuits that share the L1 current-carrying conductor.
Line1ToLine2 The circuit formed by L1 and L2 current-carrying conductors.
Line1ToNeutral The circuit formed by L1 and neutral current-carrying conductors.
Line1ToNeutralAndL1L2 The circuit formed by L1, L2, and neutral current-carrying conductors.
Line2 The circuits that share the L2 current-carrying conductor.
Line2ToLine3 The circuit formed by L2 and L3 current-carrying conductors.
Line2ToNeutral The circuit formed by L2 and neutral current-carrying conductors.
Line2ToNeutralAndL1L2 The circuit formed by L1, L2, and Neutral current-carrying conductors.
Line2ToNeutralAndL2L3 The circuits formed by L2, L3, and neutral current-carrying conductors.
Line3 The circuits that share the L3 current-carrying conductor.
Line3ToLine1 The circuit formed by L3 and L1 current-carrying conductors.
Line3ToNeutral The circuit formed by L3 and neutral current-carrying conductors.
Line3ToNeutralAndL3L1 The circuit formed by L3, L1, and neutral current-carrying conductors.
LineToLine The circuit formed by two current-carrying conductors.
LineToNeutral The circuit formed by a line and neutral current-carrying conductor.
Neutral The grounded current-carrying return circuit of current-carrying conductors.
Total The circuit formed by all current-carrying conductors.
620 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.84.5.2 IndicatorLED
The state of the indicator LED, which identifies the outlet.
string Description
Blinking The indicator LED is blinking.
Lit The indicator LED is lit.
Off The indicator LED is off.
6.84.5.3 NominalVoltage
The nominal voltage for this outlet.
string Description
AC100To127V AC 100-127V nominal.
AC100To240V AC 100-240V nominal.
AC100To277V AC 100-277V nominal.
AC120V AC 120V nominal.
AC200To240V AC 200-240V nominal.
AC200To277V AC 200-277V nominal.
AC208V AC 208V nominal.
AC230V AC 230V nominal.
AC240AndDC380V AC 200-240V and DC 380V.
AC240V AC 240V nominal.
AC277AndDC380V AC 200-277V and DC 380V.
AC277V AC 277V nominal.
AC400V AC 400V or 415V nominal.
AC480V AC 480V nominal.
DC12V DC 12V nominal.
Version 2023.1 Published 621
Redfish Resource and Schema Guide DSP2046
string Description
DC16V DC 16V nominal.
DC1_8V DC 1.8V nominal.
DC240V DC 240V nominal.
DC380V High Voltage DC (380V).
DC3_3V DC 3.3V nominal.
DC48V DC 48V nominal.
DC5V DC 5V nominal.
DC9V DC 9V nominal.
DCNeg48V -48V DC.
6.84.5.4 OutletType
The type of receptacle according to NEMA, IEC, or regional standards.
string Description
BS_1363_Type_G BS 1363 Type G (250V; 13A).
BusConnection (v1.3+) Electrical bus connection.
CEE_7_Type_E CEE 7/7 Type E (250V; 16A).
CEE_7_Type_F CEE 7/7 Type F (250V; 16A).
IEC_60320_C13 IEC C13 (250V; 10A or 15A).
IEC_60320_C19 IEC C19 (250V; 16A or 20A).
NEMA_5_15R NEMA 5-15R (120V; 15A).
NEMA_5_20R NEMA 5-20R (120V; 20A).
NEMA_L5_20R NEMA L5-20R (120V; 20A).
NEMA_L5_30R NEMA L5-30R (120V; 30A).
NEMA_L6_20R NEMA L6-20R (250V; 20A).
NEMA_L6_30R NEMA L6-30R (250V; 30A).
SEV_1011_TYPE_12 SEV 1011 Type 12 (250V; 10A).
622 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
SEV_1011_TYPE_23 SEV 1011 Type 23 (250V; 16A).
6.84.5.5 PhaseWiringType
The number of ungrounded current-carrying conductors (phases) and the total number of conductors
(wires).
string Description
OneOrTwoPhase3Wire Single or Two-Phase / 3-Wire (Line1, Line2 or Neutral, Protective Earth).
OnePhase3Wire Single-phase / 3-Wire (Line1, Neutral, Protective Earth).
ThreePhase4Wire Three-phase / 4-Wire (Line1, Line2, Line3, Protective Earth).
ThreePhase5Wire Three-phase / 5-Wire (Line1, Line2, Line3, Neutral, Protective Earth).
TwoPhase3Wire Two-phase / 3-Wire (Line1, Line2, Protective Earth).
TwoPhase4Wire Two-phase / 4-Wire (Line1, Line2, Neutral, Protective Earth).
6.84.5.6 PowerRestorePolicy
The desired power state of the outlet when power is restored after a power loss.
string Description
AlwaysOff Always remain powered off when external power is applied.
AlwaysOn Always power on when external power is applied.
LastState Return to the last power state (on or off) when external power is applied.
6.84.5.7 PowerState
6.84.5.7.1 In top level:
The power state of the outlet.
Version 2023.1 Published 623
Redfish Resource and Schema Guide DSP2046
string Description
The resource is powered off. The components within the resource might continue to have
Off
AUX power.
On The resource is powered on.
Paused The resource is paused.
A temporary state between on and off. The components within the resource can take time to
PoweringOff
process the power off action.
A temporary state between off and on. The components within the resource can take time to
PoweringOn
process the power on action.
6.84.5.7.2 In Actions: PowerControl:
The desired power state of the outlet.
string Description
Off Power off.
On Power on.
PowerCycle Power cycle.
6.84.5.8 SensorCurrentExcerpt
The Sensor schema describes a sensor and its properties. This object is an excerpt of the Sensor
resource located at the URI shown in DataSourceUri.
read-
CrestFactor
number only The crest factor for this sensor.
(v1.1+)
(null)
read-
string
DataSourceUri only The link to the resource that provides the data for this sensor.
(URI)
(null)
read-
Reading number only The sensor value.
(null)
624 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
read-
THDPercent
number only The total harmonic distortion (THD).
(v1.1+)
(null)
6.84.5.9 SensorVoltageExcerpt
The Sensor schema describes a sensor and its properties. This object is an excerpt of the Sensor
resource located at the URI shown in DataSourceUri.
read-
CrestFactor
number only The crest factor for this sensor.
(v1.1+)
(null)
read-
string
DataSourceUri only The link to the resource that provides the data for this sensor.
(URI)
(null)
read-
Reading number only The sensor value.
(null)
read-
THDPercent
number only The total harmonic distortion (THD).
(v1.1+)
(null)
6.84.5.10 VoltageType
The type of voltage applied to the outlet.
string Description
AC Alternating Current (AC) outlet.
DC Direct Current (DC) outlet.
6.84.6 Example response
{
"@odata.type": "#Outlet.v1_4_1.Outlet",
"Id": "A1",
"Name": "Outlet A1, Branch Circuit A",
"Status": {
Version 2023.1 Published 625
Redfish Resource and Schema Guide DSP2046
"Health": "OK",
"State": "Enabled"
},
"PhaseWiringType": "OnePhase3Wire",
"VoltageType": "AC",
"OutletType": "NEMA_5_20R",
"RatedCurrentAmps": 20,
"NominalVoltage": "AC120V",
"LocationIndicatorActive": true,
"PowerOnDelaySeconds": 4,
"PowerOffDelaySeconds": 0,
"PowerState": "On",
"PowerEnabled": true,
"Voltage": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/VoltageA1",
"Reading": 117.5
},
"PolyPhaseVoltage": {
"Line1ToNeutral": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/VoltageA1",
"Reading": 117.5
}
},
"CurrentAmps": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/CurrentA1",
"Reading": 1.68
},
"PolyPhaseCurrentAmps": {
"Line1": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/CurrentA1",
"Reading": 1.68
}
},
"PowerWatts": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/PowerA1",
"Reading": 197.4,
"ApparentVA": 197.4,
"ReactiveVAR": 0,
"PowerFactor": 1
},
"FrequencyHz": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/FrequencyA1",
"Reading": 60
},
"EnergykWh": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/EnergyA1",
"Reading": 36166
},
"Actions": {
"#Outlet.PowerControl": {
626 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"target": "/redfish/v1/PowerEquipment/RackPDUs/1/Outlets/A1/Outlet.PowerControl"
},
"#Outlet.ResetMetrics": {
"target": "/redfish/v1/PowerEquipment/RackPDUs/1/Outlets/A1/Outlet.ResetMetrics"
}
},
"Links": {
"BranchCircuit": {
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Branches/A"
}
},
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Outlets/A1"
}
6.85 OutletGroup 1.1.1
Version v1.1 v1.0
Release 2021.4 2019.4
6.85.1 Description
The OutletGroup schema contains definitions for an electrical outlet group.
6.85.2 URIs
/redfish/v1/PowerEquipment/ElectricalBuses/{PowerDistributionId}/OutletGroups/{OutletGroupId}
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/OutletGroups/{OutletGroupId}
/redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/OutletGroups/{OutletGroupId}
/redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/OutletGroups/{OutletGroupId}
6.85.3 Properties
Property Type Attributes Notes
ConfigurationLocked
boolean read-write Indicates whether the configuration is locked.
(v1.1+)
read-write
CreatedBy string The creator of this outlet group.
(null)
Version 2023.1 Published 627
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
object The energy (kWh) for this outlet group. This object is an excerpt
EnergykWh {
(excerpt) of the Sensor resource located at the URI shown in DataSourceUri.
number read-only
ApparentkVAh (v1.5+) Apparent energy (kVAh).
(kV.A.h) (null)
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
LifetimeReading (v1.1+) number The total accumulation value for this sensor.
(null)
number read-only
ReactivekVARh (v1.5+) Reactive energy (kVARh).
(kV.A.h) (null)
read-only
Reading number The sensor value.
(null)
string
read-only The date and time when the time-based properties were last
SensorResetTime (date-
(null) reset.
time)
Links { object The links to other resources that are related to this resource.
Oem {} object See the Oem object definition in the Common properties section.
Outlets [ { array The set of outlets in this outlet group.
Link to a Outlet resource. See the Links section and the Outlet
@odata.id string read-write
schema for details.
}]
PowerControlLocked (v1.1+) boolean read-write Indicates whether power control requests are locked.
read-write The number of seconds to delay power on after a PowerControl
PowerCycleDelaySeconds number
(null) action to cycle power. Zero seconds indicates no delay.
read-only
PowerEnabled boolean Indicates if the outlet group can be powered.
(null)
read-write The number of seconds to delay power off after a PowerControl
PowerOffDelaySeconds number
(null) action. Zero seconds indicates no delay to power off.
The number of seconds to delay power up after a power cycle or
read-write
PowerOnDelaySeconds number a PowerControl action. Zero seconds indicates no delay to power
(null)
up.
628 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write The number of seconds to delay power on after power has been
PowerRestoreDelaySeconds number
(null) restored. Zero seconds indicates no delay.
The desired power state of the outlet group when power is
string
PowerRestorePolicy read-write restored after a power loss. For the possible property values, see
(enum)
PowerRestorePolicy in Property details.
string read-only The power state of the outlet group. For the possible property
PowerState
(enum) (null) values, see PowerState in Property details.
PowerStateInTransition Indicates whether the power state is undergoing a delayed
boolean read-only
(v1.1+) transition.
object The power (W) for this outlet group. This object is an excerpt of
PowerWatts {
(excerpt) the Sensor resource located at the URI shown in DataSourceUri.
number read-only The product of voltage and current for an AC circuit, in volt-
ApparentVA
(V.A) (null) ampere units.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
PhaseAngleDegrees read-only The phase angle (degrees) between the current and voltage
number
(v1.5+) (null) waveforms.
read-only
PowerFactor number The power factor for this sensor.
(null)
number read-only The square root of the difference term of squared apparent VA
ReactiveVAR
(V.A) (null) and squared power (Reading) for a circuit, in VAR units.
read-only
Reading number The sensor value.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
6.85.4 Actions
6.85.4.1 PowerControl
Description
This action turns the outlet group on or off.
Action URI
Version 2023.1 Published 629
Redfish Resource and Schema Guide DSP2046
{Base URI of target resource}/Actions/OutletGroup.PowerControl
Action parameters
Parameter
Type Attributes Notes
Name
string The desired power state of the outlet group. For the possible property values,
PowerState optional
(enum) see PowerState in Property details.
Request Example
{
"PowerState": "Off"
}
6.85.4.2 ResetMetrics
Description
This action resets metrics related to this outlet group.
Action URI
{Base URI of target resource}/Actions/OutletGroup.ResetMetrics
Action parameters
This action takes no parameters.
6.85.5 Property details
6.85.5.1 PowerRestorePolicy
The desired power state of the outlet group when power is restored after a power loss.
string Description
AlwaysOff Always remain powered off when external power is applied.
AlwaysOn Always power on when external power is applied.
630 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
LastState Return to the last power state (on or off) when external power is applied.
6.85.5.2 PowerState
6.85.5.2.1 In top level:
The power state of the outlet group.
string Description
The resource is powered off. The components within the resource might continue to have
Off
AUX power.
On The resource is powered on.
Paused The resource is paused.
A temporary state between on and off. The components within the resource can take time to
PoweringOff
process the power off action.
A temporary state between off and on. The components within the resource can take time to
PoweringOn
process the power on action.
6.85.5.2.2 In Actions: PowerControl:
The desired power state of the outlet group.
string Description
Off Power off.
On Power on.
PowerCycle Power cycle.
6.85.6 Example response
{
"@odata.type": "#OutletGroup.v1_1_1.OutletGroup",
"Id": "Rack5Storage",
"Name": "Outlet Group Rack5Storage",
Version 2023.1 Published 631
Redfish Resource and Schema Guide DSP2046
"Status": {
"Health": "OK",
"State": "Enabled"
},
"CreatedBy": "Bob",
"PowerOnDelaySeconds": 4,
"PowerOffDelaySeconds": 0,
"PowerState": "On",
"PowerEnabled": true,
"PowerWatts": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/GroupPowerA",
"Reading": 412.36
},
"EnergykWh": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/GroupEnergyA",
"Reading": 26880
},
"Links": {
"Outlets": [
{
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Outlets/A1"
},
{
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Outlets/A2"
},
{
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Outlets/A3"
}
]
},
"Actions": {
"#OutletGroup.PowerControl": {
"target": "/redfish/v1/PowerEquipment/RackPDUs/1/OutletGroups/Rack5Storage/OutletGroup.PowerControl"
},
"#OutletGroup.ResetMetrics": {
"target": "/redfish/v1/PowerEquipment/RackPDUs/1/OutletGroups/Rack5Storage/OutletGroup.ResetMetrics"
}
},
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/OutletGroups/Rack5Storage"
}
6.86 PCIeDevice 1.11.1
Version v1.11 v1.10 v1.9 v1.8 v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 ...
Release 2022.3 2022.2 2021.4 2021.3 2021.1 2020.4 2020.3 2019.2 2018.2 2017.3 2017.1 ...
632 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.86.1 Description
The PCIeDevice schema describes the properties of a PCIe device that is attached to a system. It also
describes the location, such as a slot, socket, or bay, where a unit can be installed, by populating a
resource instance with an absent state if a unit is not present.
6.86.2 URIs
/redfish/v1/Chassis/{ChassisId}/PCIeDevices/{PCIeDeviceId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
PCIeDevices/{PCIeDeviceId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/PCIeDevices/
{PCIeDeviceId}
/redfish/v1/Systems/{ComputerSystemId}/PCIeDevices/{PCIeDeviceId}
6.86.3 Properties
Property Type Attributes Notes
The link to the assembly associated with this PCIe device.
Assembly (v1.2+) { object
See the Assembly schema for details on this property.
Link to a Assembly resource. See the Links section and the
@odata.id string read-only
Assembly schema for details.
read-write
AssetTag string The user-assigned asset tag for this PCIe device.
(null)
CXLDevice (v1.11+) { object The CXL-specific properties of this PCIe device.
(null)
string read-only The CXL device type. For the possible property values, see
DeviceType (v1.11+)
(enum) (null) DeviceType in Property details.
EgressPortCongestionSupport read-only Indicates whether the CXL device supports egress port
boolean
(v1.11+) (null) congestion management.
MaxNumberLogicalDevices read-only The maximum number of logical devices supported by this
number
(v1.11+) (null) CXL device.
ThroughputReductionSupport read-only Indicates whether the CXL device supports throughput
boolean
(v1.11+) (null) reduction.
Version 2023.1 Published 633
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
string
Timestamp (v1.11+) (date- read-write The timestamp set on the CXL device.
time)
The link to the collection of CXL logical devices within this
CXLLogicalDevices (v1.11+) { object
PCIe device. Contains a link to a resource.
Link to Collection of CXLLogicalDevice. See the
@odata.id string read-only
CXLLogicalDevice schema for details.
string The device type for this PCIe device. For the possible
DeviceType read-only
(enum) property values, see DeviceType in Property details.
The link to the environment metrics for this PCIe device. See
EnvironmentMetrics (v1.7+) { object
the EnvironmentMetrics schema for details on this property.
Link to a EnvironmentMetrics resource. See the Links section
@odata.id string read-only
and the EnvironmentMetrics schema for details.
read-only
FirmwareVersion string The version of firmware for this PCIe device.
(null)
Links { object The links to other resources that are related to this resource.
An array of links to the chassis in which the PCIe device is
Chassis [ { array
contained.
Link to a Chassis resource. See the Links section and the
@odata.id string read-only
Chassis schema for details.
}]
See the Oem object definition in the Common properties
Oem {} object
section.
An array of links to PCIe functions exposed by this device.
PCIeFunctions (deprecated Deprecated in v1.4 and later. This property has been
array
v1.4) [ { deprecated in favor of the PCIeFunctions property in the root
that provides a link to a resource collection.
Link to a PCIeFunction resource. See the Links section and
@odata.id string read-only
the PCIeFunction schema for details.
}]
634 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The link to a switch that is associated with this PCIe device.
Switch (v1.10+) { object
(null) See the Switch schema for details on this property.
Link to a Switch resource. See the Links section and the
@odata.id string read-only
Switch schema for details.
read-only
Manufacturer string The manufacturer of this PCIe device.
(null)
read-only
Model string The model number for the PCIe device.
(null)
read-only
PartNumber string The part number for this PCIe device.
(null)
The link to the collection of PCIe functions associated with
PCIeFunctions (v1.4+) { object
this PCIe device. Contains a link to a resource.
Link to Collection of PCIeFunction. See the PCIeFunction
@odata.id string read-only
schema for details.
PCIeInterface (v1.3+) { object The PCIe interface details for this PCIe device.
read-only
LanesInUse (v1.3+) integer The number of PCIe lanes in use by this device.
(null)
read-only
MaxLanes (v1.3+) integer The number of PCIe lanes supported by this device.
(null)
The highest version of the PCIe specification supported by
string read-only
MaxPCIeType (v1.3+) this device. For the possible property values, see
(enum) (null)
MaxPCIeType in Property details.
See the Oem object definition in the Common properties
Oem (v1.3+) {} object
section.
The version of the PCIe specification in use by this device.
string read-only
PCIeType (v1.3+) For the possible property values, see PCIeType in Property
(enum) (null)
details.
read-write An indication of whether the PCIe device is prepared by the
ReadyToRemove (v1.7+) boolean
(null) system for removal.
Version 2023.1 Published 635
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
SerialNumber string The serial number for this PCIe device.
(null)
read-only
SKU string The SKU for this PCIe device.
(null)
Slot (v1.9+) { object Information about the slot for this PCIe device.
(null)
read-only
Lanes (v1.9+) integer The number of PCIe lanes supported by this slot.
(null)
The lane splitting strategy used in the PCIe slot. For the
string read-only
LaneSplitting (v1.9+) possible property values, see LaneSplitting in Property
(enum) (null)
details.
The location of the PCIe slot. For property details, see
Location (v1.9+) {} object
Location.
string read-only The PCIe specification this slot supports. For the possible
PCIeType (v1.9+)
(enum) (null) property values, see PCIeType in Property details.
string read-only The PCIe slot type. For the possible property values, see
SlotType (v1.9+)
(enum) (null) SlotType in Property details.
read-only
SparePartNumber (v1.6+) string The spare part number of the PCIe device.
(null)
The staged firmware version for this PCIe device, but is not
StagedVersion (v1.11+) string read-only
yet active.
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
string read-only
UUID (v1.5+) The UUID for this PCIe device.
(uuid) (null)
6.86.4 Property details
6.86.4.1 DeviceType
6.86.4.1.1 In top level:
The device type for this PCIe device.
636 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
MultiFunction A multi-function PCIe device.
Retimer (v1.10+) A PCIe retimer device.
A PCIe device that is not currently physically present, but is being simulated by the PCIe
Simulated
infrastructure.
SingleFunction A single-function PCIe device.
6.86.4.1.2 In CXLDevice:
The CXL device type.
string Description
Type1 A CXL Type 1 device.
Type2 A CXL Type 2 device.
Type3 A CXL Type 3 device.
6.86.4.2 LaneSplitting
The lane splitting strategy used in the PCIe slot.
string Description
Bifurcated The slot is bifurcated to split the lanes with associated devices.
Bridged The slot has a bridge to share the lanes with associated devices.
None The slot has no lane splitting.
6.86.4.3 MaxPCIeType
The highest version of the PCIe specification supported by this device.
string Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
Version 2023.1 Published 637
Redfish Resource and Schema Guide DSP2046
string Description
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.
6.86.4.4 PCIeType
The version of the PCIe specification in use by this device.
string Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.
6.86.4.5 SlotType
The PCIe slot type.
string Description
FullLength Full-Length PCIe slot.
HalfLength Half-Length PCIe slot.
LowProfile Low-Profile or Slim PCIe slot.
M2 PCIe M.2 slot.
Mini Mini PCIe slot.
OCP3Large Open Compute Project 3.0 large form factor slot.
OCP3Small Open Compute Project 3.0 small form factor slot.
OEM An OEM-specific slot.
U2 U.2 / SFF-8639 slot or bay.
638 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.86.5 Example response
{
"@odata.type": "#PCIeDevice.v1_11_1.PCIeDevice",
"Id": "NIC",
"Name": "Simple Two-Port NIC",
"Description": "Simple Two-Port NIC PCIe Device",
"AssetTag": "ORD-4302015-18432RS",
"Manufacturer": "Contoso",
"Model": "SuperNIC 2000",
"SKU": "89587433",
"SerialNumber": "2M220100SL",
"PartNumber": "232-4598D7",
"DeviceType": "MultiFunction",
"FirmwareVersion": "12.342-343",
"Status": {
"State": "Enabled",
"Health": "OK",
"HealthRollup": "OK"
},
"PCIeInterface": {
"PCIeType": "Gen2",
"MaxPCIeType": "Gen3",
"LanesInUse": 4,
"MaxLanes": 4
},
"PCIeFunctions": {
"@odata.id": "/redfish/v1/Systems/1/PCIeDevices/NIC/PCIeFunctions"
},
"Links": {
"Chassis": [
{
"@odata.id": "/redfish/v1/Chassis/1"
}
]
},
"@odata.id": "/redfish/v1/Systems/1/PCIeDevices/NIC"
}
6.87 PCIeFunction 1.5.0
Version v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.3 2022.2 2021.1 2018.1 2017.1 2016.2
Version 2023.1 Published 639
Redfish Resource and Schema Guide DSP2046
6.87.1 Description
The PCIeFunction schema describes the properties of a PCIe function that is attached to a system.
6.87.2 URIs
/redfish/v1/Chassis/{ChassisId}/PCIeDevices/{PCIeDeviceId}/PCIeFunctions/{PCIeFunctionId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
PCIeDevices/{PCIeDeviceId}/PCIeFunctions/{PCIeFunctionId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/PCIeDevices/
{PCIeDeviceId}/PCIeFunctions/{PCIeFunctionId}
/redfish/v1/Systems/{ComputerSystemId}/PCIeDevices/{PCIeDeviceId}/PCIeFunctions/
{PCIeFunctionId}
6.87.3 Properties
Property Type Attributes Notes
read-only
ClassCode string The Class Code of this PCIe function.
(null)
string The class for this PCIe function. For the possible property values,
DeviceClass read-only
(enum) see DeviceClass in Property details.
read-only
DeviceId string The Device ID of this PCIe function.
(null)
Enabled (v1.3+) boolean read-write An indication of whether this PCIe device function is enabled.
read-only
FunctionId integer The PCIe function number.
(null)
string read-only The PCIe function protocol. For the possible property values, see
FunctionProtocol (v1.5+)
(enum) (null) FunctionProtocol in Property details.
string The type of the PCIe function. For the possible property values,
FunctionType read-only
(enum) see FunctionType in Property details.
Links { object The links to other resources that are related to this resource.
The link to the CXL logical device to which this function is
CXLLogicalDevice
object assigned. See the CXLLogicalDevice schema for details on this
(v1.5+) { (null)
property.
Link to a CXLLogicalDevice resource. See the Links section and
@odata.id string read-only
the CXLLogicalDevice schema for details.
640 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Drives [ { array An array of links to the drives that this PCIe function produces.
Link to a Drive resource. See the Links section and the Drive
@odata.id string read-only
schema for details.
}]
An array of links to the Ethernet interfaces that this PCIe function
EthernetInterfaces [ { array
produces.
Link to a EthernetInterface resource. See the Links section and
@odata.id string read-only
the EthernetInterface schema for details.
}]
MemoryDomains (v1.5+) An array of links to the memory domains that the PCIe function
array
[{ produces.
Link to a MemoryDomain resource. See the Links section and the
@odata.id string read-only
MemoryDomain schema for details.
}]
NetworkDeviceFunctions An array of links to the network device functions that the PCIe
array
(v1.2+) [ { function produces.
Link to a NetworkDeviceFunction resource. See the Links section
@odata.id string read-only
and the NetworkDeviceFunction schema for details.
}]
Oem {} object See the Oem object definition in the Common properties section.
The link to the PCIe device on which this function resides. See the
PCIeDevice { object
PCIeDevice schema for details on this property.
Link to a PCIeDevice resource. See the Links section and the
@odata.id string read-only
PCIeDevice schema for details.
The link to a processor that is hosted on this PCIe function. See
Processor (v1.4+) { object
(null) the Processor schema for details on this property.
Link to a Processor resource. See the Links section and the
@odata.id string read-only
Processor schema for details.
Version 2023.1 Published 641
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
An array of links to the storage controllers that this PCIe function
StorageControllers [ { array
produces.
Link to a StorageController resource. See the Links section and
@odata.id string read-only
the Storage schema for details.
}]
read-only
RevisionId string The Revision ID of this PCIe function.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
read-only
SubsystemId string The Subsystem ID of this PCIe function.
(null)
read-only
SubsystemVendorId string The Subsystem Vendor ID of this PCIe function.
(null)
read-only
VendorId string The Vendor ID of this PCIe function.
(null)
6.87.4 Property details
6.87.4.1 DeviceClass
The class for this PCIe function.
string Description
Bridge A bridge.
CommunicationController A communication controller.
Coprocessor A coprocessor.
DisplayController A display controller.
DockingStation A docking station.
EncryptionController An encryption controller.
GenericSystemPeripheral A generic system peripheral.
642 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
InputDeviceController An input device controller.
IntelligentController An intelligent controller.
MassStorageController A mass storage controller.
MemoryController A memory controller.
MultimediaController A multimedia controller.
NetworkController A network controller.
NonEssentialInstrumentation A non-essential instrumentation.
Other Other class. The function Class Code needs to be verified.
ProcessingAccelerators A processing accelerators.
Processor A processor.
SatelliteCommunicationsController A satellite communications controller.
SerialBusController A serial bus controller.
SignalProcessingController A signal processing controller.
UnassignedClass An unassigned class.
UnclassifiedDevice An unclassified device.
WirelessController A wireless controller.
6.87.4.2 FunctionProtocol
The PCIe function protocol.
string Description
CXL A PCIe function supporting CXL extensions.
PCIe A standard PCIe function.
6.87.4.3 FunctionType
The type of the PCIe function.
Version 2023.1 Published 643
Redfish Resource and Schema Guide DSP2046
string Description
Physical A physical PCIe function.
Virtual A virtual PCIe function.
6.87.5 Example response
{
"@odata.type": "#PCIeFunction.v1_5_0.PCIeFunction",
"Id": "2",
"Name": "FC Port 2",
"Description": "FC Port 2",
"FunctionId": 2,
"FunctionType": "Physical",
"DeviceClass": "NetworkController",
"DeviceId": "0xABCD",
"VendorId": "0xABCD",
"ClassCode": "0x010802",
"RevisionId": "0x00",
"SubsystemId": "0xABCD",
"SubsystemVendorId": "0xABCD",
"Status": {
"State": "Enabled",
"Health": "OK",
"HealthRollup": "OK"
},
"Links": {
"PCIeDevice": {
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/FC"
}
},
"@odata.id": "/redfish/v1/Chassis/1/PCIeDevices/FC/PCIeFunctions/2"
}
6.88 PCIeSlots 1.5.0
Version v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2021.3 2020.3 2020.1 2019.4 2019.1 2018.2
6.88.1 Description
The PCIeSlots schema describes PCIe slot properties.
644 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.88.2 URIs
/redfish/v1/Chassis/{ChassisId}/PCIeSlots
6.88.3 Properties
Property Type Attributes Notes
Slots [ { array An array of PCI Slot information.
read-only
HotPluggable (v1.1+) boolean An indication of whether this PCIe slot supports hotplug.
(null)
read-only
Lanes integer The number of PCIe lanes supported by this slot.
(null)
Links { object The links to other Resources that are related to this Resource.
Oem {} object See the Oem object definition in the Common properties section.
PCIeDevice [ { array An array of links to the PCIe devices contained in this slot.
Link to a PCIeDevice resource. See the Links section and the
@odata.id string read-only
PCIeDevice schema for details.
}]
Processors (v1.5+) [ An array of links to the processors that are directly connected or
array
{ directly bridged to this PCIe slot.
Link to a Processor resource. See the Links section and the
@odata.id string read-only
Processor schema for details.
}]
Location {} object The location of the PCIe slot. For property details, see Location.
LocationIndicatorActive read-write An indicator allowing an operator to physically locate this
boolean
(v1.4+) (null) resource.
Oem {} object See the Oem object definition in the Common properties section.
string read-only The PCIe specification supported by this slot. For the possible
PCIeType
(enum) (null) property values, see PCIeType in Property details.
string read-only The PCIe slot type for this slot. For the possible property values,
SlotType
(enum) (null) see SlotType in Property details.
Version 2023.1 Published 645
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The status and health of the Resource and its subordinate or
Status {} object
dependent Resources. For property details, see Status.
}]
6.88.4 Property details
6.88.4.1 PCIeType
The PCIe specification supported by this slot.
string Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.
6.88.4.2 SlotType
The PCIe slot type for this slot.
string Description
FullLength Full-Length PCIe slot.
HalfLength Half-Length PCIe slot.
LowProfile Low-Profile or Slim PCIe slot.
M2 PCIe M.2 slot.
Mini Mini PCIe slot.
OCP3Large (v1.2+) Open Compute Project 3.0 large form factor slot.
OCP3Small (v1.2+) Open Compute Project 3.0 small form factor slot.
OEM An OEM-specific slot.
646 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
U2 (v1.3+) U.2 / SFF-8639 slot or bay.
6.88.5 Example response
{
"@odata.type": "#PCIeSlots.v1_5_0.PCIeSlots",
"Id": "1",
"Name": "PCIe Slot Information",
"Slots": [
{
"PCIeType": "Gen3",
"Lanes": 16,
"SlotType": "FullLength",
"Status": {
"State": "Enabled"
},
"Location": {
"PartLocation": {
"ServiceLabel": "Slot 1",
"LocationOrdinalValue": 1,
"LocationType": "Slot",
"Orientation": "LeftToRight",
"Reference": "Rear"
}
},
"Links": {
"PCIeDevice": [
{
"@odata.id": "/redfish/v1/Systems/1/PCIeDevices/NIC"
}
]
}
},
{
"PCIeType": "Gen4",
"Lanes": 4,
"SlotType": "FullLength",
"Status": {
"State": "Absent"
},
"Location": {
"PartLocation": {
"ServiceLabel": "Slot 2",
"LocationOrdinalValue": 2,
"LocationType": "Slot",
"Orientation": "LeftToRight",
Version 2023.1 Published 647
Redfish Resource and Schema Guide DSP2046
"Reference": "Rear"
}
}
},
{
"PCIeType": "Gen3",
"Lanes": 1,
"SlotType": "HalfLength",
"Status": {
"State": "Absent"
},
"Location": {
"PartLocation": {
"ServiceLabel": "Slot 3",
"LocationOrdinalValue": 3,
"LocationType": "Slot",
"Orientation": "LeftToRight",
"Reference": "Rear"
}
}
}
],
"@odata.id": "/redfish/v1/Chassis/1/PCIeSlots"
}
6.89 Port 1.9.0
Version v1.9 v1.8 v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2023.1 2022.3 2022.2 2021.4 2021.2 2021.1 2020.3 2019.4 2017.3 2016.2
6.89.1 Description
The Port schema contains properties that describe a port of a switch, controller, chassis, or any other
device that could be connected to another entity.
6.89.2 URIs
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}
/redfish/v1/Chassis/{ChassisId}/MediaControllers/{MediaControllerId}/Ports/{PortId}
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Ports/{PortId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Ports/
{PortId}
648 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/
{StorageControllerId}/Ports/{PortId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/
StorageControllers/{StorageControllerId}/Ports/{PortId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/Ports/{PortId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
GraphicsControllers/{ControllerId}/Ports/{PortId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}/Ports/{PortId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/Controllers/{StorageControllerId}/Ports/{PortId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
USBControllers/{ControllerId}/Ports/{PortId}
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}
/redfish/v1/Managers/{ManagerId}/DedicatedNetworkPorts/{PortId}
/redfish/v1/Managers/{ManagerId}/USBPorts/{PortId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Ports/{PortId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{StorageControllerId}/
Ports/{PortId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/
{StorageControllerId}/Ports/{PortId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/
{FabricAdapterId}/Ports/{PortId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/GraphicsControllers/
{ControllerId}/Ports/{PortId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/
{ProcessorId}/Ports/{PortId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
Controllers/{StorageControllerId}/Ports/{PortId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
StorageControllers/{StorageControllerId}/Ports/{PortId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/USBControllers/
{ControllerId}/Ports/{PortId}
/redfish/v1/Storage/{StorageId}/Controllers/{StorageControllerId}/Ports/{PortId}
/redfish/v1/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}
/redfish/v1/Systems/{ComputerSystemId}/GraphicsControllers/{ControllerId}/Ports/{PortId}
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Ports/{PortId}
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/
Ports/{PortId}
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/
Version 2023.1 Published 649
Redfish Resource and Schema Guide DSP2046
{StorageControllerId}/Ports/{PortId}
/redfish/v1/Systems/{ComputerSystemId}/USBControllers/{ControllerId}/Ports/{PortId}
6.89.3 Properties
Property Type Attributes Notes
The number of active lanes for this
ActiveWidth (v1.2+) integer read-only
interface.
array
The protocol versions capable of being
CapableProtocolVersions (v1.4+) [ ] (string, read-only
sent over this port.
null)
read-only The protocol version being sent over this
CurrentProtocolVersion (v1.4+) string
(null) port.
number read-only
CurrentSpeedGbps The current speed of this port.
(Gbit/s) (null)
CXL (v1.8+) { object CXL properties for this port.
(null)
The congestion properties for this CXL
Congestion (v1.8+) { object
(null) port.
The interval for the CXL Specification-
read-write defined 'Egress Port Congestion'
BackpressureSampleInterval (v1.8+) integer
(null) mechanism to take samples in
nanoseconds.
The interval for the CXL Specification-
defined 'Completion Counting' mechanism
read-write
CompletionCollectionInterval (v1.8+) integer to collect the number of transmitted
(null)
responses in a single counter in
nanoseconds.
read-write Indicates whether congestion telemetry
CongestionTelemetryEnabled (v1.8+) boolean
(null) collection is enabled for this port.
integer read-write The threshold for moderate egress port
EgressModeratePercentage (v1.8+)
(%) (null) congestion as a percentage.
integer read-write The threshold for severe egress port
EgressSeverePercentage (v1.8+)
(%) (null) congestion as a percentage.
The estimated maximum sustained sum of
requests and recent responses across the
read-write
MaxSustainedRequestCmpBias (v1.8+) integer entire device, serving as the basis for the
(null)
CXL Specification-defined 'QoS Limit
Fraction'.
650 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The connected device mode. For the
string read-only
ConnectedDeviceMode (v1.8+) possible property values, see
(enum) (null)
ConnectedDeviceMode in Property details.
The connected device type. For the
string read-only
ConnectedDeviceType (v1.8+) possible property values, see
(enum) (null)
ConnectedDeviceType in Property details.
The current port configuration state. For
string read-only the possible property values, see
CurrentPortConfigurationState (v1.8+)
(enum) (null) CurrentPortConfigurationState in Property
details.
read-only The maximum number of logical devices
MaxLogicalDeviceCount (v1.8+) integer
(null) supported.
The quality of service telemetry
QoSTelemetryCapabilities (v1.8+) { object
(null) capabilities for this CXL port.
Indicates whether the port supports the
read-only
EgressPortBackpressureSupported (v1.8+) boolean CXL Specification-defined 'Egress Port
(null)
Backpressure' mechanism.
Indicates whether the port supports the
TemporaryThroughputReductionSupported read-only
boolean CXL Specification-defined 'Temporary
(v1.8+) (null)
Throughput Reduction' mechanism.
TemporaryThroughputReductionEnabled read-write Indicates whether temporary throughput
boolean
(v1.8+) (null) reduction is enabled.
An indication of whether this port is
Enabled (v1.4+) boolean read-write
enabled.
The link to the environment metrics for
this port or any attached small form-factor
EnvironmentMetrics (v1.4+) { object pluggable (SFP) device. See the
EnvironmentMetrics schema for details on
this property.
Link to a EnvironmentMetrics resource.
@odata.id string read-only See the Links section and the
EnvironmentMetrics schema for details.
Version 2023.1 Published 651
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Ethernet (v1.3+) { object Ethernet properties for this port.
(null)
An array of configured MAC addresses that
are associated with this network port,
array including the programmed address of the
AssociatedMACAddresses (v1.4+) [ ] (string, read-only lowest numbered network device function,
null) the configured but not active address, if
applicable, the address for hardware port
teaming, or other network addresses.
Indicates whether IEEE 802.3az Energy-
read-write
EEEEnabled (v1.5+) boolean Efficient Ethernet (EEE) is enabled on this
(null)
port.
The locally configured 802.3x flow control
setting for this port. For the possible
string read-write
FlowControlConfiguration (v1.3+) property values, see
(enum) (null)
FlowControlConfiguration in Property
details.
The 802.3x flow control behavior
string read-only negotiated with the link partner for this
FlowControlStatus (v1.3+)
(enum) (null) port. For the possible property values, see
FlowControlStatus in Property details.
LLDPEnabled (v1.4+) boolean read-write Enable/disable LLDP for this port.
LLDPReceive (v1.4+) { object LLDP data being received on this link.
(null)
Link Layer Data Protocol (LLDP) chassis ID
read-only
ChassisId (v1.4+) string received from the remote partner across
(null)
this link.
The type of identifier used for the chassis
ID received from the remote partner
string read-only
ChassisIdSubtype (v1.4+) across this link. For the possible property
(enum) (null)
values, see ChassisIdSubtype in Property
details.
read-only The IPv4 management address received
ManagementAddressIPv4 (v1.4+) string
(null) from the remote partner across this link.
read-only The IPv6 management address received
ManagementAddressIPv6 (v1.4+) string
(null) from the remote partner across this link.
read-only The management MAC address received
ManagementAddressMAC (v1.4+) string
(null) from the remote partner across this link.
652 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only The management VLAN ID received from
ManagementVlanId (v1.4+) integer
(null) the remote partner across this link.
read-only A colon delimited string of hexadecimal
PortId (v1.4+) string
(null) octets identifying a port.
The port ID subtype received from the
string read-only remote partner across this link. For the
PortIdSubtype (v1.4+)
(enum) (null) possible property values, see
PortIdSubtype in Property details.
The system capabilities received from the
array
read-only remote partner across this link. For the
SystemCapabilities (v1.8+) [ ] (string
(null) possible property values, see
(enum))
SystemCapabilities in Property details.
read-only The system description received from the
SystemDescription (v1.8+) string
(null) remote partner across this link.
read-only The system name received from the
SystemName (v1.8+) string
(null) remote partner across this link.
LLDPTransmit (v1.4+) { object LLDP data being transmitted on this link.
(null)
read-write
ChassisId (v1.4+) string Link Layer Data Protocol (LLDP) chassis ID.
(null)
The type of identifier used for the chassis
string read-write
ChassisIdSubtype (v1.4+) ID. For the possible property values, see
(enum) (null)
ChassisIdSubtype in Property details.
read-write The IPv4 management address to be
ManagementAddressIPv4 (v1.4+) string
(null) transmitted from this endpoint.
read-write The IPv6 management address to be
ManagementAddressIPv6 (v1.4+) string
(null) transmitted from this endpoint.
read-write The management MAC address to be
ManagementAddressMAC (v1.4+) string
(null) transmitted from this endpoint.
read-write The management VLAN ID to be
ManagementVlanId (v1.4+) integer
(null) transmitted from this endpoint.
A colon delimited string of hexadecimal
read-write
PortId (v1.4+) string octets identifying a port to be transmitted
(null)
from this endpoint.
Version 2023.1 Published 653
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The port ID subtype to be transmitted from
string read-write this endpoint. For the possible property
PortIdSubtype (v1.4+)
(enum) (null) values, see PortIdSubtype in Property
details.
The system capabilities to be transmitted
array
read-write from this endpoint. For the possible
SystemCapabilities (v1.8+) [ ] (string
(null) property values, see SystemCapabilities in
(enum))
Property details.
read-write The system description to be transmitted
SystemDescription (v1.8+) string
(null) from this endpoint.
read-write The system name to be transmitted from
SystemName (v1.8+) string
(null) this endpoint.
The set of Ethernet capabilities that this
port supports. For the possible property
array values, see SupportedEthernetCapabilities
SupportedEthernetCapabilities (v1.3+, read-only
(string in Property details. Deprecated in v1.5 and
deprecated v1.5 [ ] (null)
(enum)) later. This property has been deprecated in
favor of individual fields for the various
properties.
read-write Indicates whether Wake on LAN (WoL) is
WakeOnLANEnabled (v1.5+) boolean
(null) enabled on this port.
FibreChannel (v1.3+) { object Fibre Channel properties for this port.
(null)
An array of configured World Wide Names
(WWN) that are associated with this
network port, including the programmed
array
address of the lowest numbered network
AssociatedWorldWideNames (v1.4+) [ ] (string, read-only
device function, the configured but not
null)
active address, if applicable, the address
for hardware port teaming, or other
network addresses.
read-only The Fibre Channel Fabric Name provided
FabricName (v1.3+) string
(null) by the switch.
The number of ports not on the associated
read-only
NumberDiscoveredRemotePorts (v1.3+) integer device that the associated device has
(null)
discovered through this port.
654 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The connection type of this port. For the
string read-only
PortConnectionType (v1.3+) possible property values, see
(enum) (null)
PortConnectionType in Property details.
An array of maximum bandwidth allocation
FunctionMaxBandwidth (v1.4+) [ { array percentages for the functions associated
with this port.
The maximum bandwidth allocation
integer read-write
AllocationPercent (v1.4+) percentage allocated to the corresponding
(%) (null)
network device function instance.
The link to the network device function
associated with this bandwidth setting of
NetworkDeviceFunction (v1.4+) { object this network port. See the
NetworkDeviceFunction schema for details
on this property.
Link to a NetworkDeviceFunction resource.
See the Links section and the
@odata.id string read-only
NetworkDeviceFunction schema for
details.
}]
An array of minimum bandwidth allocation
FunctionMinBandwidth (v1.4+) [ { array percentages for the functions associated
with this port.
The minimum bandwidth allocation
integer read-write
AllocationPercent (v1.4+) percentage allocated to the corresponding
(%) (null)
network device function instance.
The link to the network device function
associated with this bandwidth setting of
NetworkDeviceFunction (v1.4+) { object this network port. See the
NetworkDeviceFunction schema for details
on this property.
Link to a NetworkDeviceFunction resource.
See the Links section and the
@odata.id string read-only
NetworkDeviceFunction schema for
details.
}]
Version 2023.1 Published 655
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
GenZ (v1.2+) { object Gen-Z specific properties.
The Linear Packet Relay Table for the port.
LPRT (v1.2+) { object
Contains a link to a resource.
Link to Collection of RouteEntry. See the
@odata.id string read-only
RouteEntry schema for details.
the Multi-subnet Packet Relay Table for the
MPRT (v1.2+) { object
port. Contains a link to a resource.
Link to Collection of RouteEntry. See the
@odata.id string read-only
RouteEntry schema for details.
the Virtual Channel Action Table for the
VCAT (v1.2+) { object
port. Contains a link to a resource.
Link to Collection of VCATEntry. See the
@odata.id string read-only
VCATEntry schema for details.
InfiniBand (v1.6+) { object InfiniBand properties for this port.
(null)
An array of configured node GUIDs that are
associated with this network port,
array including the programmed address of the
AssociatedNodeGUIDs (v1.6+) [ ] (string, read-only lowest numbered network device function,
null) the configured but not active address, if
applicable, the address for hardware port
teaming, or other network addresses.
An array of configured port GUIDs that are
associated with this network port,
array including the programmed address of the
AssociatedPortGUIDs (v1.6+) [ ] (string, read-only lowest numbered network device function,
null) the configured but not active address, if
applicable, the address for hardware port
teaming, or other network addresses.
656 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
An array of configured system GUIDs that
are associated with this network port,
array including the programmed address of the
AssociatedSystemGUIDs (v1.6+) [ ] (string, read-only lowest numbered network device function,
null) the configured but not active address, if
applicable, the address for hardware port
teaming, or other network addresses.
read-write An indication of whether the interface is
InterfaceEnabled (v1.2+) boolean
(null) enabled.
LinkConfiguration (v1.3+) [ { array The link configuration of this port.
read-only An indication of whether the port is
AutoSpeedNegotiationCapable (v1.3+) boolean
(null) capable of autonegotiating speed.
read-write Controls whether this port is configured to
AutoSpeedNegotiationEnabled (v1.3+) boolean
(null) enable autonegotiating speed.
array
(Gbit/s) The set of link speed capabilities of this
CapableLinkSpeedGbps (v1.3+) [ ] read-only
(number, port.
null)
The set of link speed and width pairs this
ConfiguredNetworkLinks (v1.3+) [ { array port is configured to use for
autonegotiation.
number read-write The link speed per lane this port is
ConfiguredLinkSpeedGbps (v1.3+)
(Gbit/s) (null) configured to use for autonegotiation.
The link width this port is configured to use
read-write
ConfiguredWidth (v1.3+) integer for autonegotiation in conjunction with the
(null)
link speed.
}]
}]
The link network technology capabilities of
string read-only this port. For the possible property values,
LinkNetworkTechnology (v1.2+)
(enum) (null) see LinkNetworkTechnology in Property
details.
The links to other resources that are
Links { object
related to this resource.
An array of links to the endpoints at the
AssociatedEndpoints [ { array
other end of the link.
Version 2023.1 Published 657
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to a Endpoint resource. See the Links
@odata.id string read-only section and the Endpoint schema for
details.
}]
An array of links to the cables connected
Cables (v1.5+) [ { array
to this port.
Link to a Cable resource. See the Links
@odata.id string read-only
section and the Cable schema for details.
}]
An array of links to the remote device
ConnectedPorts (v1.2+) [ { array
ports at the other end of the link.
@odata.id string read-only Link to another Port resource.
}]
An array of links to the switches at the
ConnectedSwitches [ { array
other end of the link.
Link to a Switch resource. See the Links
@odata.id string read-only
section and the Switch schema for details.
}]
An array of links to the switch ports at the
ConnectedSwitchPorts [ { array
other end of the link.
@odata.id string read-only Link to another Port resource.
}]
The links to the Ethernet interfaces this
EthernetInterfaces (v1.7+) [ { array
port provides.
Link to a EthernetInterface resource. See
@odata.id string read-only the Links section and the EthernetInterface
schema for details.
}]
See the Oem object definition in the
Oem {} object
Common properties section.
658 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The desired link state for this interface. For
string
LinkState (v1.2+) read-write the possible property values, see LinkState
(enum)
in Property details.
The link status for this interface. For the
string
LinkStatus (v1.2+) read-only possible property values, see LinkStatus in
(enum)
Property details.
The number of link state transitions for
LinkTransitionIndicator (v1.2+) integer read-write
this interface.
The location of the port. For property
Location (v1.1+) {} object
details, see Location.
read-write An indicator allowing an operator to
LocationIndicatorActive (v1.3+) boolean
(null) physically locate this resource.
integer read-only The maximum frame size supported by the
MaxFrameSize (v1.3+)
(bytes) (null) port.
number read-only The maximum speed of this port as
MaxSpeedGbps
(Gbit/s) (null) currently configured.
The link to the metrics associated with this
Metrics (v1.2+) { object port. See the PortMetrics schema for
(null)
details on this property.
Link to a PortMetrics resource. See the
@odata.id string read-only Links section and the PortMetrics schema
for details.
read-only The label of this port on the physical
PortId string
(null) package for this port.
The physical connection medium for this
string read-only
PortMedium (v1.2+) port. For the possible property values, see
(enum) (null)
PortMedium in Property details.
The protocol being sent over this port. For
string read-only
PortProtocol the possible property values, see
(enum) (null)
PortProtocol in Property details.
The type of this port. For the possible
string read-only
PortType property values, see PortType in Property
(enum) (null)
details.
read-only The identifier of the remote port to which
RemotePortId (v1.8+) string
(null) this port is connected.
Version 2023.1 Published 659
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The small form-factor pluggable (SFP)
SFP (v1.4+) { object
(null) device associated with this port.
The type of fiber connection currently used
string read-only by this SFP. For the possible property
FiberConnectionType (v1.4+)
(enum) (null) values, see FiberConnectionType in
Property details.
read-only
Manufacturer (v1.4+) string The manufacturer of this SFP.
(null)
The medium type connected to this SFP.
string read-only
MediumType (v1.4+) For the possible property values, see
(enum) (null)
MediumType in Property details.
read-only
PartNumber (v1.4+) string The part number for this SFP.
(null)
read-only
SerialNumber (v1.4+) string The serial number for this SFP.
(null)
The status and health of the resource and
Status (v1.4+) {} object its subordinate or dependent resources.
For property details, see Status.
The types of SFP devices that can be
array
read-only attached to this port. For the possible
SupportedSFPTypes (v1.4+) [ ] (string
(null) property values, see SupportedSFPTypes in
(enum))
Property details.
The type of SFP device that is attached to
string read-only
Type (v1.4+) this port. For the possible property values,
(enum) (null)
see Type in Property details.
read-only An indication of whether a signal is
SignalDetected (v1.2+) boolean
(null) detected on this interface.
The status and health of the resource and
Status {} object its subordinate or dependent resources.
For property details, see Status.
The number of lanes, phys, or other
read-only
Width integer physical transport links that this port
(null)
contains.
660 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.89.4 Actions
6.89.4.1 Reset
Description
This action resets this port.
Action URI
{Base URI of target resource}/Actions/Port.Reset
Action parameters
Parameter
Type Attributes Notes
Name
string The type of reset. For the possible property values, see ResetType in Property
ResetType optional
(enum) details.
Request Example
{
"ResetType": "ForceRestart"
}
6.89.4.2 ResetPPB (v1.8+)
Description
This action resets the PCI-to-PCI bridge (PPB) for this port.
Action URI
{Base URI of target resource}/Actions/Port.ResetPPB
Action parameters
This action takes no parameters.
Version 2023.1 Published 661
Redfish Resource and Schema Guide DSP2046
6.89.5 Property details
6.89.5.1 ChassisIdSubtype
The type of identifier used for the chassis ID received from the remote partner across this link.
string Description
AgentId Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC3046.
ChassisComp Chassis component, based in the value of entPhysicalAlias in RFC4133.
IfAlias Interface alias, based on the ifAlias MIB object.
IfName Interface name, based on the ifName MIB object.
LocalAssign Locally assigned, based on a alpha-numeric value locally assigned.
MAC address, based on an agent detected unicast source address as defined in IEEE standard
MacAddr
802.
NetworkAddr Network address, based on an agent detected network address.
NotTransmitted No data to be sent to/received from remote partner.
PortComp Port component, based in the value of entPhysicalAlias in RFC4133.
6.89.5.2 ConnectedDeviceMode
The connected device mode.
string Description
CXL68BFlitAndVH CXL 68B flit and VH.
CXLLatencyOptimized256BFlit CXL latency-optimized 256B flit.
Disconnected The connection is not CXL or is disconnected.
PBR Port-based routing (PBR).
RCD Restricted CXL device (RCD).
Standard256BFlit Standard 256B flit.
662 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.89.5.3 ConnectedDeviceType
The connected device type.
string Description
None No device detected.
PCIeDevice PCIe device.
Type1 CXL Type 1 device.
Type2 CXL Type 2 device.
Type3MLD CXL Type 3 multi-logical device (MLD).
Type3SLD CXL Type 3 single logical device (SLD).
6.89.5.4 CurrentPortConfigurationState
The current port configuration state.
string Description
BindInProgress Bind in progress.
Disabled Disabled.
DSP Downstream port (DSP).
Reserved Reserved.
UnbindInProgress Unbind in progress.
USP Upstream port (USP).
6.89.5.5 FiberConnectionType
The type of fiber connection currently used by this SFP.
string Description
MultiMode The connection is using multi mode operation.
SingleMode The connection is using single mode operation.
Version 2023.1 Published 663
Redfish Resource and Schema Guide DSP2046
6.89.5.6 FlowControlConfiguration
The locally configured 802.3x flow control setting for this port.
string Description
None No IEEE 802.3x flow control is enabled on this port.
RX IEEE 802.3x flow control may be initiated by the link partner.
TX IEEE 802.3x flow control may be initiated by this station.
TX_RX IEEE 802.3x flow control may be initiated by this station or the link partner.
6.89.5.7 FlowControlStatus
The 802.3x flow control behavior negotiated with the link partner for this port.
string Description
None No IEEE 802.3x flow control is enabled on this port.
RX IEEE 802.3x flow control may be initiated by the link partner.
TX IEEE 802.3x flow control may be initiated by this station.
TX_RX IEEE 802.3x flow control may be initiated by this station or the link partner.
6.89.5.8 LinkNetworkTechnology
The link network technology capabilities of this port.
string Description
Ethernet The port is capable of connecting to an Ethernet network.
FibreChannel The port is capable of connecting to a Fibre Channel network.
GenZ The port is capable of connecting to a Gen-Z fabric.
InfiniBand The port is capable of connecting to an InfiniBand network.
PCIe (v1.8+) The port is capable of connecting to PCIe and CXL fabrics.
664 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.89.5.9 LinkState
The desired link state for this interface.
string Description
Disabled This link is disabled.
Enabled This link is enabled.
6.89.5.10 LinkStatus
The link status for this interface.
string Description
LinkDown The link on this interface is down.
LinkUp This link on this interface is up.
NoLink No physical link detected on this interface.
This link on this interface is starting. A physical link has been established, but the port is not
Starting
able to transfer data.
Training This physical link on this interface is training.
6.89.5.11 MediumType
The medium type connected to this SFP.
string Description
Copper The medium connected is copper.
FiberOptic The medium connected is fiber optic.
6.89.5.12 PortConnectionType
The connection type of this port.
Version 2023.1 Published 665
Redfish Resource and Schema Guide DSP2046
string Description
DPort (v1.5+) This port connection type is a diagnostic port.
EPort (v1.5+) This port connection type is an extender fabric port.
EXPort (v1.5+) This port connection type is an external fabric port.
ExtenderFabric This port connection type is an extender fabric port.
FLPort (v1.5+) This port connects in a fabric loop configuration.
FPort (v1.5+) This port connection type is a fabric port.
Generic This port connection type is a generic fabric port.
GPort (v1.5+) This port connection type is a generic fabric port.
NLPort (v1.5+) This port connects in a node loop configuration.
NotConnected This port is not connected.
NPort This port connects through an N-Port to a switch.
NPPort (v1.5+) This port connection type is a proxy N port for N-Port virtualization.
PointToPoint This port connects in a Point-to-point configuration.
PrivateLoop This port connects in a private loop configuration.
PublicLoop This port connects in a public configuration.
TEPort (v1.5+) This port connection type is an trunking extender fabric port.
UPort (v1.5+) This port connection type is unassigned.
6.89.5.13 PortIdSubtype
The port ID subtype received from the remote partner across this link.
string Description
AgentId Agent circuit ID, based on the agent-local identifier of the circuit as defined in RFC3046.
ChassisComp Chassis component, based in the value of entPhysicalAlias in RFC4133.
IfAlias Interface alias, based on the ifAlias MIB object.
IfName Interface name, based on the ifName MIB object.
LocalAssign Locally assigned, based on a alpha-numeric value locally assigned.
666 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
MAC address, based on an agent detected unicast source address as defined in IEEE standard
MacAddr
802.
NetworkAddr Network address, based on an agent detected network address.
NotTransmitted No data to be sent to/received from remote partner.
PortComp Port component, based in the value of entPhysicalAlias in RFC4133.
6.89.5.14 PortMedium
The physical connection medium for this port.
string Description
Electrical This port has an electrical cable connection.
Optical This port has an optical cable connection.
6.89.5.15 PortProtocol
The protocol being sent over this port.
string Description
AHCI Advanced Host Controller Interface (AHCI).
CXL Compute Express Link.
DisplayPort DisplayPort.
DVI DVI.
Ethernet Ethernet.
FC Fibre Channel.
FCoE Fibre Channel over Ethernet (FCoE).
FCP Fibre Channel Protocol for SCSI.
FICON FIbre CONnection (FICON).
FTP File Transfer Protocol (FTP).
Version 2023.1 Published 667
Redfish Resource and Schema Guide DSP2046
string Description
GenZ GenZ.
HDMI HDMI.
HTTP Hypertext Transport Protocol (HTTP).
HTTPS Hypertext Transfer Protocol Secure (HTTPS).
I2C Inter-Integrated Circuit Bus.
InfiniBand InfiniBand.
iSCSI Internet SCSI.
iWARP Internet Wide Area RDMA Protocol (iWARP).
MultiProtocol Multiple Protocols.
NFSv3 Network File System (NFS) version 3.
NFSv4 Network File System (NFS) version 4.
NVLink NVLink.
NVMe Non-Volatile Memory Express (NVMe).
NVMeOverFabrics NVMe over Fabrics.
OEM OEM-specific.
PCIe PCI Express.
RoCE RDMA over Converged Ethernet Protocol.
RoCEv2 RDMA over Converged Ethernet Protocol Version 2.
SAS Serial Attached SCSI.
SATA Serial AT Attachment.
SFTP SSH File Transfer Protocol (SFTP).
SMB Server Message Block (SMB). Also known as the Common Internet File System (CIFS).
TCP Transmission Control Protocol (TCP).
TFTP Trivial File Transfer Protocol (TFTP).
UDP User Datagram Protocol (UDP).
UHCI Universal Host Controller Interface (UHCI).
668 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
USB Universal Serial Bus (USB).
VGA VGA.
6.89.5.16 PortType
The type of this port.
string Description
BidirectionalPort This port connects to any type of device.
DownstreamPort This port connects to a target device.
InterswitchPort This port connects to another switch.
ManagementPort This port connects to a switch manager.
UnconfiguredPort This port has not yet been configured.
UpstreamPort This port connects to a host device.
6.89.5.17 ResetType
The type of reset.
string Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
ForceOn Turn on the unit immediately.
ForceRestart Shut down immediately and non-gracefully and restart the system.
GracefulRestart Shut down gracefully and restart the system.
GracefulShutdown Shut down gracefully and power off.
Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal
Nmi
operations, complete diagnostic actions, and, typically, halt the system.
On Turn on the unit.
Pause execution on the unit but do not remove power. This is typically a feature of virtual
Pause
machine hypervisors.
Version 2023.1 Published 669
Redfish Resource and Schema Guide DSP2046
string Description
Power cycle the unit. Behaves like a full power removal, followed by a power restore to the
PowerCycle
resource.
PushPowerButton Simulate the pressing of the physical power button on this unit.
Resume execution on the paused unit. This is typically a feature of virtual machine
Resume
hypervisors.
Write the state of the unit to disk before powering off. This allows for the state to be restored
Suspend
when powered back on.
6.89.5.18 SupportedEthernetCapabilities
The set of Ethernet capabilities that this port supports.
string Description
EEE IEEE 802.3az Energy-Efficient Ethernet (EEE) is supported on this port.
WakeOnLAN Wake on LAN (WoL) is supported on this port.
6.89.5.19 SupportedSFPTypes
The types of SFP devices that can be attached to this port.
string Description
cSFP The SFP conforms to the CSFP MSA Specification.
MiniSASHD The SFP conforms to the SFF Specification SFF-8644.
OSFP The SFP conforms to the OSFP Specification.
QSFP The SFP conforms to the SFF Specification for QSFP.
QSFP14 The SFP conforms to the SFF Specification for QSFP14.
QSFP28 The SFP conforms to the SFF Specification for QSFP28.
QSFP56 The SFP conforms to the SFF Specification for QSFP56.
QSFPDD The SFP conforms to the QSFP Double Density Specification.
QSFPPlus The SFP conforms to the SFF Specification for QSFP+.
670 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
SFP The SFP conforms to the SFF Specification for SFP.
SFP28 The SFP conforms to the SFF Specification for SFP+ and IEEE 802.3by Specification.
SFPDD The SFP conforms to the SFP-DD MSA Specification.
SFPPlus The SFP conforms to the SFF Specification for SFP+.
6.89.5.20 SystemCapabilities
The system capabilities received from the remote partner across this link.
string Description
Bridge Bridge.
DOCSISCableDevice DOCSIS cable device.
None The system capabilities are transmitted, but no capabilities are set.
Other Other.
Repeater Repeater.
Router Router.
Station Station.
Telephone Telephone.
WLANAccessPoint WLAN access point.
6.89.5.21 Type
The type of SFP device that is attached to this port.
string Description
cSFP The SFP conforms to the CSFP MSA Specification.
MiniSASHD The SFP conforms to the SFF Specification SFF-8644.
OSFP (v1.9+) The SFP conforms to the OSFP Specification.
QSFP The SFP conforms to the SFF Specification for QSFP.
Version 2023.1 Published 671
Redfish Resource and Schema Guide DSP2046
string Description
QSFP14 The SFP conforms to the SFF Specification for QSFP14.
QSFP28 The SFP conforms to the SFF Specification for QSFP28.
QSFP56 The SFP conforms to the SFF Specification for QSFP56.
QSFPDD (v1.9+) The SFP conforms to the QSFP Double Density Specification.
QSFPPlus The SFP conforms to the SFF Specification for QSFP+.
SFP The SFP conforms to the SFF Specification for SFP.
SFP28 The SFP conforms to the SFF Specification for SFP+ and IEEE 802.3by Specification.
SFPDD The SFP conforms to the SFP-DD MSA Specification.
SFPPlus The SFP conforms to the SFF Specification for SFP+.
6.89.6 Example response
{
"@odata.type": "#Port.v1_9_0.Port",
"Id": "1",
"Name": "SAS Port 1",
"Description": "SAS Port 1",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"PortId": "1",
"PortProtocol": "SAS",
"PortType": "BidirectionalPort",
"CurrentSpeedGbps": 48,
"Width": 4,
"MaxSpeedGbps": 48,
"Links": {
"AssociatedEndpoints": [
{
"@odata.id": "/redfish/v1/Fabrics/SAS/Endpoints/Initiator1"
}
]
},
"@odata.id": "/redfish/v1/Fabrics/SAS/Switches/Switch1/Ports/1"
}
672 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.90 PortMetrics 1.4.0
Version v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.3 2022.1 2021.2 2021.1 2019.4
6.90.1 Description
The PortMetrics schema contains usage and health statistics for a switch device or component port
summary.
6.90.2 URIs
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/Metrics
/redfish/v1/Chassis/{ChassisId}/MediaControllers/{MediaControllerId}/Ports/{PortId}/Metrics
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Ports/{PortId}/Metrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Ports/
{PortId}/Metrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/
{StorageControllerId}/Ports/{PortId}/Metrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/
StorageControllers/{StorageControllerId}/Ports/{PortId}/Metrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/Ports/{PortId}/Metrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
GraphicsControllers/{ControllerId}/Ports/{PortId}/Metrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}/Ports/{PortId}/Metrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/Controllers/{StorageControllerId}/Ports/{PortId}/Metrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}/Metrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
USBControllers/{ControllerId}/Ports/{PortId}/Metrics
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/Metrics
/redfish/v1/Managers/{ManagerId}/DedicatedNetworkPorts/{PortId}/Metrics
/redfish/v1/Managers/{ManagerId}/USBPorts/{PortId}/Metrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Ports/{PortId}/Metrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{StorageControllerId}/
Ports/{PortId}/Metrics
Version 2023.1 Published 673
Redfish Resource and Schema Guide DSP2046
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/
{StorageControllerId}/Ports/{PortId}/Metrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/
{FabricAdapterId}/Ports/{PortId}/Metrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/GraphicsControllers/
{ControllerId}/Ports/{PortId}/Metrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/
{ProcessorId}/Ports/{PortId}/Metrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
Controllers/{StorageControllerId}/Ports/{PortId}/Metrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
StorageControllers/{StorageControllerId}/Ports/{PortId}/Metrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/USBControllers/
{ControllerId}/Ports/{PortId}/Metrics
/redfish/v1/Storage/{StorageId}/Controllers/{StorageControllerId}/Ports/{PortId}/Metrics
/redfish/v1/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports/{PortId}/Metrics
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/Metrics
/redfish/v1/Systems/{ComputerSystemId}/GraphicsControllers/{ControllerId}/Ports/{PortId}/Metrics
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Ports/{PortId}/Metrics
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/
Ports/{PortId}/Metrics
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/
{StorageControllerId}/Ports/{PortId}/Metrics
/redfish/v1/Systems/{ComputerSystemId}/USBControllers/{ControllerId}/Ports/{PortId}/Metrics
6.90.3 Properties
Property Type Attributes Notes
CXL (v1.4+) { object The port metrics specific to CXL ports.
BackpressureAveragePercentage integer The average congestion of the port as a
read-only
(v1.4+) (%) percentage.
The Fibre Channel-specific port metrics for network
FibreChannel (v1.2+) { object
ports.
read-only The total number of correctable forward error
CorrectableFECErrors (v1.2+) integer
(null) correction (FEC) errors.
read-only The total number of invalid cyclic redundancy
InvalidCRCs (v1.2+) integer
(null) checks (CRCs).
674 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only
InvalidTXWords (v1.2+) integer The total number of invalid transmission words.
(null)
read-only
LinkFailures (v1.2+) integer The total number of link failures.
(null)
read-only
LossesOfSignal (v1.2+) integer The total number of losses of signal.
(null)
read-only
LossesOfSync (v1.2+) integer The total number of losses of sync.
(null)
read-only The number of times the receive buffer-to-buffer
RXBBCreditZero (v1.2+) integer
(null) credit count transitioned to zero.
read-only The total number of Fibre Channel exchanges
RXExchanges (v1.2+) integer
(null) received.
read-only The total number of Fibre Channel sequences
RXSequences (v1.2+) integer
(null) received.
read-only The number of transmit buffer-to-buffer credits the
TXBBCredits (v1.2+) integer
(null) port is configured to use.
read-only The number of times the transmit buffer-to-buffer
TXBBCreditZero (v1.2+) integer
(null) credit count transitioned to zero.
The total amount of time the port has been
TXBBCreditZeroDurationMilliseconds integer read-only
blocked from transmitting due to lack of buffer
(v1.2+) (ms) (null)
credits.
read-only The total number of Fibre Channel exchanges
TXExchanges (v1.2+) integer
(null) transmitted.
read-only The total number of Fibre Channel sequences
TXSequences (v1.2+) integer
(null) transmitted.
read-only The total number of uncorrectable forward error
UncorrectableFECErrors (v1.2+) integer
(null) correction (FEC) errors.
GenZ { object The port metrics specific to Gen-Z ports.
read-only The total number of Access Key Violations
AccessKeyViolations integer
(null) detected.
read-only The total number of ECRC transient errors
EndToEndCRCErrors integer
(null) detected.
Version 2023.1 Published 675
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only The total number of link-local non-transient errors
LinkNTE integer
(null) detected.
read-only The total number of times Link-Level Reliability
LLRRecovery integer
(null) (LLR) recovery has been initiated.
read-only The number of packets with the Congestion ECN
MarkedECN integer
(null) bit set.
read-only The total number transient errors detected that are
NonCRCTransientErrors integer
(null) unrelated to CRC validation.
read-only The total number of PCRC transient errors
PacketCRCErrors integer
(null) detected.
read-only The number of packets discarded due to the
PacketDeadlineDiscards integer
(null) Congestion Deadline sub-field reaching zero.
read-only The number of packets received on this interface
ReceivedECN integer
(null) with the Congestion ECN bit set.
read-only The total number of packets received with a
RXStompedECRC integer
(null) stomped ECRC field.
read-only The total number of packets that this interface
TXStompedECRC integer
(null) stomped the ECRC field.
The port metrics for network ports, including
Networking (v1.1+) { object Ethernet, Fibre Channel, and InfiniBand, that are
not specific to one of these protocols.
read-only
RDMAProtectionErrors (v1.1+) integer The total number of RDMA protection errors.
(null)
read-only
RDMAProtocolErrors (v1.1+) integer The total number of RDMA protocol errors.
(null)
read-only The total number of RDMA bytes received on a port
RDMARXBytes (v1.1+) integer
(null) since reset.
read-only The total number of RDMA requests received on a
RDMARXRequests (v1.1+) integer
(null) port since reset.
read-only The total number of RDMA bytes transmitted on a
RDMATXBytes (v1.1+) integer
(null) port since reset.
read-only The total number of RDMA read requests
RDMATXReadRequests (v1.1+) integer
(null) transmitted on a port since reset.
676 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only The total number of RDMA requests transmitted on
RDMATXRequests (v1.1+) integer
(null) a port since reset.
read-only The total number of RDMA send requests
RDMATXSendRequests (v1.1+) integer
(null) transmitted on a port since reset.
read-only The total number of RDMA write requests
RDMATXWriteRequests (v1.1+) integer
(null) transmitted on a port since reset.
read-only The total number of valid broadcast frames
RXBroadcastFrames (v1.1+) integer
(null) received on a port since reset.
read-only The total number of frames discarded in a port's
RXDiscards (v1.1+) integer
(null) receive path since reset.
read-only The total number of false carrier errors received
RXFalseCarrierErrors (v1.1+) integer
(null) from phy on a port since reset.
read-only The total number of frames received with frame
RXFCSErrors (v1.1+) integer
(null) check sequence (FCS) errors on a port since reset.
read-only The total number of frames received with
RXFrameAlignmentErrors (v1.1+) integer
(null) alignment errors on a port since reset.
read-only The total number of frames received on a port
RXFrames (v1.1+) integer
(null) since reset.
read-only The total number of valid multicast frames
RXMulticastFrames (v1.1+) integer
(null) received on a port since reset.
read-only The total number of frames that exceed the
RXOversizeFrames (v1.1+) integer
(null) maximum frame size.
read-only The total number of flow control frames from the
RXPauseXOFFFrames (v1.1+) integer
(null) network to pause transmission.
read-only The total number of flow control frames from the
RXPauseXONFrames (v1.1+) integer
(null) network to resume transmission.
read-only The total number of priority flow control (PFC)
RXPFCFrames (v1.1+) integer
(null) frames received on a port since reset.
read-only The total number of frames that are smaller than
RXUndersizeFrames (v1.1+) integer
(null) the minimum frame size of 64 bytes.
read-only The total number of valid unicast frames received
RXUnicastFrames (v1.1+) integer
(null) on a port since reset.
read-only The total number of good broadcast frames
TXBroadcastFrames (v1.1+) integer
(null) transmitted on a port since reset.
Version 2023.1 Published 677
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only The total number of frames discarded in a port's
TXDiscards (v1.1+) integer
(null) transmit path since reset.
read-only The number of times a single transmitted frame
TXExcessiveCollisions (v1.1+) integer
(null) encountered more than 15 collisions.
read-only The total number of frames transmitted on a port
TXFrames (v1.1+) integer
(null) since reset.
read-only The total number of collisions that occurred after
TXLateCollisions (v1.1+) integer
(null) one slot time as defined by IEEE 802.3.
read-only The total number of good multicast frames
TXMulticastFrames (v1.1+) integer
(null) transmitted on a port since reset.
read-only The times that a transmitted frame encountered
TXMultipleCollisions (v1.1+) integer
(null) 2-15 collisions.
read-only The total number of XOFF frames transmitted to
TXPauseXOFFFrames (v1.1+) integer
(null) the network.
read-only The total number of XON frames transmitted to the
TXPauseXONFrames (v1.1+) integer
(null) network.
read-only The total number of priority flow control (PFC)
TXPFCFrames (v1.1+) integer
(null) frames sent on a port since reset.
read-only The times that a successfully transmitted frame
TXSingleCollisions (v1.1+) integer
(null) encountered a single collision.
read-only The total number of good unicast frames
TXUnicastFrames (v1.1+) integer
(null) transmitted on a port since reset.
PCIeErrors (v1.3+) { object The PCIe errors associated with this port.
read-only The total number of the PCIe correctable errors for
CorrectableErrorCount (v1.8+) integer
(null) this device.
read-only The total number of the PCIe fatal errors for this
FatalErrorCount (v1.8+) integer
(null) device.
The total number of times the PCIe link states
read-only
L0ToRecoveryCount (v1.8+) integer transitioned from L0 to the recovery state for this
(null)
device.
read-only The total number of NAKs issued on the PCIe link
NAKReceivedCount (v1.8+) integer
(null) by the receiver.
678 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only The total number of NAKs issued on the PCIe link
NAKSentCount (v1.8+) integer
(null) by this device.
read-only The total number of the PCIe non-fatal errors for
NonFatalErrorCount (v1.8+) integer
(null) this device.
read-only The total number of the PCIe replays issued by this
ReplayCount (v1.8+) integer
(null) device.
read-only The total number of the PCIe replay rollovers
ReplayRolloverCount (v1.8+) integer
(null) issued by this device.
integer read-only The total number of bytes received on a port since
RXBytes (v1.1+)
(bytes) (null) reset.
read-only The total number of received errors on a port since
RXErrors (v1.1+) integer
(null) reset.
The physical (phy) metrics for Serial Attached SCSI
SAS (v1.1+) [ { array
(SAS). Each member represents a single phy.
The number of invalid dwords that have been
read-only
InvalidDwordCount (v1.1+) integer received by the phy outside of phy reset
(null)
sequences.
The number of times the phy has restarted the link
LossOfDwordSynchronizationCount read-only
integer reset sequence because it lost dword
(v1.1+) (null)
synchronization.
The number of dwords containing running disparity
read-only
RunningDisparityErrorCount (v1.1+) integer errors that have been received by the phy outside
(null)
of phy reset sequences.
}]
The metrics for the transceivers in this port. Each
Transceivers (v1.1+) [ { array
member represents a single transceiver.
number read-only The RX input power value of a small form-factor
RXInputPowerMilliWatts (v1.1+)
(milliWatts) (null) pluggable (SFP) transceiver.
number read-only The supply voltage of a small form-factor
SupplyVoltage (v1.1+)
(Volts) (null) pluggable (SFP) transceiver.
number read-only The TX bias current value of a small form-factor
TXBiasCurrentMilliAmps (v1.1+)
(mA) (null) pluggable (SFP) transceiver.
number read-only The TX output power value of a small form-factor
TXOutputPowerMilliWatts (v1.1+)
(milliWatts) (null) pluggable (SFP) transceiver.
Version 2023.1 Published 679
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
}]
integer read-only The total number of bytes transmitted on a port
TXBytes (v1.1+)
(bytes) (null) since reset.
read-only The total number of transmission errors on a port
TXErrors (v1.1+) integer
(null) since reset.
6.90.4 Example response
{
"@odata.type": "#PortMetrics.v1_4_0.PortMetrics",
"Id": "Metrics",
"Name": "Gen-Z Port 1 Metrics",
"GenZ": {
"PacketCRCErrors": 24,
"EndToEndCRCErrors": 3,
"RXStompedECRC": 1,
"TXStompedECRC": 2,
"NonCRCTransientErrors": 2,
"LLRRecovery": 1,
"MarkedECN": 1,
"PacketDeadlineDiscards": 1,
"AccessKeyViolations": 1,
"LinkNTE": 1,
"ReceivedECN": 1
},
"@odata.id": "/redfish/v1/Fabrics/GenZ/Switches/Switch1/Ports/1/Metrics"
}
6.91 Power 1.7.1 (deprecated)
Version v1.7 Deprecated v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2020.4 2019.3 2017.3 2017.2 2017.1 2016.2 2016.1 1.0
This schema has been deprecated and use in new implementations is discouraged except to retain
compatibility with existing products. This schema has been deprecated in favor of the
PowerSubsystem schema.
680 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.91.1 Description
The Power schema describes power metrics and represents the properties for power consumption and
power limiting.
6.91.2 URIs
/redfish/v1/Chassis/{ChassisId}/Power
6.91.3 Properties
Property Type Attributes Notes
The set of power control functions, including power reading
PowerControl [ { array
and limiting.
string read-only
@odata.id The unique identifier for a resource.
(URI) required
Actions (v1.3+) {} object The available actions for this resource.
read-only
MemberId string The identifier for the member within the collection.
required
read-only
Name string The power control function name.
(null)
See the Oem object definition in the Common properties
Oem {} object
section.
The area, device, or set of devices to which this power control
string
PhysicalContext (v1.4+) read-only applies. For the possible property values, see PhysicalContext
(enum)
in Property details.
number read-only The total amount of power that has been allocated or
PowerAllocatedWatts
(Watts) (null) budgeted to chassis.
The amount of reserve power capacity, in watts, that remains.
number read-only
PowerAvailableWatts This value is the PowerCapacityWatts value minus the
(Watts) (null)
PowerAllocatedWatts value.
The total amount of power that can be allocated to the
number read-only chassis. This value can be either the power supply capacity or
PowerCapacityWatts
(Watts) (null) the power budget that an upstream chassis assigns to this
chassis.
number read-only
PowerConsumedWatts The actual power that the chassis consumes, in watts.
(Watts) (null)
Version 2023.1 Published 681
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The power limit status and configuration information for this
PowerLimit { object
chassis.
integer read-write The time required for the limiting process to reduce power
CorrectionInMs
(ms) (null) consumption to below the limit.
The action that is taken if the power cannot be maintained
string read-write
LimitException below the LimitInWatts. For the possible property values, see
(enum) (null)
LimitException in Property details.
number read-write
LimitInWatts The power limit, in watts. If null , power capping is disabled.
(Watts) (null)
PowerMetrics { object The power readings for this chassis.
number read-only The average power level over the measurement window over
AverageConsumedWatts
(Watts) (null) the last IntervalInMin minutes.
integer read-only The time interval, or window, over which the power metrics
IntervalInMin
(min) (null) are measured.
The highest power consumption level, in watts, that has
number read-only
MaxConsumedWatts occurred over the measurement window within the last
(Watts) (null)
IntervalInMin minutes.
The lowest power consumption level, in watts, over the
number read-only
MinConsumedWatts measurement window that occurred within the last
(Watts) (null)
IntervalInMin minutes.
The potential power, in watts, that the chassis requests, which
number read-only might be higher than the current level being consumed
PowerRequestedWatts
(Watts) (null) because the requested power includes a budget that the
chassis wants for future use.
An array of links to resources or objects associated with this
RelatedItem [ { array
power limit.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
}]
682 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The set of power supplies associated with this system or
PowerSupplies [ { array
device.
string read-only
@odata.id The unique identifier for a resource.
(URI) required
Actions (v1.3+) {} object The available actions for this resource.
The link to the assembly resource associated with this power
Assembly (v1.5+) { object
supply. See the Assembly schema for details on this property.
Link to a Assembly resource. See the Links section and the
@odata.id string read-only
Assembly schema for details.
number read-only
EfficiencyPercent (v1.5+) The measured efficiency of this power supply as a percentage.
(%) (null)
read-only
FirmwareVersion string The firmware version for this power supply.
(null)
read-only An indication of whether this device can be inserted or
HotPluggable (v1.5+) boolean
(null) removed while the equipment is in operation.
The state of The indicator LED, which identifies the power
string read-write
IndicatorLED (v1.2+) supply. For the possible property values, see IndicatorLED in
(enum) (null)
Property details.
InputRanges (v1.1+) [ { array The input ranges that the power supply can use.
string read-only The Input type (AC or DC). For the possible property values,
InputType (v1.1+)
(enum) (null) see InputType in Property details.
MaximumFrequencyHz number read-only The maximum line input frequency at which this power supply
(v1.1+) (Hz) (null) input range is effective.
MaximumVoltage number read-only The maximum line input voltage at which this power supply
(v1.1+) (Volts) (null) input range is effective.
MinimumFrequencyHz number read-only The minimum line input frequency at which this power supply
(v1.1+) (Hz) (null) input range is effective.
number read-only The minimum line input voltage at which this power supply
MinimumVoltage (v1.1+)
(Volts) (null) input range is effective.
See the Oem object definition in the Common properties
Oem (v1.1+) {} object
section.
number read-only The maximum capacity of this power supply when operating in
OutputWattage (v1.1+)
(Watts) (null) this input range.
Version 2023.1 Published 683
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
}]
number read-only
LastPowerOutputWatts The average power output of this power supply.
(Watts) (null)
number read-only
LineInputVoltage The line input voltage at which the power supply is operating.
(Volts) (null)
The line voltage type supported as an input to this power
string read-only
LineInputVoltageType supply. For the possible property values, see
(enum) (null)
LineInputVoltageType in Property details.
The location of the power supply. For property details, see
Location (v1.5+) {} object
Location.
read-only
Manufacturer (v1.1+) string The manufacturer of this power supply.
(null)
read-only
MemberId string The identifier for the member within the collection.
required
read-only
Model string The model number for this power supply.
(null)
read-only
Name string The name of the power supply.
(null)
See the Oem object definition in the Common properties
Oem {} object
section.
read-only
PartNumber string The part number for this power supply.
(null)
number read-only
PowerCapacityWatts The maximum capacity of this power supply.
(Watts) (null)
number read-only
PowerInputWatts (v1.5+) The measured input power of this power supply.
(Watts) (null)
number read-only
PowerOutputWatts (v1.5+) The measured output power of this power supply.
(Watts) (null)
string read-only The power supply type (AC or DC). For the possible property
PowerSupplyType
(enum) (null) values, see PowerSupplyType in Property details.
array The set of redundancy groups for this power supply. For
Redundancy [ { } ]
(object) property details, see Redundancy.
An array of links to resources or objects associated with this
RelatedItem [ { array
power supply.
684 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
read-only
SerialNumber string The serial number for this power supply.
(null)
read-only
SparePartNumber string The spare part number for this power supply.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
}]
array The redundancy information for the set of power supplies in
Redundancy [ { } ]
(object) this chassis. For property details, see Redundancy.
Voltages [ { array The set of voltage sensors for this chassis.
string read-only
@odata.id The unique identifier for a resource.
(URI) required
Actions (v1.3+) {} object The available actions for this resource.
number read-only The value at which the reading is below normal range but not
LowerThresholdCritical
(Volts) (null) yet fatal.
number read-only The value at which the reading is below normal range and
LowerThresholdFatal
(Volts) (null) fatal.
number read-only
LowerThresholdNonCritical The value at which the reading is below normal range.
(Volts) (null)
number read-only
MaxReadingRange Maximum value for this sensor.
(Volts) (null)
read-only
MemberId string The identifier for the member within the collection.
required
number read-only
MinReadingRange Minimum value for this sensor.
(Volts) (null)
read-only
Name string Voltage sensor name.
(null)
See the Oem object definition in the Common properties
Oem {} object
section.
Version 2023.1 Published 685
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The area or device to which this voltage measurement applies.
string
PhysicalContext read-only For the possible property values, see PhysicalContext in
(enum)
Property details.
number read-only
ReadingVolts The reading of the voltage sensor.
(Volts) (null)
An array of links to resources or objects to which this voltage
RelatedItem [ { array
measurement applies.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
read-only
SensorNumber integer A numerical identifier to represent the voltage sensor.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
number read-only The value at which the reading is above normal range but not
UpperThresholdCritical
(Volts) (null) yet fatal.
number read-only The value at which the reading is above normal range and
UpperThresholdFatal
(Volts) (null) fatal.
number read-only
UpperThresholdNonCritical The value at which the reading is above normal range.
(Volts) (null)
}]
6.91.4 Actions
6.91.4.1 PowerSupplyReset (v1.6+)
Description
This action resets the targeted power supply.
Action URI
{Base URI of target resource}/Actions/Power.PowerSupplyReset
Action parameters
686 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Parameter
Type Attributes Notes
Name
The MemberId of the power supply within the PowerSupplies array on which to
MemberId string required
perform the reset.
string The type of reset. For the possible property values, see ResetType in Property
ResetType optional
(enum) details.
Request Example
{
"MemberId": "0",
"ResetType": "ForceRestart"
}
6.91.5 Property details
6.91.5.1 IndicatorLED
The state of The indicator LED, which identifies the power supply.
string Description
Blinking The indicator LED is blinking.
Lit The indicator LED is lit.
Off The indicator LED is off.
6.91.5.2 InputType
The Input type (AC or DC).
string Description
AC Alternating Current (AC) input range.
DC Direct Current (DC) input range.
Version 2023.1 Published 687
Redfish Resource and Schema Guide DSP2046
6.91.5.3 LimitException
The action that is taken if the power cannot be maintained below the LimitInWatts.
string Description
HardPowerOff Turn the power off immediately when the limit is exceeded.
LogEventOnly Log an event when the limit is exceeded, but take no further action.
NoAction Take no action when the limit is exceeded.
Oem Take an OEM-defined action.
6.91.5.4 LineInputVoltageType
The line voltage type supported as an input to this power supply.
string Description
AC120V (v1.1+) AC 120V nominal input.
AC240V (v1.1+) AC 240V nominal input.
AC277V (v1.1+) AC 277V nominal input.
ACandDCWideRange
Wide range AC or DC input.
(v1.1+)
ACHighLine (deprecated 277V AC input. Deprecated in v1.1 and later. This value has been deprecated in favor of
v1.1) AC277V.
ACLowLine (deprecated 100-127V AC input. Deprecated in v1.1 and later. This value has been deprecated in favor of
v1.1) AC120V.
ACMidLine (deprecated 200-240V AC input. Deprecated in v1.1 and later. This value has been deprecated in favor of
v1.1) AC240V.
ACWideRange (v1.1+) Wide range AC input.
DC240V (v1.1+) DC 240V nominal input.
DC380V High Voltage DC input (380V).
DCNeg48V -48V DC input.
Unknown The power supply line input voltage type cannot be determined.
688 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.91.5.5 PhysicalContext
The area, device, or set of devices to which this power control applies.
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
GPU A graphics processor (GPU).
Version 2023.1 Published 689
Redfish Resource and Schema Guide DSP2046
string Description
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
StorageBay Within a storage bay.
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
6.91.5.6 PowerSupplyType
The power supply type (AC or DC).
690 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
AC Alternating Current (AC) power supply.
ACorDC The power supply supports both DC or AC.
DC Direct Current (DC) power supply.
Unknown The power supply type cannot be determined.
6.91.5.7 ResetType
The type of reset.
string Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
ForceOn Turn on the unit immediately.
ForceRestart Shut down immediately and non-gracefully and restart the system.
GracefulRestart Shut down gracefully and restart the system.
GracefulShutdown Shut down gracefully and power off.
Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal
Nmi
operations, complete diagnostic actions, and, typically, halt the system.
On Turn on the unit.
Pause execution on the unit but do not remove power. This is typically a feature of virtual
Pause
machine hypervisors.
Power cycle the unit. Behaves like a full power removal, followed by a power restore to the
PowerCycle
resource.
PushPowerButton Simulate the pressing of the physical power button on this unit.
Resume execution on the paused unit. This is typically a feature of virtual machine
Resume
hypervisors.
Write the state of the unit to disk before powering off. This allows for the state to be restored
Suspend
when powered back on.
Version 2023.1 Published 691
Redfish Resource and Schema Guide DSP2046
6.91.6 Example response
{
"@odata.type": "#Power.v1_7_1.Power",
"Id": "Power",
"Name": "Power",
"PowerControl": [
{
"@odata.id": "/redfish/v1/Chassis/1U/Power#/PowerControl/0",
"MemberId": "0",
"Name": "Server Power Control",
"PowerConsumedWatts": 344,
"PowerRequestedWatts": 800,
"PowerAvailableWatts": 0,
"PowerCapacityWatts": 800,
"PowerAllocatedWatts": 800,
"PowerMetrics": {
"IntervalInMin": 30,
"MinConsumedWatts": 271,
"MaxConsumedWatts": 489,
"AverageConsumedWatts": 319
},
"PowerLimit": {
"LimitInWatts": 500,
"LimitException": "LogEventOnly",
"CorrectionInMs": 50
},
"RelatedItem": [
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2"
},
{
"@odata.id": "/redfish/v1/Chassis/1U"
}
],
"Status": {
"State": "Enabled",
"Health": "OK"
}
}
],
"Voltages": [
{
"@odata.id": "/redfish/v1/Chassis/1U/Power#/Voltages/0",
"MemberId": "0",
"Name": "VRM1 Voltage",
"SensorNumber": 11,
"Status": {
"State": "Enabled",
692 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"Health": "OK"
},
"ReadingVolts": 12,
"UpperThresholdNonCritical": 12.5,
"UpperThresholdCritical": 13,
"UpperThresholdFatal": 15,
"LowerThresholdNonCritical": 11.5,
"LowerThresholdCritical": 11,
"LowerThresholdFatal": 10,
"MinReadingRange": 0,
"MaxReadingRange": 20,
"PhysicalContext": "VoltageRegulator",
"RelatedItem": [
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2"
},
{
"@odata.id": "/redfish/v1/Chassis/1U"
}
]
},
{
"@odata.id": "/redfish/v1/Chassis/1U/Power#/Voltages/1",
"MemberId": "1",
"Name": "VRM2 Voltage",
"SensorNumber": 12,
"Status": {
"State": "Enabled",
"Health": "OK"
},
"ReadingVolts": 5,
"UpperThresholdNonCritical": 5.5,
"UpperThresholdCritical": 7,
"LowerThresholdNonCritical": 4.75,
"LowerThresholdCritical": 4.5,
"MinReadingRange": 0,
"MaxReadingRange": 20,
"PhysicalContext": "VoltageRegulator",
"RelatedItem": [
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2"
},
{
"@odata.id": "/redfish/v1/Chassis/1U"
}
]
}
],
"PowerSupplies": [
{
Version 2023.1 Published 693
Redfish Resource and Schema Guide DSP2046
"@odata.id": "/redfish/v1/Chassis/1U/Power#/PowerSupplies/0",
"MemberId": "0",
"Name": "Power Supply Bay",
"Status": {
"State": "Enabled",
"Health": "Warning"
},
"PowerSupplyType": "AC",
"LineInputVoltageType": "ACWideRange",
"LineInputVoltage": 120,
"PowerCapacityWatts": 800,
"LastPowerOutputWatts": 325,
"Model": "499253-B21",
"Manufacturer": "ManufacturerName",
"FirmwareVersion": "1.00",
"SerialNumber": "1Z0000001",
"PartNumber": "0000001A3A",
"SparePartNumber": "0000001A3A",
"InputRanges": [
{
"InputType": "AC",
"MinimumVoltage": 100,
"MaximumVoltage": 120,
"OutputWattage": 800
},
{
"InputType": "AC",
"MinimumVoltage": 200,
"MaximumVoltage": 240,
"OutputWattage": 1300
}
],
"RelatedItem": [
{
"@odata.id": "/redfish/v1/Chassis/1U"
}
]
}
],
"Actions": {
"#Power.PowerSupplyReset": {
"target": "/redfish/v1/Chassis/1U/Power/Actions/Power.PowerSupplyReset"
}
},
"@odata.id": "/redfish/v1/Chassis/1U/Power"
}
694 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.92 PowerDistribution 1.3.1
Version v1.3 v1.2 v1.1 v1.0
Release 2022.3 2021.3 2021.2 2019.4
6.92.1 Description
This is the schema definition for a power distribution component or unit, such as a floor power
distribution unit (PDU) or switchgear.
6.92.2 URIs
/redfish/v1/PowerEquipment/ElectricalBuses/{PowerDistributionId}
/redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}
/redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}
/redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}
/redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}
6.92.3 Properties
Property Type Attributes Notes
read-write
AssetTag string The user-assigned asset tag for this equipment.
(null)
A link to the branch circuits for this equipment. Contains
Branches { object
a link to a resource.
Link to Collection of Circuit. See the Circuit schema for
@odata.id string read-only
details.
The type of equipment this resource represents. For the
string read-only
EquipmentType possible property values, see EquipmentType in Property
(enum) required
details.
A link to the feeder circuits for this equipment. Contains a
Feeders { object
link to a resource.
Version 2023.1 Published 695
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to Collection of Circuit. See the Circuit schema for
@odata.id string read-only
details.
FirmwareVersion string read-only The firmware version of this equipment.
The links to other resources that are related to this
Links { object
resource.
An array of links to the chassis that contain this
Chassis [ { array
equipment.
Link to a Chassis resource. See the Links section and the
@odata.id string read-only
Chassis schema for details.
}]
A link to the facility that contains this equipment. See the
Facility { object
Facility schema for details on this property.
Link to a Facility resource. See the Links section and the
@odata.id string read-only
Facility schema for details.
An array of links to the managers responsible for
ManagedBy [ { array
managing this equipment.
Link to a Manager resource. See the Links section and the
@odata.id string read-only
Manager schema for details.
}]
See the Oem object definition in the Common properties
Oem {} object
section.
The location of the equipment. For property details, see
Location {} object
Location.
A link to the power input circuits for this equipment.
Mains { object
Contains a link to a resource.
Link to Collection of Circuit. See the Circuit schema for
@odata.id string read-only
details.
696 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The redundancy information for the mains (input) circuits
MainsRedundancy (v1.1+) {} object for this equipment. For property details, see
RedundantGroup.
read-only
Manufacturer string The manufacturer of this equipment.
(null)
A link to the summary metrics for this equipment. See
Metrics { object the PowerDistributionMetrics schema for details on this
property.
Link to a PowerDistributionMetrics resource. See the Links
@odata.id string read-only section and the PowerDistributionMetrics schema for
details.
read-only
Model string The product model number of this equipment.
(null)
A link to the outlet groups for this equipment. Contains a
OutletGroups { object
link to a resource.
Link to Collection of OutletGroup. See the OutletGroup
@odata.id string read-only
schema for details.
A link to the outlets for this equipment. Contains a link to
Outlets { object
a resource.
Link to Collection of Outlet. See the Outlet schema for
@odata.id string read-only
details.
read-only
PartNumber string The part number for this equipment.
(null)
The link to the collection of power supplies for this
PowerSupplies (v1.1+, deprecated equipment. Contains a link to a resource. Deprecated in
object
v1.3 { v1.3 and later. This property has been deprecated in
favor of the PowerSupplies link in the Chassis resource.
Link to Collection of PowerSupply. See the PowerSupply
@odata.id string read-only
schema for details.
Version 2023.1 Published 697
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The redundancy information for the set of power supplies
for this equipment. For property details, see
PowerSupplyRedundancy (v1.1+, array RedundantGroup. Deprecated in v1.3 and later. This
deprecated v1.3 [ { } ] (object) property has been deprecated in favor of the
PowerSupplyRedundancy property in the Chassis
resource.
string
read-only
ProductionDate (date- The production or manufacturing date of this equipment.
(null)
time)
A link to the collection of sensors located in the
equipment and sub-components. Contains a link to a
Sensors (deprecated v1.3) { object resource. Deprecated in v1.3 and later. This property has
been deprecated in favor of the Sensors link in the
Chassis resource.
Link to Collection of Sensor. See the Sensor schema for
@odata.id string read-only
details.
read-only
SerialNumber string The serial number for this equipment.
(null)
The status and health of the resource and its subordinate
Status {} object
or dependent resources. For property details, see Status.
A link to the subfeed circuits for this equipment. Contains
Subfeeds { object
a link to a resource.
Link to Collection of Circuit. See the Circuit schema for
@odata.id string read-only
details.
The configuration settings for an automatic transfer
TransferConfiguration { object
(null) switch.
read-write The mains circuit that is switched on and qualified to
ActiveMainsId string
(null) supply power to the output circuit.
Indicates if the qualified alternate mains circuit is
read-write automatically switched on when the preferred mains
AutoTransferEnabled boolean
(null) circuit becomes unqualified and is automatically switched
off.
Indicates if a make-before-break switching sequence of
read-write
ClosedTransitionAllowed boolean the mains circuits is permitted when they are both
(null)
qualified and in synchronization.
698 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write The time in seconds to wait for a closed transition to
ClosedTransitionTimeoutSeconds integer
(null) occur.
read-write The preferred source for the mains circuit to this
PreferredMainsId string
(null) equipment.
The time in seconds to delay the automatic transfer from
read-write
RetransferDelaySeconds integer the alternate mains circuit back to the preferred mains
(null)
circuit.
Indicates if the automatic transfer is permitted from the
read-write alternate mains circuit back to the preferred mains circuit
RetransferEnabled boolean
(null) after the preferred mains circuit is qualified again and the
Retransfer Delay time has expired.
The time in seconds to delay the automatic transfer from
read-write
TransferDelaySeconds integer the preferred mains circuit to the alternate mains circuit
(null)
when the preferred mains circuit is disqualified.
read-write
TransferInhibit boolean Indicates if any transfer is inhibited.
(null)
The criteria used to initiate a transfer for an automatic
TransferCriteria { object
(null) transfer switch.
number read-write The frequency in hertz over the nominal value that
OverNominalFrequencyHz
(Hz) (null) satisfies a criterion for transfer.
number read-write The positive percentage of voltage RMS over the nominal
OverVoltageRMSPercentage
(%) (null) value that satisfies a criterion for transfer.
The sensitivity to voltage waveform quality to satisfy the
string read-write
TransferSensitivity criterion for initiating a transfer. For the possible property
(enum) (null)
values, see TransferSensitivity in Property details.
number read-write The frequency in hertz under the nominal value that
UnderNominalFrequencyHz
(Hz) (null) satisfies a criterion for transfer.
number read-write The negative percentage of voltage RMS under the
UnderVoltageRMSPercentage
(%) (null) nominal value that satisfies a criterion for transfer.
UserLabel (v1.3+) string read-write A user-assigned label.
string read-only
UUID The UUID for this equipment.
(uuid) (null)
Version 2023.1 Published 699
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
Version string The hardware version of this equipment.
(null)
6.92.4 Actions
6.92.4.1 TransferControl
Description
This action transfers control to the alternative input circuit.
Action URI
{Base URI of target resource}/Actions/PowerDistribution.TransferControl
Action parameters
This action takes no parameters.
6.92.5 Property details
6.92.5.1 EquipmentType
The type of equipment this resource represents.
string Description
AutomaticTransferSwitch An automatic power transfer switch.
BatteryShelf (v1.3+) A battery shelf or battery-backed unit (BBU).
Bus (v1.2+) An electrical bus.
FloorPDU A power distribution unit providing feeder circuits for further power distribution.
ManualTransferSwitch A manual power transfer switch.
PowerShelf (v1.1+) A power shelf.
RackPDU A power distribution unit providing outlets for a rack or similar quantity of devices.
Switchgear Electrical switchgear.
700 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.92.5.2 TransferSensitivity
The sensitivity to voltage waveform quality to satisfy the criterion for initiating a transfer.
string Description
High High sensitivity for initiating a transfer.
Low Low sensitivity for initiating a transfer.
Medium Medium sensitivity for initiating a transfer.
6.92.6 Example response
{
"@odata.type": "#PowerDistribution.v1_3_1.PowerDistribution",
"Id": "1",
"EquipmentType": "RackPDU",
"Name": "RackPDU1",
"FirmwareVersion": "4.3.0",
"Version": "1.03b",
"ProductionDate": "2017-01-11T08:00:00Z",
"Manufacturer": "Contoso",
"Model": "ZAP4000",
"SerialNumber": "29347ZT536",
"PartNumber": "AA-23",
"UUID": "32354641-4135-4332-4a35-313735303734",
"AssetTag": "PDX-92381",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Location": {
"Placement": {
"Row": "North 1"
}
},
"Mains": {
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Mains"
},
"Branches": {
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Branches"
},
"Outlets": {
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Outlets"
},
"OutletGroups": {
Version 2023.1 Published 701
Redfish Resource and Schema Guide DSP2046
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/OutletGroups"
},
"Metrics": {
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Metrics"
},
"Sensors": {
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors"
},
"Links": {
"Facility": {
"@odata.id": "/redfish/v1/Facilities/Room237"
}
},
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1"
}
6.93 PowerDistributionMetrics 1.3.0
Version v1.3 v1.2 v1.1 v1.0
Release 2021.4 2021.2 2021.1 2019.4
6.93.1 Description
This is the schema definition for the metrics of a power distribution component or unit, such as a floor
power distribution unit (PDU) or switchgear.
6.93.2 URIs
/redfish/v1/PowerEquipment/ElectricalBuses/{PowerDistributionId}/Metrics
/redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}/Metrics
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/Metrics
/redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Metrics
/redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}/Metrics
/redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Metrics
702 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.93.3 Properties
Property Type Attributes Notes
AbsoluteHumidity Absolute humidity (g/cu m). For more information about this property,
object
(v1.3+) {} see SensorExcerpt in Property Details.
object Energy consumption (kWh). This object is an excerpt of the Sensor
EnergykWh {
(excerpt) resource located at the URI shown in DataSourceUri.
ApparentkVAh number read-only
Apparent energy (kVAh).
(v1.5+) (kV.A.h) (null)
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
LifetimeReading read-only
number The total accumulation value for this sensor.
(v1.1+) (null)
ReactivekVARh number read-only
Reactive energy (kVARh).
(v1.5+) (kV.A.h) (null)
read-only
Reading number The sensor value.
(null)
string read-only
SensorResetTime The date and time when the time-based properties were last reset.
(date-time) (null)
HumidityPercent Humidity (percent). For more information about this property, see
object
(v1.1+) {} SensorExcerpt in Property Details.
PowerLoadPercent The power load (percent) for this equipment. For more information
object
(v1.2+) {} about this property, see SensorExcerpt in Property Details.
object Power consumption (W). This object is an excerpt of the Sensor
PowerWatts {
(excerpt) resource located at the URI shown in DataSourceUri.
number read-only The product of voltage and current for an AC circuit, in volt-ampere
ApparentVA
(V.A) (null) units.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
PhaseAngleDegrees read-only The phase angle (degrees) between the current and voltage
number
(v1.5+) (null) waveforms.
read-only
PowerFactor number The power factor for this sensor.
(null)
Version 2023.1 Published 703
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
number read-only The square root of the difference term of squared apparent VA and
ReactiveVAR
(V.A) (null) squared power (Reading) for a circuit, in VAR units.
read-only
Reading number The sensor value.
(null)
TemperatureCelsius Temperature (Celsius). For more information about this property, see
object
(v1.1+) {} SensorExcerpt in Property Details.
6.93.4 Actions
6.93.4.1 ResetMetrics
Description
This action resets the summary metrics related to this equipment.
Action URI
{Base URI of target resource}/Actions/PowerDistributionMetrics.ResetMetrics
Action parameters
This action takes no parameters.
6.93.5 Property details
6.93.5.1 SensorExcerpt
The Sensor schema describes a sensor and its properties. This object is an excerpt of the Sensor
resource located at the URI shown in DataSourceUri.
read-
string
DataSourceUri only The link to the resource that provides the data for this sensor.
(URI)
(null)
read-
Reading number only The sensor value.
(null)
704 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.93.6 Example response
{
"@odata.type": "#PowerDistributionMetrics.v1_3_0.PowerDistributionMetrics",
"Id": "Metrics",
"Name": "Summary Metrics",
"PowerWatts": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/PDUPower",
"Reading": 6438,
"ApparentVA": 6300,
"ReactiveVAR": 100,
"PowerFactor": 0.93
},
"EnergykWh": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/PDUEnergy",
"Reading": 56438
},
"TemperatureCelsius": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/PDUTemp",
"Reading": 26.3
},
"HumidityPercent": {
"DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/PDUHumidity",
"Reading": 52.7
},
"Actions": {
"#PowerDistributionMetrics.ResetMetrics": {
"target": "/redfish/v1/PowerEquipment/RackPDUs/1/Metrics/PowerDistributionMetrics.ResetMetrics"
}
},
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Metrics"
}
6.94 PowerDomain 1.2.0
Version v1.2 v1.1 v1.0
Release 2021.3 2021.2 2019.4
6.94.1 Description
The PowerDomain schema contains definition for the DCIM power domain.
Version 2023.1 Published 705
Redfish Resource and Schema Guide DSP2046
6.94.2 URIs
/redfish/v1/Facilities/{FacilityId}/PowerDomains/{PowerDomainId}
6.94.3 Properties
Property Type Attributes Notes
Links { object The links to other resources that are related to this resource.
ElectricalBuses
array An array of links to the electrical buses in this power domain.
(v1.2+) [ {
Link to a PowerDistribution resource. See the Links section and the
@odata.id string read-write
PowerDistribution schema for details.
}]
An array of links to the floor power distribution units in this power
FloorPDUs [ { array
domain.
Link to a PowerDistribution resource. See the Links section and the
@odata.id string read-write
PowerDistribution schema for details.
}]
An array of links to the managers responsible for managing this power
ManagedBy [ { array
domain.
Link to a Manager resource. See the Links section and the Manager
@odata.id string read-only
schema for details.
}]
Oem {} object See the Oem object definition in the Common properties section.
PowerShelves
array An array of links to the power shelves in this power domain.
(v1.1+) [ {
Link to a PowerDistribution resource. See the Links section and the
@odata.id string read-write
PowerDistribution schema for details.
}]
An array of links to the rack-level power distribution units in this power
RackPDUs [ { array
domain.
Link to a PowerDistribution resource. See the Links section and the
@odata.id string read-write
PowerDistribution schema for details.
706 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
}]
Switchgear [ { array An array of links to the switchgear in this power domain.
Link to a PowerDistribution resource. See the Links section and the
@odata.id string read-write
PowerDistribution schema for details.
}]
TransferSwitches
array An array of links to the transfer switches in this power domain.
[{
Link to a PowerDistribution resource. See the Links section and the
@odata.id string read-write
PowerDistribution schema for details.
}]
The status and health of the resource and its subordinate or dependent
Status {} object
resources. For property details, see Status.
6.94.4 Example response
{
"@odata.type": "#PowerDomain.v1_2_0.PowerDomain",
"Id": "Row1",
"Name": "Row #1 Domain",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Links": {
"ManagedBy": [
{
"@odata.id": "/redfish/v1/Managers/BMC"
}
],
"RackPDUs": [
{
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1"
}
]
},
"@odata.id": "/redfish/v1/Facilities/Room237/PowerDomains/Row1"
}
Version 2023.1 Published 707
Redfish Resource and Schema Guide DSP2046
6.95 PowerEquipment 1.2.0
Version v1.2 v1.1 v1.0
Release 2021.3 2021.2 2019.4
6.95.1 Description
This is the schema definition for the set of power equipment.
6.95.2 URIs
/redfish/v1/PowerEquipment
6.95.3 Properties
Property Type Attributes Notes
ElectricalBuses
object The link to a collection of electrical buses. Contains a link to a resource.
(v1.2+) {
Link to Collection of PowerDistribution. See the PowerDistribution schema
@odata.id string read-only
for details.
A link to a collection of floor power distribution units. Contains a link to a
FloorPDUs { object
resource.
Link to Collection of PowerDistribution. See the PowerDistribution schema
@odata.id string read-only
for details.
Links { object The links to other resources that are related to this resource.
ManagedBy [ An array of links to the managers responsible for managing this power
array
{ equipment.
Link to a Manager resource. See the Links section and the Manager schema
@odata.id string read-only
for details.
}]
Oem {} object See the Oem object definition in the Common properties section.
708 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
PowerShelves
object A link to a collection of power shelves. Contains a link to a resource.
(v1.1+) {
Link to Collection of PowerDistribution. See the PowerDistribution schema
@odata.id string read-only
for details.
A link to a collection of rack-level power distribution units. Contains a link
RackPDUs { object
to a resource.
Link to Collection of PowerDistribution. See the PowerDistribution schema
@odata.id string read-only
for details.
The status and health of the resource and its subordinate or dependent
Status {} object
resources. For property details, see Status.
Switchgear { object A link to a collection of switchgear. Contains a link to a resource.
Link to Collection of PowerDistribution. See the PowerDistribution schema
@odata.id string read-only
for details.
TransferSwitches
object A link to a collection of transfer switches. Contains a link to a resource.
{
Link to Collection of PowerDistribution. See the PowerDistribution schema
@odata.id string read-only
for details.
6.95.4 Example response
{
"@odata.type": "#PowerEquipment.v1_2_0.PowerEquipment",
"Id": "PowerEquipment",
"Name": "DCIM Power Equipment",
"Status": {
"State": "Enabled",
"HealthRollup": "OK"
},
"FloorPDUs": {
"@odata.id": "/redfish/v1/PowerEquipment/FloorPDUs"
Version 2023.1 Published 709
Redfish Resource and Schema Guide DSP2046
},
"RackPDUs": {
"@odata.id": "/redfish/v1/PowerEquipment/RackPDUs"
},
"TransferSwitches": {
"@odata.id": "/redfish/v1/PowerEquipment/TransferSwitches"
},
"@odata.id": "/redfish/v1/PowerEquipment"
}
6.96 PowerSubsystem 1.1.0
Version v1.1 v1.0
Release 2021.2 2020.4
6.96.1 Description
This PowerSubsystem schema contains the definition for the power subsystem of a chassis.
6.96.2 URIs
/redfish/v1/Chassis/{ChassisId}/PowerSubsystem
6.96.3 Properties
Property Type Attributes Notes
Allocation { object Power allocation for this subsystem.
number read-only The total amount of power that has been allocated or budgeted to
AllocatedWatts
(Watts) (null) this subsystem.
The potential power, in watts, that the subsystem requests, which
number read-only might be higher than the current level being consumed because the
RequestedWatts
(Watts) (null) requested power includes a budget that the subsystem wants for
future use.
The link to the collection of batteries within this subsystem.
Batteries (v1.1+) { object
Contains a link to a resource.
710 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
@odata.id string read-only Link to Collection of Battery. See the Battery schema for details.
The total amount of power that can be allocated to this subsystem.
number read-only
CapacityWatts This value can be either the power supply capacity or the power
(Watts) (null)
budget that an upstream chassis assigns to this subsystem.
The link to the collection of power supplies within this subsystem.
PowerSupplies { object
Contains a link to a resource.
Link to Collection of PowerSupply. See the PowerSupply schema for
@odata.id string read-only
details.
PowerSupplyRedundancy array The redundancy information for the set of power supplies in this
[{}] (object) subsystem. For property details, see RedundantGroup.
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
6.96.4 Example response
{
"@odata.type": "#PowerSubsystem.v1_1_0.PowerSubsystem",
"Id": "PowerSubsystem",
"Name": "Power Subsystem for Chassis",
"CapacityWatts": 2000,
"Allocation": {
"RequestedWatts": 1500,
"AllocatedWatts": 1200
},
"PowerSupplyRedundancy": [
{
"RedundancyType": "Failover",
"MaxSupportedInGroup": 2,
"MinNeededInGroup": 1,
"RedundancyGroup": [
{
"@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/PowerSupplies/Bay1"
},
{
"@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/PowerSupplies/Bay2"
}
],
"Status": {
Version 2023.1 Published 711
Redfish Resource and Schema Guide DSP2046
"State": "UnavailableOffline",
"Health": "OK"
}
}
],
"PowerSupplies": {
"@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/PowerSupplies"
},
"Status": {
"State": "Enabled",
"Health": "OK"
},
"@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem"
}
6.97 PowerSupply 1.5.1
Version v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.2 2022.1 2021.4 2021.3 2021.1 2020.4
6.97.1 Description
The PowerSupply schema describes a power supply unit. It also describes the location, such as a slot,
socket, or bay, where a unit can be installed, by populating a resource instance with an absent state if
a unit is not present.
6.97.2 URIs
/redfish/v1/Chassis/{ChassisId}/PowerSubsystem/PowerSupplies/{PowerSupplyId}
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/PowerSupplies/{PowerSupplyId}
6.97.3 Properties
Property Type Attributes Notes
The link to the assembly associated with this power supply. See
Assembly { object
the Assembly schema for details on this property.
Link to a Assembly resource. See the Links section and the
@odata.id string read-only
Assembly schema for details.
712 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
EfficiencyRatings [ { array The efficiency ratings of this power supply.
number read-only
EfficiencyPercent The rated efficiency of this power supply at the specified load.
(%) (null)
number read-only
LoadPercent The electrical load for this rating.
(%) (null)
}]
array
ElectricalSourceManagerURIs (URI) The URIs of the management interfaces for the upstream
read-write
(v1.2+) [ ] (string, electrical source connections for this power supply.
null)
array
ElectricalSourceNames The names of the upstream electrical sources, such as circuits
(string, read-write
(v1.2+) [ ] or outlets, connected to this power supply.
null)
read-only
FirmwareVersion string The firmware version for this power supply.
(null)
read-only An indication of whether this device can be inserted or removed
HotPluggable boolean
(null) while the equipment is in operation.
The nominal voltage type of the line input to this power supply.
string read-only
InputNominalVoltageType For the possible property values, see InputNominalVoltageType
(enum) (null)
in Property details.
InputRanges [ { array The input ranges that the power supply can use.
number read-only The maximum capacity of this power supply when operating in
CapacityWatts
(Watts) (null) this input range.
string read-only The input voltage range. For the possible property values, see
NominalVoltageType
(enum) (null) NominalVoltageType in Property details.
}]
string read-only The status of the line input. For the possible property values,
LineInputStatus (v1.3+)
(enum) (null) see LineInputStatus in Property details.
Links { object The links to other resources that are related to this resource.
See the Oem object definition in the Common properties
Oem {} object
section.
Version 2023.1 Published 713
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
A link to the outlet connected to this power supply. See the
Outlet schema for details on this property. Deprecated in v1.4
Outlet (deprecated v1.4) { object and later. This property has been deprecated in favor of the
PowerOutlets property to allow for consistent modeling of power
supplies with multiple outlet support.
Link to a Outlet resource. See the Links section and the Outlet
@odata.id string read-write
schema for details.
PoweringChassis (v1.4+) [ An array of links to the chassis that are directly powered by this
array
{ power supply.
Link to a Chassis resource. See the Links section and the
@odata.id string read-only
Chassis schema for details.
}]
An array of links to the outlets that provide power to this power
PowerOutlets (v1.2+) [ { array
supply.
Link to a Outlet resource. See the Links section and the Outlet
@odata.id string read-write
schema for details.
}]
The location of the power supply. For property details, see
Location {} object
Location.
read-write An indicator allowing an operator to physically locate this
LocationIndicatorActive boolean
(null) resource.
read-only
Manufacturer string The manufacturer of this power supply.
(null)
The link to the power supply metrics resource associated with
Metrics { object this power supply. See the PowerSupplyMetrics schema for
details on this property.
Link to a PowerSupplyMetrics resource. See the Links section
@odata.id string read-only
and the PowerSupplyMetrics schema for details.
read-only
Model string The model number for this power supply.
(null)
714 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The nominal output voltage type of this power supply. For the
OutputNominalVoltageType string read-only
possible property values, see OutputNominalVoltageType in
(v1.5+) (enum) (null)
Property details.
OutputRails [ { array The output power rails provided by this power supply.
read-only
NominalVoltage number The nominal voltage of this output power rail.
(null)
The area or device to which this power rail applies. For the
string
PhysicalContext read-only possible property values, see PhysicalContext in Property
(enum)
details.
}]
read-only
PartNumber string The part number for this power supply.
(null)
The number of ungrounded current-carrying conductors
string read-only (phases) and the total number of conductors (wires) provided for
PhaseWiringType
(enum) (null) the power supply input connector. For the possible property
values, see PhaseWiringType in Property details.
The type of plug according to NEMA, IEC, or regional standards.
string read-only
PlugType For the possible property values, see PlugType in Property
(enum) (null)
details.
number read-only
PowerCapacityWatts The maximum capacity of this power supply.
(Watts) (null)
string read-only The power supply type (AC or DC). For the possible property
PowerSupplyType
(enum) (null) values, see PowerSupplyType in Property details.
string
read-only
ProductionDate (v1.1+) (date- The production or manufacturing date of this power supply.
(null)
time)
read-only An indication of whether this component can be independently
Replaceable (v1.5+) boolean
(null) replaced as allowed by the vendor's replacement policy.
read-only
SerialNumber string The serial number for this power supply.
(null)
read-only
SparePartNumber string The spare part number for this power supply.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
read-only
Version (v1.1+) string The hardware version of this power supply.
(null)
Version 2023.1 Published 715
Redfish Resource and Schema Guide DSP2046
6.97.4 Actions
6.97.4.1 Reset
Description
This action resets the power supply.
Action URI
{Base URI of target resource}/Actions/PowerSupply.Reset
Action parameters
Parameter
Type Attributes Notes
Name
string The type of reset. For the possible property values, see ResetType in Property
ResetType optional
(enum) details.
Request Example
{
"ResetType": "ForceRestart"
}
6.97.5 Property details
6.97.5.1 InputNominalVoltageType
The nominal voltage type of the line input to this power supply.
string Description
AC100To127V AC 100-127V nominal.
AC100To240V AC 100-240V nominal.
AC100To277V AC 100-277V nominal.
AC120V AC 120V nominal.
716 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
AC200To240V AC 200-240V nominal.
AC200To277V AC 200-277V nominal.
AC208V AC 208V nominal.
AC230V AC 230V nominal.
AC240AndDC380V AC 200-240V and DC 380V.
AC240V AC 240V nominal.
AC277AndDC380V AC 200-277V and DC 380V.
AC277V AC 277V nominal.
AC400V AC 400V or 415V nominal.
AC480V AC 480V nominal.
DC12V DC 12V nominal.
DC16V DC 16V nominal.
DC1_8V DC 1.8V nominal.
DC240V DC 240V nominal.
DC380V High Voltage DC (380V).
DC3_3V DC 3.3V nominal.
DC48V DC 48V nominal.
DC5V DC 5V nominal.
DC9V DC 9V nominal.
DCNeg48V -48V DC.
6.97.5.2 LineInputStatus
The status of the line input.
string Description
LossOfInput No power detected at line input.
Normal Line input is within normal operating range.
Version 2023.1 Published 717
Redfish Resource and Schema Guide DSP2046
string Description
OutOfRange Line input voltage or current is outside of normal operating range.
6.97.5.3 NominalVoltageType
The input voltage range.
string Description
AC100To127V AC 100-127V nominal.
AC100To240V AC 100-240V nominal.
AC100To277V AC 100-277V nominal.
AC120V AC 120V nominal.
AC200To240V AC 200-240V nominal.
AC200To277V AC 200-277V nominal.
AC208V AC 208V nominal.
AC230V AC 230V nominal.
AC240AndDC380V AC 200-240V and DC 380V.
AC240V AC 240V nominal.
AC277AndDC380V AC 200-277V and DC 380V.
AC277V AC 277V nominal.
AC400V AC 400V or 415V nominal.
AC480V AC 480V nominal.
DC12V DC 12V nominal.
DC16V DC 16V nominal.
DC1_8V DC 1.8V nominal.
DC240V DC 240V nominal.
DC380V High Voltage DC (380V).
DC3_3V DC 3.3V nominal.
DC48V DC 48V nominal.
718 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
DC5V DC 5V nominal.
DC9V DC 9V nominal.
DCNeg48V -48V DC.
6.97.5.4 OutputNominalVoltageType
The nominal output voltage type of this power supply.
string Description
AC100To127V AC 100-127V nominal.
AC100To240V AC 100-240V nominal.
AC100To277V AC 100-277V nominal.
AC120V AC 120V nominal.
AC200To240V AC 200-240V nominal.
AC200To277V AC 200-277V nominal.
AC208V AC 208V nominal.
AC230V AC 230V nominal.
AC240AndDC380V AC 200-240V and DC 380V.
AC240V AC 240V nominal.
AC277AndDC380V AC 200-277V and DC 380V.
AC277V AC 277V nominal.
AC400V AC 400V or 415V nominal.
AC480V AC 480V nominal.
DC12V DC 12V nominal.
DC16V DC 16V nominal.
DC1_8V DC 1.8V nominal.
DC240V DC 240V nominal.
DC380V High Voltage DC (380V).
Version 2023.1 Published 719
Redfish Resource and Schema Guide DSP2046
string Description
DC3_3V DC 3.3V nominal.
DC48V DC 48V nominal.
DC5V DC 5V nominal.
DC9V DC 9V nominal.
DCNeg48V -48V DC.
6.97.5.5 PhaseWiringType
The number of ungrounded current-carrying conductors (phases) and the total number of conductors
(wires) provided for the power supply input connector.
string Description
OneOrTwoPhase3Wire Single or Two-Phase / 3-Wire (Line1, Line2 or Neutral, Protective Earth).
OnePhase3Wire Single-phase / 3-Wire (Line1, Neutral, Protective Earth).
ThreePhase4Wire Three-phase / 4-Wire (Line1, Line2, Line3, Protective Earth).
ThreePhase5Wire Three-phase / 5-Wire (Line1, Line2, Line3, Neutral, Protective Earth).
TwoPhase3Wire Two-phase / 3-Wire (Line1, Line2, Protective Earth).
TwoPhase4Wire Two-phase / 4-Wire (Line1, Line2, Neutral, Protective Earth).
6.97.5.6 PhysicalContext
The area or device to which this power rail applies.
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
720 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
GPU A graphics processor (GPU).
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
Version 2023.1 Published 721
Redfish Resource and Schema Guide DSP2046
string Description
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
StorageBay Within a storage bay.
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
6.97.5.7 PlugType
The type of plug according to NEMA, IEC, or regional standards.
string Description
California_CS8265 California Standard CS8265 (Single-phase 250V; 50A; 2P3W).
California_CS8365 California Standard CS8365 (Three-phase 250V; 50A; 3P4W).
Field_208V_3P4W_60A Field-wired; Three-phase 200-250V; 60A; 3P4W.
Field_400V_3P5W_32A Field-wired; Three-phase 200-240/346-415V; 32A; 3P5W.
IEC_60309_316P6 IEC 60309 316P6 (Single-phase 200-250V; 16A; 1P3W; Blue, 6-hour).
IEC_60309_332P6 IEC 60309 332P6 (Single-phase 200-250V; 32A; 1P3W; Blue, 6-hour).
722 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
IEC_60309_363P6 IEC 60309 363P6 (Single-phase 200-250V; 63A; 1P3W; Blue, 6-hour).
IEC_60309_460P9 IEC 60309 460P9 (Three-phase 200-250V; 60A; 3P4W; Blue; 9-hour).
IEC_60309_516P6 IEC 60309 516P6 (Three-phase 200-240/346-415V; 16A; 3P5W; Red; 6-hour).
IEC_60309_532P6 IEC 60309 532P6 (Three-phase 200-240/346-415V; 32A; 3P5W; Red; 6-hour).
IEC_60309_560P9 IEC 60309 560P9 (Three-phase 120-144/208-250V; 60A; 3P5W; Blue; 9-hour).
IEC_60309_563P6 IEC 60309 563P6 (Three-phase 200-240/346-415V; 63A; 3P5W; Red; 6-hour).
IEC_60320_C14 IEC C14 (Single-phase 250V; 10A; 1P3W).
IEC_60320_C20 IEC C20 (Single-phase 250V; 16A; 1P3W).
NEMA_5_15P NEMA 5-15P (Single-phase 125V; 15A; 1P3W).
NEMA_5_20P NEMA 5-20P (Single-phase 125V; 20A; 1P3W).
NEMA_6_15P NEMA 6-15P (Single-phase 250V; 15A; 2P3W).
NEMA_6_20P NEMA 6-20P (Single-phase 250V; 20A; 2P3W).
NEMA_L14_20P NEMA L14-20P (Split-phase 125/250V; 20A; 2P4W).
NEMA_L14_30P NEMA L14-30P (Split-phase 125/250V; 30A; 2P4W).
NEMA_L15_20P NEMA L15-20P (Three-phase 250V; 20A; 3P4W).
NEMA_L15_30P NEMA L15-30P (Three-phase 250V; 30A; 3P4W).
NEMA_L21_20P NEMA L21-20P (Three-phase 120/208V; 20A; 3P5W).
NEMA_L21_30P NEMA L21-30P (Three-phase 120/208V; 30A; 3P5W).
NEMA_L22_20P NEMA L22-20P (Three-phase 277/480V; 20A; 3P5W).
NEMA_L22_30P NEMA L22-30P (Three-phase 277/480V; 30A; 3P5W).
NEMA_L5_15P NEMA L5-15P (Single-phase 125V; 15A; 1P3W).
NEMA_L5_20P NEMA L5-20P (Single-phase 125V; 20A; 1P3W).
NEMA_L5_30P NEMA L5-30P (Single-phase 125V; 30A; 1P3W).
NEMA_L6_15P NEMA L6-15P (Single-phase 250V; 15A; 2P3W).
NEMA_L6_20P NEMA L6-20P (Single-phase 250V; 20A; 2P3W).
NEMA_L6_30P NEMA L6-30P (Single-phase 250V; 30A; 2P3W).
Version 2023.1 Published 723
Redfish Resource and Schema Guide DSP2046
6.97.5.8 PowerSupplyType
The power supply type (AC or DC).
string Description
AC Alternating Current (AC) power supply.
ACorDC The power supply supports both DC or AC.
DC Direct Current (DC) power supply.
DCRegulator (v1.5+) Direct Current (DC) voltage regulator.
6.97.5.9 ResetType
The type of reset.
string Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
ForceOn Turn on the unit immediately.
ForceRestart Shut down immediately and non-gracefully and restart the system.
GracefulRestart Shut down gracefully and restart the system.
GracefulShutdown Shut down gracefully and power off.
Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal
Nmi
operations, complete diagnostic actions, and, typically, halt the system.
On Turn on the unit.
Pause execution on the unit but do not remove power. This is typically a feature of virtual
Pause
machine hypervisors.
Power cycle the unit. Behaves like a full power removal, followed by a power restore to the
PowerCycle
resource.
PushPowerButton Simulate the pressing of the physical power button on this unit.
Resume execution on the paused unit. This is typically a feature of virtual machine
Resume
hypervisors.
Write the state of the unit to disk before powering off. This allows for the state to be restored
Suspend
when powered back on.
724 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.97.6 Example response
{
"@odata.type": "#PowerSupply.v1_5_1.PowerSupply",
"Id": "Bay1",
"Name": "Power Supply Bay 1",
"Status": {
"State": "Enabled",
"Health": "Warning"
},
"LineInputStatus": "Normal",
"Model": "RKS-440DC",
"Manufacturer": "Contoso Power",
"FirmwareVersion": "1.00",
"SerialNumber": "3488247",
"PartNumber": "23456-133",
"SparePartNumber": "93284-133",
"LocationIndicatorActive": false,
"HotPluggable": false,
"PowerCapacityWatts": 400,
"PhaseWiringType": "OnePhase3Wire",
"PlugType": "IEC_60320_C14",
"InputRanges": [
{
"NominalVoltageType": "AC200To240V",
"CapacityWatts": 400
},
{
"NominalVoltageType": "AC120V",
"CapacityWatts": 350
},
{
"NominalVoltageType": "DC380V",
"CapacityWatts": 400
}
],
"EfficiencyRatings": [
{
"LoadPercent": 25,
"EfficiencyPercent": 75
},
{
"LoadPercent": 50,
"EfficiencyPercent": 85
},
{
"LoadPercent": 90,
"EfficiencyPercent": 80
}
Version 2023.1 Published 725
Redfish Resource and Schema Guide DSP2046
],
"OutputRails": [
{
"NominalVoltage": 3.3,
"PhysicalContext": "SystemBoard"
},
{
"NominalVoltage": 5,
"PhysicalContext": "SystemBoard"
},
{
"NominalVoltage": 12,
"PhysicalContext": "StorageDevice"
}
],
"Location": {
"PartLocation": {
"ServiceLabel": "PSU 1",
"LocationType": "Bay",
"LocationOrdinalValue": 0
}
},
"Links": {
"Outlet": {
"@odata.id": "https://redfishpdu.contoso.com/redfish/v1/PowerEquipment/RackPDUs/1/Outlets/A4"
}
},
"Assembly": {
"@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/PowerSupplies/Bay1/Assembly"
},
"Metrics": {
"@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/PowerSupplies/Bay1/Metrics"
},
"Actions": {
"#PowerSupply.Reset": {
"target": "/redfish/v1/Chassis/1U/PowerSubsystem/PowerSupplies/Bay1/PowerSupply.Reset"
}
},
"@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/PowerSupplies/Bay1"
}
6.98 PowerSupplyMetrics 1.1.0
Version v1.1 v1.0
Release 2023.1 2020.4
726 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.98.1 Description
The PowerSupplyMetrics schema contains definitions for the metrics of a power supply.
6.98.2 URIs
/redfish/v1/Chassis/{ChassisId}/PowerSubsystem/PowerSupplies/{PowerSupplyId}/Metrics
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/PowerSupplies/{PowerSupplyId}/
Metrics
6.98.3 Properties
Property Type Attributes Notes
object The energy consumption (kWh) of this unit. This object is an excerpt
EnergykWh {
(excerpt) of the Sensor resource located at the URI shown in DataSourceUri.
ApparentkVAh number read-only
Apparent energy (kVAh).
(v1.5+) (kV.A.h) (null)
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
LifetimeReading read-only
number The total accumulation value for this sensor.
(v1.1+) (null)
ReactivekVARh number read-only
Reactive energy (kVARh).
(v1.5+) (kV.A.h) (null)
read-only
Reading number The sensor value.
(null)
string read-only
SensorResetTime The date and time when the time-based properties were last reset.
(date-time) (null)
The fan speed (percent) for this power supply. This object is an
excerpt of the Sensor resource located at the URI shown in
FanSpeedPercent object
DataSourceUri. Deprecated in v1.1 and later. This property has been
(deprecated v1.1) { (excerpt)
deprecated in favor of FanSpeedsPercent to support multiple fans
within a power supply.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
Version 2023.1 Published 727
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
number read-only
SpeedRPM (v1.2+) The rotational speed.
({rev}/min) (null)
FanSpeedsPercent array Fan speeds (percent). This object is an excerpt of the Sensor resource
(v1.1+) [ { (excerpt) located at the URI shown in DataSourceUri.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
DeviceName (v1.2+) string The name of the device.
(null)
string read-only The area or device to which this sensor measurement applies. For the
PhysicalContext
(enum) (null) possible property values, see PhysicalContext in Property details.
The usage or location within a device to which this sensor
string read-only
PhysicalSubContext measurement applies. For the possible property values, see
(enum) (null)
PhysicalSubContext in Property details.
read-only
Reading number The sensor value.
(null)
number read-only
SpeedRPM (v1.2+) The rotational speed.
({rev}/min) (null)
}]
object The frequency (Hz) for this power supply. This object is an excerpt of
FrequencyHz {
(excerpt) the Sensor resource located at the URI shown in DataSourceUri.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
object The input current (A) for this power supply. This object is an excerpt
InputCurrentAmps {
(excerpt) of the Sensor resource located at the URI shown in DataSourceUri.
read-only
CrestFactor (v1.1+) number The crest factor for this sensor.
(null)
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
728 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only
THDPercent (v1.1+) number The total harmonic distortion (THD).
(null)
object The input power (W) for this power supply. This object is an excerpt of
InputPowerWatts {
(excerpt) the Sensor resource located at the URI shown in DataSourceUri.
number read-only The product of voltage and current for an AC circuit, in volt-ampere
ApparentVA
(V.A) (null) units.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
PhaseAngleDegrees read-only The phase angle (degrees) between the current and voltage
number
(v1.5+) (null) waveforms.
read-only
PowerFactor number The power factor for this sensor.
(null)
number read-only The square root of the difference term of squared apparent VA and
ReactiveVAR
(V.A) (null) squared power (Reading) for a circuit, in VAR units.
read-only
Reading number The sensor value.
(null)
object The input voltage (V) for this power supply. This object is an excerpt
InputVoltage {
(excerpt) of the Sensor resource located at the URI shown in DataSourceUri.
read-only
CrestFactor (v1.1+) number The crest factor for this sensor.
(null)
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
read-only
THDPercent (v1.1+) number The total harmonic distortion (THD).
(null)
The total power output (W) for this power supply. This object is an
object
OutputPowerWatts { excerpt of the Sensor resource located at the URI shown in
(excerpt)
DataSourceUri.
number read-only The product of voltage and current for an AC circuit, in volt-ampere
ApparentVA
(V.A) (null) units.
Version 2023.1 Published 729
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
PhaseAngleDegrees read-only The phase angle (degrees) between the current and voltage
number
(v1.5+) (null) waveforms.
read-only
PowerFactor number The power factor for this sensor.
(null)
number read-only The square root of the difference term of squared apparent VA and
ReactiveVAR
(V.A) (null) squared power (Reading) for a circuit, in VAR units.
read-only
Reading number The sensor value.
(null)
array The output currents (A) for this power supply. This object is an excerpt
RailCurrentAmps [ {
(excerpt) of the Sensor resource located at the URI shown in DataSourceUri.
read-only
CrestFactor (v1.1+) number The crest factor for this sensor.
(null)
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
read-only
THDPercent (v1.1+) number The total harmonic distortion (THD).
(null)
}]
The output power readings (W) for this power supply. This object is an
array
RailPowerWatts [ { excerpt of the Sensor resource located at the URI shown in
(excerpt)
DataSourceUri.
number read-only The product of voltage and current for an AC circuit, in volt-ampere
ApparentVA
(V.A) (null) units.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
PhaseAngleDegrees read-only The phase angle (degrees) between the current and voltage
number
(v1.5+) (null) waveforms.
read-only
PowerFactor number The power factor for this sensor.
(null)
730 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
number read-only The square root of the difference term of squared apparent VA and
ReactiveVAR
(V.A) (null) squared power (Reading) for a circuit, in VAR units.
read-only
Reading number The sensor value.
(null)
}]
The output voltages (V) for this power supply. This object is an
array
RailVoltage [ { excerpt of the Sensor resource located at the URI shown in
(excerpt)
DataSourceUri.
read-only
CrestFactor (v1.1+) number The crest factor for this sensor.
(null)
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
read-only
THDPercent (v1.1+) number The total harmonic distortion (THD).
(null)
}]
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
object The temperature (C) for this power supply. This object is an excerpt of
TemperatureCelsius {
(excerpt) the Sensor resource located at the URI shown in DataSourceUri.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
6.98.4 Actions
6.98.4.1 ResetMetrics
Description
This action resets the summary metrics related to this equipment.
Version 2023.1 Published 731
Redfish Resource and Schema Guide DSP2046
Action URI
{Base URI of target resource}/Actions/PowerSupplyMetrics.ResetMetrics
Action parameters
This action takes no parameters.
6.98.5 Property details
6.98.5.1 PhysicalContext
The area or device to which this sensor measurement applies.
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
732 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
GPU A graphics processor (GPU).
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
StorageBay Within a storage bay.
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
Version 2023.1 Published 733
Redfish Resource and Schema Guide DSP2046
string Description
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
6.98.5.2 PhysicalSubContext
The usage or location within a device to which this sensor measurement applies.
string Description
Input The input.
Output The output.
6.98.6 Example response
{
"@odata.type": "#PowerSupplyMetrics.v1_1_0.PowerSupplyMetrics",
"Id": "Metrics",
"Name": "Metrics for Power Supply 1",
"Status": {
"State": "Enabled",
"Health": "Warning"
},
"InputVoltage": {
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/PS1InputVoltage",
"Reading": 230.2
},
"InputCurrentAmps": {
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/PS1InputCurrent",
"Reading": 5.19
},
"InputPowerWatts": {
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/PS1InputPower",
"Reading": 937.4
},
"RailVoltage": [
{
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/PS1_3VOutput",
"Reading": 3.31
734 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
},
{
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/PS1_5VOutput",
"Reading": 5.03
},
{
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/PS1_12VOutput",
"Reading": 12.06
}
],
"RailCurrentAmps": [
{
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/PS1_3VCurrent",
"Reading": 9.84
},
{
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/PS1_5VCurrent",
"Reading": 1.25
},
{
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/PS1_12Current",
"Reading": 2.58
}
],
"OutputPowerWatts": {
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/PS1OutputPower",
"Reading": 937.4
},
"RailPowerWatts": [
{
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/PS1_3VPower",
"Reading": 79.84
},
{
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/PS1_5VPower",
"Reading": 26.25
},
{
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/PS1_12VPower",
"Reading": 91.58
}
],
"EnergykWh": {
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/PS1Energy",
"Reading": 325675
},
"FrequencyHz": {
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/PS1InputFrequency",
"Reading": 60
},
Version 2023.1 Published 735
Redfish Resource and Schema Guide DSP2046
"TemperatureCelsius": {
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/PS1Temp",
"Reading": 43.9
},
"FanSpeedPercent": {
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/PS1Fan",
"Reading": 68,
"SpeedRPM": 3290
},
"Actions": {
"#PowerSupplyMetrics.ResetMetrics": {
"target": "/redfish/v1/Chassis/1U/PowerSubsystem/PowerSupplies/Bay1/Metrics/PowerSupplyMetrics.ResetMet
}
},
"@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/PowerSupplies/Bay1/Metrics"
}
6.99 PrivilegeRegistry 1.1.4
Version v1.1 v1.0
Release 2017.1 2016.3
6.99.1 Description
The PrivilegeRegistry schema describes the operation-to-privilege mappings.
6.99.2 Properties
Property Type Attributes Notes
The mappings between entities and the relevant privileges that
Mappings [ { array
access those entities.
Entity string read-only The Resource name, such as Manager .
List mapping between HTTP methods and privilege required for the
OperationMap { object
Resource.
DELETE [ { array The privilege required to complete an HTTP DELETE operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
736 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
}]
GET [ { array The privilege required to complete an HTTP GET operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
HEAD [ { array The privilege required to complete an HTTP HEAD operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
PATCH [ { array The privilege required to complete an HTTP PATCH operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
POST [ { array The privilege required to complete an HTTP POST operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
PUT [ { array The privilege required to complete an HTTP PUT operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
PropertyOverrides [ { array The privilege overrides of properties within a Resource.
The mapping between the HTTP operation and the privilege
OperationMap { object
required to complete the operation.
DELETE [ { array The privilege required to complete an HTTP DELETE operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
GET [ { array The privilege required to complete an HTTP GET operation.
Version 2023.1 Published 737
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
HEAD [ { array The privilege required to complete an HTTP HEAD operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
PATCH [ { array The privilege required to complete an HTTP PATCH operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
POST [ { array The privilege required to complete an HTTP POST operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
PUT [ { array The privilege required to complete an HTTP PUT operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
array
Targets [ ] (string, read-only The set of URIs, Resource types, or properties.
null)
}]
ResourceURIOverrides
array The privilege overrides of Resource URIs.
[{
The mapping between the HTTP operation and the privilege
OperationMap { object
required to complete the operation.
DELETE [ { array The privilege required to complete an HTTP DELETE operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
738 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
}]
GET [ { array The privilege required to complete an HTTP GET operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
HEAD [ { array The privilege required to complete an HTTP HEAD operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
PATCH [ { array The privilege required to complete an HTTP PATCH operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
POST [ { array The privilege required to complete an HTTP POST operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
PUT [ { array The privilege required to complete an HTTP PUT operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
array
Targets [ ] (string, read-only The set of URIs, Resource types, or properties.
null)
}]
SubordinateOverrides
array The privilege overrides of the subordinate Resource.
[{
The mapping between the HTTP operation and the privilege
OperationMap { object
required to complete the operation.
DELETE [ { array The privilege required to complete an HTTP DELETE operation.
Version 2023.1 Published 739
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
GET [ { array The privilege required to complete an HTTP GET operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
HEAD [ { array The privilege required to complete an HTTP HEAD operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
PATCH [ { array The privilege required to complete an HTTP PATCH operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
POST [ { array The privilege required to complete an HTTP POST operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
PUT [ { array The privilege required to complete an HTTP PUT operation.
array An array of privileges that are required to complete a specific HTTP
Privilege [ ] read-only
(string) operation on a Resource.
}]
array
Targets [ ] (string, read-only The set of URIs, Resource types, or properties.
null)
}]
}]
array
OEMPrivilegesUsed [ ] read-only The set of OEM privileges used in this mapping.
(string)
740 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
array
The set of Redfish standard privileges used in this mapping. For the
PrivilegesUsed [ ] (string read-only
possible property values, see PrivilegesUsed in Property details.
(enum))
6.99.3 Property details
6.99.3.1 PrivilegesUsed
The set of Redfish standard privileges used in this mapping.
string Description
Administrator for storage subsystems and storage systems found in the storage
AdministrateStorage
collection and storage system collection respectively.
Administrator for systems found in the systems collection. Able to manage boot
AdministrateSystems
configuration, keys, and certificates for systems.
ConfigureComponents Can configure components that this service manages.
ConfigureCompositionInfrastructure Can view and configure composition service resources.
ConfigureManager Can configure managers.
Can change the password for the current user account, log out of their own sessions,
ConfigureSelf and perform operations on resources they created. Services will need to be aware of
resource ownership to map this privilege to an operation from a particular user.
ConfigureUsers Can configure users and their accounts.
Login Can log in to the service and read resources.
NoAuth Authentication is not required.
Operator for storage backup functionality for storage subsystems and storage
OperateStorageBackup
systems found in the storage collection and storage system collection respectively.
Operator for systems found in the systems collection. Able to perform resets and
OperateSystems
configure interfaces.
6.99.4 Example response
Version 2023.1 Published 741
Redfish Resource and Schema Guide DSP2046
"@odata.type": "#PrivilegeRegistry.v1_1_4.PrivilegeRegistry",
"Id": "Contoso_1.0.1_PrivilegeRegistry",
"Name": "Privilege Map",
"PrivilegesUsed": [
"Login",
"ConfigureManager",
"ConfigureUsers",
"ConfigureComponents",
"ConfigureSelf"
],
"OEMPrivilegesUsed": [],
"Mappings": [
{
"Entity": "Manager",
"OperationMap": {
"GET": [
{
"Privilege": [
"Login"
]
}
],
"HEAD": [
{
"Privilege": [
"Login"
]
}
],
"PATCH": [
{
"Privilege": [
"ConfigureManager"
]
}
],
"POST": [
{
"Privilege": [
"ConfigureManager"
]
}
],
"PUT": [
{
"Privilege": [
"ConfigureManager"
]
}
],
742 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"DELETE": [
{
"Privilege": [
"ConfigureManager"
]
}
]
}
}
],
"@odata.id": "/redfish/v1/JobService"
}
6.100 Processor 1.18.0
Version v1.18 v1.17 v1.16 v1.15 v1.14 v1.13 v1.12 v1.11 v1.10 v1.9 v1.8 ...
Release 2023.1 2022.3 2022.2 2022.1 2021.4 2021.2 2021.1 2020.4 2020.3 2020.2 2020.1 ...
6.100.1 Description
The Processor schema describes the information about a single processor that a system contains. A
processor includes both performance characteristics, clock speed, architecture, core count, and so on,
and compatibility, such as the CPU ID instruction results. It also describes the location, such as a slot,
socket, or bay, where a unit can be installed, by populating a resource instance with an absent state if
a unit is not present.
6.100.2 URIs
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/{ProcessorId}
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/{ProcessorId}/
SubProcessors/{ProcessorId2}
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/{ProcessorId}/
SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}
/redfish/v1/Chassis/{ChassisId}/Processors/{ProcessorId}
/redfish/v1/Chassis/{ChassisId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}
/redfish/v1/Chassis/{ChassisId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/
SubProcessors/{ProcessorId3}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/
SubProcessors/{ProcessorId2}
Version 2023.1 Published 743
Redfish Resource and Schema Guide DSP2046
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/
SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}/SubProcessors/{ProcessorId2}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors/
{ProcessorId2}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors/
{ProcessorId2}/SubProcessors/{ProcessorId3}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/
{ProcessorId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/
{ProcessorId}/SubProcessors/{ProcessorId2}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/
{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/
SubProcessors/{ProcessorId3}
6.100.3 Properties
Property Type Attributes Notes
The link to the collection of acceleration functions
AccelerationFunctions (v1.4+) { object associated with this processor. Contains a link to a
resource.
Link to Collection of AccelerationFunction. See the
@odata.id string read-only
AccelerationFunction schema for details.
AdditionalFirmwareVersions
object The additional firmware versions of the processor.
(v1.15+) {
read-only The bootloader version contained in this software, such
Bootloader (v1.7+) string
(null) as U-Boot or UEFI.
read-only
Kernel (v1.7+) string The kernel version contained in this software.
(null)
744 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only The microcode version contained in this software, such
Microcode (v1.7+) string
(null) as processor microcode.
See the Oem object definition in the Common properties
Oem (v1.7+) {} object
section.
read-only
OSDistribution (v1.8+) string The operating system name of this software.
(null)
The link to the operating configuration that is applied to
AppliedOperatingConfig (v1.9+) { object this processor. See the OperatingConfig schema for
details on this property.
Link to a OperatingConfig resource. See the Links section
@odata.id string read-write
and the OperatingConfig schema for details.
The link to an assembly associated with this processor.
Assembly (v1.2+) { object
See the Assembly schema for details on this property.
Link to a Assembly resource. See the Links section and
@odata.id string read-only
the Assembly schema for details.
integer read-only
BaseSpeedMHz (v1.10+) The base (nominal) clock speed of the processor in MHz.
(MHz) (null)
The state of the base frequency settings of the operation
string read-only configuration applied to this processor. For the possible
BaseSpeedPriorityState (v1.9+)
(enum) (null) property values, see BaseSpeedPriorityState in Property
details.
The link to a collection of certificates for device identity
Certificates (v1.11+) { object
and attestation. Contains a link to a resource.
Link to Collection of Certificate. See the Certificate
@odata.id string read-only
schema for details.
Enabled (v1.12+) boolean read-write An indication of whether this processor is enabled.
The link to the environment metrics for this processor.
EnvironmentMetrics (v1.11+) { object See the EnvironmentMetrics schema for details on this
property.
Version 2023.1 Published 745
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to a EnvironmentMetrics resource. See the Links
@odata.id string read-only
section and the EnvironmentMetrics schema for details.
read-only
Family (v1.16+) string The processor family.
(null)
FirmwareVersion (v1.7+) string read-only The firmware version of the processor.
FPGA (v1.4+) { object The properties for processors of the FPGA type.
ExternalInterfaces (v1.4+) [ { array An array of the FPGA external interfaces.
Ethernet (v1.4+) { object The Ethernet-related information for this interface.
read-only
MaxLanes (v1.4+) integer The number of lanes supported by this interface.
(null)
integer read-only
MaxSpeedMbps (v1.4+) The maximum speed supported by this interface.
(Mbit/s) (null)
See the Oem object definition in the Common properties
Oem (v1.4+) {} object
section.
string read-only The interface type. For the possible property values, see
InterfaceType (v1.4+)
(enum) (null) InterfaceType in Property details.
PCIe (v1.4+) { object The PCIe-related information for this interface.
read-only
LanesInUse (v1.3+) integer The number of PCIe lanes in use by this device.
(null)
read-only
MaxLanes (v1.3+) integer The number of PCIe lanes supported by this device.
(null)
The highest version of the PCIe specification supported
string read-only
MaxPCIeType (v1.3+) by this device. For the possible property values, see
(enum) (null)
MaxPCIeType in Property details.
See the Oem object definition in the Common properties
Oem (v1.3+) {} object
section.
The version of the PCIe specification in use by this
string read-only
PCIeType (v1.3+) device. For the possible property values, see PCIeType in
(enum) (null)
Property details.
746 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
}]
FirmwareId (v1.4+) string read-only The FPGA firmware identifier.
FirmwareManufacturer (v1.4+) string read-only The FPGA firmware manufacturer.
The FPGA firmware version. Deprecated in v1.9 and later.
FirmwareVersion (v1.4+,
string read-only This property has been deprecated in favor of the
deprecated v1.9
FirmwareVersion property in the root of this resource.
string The FPGA type. For the possible property values, see
FpgaType (v1.4+) read-only
(enum) FpgaType in Property details.
The FPGA interface to the host. Deprecated in v1.8 and
HostInterface (v1.4+,
object later. This property has been deprecated in favor of the
deprecated v1.8 {
SystemInterface property in the root of this resource.
Ethernet (v1.4+) { object The Ethernet-related information for this interface.
read-only
MaxLanes (v1.4+) integer The number of lanes supported by this interface.
(null)
integer read-only
MaxSpeedMbps (v1.4+) The maximum speed supported by this interface.
(Mbit/s) (null)
See the Oem object definition in the Common properties
Oem (v1.4+) {} object
section.
string read-only The interface type. For the possible property values, see
InterfaceType (v1.4+)
(enum) (null) InterfaceType in Property details.
PCIe (v1.4+) { object The PCIe-related information for this interface.
read-only
LanesInUse (v1.3+) integer The number of PCIe lanes in use by this device.
(null)
read-only
MaxLanes (v1.3+) integer The number of PCIe lanes supported by this device.
(null)
The highest version of the PCIe specification supported
string read-only
MaxPCIeType (v1.3+) by this device. For the possible property values, see
(enum) (null)
MaxPCIeType in Property details.
See the Oem object definition in the Common properties
Oem (v1.3+) {} object
section.
The version of the PCIe specification in use by this
string read-only
PCIeType (v1.3+) device. For the possible property values, see PCIeType in
(enum) (null)
Property details.
Version 2023.1 Published 747
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Model (v1.4+) string read-only The FPGA model.
See the Oem object definition in the Common properties
Oem (v1.4+) {} object
section.
PCIeVirtualFunctions (v1.4+) integer read-write The number of the PCIe Virtual Functions.
ProgrammableFromHost read-write An indication of whether the FPGA firmware can be
boolean
(v1.4+) (null) reprogrammed from the host by using system software.
An array of the FPGA reconfiguration slots. An FPGA uses
ReconfigurationSlots (v1.4+) [
array a reconfiguration slot to contain an acceleration function
{
that can change as the FPGA is provisioned.
The link to the acceleration function that the code
AccelerationFunction
object programmed into a reconfiguration slot provides. See the
(v1.4+) {
AccelerationFunction schema for details on this property.
Link to a AccelerationFunction resource. See the Links
@odata.id string read-only
section and the AccelerationFunction schema for details.
ProgrammableFromHost read-write An indication of whether the reconfiguration slot can be
boolean
(v1.4+) (null) reprogrammed from the host by using system software.
read-only
SlotId (v1.4+) string The FPGA reconfiguration slot identifier.
(null)
string read-only
UUID (v1.4+) The UUID for this reconfiguration slot.
(uuid) (null)
}]
array The list of core identifiers corresponding to the cores that
HighSpeedCoreIDs (v1.9+) [ ] (integer, read-only have been configured with the higher clock speed from
null) the operating configuration applied to this processor.
string read-only The instruction set of the processor. For the possible
InstructionSet
(enum) (null) property values, see InstructionSet in Property details.
The links to other resources that are related to this
Links (v1.1+) { object
resource.
748 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The link to the chassis that contains this processor. See
Chassis (v1.1+) { object
the Chassis schema for details on this property.
Link to a Chassis resource. See the Links section and the
@odata.id string read-only
Chassis schema for details.
ConnectedProcessors (v1.4+) [ An array of links to the processors directly connected to
array
{ this processor.
@odata.id string read-only Link to another Processor resource.
}]
An array of links to the endpoints that connect to this
Endpoints (v1.4+) [ { array
processor.
Link to a Endpoint resource. See the Links section and
@odata.id string read-only
the Endpoint schema for details.
}]
An array of links to the fabric adapters that present this
FabricAdapters (v1.17+) [ { array
processor to a fabric.
Link to a FabricAdapter resource. See the Links section
@odata.id string read-only
and the FabricAdapter schema for details.
}]
A link to the graphics controller associated with this
GraphicsController (v1.12+) { object processor. See the GraphicsController schema for details
(null)
on this property.
Link to a GraphicsController resource. See the Links
@odata.id string read-only
section and the GraphicsController schema for details.
An array of links to the memory associated with this
Memory (v1.11+) [ { array
processor.
Link to a Memory resource. See the Links section and the
@odata.id string read-only
Memory schema for details.
}]
NetworkDeviceFunctions The network device functions to which this processor
array
(v1.13+) [ { performs offload computation, such as with a SmartNIC.
Version 2023.1 Published 749
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to a NetworkDeviceFunction resource. See the Links
@odata.id string read-only section and the NetworkDeviceFunction schema for
details.
}]
See the Oem object definition in the Common properties
Oem {} object
section.
The link to the PCIe device associated with this
PCIeDevice (v1.4+) { object processor. See the PCIeDevice schema for details on this
property.
Link to a PCIeDevice resource. See the Links section and
@odata.id string read-only
the PCIeDevice schema for details.
An array of links to the PCIeFunctions associated with
PCIeFunctions (v1.4+) [ { array
this processor.
Link to a PCIeFunction resource. See the Links section
@odata.id string read-only
and the PCIeFunction schema for details.
}]
The location of the processor. For property details, see
Location (v1.2+) {} object
Location.
read-write An indicator allowing an operator to physically locate this
LocationIndicatorActive (v1.10+) boolean
(null) resource.
read-only
Manufacturer string The processor manufacturer.
(null)
integer read-only
MaxSpeedMHz The maximum clock speed of the processor.
(MHz) (null)
integer read-only
MaxTDPWatts (v1.4+) The maximum Thermal Design Power (TDP) in watts.
(Watts) (null)
An array of DSP0274-defined measurement blocks.
Measurements (v1.11+, deprecated
array Deprecated in v1.14 and later. This property has been
v1.14 [ {
deprecated in favor of the ComponentIntegrity resource.
Link to a MeasurementBlock resource. See the Links
@odata.id string read-only
section and the SoftwareInventory schema for details.
}]
750 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The summary of all memory associated with this
MemorySummary (v1.11+) { object
processor.
read-write An indication of whether memory ECC mode is enabled
ECCModeEnabled (v1.13+) boolean
(null) for this processor.
The link to the memory metrics associated with all
Metrics (v1.11+) { object memory of this processor. See the MemoryMetrics
schema for details on this property.
Link to a MemoryMetrics resource. See the Links section
@odata.id string read-only
and the MemoryMetrics schema for details.
integer read-only
TotalCacheSizeMiB (v1.11+) Total size of cache memory of this processor.
(mebibytes) (null)
Total size of non-cache, volatile or non-volatile memory
integer read-only
TotalMemorySizeMiB (v1.11+) attached to this processor. Examples include DRAMs and
(mebibytes) (null)
NV-DIMMs that are not configured as block storage.
The link to the metrics associated with this processor.
Metrics (v1.4+) { object See the ProcessorMetrics schema for details on this
property.
Link to a ProcessorMetrics resource. See the Links
@odata.id string read-only
section and the ProcessorMetrics schema for details.
integer read-only
MinSpeedMHz (v1.8+) The minimum clock speed of the processor in MHz.
(MHz) (null)
read-only
Model string The product model number of this device.
(null)
The link to the collection operating configurations that
OperatingConfigs (v1.9+) { object can be applied to this processor. Contains a link to a
resource.
Link to Collection of OperatingConfig. See the
@odata.id string read-only
OperatingConfig schema for details.
integer read-only
OperatingSpeedMHz (v1.8+) Operating speed of the processor in MHz.
(MHz) (null)
Version 2023.1 Published 751
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Range of allowed operating speeds (MHz). This object is
OperatingSpeedRangeMHz object
an excerpt of the Control resource located at the URI
(v1.13+) { (excerpt)
shown in DataSourceUri.
read-only
AllowableMax number The maximum possible setting for this control.
(null)
read-only
AllowableMin number The minimum possible setting for this control.
(null)
array
AllowableNumericValues [ ] (number, read-only The supported values for the set point.
null)
The current operating mode of the control. For the
string read-write
ControlMode possible property values, see ControlMode in Property
(enum) (null)
details.
string read-only The link to the resource that provides the data for this
DataSourceUri
(URI) (null) control.
read-only
Reading number The reading of the sensor associated with this control.
(null)
read-only The units of the sensor reading associated with this
ReadingUnits string
(null) control.
read-write
SettingMax number The maximum set point in the allowed range.
(null)
read-write
SettingMin number The minimum set point in the allowed range.
(null)
read-only
PartNumber (v1.7+) string The part number of the processor.
(null)
The link to the collection of ports for this processor.
Ports (v1.13+) { object
Contains a link to a resource.
@odata.id string read-only Link to Collection of Port. See the Port schema for details.
The current power state of the processor. For the
string read-only
PowerState (v1.17+) possible property values, see PowerState in Property
(enum) (null)
details.
752 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The architecture of the processor. For the possible
string read-only
ProcessorArchitecture property values, see ProcessorArchitecture in Property
(enum) (null)
details.
ProcessorId { object The identification information for this processor.
read-only
EffectiveFamily string The effective family for this processor.
(null)
read-only
EffectiveModel string The effective model for this processor.
(null)
read-only The raw manufacturer-provided processor identification
IdentificationRegisters string
(null) registers for this processor.
read-only
MicrocodeInfo string The microcode information for this processor.
(null)
ProtectedIdentificationNumber read-only The Protected Processor Identification Number (PPIN) for
string
(v1.10+) (null) this processor.
read-only
Step string The step value for this processor.
(null)
read-only
VendorId string The vendor identification for this processor.
(null)
read-only
ProcessorIndex (v1.16+) integer The logical index of this processor within the system.
(null)
The memory directly attached or integrated within this
ProcessorMemory (v1.4+) [ { array processor. Examples include internal cache, dedicated
memory for the processor, and system memory.
integer read-only
CapacityMiB (v1.4+) The memory capacity in MiB.
(mebibytes) (null)
read-only An indication of whether this memory is integrated
IntegratedMemory (v1.4+) boolean
(null) within the processor.
The type of memory used by this processor. For the
string read-only
MemoryType (v1.4+) possible property values, see MemoryType in Property
(enum) (null)
details.
read-only
SpeedMHz (v1.4+) integer The operating speed of the memory in MHz.
(null)
}]
Version 2023.1 Published 753
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
string read-only The type of processor. For the possible property values,
ProcessorType
(enum) (null) see ProcessorType in Property details.
An indication of whether this component can be
read-only
Replaceable (v1.16+) boolean independently replaced as allowed by the vendor's
(null)
replacement policy.
read-only
SerialNumber (v1.7+) string The serial number of the processor.
(null)
read-only
Socket string The socket or location of the processor.
(null)
read-only
SparePartNumber (v1.11+) string The spare part number of the processor.
(null)
integer read-write
SpeedLimitMHz (v1.10+) The clock limit of the processor in MHz.
(MHz) (null)
Indicates whether the clock speed of the processor is
read-write
SpeedLocked (v1.10+) boolean fixed at the value specified in the SpeedLimitMHz
(null)
property.
The status and health of the resource and its subordinate
Status {} object
or dependent resources. For property details, see Status.
The link to the collection of sub-processors associated
SubProcessors (v1.3+) { object with this processor, such as cores or threads, that are
part of a processor. Contains a link to a resource.
Link to Collection of Processor. See the Processor schema
@odata.id string read-only
for details.
SystemInterface (v1.8+) { object The interface between the system and the processor.
Ethernet (v1.4+) { object The Ethernet-related information for this interface.
read-only
MaxLanes (v1.4+) integer The number of lanes supported by this interface.
(null)
integer read-only
MaxSpeedMbps (v1.4+) The maximum speed supported by this interface.
(Mbit/s) (null)
See the Oem object definition in the Common properties
Oem (v1.4+) {} object
section.
754 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
string read-only The interface type. For the possible property values, see
InterfaceType (v1.4+)
(enum) (null) InterfaceType in Property details.
PCIe (v1.4+) { object The PCIe-related information for this interface.
read-only
LanesInUse (v1.3+) integer The number of PCIe lanes in use by this device.
(null)
read-only
MaxLanes (v1.3+) integer The number of PCIe lanes supported by this device.
(null)
The highest version of the PCIe specification supported
string read-only
MaxPCIeType (v1.3+) by this device. For the possible property values, see
(enum) (null)
MaxPCIeType in Property details.
See the Oem object definition in the Common properties
Oem (v1.3+) {} object
section.
The version of the PCIe specification in use by this
string read-only
PCIeType (v1.3+) device. For the possible property values, see PCIeType in
(enum) (null)
Property details.
integer read-only
TDPWatts (v1.4+) The nominal Thermal Design Power (TDP) in watts.
(Watts) (null)
array The causes of the processor being throttled. For the
read-only
ThrottleCauses (v1.16+) [ ] (string possible property values, see ThrottleCauses in Property
(null)
(enum)) details.
read-only
Throttled (v1.16+) boolean An indication of whether the processor is throttled.
(null)
read-only
TotalCores integer The total number of cores that this processor contains.
(null)
read-only The total number of enabled cores that this processor
TotalEnabledCores (v1.5+) integer
(null) contains.
read-only The total number of execution threads that this
TotalThreads integer
(null) processor supports.
string read-only The state of the turbo for this processor. For the possible
TurboState (v1.9+)
(enum) (null) property values, see TurboState in Property details.
string read-only
UUID (v1.4+) The UUID for this processor.
(uuid) (null)
Version 2023.1 Published 755
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
Version (v1.7+) string The hardware version of the processor.
(null)
6.100.4 Actions
6.100.4.1 Reset (v1.6+)
Description
This action resets the processor.
Action URI
{Base URI of target resource}/Actions/Processor.Reset
Action parameters
Parameter
Type Attributes Notes
Name
string The type of reset. For the possible property values, see ResetType in Property
ResetType optional
(enum) details.
Request Example
{
"ResetType": "ForceRestart"
}
6.100.4.2 ResetToDefaults (v1.15+)
Description
The action resets the values of writable properties to factory defaults.
Action URI
{Base URI of target resource}/Actions/Processor.ResetToDefaults
Action parameters
756 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
This action takes no parameters.
6.100.5 Property details
6.100.5.1 BaseSpeedPriorityState
The state of the base frequency settings of the operation configuration applied to this processor.
string Description
Disabled Base speed priority is disabled.
Enabled Base speed priority is enabled.
6.100.5.2 ControlMode
The current operating mode of the control.
string Description
Automatic Automatically adjust control to meet the set point.
Disabled The control has been disabled.
Manual No automatic adjustments are made to the control.
Override User override of the automatic set point value.
6.100.5.3 FpgaType
The FPGA type.
string Description
Discrete The discrete FPGA device.
Integrated The FPGA device integrated with other processor in the single chip.
6.100.5.4 InstructionSet
The instruction set of the processor.
Version 2023.1 Published 757
Redfish Resource and Schema Guide DSP2046
string Description
ARM-A32 ARM 32-bit.
ARM-A64 ARM 64-bit.
IA-64 Intel IA-64.
MIPS32 MIPS 32-bit.
MIPS64 MIPS 64-bit.
OEM OEM-defined.
PowerISA (v1.4+) PowerISA-64 or PowerISA-32.
x86 x86 32-bit.
x86-64 x86 64-bit.
6.100.5.5 InterfaceType
The interface type.
string Description
AMBA (v1.8+) The Arm Advanced Microcontroller Bus Architecture interface.
CCIX (v1.8+) The Cache Coherent Interconnect for Accelerators interface.
CXL (v1.8+) The Compute Express Link interface.
Ethernet An Ethernet interface.
OEM An OEM-defined interface.
PCIe A PCI Express interface.
QPI The Intel QuickPath Interconnect.
UPI The Intel UltraPath Interconnect.
6.100.5.6 MaxPCIeType
The highest version of the PCIe specification supported by this device.
758 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.
6.100.5.7 MemoryType
The type of memory used by this processor.
string Description
Cache (v1.17+) Processor cache, but no level is determined.
DDR Double data rate synchronous dynamic random-access memory.
DDR2 Double data rate type two synchronous dynamic random-access memory.
DDR3 Double data rate type three synchronous dynamic random-access memory.
DDR4 Double data rate type four synchronous dynamic random-access memory.
DDR5 Double data rate type five synchronous dynamic random-access memory.
Flash Flash memory.
GDDR Synchronous graphics random-access memory.
GDDR2 Double data rate type two synchronous graphics random-access memory.
GDDR3 Double data rate type three synchronous graphics random-access memory.
GDDR4 Double data rate type four synchronous graphics random-access memory.
GDDR5 Double data rate type five synchronous graphics random-access memory.
GDDR5X Double data rate type five X synchronous graphics random-access memory.
GDDR6 Double data rate type six synchronous graphics random-access memory.
HBM1 High Bandwidth Memory.
HBM2 The second generation of High Bandwidth Memory.
HBM2E (v1.17+) An updated version of the second generation of High Bandwidth Memory.
Version 2023.1 Published 759
Redfish Resource and Schema Guide DSP2046
string Description
HBM3 The third generation of High Bandwidth Memory.
L1Cache L1 cache.
L2Cache L2 cache.
L3Cache L3 cache.
L4Cache L4 cache.
L5Cache L5 cache.
L6Cache L6 cache.
L7Cache L7 cache.
OEM OEM-defined.
SDRAM Synchronous dynamic random-access memory.
SGRAM Synchronous graphics RAM.
SRAM Static random-access memory.
6.100.5.8 PCIeType
The version of the PCIe specification in use by this device.
string Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.
6.100.5.9 PowerState
The current power state of the processor.
760 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
The resource is powered off. The components within the resource might continue to have
Off
AUX power.
On The resource is powered on.
Paused The resource is paused.
A temporary state between on and off. The components within the resource can take time to
PoweringOff
process the power off action.
A temporary state between off and on. The components within the resource can take time to
PoweringOn
process the power on action.
6.100.5.10 ProcessorArchitecture
The architecture of the processor.
string Description
ARM ARM.
IA-64 Intel Itanium.
MIPS MIPS.
OEM OEM-defined.
Power (v1.4+) Power.
x86 x86 or x86-64.
6.100.5.11 ProcessorType
The type of processor.
string Description
Accelerator An accelerator.
Core (v1.3+) A core in a processor.
CPU A CPU.
DSP A DSP.
Version 2023.1 Published 761
Redfish Resource and Schema Guide DSP2046
string Description
FPGA An FPGA.
GPU A GPU.
OEM An OEM-defined processing unit.
Thread (v1.3+) A thread in a processor.
6.100.5.12 ResetType
The type of reset.
string Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
ForceOn Turn on the unit immediately.
ForceRestart Shut down immediately and non-gracefully and restart the system.
GracefulRestart Shut down gracefully and restart the system.
GracefulShutdown Shut down gracefully and power off.
Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal
Nmi
operations, complete diagnostic actions, and, typically, halt the system.
On Turn on the unit.
Pause execution on the unit but do not remove power. This is typically a feature of virtual
Pause
machine hypervisors.
Power cycle the unit. Behaves like a full power removal, followed by a power restore to the
PowerCycle
resource.
PushPowerButton Simulate the pressing of the physical power button on this unit.
Resume execution on the paused unit. This is typically a feature of virtual machine
Resume
hypervisors.
Write the state of the unit to disk before powering off. This allows for the state to be restored
Suspend
when powered back on.
6.100.5.13 ThrottleCauses
The causes of the processor being throttled.
762 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
ClockLimit The cause of the processor being throttled is a clock limit.
The cause of the processor being throttled is a fault detected by management hardware or
ManagementDetectedFault
firmware.
OEM The cause of the processor being throttled is OEM-specific.
PowerLimit The cause of the processor being throttled is a power limit.
ThermalLimit The cause of the processor being throttled is a thermal limit.
Unknown The cause of the processor being throttled is not known.
6.100.5.14 TurboState
The state of the turbo for this processor.
string Description
Disabled Turbo is disabled.
Enabled Turbo is enabled.
6.100.6 Example response
{
"@odata.type": "#Processor.v1_18_0.Processor",
"Name": "Processor",
"Id": "1",
"Socket": "CPU 1",
"ProcessorType": "CPU",
"ProcessorArchitecture": "x86",
"InstructionSet": "x86-64",
"Manufacturer": "Intel(R) Corporation",
"Model": "Multi-Core Intel(R) Xeon(R) processor 7xxx Series",
"ProcessorId": {
"VendorId": "GenuineIntel",
"IdentificationRegisters": "0x34AC34DC8901274A",
"EffectiveFamily": "0x42",
"EffectiveModel": "0x61",
"Step": "0x1",
"MicrocodeInfo": "0x429943"
},
"MaxSpeedMHz": 3700,
Version 2023.1 Published 763
Redfish Resource and Schema Guide DSP2046
"TotalCores": 8,
"TotalThreads": 16,
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Location": {
"PartLocation": {
"ServiceLabel": "Processor 1",
"LocationType": "Socket",
"LocationOrdinalValue": 0
}
},
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Processors/1"
}
6.101 ProcessorMetrics 1.6.1
Version v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.2 2022.1 2021.3 2021.2 2020.4 2020.1 2018.3
6.101.1 Description
The ProcessorMetrics schema contains usage and health statistics for a processor.
6.101.2 URIs
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/{ProcessorId}/
ProcessorMetrics
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/{ProcessorId}/
SubProcessors/{ProcessorId2}/ProcessorMetrics
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/{ProcessorId}/
SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}/ProcessorMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/
ProcessorMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/
SubProcessors/{ProcessorId2}/ProcessorMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/
SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}/ProcessorMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}/ProcessorMetrics
764 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/ProcessorMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}/
ProcessorMetrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
ProcessorSummary/ProcessorMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/ProcessorMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors/
{ProcessorId2}/ProcessorMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors/
{ProcessorId2}/SubProcessors/{ProcessorId3}/ProcessorMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/
{ProcessorId}/ProcessorMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/
{ProcessorId}/SubProcessors/{ProcessorId2}/ProcessorMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/
{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}/ProcessorMetrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/ProcessorSummary/
ProcessorMetrics
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/ProcessorMetrics
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/
ProcessorMetrics
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/
SubProcessors/{ProcessorId3}/ProcessorMetrics
/redfish/v1/Systems/{ComputerSystemId}/ProcessorSummary/ProcessorMetrics
6.101.3 Properties
Property Type Attributes Notes
The average frequency of the processor. Deprecated in
AverageFrequencyMHz (deprecated number read-only
v1.1 and later. This property has been deprecated in favor
v1.1) (MHz) (null)
of OperatingSpeedMHz property.
number read-only
BandwidthPercent The bandwidth usage of this processor as a percentage.
(%) (null)
Cache [ { array The processor cache metrics.
read-only
CacheMiss number The number of cache line misses in millions.
(null)
read-only
CacheMissesPerInstruction number The number of cache misses per instruction.
(null)
Version 2023.1 Published 765
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
HitRatio number The cache line hit ratio.
(null)
read-only
Level string The cache level.
(null)
integer read-only
OccupancyBytes The total cache level occupancy in bytes.
(bytes) (null)
number read-only
OccupancyPercent The total cache occupancy percentage.
(%) (null)
}]
CacheMetricsTotal (v1.2+) { object The total cache metrics for this processor.
The cache metrics since the last reset or
CurrentPeriod (v1.2+) { object
ClearCurrentPeriod action for this processor.
CorrectableECCErrorCount read-only The number of the correctable errors of cache memory
integer
(v1.2+) (null) since reset or ClearCurrentPeriod action for this processor.
UncorrectableECCErrorCount read-only The number of the uncorrectable errors of cache memory
integer
(v1.2+) (null) since reset or ClearCurrentPeriod action for this processor.
LifeTime (v1.2+) { object The cache metrics for the lifetime of this processor.
CorrectableECCErrorCount read-only The number of the correctable errors for the lifetime of
integer
(v1.2+) (null) the cache memory.
UncorrectableECCErrorCount read-only The number of the uncorrectable errors for the lifetime of
integer
(v1.2+) (null) the cache memory.
The power, in watts, that the processor has consumed.
ConsumedPowerWatt (deprecated number read-only Deprecated in v1.2 and later. This property has been
v1.2) (Watts) (null) deprecated in favor of the properties in
EnvironmentMetrics.
CoreMetrics [ { array The processor core metrics.
CoreCache [ { array The cache metrics of this core in the processor.
read-only
CacheMiss number The number of cache line misses in millions.
(null)
766 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only
CacheMissesPerInstruction number The number of cache misses per instruction.
(null)
read-only
HitRatio number The cache line hit ratio.
(null)
read-only
Level string The cache level.
(null)
integer read-only
OccupancyBytes The total cache level occupancy in bytes.
(bytes) (null)
number read-only
OccupancyPercent The total cache occupancy percentage.
(%) (null)
}]
read-only
CoreId string The processor core identifier.
(null)
CorrectableCoreErrorCount read-only
integer The number of the correctable core errors.
(v1.5+) (null)
CorrectableOtherErrorCount read-only The number of the correctable errors of all other
integer
(v1.5+) (null) components.
CStateResidency [ { array The C-state residency of this core in the processor.
read-only
Level string The C-state level, such as C0, C1, or C2.
(null)
number read-only The percentage of time that the processor or core has
ResidencyPercent
(%) (null) spent in this particular level of C-state.
}]
read-only
InstructionsPerCycle number The number of instructions per clock cycle of this core.
(null)
read-only
IOStallCount number The number of stalled cycles due to I/O operations.
(null)
read-only
MemoryStallCount number The number of stalled cycles due to memory operations.
(null)
UncorrectableCoreErrorCount read-only
integer The number of the uncorrectable core errors.
(v1.5+) (null)
UncorrectableOtherErrorCount read-only The number of the uncorrectable errors of all other
integer
(v1.5+) (null) components.
Version 2023.1 Published 767
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
UnhaltedCycles number The unhalted cycles count of this core.
(null)
}]
The core voltage (V) of this processor. This object is an
object
CoreVoltage (v1.3+) { excerpt of the Sensor resource located at the URI shown
(excerpt)
in DataSourceUri.
read-only
CrestFactor (v1.1+) number The crest factor for this sensor.
(null)
string read-only The link to the resource that provides the data for this
DataSourceUri
(URI) (null) sensor.
read-only
Reading number The sensor value.
(null)
read-only
THDPercent (v1.1+) number The total harmonic distortion (THD).
(null)
read-only
CorrectableCoreErrorCount (v1.5+) integer The number of the correctable core errors.
(null)
read-only The number of the correctable errors of all other
CorrectableOtherErrorCount (v1.5+) integer
(null) components.
read-only The frequency relative to the nominal processor
FrequencyRatio number
(null) frequency ratio.
number read-only
KernelPercent The percentage of time spent in kernel mode.
(%) (null)
integer read-only
LocalMemoryBandwidthBytes The local memory bandwidth usage in bytes.
(bytes) (null)
integer read-only
OperatingSpeedMHz (v1.1+) Operating speed of the processor in MHz.
(MHz) (null)
PCIeErrors (v1.4+) { object The PCIe errors associated with this processor.
read-only The total number of the PCIe correctable errors for this
CorrectableErrorCount (v1.8+) integer
(null) device.
read-only
FatalErrorCount (v1.8+) integer The total number of the PCIe fatal errors for this device.
(null)
read-only The total number of times the PCIe link states
L0ToRecoveryCount (v1.8+) integer
(null) transitioned from L0 to the recovery state for this device.
768 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only The total number of NAKs issued on the PCIe link by the
NAKReceivedCount (v1.8+) integer
(null) receiver.
read-only The total number of NAKs issued on the PCIe link by this
NAKSentCount (v1.8+) integer
(null) device.
read-only The total number of the PCIe non-fatal errors for this
NonFatalErrorCount (v1.8+) integer
(null) device.
read-only The total number of the PCIe replays issued by this
ReplayCount (v1.8+) integer
(null) device.
read-only The total number of the PCIe replay rollovers issued by
ReplayRolloverCount (v1.8+) integer
(null) this device.
string read-only The total duration of throttling caused by a power limit of
PowerLimitThrottleDuration (v1.6+)
(duration) (null) the processor since reset.
integer read-only
RemoteMemoryBandwidthBytes The remote memory bandwidth usage in bytes.
(bytes) (null)
The temperature of the processor. Deprecated in v1.2 and
TemperatureCelsius (deprecated number read-only
later. This property has been deprecated in favor of the
v1.2) (Celsius) (null)
properties in EnvironmentMetrics.
ThermalLimitThrottleDuration string read-only The total duration of throttling caused by a thermal limit
(v1.6+) (duration) (null) of the processor since reset.
number read-only The CPU margin to throttle (temperature offset in degree
ThrottlingCelsius
(Celsius) (null) Celsius).
UncorrectableCoreErrorCount read-only
integer The number of the uncorrectable core errors.
(v1.5+) (null)
UncorrectableOtherErrorCount read-only The number of the uncorrectable errors of all other
integer
(v1.5+) (null) components.
number read-only
UserPercent The percentage of time spent in user mode.
(%) (null)
6.101.4 Actions
6.101.4.1 ClearCurrentPeriod (v1.2+)
Description
This action sets the CurrentPeriod property's values to 0.
Version 2023.1 Published 769
Redfish Resource and Schema Guide DSP2046
Action URI
{Base URI of target resource}/Actions/ProcessorMetrics.ClearCurrentPeriod
Action parameters
This action takes no parameters.
6.101.5 Example response
{
"@odata.type": "#ProcessorMetrics.v1_6_1.ProcessorMetrics",
"Id": "Metrics",
"Name": "Processor Metrics",
"BandwidthPercent": 62,
"OperatingSpeedMHz": 2400,
"ThrottlingCelsius": 65,
"FrequencyRatio": 0.00432,
"Cache": [
{
"Level": "3",
"CacheMiss": 0.12,
"HitRatio": 0.719,
"CacheMissesPerInstruction": 0.00088,
"OccupancyBytes": 3030144,
"OccupancyPercent": 90.1
}
],
"LocalMemoryBandwidthBytes": 18253611008,
"RemoteMemoryBandwidthBytes": 81788928,
"KernelPercent": 2.3,
"UserPercent": 34.7,
"CoreMetrics": [
{
"CoreId": "core0",
"InstructionsPerCycle": 1.16,
"UnhaltedCycles": 6254383746,
"MemoryStallCount": 58372,
"IOStallCount": 2634872,
"CoreCache": [
{
"Level": "2",
"CacheMiss": 0.472,
"HitRatio": 0.57,
"CacheMissesPerInstruction": 0.00346,
"OccupancyBytes": 198231,
"OccupancyPercent": 77.4
}
],
770 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"CStateResidency": [
{
"Level": "C0",
"Residency": 1.13
},
{
"Level": "C1",
"Residency": 26
},
{
"Level": "C3",
"Residency": 0.00878
},
{
"Level": "C6",
"Residency": 0.361
},
{
"Level": "C7",
"Residency": 72.5
}
]
}
],
"@odata.id": "/redfish/v1/Systems/1/Processors/FPGA1/ProcessorMetrics"
}
6.102 Pump 1.0.0
Version v1.0
Release 2023.1
6.102.1 Description
The Pump schema describes a pump unit for a cooling system or similar device.
6.102.2 URIs
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Pumps/{PumpId}
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Pumps/{PumpId}
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Pumps/{PumpId}
Version 2023.1 Published 771
Redfish Resource and Schema Guide DSP2046
6.102.3 Properties
Property Type Attributes Notes
The link to the assembly associated with this pump. See the
Assembly { object
Assembly schema for details on this property.
Link to a Assembly resource. See the Links section and the Assembly
@odata.id string read-only
schema for details.
read-write
AssetTag string The user-assigned asset tag for this equipment.
(null)
Filters { object A link to a collection of filters. Contains a link to a resource.
@odata.id string read-only Link to Collection of Filter. See the Filter schema for details.
FirmwareVersion string read-only The firmware version of this equipment.
Location {} object The location of the pump. For property details, see Location.
read-write
LocationIndicatorActive boolean An indicator allowing an operator to physically locate this resource.
(null)
read-only
Manufacturer string The manufacturer of this pump.
(null)
read-only
Model string The model number for this pump.
(null)
read-only
PartNumber string The part number for this pump.
(null)
string The area or device associated with this pump. For the possible
PhysicalContext read-only
(enum) property values, see PhysicalContext in Property details.
string read-only
ProductionDate The production or manufacturing date of this equipment.
(date-time) (null)
object The pump speed (%). This object is an excerpt of the Sensor resource
PumpSpeedPercent {
(excerpt) located at the URI shown in DataSourceUri.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
772 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
number read-only
SpeedRPM (v1.2+) The rotational speed.
({rev}/min) (null)
string read-only The type of pump. For the possible property values, see PumpType in
PumpType
(enum) (null) Property details.
read-only
SerialNumber string The serial number for this pump.
(null)
read-write
ServiceHours number The hours of service this pump has provided.
(null)
read-only
SparePartNumber string The spare part number for this pump.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
UserLabel string read-write A user-assigned label.
read-only
Version string The hardware version of this equipment.
(null)
6.102.4 Property details
6.102.4.1 PhysicalContext
The area or device associated with this pump.
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Version 2023.1 Published 773
Redfish Resource and Schema Guide DSP2046
string Description
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
GPU A graphics processor (GPU).
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
774 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
StorageBay Within a storage bay.
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
6.102.4.2 PumpType
The type of pump.
string Description
Compressor A compressor.
Liquid A water or liquid pump.
6.102.5 Example response
{
"@odata.type": "#Pump.v1_0_0.Pump",
"Id": "1",
"PumpType": "Liquid",
"Name": "Immersion Unit Pump",
Version 2023.1 Published 775
Redfish Resource and Schema Guide DSP2046
"Version": "1.03b",
"ProductionDate": "2021-06-24T08:00:00Z",
"Manufacturer": "Contoso",
"Model": "UP-JAM",
"SerialNumber": "29347ZT599",
"PartNumber": "MAARS",
"AssetTag": "PDX5-92399",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"PumpSpeedPercent": {
"Reading": 62,
"SpeedRPM": 1800
},
"@odata.id": "/redfish/v1/ThermalEquipment/ImmersionUnits/1/Pumps/1"
}
6.103 RegisteredClient 1.1.0
Version v1.1 v1.0
Release 2023.1 2021.4
6.103.1 Description
The RegisteredClient schema defines the record format for a registered client. It is designed to allow
well behaved clients to register with a Redfish service such that other clients are aware the service
might be configured or monitored by the client.
6.103.2 URIs
/redfish/v1/RegisteredClients/{RegisteredClientId}
6.103.3 Properties
Property Type Attributes Notes
string read-write The type of registered client. For the possible property values, see
ClientType
(enum) required ClientType in Property details.
776 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
ClientURI string read-write The URI of the registered client.
Context (v1.1+) string read-write A client-supplied data for providing context for its own use.
string
CreatedDate (date- read-only The date and time when the client entry was created.
time)
string
ExpirationDate (date- read-write The date and time when the client entry will expire.
time)
An array of resources that the registered client monitors or
ManagedResources [ { array
configures.
read-write Indicates whether the subordinate resources of the managed
IncludesSubordinates boolean
(null) resource are also managed by the registered client.
string read-write The URI of the resource or resource collection managed by the
ManagedResourceURI
(URI) (null) registered client.
read-write Indicates whether the registered client expects to have exclusive
PreferExclusive boolean
(null) access to the managed resource.
}]
Additional client-supplied data for providing contextual information
SubContext (v1.1+) string read-write
for its own use.
6.103.4 Property details
6.103.4.1 ClientType
The type of registered client.
string Description
The registered client performs update, create, and delete operations on the resources listed
Configure
in the ManagedResources property as well as read operations on the service.
Monitor The registered client only performs read operations on this service.
Version 2023.1 Published 777
Redfish Resource and Schema Guide DSP2046
6.103.5 Example response
{
"@odata.type": "#RegisteredClient.v1_1_0.RegisteredClient",
"Id": "2",
"Name": "ContosoConfigure",
"ClientType": "Configure",
"CreatedDate": "2021-09-25T20:12:24Z",
"Description": "Contoso manager access",
"ExpirationDate": "2022-10-03T20:00:00Z",
"ManagedResources": [
{
"ManagedResourceURI": "/redfish/v1/Systems",
"PreferExclusive": true,
"IncludesSubordinates": true
},
{
"ManagedResourceURI": "/redfish/v1/Chassis",
"PreferExclusive": true,
"IncludesSubordinates": true
}
],
"ClientURI": "https://4.5.6.2/ContosoManager",
"@odata.id": "/redfish/v1/RegisteredClients/2"
}
6.104 Reservoir 1.0.0
Version v1.0
Release 2023.1
6.104.1 Description
The Reservoir schema describes a reservoir unit for a cooling system or similar device.
6.104.2 URIs
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Reservoirs/{ReservoirId}
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Reservoirs/{ReservoirId}
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Reservoirs/{ReservoirId}
778 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.104.3 Properties
Property Type Attributes Notes
The link to the assembly associated with this reservoir. See the
Assembly { object
Assembly schema for details on this property.
Link to a Assembly resource. See the Links section and the Assembly
@odata.id string read-only
schema for details.
read-only
CapacityLiters number The capacity of the reservoir (l).
(null)
Details about the coolant used in this unit. See the CoolingLoop
Coolant { object
schema for details on this property.
Link to a Coolant resource. See the Links section and the CoolingLoop
@odata.id string read-only
schema for details.
Filters { object A link to a collection of filters. Contains a link to a resource.
@odata.id string read-only Link to Collection of Filter. See the Filter schema for details.
object The fluid capacity filled (percent). This object is an excerpt of the
FluidLevelPercent {
(excerpt) Sensor resource located at the URI shown in DataSourceUri.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
string read-only The status of the fluid level in this reservoir. For the possible property
FluidLevelStatus
(enum) (null) values, see FluidLevelStatus in Property details.
object The internal pressure (kPa) reading. This object is an excerpt of the
InternalPressurekPa {
(excerpt) Sensor resource located at the URI shown in DataSourceUri.
string read-only
DataSourceUri The link to the resource that provides the data for this sensor.
(URI) (null)
read-only
Reading number The sensor value.
(null)
Version 2023.1 Published 779
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Location {} object The location of the reservoir. For property details, see Location.
read-write
LocationIndicatorActive boolean An indicator allowing an operator to physically locate this resource.
(null)
read-only
Manufacturer string The manufacturer of this reservoir.
(null)
read-only
Model string The model number for this reservoir.
(null)
read-only
PartNumber string The part number for this reservoir.
(null)
string The area or device associated with this reservoir. For the possible
PhysicalContext read-only
(enum) property values, see PhysicalContext in Property details.
string read-only The type of reservoir. For the possible property values, see
ReservoirType
(enum) (null) ReservoirType in Property details.
read-only
SerialNumber string The serial number for this reservoir.
(null)
read-only
SparePartNumber string The spare part number for this reservoir.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
UserLabel string read-write A user-assigned label.
6.104.4 Property details
6.104.4.1 FluidLevelStatus
The status of the fluid level in this reservoir.
string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.
780 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.104.4.2 PhysicalContext
The area or device associated with this reservoir.
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
GPU A graphics processor (GPU).
Version 2023.1 Published 781
Redfish Resource and Schema Guide DSP2046
string Description
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
StorageBay Within a storage bay.
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
6.104.4.3 ReservoirType
The type of reservoir.
782 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Immersion An immersion cooling tank.
Inline An inline or integrated reservoir.
Overflow An overflow reservoir for excess fluid.
Reserve A reservoir providing reserve fluid capacity.
6.104.5 Example response
{
"@odata.type": "#Reservoir.v1_0_0.Reservoir",
"Id": "1",
"ReservoirType": "Reserve",
"Name": "Cooling Loop Reservoir",
"Manufacturer": "Contoso",
"Model": "Tarantino",
"CapacityLiters": 10,
"PartNumber": "Pink",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Location": {
"Placement": {
"Row": "North 1"
}
},
"FluidLevelPercent": {
"Reading": 64.8
},
"InternalPressurekPa": {
"Reading": 138.7
},
"@odata.id": "/redfish/v1/ThermalEquipment/CDUs/1/Reservoirs/1"
}
6.105 ResourceBlock 1.4.1
Version v1.4 v1.3 v1.2 v1.1 v1.0
Release 2020.4 2018.3 2018.2 2018.1 2017.1
Version 2023.1 Published 783
Redfish Resource and Schema Guide DSP2046
6.105.1 Description
The ResourceBlock schema contains definitions resource blocks, its components, and affinity to
composed devices.
6.105.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}
6.105.3 Properties
Property Type Attributes Notes
read-write
Client (v1.4+) string The client to which this resource block is assigned.
(null)
CompositionStatus { object required The composition status details for this resource block.
read-only The current state of the resource block from a composition
string
CompositionState required perspective. For the possible property values, see
(enum)
(null) CompositionState in Property details.
read-only The maximum number of compositions in which this resource
MaxCompositions (v1.1+) integer
(null) block can participate simultaneously.
NumberOfCompositions read-only The number of compositions in which this resource block is
integer
(v1.1+) (null) currently participating.
read-write An indication of whether any client has reserved the resource
Reserved boolean
(null) block.
read-only An indication of whether this resource block can participate in
SharingCapable (v1.1+) boolean
(null) multiple compositions simultaneously.
read-write An indication of whether this resource block is allowed to
SharingEnabled (v1.1+) boolean
(null) participate in multiple compositions simultaneously.
An array of links to the computer systems available in this
ComputerSystems [ { array
resource block.
Link to a ComputerSystem resource. See the Links section and
@odata.id string read-only
the ComputerSystem schema for details.
}]
784 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Drives (v1.3+) [ { array An array of links to the drives available in this resource block.
Link to a Drive resource. See the Links section and the Drive
@odata.id string read-only
schema for details.
}]
An array of links to the Ethernet interfaces available in this
EthernetInterfaces [ { array
resource block.
Link to a EthernetInterface resource. See the Links section and
@odata.id string read-only
the EthernetInterface schema for details.
}]
Links { object The links to other resources that are related to this resource.
An array of links to the chassis in which this resource block is
Chassis [ { array
contained.
Link to a Chassis resource. See the Links section and the
@odata.id string read-only
Chassis schema for details.
}]
An array of links to the computer systems that are composed
ComputerSystems [ { array
from this resource block.
Link to a ComputerSystem resource. See the Links section and
@odata.id string read-only
the ComputerSystem schema for details.
}]
ConsumingResourceBlocks An array of links to resource blocks that depend on this
array
(v1.4+) [ { resource block.
@odata.id string read-only Link to another ResourceBlock resource.
}]
See the Oem object definition in the Common properties
Oem {} object
section.
SupplyingResourceBlocks An array of links to resource blocks that this resource block
array
(v1.4+) [ { depends on.
@odata.id string read-only Link to another ResourceBlock resource.
}]
Version 2023.1 Published 785
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
An array of links to the zones in which this resource block is
Zones [ { array
bound.
Link to a Zone resource. See the Links section and the Zone
@odata.id string read-only
schema for details.
}]
Memory [ { array An array of links to the memory available in this resource block.
Link to a Memory resource. See the Links section and the
@odata.id string read-only
Memory schema for details.
}]
An array of links to the Network Interfaces available in this
NetworkInterfaces [ { array
resource block.
Link to a NetworkInterface resource. See the Links section and
@odata.id string read-only
the NetworkInterface schema for details.
}]
string read-write The pool to which this resource block belongs. For the possible
Pool (v1.4+)
(enum) (null) property values, see Pool in Property details.
An array of links to the processors available in this resource
Processors [ { array
block.
Link to a Processor resource. See the Links section and the
@odata.id string read-only
Processor schema for details.
}]
array The types of resources available on this resource block. For the
read-only
ResourceBlockType [ ] (string possible property values, see ResourceBlockType in Property
required
(enum)) details.
An array of links to the simple storage available in this resource
SimpleStorage [ { array
block.
Link to a SimpleStorage resource. See the Links section and the
@odata.id string read-only
SimpleStorage schema for details.
}]
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
786 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Storage [ { array An array of links to the storage available in this resource block.
Link to a Storage resource. See the Links section and the
@odata.id string read-only
Storage schema for details.
}]
6.105.4 Property details
6.105.4.1 CompositionState
The current state of the resource block from a composition perspective.
string Description
Composed Final successful state of a resource block that has participated in composition.
ComposedAndAvailable The resource block is currently participating in one or more compositions, and is available to
(v1.1+) use in more compositions.
Composing Intermediate state indicating composition is in progress.
Failed The final composition resulted in failure and manual intervention might be required to fix it.
The resource block has been made unavailable by the service, such as due to maintenance
Unavailable (v1.2+)
being performed on the resource block.
Unused The resource block is free and can participate in composition.
6.105.4.2 Pool
The pool to which this resource block belongs.
string Description
This resource block is in the active pool and is contributing to at least one composed resource
Active
as a result of a composition request.
Free This resource block is in the free pool and is not contributing to any composed resources.
Unassigned This resource block is not assigned to any pools.
Version 2023.1 Published 787
Redfish Resource and Schema Guide DSP2046
6.105.4.3 ResourceBlockType
The types of resources available on this resource block.
string Description
This resource block contains resources of type Processor and Memory in a manner that
Compute
creates a compute complex.
ComputerSystem This resource block contains resources of type ComputerSystem .
This resource block is capable of changing over time based on its configuration. Different
Expansion
types of devices within this resource block can be added and removed over time.
This resource block is capable of being consumed as a standalone component. This resource
block can represent things such as a software platform on one or more computer systems or
IndependentResource
an appliance that provides composable resources and other services, and can be managed
independently of the Redfish service.
Memory This resource block contains resources of type Memory .
This resource block contains network resources, such as resource of type EthernetInterface
Network
and NetworkInterface .
Processor This resource block contains resources of type Processor .
This resource block contains storage resources, such as resources of type Storage and
Storage
SimpleStorage .
6.105.5 Example response
{
"@odata.type": "#ResourceBlock.v1_4_1.ResourceBlock",
"Id": "ComputeBlock1",
"Name": "Compute Block 1",
"ResourceBlockType": [
"Compute",
"Network"
],
"Status": {
"State": "Enabled",
"Health": "OK"
},
"CompositionStatus": {
"Reserved": false,
"CompositionState": "Composed",
"SharingCapable": false,
788 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"MaxCompositions": 1,
"NumberOfCompositions": 1
},
"Processors": [
{
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ComputeBlock1/Processors/Block1CPU0"
},
{
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ComputeBlock1/Processors/Block1CPU1"
}
],
"Memory": [
{
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ComputeBlock1/Memory/Block1DIMM0"
},
{
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ComputeBlock1/Memory/Block1DIMM1"
},
{
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ComputeBlock1/Memory/Block1DIMM2"
},
{
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ComputeBlock1/Memory/Block1DIMM3"
}
],
"EthernetInterfaces": [
{
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ComputeBlock1/EthernetInterfaces/Block1Onbo
}
],
"ComputerSystems": [],
"Links": {
"ComputerSystems": [
{
"@odata.id": "/redfish/v1/Systems/ComposedSystem"
}
],
"Chassis": [
{
"@odata.id": "/redfish/v1/Chassis/ComposableModule1"
}
],
"Zones": [
{
"@odata.id": "/redfish/v1/CompositionService/ResourceZones/1"
}
]
},
"@odata.id": "/redfish/v1/CompositionService/ResourceBlocks/ComputeBlock1"
}
Version 2023.1 Published 789
Redfish Resource and Schema Guide DSP2046
6.106 Role 1.3.1
Version v1.3 v1.2 v1.1 v1.0
Release 2020.4 2017.2 2017.1 1.0
6.106.1 Description
The Role schema contains a Redfish role to use in conjunction with a manager account.
6.106.2 URIs
/redfish/v1/AccountService/Roles/{RoleId}
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/Roles/{RoleId}
6.106.3 Properties
Property Type Attributes Notes
AlternateRoleId
string read-only An equivalent role to use when this role is restricted.
(v1.3+)
array
AssignedPrivileges The Redfish privileges for this role. For the possible property values, see
(string read-write
[] AssignedPrivileges in Property details.
(enum))
An indication of whether the role is predefined by Redfish or an OEM
IsPredefined boolean read-only
rather than a client-defined role.
array
OemPrivileges [ ] read-write The OEM privileges for this role.
(string)
Restricted (v1.3+) boolean read-only An indication of whether use of the role is restricted.
read-only
RoleId (v1.2+) string required on The name of the role.
create
790 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.106.4 Property details
6.106.4.1 AssignedPrivileges
The Redfish privileges for this role.
string Description
Administrator for storage subsystems and storage systems found in the storage
AdministrateStorage
collection and storage system collection respectively.
Administrator for systems found in the systems collection. Able to manage boot
AdministrateSystems
configuration, keys, and certificates for systems.
ConfigureComponents Can configure components that this service manages.
ConfigureCompositionInfrastructure Can view and configure composition service resources.
ConfigureManager Can configure managers.
Can change the password for the current user account, log out of their own sessions,
ConfigureSelf and perform operations on resources they created. Services will need to be aware of
resource ownership to map this privilege to an operation from a particular user.
ConfigureUsers Can configure users and their accounts.
Login Can log in to the service and read resources.
NoAuth Authentication is not required.
Operator for storage backup functionality for storage subsystems and storage
OperateStorageBackup
systems found in the storage collection and storage system collection respectively.
Operator for systems found in the systems collection. Able to perform resets and
OperateSystems
configure interfaces.
6.106.5 Example response
{
"@odata.type": "#Role.v1_3_1.Role",
"Id": "Administrator",
"Name": "User Role",
"Description": "Admin User Role",
"IsPredefined": true,
"AssignedPrivileges": [
"Login",
Version 2023.1 Published 791
Redfish Resource and Schema Guide DSP2046
"ConfigureManager",
"ConfigureUsers",
"ConfigureSelf",
"ConfigureComponents"
],
"OemPrivileges": [
"OemClearLog",
"OemPowerControl"
],
"@odata.id": "/redfish/v1/AccountService/Roles/Administrator"
}
6.107 RouteEntry 1.0.1
Version v1.0
Release 2019.4
6.107.1 Description
The RouteEntry schema describes the content of route entry rows. Each route entry contains route
sets that list the possible routes for the route entry.
6.107.2 URIs
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/GenZ/MSDT/{MSDTId}
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/GenZ/SSDT/{SSDTId}
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/MSDT/{MSDTId}
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/LPRT/{LPRTId}
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/MPRT/{MPRTId}
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT/{LPRTId}
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT/{MPRTId}
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/SSDT/{SSDTId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/GenZ/MSDT/{MSDTId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/GenZ/SSDT/{SSDTId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/MSDT/{MSDTId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/LPRT/{LPRTId}
792 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/MPRT/{MPRTId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT/{LPRTId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT/{MPRTId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
FabricAdapters/{FabricAdapterId}/SSDT/{SSDTId}
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/GenZ/LPRT/{LPRTId}
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/GenZ/MPRT/{MPRTId}
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/LPRT/{LPRTId}
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/MPRT/{MPRTId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/
{FabricAdapterId}/GenZ/MSDT/{MSDTId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/
{FabricAdapterId}/GenZ/SSDT/{SSDTId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/
{FabricAdapterId}/MSDT/{MSDTId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/
{FabricAdapterId}/Ports/{PortId}/GenZ/LPRT/{LPRTId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/
{FabricAdapterId}/Ports/{PortId}/GenZ/MPRT/{MPRTId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/
{FabricAdapterId}/Ports/{PortId}/LPRT/{LPRTId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/
{FabricAdapterId}/Ports/{PortId}/MPRT/{MPRTId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/
{FabricAdapterId}/SSDT/{SSDTId}
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/GenZ/MSDT/{MSDTId}
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/GenZ/SSDT/{SSDTId}
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/MSDT/{MSDTId}
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/
LPRT/{LPRTId}
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/
MPRT/{MPRTId}
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT/
{LPRTId}
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT/
{MPRTId}
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/SSDT/{SSDTId}
Version 2023.1 Published 793
Redfish Resource and Schema Guide DSP2046
6.107.3 Properties
Property Type Attributes Notes
MinimumHopCount integer read-write The minimum number of hops.
RawEntryHex string read-write The raw data of route entry rows.
The link to the collection of route set entries associated with this route.
RouteSet { object
Contains a link to a resource.
Link to Collection of RouteSetEntry. See the RouteSetEntry schema for
@odata.id string read-only
details.
6.107.4 Example response
{
"@odata.type": "#RouteEntry.v1_0_1.RouteEntry",
"Id": "0",
"Name": "LPRT0",
"Description": "Gen-Z Port 1 LPRT Entry 0",
"RawEntryHex": "0x34EF124500000000",
"RouteSet": {
"@odata.id": "/redfish/v1/Fabrics/GenZ/Switches/Switch1/Ports/1/LPRT/0/RouteSet"
},
"MinimumHopCount": 1,
"@odata.id": "/redfish/v1/Fabrics/GenZ/Switches/Switch1/Ports/1/LPRT/0"
}
6.108 RouteSetEntry 1.0.1
Version v1.0
Release 2019.4
6.108.1 Description
The RouteSetEntry schema contains the information about a route. It is part of a larger set that
contains possible routes for a particular route entry.
794 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.108.2 URIs
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/MSDT/{MSDTId}/RouteSet/
{RouteId}
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT/{LPRTId}/
RouteSet/{RouteId}
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT/{MPRTId}/
RouteSet/{RouteId}
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/SSDT/{SSDTId}/RouteSet/{RouteId}
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/LPRT/{LPRTId}/RouteSet/{RouteId}
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/MPRT/{MPRTId}/RouteSet/{RouteId}
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/MSDT/{MSDTId}/
RouteSet/{RouteId}
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT/
{LPRTId}/RouteSet/{RouteId}
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT/
{MPRTId}/RouteSet/{RouteId}
/redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/SSDT/{SSDTId}/RouteSet/
{RouteId}
6.108.3 Properties
Property Type Attributes Notes
EgressIdentifier integer read-write The egress interface identifier.
HopCount integer read-write The number of hops.
Valid boolean read-write An indication of whether the entry is valid.
VCAction integer read-write The Virtual Channel Action index.
6.108.4 Example response
{
"@odata.type": "#RouteSetEntry.v1_0_1.RouteSetEntry",
"Id": "0",
"Name": "RouteSet0",
"Description": "Gen-Z Port 1 LPRT Entry 0 Route 0",
"Valid": false,
"VCAction": 1,
"HopCount": 2,
Version 2023.1 Published 795
Redfish Resource and Schema Guide DSP2046
"EgressIdentifier": 0,
"@odata.id": "/redfish/v1/Fabrics/GenZ/Switches/Switch1/Ports/1/LPRT/0/RouteSet/0"
}
6.109 SecureBoot 1.1.0
Version v1.1 v1.0
Release 2020.1 2016.1
6.109.1 Description
The SecureBoot schema contains UEFI Secure Boot information and represents properties for
managing the UEFI Secure Boot functionality of a system.
6.109.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
SecureBoot
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SecureBoot
/redfish/v1/Systems/{ComputerSystemId}/SecureBoot
6.109.3 Properties
Property Type Attributes Notes
The UEFI Secure Boot state during the current boot cycle. For the
string read-only
SecureBootCurrentBoot possible property values, see SecureBootCurrentBoot in Property
(enum) (null)
details.
SecureBootDatabases A link to the collection of UEFI Secure Boot databases. Contains a link
object
(v1.1+) { to a resource.
Link to Collection of SecureBootDatabase. See the
@odata.id string read-only
SecureBootDatabase schema for details.
read-write
SecureBootEnable boolean An indication of whether UEFI Secure Boot is enabled.
(null)
796 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
string read-only The current UEFI Secure Boot Mode. For the possible property values,
SecureBootMode
(enum) (null) see SecureBootMode in Property details.
6.109.4 Actions
6.109.4.1 ResetKeys
Description
This action resets the UEFI Secure Boot keys.
Action URI
{Base URI of target resource}/Actions/SecureBoot.ResetKeys
Action parameters
Parameter Name Type Attributes Notes
string The type of reset or delete to perform on the UEFI Secure Boot databases.
ResetKeysType required
(enum) For the possible property values, see ResetKeysType in Property details.
Request Example
{
"ResetKeysType": "DeleteAllKeys"
}
6.109.5 Property details
6.109.5.1 ResetKeysType
The type of reset or delete to perform on the UEFI Secure Boot databases.
string Description
Delete the contents of all UEFI Secure Boot key databases, including the PK key database.
DeleteAllKeys
This puts the system in Setup Mode.
Version 2023.1 Published 797
Redfish Resource and Schema Guide DSP2046
string Description
Delete the contents of the PK UEFI Secure Boot database. This puts the system in Setup
DeletePK
Mode.
Reset the contents of all UEFI Secure Boot key databases, including the PK key database, to
ResetAllKeysToDefault
the default values.
6.109.5.2 SecureBootCurrentBoot
The UEFI Secure Boot state during the current boot cycle.
string Description
Disabled UEFI Secure Boot is currently disabled.
Enabled UEFI Secure Boot is currently enabled.
6.109.5.3 SecureBootMode
The current UEFI Secure Boot Mode.
string Description
AuditMode UEFI Secure Boot is currently in Audit Mode.
DeployedMode UEFI Secure Boot is currently in Deployed Mode.
SetupMode UEFI Secure Boot is currently in Setup Mode.
UserMode UEFI Secure Boot is currently in User Mode.
6.109.6 Example response
{
"@odata.type": "#SecureBoot.v1_1_0.SecureBoot",
"Id": "SecureBoot",
"Name": "UEFI Secure Boot",
"Actions": {
"#SecureBoot.ResetKeys": {
"target": "/redfish/v1/Systems/1/SecureBoot/Actions/SecureBoot.ResetKeys",
"[email protected]": [
"ResetAllKeysToDefault",
798 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"DeleteAllKeys",
"DeletePK"
]
}
},
"SecureBootEnable": false,
"SecureBootCurrentBoot": "Disabled",
"SecureBootMode": "UserMode",
"SecureBootDatabases": {
"@odata.id": "/redfish/v1/Systems/1/SecureBoot/SecureBootDatabases"
},
"@odata.id": "/redfish/v1/Systems/1/SecureBoot"
}
6.110 SecureBootDatabase 1.0.1
Version v1.0
Release 2020.1
6.110.1 Description
The SecureBootDatabase schema describes a UEFI Secure Boot database used to store certificates or
hashes.
6.110.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
SecureBoot/SecureBootDatabases/{DatabaseId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SecureBoot/
SecureBootDatabases/{DatabaseId}
/redfish/v1/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases/{DatabaseId}
6.110.3 Properties
Property Type Attributes Notes
A link to the collection of certificates contained in this UEFI Secure Boot
Certificates { object
database. Contains a link to a resource.
@odata.id string read-only Link to Collection of Certificate. See the Certificate schema for details.
Version 2023.1 Published 799
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
DatabaseId string read-only This property contains the name of the UEFI Secure Boot database.
A link to the collection of signatures contained in this UEFI Secure Boot
Signatures { object
database. Contains a link to a resource.
@odata.id string read-only Link to Collection of Signature. See the Signature schema for details.
6.110.4 Actions
6.110.4.1 ResetKeys
Description
This action is used to reset the UEFI Secure Boot keys of this database.
Action URI
{Base URI of target resource}/Actions/SecureBootDatabase.ResetKeys
Action parameters
Parameter Name Type Attributes Notes
string The type of reset or delete to perform on this UEFI Secure Boot database.
ResetKeysType required
(enum) For the possible property values, see ResetKeysType in Property details.
Request Example
{
"ResetKeysType": "ResetAllKeysToDefault"
}
800 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.110.5 Property details
6.110.5.1 ResetKeysType
The type of reset or delete to perform on this UEFI Secure Boot database.
string Description
DeleteAllKeys Delete the content of this UEFI Secure Boot key database.
ResetAllKeysToDefault Reset the content of this UEFI Secure Boot key database to the default values.
6.110.6 Example response
{
"@odata.type": "#SecureBootDatabase.v1_0_1.SecureBootDatabase",
"Id": "PK",
"Name": "PK - Platform Key",
"Description": "UEFI PK Secure Boot Database",
"DatabaseId": "PK",
"Certificates": {
"@odata.id": "/redfish/v1/Systems/1/SecureBoot/SecureBootDatabases/PK/Certificates/"
},
"Actions": {
"#SecureBootDatabase.ResetKeys": {
"target": "/redfish/v1/Systems/1/SecureBoot/SecureBootDatabases/PK/Actions/SecureBootDatabase.ResetKeys
"[email protected]": [
"ResetAllKeysToDefault",
"DeleteAllKeys"
]
}
},
"@odata.id": "/redfish/v1/Systems/1/SecureBoot/SecureBootDatabases/PK"
}
6.111 SecurityPolicy 1.0.0
Version v1.0
Release 2022.2
Version 2023.1 Published 801
Redfish Resource and Schema Guide DSP2046
6.111.1 Description
The SecurityPolicy resource provides a central point to configure the security policy of a manager.
6.111.2 URIs
/redfish/v1/Managers/{ManagerId}/SecurityPolicy
6.111.3 Properties
Property Type Attributes Notes
OverrideParentManager boolean read-write Override the security policy of the parent manager.
SPDM { object The SPDM policy.
The SPDM policy settings that are allowed, such as the allowable
Allowed { object
(null) SPDM versions and algorithms.
Algorithms { object The SPDM algorithms.
(null)
array
AEAD [ ] (string, read-write The AEAD algorithms.
null)
array
BaseAsym [ ] (string, read-write The asymmetric signature algorithms.
null)
array
BaseHash [ ] (string, read-write The hash algorithms.
null)
array
Versions [ ] (string, read-write The SPDM versions.
null)
read-write
AllowExtendedAlgorithms boolean An indication of whether SPDM extended algorithms are allowed.
(null)
The SPDM policy settings that are prohibited, such as the
Denied { object
(null) prohibited SPDM versions and algorithms.
802 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Algorithms { object The SPDM algorithms.
(null)
array
AEAD [ ] (string, read-write The AEAD algorithms.
null)
array
BaseAsym [ ] (string, read-write The asymmetric signature algorithms.
null)
array
BaseHash [ ] (string, read-write The hash algorithms.
null)
array
Versions [ ] (string, read-write The SPDM versions.
null)
read-write An indication of whether SPDM communication with devices is
Enabled boolean
(null) enabled.
The revoked SPDM device certificates. Contains a link to a
RevokedCertificates { object
(null) resource.
Link to Collection of Certificate. See the Certificate schema for
@odata.id string read-only
details.
read-write An indication of whether SPDM secure sessions with devices is
SecureSessionEnabled boolean
(null) enabled.
The trusted SPDM device certificates. Contains a link to a
TrustedCertificates { object
(null) resource.
Link to Collection of Certificate. See the Certificate schema for
@odata.id string read-only
details.
read-write An indication of whether the manager will verify the certificate
VerifyCertificate boolean
(null) of the SPDM endpoint.
Version 2023.1 Published 803
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
TLS { object The TLS policy.
Client { object The TLS policy.
The TLS policy settings that are allowed, such as the allowable
Allowed {} object TLS versions and algorithms. For more information about this
(null)
property, see TLSParameterSet in Property Details.
The TLS policy settings that are prohibited, such as the
Denied {} object prohibited TLS versions and algorithms. For more information
(null)
about this property, see TLSParameterSet in Property Details.
The revoked TLS server certificates. Contains a link to a
RevokedCertificates { object
(null) resource.
Link to Collection of Certificate. See the Certificate schema for
@odata.id string read-only
details.
TrustedCertificates { object The trusted TLS server certificates. Contains a link to a resource.
(null)
Link to Collection of Certificate. See the Certificate schema for
@odata.id string read-only
details.
read-write An indication of whether the manager will verify the certificate
VerifyCertificate boolean
(null) of the remote TLS endpoint.
Server { object The TLS policy.
The TLS policy settings that are allowed, such as the allowable
Allowed {} object TLS versions and algorithms. For more information about this
(null)
property, see TLSParameterSet in Property Details.
The TLS policy settings that are prohibited, such as the
Denied {} object prohibited TLS versions and algorithms. For more information
(null)
about this property, see TLSParameterSet in Property Details.
The revoked TLS server certificates. Contains a link to a
RevokedCertificates { object
(null) resource.
Link to Collection of Certificate. See the Certificate schema for
@odata.id string read-only
details.
804 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
TrustedCertificates { object The trusted TLS server certificates. Contains a link to a resource.
(null)
Link to Collection of Certificate. See the Certificate schema for
@odata.id string read-only
details.
read-write An indication of whether the manager will verify the certificate
VerifyCertificate boolean
(null) of the remote TLS endpoint.
6.111.4 Property details
6.111.4.1 TLSParameterSet
The TLS policy settings.
The TLS
Algorithms { object
(null) algorithms.
array The TLS
read-
CipherSuites [ ] (string, cipher
write
null) suites.
array The TLS
SignatureAlgorithms read-
(string, signature
[] write
null) algorithms.
array
read- The TLS
Versions [ ] (string,
write versions.
null)
6.111.5 Example response
Version 2023.1 Published 805
Redfish Resource and Schema Guide DSP2046
"@odata.type": "#SecurityPolicy.v1_0_0.SecurityPolicy",
"Id": "ManagerGlobalSecurityPolicy",
"Status": {
"Health": "OK",
"State": "Enabled"
},
"OverrideParentManager": true,
"SPDM": {
"Enabled": true,
"SecureSessionEnabled": true,
"VerifyCertificate": true,
"TrustedCertificates": {
"@odata.id": "/redfish/v1/Managers/BMC/SecurityPolicy/SPDM/TrustedCertificates"
},
"RevokedCertificates": {
"@odata.id": "/redfish/v1/Managers/BMC/SecurityPolicy/SPDM/RevokedCertificates"
},
"Allowed": {
"Versions": [
"ALL"
],
"Algorithms": {
"AEAD": [
"AES-GCM-256",
"AES-GCM-128"
],
"BaseAsym": [
"TPM_ALG_RSASSA_2048",
"TPM_ALG_ECDSA_ECC_NIST_P384",
"TPM_ALG_SM2_ECC_SM2_P256"
],
"BaseHash": [
"TPM_ALG_SHA_512",
"TPM_ALG_SHA3_512"
]
}
},
"Denied": {
"Versions": [
"NONE"
],
"Algorithms": {
"AEAD": [],
"BaseAsym": [
"EdDSA ed25519"
],
"BaseHash": [
"TPM_ALG_SHA_256"
]
}
806 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
},
"AllowExtendedAlgorithms": false
},
"TLS": {
"Client": {
"VerifyCertificate": true,
"TrustedCertificates": {
"@odata.id": "/redfish/v1/Managers/BMC/SecurityPolicy/TLS/Server/TrustedCertificates"
},
"RevokedCertificates": {
"@odata.id": "/redfish/v1/Managers/BMC/SecurityPolicy/TLS/Server/RevokedCertificates"
},
"Allowed": {
"Versions": [
"1.2",
"1.3"
],
"Algorithms": {
"CipherSuites": [
"TLS_AES_128_GCM_SHA256",
"TLS_AES_128_GCM_SHA384"
],
"SignatureAlgorithms": []
}
},
"Denied": {
"Versions": [
"1.1"
],
"Algorithms": {
"CipherSuites": [],
"SignatureAlgorithms": [
"rsa_pkcs1_sha1",
"ecdsa_sha1"
]
}
}
},
"Server": {
"VerifyCertificate": false,
"TrustedCertificates": {
"@odata.id": "/redfish/v1/Managers/BMC/SecurityPolicy/TLS/Client/TrustedCertificates"
},
"RevokedCertificates": {
"@odata.id": "/redfish/v1/Managers/BMC/SecurityPolicy/TLS/Client/RevokedCertificates"
},
"Allowed": {
"Versions": [
"1.3"
],
Version 2023.1 Published 807
Redfish Resource and Schema Guide DSP2046
"Algorithms": {
"CipherSuites": [
"TLS_AES_128_GCM_SHA256",
"TLS_AES_128_GCM_SHA384"
],
"SignatureAlgorithms": []
}
},
"Denied": {
"Versions": [
"1.1",
"1.2"
],
"Algorithms": {
"CipherSuites": [],
"SignatureAlgorithms": [
"rsa_pkcs1_sha1",
"ecdsa_sha1"
]
}
}
}
},
"@odata.id": "/redfish/v1/Managers/BMC/SecurityPolicy"
}
6.112 Sensor 1.7.0
Version v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2023.1 2022.2 2021.4 2021.2 2021.1 2020.4 2019.4 2018.3
6.112.1 Description
The Sensor schema describes a sensor and its properties.
6.112.2 URIs
/redfish/v1/Chassis/{ChassisId}/Sensors/{SensorId}
/redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}/Sensors/{SensorId}
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/Sensors/{SensorId}
/redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Sensors/{SensorId}
808 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
/redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}/Sensors/{SensorId}
/redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Sensors/{SensorId}
6.112.3 Properties
Property Type Attributes Notes
number read-only The estimated percent error of measured versus
Accuracy
(%) (null) actual values.
The adjusted maximum allowable operating value for
read-only
AdjustedMaxAllowableOperatingValue number this equipment based on the environmental
(null)
conditions.
The adjusted minimum allowable operating value for
read-only
AdjustedMinAllowableOperatingValue number this equipment based on the environmental
(null)
conditions.
number read-only
ApparentkVAh (v1.5+) Apparent energy (kVAh).
(kV.A.h) (null)
number read-only The product of voltage and current for an AC circuit,
ApparentVA
(V.A) (null) in volt-ampere units.
read-only
AverageReading (v1.4+) number The average sensor value.
(null)
string read-write The interval over which the average sensor value is
AveragingInterval (v1.4+)
(duration) (null) calculated.
Indicates that enough readings were collected to
read-only
AveragingIntervalAchieved (v1.4+) boolean calculate the average sensor reading over the
(null)
averaging interval time.
read-write
Calibration (v1.4+) number The calibration offset applied to the Reading.
(null)
string read-write The date and time that the sensor was last
CalibrationTime (v1.4+)
(date-time) (null) calibrated.
read-only
CrestFactor (v1.1+) number The crest factor for this sensor.
(null)
The combination of current-carrying conductors. For
string read-only
ElectricalContext the possible property values, see ElectricalContext in
(enum) (null)
Property details.
The implementation of the sensor. For the possible
string read-only
Implementation (v1.1+) property values, see Implementation in Property
(enum) (null)
details.
Version 2023.1 Published 809
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
LifetimeReading (v1.1+) number The total accumulation value for this sensor.
(null)
The links to other resources that are related to this
Links (v1.3+) { object
resource.
An array of links to the controls that can affect this
AssociatedControls (v1.4+) [ { array
sensor.
Link to a Control resource. See the Links section and
@odata.id string read-only
the Control schema for details.
}]
See the Oem object definition in the Common
Oem {} object
properties section.
The power load utilization for this sensor. Deprecated
in v1.1 and later. This property has been deprecated
number read-only
LoadPercent (deprecated v1.1) in favor of using a sensor instance with a
(%) (null)
ReadingType of Percent to show utilization values
when needed.
The location information for this sensor. For property
Location {} object
details, see Location.
read-only
LowestReading (v1.4+) number The lowest sensor value.
(null)
string read-only
LowestReadingTime (v1.4+) The time when the lowest sensor value occurred.
(date-time) (null)
read-only The maximum allowable operating value for this
MaxAllowableOperatingValue number
(null) equipment.
read-only The minimum allowable operating value for this
MinAllowableOperatingValue number
(null) equipment.
read-only
PeakReading number The peak sensor value.
(null)
string read-only
PeakReadingTime The time when the peak sensor value occurred.
(date-time) (null)
read-only The phase angle (degrees) between the current and
PhaseAngleDegrees (v1.5+) number
(null) voltage waveforms.
810 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The area or device to which this sensor
string read-only
PhysicalContext measurement applies. For the possible property
(enum) (null)
values, see PhysicalContext in Property details.
The usage or location within a device to which this
string read-only sensor measurement applies. For the possible
PhysicalSubContext
(enum) (null) property values, see PhysicalSubContext in Property
details.
read-only
PowerFactor number The power factor for this sensor.
(null)
read-only
Precision number The number of significant digits in the reading.
(null)
number read-only
ReactivekVARh (v1.5+) Reactive energy (kVARh).
(kV.A.h) (null)
The square root of the difference term of squared
number read-only
ReactiveVAR apparent VA and squared power (Reading) for a
(V.A) (null)
circuit, in VAR units.
read-only
Reading number The sensor value.
(null)
The basis for the reading of this sensor. For the
string read-only
ReadingBasis (v1.7+) possible property values, see ReadingBasis in
(enum) (null)
Property details.
read-only
ReadingRangeMax number The maximum possible value for this sensor.
(null)
read-only
ReadingRangeMin number The minimum possible value for this sensor.
(null)
string read-only The date and time that the reading was acquired
ReadingTime (v1.1+)
(date-time) (null) from the sensor.
string read-only The type of sensor. For the possible property values,
ReadingType
(enum) (null) see ReadingType in Property details.
read-only
ReadingUnits string The units of the reading and thresholds.
(null)
An array of links to resources or objects that this
RelatedItem (v1.2+) [ { array
sensor services.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
Version 2023.1 Published 811
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The time interval between readings of the physical
sensor. Deprecated in v1.1 and later. This property
read-only
SensingFrequency (deprecated v1.1) number has been deprecated in favor of the SensingInterval
(null)
property, which uses the duration time format for
interoperability.
string read-only
SensingInterval (v1.1+) The time interval between readings of the sensor.
(duration) (null)
The group of sensors that provide readings for this
SensorGroup (v1.4+) {} object
sensor. For property details, see RedundantGroup.
string read-only The date and time when the time-based properties
SensorResetTime
(date-time) (null) were last reset.
number read-only
SpeedRPM (v1.2+) The rotational speed.
({rev}/min) (null)
The status and health of the resource and its
Status {} object subordinate or dependent resources. For property
details, see Status.
read-only
THDPercent (v1.1+) number The total harmonic distortion (THD).
(null)
Thresholds { object The set of thresholds defined for this sensor.
The value at which the reading is below normal
LowerCaution {} object range. For more information about this property, see
Threshold in Property Details.
A user-defined value at which the reading is
considered below normal range. For more
LowerCautionUser (v1.2+) {} object
information about this property, see Threshold in
Property Details.
The value at which the reading is below normal
LowerCritical {} object range but not yet fatal. For more information about
this property, see Threshold in Property Details.
A user-defined value at which the reading is
considered below normal range but not yet fatal. For
LowerCriticalUser (v1.2+) {} object
more information about this property, see Threshold
in Property Details.
The value at which the reading is below normal
LowerFatal {} object range and fatal. For more information about this
property, see Threshold in Property Details.
812 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The value at which the reading is above normal
UpperCaution {} object range. For more information about this property, see
Threshold in Property Details.
A user-defined value at which the reading is
considered above normal range. For more
UpperCautionUser (v1.2+) {} object
information about this property, see Threshold in
Property Details.
The value at which the reading is above normal
UpperCritical {} object range but not yet fatal. For more information about
this property, see Threshold in Property Details.
A user-defined value at which the reading is
considered above normal range but not yet fatal. For
UpperCriticalUser (v1.2+) {} object
more information about this property, see Threshold
in Property Details.
The value at which the reading is above normal
UpperFatal {} object range and fatal. For more information about this
property, see Threshold in Property Details.
string read-only The voltage type for this sensor. For the possible
VoltageType
(enum) (null) property values, see VoltageType in Property details.
6.112.4 Actions
6.112.4.1 ResetMetrics
Description
Resets metrics related to this sensor.
Action URI
{Base URI of target resource}/Actions/Sensor.ResetMetrics
Action parameters
This action takes no parameters.
6.112.4.2 ResetToDefaults (v1.6+)
Description
Version 2023.1 Published 813
Redfish Resource and Schema Guide DSP2046
The action resets the values of writable properties to factory defaults.
Action URI
{Base URI of target resource}/Actions/Sensor.ResetToDefaults
Action parameters
This action takes no parameters.
6.112.5 Property details
6.112.5.1 Activation
The direction of crossing that activates this threshold.
string Description
Decreasing Value decreases below the threshold.
Disabled (v1.7+) The threshold is disabled.
Either Value crosses the threshold in either direction.
Increasing Value increases above the threshold.
6.112.5.2 ElectricalContext
The combination of current-carrying conductors.
string Description
Line1 The circuits that share the L1 current-carrying conductor.
Line1ToLine2 The circuit formed by L1 and L2 current-carrying conductors.
Line1ToNeutral The circuit formed by L1 and neutral current-carrying conductors.
Line1ToNeutralAndL1L2 The circuit formed by L1, L2, and neutral current-carrying conductors.
Line2 The circuits that share the L2 current-carrying conductor.
Line2ToLine3 The circuit formed by L2 and L3 current-carrying conductors.
Line2ToNeutral The circuit formed by L2 and neutral current-carrying conductors.
814 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Line2ToNeutralAndL1L2 The circuit formed by L1, L2, and Neutral current-carrying conductors.
Line2ToNeutralAndL2L3 The circuits formed by L2, L3, and neutral current-carrying conductors.
Line3 The circuits that share the L3 current-carrying conductor.
Line3ToLine1 The circuit formed by L3 and L1 current-carrying conductors.
Line3ToNeutral The circuit formed by L3 and neutral current-carrying conductors.
Line3ToNeutralAndL3L1 The circuit formed by L3, L1, and neutral current-carrying conductors.
LineToLine The circuit formed by two current-carrying conductors.
LineToNeutral The circuit formed by a line and neutral current-carrying conductor.
Neutral The grounded current-carrying return circuit of current-carrying conductors.
Total The circuit formed by all current-carrying conductors.
6.112.5.3 Implementation
The implementation of the sensor.
string Description
PhysicalSensor The reading is acquired from a physical sensor.
Reported The reading is obtained from software or a device.
The reading is obtained by applying a calculation on one or more properties or multiple
Synthesized
sensors. The calculation is not provided.
6.112.5.4 PhysicalContext
The area or device to which this sensor measurement applies.
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
Version 2023.1 Published 815
Redfish Resource and Schema Guide DSP2046
string Description
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
GPU A graphics processor (GPU).
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
816 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
StorageBay Within a storage bay.
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
6.112.5.5 PhysicalSubContext
The usage or location within a device to which this sensor measurement applies.
string Description
Input The input.
Output The output.
Version 2023.1 Published 817
Redfish Resource and Schema Guide DSP2046
6.112.5.6 ReadingBasis
The basis for the reading of this sensor.
string Description
Delta A reading that reports the difference between two measurements.
Headroom A reading that decreases as it approaches a defined reference point.
Zero A zero-based reading.
6.112.5.7 ReadingType
The type of sensor.
string Description
AbsoluteHumidity (v1.5+) Absolute humidity (g/cu m).
Air flow (cu ft/min). Deprecated in v1.7 and later. This value has been deprecated in favor of
AirFlow (deprecated v1.7)
AirFlowCMM for consistent use of SI units.
AirFlowCMM (v1.7+) Air flow (m^3/min).
Altitude Altitude (m).
Barometric Barometric pressure (mm).
ChargeAh (v1.4+) Charge (Ah).
Current Current (A).
EnergyJoules Energy (J).
EnergykWh Energy (kWh).
EnergyWh (v1.4+) Energy (Wh).
Frequency Frequency (Hz).
Heat (v1.7+) Heat (kW).
Humidity Relative humidity (percent).
Liquid flow (L/s). Deprecated in v1.7 and later. This value has been deprecated in favor of
LiquidFlow (deprecated
LiquidFlowLPM for consistency of units typically expected or reported by Sensor and Control
v1.7)
resources.
818 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
LiquidFlowLPM (v1.7+) Liquid flow (L/min).
LiquidLevel Liquid level (cm).
Percent (v1.1+) Percent (%).
Power Power (W).
Pressure (Pa). Deprecated in v1.7 and later. This value has been deprecated in favor of
Pressure (deprecated v1.7)
PressurePa or PressurekPa for consistency of units between Sensor and Control resources.
PressurekPa (v1.5+) Pressure (kPa).
PressurePa (v1.7+) Pressure (Pa).
Rotational Rotational (RPM).
Temperature Temperature (C).
Voltage Voltage (VAC or VDC).
6.112.5.8 Threshold
The threshold definition for a sensor.
read-
string The direction of crossing that activates this threshold. For the possible property
Activation write
(enum) values, see Activation in Property details.
(null)
read-
string The duration the sensor value must violate the threshold before the threshold is
DwellTime write
(duration) activated.
(null)
read-
HysteresisDuration string The duration the sensor value must not violate the threshold before the
write
(v1.7+) (duration) threshold is deactivated.
(null)
read-
HysteresisReading
number write The reading offset from the threshold value required to clear the threshold.
(v1.7+)
(null)
read-
Reading number write The threshold value.
(null)
Version 2023.1 Published 819
Redfish Resource and Schema Guide DSP2046
6.112.5.9 VoltageType
The voltage type for this sensor.
string Description
AC Alternating current.
DC Direct current.
6.112.6 Example response
{
"@odata.type": "#Sensor.v1_7_0.Sensor",
"Id": "CabinetTemp",
"Name": "Rack Temperature",
"ReadingType": "Temperature",
"ReadingTime": "2019-12-25T04:14:33+06:00",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Reading": 31.6,
"ReadingUnits": "C",
"ReadingRangeMin": 0,
"ReadingRangeMax": 70,
"Accuracy": 0.25,
"Precision": 1,
"SensingInterval": "PT3S",
"PhysicalContext": "Chassis",
"Thresholds": {
"UpperCritical": {
"Reading": 40,
"Activation": "Increasing"
},
"UpperCaution": {
"Reading": 35,
"Activation": "Increasing"
},
"LowerCaution": {
"Reading": 10,
"Activation": "Increasing"
}
},
"@odata.id": "/redfish/v1/Chassis/1/Sensors/CabinetTemp"
}
820 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.113 SerialInterface 1.1.8
Version v1.1 v1.0
Release 2017.1 1.0
6.113.1 Description
The SerialInterface schema describes an asynchronous serial interface, such as an RS-232 interface,
available to a system or device.
6.113.2 URIs
/redfish/v1/Managers/{ManagerId}/SerialInterfaces/{SerialInterfaceId}
6.113.3 Properties
Property Type Attributes Notes
The receive and transmit rate of data flow, typically in bits per second (bit/
string
BitRate read-write s), over the serial connection. For the possible property values, see BitRate
(enum)
in Property details.
string The type of connector used for this interface. For the possible property
ConnectorType read-only
(enum) values, see ConnectorType in Property details.
string The number of data bits that follow the start bit over the serial connection.
DataBits read-write
(enum) For the possible property values, see DataBits in Property details.
string The type of flow control, if any, that is imposed on the serial connection.
FlowControl read-write
(enum) For the possible property values, see FlowControl in Property details.
read-write
InterfaceEnabled boolean An indication of whether this interface is enabled.
(null)
The type of parity used by the sender and receiver to detect errors over the
string
Parity read-write serial connection. For the possible property values, see Parity in Property
(enum)
details.
string read-only The physical pinout configuration for a serial connector. For the possible
PinOut
(enum) (null) property values, see PinOut in Property details.
string The type of signal used for the communication connection. For the possible
SignalType read-only
(enum) property values, see SignalType in Property details.
Version 2023.1 Published 821
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
string The period of time before the next start bit is transmitted. For the possible
StopBits read-write
(enum) property values, see StopBits in Property details.
6.113.4 Property details
6.113.4.1 BitRate
The receive and transmit rate of data flow, typically in bits per second (bit/s), over the serial
connection.
string Description
115200 A bit rate of 115200 bit/s.
1200 A bit rate of 1200 bit/s.
19200 A bit rate of 19200 bit/s.
230400 A bit rate of 230400 bit/s.
2400 A bit rate of 2400 bit/s.
38400 A bit rate of 38400 bit/s.
4800 A bit rate of 4800 bit/s.
57600 A bit rate of 57600 bit/s.
9600 A bit rate of 9600 bit/s.
6.113.4.2 ConnectorType
The type of connector used for this interface.
string Description
DB25 Female A DB25 Female connector.
DB25 Male A DB25 Male connector.
DB9 Female A DB9 Female connector.
DB9 Male A DB9 Male connector.
822 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
mUSB A mUSB connector.
RJ11 An RJ11 connector.
RJ45 An RJ45 connector.
USB A USB connector.
uUSB A uUSB connector.
6.113.4.3 DataBits
The number of data bits that follow the start bit over the serial connection.
string Description
5 Five bits of data following the start bit.
6 Six bits of data following the start bit.
7 Seven bits of data following the start bit.
8 Eight bits of data following the start bit.
6.113.4.4 FlowControl
The type of flow control, if any, that is imposed on the serial connection.
string Description
Hardware Out-of-band flow control imposed.
None No flow control imposed.
Software XON/XOFF in-band flow control imposed.
6.113.4.5 Parity
The type of parity used by the sender and receiver to detect errors over the serial connection.
Version 2023.1 Published 823
Redfish Resource and Schema Guide DSP2046
string Description
Even An even parity bit.
Mark A mark parity bit.
None No parity bit.
Odd An odd parity bit.
Space A space parity bit.
6.113.4.6 PinOut
The physical pinout configuration for a serial connector.
string Description
Cisco The Cisco pinout configuration.
Cyclades The Cyclades pinout configuration.
Digi The Digi pinout configuration.
6.113.4.7 SignalType
The type of signal used for the communication connection.
string Description
Rs232 The serial interface follows RS232.
Rs485 The serial interface follows RS485.
6.113.4.8 StopBits
The period of time before the next start bit is transmitted.
string Description
1 One stop bit following the data bits.
2 Two stop bits following the data bits.
824 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.113.5 Example response
{
"@odata.type": "#SerialInterface.v1_1_8.SerialInterface",
"Id": "TTY0",
"Name": "Manager Serial Interface 1",
"Description": "Management for Serial Interface",
"InterfaceEnabled": true,
"SignalType": "Rs232",
"BitRate": "115200",
"Parity": "None",
"DataBits": "8",
"StopBits": "1",
"FlowControl": "None",
"ConnectorType": "RJ45",
"PinOut": "Cyclades",
"@odata.id": "/redfish/v1/Managers/BMC/SerialInterfaces/TTY0"
}
6.114 ServiceConditions 1.0.0
Version v1.0
Release 2021.4
6.114.1 Description
The ServiceConditions schema contains definitions for reporting the conditions present in the service
that require attention.
6.114.2 URIs
/redfish/v1/ServiceConditions
6.114.3 Properties
Property Type Attributes Notes
Conditions [ array Conditions reported by this service that require attention. For property details,
{}] (object) (null) see Condition.
Version 2023.1 Published 825
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
string The health roll-up for all resources. For the possible property values, see
HealthRollup read-only
(enum) HealthRollup in Property details.
6.114.4 Property details
6.114.4.1 HealthRollup
The health roll-up for all resources.
string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.
6.114.5 Example response
{
"@odata.type": "#ServiceConditions.v1_0_0.ServiceConditions",
"Name": "Redfish Service Conditions",
"HealthRollup": "Warning",
"Conditions": [
{
"MessageId": "ThermalEvents.1.0.OverTemperature",
"Timestamp": "2020-11-08T12:25:00-05:00 ",
"Message": "Temperature exceeds rated limit in power supply `A`.",
"Severity": "Warning",
"MessageArgs": [
"A"
],
"OriginOfCondition": {
"@odata.id": "/redfish/v1/Chassis/1/Power"
},
"LogEntry": {
"@odata.id": "/redfish/v1/Managers/1/LogServices/Log1/Entries/1"
}
},
{
"MessageId": "Base.1.9.ConditionInRelatedResource",
"Message": "One or more conditions exist in a related resource. See the OriginOfCondition property.",
"Severity": "Warning",
826 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"OriginOfCondition": {
"@odata.id": "/redfish/v1/Systems/cpu-memory-example"
}
}
],
"@odata.id": "/redfish/v1/ServiceConditions"
}
6.115 ServiceRoot 1.16.0
Version v1.16 v1.15 v1.14 v1.13 v1.12 v1.11 v1.10 v1.9 v1.8 v1.7 v1.6 ...
Release 2023.1 2022.3 2022.1 2021.4 2021.3 2021.2 2021.1 2020.3 2020.2 2020.1 2019.4 ...
6.115.1 Description
The ServiceRoot schema describes the root of the Redfish service, located at the '/redfish/v1' URI. All
other resources accessible through the Redfish interface on this device are linked directly or indirectly
from the service root.
6.115.2 URIs
/redfish/v1
/redfish/v1/
6.115.3 Properties
Property Type Attributes Notes
The link to the account service. See the AccountService schema
AccountService { object
for details on this property.
Link to a AccountService resource. See the Links section and the
@odata.id string read-only
AccountService schema for details.
The link to the aggregation service. See the AggregationService
AggregationService (v1.8+) { object
schema for details on this property.
Version 2023.1 Published 827
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to a AggregationService resource. See the Links section and
@odata.id string read-only
the AggregationService schema for details.
Cables (v1.11+) { object The link to a collection of cables. Contains a link to a resource.
@odata.id string read-only Link to Collection of Cable. See the Cable schema for details.
The link to the certificate service. See the CertificateService
CertificateService (v1.5+) { object
schema for details on this property.
Link to a CertificateService resource. See the Links section and
@odata.id string read-only
the CertificateService schema for details.
Chassis { object The link to a collection of chassis. Contains a link to a resource.
@odata.id string read-only Link to Collection of Chassis. See the Chassis schema for details.
ComponentIntegrity (v1.13+) The link to a collection of component integrity information.
object
{ Contains a link to a resource.
Link to Collection of ComponentIntegrity. See the
@odata.id string read-only
ComponentIntegrity schema for details.
The link to the composition service. See the CompositionService
CompositionService (v1.2+) { object
schema for details on this property.
Link to a CompositionService resource. See the Links section and
@odata.id string read-only
the CompositionService schema for details.
The link to the event service. See the EventService schema for
EventService { object
details on this property.
Link to a EventService resource. See the Links section and the
@odata.id string read-only
EventService schema for details.
Fabrics (v1.1+) { object The link to a collection of fabrics. Contains a link to a resource.
@odata.id string read-only Link to Collection of Fabric. See the Fabric schema for details.
828 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Facilities (v1.6+) { object The link to a collection of facilities. Contains a link to a resource.
@odata.id string read-only Link to Collection of Facility. See the Facility schema for details.
The link to the job service. See the JobService schema for details
JobService (v1.4+) { object
on this property.
Link to a JobService resource. See the Links section and the
@odata.id string read-only
JobService schema for details.
The link to a collection of JSON Schema files. Contains a link to a
JsonSchemas { object
resource.
Link to Collection of JsonSchemaFile. See the JsonSchemaFile
@odata.id string read-only
schema for details.
The link to the key service. See the KeyService schema for
KeyService (v1.11+) { object
details on this property.
Link to a KeyService resource. See the Links section and the
@odata.id string read-only
KeyService schema for details.
The link to the license service. See the LicenseService schema
LicenseService (v1.12+) { object
for details on this property.
Link to a LicenseService resource. See the Links section and the
@odata.id string read-only
LicenseService schema for details.
Links { object required The links to other resources that are related to this resource.
ManagerProvidingService The link to the manager that is providing this Redfish service.
object
(v1.15+) { See the Manager schema for details on this property.
Link to a Manager resource. See the Links section and the
@odata.id string read-only
Manager schema for details.
Oem {} object See the Oem object definition in the Common properties section.
Version 2023.1 Published 829
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Sessions { object required The link to a collection of sessions. Contains a link to a resource.
@odata.id string read-only Link to Collection of Session. See the Session schema for details.
The link to a collection of managers. Contains a link to a
Managers { object
resource.
Link to Collection of Manager. See the Manager schema for
@odata.id string read-only
details.
NVMeDomains (v1.10+) {} object The link to a collection of NVMe domains.
The link to a set of power equipment. See the PowerEquipment
PowerEquipment (v1.6+) { object
schema for details on this property.
Link to a PowerEquipment resource. See the Links section and
@odata.id string read-only
the PowerEquipment schema for details.
read-only
Product (v1.3+) string The product associated with this Redfish service.
(null)
ProtocolFeaturesSupported The information about protocol features that the service
object
(v1.3+) { supports.
The information about deep operations that the service
DeepOperations (v1.7+) { object
supports.
An indication of whether the service supports the deep PATCH
DeepPATCH (v1.7+) boolean read-only
operation.
An indication of whether the service supports the deep POST
DeepPOST (v1.7+) boolean read-only
operation.
MaxLevels (v1.7+) integer read-only The maximum levels of resources allowed in deep operations.
An indication of whether the service supports the excerpt query
ExcerptQuery (v1.4+) boolean read-only
parameter.
ExpandQuery (v1.3+) { object The information about the use of $expand in the service.
830 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
An indication of whether the service supports the asterisk ( * )
ExpandAll (v1.3+) boolean read-only
option of the $expand query parameter.
An indication of whether the service supports the $levels option
Levels (v1.3+) boolean read-only
of the $expand query parameter.
An indication of whether this service supports the tilde ( ~ )
Links (v1.3+) boolean read-only
option of the $expand query parameter.
The maximum $levels option value in the $expand query
MaxLevels (v1.3+) integer read-only
parameter.
An indication of whether the service supports the period ( . )
NoLinks (v1.3+) boolean read-only
option of the $expand query parameter.
An indication of whether the service supports the $filter query
FilterQuery (v1.3+) boolean read-only
parameter.
MultipleHTTPRequests An indication of whether the service supports multiple
boolean read-only
(v1.14+) outstanding HTTP requests.
OnlyMemberQuery An indication of whether the service supports the only query
boolean read-only
(v1.4+) parameter.
An indication of whether the service supports the $select query
SelectQuery (v1.3+) boolean read-only
parameter.
RedfishVersion string read-only The version of the Redfish service.
The link to a collection of registered clients. Contains a link to a
RegisteredClients (v1.13+) { object
resource.
Link to Collection of RegisteredClient. See the RegisteredClient
@odata.id string read-only
schema for details.
The link to a collection of registries. Contains a link to a
Registries { object
resource.
Link to Collection of MessageRegistryFile. See the
@odata.id string read-only
MessageRegistryFile schema for details.
Version 2023.1 Published 831
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The link to a collection of resource blocks. This collection is
intended for implementations that do not contain a composition
ResourceBlocks (v1.5+) { object
service but that expose resources to an orchestrator that
implements a composition service. Contains a link to a resource.
Link to Collection of ResourceBlock. See the ResourceBlock
@odata.id string read-only
schema for details.
The link to the service conditions. See the ServiceConditions
ServiceConditions (v1.13+) { object
schema for details on this property.
Link to a ServiceConditions resource. See the Links section and
@odata.id string read-only
the ServiceConditions schema for details.
ServiceIdentification
string read-only The vendor or user-provided product and service identifier.
(v1.14+)
The link to the sessions service. See the SessionService schema
SessionService { object
for details on this property.
Link to a SessionService resource. See the Links section and the
@odata.id string read-only
SessionService schema for details.
The link to a collection of storage subsystems. Contains a link to
Storage (v1.9+) { object
a resource.
@odata.id string read-only Link to Collection of Storage. See the Storage schema for details.
StorageServices (v1.1+) {} object The link to a collection of storage services.
StorageSystems (v1.1+) {} object The link to a collection of storage systems.
Systems { object The link to a collection of systems. Contains a link to a resource.
Link to Collection of ComputerSystem. See the ComputerSystem
@odata.id string read-only
schema for details.
The link to the task service. See the TaskService schema for
Tasks { object
details on this property.
832 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to a TaskService resource. See the Links section and the
@odata.id string read-only
TaskService schema for details.
The link to the telemetry service. See the TelemetryService
TelemetryService (v1.4+) { object
schema for details on this property.
Link to a TelemetryService resource. See the Links section and
@odata.id string read-only
the TelemetryService schema for details.
ThermalEquipment (v1.16+) The link to a set of cooling equipment. See the
object
{ ThermalEquipment schema for details on this property.
Link to a ThermalEquipment resource. See the Links section and
@odata.id string read-only
the ThermalEquipment schema for details.
The link to the update service. See the UpdateService schema
UpdateService (v1.1+) { object
for details on this property.
Link to a UpdateService resource. See the Links section and the
@odata.id string read-only
UpdateService schema for details.
Unique identifier for a service instance. When SSDP is used, this
string read-only
UUID value contains the same UUID returned in an HTTP 200 OK
(uuid) (null)
response from an SSDP M-SEARCH request during discovery.
read-only
Vendor (v1.5+) string The vendor or manufacturer associated with this Redfish service.
(null)
6.115.4 Property details
6.115.4.1 idRef
string
@odata.id read-only The unique identifier for a resource.
(URI)
Version 2023.1 Published 833
Redfish Resource and Schema Guide DSP2046
6.115.5 Example response
{
"@odata.type": "#ServiceRoot.v1_16_0.ServiceRoot",
"Id": "RootService",
"Name": "Root Service",
"RedfishVersion": "1.15.0",
"UUID": "92384634-2938-2342-8820-489239905423",
"Product": "UR99 1U Server",
"ProtocolFeaturesSupported": {
"ExpandQuery": {
"ExpandAll": true,
"Levels": true,
"MaxLevels": 6,
"Links": true,
"NoLinks": true
},
"SelectQuery": false,
"FilterQuery": false,
"OnlyMemberQuery": true,
"ExcerptQuery": true,
"MultipleHTTPRequests": true
},
"ServiceConditions": {
"@odata.id": "/redfish/v1/ServiceConditions"
},
"Systems": {
"@odata.id": "/redfish/v1/Systems"
},
"Chassis": {
"@odata.id": "/redfish/v1/Chassis"
},
"Managers": {
"@odata.id": "/redfish/v1/Managers"
},
"UpdateService": {
"@odata.id": "/redfish/v1/UpdateService"
},
"CompositionService": {
"@odata.id": "/redfish/v1/CompositionService"
},
"Tasks": {
"@odata.id": "/redfish/v1/TaskService"
},
"SessionService": {
"@odata.id": "/redfish/v1/SessionService"
},
"AccountService": {
"@odata.id": "/redfish/v1/AccountService"
834 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
},
"EventService": {
"@odata.id": "/redfish/v1/EventService"
},
"Links": {
"Sessions": {
"@odata.id": "/redfish/v1/SessionService/Sessions"
}
},
"@odata.id": "/redfish/v1/"
}
6.116 Session 1.6.0
Version v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.3 2022.2 2022.1 2020.3 2019.1 2017.1 1.0
6.116.1 Description
The Session resource describes a single connection (session) between a client and a Redfish service
instance.
6.116.2 URIs
/redfish/v1/SessionService/Sessions/{SessionId}
6.116.3 Properties
Property Type Attributes Notes
ClientOriginIPAddress read-only
string The IP address of the client that created the session.
(v1.3+) (null)
read-only
Context (v1.5+) string A client-supplied string that is stored with the session.
(null)
string read-only
CreatedTime (v1.4+) The date and time when the session was created.
(date-time) (null)
OemSessionType read-only
string The active OEM-defined session type.
(v1.2+) (null)
Version 2023.1 Published 835
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only
required on
Password string The password for this session. The value is null in responses.
create
(null)
string read-only The active session type. For the possible property values, see
SessionType (v1.2+)
(enum) (null) SessionType in Property details.
read-only The multi-factor authentication token for this session. The value is
Token (v1.6+) string
(null) null in responses.
read-only
required on
UserName string The username for the account for this session.
create
(null)
6.116.4 Property details
6.116.4.1 SessionType
The active session type.
string Description
HostConsole The host's console, which could be connected through Telnet, SSH, or other protocol.
IPMI Intelligent Platform Management Interface.
KVMIP Keyboard-Video-Mouse over IP Session.
The manager's console, which could be connected through Telnet, SSH, SM CLP, or other
ManagerConsole
protocol.
OEM OEM type. For OEM session types, see the OemSessionType property.
Redfish A Redfish session.
VirtualMedia Virtual media.
A non-Redfish web user interface session, such as a graphical interface or another web-based
WebUI
protocol.
836 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.116.5 Example response
{
"@odata.type": "#Session.v1_6_0.Session",
"Id": "1234567890ABCDEF",
"Name": "User Session",
"Description": "Manager User Session",
"UserName": "Administrator",
"@odata.id": "/redfish/v1/SessionService/Sessions/1234567890ABCDEF"
}
6.117 SessionService 1.1.8
Version v1.1 v1.0
Release 2016.2 1.0
6.117.1 Description
The SessionService schema describes the session service and its properties, with links to the actual
list of sessions.
6.117.2 URIs
/redfish/v1/SessionService
6.117.3 Properties
Property Type Attributes Notes
An indication of whether this service is enabled. If true , this service is
read-write enabled. If false , it is disabled, and new sessions cannot be created, old
ServiceEnabled boolean
(null) sessions cannot be deleted, and established sessions can continue
operating.
Sessions { object The link to a collection of sessions. Contains a link to a resource.
@odata.id string read-only Link to Collection of Session. See the Session schema for details.
Version 2023.1 Published 837
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
integer The number of seconds of inactivity that a session can have before the
SessionTimeout read-write
(seconds) session service closes the session due to inactivity.
The status and health of the resource and its subordinate or dependent
Status {} object
resources. For property details, see Status.
6.117.4 Example response
{
"@odata.type": "#SessionService.v1_1_8.SessionService",
"Id": "SessionService",
"Name": "Session Service",
"Description": "Session Service",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"ServiceEnabled": true,
"SessionTimeout": 30,
"Sessions": {
"@odata.id": "/redfish/v1/SessionService/Sessions"
},
"@odata.id": "/redfish/v1/SessionService"
}
6.118 Signature 1.0.2
Version v1.0
Release 2020.1
6.118.1 Description
The Signature schema describes a signature or a hash.
6.118.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
SecureBoot/SecureBootDatabases/{DatabaseId}/Signatures/{SignatureId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SecureBoot/
838 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
SecureBootDatabases/{DatabaseId}/Signatures/{SignatureId}
/redfish/v1/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases/{DatabaseId}/
Signatures/{SignatureId}
6.118.3 Properties
Property Type Attributes Notes
read-only
required
SignatureString string The string for the signature.
on create
(null)
read-only
required
SignatureType string The format of the signature.
on create
(null)
read-only
string required The type of the signature. For the possible property values, see
SignatureTypeRegistry
(enum) on create SignatureTypeRegistry in Property details.
(null)
string read-only
UefiSignatureOwner The UEFI signature owner for this signature.
(uuid) (null)
6.118.4 Property details
6.118.4.1 SignatureTypeRegistry
The type of the signature.
string Description
UEFI A signature defined in the UEFI Specification.
6.118.5 Example response
{
"@odata.type": "#Signature.v1_0_2.Signature",
"Id": "1",
"Name": "SHA256 Signature",
"SignatureString": "80B4D96931BF0D02FD91A61E19D14F1DA452E66DB2408CA8604D411F92659F0A",
Version 2023.1 Published 839
Redfish Resource and Schema Guide DSP2046
"SignatureTypeRegistry": "UEFI",
"SignatureType": "EFI_CERT_SHA256_GUID",
"UefiSignatureOwner": "28d5e212-165b-4ca0-909b-c86b9cee0112",
"@odata.id": "/redfish/v1/Systems/1/SecureBoot/SecureBootDatabases/db/Signatures/1"
}
6.119 SimpleStorage 1.3.1
Version v1.3 v1.2 v1.1 v1.0
Release 2020.3 2017.1 2016.1 1.0
6.119.1 Description
The SimpleStorage schema represents the properties of a storage controller and its directly-attached
devices.
6.119.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/SimpleStorage/{SimpleStorageId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
SimpleStorage/{SimpleStorageId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/SimpleStorage/{SimpleStorageId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SimpleStorage/
{SimpleStorageId}
/redfish/v1/Systems/{ComputerSystemId}/SimpleStorage/{SimpleStorageId}
6.119.3 Properties
Property Type Attributes Notes
Devices [ { array The storage devices.
CapacityBytes integer read-only
The size, in bytes, of the storage device.
(v1.1+) (bytes) (null)
read-only
Manufacturer string The name of the manufacturer of this device.
(null)
840 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only
Model string The product model number of this device.
(null)
read-only
Name string The name of the Resource or array member.
required
Oem {} object See the Oem object definition in the Common properties section.
The status and health of the Resource and its subordinate or dependent
Status {} object
Resources. For property details, see Status.
}]
Links (v1.2+) { object The links to other Resources that are related to this Resource.
Chassis The link to the chassis that contains this simple storage. See the Chassis
object
(v1.2+) { schema for details on this property.
Link to a Chassis resource. See the Links section and the Chassis schema
@odata.id string read-only
for details.
Oem {} object See the Oem object definition in the Common properties section.
Storage The link to the storage instance that corresponds to this simple storage.
object
(v1.3+) { See the Storage schema for details on this property.
Link to a Storage resource. See the Links section and the Storage schema
@odata.id string read-only
for details.
The status and health of the Resource and its subordinate or dependent
Status {} object
Resources. For property details, see Status.
read-only
UefiDevicePath string The UEFI device path to access this storage controller.
(null)
6.119.4 Example response
{
"@odata.type": "#SimpleStorage.v1_3_1.SimpleStorage",
"Id": "1",
"Name": "Simple Storage Controller",
"Description": "System SATA",
Version 2023.1 Published 841
Redfish Resource and Schema Guide DSP2046
"UefiDevicePath": "Acpi(PNP0A03,0)/Pci(1F|1)/Ata(Primary,Master)/HD(Part3, Sig00110011)",
"Status": {
"State": "Enabled",
"Health": "OK",
"HealthRollup": "Warning"
},
"Devices": [
{
"Name": "SATA Bay 1",
"Manufacturer": "Contoso",
"Model": "3000GT8",
"CapacityBytes": 8000000000000,
"Status": {
"State": "Enabled",
"Health": "OK"
}
},
{
"Name": "SATA Bay 2",
"Manufacturer": "Contoso",
"Model": "3000GT7",
"CapacityBytes": 4000000000000,
"Status": {
"State": "Enabled",
"Health": "Warning"
}
},
{
"Name": "SATA Bay 3",
"Status": {
"State": "Absent"
}
},
{
"Name": "SATA Bay 4",
"Status": {
"State": "Absent"
}
}
],
"@odata.id": "/redfish/v1/Systems/437XR1138R2/SimpleStorage/1"
}
6.120 SoftwareInventory 1.9.0
Version v1.9 v1.8 v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
842 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Release 2022.3 2022.2 2022.1 2021.4 2021.2 2020.4 2020.1 2018.1 2016.3 2016.2
6.120.1 Description
The SoftwareInventory schema contains an inventory of software components. This can include
software components such as BIOS, BMC firmware, firmware for other devices, system drivers, or
provider software.
6.120.2 URIs
/redfish/v1/UpdateService/FirmwareInventory/{SoftwareInventoryId}
/redfish/v1/UpdateService/SoftwareInventory/{SoftwareInventoryId}
6.120.3 Properties
Property Type Attributes Notes
AdditionalVersions (v1.7+) { object The additional versions of this software.
read-only The bootloader version contained in this software, such as U-
Bootloader (v1.7+) string
(null) Boot or UEFI.
read-only
Kernel (v1.7+) string The kernel version contained in this software.
(null)
read-only The microcode version contained in this software, such as
Microcode (v1.7+) string
(null) processor microcode.
See the Oem object definition in the Common properties
Oem (v1.7+) {} object
section.
read-only
OSDistribution (v1.8+) string The operating system name of this software.
(null)
LowestSupportedVersion read-only
string The lowest supported version of this software.
(v1.1+) (null)
read-only
Manufacturer (v1.2+) string The manufacturer or producer of this software.
(null)
A DSP0274-defined measurement block. Deprecated in v1.6
Measurement (v1.4+,
object and later. This property has been deprecated in favor of the
deprecated v1.6 {
ComponentIntegrity resource.
Version 2023.1 Published 843
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The hexadecimal string representation of the numeric value of
read-only
Measurement (v1.4+) string the DSP0274-defined Measurement field of the measurement
(null)
block.
read-only
MeasurementIndex (v1.5+) integer The DSP0274-defined Index field of the measurement block.
(null)
read-only The DSP0274-defined MeasurementSize field of the
MeasurementSize (v1.4+) integer
(null) measurement block.
MeasurementSpecification read-only The DSP0274-defined MeasurementSpecification field of the
integer
(v1.4+) (null) measurement block.
The IDs of the Resources associated with this software
RelatedItem (v1.1+) [ { array
inventory item.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
string
read-only
ReleaseDate (v1.2+) (date- The release date of this software.
(null)
time)
SoftwareId (v1.1+) string read-only The implementation-specific label that identifies this software.
The status and health of the Resource and its subordinate or
Status {} object
dependent Resources. For property details, see Status.
array
The list of UEFI device paths of the components associated with
UefiDevicePaths (v1.1+) [ ] (string, read-only
this software inventory item.
null)
read-only An indication of whether the Update Service can update this
Updateable boolean
(null) software.
read-only
Version string The version of this software.
(null)
string read-only The format of the version. For the possible property values, see
VersionScheme (v1.9+)
(enum) (null) VersionScheme in Property details.
read-write
WriteProtected (v1.3+) boolean Indicates if the software is write-protected.
(null)
844 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.120.4 Property details
6.120.4.1 VersionScheme
The format of the version.
string Description
DotIntegerNotation Version formatted as dot-separated integers.
OEM Version follows OEM-defined format.
SemVer Version follows Semantic Versioning 2.0 rules.
6.120.5 Example response
{
"@odata.type": "#SoftwareInventory.v1_9_0.SoftwareInventory",
"Id": "BMC",
"Name": "Contoso BMC Firmware",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Updateable": true,
"Manufacturer": "Contoso",
"ReleaseDate": "2017-08-22T12:00:00",
"Version": "1.45.455b66-rev4",
"SoftwareId": "1624A9DF-5E13-47FC-874A-DF3AFF143089",
"LowestSupportedVersion": "1.30.367a12-rev1",
"UefiDevicePaths": [
"BMC(0x1,0x0ABCDEF)"
],
"RelatedItem": [
{
"@odata.id": "/redfish/v1/Managers/1"
}
],
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/BMC"
}
Version 2023.1 Published 845
Redfish Resource and Schema Guide DSP2046
6.121 Storage 1.15.0
Version v1.15 v1.14 v1.13 v1.12 v1.11 v1.10 v1.9 v1.8 v1.7 v1.6 v1.5 ...
Release 2023.1 2022.3 2022.1 2021.4 2021.2 2020.4 2020.3 2019.3 2019.1 2018.3 2018.2 ...
6.121.1 Description
The Storage schema defines a storage subsystem and its respective properties. A storage subsystem
represents a set of physical or virtual storage controllers and the resources, such as volumes, that can
be accessed from that subsystem.
6.121.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}
/redfish/v1/Storage/{StorageId}
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}
6.121.3 Properties
Property Type Attributes Notes
Indicates if this storage subsystem automatically
string read-write create new volumes for unassigned drives. For the
AutoVolumeCreate (v1.15+)
(enum) (null) possible property values, see AutoVolumeCreate in
Property details.
The collection of links to the connections that this
Connections (v1.15+) { object storage subsystem contains. Contains a link to a
resource.
Link to Collection of Connection. See the Connection
@odata.id string read-only
schema for details.
846 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The consistency groups, each of which contains a set
of volumes that are treated by an application or set of
ConsistencyGroups (v1.8+) {} object
applications as a single resource, that are managed
by this storage subsystem.
The set of controllers instantiated by this storage
Controllers (v1.9+) { object
subsystem. Contains a link to a resource.
Link to Collection of StorageController. See the
@odata.id string read-only
StorageController schema for details.
The set of drives attached to the storage controllers
Drives [ { array
that this resource represents.
Link to a Drive resource. See the Links section and the
@odata.id string read-only
Drive schema for details.
}]
The encryption mode of this storage subsystem. For
string read-write
EncryptionMode (v1.14+) the possible property values, see EncryptionMode in
(enum) (null)
Property details.
All of the endpoint groups, each of which contains a
set of endpoints that are used for a common purpose
EndpointGroups (v1.8+) { object
such as an ACL or logical identification, that belong to
this storage subsystem. Contains a link to a resource.
Link to Collection of EndpointGroup. See the
@odata.id string read-only
EndpointGroup schema for details.
All file systems that are allocated by this storage
FileSystems (v1.8+) {} object
subsystem.
The policy under which hot spare drives in this
string read-write storage domain will activate. For the possible property
HotspareActivationPolicy (v1.14+)
(enum) (null) values, see HotspareActivationPolicy in Property
details.
array The durable names for the storage subsystem. For
Identifiers (v1.9+) [ { } ]
(object) property details, see Identifier.
The links to other resources that are related to this
Links { object
resource.
An array of links to the chassis to which this storage
Enclosures [ { array
subsystem is attached.
Version 2023.1 Published 847
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to a Chassis resource. See the Links section and
@odata.id string read-only
the Chassis schema for details.
}]
HostingStorageSystems (v1.11+) The storage systems that host this storage
array
[{ subsystem.
Link to a ComputerSystem resource. See the Links
@odata.id string read-only
section and the ComputerSystem schema for details.
}]
An array of links to the discovery subsystems that
NVMeoFDiscoverySubysystems
array discovered this subsystem in an NVMe-oF
(v1.15+) [ {
environment.
@odata.id string read-only Link to another Storage resource.
}]
See the Oem object definition in the Common
Oem {} object
properties section.
The link to the simple storage instance that
SimpleStorage (v1.9+) { object corresponds to this storage. See the SimpleStorage
schema for details on this property.
Link to a SimpleStorage resource. See the Links
@odata.id string read-only
section and the SimpleStorage schema for details.
An array of links to the storage services that connect
StorageServices (v1.9+) [ { array
to this storage subsystem.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
LocalEncryptionKeyIdentifier read-only The local encryption key identifier used by the
string
(v1.14+) (null) storage subsystem.
array Redundancy information for the storage subsystem.
Redundancy [ { } ]
(object) For property details, see Redundancy.
848 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The status and health of the resource and its
Status {} object subordinate or dependent resources. For property
details, see Status.
The set of storage controllers that this resource
represents. Deprecated in v1.13 and later. This
StorageControllers (deprecated v1.13)
array property has been deprecated in favor of Controllers
[{
to allow for storage controllers to be represented as
their own resources.
string read-only
@odata.id The unique identifier for a resource.
(URI) required
Actions (v1.2+) {} object The available actions for this resource.
The link to the assembly associated with this storage
Assembly (v1.4+) { object controller. See the Assembly schema for details on
this property.
Link to a Assembly resource. See the Links section
@odata.id string read-only
and the Assembly schema for details.
read-write
AssetTag string The user-assigned asset tag for this storage controller.
(null)
The cache memory of the storage controller in
CacheSummary (v1.5+) { object
general detail.
PersistentCacheSizeMiB integer read-only The portion of the cache memory that is persistent,
(v1.5+) (mebibytes) (null) measured in MiB.
The status and health of the resource and its
Status (v1.5+) {} object subordinate or dependent resources. For property
details, see Status.
read-only
integer
TotalCacheSizeMiB (v1.5+) required The total configured cache memory, measured in MiB.
(mebibytes)
(null)
The link to a collection of certificates for device
Certificates (v1.10+) { object
identity and attestation. Contains a link to a resource.
Link to Collection of Certificate. See the Certificate
@odata.id string read-only
schema for details.
Version 2023.1 Published 849
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
This property describes the various controller rates
ControllerRates (v1.7+) { object used for processes such as volume rebuild or
consistency checks.
ConsistencyCheckRatePercent read-write The percentage of controller resources used for
integer
(v1.7+) (null) performing a data consistency check on volumes.
read-write The percentage of controller resources used for
RebuildRatePercent (v1.7+) integer
(null) rebuilding/repairing volumes.
The percentage of controller resources used for
TransformationRatePercent read-write
integer transforming volumes from one configuration to
(v1.7+) (null)
another.
read-only
FirmwareVersion string The firmware version of this storage controller.
(null)
array The durable names for the storage controller. For
Identifiers [ { } ]
(object) property details, see Identifier.
The links to other resources that are related to this
Links (v1.1+) { object
resource.
An array of links to the endpoints that connect to this
Endpoints (v1.1+) [ { array
controller.
Link to a Endpoint resource. See the Links section and
@odata.id string read-only
the Endpoint schema for details.
}]
See the Oem object definition in the Common
Oem {} object
properties section.
An array of links to the PCIe functions that the storage
PCIeFunctions (v1.7+) [ { array
controller produces.
Link to a PCIeFunction resource. See the Links section
@odata.id string read-only
and the PCIeFunction schema for details.
}]
An array of links to the storage services that connect
to this controller. Deprecated in v1.9 and later. This
StorageServices (v1.4+,
array property has been deprecated in favor of
deprecated v1.9 [ {
StorageServices within the Links property at the root
level.
850 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
The location of the storage controller. For property
Location (v1.4+) {} object
details, see Location.
read-only
Manufacturer string The manufacturer of this storage controller.
(null)
An array of DSP0274-defined measurement blocks.
Measurements (v1.10+, deprecated Deprecated in v1.12 and later. This property has been
array
v1.12 [ { deprecated in favor of the ComponentIntegrity
resource.
Link to a MeasurementBlock resource. See the Links
@odata.id string read-only
section and the SoftwareInventory schema for details.
}]
read-only
MemberId string The unique identifier for the member within an array.
required
read-only
Model string The model number for the storage controller.
(null)
read-only
Name (v1.3+) string The name of the storage controller.
(null)
See the Oem object definition in the Common
Oem {} object
properties section.
read-only
PartNumber string The part number for this storage controller.
(null)
PCIeInterface (v1.5+) { object The PCIe interface details for this controller.
read-only
LanesInUse (v1.3+) integer The number of PCIe lanes in use by this device.
(null)
read-only
MaxLanes (v1.3+) integer The number of PCIe lanes supported by this device.
(null)
The highest version of the PCIe specification
string read-only
MaxPCIeType (v1.3+) supported by this device. For the possible property
(enum) (null)
values, see MaxPCIeType in Property details.
Version 2023.1 Published 851
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
See the Oem object definition in the Common
Oem (v1.3+) {} object
properties section.
The version of the PCIe specification in use by this
string read-only
PCIeType (v1.3+) device. For the possible property values, see PCIeType
(enum) (null)
in Property details.
The link to the collection of ports that exist on the
Ports (v1.7+) { object
storage controller. Contains a link to a resource.
Link to Collection of Port. See the Port schema for
@odata.id string read-only
details.
read-only
SerialNumber string The serial number for this storage controller.
(null)
read-only
SKU string The SKU for this storage controller.
(null)
number read-only The maximum speed of the storage controller's
SpeedGbps
(Gbit/s) (null) device interface.
The status and health of the resource and its
Status {} object subordinate or dependent resources. For property
details, see Status.
The supported set of protocols for communicating to
array
this storage controller. For the possible property
SupportedControllerProtocols [ ] (string read-only
values, see SupportedControllerProtocols in Property
(enum))
details.
The protocols that the storage controller can use to
array
communicate with attached devices. For the possible
SupportedDeviceProtocols [ ] (string read-only
property values, see SupportedDeviceProtocols in
(enum))
Property details.
array The set of RAID types supported by the storage
read-only
SupportedRAIDTypes (v1.6+) [ ] (string controller. For the possible property values, see
(null)
(enum)) SupportedRAIDTypes in Property details.
}]
852 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
All of the storage groups, each of which contains a set
of volumes and endpoints that are managed as a
StorageGroups (v1.8+, deprecated group for mapping and masking, that belong to this
object
v1.15 {} storage subsystem. Deprecated in v1.15 and later.
This property was deprecated in favor of the
Connections property.
The set of all storage pools that are allocated by this
storage subsystem. A storage pool is the set of
StoragePools (v1.8+) {} object
storage capacity that can be used to produce volumes
or other storage pools.
The set of volumes that the storage controllers
Volumes {} object
produce.
6.121.4 Actions
6.121.4.1 ResetToDefaults (v1.11+)
Description
The reset action resets the storage device to factory defaults. This can cause the loss of data.
Action URI
{Base URI of target resource}/Actions/Storage.ResetToDefaults
Action parameters
Parameter
Type Attributes Notes
Name
string The type of reset to defaults. For the possible property values, see ResetType
ResetType required
(enum) in Property details.
Request Example
{
"ResetType": "ResetAll"
}
Version 2023.1 Published 853
Redfish Resource and Schema Guide DSP2046
6.121.4.2 SetEncryptionKey
Description
This action sets the local encryption key for the storage subsystem.
Action URI
{Base URI of target resource}/Actions/Storage.SetEncryptionKey
Action parameters
Parameter Name Type Attributes Notes
CurrentEncryptionKey
string optional The current local encryption key on the storage subsystem.
(v1.14+)
EncryptionKey string required The local encryption key to set on the storage subsystem.
EncryptionKeyIdentifier
string optional The local encryption key identifier used by the storage subsystem.
(v1.14+)
Request Example
{
"EncryptionKey": "566b523d3f955a7fba38a28ec708ca10"
}
6.121.5 Property details
6.121.5.1 AutoVolumeCreate
Indicates if this storage subsystem automatically create new volumes for unassigned drives.
string Description
Disabled Do not automatically create volumes.
NonRAID Automatically create non-RAID volumes.
RAID0 Automatically create RAID0 volumes.
854 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
RAID1 Automatically create RAID1 volumes.
6.121.5.2 EncryptionMode
The encryption mode of this storage subsystem.
string Description
Disabled Encryption is disabled on the storage subsystem.
UseExternalKey The storage subsystem uses one or more external keys for encryption.
UseLocalKey The storage subsystem uses a local key for encryption.
6.121.5.3 HotspareActivationPolicy
The policy under which hot spare drives in this storage domain will activate.
string Description
OEM The hot spare drive will take over for the original drive in an algorithm custom to the OEM.
The hot spare drive will take over for the original drive when the original drive has been
OnDriveFailure
marked as failed by the storage domain.
The hot spare drive will take over for the original drive when the original drive has been
OnDrivePredictedFailure
predicted to fail in the future by the storage domain.
6.121.5.4 idRef
string
@odata.id read-only The unique identifier for a resource.
(URI)
6.121.5.5 MaxPCIeType
The highest version of the PCIe specification supported by this device.
Version 2023.1 Published 855
Redfish Resource and Schema Guide DSP2046
string Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.
6.121.5.6 PCIeType
The version of the PCIe specification in use by this device.
string Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.
6.121.5.7 ResetType
The type of reset to defaults.
string Description
PreserveVolumes Reset all settings to factory defaults but preserve the configured volumes on the controllers.
ResetAll Reset all settings to factory defaults and remove all volumes.
6.121.5.8 SupportedControllerProtocols
The supported set of protocols for communicating to this storage controller.
856 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
AHCI Advanced Host Controller Interface (AHCI).
CXL Compute Express Link.
DisplayPort DisplayPort.
DVI DVI.
Ethernet Ethernet.
FC Fibre Channel.
FCoE Fibre Channel over Ethernet (FCoE).
FCP Fibre Channel Protocol for SCSI.
FICON FIbre CONnection (FICON).
FTP File Transfer Protocol (FTP).
GenZ GenZ.
HDMI HDMI.
HTTP Hypertext Transport Protocol (HTTP).
HTTPS Hypertext Transfer Protocol Secure (HTTPS).
I2C Inter-Integrated Circuit Bus.
InfiniBand InfiniBand.
iSCSI Internet SCSI.
iWARP Internet Wide Area RDMA Protocol (iWARP).
MultiProtocol Multiple Protocols.
NFSv3 Network File System (NFS) version 3.
NFSv4 Network File System (NFS) version 4.
NVLink NVLink.
NVMe Non-Volatile Memory Express (NVMe).
NVMeOverFabrics NVMe over Fabrics.
OEM OEM-specific.
PCIe PCI Express.
Version 2023.1 Published 857
Redfish Resource and Schema Guide DSP2046
string Description
RoCE RDMA over Converged Ethernet Protocol.
RoCEv2 RDMA over Converged Ethernet Protocol Version 2.
SAS Serial Attached SCSI.
SATA Serial AT Attachment.
SFTP SSH File Transfer Protocol (SFTP).
SMB Server Message Block (SMB). Also known as the Common Internet File System (CIFS).
TCP Transmission Control Protocol (TCP).
TFTP Trivial File Transfer Protocol (TFTP).
UDP User Datagram Protocol (UDP).
UHCI Universal Host Controller Interface (UHCI).
USB Universal Serial Bus (USB).
VGA VGA.
6.121.5.9 SupportedDeviceProtocols
The protocols that the storage controller can use to communicate with attached devices.
string Description
AHCI Advanced Host Controller Interface (AHCI).
CXL Compute Express Link.
DisplayPort DisplayPort.
DVI DVI.
Ethernet Ethernet.
FC Fibre Channel.
FCoE Fibre Channel over Ethernet (FCoE).
FCP Fibre Channel Protocol for SCSI.
FICON FIbre CONnection (FICON).
FTP File Transfer Protocol (FTP).
858 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
GenZ GenZ.
HDMI HDMI.
HTTP Hypertext Transport Protocol (HTTP).
HTTPS Hypertext Transfer Protocol Secure (HTTPS).
I2C Inter-Integrated Circuit Bus.
InfiniBand InfiniBand.
iSCSI Internet SCSI.
iWARP Internet Wide Area RDMA Protocol (iWARP).
MultiProtocol Multiple Protocols.
NFSv3 Network File System (NFS) version 3.
NFSv4 Network File System (NFS) version 4.
NVLink NVLink.
NVMe Non-Volatile Memory Express (NVMe).
NVMeOverFabrics NVMe over Fabrics.
OEM OEM-specific.
PCIe PCI Express.
RoCE RDMA over Converged Ethernet Protocol.
RoCEv2 RDMA over Converged Ethernet Protocol Version 2.
SAS Serial Attached SCSI.
SATA Serial AT Attachment.
SFTP SSH File Transfer Protocol (SFTP).
SMB Server Message Block (SMB). Also known as the Common Internet File System (CIFS).
TCP Transmission Control Protocol (TCP).
TFTP Trivial File Transfer Protocol (TFTP).
UDP User Datagram Protocol (UDP).
UHCI Universal Host Controller Interface (UHCI).
Version 2023.1 Published 859
Redfish Resource and Schema Guide DSP2046
string Description
USB Universal Serial Bus (USB).
VGA VGA.
6.121.5.10 SupportedRAIDTypes
The set of RAID types supported by the storage controller.
string Description
None A placement policy with no redundancy at the device level.
A placement policy where consecutive logical blocks of data are uniformly distributed across
RAID0
a set of independent storage devices without offering any form of redundancy.
RAID00 A placement policy that creates a RAID 0 stripe set over two or more RAID 0 sets.
A data placement policy that creates a mirrored device (RAID 1) over a set of striped devices
RAID01
(RAID 0).
A placement policy where each logical block of data is stored on more than one independent
RAID1
storage device.
A placement policy that creates a striped device (RAID 0) over a set of mirrored devices (RAID
RAID10
1).
RAID10E A placement policy that uses a RAID 0 stripe set over two or more RAID 10 sets.
A placement policy that uses a striped device (RAID 0) over a set of triple mirrored devices
RAID10Triple
(RAID 1Triple).
A placement policy that uses a form of mirroring implemented over a set of independent
RAID1E storage devices where logical blocks are duplicated on a pair of independent storage devices
so that data is uniformly distributed across the storage devices.
A placement policy where each logical block of data is mirrored three times across a set of
RAID1Triple
three independent storage devices.
A placement policy using parity-based protection where logical bytes of data are uniformly
RAID3 distributed across a set of independent storage devices and where the parity is stored on a
dedicated independent storage device.
A placement policy using parity-based protection where logical blocks of data are uniformly
RAID4 distributed across a set of independent storage devices and where the parity is stored on a
dedicated independent storage device.
860 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
A placement policy using parity-based protection for storing stripes of 'n' logical blocks of
RAID5 data and one logical block of parity across a set of 'n+1' independent storage devices where
the parity and data blocks are interleaved across the storage devices.
A placement policy that uses a RAID 0 stripe set over two or more RAID 5 sets of independent
RAID50
storage devices.
A placement policy using parity-based protection for storing stripes of 'n' logical blocks of
RAID6 data and two logical blocks of independent parity across a set of 'n+2' independent storage
devices where the parity and data blocks are interleaved across the storage devices.
A placement policy that uses a RAID 0 stripe set over two or more RAID 6 sets of independent
RAID60
storage devices.
A placement policy that uses parity-based protection for storing stripes of 'n' logical blocks of
RAID6TP data and three logical blocks of independent parity across a set of 'n+3' independent storage
devices where the parity and data blocks are interleaved across the storage devices.
6.121.6 Example response
{
"@odata.type": "#Storage.v1_15_0.Storage",
"Id": "1",
"Name": "Local Storage Controller",
"Description": "Integrated RAID Controller",
"Status": {
"State": "Enabled",
"Health": "OK",
"HealthRollup": "OK"
},
"StorageControllers": [
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1#/StorageControllers/0",
"MemberId": "0",
"Name": "Contoso Integrated RAID",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Identifiers": [
{
"DurableNameFormat": "NAA",
"DurableName": "345C59DBD970859C"
}
],
"Manufacturer": "Contoso",
"Model": "12Gbs Integrated RAID",
Version 2023.1 Published 861
Redfish Resource and Schema Guide DSP2046
"SerialNumber": "2M220100SL",
"PartNumber": "CT18754",
"SpeedGbps": 12,
"FirmwareVersion": "1.0.0.7",
"SupportedControllerProtocols": [
"PCIe"
],
"SupportedDeviceProtocols": [
"SAS",
"SATA"
]
}
],
"Drives": [
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Drives/35D38F11ACEF7BD3"
},
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Drives/3F5A8C54207B7233"
},
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Drives/32ADF365C6C1B7BD"
},
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Drives/3D58ECBC375FD9F2"
}
],
"Volumes": {
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Volumes"
},
"Actions": {
"#Storage.SetEncryptionKey": {
"target": "/redfish/v1/Systems/437XR1138R2/Storage/1/Actions/Storage.SetEncryptionKey"
}
},
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1"
}
6.122 StorageController 1.7.0
Version v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2023.1 2022.1 2021.4 2021.3 2021.2 2021.1 2020.4 2020.3
862 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.122.1 Description
The StorageController schema describes a storage controller and its properties. A storage controller
represents a physical or virtual storage device that produces volumes.
6.122.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/
{ControllerId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/Controllers/{ControllerId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{ControllerId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
Controllers/{ControllerId}
/redfish/v1/Storage/{StorageId}/Controllers/{ControllerId}
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{ControllerId}
6.122.3 Properties
Property Type Attributes Notes
The link to the assembly
associated with this storage
Assembly { object controller. See the Assembly
schema for details on this
property.
Link to a Assembly resource. See
@odata.id string read-only the Links section and the
Assembly schema for details.
read-write The user-assigned asset tag for
AssetTag string
(null) this storage controller.
The cache memory of the
CacheSummary { object storage controller in general
detail.
The portion of the cache memory
integer read-only
PersistentCacheSizeMiB that is persistent, measured in
(mebibytes) (null)
MiB.
Version 2023.1 Published 863
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The status and health of the
resource and its subordinate or
Status {} object
dependent resources. For
property details, see Status.
read-only
integer The total configured cache
TotalCacheSizeMiB required
(mebibytes) memory, measured in MiB.
(null)
The link to a collection of
certificates for device identity
Certificates (v1.1+) { object
and attestation. Contains a link
to a resource.
Link to Collection of Certificate.
@odata.id string read-only See the Certificate schema for
details.
This property describes the
various controller rates used for
ControllerRates { object
processes such as volume rebuild
or consistency checks.
The percentage of controller
read-write resources used for performing a
ConsistencyCheckRatePercent integer
(null) data consistency check on
volumes.
The percentage of controller
read-write
RebuildRatePercent integer resources used for rebuilding/
(null)
repairing volumes.
The percentage of controller
read-write resources used for transforming
TransformationRatePercent integer
(null) volumes from one configuration
to another.
The link to the environment
metrics for this storage
EnvironmentMetrics (v1.2+) { object controller. See the
EnvironmentMetrics schema for
details on this property.
864 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to a EnvironmentMetrics
resource. See the Links section
@odata.id string read-only
and the EnvironmentMetrics
schema for details.
read-only The firmware version of this
FirmwareVersion string
(null) storage controller.
The durable names for the
array
Identifiers [ { } ] storage controller. For property
(object)
details, see Identifier.
The links to other resources that
Links { object
are related to this resource.
An array of links to volumes that
AttachedVolumes [ { array are attached to this controller
instance.
string The unique identifier for a
@odata.id read-only
(URI) resource.
}]
The batteries that provide power
Batteries (v1.6+) [ { array to this storage controller during a
power loss event.
Link to a Battery resource. See
@odata.id string read-only the Links section and the Battery
schema for details.
}]
An array of links to the endpoints
Endpoints [ { array
that connect to this controller.
Link to a Endpoint resource. See
@odata.id string read-only the Links section and the
Endpoint schema for details.
}]
The network device functions
NetworkDeviceFunctions (v1.3+) [ { array that provide connectivity to this
controller.
Version 2023.1 Published 865
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to a NetworkDeviceFunction
resource. See the Links section
@odata.id string read-only
and the NetworkDeviceFunction
schema for details.
}]
The NVMe subsystems
NVMeDiscoveredSubsystems (v1.7+) [ { array discovered by this discovery
controller.
Link to a Storage resource. See
@odata.id string read-only the Links section and the Storage
schema for details.
}]
See the Oem object definition in
Oem {} object
the Common properties section.
An array of links to the PCIe
PCIeFunctions [ { array functions that the storage
controller produces.
Link to a PCIeFunction resource.
@odata.id string read-only See the Links section and the
PCIeFunction schema for details.
}]
The location of the storage
Location {} object controller. For property details,
see Location.
read-only The manufacturer of this storage
Manufacturer string
(null) controller.
An array of DSP0274-defined
measurement blocks.
Deprecated in v1.5 and later.
Measurements (v1.1+, deprecated v1.5 [ { array
This property has been
deprecated in favor of the
ComponentIntegrity resource.
Link to a MeasurementBlock
resource. See the Links section
@odata.id string read-only
and the SoftwareInventory
schema for details.
866 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
}]
The link to the metrics
associated with this storage
Metrics (v1.7+) { object controller. See the
(null)
StorageControllerMetrics schema
for details on this property.
Link to a
StorageControllerMetrics
@odata.id string read-only resource. See the Links section
and the StorageControllerMetrics
schema for details.
read-only The model number for the
Model string
(null) storage controller.
The NVMe related properties for
NVMeControllerProperties { object
this storage controller.
The number of I/O completion
read-only
AllocatedCompletionQueues (v1.4+) integer queues allocated to this NVMe
(null)
I/O controller.
The number of I/O submission
read-only
AllocatedSubmissionQueues (v1.4+) integer queues allocated to this NVMe
(null)
I/O controller.
The ANA characteristics and
ANACharacteristics [ { array
volume information.
Reported ANA access state. For
string read-only
AccessState the possible property values, see
(enum) (null)
AccessState in Property details.
Volume { object The specified volume.
string The unique identifier for a
@odata.id read-only
(URI) resource.
}]
The type of NVMe controller. For
string read-only the possible property values, see
ControllerType
(enum) (null) ControllerType in Property
details.
Version 2023.1 Published 867
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The maximum individual queue
read-only
MaxQueueSize integer size that an NVMe IO controller
(null)
supports.
NVMeControllerAttributes { object The NVMe controller attributes.
(null)
Indicates whether or not the
read-only
ReportsNamespaceGranularity boolean controller supports reporting of
(null)
Namespace Granularity.
Indicates whether or not the
read-only
ReportsUUIDList boolean controller supports reporting of a
(null)
UUID list.
Indicates whether or not the
read-only
Supports128BitHostId boolean controller supports a 128-bit Host
(null)
Identifier.
Indicates whether or not the
read-only
SupportsEnduranceGroups boolean controller supports Endurance
(null)
Groups.
Indicates whether or not the
controller supports exceeding
read-only Power of Non-Operational State
SupportsExceedingPowerOfNonOperationalState boolean
(null) in order to execute controller
initiated background operations
in a non-operational power state.
read-only Indicates whether or not the
SupportsNVMSets boolean
(null) controller supports NVM Sets.
Indicates whether or not the
read-only
SupportsPredictableLatencyMode boolean controller supports Predictable
(null)
Latency Mode.
Indicates whether or not the
read-only
SupportsReadRecoveryLevels boolean controller supports Read
(null)
Recovery Levels.
read-only Indicates if the controller
SupportsReservations (v1.2+) boolean
(null) supports reservations.
Indicates whether or not the
read-only
SupportsSQAssociations boolean controller supports SQ
(null)
Associations.
868 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Indicates whether or not the
controller supports restarting
read-only Keep Alive Timer if traffic is
SupportsTrafficBasedKeepAlive boolean
(null) processed from an admin
command or IO during a Keep
Alive Timeout interval.
The NVMe SMART Critical
Warnings for this storage
controller. This property contains
NVMeSMARTCriticalWarnings { object
(null) possible triggers for the
predictive drive failure warning
for the corresponding drive.
read-only Indicates the media has been
MediaInReadOnly boolean
(null) placed in read only mode.
Indicates that the NVM
read-only
OverallSubsystemDegraded boolean subsystem reliability has been
(null)
compromised.
read-only The Persistent Memory Region
PMRUnreliable boolean
(null) has become unreliable.
Indicates that the volatile
read-only
PowerBackupFailed boolean memory backup device has
(null)
failed.
Indicates that the available spare
read-only
SpareCapacityWornOut boolean capacity has fallen below the
(null)
threshold.
read-only The version of the NVMe Base
NVMeVersion string
(null) Specification supported.
read-only The part number for this storage
PartNumber string
(null) controller.
The PCIe interface details for this
PCIeInterface { object
controller.
read-only The number of PCIe lanes in use
LanesInUse (v1.3+) integer
(null) by this device.
Version 2023.1 Published 869
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only The number of PCIe lanes
MaxLanes (v1.3+) integer
(null) supported by this device.
The highest version of the PCIe
specification supported by this
string read-only
MaxPCIeType (v1.3+) device. For the possible property
(enum) (null)
values, see MaxPCIeType in
Property details.
See the Oem object definition in
Oem (v1.3+) {} object
the Common properties section.
The version of the PCIe
specification in use by this
string read-only
PCIeType (v1.3+) device. For the possible property
(enum) (null)
values, see PCIeType in Property
details.
The link to the collection of ports
that exist on the storage
Ports { object
controller. Contains a link to a
resource.
Link to Collection of Port. See the
@odata.id string read-only
Port schema for details.
read-only The serial number for this
SerialNumber string
(null) storage controller.
read-only The SKU for this storage
SKU string
(null) controller.
The maximum speed of the
number read-only
SpeedGbps storage controller's device
(Gbit/s) (null)
interface.
The status and health of the
resource and its subordinate or
Status {} object
dependent resources. For
property details, see Status.
870 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The supported set of protocols
for communicating to this
array
storage controller. For the
SupportedControllerProtocols [ ] (string read-only
possible property values, see
(enum))
SupportedControllerProtocols in
Property details.
The protocols that the storage
controller can use to
array communicate with attached
SupportedDeviceProtocols [ ] (string read-only devices. For the possible
(enum)) property values, see
SupportedDeviceProtocols in
Property details.
The set of RAID types supported
array by the storage controller. For the
read-only
SupportedRAIDTypes [ ] (string possible property values, see
(null)
(enum)) SupportedRAIDTypes in Property
details.
6.122.4 Actions
6.122.4.1 AttachNamespaces (v1.7+)
Description
This action attaches referenced namespaces to the storage controller. Attached namespaces are
added to the AttachedVolumes property in Links.
Action URI
{Base URI of target resource}/Actions/StorageController.AttachNamespaces
Action parameters
Parameter
Type Attributes Notes
Name
Namespaces
array required The namespaces to attach to the storage controller.
[{
string
@odata.id read-only The unique identifier for a resource.
(URI)
Version 2023.1 Published 871
Redfish Resource and Schema Guide DSP2046
Parameter
Type Attributes Notes
Name
}]
Response Payload
AttachedVolumes
array required An array of links to volumes that are attached to this controller instance.
(v1.7+) [ {
string read-
@odata.id The unique identifier for a resource.
(URI) only
}]
Request Example
{
"Namespaces": [
{
"@odata.id": "/redfish/v1/Systems/1/Storage/NVMe/Volumes/Namespace5"
}
]
}
Response Example
{
"Volumes": [
{
"@odata.id": "/redfish/v1/Systems/1/Storage/NVMe/Volumes/Namespace1"
},
{
"@odata.id": "/redfish/v1/Systems/1/Storage/NVMe/Volumes/Namespace2"
},
{
"@odata.id": "/redfish/v1/Systems/1/Storage/NVMe/Volumes/Namespace5"
}
]
}
872 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.122.4.2 DetachNamespaces (v1.7+)
Description
This action detaches referenced namespaces from the storage controller. Detached namespaces are
removed from the AttachedVolumes property in Links.
Action URI
{Base URI of target resource}/Actions/StorageController.DetachNamespaces
Action parameters
Parameter
Type Attributes Notes
Name
Namespaces
array required The namespaces to detach from the storage controller.
[{
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
Response Payload
AttachedVolumes
array required An array of links to volumes that are attached to this controller instance.
(v1.7+) [ {
string read-
@odata.id The unique identifier for a resource.
(URI) only
}]
Request Example
{
"Namespaces": [
{
"@odata.id": "/redfish/v1/Systems/1/Storage/NVMe/Volumes/Namespace5"
Version 2023.1 Published 873
Redfish Resource and Schema Guide DSP2046
}
]
}
Response Example
{
"Volumes": [
{
"@odata.id": "/redfish/v1/Systems/1/Storage/NVMe/Volumes/Namespace1"
},
{
"@odata.id": "/redfish/v1/Systems/1/Storage/NVMe/Volumes/Namespace2"
}
]
}
6.122.4.3 SecurityReceive (v1.7+)
Description
This action transfers security protocol data from the controller. The data transferred from the controller
contains the status and data result of one or more SecuritySend action requests that were previously
submitted to the controller.
Action URI
{Base URI of target resource}/Actions/StorageController.SecurityReceive
Action parameters
Parameter Name Type Attributes Notes
AllocationLength integer required Allocated size for received data.
SecurityProtocol integer required The security protocol number.
SecurityProtocolSpecific integer required The security protocol-specific parameter.
Response Payload
874 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Data read-
string The Base64-encoded security protocol data.
(v1.7+) only
Request Example
{
"SecurityProtocol": 2,
"SecurityProtocolSpecific": 4100,
"AllocationLength": 48
}
Response Example
{
"Data": "EAQAAAAAAAEAAAAiAAAAAgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
}
6.122.4.4 SecuritySend (v1.7+)
Description
This action transfers security protocol data to the controller. The data transferred to the controller
contains security protocol-specific commands to be performed by the controller.
Action URI
{Base URI of target resource}/Actions/StorageController.SecuritySend
Action parameters
Parameter Name Type Attributes Notes
Data string required The data to transfer.
SecurityProtocol integer required The security protocol number.
SecurityProtocolSpecific integer required The security protocol-specific parameter.
Version 2023.1 Published 875
Redfish Resource and Schema Guide DSP2046
Request Example
{
"SecurityProtocol": 2,
"SecurityProtocolSpecific": 4100,
"Data": "EAQAAAAAAAE="
}
6.122.5 Property details
6.122.5.1 AccessState
Reported ANA access state.
string Description
Namespaces in this group are inaccessible. Commands are not able to access user data of
Inaccessible
namespaces in the ANA Group.
Commands processed by a controller that reports this state for an ANA Group provide non-
NonOptimized optimized access characteristics, such as lower performance or non-optimal use of
subsystem resources, to any namespace in the ANA Group.
Commands processed by a controller provide optimized access to any namespace in the ANA
Optimized
group.
The group is persistently inaccessible. Commands are persistently not able to access user
PersistentLoss
data of namespaces in the ANA Group.
6.122.5.2 ControllerType
The type of NVMe controller.
string Description
Admin The NVMe controller is an admin controller.
Discovery The NVMe controller is a discovery controller.
IO The NVMe controller is an IO controller.
6.122.5.3 MaxPCIeType
The highest version of the PCIe specification supported by this device.
876 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.
6.122.5.4 PCIeType
The version of the PCIe specification in use by this device.
string Description
Gen1 A PCIe v1.0 slot.
Gen2 A PCIe v2.0 slot.
Gen3 A PCIe v3.0 slot.
Gen4 A PCIe v4.0 slot.
Gen5 A PCIe v5.0 slot.
6.122.5.5 SupportedControllerProtocols
The supported set of protocols for communicating to this storage controller.
string Description
AHCI Advanced Host Controller Interface (AHCI).
CXL Compute Express Link.
DisplayPort DisplayPort.
DVI DVI.
Ethernet Ethernet.
FC Fibre Channel.
FCoE Fibre Channel over Ethernet (FCoE).
Version 2023.1 Published 877
Redfish Resource and Schema Guide DSP2046
string Description
FCP Fibre Channel Protocol for SCSI.
FICON FIbre CONnection (FICON).
FTP File Transfer Protocol (FTP).
GenZ GenZ.
HDMI HDMI.
HTTP Hypertext Transport Protocol (HTTP).
HTTPS Hypertext Transfer Protocol Secure (HTTPS).
I2C Inter-Integrated Circuit Bus.
InfiniBand InfiniBand.
iSCSI Internet SCSI.
iWARP Internet Wide Area RDMA Protocol (iWARP).
MultiProtocol Multiple Protocols.
NFSv3 Network File System (NFS) version 3.
NFSv4 Network File System (NFS) version 4.
NVLink NVLink.
NVMe Non-Volatile Memory Express (NVMe).
NVMeOverFabrics NVMe over Fabrics.
OEM OEM-specific.
PCIe PCI Express.
RoCE RDMA over Converged Ethernet Protocol.
RoCEv2 RDMA over Converged Ethernet Protocol Version 2.
SAS Serial Attached SCSI.
SATA Serial AT Attachment.
SFTP SSH File Transfer Protocol (SFTP).
SMB Server Message Block (SMB). Also known as the Common Internet File System (CIFS).
TCP Transmission Control Protocol (TCP).
878 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
TFTP Trivial File Transfer Protocol (TFTP).
UDP User Datagram Protocol (UDP).
UHCI Universal Host Controller Interface (UHCI).
USB Universal Serial Bus (USB).
VGA VGA.
6.122.5.6 SupportedDeviceProtocols
The protocols that the storage controller can use to communicate with attached devices.
string Description
AHCI Advanced Host Controller Interface (AHCI).
CXL Compute Express Link.
DisplayPort DisplayPort.
DVI DVI.
Ethernet Ethernet.
FC Fibre Channel.
FCoE Fibre Channel over Ethernet (FCoE).
FCP Fibre Channel Protocol for SCSI.
FICON FIbre CONnection (FICON).
FTP File Transfer Protocol (FTP).
GenZ GenZ.
HDMI HDMI.
HTTP Hypertext Transport Protocol (HTTP).
HTTPS Hypertext Transfer Protocol Secure (HTTPS).
I2C Inter-Integrated Circuit Bus.
InfiniBand InfiniBand.
iSCSI Internet SCSI.
Version 2023.1 Published 879
Redfish Resource and Schema Guide DSP2046
string Description
iWARP Internet Wide Area RDMA Protocol (iWARP).
MultiProtocol Multiple Protocols.
NFSv3 Network File System (NFS) version 3.
NFSv4 Network File System (NFS) version 4.
NVLink NVLink.
NVMe Non-Volatile Memory Express (NVMe).
NVMeOverFabrics NVMe over Fabrics.
OEM OEM-specific.
PCIe PCI Express.
RoCE RDMA over Converged Ethernet Protocol.
RoCEv2 RDMA over Converged Ethernet Protocol Version 2.
SAS Serial Attached SCSI.
SATA Serial AT Attachment.
SFTP SSH File Transfer Protocol (SFTP).
SMB Server Message Block (SMB). Also known as the Common Internet File System (CIFS).
TCP Transmission Control Protocol (TCP).
TFTP Trivial File Transfer Protocol (TFTP).
UDP User Datagram Protocol (UDP).
UHCI Universal Host Controller Interface (UHCI).
USB Universal Serial Bus (USB).
VGA VGA.
6.122.5.7 SupportedRAIDTypes
The set of RAID types supported by the storage controller.
string Description
None A placement policy with no redundancy at the device level.
880 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
A placement policy where consecutive logical blocks of data are uniformly distributed across
RAID0
a set of independent storage devices without offering any form of redundancy.
RAID00 A placement policy that creates a RAID 0 stripe set over two or more RAID 0 sets.
A data placement policy that creates a mirrored device (RAID 1) over a set of striped devices
RAID01
(RAID 0).
A placement policy where each logical block of data is stored on more than one independent
RAID1
storage device.
A placement policy that creates a striped device (RAID 0) over a set of mirrored devices (RAID
RAID10
1).
RAID10E A placement policy that uses a RAID 0 stripe set over two or more RAID 10 sets.
A placement policy that uses a striped device (RAID 0) over a set of triple mirrored devices
RAID10Triple
(RAID 1Triple).
A placement policy that uses a form of mirroring implemented over a set of independent
RAID1E storage devices where logical blocks are duplicated on a pair of independent storage devices
so that data is uniformly distributed across the storage devices.
A placement policy where each logical block of data is mirrored three times across a set of
RAID1Triple
three independent storage devices.
A placement policy using parity-based protection where logical bytes of data are uniformly
RAID3 distributed across a set of independent storage devices and where the parity is stored on a
dedicated independent storage device.
A placement policy using parity-based protection where logical blocks of data are uniformly
RAID4 distributed across a set of independent storage devices and where the parity is stored on a
dedicated independent storage device.
A placement policy using parity-based protection for storing stripes of 'n' logical blocks of
RAID5 data and one logical block of parity across a set of 'n+1' independent storage devices where
the parity and data blocks are interleaved across the storage devices.
A placement policy that uses a RAID 0 stripe set over two or more RAID 5 sets of independent
RAID50
storage devices.
A placement policy using parity-based protection for storing stripes of 'n' logical blocks of
RAID6 data and two logical blocks of independent parity across a set of 'n+2' independent storage
devices where the parity and data blocks are interleaved across the storage devices.
A placement policy that uses a RAID 0 stripe set over two or more RAID 6 sets of independent
RAID60
storage devices.
A placement policy that uses parity-based protection for storing stripes of 'n' logical blocks of
RAID6TP data and three logical blocks of independent parity across a set of 'n+3' independent storage
devices where the parity and data blocks are interleaved across the storage devices.
Version 2023.1 Published 881
Redfish Resource and Schema Guide DSP2046
6.122.6 Example response
{
"@odata.type": "#StorageController.v1_7_0.StorageController",
"Id": "1",
"Name": "NVMe IO Controller",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"SupportedControllerProtocols": [
"NVMeOverFabrics"
],
"NVMeControllerProperties": {
"NVMeVersion": "1.4",
"ControllerType": "IO",
"NVMeControllerAttributes": {
"ReportsUUIDList": false,
"SupportsSQAssociations": false,
"ReportsNamespaceGranularity": false,
"SupportsTrafficBasedKeepAlive": false,
"SupportsPredictableLatencyMode": false,
"SupportsEnduranceGroups": false,
"SupportsReadRecoveryLevels": false,
"SupportsNVMSets": false,
"SupportsExceedingPowerOfNonOperationalState": false,
"Supports128BitHostId": false
},
"NVMeSMARTCriticalWarnings": {
"PMRUnreliable": false,
"PowerBackupFailed": false,
"MediaInReadOnly": false,
"OverallSubsystemDegraded": false,
"SpareCapacityWornOut": false
}
},
"Links": {
"Endpoints": [
{
"@odata.id": "/redfish/v1/Fabrics/NVMeoF/Endpoints/Initiator1"
},
{
"@odata.id": "/redfish/v1/Fabrics/NVMeoF/Endpoints/Target1"
}
],
"AttachedVolumes": [
{
"@odata.id": "/redfish/v1/Storage/NVMeoF/Volumes/1"
},
882 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
{
"@odata.id": "/redfish/v1/Storage/NVMeoF/Volumes/3"
},
{
"@odata.id": "/redfish/v1/Storage/NVMeoF/Volumes/4"
}
]
},
"@odata.id": "/redfish/v1/Storage/NVMeoF/Controllers/1"
}
6.123 StorageControllerMetrics 1.0.0
Version v1.0
Release 2023.1
6.123.1 Description
The usage and health statistics for a storage controller.
6.123.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/
{ControllerId}/Metrics
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/Controllers/{ControllerId}/Metrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{ControllerId}/Metrics
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
Controllers/{ControllerId}/Metrics
/redfish/v1/Storage/{StorageId}/Controllers/{ControllerId}/Metrics
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{ControllerId}/Metrics
6.123.3 Properties
Property Type Attributes Notes
read-only The number of the correctable errors for the
CorrectableECCErrorCount integer
(null) lifetime of the memory of the storage controller.
Version 2023.1 Published 883
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only The number of the correctable parity errors for the
CorrectableParityErrorCount integer
(null) lifetime of the memory of the storage controller.
The NVMe SMART metrics for this storage
NVMeSMART { object
controller.
number read-only The normalized percentage of the remaining spare
AvailableSparePercent
(%) (null) capacity available.
number read-only The available spare threshold as a normalized
AvailableSpareThresholdPercent
(%) (null) percentage.
number read-only The composite temperature in degrees Celsius for
CompositeTemperatureCelsius
(Celsius) (null) this storage controller.
read-only The total time the controller is busy with I/O
ControllerBusyTimeMinutes integer
(null) commands in minutes.
The amount of time in minutes that the controller is
read-only operational and the composite temperature is
CriticalCompositeTempTimeMinutes integer
(null) greater than or equal to the critical composite
temperature threshold.
The NVMe SMART critical warnings. See the
CriticalWarnings { object StorageController schema for details on this
property.
Link to a NVMeSMARTCriticalWarnings resource.
@odata.id string read-only See the Links section and the StorageController
schema for details.
The number of 512 byte data units the host has
read-only read from the controller as part of processing a
DataUnitsRead integer
(null) SMART Data Units Read Command in units of one
thousand.
The number of 512 byte data units the host has
read-only
DataUnitsWritten integer written to the controller as part of processing a
(null)
User Data Out Command in units of one thousand.
EGCriticalWarningSummary { object The Endurance Group critical warnings summary.
An indication of whether namespaces in one or
read-only more Endurance Groups are in read-only mode not
NamespacesInReadOnlyMode boolean
(null) as a result of a change in the write protection state
of a namespace.
884 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
An indication of whether the reliability of one or
read-only more Endurance Groups is degraded due to
ReliabilityDegraded boolean
(null) significant media related errors or any internal error
that degrades the NVM subsystem reliability.
An indication of whether the available spare
read-only
SpareCapacityUnderThreshold boolean capacity of one or more Endurance Groups is below
(null)
the threshold.
read-only The number of SMART Host Read Commands
HostReadCommands integer
(null) completed by the controller.
read-only The number of User Data Out Commands
HostWriteCommands integer
(null) completed by the controller.
read-only The number of occurrences where the controller
MediaAndDataIntegrityErrors integer
(null) detected an unrecovered data integrity error.
read-only The number of error information log entries over
NumberOfErrorInformationLogEntries integer
(null) the life of the controller.
number read-only
PercentageUsed The percentage of the NVM subsystem life used.
(%) (null)
read-only
PowerCycles integer The number of power cycles.
(null)
read-only
PowerOnHours number The number of power-on hours.
(null)
array
(Celsius) The temperature sensor readings in degrees
TemperatureSensorsCelsius [ ] read-only
(number, Celsius for this storage controller.
null)
The number of seconds the controller transitioned
to lower power states or performed vendor-specific
read-only
ThermalMgmtTemp1TotalTimeSeconds integer thermal management actions while minimizing the
(null)
impact on performance in order to attempt to
reduce the composite temperature.
The number of times the controller transitioned to
lower power states or performed vendor-specific
read-only
ThermalMgmtTemp1TransitionCount integer thermal management actions while minimizing the
(null)
impact on performance in order to attempt to
reduce the composite temperature.
Version 2023.1 Published 885
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The number of seconds the controller transitioned
to lower power states or performed vendor-specific
read-only
ThermalMgmtTemp2TotalTimeSeconds integer thermal management actions regardless of the
(null)
impact on performance in order to attempt to
reduce the composite temperature.
The number of times the controller transitioned to
lower power states or performed vendor-specific
read-only
ThermalMgmtTemp2TransitionCount integer thermal management actions regardless of the
(null)
impact on performance in order to attempt to
reduce the composite temperature.
read-only
UnsafeShutdowns integer The number of unsafe shutdowns.
(null)
The amount of time in minutes that the controller is
read-only operational and the composite temperature is
WarningCompositeTempTimeMinutes integer
(null) greater than or equal to the warning composite
temperature threshold.
read-only The number of state changes for this storage
StateChangeCount integer
(null) controller.
read-only The number of the uncorrectable errors for the
UncorrectableECCErrorCount integer
(null) lifetime of the memory of the storage controller.
The number of the uncorrectable parity errors for
read-only
UncorrectableParityErrorCount integer the lifetime of the memory of the storage
(null)
controller.
6.123.4 Example response
{
"@odata.type": "#StorageControllerMetrics.v1_0_0.StorageControllerMetrics",
"Id": "Metrics",
"Name": "Storage Controller Metrics for NVMe IO Controller",
"NVMeSMART": {
"CriticalWarnings": {
"PMRUnreliable": false,
"PowerBackupFailed": false,
"MediaInReadOnly": false,
"OverallSubsystemDegraded": false,
"SpareCapacityWornOut": false
},
"CompositeTemperatureCelsius": 34,
886 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"AvailableSparePercent": 50,
"AvailableSpareThresholdPercent": 30,
"PercentageUsed": 50,
"EGCriticalWarningSummary": {
"NamespacesInReadOnlyMode": false,
"ReliabilityDegraded": false,
"SpareCapacityUnderThreshold": false
},
"DataUnitsRead": 0,
"DataUnitsWritten": 0,
"HostReadCommands": 0,
"HostWriteCommands": 0,
"ControllerBusyTimeMinutes": 20,
"PowerCycles": 49,
"PowerOnHours": 3,
"UnsafeShutdowns": 4,
"MediaAndDataIntegrityErrors": 0,
"NumberOfErrorInformationLogEntries": 100,
"WarningCompositeTempTimeMinutes": 0,
"CriticalCompositeTempTimeMinutes": 0,
"TemperatureSensorsCelsius": [
34,
34,
34,
26,
31,
35,
33,
32
],
"ThermalMgmtTemp1TransitionCount": 10,
"ThermalMgmtTemp2TransitionCount": 2,
"ThermalMgmtTemp1TotalTimeSeconds": 20,
"ThermalMgmtTemp2TotalTimeSeconds": 42
},
"@odata.id": "/redfish/v1/Systems/Sys-1/Storage/SimplestNVMeSSD/Controllers/NVMeIOController/Metrics"
}
6.124 Switch 1.9.1
Version v1.9 v1.8 v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.3 2021.4 2021.3 2021.1 2020.4 2020.3 2019.4 2019.2 2017.3 2016.2
Version 2023.1 Published 887
Redfish Resource and Schema Guide DSP2046
6.124.1 Description
The Switch schema contains properties that describe a fabric switch.
6.124.2 URIs
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}
6.124.3 Properties
Property Type Attributes Notes
read-write
AssetTag string The user-assigned asset tag for this switch.
(null)
The link to a collection of certificates for device identity and
Certificates (v1.5+) { object
attestation. Contains a link to a resource.
@odata.id string read-only Link to Collection of Certificate. See the Certificate schema for details.
CurrentBandwidthGbps number read-only
The current internal bandwidth of this switch.
(v1.4+) (Gbit/s) (null)
CXL (v1.9+) { object CXL properties for this switch.
MaxVCSsSupported The maximum number of Virtual CXL Switches (VCSs) supported in
integer read-only
(v1.9+) this switch.
TotalNumbervPPBs The total number of virtual PCI-to-PCI bridges (vPPBs) supported in
integer read-only
(v1.9+) this switch.
VCS (v1.9+) { object Virtual CXL Switch (VCS) properties for this switch.
HDMDecoders The number of Host Device Memory (HDM) Decoders supported by
integer read-only
(v1.9+) this switch.
read-only
DomainID integer The domain ID for this switch.
(null)
Enabled (v1.6+) boolean read-write An indication of whether this switch is enabled.
EnvironmentMetrics The link to the environment metrics for this switch. See the
object
(v1.6+) { EnvironmentMetrics schema for details on this property.
888 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to a EnvironmentMetrics resource. See the Links section and the
@odata.id string read-only
EnvironmentMetrics schema for details.
FirmwareVersion read-only
string The firmware version of this switch.
(v1.2+) (null)
The state of the indicator LED, which identifies the switch. For the
IndicatorLED string read-write possible property values, see IndicatorLED in Property details.
(deprecated v1.4) (enum) (null) Deprecated in v1.4 and later. This property has been deprecated in
favor of the LocationIndicatorActive property.
read-write An indication of whether the switch is in a managed or unmanaged
IsManaged boolean
(null) state.
Links { object The links to other resources that are related to this resource.
The link to the chassis that contains this switch. See the Chassis
Chassis { object
schema for details on this property.
Link to a Chassis resource. See the Links section and the Chassis
@odata.id string read-only
schema for details.
Endpoints (v1.3+) [ { array An array of links to the endpoints that connect to this switch.
Link to a Endpoint resource. See the Links section and the Endpoint
@odata.id string read-only
schema for details.
}]
ManagedBy [ { array An array of links to the managers that manage this switch.
Link to a Manager resource. See the Links section and the Manager
@odata.id string read-only
schema for details.
}]
Oem {} object See the Oem object definition in the Common properties section.
The link to the PCIe device providing this switch. See the PCIeDevice
PCIeDevice (v1.4+) { object
(null) schema for details on this property.
Link to a PCIeDevice resource. See the Links section and the
@odata.id string read-only
PCIeDevice schema for details.
Version 2023.1 Published 889
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Location (v1.1+) {} object The location of the switch. For property details, see Location.
LocationIndicatorActive read-write
boolean An indicator allowing an operator to physically locate this resource.
(v1.4+) (null)
The link to the collection of log services associated with this switch.
LogServices { object
Contains a link to a resource.
Link to Collection of LogService. See the LogService schema for
@odata.id string read-only
details.
read-only
Manufacturer string The manufacturer of this switch.
(null)
MaxBandwidthGbps number read-only The maximum internal bandwidth of this switch as currently
(v1.4+) (Gbit/s) (null) configured.
An array of DSP0274-defined measurement blocks. Deprecated in
Measurements (v1.5+,
array v1.8 and later. This property has been deprecated in favor of the
deprecated v1.8 [ {
ComponentIntegrity resource.
Link to a MeasurementBlock resource. See the Links section and the
@odata.id string read-only
SoftwareInventory schema for details.
}]
The link to the metrics associated with this switch. See the
Metrics (v1.7+) { object
SwitchMetrics schema for details on this property.
Link to a SwitchMetrics resource. See the Links section and the
@odata.id string read-only
SwitchMetrics schema for details.
read-only
Model string The product model number of this switch.
(null)
read-only
PartNumber string The part number for this switch.
(null)
The link to the collection ports for this switch. Contains a link to a
Ports { object
resource.
@odata.id string read-only Link to Collection of Port. See the Port schema for details.
string read-only The current power state of the switch. For the possible property
PowerState
(enum) (null) values, see PowerState in Property details.
890 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
array Redundancy information for the switches. For property details, see
Redundancy [ { } ]
(object) Redundancy.
read-only
SerialNumber string The serial number for this switch.
(null)
read-only
SKU string The SKU for this switch.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
array
SupportedProtocols The protocols this switch supports. For the possible property values,
(string read-only
(v1.3+) [ ] see SupportedProtocols in Property details.
(enum))
string read-only The protocol being sent over this switch. For the possible property
SwitchType
(enum) (null) values, see SwitchType in Property details.
read-only The total number of lanes, phys, or other physical transport links that
TotalSwitchWidth integer
(null) this switch contains.
string read-only
UUID (v1.3+) The UUID for this switch.
(uuid) (null)
6.124.4 Actions
6.124.4.1 Reset
Description
This action resets this switch.
Action URI
{Base URI of target resource}/Actions/Switch.Reset
Action parameters
Parameter
Type Attributes Notes
Name
string The type of reset. For the possible property values, see ResetType in Property
ResetType optional
(enum) details.
Version 2023.1 Published 891
Redfish Resource and Schema Guide DSP2046
Request Example
{
"ResetType": "ForceRestart"
}
6.124.5 Property details
6.124.5.1 IndicatorLED
The state of the indicator LED, which identifies the switch.
string Description
Blinking The indicator LED is blinking.
Lit The indicator LED is lit.
Off The indicator LED is off.
6.124.5.2 PowerState
The current power state of the switch.
string Description
The resource is powered off. The components within the resource might continue to have
Off
AUX power.
On The resource is powered on.
Paused The resource is paused.
A temporary state between on and off. The components within the resource can take time to
PoweringOff
process the power off action.
A temporary state between off and on. The components within the resource can take time to
PoweringOn
process the power on action.
6.124.5.3 ResetType
The type of reset.
892 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
ForceOn Turn on the unit immediately.
ForceRestart Shut down immediately and non-gracefully and restart the system.
GracefulRestart Shut down gracefully and restart the system.
GracefulShutdown Shut down gracefully and power off.
Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal
Nmi
operations, complete diagnostic actions, and, typically, halt the system.
On Turn on the unit.
Pause execution on the unit but do not remove power. This is typically a feature of virtual
Pause
machine hypervisors.
Power cycle the unit. Behaves like a full power removal, followed by a power restore to the
PowerCycle
resource.
PushPowerButton Simulate the pressing of the physical power button on this unit.
Resume execution on the paused unit. This is typically a feature of virtual machine
Resume
hypervisors.
Write the state of the unit to disk before powering off. This allows for the state to be restored
Suspend
when powered back on.
6.124.5.4 SupportedProtocols
The protocols this switch supports.
string Description
AHCI Advanced Host Controller Interface (AHCI).
CXL Compute Express Link.
DisplayPort DisplayPort.
DVI DVI.
Ethernet Ethernet.
FC Fibre Channel.
FCoE Fibre Channel over Ethernet (FCoE).
Version 2023.1 Published 893
Redfish Resource and Schema Guide DSP2046
string Description
FCP Fibre Channel Protocol for SCSI.
FICON FIbre CONnection (FICON).
FTP File Transfer Protocol (FTP).
GenZ GenZ.
HDMI HDMI.
HTTP Hypertext Transport Protocol (HTTP).
HTTPS Hypertext Transfer Protocol Secure (HTTPS).
I2C Inter-Integrated Circuit Bus.
InfiniBand InfiniBand.
iSCSI Internet SCSI.
iWARP Internet Wide Area RDMA Protocol (iWARP).
MultiProtocol Multiple Protocols.
NFSv3 Network File System (NFS) version 3.
NFSv4 Network File System (NFS) version 4.
NVLink NVLink.
NVMe Non-Volatile Memory Express (NVMe).
NVMeOverFabrics NVMe over Fabrics.
OEM OEM-specific.
PCIe PCI Express.
RoCE RDMA over Converged Ethernet Protocol.
RoCEv2 RDMA over Converged Ethernet Protocol Version 2.
SAS Serial Attached SCSI.
SATA Serial AT Attachment.
SFTP SSH File Transfer Protocol (SFTP).
SMB Server Message Block (SMB). Also known as the Common Internet File System (CIFS).
TCP Transmission Control Protocol (TCP).
894 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
TFTP Trivial File Transfer Protocol (TFTP).
UDP User Datagram Protocol (UDP).
UHCI Universal Host Controller Interface (UHCI).
USB Universal Serial Bus (USB).
VGA VGA.
6.124.5.5 SwitchType
The protocol being sent over this switch.
string Description
AHCI Advanced Host Controller Interface (AHCI).
CXL Compute Express Link.
DisplayPort DisplayPort.
DVI DVI.
Ethernet Ethernet.
FC Fibre Channel.
FCoE Fibre Channel over Ethernet (FCoE).
FCP Fibre Channel Protocol for SCSI.
FICON FIbre CONnection (FICON).
FTP File Transfer Protocol (FTP).
GenZ GenZ.
HDMI HDMI.
HTTP Hypertext Transport Protocol (HTTP).
HTTPS Hypertext Transfer Protocol Secure (HTTPS).
I2C Inter-Integrated Circuit Bus.
InfiniBand InfiniBand.
iSCSI Internet SCSI.
Version 2023.1 Published 895
Redfish Resource and Schema Guide DSP2046
string Description
iWARP Internet Wide Area RDMA Protocol (iWARP).
MultiProtocol Multiple Protocols.
NFSv3 Network File System (NFS) version 3.
NFSv4 Network File System (NFS) version 4.
NVLink NVLink.
NVMe Non-Volatile Memory Express (NVMe).
NVMeOverFabrics NVMe over Fabrics.
OEM OEM-specific.
PCIe PCI Express.
RoCE RDMA over Converged Ethernet Protocol.
RoCEv2 RDMA over Converged Ethernet Protocol Version 2.
SAS Serial Attached SCSI.
SATA Serial AT Attachment.
SFTP SSH File Transfer Protocol (SFTP).
SMB Server Message Block (SMB). Also known as the Common Internet File System (CIFS).
TCP Transmission Control Protocol (TCP).
TFTP Trivial File Transfer Protocol (TFTP).
UDP User Datagram Protocol (UDP).
UHCI Universal Host Controller Interface (UHCI).
USB Universal Serial Bus (USB).
VGA VGA.
6.124.6 Example response
{
"@odata.type": "#Switch.v1_9_1.Switch",
"Id": "Switch1",
"Name": "SAS Switch",
896 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"SwitchType": "SAS",
"Manufacturer": "Contoso",
"Model": "SAS1000",
"SKU": "67B",
"SerialNumber": "2M220100SL",
"PartNumber": "76-88883",
"Ports": {
"@odata.id": "/redfish/v1/Fabrics/SAS/Switches/Switch1/Ports"
},
"Redundancy": [
{
"@odata.id": "/redfish/v1/Fabrics/SAS/Switches/Switch1#/Redundancy/0",
"MemberId": "Redundancy",
"Mode": "Sharing",
"MaxNumSupported": 2,
"MinNumNeeded": 1,
"Status": {
"State": "Enabled",
"Health": "OK"
},
"RedundancySet": [
{
"@odata.id": "/redfish/v1/Fabrics/SAS/Switches/Switch1"
},
{
"@odata.id": "/redfish/v1/Fabrics/SAS/Switches/Switch2"
}
]
}
],
"Links": {
"Chassis": {
"@odata.id": "/redfish/v1/Chassis/Switch1"
},
"ManagedBy": [
{
"@odata.id": "/redfish/v1/Managers/Switch1"
},
{
"@odata.id": "/redfish/v1/Managers/Switch2"
}
]
},
"Actions": {
"#Switch.Reset": {
"target": "/redfish/v1/Fabrics/SAS/Switches/Switch1/Actions/Switch.Reset",
"[email protected]": [
"ForceRestart",
"GracefulRestart"
]
Version 2023.1 Published 897
Redfish Resource and Schema Guide DSP2046
}
},
"@odata.id": "/redfish/v1/Fabrics/SAS/Switches/Switch1"
}
6.125 SwitchMetrics 1.0.0
Version v1.0
Release 2021.3
6.125.1 Description
The SwitchMetrics schema contains usage and health statistics for a switch device.
6.125.2 URIs
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/SwitchMetrics
6.125.3 Properties
Property Type Attributes Notes
InternalMemoryMetrics { object The memory metrics for a switch.
CurrentPeriod { object The memory metrics since the last reset for this switch.
read-only The number of the correctable errors of memory since
CorrectableECCErrorCount integer
(null) reset.
read-only The number of the uncorrectable errors of memory since
UncorrectableECCErrorCount integer
(null) reset.
LifeTime { object The memory metrics for the lifetime of this switch.
read-only The number of the correctable errors for the lifetime of the
CorrectableECCErrorCount integer
(null) memory.
read-only The number of the uncorrectable errors for the lifetime of
UncorrectableECCErrorCount integer
(null) the memory.
898 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
PCIeErrors { object The PCIe errors associated with this switch.
read-only The total number of the PCIe correctable errors for this
CorrectableErrorCount (v1.8+) integer
(null) device.
read-only
FatalErrorCount (v1.8+) integer The total number of the PCIe fatal errors for this device.
(null)
read-only The total number of times the PCIe link states transitioned
L0ToRecoveryCount (v1.8+) integer
(null) from L0 to the recovery state for this device.
read-only The total number of NAKs issued on the PCIe link by the
NAKReceivedCount (v1.8+) integer
(null) receiver.
read-only The total number of NAKs issued on the PCIe link by this
NAKSentCount (v1.8+) integer
(null) device.
read-only The total number of the PCIe non-fatal errors for this
NonFatalErrorCount (v1.8+) integer
(null) device.
read-only
ReplayCount (v1.8+) integer The total number of the PCIe replays issued by this device.
(null)
read-only The total number of the PCIe replay rollovers issued by
ReplayRolloverCount (v1.8+) integer
(null) this device.
6.125.4 Actions
6.125.4.1 ClearCurrentPeriod
Description
This action sets the CurrentPeriod property's values to 0.
Action URI
{Base URI of target resource}/Actions/SwitchMetrics.ClearCurrentPeriod
Action parameters
This action takes no parameters.
Version 2023.1 Published 899
Redfish Resource and Schema Guide DSP2046
6.125.5 Example response
{
"@odata.type": "#SwitchMetrics.v1_0_0.SwitchMetrics",
"Id": "SwitchMetrics",
"Name": "PCIe Switch Metrics",
"PCIeErrors": {
"CorrectableErrorCount": 0,
"NonFatalErrorCount": 0,
"FatalErrorCount": 0,
"L0ToRecoveryCount": 0,
"ReplayCount": 0,
"ReplayRolloverCount": 0,
"NAKSentCount": 0,
"NAKReceivedCount": 0
},
"InternalMemoryMetrics": {
"CurrentPeriod": {
"CorrectableECCErrorCount": 0,
"UncorrectableECCErrorCount": 0
},
"LifeTime": {
"CorrectableECCErrorCount": 0,
"UncorrectableECCErrorCount": 0
}
},
"@odata.id": "/redfish/v1/Fabrics/PCIe/Switches/1/SwitchMetrics"
}
6.126 Task 1.7.1
Version v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.3 2022.1 2020.3 2018.3 2018.2 2018.1 2017.1 1.0
6.126.1 Description
The Task schema contains information about a task that the Redfish task service schedules or
executes. Tasks represent operations that take more time than a client typically wants to wait.
900 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.126.2 URIs
/redfish/v1/TaskService/Tasks/{TaskId}
/redfish/v1/TaskService/Tasks/{TaskId}/SubTasks/{TaskId2}
6.126.3 Properties
Property Type Attributes Notes
string The date and time when the task was completed. This property will only
EndTime read-only
(date-time) appear when the task is complete.
EstimatedDuration string read-only
The estimated total time required to complete the task.
(v1.6+) (duration) (null)
An indication of whether the contents of the payload are hidden from
view after the task has been created. If true , responses do not return
HidePayload (v1.3+) boolean read-only
the payload. If false , responses return the payload. If this property is
not present when the task is created, the default is false .
Links (v1.7+) { object Contains references to other resources that are related to this resource.
CreatedResources An array of URIs referencing the resources created as the result of the
array
(v1.7+) [ { operation that produced this task.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
Oem {} object See the Oem object definition in the Common properties section.
array An array of messages associated with the task. For property details, see
Messages [ { } ]
(object) Message.
The HTTP and JSON request payload details for this task, unless they
Payload (v1.3+) { object
are hidden from view by the service.
HttpHeaders array
read-only An array of HTTP headers that this task includes.
(v1.3+) [ ] (string)
HttpOperation
string read-only The HTTP operation to perform to execute this task.
(v1.3+)
JsonBody (v1.3+) string read-only The JSON payload to use in the execution of this task.
Version 2023.1 Published 901
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
string
TargetUri (v1.3+) read-only The URI of the target for this task.
(URI)
PercentComplete integer read-only
The completion percentage of this task.
(v1.4+) (%) (null)
string
StartTime read-only The date and time when the task was started.
(date-time)
The link to a collection of sub-tasks for this task. Contains a link to a
SubTasks (v1.5+) { object
resource.
@odata.id string read-only Link to Collection of Task. See the Task schema for details.
string
TaskMonitor (v1.2+) read-only The URI of the Task Monitor for this task.
(URI)
string The state of the task. For the possible property values, see TaskState in
TaskState read-only
(enum) Property details.
string The completion status of the task. For the possible property values, see
TaskStatus read-only
(enum) TaskStatus in Property details.
6.126.4 Property details
6.126.4.1 TaskState
The state of the task.
string Description
Cancelled (v1.2+) Task has been cancelled by an operator or internal process.
Cancelling (v1.2+) Task is in the process of being cancelled.
Completed Task was completed.
Exception Task has stopped due to an exception condition.
Interrupted Task has been interrupted.
Task was terminated. Deprecated in v1.2 and later. This value has been deprecated and is
Killed (deprecated v1.2)
being replaced by the Cancelled value, which has more determinate semantics.
902 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
New A new task.
Pending Task is pending and has not started.
Running Task is running normally.
Service Task is running as a service.
Starting Task is starting.
Stopping Task is in the process of stopping.
Suspended Task has been suspended.
6.126.4.2 TaskStatus
The completion status of the task.
string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.
6.126.5 Example response
{
"@odata.type": "#Task.v1_7_1.Task",
"Id": "545",
"Name": "Task 545",
"TaskMonitor": "/taskmon/545",
"TaskState": "Completed",
"StartTime": "2012-03-07T14:44+06:00",
"EndTime": "2012-03-07T14:45+06:00",
"TaskStatus": "OK",
"Messages": [
{
"MessageId": "Base.1.0.PropertyNotWritable",
"RelatedProperties": [
"SKU"
],
"Message": "The property SKU is a read only property and cannot be assigned a value",
Version 2023.1 Published 903
Redfish Resource and Schema Guide DSP2046
"MessageArgs": [
"SKU"
],
"Severity": "Warning"
}
],
"@odata.id": "/redfish/v1/TaskService/Tasks/545"
}
6.127 TaskService 1.2.0
Version v1.2 v1.1 v1.0
Release 2021.1 2017.1 1.0
6.127.1 Description
The TaskService schema describes a task service that enables management of long-duration
operations, includes the properties for the task service itself, and has links to the resource collection of
tasks.
6.127.2 URIs
/redfish/v1/TaskService
6.127.3 Properties
Property Type Attributes Notes
The overwrite policy for completed tasks. This property
string indicates if the task service overwrites completed task
CompletedTaskOverWritePolicy read-only
(enum) information. For the possible property values, see
CompletedTaskOverWritePolicy in Property details.
string
read-only The current date and time, with UTC offset, setting that the
DateTime (date-
(null) task service uses.
time)
An indication of whether a task state change sends an
LifeCycleEventOnTaskStateChange boolean read-only
event.
904 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write
ServiceEnabled boolean An indication of whether this service is enabled.
(null)
The status and health of the resource and its subordinate
Status {} object
or dependent resources. For property details, see Status.
TaskAutoDeleteTimeoutMinutes The number of minutes after which a completed task is
integer read-write
(v1.2+) deleted by the service.
The links to the collection of tasks. Contains a link to a
Tasks { object
resource.
@odata.id string read-only Link to Collection of Task. See the Task schema for details.
6.127.4 Property details
6.127.4.1 CompletedTaskOverWritePolicy
The overwrite policy for completed tasks. This property indicates if the task service overwrites
completed task information.
string Description
Manual Completed tasks are not automatically overwritten.
Oldest Oldest completed tasks are overwritten.
6.127.5 Example response
{
"@odata.type": "#TaskService.v1_2_0.TaskService",
"Id": "TaskService",
"Name": "Tasks Service",
"DateTime": "2015-03-13T04:14:33+06:00",
"CompletedTaskOverWritePolicy": "Manual",
"LifeCycleEventOnTaskStateChange": true,
"Status": {
"State": "Enabled",
"Health": "OK"
},
"ServiceEnabled": true,
Version 2023.1 Published 905
Redfish Resource and Schema Guide DSP2046
"Tasks": {
"@odata.id": "/redfish/v1/TaskService/Tasks"
},
"@odata.id": "/redfish/v1/TaskService"
}
6.128 TelemetryService 1.3.2
Version v1.3 v1.2 v1.1 v1.0
Release 2020.4 2019.4 2018.3 2018.2
6.128.1 Description
The TelemetryService schema describes a telemetry service. The telemetry service is used to for
collecting and reporting metric data within the Redfish Service.
6.128.2 URIs
/redfish/v1/TelemetryService
6.128.3 Properties
Property Type Attributes Notes
The link to a log service that the telemetry service uses. This
service can be a dedicated log service or a pointer a log service
LogService { object
under another resource, such as a manager. See the LogService
schema for details on this property.
Link to a LogService resource. See the Links section and the
@odata.id string read-only
LogService schema for details.
read-only The maximum number of metric reports that this service
MaxReports integer
(null) supports.
The link to the collection of metric definitions. Contains a link to
MetricDefinitions { object
a resource.
906 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to Collection of MetricDefinition. See the MetricDefinition
@odata.id string read-only
schema for details.
The link to the collection of metric report definitions. Contains a
MetricReportDefinitions { object
link to a resource.
Link to Collection of MetricReportDefinition. See the
@odata.id string read-only
MetricReportDefinition schema for details.
The link to the collection of metric reports. Contains a link to a
MetricReports { object
resource.
Link to Collection of MetricReport. See the MetricReport schema
@odata.id string read-only
for details.
string read-only The minimum time interval between gathering metric data that
MinCollectionInterval
(duration) (null) this service allows.
read-write
ServiceEnabled (v1.2+) boolean An indication of whether this service is enabled.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
array The functions that can be performed over each metric. For the
SupportedCollectionFunctions read-only
(string possible property values, see SupportedCollectionFunctions in
[] (null)
(enum)) Property details.
The link to the collection of triggers that apply to metrics.
Triggers { object
Contains a link to a resource.
Link to Collection of Triggers. See the Triggers schema for
@odata.id string read-only
details.
6.128.4 Actions
6.128.4.1 ClearMetricReports (v1.3+)
Description
The action to clear the metric reports for this telemetry service.
Version 2023.1 Published 907
Redfish Resource and Schema Guide DSP2046
Action URI
{Base URI of target resource}/Actions/TelemetryService.ClearMetricReports
Action parameters
This action takes no parameters.
6.128.4.2 ResetMetricReportDefinitionsToDefaults (v1.3+)
Description
The action to reset the metric report definitions to factory defaults.
Action URI
{Base URI of target resource}/Actions/TelemetryService.ResetMetricReportDefinitionsToDefaults
Action parameters
This action takes no parameters.
6.128.4.3 ResetTriggersToDefaults (v1.3+)
Description
The action to reset the triggers to factory defaults.
Action URI
{Base URI of target resource}/Actions/TelemetryService.ResetTriggersToDefaults
Action parameters
This action takes no parameters.
6.128.4.4 SubmitTestMetricReport
Description
This action generates a metric report.
Action URI
{Base URI of target resource}/Actions/TelemetryService.SubmitTestMetricReport
908 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Action parameters
Parameter Name Type Attributes Notes
GeneratedMetricReportValues The content of the MetricReportValues in the generated
array required
(v1.1+) [ { metric report.
The link to the metric definition for this metric. See the
MetricDefinition (v1.1+) { object
MetricDefinition schema for details on this property.
Link to a MetricDefinition resource. See the Links section
@odata.id string read-only
and the MetricDefinition schema for details.
read-only
MetricId (v1.1+) string The metric definitions identifier for this metric.
(null)
string read-only
MetricProperty (v1.1+) The URI for the property from which this metric is derived.
(URI) (null)
read-only
MetricValue (v1.1+) string The metric value, as a string.
(null)
The date and time when the metric is obtained. A
string
read-only management application can establish a time series of
Timestamp (v1.1+) (date-
(null) metric data by retrieving the instances of metric value and
time)
sorting them according to their timestamp.
}]
MetricReportName string required The name of the metric report in generated metric report.
The contents of MetricReportValues array in the generated
MetricReportValues metric report. Deprecated in v1.1 and later. This property
string optional
(deprecated v1.1) has been deprecated in favor of using the property
'GeneratedMetricReportValues'.
Request Example
{
"MetricReportName": "TestMetricReport",
"GeneratedMetricReportValues": [
{
"MetricId": "AverageReadingCelsius",
"MetricValue": "50",
"Timestamp": "2020-12-06T12:00:00Z",
"MetricProperty": "/redfish/v1/Chassis/Tray_1/Thermal#/Temperatures/0/ReadingCelsius",
"MetricDefinition": {
"@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/AverageReadingCelsius"
Version 2023.1 Published 909
Redfish Resource and Schema Guide DSP2046
}
},
{
"MetricId": "AverageReadingCelsius",
"MetricValue": "53",
"Timestamp": "2020-12-06T12:00:01Z",
"MetricProperty": "/redfish/v1/Chassis/Tray_1/Thermal#/Temperatures/0/ReadingCelsius",
"MetricDefinition": {
"@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions/AverageReadingCelsius"
}
}
]
}
6.128.5 Property details
6.128.5.1 SupportedCollectionFunctions
The functions that can be performed over each metric.
string Description
Average An averaging function.
Maximum A maximum function.
Minimum A minimum function.
Summation A summation function.
6.128.6 Example response
{
"@odata.type": "#TelemetryService.v1_3_2.TelemetryService",
"Id": "TelemetryService",
"Name": "Telemetry Service",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"SupportedCollectionFunctions": [
"Average",
"Minimum",
"Maximum"
910 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
],
"MetricDefinitions": {
"@odata.id": "/redfish/v1/TelemetryService/MetricDefinitions"
},
"MetricReportDefinitions": {
"@odata.id": "/redfish/v1/TelemetryService/MetricReportDefinitions"
},
"MetricReports": {
"@odata.id": "/redfish/v1/TelemetryService/MetricReports"
},
"Triggers": {
"@odata.id": "/redfish/v1/TelemetryService/Triggers"
},
"LogService": {
"@odata.id": "/redfish/v1/Managers/1/LogServices/Log1"
},
"@odata.id": "/redfish/v1/TelemetryService"
}
6.129 Thermal 1.7.1 (deprecated)
Version v1.7 Deprecated v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2020.4 2019.4 2018.2 2017.3 2017.1 2016.3 2016.1 1.0
This schema has been deprecated and use in new implementations is discouraged except to retain
compatibility with existing products. This schema has been deprecated in favor of the
ThermalSubsystem schema.
6.129.1 Description
The Thermal schema describes temperature monitoring and thermal management subsystems, such
as cooling fans, for a computer system or similar devices contained within a chassis.
6.129.2 URIs
/redfish/v1/Chassis/{ChassisId}/Thermal
Version 2023.1 Published 911
Redfish Resource and Schema Guide DSP2046
6.129.3 Properties
Property Type Attributes Notes
Fans [ { array The set of fans for this chassis.
string read-only
@odata.id The unique identifier for a resource.
(URI) required
Actions (v1.3+) {} object The available actions for this resource.
The link to the assembly associated with this fan.
Assembly (v1.4+) { object See the Assembly schema for details on this
property.
Link to a Assembly resource. See the Links section
@odata.id string read-only
and the Assembly schema for details.
The name of the fan. Deprecated in v1.1 and later.
read-only
FanName (deprecated v1.1) string This property has been deprecated in favor of the
(null)
Name property.
read-only An indication of whether this device can be inserted
HotPluggable (v1.4+) boolean
(null) or removed while the equipment is in operation.
The state of the indicator LED, which identifies this
string read-write
IndicatorLED (v1.2+) fan. For the possible property values, see
(enum) (null)
IndicatorLED in Property details.
The location of the fan. For property details, see
Location (v1.4+) {} object
Location.
read-only The value at which the reading is below normal
LowerThresholdCritical integer
(null) range but not yet fatal.
read-only The value at which the reading is below normal
LowerThresholdFatal integer
(null) range and fatal.
read-only The value at which the reading is below normal
LowerThresholdNonCritical integer
(null) range.
read-only
Manufacturer (v1.2+) string The manufacturer of this fan.
(null)
read-only
MaxReadingRange integer Maximum value for this sensor.
(null)
read-only
MemberId string The identifier for the member within the collection.
required
912 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only
MinReadingRange integer Minimum value for this sensor.
(null)
read-only
Model (v1.2+) string The model number for this fan.
(null)
read-only
Name (v1.1+) string Name of the fan.
(null)
See the Oem object definition in the Common
Oem {} object
properties section.
read-only
PartNumber (v1.2+) string The part number for this fan.
(null)
The area or device associated with this fan. For the
string
PhysicalContext read-only possible property values, see PhysicalContext in
(enum)
Property details.
read-only
Reading integer The fan speed.
(null)
The units in which the fan reading and thresholds
string read-only
ReadingUnits (v1.0.1+) are measured. For the possible property values, see
(enum) (null)
ReadingUnits in Property details.
array The set of redundancy groups for this fan. For
Redundancy [ { } ]
(object) property details, see Redundancy.
An array of links to resources or objects that this fan
RelatedItem [ { array
services.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
read-only
SensorNumber (v1.5+) integer The numerical identifier for this fan speed sensor.
(null)
read-only
SerialNumber (v1.2+) string The serial number for this fan.
(null)
read-only
SparePartNumber (v1.2+) string The spare part number for this fan.
(null)
The status and health of the resource and its
Status {} object subordinate or dependent resources. For property
details, see Status.
Version 2023.1 Published 913
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-only The value at which the reading is above normal
UpperThresholdCritical integer
(null) range but not yet fatal.
read-only The value at which the reading is above normal
UpperThresholdFatal integer
(null) range and fatal.
read-only The value at which the reading is above normal
UpperThresholdNonCritical integer
(null) range.
}]
array The redundancy information for the set of fans in
Redundancy [ { } ]
(object) this chassis. For property details, see Redundancy.
The status and health of the resource and its
Status {} object subordinate or dependent resources. For property
details, see Status.
Temperatures [ { array The set of temperature sensors for this chassis.
string read-only
@odata.id The unique identifier for a resource.
(URI) required
Actions (v1.3+) {} object The available actions for this resource.
Adjusted maximum allowable operating
AdjustedMaxAllowableOperatingValue integer read-only
temperature for this equipment based on the
(v1.4+) (Celsius) (null)
current environmental conditions present.
Adjusted minimum allowable operating temperature
AdjustedMinAllowableOperatingValue integer read-only
for this equipment based on the current
(v1.4+) (Celsius) (null)
environmental conditions present.
The area or device to which the DeltaReadingCelsius
string temperature measurement applies, relative to
DeltaPhysicalContext (v1.4+) read-only
(enum) PhysicalContext. For the possible property values,
see DeltaPhysicalContext in Property details.
number read-only
DeltaReadingCelsius (v1.4+) The delta temperature reading.
(Celsius) (null)
number read-only The value at which the reading is below normal
LowerThresholdCritical
(Celsius) (null) range but not yet fatal.
number read-only The value at which the reading is below normal
LowerThresholdFatal
(Celsius) (null) range and fatal.
number read-only The value at which the reading is below normal
LowerThresholdNonCritical
(Celsius) (null) range.
914 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
integer read-write The value at which the reading is below the user-
LowerThresholdUser (v1.6+)
(Celsius) (null) defined range.
integer read-only Maximum allowable operating temperature for this
MaxAllowableOperatingValue (v1.4+)
(Celsius) (null) equipment.
number read-only
MaxReadingRangeTemp Maximum value for this sensor.
(Celsius) (null)
read-only
MemberId string The identifier for the member within the collection.
required
integer read-only Minimum allowable operating temperature for this
MinAllowableOperatingValue (v1.4+)
(Celsius) (null) equipment.
number read-only
MinReadingRangeTemp Minimum value for this sensor.
(Celsius) (null)
read-only
Name string The temperature sensor name.
(null)
See the Oem object definition in the Common
Oem {} object
properties section.
The area or device to which this temperature
string
PhysicalContext read-only measurement applies. For the possible property
(enum)
values, see PhysicalContext in Property details.
number read-only
ReadingCelsius The temperature in degrees Celsius.
(Celsius) (null)
An array of links to resources or objects that
RelatedItem [ { array represent areas or devices to which this
temperature applies.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
read-only
SensorNumber integer The numerical identifier of the temperature sensor.
(null)
The status and health of the resource and its
Status {} object subordinate or dependent resources. For property
details, see Status.
number read-only The value at which the reading is above normal
UpperThresholdCritical
(Celsius) (null) range but not yet fatal.
Version 2023.1 Published 915
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
number read-only The value at which the reading is above normal
UpperThresholdFatal
(Celsius) (null) range and fatal.
number read-only The value at which the reading is above normal
UpperThresholdNonCritical
(Celsius) (null) range.
integer read-write The value at which the reading is above the user-
UpperThresholdUser (v1.6+)
(Celsius) (null) defined range.
}]
6.129.4 Property details
6.129.4.1 DeltaPhysicalContext
The area or device to which the DeltaReadingCelsius temperature measurement applies, relative to
PhysicalContext.
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
916 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
GPU A graphics processor (GPU).
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
StorageBay Within a storage bay.
Version 2023.1 Published 917
Redfish Resource and Schema Guide DSP2046
string Description
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
6.129.4.2 IndicatorLED
The state of the indicator LED, which identifies this fan.
string Description
Blinking The indicator LED is blinking.
Lit The indicator LED is lit.
Off The indicator LED is off.
6.129.4.3 PhysicalContext
The area or device associated with this fan.
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
918 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
GPU A graphics processor (GPU).
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
Version 2023.1 Published 919
Redfish Resource and Schema Guide DSP2046
string Description
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
StorageBay Within a storage bay.
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
6.129.4.4 ReadingUnits
The units in which the fan reading and thresholds are measured.
string Description
Percent The fan reading and thresholds are measured as a percentage.
RPM The fan reading and thresholds are measured in revolutions per minute.
6.129.5 Example response
{
"@odata.type": "#Thermal.v1_7_1.Thermal",
"Id": "Thermal",
"Name": "Thermal",
"Temperatures": [
920 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
{
"@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Temperatures/0",
"MemberId": "0",
"Name": "CPU1 Temp",
"SensorNumber": 5,
"Status": {
"State": "Enabled",
"Health": "OK"
},
"ReadingCelsius": 41,
"UpperThresholdNonCritical": 42,
"UpperThresholdCritical": 45,
"UpperThresholdFatal": 48,
"MinReadingRangeTemp": 0,
"MaxReadingRangeTemp": 60,
"PhysicalContext": "CPU",
"RelatedItem": [
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Processors/CPU1"
}
]
},
{
"@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Temperatures/1",
"MemberId": "1",
"Name": "CPU2 Temp",
"SensorNumber": 6,
"Status": {
"State": "Disabled"
},
"UpperThresholdNonCritical": 42,
"UpperThresholdCritical": 45,
"UpperThresholdFatal": 48,
"MinReadingRangeTemp": 0,
"MaxReadingRangeTemp": 60,
"PhysicalContext": "CPU",
"RelatedItem": [
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Processors/CPU2"
}
]
},
{
"@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Temperatures/2",
"MemberId": "2",
"Name": "Chassis Intake Temp",
"SensorNumber": 9,
"Status": {
"State": "Enabled",
"Health": "OK"
Version 2023.1 Published 921
Redfish Resource and Schema Guide DSP2046
},
"ReadingCelsius": 25,
"UpperThresholdUser": 28,
"UpperThresholdNonCritical": 30,
"UpperThresholdCritical": 40,
"UpperThresholdFatal": 50,
"LowerThresholdUser": 20,
"LowerThresholdNonCritical": 10,
"LowerThresholdCritical": 5,
"LowerThresholdFatal": 0,
"MinReadingRangeTemp": 0,
"MaxReadingRangeTemp": 60,
"PhysicalContext": "Intake",
"RelatedItem": [
{
"@odata.id": "/redfish/v1/Chassis/1U"
},
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2"
}
]
}
],
"Fans": [
{
"@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Fans/0",
"MemberId": "0",
"Name": "BaseBoard System Fan",
"PhysicalContext": "Backplane",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Reading": 2100,
"ReadingUnits": "RPM",
"LowerThresholdFatal": 0,
"MinReadingRange": 0,
"MaxReadingRange": 5000,
"Redundancy": [
{
"@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Redundancy/0"
}
],
"RelatedItem": [
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2"
},
{
"@odata.id": "/redfish/v1/Chassis/1U"
}
922 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
]
},
{
"@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Fans/1",
"MemberId": "1",
"Name": "BaseBoard System Fan Backup",
"PhysicalContext": "Backplane",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Reading": 2050,
"ReadingUnits": "RPM",
"LowerThresholdFatal": 0,
"MinReadingRange": 0,
"MaxReadingRange": 5000,
"Redundancy": [
{
"@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Redundancy/0"
}
],
"RelatedItem": [
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2"
},
{
"@odata.id": "/redfish/v1/Chassis/1U"
}
]
}
],
"Redundancy": [
{
"@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Redundancy/0",
"MemberId": "0",
"Name": "BaseBoard System Fans",
"RedundancySet": [
{
"@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Fans/0"
},
{
"@odata.id": "/redfish/v1/Chassis/1U/Thermal#/Fans/1"
}
],
"Mode": "N+m",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"MinNumNeeded": 1,
Version 2023.1 Published 923
Redfish Resource and Schema Guide DSP2046
"MaxNumSupported": 2
}
],
"@odata.id": "/redfish/v1/Chassis/1U/Thermal"
}
6.130 ThermalEquipment 1.0.0
Version v1.0
Release 2023.1
6.130.1 Description
This is the schema definition for the set of cooling equipment.
6.130.2 URIs
/redfish/v1/ThermalEquipment
6.130.3 Properties
Property Type Attributes Notes
A link to a collection of cooling distribution units. Contains a link to a
CDUs { object
resource.
@odata.id string read-only Link to Collection of CoolingUnit. See the CoolingUnit schema for details.
CoolingLoops { object A link to a collection of cooling loops. Contains a link to a resource.
@odata.id string read-only Link to Collection of CoolingLoop. See the CoolingLoop schema for details.
HeatExchangers
object A link to a collection of heat exchanger units. Contains a link to a resource.
{
@odata.id string read-only Link to Collection of CoolingUnit. See the CoolingUnit schema for details.
924 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
ImmersionUnits A link to a collection of immersion cooling units. Contains a link to a
object
{ resource.
@odata.id string read-only Link to Collection of CoolingUnit. See the CoolingUnit schema for details.
The status and health of the resource and its subordinate or dependent
Status {} object
resources. For property details, see Status.
6.130.4 Example response
{
"@odata.type": "#ThermalEquipment.v1_0_0.ThermalEquipment",
"Id": "ThermalEquipment",
"Name": "Cooling Equipment",
"Status": {
"State": "Enabled",
"HealthRollup": "OK"
},
"CDUs": {
"@odata.id": "/redfish/v1/ThermalEquipment/CDUs"
},
"CoolingLoops": {
"@odata.id": "/redfish/v1/ThermalEquipment/CoolingLoops"
},
"@odata.id": "/redfish/v1/ThermalEquipment"
}
6.131 ThermalMetrics 1.2.0
Version v1.2 v1.1 v1.0
Release 2023.1 2022.3 2020.4
6.131.1 Description
The ThermalMetrics schema represents the thermal metrics of a chassis.
Version 2023.1 Published 925
Redfish Resource and Schema Guide DSP2046
6.131.2 URIs
/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/ThermalMetrics
6.131.3 Properties
Property Type Attributes Notes
The air flow through the chassis (m^3/min). For
AirFlowCubicMetersPerMinute (v1.2+) {} object more information about this property, see
SensorExcerpt in Property Details.
The differential pressure (kPa). For more information
DeltaPressurekPa (v1.2+) {} object about this property, see SensorExcerpt in Property
Details.
HeaterSummary (v1.1+) { object The summary of heater metrics for this chassis.
(null)
The total number of seconds all the heaters in the
TotalPrePowerOnHeatingTimeSeconds read-only
integer thermal subsystem were active while the respective
(v1.1+) (null)
devices they heat were powered off.
The total number of seconds all the heaters in the
TotalRuntimeHeatingTimeSeconds read-only
integer thermal subsystem were active while the respective
(v1.1+) (null)
devices they heat were powered on.
The temperatures (Celsius) from all related sensors
array for this device. This object is an excerpt of the
TemperatureReadingsCelsius [ {
(excerpt) Sensor resource located at the URI shown in
DataSourceUri.
string read-only The link to the resource that provides the data for
DataSourceUri
(URI) (null) this sensor.
read-only
DeviceName (v1.2+) string The name of the device.
(null)
The area or device to which this sensor
string read-only
PhysicalContext measurement applies. For the possible property
(enum) (null)
values, see PhysicalContext in Property details.
The usage or location within a device to which this
string read-only sensor measurement applies. For the possible
PhysicalSubContext
(enum) (null) property values, see PhysicalSubContext in Property
details.
926 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only
Reading number The sensor value.
(null)
}]
TemperatureSummaryCelsius { object The summary temperature readings for this chassis.
(null)
The ambient temperature (Celsius) of this
Ambient {} object subsystem. For more information about this
property, see SensorExcerpt in Property Details.
The exhaust temperature (Celsius) of this
Exhaust {} object subsystem. For more information about this
property, see SensorExcerpt in Property Details.
The intake temperature (Celsius) of this subsystem.
Intake {} object For more information about this property, see
SensorExcerpt in Property Details.
The internal temperature (Celsius) of this
Internal {} object subsystem. For more information about this
property, see SensorExcerpt in Property Details.
6.131.4 Actions
6.131.4.1 ResetMetrics
Description
This action resets the summary metrics related to this equipment.
Action URI
{Base URI of target resource}/Actions/ThermalMetrics.ResetMetrics
Action parameters
This action takes no parameters.
Version 2023.1 Published 927
Redfish Resource and Schema Guide DSP2046
6.131.5 Property details
6.131.5.1 PhysicalContext
The area or device to which this sensor measurement applies.
string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
Chassis The entire chassis.
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
928 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
GPU A graphics processor (GPU).
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
StorageBay Within a storage bay.
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.
Version 2023.1 Published 929
Redfish Resource and Schema Guide DSP2046
6.131.5.2 PhysicalSubContext
The usage or location within a device to which this sensor measurement applies.
string Description
Input The input.
Output The output.
6.131.5.3 SensorExcerpt
The Sensor schema describes a sensor and its properties. This object is an excerpt of the Sensor
resource located at the URI shown in DataSourceUri.
read-
string
DataSourceUri only The link to the resource that provides the data for this sensor.
(URI)
(null)
read-
Reading number only The sensor value.
(null)
6.131.6 Example response
{
"@odata.type": "#ThermalMetrics.v1_2_0.ThermalMetrics",
"Id": "ThermalMetrics",
"Name": "Chassis Thermal Metrics",
"TemperatureSummaryCelsius": {
"Internal": {
"Reading": 39,
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/CPU1Temp"
},
"Intake": {
"Reading": 24.8,
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/IntakeTemp"
},
"Ambient": {
"Reading": 22.5,
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/AmbientTemp"
},
"Exhaust": {
930 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"Reading": 40.5,
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/ExhaustTemp"
}
},
"TemperatureReadingsCelsius": [
{
"Reading": 40,
"DeviceName": "SystemBoard",
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/SysBrdTemp"
},
{
"Reading": 24.8,
"DeviceName": "Intake",
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/IntakeTemp"
},
{
"Reading": 39,
"DeviceName": "CPUSubsystem",
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/CPUTemps"
},
{
"Reading": 42,
"DeviceName": "MemorySubsystem",
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/MemoryTemp"
},
{
"Reading": 33,
"DeviceName": "PowerSupply",
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/PSTemp"
},
{
"Reading": 40.5,
"DeviceName": "Exhaust",
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/ExhaustTemp"
}
],
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/ThermalMetrics"
}
6.132 ThermalSubsystem 1.2.0
Version v1.2 v1.1 v1.0
Release 2023.1 2022.3 2020.4
Version 2023.1 Published 931
Redfish Resource and Schema Guide DSP2046
6.132.1 Description
This ThermalSubsystem schema contains the definition for the thermal subsystem of a chassis.
6.132.2 URIs
/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem
6.132.3 Properties
Property Type Attributes Notes
CoolantConnectors A link to the coolant connectors for this equipment. Contains a link to a
object
(v1.2+) { resource.
Link to Collection of CoolantConnector. See the CoolantConnector schema
@odata.id string read-only
for details.
FanRedundancy [ { array The redundancy information for the groups of fans in this subsystem. For
}] (object) property details, see RedundantGroup.
The link to the collection of fans within this subsystem. Contains a link to
Fans { object
a resource.
@odata.id string read-only Link to Collection of Fan. See the Fan schema for details.
The link to the collection of heaters within this subsystem. Contains a link
Heaters (v1.1+) { object
to a resource.
@odata.id string read-only Link to Collection of Heater. See the Heater schema for details.
The status and health of the resource and its subordinate or dependent
Status {} object
resources. For property details, see Status.
The link to the summary of thermal metrics for this subsystem. See the
ThermalMetrics { object
ThermalMetrics schema for details on this property.
Link to a ThermalMetrics resource. See the Links section and the
@odata.id string read-only
ThermalMetrics schema for details.
932 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.132.4 Example response
{
"@odata.type": "#ThermalSubsystem.v1_2_0.ThermalSubsystem",
"Id": "ThermalSubsystem",
"Name": "Thermal Subsystem for Chassis",
"FanRedundancy": [
{
"RedundancyType": "NPlusM",
"MaxSupportedInGroup": 2,
"MinNeededInGroup": 1,
"RedundancyGroup": [
{
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/Fans/Bay1"
},
{
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/Fans/Bay2"
}
],
"Status": {
"State": "Enabled",
"Health": "OK"
}
},
{
"RedundancyType": "NPlusM",
"MaxSupportedInGroup": 2,
"MinNeededInGroup": 1,
"RedundancyGroup": [
{
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/Fans/CPU1"
},
{
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/Fans/CPU2"
}
],
"Status": {
"State": "Disabled"
}
}
],
"Fans": {
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/Fans"
},
"ThermalMetrics": {
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/ThermalMetrics"
},
"Status": {
"State": "Enabled",
Version 2023.1 Published 933
Redfish Resource and Schema Guide DSP2046
"Health": "OK"
},
"@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem"
}
6.133 Triggers 1.3.1
Version v1.3 v1.2 v1.1 v1.0
Release 2023.1 2021.2 2019.1 2018.2
6.133.1 Description
The Triggers schema describes a trigger that applies to metrics.
6.133.2 URIs
/redfish/v1/TelemetryService/Triggers/{TriggersId}
6.133.3 Properties
Property Type Attributes Notes
string read-only The conditions when a discrete metric triggers. For the possible
DiscreteTriggerCondition
(enum) (null) property values, see DiscreteTriggerCondition in Property details.
DiscreteTriggers [ { array The list of discrete triggers.
string read-write The amount of time that a trigger event persists before the metric
DwellTime
(duration) (null) action is performed.
read-only
Name string The name of trigger.
(null)
string read-write The severity of the event message. For the possible property
Severity
(enum) (null) values, see Severity in Property details.
read-write
Value string The discrete metric value that constitutes a trigger event.
(null)
}]
934 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
array
The array of MessageIds that specify when a trigger condition is
EventTriggers (v1.1+) [ ] (string, read-write
met based on an event.
null)
string read-write The duration the sensor value must not violate the threshold
HysteresisDuration (v1.3+)
(duration) (null) before the threshold is deactivated.
read-write The reading offset from the threshold value required to clear the
HysteresisReading (v1.3+) number
(null) threshold.
Links (v1.1+) { object The links to other resources that are related to this resource.
The metric report definitions that generate new metric reports
MetricReportDefinitions
array when a trigger condition is met and when the TriggerActions
(v1.1+) [ {
property contains RedfishMetricReport .
Link to a MetricReportDefinition resource. See the Links section
@odata.id string read-write
and the MetricReportDefinition schema for details.
}]
Oem {} object See the Oem object definition in the Common properties section.
array The label for the metric definitions that contain the property
MetricIds (v1.2+) [ ] (string, read-write identifiers for this trigger. It matches the Id property of the
null) corresponding metric definition.
array
An array of URIs with wildcards and property identifiers for this
(URI)
MetricProperties [ ] read-write trigger. Each wildcard shall be replaced with its corresponding
(string,
entry in the Wildcard array property.
null)
string read-only The metric type of the trigger. For the possible property values,
MetricType
(enum) (null) see MetricType in Property details.
NumericThresholds { object The thresholds when a numeric metric triggers.
The value at which the reading is below normal range and
LowerCritical {} object requires attention. For more information about this property, see
Threshold in Property Details.
The value at which the reading is below normal range. For more
LowerWarning {} object
information about this property, see Threshold in Property Details.
The value at which the reading is above normal range and
UpperCritical {} object requires attention. For more information about this property, see
Threshold in Property Details.
Version 2023.1 Published 935
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The value at which the reading is above normal range. For more
UpperWarning {} object
information about this property, see Threshold in Property Details.
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
array
The actions that the trigger initiates. For the possible property
TriggerActions [ ] (string read-only
values, see TriggerActions in Property details.
(enum))
The wildcards and their substitution values for the entries in the
Wildcards [ { array
MetricProperties array property.
read-only
Name string The wildcard.
(null)
array
Values [ ] (string, read-only An array of values to substitute for the wildcard.
null)
}]
6.133.4 Property details
6.133.4.1 Activation
The direction of crossing that activates this threshold.
string Description
Decreasing Value decreases below the threshold.
Disabled (v1.3+) The threshold is disabled.
Either Value crosses the threshold in either direction.
Increasing Value increases above the threshold.
6.133.4.2 DiscreteTriggerCondition
The conditions when a discrete metric triggers.
936 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
Changed A discrete trigger condition is met whenever the metric value changes.
A discrete trigger condition is met when the metric value becomes one of the values that the
Specified
DiscreteTriggers property lists.
6.133.4.3 MetricType
The metric type of the trigger.
string Description
Discrete The trigger is for a discrete sensor.
Numeric The trigger is for numeric sensor.
6.133.4.4 Severity
The severity of the event message.
string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.
6.133.4.5 Threshold
A threshold definition for a sensor.
read-
string The direction of crossing that activates this threshold. For the possible property values,
Activation write
(enum) see Activation in Property details.
(null)
read-
string
DwellTime write The duration the sensor value must violate the threshold before the threshold is activated.
(duration)
(null)
Version 2023.1 Published 937
Redfish Resource and Schema Guide DSP2046
read-
Reading number write The threshold value.
(null)
6.133.4.6 TriggerActions
The actions that the trigger initiates.
string Description
LogToLogService When a trigger condition is met, record in a log.
RedfishEvent When a trigger condition is met, the service sends an event to subscribers.
RedfishMetricReport When a trigger condition is met, force an update of the specified metric reports.
6.133.5 Example response
{
"@odata.type": "#Triggers.v1_3_1.Triggers",
"Id": "PlatformPowerCapTriggers",
"Name": "Triggers for platform power consumed",
"MetricType": "Numeric",
"TriggerActions": [
"RedfishEvent"
],
"NumericThresholds": {
"UpperCritical": {
"Reading": 50,
"Activation": "Increasing",
"DwellTime": "PT0.001S"
},
"UpperWarning": {
"Reading": 48.1,
"Activation": "Increasing",
"DwellTime": "PT0.004S"
}
},
"MetricProperties": [
"/redfish/v1/Chassis/1/Power#/PowerControl/0/PowerConsumedWatts"
],
"@odata.id": "/redfish/v1/TelemetryService/Triggers/PlatformPowerCapTriggers"
}
938 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.134 TrustedComponent 1.1.0
Version v1.1 v1.0
Release 2023.1 2022.2
6.134.1 Description
The TrustedComponent resource represents a trusted device, such as a TPM.
6.134.2 URIs
/redfish/v1/Chassis/{ChassisId}/TrustedComponents/{TrustedComponentId}
6.134.3 Properties
Property Type Attributes Notes
The link to a collection of device identity certificates of the
Certificates { object
trusted component. Contains a link to a resource.
Link to Collection of Certificate. See the Certificate schema for
@odata.id string read-only
details.
read-only The software version of the active software image on the
FirmwareVersion string
(null) trusted component.
Links { object The links to other resources that are related to this resource.
The link to the software inventory resource that represents the
ActiveSoftwareImage { object active firmware image for this trusted component. See the
SoftwareInventory schema for details on this property.
Link to a SoftwareInventory resource. See the Links section
@odata.id string read-write
and the SoftwareInventory schema for details.
An array of links to ComponentIntegrity resources for which
ComponentIntegrity [ { array
the trusted component is responsible.
Version 2023.1 Published 939
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Link to a ComponentIntegrity resource. See the Links section
@odata.id string read-only
and the ComponentIntegrity schema for details.
}]
An array of links to resources that the target component
ComponentsProtected [ { array
protects.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
A link to a resource to which this trusted component is
IntegratedInto { object
integrated.
string
@odata.id read-only The unique identifier for a resource.
(URI)
See the Oem object definition in the Common properties
Oem {} object
section.
SoftwareImages [ { array The images that are associated with this trusted component.
Link to a SoftwareInventory resource. See the Links section
@odata.id string read-only
and the SoftwareInventory schema for details.
}]
read-only
Manufacturer string The manufacturer of this trusted component.
(null)
read-only
Model string The model number of the trusted component.
(null)
read-only
PartNumber string The part number of the trusted component.
(null)
read-only
SerialNumber string The serial number of the trusted component.
(null)
read-only
SKU string The SKU of the trusted component.
(null)
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
940 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
TPM (v1.1+) { object TPM-specific information for this trusted component.
CapabilitiesVendorID read-only
string The capabilities vendor ID for this trusted component.
(v1.1+) (null)
HardwareInterfaceVendorID read-only
string The hardware interface vendor ID for this trusted component.
(v1.1+) (null)
The type of trusted component, such as any physical
string read-only distinction about the trusted component. For the possible
TrustedComponentType
(enum) required property values, see TrustedComponentType in Property
details.
string read-only
UUID The UUID for this trusted component.
(uuid) (null)
6.134.4 Property details
6.134.4.1 TrustedComponentType
The type of trusted component, such as any physical distinction about the trusted component.
string Description
Discrete A discrete trusted component.
Integrated An integrated trusted component.
6.134.5 Example response
{
"@odata.type": "#TrustedComponent.v1_1_0.TrustedComponent",
"Id": "iRoT0",
"UUID": "A3981CF9-576A-4335-A19F-B8CD7EC2821E",
"Status": {
"Health": "OK",
"State": "Enabled"
},
"TrustedComponentType": "Integrated",
"Certificates": {
"@odata.id": "/redfish/v1/Chassis/1U/TrustedComponents/iRoT0/Certificates"
Version 2023.1 Published 941
Redfish Resource and Schema Guide DSP2046
},
"Links": {
"ComponentsProtected": [
{
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Processors/CPU1"
}
],
"IntegratedInto": {
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Processors/CPU1"
},
"ComponentIntegrity": [
{
"@odata.id": "/redfish/v1/ComponentIntegrity/SS-SPDM-1"
}
]
},
"@odata.id": "/redfish/v1/Chassis/1U/TrustedComponents/iRoT0"
}
6.135 UpdateService 1.11.3
Version v1.11 v1.10 v1.9 v1.8 v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 ...
Release 2021.4 2021.2 2021.1 2019.4 2019.3 2019.2 2019.1 2018.3 2018.2 2017.1 2016.3 ...
6.135.1 Description
The UpdateService schema describes the update service and the properties for the service itself with
links to collections of firmware and software inventory. The update service also provides methods for
updating software and firmware of the resources in a Redfish service.
6.135.2 URIs
/redfish/v1/UpdateService
942 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.135.3 Properties
Property Type Attributes Notes
The link to a collection of client identity
certificates provided to the server referenced
ClientCertificates (v1.10+) { object
by the ImageURI property in SimpleUpdate.
Contains a link to a resource.
Link to Collection of Certificate. See the
@odata.id string read-only
Certificate schema for details.
An inventory of firmware. Contains a link to a
FirmwareInventory { object
resource.
Link to Collection of SoftwareInventory. See
@odata.id string read-only
the SoftwareInventory schema for details.
The URI used to perform an HTTP or HTTPS
string
HttpPushUri (v1.1+) read-only push update to the update service. The
(URI)
format of the message is vendor-specific.
The options for HttpPushUri-provided software
HttpPushUriOptions (v1.4+) { object
updates.
An indication of whether the service should
ForceUpdate (v1.11+) boolean read-write bypass update policies when applying the
HttpPushUri-provided image.
The settings for when to apply HttpPushUri-
HttpPushUriApplyTime (v1.4+) { object
provided firmware.
The time when to apply the HttpPushUri-
string provided software update. For the possible
ApplyTime (v1.4+) read-write
(enum) property values, see ApplyTime in Property
details.
MaintenanceWindowDurationInSeconds integer The expiry time, in seconds, of the
read-write
(v1.4+) (seconds) maintenance window.
string
MaintenanceWindowStartTime (v1.4+) (date- read-write The start time of a maintenance window.
time)
Version 2023.1 Published 943
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
An indication of whether a client has reserved
read-write
HttpPushUriOptionsBusy (v1.4+) boolean the HttpPushUriOptions properties for
(null)
software updates.
array
(URI) An array of URIs that indicate where to apply
HttpPushUriTargets (v1.2+) [ ] read-write
(string, the update image.
null)
read-write An indication of whether any client has
HttpPushUriTargetsBusy (v1.2+) boolean
(null) reserved the HttpPushUriTargets property.
integer read-only The maximum size in bytes of the software
MaxImageSizeBytes (v1.5+)
(bytes) (null) update image that this service supports.
The URI used to perform a Redfish
string
MultipartHttpPushUri (v1.6+) read-only Specification-defined Multipart HTTP or HTTPS
(URI)
push update to the update service.
The link to a collection of server certificates
for the server referenced by the ImageURI
RemoteServerCertificates (v1.9+) { object
property in SimpleUpdate. Contains a link to a
resource.
Link to Collection of Certificate. See the
@odata.id string read-only
Certificate schema for details.
read-write An indication of whether this service is
ServiceEnabled boolean
(null) enabled.
An inventory of software. Contains a link to a
SoftwareInventory { object
resource.
Link to Collection of SoftwareInventory. See
@odata.id string read-only
the SoftwareInventory schema for details.
The status and health of the resource and its
Status {} object subordinate or dependent resources. For
property details, see Status.
An indication of whether the service will
read-write verify the certificate of the server referenced
VerifyRemoteServerCertificate (v1.9+) boolean
(null) by the ImageURI property in SimpleUpdate
prior to sending the transfer request.
944 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.135.4 Actions
6.135.4.1 SimpleUpdate
Description
This action updates software components.
Action URI
{Base URI of target resource}/Actions/UpdateService.SimpleUpdate
Action parameters
Parameter Name Type Attributes Notes
ForceUpdate An indication of whether the service should bypass update policies when
boolean optional
(v1.11+) applying the provided image. The default is false .
ImageURI string required The URI of the software image to install.
Password
string optional The password to access the URI specified by the ImageURI parameter.
(v1.4+)
array
Targets (v1.2+) [
(URI) optional An array of URIs that indicate where to apply the update image.
]
(string)
The network protocol that the update service uses to retrieve the
string software image file located at the URI provided in ImageURI. This
TransferProtocol optional
(enum) parameter is ignored if the URI provided in ImageURI contains a scheme.
For the possible property values, see TransferProtocol in Property details.
Username
string optional The user name to access the URI specified by the ImageURI parameter.
(v1.4+)
Request Example
{
"ImageURI": "https://images.contoso.org/bmc_0260_2021.bin"
}
Version 2023.1 Published 945
Redfish Resource and Schema Guide DSP2046
6.135.4.2 StartUpdate (v1.7+)
Description
This action starts updating all images that have been previously invoked using an OperationApplyTime
value of OnStartUpdateRequest .
Action URI
{Base URI of target resource}/Actions/UpdateService.StartUpdate
Action parameters
This action takes no parameters.
6.135.5 Property details
6.135.5.1 ApplyTime
The time when to apply the HttpPushUri-provided software update.
string Description
AtMaintenanceWindowStart Apply during an administrator-specified maintenance window.
Immediate Apply immediately.
InMaintenanceWindowOnReset Apply after a reset but within an administrator-specified maintenance window.
OnReset Apply on a reset.
OnStartUpdateRequest
Apply when the StartUpdate action of the update service is invoked.
(v1.11+)
6.135.5.2 TransferProtocol
The network protocol that the update service uses to retrieve the software image file located at the
URI provided in ImageURI. This parameter is ignored if the URI provided in ImageURI contains a
scheme.
string Description
CIFS Common Internet File System (CIFS).
946 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
FTP File Transfer Protocol (FTP).
HTTP Hypertext Transfer Protocol (HTTP).
HTTPS Hypertext Transfer Protocol Secure (HTTPS).
NFS (v1.3+) Network File System (NFS).
Network File System (NFS). Deprecated in v1.3 and later. This value has been deprecated in
NSF (deprecated v1.3)
favor of NFS.
OEM A manufacturer-defined protocol.
SCP Secure Copy Protocol (SCP).
SFTP (v1.1+) Secure File Transfer Protocol (SFTP).
TFTP Trivial File Transfer Protocol (TFTP).
6.135.6 Example response
{
"@odata.type": "#UpdateService.v1_11_3.UpdateService",
"Id": "UpdateService",
"Name": "Update service",
"Status": {
"State": "Enabled",
"Health": "OK",
"HealthRollup": "OK"
},
"ServiceEnabled": true,
"HttpPushUri": "/FWUpdate",
"FirmwareInventory": {
"@odata.id": "/redfish/v1/UpdateService/FirmwareInventory"
},
"SoftwareInventory": {
"@odata.id": "/redfish/v1/UpdateService/SoftwareInventory"
},
"Actions": {
"#UpdateService.SimpleUpdate": {
"target": "/redfish/v1/UpdateService/Actions/SimpleUpdate",
"@Redfish.ActionInfo": "/redfish/v1/UpdateService/SimpleUpdateActionInfo"
}
},
"@odata.id": "/redfish/v1/UpdateService"
}
Version 2023.1 Published 947
Redfish Resource and Schema Guide DSP2046
6.136 USBController 1.0.0
Version v1.0
Release 2021.1
6.136.1 Description
The USBController schema defines a Universal Serial Bus controller.
6.136.2 URIs
/redfish/v1/Systems/{ComputerSystemId}/USBControllers/{ControllerId}
6.136.3 Properties
Property Type Attributes Notes
Links { object The links to other resources that are related to this resource.
Oem {} object See the Oem object definition in the Common properties section.
A link to the PCIe device that represents this USB controller. See the
PCIeDevice { object
(null) PCIeDevice schema for details on this property.
Link to a PCIeDevice resource. See the Links section and the PCIeDevice
@odata.id string read-only
schema for details.
Processors [ { array An array of links to the processors that can utilize this USB controller.
Link to a Processor resource. See the Links section and the Processor
@odata.id string read-only
schema for details.
}]
read-only
Manufacturer string The manufacturer of this USB controller.
(null)
read-only
Model string The product model number of this USB controller.
(null)
948 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-only
PartNumber string The part number for this USB controller.
(null)
Ports { object The ports of the USB controller. Contains a link to a resource.
@odata.id string read-only Link to Collection of Port. See the Port schema for details.
read-only
SerialNumber string The serial number for this USB controller.
(null)
read-only
SKU string The SKU for this USB controller.
(null)
read-only
SparePartNumber string The spare part number of the USB controller.
(null)
The status and health of the resource and its subordinate or dependent
Status {} object
resources. For property details, see Status.
6.136.4 Example response
{
"@odata.type": "#USBController.v1_0_0.USBController",
"Id": "USB1",
"Name": "Contoso USB Controller 1",
"Manufacturer": "Contoso",
"Model": "USBv3",
"SKU": "80937",
"SerialNumber": "2M220100SL",
"PartNumber": "G37891",
"SparePartNumber": "G37890",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Ports": {
"@odata.id": "/redfish/v1/Systems/1/USBControllers/USB1/Ports"
},
"Links": {
"Processors": [
{
"@odata.id": "/redfish/v1/Systems/1/Processors/1"
},
{
"@odata.id": "/redfish/v1/Systems/1/Processors/2"
Version 2023.1 Published 949
Redfish Resource and Schema Guide DSP2046
}
]
},
"@odata.id": "/redfish/v1/Systems/1/USBControllers/USB1"
}
6.137 VCATEntry 1.0.1
Version v1.0
Release 2019.4
6.137.1 Description
The VCATEntry schema defines an entry in a Virtual Channel Action Table. A Virtual Channel is a
mechanism used to create multiple, logical communication streams across a physical link.
6.137.2 URIs
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/GenZ/REQ-VCAT/{VCATEntryId}
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/GenZ/RSP-VCAT/{VCATEntryId}
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/VCAT/
{VCATEntryId}
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/VCAT/{VCATEntryId}
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/REQ-VCAT/{VCATEntryId}
/redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/RSP-VCAT/{VCATEntryId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/
FabricAdapters/{FabricAdapterId}/GenZ/REQ-VCAT/{VCATEntryId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/
FabricAdapters/{FabricAdapterId}/GenZ/RSP-VCAT/{VCATEntryId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/
FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/VCAT/{VCATEntryId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/
FabricAdapters/{FabricAdapterId}/Ports/{PortId}/VCAT/{VCATEntryId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/
FabricAdapters/{FabricAdapterId}/REQ-VCAT/{VCATEntryId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/
FabricAdapters/{FabricAdapterId}/RSP-VCAT/{VCATEntryId}
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/GenZ/VCAT/{VCATEntryId}
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/VCAT/{VCATEntryId}
950 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/
GenZ/REQ-VCAT/{VCATEntryId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/
GenZ/RSP-VCAT/{VCATEntryId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/
Ports/{PortId}/GenZ/VCAT/{VCATEntryId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/
Ports/{PortId}/VCAT/{VCATEntryId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/
REQ-VCAT/{VCATEntryId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/
RSP-VCAT/{VCATEntryId}
/redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/GenZ/REQ-VCAT/{VCATEntryId}
/redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/GenZ/RSP-VCAT/{VCATEntryId}
/redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/VCAT/
{VCATEntryId}
/redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/VCAT/{VCATEntryId}
/redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/REQ-VCAT/{VCATEntryId}
/redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/RSP-VCAT/{VCATEntryId}
6.137.3 Properties
Property Type Attributes Notes
read-write
RawEntryHex string The hexadecimal value of the Virtual Channel Action Table entries.
(null)
VCEntries [ { array An array of entries of the Virtual Channel Action Table.
read-write
Threshold string The configured threshold.
(null)
read-write
VCMask string The bits corresponding to the supported Virtual Channel.
(null)
}]
6.137.4 Example response
{
"@odata.type": "#VCATEntry.v1_0_1.VCATEntry",
"Id": "0",
"Name": "VCAT Entry 0",
"Description": "Gen-Z Port 1 Virtual Channel Action Table Entry 0",
Version 2023.1 Published 951
Redfish Resource and Schema Guide DSP2046
"RawEntryHex": "0x123456",
"VCEntries": [
{
"VCMask": "0x00000034",
"Threshold": "0x12"
},
{
"VCMask": "0x00000034",
"Threshold": "0x12"
},
{
"VCMask": "0x00000034",
"Threshold": "0x12"
},
{
"VCMask": "0x00000034",
"Threshold": "0x12"
}
],
"@odata.id": "/redfish/v1/Fabrics/GenZ/Switches/Switch1/Ports/1/VCAT/0"
}
6.138 VirtualMedia 1.6.1
Version v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.3 2021.2 2021.1 2018.3 2017.3 2017.1 1.0
6.138.1 Description
The VirtualMedia schema contains properties related to the monitor and control of an instance of
virtual media, such as a remote CD, DVD, or USB device. A manager for a system or device provides
virtual media functionality.
6.138.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
VirtualMedia/{VirtualMediaId}
/redfish/v1/Managers/{ManagerId}/VirtualMedia/{VirtualMediaId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/VirtualMedia/
{VirtualMediaId}
/redfish/v1/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}
952 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.138.3 Properties
Property Type Attributes Notes
The link to a collection of server certificates for the server referenced by
Certificates (v1.4+) { object
the Image property. Contains a link to a resource.
@odata.id string read-only Link to Collection of Certificate. See the Certificate schema for details.
ClientCertificates The link to a collection of client identity certificates provided to the
object
(v1.5+) { server referenced by the Image property. Contains a link to a resource.
@odata.id string read-only Link to Collection of Certificate. See the Certificate schema for details.
string read-only The current virtual media connection method. For the possible property
ConnectedVia
(enum) (null) values, see ConnectedVia in Property details.
string read-write The ejection policy for the virtual media. For the possible property
EjectPolicy (v1.6+)
(enum) (null) values, see EjectPolicy in Property details.
string read-write
EjectTimeout (v1.6+) Timeout value before the virtual media is automatically ejected.
(duration) (null)
string read-write
Image The URI of the location of the selected image.
(URI) (null)
read-only
ImageName string The current image name.
(null)
read-write
Inserted boolean An indication of whether virtual media is inserted into the virtual device.
(null)
array
The media types supported as virtual media. For the possible property
MediaTypes [ ] (string read-only
values, see MediaTypes in Property details.
(enum))
read-write The password to access the Image parameter-specified URI. This
Password (v1.3+) string
(null) property is null in responses.
The status and health of the resource and its subordinate or dependent
Status (v1.4+) {} object
resources. For property details, see Status.
TransferMethod string read-write The transfer method to use with the Image. For the possible property
(v1.3+) (enum) (null) values, see TransferMethod in Property details.
TransferProtocolType string read-write The network protocol to use with the image. For the possible property
(v1.3+) (enum) (null) values, see TransferProtocolType in Property details.
Version 2023.1 Published 953
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
read-write
UserName (v1.3+) string The user name to access the Image parameter-specified URI.
(null)
An indication of whether the service will verify the certificate of the
VerifyCertificate read-write
boolean server referenced by the Image property prior to completing the remote
(v1.4+) (null)
media connection.
read-write
WriteProtected boolean An indication of whether the media is write-protected.
(null)
6.138.4 Actions
6.138.4.1 EjectMedia (v1.2+)
Description
This action detaches remote media from virtual media.
Action URI
{Base URI of target resource}/Actions/VirtualMedia.EjectMedia
Action parameters
This action takes no parameters.
6.138.4.2 InsertMedia (v1.2+)
Description
This action attaches remote media to virtual media.
Action URI
{Base URI of target resource}/Actions/VirtualMedia.InsertMedia
Action parameters
Parameter Name Type Attributes Notes
Image string required The URI of the media to attach to the virtual media.
954 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Parameter Name Type Attributes Notes
An indication of whether the image is treated as inserted upon
Inserted boolean optional
completion of the action. The default is true .
Password (v1.3+) string optional The password to access the URI specified by the Image parameter.
TransferMethod string The transfer method to use with the image. For the possible property
optional
(v1.3+) (enum) values, see TransferMethod in Property details.
TransferProtocolType string The network protocol to use with the image. For the possible
optional
(v1.3+) (enum) property values, see TransferProtocolType in Property details.
UserName (v1.3+) string optional The username to access the URI specified by the Image parameter.
An indication of whether the remote media is treated as write-
WriteProtected boolean optional
protected. The default is true .
Request Example
{
"Image": "https://192.168.1.225/boot_image.iso",
"Inserted": true,
"WriteProtected": true
}
6.138.5 Property details
6.138.5.1 ConnectedVia
The current virtual media connection method.
string Description
Applet Connected to a client application.
NotConnected No current connection.
Oem Connected through an OEM-defined method.
URI Connected to a URI location.
6.138.5.2 EjectPolicy
The ejection policy for the virtual media.
Version 2023.1 Published 955
Redfish Resource and Schema Guide DSP2046
string Description
AfterUse The virtual media ejection occurs after the media is used.
OnPowerOff The virtual media ejection occurs during a system power or reset event.
Persistent The virtual media mount information persists indefinitely.
The virtual media ejection occurs when a session is terminated. The session may be outside
Session
the Redfish service.
The virtual media ejection occurs when a timer configured by the EjectTimeout property
Timed
expires.
6.138.5.3 MediaTypes
The media types supported as virtual media.
string Description
CD A CD-ROM format (ISO) image.
DVD A DVD-ROM format image.
Floppy A floppy disk image.
USBStick An emulation of a USB storage device.
6.138.5.4 TransferMethod
The transfer method to use with the image.
string Description
Stream Stream image file data from the source URI.
Upload Upload the entire image file from the source URI to the service.
6.138.5.5 TransferProtocolType
The network protocol to use with the image.
956 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
CIFS Common Internet File System (CIFS).
FTP File Transfer Protocol (FTP).
HTTP Hypertext Transfer Protocol (HTTP).
HTTPS Hypertext Transfer Protocol Secure (HTTPS).
NFS Network File System (NFS).
OEM A manufacturer-defined protocol.
SCP Secure Copy Protocol (SCP).
SFTP Secure File Transfer Protocol (SFTP).
TFTP Trivial File Transfer Protocol (TFTP).
6.138.6 Example response
{
"@odata.type": "#VirtualMedia.v1_6_1.VirtualMedia",
"Id": "CD1",
"Name": "Virtual CD",
"MediaTypes": [
"CD",
"DVD"
],
"Image": "redfish.dmtf.org/freeImages/freeOS.1.1.iso",
"ImageName": "mymedia-read-only",
"ConnectedVia": "Applet",
"Inserted": true,
"WriteProtected": false,
"@odata.id": "/redfish/v1/Managers/BMC/VirtualMedia/CD1"
}
6.139 VLanNetworkInterface 1.3.0 (deprecated)
Version v1.3 Deprecated v1.2 v1.1 v1.0
Release 2021.2 2020.4 2017.1 1.0
This schema has been deprecated and use in new implementations is discouraged except to retain
Version 2023.1 Published 957
Redfish Resource and Schema Guide DSP2046
compatibility with existing products. This schema has been deprecated in favor of using individual
EthernetInterface resources to show VLAN information.
6.139.1 Description
The VLanNetworkInterface schema describes a VLAN network instance that is available on a manager,
system, or other device.
6.139.2 URIs
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions/
{NetworkDeviceFunctionId}/Ethernet/VLANs/{VLanNetworkInterfaceId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/EthernetInterfaces/
{EthernetInterfaceId}/VLANs/{VLanNetworkInterfaceId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
EthernetInterfaces/{EthernetInterfaceId}/VLANs/{VLanNetworkInterfaceId}
/redfish/v1/Managers/{ManagerId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs/
{VLanNetworkInterfaceId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs/
{VLanNetworkInterfaceId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/EthernetInterfaces/
{EthernetInterfaceId}/VLANs/{VLanNetworkInterfaceId}
/redfish/v1/Systems/{ComputerSystemId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs/
{VLanNetworkInterfaceId}
6.139.3 Properties
Property Type Attributes Notes
read-write
required on
VLANEnable boolean An indication of whether this VLAN is enabled for this interface.
create
(null)
read-write
required on
VLANId integer The ID for this VLAN.
create
(null)
VLANPriority read-write
integer The priority for this VLAN.
(v1.2+) (null)
958 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.139.4 Example response
{
"@odata.type": "#VLanNetworkInterface.v1_3_0.VLanNetworkInterface",
"Id": "1",
"Name": "VLAN Network Interface",
"Description": "System NIC 1 VLAN",
"VLANEnable": true,
"VLANId": 101,
"@odata.id": "/redfish/v1/Systems/437XR1138R2/EthernetInterfaces/12446A3B0411/VLANs/1"
}
6.140 Volume 1.9.0
Version v1.9 v1.8 v1.7 v1.6 v1.5 v1.4 v1.3 v1.2
Release 1.2.5 1.2.4 1.2.3 1.2.1 1.2.0 1.1.0 1.0.6a 1.0.5
6.140.1 Description
Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity
for any system.
6.140.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Volumes/
{VolumeId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/
Storage/{StorageId}/Volumes/{VolumeId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Volumes/{VolumeId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/
Volumes/{VolumeId}
/redfish/v1/Storage/{StorageId}/ConsistencyGroups/{ConsistencyGroupId}/Volumes/{VolumeId}
/redfish/v1/Storage/{StorageId}/FileSystems/{FileSystemId}/CapacitySources/{CapacitySourceId}/
ProvidingVolumes/{VolumeId}
/redfish/v1/Storage/{StorageId}/StoragePools/{StoragePoolId}/AllocatedVolumes/{VolumeId}
/redfish/v1/Storage/{StorageId}/StoragePools/{StoragePoolId}/CapacitySources/{CapacitySourceId}/
ProvidingVolumes/{VolumeId}
/redfish/v1/Storage/{StorageId}/Volumes/{VolumeId}
/redfish/v1/StorageServices/{StorageServiceId}/ConsistencyGroups/{ConsistencyGroupId}/Volumes/
Version 2023.1 Published 959
Redfish Resource and Schema Guide DSP2046
{VolumeId}
/redfish/v1/StorageServices/{StorageServiceId}/FileSystems/{FileSystemId}/CapacitySources/
{CapacitySourceId}/ProvidingVolumes/{VolumeId}
/redfish/v1/StorageServices/{StorageServiceId}/StoragePools/{StoragePoolId}/AllocatedVolumes/
{VolumeId}
/redfish/v1/StorageServices/{StorageServiceId}/StoragePools/{StoragePoolId}/CapacitySources/
{CapacitySourceId}/ProvidingVolumes/{VolumeId}
/redfish/v1/StorageServices/{StorageServiceId}/Volumes/{VolumeId}
/redfish/v1/StorageServices/{StorageServiceId}/Volumes/{VolumeId}/CapacitySources/
{CapacitySourceId}/ProvidingVolumes/{ProvidingVolumeId}
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/ConsistencyGroups/
{ConsistencyGroupId}/Volumes/{VolumeId}
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/FileSystems/{FileSystemId}/
CapacitySources/{CapacitySourceId}/ProvidingVolumes/{VolumeId}
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StoragePools/{StoragePoolId}/
AllocatedVolumes/{VolumeId}
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StoragePools/{StoragePoolId}/
CapacitySources/{CapacitySourceId}/ProvidingVolumes/{VolumeId}
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/{VolumeId}
6.140.3 Properties
Property Type Attributes Notes
array Supported IO access capabilities. For the
read-write
AccessCapabilities (v1.1+) [ ] (string possible property values, see
(null)
(enum)) AccessCapabilities in Property details.
An array of references to StoragePools
AllocatedPools (v1.1+) {} object
allocated from this Volume.
integer read-only The size of the smallest addressable unit
BlockSizeBytes
(bytes) (null) (Block) of this volume in bytes.
Capacity utilization. For property details, see
Capacity (v1.1+) {} object
Capacity v1.0.0).
integer read-write
CapacityBytes The size in bytes of this Volume.
(bytes) (null)
CapacitySources (v1.1+) [ { array An array of space allocations to this volume.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
960 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
read-write Indicator of whether or not the Volume has
Compressed (v1.4+) boolean
(null) compression enabled.
An array of references to Connections that
Connections (v1.9+) [ { array
includes this volume.
Link to a Connection resource. See the Links
@odata.id string read-only section and the Connection schema for
details.
}]
read-write Indicator of whether or not the Volume has
Deduplicated (v1.4+) boolean
(null) deduplication enabled.
read-write A user-configurable string to name the
DisplayName (v1.4+) string
(null) volume.
read-write
Encrypted boolean Is this Volume encrypted.
(null)
array The types of encryption used by this Volume.
EncryptionTypes [ ] (string read-write For the possible property values, see
(enum)) EncryptionTypes in Property details.
array The Durable names for the volume. For
Identifiers [ { } ]
(object) property details, see Identifier.
Indicates the Initialization Method used for
this volume. If InitializeMethod is not
string read-only
InitializeMethod (v1.6+) specified, the InitializeMethod should be
(enum) (null)
Foreground. For the possible property values,
see InitializeMethod in Property details.
read-write Indicates the IO performance mode setting
IOPerfModeEnabled (v1.5+) boolean
(null) for the volume.
Statistics for this volume. For property details,
IOStatistics (v1.2+) {} object
see IOStatistics v1.0.1).
This property indicates whether or not the
read-write
IsBootCapable (v1.7+) boolean Volume contains a boot image and is capable
(null)
of booting.
Contains references to other resources that
Links { object
are related to this resource.
A pointer to the data volumes this volume
CacheDataVolumes (v1.6+) [ { array
serves as a cache volume.
Version 2023.1 Published 961
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
A pointer to the cache volume source for this
CacheVolumeSource (v1.6+) {} object
(null) volume.
The ClassOfService that this storage volume
ClassOfService (v1.1+) {} object
conforms to.
An array of references to the client Endpoints
ClientEndpoints (v1.4+) [ { array
associated with this volume.
Link to a Endpoint resource. See the Links
@odata.id string read-only
section and the Endpoint schema for details.
}]
An array of references to the
ConsistencyGroups (v1.4+) [ { array ConsistencyGroups associated with this
volume.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
An array of the Controllers associated with
Controllers (v1.9+) [ { array
this volume.
Link to a StorageController resource. See the
@odata.id string read-only Links section and the StorageController
schema for details.
}]
An array of references to the drives which are
DedicatedSpareDrives (v1.2+) [ { array
dedicated spares for this volume.
Link to a Drive resource. See the Links section
@odata.id string read-write
and the Drive schema for details.
}]
An array of references to the drives which
contain this volume. This will reference Drives
Drives [ { array
that either wholly or only partly contain this
volume.
962 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Link to a Drive resource. See the Links section
@odata.id string read-only
and the Drive schema for details.
}]
A pointer to the Resource that serves as a
JournalingMedia (v1.5+) {} object
(null) journaling media for this volume.
See the Oem object definition in the Common
Oem {} object
properties section.
A pointer to the Storage resource that owns
OwningStorageResource (v1.5+) { object or contains this volume. See the Storage
schema for details on this property.
Link to a Storage resource. See the Links
@odata.id string read-only
section and the Storage schema for details.
A pointer to the StorageService that owns or
OwningStorageService (v1.4+) {} object
contains this volume.
An array of references to the server Endpoints
ServerEndpoints (v1.4+) [ { array
associated with this volume.
Link to a Endpoint resource. See the Links
@odata.id string read-only
section and the Endpoint schema for details.
}]
SpareResourceSets (v1.3+) [ { array An array of references to SpareResourceSets.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
An array of references to the StorageGroups
StorageGroups (v1.4+) [ { array
associated with this volume.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
read-only Indicates the host-visible LogicalUnitNumber
LogicalUnitNumber (v1.4+) integer
(null) assigned to this Volume.
Version 2023.1 Published 963
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
array
(%)
LowSpaceWarningThresholdPercents (v1.1+) [ ] read-write Low space warning.
(integer,
null)
read-only The manufacturer or OEM of this storage
Manufacturer (v1.1+) string
(null) volume.
integer read-only
MaxBlockSizeBytes (v1.1+) Max Block size in bytes.
(bytes) (null)
Indicates the number of media elements used
read-only
MediaSpanCount (v1.4+) integer per span in the secondary RAID for a
(null)
hierarchical RAID type.
Metrics (v1.9+) {} object The link to the metrics for this volume.
read-only
Model (v1.1+) string The model number for this storage volume.
(null)
This property contains properties to use when
NVMeNamespaceProperties (v1.5+) { object Volume is used to describe an NVMe
(null)
Namespace.
The LBA data size and metadata size
read-only
FormattedLBASize (v1.5+) string combination that the namespace has been
(null)
formatted with.
read-write
IsShareable (v1.5+) boolean Indicates the namespace is shareable.
(null)
Describes the current LBA format ID and
LBAFormat (v1.9+) { object
(null) detailed properties.
read-only
LBADataSizeBytes (v1.9+) integer The LBA data size in bytes.
(null)
The LBA format type. For the possible
string read-only
LBAFormatType (v1.9+) property values, see LBAFormatType in
(enum) (null)
Property details.
read-only
LBAMetadataSizeBytes (v1.9+) integer The LBA metadata size in bytes.
(null)
The LBA Relative Performance type. For the
string read-only
RelativePerformance (v1.9+) possible property values, see
(enum) (null)
RelativePerformance in Property details.
964 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
Describes the LBA format IDs and detailed
LBAFormats (v1.9+) [ { array
properties.
read-only
LBADataSizeBytes (v1.9+) integer The LBA data size in bytes.
(null)
The LBA format type. For the possible
string read-only
LBAFormatType (v1.9+) property values, see LBAFormatType in
(enum) (null)
Property details.
read-only
LBAMetadataSizeBytes (v1.9+) integer The LBA metadata size in bytes.
(null)
The LBA Relative Performance type. For the
string read-only
RelativePerformance (v1.9+) possible property values, see
(enum) (null)
RelativePerformance in Property details.
}]
A list of the LBA format types supported for
array
read-only the namespace, or potential namespaces. For
LBAFormatsSupported (v1.8+) [ ] (string
(null) the possible property values, see
(enum))
LBAFormatsSupported in Property details.
This property indicates whether or not the
MetadataTransferredAtEndOfDataLBA read-only
boolean metadata is transferred at the end of the LBA
(v1.5+) (null)
creating an extended data LBA.
This property contains a set of Namespace
NamespaceFeatures (v1.5+) { object
(null) Features.
Indicates that the NVM fields for Namespace
preferred write granularity (NPWG), write
alignment (NPWA), deallocate granularity
read-only
SupportsAtomicTransactionSize (v1.5+) boolean (NPDG), deallocate alignment (NPDA) and
(null)
optimal write size (NOWS) are defined for this
namespace and should be used by the host
for I/O optimization.
This property indicates that the controller
SupportsDeallocatedOrUnwrittenLBError read-only
boolean supports deallocated or unwritten logical
(v1.5+) (null)
block error for this namespace.
Version 2023.1 Published 965
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Indicates that the Namespace Atomic Write
Unit Normal (NAWUN), Namespace Atomic
Write Unit Power Fail (NAWUPF), and
read-only Namespace Atomic Compare and Write Unit
SupportsIOPerformanceHints (v1.5+) boolean
(null) (NACWU) fields are defined for this
namespace and should be used by the host
for this namespace instead of the controller-
level properties AWUN, AWUPF, and ACWU.
This property indicates that the namespace
read-only
SupportsNGUIDReuse (v1.5+) boolean supports the use of an NGUID (namespace
(null)
globally unique identifier) value.
read-only This property indicates whether or not the
SupportsThinProvisioning (v1.5+) boolean
(null) NVMe Namespace supports thin provisioning.
read-only The NVMe Namespace Identifier for this
NamespaceId (v1.5+) string
(null) namespace.
Identifies the type of namespace. For the
string read-only
NamespaceType (v1.9+) possible property values, see NamespaceType
(enum) (null)
in Property details.
The number of LBA data size and metadata
integer read-only size combinations supported by this
NumberLBAFormats (v1.5+)
(bytes) (null) namespace. The value of this property is
between 0 and 16.
read-only The version of the NVMe Base Specification
NVMeVersion (v1.5+) string
(null) supported.
Identifies the type of namespace. For the
string read-only
Type (v1.8+) possible property values, see Type in Property
(enum) (null)
details.
The operations currently running on the
Operations [ { array
Volume.
A reference to the task associated with the
AssociatedFeaturesRegistry {} object
operation if any.
The type of the operation. For the possible
string read-only
Operation (v1.9+) property values, see Operation in Property
(enum) (null)
details.
966 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The name of the operation. Deprecated in
read-only v1.9 and later. This property is deprecated in
OperationName (deprecated v1.9) string
(null) favor of the Operation property using the
Operation enum.
read-only The percentage of the operation that has
PercentageComplete integer
(null) been completed.
}]
integer read-only The size in bytes of this Volume's optimum IO
OptimumIOSizeBytes
(bytes) (null) size.
This property specifies the volume's storage
string read-write allocation, or provisioning policy. For the
ProvisioningPolicy (v1.4+)
(enum) (null) possible property values, see
ProvisioningPolicy in Property details.
The RAID type of this volume. For the possible
string read-only
RAIDType (v1.3.1+) property values, see RAIDType in Property
(enum) (null)
details.
Indicates the read cache policy setting for the
string read-write
ReadCachePolicy (v1.4+) Volume. For the possible property values, see
(enum) (null)
ReadCachePolicy in Property details.
read-write Current number of capacity source resources
RecoverableCapacitySourceCount (v1.3+) integer
(null) that are available as replacements.
read-only The percentage of the capacity remaining in
RemainingCapacityPercent (v1.2+) integer
(null) the Volume.
array
URIs to the resources that are remote target
RemoteReplicaTargets (v1.8+) [ ] (string, read-only
replicas of this source.
null)
Describes this storage volume in its role as a
ReplicaInfo (v1.1+) {} object target replica. For property details, see
ReplicaInfo v1.4.0).
The resources that are target replicas of this
ReplicaTargets (v1.3+) [ { array
source.
string
@odata.id read-only The unique identifier for a resource.
(URI)
}]
read-write Indicates whether or not replication is
ReplicationEnabled (v1.9+) boolean
(null) enabled on the volume.
Version 2023.1 Published 967
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
The property contains the status of the
Status {} object
Volume. For property details, see Status.
An array of references to Storage Groups that
includes this volume. Deprecated in v1.9 and
StorageGroups (v1.1+, deprecated v1.9 {} object
later. This property is deprecated in favor of
the Connections property.
integer read-write The number of blocks (bytes) in a strip in a
StripSizeBytes (v1.4+)
(bytes) (null) disk array that uses striped data mapping.
The type of this volume. For the possible
string read-only
VolumeType property values, see VolumeType in Property
(enum) (null)
details.
Indicates the Volume usage type setting for
string read-only
VolumeUsage (v1.4+) the Volume. For the possible property values,
(enum) (null)
see VolumeUsage in Property details.
Indicates the write cache policy setting for
string read-write
WriteCachePolicy (v1.4+) the Volume. For the possible property values,
(enum) (null)
see WriteCachePolicy in Property details.
Indicates the WriteCacheState policy setting
string read-only for the Volume. For the possible property
WriteCacheState (v1.4+)
(enum) (null) values, see WriteCacheState in Property
details.
The policy that the RAID volume is using to
string address the write hole issue. For the possible
WriteHoleProtectionPolicy (v1.4+) read-write
(enum) property values, see
WriteHoleProtectionPolicy in Property details.
6.140.4 Actions
6.140.4.1 AssignReplicaTarget (v1.4+)
Description
This action is used to establish a replication relationship by assigning an existing volume to serve as a
target replica for an existing source volume.
Action URI
{Base URI of target resource}/Actions/Volume.AssignReplicaTarget
Action parameters
968 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Parameter Name Type Attributes Notes
string The type of replica relationship to be created. For the possible
ReplicaType required
(enum) property values, see ReplicaType in Property details.
string The replica update mode (synchronous vs asynchronous). For the
ReplicaUpdateMode required
(enum) possible property values, see ReplicaUpdateMode in Property details.
TargetVolume string required The Uri to the existing target volume.
Request Example
{
"ReplicaUpdateMode": "Synchronous",
"TargetVolume": "/redfish/v1/Storage/1/ConsistencyGroup/CG_DB2",
"ReplicaType": "Mirror"
}
6.140.4.2 ChangeRAIDLayout (v1.5+)
Description
Request system change the RAID layout of the volume.
Action URI
{Base URI of target resource}/Actions/Volume.ChangeRAIDLayout
Action parameters
Parameter Name Type Attributes Notes
Drives [ { array optional An array of the drives to be used by the volume.
Link to a Drive resource. See the Links section and the Drive schema for
@odata.id string read-only
details.
}]
The requested number of media elements used per span in the
MediaSpanCount integer optional
secondary RAID for a hierarchical RAID type.
string The requested RAID type for the volume. For the possible property
RAIDType optional
(enum) values, see RAIDType in Property details.
Version 2023.1 Published 969
Redfish Resource and Schema Guide DSP2046
Parameter Name Type Attributes Notes
StripSizeBytes integer optional The number of blocks (bytes) requested for new strip size.
Request Example
{
"Drives": [
{
"@odata.id": "/redfish/v1/Chassis/1U/Drives/Bay1A"
},
{
"@odata.id": "/redfish/v1/Chassis/1U/Drives/Bay2A"
},
{
"@odata.id": "/redfish/v1/Chassis/1U/Drives/Bay3B"
},
{
"@odata.id": "/redfish/v1/Chassis/1U/Drives/Bay4B"
}
],
"RAIDType": "RAID6"
}
6.140.4.3 CheckConsistency
Description
This action is used to force a check of the Volume's parity or redundant data to ensure it matches
calculated values.
Action URI
{Base URI of target resource}/Actions/Volume.CheckConsistency
Action parameters
This action takes no parameters.
6.140.4.4 CreateReplicaTarget (v1.4+)
Description
This action is used to create a new volume resource to provide expanded data protection through a
replica relationship with the specified source volume.
970 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Action URI
{Base URI of target resource}/Actions/Volume.CreateReplicaTarget
Action parameters
Parameter Name Type Attributes Notes
string The type of replica relationship to be created. For the possible
ReplicaType required
(enum) property values, see ReplicaType in Property details.
string The replica update mode (synchronous vs asynchronous). For the
ReplicaUpdateMode required
(enum) possible property values, see ReplicaUpdateMode in Property details.
TargetStoragePool string required The Uri to the existing target Storage Pool.
VolumeName string optional The Name for the new target volume.
Request Example
{
"VolumeName": "Mirror of Volume 65",
"ReplicaUpdateMode": "Synchronous",
"TargetStoragePool": "/redfish/v1/Storage/1/StoragePools/PrimaryPool",
"ReplicaType": "Mirror"
}
6.140.4.5 ForceEnable (v1.5+)
Description
Request system force the volume to an enabled state regardless of data loss.
Action URI
{Base URI of target resource}/Actions/Volume.ForceEnable
Action parameters
This action takes no parameters.
6.140.4.6 Initialize (v1.5+)
Description
Version 2023.1 Published 971
Redfish Resource and Schema Guide DSP2046
This action is used to prepare the contents of the volume for use by the system. If InitializeMethod is
not specified in the request body, but the property InitializeMethod is specified, the property
InitializeMethod value should be used. If neither is specified, the InitializeMethod should be
Foreground.
Action URI
{Base URI of target resource}/Actions/Volume.Initialize
Action parameters
Parameter Name Type Attributes Notes
string The type of initialization to be performed. For the possible property
InitializeMethod optional
(enum) values, see InitializeMethod in Property details.
string The type of initialization to be performed. For the possible property
InitializeType optional
(enum) values, see InitializeType in Property details.
Request Example
{
"InitializeMethod": "Background",
"InitializeType": "Fast"
}
6.140.4.7 RemoveReplicaRelationship (v1.4+)
Description
This action is used to disable data synchronization between a source and target volume, remove the
replication relationship, and optionally delete the target volume.
Action URI
{Base URI of target resource}/Actions/Volume.RemoveReplicaRelationship
Action parameters
Parameter Name Type Attributes Notes
Indicate whether or not to delete the target volume as part of the
DeleteTargetVolume boolean optional
operation.
972 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Parameter Name Type Attributes Notes
TargetVolume string required The Uri to the existing target volume.
Request Example
{
"TargetVolume": "/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/650973452245",
"DeleteTargetVolume": "false"
}
6.140.4.8 ResumeReplication (v1.4+)
Description
This action is used to resume the active data synchronization between a source and target volume,
without otherwise altering the replication relationship.
Action URI
{Base URI of target resource}/Actions/Volume.ResumeReplication
Action parameters
Parameter Name Type Attributes Notes
TargetVolume string required The Uri to the existing target volume.
Request Example
{
"TargetVolume": "/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/650973452245"
}
6.140.4.9 ReverseReplicationRelationship (v1.4+)
Description
This action is used to reverse the replication relationship between a source and target volume.
Version 2023.1 Published 973
Redfish Resource and Schema Guide DSP2046
Action URI
{Base URI of target resource}/Actions/Volume.ReverseReplicationRelationship
Action parameters
Parameter Name Type Attributes Notes
TargetVolume string required The Uri to the existing target volume.
Request Example
{
"TargetVolume": "/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/650973452245"
}
6.140.4.10 SplitReplication (v1.4+)
Description
This action is used to split the replication relationship and suspend data synchronization between a
source and target volume.
Action URI
{Base URI of target resource}/Actions/Volume.SplitReplication
Action parameters
Parameter Name Type Attributes Notes
TargetVolume string required The Uri to the existing target volume.
Request Example
{
"TargetVolume": "/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/650973452245"
}
974 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.140.4.11 SuspendReplication (v1.4+)
Description
This action is used to suspend active data synchronization between a source and target volume,
without otherwise altering the replication relationship.
Action URI
{Base URI of target resource}/Actions/Volume.SuspendReplication
Action parameters
Parameter Name Type Attributes Notes
TargetVolume string required The Uri to the existing target volume.
Request Example
{
"TargetVolume": "/redfish/v1/Storage/1/StoragePools/PrimaryPool/AllocatedVolumes/650973452245"
}
6.140.5 Property details
6.140.5.1 AccessCapabilities
Supported IO access capabilities.
string Description
Append AppendOnly.
Execute Execute access is allowed by the file share.
Read Read.
Streaming Streaming.
Write Write Many.
WriteOnce WriteOnce.
Version 2023.1 Published 975
Redfish Resource and Schema Guide DSP2046
6.140.5.2 EncryptionTypes
The types of encryption used by this Volume.
string Description
ControllerAssisted The volume is being encrypted by the storage controller entity.
NativeDriveEncryption The volume is utilizing the native drive encryption capabilities of the drive hardware.
SoftwareAssisted The volume is being encrypted by software running on the system or the operating system.
6.140.5.3 idRef
string
@odata.id read-only The unique identifier for a resource.
(URI)
6.140.5.4 InitializeMethod
The type of initialization to be performed.
string Description
The volume will be available for use immediately, with data erasure and preparation to
Background
happen as background tasks.
Data erasure and preparation tasks will complete before the volume is presented as available
Foreground
for use.
Skip The volume will be available for use immediately, with no preparation.
6.140.5.5 InitializeType
The type of initialization to be performed.
string Description
The volume is prepared for use quickly, typically by erasing just the beginning and end of the
Fast
space so that partitioning can be performed.
Slow The volume is prepared for use slowly, typically by completely erasing the volume.
976 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.140.5.6 LBAFormatsSupported
A list of the LBA format types supported for the namespace, or potential namespaces.
string Description
LBAFormat0 LBAFormat0 is a required type. Indicates the LBA data size supported.
LBAFormat1 Indicates the LBA data size if supported.
LBAFormat10 Indicates the LBA data size supported if supported.
LBAFormat11 Indicates the LBA data size supported if supported.
LBAFormat12 Indicates the LBA data size supported if supported.
LBAFormat13 Indicates the LBA data size supported if supported.
LBAFormat14 Indicates the LBA data size supported if supported.
LBAFormat15 Indicates the LBA data size supported if supported.
LBAFormat2 Indicates the LBA data size supported if supported.
LBAFormat3 Indicates the LBA data size supported if supported.
LBAFormat4 Indicates the LBA data size supported if supported.
LBAFormat5 Indicates the LBA data size supported if supported.
LBAFormat6 Indicates the LBA data size supported if supported.
LBAFormat7 Indicates the LBA data size supported if supported.
LBAFormat8 Indicates the LBA data size supported if supported.
LBAFormat9 Indicates the LBA data size supported if supported.
6.140.5.7 LBAFormatType
The LBA format type.
string Description
LBAFormat0 LBAFormat0 is a required type. Indicates the LBA data size supported.
LBAFormat1 Indicates the LBA data size if supported.
Version 2023.1 Published 977
Redfish Resource and Schema Guide DSP2046
string Description
LBAFormat10 Indicates the LBA data size supported if supported.
LBAFormat11 Indicates the LBA data size supported if supported.
LBAFormat12 Indicates the LBA data size supported if supported.
LBAFormat13 Indicates the LBA data size supported if supported.
LBAFormat14 Indicates the LBA data size supported if supported.
LBAFormat15 Indicates the LBA data size supported if supported.
LBAFormat2 Indicates the LBA data size supported if supported.
LBAFormat3 Indicates the LBA data size supported if supported.
LBAFormat4 Indicates the LBA data size supported if supported.
LBAFormat5 Indicates the LBA data size supported if supported.
LBAFormat6 Indicates the LBA data size supported if supported.
LBAFormat7 Indicates the LBA data size supported if supported.
LBAFormat8 Indicates the LBA data size supported if supported.
LBAFormat9 Indicates the LBA data size supported if supported.
6.140.5.8 NamespaceType
Identifies the type of namespace.
string Description
Block The namespace is configured for use with a block storage interface.
Computational The namespace is configured for use with a computational storage interface.
KeyValue The namespace is configured for use with a KeyValue interface.
ZNS The namespace is configured for use with a zoned storage interface.
6.140.5.9 Operation
The type of the operation.
978 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
string Description
ChangeRAIDType A ChangeRAIDType operation is being performed.
CheckConsistency A CheckConsistency operation is being performed.
Compress A Compress operation is being performed.
Decrypt A Decrypt operation is being performed.
Deduplicate A Deduplicate operation is being performed.
Delete A Delete operation is being performed.
Encrypt An Encrypt operation is being performed.
Format A Format operation is being performed.
Initialize An Initialize operation is being performed.
Rebuild A Rebuild operation is being performed.
Replicate A Replicate operation is being performed.
Resize A Resize operation is being performed.
Sanitize A Sanitize operation is being performed.
6.140.5.10 ProvisioningPolicy
This property specifies the volume's storage allocation, or provisioning policy.
string Description
Fixed Storage is fully allocated.
Thin Storage may be over allocated.
6.140.5.11 RAIDType
The requested RAID type for the volume.
string Description
None A placement policy with no redundancy at the device level.
Version 2023.1 Published 979
Redfish Resource and Schema Guide DSP2046
string Description
A placement policy where consecutive logical blocks of data are uniformly distributed across
RAID0
a set of independent storage devices without offering any form of redundancy.
RAID00 A placement policy that creates a RAID 0 stripe set over two or more RAID 0 sets.
A data placement policy that creates a mirrored device (RAID 1) over a set of striped devices
RAID01
(RAID 0).
A placement policy where each logical block of data is stored on more than one independent
RAID1
storage device.
A placement policy that creates a striped device (RAID 0) over a set of mirrored devices (RAID
RAID10
1).
RAID10E A placement policy that uses a RAID 0 stripe set over two or more RAID 10 sets.
A placement policy that uses a striped device (RAID 0) over a set of triple mirrored devices
RAID10Triple
(RAID 1Triple).
A placement policy that uses a form of mirroring implemented over a set of independent
RAID1E storage devices where logical blocks are duplicated on a pair of independent storage devices
so that data is uniformly distributed across the storage devices.
A placement policy where each logical block of data is mirrored three times across a set of
RAID1Triple
three independent storage devices.
A placement policy using parity-based protection where logical bytes of data are uniformly
RAID3 distributed across a set of independent storage devices and where the parity is stored on a
dedicated independent storage device.
A placement policy using parity-based protection where logical blocks of data are uniformly
RAID4 distributed across a set of independent storage devices and where the parity is stored on a
dedicated independent storage device.
A placement policy using parity-based protection for storing stripes of 'n' logical blocks of
RAID5 data and one logical block of parity across a set of 'n+1' independent storage devices where
the parity and data blocks are interleaved across the storage devices.
A placement policy that uses a RAID 0 stripe set over two or more RAID 5 sets of independent
RAID50
storage devices.
A placement policy using parity-based protection for storing stripes of 'n' logical blocks of
RAID6 data and two logical blocks of independent parity across a set of 'n+2' independent storage
devices where the parity and data blocks are interleaved across the storage devices.
A placement policy that uses a RAID 0 stripe set over two or more RAID 6 sets of independent
RAID60
storage devices.
A placement policy that uses parity-based protection for storing stripes of 'n' logical blocks of
RAID6TP data and three logical blocks of independent parity across a set of 'n+3' independent storage
devices where the parity and data blocks are interleaved across the storage devices.
980 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.140.5.12 ReadCachePolicy
Indicates the read cache policy setting for the Volume.
string Description
A caching technique in which the controller dynamically determines whether to pre-fetch
AdaptiveReadAhead
data anticipating future read requests, based on previous cache hit ratio.
Off The read cache is disabled.
A caching technique in which the controller pre-fetches data anticipating future read
ReadAhead
requests.
6.140.5.13 RelativePerformance
The LBA Relative Performance type.
string Description
Best Best performance.
Better Better performance.
Degraded Degraded performance.
Good Good performance.
6.140.5.14 ReplicaType
The type of replica relationship to be created.
string Description
Clone Create a point in time, full copy the source.
Mirror Create and maintain a copy of the source.
Snapshot Create a point in time, virtual copy of the source.
TokenizedClone Create a token based clone.
Version 2023.1 Published 981
Redfish Resource and Schema Guide DSP2046
6.140.5.15 ReplicaUpdateMode
The replica update mode (synchronous vs asynchronous).
string Description
Active Active-Active (i.e. bidirectional) synchronous updates.
Adaptive Allows implementation to switch between synchronous and asynchronous modes.
Asynchronous Asynchronous updates.
Synchronous Synchronous updates.
6.140.5.16 Type
Identifies the type of namespace.
string Description
Block The namespace is configured for use with a block storage interface.
Computational The namespace is configured for use with a computational storage interface.
KeyValue The namespace is configured for use with a KeyValue interface.
ZNS The namespace is configured for use with a zoned storage interface.
6.140.5.17 VolumeType
The type of this volume.
string Description
Mirrored The volume is a mirrored device.
NonRedundant The volume is a non-redundant storage device.
RawDevice The volume is a raw physical device without any RAID or other virtualization applied.
SpannedMirrors The volume is a spanned set of mirrored devices.
SpannedStripesWithParity The volume is a spanned set of devices which uses parity to retain redundant information.
StripedWithParity The volume is a device which uses parity to retain redundant information.
982 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.140.5.18 VolumeUsage
Indicates the Volume usage type setting for the Volume.
string Description
CacheOnly The volume is allocated for use as a non-consumable cache only volume.
Data The volume is allocated for use as a consumable data volume.
ReplicationReserve The volume is allocated for use as a non-consumable reserved volume for replication use.
SystemData The volume is allocated for use as a consumable data volume reserved for system use.
SystemReserve The volume is allocated for use as a non-consumable system reserved volume.
6.140.5.19 WriteCachePolicy
Indicates the write cache policy setting for the Volume.
string Description
Off The write cache is disabled.
A caching technique in which the completion of a write request is signaled as soon as the
ProtectedWriteBack data is in cache, and actual writing to non-volatile media is guaranteed to occur at a later
time.
A caching technique in which the completion of a write request is signaled as soon as the
UnprotectedWriteBack data is in cache; actual writing to non-volatile media is not guaranteed to occur at a later
time.
A caching technique in which the completion of a write request is not signaled until data is
WriteThrough
safely stored on non-volatile media.
6.140.5.20 WriteCacheState
Indicates the WriteCacheState policy setting for the Volume.
string Description
Indicates an issue with the cache state in which the cache space is diminished or disabled
Degraded
due to a failure or an outside influence such as a discharged battery.
Version 2023.1 Published 983
Redfish Resource and Schema Guide DSP2046
string Description
Indicates that the cache state type in use generally protects write requests on non-volatile
Protected
media.
Indicates that the cache state type in use generally does not protect write requests on non-
Unprotected
volatile media.
6.140.5.21 WriteHoleProtectionPolicy
The policy that the RAID volume is using to address the write hole issue.
string Description
The policy that distributes additional log among the volume's capacity sources to address
DistributedLog
write hole issue.
The policy that uses separate block device for write-ahead logging to address write hole
Journaling
issue.
Oem The policy that is Oem specific.
Off The volume is not using any policy to address the write hole issue.
6.140.6 Example response
{
"@odata.type": "#Volume.v1_9_0.Volume",
"Id": "2",
"Name": "Virtual Disk 2",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Encrypted": false,
"RAIDType": "RAID0",
"CapacityBytes": 107374182400,
"Identifiers": [
{
"DurableNameFormat": "UUID",
"DurableName": "0324c96c-8031-4f5e-886c-50cd90aca854"
}
],
"Links": {
"Drives": [
{
984 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Drives/3D58ECBC375FD9F2"
}
]
},
"Actions": {
"#Volume.Initialize": {
"target": "/redfish/v1/Systems/3/Storage/RAIDIntegrated/Volumes/1/Actions/Volume.Initialize",
"[email protected]": [
"Fast",
"Slow"
]
}
},
"@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Volumes/2"
}
6.141 Zone 1.6.1
Version v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2020.4 2020.3 2019.4 2019.1 2017.3 2017.1 2016.2
6.141.1 Description
The Zone schema describes a simple fabric zone for a Redfish implementation.
6.141.2 URIs
/redfish/v1/CompositionService/ResourceZones/{ZoneId}
/redfish/v1/Fabrics/{FabricId}/Zones/{ZoneId}
6.141.3 Properties
Property Type Attributes Notes
DefaultRoutingEnabled read-write
boolean This property indicates whether routing within this zone is enabled.
(v1.4+) (null)
Indicates accessibility of endpoints in this zone to endpoints outside of
ExternalAccessibility string read-write
this zone. For the possible property values, see ExternalAccessibility in
(v1.3+) (enum) (null)
Property details.
Version 2023.1 Published 985
Redfish Resource and Schema Guide DSP2046
Property Type Attributes Notes
Identifiers (v1.2+) [ { } array
The durable names for the zone. For property details, see Identifier.
] (object)
Links { object The links to other resources that are related to this resource.
AddressPools
array An array of links to the address pools associated with this zone.
(v1.4+) [ {
Link to a AddressPool resource. See the Links section and the
@odata.id string read-only
AddressPool schema for details.
}]
ContainedByZones
array An array of links to the zone that contain this zone.
(v1.4+) [ {
@odata.id string read-only Link to another Zone resource.
}]
ContainsZones
array An array of links to the zones that are contained by this zone.
(v1.4+) [ {
@odata.id string read-write Link to another Zone resource.
}]
Endpoints [ { array The links to the endpoints that this zone contains.
Link to a Endpoint resource. See the Links section and the Endpoint
@odata.id string read-only
schema for details.
}]
InvolvedSwitches [
array The links to the collection of switches in this zone.
{
Link to a Switch resource. See the Links section and the Switch
@odata.id string read-only
schema for details.
}]
Oem {} object See the Oem object definition in the Common properties section.
ResourceBlocks
array The links to the resource blocks with which this zone is associated.
(v1.1+) [ {
Link to a ResourceBlock resource. See the Links section and the
@odata.id string read-only
ResourceBlock schema for details.
}]
986 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Property Type Attributes Notes
The status and health of the resource and its subordinate or
Status {} object
dependent resources. For property details, see Status.
string read-write The type of zone. For the possible property values, see ZoneType in
ZoneType (v1.4+)
(enum) (null) Property details.
6.141.4 Actions
6.141.4.1 AddEndpoint (v1.5+)
Description
This action adds an endpoint to a zone.
Action URI
{Base URI of target resource}/Actions/Zone.AddEndpoint
Action parameters
Parameter Name Type Attributes Notes
The endpoint to add to the zone. See the Endpoint schema for details on
Endpoint { object required
this property.
Link to a Endpoint resource. See the Links section and the Endpoint schema
@odata.id string read-only
for details.
EndpointETag string optional The current ETag of the endpoint to add to the zone.
ZoneETag string optional The current ETag of the zone.
Request Example
{
"Endpoint": {
"@odata.id": "/redfish/v1/Fabrics/SAS/Endpoints/Initiator1"
},
Version 2023.1 Published 987
Redfish Resource and Schema Guide DSP2046
"EndpointETag": "W/\"19472363938\"",
"ZoneETag": "W/\"99374369273\""
}
6.141.4.2 RemoveEndpoint (v1.5+)
Description
This action removes an endpoint from a zone.
Action URI
{Base URI of target resource}/Actions/Zone.RemoveEndpoint
Action parameters
Parameter Name Type Attributes Notes
The endpoint to remove from the zone. See the Endpoint schema for details
Endpoint { object required
on this property.
Link to a Endpoint resource. See the Links section and the Endpoint schema
@odata.id string read-only
for details.
EndpointETag string optional The current ETag of the endpoint to remove from the system.
ZoneETag string optional The current ETag of the zone.
Request Example
{
"Endpoint": {
"@odata.id": "/redfish/v1/Fabrics/SAS/Endpoints/Initiator1"
},
"EndpointETag": "W/\"19472363938\"",
"ZoneETag": "W/\"99374369273\""
}
988 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
6.141.5 Property details
6.141.5.1 ExternalAccessibility
Indicates accessibility of endpoints in this zone to endpoints outside of this zone.
string Description
Any external entity with the correct access details, which may include authorization
GloballyAccessible
information, can access the endpoints that this zone lists.
NoInternalRouting Routing is not enabled within this zone.
Any external entity that another zone does not explicitly list can access the endpoints that
NonZonedAccessible
this zone lists.
ZoneOnly Only accessible by endpoints that this zone explicitly lists.
6.141.5.2 ZoneType
The type of zone.
string Description
Default The zone in which all endpoints are added by default when instantiated.
ZoneOfEndpoints A zone that contains endpoints.
ZoneOfResourceBlocks
A zone that contains resource blocks.
(v1.6+)
ZoneOfZones A zone that contains zones.
6.141.6 Example response
{
"@odata.type": "#Zone.v1_6_1.Zone",
"Id": "1",
"Name": "SAS Zone 1",
"Description": "SAS Zone 1",
"Status": {
"State": "Enabled",
"Health": "OK"
Version 2023.1 Published 989
Redfish Resource and Schema Guide DSP2046
},
"Links": {
"Endpoints": [
{
"@odata.id": "/redfish/v1/Fabrics/SAS/Endpoints/Initiator1"
},
{
"@odata.id": "/redfish/v1/Fabrics/SAS/Endpoints/Initiator2"
},
{
"@odata.id": "/redfish/v1/Fabrics/SAS/Endpoints/Drive1"
},
{
"@odata.id": "/redfish/v1/Fabrics/SAS/Endpoints/Drive3"
}
]
},
"@odata.id": "/redfish/v1/Fabrics/SAS/Zones/1"
}
990 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
7 Redfish documentation generator
This document was created using the Redfish Documentation Generator utility, which uses the
contents of the Redfish schema files (in JSON schema format) to automatically generate the bulk of the
text. The source code for the utility is available for download at DMTF's GitHub repository located at
https://www.github.com/DMTF/Redfish-Tools.
Version 2023.1 Published 991
Redfish Resource and Schema Guide DSP2046
8 ANNEX A (informative) Change log
Version Date Description
2023.1 2023-04-06 Release built from Redfish schemas released in DSP8010 version 2023.1.
2022.3 2022-12-08 Release built from Redfish schemas released in DSP8010 version 2022.3.
Added uuid and duration as known string formats.
Corrrected missing required notations on array properties.
Added supplemental details for HealthRollup .
2022.2 2022-08-04 Release built from Redfish schemas released in DSP8010 version 2022.2.
2022.1 2022-04-15 Release built from Redfish schemas released in DSP8010 version 2022.1.
2021.4 2021-12-02 Release built from Redfish schemas released in DSP8010 version 2021.4.
Added Collection Capabilities section under Resource Collections.
2021.3 2021-10-15 Release built from Redfish schemas released in DSP8010 version 2021.3.
2021.2 2021-08-13 Release built from Redfish schemas released in DSP8010 version 2021.2.
Corrected format of UUID from RFC4122.
2021.1 2021-04-16 Release built from Redfish schemas released in DSP8010 version 2021.1.
Document formatting updated for Documentation Generator v3.
2020.4 2020-12-01 Release built from Redfish schemas released in DSP8010 version 2020.4.
2020.3 2020-08-14 Release built from Redfish schemas released in DSP8010 version 2020.3.
Corrected issue that caused read-write links to be listed as read-only.
2020.2 2020-05-08 Release built from Redfish schemas released in DSP8010 version 2020.2.
2020.1 2020-03-27 Release built from Redfish schemas released in DSP8010 version 2020.1.
2019.4 2019-12-06 Release built from Redfish schemas released in DSP8010 version 2019.4.
2019.3 2019-10-11 Release built from Redfish schemas released in DSP8010 version 2019.3.
2019.2 2019-09-13 Release built from Redfish schemas released in DSP8010 version 2019.2.
2019.1 2019-05-03 Release built from Redfish schemas released in DSP8010 version 2019.1.
Added release version history to match each schema to the DSP8010 version that
included it.
992 Published Version 2023.1
DSP2046 Redfish Resource and Schema Guide
Version Date Description
Added action URIs to the Action Details section, and removed the Action object from
the property table for clarity.
2018.3 2018-12-15 Release built from Redfish schemas released in DSP8010 version 2018.3.
2018.2 2018-08-10 Release built from Redfish schemas released in DSP8010 version 2018.2.
Expanded introduction section with additional information.
Expanded Common Objects section to include previously excluded objects.
Added URI listings for all Resources for use with Redfish Specification v1.6.0.
Added Resource Collection table showing schema names and URIs.
Restructured common objects section utilizing new Documentation Generator
functions.
2018.1 2018-05-01 Initial release. Built from Redfish schemas released in DSP8010 version 2018.1.
2017.0a 2017-05-19 Work in progress release to gather feedback on content and format.
Version 2023.1 Published 993
You might also like
- Bitdefender GravityZone Cloud APIGuide ForCustomers EnUSNo ratings yetBitdefender GravityZone Cloud APIGuide ForCustomers EnUS221 pages
- Open62541-Master Information For This BoNo ratings yetOpen62541-Master Information For This Bo396 pages
- Oracle Ebs Isg Rest Web Services The Ultimate Guide100% (1)Oracle Ebs Isg Rest Web Services The Ultimate Guide79 pages
- SAP Predictive Analytics Developer GuideNo ratings yetSAP Predictive Analytics Developer Guide252 pages
- Home - Latest Documentation - MapR (PDFDrive)No ratings yetHome - Latest Documentation - MapR (PDFDrive)345 pages
- Prosys OPC UA SDK For Java Server TutorialNo ratings yetProsys OPC UA SDK For Java Server Tutorial54 pages
- In 1021 EnterpriseDataCatalog (REST-API) Reference en100% (1)In 1021 EnterpriseDataCatalog (REST-API) Reference en59 pages
- Bitdefender GravityZone Cloud APIGuide Forcustomers enUSNo ratings yetBitdefender GravityZone Cloud APIGuide Forcustomers enUS169 pages
- Dibbler - A Portable Dhcpv6 User'S Guide: Tomek MrugalskiNo ratings yetDibbler - A Portable Dhcpv6 User'S Guide: Tomek Mrugalski113 pages
- TMF640-Service Activation and Configuration-V5.0.0No ratings yetTMF640-Service Activation and Configuration-V5.0.070 pages
- Node Patterns - Databases Volume I - LevelDB, Redis and CouchDBNo ratings yetNode Patterns - Databases Volume I - LevelDB, Redis and CouchDB98 pages
- Pro Power BI Theme Creation: JSON Stylesheets For Automated Dashboard Formatting 2nd Edition Adam Aspin 2024 Scribd Download100% (3)Pro Power BI Theme Creation: JSON Stylesheets For Automated Dashboard Formatting 2nd Edition Adam Aspin 2024 Scribd Download76 pages
- Collapsible Lists in Claris FileMaker - DB ServicesNo ratings yetCollapsible Lists in Claris FileMaker - DB Services7 pages
- Imaster NCE-FAN V100R022C10 Northbound REST API Guide (FAN Sharing)No ratings yetImaster NCE-FAN V100R022C10 Northbound REST API Guide (FAN Sharing)654 pages
- Experience in The Implementation of OOPsNo ratings yetExperience in The Implementation of OOPs1 page
- Caution Required While Grouping in KustoNo ratings yetCaution Required While Grouping in Kusto1 page
- Display Only The Date Part of The Ingestion TimeNo ratings yetDisplay Only The Date Part of The Ingestion Time1 page
- Terraform To Attach A Security Group To An EC2 InstanceNo ratings yetTerraform To Attach A Security Group To An EC2 Instance1 page
- In App Purchase Programming Guide: Networking & InternetNo ratings yetIn App Purchase Programming Guide: Networking & Internet38 pages
- WSO2 Identity Server Authentication From C LibraryNo ratings yetWSO2 Identity Server Authentication From C Library2 pages
- Servicestack Servicestack: Step 1: Create An ApplicationNo ratings yetServicestack Servicestack: Step 1: Create An Application5 pages
- Microservice Design and Architecture: Priyanka Vergadia Developer Advocate, Google CloudNo ratings yetMicroservice Design and Architecture: Priyanka Vergadia Developer Advocate, Google Cloud43 pages
- Vega-Lite for Data Visualization EnthusiastsNo ratings yetVega-Lite for Data Visualization Enthusiasts69 pages
- JavaScript Syllabus & Function ExamplesNo ratings yetJavaScript Syllabus & Function Examples90 pages