Redfish Resource and Schema Guide: Document Class: Informative Document Status: Published Document Language: en-US

Document Identifier: DSP2046
Date: 2018-10-30
Version: 2017.1
Redfish Resource and Schema Guide
Document Class: Informative

Document Status: Published
Document Language: en-US
Copyright Notice
Copyright © 2016-2018 DMTF. All rights reserved.
DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems management and
interoperability. Members and non-members may reproduce DMTF specifications and documents, provided that correct
attribution is given. As DMTF specifications may be revised from time to time, the particular version and release date
should always be noted.
Implementation of certain elements of this standard or proposed standard may be subject to third party patent rights,
including provisional patent rights (herein "patent rights"). DMTF makes no representations to users of the standard as to
the existence of such rights, and is not responsible to recognize, disclose, or identify any or all such third party patent right,
owners or claimants, nor for any incomplete or inaccurate identification or disclosure of such rights, owners or claimants.
DMTF shall have no liability to any party, in any manner or circumstance, under any legal theory whatsoever, for failure to
recognize, disclose, or identify any such third party patent rights, or for such party's reliance on the standard or
incorporation thereof in its product, protocols or testing procedures. DMTF shall have no liability to any party implementing
such standard, whether such implementation is foreseeable or not, nor to any patent owner or claimant, and shall have no
liability or responsibility for costs or losses incurred if a standard is withdrawn or modified after publication, and shall be
indemnified and held harmless by any party implementing the standard from any and all claims of infringement by a patent
owner for such implementations.
For information about patents held by third-parties which have notified the DMTF that, in their opinion, such patent may
relate to or impact implementations of DMTF standards, visit http://www.dmtf.org/about/policies/disclosures.php.
This document's normative language is English. Translation into other languages is permitted.
Contents
Contents
Overview
Historical Reference
Where can I find more information?
Using this guide
Reference Guide
AccountService 1.2.0
ActionInfo 1.0.2
AttributeRegistry 1.1.0
Bios 1.0.2
Chassis 1.5.0
CompositionService 1.0.0
ComputerSystem 1.4.0
Drive 1.2.0
Endpoint 1.0.2
EthernetInterface 1.3.0
Event 1.2.0
EventDestination 1.2.0
EventService 1.0.4
Fabric 1.0.2
HostInterface 1.1.0
JsonSchemaFile 1.1.0
LogEntry 1.2.0
LogService 1.0.4
Manager 1.3.1
ManagerAccount 1.1.0
ManagerNetworkProtocol 1.2.0
Memory 1.2.0
MemoryChunks 1.1.0
MemoryDomain 1.2.0
MemoryMetrics 1.1.2
MessageRegistry 1.1.0
MessageRegistryFile 1.1.0
NetworkAdapter 1.0.1
NetworkDeviceFunction 1.1.0
NetworkInterface 1.1.0
NetworkPort 1.1.0
PCIeDevice 1.1.0
PCIeFunction 1.1.0
Port 1.0.2
Power 1.3.0
redfish.dmtf.org 1 DSP2046 v2017.1

PrivilegeRegistry 1.1.0
Processor 1.1.0
ResourceBlock 1.0.0
Role 1.1.0
SecureBoot 1.0.2
SerialInterface 1.1.0
ServiceRoot 1.2.0
Session 1.1.0
SessionService 1.1.2
SimpleStorage 1.2.0
SoftwareInventory 1.1.1
Storage 1.2.0
Switch 1.0.2
Task 1.1.0
TaskService 1.1.0
Thermal 1.3.0
UpdateService 1.2.0
VirtualMedia 1.1.0
VLanNetworkInterface 1.1.0
Volume 1.0.3
Zone 1.1.0
Redfish documentation generator
ANNEX A
Change log

Overview
The Redfish standard comprises a set of specifications maintained by the Redfish Forum, a working group within the
DMTF. The standard defines a protocol that uses RESTful interfaces to provide access to data and operations associated
with the management of systems and networks. One of the strengths of the Redfish protocol is that it works with a wide
range of servers: from stand-alone servers to rack-mount and bladed environments to large-scale data centers and cloud
environments.
The Redfish standard addresses several key issues for infrastructures that require scalability. Large infrastructures often
consist of many simple servers of different makes and types. This hyper-scale usage model requires a new approach to
systems management. The Redfish Scalable Platforms Management ("Redfish") protocol addresses these needs by
providing a standard protocol based on out-of-band systems management.
With the above goals in mind, the Redfish protocol was designed as an open industry standard to meet scalability
requirements in multi-vendor deployments. It easily integrates with commonly used tools, using RESTful interfaces to
perform operations and using JSON and OData formats for data payloads.
Historical Reference
This version of the Redfish Resource and Schema Guide was created to allow for historical comparison to previous
releases of the Redfish Schema bundle (DSP8010). The latest version of this document, available from the Redfish
Standards website, contains up-to-date schema contents, as well as common property definitions, example payloads, and
additional material to explain the Redfish data model. This version of the document should only be used as a historical
reference.
Where can I find more information?

The following web sites provide more information about the Redfish standard:
Redfish Developer Hub: http://redfish.dmtf.org Resources for developers building applications using Redfish.
Contains an interactive schema explorer, hosted schema and other links.
Redfish User Forum: http://www.redfishforum.com User forum monitored by DMTF Redfish personnel to answer
questions about any Redfish-related topics:
DMTF Github Repositories: http://www.github.com/DMTF Open source tools and libraries for working with the
Redfish API.
Redfish Standards: http://www.dmtf.org/standards/redfish Schemas, specs, mockups, white papers, FAQ,
educational material and more.
DMTF Redfish Forum (Working group that maintains the Redfish standard): http://www.dmtf.org/standards/spmf
Companies involved, upcoming schedules and future work, charter, and information about joining.

Using this guide

Every Redfish API response consists of a JSON payload containing properties that are strictly defined by a schema for that
resource. The schema defining a particular resource can be determined from the value of the "@odata.type" property
returned in every Redfish response. This guide details the definitions for every Redfish standard schema.
Each schema section contains:
The name, version and description of the schema.
A table defining each property with additional details for those properties when needed.
A listing of the available Actions defined for the schema.
The property-level details include:
Column Purpose
Property The name of the JSON property as it will appear (case sensitive) in the JSON payload. For properties
Name added to the schema after the initial release (v1.0.0), the version that the property was added will be shown
in parenthesis. Properties that have been deprecated will also be indicated (along with the version where
the deprecation occurred).
Type The JSON data type(s) for the property. This can include boolean, number, string or object. String types
that use defined enumerations will state "(enum)". Number types will state their units where used.
Attributes Designates whether the property is read-only or read-write (if supported by the implementation), and
whether a 'null' value may be returned by the Service if the value of the property is temporarily unavailable.
Description The description of the property, as copied directly from the schema 'Description' definition.

Reference Guide
This guide was produced using the contents of the schema files from DMTF Redfish Schema bundle DSP8010 and merged
with supplemental text using the DMTF's Redfish Documentation Generator.
AccountService 1.2.0
Account 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.
AccountLockoutCounterResetAfter number read-write The interval of time in seconds since the last failed login
(seconds) attempt at which point the lockout threshold counter for
the account is reset to zero. Must be less than or equal
to AccountLockoutDuration.
AccountLockoutDuration number read-write The time in seconds an account is locked after the
(seconds) (null) account lockout threshold is met. Must be >=
AccountLockoutResetAfter. If set to 0, no lockout will
occur.
AccountLockoutThreshold number read-write The number of failed login attempts before a user
(null) account is locked for a specified duration (0=never
locked).
Accounts { object Link to a collection of Manager Accounts.
@odata.id string read-only The unique identifier for a resource.

}
Actions (v1.2+) { } object The available actions for this resource.
AuthFailureLoggingThreshold number read-write This is the number of authorization failures that need to
occur before the failure attempt is logged to the
manager log.
MaxPasswordLength number read-only This is the maximum password length for this service.
MinPasswordLength number read-only This is the minimum password length for this service.
PrivilegeMap { object A reference to the Privilege mapping defining the

privileges needed to perform a requested operation on
a URI associated with this service.

}
Roles { object Link to a collection of Roles.

}
ServiceEnabled boolean read-write This indicates whether this service is enabled.

(null)
Status { } object This type describes the status and health of a resource
and its children. See the
redfish.dmtf.org/schemas/v1/Resource.json schema for
details on this property.

ActionInfo 1.0.2
ActionInfo 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.
Parameters [ { array read-write The parameters associated with the specified Redfish Action.
AllowableValues [ ] array read-only A list of values for this parameter supported by this Action target.
(string,
null)
DataType string read-only The JSON property type used for this parameter.
(enum) (null) See DataType in Property Details, below, for the possible values of
this property.
Name string read-only The name of the parameter for this Action.
ObjectDataType string read-only The OData Type of an object-based parameter.

(null)
Required boolean read-only Indicates whether the parameter is required to perform this Action.
}]
Property Details
DataType:
The JSON property type used for this parameter.
string Description
Boolean A boolean (true or false).
Number A number.
NumberArray An array of numbers.
Object An embedded JSON object.
ObjectArray An array of JSON objects.
String A string.
StringArray An array of strings.
AttributeRegistry 1.1.0
An 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.
Language string read-only This is the RFC 5646 compliant language code for the
required registry.
OwningEntity string read-only This is the organization or company that publishes this
required registry.
RegistryEntries { object List of all attributes and their metadata for this component.

Attributes [ { array read-write The array containing the attributes and their possible
values.
AttributeName string read-only The unique name of the attribute.
CurrentValue string, read-only Placeholder of the current value of the attribute.

boolean, (null)
number
DefaultValue string, read-only The default current value of the attribute.

boolean, (null)
number
DisplayName string read-only The user-readable display string of the attribute in the
(null) defined 'Language'.
DisplayOrder number read-only The numeric value describing the ascending order that the
(null) attribute is displayed relative to other attributes.
GrayOut boolean read-only The gray-out state of this attribute.

(null)
HelpText string read-only The help text for the attribute.

(null)
Hidden boolean read-only The hidden state of this attribute.

(null)
Immutable boolean read-only Defines whether this attribute is immutable or not.

(null)
IsSystemUniqueProperty boolean read-only Defines whether this attribute is unique for this system
(null) and should not be replicated.
LowerBound number read-only The lower limit of the value of an attribute of type 'Integer'.
(null)
MaxLength number read-only The maximum character length of the value of an attribute
(null) of type 'String'.
MenuPath string read-only A path that describes the menu hierarchy of this attribute.
(null)
MinLength number read-only The minimum character length of the value of an attribute
(null) of type 'String'.
ReadOnly boolean read-only The read-only state of this attribute.

(null)
ScalarIncrement number read-only The amount to increment or decrement the value of an

(null) attribute of type 'Integer' each time a user requests a
value change.
Type string read-only The type of the attribute.

(enum) See Type in Property Details, below, for the possible
values of this property.
UpperBound number read-only The upper limit of the value of an attribute of type 'Integer'.
(null)
Value [ { array read-write The array containing possible values for attributes of type
'Enumeration'.
ValueDisplayName string read-only A user-readable display string of the value of the attribute

(null) in the defined 'Language'.
ValueName string read-only The value name of the attribute.

} ] (null)
ValueExpression string read-only A regular expression that is used to validate the value of
(null) the attribute. This is only applicable to attributes of type
'String' or 'Integer'.
WarningText string read-only The warning text for changing the attribute.
(null)
WriteOnly boolean read-only Defines whether this attribute is write-only. Such attributes
} ] (null) revert back to their initial value after settings are applied.
Dependencies [ { array read-write The array containing a list of dependencies of attributes

on this component.
Dependency { object The dependency expression for one or more Attributes in

this Attribute Registry.
MapFrom [ { array read-write Array of the map-from conditions for mapping

dependency.
MapFromAttribute string read-only The attribute that is used to evaluate this dependency
expression.
MapFromCondition string read-only The condition that is used to evaluate this dependency
(enum) expression.
See MapFromCondition in Property Details, below, for the
possible values of this property.
MapFromProperty string read-only The meta-data property of the attribute specified in

(enum) MapFromAttribute that is used to evaluate this
dependency expression.
See MapFromProperty in Property Details, below, for the
MapFromValue string, read-only The value that the is used property specified in
boolean, (null) MapFromProperty that is used to evaluate this
number dependency expression.
MapTerms string read-only The logical term used to combine two or more MapFrom
} ] (enum) conditions in this dependency expression.
See MapTerms in Property Details, below, for the possible
MapToAttribute string read-only The Name of the attribute that is affected by this
MapToProperty string read-only The meta-data property of the attribute specified in

(enum) MapFromAttribute that is used to evaluate this
See MapToProperty in Property Details, below, for the
MapToValue string, read-only The value that MapToProperty is changed to if the

} boolean, (null) dependency expression evaluates to true.
number
DependencyFor string read-only The AttributeName of the attribute whose change triggers
the evaluation of this dependency expression.
Type string read-only The type of the dependency structure.

} ] (enum) See Type in Property Details, below, for the possible
Menus [ { array read-write The array containing the attributes menus and their
hierarchy.
DisplayName string read-only The user-readable display string of this menu in the
(null) defined 'Language'.
DisplayOrder number read-only The numeric value describing the ascending order in
(null) which this menu is displayed relative to other menus.
GrayOut boolean read-only The gray-out state of this menu. A grayed-only menu is
(null) not accessible in user interfaces.
MenuName string read-only The unique name string of this menu.
MenuPath string read-only A path that describes this menu hierarchy relative to other
(null) menus.
ReadOnly boolean read-only The read-only state of this menu.

} ] (null)
}
RegistryVersion string read-only This is the attribute registry version which is used in the
required middle portion of a AttributeRegistry.
SupportedSystems [ { array read-write Array of systems supported by this attribute registry.
FirmwareVersion (v1.1+) string read-only Firmware version.

(null)
ProductName string read-only The product name of the system.

(null)
SystemId string read-only The system ID of the system.

}] (null)
Property Details
MapFromCondition:
The condition that is used to evaluate this dependency expression.
string Description
EQU The logical operation for 'Equal'.
GEQ The logical operation for 'Greater than or Equal'.
GTR The logical operation for 'Greater than'.
LEQ The logical operation for 'Less than or Equal'.
LSS The logical operation for 'Less than'.
NEQ The logical operation for 'Not Equal'.
MapFromProperty:
The meta-data property of the attribute specified in MapFromAttribute that is used to evaluate this dependency
expression.
string Description

CurrentValue The dependency on an attribute's CurrentValue.
DefaultValue The dependency on an attribute's DefaultValue.
GrayOut The dependency on an attribute's GrayOut state.
Hidden The dependency on an attribute's Hidden state.
LowerBound The dependency on an attribute's LowerBound.
MaxLength The dependency on an attribute's MaxLength.
MinLength The dependency on an attribute's MinLength.
ReadOnly The dependency on an attribute's ReadOnly state.
ScalarIncrement The dependency on an attribute's ScalarIncrement.
UpperBound The dependency on an attribute's UpperBound.
WriteOnly The dependency on an attribute's WriteOnly state.
MapTerms:
The logical term used to combine two or more MapFrom conditions in this dependency expression.
string Description
AND The operation used for logical 'AND' of dependency terms.
OR The operation used for logical 'OR' of dependency terms.
MapToProperty:
The meta-data property of the attribute specified in MapFromAttribute that is used to evaluate this dependency
expression.
string Description
CurrentValue The dependency that affects an attribute's CurrentValue.
DefaultValue The dependency that affects an attribute's DefaultValue.
DisplayName The dependency that affects an attribute's DisplayName.
DisplayOrder The dependency that affects an attribute's DisplayName.
GrayOut The dependency that affects an attribute's GrayOut state.
HelpText The dependency that affects an attribute's HelpText.
Hidden The dependency that affects an attribute's Hidden state.
Immutable The dependency that affects an attribute's Immutable state.
LowerBound The dependency that affects an attribute's LowerBound.
MaxLength The dependency that affects an attribute's MaxLength.
MinLength The dependency that affects an attribute's MinLength.
ReadOnly The dependency that affects an attribute's ReadOnly state.
ScalarIncrement The dependency that affects an attribute's ScalarIncrement.
UpperBound The dependency that affects an attribute's UpperBound.

ValueExpression The dependency that affects an attribute's ValueExpression.
WarningText The dependency that affects an attribute's WarningText.
WriteOnly The dependency that affects an attribute's WriteOnly state.
Type:
The type of the dependency structure.
string Description
Map A simple mapping dependency. The attribute value or state is changed to the mapped value if the
condition evaluates to true.
Bios 1.0.2
Bios 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.
Actions { object The available actions for this resource.
#Bios.ChangePassword { } object This action is used to change the BIOS passwords.

For more information, see the Action Details section below.
#Bios.ResetBios { } object This action is used to reset the BIOS attributes to default.
} For more information, see the Action Details section below.
AttributeRegistry string read-only The Resource ID of the Attribute Registry for the BIOS
(null) Attributes resource.
Attributes { } object This is the manufacturer/provider specific list of BIOS

attributes.
Action Details
ChangePassword
This action is used to change the BIOS passwords.
(This action takes no parameters.)
ResetBios
This action is used to reset the BIOS attributes to default.
Chassis 1.5.0
A 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.
#Chassis.Reset { } object This action is used to reset the chassis. This action resets
} the chassis, not Systems or other contained resources,
although side effects may occur which affect those
resources.

AssetTag string read-write The user assigned asset tag for this chassis.
(null)
ChassisType string read-only This property indicates the type of physical form factor of this
(enum) required resource.
See ChassisType in Property Details, below, for the possible
DepthMm (v1.4+) number read-only The depth of the chassis.

(mm) (null)
HeightMm (v1.4+) number read-only The height of the chassis.

