Redfish Schema Index


Primary Schema Files

The following files are the primary schemas defined for JSON resources conforming to the Redfish Specification. Each schema definition is available in both CSDL (XML) and json-schema formats. A .ZIP archive (DSP8010) containing all of current schema files (both CSDL and json-schema) can be downloaded from the Redfish Standards page at: http://www.dmtf.org/standards/redfish

AccelerationFunction
[csdl[json-schema] [yaml]
v1.0.2The AccelerationFunction schema describes an acceleration function that a processor implements. This can include functions such as audio processing, compression, encryption, packet inspection, packet switching, scheduling, or video processing.
AccountService
[csdl[json-schema] [yaml]
v1.6.0The AccountService schema defines an Account Service. The properties are common to, and enable management of, all user accounts. The properties include the password requirements and control features, such as account lockout. The schema also contains links to the manager accounts and roles.
ActionInfo
[csdl[json-schema] [yaml]
v1.1.2The 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.
Assembly
[csdl[json-schema] [yaml]
v1.2.2The Assembly schema defines an assembly. Assembly information contains details about a device, such as part number, serial number, manufacturer, and production date. It also provides access to the original data for the assembly.
AttributeRegistry
[csdl[json-schema] [yaml]
v1.3.2The 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.
Bios
[csdl[json-schema] [yaml]
v1.1.0The Bios schema contains properties related to the BIOS Attribute Registry. The Attribute Registry describes the system-specific BIOS attributes and actions for changing to BIOS settings. Changes to the BIOS typically require a system reset before they take effect. It is likely that a client finds the `@Redfish.Settings` term in this Resource, and if it is found, the client makes requests to change BIOS settings by modifying the Resource identified by the `@Redfish.Settings` term.
BootOption
[csdl[json-schema] [yaml]
v1.0.3The BootOption schema describes a boot option. It represents the properties of a bootable device available in the system.
Certificate
[csdl[json-schema] [yaml]
v1.1.1The Certificate schema describes a certificate that proves the identify of a component, account, or service.
CertificateLocations
[csdl[json-schema] [yaml]
v1.0.2The CertificateLocations schema describes a Resource that an administrator can use in order to locate all certificates installed on a given service.
CertificateService
[csdl[json-schema] [yaml]
v1.0.2The CertificateService schema describes a Certificate Service that represents the actions available to manage certificates and links to the certificates.
Chassis
[csdl[json-schema] [yaml]
v1.10.0The Chassis schema represents the physical components of a system. This Resource represents the sheet-metal confined spaces and logical zones such as racks, enclosures, chassis and all other containers. Subsystems, such as sensors, that operate outside of a system's data plane are linked either directly or indirectly through this Resource. A subsystem that operates outside of a system's data plane are not accessible to software that runs on the system.
CollectionCapabilities
[csdl[json-schema] [yaml]
v1.2.0This type describes the capabilities of a collection.
CompositionService
[csdl[json-schema] [yaml]
v1.1.2The CompositionService schema describes a Composition Service and its properties and links to the Resources available for composition.
ComputerSystem
[csdl[json-schema] [yaml]
v1.9.0The ComputerSystem schema represents a computer or system instance and the software-visible Resources, or items within the data plane, such as memory, CPU, and other devices that it can access. Details of those Resources or subsystems are also linked through this Resource.
Drive
[csdl[json-schema] [yaml]
v1.8.0The Drive schema represents a single physical drive for a system, including links to associated volumes.
Endpoint
[csdl[json-schema] [yaml]
v1.3.2The 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.
EthernetInterface
[csdl[json-schema] [yaml]
v1.5.1The EthernetInterface schema represents a single, logical Ethernet interface or network interface controller (NIC).
Event
[csdl[json-schema] [yaml]
v1.4.1The 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 MessageId link to a Message Registry that can be accessed for further information.
EventDestination
[csdl[json-schema] [yaml]
v1.7.0The EventDestination schema defines the target of an event subscription, including the event types and context to provide to the target in the Event payload.
EventService
[csdl[json-schema] [yaml]
v1.5.0The EventService schema contains properties for managing event subcriptions and generates the events sent to subscribers. The Resource has links to the actual collection of subscriptions, which are called event destinations.
ExternalAccountProvider
[csdl[json-schema] [yaml]
v1.1.2The remote service that provides accounts for this manager to use for authentication.
Fabric
[csdl[json-schema] [yaml]
v1.0.6The 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] [yaml]
v1.2.2The properties associated with a Host Interface. A Host Interface is a connection between host software and a Redfish Service.
IPAddresses
[csdl[json-schema] [yaml]
v1.1.1
Job
[csdl[json-schema] [yaml]
v1.0.3The Job schema contains information about a job that a a Redfish Job Service schedules or executes. Clients create jobs to describe a series of operations that occur at periodic intervals.
JobService
[csdl[json-schema] [yaml]
v1.0.2The Redfish Job Service enables the scheduling and execution of operations, represents the properties for the Job Service itself, and has links to the actual Resource Collection of Jobs.
JsonSchemaFile
[csdl[json-schema] [yaml]
v1.1.4The JsonSchemaFile schema contains the properties that describe the locations, as URIs, of a Redfish Schema definition that a Redfish Service implements or references.
LogEntry
[csdl[json-schema] [yaml]
v1.5.0The LogEntry schema defines the record format for a log. It is designed for Redfish event logs, OEM-specific log formats, and the IPMI System Event Log (SEL). The EntryType field indicates the type of log and the Resource includes several additional properties dependent on the EntryType.
LogService
[csdl[json-schema] [yaml]
v1.1.3The LogService schema contains properties for monitoring and configuring a Log Service.
Manager
[csdl[json-schema] [yaml]
v1.6.0In Redfish, a manager is a systems management entity that may implement or provide access to a Redfish Service. Examples of managers are BMCs, enclosure managers, management controllers, and other subsystems that are assigned managability functions. An implementation may have multiple managers, which may or may not be directly accessible through a Redfish-defined interface.
ManagerAccount
[csdl[json-schema] [yaml]
v1.4.0The 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] [yaml]
v1.5.0The network service settings for the manager.
Memory
[csdl[json-schema] [yaml]
v1.8.0The schema for definition of a memory and its configuration.
MemoryChunks
[csdl[json-schema] [yaml]
v1.2.4The schema definition of a memory chunk and its configuration.
MemoryDomain
[csdl[json-schema] [yaml]
v1.2.3The MemoryDomain schema describes a memory domain and its configuration. Memory domains indicate to the client which memory, or DIMMs, can be grouped together in memory chunks to represent addressable memory.
MemoryMetrics
[csdl[json-schema] [yaml]
v1.2.0The usage and health statistics for a memory device or system memory summary.
Message
[csdl[json-schema] [yaml]
v1.0.8The message that the Redfish Service returns.
MessageRegistry
[csdl[json-schema] [yaml]
v1.3.1The MessageRegistry schema describes all Message Registries. It represents the properties for the Message Registries themselves.
MessageRegistryFile
[csdl[json-schema] [yaml]
v1.1.3The MessageRegistryFile schema describes the Message Registry file locator Resource.
MetricDefinition
[csdl[json-schema] [yaml]
v1.0.3The MetricDefinition schema describes the metadata information for a metric.
MetricReport
[csdl[json-schema] [yaml]
v1.2.0The metric definitions that create a metric report.
MetricReportDefinition
[csdl[json-schema] [yaml]
v1.3.0The MetricReportDefinition schema describes set of metrics that are collected into a metric report.
NetworkAdapter
[csdl[json-schema] [yaml]
v1.3.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] [yaml]
v1.3.3The NetworkDeviceFunction schema represents a logical interface that a network adapter exposes.
NetworkInterface
[csdl[json-schema] [yaml]
v1.1.3The NetworkInterface schema describes links to the NetworkAdapter, NetworkPort, and NetworkDeviceFunction Resources and represents the functionality available to the containing system.
NetworkPort
[csdl[json-schema] [yaml]
v1.2.3A network port, which is a discrete physical port that can connect to a network.
PCIeDevice
[csdl[json-schema] [yaml]
v1.4.0The PCIeDevice schema describes the properties of a PCIe device that is attached to a system.
PCIeFunction
[csdl[json-schema] [yaml]
v1.2.3The schema definition for the PCIeFunction Resource. It represents the properties of a PCIeFunction attached to a System.
PCIeSlots
[csdl[json-schema] [yaml]
v1.1.1The PCIeSlots schema describes PCIe slot properties.
PhysicalContext
[csdl[json-schema] [yaml]
v1.3.0
Port
[csdl[json-schema] [yaml]
v1.1.3The Port schema contains properties that describe a port of a switch, controller, chassis, or any other device that could be connected to another entity.
Power
[csdl[json-schema] [yaml]
v1.6.0The Power schema describes power metrics and represents the properties for power consumption and power limiting.
PrivilegeRegistry
[csdl[json-schema] [yaml]
v1.1.4The PrivilegeRegistry schema describes the operation-to-privilege mappings.
Privileges
[csdl[json-schema] [yaml]
v1.0.5
Processor
[csdl[json-schema] [yaml]
v1.6.0The Processor schema describes the information about a single processor that a system contains. A processor includes both performance characteristics, clock speed, architecture, core count, and so on, and compatibility, such as the CPU ID instruction results.
ProcessorMetrics
[csdl[json-schema] [yaml]
v1.0.2The ProcessorMetrics schema contains usage and health statistics for a processor.
Redundancy
[csdl[json-schema] [yaml]
v1.3.4The common redundancy definition and structure used in other Redfish schemas.
Resource
[csdl[json-schema] [yaml]
v1.8.3The base type for Resources and members that can be linked to.
ResourceBlock
[csdl[json-schema] [yaml]
v1.3.2The schema definition of the Resource Block, its components, and affinity to composed devices.
Role
[csdl[json-schema] [yaml]
v1.2.4The Role schema contains a Redfish Role to use in conjunction with a manager account.
Schedule
[csdl[json-schema] [yaml]
v1.2.1Schedule a series of occurrences.
SecureBoot
[csdl[json-schema] [yaml]
v1.0.6The SecureBoot schema contains UEFI Secure Boot information and represents properties for managing the UEFI Secure Boot functionality of a system.
Sensor
[csdl[json-schema] [yaml]
v1.0.3The Sensor schema describes a sensor and its properties.
SerialInterface
[csdl[json-schema] [yaml]
v1.1.5The SerialInterface schema describes an asynchronous serial interface, such as an RS-232 interface, available to a system or device.
ServiceRoot
[csdl[json-schema] [yaml]
v1.5.2The ServiceRoot schema describes the root of the Redfish Service, located at the '/redfish/v1' URI. All other Resources accessible through the Redfish interface on this device are linked directly or indirectly from the Service Root.
Session
[csdl[json-schema] [yaml]
v1.2.1The Session Resource describes a single connection (session) between a client and a Redfish Service instance.
SessionService
[csdl[json-schema] [yaml]
v1.1.6The SessionService schema describes the Session Service and its properties, with links to the actual list of sessions.
Settings
[csdl[json-schema] [yaml]
v1.3.0The Resource settings.
SimpleStorage
[csdl[json-schema] [yaml]
v1.2.3The SimpleStorage schema represents the properties of a storage controller and its directly-attached devices.
SoftwareInventory
[csdl[json-schema] [yaml]
v1.2.3The SoftwareInventory schema contains an inventory of software components. This can include software components such as BIOS, BMC firmware, firmware for other devices, system drivers, or provider software.
Storage
[csdl[json-schema] [yaml]
v1.8.0The 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.
Switch
[csdl[json-schema] [yaml]
v1.2.0The Switch schema contains properties that describe a fabric switch.
Task
[csdl[json-schema] [yaml]
v1.4.2The Task schema contains information about a task that the Redfish Task Service schedules or executes. Tasks represent operations that take more time than a client typically wants to wait.
TaskService
[csdl[json-schema] [yaml]
v1.1.4The 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 actual Resource Collection of Tasks.
TelemetryService
[csdl[json-schema] [yaml]
v1.1.2The TelemetryService schema describes a Telemetry Service. The Telemetry Service is used to for collecting and reporting metric data within the Redfish Service.
Thermal
[csdl[json-schema] [yaml]
v1.5.3The Thermal schema describes temperature monitoring and thermal management subsystems, such as cooling fans, for a computer system or similiar devices contained within a chassis.
Triggers
[csdl[json-schema] [yaml]
v1.1.1The Triggers schema describes a trigger that applies to metrics.
UpdateService
[csdl[json-schema] [yaml]
v1.7.0The UpdateService schema describes the Update Service and the properties for the Service itself with links to collections of firmware and software inventory. The Update Service also provides methods for updating software and firmware of the Resources in a Redfish Service.
VLanNetworkInterface
[csdl[json-schema] [yaml]
v1.1.4The attributes of a VLAN.
VirtualMedia
[csdl[json-schema] [yaml]
v1.3.2The VirtualMedia schema contains properties related to the monitor and control of an instance of virtual media, such as a remote CD, DVD, or USB device. A manager for a system or device provides virtual media functionality.
Volume
[csdl[json-schema] [yaml]
v1.4.0Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system.
Zone
[csdl[json-schema] [yaml]
v1.3.1The Zone schema describes a simple fabric zone for a Redfish implementation.
odata
[json-schema] [yaml]
v4.0.4
odata-v4
[yaml]
openapi
[yaml]
redfish-error
[json-schema]
v1.0.1
redfish-payload-annotations
[json-schema]
v1.0.2
redfish-schema
[json-schema]
v1.7.0

Supporting Schema Files

The following files are supporting schema files, used primarily for programmatic validation of schemas or conformance testing. These support files include schema definitions for each type of 'Collection' defined by the Redfish Specification, and an un-versioned json-schema definition to allow each schema to be revised independently without causing version dependencies.

AccelerationFunction
[json-schema]
The AccelerationFunction schema describes an acceleration function that a processor implements. This can include functions such as audio processing, compression, encryption, packet inspection, packet switching, scheduling, or video processing.
AccelerationFunctionCollection
[csdl[json-schema] [yaml]
Unversioned root definition of AccelerationFunctionCollection.
AccountService
[json-schema]
The AccountService schema defines an Account Service. The properties are common to, and enable management of, all user accounts. The properties include the password requirements and control features, such as account lockout. The schema also contains links to the manager accounts and roles.
ActionInfo
[json-schema]
The ActionInfo schema defines the supported parameters and other information for a Redfish action. Supported parameters can differ among vendors and even among Resource instances. This data can ensure that action requests from applications contain supported parameters.
Assembly
[json-schema]
The Assembly schema defines an assembly. Assembly information contains details about a device, such as part number, serial number, manufacturer, and production date. It also provides access to the original data for the assembly.
AttributeRegistry
[json-schema]
The AttributeRegistry schema contains a set of key-value pairs that represent the structure of an Attribute Registry. It includes mechanisms for building user interfaces, or menus, allowing consistent navigation of the contents. The Attribute Registry is specific to an implementation or product. The attributes and property names are not standardized.
Bios
[json-schema]
The Bios schema contains properties related to the BIOS Attribute Registry. The Attribute Registry describes the system-specific BIOS attributes and actions for changing to BIOS settings. Changes to the BIOS typically require a system reset before they take effect. It is likely that a client finds the `@Redfish.Settings` term in this Resource, and if it is found, the client makes requests to change BIOS settings by modifying the Resource identified by the `@Redfish.Settings` term.
BootOption
[json-schema]
The BootOption schema reports information about a single boot option in a system.
BootOptionCollection
[csdl[json-schema] [yaml]
Unversioned root definition of BootOptionCollection.
Certificate
[json-schema]
The Certificate schema describes a certificate that proves the identify of a component, account, or service.
CertificateCollection
[csdl[json-schema] [yaml]
Unversioned root definition of CertificateCollection.
CertificateLocations
[json-schema]
The CertificateLocations schema describes a Resource that an administrator can use in order to locate all certificates installed on a given service.
CertificateService
[json-schema]
The CertificateService schema describes a Certificate Service that represents the actions available to manage certificates and links to the certificates.
Chassis
[json-schema]
The Chassis schema represents the physical components of a system. This Resource represents the sheet-metal confined spaces and logical zones such as racks, enclosures, chassis and all other containers. Subsystems, such as sensors, that operate outside of a system's data plane are linked either directly or indirectly through this Resource. A subsystem that operates outside of a system's data plane are not accessible to software that runs on the system.
ChassisCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ChassisCollection.
CollectionCapabilities
[json-schema]
Unversioned root definition of CollectionCapabilities.
CompositionService
[json-schema]
The CompositionService schema describes a Composition Service and its properties and links to the Resources available for composition.
ComputerSystem
[json-schema]
The ComputerSystem schema represents a computer or system instance and the software-visible Resources, or items within the data plane, such as memory, CPU, and other devices that it can access. Details of those Resources or subsystems are also linked through this Resource.
ComputerSystemCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ComputerSystemCollection.
Drive
[json-schema]
The Drive schema represents a single physical drive for a system, including links to associated volumes.
Endpoint
[json-schema]
The Endpoint schema contains the properties of an Endpoint Resource that represents the properties of an entity that sends or receives protocol-defined messages over a transport.
EndpointCollection
[csdl[json-schema] [yaml]
Unversioned root definition of EndpointCollection.
EthernetInterface
[json-schema]
The EthernetInterface schema represents a single, logical Ethernet interface or network interface controller (NIC).
EthernetInterfaceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of EthernetInterfaceCollection.
Event
[json-schema]
The Event schema describes the JSON payload received by an Event Destination, which has subscribed to event notification, when events occur. This Resource contains data about events, including descriptions, severity, and a MessageId link to a Message Registry that can be accessed for further information.
EventDestination
[json-schema]
The EventDestination schema defines the target of an event subscription, including the event types and context to provide to the target in the Event payload.
EventDestinationCollection
[csdl[json-schema] [yaml]
Unversioned root definition of EventDestinationCollection.
EventService
[json-schema]
The EventService schema contains properties for managing event subcriptions and generates the events sent to subscribers. The Resource has links to the actual collection of subscriptions, which are called event destinations.
ExternalAccountProvider
[json-schema]
The remote service that provides accounts for this manager to use for authentication.
ExternalAccountProviderCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ExternalAccountProviderCollection.
Fabric
[json-schema]
The Fabric schema represents a simple fabric consisting of one or more switches, zero or more endpoints, and zero or more zones.
FabricCollection
[csdl[json-schema] [yaml]
Unversioned root definition of FabricCollection.
HostInterface
[json-schema]
The properties associated with a Host Interface. A Host Interface is a connection between host software and a Redfish Service.
HostInterfaceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of HostInterfaceCollection.
IPAddresses
[json-schema]
Job
[json-schema]
The Job schema contains information about a job that a a Redfish Job Service schedules or executes. Clients create jobs to describe a series of operations that occur at periodic intervals.
JobCollection
[csdl[json-schema] [yaml]
Unversioned root definition of JobCollection.
JobService
[json-schema]
The Redfish Job Service enables the scheduling and execution of operations, represents the properties for the Job Service itself, and has links to the actual Resource Collection of Jobs.
JsonSchemaFile
[json-schema]
The JsonSchemaFile schema contains the properties that describe the locations, as URIs, of a Redfish Schema definition that a Redfish Service implements or references.
JsonSchemaFileCollection
[csdl[json-schema] [yaml]
Unversioned root definition of JsonSchemaFileCollection.
LogEntry
[json-schema]
The LogEntry schema defines the record format for a log. It is designed for Redfish event logs, OEM-specific log formats, and the IPMI System Event Log (SEL). The EntryType field indicates the type of log and the Resource includes several additional properties dependent on the EntryType.
LogEntryCollection
[csdl[json-schema] [yaml]
Unversioned root definition of LogEntryCollection.
LogService
[json-schema]
The LogService schema contains properties for monitoring and configuring a Log Service.
LogServiceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of LogServiceCollection.
Manager
[json-schema]
In Redfish, a manager is a systems management entity that may implement or provide access to a Redfish Service. Examples of managers are BMCs, enclosure managers, management controllers, and other subsystems that are assigned managability functions. An implementation may have multiple managers, which may or may not be directly accessible through 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] [yaml]
Unversioned root definition of ManagerAccountCollection.
ManagerCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ManagerCollection.
ManagerNetworkProtocol
[json-schema]
The network service settings for the manager.
Memory
[json-schema]
The schema definition of the memory and its configuration.
MemoryChunks
[json-schema]
The schema definition of a memory chunk and its configuration.
MemoryChunksCollection
[csdl[json-schema] [yaml]
Unversioned root definition of MemoryChunksCollection.
MemoryCollection
[csdl[json-schema] [yaml]
Unversioned root definition of MemoryCollection.
MemoryDomain
[json-schema]
The MemoryDomain schema describes a memory domain and its configuration. Memory domains indicate to the client which memory, or DIMMs, can be grouped together in memory chunks to represent addressable memory.
MemoryDomainCollection
[csdl[json-schema] [yaml]
Unversioned root definition of MemoryDomainCollection.
MemoryMetrics
[json-schema]
The usage and health statistics for a memory device or system memory summary.
Message
[json-schema]
The message that the Redfish Service returns.
MessageRegistry
[json-schema]
The MessageRegistry schema describes all Message Registries. It represents the properties for the Message Registries themselves.
MessageRegistryCollection
[csdl[json-schema] [yaml]
Unversioned root definition of MessageRegistryCollection.
MessageRegistryFile
[json-schema]
The MessageRegistryFile schema describes the Message Registry file locator Resource.
MessageRegistryFileCollection
[csdl[json-schema] [yaml]
Unversioned root definition of MessageRegistryFileCollection.
MetricDefinition
[json-schema]
The MetricDefinition schema describes the metadata information for a metric.
MetricDefinitionCollection
[csdl[json-schema] [yaml]
Unversioned root definition of MetricDefinitionCollection.
MetricReport
[json-schema]
The metric definitions that create a metric report.
MetricReportCollection
[csdl[json-schema] [yaml]
Unversioned root definition of MetricReportCollection.
MetricReportDefinition
[json-schema]
The MetricReportDefinition schema describes set of metrics that are collected into a metric report.
MetricReportDefinitionCollection
[csdl[json-schema] [yaml]
Unversioned root definition of MetricReportDefinitionCollection.
NetworkAdapter
[json-schema]
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] [yaml]
Unversioned root definition of NetworkAdapterCollection.
NetworkDeviceFunction
[json-schema]
The NetworkDeviceFunction schema represents a logical interface that a network adapter exposes.
NetworkDeviceFunctionCollection
[csdl[json-schema] [yaml]
Unversioned root definition of NetworkDeviceFunctionCollection.
NetworkInterface
[json-schema]
The NetworkInterface schema describes links to the NetworkAdapter, NetworkPort, and NetworkDeviceFunction Resources and represents the functionality available to the containing system.
NetworkInterfaceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of NetworkInterfaceCollection.
NetworkPort
[json-schema]
A network port, which is a discrete physical port that can connect to a network.
NetworkPortCollection
[csdl[json-schema] [yaml]
Unversioned root definition of NetworkPortCollection.
PCIeDevice
[json-schema]
The PCIeDevice schema describes the properties of a PCIe device that is attached to a system.
PCIeDeviceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of PCIeDeviceCollection.
PCIeFunction
[json-schema]
The schema definition for the PCIeFunction Resource. It represents the properties of a PCIeFunction attached to a System.
PCIeFunctionCollection
[csdl[json-schema] [yaml]
Unversioned root definition of PCIeFunctionCollection.
PCIeSlots
[json-schema]
The PCIeSlots schema describes PCIe slot properties.
PhysicalContext
[json-schema]
Port
[json-schema]
The Port schema contains properties that describe a port of a switch, controller, chassis, or any other device that could be connected to another entity.
PortCollection
[csdl[json-schema] [yaml]
Unversioned root definition of PortCollection.
Power
[json-schema]
The Power schema describes power metrics and represents the properties for power consumption and power limiting.
PrivilegeRegistry
[json-schema]
The PrivilegeRegistry schema describes the operation-to-privilege mappings.
Privileges
[json-schema]
Processor
[json-schema]
The Processor schema describes the information about a single processor that a system contains. A processor includes both performance characteristics, clock speed, architecture, core count, and so on, and compatibility, such as the CPU ID instruction results.
ProcessorCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ProcessorCollection.
ProcessorMetrics
[json-schema]
The ProcessorMetrics schema contains usage and health statistics for a processor.
Protocol
[csdl] [yaml]
RedfishError
[csdl]
RedfishExtensions
[csdl]
Redundancy
[json-schema]
The common redundancy definition and structure used in other Redfish schemas.
Resource
[json-schema]
Unversioned root definition of Resource.
ResourceBlock
[json-schema]
The schema definition of the Resource Block, its components, and affinity to composed devices.
ResourceBlockCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ResourceBlockCollection.
Role
[json-schema]
The Role schema contains a Redfish Role to use in conjunction with a manager account.
RoleCollection
[csdl[json-schema] [yaml]
Unversioned root definition of RoleCollection.
Schedule
[json-schema]
Schedules a series of occurrences.
SecureBoot
[json-schema]
The SecureBoot schema contains UEFI Secure Boot information and represents properties for managing the UEFI Secure Boot functionality of a system.
Sensor
[json-schema]
The Sensor schema describes a sensor and its properties.
SensorCollection
[csdl[json-schema] [yaml]
Unversioned root definition of SensorCollection.
SerialInterface
[json-schema]
The SerialInterface schema describes an asynchronous serial interface, such as an RS-232 interface, available to a system or device.
SerialInterfaceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of SerialInterfaceCollection.
ServiceRoot
[json-schema]
The ServiceRoot schema describes the root of the Redfish Service, located at the '/redfish/v1' URI. All other Resources accessible through the Redfish interface on this device are linked directly or indirectly from the Service Root.
Session
[json-schema]
The Session Resource describes a single connection (session) between a client and a Redfish Service instance.
SessionCollection
[csdl[json-schema] [yaml]
Unversioned root definition of SessionCollection.
SessionService
[json-schema]
The SessionService schema describes the Session Service and its properties, with links to the actual list of sessions.
Settings
[json-schema]
Unversioned root definition of Settings.
SimpleStorage
[json-schema]
The SimpleStorage schema represents the properties of a storage controller and its directly-attached devices.
SimpleStorageCollection
[csdl[json-schema] [yaml]
Unversioned root definition of SimpleStorageCollection.
SoftwareInventory
[json-schema]
The SoftwareInventory schema contains an inventory of software components. This can include software components such as BIOS, BMC firmware, firmware for other devices, system drivers, or provider software.
SoftwareInventoryCollection
[csdl[json-schema] [yaml]
Unversioned root definition of SoftwareInventoryCollection.
Storage
[json-schema]
The Storage schema defines a storage subsystem and its respective properties. A storage subsystem represents a set of physical or virtual storage controllers and the Resources, such as volumes, that can be accessed from that subsystem.
StorageCollection
[csdl[json-schema] [yaml]
Unversioned root definition of StorageCollection.
Switch
[json-schema]
The Switch schema contains properties that describe a fabric switch.
SwitchCollection
[csdl[json-schema] [yaml]
Unversioned root definition of SwitchCollection.
Task
[json-schema]
The Task schema contains information about a task that the Redfish Task Service schedules or executes. Tasks represent operations that take more time than a client typically wants to wait.
TaskCollection
[csdl[json-schema] [yaml]
Unversioned root definition of TaskCollection.
TaskService
[json-schema]
The TaskService schema describes a Task Service that enables management of long-duration operations, includes the properties for the Task Service itself, and has links to the actual Resource Collection of Tasks.
TelemetryService
[json-schema]
The TelemetryService schema describes a Telemetry Service. The Telemetry Service is used to for collecting and reporting metric data within the Redfish Service.
Thermal
[json-schema]
The Thermal schema describes temperature monitoring and thermal management subsystems, such as cooling fans, for a computer system or similiar devices contained within a chassis.
Triggers
[json-schema]
The Triggers schema describes a trigger that applies to metrics.
TriggersCollection
[csdl[json-schema] [yaml]
Unversioned root definition of TriggersCollection.
UpdateService
[json-schema]
The UpdateService schema describes the Update Service and the properties for the Service itself with links to collections of firmware and software inventory. The Update Service also provides methods for updating software and firmware of the Resources in a Redfish Service.
VLanNetworkInterface
[json-schema]
The VLanNetworkInterface schema describes a VLAN network instance that is available on a manager, system, or other device.
VLanNetworkInterfaceCollection
[csdl[json-schema] [yaml]
Unversioned root definition of VLanNetworkInterfaceCollection.
VirtualMedia
[json-schema]
The VirtualMedia schema contains properties related to the monitor and control of an instance of virtual media, such as a remote CD, DVD, or USB device. A manager for a system or device provides virtual media functionality.
VirtualMediaCollection
[csdl[json-schema] [yaml]
Unversioned root definition of VirtualMediaCollection.
Volume
[json-schema]
Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system.
VolumeCollection
[csdl[json-schema] [yaml]
Unversioned root definition of VolumeCollection.
Zone
[json-schema]
The Zone schema describes a simple fabric zone for a Redfish implementation.
ZoneCollection
[csdl[json-schema] [yaml]
Unversioned root definition of ZoneCollection.
odata-v4
[json-schema]
redfish-schema-v1
[json-schema]