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

AccountService
[csdl] [json-schema]
v1.3.0The AccountService schema contains properties for managing user accounts. The properties are common to all user accounts, such as password requirements, and control features such as account lockout. The schema also contains links to the collections of Manager Accounts and Roles.
ActionInfo
[csdl] [json-schema]
v1.0.3The ActionInfo schema describes the parameters and other information necessary to perform a Redfish Action on a particular Action target. Parameter support can differ between vendors and even between instances of a resource. This data can be used to ensure Action requests from applications contain supported parameters.
Assembly
[csdl] [json-schema]
v1.1.0This is the schema definition for the Assembly properties.
AttributeRegistry
[csdl] [json-schema]
v1.2.0The AttributeRegistry schema contains a set of key-value pairs that represents the structure of a Registry. It includes mechanisms for building user interfaces (menus), allowing consistent navigation of the contents. The Attribute Registry is specific to a particular implementation or product. The attributes and property names are not standardized.
Bios
[csdl] [json-schema]
v1.0.3The 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.
BootOption
[csdl] [json-schema]
v1.0.0This is the schema definition for the BootOption resource. It represents the properties of a bootable device available in the System.
Chassis
[csdl] [json-schema]
v1.7.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 (like sensors) that operate outside of a system's data plane (meaning the resources are not accessible to software running on the system) are linked either directly or indirectly through this resource.
CollectionCapabilities
[csdl] [json-schema]
v1.0.0This type describes the capabilities of a collection.
CompositionService
[csdl] [json-schema]
v1.0.1The CompositionService schema defines a Composition Service which represents the properties for the service and links to the resources available for composition.
ComputerSystem
[csdl] [json-schema]
v1.5.0This schema defines a computer system and its respective properties. A computer system represents a machine (physical or virtual) and the local resources such as memory, cpu and other devices that can be accessed from that machine.
Drive
[csdl] [json-schema]
v1.4.0The Drive schema represents a single physical disk drive for a system, including links to associated Volumes.
Endpoint
[csdl] [json-schema]
v1.1.0This is the schema definition for the Endpoint resource. It represents the properties of an entity that sends or receives protocol defined messages over a transport.
EthernetInterface
[csdl] [json-schema]
v1.4.0The EthernetInterface schema represents a single, logical ethernet interface or network interface controller (NIC).
Event
[csdl] [json-schema]
v1.2.1The Event schema describes the JSON payload received by an Event Destination (which has subscribed to event notification) when events occurs. This resource contains data about event(s), including descriptions, severity and MessageId reference to a Message Registry that can be accessed for further information.
EventDestination
[csdl] [json-schema]
v1.3.0An Event Destination desribes the target of an event subscription, including the types of events subscribed and context to provide to the target in the Event payload.
EventService
[csdl] [json-schema]
v1.1.0The Event Service resource contains properties for managing event subcriptions and generates the events sent to subscribers. The resource has links to the actual collection of subscriptions (called Event Destinations).
ExternalAccountProvider
[csdl] [json-schema]
v1.0.0A remote service that can provide accounts for this manager to utilize for authentication.
Fabric
[csdl] [json-schema]
v1.0.3The Fabric schema represents a simple fabric consisting of one or more switches, zero or more endpoints, and zero or more zones.
HostInterface
[csdl] [json-schema]
v1.1.2This schema defines a single Host Interface resource.
IPAddresses
[csdl] [json-schema]
v1.0.6
JsonSchemaFile
[csdl] [json-schema]
v1.1.0This is the schema definition for the Schema File locator resource.
LogEntry
[csdl] [json-schema]
v1.3.0This resource defines the record format for a log. It is designed to be used for SEL logs (from IPMI) as well as Event Logs and OEM-specific log formats. The EntryType field indicates the type of log and the resource includes several additional properties dependent on the EntryType.
LogService
[csdl] [json-schema]
v1.1.0This resource represents the log service for the resource or service to which it is associated.
Manager
[csdl] [json-schema]
v1.4.0This is the schema definition for a Manager. Examples of managers are BMCs, Enclosure Managers, Management Controllers and other subsystems assigned managability functions.
ManagerAccount
[csdl] [json-schema]
v1.1.2The user accounts, owned by a Manager, are defined in this resource. Changes to a Manager Account may affect the current Redfish service connection if this manager is responsible for the Redfish service.
ManagerNetworkProtocol
[csdl] [json-schema]
v1.2.0This resource is used to obtain or modify the network services managed by a given manager.
Memory
[csdl] [json-schema]
v1.5.0This is the schema definition for definition of a Memory and its configuration.
MemoryChunks
[csdl] [json-schema]
v1.2.1This is the schema definition of a Memory Chunk and its configuration.
MemoryDomain
[csdl] [json-schema]
v1.2.0This is the schema definition of a Memory Domain and its configuration. Memory Domains are used to indicate to the client which Memory (DIMMs) can be grouped together in Memory Chunks to form interleave sets or otherwise grouped together.
MemoryMetrics
[csdl] [json-schema]
v1.1.3MemoryMetrics contains usage and health statistics for a single Memory module or device instance.
Message
[csdl] [json-schema]
v1.0.5This type describes a Message returned by the Redfish service.
MessageRegistry
[csdl] [json-schema]
v1.1.1This is the schema definition for all Message Registries. It represents the properties for the registries themselves. The MessageId is formed per the Redfish specification. It consists of the RegistryPrefix concatenated with the version concatenated with the unique identifier for the message registry entry.
MessageRegistryFile
[csdl] [json-schema]
v1.1.0This is the schema definition for the Schema File locator resource.
NetworkAdapter
[csdl] [json-schema]
v1.1.0A NetworkAdapter represents the physical network adapter capable of connecting to a computer network. Examples include but are not limited to Ethernet, Fibre Channel, and converged network adapters.
NetworkDeviceFunction
[csdl] [json-schema]
v1.2.1A Network Device Function represents a logical interface exposed by the network adapter.
NetworkInterface
[csdl] [json-schema]
v1.1.0A NetworkInterface contains references linking NetworkAdapter, NetworkPort, and NetworkDeviceFunction resources and represents the functionality available to the containing system.
NetworkPort
[csdl] [json-schema]
v1.1.0A Network Port represents a discrete physical port capable of connecting to a network.
PCIeDevice
[csdl] [json-schema]
v1.2.0This is the schema definition for the PCIeDevice resource. It represents the properties of a PCIeDevice attached to a System.
PCIeFunction
[csdl] [json-schema]
v1.2.0This is the schema definition for the PCIeFunction resource. It represents the properties of a PCIeFunction attached to a System.
PhysicalContext
[csdl] [json-schema]
v1.3.0
Port
[csdl] [json-schema]
v1.1.0Port contains properties describing a port of a switch.
Power
[csdl] [json-schema]
v1.5.0This is the schema definition for the Power Metrics. It represents the properties for Power Consumption and Power Limiting.
PrivilegeRegistry
[csdl] [json-schema]
v1.1.1This is the schema definition for Operation to Privilege mapping.
Privileges
[csdl] [json-schema]
v1.0.4
Processor
[csdl] [json-schema]
v1.3.0This is the schema definition for the Processor resource. It represents the properties of a processor attached to a System.
Redundancy
[csdl] [json-schema]
v1.3.0This is the redundancy definition to be used in other resource schemas.
Resource
[csdl] [json-schema]
v1.6.0This is the base type for resources and referenceable members.
ResourceBlock
[csdl] [json-schema]
v1.1.0This schema defines a Resource Block resource.
Role
[csdl] [json-schema]
v1.2.1This resource defines a user role to be used in conjunction with a Manager Account.
SecureBoot
[csdl] [json-schema]
v1.0.3This resource contains UEFI Secure Boot information. It represents properties for managing the UEFI Secure Boot functionality of a system.
SerialInterface
[csdl] [json-schema]
v1.1.2This schema defines an asynchronous serial interface resource.
ServiceRoot
[csdl] [json-schema]
v1.3.1This object represents the root Redfish service.
Session
[csdl] [json-schema]
v1.1.0The Session resource describes a single connection (session) between a client and a Redfish service instance.
SessionService
[csdl] [json-schema]
v1.1.3This is the schema definition for the Session Service. It represents the properties for the service itself and has links to the actual list of sessions.
Settings
[csdl] [json-schema]
v1.2.0This type describes the settings of a resouce.
SimpleStorage
[csdl] [json-schema]
v1.2.0This is the schema definition for the Simple Storage resource. It represents the properties of a storage controller and its directly-attached devices.
SoftwareInventory
[csdl] [json-schema]
v1.2.0This schema defines an inventory of software components.
Storage
[csdl] [json-schema]
v1.4.0This schema defines a storage subsystem and its respective properties. A storage subsystem represents a set of storage controllers (physical or virtual) and the resources such as volumes that can be accessed from that subsystem.
Switch
[csdl] [json-schema]
v1.1.0Switch contains properties describing a simple fabric switch.
Task
[csdl] [json-schema]
v1.2.0This resource contains information about a specific Task scheduled by or being executed by a Redfish service's Task Service.
TaskService
[csdl] [json-schema]
v1.1.1This is the schema definition for the Task Service. It represents the properties for the service itself and has links to the actual list of tasks.
Thermal
[csdl] [json-schema]
v1.4.0This is the schema definition for the Thermal properties. It represents the properties for Temperature and Cooling.
UpdateService
[csdl] [json-schema]
v1.2.1This is the schema definition for the Update Service. It represents the properties for the service itself and has links to collections of firmware and software inventory.
VLanNetworkInterface
[csdl] [json-schema]
v1.1.1This resource describes the attributes of a Virtual LAN.
VirtualMedia
[csdl] [json-schema]
v1.2.0The VirtualMedia schema contains properties related to monitoring and control of an instance of virtual media such as a remote CD, DVD, or USB device. Virtual media functionality is provided by a Manager for a system or device.
Volume
[csdl] [json-schema]
v1.0.3Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system.
Zone
[csdl] [json-schema]
v1.2.0The Zone schema represents a fabric zone.
odata
[json-schema]
v4.0.2
redfish-schema
[json-schema]
v1.4.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.