(mm) (null)
IndicatorLED string read-write The state of the indicator LED, used to identify the chassis.
(enum) (null) See IndicatorLED in Property Details, below, for the possible
Links { object Contains references to other resources that are related to

this resource.
ComputerSystems [ { array read-only An array of references to the computer systems contained in

this chassis. This will only reference ComputerSystems that
are directly and wholly contained in this chassis.

} ]
ContainedBy { object A reference to the chassis that this chassis is contained by.

}
Contains [ { array read-only An array of references to any other chassis that this chassis
has in it.

} ]
CooledBy [ { array read-only An array of ID[s] of resources that cool this chassis.
Normally the ID will be a chassis or a specific set of fans.

} ]
Drives (v1.2+) [ { array read-only An array of references to the disk drives located in this
Chassis.

} ]
ManagedBy [ { array read-only An array of references to the Managers responsible for

managing this chassis.

} ]
ManagersInChassis (v1.2+) [ { array read-only An array of references to the managers located in this
Chassis.

} ]

Oem { } object See the OEM object definition in the Common properties
section. See the redfish.dmtf.org/schemas/v1/Resource.json
schema for details on this property.
PCIeDevices (v1.4+) [ { array read-only An array of references to the PCIe Devices located in this
Chassis.

} ]
PoweredBy [ { array read-only An array of ID[s] of resources that power this chassis.
Normally the ID will be a chassis or a specific set of Power
Supplies.

} ]
ResourceBlocks (v1.5+) [ { array read-only An array of references to the Resource Blocks located in this
Chassis.

} ]
Storage (v1.2+) [ { array read-only An array of references to the storage subsystems connected
to or inside this Chassis.

} ]
}
Location (v1.2+) { } object See the redfish.dmtf.org/schemas/v1/Resource.v1_1_0.json

LogServices { object A reference to the logs for this chassis.

}
Manufacturer string read-only This is the manufacturer of this chassis.

(null)
Model string read-only This is the model number for the chassis.
(null)
NetworkAdapters { object A reference to the collection of Network Adapters associated

with this chassis.

}
PartNumber string read-only The part number for this chassis.

(null)
PhysicalSecurity (v1.1+) { object The state of the physical security sensor.
IntrusionSensor string read-write This indicates the known state of the physical security
(enum) (null) sensor, such as if it is hardware intrusion detected.
See IntrusionSensor in Property Details, below, for the
IntrusionSensorNumber number read-only A numerical identifier to represent the physical security

(null) sensor.
IntrusionSensorReArm string read-only This indicates how the Normal state to be restored.

} (enum) (null) See IntrusionSensorReArm in Property Details, below, for
the possible values of this property.
Power { object A reference to the power properties (power supplies, power

policies, sensors) for this chassis.

}
PowerState (v1.1+) string read-only This is the current power state of the chassis.
(enum) (null) See PowerState in Property Details, below, for the possible
SerialNumber string read-only The serial number for this chassis.

(null)
SKU string read-only This is the SKU for this chassis.

(null)
Status { } object This type describes the status and health of a resource and
its children. See the
Thermal { object A reference to the thermal properties (fans, cooling, sensors)

for this chassis.

}
WeightKg (v1.4+) number read-only The weight of the chassis.

(kg) (null)
WidthMm (v1.4+) number read-only The width of the chassis.

(mm) (null)
Action Details
Reset
This action is used to reset the chassis. This action resets the chassis, not Systems or other contained
resources, although side effects may occur which affect those resources.
Property Details
ChassisType:
This property indicates the type of physical form factor of this resource.
string Description
Blade An enclosed or semi-enclosed, typically vertically-oriented, system chassis which must be

plugged into a multi-system chassis to function normally.
Card A loose device or circuit board intended to be installed in a system or other enclosure.
Cartridge A small self-contained system intended to be plugged into a multi-system chassis.
Component A small chassis, card, or device which contains devices for a particular subsystem or
function.
Drawer An enclosed or semi-enclosed, typically horizontally-oriented, system chassis which may be

slid into a multi-system chassis.

Enclosure A generic term for a chassis that does not fit any other description.
Expansion A chassis which expands the capabilities or capacity of another chassis.
IPBasedDrive A chassis in a drive form factor with IP-based network connections.

(v1.3+)
Module A small, typically removable, chassis or card which contains devices for a particular
subsystem or function.
Other A chassis that does not fit any of these definitions.
Pod A collection of equipment racks in a large, likely transportable, container.
Rack An equipment rack, typically a 19-inch wide freestanding unit.
RackGroup A group of racks which form a single entity or share infrastructure.

(v1.4+)
RackMount A single system chassis designed specifically for mounting in an equipment rack.
Row A collection of equipment racks.
Shelf An enclosed or semi-enclosed, typically horizontally-oriented, system chassis which must be

plugged into a multi-system chassis to function normally.
Sidecar A chassis that mates mechanically with another chassis to expand its capabilities or capacity.
Sled An enclosed or semi-enclosed, system chassis which must be plugged into a multi-system
chassis to function normally similar to a blade type chassis.
StandAlone A single, free-standing system, commonly called a tower or desktop chassis.
Zone A logical division or portion of a physical chassis that contains multiple devices or systems
that cannot be physically separated.
IndicatorLED:
The state of the indicator LED, used to identify the chassis.
string Description
Blinking The Indicator LED is blinking.
Lit The Indicator LED is lit.
Off The Indicator LED is off.
Unknown The state of the Indicator LED cannot be determined. Deprecated v1.5+. This value has
(deprecated been Deprecated in favor of returning null if the state is unknown.
v1.5)
IntrusionSensor:
This indicates the known state of the physical security sensor, such as if it is hardware intrusion detected.
string Description
HardwareIntrusion A door, lock, or other mechanism protecting the internal system hardware from being
accessed is detected as being in an insecure state.
Normal No abnormal physical security conditions are detected at this time.
TamperingDetected Physical tampering of the monitored entity is detected.

IntrusionSensorReArm:
This indicates how the Normal state to be restored.
string Description
Automatic This sensor would be restored to the Normal state automatically as no abnormal physical security
conditions are detected.
Manual This sensor would be restored to the Normal state by a manual re-arm.
PowerState:
This is the current power state of the chassis.
string Description
Off The components within the chassis has no power, except some components may continue to
have AUX power such as management controller.
On The components within the chassis has power on.
PoweringOff A temporary state between On and Off. The components within the chassis can take time to
process the power off action.
PoweringOn A temporary state between Off and On. The components within the chassis can take time to
process the power on action.
CompositionService 1.0.0
This 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.
Actions { } object The available actions for this resource.
ResourceBlocks { object The resource blocks available on the service.

}
ResourceZones { object The resource zones available on the service.

}

(null)
Status { } object This type describes the status and health of a resource and its children. See
the redfish.dmtf.org/schemas/v1/Resource.json schema for details on this
property.
ComputerSystem 1.4.0
This 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.
#ComputerSystem.Reset { } object This action is used to reset the system.

} For more information, see the Action Details
section below.
AssetTag string read-write The user definable tag that can be used to
(null) track this computer system for inventory or
other client purposes.
Bios { object A reference to the BIOS settings associated

with this system.

}
BiosVersion string read-only The version of the system BIOS or primary

(null) system firmware.
Boot { object Information about the boot settings for this

system.
BootSourceOverrideEnabled string read-write Describes the state of the Boot Source

(enum) (null) Override feature.
See BootSourceOverrideEnabled in Property
Details, below, for the possible values of this
property.
BootSourceOverrideMode (v1.1+) string read-write The BIOS Boot Mode (either Legacy or UEFI)
(enum) (null) to be used when BootSourceOverrideTarget
boot source is booted from.
See BootSourceOverrideMode in Property
property.
BootSourceOverrideTarget string read-write The current boot source to be used at next

(enum) (null) boot instead of the normal boot device, if
BootSourceOverrideEnabled is true.
See BootSourceOverrideTarget in Property
property.
UefiTargetBootSourceOverride string read-write This property is the UEFI Device Path of the
} (null) device to boot from when
BootSourceOverrideSupported is UefiTarget.
EthernetInterfaces { object A reference to the collection of Ethernet

interfaces associated with this system.

}
HostedServices (v1.2+) { object The services that this computer system

supports.
Oem { } object See the OEM object definition in the Common

properties section. See the
redfish.dmtf.org/schemas/v1/Resource.json
StorageServices read-only A reference to a collection of storage services

} supported by this computer system.
HostingRoles (v1.2+) [ ] array read-only The hosing roles that this computer system
(string supports. The enumerations of HostingRoles
(enum)) specify different features that the hosting

ComputerSystem supports.
See HostingRoles in Property Details, below,
for the possible values of this property.
HostName string read-write The DNS Host Name, without any domain
(null) information.
IndicatorLED string read-write The state of the indicator LED, used to identify
(enum) (null) the system.
See IndicatorLED in Property Details, below,
Links { object Contains references to other resources that are

related to this resource.
Chassis [ { array read-only An array of references to the chassis in which

this system is contained.

} ]
CooledBy [ { array read-only An array of ID[s] of resources that cool this

computer system. Normally the ID will be a
chassis or a specific set of fans.

} ]
Endpoints (v1.2+) [ { array read-only An array of references to the endpoints that

connect to this system.

} ]
ManagedBy [ { array read-only An array of references to the Managers

responsible for this system.

} ]

PoweredBy [ { array read-only An array of ID[s] of resources that power this

computer system. Normally the ID will be a
chassis or a specific set of Power Supplies.

} ]
ResourceBlocks (v1.4+) [ { array read-write An array of references to the Resource Blocks

that are used in this Computer System.

} ]
}
LogServices { object A reference to the collection of Log Services

associated with this system.

}

Manufacturer string read-only The manufacturer or OEM of this system.

(null)
Memory { object A reference to the collection of Memory


}
MemoryDomains { object (null) A reference to the collection of Memory

Domains associated with this system.

}
MemorySummary { object This object describes the central memory of

the system in general detail.
MemoryMirroring (v1.1+) string read-only The ability and type of memory mirroring
(enum) (null) supported by this system.
See MemoryMirroring in Property Details,
below, for the possible values of this property.
Status { } object This type describes the status and health of a

resource and its children. See the
TotalSystemMemoryGiB number read-only The total configured operating system-

(null) accessible memory (RAM), measured in GiB.
TotalSystemPersistentMemoryGiB (v1.4+) number read-only The total configured, system-accessible

} (null) persistent memory, measured in GiB.
Model string read-only The model number for this system.

(null)
NetworkInterfaces { object A reference to the collection of Network

Interfaces associated with this system.

}
PartNumber string read-only The part number for this system.

(null)
PCIeDevices (v1.2+) [ { array read-only A reference to a collection of PCIe Devices

used by this computer system.

}]
PCIeFunctions (v1.2+) [ { array read-only A reference to a collection of PCIe Functions

used by this computer system.

}]
PowerState string read-only This is the current power state of the system.
(enum) (null) See PowerState in Property Details, below, for
Processors { object A reference to the collection of Processors


}
ProcessorSummary { object This object describes the central processors of

the system in general detail.
Count number read-only The number of processors in the system.

(null)
Model string read-only The processor model for the primary or

(null) majority of processors in this system.

} resource and its children. See the
SecureBoot { object A reference to the UEFI SecureBoot resource


}
SerialNumber string read-only The serial number for this system.

(null)
SimpleStorage { object A reference to the collection of storage devices


}
SKU string read-only The manufacturer SKU for this system.

(null)

Storage { object A reference to the collection of storage devices


}
SystemType string read-only The type of computer system represented by

(enum) this resource.
See SystemType in Property Details, below, for
TrustedModules (v1.1+) [ { array read-write This object describes the array of Trusted
Modules in the system.
FirmwareVersion string read-only The firmware version of this Trusted Module.

(null)
FirmwareVersion2 (v1.3+) string read-only The 2nd firmware version of this Trusted
(null) Module, if applicable.
InterfaceType string read-only This property indicates the interface type of the
(enum) (null) Trusted Module.

See InterfaceType in Property Details, below,
InterfaceTypeSelection (v1.3+) string read-only The Interface Type selection supported by this
(enum) (null) Trusted Module.
See InterfaceTypeSelection in Property
property.


}] resource and its children. See the
UUID string read-only The universal unique identifier (UUID) for this
(null) system.
Action Details
Reset
This action is used to reset the system.
Property Details
BootSourceOverrideEnabled:
Describes the state of the Boot Source Override feature.
string Description
Continuous The system will boot to the target specified in the BootSourceOverrideTarget until this property
is set to Disabled.
Disabled The system will boot normally.
Once On its next boot cycle, the system will boot (one time) to the Boot Source Override Target. The
value of BootSourceOverrideEnabled is then reset back to Disabled.
BootSourceOverrideMode:
The BIOS Boot Mode (either Legacy or UEFI) to be used when BootSourceOverrideTarget boot source is
booted from.
string Description
Legacy The system will boot in non-UEFI boot mode to the Boot Source Override Target.
UEFI The system will boot in UEFI boot mode to the Boot Source Override Target.
BootSourceOverrideTarget:
The current boot source to be used at next boot instead of the normal boot device, if
BootSourceOverrideEnabled is true.
string Description
BiosSetup Boot to the BIOS Setup Utility.

Cd Boot from the CD/DVD disc.
Diags Boot the manufacturer's Diagnostics program.
Floppy Boot from the floppy disk drive.
Hdd Boot from a hard drive.
None Boot from the normal boot device.
Pxe Boot from the Pre-Boot EXecution (PXE) environment.
RemoteDrive (v1.2+) Boot from a remote drive (e.g. iSCSI).
SDCard Boot from an SD Card.
UefiHttp Boot from a UEFI HTTP network location.
UefiShell Boot to the UEFI Shell.
UefiTarget Boot to the UEFI Device specified in the UefiTargetBootSourceOverride property.
Usb Boot from a USB device as specified by the system BIOS.
Utilities Boot the manufacturer's Utilities program(s).
HostingRoles:
The hosing roles that this computer system supports. The enumerations of HostingRoles specify different
features that the hosting ComputerSystem supports.
string Description
ApplicationServer The system hosts functionality that supports general purpose applications.
StorageServer The system hosts functionality that supports the system acting as a storage server.
Switch The system hosts functionality that supports the system acting as a switch.
IndicatorLED:
The state of the indicator LED, used to identify the system.
string Description
Unknown The state of the Indicator LED cannot be determined. Deprecated v1.4+. This value has
(deprecated been Deprecated in favor of returning null if the state is unknown.
v1.4)
InterfaceType:
This property indicates the interface type of the Trusted Module.
string Description
TCM1_0 Trusted Cryptography Module (TCM) 1.0.
TPM1_2 Trusted Platform Module (TPM) 1.2.

TPM2_0 Trusted Platform Module (TPM) 2.0.
InterfaceTypeSelection:
The Interface Type selection supported by this Trusted Module.
string Description
BiosSetting The TrustedModule supports switching InterfaceType via platform software, such as a
BIOS configuration Attribute.
FirmwareUpdate The TrustedModule supports switching InterfaceType via a firmware update.
None The TrustedModule does not support switching the InterfaceType.
OemMethod The TrustedModule supports switching InterfaceType via an OEM proprietary mechanism.
MemoryMirroring:
The ability and type of memory mirroring supported by this system.
string Description
DIMM The system supports DIMM mirroring at the DIMM level. Individual DIMMs can be mirrored.
Hybrid The system supports a hybrid mirroring at the system and DIMM levels. Individual DIMMs can be
mirrored.
None The system does not support DIMM mirroring.
System The system supports DIMM mirroring at the System level. Individual DIMMs are not paired for
mirroring in this mode.
PowerState:
This is the current power state of the system.
string Description
Off The system is powered off, although some components may continue to have AUX power
such as management controller.
On The system is powered on.
PoweringOff A temporary state between On and Off. The power off action can take time while the OS is in
the shutdown process.
PoweringOn A temporary state between Off and On. This temporary state can be very short.
SystemType:
The type of computer system represented by this resource.
string Description
Composed (v1.4+) A computer system that has been created by binding resource blocks together.
OS An operating system instance.
Physical A computer system.
PhysicallyPartitioned A hardware-based partition of a computer system.
Virtual A virtual machine instance running on this system.

VirtuallyPartitioned A virtual or software-based partition of a computer system.
Drive 1.2.0
Drive contains properties describing a single physical disk drive for any system, along with links to associated Volumes.
#Drive.SecureErase { } object This action is used to securely erase the contents of the drive.
AssetTag string read-write The user assigned asset tag for this drive.
(null)
BlockSizeBytes number read-only The size of the smallest addressible unit (Block) of this drive in
(bytes) (null) bytes.
CapableSpeedGbs number read-only The speed which this drive can communicate to a storage
(Gbit/s) (null) controller in ideal conditions in Gigabits per second.
CapacityBytes number read-only The size in bytes of this Drive.

(bytes) (null)
EncryptionAbility string read-only The encryption abilities of this drive.

(enum) (null) See EncryptionAbility in Property Details, below, for the
EncryptionStatus string read-only The status of the encrytion of this drive.

(enum) (null) See EncryptionStatus in Property Details, below, for the
FailurePredicted boolean read-only Is this drive currently predicting a failure in the near future.
(null)
HotspareType string read-only The type of hotspare this drive is currently serving as.
(enum) (null) See HotspareType in Property Details, below, for the possible
Identifiers [ { } ] array The Durable names for the drive. See the
(object) redfish.dmtf.org/schemas/v1/Resource.v1_1_0.json schema
for details on this property.
IndicatorLED string read-write The state of the indicator LED, used to identify the drive.
Links { object Contains references to other resources that are related to this
resource.
Chassis (v1.2+) { object A reference to the Chassis which contains this Drive.

}
Endpoints (v1.1+) [ { array read-only An array of references to the endpoints that connect to this
drive.

} ]

Volumes [ { array read-only An array of references to the volumes contained in this drive.
This will reference Volumes that are either wholly or only partly
contained by this drive.

} ]
}
Location [ { } ] array The Location of the drive. See the

(object) redfish.dmtf.org/schemas/v1/Resource.v1_1_0.json schema
Manufacturer string read-only This is the manufacturer of this drive.

(null)
MediaType string read-only The type of media contained in this drive.

