Redfish Schema Index

Primary Schema Files

The following files are the primary schemas defined for JSON resources conforming to the Redfish Specification. Each schema definition is available in both CSDL (XML) and json-schema formats. A .ZIP archive (DSP8010) containing all of current schema files (both CSDL and json-schema) can be downloaded from the Redfish Standards page at: http://www.dmtf.org/standards/redfish
AccelerationFunction
[csdl[json-schema] [yaml]
v1.0.4The 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.
AccountService
[csdl[json-schema] [yaml]
v1.15.0The 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 might override these behaviors for special accounts or situations to avoid denial of service or other deadlock situations.
ActionInfo
[csdl[json-schema] [yaml]
v1.4.1The 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.
AddressPool
[csdl[json-schema] [yaml]
v1.2.4The schema definition of an address pool and its configuration.
Aggregate
[csdl[json-schema] [yaml]
v1.0.2The Aggregate schema describes a grouping method for an aggregation service. Aggregates are formal groups of resources that are more persistent than ad hoc groupings.
AggregationService
[csdl[json-schema] [yaml]
v1.0.2The 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.
AggregationSource
[csdl[json-schema] [yaml]
v1.4.0The 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.
AllowDeny
[csdl[json-schema] [yaml]
v1.0.2The AllowDeny schema represents a set of allow or deny configurations.
Application
[csdl[json-schema] [yaml]
v1.0.0The Application schema represents an application or service running on a computer system.
Assembly
[csdl[json-schema] [yaml]
v1.5.0The 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.
AttributeRegistry
[csdl[json-schema] [yaml]
v1.3.8The 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.
Battery
[csdl[json-schema] [yaml]
v1.2.2The 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.
BatteryMetrics
[csdl[json-schema] [yaml]
v1.0.3The BatteryMetrics schema contains definitions for the metrics of a battery unit.
Bios
[csdl[json-schema] [yaml]
v1.2.2The 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.
BootOption
[csdl[json-schema] [yaml]
v1.0.5The BootOption schema reports information about a single boot option in a system. It represents the properties of a bootable device available in the system.
CXLLogicalDevice
[csdl[json-schema] [yaml]
v1.1.1The schema definition for the CXLLogicalDevice resource. It represents the properties of a CXL logical device within a PCIe device.
Cable
[csdl[json-schema] [yaml]
v1.2.2The Cable schema contains properties that describe a cable connecting endpoints of a chassis, port, or any other cable-compatible endpoint.
Certificate
[csdl[json-schema] [yaml]
v1.8.1The Certificate schema describes a certificate that proves the identity of a component, account, or service.
CertificateLocations
[csdl[json-schema] [yaml]
v1.0.3The CertificateLocations schema describes a resource that an administrator can use in order to locate all certificates installed on a given service.
CertificateService
[csdl[json-schema] [yaml]
v1.0.4The CertificateService schema describes a certificate service that represents the actions available to manage certificates and links to the certificates.
Chassis
[csdl[json-schema] [yaml]
v1.25.0The 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.
Circuit
[csdl[json-schema] [yaml]
v1.7.1This is the schema definition for an electrical circuit.
CollectionCapabilities
[csdl[json-schema] [yaml]
v1.4.0This type describes the capabilities of a collection.
ComponentIntegrity
[csdl[json-schema] [yaml]
v1.2.2The ComponentIntegrity resource provides critical and pertinent security information about a specific device, system, software element, or other managed entity.
CompositionReservation
[csdl[json-schema] [yaml]
v1.0.1The CompositionReservation schema contains reservation information related to the Compose action defined in the CompositionService resource when the RequestType parameter contains the value `PreviewReserve`.
CompositionService
[csdl[json-schema] [yaml]
v1.2.2The CompositionService schema describes a composition service and its properties and links to the resources available for composition.
ComputerSystem
[csdl[json-schema] [yaml]
v1.22.0The 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.
Connection
[csdl[json-schema] [yaml]
v1.3.1The Connection schema describes the access permissions that endpoints, or groups of endpoints, have with other resources in the service.
ConnectionMethod
[csdl[json-schema] [yaml]
v1.1.0The ConnectionMethod schema describes the protocol, provider, or other method used to communicate to a given access point for a Redfish aggregation service.
Container
[csdl[json-schema] [yaml]
v1.0.0The Container schema represents an instance of a container that is running on a computer system.
ContainerImage
[csdl[json-schema] [yaml]
v1.0.0The ContainerImage schema represents a container image available to a computer system.
Control
[csdl[json-schema] [yaml]
v1.5.0The Control schema describes a control point and its properties.
CoolantConnector
[csdl[json-schema] [yaml]
v1.0.1This schema describes a liquid coolant connector, including any associated instrumentation.
CoolingLoop
[csdl[json-schema] [yaml]
v1.0.2This schema describes a cooling loop. A cooling loop might be any coolant-carrying vessel, such as facility-level pipework, 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.
CoolingUnit
[csdl[json-schema] [yaml]
v1.1.1This is the schema definition for a cooling system component or unit, such as a coolant distribution unit (CDU) or a heat exchanger.
Drive
[csdl[json-schema] [yaml]
v1.18.0The 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.
DriveMetrics
[csdl[json-schema] [yaml]
v1.2.0The usage and health statistics for a drive.
Endpoint
[csdl[json-schema] [yaml]
v1.8.1The 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.
EndpointGroup
[csdl[json-schema] [yaml]
v1.3.3The EndpointGroup schema describes a group of endpoints that are managed as a unit.
EnvironmentMetrics
[csdl[json-schema] [yaml]
v1.3.1The EnvironmentMetrics schema represents the environmental metrics of a device.
EthernetInterface
[csdl[json-schema] [yaml]
v1.12.0The EthernetInterface schema represents a single, logical Ethernet interface or network interface controller (NIC).
Event
[csdl[json-schema] [yaml]
v1.10.0The 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.
EventDestination
[csdl[json-schema] [yaml]
v1.14.0The EventDestination schema defines the target of an event subscription, including the event types and context to provide to the target in the event payload.
EventService
[csdl[json-schema] [yaml]
v1.10.1The 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.
ExtendedInfo
[json-schema]
v1.0.0
ExternalAccountProvider
[csdl[json-schema] [yaml]
v1.7.1The ExternalAccountProvider schema represents a remote service that provides accounts for this manager to use for authentication.
Fabric
[csdl[json-schema] [yaml]
v1.3.1The Fabric schema represents a simple fabric consisting of one or more switches, zero or more endpoints, and zero or more zones.
FabricAdapter
[csdl[json-schema] [yaml]
v1.5.2A 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.
Facility
[csdl[json-schema] [yaml]
v1.4.1The Facility schema represents the physical location containing equipment, such as a room, building, or campus.
Fan
[csdl[json-schema] [yaml]
v1.5.1The 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.
Filter
[csdl[json-schema] [yaml]
v1.0.1The Filter schema describes a filter unit for a cooling system or similar device.
GraphicsController
[csdl[json-schema] [yaml]
v1.0.1The GraphicsController schema defines a graphics controller that can be used to drive one or more display devices.
Heater
[csdl[json-schema] [yaml]
v1.0.1The Heater schema describes a heating unit for devices contained within a chassis.
HeaterMetrics
[csdl[json-schema] [yaml]
v1.0.1The HeaterMetrics schema contains definitions for the metrics of a heater.
HostInterface
[csdl[json-schema] [yaml]
v1.3.1The properties associated with a Redfish host interface. A Redfish host interface is a connection between host software and a Redfish service.
IPAddresses
[csdl[json-schema] [yaml]
v1.1.4
Job
[csdl[json-schema] [yaml]
v1.2.3The 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.
JobService
[csdl[json-schema] [yaml]
v1.0.5The 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.
JsonSchemaFile
[csdl[json-schema] [yaml]
v1.1.4The JsonSchemaFile schema contains the properties that describe the locations, as URIs, of a Redfish Schema definition that a Redfish Service implements or references.
Key
[csdl[json-schema] [yaml]
v1.4.0The Key schema describes sensitive data for accessing devices or services.
KeyPolicy
[csdl[json-schema] [yaml]
v1.0.0The KeyPolicy schema describes settings for how keys are allowed to be used for accessing devices or services.
KeyService
[csdl[json-schema] [yaml]
v1.0.0The KeyService schema describes a key service that represents the actions available to manage keys.
LeakDetection
[csdl[json-schema] [yaml]
v1.0.0The LeakDetection schema contains definitions for reporting leaks in liquid cooling systems or other equipment.
LeakDetector
[csdl[json-schema] [yaml]
v1.0.1The LeakDetector schema describes a state-based or digital-value leak detector and its properties.
License
[csdl[json-schema] [yaml]
v1.1.2The License schema describes a license for a feature.
LicenseService
[csdl[json-schema] [yaml]
v1.1.1The 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.
LogEntry
[csdl[json-schema] [yaml]
v1.16.0The 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.
LogService
[csdl[json-schema] [yaml]
v1.6.0The 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.
Manager
[csdl[json-schema] [yaml]
v1.19.0In Redfish, a manager is a systems management entity that can implement or provide access to a Redfish service. Examples of managers are BMCs (baseboard management controllers), 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.
ManagerAccount
[csdl[json-schema] [yaml]
v1.12.0The 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.
ManagerDiagnosticData
[csdl[json-schema] [yaml]
v1.2.2The 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.
ManagerNetworkProtocol
[csdl[json-schema] [yaml]
v1.10.0The network service settings for the manager.
Manifest
[csdl[json-schema] [yaml]
v1.1.1This type describes a manifest containing a set of requests to be fulfilled. The manifest contains a set of stanzas, where each stanza describes a single request.
MediaController
[csdl[json-schema] [yaml]
v1.3.1The MediaController schema contains the definition of the media controller and its configuration.
Memory
[csdl[json-schema] [yaml]
v1.19.0The 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.
MemoryChunks
[csdl[json-schema] [yaml]
v1.6.1The schema definition of a memory chunk and its configuration.
MemoryDomain
[csdl[json-schema] [yaml]
v1.5.0The 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.
MemoryMetrics
[csdl[json-schema] [yaml]
v1.7.2The usage and health statistics for a memory device or system memory summary.
MemoryRegion
[csdl[json-schema] [yaml]
v1.0.1The schema definition of a memory region and its configuration.
Message
[csdl[json-schema] [yaml]
v1.2.0The message that the Redfish service returns.
MessageRegistry
[csdl[json-schema] [yaml]
v1.6.2The MessageRegistry schema describes all message registries. It represents the properties for the message registries themselves.
MessageRegistryFile
[csdl[json-schema] [yaml]
v1.1.4The MessageRegistryFile schema describes the registry file locator resource. This referenced registry file can be any type of registry, such as a message registry, privilege registry, or attribute registry.
MetricDefinition
[csdl[json-schema] [yaml]
v1.3.3The MetricDefinition schema describes the metadata information for a metric.
MetricReport
[csdl[json-schema] [yaml]
v1.5.0The MetricReport schema represents a set of collected metrics.
MetricReportDefinition
[csdl[json-schema] [yaml]
v1.4.5The MetricReportDefinition schema describes set of metrics that are collected into a metric report.
NetworkAdapter
[csdl[json-schema] [yaml]
v1.10.0The 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.
NetworkAdapterMetrics
[csdl[json-schema] [yaml]
v1.0.1The NetworkAdapterMetrics schema contains usage and health statistics for a network adapter.
NetworkDeviceFunction
[csdl[json-schema] [yaml]
v1.9.1The NetworkDeviceFunction schema represents a logical interface that a network adapter exposes.
NetworkDeviceFunctionMetrics
[csdl[json-schema] [yaml]
v1.1.2The NetworkDeviceFunctionMetrics schema contains usage and health statistics for a network function of a network adapter.
NetworkInterface
[csdl[json-schema] [yaml]
v1.2.1The NetworkInterface schema describes links to the network adapters, network ports, and network device functions, and represents the functionality available to the containing system.
NetworkPort
[csdl[json-schema] [yaml]
v1.4.2The NetworkPort schema describes a network port, which is a discrete physical port that can connect to a network.
OperatingConfig
[csdl[json-schema] [yaml]
v1.0.3The OperatingConfig schema specifies a configuration that can be used when the processor is operational.
OperatingSystem
[csdl[json-schema] [yaml]
v1.0.1The OperatingSystem schema represents the operating system and software running on a computer system.
OutboundConnection
[csdl[json-schema] [yaml]
v1.0.1The OutboundConnection schema defines how the Redfish service connects to a remote client over a WebSocket connection. This allows a service behind a firewall to establish a connection to a remote client outside of the firewall.
Outlet
[csdl[json-schema] [yaml]
v1.4.2The Outlet schema contains a definition for an electrical outlet.
OutletGroup
[csdl[json-schema] [yaml]
v1.1.2The OutletGroup schema contains definitions for an electrical outlet group.
PCIeDevice
[csdl[json-schema] [yaml]
v1.13.0The 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.
PCIeFunction
[csdl[json-schema] [yaml]
v1.5.1The PCIeFunction schema describes the properties of a PCIe function that is attached to a system.
PCIeSlots
[csdl[json-schema] [yaml]
v1.6.0The PCIeSlots schema describes PCIe slot properties.
PhysicalContext
[csdl[json-schema] [yaml]
v1.3.0
Port
[csdl[json-schema] [yaml]
v1.11.0The Port schema contains properties that describe a port of a switch, controller, chassis, or any other device that could be connected to another entity.
PortMetrics
[csdl[json-schema] [yaml]
v1.5.1The PortMetrics schema contains usage and health statistics for a switch device or component port summary.
Power
[csdl[json-schema] [yaml]
v1.7.2The Power schema describes power metrics and represents the properties for power consumption and power limiting.
PowerDistribution
[csdl[json-schema] [yaml]
v1.3.3This is the schema definition for a power distribution component or unit, such as a floor power distribution unit (PDU) or switchgear.
PowerDistributionMetrics
[csdl[json-schema] [yaml]
v1.3.1This is the schema definition for the metrics of a power distribution component or unit, such as a floor power distribution unit (PDU) or switchgear.
PowerDomain
[csdl[json-schema] [yaml]
v1.2.1The PowerDomain schema contains the definition for the DCIM power domain.
PowerEquipment
[csdl[json-schema] [yaml]
v1.2.1This is the schema definition for the set of power equipment.
PowerSubsystem
[csdl[json-schema] [yaml]
v1.1.1This PowerSubsystem schema contains the definition for the power subsystem of a chassis.
PowerSupply
[csdl[json-schema] [yaml]
v1.5.3The 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.
PowerSupplyMetrics
[csdl[json-schema] [yaml]
v1.1.1The PowerSupplyMetrics schema contains definitions for the metrics of a power supply.
PrivilegeRegistry
[csdl[json-schema] [yaml]
v1.1.4The PrivilegeRegistry schema describes the operation-to-privilege mappings.
Privileges
[csdl[json-schema] [yaml]
v1.0.5
Processor
[csdl[json-schema] [yaml]
v1.19.0The 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.
ProcessorMetrics
[csdl[json-schema] [yaml]
v1.6.3The ProcessorMetrics schema contains usage and health statistics for a processor.
Pump
[csdl[json-schema] [yaml]
v1.0.1The Pump schema describes a pump unit for a cooling system or similar device.
RedfishExtensions
[csdl[json-schema]
v1.0.0
Redundancy
[csdl[json-schema] [yaml]
v1.4.1The common redundancy definition and structure used in other Redfish schemas.
RegisteredClient
[csdl[json-schema] [yaml]
v1.1.1The 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.
Reservoir
[csdl[json-schema] [yaml]
v1.0.1The Reservoir schema describes a reservoir unit for a cooling system or similar device.
ResolutionStep
[csdl[json-schema] [yaml]
v1.0.0This type describes a recommended step of the service-defined resolution.
Resource
[csdl[json-schema] [yaml]
v1.18.0The base type for resources and members that can be linked to.
ResourceBlock
[csdl[json-schema] [yaml]
v1.4.2The ResourceBlock schema contains definitions of a resource block, its components, and affinity to composed devices.
ResourceEvent
[json-schema]
v1.0.0
Role
[csdl[json-schema] [yaml]
v1.3.1The Role schema contains a Redfish role to use in conjunction with a manager account.
RouteEntry
[csdl[json-schema] [yaml]
v1.0.1The RouteEntry schema describes the content of route entry rows. Each route entry contains route sets that list the possible routes for the route entry.
RouteSetEntry
[csdl[json-schema] [yaml]
v1.0.1The RouteSetEntry schema contains the information about a route. It is part of a larger set that contains possible routes for a particular route entry.
Schedule
[csdl[json-schema] [yaml]
v1.2.4Schedule a series of occurrences.
SecureBoot
[csdl[json-schema] [yaml]
v1.1.1The SecureBoot schema contains UEFI Secure Boot information and represents properties for managing the UEFI Secure Boot functionality of a system.
SecureBootDatabase
[csdl[json-schema] [yaml]
v1.0.2The SecureBootDatabase schema describes a UEFI Secure Boot database used to store certificates or hashes.
SecurityPolicy
[csdl[json-schema] [yaml]
v1.0.1The SecurityPolicy resource provides a central point to configure the security policy of a manager.
Sensor
[csdl[json-schema] [yaml]
v1.8.1The Sensor schema describes a sensor and its properties.
SerialInterface
[csdl[json-schema] [yaml]
v1.2.0The SerialInterface schema describes an asynchronous serial interface, such as an RS-232 interface, available to a system or device.
ServiceConditions
[csdl[json-schema] [yaml]
v1.0.0The ServiceConditions schema contains definitions for reporting the conditions present in the service that require attention.
ServiceRoot
[csdl[json-schema] [yaml]
v1.16.1The 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.
Session
[csdl[json-schema] [yaml]
v1.7.1The Session resource describes a single connection (session) between a client and a Redfish service instance.
SessionService
[csdl[json-schema] [yaml]
v1.1.8The SessionService schema describes the session service and its properties, with links to the actual list of sessions.
Settings
[csdl[json-schema] [yaml]
v1.3.5The resource settings.
Signature
[csdl[json-schema] [yaml]
v1.0.2The Signature schema describes a signature or a hash.
SimpleStorage
[csdl[json-schema] [yaml]
v1.3.1The SimpleStorage schema represents the properties of a storage controller and its directly-attached devices.
SoftwareInventory
[csdl[json-schema] [yaml]
v1.10.1The 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.
Storage
[csdl[json-schema] [yaml]
v1.15.1The 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.
StorageController
[csdl[json-schema] [yaml]
v1.7.2The StorageController schema describes a storage controller and its properties. A storage controller represents a physical or virtual storage device that produces volumes.
StorageControllerMetrics
[csdl[json-schema] [yaml]
v1.0.2The usage and health statistics for a storage controller.
Switch
[csdl[json-schema] [yaml]
v1.9.2The Switch schema contains properties that describe a fabric switch.
SwitchMetrics
[csdl[json-schema] [yaml]
v1.0.1The SwitchMetrics schema contains usage and health statistics for a switch device.
Task
[csdl[json-schema] [yaml]
v1.7.3The 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.
TaskService
[csdl[json-schema] [yaml]
v1.2.0The 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.
TelemetryService
[csdl[json-schema] [yaml]
v1.3.3The TelemetryService schema describes a telemetry service. The telemetry service is used for collecting and reporting metric data within the Redfish Service.
Thermal
[csdl[json-schema] [yaml]
v1.7.2The Thermal schema describes temperature monitoring and thermal management subsystems, such as cooling fans, for a computer system or similar devices contained within a chassis.
ThermalEquipment
[csdl[json-schema] [yaml]
v1.1.1This is the schema definition for the set of cooling equipment.
ThermalMetrics
[csdl[json-schema] [yaml]
v1.3.1The ThermalMetrics schema represents the thermal metrics of a chassis.
ThermalSubsystem
[csdl[json-schema] [yaml]
v1.3.1This ThermalSubsystem schema contains the definition for the thermal subsystem of a chassis.
Triggers
[csdl[json-schema] [yaml]
v1.3.2The Triggers schema describes a trigger that applies to metrics.
TrustedComponent
[csdl[json-schema] [yaml]
v1.3.0The TrustedComponent resource represents a trusted device, such as a TPM.
USBController
[csdl[json-schema] [yaml]
v1.0.0The USBController schema defines a Universal Serial Bus controller.
UpdateService
[csdl[json-schema] [yaml]
v1.13.0The 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.
VCATEntry
[csdl[json-schema] [yaml]
v1.0.2The 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.
VLanNetworkInterface
[csdl[json-schema] [yaml]
v1.3.0The VLanNetworkInterface schema describes a VLAN network instance that is available on a manager, system, or other device.
VirtualMedia
[csdl[json-schema] [yaml]
v1.6.3The 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.
Volume
[csdl[json-schema] [yaml]
v1.10.0Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system.
Zone
[csdl[json-schema] [yaml]
v1.6.2The Zone schema describes a simple fabric zone for a Redfish implementation.
odata
[json-schema] [yaml]
v4.0.5
odata-v4
[yaml]
openapi
[yaml]
redfish-error
[json-schema]
v1.0.1
redfish-payload-annotations
[json-schema]
v1.2.2
redfish-payload-annotations-v1
[yaml]
redfish-schema
[json-schema]
v1.10.0

Supporting Schema Files

The following files are supporting schema files, used primarily for programmatic validation of schemas or conformance testing. These support files include schema definitions for each type of 'Collection' defined by the Redfish Specification, and an un-versioned json-schema definition to allow each schema to be revised independently without causing version dependencies.
AccelerationFunction
[json-schema]
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.
AccelerationFunctionCollection
[csdl[json-schema] [yaml]
Unversioned root definition of AccelerationFunctionCollection.
AccountService
[json-schema]
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 might override these behaviors for special accounts or situations to avoid denial of service or other deadlock situations.
ActionInfo
[json-schema]
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.
AddressPool
[json-schema]
The schema definition of an address pool and its configuration.
AddressPoolCollection
[csdl[json-schema] [yaml]
Unversioned root definition of AddressPoolCollection.
Aggregate
[json-schema]
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.
AggregateCollection
[csdl[json-schema] [yaml]
Unversioned root definition of AggregateCollection.
AggregationService
[json-schema]
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.
AggregationSource
[json-schema]
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.
AggregationSourceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of AggregationSourceCollection.
AllowDeny
[json-schema]
The AllowDeny schema represents a set of allow or deny configurations.
AllowDenyCollection
[csdl[json-schema] [yaml]
Unversioned root definition of AllowDenyCollection.
Application
[json-schema]
The Application schema represents an application or service running on a computer system.
ApplicationCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ApplicationCollection.
Assembly
[json-schema]
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.
AttributeRegistry
[json-schema]
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.
Battery
[json-schema]
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.
BatteryCollection
[csdl[json-schema] [yaml]
Unversioned root definition of BatteryCollection.
BatteryMetrics
[json-schema]
The BatteryMetrics schema contains definitions for the metrics of a battery unit.
Bios
[json-schema]
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.
BootOption
[json-schema]
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.
BootOptionCollection
[csdl[json-schema] [yaml]
Unversioned root definition of BootOptionCollection.
CXLLogicalDevice
[json-schema]
The schema definition for the CXLLogicalDevice resource. It represents the properties of a CXL logical device within a PCIe device.
CXLLogicalDeviceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of CXLLogicalDeviceCollection.
Cable
[json-schema]
The Cable schema contains properties that describe a cable connecting endpoints of a chassis, port, or any other cable-compatible endpoint.
CableCollection
[csdl[json-schema] [yaml]
Unversioned root definition of CableCollection.
Certificate
[json-schema]
The Certificate schema describes a certificate that proves the identity of a component, account, or service.
CertificateCollection
[csdl[json-schema] [yaml]
Unversioned root definition of CertificateCollection.
CertificateLocations
[json-schema]
The CertificateLocations schema describes a resource that an administrator can use in order to locate all certificates installed on a given service.
CertificateService
[json-schema]
The CertificateService schema describes a certificate service that represents the actions available to manage certificates and links to the certificates.
Chassis
[json-schema]
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.
ChassisCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ChassisCollection.
Circuit
[json-schema]
This is the schema definition for an electrical circuit.
CircuitCollection
[csdl[json-schema] [yaml]
Unversioned root definition of CircuitCollection.
CollectionCapabilities
[json-schema]
This type describes the capabilities of a collection.
ComponentIntegrity
[json-schema]
The ComponentIntegrity resource provides critical and pertinent security information about a specific device, system, software element, or other managed entity.
ComponentIntegrityCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ComponentIntegrityCollection.
CompositionReservation
[json-schema]
The CompositionReservation schema contains reservation information related to the Compose action defined in the CompositionService resource when the RequestType parameter contains the value `PreviewReserve`.
CompositionReservationCollection
[csdl[json-schema] [yaml]
Unversioned root definition of CompositionReservationCollection.
CompositionService
[json-schema]
The CompositionService schema describes a composition service and its properties and links to the resources available for composition.
ComputerSystem
[json-schema]
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.
ComputerSystemCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ComputerSystemCollection.
Connection
[json-schema]
The Connection schema describes the access permissions that endpoints, or groups of endpoints, have with other resources in the service.
ConnectionCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ConnectionCollection.
ConnectionMethod
[json-schema]
The ConnectionMethod schema describes the protocol, provider, or other method used to communicate to a given access point for a Redfish aggregation service.
ConnectionMethodCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ConnectionMethodCollection.
Container
[json-schema]
The Container schema represents an instance of a container that is running on a computer system.
ContainerCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ContainerCollection.
ContainerImage
[json-schema]
The ContainerImage schema represents a container image available to a computer system.
ContainerImageCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ContainerImageCollection.
Control
[json-schema]
The Control schema describes a control point and its properties.
ControlCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ControlCollection.
CoolantConnector
[json-schema]
This schema describes a liquid coolant connector, including any associated instrumentation.
CoolantConnectorCollection
[csdl[json-schema] [yaml]
Unversioned root definition of CoolantConnectorCollection.
CoolingLoop
[json-schema]
This schema describes a cooling loop. A cooling loop might be any coolant-carrying vessel, such as facility-level pipework, 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.
CoolingLoopCollection
[csdl[json-schema] [yaml]
Unversioned root definition of CoolingLoopCollection.
CoolingUnit
[json-schema]
This is the schema definition for a cooling system component or unit, such as a coolant distribution unit (CDU) or a heat exchanger.
CoolingUnitCollection
[csdl[json-schema] [yaml]
Unversioned root definition of CoolingUnitCollection.
Drive
[json-schema]
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.
DriveCollection
[csdl[json-schema] [yaml]
Unversioned root definition of DriveCollection.
DriveMetrics
[json-schema]
The usage and health statistics for a drive.
Endpoint
[json-schema]
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.
EndpointCollection
[csdl[json-schema] [yaml]
Unversioned root definition of EndpointCollection.
EndpointGroup
[json-schema]
The EndpointGroup schema describes a group of endpoints that are managed as a unit.
EndpointGroupCollection
[csdl[json-schema] [yaml]
Unversioned root definition of EndpointGroupCollection.
EnvironmentMetrics
[json-schema]
The EnvironmentMetrics schema represents the environmental metrics of a device.
EthernetInterface
[json-schema]
The EthernetInterface schema represents a single, logical Ethernet interface or network interface controller (NIC).
EthernetInterfaceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of EthernetInterfaceCollection.
Event
[json-schema]
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.
EventDestination
[json-schema]
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.
EventDestinationCollection
[csdl[json-schema] [yaml]
Unversioned root definition of EventDestinationCollection.
EventService
[json-schema]
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.
ExternalAccountProvider
[json-schema]
The ExternalAccountProvider schema represents a remote service that provides accounts for this manager to use for authentication.
ExternalAccountProviderCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ExternalAccountProviderCollection.
Fabric
[json-schema]
The Fabric schema represents a simple fabric consisting of one or more switches, zero or more endpoints, and zero or more zones.
FabricAdapter
[json-schema]
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.
FabricAdapterCollection
[csdl[json-schema] [yaml]
Unversioned root definition of FabricAdapterCollection.
FabricCollection
[csdl[json-schema] [yaml]
Unversioned root definition of FabricCollection.
Facility
[json-schema]
The Facility schema represents the physical location containing equipment, such as a room, building, or campus.
FacilityCollection
[csdl[json-schema] [yaml]
Unversioned root definition of FacilityCollection.
Fan
[json-schema]
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.
FanCollection
[csdl[json-schema] [yaml]
Unversioned root definition of FanCollection.
Filter
[json-schema]
The Filter schema describes a filter unit for a cooling system or similar device.
FilterCollection
[csdl[json-schema] [yaml]
Unversioned root definition of FilterCollection.
GraphicsController
[json-schema]
The GraphicsController schema defines a graphics controller that can be used to drive one or more display devices.
GraphicsControllerCollection
[csdl[json-schema] [yaml]
Unversioned root definition of GraphicsControllerCollection.
Heater
[json-schema]
The Heater schema describes a heating unit for devices contained within a chassis.
HeaterCollection
[csdl[json-schema] [yaml]
Unversioned root definition of HeaterCollection.
HeaterMetrics
[json-schema]
The HeaterMetrics schema contains definitions for the metrics of a heater.
HostInterface
[json-schema]
The properties associated with a Redfish host interface. A Redfish host interface is a connection between host software and a Redfish service.
HostInterfaceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of HostInterfaceCollection.
IPAddresses
[json-schema]
Job
[json-schema]
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.
JobCollection
[csdl[json-schema] [yaml]
Unversioned root definition of JobCollection.
JobService
[json-schema]
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.
JsonSchemaFile
[json-schema]
The JsonSchemaFile schema contains the properties that describe the locations, as URIs, of a Redfish Schema definition that a Redfish Service implements or references.
JsonSchemaFileCollection
[csdl[json-schema] [yaml]
Unversioned root definition of JsonSchemaFileCollection.
Key
[json-schema]
The Key schema describes sensitive data for accessing devices or services.
KeyCollection
[csdl[json-schema] [yaml]
Unversioned root definition of KeyCollection.
KeyPolicy
[json-schema]
The KeyPolicy schema describes settings for how keys are allowed to be used for accessing devices or services.
KeyPolicyCollection
[csdl[json-schema] [yaml]
Unversioned root definition of KeyPolicyCollection.
KeyService
[json-schema]
The KeyService schema describes a key service that represents the actions available to manage keys.
LeakDetection
[json-schema]
The LeakDetection schema contains definitions for reporting leaks in liquid cooling systems or other equipment.
LeakDetector
[json-schema]
The LeakDetector schema describes a state-based or digital-value leak detector and its properties.
LeakDetectorCollection
[csdl[json-schema] [yaml]
Unversioned root definition of LeakDetectorCollection.
License
[json-schema]
The License schema describes a license for a feature.
LicenseCollection
[csdl[json-schema] [yaml]
Unversioned root definition of LicenseCollection.
LicenseService
[json-schema]
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.
LogEntry
[json-schema]
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.
LogEntryCollection
[csdl[json-schema] [yaml]
Unversioned root definition of LogEntryCollection.
LogService
[json-schema]
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.
LogServiceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of LogServiceCollection.
Manager
[json-schema]
In Redfish, a manager is a systems management entity that can implement or provide access to a Redfish service. Examples of managers are BMCs (baseboard management controllers), 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.
ManagerAccount
[json-schema]
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.
ManagerAccountCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ManagerAccountCollection.
ManagerCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ManagerCollection.
ManagerDiagnosticData
[json-schema]
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.
ManagerNetworkProtocol
[json-schema]
The network service settings for the manager.
Manifest
[json-schema]
This type describes a manifest containing a set of requests to be fulfilled. The manifest contains a set of stanzas, where each stanza describes a single request.
MediaController
[json-schema]
The MediaController schema contains the definition of the media controller and its configuration.
MediaControllerCollection
[csdl[json-schema] [yaml]
Unversioned root definition of MediaControllerCollection.
Memory
[json-schema]
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.
MemoryChunks
[json-schema]
The schema definition of a memory chunk and its configuration.
MemoryChunksCollection
[csdl[json-schema] [yaml]
Unversioned root definition of MemoryChunksCollection.
MemoryCollection
[csdl[json-schema] [yaml]
Unversioned root definition of MemoryCollection.
MemoryDomain
[json-schema]
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.
MemoryDomainCollection
[csdl[json-schema] [yaml]
Unversioned root definition of MemoryDomainCollection.
MemoryMetrics
[json-schema]
The usage and health statistics for a memory device or system memory summary.
MemoryRegion
[json-schema]
The schema definition of a memory region and its configuration.
MemoryRegionCollection
[csdl[json-schema] [yaml]
Unversioned root definition of MemoryRegionCollection.
Message
[json-schema]
The message that the Redfish service returns.
MessageRegistry
[json-schema]
The MessageRegistry schema describes all message registries. It represents the properties for the message registries themselves.
MessageRegistryCollection
[csdl[json-schema] [yaml]
Unversioned root definition of MessageRegistryCollection.
MessageRegistryFile
[json-schema]
The MessageRegistryFile schema describes the registry file locator resource. This referenced registry file can be any type of registry, such as a message registry, privilege registry, or attribute registry.
MessageRegistryFileCollection
[csdl[json-schema] [yaml]
Unversioned root definition of MessageRegistryFileCollection.
MetricDefinition
[json-schema]
The MetricDefinition schema describes the metadata information for a metric.
MetricDefinitionCollection
[csdl[json-schema] [yaml]
Unversioned root definition of MetricDefinitionCollection.
MetricReport
[json-schema]
The MetricReport schema represents a set of collected metrics.
MetricReportCollection
[csdl[json-schema] [yaml]
Unversioned root definition of MetricReportCollection.
MetricReportDefinition
[json-schema]
The MetricReportDefinition schema describes set of metrics that are collected into a metric report.
MetricReportDefinitionCollection
[csdl[json-schema] [yaml]
Unversioned root definition of MetricReportDefinitionCollection.
NetworkAdapter
[json-schema]
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.
NetworkAdapterCollection
[csdl[json-schema] [yaml]
Unversioned root definition of NetworkAdapterCollection.
NetworkAdapterMetrics
[json-schema]
The NetworkAdapterMetrics schema contains usage and health statistics for a network adapter.
NetworkDeviceFunction
[json-schema]
The NetworkDeviceFunction schema represents a logical interface that a network adapter exposes.
NetworkDeviceFunctionCollection
[csdl[json-schema] [yaml]
Unversioned root definition of NetworkDeviceFunctionCollection.
NetworkDeviceFunctionMetrics
[json-schema]
The NetworkDeviceFunctionMetrics schema contains usage and health statistics for a network function of a network adapter.
NetworkInterface
[json-schema]
The NetworkInterface schema describes links to the network adapters, network ports, and network device functions, and represents the functionality available to the containing system.
NetworkInterfaceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of NetworkInterfaceCollection.
NetworkPort
[json-schema]
The NetworkPort schema describes a network port, which is a discrete physical port that can connect to a network.
NetworkPortCollection
[csdl[json-schema] [yaml]
Unversioned root definition of NetworkPortCollection.
OperatingConfig
[json-schema]
The OperatingConfig schema specifies a configuration that can be used when the processor is operational.
OperatingConfigCollection
[csdl[json-schema] [yaml]
Unversioned root definition of OperatingConfigCollection.
OperatingSystem
[json-schema]
The OperatingSystem schema represents the operating system and software running on a computer system.
OutboundConnection
[json-schema]
The OutboundConnection schema defines how the Redfish service connects to a remote client over a WebSocket connection. This allows a service behind a firewall to establish a connection to a remote client outside of the firewall.
OutboundConnectionCollection
[csdl[json-schema] [yaml]
Unversioned root definition of OutboundConnectionCollection.
Outlet
[json-schema]
The Outlet schema contains a definition for an electrical outlet.
OutletCollection
[csdl[json-schema] [yaml]
Unversioned root definition of OutletCollection.
OutletGroup
[json-schema]
The OutletGroup schema contains definitions for an electrical outlet group.
OutletGroupCollection
[csdl[json-schema] [yaml]
Unversioned root definition of OutletGroupCollection.
PCIeDevice
[json-schema]
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.
PCIeDeviceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of PCIeDeviceCollection.
PCIeFunction
[json-schema]
The PCIeFunction schema describes the properties of a PCIe function that is attached to a system.
PCIeFunctionCollection
[csdl[json-schema] [yaml]
Unversioned root definition of PCIeFunctionCollection.
PCIeSlots
[json-schema]
The PCIeSlots schema describes PCIe slot properties.
PhysicalContext
[json-schema]
Port
[json-schema]
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.
PortCollection
[csdl[json-schema] [yaml]
Unversioned root definition of PortCollection.
PortMetrics
[json-schema]
The PortMetrics schema contains usage and health statistics for a switch device or component port summary.
Power
[json-schema]
The Power schema describes power metrics and represents the properties for power consumption and power limiting.
PowerDistribution
[json-schema]
This is the schema definition for a power distribution component or unit, such as a floor power distribution unit (PDU) or switchgear.
PowerDistributionCollection
[csdl[json-schema] [yaml]
Unversioned root definition of PowerDistributionCollection.
PowerDistributionMetrics
[json-schema]
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.
PowerDomain
[json-schema]
The PowerDomain schema contains the definition for the DCIM power domain.
PowerDomainCollection
[csdl[json-schema] [yaml]
Unversioned root definition of PowerDomainCollection.
PowerEquipment
[json-schema]
This is the schema definition for the set of power equipment.
PowerSubsystem
[json-schema]
This PowerSubsystem schema contains the definition for the power subsystem of a chassis.
PowerSupply
[json-schema]
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.
PowerSupplyCollection
[csdl[json-schema] [yaml]
Unversioned root definition of PowerSupplyCollection.
PowerSupplyMetrics
[json-schema]
The PowerSupplyMetrics schema contains definitions for the metrics of a power supply.
PrivilegeRegistry
[json-schema]
The PrivilegeRegistry schema describes the operation-to-privilege mappings.
Privileges
[json-schema]
Processor
[json-schema]
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.
ProcessorCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ProcessorCollection.
ProcessorMetrics
[json-schema]
The ProcessorMetrics schema contains usage and health statistics for a processor.
Protocol
[csdl] [yaml]
Pump
[json-schema]
The Pump schema describes a pump unit for a cooling system or similar device.
PumpCollection
[csdl[json-schema] [yaml]
Unversioned root definition of PumpCollection.
RedfishError
[csdl]
Redundancy
[json-schema]
The common redundancy definition and structure used in other Redfish schemas.
RegisteredClient
[json-schema]
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.
RegisteredClientCollection
[csdl[json-schema] [yaml]
Unversioned root definition of RegisteredClientCollection.
Reservoir
[json-schema]
The Reservoir schema describes a reservoir unit for a cooling system or similar device.
ReservoirCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ReservoirCollection.
ResolutionStep
[json-schema]
This type describes a recommended step of the service-defined resolution.
Resource
[json-schema]
Unversioned root definition of Resource.
ResourceBlock
[json-schema]
The ResourceBlock schema contains definitions of a resource block, its components, and affinity to composed devices.
ResourceBlockCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ResourceBlockCollection.
Role
[json-schema]
The Role schema contains a Redfish role to use in conjunction with a manager account.
RoleCollection
[csdl[json-schema] [yaml]
Unversioned root definition of RoleCollection.
RouteEntry
[json-schema]
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.
RouteEntryCollection
[csdl[json-schema] [yaml]
Unversioned root definition of RouteEntryCollection.
RouteSetEntry
[json-schema]
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.
RouteSetEntryCollection
[csdl[json-schema] [yaml]
Unversioned root definition of RouteSetEntryCollection.
Schedule
[json-schema]
Schedules a series of occurrences.
SecureBoot
[json-schema]
The SecureBoot schema contains UEFI Secure Boot information and represents properties for managing the UEFI Secure Boot functionality of a system.
SecureBootDatabase
[json-schema]
The SecureBootDatabase schema describes a UEFI Secure Boot database used to store certificates or hashes.
SecureBootDatabaseCollection
[csdl[json-schema] [yaml]
Unversioned root definition of SecureBootDatabaseCollection.
SecurityPolicy
[json-schema]
The SecurityPolicy resource provides a central point to configure the security policy of a manager.
Sensor
[json-schema]
The Sensor schema describes a sensor and its properties.
SensorCollection
[csdl[json-schema] [yaml]
Unversioned root definition of SensorCollection.
SerialInterface
[json-schema]
The SerialInterface schema describes an asynchronous serial interface, such as an RS-232 interface, available to a system or device.
SerialInterfaceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of SerialInterfaceCollection.
ServiceConditions
[json-schema]
The ServiceConditions schema contains definitions for reporting the conditions present in the service that require attention.
ServiceRoot
[json-schema]
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.
Session
[json-schema]
The Session resource describes a single connection (session) between a client and a Redfish service instance.
SessionCollection
[csdl[json-schema] [yaml]
Unversioned root definition of SessionCollection.
SessionService
[json-schema]
The SessionService schema describes the session service and its properties, with links to the actual list of sessions.
Settings
[json-schema]
Unversioned root definition of Settings.
Signature
[json-schema]
The Signature schema describes a signature or a hash.
SignatureCollection
[csdl[json-schema] [yaml]
Unversioned root definition of SignatureCollection.
SimpleStorage
[json-schema]
The SimpleStorage schema represents the properties of a storage controller and its directly-attached devices.
SimpleStorageCollection
[csdl[json-schema] [yaml]
Unversioned root definition of SimpleStorageCollection.
SoftwareInventory
[json-schema]
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.
SoftwareInventoryCollection
[csdl[json-schema] [yaml]
Unversioned root definition of SoftwareInventoryCollection.
Storage
[json-schema]
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.
StorageCollection
[csdl[json-schema] [yaml]
Unversioned root definition of StorageCollection.
StorageController
[json-schema]
The StorageController schema describes a storage controller and its properties. A storage controller represents a physical or virtual storage device that produces volumes.
StorageControllerCollection
[csdl[json-schema] [yaml]
Unversioned root definition of StorageControllerCollection.
StorageControllerMetrics
[json-schema]
The usage and health statistics for a storage controller.
Switch
[json-schema]
The Switch schema contains properties that describe a fabric switch.
SwitchCollection
[csdl[json-schema] [yaml]
Unversioned root definition of SwitchCollection.
SwitchMetrics
[json-schema]
The SwitchMetrics schema contains usage and health statistics for a switch device.
Task
[json-schema]
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.
TaskCollection
[csdl[json-schema] [yaml]
Unversioned root definition of TaskCollection.
TaskService
[json-schema]
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.
TelemetryService
[json-schema]
The TelemetryService schema describes a telemetry service. The telemetry service is used for collecting and reporting metric data within the Redfish Service.
Thermal
[json-schema]
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.
ThermalEquipment
[json-schema]
This is the schema definition for the set of cooling equipment.
ThermalMetrics
[json-schema]
The ThermalMetrics schema represents the thermal metrics of a chassis.
ThermalSubsystem
[json-schema]
This ThermalSubsystem schema contains the definition for the thermal subsystem of a chassis.
Triggers
[json-schema]
The Triggers schema describes a trigger that applies to metrics.
TriggersCollection
[csdl[json-schema] [yaml]
Unversioned root definition of TriggersCollection.
TrustedComponent
[json-schema]
The TrustedComponent resource represents a trusted device, such as a TPM.
TrustedComponentCollection
[csdl[json-schema] [yaml]
Unversioned root definition of TrustedComponentCollection.
USBController
[json-schema]
The USBController schema defines a Universal Serial Bus controller.
USBControllerCollection
[csdl[json-schema] [yaml]
Unversioned root definition of USBControllerCollection.
UpdateService
[json-schema]
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.
VCATEntry
[json-schema]
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.
VCATEntryCollection
[csdl[json-schema] [yaml]
Unversioned root definition of VCATEntryCollection.
VLanNetworkInterface
[json-schema]
The VLanNetworkInterface schema describes a VLAN network instance that is available on a manager, system, or other device.
VLanNetworkInterfaceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of VLanNetworkInterfaceCollection.
VirtualMedia
[json-schema]
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.
VirtualMediaCollection
[csdl[json-schema] [yaml]
Unversioned root definition of VirtualMediaCollection.
Volume
[json-schema]
Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system.
VolumeCollection
[csdl[json-schema] [yaml]
Unversioned root definition of VolumeCollection.
Zone
[json-schema]
The Zone schema describes a simple fabric zone for a Redfish implementation.
ZoneCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ZoneCollection.
info
[json-schema]
odata-v4
[json-schema]
redfish-payload-annotations-v1
[json-schema]
redfish-schema-v1
[json-schema]