DMTF
Redfish® Developers Hub
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] | v1.0.5 | 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. |
| AccountService [csdl] | v1.15.1 | 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 [csdl] | v1.4.2 | 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 [csdl] | v1.3.0 | The `AddressPool` schema contains the definition of an address pool and its configuration. |
| Aggregate [csdl] | v1.0.3 | 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. |
| AggregationService [csdl] | v1.0.3 | 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 [csdl] | v1.4.1 | 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. |
| AllowDeny [csdl] | v1.0.3 | The `AllowDeny` schema represents a set of allow or deny configurations. |
| Application [csdl] | v1.0.1 | The `Application` schema represents an application or service running on a computer system. |
| Assembly [csdl] | v1.5.1 | 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 [csdl] | v1.3.9 | 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 [csdl] | v1.3.0 | 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. |
| BatteryMetrics [csdl] | v1.0.4 | The `BatteryMetrics` schema contains definitions for the metrics of a battery unit. |
| Bios [csdl] | v1.2.3 | 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 [csdl] | v1.0.6 | 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. |
| CXLLogicalDevice [csdl] | v1.2.0 | The `CXLLogicalDevice` schema contains the properties of a CXL logical device within a PCIe device. |
| Cable [csdl] | v1.2.3 | The `Cable` schema contains properties that describe a cable connecting endpoints of a chassis, port, or any other cable-compatible endpoint. |
| Certificate [csdl] | v1.8.2 | The `Certificate` schema describes a certificate that proves the identity of a component, account, or service. |
| CertificateLocations [csdl] | v1.0.4 | The `CertificateLocations` schema describes a resource that an administrator can use in order to locate all certificates installed on a given service. |
| CertificateService [csdl] | v1.0.5 | The `CertificateService` schema describes a certificate service that represents the actions available to manage certificates and links to the certificates. |
| Chassis [csdl] | v1.25.1 | 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. |
| Circuit [csdl] | v1.8.0 | This `Circuit` schema contains the definition for an electrical circuit. |
| CollectionCapabilities [csdl] | v1.4.1 | This type describes the capabilities of a collection. |
| ComponentIntegrity [csdl] | v1.2.3 | The `ComponentIntegrity` resource provides critical and pertinent security information about a specific device, system, software element, or other managed entity. |
| CompositionReservation [csdl] | v1.0.2 | The `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] | v1.2.3 | The `CompositionService` schema describes a composition service and its properties and links to the resources available for composition. |
| ComputerSystem [csdl] | v1.22.1 | 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. |
| Connection [csdl] | v1.3.2 | The `Connection` schema describes the access permissions that endpoints, or groups of endpoints, have with other resources in the service. |
| ConnectionMethod [csdl] | v1.1.1 | The `ConnectionMethod` schema describes the protocol, provider, or other method used to communicate to a given access point for a Redfish aggregation service. |
| Container [csdl] | v1.0.1 | The `Container` schema represents an instance of a container that is running on a computer system. |
| ContainerImage [csdl] | v1.0.1 | The `ContainerImage` schema represents a container image available to a computer system. |
| Control [csdl] | v1.5.1 | The `Control` schema describes a control point and its properties. |
| CoolantConnector [csdl] | v1.0.2 | The `CoolantConnector` schema describes a liquid coolant connector, including any associated instrumentation. |
| CoolingLoop [csdl] | v1.0.3 | The `CoolingLoop` 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] | v1.1.2 | The `CoolingUnit` schema contains the definition for a cooling system component or unit, such as a coolant distribution unit (CDU) or a heat exchanger. |
| Drive [csdl] | v1.19.0 | 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. |
| DriveMetrics [csdl] | v1.2.1 | The usage and health statistics for a drive. |
| Endpoint [csdl] | v1.8.2 | 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. |
| EndpointGroup [csdl] | v1.3.4 | The `EndpointGroup` schema describes a group of endpoints that are managed as a unit. |
| EnvironmentMetrics [csdl] | v1.3.2 | The `EnvironmentMetrics` schema represents the environmental metrics of a device. |
| EthernetInterface [csdl] | v1.12.1 | The `EthernetInterface` schema represents a single, logical Ethernet interface or network interface controller (NIC). |
| Event [csdl] | v1.10.1 | 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 [csdl] | v1.14.1 | 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. |
| EventService [csdl] | v1.10.2 | 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. |
| ExtendedInfo | v1.0.0 | |
| ExternalAccountProvider [csdl] | v1.7.2 | The `ExternalAccountProvider` schema represents a remote service that provides accounts for this manager to use for authentication. |
| Fabric [csdl] | v1.3.2 | The `Fabric` schema represents a simple fabric consisting of one or more switches, zero or more endpoints, and zero or more zones. |
| FabricAdapter [csdl] | v1.5.3 | 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. |
| Facility [csdl] | v1.4.2 | The `Facility` schema represents the physical location containing equipment, such as a room, building, or campus. |
| Fan [csdl] | v1.5.2 | 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. |
| Filter [csdl] | v1.0.2 | The `Filter` schema describes a filter unit for a cooling system or similar device. |
| GraphicsController [csdl] | v1.0.2 | The `GraphicsController` schema defines a graphics controller that can be used to drive one or more display devices. |
| Heater [csdl] | v1.0.2 | The `Heater` schema describes a heating unit for devices contained within a chassis. |
| HeaterMetrics [csdl] | v1.0.2 | The `HeaterMetrics` schema contains definitions for the metrics of a heater. |
| HostInterface [csdl] | v1.3.2 | The `HostInterface` schema contains properties associated with a Redfish host interface. A Redfish host interface is a connection between host software and a Redfish service. |
| IPAddresses [csdl] | v1.1.5 | |
| Job [csdl] | v1.2.4 | 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. |
| JobService [csdl] | v1.0.6 | 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 [csdl] | v1.1.5 | The `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] | v1.4.1 | The `Key` schema describes sensitive data for accessing devices or services. |
| KeyPolicy [csdl] | v1.0.1 | The `KeyPolicy` schema describes settings for how keys are allowed to be used for accessing devices or services. |
| KeyService [csdl] | v1.0.1 | The `KeyService` schema describes a key service that represents the actions available to manage keys. |
| LeakDetection [csdl] | v1.0.1 | The `LeakDetection` schema contains definitions for reporting leaks in liquid cooling systems or other equipment. |
| LeakDetector [csdl] | v1.1.0 | The `LeakDetector` schema describes a state-based or digital-value leak detector and its properties. |
| License [csdl] | v1.1.3 | The `License` schema describes a license for a feature. |
| LicenseService [csdl] | v1.1.2 | 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 [csdl] | v1.16.1 | 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`. |
| LogService [csdl] | v1.7.0 | 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. |
| Manager [csdl] | v1.19.1 | 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 [csdl] | v1.12.1 | 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. |
| ManagerDiagnosticData [csdl] | v1.2.3 | 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 [csdl] | v1.10.1 | The network service settings for the manager. |
| Manifest [csdl] | v1.1.2 | 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 [csdl] | v1.3.2 | The `MediaController` schema contains the definition of a media controller and its configuration. |
| Memory [csdl] | v1.20.0 | 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 [csdl] | v1.6.2 | The `MemoryChunks` schema contains the definition of a memory chunk and its configuration. |
| MemoryDomain [csdl] | v1.5.1 | 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. |
| MemoryMetrics [csdl] | v1.7.3 | The `MemoryMetrics` schema contains usage and health statistics for a memory device or system memory summary. |
| MemoryRegion [csdl] | v1.0.2 | The `MemoryRegion` schema contains the definition of a memory region and its configuration. |
| Message [csdl] | v1.2.1 | The message that the Redfish service returns. |
| MessageRegistry [csdl] | v1.6.3 | The `MessageRegistry` schema describes all message registries. It represents the properties for the message registries themselves. |
| MessageRegistryFile [csdl] | v1.1.5 | 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. |
| MetricDefinition [csdl] | v1.3.4 | The `MetricDefinition` schema describes the metadata information for a metric. |
| MetricReport [csdl] | v1.5.1 | The `MetricReport` schema represents a set of collected metrics. |
| MetricReportDefinition [csdl] | v1.4.6 | The `MetricReportDefinition` schema describes set of metrics that are collected into a metric report. |
| NetworkAdapter [csdl] | v1.11.0 | 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. |
| NetworkAdapterMetrics [csdl] | v1.1.0 | The NetworkAdapterMetrics schema contains usage and health statistics for a network adapter. |
| NetworkDeviceFunction [csdl] | v1.9.2 | The `NetworkDeviceFunction` schema represents a logical interface that a network adapter exposes. |
| NetworkDeviceFunctionMetrics [csdl] | v1.2.0 | The `NetworkDeviceFunctionMetrics` schema contains usage and health statistics for a network function of a network adapter. |
| NetworkInterface [csdl] | v1.2.2 | The `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] | v1.4.3 | The `NetworkPort` schema describes a network port, which is a discrete physical port that can connect to a network. |
| OperatingConfig [csdl] | v1.0.4 | The `OperatingConfig` schema specifies a configuration that can be used when the processor is operational. |
| OperatingSystem [csdl] | v1.0.2 | The `OperatingSystem` schema represents the operating system and software running on a computer system. |
| OutboundConnection [csdl] | v1.0.2 | 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. |
| Outlet [csdl] | v1.4.3 | The `Outlet` schema contains a definition for an electrical outlet. |
| OutletGroup [csdl] | v1.2.0 | The `OutletGroup` schema contains definitions for an electrical outlet group. |
| PCIeDevice [csdl] | v1.14.0 | 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. |
| PCIeFunction [csdl] | v1.6.0 | The `PCIeFunction` schema describes the properties of a PCIe function that is attached to a system. |
| PCIeSlots [csdl] | v1.6.1 | The `PCIeSlots` schema describes PCIe slot properties. |
| PhysicalContext [csdl] | v1.3.0 | |
| Port [csdl] | v1.12.0 | 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. |
| PortMetrics [csdl] | v1.6.1 | The `PortMetrics` schema contains usage and health statistics for a switch device or component port summary. |
| Power [csdl] | v1.7.3 | The `Power` schema describes power metrics and represents the properties for power consumption and power limiting. |
| PowerDistribution [csdl] | v1.4.0 | The `PowerDistribution` schema contains the definitions for a power distribution component or unit, such as a floor power distribution unit (PDU) or switchgear. |
| PowerDistributionMetrics [csdl] | v1.3.2 | The `PowerDistributionMetrics` schema contains metrics of a power distribution component or unit, such as a floor power distribution unit (PDU) or switchgear. |
| PowerDomain [csdl] | v1.2.2 | The `PowerDomain` schema contains the definition for the DCIM power domain. |
| PowerEquipment [csdl] | v1.2.2 | The `ThermalEquipment` schema represents the set of power equipment managed by a Redfish service. |
| PowerSubsystem [csdl] | v1.1.2 | This `PowerSubsystem schema` contains the definition for the power subsystem of a chassis. |
| PowerSupply [csdl] | v1.6.0 | 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. |
| PowerSupplyMetrics [csdl] | v1.1.2 | The `PowerSupplyMetrics` schema contains definitions for the metrics of a power supply. |
| PrivilegeRegistry [csdl] | v1.1.5 | The `PrivilegeRegistry` schema describes the operation-to-privilege mappings. |
| Privileges [csdl] | v1.0.6 | |
| Processor [csdl] | v1.20.0 | 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. |
| ProcessorMetrics [csdl] | v1.6.4 | The `ProcessorMetrics` schema contains usage and health statistics for a processor. |
| Pump [csdl] | v1.1.0 | The `Pump` schema describes a pump unit for a cooling system or similar device. |
| RedfishExtensions [csdl] | v1.0.0 | |
| Redundancy [csdl] | v1.4.2 | The common redundancy definition and structure used in other Redfish schemas. |
| RegisteredClient [csdl] | v1.1.2 | 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. |
| Reservoir [csdl] | v1.0.2 | The `Reservoir` schema describes a reservoir unit for a cooling system or similar device. |
| ResolutionStep [csdl] | v1.0.1 | This type describes a recommended step of the service-defined resolution. |
| Resource [csdl] | v1.19.0 | The base type for resources and members that can be linked to. |
| ResourceBlock [csdl] | v1.4.3 | The `ResourceBlock` schema contains definitions of a resource block, its components, and affinity to composed devices. |
| ResourceEvent | v1.0.0 | |
| Role [csdl] | v1.3.2 | The `Role` schema contains a Redfish role to use in conjunction with a manager account. |
| RouteEntry [csdl] | v1.0.2 | 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. |
| RouteSetEntry [csdl] | v1.0.2 | 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. |
| Schedule [csdl] | v1.2.5 | Schedule a series of occurrences. |
| SecureBoot [csdl] | v1.1.2 | The `SecureBoot` schema contains UEFI Secure Boot information and represents properties for managing the UEFI Secure Boot functionality of a system. |
| SecureBootDatabase [csdl] | v1.0.3 | The `SecureBootDatabase` schema describes a UEFI Secure Boot database used to store certificates or hashes. |
| SecurityPolicy [csdl] | v1.0.2 | The `SecurityPolicy` resource provides a central point to configure the security policy of a manager. |
| Sensor [csdl] | v1.9.0 | The `Sensor` schema describes a sensor and its properties. |
| SerialInterface [csdl] | v1.2.1 | The `SerialInterface` schema describes an asynchronous serial interface, such as an RS-232 interface, available to a system or device. |
| ServiceConditions [csdl] | v1.0.1 | The `ServiceConditions` schema contains definitions for reporting the conditions present in the service that require attention. |
| ServiceRoot [csdl] | v1.17.0 | 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 [csdl] | v1.7.2 | The `Session` resource describes a single connection (session) between a client and a Redfish service instance. |
| SessionService [csdl] | v1.1.9 | The `SessionService` schema describes the session service and its properties, with links to the actual list of sessions. |
| Settings [csdl] | v1.4.0 | The resource settings. |
| Signature [csdl] | v1.0.3 | The `Signature` schema describes a signature or a hash. |
| SimpleStorage [csdl] | v1.3.2 | The `SimpleStorage` schema represents the properties of a storage controller and its directly-attached devices. |
| SoftwareInventory [csdl] | v1.10.2 | 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. |
| Storage [csdl] | v1.16.0 | 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. |
| StorageController [csdl] | v1.7.3 | The `StorageController` schema describes a storage controller and its properties. A storage controller represents a physical or virtual storage device that produces volumes. |
| StorageControllerMetrics [csdl] | v1.0.3 | The usage and health statistics for a storage controller. |
| Switch [csdl] | v1.9.3 | The `Switch` schema contains properties that describe a fabric switch. |
| SwitchMetrics [csdl] | v1.0.2 | The `SwitchMetrics` schema contains usage and health statistics for a switch device. |
| Task [csdl] | v1.7.4 | 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. |
| TaskService [csdl] | v1.2.1 | 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 [csdl] | v1.3.4 | The `TelemetryService` schema describes a telemetry service. The telemetry service is used for collecting and reporting metric data within the Redfish service. |
| Thermal [csdl] | v1.7.3 | The `Therma`l 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] | v1.1.2 | The `ThermalEquipment` schema represents the set of cooling equipment managed by a Redfish service. |
| ThermalMetrics [csdl] | v1.3.2 | The `ThermalMetrics` schema represents the thermal metrics of a chassis. |
| ThermalSubsystem [csdl] | v1.3.2 | The `ThermalSubsystem` schema contains the definition for the thermal subsystem of a chassis. |
| Triggers [csdl] | v1.4.0 | The `Triggers` schema describes a trigger condition that applies to metrics. |
| TrustedComponent [csdl] | v1.3.1 | The `TrustedComponent` resource represents a trusted device, such as a TPM. |
| USBController [csdl] | v1.0.1 | The `USBController` schema defines a Universal Serial Bus controller. |
| UpdateService [csdl] | v1.14.0 | 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 [csdl] | v1.0.3 | 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. |
| VLanNetworkInterface [csdl] | v1.3.1 | The `VLanNetworkInterface` schema describes a VLAN network instance that is available on a manager, system, or other device. |
| VirtualMedia [csdl] | v1.6.4 | 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. |
| Volume [csdl] | v1.10.0 | Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system. |
| Zone [csdl] | v1.6.3 | The `Zone` schema describes a simple fabric zone for a Redfish implementation. |
| odata | v4.0.5 | |
| odata-v4 [yaml] | ||
| openapi [yaml] | ||
| redfish-error | v1.0.2 | |
| redfish-payload-annotations | v1.2.2 | |
| redfish-payload-annotations-v1 [yaml] | ||
| redfish-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 | 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] | Unversioned root definition of AccelerationFunctionCollection. | |
| AccountService | 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 | 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 | The `AddressPool` schema contains the definition of an address pool and its configuration. | |
| AddressPoolCollection [csdl] | Unversioned root definition of AddressPoolCollection. | |
| Aggregate | 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] | Unversioned root definition of AggregateCollection. | |
| AggregationService | 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 | 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] | Unversioned root definition of AggregationSourceCollection. | |
| AllowDeny | The `AllowDeny` schema represents a set of allow or deny configurations. | |
| AllowDenyCollection [csdl] | Unversioned root definition of AllowDenyCollection. | |
| Application | The `Application` schema represents an application or service running on a computer system. | |
| ApplicationCollection [csdl] | Unversioned root definition of ApplicationCollection. | |
| Assembly | 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 | 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 | 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] | Unversioned root definition of BatteryCollection. | |
| BatteryMetrics | The `BatteryMetrics` schema contains definitions for the metrics of a battery unit. | |
| Bios | 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 | 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] | Unversioned root definition of BootOptionCollection. | |
| CXLLogicalDevice | The `CXLLogicalDevice` schema contains the properties of a CXL logical device within a PCIe device. | |
| CXLLogicalDeviceCollection [csdl] | Unversioned root definition of CXLLogicalDeviceCollection. | |
| Cable | The `Cable` schema contains properties that describe a cable connecting endpoints of a chassis, port, or any other cable-compatible endpoint. | |
| CableCollection [csdl] | Unversioned root definition of CableCollection. | |
| Certificate | The `Certificate` schema describes a certificate that proves the identity of a component, account, or service. | |
| CertificateCollection [csdl] | Unversioned root definition of CertificateCollection. | |
| CertificateLocations | The `CertificateLocations` schema describes a resource that an administrator can use in order to locate all certificates installed on a given service. | |
| CertificateService | The `CertificateService` schema describes a certificate service that represents the actions available to manage certificates and links to the certificates. | |
| Chassis | 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] | Unversioned root definition of ChassisCollection. | |
| Circuit | This `Circuit` schema contains the definition for an electrical circuit. | |
| CircuitCollection [csdl] | Unversioned root definition of CircuitCollection. | |
| CollectionCapabilities | This type describes the capabilities of a collection. | |
| ComponentIntegrity | The `ComponentIntegrity` resource provides critical and pertinent security information about a specific device, system, software element, or other managed entity. | |
| ComponentIntegrityCollection [csdl] | Unversioned root definition of ComponentIntegrityCollection. | |
| CompositionReservation | 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] | Unversioned root definition of CompositionReservationCollection. | |
| CompositionService | The `CompositionService` schema describes a composition service and its properties and links to the resources available for composition. | |
| ComputerSystem | 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] | Unversioned root definition of ComputerSystemCollection. | |
| Connection | The `Connection` schema describes the access permissions that endpoints, or groups of endpoints, have with other resources in the service. | |
| ConnectionCollection [csdl] | Unversioned root definition of ConnectionCollection. | |
| ConnectionMethod | 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] | Unversioned root definition of ConnectionMethodCollection. | |
| Container | The `Container` schema represents an instance of a container that is running on a computer system. | |
| ContainerCollection [csdl] | Unversioned root definition of ContainerCollection. | |
| ContainerImage | The `ContainerImage` schema represents a container image available to a computer system. | |
| ContainerImageCollection [csdl] | Unversioned root definition of ContainerImageCollection. | |
| Control | The `Control` schema describes a control point and its properties. | |
| ControlCollection [csdl] | Unversioned root definition of ControlCollection. | |
| CoolantConnector | The `CoolantConnector` schema describes a liquid coolant connector, including any associated instrumentation. | |
| CoolantConnectorCollection [csdl] | Unversioned root definition of CoolantConnectorCollection. | |
| CoolingLoop | The `CoolingLoop` 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] | Unversioned root definition of CoolingLoopCollection. | |
| CoolingUnit | The `CoolingUnit` schema contains the definition for a cooling system component or unit, such as a coolant distribution unit (CDU) or a heat exchanger. | |
| CoolingUnitCollection [csdl] | Unversioned root definition of CoolingUnitCollection. | |
| Drive | 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] | Unversioned root definition of DriveCollection. | |
| DriveMetrics | The usage and health statistics for a drive. | |
| Endpoint | 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] | Unversioned root definition of EndpointCollection. | |
| EndpointGroup | The `EndpointGroup` schema describes a group of endpoints that are managed as a unit. | |
| EndpointGroupCollection [csdl] | Unversioned root definition of EndpointGroupCollection. | |
| EnvironmentMetrics | The `EnvironmentMetrics` schema represents the environmental metrics of a device. | |
| EthernetInterface | The `EthernetInterface` schema represents a single, logical Ethernet interface or network interface controller (NIC). | |
| EthernetInterfaceCollection [csdl] | Unversioned root definition of EthernetInterfaceCollection. | |
| Event | 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 | 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] | Unversioned root definition of EventDestinationCollection. | |
| EventService | 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 | The `ExternalAccountProvider` schema represents a remote service that provides accounts for this manager to use for authentication. | |
| ExternalAccountProviderCollection [csdl] | Unversioned root definition of ExternalAccountProviderCollection. | |
| Fabric | The `Fabric` schema represents a simple fabric consisting of one or more switches, zero or more endpoints, and zero or more zones. | |
| FabricAdapter | 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] | Unversioned root definition of FabricAdapterCollection. | |
| FabricCollection [csdl] | Unversioned root definition of FabricCollection. | |
| Facility | The `Facility` schema represents the physical location containing equipment, such as a room, building, or campus. | |
| FacilityCollection [csdl] | Unversioned root definition of FacilityCollection. | |
| Fan | 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] | Unversioned root definition of FanCollection. | |
| Filter | The `Filter` schema describes a filter unit for a cooling system or similar device. | |
| FilterCollection [csdl] | Unversioned root definition of FilterCollection. | |
| GraphicsController | The `GraphicsController` schema defines a graphics controller that can be used to drive one or more display devices. | |
| GraphicsControllerCollection [csdl] | Unversioned root definition of GraphicsControllerCollection. | |
| Heater | The `Heater` schema describes a heating unit for devices contained within a chassis. | |
| HeaterCollection [csdl] | Unversioned root definition of HeaterCollection. | |
| HeaterMetrics | The `HeaterMetrics` schema contains definitions for the metrics of a heater. | |
| HostInterface | The `HostInterface` schema contains properties associated with a Redfish host interface. A Redfish host interface is a connection between host software and a Redfish service. | |
| HostInterfaceCollection [csdl] | Unversioned root definition of HostInterfaceCollection. | |
| IPAddresses | ||
| Job | 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] | Unversioned root definition of JobCollection. | |
| JobService | 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 | 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] | Unversioned root definition of JsonSchemaFileCollection. | |
| Key | The `Key` schema describes sensitive data for accessing devices or services. | |
| KeyCollection [csdl] | Unversioned root definition of KeyCollection. | |
| KeyPolicy | The `KeyPolicy` schema describes settings for how keys are allowed to be used for accessing devices or services. | |
| KeyPolicyCollection [csdl] | Unversioned root definition of KeyPolicyCollection. | |
| KeyService | The `KeyService` schema describes a key service that represents the actions available to manage keys. | |
| LeakDetection | The `LeakDetection` schema contains definitions for reporting leaks in liquid cooling systems or other equipment. | |
| LeakDetector | The `LeakDetector` schema describes a state-based or digital-value leak detector and its properties. | |
| LeakDetectorCollection [csdl] | Unversioned root definition of LeakDetectorCollection. | |
| License | The `License` schema describes a license for a feature. | |
| LicenseCollection [csdl] | Unversioned root definition of LicenseCollection. | |
| LicenseService | 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 | 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] | Unversioned root definition of LogEntryCollection. | |
| LogService | 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] | Unversioned root definition of LogServiceCollection. | |
| Manager | 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 | 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] | Unversioned root definition of ManagerAccountCollection. | |
| ManagerCollection [csdl] | Unversioned root definition of ManagerCollection. | |
| ManagerDiagnosticData | 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 | The network service settings for the manager. | |
| Manifest | 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 | The `MediaController` schema contains the definition of a media controller and its configuration. | |
| MediaControllerCollection [csdl] | Unversioned root definition of MediaControllerCollection. | |
| Memory | 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 | The `MemoryChunks` schema contains the definition of a memory chunk and its configuration. | |
| MemoryChunksCollection [csdl] | Unversioned root definition of MemoryChunksCollection. | |
| MemoryCollection [csdl] | Unversioned root definition of MemoryCollection. | |
| MemoryDomain | 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] | Unversioned root definition of MemoryDomainCollection. | |
| MemoryMetrics | The `MemoryMetrics` schema contains usage and health statistics for a memory device or system memory summary. | |
| MemoryRegion | The `MemoryRegion` schema contains the definition of a memory region and its configuration. | |
| MemoryRegionCollection [csdl] | Unversioned root definition of MemoryRegionCollection. | |
| Message | The message that the Redfish service returns. | |
| MessageRegistry | The `MessageRegistry` schema describes all message registries. It represents the properties for the message registries themselves. | |
| MessageRegistryCollection [csdl] | Unversioned root definition of MessageRegistryCollection. | |
| MessageRegistryFile | 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] | Unversioned root definition of MessageRegistryFileCollection. | |
| MetricDefinition | The `MetricDefinition` schema describes the metadata information for a metric. | |
| MetricDefinitionCollection [csdl] | Unversioned root definition of MetricDefinitionCollection. | |
| MetricReport | The `MetricReport` schema represents a set of collected metrics. | |
| MetricReportCollection [csdl] | Unversioned root definition of MetricReportCollection. | |
| MetricReportDefinition | The `MetricReportDefinition` schema describes set of metrics that are collected into a metric report. | |
| MetricReportDefinitionCollection [csdl] | Unversioned root definition of MetricReportDefinitionCollection. | |
| NetworkAdapter | 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] | Unversioned root definition of NetworkAdapterCollection. | |
| NetworkAdapterMetrics | The NetworkAdapterMetrics schema contains usage and health statistics for a network adapter. | |
| NetworkDeviceFunction | The `NetworkDeviceFunction` schema represents a logical interface that a network adapter exposes. | |
| NetworkDeviceFunctionCollection [csdl] | Unversioned root definition of NetworkDeviceFunctionCollection. | |
| NetworkDeviceFunctionMetrics | The `NetworkDeviceFunctionMetrics` schema contains usage and health statistics for a network function of a network adapter. | |
| NetworkInterface | 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] | Unversioned root definition of NetworkInterfaceCollection. | |
| NetworkPort | The `NetworkPort` schema describes a network port, which is a discrete physical port that can connect to a network. | |
| NetworkPortCollection [csdl] | Unversioned root definition of NetworkPortCollection. | |
| OperatingConfig | The `OperatingConfig` schema specifies a configuration that can be used when the processor is operational. | |
| OperatingConfigCollection [csdl] | Unversioned root definition of OperatingConfigCollection. | |
| OperatingSystem | The `OperatingSystem` schema represents the operating system and software running on a computer system. | |
| OutboundConnection | 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] | Unversioned root definition of OutboundConnectionCollection. | |
| Outlet | The `Outlet` schema contains a definition for an electrical outlet. | |
| OutletCollection [csdl] | Unversioned root definition of OutletCollection. | |
| OutletGroup | The `OutletGroup` schema contains definitions for an electrical outlet group. | |
| OutletGroupCollection [csdl] | Unversioned root definition of OutletGroupCollection. | |
| PCIeDevice | 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] | Unversioned root definition of PCIeDeviceCollection. | |
| PCIeFunction | The `PCIeFunction` schema describes the properties of a PCIe function that is attached to a system. | |
| PCIeFunctionCollection [csdl] | Unversioned root definition of PCIeFunctionCollection. | |
| PCIeSlots | The `PCIeSlots` schema describes PCIe slot properties. | |
| PhysicalContext | ||
| Port | 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] | Unversioned root definition of PortCollection. | |
| PortMetrics | The `PortMetrics` schema contains usage and health statistics for a switch device or component port summary. | |
| Power | The `Power` schema describes power metrics and represents the properties for power consumption and power limiting. | |
| PowerDistribution | The `PowerDistribution` schema contains the definitions for a power distribution component or unit, such as a floor power distribution unit (PDU) or switchgear. | |
| PowerDistributionCollection [csdl] | Unversioned root definition of PowerDistributionCollection. | |
| PowerDistributionMetrics | The `PowerDistributionMetrics` schema contains metrics of a power distribution component or unit, such as a floor power distribution unit (PDU) or switchgear. | |
| PowerDomain | The `PowerDomain` schema contains the definition for the DCIM power domain. | |
| PowerDomainCollection [csdl] | Unversioned root definition of PowerDomainCollection. | |
| PowerEquipment | The `ThermalEquipment` schema represents the set of power equipment managed by a Redfish service. | |
| PowerSubsystem | This `PowerSubsystem schema` contains the definition for the power subsystem of a chassis. | |
| PowerSupply | 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] | Unversioned root definition of PowerSupplyCollection. | |
| PowerSupplyMetrics | The `PowerSupplyMetrics` schema contains definitions for the metrics of a power supply. | |
| PrivilegeRegistry | The `PrivilegeRegistry` schema describes the operation-to-privilege mappings. | |
| Privileges | ||
| Processor | 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] | Unversioned root definition of ProcessorCollection. | |
| ProcessorMetrics | The `ProcessorMetrics` schema contains usage and health statistics for a processor. | |
| Protocol [csdl] [yaml] | ||
| Pump | The `Pump` schema describes a pump unit for a cooling system or similar device. | |
| PumpCollection [csdl] | Unversioned root definition of PumpCollection. | |
| RedfishError [csdl] | ||
| Redundancy | The common redundancy definition and structure used in other Redfish schemas. | |
| RegisteredClient | 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] | Unversioned root definition of RegisteredClientCollection. | |
| Reservoir | The `Reservoir` schema describes a reservoir unit for a cooling system or similar device. | |
| ReservoirCollection [csdl] | Unversioned root definition of ReservoirCollection. | |
| ResolutionStep | This type describes a recommended step of the service-defined resolution. | |
| Resource | Unversioned root definition of Resource. | |
| ResourceBlock | The `ResourceBlock` schema contains definitions of a resource block, its components, and affinity to composed devices. | |
| ResourceBlockCollection [csdl] | Unversioned root definition of ResourceBlockCollection. | |
| Role | The `Role` schema contains a Redfish role to use in conjunction with a manager account. | |
| RoleCollection [csdl] | Unversioned root definition of RoleCollection. | |
| RouteEntry | 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] | Unversioned root definition of RouteEntryCollection. | |
| RouteSetEntry | 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] | Unversioned root definition of RouteSetEntryCollection. | |
| Schedule | Schedules a series of occurrences. | |
| SecureBoot | The `SecureBoot` schema contains UEFI Secure Boot information and represents properties for managing the UEFI Secure Boot functionality of a system. | |
| SecureBootDatabase | The `SecureBootDatabase` schema describes a UEFI Secure Boot database used to store certificates or hashes. | |
| SecureBootDatabaseCollection [csdl] | Unversioned root definition of SecureBootDatabaseCollection. | |
| SecurityPolicy | The `SecurityPolicy` resource provides a central point to configure the security policy of a manager. | |
| Sensor | The `Sensor` schema describes a sensor and its properties. | |
| SensorCollection [csdl] | Unversioned root definition of SensorCollection. | |
| SerialInterface | The `SerialInterface` schema describes an asynchronous serial interface, such as an RS-232 interface, available to a system or device. | |
| SerialInterfaceCollection [csdl] | Unversioned root definition of SerialInterfaceCollection. | |
| ServiceConditions | The `ServiceConditions` schema contains definitions for reporting the conditions present in the service that require attention. | |
| ServiceRoot | 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 | The `Session` resource describes a single connection (session) between a client and a Redfish service instance. | |
| SessionCollection [csdl] | Unversioned root definition of SessionCollection. | |
| SessionService | The `SessionService` schema describes the session service and its properties, with links to the actual list of sessions. | |
| Settings | Unversioned root definition of Settings. | |
| Signature | The `Signature` schema describes a signature or a hash. | |
| SignatureCollection [csdl] | Unversioned root definition of SignatureCollection. | |
| SimpleStorage | The `SimpleStorage` schema represents the properties of a storage controller and its directly-attached devices. | |
| SimpleStorageCollection [csdl] | Unversioned root definition of SimpleStorageCollection. | |
| SoftwareInventory | 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] | Unversioned root definition of SoftwareInventoryCollection. | |
| Storage | 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] | Unversioned root definition of StorageCollection. | |
| StorageController | 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] | Unversioned root definition of StorageControllerCollection. | |
| StorageControllerMetrics | The usage and health statistics for a storage controller. | |
| Switch | The `Switch` schema contains properties that describe a fabric switch. | |
| SwitchCollection [csdl] | Unversioned root definition of SwitchCollection. | |
| SwitchMetrics | The `SwitchMetrics` schema contains usage and health statistics for a switch device. | |
| Task | 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] | Unversioned root definition of TaskCollection. | |
| TaskService | 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 | The `TelemetryService` schema describes a telemetry service. The telemetry service is used for collecting and reporting metric data within the Redfish service. | |
| Thermal | The `Therma`l schema describes temperature monitoring and thermal management subsystems, such as cooling fans, for a computer system or similar devices contained within a chassis. | |
| ThermalEquipment | The `ThermalEquipment` schema represents the set of cooling equipment managed by a Redfish service. | |
| ThermalMetrics | The `ThermalMetrics` schema represents the thermal metrics of a chassis. | |
| ThermalSubsystem | The `ThermalSubsystem` schema contains the definition for the thermal subsystem of a chassis. | |
| Triggers | The `Triggers` schema describes a trigger condition that applies to metrics. | |
| TriggersCollection [csdl] | Unversioned root definition of TriggersCollection. | |
| TrustedComponent | The `TrustedComponent` resource represents a trusted device, such as a TPM. | |
| TrustedComponentCollection [csdl] | Unversioned root definition of TrustedComponentCollection. | |
| USBController | The `USBController` schema defines a Universal Serial Bus controller. | |
| USBControllerCollection [csdl] | Unversioned root definition of USBControllerCollection. | |
| UpdateService | 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 | 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] | Unversioned root definition of VCATEntryCollection. | |
| VLanNetworkInterface | The `VLanNetworkInterface` schema describes a VLAN network instance that is available on a manager, system, or other device. | |
| VLanNetworkInterfaceCollection [csdl] | Unversioned root definition of VLanNetworkInterfaceCollection. | |
| VirtualMedia | 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] | Unversioned root definition of VirtualMediaCollection. | |
| Volume | Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system. | |
| VolumeCollection [csdl] | Unversioned root definition of VolumeCollection. | |
| Zone | The `Zone` schema describes a simple fabric zone for a Redfish implementation. | |
| ZoneCollection [csdl] | Unversioned root definition of ZoneCollection. | |
| info | ||
| odata-v4 | ||
| redfish-payload-annotations-v1 | ||
| redfish-schema-v1 |