(enum) (null) See MediaType in Property Details, below, for the possible
Model string read-only This is the model number for the drive.
(null)
NegotiatedSpeedGbs number read-only The speed which this drive is currently communicating to the
(Gbit/s) (null) storage controller in Gigabits per second.
Operations [ { } ] array The operations currently running on the Drive. See the
(object) redfish.dmtf.org/schemas/v1/Volume.v1_0_0.json schema for
PartNumber string read-only The part number for this drive.

(null)
PredictedMediaLifeLeftPercent number read-only The percentage of reads and writes that are predicted to still
(null) be available for the media.
Protocol string read-only The protocol this drive is using to communicate to the storage
(enum) (null) controller.
See Protocol in Property Details, below, for the possible
Revision string read-only The revision of this Drive. This is typically the
(null) firmware/hardware version of the drive.
RotationSpeedRPM number read-only The rotation speed of this Drive in Revolutions per Minute
(RPM) (null) (RPM).
SerialNumber string read-only The serial number for this drive.

(null)
SKU string read-only This is the SKU for this drive.

(null)
Status { } object This type describes the status and health of a resource and its
children. See the redfish.dmtf.org/schemas/v1/Resource.json
StatusIndicator string read-write The state of the status indicator, used to communicate status
(enum) (null) information about this drive.
See StatusIndicator in Property Details, below, for the possible

Action Details
SecureErase
This action is used to securely erase the contents of the drive.
Property Details
EncryptionAbility:
The encryption abilities of this drive.
string Description
None The drive is not capable of self encryption.
Other The drive is capable of self encryption through some other means.
SelfEncryptingDrive The drive is capable of self encryption per the Trusted Computing Group's Self
Encrypting Drive Standard.
EncryptionStatus:
The status of the encrytion of this drive.
string Description
Foreign The drive is currently encrypted, the data is not accessible to the user, and the system
requires user intervention to expose the data.
Locked The drive is currently encrypted and the data is not accessible to the user, however the
system has the ability to unlock the drive automatically.
Unecrypted The drive is not currently encrypted. Deprecated v1.2+. This value has been Deprecated
(deprecated v1.2) in favor of Unencrypted.
Unencrypted The drive is not currently encrypted.

(v1.1+)
Unlocked The drive is currently encrypted but the data is accessible to the user unencrypted.
HotspareType:
The type of hotspare this drive is currently serving as.
string Description
Chassis The drive is currently serving as a hotspare for all other drives in the chassis.
Dedicated The drive is currently serving as a hotspare for a user defined set of drives.
Global The drive is currently serving as a hotspare for all other drives in the storage system.
None The drive is not currently a hotspare.
IndicatorLED:
The state of the indicator LED, used to identify the drive.
string Description

MediaType:
The type of media contained in this drive.
string Description
HDD The drive media type is traditional magnetic platters.
SMR The drive media type is shingled magnetic recording.
SSD The drive media type is solid state or flash memory.
Protocol:
The protocol this drive is using to communicate to the storage controller.
string Description
AHCI Advanced Host Controller Interface
FC Fibre Channel
FCoE Fibre Channel over Ethernet
FTP File Transfer Protocol
HTTP Hypertext Transport Protocol
HTTPS Secure Hypertext Transport Protocol
iSCSI Internet SCSI
NFSv3 Network File System version 3
NVMe Non-Volatile Memory Express
NVMeOverFabrics NVMe over Fabrics
PCIe PCI Express (Vendor Proprietary)
SAS Serial Attached SCSI
SATA Serial AT Attachment
SFTP Secure File Transfer Protocol
SMB Server Message Block (aka CIFS Common Internet File System)
UHCI Universal Host Controller Interface
USB Universal Serial Bus
StatusIndicator:
The state of the status indicator, used to communicate status information about this drive.
string Description
Fail The drive has failed.
Hotspare The drive is marked to be automatically rebuilt and used as a replacement for a
failed drive.

InACriticalArray The array that this drive is a part of is degraded.
InAFailedArray The array that this drive is a part of is failed.
OK The drive is OK.
PredictiveFailureAnalysis The drive is still working but predicted to fail soon.
Rebuild The drive is being rebuilt.
Endpoint 1.0.2
This 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.
Actions { } object The Actions object contains the available custom actions
on this resource.
ConnectedEntities [ { array read-write All the entities connected to this endpoint.
EntityLink read-only A link to the associated entity.

(null)
EntityPciId { object (null) The PCI ID of the connected entity.
DeviceId string read-only The Device ID of this PCIe function.

(null)
SubsystemId string read-only The Subsystem ID of this PCIe function.

(null)
SubsystemVendorId string read-only The Subsystem Vendor ID of this PCIe function.

(null)
VendorId string read-only The Vendor ID of this PCIe function.

} (null)
EntityRole string read-only The role of the connected entity.

(enum) (null) See EntityRole in Property Details, below, for the possible
EntityType string read-only The type of the connected entity.

(enum) (null) See EntityType in Property Details, below, for the possible
Identifiers [ { } ] array (null) Identifiers for the remote entity. See the
(object) redfish.dmtf.org/schemas/v1/Resource.v1_1_0.json
Oem { } object (null) See the OEM object definition in the Common properties
section. See the
PciClassCode string read-only The Class Code, Subclass code, and Programming
(null) Interface code of this PCIe function.
PciFunctionNumber number read-only The PCI ID of the connected entity.

}] (null)
EndpointProtocol string read-only The protocol supported by this endpoint.

(enum) (null) See EndpointProtocol in Property Details, below, for the
HostReservationMemoryBytes number read-only The amount of memory in Bytes that the Host should
(bytes) (null) allocate to connect to this endpoint.
Identifiers [ { } ] array (null) Identifiers for this endpoint. See the

Links { object The links object contains the links to other resources that
are related to this resource.
MutuallyExclusiveEndpoints [ { array read-only An array of references to the endpoints that may not be
used in zones if this endpoint is used in a zone.

} ]
section. See the
Ports [ { array read-only An array of references to the the physical ports associated
with this endpoint.

} ]
}
PciId { object (null) The PCI ID of the endpoint.

(null)

(null)

(null)

} (null)
Redundancy [ { array read-write Redundancy information for the lower level endpoints
supporting this endpoint.

}]
Status { } object (null) This type describes the status and health of a resource
Property Details
EndpointProtocol:
The protocol supported by this endpoint.
string Description

FC Fibre Channel
iSCSI Internet SCSI
EntityRole:
The role of the connected entity.
string Description
Both The entity is acting as both an initiator and a target.
Initiator The entity is acting as an initiator.
Target The entity is acting as a target.
EntityType:
The type of the connected entity.
string Description
Bridge The entity is a PCI(e) bridge.
DisplayController The entity is a display controller.
Drive The entity is a disk drive. The EntityLink property (if present) should be a Drive.Drive
entity.
NetworkController The entity is a network controller. The EntityLink property (if present) should be an
EthernetInterface.EthernetInterface entity.
Processor The entity is a processor device.

RootComplex The entity is a PCI(e) root complex. The EntityLink property (if present) should be a
ComputerSystem.ComputerSystem entity.
StorageExpander The entity is a storage expander. The EntityLink property (if present) should be a
Chassis.Chassis entity.
StorageInitiator The entity is a storage initator. The EntityLink property (if present) should be a
Storage.StorageController entity.
EthernetInterface 1.3.0
This schema defines a simple ethernet NIC resource.
AutoNeg boolean read-write This indicates if the speed and duplex are automatically negotiated
(null) and configured on this interface.
FQDN string read-write This is the complete, fully qualified domain name obtained by DNS
(null) for this interface.
FullDuplex boolean read-write This indicates if the interface is in Full Duplex mode or not.
(null)
HostName string read-write The DNS Host Name, without any domain information.
(null)
InterfaceEnabled boolean read-write This indicates whether this interface is enabled.

(null)
IPv4Addresses [ { } ] array The IPv4 addresses assigned to this interface. See the
(object) redfish.dmtf.org/schemas/v1/IPAddresses.v1_0_0.json schema for
IPv6Addresses [ { } ] array This array of objects enumerates all of the currently assigned IPv6
(object) addresses on this interface. See the
redfish.dmtf.org/schemas/v1/IPAddresses.v1_0_0.json schema for
IPv6AddressPolicyTable [ { array read-write An array representing the RFC 6724 Address Selection Policy
Table.
Label number read-write The IPv6 Label (as defined in RFC 6724 section 2.1).
(null)
Precedence number read-write The IPv6 Precedence (as defined in RFC 6724 section 2.1.
(null)
Prefix string read-write The IPv6 Address Prefix (as defined in RFC 6724 section 2.1).
}] (null)
IPv6DefaultGateway string read-only This is the IPv6 default gateway address that is currently in use on
(null) this interface.
IPv6StaticAddresses [ { } ] array This array of objects represents all of the IPv6 static addresses to
(object) be assigned on this interface. This object represents a single IPv6
static address to be assigned on a network interface. See the
redfish.dmtf.org/schemas/v1/IPAddresses.v1_0_0.json schema for
Links (v1.1+) { object Contains references to other resources that are related to this
resource.

Chassis (v1.3+) { object A reference to the Chassis which contains this Ethernet Interface.

}
Endpoints [ { array read-only An array of references to the endpoints that connect to this
ethernet interface.

} ]
HostInterface (v1.2+) { object This is a reference to a Host Interface that is associated with this
Ethernet Interface.

}
Oem { } object See the OEM object definition in the Common properties section.
} See the redfish.dmtf.org/schemas/v1/Resource.json schema for
LinkStatus (v1.1+) string read-only The link status of this interface (port).
(enum) (null) See LinkStatus in Property Details, below, for the possible values
of this property.
MACAddress string read-write This is the currently configured MAC address of the (logical port)
(null) interface.
MaxIPv6StaticAddresses number read-only This indicates the maximum number of Static IPv6 addresses that
(null) can be configured on this interface.
MTUSize number read-write This is the currently configured Maximum Transmission Unit
(null) (MTU) in bytes on this interface.
NameServers [ ] array read-only This represents DNS name servers that are currently in use on this
(string) interface.
PermanentMACAddress string read-only This is the permanent MAC address assigned to this interface
(null) (port).
SpeedMbps number read-write This is the current speed in Mbps of this interface.
(Mbit/s) (null)
Status { } object (null) This type describes the status and health of a resource and its
UefiDevicePath string read-only The UEFI device path for this interface.
(null)
VLAN { } object (null) If this Network Interface supports more than one VLAN, this
property will not be present and the client should look for VLANs
collection in the link section of this resource. See the
redfish.dmtf.org/schemas/v1/VLanNetworkInterface.v1_0_0.json
VLANs { object This is a reference to a collection of VLANs and is only used if the
interface supports more than one VLANs.

}

Property Details
LinkStatus:
The link status of this interface (port).
string Description
LinkDown There is no link on this interface, but the interface is connected.
LinkUp The link is available for communication on this interface.
NoLink There is no link or connection detected on this interface.
Event 1.2.0
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.
Context (v1.1+) string read-only A context can be supplied at subscription time. This property is
the context value supplied by the subscriber.
Events [ { array read-write Each event in this array has a set of properties that describe the
required event. Since this is an array, more than one event can be sent
simultaneously.
Context (deprecated v1.2) string read-only A context can be supplied at subscription time. This property is
the context value supplied by the subscriber. Deprecated v1.2+.
Events are triggered independently from subscriptions to those
events. This property has been Deprecated in favor of
Event.v1_0_2.Event.Context
EventId string read-only This is a unique instance identifier of an event.
EventTimestamp string read-only This is time the event occurred.
EventType string read-only This indicates the type of event sent, according to the definitions
(enum) in the EventService.
See EventType in Property Details, below, for the possible values
of this property.
MemberId string read-only This is the identifier for the member within the collection.
Message string read-only This is the human readable message, if provided.
MessageArgs [ ] array read-only This array of message arguments are substituted for the
(string) arguments in the message when looked up in the message
registry.
MessageId string read-only This is the key for this message which can be used to look up the
message in a message registry.
See the redfish.dmtf.org/schemas/v1/Resource.json schema for
OriginOfCondition { object This indicates the resource that originated the condition that

caused the event to be generated.

}
Severity string read-only This is the severity of the event.

}]
Property Details
EventType:
This indicates the type of event sent, according to the definitions in the EventService.
string Description
Alert A condition exists which requires attention.
ResourceAdded A resource has been added.
ResourceRemoved A resource has been removed.
ResourceUpdated The value of this resource has been updated.
StatusChange The status of this resource has changed.
EventDestination 1.2.0
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.
Context string read-write A client-supplied string that is stored with the event
required (null) destination subscription.
Destination string read-only The URI of the destination Event Service.

required on create
EventTypes [ ] array read-only This property shall contain the types of events that shall be
(string sent to the desination.
(enum)) See EventTypes in Property Details, below, for the
HttpHeaders [ { } ] array read-write This is for setting HTTP headers, such as authorization
information. This object will be null on a GET.
MessageIds (v1.1+) [ ] array read-only A list of MessageIds that the service will only send.
(string,
null)
OriginResources (v1.1+) [ { array read-only A list of resources for which the service will only send
related events.

}]
Protocol string read-only The protocol type of the event connection.

(enum) required on create See Protocol in Property Details, below, for the possible

Property Details
EventTypes:
This property shall contain the types of events that shall be sent to the desination.
string Description
Alert A condition exists which requires attention
ResourceAdded A resource has been added
ResourceRemoved A resource has been removed
ResourceUpdated The value of this resource has been updated
StatusChange The status of this resource has changed
Protocol:
The protocol type of the event connection.
string
Redfish
EventService 1.0.4
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).
#EventService.SubmitTestEvent { } object This action is used to generate a test event.

} For more information, see the Action Details section
below.
DeliveryRetryAttempts number read-only This is the number of attempts an event posting is

retried before the subscription is terminated.
DeliveryRetryIntervalSeconds number read-only This represents the number of seconds between

(seconds) retry attempts for sending any given Event.
EventTypesForSubscription [ ] array read-only This is the types of Events that can be subscribed
(string to.
(enum)) See EventTypesForSubscription in Property Details,

(null)

redfish.dmtf.org/schemas/v1/Resource.json schema
Subscriptions { object This is a reference to a collection of Event

Destination resources.

}

Action Details
SubmitTestEvent
This action is used to generate a test event.
Property Details
EventTypesForSubscription:
This is the types of Events that can be subscribed to.
string Description
Fabric 1.0.2
Fabric contains properties describing a simple fabric consisting of one or more switches, zero or more endpoints, and zero
or more zones.
Endpoints { object A collection of references to the endpoints contained in this fabric.

}
FabricType string read-only The protocol being sent over this fabric.
(enum) (null) See FabricType in Property Details, below, for the possible values of this
property.
Links { object Contains references to other resources that are related to this resource.
Oem { } object See the OEM object definition in the Common properties section. See the
} redfish.dmtf.org/schemas/v1/Resource.json schema for details on this property.
MaxZones number read-only The value of this property shall contain the maximum number of zones the switch
(null) can currently configure.
Status { } object This type describes the status and health of a resource and its children. See the
redfish.dmtf.org/schemas/v1/Resource.json schema for details on this property.
Switches { object A collection of references to the switches contained in this fabric.

}
Zones { object A collection of references to the zones contained in this fabric.

}

Property Details
FabricType:
The protocol being sent over this fabric.
string Description
FC Fibre Channel
iSCSI Internet SCSI
HostInterface 1.1.0
This schema defines a Host Interface resource.
AuthenticationModes [ ] array read-write This indicates the authentication modes available on this interface.
(string See AuthenticationModes in Property Details, below, for the
(enum)) possible values of this property.
ExternallyAccessible boolean read-only This indicates whether this interface is accessible by external
(null) entities.
FirmwareAuthEnabled boolean read-write This indicates whether this firmware authentication is enabled for
(null) this interface.
FirmwareAuthRoleId string read-write This property contains the Role for firmware authentication on this
interface.
HostEthernetInterfaces { object This is a reference to a collection of NICs that Computer Systems

use for network communication with this Host Interface.

}
HostInterfaceType string read-only This indicates the Host Interface type for this interface.
(enum) (null) See HostInterfaceType in Property Details, below, for the possible

(null)
KernelAuthEnabled boolean read-write This indicates whether this kernel authentication is enabled for this
(null) interface.
KernelAuthRoleId string read-write This property contains the Role for kernel authentication on this
interface.
resource.
ComputerSystems [ { array read-only An array of references to the Computer Systems connected to this
Host Interface.

} ]
FirmwareAuthRole { object A reference to the Role object defining Privileges for this Host
Interface when using firmware authentication.

}
KernelAuthRole { object A reference to the Role object defining Privileges for this Host
Interface when using kernel authentication.

}
ManagerEthernetInterface { object This is a reference to a single NIC that this Manager uses for
network communication with this Host Interface.

}
NetworkProtocol { object This is a reference to the network services and their settings that
the Manager controls. It is here that clients will find network
configuration options as well as network services.

}
Property Details
AuthenticationModes:

This indicates the authentication modes available on this interface.
string Description
AuthNone Requests without any sort of authentication are allowed.
BasicAuth Requests using HTTP Basic Authentication are allowed.
OemAuth Requests using OEM authentication mechanisms are allowed.
RedfishSessionAuth Requests using Redfish Session Authentication are allowed.
HostInterfaceType:
This indicates the Host Interface type for this interface.
string Description
NetworkHostInterface This interface is a Network Host Interface.
JsonSchemaFile 1.1.0
This is the schema definition for the Schema File locator resource.
Languages [ ] array read-only Language codes for the schemas available.

(string) required
Location [ { array read-write Location information for this schema file.

required
ArchiveFile string read-only If the schema is hosted on the service in an archive file, this is the name
of the file within the archive.
ArchiveUri string read-only If the schema is hosted on the service in an archive file, this is the link to
the archive file.
Language string read-only The language code for the file the schema is in.
PublicationUri string read-only Link to publicly available (canonical) URI for schema.
Uri string read-only Link to locally available URI for schema.

}]
Schema string read-only The @odata.type name this schema describes.

required
LogEntry 1.2.0
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.
Created string read-only The time the log entry was created.
EntryCode string read-only (null) If the EntryType is SEL, this will have the entry code for the
(enum) log entry.