AccountService
[json-schema]
The AccountService schema contains properties for managing user accounts. The properties are common to all user accounts, such as password requirements, and control features such as account lockout. The schema also contains links to the collections of Manager Accounts and Roles.
ActionInfo
[json-schema]
The ActionInfo schema describes the parameters and other information necessary to perform a Redfish Action on a particular Action target. Parameter support can differ between vendors and even between instances of a resource. This data can be used to ensure Action requests from applications contain supported parameters.
Assembly
[json-schema]
This is the schema definition for the Assembly properties.
AttributeRegistry
[json-schema]
The AttributeRegistry schema contains a set of key-value pairs that represents the structure of a Registry. It includes mechanisms for building user interfaces (menus), allowing consistent navigation of the contents. The Attribute Registry is specific to a particular implementation or product. The attributes and property names are not standardized.
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.
BootOption
[json-schema]
The BootOption resource reports information about a single BootOption contained within a system.
BootOptionCollection
[csdl] [json-schema]
Unversioned root definition of BootOptionCollection.
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 (like sensors) that operate outside of a system's data plane (meaning the resources are not accessible to software running on the system) are linked either directly or indirectly through this resource.
ChassisCollection
[csdl] [json-schema]
Unversioned root definition of ChassisCollection.
CollectionCapabilities
[json-schema]
Unversioned root definition of CollectionCapabilities.
CompositionService
[json-schema]
The CompositionService schema defines a Composition Service which represents the properties for the service and links to the resources available for composition.
ComputerSystem
[json-schema]
The ComputerSystem schema represents a general purpose machine or system (as opposed to an appliance) instance and the software-visible resources (items within the data plane) such as memory, CPU and other devices that can be accessed from that machine. Details of those resources or subsystems are also linked through this resource.
ComputerSystemCollection
[csdl] [json-schema]
Unversioned root definition of ComputerSystemCollection.
Drive
[json-schema]
The Drive schema represents a single physical disk drive for a system, including links to associated Volumes.
Endpoint
[json-schema]
The Endpoint schema defines the properties of an Endpoint resource. It represents the properties of an entity that sends or receives protocol defined messages over a transport.
EndpointCollection
[csdl] [json-schema]
Unversioned root definition of EndpointCollection.
EthernetInterface
[json-schema]
The EthernetInterface schema represents a single, logical ethernet interface or network interface controller (NIC).
EthernetInterfaceCollection
[csdl] [json-schema]
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 occurs. This resource contains data about event(s), including descriptions, severity and MessageId reference to a Message Registry that can be accessed for further information.
EventDestination
[json-schema]
An Event Destination desribes the target of an event subscription, including the types of events subscribed and context to provide to the target in the Event payload.
EventDestinationCollection
[csdl] [json-schema]
Unversioned root definition of EventDestinationCollection.
EventService
[json-schema]
The Event Service resource contains properties for managing event subcriptions and generates the events sent to subscribers. The resource has links to the actual collection of subscriptions (called Event Destinations).
ExternalAccountProvider
[json-schema]
A remote service that can provide accounts for this manager to utilize for authentication.
ExternalAccountProviderCollection
[csdl] [json-schema]
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.
FabricCollection
[csdl] [json-schema]
Unversioned root definition of FabricCollection.
HostInterface
[json-schema]
The properties associated with a single, Host Interface.
HostInterfaceCollection
[csdl] [json-schema]
Unversioned root definition of HostInterfaceCollection.
IPAddresses
[json-schema]
JsonSchemaFile
[json-schema]
The JSON Schema File resource describes the location (URI) of a particular Redfish schema definition being implemented or referenced by a Redfish service.
JsonSchemaFileCollection
[csdl] [json-schema]
Unversioned root definition of JsonSchemaFileCollection.
LogEntry
[json-schema]
This resource defines the record format for a log. It is designed to be used for SEL logs (from IPMI) as well as Event Logs and OEM-specific log formats. The EntryType field indicates the type of log and the resource includes several additional properties dependent on the EntryType.
LogEntryCollection
[csdl] [json-schema]
Unversioned root definition of LogEntryCollection.
LogService
[json-schema]
This resource contains properties for monitoring and configuring an event log service for the resource or service to which it is associated.
LogServiceCollection
[csdl] [json-schema]
Unversioned root definition of LogServiceCollection.
Manager
[json-schema]
In Redfish, a Manager is a systems management entity which may implement or provide access to a Redfish service. Examples of managers are BMCs, Enclosure Managers, Management Controllers and other subsystems assigned managability functions. There may be multiple Managers in an implementation, and they may or may not be directly accessible via a Redfish-defined interface.
ManagerAccount
[json-schema]
The user accounts, owned by a Manager, are defined in this resource. Changes to a Manager Account may affect the current Redfish service connection if this manager is responsible for the Redfish service.
ManagerAccountCollection
[csdl] [json-schema]
Unversioned root definition of ManagerAccountCollection.
ManagerCollection
[csdl] [json-schema]
Unversioned root definition of ManagerCollection.
ManagerNetworkProtocol
[json-schema]
This resource is used to obtain or modify the network services managed by a given manager.
Memory
[json-schema]
This is the schema definition of the Memory and its configuration.
MemoryChunks
[json-schema]
This is the schema definition of a Memory Chunk and its configuration.
MemoryChunksCollection
[csdl] [json-schema]
Unversioned root definition of MemoryChunksCollection.
MemoryCollection
[csdl] [json-schema]
Unversioned root definition of MemoryCollection.
MemoryDomain
[json-schema]
This is the schema definition of a Memory Domain and its configuration. Memory Domains are used to indicate to the client which Memory (DIMMs) can be grouped together in Memory Chunks to form interleave sets or otherwise grouped together.
MemoryDomainCollection
[csdl] [json-schema]
Unversioned root definition of MemoryDomainCollection.
MemoryMetrics
[json-schema]
MemoryMetrics contains usage and health statistics for a single Memory module or device instance.
Message
[json-schema]
This type describes a Message returned by the Redfish service.
MessageRegistry
[json-schema]
This is the schema definition for all Message Registries. It represents the properties for the registries themselves. The MessageId is formed per the Redfish specification. It consists of the RegistryPrefix concatenated with the version concatenated with the unique identifier for the message registry entry.
MessageRegistryCollection
[csdl] [json-schema]
Unversioned root definition of MessageRegistryCollection.
MessageRegistryFile
[json-schema]
This is the schema definition for the Schema File locator resource.
MessageRegistryFileCollection
[csdl] [json-schema]
Unversioned root definition of MessageRegistryFileCollection.
NetworkAdapter
[json-schema]
A NetworkAdapter represents the 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]
Unversioned root definition of NetworkAdapterCollection.
NetworkDeviceFunction
[json-schema]
The NetworkDeviceFunction schema represents a logical interface exposed by the network adapter.
NetworkDeviceFunctionCollection
[csdl] [json-schema]
Unversioned root definition of NetworkDeviceFunctionCollection.
NetworkInterface
[json-schema]
A NetworkInterface contains references linking NetworkAdapter, NetworkPort, and NetworkDeviceFunction resources and represents the functionality available to the containing system.
NetworkInterfaceCollection
[csdl] [json-schema]
Unversioned root definition of NetworkInterfaceCollection.
NetworkPort
[json-schema]
A Network Port represents a discrete physical port capable of connecting to a network.
NetworkPortCollection
[csdl] [json-schema]
Unversioned root definition of NetworkPortCollection.
PCIeDevice
[json-schema]
This is the schema definition for the PCIeDevice resource. It represents the properties of a PCIeDevice attached to a System.
PCIeFunction
[json-schema]
This is the schema definition for the PCIeFunction resource. It represents the properties of a PCIeFunction attached to a System.
PhysicalContext
[json-schema]
Port
[json-schema]
Port contains properties describing a port of a switch.
PortCollection
[csdl] [json-schema]
Unversioned root definition of PortCollection.
Power
[json-schema]
This is the schema definition for the Power Metrics. It represents the properties for Power Consumption and Power Limiting.
PrivilegeRegistry
[json-schema]
This is the schema definition for Operation to Privilege mapping.
Privileges
[json-schema]
Processor
[json-schema]
The Processor resource reports information about a single processor contained within a system. This includes both performance characteristics (clock speed, architecture, core count, etc.) and compatibility (e.g. CPU ID instruction results).
ProcessorCollection
[csdl] [json-schema]
Unversioned root definition of ProcessorCollection.
Protocol
[csdl]
RedfishExtensions
[csdl]
Redundancy
[json-schema]
This is the common redundancy definition and structure used in other Redfish schemas.
Resource
[json-schema]
Unversioned root definition of Resource.
ResourceBlock
[json-schema]
This is the schema definition of the Resource Block, its components, and affinity to composed devices.
ResourceBlockCollection
[csdl] [json-schema]
Unversioned root definition of ResourceBlockCollection.
Role
[json-schema]
This schema defines a user role to be used in conjunction with a manager account.
RoleCollection
[csdl] [json-schema]
Unversioned root definition of RoleCollection.
SecureBoot
[json-schema]
This resource contains UEFI Secure Boot information. It represents properties for managing the UEFI Secure Boot functionality of a system.
SerialInterface
[json-schema]
This resource describes an asynchronous serial interface, such as an RS-232 interface, available to a system or device.
SerialInterfaceCollection
[csdl] [json-schema]
Unversioned root definition of SerialInterfaceCollection.
ServiceRoot
[json-schema]
This resource represents the root of the Redfish service, located at the \redfish\v1 URI. As a hypermedia API, 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]
Unversioned root definition of SessionCollection.
SessionService
[json-schema]
This is the schema definition for the Session Service. It represents the properties for the service itself and has links to the actual list of sessions.
Settings
[json-schema]
Unversioned root definition of Settings.
SimpleStorage
[json-schema]
This is the schema definition for the Simple Storage resource. It represents the properties of a storage controller and its directly-attached devices.
SimpleStorageCollection
[csdl] [json-schema]
Unversioned root definition of SimpleStorageCollection.
SoftwareInventory
[json-schema]
This schema defines an inventory of software components.
SoftwareInventoryCollection
[csdl] [json-schema]
Unversioned root definition of SoftwareInventoryCollection.
Storage
[json-schema]
Storage defines a storage subsystem and its respective properties. A storage subsystem represents a set of storage controllers (physical or virtual) and the resources such as volumes that can be accessed from that subsystem.
StorageCollection
[csdl] [json-schema]
Unversioned root definition of StorageCollection.
Switch
[json-schema]
Switch contains properties describing a simple fabric switch.
SwitchCollection
[csdl] [json-schema]
Unversioned root definition of SwitchCollection.
Task
[json-schema]
This resource contains information about a specific Task scheduled by or being executed by a Redfish service's Task Service.
TaskCollection
[csdl] [json-schema]
Unversioned root definition of TaskCollection.
TaskService
[json-schema]
The Task Service of a Redfish service allows scheduling and execution of long-duration processes. It represents the properties for the Task Service itself and has links to the actual collection of Task resources.
Thermal
[json-schema]
This is the schema definition for the Thermal properties. It represents the properties for Temperature and Cooling.
UpdateService
[json-schema]
This is the schema definition for the Update Service. It represents the properties for the service itself and has links to collections of firmware and software inventory.
VLanNetworkInterface
[json-schema]
This resource contains information for a Virtual LAN (VLAN) network instance available on a manager, system or other device.
VLanNetworkInterfaceCollection
[csdl] [json-schema]
Unversioned root definition of VLanNetworkInterfaceCollection.
VirtualMedia
[json-schema]
The VirtualMedia schema contains properties related to monitoring and control of an instance of virtual media such as a remote CD, DVD, or USB device. Virtual media functionality is provided by a Manager for a system or device.
VirtualMediaCollection
[csdl] [json-schema]
Unversioned root definition of VirtualMediaCollection.
Volume
[json-schema]
Unversioned root definition of Volume.
VolumeCollection
[csdl] [json-schema]
A Collection of Storage resource instances.
Zone
[json-schema]
The Zone schema represents a fabric zone.
ZoneCollection
[csdl] [json-schema]
Unversioned root definition of ZoneCollection.