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.2.1Account Service contains properties common to all user accounts, such as password requirements, and control features such as account lockout. It also contains links to the collections of Manager Accounts and Roles.
ActionInfo
[csdl] [json-schema]
v1.0.2ActionInfo describes the parameters and other information necessary to perform a Redfish Action to a particular Action target. As parameter support may differ between implementations and even among instances of a resource, this data can be used to ensure Action requests from applications contain supported parameters.
AttributeRegistry
[csdl] [json-schema]
v1.1.0An Attribute Registry is a set of key-value pairs which are specific to a particular implementation or product, such that creating standardized property names would be impractical. This schema describes the structure of a Registry, and also includes mechanisms for building user interfaces (menus) allowing consistent navigation of the contents.
Bios
[csdl] [json-schema]
v1.0.2Bios contains properties surrounding a BIOS Attribute Registry (where the system-specific BIOS attributes are described) and the Actions needed to perform changes to BIOS settings, which typically require a system reset to apply.
Chassis
[csdl] [json-schema]
v1.5.1A Chassis represents the physical components for any system. This resource represents the sheet-metal confined spaces and logical zones like racks, enclosures, chassis and all other containers. Subsystems (like sensors), which 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.0This is the schema definition for the Composition Service. It represents the properties for the service itself and has links to the actual list of resources available for composition.
ComputerSystem
[csdl] [json-schema]
v1.4.1This 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.2.0Drive contains properties describing a single physical disk drive for any system, along with links to associated Volumes.
Endpoint
[csdl] [json-schema]
v1.0.2This 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.3.0This schema defines a simple ethernet NIC resource.
Event
[csdl] [json-schema]
v1.2.0The 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.2.1An 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.0.5The 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).
ExtendedInfo
[json-schema]
v1.0.0
Fabric
[csdl] [json-schema]
v1.0.2Fabric contains properties describing a simple fabric consisting of one or more switches, zero or more endpoints, and zero or more zones.
HostInterface
[csdl] [json-schema]
v1.1.0This schema defines a Host Interface resource.
IPAddresses
[csdl] [json-schema]
v1.0.5
JsonSchemaFile
[csdl] [json-schema]
v1.1.0This is the schema definition for the Schema File locator resource.
LogEntry
[csdl] [json-schema]
v1.2.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.0.4This resource represents the log service for the resource or service to which it is associated.
Manager
[csdl] [json-schema]
v1.3.2This 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.1The 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.3.0This is the schema definition for definition of a Memory and its configuration.
MemoryChunks
[csdl] [json-schema]
v1.1.0This 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.2MemoryMetrics 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.0This 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.0.1A 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.1.0A 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.1.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.1.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.2.0
Port
[csdl] [json-schema]
v1.0.2Port contains properties describing a port of a switch.
Power
[csdl] [json-schema]
v1.4.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.0This is the schema definition for Operation to Privilege mapping.
Privileges
[csdl] [json-schema]
v1.0.3
Processor
[csdl] [json-schema]
v1.1.0This is the schema definition for the Processor resource. It represents the properties of a processor attached to a System.
RedfishExtensions
[csdl] [json-schema]
v1.0.0
Redundancy
[csdl] [json-schema]
v1.2.0This is the redundancy definition to be used in other resource schemas.
Resource
[csdl] [json-schema]
v1.5.0This is the base type for resources and referenceable members.
ResourceBlock
[csdl] [json-schema]
v1.0.0This schema defines a Resource Block resource.
Role
[csdl] [json-schema]
v1.2.0This resource defines a user role to be used in conjunction with a Manager Account.
SecureBoot
[csdl] [json-schema]
v1.0.2This 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.1This schema defines an asynchronous serial interface resource.
ServiceRoot
[csdl] [json-schema]
v1.2.0This 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.1.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.1.1This schema defines an inventory of software components.
Storage
[csdl] [json-schema]
v1.3.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.0.2Switch contains properties describing a simple fabric switch.
Task
[csdl] [json-schema]
v1.1.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.0This 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.3.1This is the schema definition for the Thermal properties. It represents the properties for Temperature and Cooling.
UpdateService
[csdl] [json-schema]
v1.2.0This 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.0This resource describes the attributes of a Virtual LAN.
VirtualMedia
[csdl] [json-schema]
v1.1.0This resource allows monitoring and control of an instance of virtual media (e.g. a remote CD, DVD, or USB device) functionality 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.1.0Switch contains properties describing a simple fabric zone.
odata
[json-schema]
v4.0.0
redfish-schema
[json-schema]
v1.2.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]
Unversioned root definition of AccountService.
ActionInfo
[json-schema]
Unversioned root definition of ActionInfo.
AttributeRegistry
[json-schema]
Unversioned root definition of AttributeRegistry.
Bios
[json-schema]
Unversioned root definition of Bios.
Chassis
[json-schema]
Unversioned root definition of Chassis.
ChassisCollection
[csdl] [json-schema]
A Collection of Chassis resource instances.
CollectionCapabilities
[json-schema]
CompositionService
[json-schema]
Unversioned root definition of CompositionService.
ComputerSystem
[json-schema]
Unversioned root definition of ComputerSystem.
ComputerSystemCollection
[csdl] [json-schema]
A Collection of ComputerSystem resource instances.
Drive
[json-schema]
Unversioned root definition of Drive.
Endpoint
[json-schema]
Unversioned root definition of Endpoint.
EndpointCollection
[csdl] [json-schema]
Unversioned root definition of EndpointCollection.
EthernetInterface
[json-schema]
Unversioned root definition of EthernetInterface.
EthernetInterfaceCollection
[csdl] [json-schema]
A Collection of EthernetInterface resource instances.
Event
[json-schema]
Unversioned root definition of Event.
EventDestination
[json-schema]
Unversioned root definition of EventDestination.
EventDestinationCollection
[csdl] [json-schema]
A Collection of EventDestination resource instances.
EventService
[json-schema]
Unversioned root definition of EventService.
Fabric
[json-schema]
Unversioned root definition of Fabric.
FabricCollection
[csdl] [json-schema]
A Collection of Fabric resource instances.
HostInterface
[json-schema]
Unversioned root definition of HostInterface.
HostInterfaceCollection
[csdl] [json-schema]
A Collection of HostInterface resource instances.
JsonSchemaFile
[json-schema]
Unversioned root definition of JsonSchemaFile.
JsonSchemaFileCollection
[csdl] [json-schema]
A Collection of JsonSchemaFile resource instances.
LogEntry
[json-schema]
Unversioned root definition of LogEntry.
LogEntryCollection
[csdl] [json-schema]
A Collection of LogEntry resource instances.
LogService
[json-schema]
Unversioned root definition of LogService.
LogServiceCollection
[csdl] [json-schema]
A Collection of LogService resource instances.
Manager
[json-schema]
Unversioned root definition of Manager.
ManagerAccount
[json-schema]
Unversioned root definition of ManagerAccount.
ManagerAccountCollection
[csdl] [json-schema]
A Collection of ManagerAccount resource instances.
ManagerCollection
[csdl] [json-schema]
A Collection of Manager resource instances.
ManagerNetworkProtocol
[json-schema]
Unversioned root definition of ManagerNetworkProtocol.
Memory
[json-schema]
Unversioned root definition of Memory.
MemoryChunks
[json-schema]
Unversioned root definition of MemoryChunks.
MemoryChunksCollection
[csdl] [json-schema]
Unversioned root definition of MemoryChunksCollection.
MemoryCollection
[csdl] [json-schema]
A Collection of Memory resource instances.
MemoryDomain
[json-schema]
Unversioned root definition of MemoryDomain.
MemoryDomainCollection
[csdl] [json-schema]
Unversioned root definition of MemoryDomainCollection.
MemoryMetrics
[json-schema]
Unversioned root definition of MemoryMetrics.
Message
[json-schema]
This type describes a Message returned by the Redfish service.
MessageRegistry
[json-schema]
Unversioned root definition of MessageRegistry.
MessageRegistryCollection
[csdl] [json-schema]
A Collection of MessageRegistry resource instances.
MessageRegistryFile
[json-schema]
Unversioned root definition of MessageRegistryFile.
MessageRegistryFileCollection
[csdl] [json-schema]
A Collection of MessageRegistryFile resource instances.
NetworkAdapter
[json-schema]
Unversioned root definition of NetworkAdapter.
NetworkAdapterCollection
[csdl] [json-schema]
A Collection of NetworkAdapter resource instances.
NetworkDeviceFunction
[json-schema]
Unversioned root definition of NetworkDeviceFunction.
NetworkDeviceFunctionCollection
[csdl] [json-schema]
A Collection of NetworkDeviceFunction resource instances.
NetworkInterface
[json-schema]
Unversioned root definition of NetworkInterface.
NetworkInterfaceCollection
[csdl] [json-schema]
A Collection of NetworkInterface resource instances.
NetworkPort
[json-schema]
Unversioned root definition of NetworkPort.
NetworkPortCollection
[csdl] [json-schema]
A Collection of NetworkPort resource instances.
PCIeDevice
[json-schema]
Unversioned root definition of PCIeDevice.
PCIeFunction
[json-schema]
Unversioned root definition of PCIeFunction.
Port
[json-schema]
Unversioned root definition of Port.
PortCollection
[csdl] [json-schema]
A Collection of Port resource instances.
Power
[json-schema]
Unversioned root definition of Power.
PrivilegeRegistry
[json-schema]
Unversioned root definition of PrivilegeRegistry.
Processor
[json-schema]
Unversioned root definition of Processor.
ProcessorCollection
[csdl] [json-schema]
A Collection of Processor resource instances.
Redundancy
[json-schema]
Unversioned root definition of Redundancy.
Resource
[json-schema]
ResourceBlock
[json-schema]
Unversioned root definition of ResourceBlock.
ResourceBlockCollection
[csdl] [json-schema]
A Collection of ResourceBlock resource instances.
Role
[json-schema]
Unversioned root definition of Role.
RoleCollection
[csdl] [json-schema]
A Collection of Role resource instances.
SecureBoot
[json-schema]
Unversioned root definition of SecureBoot.
SerialInterface
[json-schema]
Unversioned root definition of SerialInterface.
SerialInterfaceCollection
[csdl] [json-schema]
A Collection of SerialInterface resource instances.
ServiceRoot
[json-schema]
Unversioned root definition of ServiceRoot.
Session
[json-schema]
Unversioned root definition of Session.
SessionCollection
[csdl] [json-schema]
A Collection of Session resource instances.
SessionService
[json-schema]
Unversioned root definition of SessionService.
Settings
[json-schema]
Unversioned root definition of Settings.
SimpleStorage
[json-schema]
Unversioned root definition of SimpleStorage.
SimpleStorageCollection
[csdl] [json-schema]
A Collection of SimpleStorage resource instances.
SoftwareInventory
[json-schema]
Unversioned root definition of SoftwareInventory.
SoftwareInventoryCollection
[csdl] [json-schema]
Unversioned root definition of SoftwareInventoryCollection.
Storage
[json-schema]
Unversioned root definition of Storage.
StorageCollection
[csdl] [json-schema]
A Collection of Storage resource instances.
Switch
[json-schema]
Unversioned root definition of Switch.
SwitchCollection
[csdl] [json-schema]
A Collection of Switch resource instances.
Task
[json-schema]
Unversioned root definition of Task.
TaskCollection
[csdl] [json-schema]
A Collection of Task resource instances.
TaskService
[json-schema]
Unversioned root definition of TaskService.
Thermal
[json-schema]
Unversioned root definition of Thermal.
UpdateService
[json-schema]
Unversioned root definition of UpdateService.
VLanNetworkInterface
[json-schema]
Unversioned root definition of VLanNetworkInterface.
VLanNetworkInterfaceCollection
[csdl] [json-schema]
A Collection of VLanNetworkInterface resource instances.
VirtualMedia
[json-schema]
Unversioned root definition of VirtualMedia.
VirtualMediaCollection
[csdl] [json-schema]
A Collection of VirtualMedia resource instances.
Volume
[json-schema]
Unversioned root definition of Volume.
VolumeCollection
[csdl] [json-schema]
A Collection of Storage resource instances.
Zone
[json-schema]
Unversioned root definition of Zone.
ZoneCollection
[csdl] [json-schema]
A Collection of Zone resource instances.