See EntryCode in Property Details, below, for the possible
EntryType string read-only his is the type of log entry.

(enum) required on create See EntryType in Property Details, below, for the possible
EventId (v1.1+) string read-only This is a unique instance identifier of an event.
EventTimestamp (v1.1+) string read-only This is time the event occurred.
EventType (v1.1+) string read-only This indicates the type of an event recorded in this log.
(enum) See EventType in Property Details, below, for the possible
resource.
OriginOfCondition { object This is the URI of the resource that caused the log entry.

}
}
Message string read-only (null) This property decodes from EntryType: If it is Event then it is
a message string. Otherwise, it is SEL or Oem specific. In
most cases, this will be the actual Log Entry.
MessageArgs [ ] array read-only The values of this property shall be any arguments for the
(string) message.
MessageId string read-only This property decodes from EntryType: If it is Event then it is
a message id. Otherwise, it is SEL or Oem specific. This
value is only used for registries - for more information, see the
specification.
OemRecordFormat string read-only (null) If the entry type is Oem, this will contain more information
about the record format from the Oem.
SensorNumber number read-only (null) This property decodes from EntryType: If it is SEL, it is the
sensor number; if Event then the count of events. Otherwise,
it is Oem specific.
SensorType string read-only (null) If the EntryType is SEL, this will have the sensor type that the
(enum) log entry pertains to.
See SensorType in Property Details, below, for the possible
Severity string read-only (null) This is the severity of the log entry.
(enum) See Severity in Property Details, below, for the possible
Property Details
EntryCode:
If the EntryType is SEL, this will have the entry code for the log entry.
string

Assert
D0 Power State
D1 Power State
D2 Power State
D3 Power State
Deassert
Device Disabled
Device Enabled
Device Inserted / Device Present
Device Removed / Device Absent
Fully Redundant
Informational
Install Error
Limit Exceeded
Limit Not Exceeded
Lower Critical - going high
Lower Critical - going low
Lower Non-critical - going high
Lower Non-critical - going low
Lower Non-recoverable - going high
Lower Non-recoverable - going low
Monitor
Non-redundant:Insufficient Resources
Non-redundant:Sufficient Resources from Insufficient Resources
Non-redundant:Sufficient Resources from Redundant
Performance Lags
Performance Met
Predictive Failure asserted
Predictive Failure deasserted
Redundancy Degraded
Redundancy Degraded from Fully Redundant
Redundancy Degraded from Non-redundant
Redundancy Lost
State Asserted

State Deasserted
Transition to Active
Transition to Busy
Transition to Critical from less severe
Transition to Critical from Non-recoverable
Transition to Degraded
Transition to Idle
Transition to In Test
Transition to Non-Critical from more severe
Transition to Non-Critical from OK
Transition to Non-recoverable
Transition to Non-recoverable from less severe
Transition to Off Duty
Transition to Off Line
Transition to OK
Transition to On Line
Transition to Power Off
Transition to Power Save
Transition to Running
Upper Critical - going high
Upper Critical - going low
Upper Non-critical - going high
Upper Non-critical - going low
Upper Non-recoverable - going high
Upper Non-recoverable - going low
EntryType:
his is the type of log entry.
string
Event
Oem
SEL
EventType:
This indicates the type of an event recorded in this log.

string Description
SensorType:
If the EntryType is SEL, this will have the sensor type that the log entry pertains to.
string
Add-in Card
BaseOSBoot/InstallationStatus
Battery
Boot Error
Button/Switch
Cable/Interconnect
Chassis
ChipSet
CoolingDevice
Critical Interrupt
Current
Drive Slot/Bay
Entity Presence
Event Logging Disabled
Fan
FRUState
LAN
Management Subsystem Health
Memory
Microcontroller/Coprocessor
Module/Board
Monitor ASIC/IC
OS Stop/Shutdown
Other FRU

Other Units-based Sensor
Physical Chassis Security
Platform Alert
Platform Security Violation Attempt
POST Memory Resize
Power Supply / Converter
PowerUnit
Processor
Session Audit
Slot/Connector
System ACPI PowerState
System Event
System Firmware Progress
SystemBoot/Restart
Temperature
Terminator
Version Change
Voltage
Watchdog
Severity:
This is the severity of the log entry.
string
Critical
OK
Warning
LogService 1.0.4
This resource represents the log service for the resource or service to which it is associated.
#LogService.ClearLog { } object
DateTime string read-write The current DateTime (with offset) for the log service, used to set
(null) or read time.
DateTimeLocalOffset string read-write The time offset from UTC that the DateTime property is set to in

(null) format: +06:00 .
Entries { object References to the log entry collection.

}
MaxNumberOfRecords number read-only The maximum number of log entries this service can have.
OverWritePolicy string read-only The overwrite policy for this service that takes place when the log
(enum) is full.
See OverWritePolicy in Property Details, below, for the possible

(null)
Action Details
ClearLog
Property Details
OverWritePolicy:
The overwrite policy for this service that takes place when the log is full.
string Description
NeverOverWrites When full, new entries to the Log will be discarded.
Unknown The overwrite policy is not known or is undefined.
WrapsWhenFull When full, new entries to the Log will overwrite previous entries.
Manager 1.3.1
This is the schema definition for a Manager. Examples of managers are BMCs, Enclosure Managers, Management
Controllers and other subsystems assigned managability functions.
#Manager.ForceFailover { } object The ForceFailover action forces a failover of this

manager to the manager used in the parameter.
For more information, see the Action Details section
below.
#Manager.ModifyRedundancySet { } object The ModifyRedundancySet operation is used to add

or remove members to a redundant group of
manager.
below.
#Manager.Reset { } object The reset action resets/reboots the manager.

below.

CommandShell { object Information about the Command Shell service

provided by this manager.
ConnectTypesSupported [ ] array read-only This object is used to enumerate the Command Shell
(string connection types allowed by the implementation.
(enum)) See ConnectTypesSupported in Property Details,
MaxConcurrentSessions number read-only Indicates the maximum number of service sessions,

regardless of protocol, this manager is able to
support.
ServiceEnabled boolean read-write Indicates if the service is enabled for this manager.
}
DateTime string read-write The current DateTime (with offset) for the manager,
(null) used to set or read time.
DateTimeLocalOffset string read-write The time offset from UTC that the DateTime property
(null) is set to in format: +06:00 .
EthernetInterfaces { object This is a reference to a collection of NICs that this

manager uses for network communication. It is here
that clients will find NIC configuration options and
settings.

}
FirmwareVersion string read-only The firmware version of this Manager.

(null)
GraphicalConsole { object The value of this property shall contain the

information about the Graphical Console (KVM-IP)
service of this manager.
ConnectTypesSupported [ ] array read-only This object is used to enumerate the Graphical

(string Console connection types allowed by the
(enum)) implementation.
See ConnectTypesSupported in Property Details,

support.
}
HostInterfaces { object This is a reference to a collection of Host Interfaces

that this manager uses for local host communication.
It is here that clients will find Host Interface
configuration options and settings.

}
Links { object Contains references to other resources that are

ManagerForChassis [ { array read-only This property is an array of references to the chassis

that this manager has control over.

} ]
ManagerForServers [ { array read-only This property is an array of references to the systems

that this manager has control over.

} ]
ManagerInChassis (v1.1+) { object This property is a reference to the chassis that this
manager is located in.

}

} properties section. See the
LogServices { object This is a reference to a collection of Logs used by the

manager.

}
ManagerType string read-only This property represents the type of manager that
(enum) this resource represents.
See ManagerType in Property Details, below, for the
Model string read-only The model information of this Manager as defined by

(null) the manufacturer.
NetworkProtocol { object This is a reference to the network services and their

settings that the manager controls. It is here that
clients will find network configuration options as well
as network services.

}
PowerState string read-only This is the current power state of the Manager.
(enum) (null) See PowerState in Property Details, below, for the
Redundancy [ { array read-write Redundancy information for the managers of this

system.

}]
SerialConsole { object Information about the Serial Console service

provided by this manager.
ConnectTypesSupported [ ] array read-only This object is used to enumerate the Serial Console
(string connection types allowed by the implementation.
(enum)) See ConnectTypesSupported in Property Details,

support.

}
SerialInterfaces { object This is a reference to a collection of serial interfaces

that this manager uses for serial and console
communication. It is here that clients will find serial
configuration options and settings.

}
ServiceEntryPointUUID string read-only The UUID of the Redfish Service provided by this
manager.

UUID string read-only The Universal Unique Identifier (UUID) for this
(null) Manager.
VirtualMedia { object This is a reference to the Virtual Media services for

this particular manager.

}
Action Details
ForceFailover
The ForceFailover action forces a failover of this manager to the manager used in the parameter.
ModifyRedundancySet
The ModifyRedundancySet operation is used to add or remove members to a redundant group of manager.
Reset
The reset action resets/reboots the manager.
Property Details
ConnectTypesSupported:
This object is used to enumerate the Serial Console connection types allowed by the implementation.
string Description
IPMI The controller supports a Serial Console connection using the IPMI Serial-over-LAN (SOL) protocol.
Oem The controller supports a Serial Console connection using an OEM-specific protocol.
SSH The controller supports a Serial Console connection using the SSH protocol.
Telnet The controller supports a Serial Console connection using the Telnet protocol.
ManagerType:
This property represents the type of manager that this resource represents.

string Description
AuxiliaryController A controller which provides management functions for a particular subsystem or

group of devices.
BMC A controller which provides management functions for a single computer system.
EnclosureManager A controller which provides management functions for a chassis or group of devices
or systems.
ManagementController A controller used primarily to monitor or manage the operation of a device or

system.
RackManager A controller which provides management functions for a whole or part of a rack.
PowerState:
This is the current power state of the Manager.
string Description
Off The state is powered Off.
On The state is powered On.
PoweringOff A temporary state between On and Off.
PoweringOn A temporary state between Off and On.
ManagerAccount 1.1.0
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.
Enabled boolean read-write This property is used by a User Administrator to disable an account
w/o having to delet the user information. When set to true, the user
can login. When set to false, the account is administratively disabled
and the user cannot login.
resource.
Role { object A reference to the Role object defining Privileges for this account--
returned when the resource is read. The ID of the role is the same
as property RoleId.

}
}
Locked boolean read-write This property indicates that the account has been auto-locked by the
account service because the lockout threshold has been exceeded.
When set to true, the account is locked. A user admin can write the
property to false to manually unlock, or the account service will
unlock it once the lockout duration period has passed.

Password string read-write This property is used with a PATCH or PUT to write the password
required on create for the account. This property is null on a GET.
(null)
RoleId string read-write This property contains the Role for this account.
required on create
UserName string read-write This property contains the user name for the account.
required on create
ManagerNetworkProtocol 1.2.0
This resource is used to obtain or modify the network services managed by a given manager.
DHCP { object Settings for this Manager's DHCP protocol support.
Port number read-write Indicates the protocol port.

(null)
ProtocolEnabled boolean read-write Indicates if the protocol is enabled or disabled.

} (null)
FQDN string read-only This is the fully qualified domain name for the manager
(null) obtained by DNS including the host name and top-level
domain name.
HostName string read-only The DNS Host Name of this manager, without any
(null) domain information.
HTTP { object Settings for this Manager's HTTP protocol support.

(null)

} (null)
HTTPS { object Settings for this Manager's HTTPS protocol support.

(null)

} (null)
IPMI { object Settings for this Manager's IPMI-over-LAN protocol

support.

(null)

} (null)
KVMIP { object Settings for this Manager's KVM-IP protocol support.

(null)

} (null)
NTP (v1.2+) { object Settings for this Manager's NTP protocol support.
NTPServers [ ] array read-write Indicates to which NTP servers this manager is

(string, subscribed.
null)

(null)

} (null)
SNMP { object Settings for this Manager's SNMP support.

(null)

} (null)
SSDP { object Settings for this Manager's SSDP support.
NotifyIPv6Scope string read-write Indicates the scope for the IPv6 Notify messages for
(enum) (null) SSDP.
See NotifyIPv6Scope in Property Details, below, for the
NotifyMulticastIntervalSeconds number read-write Indicates how often the Multicast is done from this
(seconds) (null) service for SSDP.
NotifyTTL number read-write Indicates the time to live hop count for SSDPs Notify
(null) messages.

(null)

} (null)
SSH { object Settings for this Manager's SSH (Secure Shell) protocol
support.

(null)

} (null)
Telnet { object Settings for this Manager's Telnet protocol support.

(null)

} (null)
VirtualMedia { object Settings for this Manager's Virtual Media support.


(null)

} (null)
Property Details
NotifyIPv6Scope:
Indicates the scope for the IPv6 Notify messages for SSDP.
string Description
Link SSDP Notify messages are sent to addresses in the IPv6 Local Link scope.
Organization SSDP Notify messages are sent to addresses in the IPv6 Local Organization scope.
Site SSDP Notify messages are sent to addresses in the IPv6 Local Site scope.
Memory 1.2.0
This is the schema definition for definition of a Memory and its configuration.
#Memory.DisablePassphrase { } object Disable passphrase for given regions.

below.
#Memory.SecureEraseUnit { } object This defines the action for securely erasing given
regions.
below.
#Memory.SetPassphrase { } object Set passphrase for the given regions.

below.
#Memory.UnlockUnit { } object This defines the action for unlocking given regions.
below.
AllocationAlignmentMiB (v1.2+) number read-only The boundary which memory regions are allocated
(null) on, measured in MiB.
AllocationIncrementMiB (v1.2+) number read-only The size of the smallest unit of allocation for a
(null) memory region, thus it is the multiple in which
regions are actually reserved.
AllowedSpeedsMHz [ ] array read-only Speed bins supported by this Memory.

(number)
BaseModuleType string read-only The base module type of Memory.

(enum) (null) See BaseModuleType in Property Details, below,
BusWidthBits number read-only Bus Width in bits.

(null)
CapacityMiB number read-only Memory Capacity in MiB.

(mebibytes) (null)

DataWidthBits number read-only Data Width in bits.

(null)
DeviceID string read-only Device ID.

(null)
DeviceLocator string read-only Location of the Memory in the platform.

(null)
ErrorCorrection string read-only Error correction scheme supported for this memory.
(enum) (null) See ErrorCorrection in Property Details, below, for
FirmwareApiVersion string read-only Version of API supported by the firmware.

(null)
FirmwareRevision string read-only Revision of firmware on the Memory controller.

(null)
FunctionClasses [ ] array read-only Function Classes by the Memory.

(string)
IsRankSpareEnabled boolean read-only Rank spare enabled status.

(null)
IsSpareDeviceEnabled boolean read-only Spare device enabled status.

(null)
Links (v1.2+) { object Contains references to other resources that are

Chassis { object A reference to the Chassis which contains this

Memory.

}

} properties section. See the
Manufacturer string read-only The Memory manufacturer.

(null)
MaxTDPMilliWatts [ ] array read-only Maximum TDPs in milli Watts.

(number)
MemoryDeviceType string read-only Type details of the Memory.

(enum) (null) See MemoryDeviceType in Property Details, below,
MemoryLocation { object Memory connection information to sockets and

memory controllers.
Channel number read-only Channel number in which Memory is connected.

(null)
MemoryController number read-only Memory controller number in which Memory is

(null) connected.
Slot number read-only Slot number in which Memory is connected.

(null)

Socket number read-only Socket number in which Memory is connected.

} (null)
MemoryMedia [ ] array read-only Media of this Memory.

(string See MemoryMedia in Property Details, below, for
(enum)) the possible values of this property.
MemoryType string read-only The type of Memory.

(enum) (null) See MemoryType in Property Details, below, for the
Metrics { object A reference to the Metrics associated with this

Memory.

}
OperatingMemoryModes [ ] array read-only Memory modes supported by the Memory.

(string See OperatingMemoryModes in Property Details,
(enum)) below, for the possible values of this property.
OperatingSpeedMhz number read-only Operating speed of Memory in MHz.

(null)
PartNumber string read-only The product part number of this device.

(null)
PersistentRegionNumberLimit (v1.2+) number read-only Total number of persistent regions this Memory can
(null) support.
PersistentRegionSizeLimitMiB number read-only Total size of persistent regions in MiB.

(null)
PersistentRegionSizeMaxMiB (v1.2+) number read-only Maximum size of a single persistent region in MiB.
(null)
PowerManagementPolicy { object Power management policy information.
AveragePowerBudgetMilliWatts number read-only Average power budget in milli watts.

(milliWatts) (null)
MaxTDPMilliWatts number read-only Maximum TDP in milli watts.

(milliWatts) (null)
PeakPowerBudgetMilliWatts number read-only Peak power budget in milli watts.

(milliWatts) (null)
PolicyEnabled boolean read-only Power management policy enabled status.

} (null)
RankCount number read-only Number of ranks available in the Memory.

(null)
Regions [ { array read-write Memory regions information within the Memory.
MemoryClassification string read-only Classification of memory occupied by the given

(enum) (null) memory region.
See MemoryClassification in Property Details,
OffsetMiB number read-only Offset with in the Memory that corresponds to the
(mebibytes) (null) starting of this memory region in MiB.
PassphraseState boolean read-only State of the passphrase for this region.

(null)
RegionId string read-only Unique region ID representing a specific region

(null) within the Memory.
SizeMiB number read-only Size of this memory region in MiB.

}] (mebibytes) (null)
SecurityCapabilities { object This object contains security capabilities of the

Memory.
MaxPassphraseCount number read-only Maximum number of passphrases supported for

(null) this Memory.
PassphraseCapable boolean read-only Memory passphrase set capability.

(null)
SecurityStates [ ] array read-only Security states supported by the Memory.

} (string See SecurityStates in Property Details, below, for
SerialNumber string read-only The product serial number of this device.

(null)
SpareDeviceCount number read-only Number of unused spare devices available in the

(null) Memory.
Status (v1.1+) { } object This type describes the status and health of a
SubsystemDeviceID string read-only Subsystem Device ID.

(null)
SubsystemVendorID string read-only SubSystem Vendor ID.

(null)
VendorID string read-only Vendor ID.

(null)
VolatileRegionNumberLimit (v1.2+) number read-only Total number of volatile regions this Memory can
(null) support.
VolatileRegionSizeLimitMiB number read-only Total size of volatile regions in MiB.

(null)
VolatileRegionSizeMaxMiB (v1.2+) number read-only Maximum size of a single volatile region in MiB.
(null)
Action Details
DisablePassphrase
Disable passphrase for given regions.
SecureEraseUnit
This defines the action for securely erasing given regions.
SetPassphrase

Set passphrase for the given regions.
UnlockUnit
This defines the action for unlocking given regions.
Property Details
BaseModuleType:
The base module type of Memory.
string Description
LRDIMM Load Reduced.
Mini_RDIMM Mini_RDIMM.
Mini_UDIMM Mini_UDIMM.
RDIMM Registered DIMM.
SO_DIMM SO_DIMM.
SO_DIMM_16b SO_DIMM_16b.
SO_DIMM_32b SO_DIMM_32b.
SO_RDIMM_72b SO_RDIMM_72b.
SO_UDIMM_72b SO_UDIMM_72b.
UDIMM UDIMM.
ErrorCorrection:
Error correction scheme supported for this memory.
string Description
AddressParity Address Parity errors can be corrected.
MultiBitECC Multi-bit Data errors can be corrected by ECC.
NoECC No ECC available.
SingleBitECC Single bit Data error can be corrected by ECC.
MemoryClassification:
Classification of memory occupied by the given memory region.
string Description
Block Block accesible memory.
ByteAccessiblePersistent Byte accessible persistent memory.
Volatile Volatile memory.
MemoryDeviceType:
Type details of the Memory.

string Description
DDR DDR.
DDR2 DDR2.
DDR2_SDRAM DDR2 SDRAM.
DDR2_SDRAM_FB_DIMM DDR2 SDRAM FB_DIMM.
DDR2_SDRAM_FB_DIMM_PROBE DDR2 SDRAM FB_DIMM PROBE.
DDR3 DDR3.
DDR4 DDR4.
DDR4E_SDRAM DDR4E SDRAM.
DDR_SDRAM DDR SDRAM.
DDR_SGRAM DDR SGRAM.
EDO EDO.
FastPageMode Fast Page Mode.
LPDDR3_SDRAM LPDDR3 SDRAM.
LPDDR4_SDRAM LPDDR4 SDRAM.
PipelinedNibble Pipelined Nibble.
ROM ROM.
SDRAM SDRAM.
MemoryMedia:
Media of this Memory.
string Description
DRAM DRAM media.
NAND NAND media.
Proprietary Proprietary media.
MemoryType:
The type of Memory.
string Description
DRAM The memory module is composed of volatile memory.
NVDIMM_F The memory module is composed of non-volatile memory.
NVDIMM_N The memory module is composed of volatile memory backed by non-volatile memory.
NVDIMM_P The memory module is composed of a combination of non-volatile and volatile memory.

OperatingMemoryModes:
Memory modes supported by the Memory.
string Description
Block Block accessible system memory.
PMEM Persistent memory, byte accesible through system address space.
SecurityStates:
Security states supported by the Memory.
string Description
Disabled Secure mode is disabled.
Enabled Secure mode is enabled.
Frozen Secure state is frozen and can not be modified until reset.
Locked Secure mode is enabled and access to the data is locked.
Passphraselimit Number of attempts to unlock the Memory exceeded limit.
Unlocked Secure mode is enabled and access to the data is unlocked.
MemoryChunks 1.1.0
This is the schema definition of a Memory Chunk and its configuration.
AddressRangeType string read-only Memory type of this memory chunk.

(enum) (null) See AddressRangeType in Property Details, below, for the possible
InterleaveSets [ { array read-write This is the interleave sets for the memory chunk.
Memory { object Describes a memory device of the interleave set.

}
MemoryLevel number read-only Level of the interleave set for multi-level tiered memory.
(null)
OffsetMiB number read-only Offset within the DIMM that corresponds to the start of this memory
(null) region, with units in MiB.
RegionId string read-only DIMM region identifier.

(null)
SizeMiB number read-only Size of this memory region in MiB.

}] (null)
IsMirrorEnabled boolean read-only Mirror Enabled status.

(null)
IsSpare boolean read-only Spare enabled status.

(null)
MemoryChunkSizeMiB number read-only Size of the memory chunk in MiB.

(null)
Property Details
AddressRangeType:
Memory type of this memory chunk.
string Description
Block Block accesible memory.
PMEM Byte accessible persistent memory.
MemoryDomain 1.2.0
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.
AllowsBlockProvisioning boolean read-only Indicates if this Memory Domain supports the provisioning of
(null) blocks of memory.
AllowsMemoryChunkCreation boolean read-only Indicates if this Memory Domain supports the creation of
(null) Memory Chunks.
AllowsMirroring (v1.1+) boolean read-only Indicates if this Memory Domain supports the creation of
(null) Memory Chunks with mirroring enabled.
AllowsSparing (v1.1+) boolean read-only Indicates if this Memory Domain supports the creation of
(null) Memory Chunks with sparing enabled.
InterleavableMemorySets [ { array read-write This is the interleave sets for the memory chunk.
MemorySet [ { array read-only This is the collection of memory for a particular interleave set.

} ]
}]
MemoryChunks { object (null) A reference to the collection of Memory Chunks associated with
this Memory Domain.

}
MemoryMetrics 1.1.2
MemoryMetrics contains usage and health statistics for a single Memory module or device instance.
#MemoryMetrics.ClearCurrentPeriod { } object This sets the CurrentPeriod object values to zero.

} For more information, see the Action Details

section below.
BlockSizeBytes number read-only Block size in bytes.

(bytes) (null)
CurrentPeriod { object This object contains the Memory metrics since last
reset or ClearCurrentPeriod action.
BlocksRead number read-only Number of blocks read since reset.

(null)
BlocksWritten number read-only Number of blocks written since reset.

} (null)
HealthData { object This object describes the health information of the

memory.
AlarmTrips { object Alarm trip information about the memory.
AddressParityError boolean read-only Address parity error detected status.

(null)
CorrectableECCError boolean read-only Correctable data error threshold crossing alarm

(null) trip detected status.
SpareBlock boolean read-only Spare block capacity crossing alarm trip detected
(null) status.
Temperature boolean read-only Temperature threshold crossing alarm trip

(null) detected status.
UncorrectableECCError boolean read-only Uncorrectable data error threshold crossing alarm

} (null) trip detected status.
DataLossDetected boolean read-only Data loss detection status.

(null)
LastShutdownSuccess boolean read-only Status of last shutdown.

(null)
PerformanceDegraded boolean read-only Performance degraded mode status.

(null)
PredictedMediaLifeLeftPercent (v1.1+) number read-only The percentage of reads and writes that are
(null) predicted to still be available for the media.
RemainingSpareBlockPercentage number read-only Remaining spare blocks in percentage.

} (null)
LifeTime { object This object contains the Memory metrics for the
lifetime of the Memory.
BlocksRead number read-only Number of blocks read for the lifetime of the
(null) Memory.
BlocksWritten number read-only Number of blocks written for the lifetime of the
} (null) Memory.
Action Details
ClearCurrentPeriod
This sets the CurrentPeriod object values to zero.

MessageRegistry 1.1.0
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.
Language string read-only This is the RFC 5646 compliant language code for the registry.
required
Messages { } object required The pattern property indicates that a free-form string is the unique identifier
for the message within the registry.
OwningEntity string read-only This is the organization or company that publishes this registry.
required
RegistryPrefix string read-only This is the single word prefix used to form a messageID structure.
required
RegistryVersion string read-only This is the message registry version which is used in the middle portion of a
required messageID.
MessageRegistryFile 1.1.0
This is the schema definition for the Schema File locator resource.
Languages [ ] array read-only Language codes for the schemas available.

(string) required
Location [ { array read-write Location information for this schema file.

required
ArchiveFile string read-only If the schema is hosted on the service in an archive file, this is the name
of the file within the archive.
ArchiveUri string read-only If the schema is hosted on the service in an archive file, this is the link to
the archive file.
Language string read-only The language code for the file the schema is in.
PublicationUri string read-only Link to publicly available (canonical) URI for schema.
Uri string read-only Link to locally available URI for schema.

}]
Registry string read-only The Registry Name, Major and Minor version used in MessageID
required construction.
NetworkAdapter 1.0.1
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.

#NetworkAdapter.ResetSettingsToDefault { } object This action is to clear the settings back to

} factory defaults.
For more information, see the Action Details
section below.
Controllers [ { array read-write The set of network controllers ASICs that

make up this NetworkAdapter.
ControllerCapabilities { object (null) The capabilities of this controller.
DataCenterBridging { object (null) Data Center Bridging (DCB) for this

controller.
Capable boolean read-only Whether this controller is capable of Data

} (null) Center Bridging (DCB).
NetworkDeviceFunctionCount number read-only The maximum number of physical functions

(null) available on this controller.
NetworkPortCount number read-only The number of physical ports on this

(null) controller.
NPIV { object (null) N_Port ID Virtualization (NPIV) capabilties

for this controller.
MaxDeviceLogins number read-only The maximum number of N_Port ID

(null) Virtualization (NPIV) logins allowed
simultaneously from all ports on this
controller.
MaxPortLogins number read-only The maximum number of N_Port ID

} (null) Virtualization (NPIV) logins allowed per
physical port on this controller.
VirtualizationOffload { object (null) Virtualization offload for this controller.
SRIOV { object (null) Single-Root Input/Output Virtualization (SR-

IOV) capabilities.
SRIOVVEPACapable boolean read-only Whether this controller supports Single Root

} (null) Input/Output Virtualization (SR-IOV) in
Virtual Ethernet Port Aggregator (VEPA)
mode.
VirtualFunction { object (null) A virtual function of a controller.
DeviceMaxCount number read-only The maximum number of Virtual Functions

(null) (VFs) supported by this controller.
MinAssignmentGroupSize number read-only The minimum number of Virtual Functions

(null) (VFs) that can be allocated or moved
between physical functions for this
controller.
NetworkPortMaxCount number read-only The maximum number of Virtual Functions

} (null) (VFs) supported per network port for this
} controller.
}
FirmwarePackageVersion string read-only The version of the user-facing firmware

(null) package.
Links { object Links.

NetworkDeviceFunctions [ { array read-only Contains the members of this collection.

} ]
NetworkPorts [ { array read-only Contains the members of this collection.

} ]
Oem { } object See the OEM object definition in the

Common properties section. See the
PCIeDevices [ { array read-only Contains the members of this collection.

} ]
}
}]
Manufacturer string read-only The manufacturer or OEM of this network

(null) adapter.
Model string read-only The model string for this network adapter.
(null)
NetworkDeviceFunctions { object Contains the members of this collection.

}
NetworkPorts { object Contains the members of this collection.

}
PartNumber string read-only Part number for this network adapter.

(null)
SerialNumber string read-only The serial number for this network adapter.
(null)
SKU string read-only The manufacturer SKU for this network

(null) adapter.
Status { } object (null) This type describes the status and health of
a resource and its children. See the
Action Details
ResetSettingsToDefault
This action is to clear the settings back to factory defaults.
NetworkDeviceFunction 1.1.0
A Network Device Function represents a logical interface exposed by the network adapter.

AssignablePhysicalPorts [ { array read-only Contains the members of this collection.

}]
BootMode string read-write The boot mode configured for this network device function.
(enum) (null) See BootMode in Property Details, below, for the possible
DeviceEnabled boolean read-write Whether the network device function is enabled.

(null)
Ethernet { object (null) Ethernet.
MACAddress string read-write This is the currently configured MAC address of the (logical
(null) port) network device function.
MTUSize number read-write The Maximum Transmission Unit (MTU) configured for this
(null) network device function.
PermanentMACAddress string read-only This is the permanent MAC address assigned to this
} (null) network device function (physical function).
FibreChannel { object (null) Fibre Channel.
AllowFIPVLANDiscovery boolean read-write Whether the FCoE Initialization Protocol (FIP) is used for
(null) populating the FCoE VLAN Id.
BootTargets [ { array read-write An array of Fibre Channel boot targets configured for this
network device function.
BootPriority number read-write The relative priority for this entry in the boot targets array.
(null)
LUNID string read-write The Logical Unit Number (LUN) ID to boot from on the
(null) device referred to by the corresponding WWPN.
WWPN string read-write The World-Wide Port Name to boot from.

} ] (null)
FCoEActiveVLANId number read-only The active FCoE VLAN ID.

(null)
FCoELocalVLANId number read-write The locally configured FCoE VLAN ID.

(null)
PermanentWWNN string read-only This is the permanent WWNN address assigned to this
(null) network device function (physical function).
PermanentWWPN string read-only This is the permanent WWPN address assigned to this
WWNN string read-write This is the currently configured WWNN address of the
WWNSource string read-write The configuration source of the WWNs for this connection
(enum) (null) (WWPN and WWNN).
See WWNSource in Property Details, below, for the
WWPN string read-write This is the currently configured WWPN address of the
} (null) network device function (physical function).

iSCSIBoot { object (null) iSCSI Boot.
AuthenticationMethod string read-write The iSCSI boot authentication method for this network
(enum) (null) device function.
See AuthenticationMethod in Property Details, below, for
CHAPSecret string read-write The shared secret for CHAP authentication.

(null)
CHAPUsername string read-write The username for CHAP authentication.

(null)
InitiatorDefaultGateway string read-write The IPv6 or IPv4 iSCSI boot default gateway.
(null)
InitiatorIPAddress string read-write The IPv6 or IPv4 address of the iSCSI initiator.
(null)
InitiatorName string read-write The iSCSI initiator name.

(null)
InitiatorNetmask string read-write The IPv6 or IPv4 netmask of the iSCSI boot initiator.
(null)
IPAddressType string read-write The type of IP address (IPv6 or IPv4) being populated in the
(enum) (null) iSCSIBoot IP address fields.
See IPAddressType in Property Details, below, for the
IPMaskDNSViaDHCP boolean read-write Whether the iSCSI boot initiator uses DHCP to obtain the
(null) iniator name, IP address, and netmask.
MutualCHAPSecret string read-write The CHAP Secret for 2-way CHAP authentication.
(null)
MutualCHAPUsername string read-write The CHAP Username for 2-way CHAP authentication.
(null)
PrimaryDNS string read-write The IPv6 or IPv4 address of the primary DNS server for the
(null) iSCSI boot initiator.
PrimaryLUN number read-write The logical unit number (LUN) for the primary iSCSI boot
(null) target.
PrimaryTargetIPAddress string read-write The IP address (IPv6 or IPv4) for the primary iSCSI boot
(null) target.
PrimaryTargetName string read-write The name of the iSCSI primary boot target.
(null)
PrimaryTargetTCPPort number read-write The TCP port for the primary iSCSI boot target.
(null)
PrimaryVLANEnable boolean read-write This indicates if the primary VLAN is enabled.

(null)
PrimaryVLANId number read-write The 802.1q VLAN ID to use for iSCSI boot from the primary
(null) target.
RouterAdvertisementEnabled boolean read-write Whether IPv6 router advertisement is enabled for the iSCSI
(null) boot target.

SecondaryDNS string read-write The IPv6 or IPv4 address of the secondary DNS server for
(null) the iSCSI boot initiator.
SecondaryLUN number read-write The logical unit number (LUN) for the secondary iSCSI boot
(null) target.
SecondaryTargetIPAddress string read-write The IP address (IPv6 or IPv4) for the secondary iSCSI boot
(null) target.
SecondaryTargetName string read-write The name of the iSCSI secondary boot target.
(null)
SecondaryTargetTCPPort number read-write The TCP port for the secondary iSCSI boot target.
(null)
SecondaryVLANEnable boolean read-write This indicates if the secondary VLAN is enabled.

(null)
SecondaryVLANId number read-write The 802.1q VLAN ID to use for iSCSI boot from the
(null) secondary target.
TargetInfoViaDHCP boolean read-write Whether the iSCSI boot target name, LUN, IP address, and
} (null) netmask should be obtained from DHCP.
PCIeFunction { object Contains the members of this collection.

}
}
MaxVirtualFunctions number read-only The number of virtual functions (VFs) that are available for
(null) this Network Device Function.
NetDevFuncCapabilities [ ] array read-only Capabilities of this network device function.

(string (null) See NetDevFuncCapabilities in Property Details, below, for
NetDevFuncType string read-write The configured capability of this network device function.
(enum) (null) See NetDevFuncType in Property Details, below, for the
PhysicalPortAssignment { object Contains the members of this collection.

}
Status { } object (null) This type describes the status and health of a resource and
VirtualFunctionsEnabled boolean read-only Whether Single Root I/O Virtualization (SR-IOV) Virual
(null) Functions (VFs) are enabled for this Network Device
Function.
Property Details
AuthenticationMethod:
The iSCSI boot authentication method for this network device function.
string Description

CHAP iSCSI Challenge Handshake Authentication Protocol (CHAP) authentication is used.
MutualCHAP iSCSI Mutual Challenge Handshake Authentication Protocol (CHAP) authentication is used.
None No iSCSI authentication is used.
BootMode:
The boot mode configured for this network device function.
string Description
Disabled Do not indicate to UEFI/BIOS that this device is bootable.
FibreChannel Boot this device using the embedded Fibre Channel support and configuration.
Only applicable if the NetworkDeviceFunctionType is set to FibreChannel.
FibreChannelOverEthernet Boot this device using the embedded Fibre Channel over Ethernet (FCoE) boot
support and configuration. Only applicable if the NetworkDeviceFunctionType is
set to FibreChannelOverEthernet.
iSCSI Boot this device using the embedded iSCSI boot support and configuration.
Only applicable if the NetworkDeviceFunctionType is set to iSCSI.
PXE Boot this device using the embedded PXE support. Only applicable if the
NetworkDeviceFunctionType is set to Ethernet.
IPAddressType:
The type of IP address (IPv6 or IPv4) being populated in the iSCSIBoot IP address fields.
string Description
IPv4 IPv4 addressing is used for all IP-fields in this object.
IPv6 IPv6 addressing is used for all IP-fields in this object.
NetDevFuncCapabilities:
Capabilities of this network device function.
string Description
Disabled Neither enumerated nor visible to the operating system.
Ethernet Appears to the operating system as an Ethernet device.
FibreChannel Appears to the operating system as a Fibre Channel device.
FibreChannelOverEthernet Appears to the operating system as an FCoE device.
iSCSI Appears to the operating system as an iSCSI device.
NetDevFuncType:
The configured capability of this network device function.
string Description
Disabled Neither enumerated nor visible to the operating system.
Ethernet Appears to the operating system as an Ethernet device.
FibreChannel Appears to the operating system as a Fibre Channel device.

FibreChannelOverEthernet Appears to the operating system as an FCoE device.
iSCSI Appears to the operating system as an iSCSI device.
WWNSource:
The configuration source of the WWNs for this connection (WWPN and WWNN).
string Description
ConfiguredLocally The set of FC/FCoE boot targets was applied locally through API or UI.
ProvidedByFabric The set of FC/FCoE boot targets was applied by the Fibre Channel fabric.
NetworkInterface 1.1.0
A NetworkInterface contains references linking NetworkAdapter, NetworkPort, and NetworkDeviceFunction resources and
represents the functionality available to the containing system.
NetworkAdapter { object Contains the members of this collection.

}
Oem { } object See the OEM object definition in the Common properties section. See
} the redfish.dmtf.org/schemas/v1/Resource.json schema for details on
this property.
NetworkDeviceFunctions { object Contains the members of this collection.

}
NetworkPorts { object Contains the members of this collection.

}
children. See the redfish.dmtf.org/schemas/v1/Resource.json schema
NetworkPort 1.1.0
A Network Port represents a discrete physical port capable of connecting to a network.
ActiveLinkTechnology string read-write Network Port Active Link Technology.

(enum) (null) See ActiveLinkTechnology in Property Details, below, for
AssociatedNetworkAddresses [ ] array read-only The array of configured network addresses (MAC or WWN)
(string, that are associated with this Network Port, including the
null) programmed address of the lowest numbered Network
Device Function, the configured but not active address if

applicable, the address for hardware port teaming, or other
network addresses.
EEEEnabled boolean read-write Whether IEEE 802.3az Energy Efficient Ethernet (EEE) is
(null) enabled for this network port.
FlowControlConfiguration string read-write The locally configured 802.3x flow control setting for this
(enum) (null) network port.
See FlowControlConfiguration in Property Details, below,
FlowControlStatus string read-only The 802.3x flow control behavior negotiated with the link
(enum) (null) partner for this network port (Ethernet-only).
See FlowControlStatus in Property Details, below, for the
LinkStatus string read-only The status of the link between this port and its link partner.
(enum) (null) See LinkStatus in Property Details, below, for the possible
NetDevFuncMaxBWAlloc [ { array read-write The array of maximum bandwidth allocation percentages for
the Network Device Functions associated with this port.
MaxBWAllocPercent number read-write The maximum bandwidth allocation percentage allocated to

(null) the corresponding network device function instance.
NetworkDeviceFunction { object Contains the members of this collection.

}
}]
NetDevFuncMinBWAlloc [ { array read-write The array of minimum bandwidth allocation percentages for
the Network Device Functions associated with this port.
MinBWAllocPercent number read-write The minimum bandwidth allocation percentage allocated to

(null) the corresponding network device function instance.
NetworkDeviceFunction { object Contains the members of this collection.

}
}]
PhysicalPortNumber string read-only The physical port number label for this port.
(null)
PortMaximumMTU number read-only The largest maximum transmission unit (MTU) that can be
(null) configured for this network port.
SignalDetected boolean read-only Whether or not the port has detected enough signal on
(null) enough lanes to establish link.
SupportedEthernetCapabilities [ ] array read-only The set of Ethernet capabilities that this port supports.
(string (null) See SupportedEthernetCapabilities in Property Details,
(enum)) below, for the possible values of this property.
SupportedLinkCapabilities [ { array read-write The self-described link capabilities of this port.

LinkNetworkTechnology string read-only The self-described link network technology capabilities of
(enum) (null) this port.
See LinkNetworkTechnology in Property Details, below, for
LinkSpeedMbps number read-only The speed of the link in Mbps when this link network
}] (null) technology is active.
WakeOnLANEnabled boolean read-write Whether Wake on LAN (WoL) is enabled for this network
(null) port.
Property Details
ActiveLinkTechnology:
Network Port Active Link Technology.
string Description
Ethernet The port is capable of connecting to an Ethernet network.
FibreChannel The port is capable of connecting to a Fibre Channel network.
InfiniBand The port is capable of connecting to an InfiniBand network.
FlowControlConfiguration:
The locally configured 802.3x flow control setting for this network port.
string Description
None No IEEE 802.3x flow control is enabled on this port.
RX IEEE 802.3x flow control may be initiated by the link partner.
TX IEEE 802.3x flow control may be initiated by this station.
TX_RX IEEE 802.3x flow control may be initiated by this station or the link partner.
FlowControlStatus:
The 802.3x flow control behavior negotiated with the link partner for this network port (Ethernet-only).
string Description
None No IEEE 802.3x flow control is enabled on this port.
RX IEEE 802.3x flow control may be initiated by the link partner.
TX IEEE 802.3x flow control may be initiated by this station.
TX_RX IEEE 802.3x flow control may be initiated by this station or the link partner.
LinkNetworkTechnology:
The self-described link network technology capabilities of this port.
string Description
Ethernet The port is capable of connecting to an Ethernet network.
FibreChannel The port is capable of connecting to a Fibre Channel network.
InfiniBand The port is capable of connecting to an InfiniBand network.

LinkStatus:
The status of the link between this port and its link partner.
string Description
Down The port is enabled but link is down.
Up The port is enabled and link is good (up).
SupportedEthernetCapabilities:
The set of Ethernet capabilities that this port supports.
string Description
EEE IEEE 802.3az Energy Efficient Ethernet (EEE) is supported on this port.
WakeOnLAN Wake on LAN (WoL) is supported on this port.
PCIeDevice 1.1.0
This is the schema definition for the PCIeDevice resource. It represents the properties of a PCIeDevice attached to a
System.
AssetTag string read-write The user assigned asset tag for this PCIe device.
(null)
DeviceType string read-only The device type for this PCIe device.
(enum) See DeviceType in Property Details, below, for the possible values of this
property.
FirmwareVersion string read-only The version of firmware for this PCIe device.
(null)
Links { object The links object contains the links to other resources that are related to
this resource.
Chassis [ { array read-only An array of references to the chassis in which the PCIe device is
contained.

} ]
redfish.dmtf.org/schemas/v1/Resource.json schema for details on this
property.
PCIeFunctions [ { array read-only An array of references to PCIeFunctions exposed by this device.

} ]
}
Manufacturer string read-only This is the manufacturer of this PCIe device.

(null)
Model string read-only This is the model number for the PCIe device.
(null)
PartNumber string read-only The part number for this PCIe device.

(null)
SerialNumber string read-only The serial number for this PCIe device.
(null)
SKU string read-only This is the SKU for this PCIe device.
(null)
Status { } object (null) This type describes the status and health of a resource and its children.
See the redfish.dmtf.org/schemas/v1/Resource.json schema for details on
this property.
Property Details
DeviceType:
The device type for this PCIe device.
string Description
MultiFunction A multi-function PCIe device.
Simulated A PCIe device which is not currently physically present, but is being simulated by the PCIe
infrastructure.
SingleFunction A single-function PCIe device.
PCIeFunction 1.1.0
This is the schema definition for the PCIeFunction resource. It represents the properties of a PCIeFunction attached to a
System.
ClassCode string read-only The Class Code of this PCIe function.

(null)
DeviceClass string read-only The class for this PCIe Function.

(enum) See DeviceClass in Property Details, below, for the possible values of
this property.

(null)
FunctionId number read-only The the PCIe Function identifier.

(null)
FunctionType string read-only The type of the PCIe Function.

(enum) See FunctionType in Property Details, below, for the possible values
of this property.
Links { object The links object contains the links to other resources that are related
to this resource.
Drives [ { array read-only An array of references to the drives which the PCIe device produces.

} ]
EthernetInterfaces [ { array read-only An array of references to the ethernet interfaces which the PCIe
device produces.

} ]
the redfish.dmtf.org/schemas/v1/Resource.json schema for details on
this property.
PCIeDevice { object (null) A reference to the PCIeDevice on which this function resides.

}
StorageControllers [ { array read-only An array of references to the storage controllers which the PCIe
device produces.

} ]
}
RevisionId string read-only The Revision ID of this PCIe function.

(null)

(null)

(null)

(null)
Property Details
DeviceClass:
The class for this PCIe Function.
string Description
Bridge A bridge.
CommunicationController A communication controller.
Coprocessor A coprocessor.
DisplayController A display controller.
DockingStation A docking station.
EncryptionController An encryption controller.
GenericSystemPeripheral A generic system peripheral.
InputDeviceController An input device controller.
IntelligentController An intelligent controller.
MassStorageController A mass storage controller.
MemoryController A memory controller.

MultimediaController A multimedia controller.
NetworkController A network controller.
NonEssentialInstrumentation A non-essential instrumentation.
Other A other class. The function Device Class Id needs to be verified.
ProcessingAccelerators A processing accelerators.
Processor A processor.
SatelliteCommunicationsController A satellite communications controller.
SerialBusController A serial bus controller.
SignalProcessingController A signal processing controller.
UnassignedClass An unassigned class.
UnclassifiedDevice An unclassified device.
WirelessController A wireless controller.
FunctionType:
The type of the PCIe Function.
string Description
Physical A physical PCie function.
Virtual A virtual PCIe function.
Port 1.0.2
Port contains properties describing a port of a switch.
#Port.Reset { } object This action is used to reset this switch.

CurrentSpeedGbps number read-only The current speed of this port.

(Gbit/s) (null)
resource.
AssociatedEndpoints [ { array read-only An array of references to the endpoints that connect to the switch
through this port.

} ]
ConnectedSwitches [ { array read-only An array of references to the switches that connect to the switch
through this port.

} ]
ConnectedSwitchPorts [ { array read-only An array of references to the ports that connect to the switch
through this port.


} ]
MaxSpeedGbps number read-only The maximum speed of this port as currently configured.
(Gbit/s) (null)
PortId string read-only This is the label of this port on the physical switch package.
(null)
PortProtocol string read-only The protocol being sent over this port.
(enum) (null) See PortProtocol in Property Details, below, for the possible
PortType string read-only This is the type of this port.

(enum) (null) See PortType in Property Details, below, for the possible values
of this property.
Width number read-only The number of lanes, phys, or other physical transport links that
(null) this port contains.
Action Details
Reset
This action is used to reset this switch.
Property Details
PortProtocol:
The protocol being sent over this port.
string Description
FC Fibre Channel
iSCSI Internet SCSI

PortType:
This is the type of this port.
string Description
BidirectionalPort This port connects to any type of device.
DownstreamPort This port connects to a target device.
InterswitchPort This port connects to another switch.
ManagementPort This port connects to a switch manager.
UnconfiguredPort This port has not yet been configured.
UpstreamPort This port connects to a host device.
Power 1.3.0
This is the schema definition for the Power Metrics. It represents the properties for Power Consumption and Power
Limiting.
PowerControl [ { array read-write This is the definition for power control function (power
reading/limiting).
Name string read-only Power Control Function name.

(null)
PowerAllocatedWatts number read-only The total amount of power that has been allocated (or
(Watts) (null) budegeted)to chassis resources.
PowerAvailableWatts number read-only The amount of power not already budgeted and therefore
(Watts) (null) available for additional allocation. (powerCapacity -
powerAllocated). This indicates how much reserve power
capacity is left.
PowerCapacityWatts number read-only The total amount of power available to the chassis for

(Watts) (null) allocation. This may the power supply capacity, or power
budget assigned to the chassis from an up-stream chassis.
PowerConsumedWatts number read-only The actual power being consumed by the chassis.
(Watts) (null)
PowerLimit { object Power limit status and configuration information for this
chassis.
CorrectionInMs number read-write The time required for the limiting process to reduce power
(ms) (null) consumption to below the limit.
LimitException string read-write The action that is taken if the power cannot be maintained
(enum) (null) below the LimitInWatts.
See LimitException in Property Details, below, for the
LimitInWatts number read-write The Power limit in watts. Set to null to disable power capping.
} (Watts) (null)
PowerMetrics { object Power readings for this chassis.
AverageConsumedWatts number read-only The average power level over the measurement window (the
(Watts) (null) last IntervalInMin minutes).
IntervalInMin number read-only The time interval (or window) in which the PowerMetrics are
(min) (null) measured over.
MaxConsumedWatts number read-only The highest power consumption level that has occured over
(Watts) (null) the measurement window (the last IntervalInMin minutes).
MinConsumedWatts number read-only The lowest power consumption level over the measurement
} (Watts) (null) window (the last IntervalInMin minutes).
PowerRequestedWatts number read-only The potential power that the chassis resources are requesting
(Watts) (null) which may be higher than the current level being consumed
since requested power includes budget that the chassis
resource wants for future use.
RelatedItem [ { array read-only The ID(s) of the resources associated with this Power Limit.

} ]
}] its children. See the
PowerSupplies [ { array read-write Details of the power supplies associated with this system or
device.
FirmwareVersion string read-only The firmware version for this Power Supply.
(null)
IndicatorLED (v1.2+) string read-write The state of the indicator LED, used to identify the power
(enum) (null) supply.
See IndicatorLED in Property Details, below, for the possible
InputRanges (v1.1+) [ { array read-write This is the input ranges that the power supply can use.

InputType string read-only The Input type (AC or DC).
(enum) (null) See InputType in Property Details, below, for the possible
MaximumFrequencyHz number read-only The maximum line input frequency at which this power supply
(Hz) (null) input range is effective.
MaximumVoltage number read-only The maximum line input voltage at which this power supply
(Volts) (null) input range is effective.
MinimumFrequencyHz number read-only The minimum line input frequency at which this power supply
(Hz) (null) input range is effective.
MinimumVoltage number read-only The minimum line input voltage at which this power supply
(Volts) (null) input range is effective.
OutputWattage number read-only The maximum capacity of this Power Supply when operating
} ] (Watts) (null) in this input range.
LastPowerOutputWatts number read-only The average power output of this Power Supply.
(Watts) (null)
LineInputVoltage number read-only The line input voltage at which the Power Supply is operating.
(Volts) (null)
LineInputVoltageType string read-only The line voltage type supported as an input to this Power
(enum) (null) Supply.
See LineInputVoltageType in Property Details, below, for the
Manufacturer (v1.1+) string read-only This is the manufacturer of this power supply.
(null)
Model string read-only The model number for this Power Supply.
(null)
Name string read-only The name of the Power Supply.

(null)
PartNumber string read-only The part number for this Power Supply.
(null)
PowerCapacityWatts number read-only The maximum capacity of this Power Supply.

(Watts) (null)
PowerSupplyType string read-only The Power Supply type (AC or DC).

(enum) (null) See PowerSupplyType in Property Details, below, for the
Redundancy [ { array read-write A reference to a set of Redundancy entities that provide

redundant services for this resource. See the Redundancy
object definition in the Common objects section.

} ]
RelatedItem [ { array read-write The ID(s) of the resources associated with this Power Limit.

} ]
SerialNumber string read-only The serial number for this Power Supply.
(null)
SparePartNumber string read-only The spare part number for this Power Supply.
(null)
}] its children. See the
Redundancy [ { array read-write Redundancy information for the power subsystem of this
system or device.

}]
Voltages [ { array read-write This is the definition for voltage sensors.
LowerThresholdCritical number read-only Below normal range but not yet fatal.
(Volts) (null)
LowerThresholdFatal number read-only Below normal range and is fatal.

(Volts) (null)
LowerThresholdNonCritical number read-only Below normal range.

(Volts) (null)
MaxReadingRange number read-only Maximum value for this Voltage sensor.

(Volts) (null)
MinReadingRange number read-only Minimum value for this Voltage sensor.

(Volts) (null)
Name string read-only Voltage sensor name.

(null)
PhysicalContext string read-only Describes the area or device to which this voltage
(enum) measurement applies.
See PhysicalContext in Property Details, below, for the
ReadingVolts number read-only The present reading of the voltage sensor.

(Volts) (null)
RelatedItem [ { array read-only Describes the areas or devices to which this voltage
measurement applies.

} ]
SensorNumber number read-only A numerical identifier to represent the voltage sensor.

(null)
UpperThresholdCritical number read-only Above normal range but not yet fatal.
(Volts) (null)
UpperThresholdFatal number read-only Above normal range and is fatal.

(Volts) (null)
UpperThresholdNonCritical number read-only Above normal range.

}] (Volts) (null)
Property Details
IndicatorLED:
The state of the indicator LED, used to identify the power supply.
string Description
InputType:
The Input type (AC or DC).
string Description
AC Alternating Current (AC) input range.
DC Direct Current (DC) input range.
LimitException:
The action that is taken if the power cannot be maintained below the LimitInWatts.
string Description
HardPowerOff Turn the power off immediately when the limit is exceeded.
LogEventOnly Log an event when the limit is exceeded, but take no further action.
NoAction Take no action when the limit is exceeded.
Oem Take an OEM-defined action.
LineInputVoltageType:
The line voltage type supported as an input to this Power Supply.
string Description
AC120V AC 120V nominal input.

ACandDCWideRange Wide range AC or DC input.
ACHighLine (deprecated 277V AC input. Deprecated v1.3+. This value has been Deprecated in favor of
v1.3) AC277V.
ACLowLine (deprecated 100-127V AC input. Deprecated v1.3+. This value has been Deprecated in favor
v1.3) of AC120V.
ACMidLine (deprecated 200-240V AC input. Deprecated v1.3+. This value has been Deprecated in favor
v1.3) of AC240V.
ACWideRange Wide range AC input.
DC240V DC 240V nominal input.
DC380V High Voltage DC input (380V).
DCNeg48V -48V DC input.
Unknown The power supply line input voltage type cannot be determined.
PhysicalContext:
Describes the area or device to which this voltage measurement applies.
string Description
Back The back of the chassis
Backplane A backplane within the chassis
ComputeBay Within a compute bay
CPU A Processor (CPU)
Exhaust The exhaust point of the chassis
ExpansionBay Within an expansion bay
Front The front of the chassis
GPU A Graphics Processor (GPU)
Intake The intake point of the chassis
Lower The lower portion of the chassis
NetworkBay Within a networking bay
NetworkingDevice A networking device
PowerSupply A power supply
PowerSupplyBay Within a power supply bay
Room The room
StorageBay Within a storage bay
StorageDevice A storage device
SystemBoard The system board (PCB)

Upper The upper portion of the chassis
VoltageRegulator A voltage regulator device
PowerSupplyType:
The Power Supply type (AC or DC).
string Description
AC Alternating Current (AC) power supply.
ACorDC Power Supply supports both DC or AC.
DC Direct Current (DC) power supply.
Unknown The power supply type cannot be determined.
PrivilegeRegistry 1.1.0
This is the schema definition for Operation to Privilege mapping.
Mappings [ { array read-write
Entity string read-only Indicates entity name. e.g., Manager.
OperationMap { object List mapping between HTTP method and privilege required for
entity.
DELETE [ { array read-write Indicates privilege required for HTTP DELETE operation.
Privilege [ ] array read-only Lists the privileges that are allowed to perform the given type of
} ] (string) HTTP operation on the entity type.
GET [ { array read-write Indicates privilege required for HTTP GET operation.
HEAD [ { array read-write Indicates privilege required for HTTP HEAD operation.
PATCH [ { array read-write Indicates privilege required for HTTP PATCH operation.
POST [ { array read-write Indicates privilege required for HTTP POST operation.
PUT [ { array read-write Indicates privilege required for HTTP PUT operation.
}
PropertyOverrides [ { array read-write Indicates privilege overrides of property or element within a

entity.
OperationMap { object (null) List mapping between HTTP operation and privilege needed to
perform operation.
}
Targets [ ] array read-only Indicates the URI or Entity.

} ] (string,
null)
ResourceURIOverrides [ { array read-write Indicates privilege overrides of Resource URI.
perform operation.

}

} ] (string,
null)
SubordinateOverrides [ { array read-write Indicates privilege overrides of subordinate resource.
perform operation.
}

} ] (string,
}] null)
OEMPrivilegesUsed [ ] array read-only Lists the set of OEM Priviliges used in building this mapping.
(string)
PrivilegesUsed [ ] array read-only Lists the set of Redfish standard priviliges used in building this
(string mapping.
(enum)) See PrivilegesUsed in Property Details, below, for the possible
Property Details

PrivilegesUsed:
Lists the set of Redfish standard priviliges used in building this mapping.
string Description
ConfigureComponents Able to configure components managed by this service.
ConfigureManager Able to configure Manager resources.
ConfigureSelf Able to change the password for the current user Account.
ConfigureUsers Able to configure Users and their Accounts.
Login Able to log into the service and read resources.
Processor 1.1.0
This is the schema definition for the Processor resource. It represents the properties of a processor attached to a System.
InstructionSet string read-only The instruction set of the processor.

(enum) (null) See InstructionSet in Property Details, below, for the possible values
of this property.
resource.
Chassis { object A reference to the Chassis which contains this Processor.

}
Manufacturer string read-only The processor manufacturer.

(null)
MaxSpeedMHz number read-only The maximum clock speed of the processor.

(null)
Model string read-only The product model number of this device.

(null)
ProcessorArchitecture string read-only The architecture of the processor.

(enum) (null) See ProcessorArchitecture in Property Details, below, for the
ProcessorId { object Identification information for this processor.
EffectiveFamily string read-only The effective Family for this processor.

(null)
EffectiveModel string read-only The effective Model for this processor.

(null)
IdentificationRegisters string read-only The contents of the Identification Registers (CPUID) for this
(null) processor.

MicrocodeInfo string read-only The Microcode Information for this processor.
(null)
Step string read-only The Step value for this processor.

(null)
VendorId string read-only The Vendor Identification for this processor.

} (null)
ProcessorType string read-only The type of processor.

(enum) (null) See ProcessorType in Property Details, below, for the possible
Socket string read-only The socket or location of the processor.

(null)
TotalCores number read-only The total number of cores contained in this processor.
(null)
TotalThreads number read-only The total number of execution threads supported by this processor.
(null)
Property Details
InstructionSet:
The instruction set of the processor.
string Description
ARM-A32 ARM 32-bit.
ARM-A64 ARM 64-bit.
IA-64 Intel IA-64.
MIPS32 MIPS 32-bit.
MIPS64 MIPS 64-bit.
OEM OEM-defined.
x86 x86 32-bit.
x86-64 x86 64-bit.
ProcessorArchitecture:
The architecture of the processor.
string Description
ARM ARM.
IA-64 Intel Itanium.
MIPS MIPS.
OEM OEM-defined.
x86 x86 or x86-64.

ProcessorType:
The type of processor.
string Description
Accelerator An Accelerator.
CPU A Central Processing Unit.
DSP A Digital Signal Processor.
FPGA A Field Programmable Gate Array.
GPU A Graphics Processing Unit.
OEM An OEM-defined Processing Unit.
ResourceBlock 1.0.0
This schema defines a Resource Block resource.
CompositionStatus { object required This property describes the composition status details for this
Resource Block.
CompositionState string read-only This property represents the current state of the Resource Block from
(enum) required a composition perspective.
(null) See CompositionState in Property Details, below, for the possible
Reserved boolean read-write This represents if the Resource Block is reserved by any client.
} (null)
ComputerSystems [ { array read-only An array of references to the Computer Systems available in this
Resource Block.

}]
EthernetInterfaces [ { array read-only An array of references to the Ethernet Interfaces available in this
Resource Block.

}]
resource.
Chassis [ { array read-only An array of references to the Chassis in which this Resource Block is
contained.

} ]
ComputerSystems [ { array read-only An array of references to the Computer Systems that are composed
from this Resource Block.

} ]

Zones [ { array read-only An array of references to the Zones in which this Resource Block is
bound.

} ]
}
Memory [ { array read-only An array of references to the Memory available in this Resource
Block.

}]
NetworkInterfaces [ { array read-only An array of references to the Network Interfaces available in this
Resource Block.

}]
Processors [ { array read-only An array of references to the Processors available in this Resource
Block.

}]
ResourceBlockType [ ] array read-only This property represents the types of resources available on this
(string Resource Block.
(enum)) See ResourceBlockType in Property Details, below, for the possible
SimpleStorage [ { array read-only An array of references to the Simple Storage available in this
Resource Block.

}]
Storage [ { array read-only An array of references to the Storage available in this Resource
Block.

}]
Property Details
CompositionState:
This property represents the current state of the Resource Block from a composition perspective.
string Description
Composed Final successful state of a Resource Block which has participated in composition.
Composing Intermediate state indicating composition is in progress.
Failed The final composition resulted in failure and manual intervention is required to fix it.

Unused Indicates the Resource Block is free and can participate in composition.
ResourceBlockType:
This property represents the types of resources available on this Resource Block.
string Description
Compute This Resource Block contains both Processor and Memory resources in a manner that
creates a compute complex.
ComputerSystem This Resource Block contains ComputerSystem resources.
Memory This Resource Block contains Memory resources.
Network This Resource Block contains Network resources, such as Ethernet Interfaces.
Processor This Resource Block contains Processor resources.
Storage This Resource Block contains Storage resources, such as Storage and Simple Storage.
Role 1.1.0
This resource defines a user role to be used in conjunction with a Manager Account.
AssignedPrivileges [ ] array read-write The redfish privileges that this role includes.
(string See AssignedPrivileges in Property Details, below, for the possible
(enum)) values of this property.
IsPredefined boolean read-only This property is used to indicate if the Role is one of the Redfish
Predefined Roles vs a Custom role.
OemPrivileges [ ] array read-write The OEM privileges that this role includes.
(string)
Property Details
AssignedPrivileges:
The redfish privileges that this role includes.
string Description
ConfigureComponents Able to configure components managed by this service.
ConfigureManager Able to configure Manager resources.
ConfigureSelf Able to change the password for the current user Account.
ConfigureUsers Able to configure Users and their Accounts.
Login Able to log into the service and read resources.
SecureBoot 1.0.2
This resource contains UEFI Secure Boot information. It represents properties for managing the UEFI Secure Boot
functionality of a system.

#SecureBoot.ResetKeys { } object This action is used to reset the Secure Boot keys.
SecureBootCurrentBoot string read-only Secure Boot state during the current boot cycle.
(enum) (null) See SecureBootCurrentBoot in Property Details, below, for the
SecureBootEnable boolean read-write Enable or disable UEFI Secure Boot (takes effect on next
(null) boot).
SecureBootMode string read-only Current Secure Boot Mode.

(enum) (null) See SecureBootMode in Property Details, below, for the
Action Details
ResetKeys
This action is used to reset the Secure Boot keys.
Property Details
SecureBootCurrentBoot:
Secure Boot state during the current boot cycle.
string Description
Disabled Secure Boot is currently disabled.
Enabled Secure Boot is currently enabled.
SecureBootMode:
Current Secure Boot Mode.
string Description
AuditMode Secure Boot is currently in Audit Mode.
DeployedMode Secure Boot is currently in Deployed Mode.
SetupMode Secure Boot is currently in Setup Mode.
UserMode Secure Boot is currently in User Mode.
SerialInterface 1.1.0
This schema defines an asynchronous serial interface resource.
BitRate string read-write The receive and transmit rate of data flow, typically in bits-per-second (bps),
(enum) over the serial connection.
See BitRate in Property Details, below, for the possible values of this
property.
ConnectorType string read-only The type of connector used for this interface.
(enum) See ConnectorType in Property Details, below, for the possible values of

this property.
DataBits string read-write The number of data bits that will follow the start bit over the serial
(enum) connection.
See DataBits in Property Details, below, for the possible values of this
property.
FlowControl string read-write The type of flow control, if any, that will be imposed on the serial
(enum) connection.
See FlowControl in Property Details, below, for the possible values of this
property.

(null)
Parity string read-write The type of parity used by the sender and receiver in order to detect errors
(enum) over the serial connection.
See Parity in Property Details, below, for the possible values of this
property.
PinOut string read-only The physical pin configuration needed for a serial connector.
(enum) (null) See PinOut in Property Details, below, for the possible values of this
property.
SignalType string read-only The type of signal used for the communication connection - RS232 or
(enum) RS485.
See SignalType in Property Details, below, for the possible values of this
property.
StopBits string read-write The period of time before the next start bit is transmitted.
(enum) See StopBits in Property Details, below, for the possible values of this
property.
Property Details
BitRate:
The receive and transmit rate of data flow, typically in bits-per-second (bps), over the serial connection.
string
115200
1200
19200
230400
2400
38400
4800
57600
9600
ConnectorType:
The type of connector used for this interface.
string

DB25 Female. (v1.1+)
DB25 Male. (v1.1+)
DB9 Female. (v1.1+)
DB9 Male. (v1.1+)
mUSB. (v1.1+)
RJ11. (v1.1+)
RJ45. (v1.1+)
USB. (v1.1+)
uUSB. (v1.1+)
DataBits:
The number of data bits that will follow the start bit over the serial connection.
string
FlowControl:
The type of flow control, if any, that will be imposed on the serial connection.
string Description
Hardware Out of band flow control imposed.
None No flow control imposed.
Software XON/XOFF in-band flow control imposed.
Parity:
The type of parity used by the sender and receiver in order to detect errors over the serial connection.
string
Even
Mark
None
Odd
Space
PinOut:
The physical pin configuration needed for a serial connector.
string

Cisco
Cyclades
Digi
SignalType:
The type of signal used for the communication connection - RS232 or RS485.
string
Rs232
Rs485
StopBits:
The period of time before the next start bit is transmitted.
string
ServiceRoot 1.2.0
This object represents the root Redfish service.
AccountService { object This is a link to the Account Service.

}
Chassis { object This is a link to a collection of Chassis.

}
CompositionService { object This is a link to the CompositionService.

}
EventService { object This is a link to the EventService.

}
Fabrics { object A link to a collection of all fabric entities.

}
JsonSchemas { object This is a link to a collection of Json-Schema files.

}
Links { object required Contains references to other resources that are related to this resource.

the redfish.dmtf.org/schemas/v1/Resource.json schema for details on
this property.
Sessions { object Link to a collection of Sessions.

}
}
Managers { object This is a link to a collection of Managers.

}
RedfishVersion string read-only The version of the Redfish service.
Registries { object This is a link to a collection of Registries.

}
SessionService { object This is a link to the Sessions Service.

}
StorageServices (v1.1+) read-only A link to a collection of all storage service entities.
StorageSystems (v1.1+) read-only This is a link to a collection of storage systems.
Systems { object This is a link to a collection of Systems.

}
Tasks { object This is a link to the Task Service.

}
UpdateService { object This is a link to the UpdateService.

}
UUID string read-only Unique identifier for a service instance. When SSDP is used, this value
(null) should be an exact match of the UUID value returned in a 200OK from
an SSDP M-SEARCH request during discovery.
Session 1.1.0
The Session resource describes a single connection (session) between a client and a Redfish service instance.
Password string read-only This property is used in a POST to specify a password when creating
required on create a new session. This property is null on a GET.
(null)
UserName string read-only The UserName for the account for this session.
required on create
(null)

SessionService 1.1.2
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.
Actions (v1.1+) { } object The Actions object contains the available custom actions on this resource.

(null)
Sessions { object Link to a collection of Sessions.

}
SessionTimeout number read-write This is the number of seconds of inactivity that a session may have before
(seconds) the session service closes the session due to inactivity.
Status { } object This type describes the status and health of a resource and its children.
this property.
SimpleStorage 1.2.0
This is the schema definition for the Simple Storage resource. It represents the properties of a storage controller and its
directly-attached devices.
Devices [ { array read-write The storage devices associated with this resource.
CapacityBytes (v1.1+) number read-only The size of the storage device.

(bytes) (null)
Manufacturer string read-only The name of the manufacturer of this device.

(null)
Model string read-only The product model number of this device.

(null)
Name string read-only The name of the resource or array element.
}] children. See the redfish.dmtf.org/schemas/v1/Resource.json
resource.
Chassis { object A reference to the Chassis which contains this Simple Storage.

}

UefiDevicePath string read-only The UEFI device path used to access this storage controller.
(null)
SoftwareInventory 1.1.1
This schema defines an inventory of software components.
Actions { } object The Actions object contains the available custom actions on
this resource.
LowestSupportedVersion (v1.1+) string read-only A string representing the lowest supported version of this
(null) software.
RelatedItem (v1.1+) [ { array read-only The ID(s) of the resources associated with this software
inventory item.

}]
SoftwareId (v1.1+) string read-only A string representing the implementation-specific ID for

identifying this software.
UefiDevicePaths (v1.1+) [ ] array read-only A list of strings representing the UEFI Device Path(s) of the
(string, component(s) associated with this software inventory item.
null)
Updateable boolean read-only Indicates whether this software can be updated by the
(null) update service.
Version string read-only A string representing the version of this software.

(null)
Storage 1.2.0
This 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.
#Storage.SetEncryptionKey { } object This action is used to set the encryption key for the
} storage subsystem.
below.
Drives [ { array read-only The set of drives attached to the storage controllers
represented by this resource.

}]
Links { object Contains references to other resources that are related

to this resource.
Enclosures [ { array read-only An array of references to the chassis to which this

storage subsystem is attached.

} ]
} section. See the
Redundancy [ { array read-write Redundancy information for the storage subsystem.

}]
StorageControllers [ { array read-only The set of storage controllers represented by this

resource.
AssetTag (v1.1+) string read-write The user assigned asset tag for this storage controller.
(null)
FirmwareVersion (v1.1+) string read-only The firmware version of this storage Controller.
(null)
Identifiers [ { } ] array The Durable names for the storage controller. See the
Links (v1.1+) { object Contains references to other resources that are related
to this resource.
Endpoints [ { array read-write An array of references to the endpoints that connect to

this controller.

} ]
} section. See the
Manufacturer (v1.1+) string read-only This is the manufacturer of this storage controller.
(null)
MemberId (v1.1+) string read-only This is the identifier for the member within the collection.
Model (v1.1+) string read-only This is the model number for the storage controller.
(null)
Oem (v1.1+) { } object See the OEM object definition in the Common properties

section. See the
PartNumber (v1.1+) string read-only The part number for this storage controller.
(null)
SerialNumber (v1.1+) string read-only The serial number for this storage controller.
(null)
SKU (v1.1+) string read-only This is the SKU for this storage controller.
(null)
SpeedGbps (v1.1+) number read-only The speed of the storage controller interface.
(Gbit/s) (null)
Status (v1.1+) { } object This type describes the status and health of a resource
SupportedControllerProtocols [ ] array read-only This represents the protocols by which this storage
(string controller can be communicated to.
(enum)) See SupportedControllerProtocols in Property Details,
SupportedDeviceProtocols [ ] array read-only This represents the protocols which the storage
}] (string controller can use to communicate with attached
(enum)) devices.
See SupportedDeviceProtocols in Property Details,
Volumes { object The set of volumes produced by the storage controllers

represented by this resource.

}
Action Details
SetEncryptionKey
This action is used to set the encryption key for the storage subsystem.
Property Details
SupportedControllerProtocols:
This represents the protocols by which this storage controller can be communicated to.
string Description
AHCI Advanced Host Controller Interface.
FC Fibre Channel.
FCoE Fibre Channel over Ethernet.
FCP (v1.2+) Fibre Channel Protocol for SCSI.
FICON (v1.2+) FIbre CONnection (FICON).
FTP File Transfer Protocol.

HTTP Hypertext Transport Protocol.
HTTPS Secure Hypertext Transport Protocol.
iSCSI Internet SCSI.
NFSv3 Network File System version 3.
NVMe Non-Volatile Memory Express.
NVMeOverFabrics NVMe over Fabrics.
PCIe PCI Express (Vendor Proprietary).
SAS Serial Attached SCSI.
SATA Serial AT Attachment.
SFTP Secure File Transfer Protocol.
SMB Server Message Block (aka CIFS Common Internet File System).
UHCI Universal Host Controller Interface.
USB Universal Serial Bus.
SupportedDeviceProtocols:
This represents the protocols which the storage controller can use to communicate with attached devices.
string Description
AHCI Advanced Host Controller Interface.
FC Fibre Channel.
FCoE Fibre Channel over Ethernet.
FCP (v1.2+) Fibre Channel Protocol for SCSI.
FICON (v1.2+) FIbre CONnection (FICON).
FTP File Transfer Protocol.
HTTP Hypertext Transport Protocol.
HTTPS Secure Hypertext Transport Protocol.
iSCSI Internet SCSI.
NVMe Non-Volatile Memory Express.
NVMeOverFabrics NVMe over Fabrics.
PCIe PCI Express (Vendor Proprietary).
SAS Serial Attached SCSI.
SATA Serial AT Attachment.

SFTP Secure File Transfer Protocol.
SMB Server Message Block (aka CIFS Common Internet File System).
UHCI Universal Host Controller Interface.
USB Universal Serial Bus.
Switch 1.0.2
Switch contains properties describing a simple fabric switch.
#Switch.Reset { } object This action is used to reset this switch.

AssetTag string read-write The user assigned asset tag for this switch.
(null)
DomainID number read-only The Domain ID for this switch.

(null)
IndicatorLED string read-write The state of the indicator LED, used to identify the switch.
(enum) (null) See IndicatorLED in Property Details, below, for the possible values of
this property.
IsManaged boolean read-write This indicates whether the switch is in a managed or unmanaged state.
(null)
Links { object Contains references to other resources that are related to this resource.
Chassis { object A reference to the chassis which contains this switch.

}
ManagedBy [ { array read-only An array of references to the managers that manage this switch.

} ]
} redfish.dmtf.org/schemas/v1/Resource.json schema for details on this
property.
LogServices { object (null) A reference to the collection of Log Services associated with this system.

}
Manufacturer string read-only This is the manufacturer of this switch.

(null)
Model string read-only The product model number of this switch.

(null)
PartNumber string read-only The part number for this switch.

(null)
Ports { object A collection of references to the ports for this switch.

PowerState string read-only This is the current power state of the switch.
(enum) (null) See PowerState in Property Details, below, for the possible values of this
property.
Redundancy [ { array read-write Redundancy information for the switches.

}]
SerialNumber string read-only The serial number for this switch.

(null)
SKU string read-only This is the SKU for this switch.

(null)
Status { } object This type describes the status and health of a resource and its children.
this property.
SwitchType string read-only The protocol being sent over this switch.
(enum) (null) See SwitchType in Property Details, below, for the possible values of this
property.
TotalSwitchWidth number read-only The total number of lanes, phys, or other physical transport links that this
(null) switch contains.
Action Details
Reset
This action is used to reset this switch.
Property Details
IndicatorLED:
The state of the indicator LED, used to identify the switch.
string Description
PowerState:
This is the current power state of the switch.
string Description
Off The state is powered Off.
On The state is powered On.
PoweringOff A temporary state between On and Off.
PoweringOn A temporary state between Off and On.
SwitchType:

The protocol being sent over this switch.
string Description
FC Fibre Channel
iSCSI Internet SCSI
Task 1.1.0
This resource contains information about a specific Task scheduled by or being executed by a Redfish service's Task
Service.
EndTime string read-only The date-time stamp that the task was last completed.
Messages [ { } ] array This is an array of messages associated with the task. This type describes a
(object) Message returned by the Redfish service. See the
redfish.dmtf.org/schemas/v1/Message.v1_0_6.json schema for details on this
property.
StartTime string read-only The date-time stamp that the task was last started.
TaskState string read-only The state of the task.

(enum) See TaskState in Property Details, below, for the possible values of this
property.
TaskStatus string read-only This is the completion status of the task.

(enum) See TaskStatus in Property Details, below, for the possible values of this
property.

Property Details
TaskState:
The state of the task.
string Description
Completed Task has completed.
Exception Task has stopped due to an exception condition.
Interrupted Task has been interrupted.
Killed Task was terminated.
New A new task.
Pending Task is pending and has not started.
Running Task is running normally.
Service Task is running as a service.
Starting Task is starting.
Stopping Task is in the process of stopping.
Suspended Task has been suspended.
TaskStatus:
This is the completion status of the task.
string Description
Critical A critical condition exists that requires immediate attention.
OK Normal.
Warning A condition exists that requires attention.
TaskService 1.1.0
This 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.
CompletedTaskOverWritePolicy string read-only Overwrite policy of completed tasks.

(enum) See CompletedTaskOverWritePolicy in Property Details,
DateTime string read-only The current DateTime (with offset) setting that the task
(null) service is using.
LifeCycleEventOnTaskStateChange boolean read-only Send an Event upon Task State Change.

(null)

Tasks { object References to the Tasks collection.

}
Property Details
CompletedTaskOverWritePolicy:
Overwrite policy of completed tasks.
string Description
Manual Completed tasks are not automatically overwritten.
Oldest Oldest completed tasks are overwritten.
Thermal 1.3.0
This is the schema definition for the Thermal properties. It represents the properties for Temperature and Cooling.
Fans [ { array read-write This is the definition for fans.
FanName (deprecated v1.2) string read-only Name of the fan. Deprecated v1.2+. This property has been
(null) Deprecated in favor of Thermal.v1_1_0.Thermal.Fan.Name
IndicatorLED (v1.2+) string read-write The state of the indicator LED, used to identify this Fan.
(null)

(null)

(null)
Manufacturer (v1.2+) string read-only This is the manufacturer of this Fan.

(null)
MaxReadingRange number read-only Maximum value for Reading.

(null)
MinReadingRange number read-only Minimum value for Reading.

(null)
Model (v1.2+) string read-only The model number for this Fan.
(null)
Name (v1.1+) string read-only Name of the fan.

(null)
PartNumber (v1.2+) string read-only The part number for this Fan.
(null)
PhysicalContext string read-only Describes the area or device associated with this fan.
(enum) See PhysicalContext in Property Details, below, for the
Reading number read-only Current fan speed.

(null)
ReadingUnits (v1.1+) string read-only Units in which the reading and thresholds are measured.
(enum) (null) See ReadingUnits in Property Details, below, for the possible
Redundancy [ { array read-write A reference to a set of Redundancy entities that provide

redundant services for this resource. See the Redundancy
object definition in the Common objects section.

} ]
RelatedItem [ { array read-only The ID(s) of the resources serviced with this fan.

} ]
SerialNumber (v1.2+) string read-only The serial number for this Fan.
(null)
SparePartNumber (v1.2+) string read-only The spare part number for this Fan.
(null)
(null)

(null)

}] (null)
Redundancy [ { array read-write This structure is used to show redundancy for fans. The
Component ids will reference the members of the
redundancy groups.

}]

Temperatures [ { array read-write This is the definition for temperature sensors.
(Celsius) (null)

(Celsius) (null)

(Celsius) (null)
MaxReadingRangeTemp number read-only Maximum value for ReadingCelsius.

(Celsius) (null)
MinReadingRangeTemp number read-only Minimum value for ReadingCelsius.

(Celsius) (null)
Name string read-only Temperature sensor name.

(null)
PhysicalContext string read-only Describes the area or device to which this temperature
(enum) measurement applies.
See PhysicalContext in Property Details, below, for the
ReadingCelsius number read-only Temperature.

(Celsius) (null)
RelatedItem [ { array read-only Describes the areas or devices to which this temperature
measurement applies.

} ]
SensorNumber number read-only A numerical identifier to represent the temperature sensor.

(null)
(Celsius) (null)

(Celsius) (null)

}] (Celsius) (null)
Property Details
IndicatorLED:
The state of the indicator LED, used to identify this Fan.

string Description
PhysicalContext:
Describes the area or device to which this temperature measurement applies.
string Description
Back The back of the chassis
Backplane A backplane within the chassis
ComputeBay Within a compute bay
CPU A Processor (CPU)
Exhaust The exhaust point of the chassis
ExpansionBay Within an expansion bay
Front The front of the chassis
GPU A Graphics Processor (GPU)
Intake The intake point of the chassis
Lower The lower portion of the chassis
NetworkBay Within a networking bay
NetworkingDevice A networking device
PowerSupply A power supply
PowerSupplyBay Within a power supply bay
Room The room
StorageBay Within a storage bay
StorageDevice A storage device
SystemBoard The system board (PCB)
Upper The upper portion of the chassis
VoltageRegulator A voltage regulator device
ReadingUnits:
Units in which the reading and thresholds are measured.
string Description
Percent Indicates that the fan reading and thresholds are measured in percentage.
RPM Indicates that the fan reading and thresholds are measured in rotations per minute.

UpdateService 1.2.0
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.
Actions { object The Actions object contains the available custom actions
on this resource.
#UpdateService.SimpleUpdate { } object This action is used to update software components.

below.
FirmwareInventory { object (null) An inventory of firmware.

}
HttpPushUri (v1.1+) string read-only The URI used to perform an HTTP or HTTPS push
update to the Update Service.
HttpPushUriTargets (v1.2+) [ ] array read-write The array of URIs indicating the target for applying the
(string, update image.
null)
HttpPushUriTargetsBusy (v1.2+) boolean read-write This represents if the HttpPushUriTargets property is

(null) reserved by any client.

(null)
SoftwareInventory { object (null) An inventory of software.

}
Status { } object (null) This type describes the status and health of a resource
Action Details
SimpleUpdate
This action is used to update software components.
VirtualMedia 1.1.0
This 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.
ConnectedVia string read-only Current virtual media connection methods.

(enum) (null) See ConnectedVia in Property Details, below, for the possible values of
this property.
Image string read-only A URI providing the location of the selected image.
(null)

ImageName string read-only The current image name.
(null)
Inserted boolean read-only Indicates if virtual media is inserted in the virtual device.
(null)
MediaTypes [ ] array read-only This is the media types supported as virtual media.
(string See MediaTypes in Property Details, below, for the possible values of
(enum)) this property.
WriteProtected boolean read-only Indicates the media is write protected.

(null)
Property Details
ConnectedVia:
Current virtual media connection methods.
string Description
Applet Connected to a client application.
NotConnected No current connection.
Oem Connected via an OEM-defined method.
URI Connected to a URI location.
MediaTypes:
This is the media types supported as virtual media.
string Description
CD A CD-ROM format (ISO) image.
DVD A DVD-ROM format image.
Floppy A floppy disk image.
USBStick An emulation of a USB storage device.
VLanNetworkInterface 1.1.0
This resource describes the attributes of a Virtual LAN.
VLANEnable boolean read-write required on create (null) This indicates if this VLAN is enabled.
VLANId number read-write required on create (null) This indicates the VLAN identifier for this VLAN.
Volume 1.0.3
Volume contains properties used to describe a volume, virtual disk, LUN, or other logical storage entity for any system.
#Volume.Initialize { } object This action is used to prepare the contents of the volume for use by

} the system.
BlockSizeBytes number read-only The size of the smallest addressible unit (Block) of this volume in
(bytes) (null) bytes.
CapacityBytes number read-only The size in bytes of this Volume.

(bytes) (null)
Encrypted boolean read-write Is this Volume encrypted.

(null)
EncryptionTypes [ ] array read-write The types of encryption used by this Volume.

(string See EncryptionTypes in Property Details, below, for the possible
(enum)) values of this property.
Identifiers [ { } ] array The Durable names for the volume. See the
(object) redfish.dmtf.org/schemas/v1/Resource.v1_1_0.json schema for
resource.
Drives [ { array read-only An array of references to the drives which contain this volume. This
will reference Drives that either wholly or only partly contain this
volume.

} ]
} the redfish.dmtf.org/schemas/v1/Resource.json schema for details on
this property.
Operations [ { array read-write The operations currently running on the Volume.
AssociatedTask { object A reference to the task associated with the operation if any.

}
OperationName string read-only The name of the operation.

(null)
PercentageComplete number read-only The percentage of the operation that has been completed.
}] (null)
OptimumIOSizeBytes number read-only The size in bytes of this Volume's optimum IO size.
(bytes) (null)
VolumeType string read-only The type of this volume.

(enum) (null) See VolumeType in Property Details, below, for the possible values
of this property.
Action Details
Initialize
This action is used to prepare the contents of the volume for use by the system.

Property Details
EncryptionTypes:
The types of encryption used by this Volume.
string Description
ControllerAssisted The volume is being encrypted by the storage controller entity.
NativeDriveEncryption The volume is utilizing the native drive encryption capabilities of the drive hardware.
SoftwareAssisted The volume is being encrypted by software running on the system or the operating
system.
VolumeType:
The type of this volume.
string Description
Mirrored The volume is a mirrored device.
NonRedundant The volume is a non-redundant storage device.
RawDevice The volume is a raw physical device without any RAID or other virtualization
applied.
SpannedMirrors The volume is a spanned set of mirrored devices.
SpannedStripesWithParity The volume is a spanned set of devices which uses parity to retain redundant
information.
StripedWithParity The volume is a device which uses parity to retain redundant information.
Zone 1.1.0
Switch contains properties describing a simple fabric zone.
resource.
Endpoints [ { array read-only An array of references to the endpoints that are contained in this
zone.

} ]
InvolvedSwitches [ { array read-only An array of references to the switchs that are utilized in this zone.

} ]
ResourceBlocks (v1.1+) [ { array read-only An array of references to the Resource Blocks that are used in this
Zone.


} ]
}
Redfish documentation generator

This document was created using the Redfish Documentation Generator utility, which uses the contents of the Redfish
schema files (in JSON schema format) to automatically generate the bulk of the text. The source code for the utility is
available for download at the DMTF's Github repository located at http://www.github.com/DMTF/Redfish-Tools.
ANNEX A
Change log
Version Date Description
2018.2 2018-08-10 Release built from Redfish schemas released in DSP8010 version 2018.2
Expanded introduction section with additional information.
Expanded Common Objects section to include previously excluded objects.
Added URI listings for all resources for use with Redfish Specification v1.6.0
Added Resource Collection table showing schema names and URIs.
Restructured common objects section utilizing new Documentation Generator functions.
2018.1 2018-05-01 Initial release. Built from Redfish schemas released in DSP8010 version 2018.1
2017.3 2018-10-30 Historical version build from DSP8010 v2017.3 for use in comparisons with later releases.
2017.0a 2017-05-19 Work in progress release to gather feedback on content and format.

Redfish Resource and Schema Guide: Document Class: Informative Document Status: Published Document Language: en-US

Uploaded by

Copyright:

Available Formats

Redfish Resource and Schema Guide: Document Class: Informative Document Status: Published Document Language: en-US

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Redfish Resource and Schema Guide: Document Class: Informative Document Status: Published Document Language: en-US

Uploaded by

Copyright:

Available Formats

Document Identifier: DSP2046

Redfish Resource and Schema Guide

Document Class: Informative

redfish.dmtf.org 1 DSP2046 v2017.1

redfish.dmtf.org 2 DSP2046 v2017.1

Where can I find more information?

redfish.dmtf.org 3 DSP2046 v2017.1

Using this guide

The property-level details include:

redfish.dmtf.org 4 DSP2046 v2017.1

Accounts { object Link to a collection of Manager Accounts.

@odata.id string read-only The unique identifier for a resource.

Actions (v1.2+) { } object The available actions for this resource.

PrivilegeMap { object A reference to the Privilege mapping defining the

@odata.id string read-only The unique identifier for a resource.

Roles { object Link to a collection of Roles.

@odata.id string read-only The unique identifier for a resource.

ServiceEnabled boolean read-write This indicates whether this service is enabled.

redfish.dmtf.org 5 DSP2046 v2017.1

ObjectDataType string read-only The OData Type of an object-based parameter.

Boolean A boolean (true or false).

NumberArray An array of numbers.

Object An embedded JSON object.

ObjectArray An array of JSON objects.

StringArray An array of strings.

Actions (v1.1+) { } object The available actions for this resource.

redfish.dmtf.org 6 DSP2046 v2017.1

AttributeName string read-only The unique name of the attribute.

CurrentValue string, read-only Placeholder of the current value of the attribute.

DefaultValue string, read-only The default current value of the attribute.

GrayOut boolean read-only The gray-out state of this attribute.

HelpText string read-only The help text for the attribute.

Hidden boolean read-only The hidden state of this attribute.

Immutable boolean read-only Defines whether this attribute is immutable or not.

ReadOnly boolean read-only The read-only state of this attribute.

ScalarIncrement number read-only The amount to increment or decrement the value of an

Type string read-only The type of the attribute.

redfish.dmtf.org 7 DSP2046 v2017.1

ValueName string read-only The value name of the attribute.

Dependencies [ { array read-write The array containing a list of dependencies of attributes

Dependency { object The dependency expression for one or more Attributes in

MapFrom [ { array read-write Array of the map-from conditions for mapping

MapFromProperty string read-only The meta-data property of the attribute specified in

MapToProperty string read-only The meta-data property of the attribute specified in

MapToValue string, read-only The value that MapToProperty is changed to if the

Type string read-only The type of the dependency structure.

redfish.dmtf.org 8 DSP2046 v2017.1

MenuName string read-only The unique name string of this menu.

ReadOnly boolean read-only The read-only state of this menu.

SupportedSystems [ { array read-write Array of systems supported by this attribute registry.

FirmwareVersion (v1.1+) string read-only Firmware version.

ProductName string read-only The product name of the system.

SystemId string read-only The system ID of the system.

EQU The logical operation for 'Equal'.

GEQ The logical operation for 'Greater than or Equal'.

GTR The logical operation for 'Greater than'.

LEQ The logical operation for 'Less than or Equal'.

LSS The logical operation for 'Less than'.

NEQ The logical operation for 'Not Equal'.