Redfish Property Guide - DMTF · Property Name The name of the JSON property as it will appear (case sensitive) in the JSON payload. Defined in Schema(s) The name(s) of the Redfish
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems management andinteroperability. Members and non-members may reproduce DMTF specifications and documents, provided that correctattribution is given. As DMTF specifications may be revised from time to time, the particular version and release date shouldalways be noted.
Implementation of certain elements of this standard or proposed standard may be subject to third party patent rights, includingprovisional patent rights (herein "patent rights"). DMTF makes no representations to users of the standard as to the existenceof such rights, and is not responsible to recognize, disclose, or identify any or all such third party patent right, owners orclaimants, nor for any incomplete or inaccurate identification or disclosure of such rights, owners or claimants. DMTF shallhave 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 itsproduct, protocols or testing procedures. DMTF shall have no liability to any party implementing such standard, whether suchimplementation is foreseeable or not, nor to any patent owner or claimant, and shall have no liability or responsibility for costsor losses incurred if a standard is withdrawn or modified after publication, and shall be indemnified and held harmless by anyparty 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 relateto 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.
OverviewThe 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 themanagement of systems and networks. One of the strengths of the Redfish protocol is that it works with a wide range ofservers: from stand-alone servers to rack-mount and bladed environments to large-scale data centers and cloudenvironments.
The Redfish standard addresses several key issues for infrastructures that require scalability. Large infrastructures oftenconsist of many simple servers of different makes and types. This hyper-scale usage model requires a new approach tosystems management. The Redfish Scalable Platforms Management ("Redfish") protocol addresses these needs by providinga 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 scalabilityrequirements in multi-vendor deployments. It easily integrates with commonly used tools, using RESTful interfaces to performoperations and using JSON and OData formats for data payloads.
Who should read this document?This document is intended primarily as a reference for schema authors to locate existing property definitions within theRedfish Schema. End users and other consumers of Redfish data may also use this guide to look up property definitionswithout regard to their location in the schema.
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. Containsan interactive schema explorer, hosted schema and other links.
Redfish User Forum: http://www.redfishforum.com User forum monitored by DMTF Redfish personnel to answerquestions about any Redfish-related topics:
DMTF Github Repositories: http://www.github.com/DMTF Open source tools and libraries for working with the RedfishAPI.
Redfish Standards: http://www.dmtf.org/standards/redfish Schemas, specs, mockups, white papers, FAQ, educationalmaterial and more.
DMTF Redfish Forum (Working group that maintains the Redfish standard): http://www.dmtf.org/standards/spmfCompanies involved, upcoming schedules and future work, charter, and information about joining.
Using this guideEvery Redfish API response consists of a JSON payload containing properties that are strictly defined by a schema for thatresource. The schema defining a particular resource can be determined from the value of the "@odata.type" property returnedin every Redfish response. This guide details the definitions for every Redfish standard property defined in the DMTF-published Redfish schemas.
The property-level details include:
Column Purpose
PropertyName
The name of the JSON property as it will appear (case sensitive) in the JSON payload.
Defined inSchema(s)
The name(s) of the Redfish schema(s) where this property is defined, and therefore which resources it mayappear in. For properties that appear within embedded JSON objects, the object name will be shown inparenthesis.
Type The JSON data type(s) for the property. This can include boolean, number, string or object. String types thatuse defined enumerations will state "(enum)". Number types will state their units where used.
Description The description of the property, as copied directly from the schema 'Description' definition, or, for propertiesthat appear in multiple schemas, a general description of its usage in any of the listed schemas.
Redfish Property Guide
redfish.dmtf.org 3 DSP2053 v2019.1
Reference GuideThis guide was produced using the contents of the schema files from DMTF Redfish Schema bundle DSP8010 and mergedwith supplemental text using the DMTF's Redfish Documentation Generator.
Property Name Defined In Schema(s) Type Description
AccelerationFunctions Processor object A reference to the collection ofAcceleration Functions associatedwith this Processor.
AccountLockoutCounterResetAfter AccountService integer The interval of time in secondsbetween the last failed loginattempt and reset of the lockoutthreshold counter. This value mustbe less than or equal toAccountLockoutDuration. Resetsets the counter to zero.
AccountLockoutCounterResetEnabled AccountService boolean The value indicates whether thethreshold counter will be resetafterAccountLockoutCounterResetAfterexpires.
AccountLockoutDuration AccountService integer The time in seconds an account islocked out. The value must begreater than or equal to the valueof theAccountLockoutCounterResetAfterproperty. If set to 0, no lockoutoccurs.
AccountLockoutThreshold AccountService integer The number of failed loginattempts allowed before a useraccount is locked for a specifiedduration. A value of 0 means it isnever locked.
AdjustedMaxAllowableOperatingValue Thermal (Temperatures) integer Adjusted maximum allowableoperating temperature for thisequipment based on the currentenvironmental conditions present.
Sensor number Adjusted maximum allowableoperating value for this equipmentbased on the currentenvironmental conditions present.
AdjustedMinAllowableOperatingValue Thermal (Temperatures) integer Adjusted minimum allowableoperating temperature for thisequipment based on the currentenvironmental conditions present.
Sensor number Adjusted minimum allowableoperating value for this equipmentbased on the currentenvironmental conditions present.
AlarmTrips MemoryMetrics (HealthData) object Alarm trip information about thememory.
Redfish Property Guide
redfish.dmtf.org 5 DSP2053 v2019.1
Alias BootOption string(enum)
The alias of this Boot Source.
AliasBootOrder ComputerSystem (Boot) array Ordered array of boot sourcealiases representing the persistentBoot Order associated with thiscomputer system.
AllocationAlignmentMiB Memory integer The boundary which memoryregions are allocated on,measured in mebibytes (MiB).
AllocationIncrementMiB Memory integer The size of the smallest unit ofallocation for a memory region inmebibytes (MiB).
boolean Whether the FCoE InitializationProtocol (FIP) is used forpopulating the FCoE VLAN Id.
AllowOverprovisioning CompositionService boolean This indicates whether this serviceis allowed to overprovision acomposition relative to thecomposition request.
AllowZoneAffinity CompositionService boolean This indicates whether a client isallowed to request that givencomposition request is fulfilled bya specified Resource Zone.
AllowableValues ActionInfo (Parameters) array A list of values for this parametersupported by this Action target.
AllowedSpeedsMHz Memory array Speed bins supported by thisMemory.
AllowsBlockProvisioning MemoryDomain boolean Indicates if this Memory Domainsupports the provisioning of blocksof memory.
AllowsMemoryChunkCreation MemoryDomain boolean Indicates if this Memory Domainsupports the creation of MemoryChunks.
AllowsMirroring MemoryDomain boolean Indicates if this Memory Domainsupports the creation of MemoryChunks with mirroring enabled.
AllowsSparing MemoryDomain boolean Indicates if this Memory Domainsupports the creation of MemoryChunks with sparing enabled.
ApparentVA Sensor number The product of Voltage andCurrent for an AC circuit, in Volt-Amperes units.
AppendLimit MetricReportDefinition integer Indicates the maximum number ofentries that can be appended to ametric report. When the metricreport reaches its limit, its behavioris dictated by the ReportUpdatesproperty.
ApplyTime UpdateService(HttpPushUriOptions >
string(enum)
This property indicates when thesoftware update invoked via
Redfish Property Guide
redfish.dmtf.org 6 DSP2053 v2019.1
HttpPushUriApplyTime) HttpPushUri should be applied.
string The user assigned asset tag forthis device.
AssignablePhysicalPorts NetworkDeviceFunction array The array of physical portreferences that this network devicefunction may be assigned to.
AssignedPrivileges Role array The redfish privileges that this roleincludes.
AssociatedEndpoints Port (Links) array An array of references to theendpoints that connect throughthis port.
AssociatedNetworkAddresses NetworkPort array The array of configured networkaddresses (MAC or WWN) thatare associated with this NetworkPort, including the programmedaddress of the lowest numberedNetwork Device Function, theconfigured but not active addressif applicable, the address forhardware port teaming, or othernetwork addresses.
AttributeRegistry Bios string The Resource ID of the AttributeRegistry that has the system-specific information about a BIOSresource.
Attributes AttributeRegistry array The array containing the attributes
Redfish Property Guide
redfish.dmtf.org 7 DSP2053 v2019.1
(RegistryEntries) and their possible values.
Bios object The list of BIOS attributes specificto the manufacturer or provider.
AuthFailureLoggingThreshold AccountService integer The number of authorizationfailures allowed before the failureattempt is logged to the managerlog.
AuthNoneRole HostInterface (Links) object A reference to the Role thatcontains the privileges on this HostInterface when no authentication isperformed.
AuthNoneRoleId HostInterface string The Role used when noauthentication on this interface isused.
BinaryDataURI Assembly (Assemblies) string URI that provides the ability toaccess an image of the assemblyinformation.
Bios ComputerSystem object A reference to the BIOS settingsassociated with this system.
BiosVersion ComputerSystem string The version of the system BIOS orprimary system firmware.
BitRate SerialInterface string(enum)
The receive and transmit rate ofdata flow, typically in bits-per-second (bps), over the serialconnection.
BlockSizeBytes Drive, MemoryMetrics
integer The size of the smallestaddressible unit (Block) of thisdevice in bytes.
Volume number The size of the smallestaddressible unit (Block) of thisvolume in bytes.
BlocksRead MemoryMetrics (CurrentPeriod),
MemoryMetrics (LifeTime)
integer Number of blocks read.
BlocksWritten MemoryMetrics (CurrentPeriod),
MemoryMetrics (LifeTime)
integer Number of blocks written.
Boot ComputerSystem object Information about the boot settingsfor this system.
BootMode NetworkDeviceFunction string(enum)
The boot mode configured for thisnetwork device function.
BootNext ComputerSystem (Boot) string This property is theBootOptionReference of the BootOption to perform a one time bootfrom whenBootSourceOverrideTarget isUefiBootNext.
BootOptionEnabled BootOption boolean A flag that shows if the BootOption is enabled.
BootOptionReference BootOption string The unique boot option string thatis referenced in the BootOrder.
BootOptions ComputerSystem (Boot) object A reference to the collection of theUEFI Boot Options associated withthis Computer System.
Redfish Property Guide
redfish.dmtf.org 9 DSP2053 v2019.1
BootOrder ComputerSystem (Boot) array Ordered array ofBootOptionReference stringsrepresenting the persistent BootOrder associated with thiscomputer system.
The calculation which is performedon a source metric to obtain themetric being defined.
Redfish Property Guide
redfish.dmtf.org 10 DSP2053 v2019.1
CalculationParameters MetricDefinition array Specifies the metric propertieswhich are part of the synthesiscalculation. This property ispresent when the MetricTypeproperty has the value'Synthesized'.
CalculationTimeInterval MetricDefinition string The time interval over which themetric calculation is performed.
Calibration MetricDefinition number Specifies the calibration offsetadded to the metric reading.
integer The percentage of controllerresources used for performing adata consistency check onvolumes.
ConsumedPowerWatt ProcessorMetrics number The power consumed by theprocessor.
ConsumingComputerSystems ComputerSystem (Links) array An array of references toComputerSystems that arerealized, in whole or in part, fromthis ComputerSystem.
ContainedBy Chassis (Links) object A reference to the chassis that thischassis is contained by.
Contains Chassis (Links) array An array of references to any other
Redfish Property Guide
redfish.dmtf.org 13 DSP2053 v2019.1
chassis that this chassis has in it.
Context Event, Event (Events), EventDestination
string A client-supplied string that isstored with the event destinationsubscription.
ControllerCapabilities NetworkAdapter (Controllers) object The capabilities of this controller.
ControllerRates Storage (StorageControllers) object This object describes the variouscontroller rates used for things likeVolume Rebuild or ConsistencyChecks.
Controllers NetworkAdapter array The set of network controllersASICs that make up thisNetworkAdapter.
CooledBy Chassis (Links), ComputerSystem (Links)
array An array of ID[s] of resources thatcool this resource. Normally the IDwill be a chassis or a specific setof fans.
CoreCache ProcessorMetrics (CoreMetrics) array The cache metrics of this core inthe processor.
CoreId ProcessorMetrics (CoreMetrics) string The processor core identifier.
CoreMetrics ProcessorMetrics array The processor core metrics.
DeliveryRetryAttempts EventService integer This is the number of attempts anevent posting is retried before the
Redfish Property Guide
redfish.dmtf.org 15 DSP2053 v2019.1
subscription is terminated. Thisretry is at the service level,meaning the HTTP POST to theEvent Destination was returned bythe HTTP operation asunsuccessful (4xx or 5xx returncode) or an HTTP timeoutoccurred this many times beforethe Event Destination subscriptionis terminated.
DeliveryRetryIntervalSeconds EventService integer This represents the number ofseconds between retry attemptsfor sending any given Event.
string The time interval over which thesensor reading must have passedthrough this Threshold valuebefore the threshold is consideredto be violated.
EEEEnabled NetworkPort boolean Whether IEEE 802.3az EnergyEfficient Ethernet (EEE) is enabledfor this network port.
EffectiveFamily Processor (ProcessorId) string The effective Family for thisprocessor.
EffectiveModel Processor (ProcessorId) string The effective Model for this
Redfish Property Guide
redfish.dmtf.org 17 DSP2053 v2019.1
processor.
EfficiencyPercent Power (PowerSupplies) number The measured efficiency of thisPower Supply as a percentage.
EjectMedia (Action) VirtualMedia (Actions) object This action is used to detachremote media from virtual media.
ElectricalContext Sensor string(enum)
The combination of current-carrying conductors.
Email Certificate (Issuer), Certificate (Subject)
string The email address of the contactwithin the organization of theentity.
Enabled ManagerAccount boolean This property is used by a UserAdministrator to disable anaccount w/o having to delet theuser information. When set to true,the user can login. When set tofalse, the account isadministratively disabled and theuser cannot login.
Enclosures Storage (Links) array An array of references to thechassis to which this storagesubsystem is attached.
Encrypted Volume boolean Is this Volume encrypted.
EncryptionAbility Drive string(enum)
The encryption abilities of thisdrive.
EncryptionStatus Drive string(enum)
The status of the encrytion of thisdrive.
EncryptionTypes Volume array The types of encryption used bythis Volume.
EndTime Job, Task
string The date-time stamp that the jobor task was completed.
boolean This indicates if the EventTypeproperty is supported.
LogEntry string(enum)
This indicates the type of an eventrecorded in this log.
Event (Events) string(enum)
This indicates the type of eventsent, according to the definitions inthe EventService.
EventTypes EventDestination array This property contains the types ofevents that will be sent to thedestination.
EventTypesForSubscription EventService array This is the types of Events thatcan be subscribed to.
Events Event array Each event in this array has a setof properties that describe theevent. Since this is an array, morethan one event can be sentsimultaneously.
string The 2nd firmware version of thisTrusted Module, if applicable.
FlowControl SerialInterface string The type of flow control, if any,
Redfish Property Guide
redfish.dmtf.org 21 DSP2053 v2019.1
(enum) that will be imposed on the serialconnection.
FlowControlConfiguration NetworkPort string(enum)
The locally configured 802.3x flowcontrol setting for this networkport.
FlowControlStatus NetworkPort string(enum)
The 802.3x flow control behaviornegotiated with the link partner forthis network port (Ethernet-only).
ForceFailover (Action) Manager (Actions) object The ForceFailover action forces afailover of this manager to themanager used in the parameter.
FpgaReconfigurationSlots AccelerationFunction array An array of the reconfiguration slotidentifiers for an FPGA.
FpgaType Processor (FPGA) string(enum)
The FPGA type.
FrequencyRatio ProcessorMetrics number The frequency relative to thenominal processor frequency ratio.
FullDuplex EthernetInterface boolean This indicates if the interface is inFull Duplex mode or not.
FunctionClasses Memory array Function Classes by the Memory.
FunctionEnabled ComputerSystem(HostWatchdogTimer)
boolean This indicates if the HostWatchdog Timer functionality hasbeen enabled. Additional host-based software is necessary toactivate the timer function.
FunctionId PCIeFunction integer The the PCIe Function identifier.
boolean The hidden state of this attribute ormenu.
HidePayload Job, Task
boolean Indicates that the contents of thePayload should be hidden fromview after the Job or Task hasbeen created. When set to True,the Payload object will not bereturned on GET.
HostEthernetInterfaces HostInterface object The Redfish link to the collectionof network interface controllers orcards (NICs) that a ComputerSystem uses to communicate withthis Host Interface.
HostInterface Processor (FPGA) object The FPGA interface to the host.
EthernetInterface (Links) object This is a reference to a HostInterface that is associated withthis Ethernet Interface.
HostInterfaceType HostInterface string(enum)
Indicates the Host Interface typefor this interface.
HostInterfaces Manager object This is a reference to a collectionof Host Interfaces that thismanager uses for local hostcommunication. It is here thatclients will find Host Interfaceconfiguration options and settings.
array This represents the HTTP headersused in the operation of this Taskor Job, or that will be supplied toan EventDestination when anEvent is sent. For usage in
Redfish Property Guide
redfish.dmtf.org 24 DSP2053 v2019.1
EventDestination, this object willbe null on a GET.
HttpOperation Task (Payload) string The HTTP operation to perform toexecute this Task.
Job (Payload) string The HTTP operation to perform toexecute this job.
HttpPushUri UpdateService string The URI used to perform an HTTPor HTTPS push update to theUpdate Service.
object This property contains settings forwhen firmware is to be appliedwhen provided via HttpPushUri.
HttpPushUriOptions UpdateService object This property contains options forsoftware update via HttpPushUri.
HttpPushUriOptionsBusy UpdateService boolean This represents if the properties ofHttpPushUriOptions are reservedby any client.
HttpPushUriTargets UpdateService array The array of URIs indicating thetarget for applying the updateimage.
HttpPushUriTargetsBusy UpdateService boolean This represents if theHttpPushUriTargets property isreserved by any client.
IOStallCount ProcessorMetrics (CoreMetrics) number The number of stalled cycles dueto I/O operations.
IPAddressType NetworkDeviceFunction(iSCSIBoot)
string(enum)
The type of IP address (IPv6 orIPv4) being populated in theiSCSIBoot IP address fields.
IPMI ManagerNetworkProtocol object Settings for this Manager's IPMI-over-LAN protocol support.
IPMaskDNSViaDHCP NetworkDeviceFunction(iSCSIBoot)
boolean Whether the iSCSI boot initiatoruses DHCP to obtain the iniatorname, IP address, and netmask.
IPTransportDetails Endpoint array This array contains details foreach IP transport supported bythis endpoint. The array structurecan be used to model multiple IPaddresses for this endpoint.
IPv4Address Endpoint (IPTransportDetails) object The IPv4 addresses assigned tothe Endpoint.
string The name of the local role in whichto map the remote user or group.
Location JsonSchemaFile, MessageRegistryFile
array Location information for thisregistry or schema file.
Drive array The Location of the drive.
various(Chassis, Drive (Location) ... )
object The physical location of this deviceor resource.
Locked ManagerAccount boolean This property indicates that theaccount has been auto-locked bythe account service because thelockout threshold has beenexceeded. When set to true, theaccount is locked. A user admincan write the property to false tomanually unlock, or the accountservice will unlock it once thelockout duration period haspassed.
Log JobService object This is a reference to a LogService used by the Job Service.
LogEntryType LogService string(enum)
The format of the Entries of thislog.
LogService TelemetryService object This is a reference to a LogService used by the TelemetryService.
LogServices ComputerSystem, Switch
object A reference to the collection of LogServices associated with this
Redfish Property Guide
redfish.dmtf.org 31 DSP2053 v2019.1
system.
Chassis object A reference to the logs for thischassis.
Manager object This is a reference to a collectionof Logs used by the manager.
array An array of references to theManagers responsible formanaging this resource.
ManagerEthernetInterface HostInterface object The Redfish link to a singlenetwork interface controllers orcards (NIC) that this Manageruses for network communicationwith this Host Interface.
ManagerForChassis Manager (Links) array This property is an array ofreferences to the chassis that thismanager has control over.
ManagerForServers Manager (Links) array This property is an array ofreferences to the systems that thismanager has control over.
ManagerForSwitches Manager (Links) array This property is an array ofreferences to the switches that thismanager has control over.
ManagerInChassis Manager (Links) object This property is a reference to thechassis that this manager islocated in.
ManagerType Manager string(enum)
This property represents the typeof manager that this resourcerepresents.
Managers ServiceRoot object This is a link to a collection ofManagers.
ManagersInChassis Chassis (Links) array An array of references to themanagers located in this Chassis.
string A path that describes the menuhierarchy of this attribute.
AttributeRegistry(RegistryEntries > Menus)
string A path that describes this menuhierarchy relative to other menus.
Redfish Property Guide
redfish.dmtf.org 37 DSP2053 v2019.1
Menus AttributeRegistry(RegistryEntries)
array The array containing the attributesmenus and their hierarchy.
Message Job (Messages), Task (Messages)
object This type describes a Messagereturned by the Redfish service.
Event (Events) string This is the human readablemessage, if provided.
LogEntry string This property decodes fromEntryType. If the EntryType isEvent, then it is a message string.Otherwise, it is SEL or OEMspecific. In most cases, this will bethe actual Log Entry.
MessageArgs LogEntry array The values of this property shallbe any arguments for themessage.
Event (Events) array This array of message argumentsare substituted for the argumentsin the message when looked up inthe message registry.
boolean This indicates if the MessageIdproperty is supported.
Event (Events) string This is the key for this messagewhich can be used to look up themessage in a message registry.
LogEntry string This property decodes fromEntryType. If the EntryType isEvent, then it is a message id. Ifthe EntryType is SEL, then itcontains the Event Data.Otherwise, it is OEM specific. Thisvalue is only used for registries -for more information, see thespecification.
MessageIds EventDestination array A list of MessageIds that theservice will only send. If thisproperty is absent or the array isempty, then Events with anyMessageId will be sent to thesubscriber.
Messages Job array This is an array of messagesassociated with the job.
Task array This is an array of messagesassociated with the task.
MessageRegistry object The pattern property indicates thata free-form string is the uniqueidentifier for the message withinthe registry.
MetricDataType MetricDefinition string(enum)
The data type of the metric.
MetricDefinition MetricReport (MetricValues) object A link to the Metric Definition.
Redfish Property Guide
redfish.dmtf.org 38 DSP2053 v2019.1
MetricDefinitions TelemetryService object A link to the collection of MetricDefinitions.
MetricId MetricReportDefinition (Metrics) string Specifies the label for the metricdefinition which is derived byapplying the CollectionFunction tothe metric property.
MetricReport (MetricValues) string The metric definitions identifier forthis metric.
MetricProperties MetricReportDefinition (Metrics) array A collection of URI for theproperties on which this metric iscollected.
MetricDefinition array A list of URIs with wildcards andproperty identifiers for which thismetric definition is defined. If aURI has wildcards, the wildcardsare substituted as specified in theWildcards array property.
Triggers array A list of URIs with wildcards andproperty identifiers for which thistrigger is defined. If a URI haswildcards, the wildcards aresubstituted as specified in theWildcards array property.
MetricReportDefinition array A list of URIs with wildcards andproperty identifiers to include inthe metric report. If a URI haswildcards, the wildcards aresubstituted as specified in theWildcards array property.
MetricProperty MetricReport (MetricValues) string The URI for the property fromwhich this metric is derived.
MetricReport MetricReportDefinition object Specifies the location where theresultant metric report is placed.
MetricReportDefinitions Triggers (Links) array The metric report definitions thatwill generate new metric reportswhen a trigger occurs when theTriggerActions property containsthe value RedfishMetricReport.
TelemetryService object A link to the collection of MetricReport Definitions.
MetricReportHeartbeatInterval MetricReportDefinition string This property specifices an interval
Redfish Property Guide
redfish.dmtf.org 39 DSP2053 v2019.1
to send complete MetricReportregardless of whether values havechanged. It is used in addition tothe ReccurranceInterval whereSuppressRepeatedMetricValue isEnabled and the Redfish clientdesired to be refreshed with metricdata occasionally regardless ofwhether the data is changed ornot.
MetricReports TelemetryService object A link to the collection of MetricReports.
MetricType MetricDefinition string(enum)
The type of metric.
Triggers string(enum)
The type of trigger.
MetricValue MetricReport (MetricValues) string The value identifies this resource.
MetricValues MetricReport array An array of metric values for themetered items of this Metric.
Metrics MetricReportDefinition array Specifies a list of metrics toinclude in the metric report. Themetrics may include metricproperties or calculations appliedto a metric property.
ComputerSystem(ProcessorSummary)
object A reference to the Metricsassociated with all Processors inthis system.
Memory object A reference to the Metricsassociated with this Memory.
Processor object A reference to the Metricsassociated with this Processor.
MicrocodeInfo Processor (ProcessorId) string The Microcode Information for thisprocessor.
MinAllowableOperatingValue Thermal (Temperatures) integer Minimum allowable operatingtemperature for this equipment.
Sensor number Minimum allowable operatingvalue for this equipment.
string The CHAP Username for 2-wayCHAP authentication.
MutuallyExclusiveEndpoints Endpoint (Links) array An array of references to theendpoints that may not be used inzones if this endpoint is used in azone.
object N_Port ID Virtualization (NPIV)capabilties for this controller.
Redfish Property Guide
redfish.dmtf.org 41 DSP2053 v2019.1
NTP ManagerNetworkProtocol object Settings for this Manager's NTPprotocol support.
NTPServers ManagerNetworkProtocol (NTP) array Indicates to which NTP serversthis manager is subscribed.
Name various(AccelerationFunction, AccelerationFunctionCollection... )
string Name of the resource as assignedby the Redfish Service.
NameServers EthernetInterface array This represents DNS nameservers that are currently in use onthis interface.
NegotiatedSpeedGbs Drive number The speed which this drive iscurrently communicating to thestorage controller in Gigabits persecond.
NetDevFuncCapabilities NetworkDeviceFunction array Capabilities of this network devicefunction.
NetDevFuncMaxBWAlloc NetworkPort array The array of maximum bandwidthallocation percentages for theNetwork Device Functionsassociated with this port.
NetDevFuncMinBWAlloc NetworkPort array The array of minimum bandwidthallocation percentages for theNetwork Device Functionsassociated with this port.
NetDevFuncType NetworkDeviceFunction string(enum)
The configured capability of thisnetwork device function.
NetworkAdapter NetworkInterface (Links) object A reference to the NetworkAdapterwhich contains thisNetworkInterface.
NetworkAdapters Chassis object A reference to the collection ofNetwork Adapters associated withthis chassis.
NetworkDeviceFunction Endpoint (Links) array When NetworkDeviceFunctionresources are present, this arraycontains references to the networkdevice function that connect to thisendpoint.
integer The maximum number of VirtualFunctions (VFs) supported pernetwork port for this controller.
NetworkPorts NetworkAdapter (Controllers >Links)
array An array of references to theNetworkPorts associated with thisNetwork Controller.
NetworkAdapter object A reference to the collection ofNetworkPorts associated with thisNetworkAdapter.
NetworkInterface object A reference to the collection ofNetworkPorts associated with thisNetworkInterface.
NetworkProtocol HostInterface object The Redfish link to the networkservices and their settings that theManager controls. It is here thatclients will find networkconfiguration options as well asnetwork services.
Manager object This is a reference to the networkservices and their settings that themanager controls. It is here thatclients will find networkconfiguration options as well asnetwork services.
boolean This indicates if theOriginResource property issupported.
OriginResources EventDestination array A list of resources for which theservice will only send relatedevents. If this property is absent orthe array is empty, then Eventsoriginating from any resource willbe sent to the subscriber.
OutputWattage Power (PowerSupplies > number The maximum capacity of this
Redfish Property Guide
redfish.dmtf.org 45 DSP2053 v2019.1
InputRanges) Power Supply when operating inthis input range.
OverWritePolicy LogService string(enum)
The overwrite policy for thisservice that takes place when thelog is full.
OverwriteUnit (Action) Memory (Actions) object This defines the action for securelyerasing given regions using theNIST SP800-88 Purge: Overwrite.
OwningEntity AttributeRegistry, MessageRegistry
string This is the organization orcompany that publishes thisregistry.
string This property is used with aPATCH or PUT to write thepassword for the account service.This property is null on a GET.
ManagerAccount string This property is used with aPATCH or PUT to write thepassword for the account. Thisproperty is null on a GET.
PasswordChangeRequired ManagerAccount boolean Indicates that the password for thisaccount must be changed. Theservice requires the password tobe changed before access isallowed.
Payload Job object The HTTP and JSON payloaddetails for this job.
Task object The HTTP and JSON payloaddetails for this task.
PciClassCode Endpoint (ConnectedEntities) string The Class Code, Subclass code,and Programming Interface codeof this PCIe function.
PciFunctionNumber Endpoint (ConnectedEntities) integer The PCI ID of the connectedentity.
object The physical port that this networkdevice function is currentlyassigned to.
PhysicalPortNumber NetworkPort string The physical port number label forthis port.
PhysicalSecurity Chassis object The state of the physical securitysensor.
PhysicalSubContext Sensor string(enum)
Describes the usage or locationwithin a device to which thissensor measurement applies.
PinOut SerialInterface string(enum)
The physical pin configurationneeded for a serial connector.
PolicyEnabled Memory(PowerManagementPolicy)
boolean Power management policyenabled status.
Port various(ManagerNetworkProtocol(DHCP), ManagerNetworkProtocol(DHCPv6) ... )
integer Indicates the protocol port.
Endpoint (IPTransportDetails) number The UDP or TCP port numberused by the Endpoint.
PortId Port string This is the label of this port on thephysical package for this port.
PortMaximumMTU NetworkPort integer The largest maximumtransmission unit (MTU) that canbe configured for this network port.
PortProtocol Port string(enum)
The protocol being sent over thisport.
PortType Port string(enum)
This is the type of this port.
Ports Endpoint (Links) array An array of references to the thephysical ports associated with thisendpoint.
Switch object A collection of references to theports for this switch.
Storage (StorageControllers) object This object describes the Portsthat exist on the storage controller.
Power Chassis object A reference to the powerproperties (power supplies, powerpolicies, sensors) of this chassis.
Redfish Property Guide
redfish.dmtf.org 50 DSP2053 v2019.1
PowerAllocatedWatts Power (PowerControl) number The total amount of power that hasbeen allocated (or budegeted)tochassis resources.
PowerAvailableWatts Power (PowerControl) number The amount of power not alreadybudgeted and therefore availablefor additional allocation.(powerCapacity - powerAllocated).This indicates how much reservepower capacity is left.
PowerCapacityWatts Power (PowerSupplies) number The maximum capacity of thisPower Supply.
Power (PowerControl) number The total amount of poweravailable to the chassis forallocation. This may the powersupply capacity, or power budgetassigned to the chassis from anup-stream chassis.
PowerConsumedWatts Power (PowerControl) number The actual power being consumedby the chassis.
PowerControl Power array This is the definition for powercontrol function (powerreading/limiting).
PowerFactor Sensor number The power factor for this Sensor.
PowerInputWatts Power (PowerSupplies) number The measured input power of thisPower Supply.
PowerLimit Power (PowerControl) object Power limit status andconfiguration information for thischassis.
PowerManagementPolicy Memory object Power management policyinformation.
PowerMetrics Power (PowerControl) object Power readings for this chassis.
PowerOutputWatts Power (PowerSupplies) number The measured output power of thisPower Supply.
PowerRequestedWatts Power (PowerControl) number The potential power that thechassis resources are requestingwhich may be higher than thecurrent level being consumedsince requested power includesbudget that the chassis resourcewants for future use.
PowerRestorePolicy ComputerSystem string(enum)
The desired power state of thesystem when power is restoredafter a power loss.
PowerState Chassis string(enum)
The current power state of thechassis.
Manager string(enum)
This is the current power state ofthe Manager.
Switch string(enum)
This is the current power state ofthe switch.
Redfish Property Guide
redfish.dmtf.org 51 DSP2053 v2019.1
ComputerSystem string(enum)
This is the current power state ofthe system.
PowerSupplies Power array Details of the power suppliesassociated with this system ordevice.
PowerSupplyType Power (PowerSupplies) string(enum)
The Power Supply type (AC orDC).
PowerWatts AccelerationFunction integer The acceleration function powerconsumption.
PoweredBy Chassis (Links) array An array of ID[s] of resources thatpower this chassis. Normally theID will be a chassis or a specificset of Power Supplies.
ComputerSystem (Links) array An array of ID[s] of resources thatpower this computer system.Normally the ID will be a chassisor a specific set of PowerSupplies.
PrivilegeMap AccountService object A reference to the Privilegemapping that defines the privilegesneeded to perform a requestedoperation on a URI associatedwith this service.
PrivilegesUsed PrivilegeRegistry array Lists the set of Redfish standardpriviliges used in building thismapping.
ProcessorArchitecture Processor string(enum)
The architecture of the processor.
ProcessorId Processor object Identification information for thisprocessor.
ProcessorMemory Processor array The memory directly attached orintegrated witin this Procesor.
ProcessorSummary ComputerSystem object This object describes the centralprocessors of the system ingeneral detail.
ProcessorType Processor string(enum)
The type of processor.
Processors ResourceBlock array An array of references to theProcessors available in thisResource Block.
Chassis (Links) array An array of references to theProcessors located in thisChassis.
ComputerSystem object A reference to the collection ofProcessors associated with thissystem.
Producer Assembly (Assemblies) string Producer or manufacturer of theAssembly.
Product ServiceRoot string The product associated with thisRedfish service.
ProductName AttributeRegistry(SupportedSystems)
string The product name of the system.
ProductionDate Assembly (Assemblies) string Production date of the Assembly.
ProgrammableFromHost Processor (FPGA) boolean This flag indicates if the FPGAfirmware can be reprogrammedfrom the host using systemsoftware.
Processor (FPGA >ReconfigurationSlots)
boolean This flag indicates if thereconfiguration slot can bereprogrammed from the host usingsystem software.
PropertyOverrides PrivilegeRegistry (Mappings) array Indicates privilege overrides ofproperty or element within a entity.
Redfish Property Guide
redfish.dmtf.org 53 DSP2053 v2019.1
Protocol Drive string(enum)
The protocol this drive is using tocommunicate to the storagecontroller.
integer The percentage of controllerresources used forrebuilding/repairing volumes.
ReconfigurationSlots Processor (FPGA) array An array of the FPGAreconfiguration slots. Areconfiguration slot is used by anFPGA to contain an accelerationfunction that can change as theFPGA is being provisioned.
RedfishVersion ServiceRoot string The version of the Redfish service.
Redundancy ComputerSystem array A reference to a collection ofRedundancy entities that eachname a set of computer systemsthat provide redundancy for thisComputerSystem.
Endpoint array Redundancy information for thelower level endpoints supportingthis endpoint.
Manager array Redundancy information for themanagers of this system.
Power array Redundancy information for thepower subsystem of this system ordevice.
Storage array Redundancy information for thestorage subsystem.
Switch array Redundancy information for theswitches.
Thermal (Fans), Thermal
array This structure is used to showredundancy for fans. TheComponent ids will reference themembers of the redundancygroups.
Redfish Property Guide
redfish.dmtf.org 55 DSP2053 v2019.1
Power (PowerSupplies) array This structure is used to showredundancy for power supplies.The Component ids will referencethe members of the redundancygroups.
RegionId MemoryChunks (InterleaveSets) string DIMM region identifier.
Memory (Regions) string Unique region ID representing aspecific region within the Memory.
Regions Memory array Memory regions information withinthe Memory.
Registries ServiceRoot object This is a link to a collection ofRegistries.
Registry MessageRegistryFile string The Registry Name, Major, andMinor version. This Registry canreference any type of Registry,such as a Message Registry,Privilege Registry, or AttributeRegistry.
RegistryEntries AttributeRegistry object List of all attributes and theirmetadata for this component.
boolean This indicates if the RegistryPrefixproperty is supported.
MessageRegistry string This is the single word prefix usedto form a messageID structure.
RegistryPrefixes EventDestination array A list of the Prefixes for theMessage Registries that containthe MessageIds that will be sent tothis event destination.
EventService array A list of the Prefixes of theMessage Registries that can beused for the RegistryPrefixproperty on a subscription. If thisproperty is absent or contains anempty array, the service does notsupport RegistryPrefix-basedsubscriptions.
RegistryVersion AttributeRegistry string This is the attribute registryversion which is used in the middleportion of a AttributeRegistry.
MessageRegistry string This is the message registryversion which is used in the middleportion of a messageID.
Rekey (Action) Certificate (Actions) object This action is used to generate anew key pair for an existingcertificate and produce acertificate signing request.
RelatedItem BootOption, Power (PowerControl), Power (PowerSupplies), Power (Voltages),
array Describes the areas or devicesrelated to this resource.
ReleaseDate SoftwareInventory string Release date of this software.
RemainingSpareBlockPercentage MemoryMetrics (HealthData) number Remaining spare blocks inpercentage.
RemoteAccountService Manager object This property contains a referenceto the AccountService resource forthe remote Manager representedby this resource.
string This property is the name of theremote group (or in the case of aRedfish Service, remote role) thatwill be mapped to the local rolereferenced by this entity.
RemoteMemoryBandwidthBytes ProcessorMetrics integer The remote memory bandwidthusage in bytes.
RemoteRedfishServiceUri Manager string This property contains the URI ofthe Redfish Service Root for theremote Manager represented bythis resource.
string This property is the name of theremote user that will be mapped tothe local role referenced by thisentity.
RemoveResourceBlock (Action) ComputerSystem (Actions) object This action is used to remove aResource Block from a system.
Renew (Action) Certificate (Actions) object This action is used to generate acertificate signing request usingthe existing information and keypair of the certificate.
ReplaceCertificate (Action) CertificateService (Actions) object This action is used to replace anexisting certificate.
ReportActions MetricReportDefinition array Specifies the actions to performwhen a metric report is generated.
Actions to perform when a metricreport is generated.
ReportSequence MetricReport string The current sequence identifier forthis metric report.
ReportUpdates MetricReportDefinition string(enum)
When logging metric reports,specifies how subsequent metricreports are handled in relationship
Redfish Property Guide
redfish.dmtf.org 57 DSP2053 v2019.1
to an existing metric report createdfrom the metric report definition.Namely, whether to overwrite,append, or create new reportresource.
Required ActionInfo (Parameters) boolean Indicates whether the parameter isrequired to perform this Action.
Reserved ResourceBlock(CompositionStatus)
boolean This represents if the ResourceBlock is reserved by any client.
Reset (Action) Manager (Actions) object The reset action resets/reboots themanager.
Chassis (Actions) object This action is used to reset thechassis. This action resets thechassis, not Systems or othercontained resources, althoughside effects may occur whichaffect those resources.
ComputerSystem (Actions) object This action is used to reset thesystem.
Port (Actions) object This action is used to reset thisport.
Switch (Actions) object This action is used to reset thisswitch.
ResetBios (Action) Bios (Actions) object This action is used to reset theBIOS attributes to default.
ResetKeys (Action) SecureBoot (Actions) object This action is used to reset theSecure Boot keys.
number The percentage of time that theprocessor or core has spent in thisparticular level of C-state.
ResourceBlockType ResourceBlock array This property represents the typesof resources available on thisResource Block.
ResourceBlocks Chassis (Links) array An array of references to theResource Blocks located in thisChassis.
ComputerSystem (Links) array An array of references to theResource Blocks that are used inthis Computer System.
Zone (Links) array An array of references to theResource Blocks that are used in
Redfish Property Guide
redfish.dmtf.org 58 DSP2053 v2019.1
this Zone.
ServiceRoot object A link to a collection of all resourceblock entities. This collection isintended for implementations thatdo not contain a CompositionService, but will expose resourcesto an orchestrator that implementsa Composition Service.
CompositionService object The resource blocks available onthe service.
boolean This indicates if the ResourceTypeproperty is supported.
ResourceTypes EventService array A list of @odata.type values(Schema names) that can bespecified in a ResourceType on asubscription. If this property isabsent or contains an empty array,the service does not supportResourceType-basedsubscriptions.
EventDestination array A list of Resource Type values(Schema names) that correspondto the OriginOfCondition. Theversion and full namespace shouldnot be specified.
string The metric property used to storethe results of the calculation.
Revision Drive string The revision of this Drive. This istypically the firmware/hardwareversion of the drive.
RevisionId PCIeFunction string The Revision ID of this PCIefunction.
Role ManagerAccount (Links) object A reference to the Role objectdefining Privileges for thisaccount--returned when theresource is read. The ID of the roleis the same as property RoleId.
RoleId ManagerAccount string This property contains the Role forthis account.
Role string This property contains the name ofthe Role.
Roles AccountService object A link to a collection of Roles.
RotationSpeedRPM Drive number The rotation speed of this Drive inRevolutions per Minute (RPM).
boolean Whether this controller supportsSingle Root Input/OutputVirtualization (SR-IOV) in VirtualEthernet Port Aggregator (VEPA)mode.
SSDP ManagerNetworkProtocol object Settings for this Manager's SSDPsupport.
SSEFilterPropertiesSupported EventService object Contains a set of properties thatindicate which properties aresupported in the $filter queryparameter for theServerSentEventUri.
SSH ManagerNetworkProtocol object Settings for this Manager's SSH(Secure Shell) protocol support.
boolean This indicates if the secondaryVLAN is enabled.
SecondaryVLANId NetworkDeviceFunction(iSCSIBoot)
integer The 802.1q VLAN ID to use foriSCSI boot from the secondarytarget.
SecureBoot ComputerSystem object A reference to the UEFISecureBoot resource associatedwith this system.
SecureBootCurrentBoot SecureBoot string(enum)
Secure Boot state during thecurrent boot cycle.
SecureBootEnable SecureBoot boolean Enable or disable UEFI SecureBoot (takes effect on next boot).
SecureBootMode SecureBoot string(enum)
Current Secure Boot Mode.
SecureErase (Action) Drive (Actions) object This action is used to securelyerase the contents of the drive.
SecureEraseUnit (Action) Memory (Actions) object This defines the action for securelyerasing given regions using theNIST SP800-88 Purge:Cryptograhic Erase.
SecurityCapabilities Memory object This object contains securitycapabilities of the Memory.
SecurityState Memory string(enum)
The current security state of thisMemory.
SecurityStates Memory (SecurityCapabilities) array Security states supported by theMemory.
boolean This indicates whether the $selectquery parameter is supported.
SensingFrequency Sensor number The time interval betweenreadings of the physical sensor.
SensingInterval MetricDefinition string The time interval between when ametric is updated.
SensorNumber Thermal (Fans) integer A numerical identifier to representthe fan speed sensor.
Thermal (Temperatures) integer A numerical identifier to representthe temperature sensor.
Power (Voltages) integer A numerical identifier to representthe voltage sensor.
LogEntry integer This property decodes fromEntryType. If the EntryType is
Redfish Property Guide
redfish.dmtf.org 61 DSP2053 v2019.1
SEL, it is the sensor number. If theEntryType is Event, then the countof events. Otherwise, it is OEMspecific.
SensorResetTime Sensor string The time at which the time-basedproperties were last reset.
SensorType LogEntry string(enum)
If the EntryType is SEL, this willhave the sensor type that the logentry pertains to.
Sensors Chassis object The naivgation pointer to thecollection of sensors located in theequipment and sub-components.
SerialConsole Manager object Information about the SerialConsole service provided by thismanager.
SerialInterfaces Manager object This is a reference to a collectionof serial interfaces that thismanager uses for serial andconsole communication. It is herethat clients will find serialconfiguration options and settings.
boolean Indicates if the service is enabledfor this manager.
AccountService boolean Indicates whether this service isenabled. If set to false, theAccountService is disabled. Thismeans no users can be created,deleted or modified. Any serviceattempting to access theAccountService resource (forexample, the Session Service) willfail. New sessions cannot bestarted when the service isdisabled. However, establishedsessions may still continueoperating. This does not affectBasic AUTH connections.
boolean This indicates whether this serviceis enabled.
SessionService boolean This indicates whether this serviceis enabled. If set to false, theSession Service is disabled, andnew sessions cannot be created,old sessions cannot be deleted,and established sessions maycontinue operating.
ServiceEntryPointUUID Manager string The UUID of the Redfish Serviceprovided by this manager.
SessionService ServiceRoot object This is a link to the SessionsService.
SessionTimeout SessionService integer This is the number of seconds ofinactivity that a session may havebefore the session service closesthe session due to inactivity.
Sessions ServiceRoot (Links), SessionService
object Link to a collection of Sessions.
SetDefaultBootOrder (Action) ComputerSystem (Actions) object This action is used to set the BootOrder to the default settings.
SetEncryptionKey (Action) Storage (Actions) object This action is used to set theencryption key for the storagesubsystem.
SetPassphrase (Action) Memory (Actions) object Set passphrase for the givenregions.
Severity Event (Events) string This is the severity of the event.
LogEntry string(enum)
This is the severity of the log entry.
Triggers (DiscreteTriggers) string(enum)
This property contains the value ofthe Severity property in the Eventmessage.
SharingCapable ResourceBlock(CompositionStatus)
boolean Indicates if this Resource Block iscapable of participating in multiplecompositions simultaneously.
SharingEnabled ResourceBlock(CompositionStatus)
boolean Indicates if this Resource Block isallowed to participate in multiplecompositions simultaneously.
SignalDetected NetworkPort boolean Whether or not the port hasdetected enough signal on enoughlanes to establish link.
SignalType SerialInterface string The type of signal used for the
Redfish Property Guide
redfish.dmtf.org 63 DSP2053 v2019.1
(enum) communication connection -RS232 or RS485.
SimpleStorage ResourceBlock array An array of references to theSimple Storage available in thisResource Block.
ComputerSystem object A reference to the collection ofstorage devices associated withthis system.
SimpleUpdate (Action) UpdateService (Actions) object This action is used to updatesoftware components.
SizeMiB Memory (Regions) integer Size of this memory region inmebibytes (MiB).
MemoryChunks (InterleaveSets) integer Size of this memory regionmeasured in mebibytes (MiB).
Slot Memory (MemoryLocation) integer Slot number in which Memory isconnected.
SlotId Processor (FPGA >ReconfigurationSlots)
string The FPGA reconfiguration slotidentifier.
SlotType PCIeSlots (Slots) string(enum)
This is the PCIe slot type for thisslot.
Slots PCIeSlots array An array of PCI Slot information.
Socket Memory (MemoryLocation) integer Socket number in which Memoryis connected.
Processor string The socket or location of theprocessor.
SoftwareId SoftwareInventory string A string representing theimplementation-specific ID foridentifying this software.
SoftwareInventory UpdateService object An inventory of software.
array An array of references to theStorageServices that connect tothis controller.
Redfish Property Guide
redfish.dmtf.org 65 DSP2053 v2019.1
ServiceRoot object A link to a collection of all storageservice entities.
ComputerSystem(HostedServices)
object A reference to a collection ofstorage services supported by thiscomputer system.
StorageSystems ServiceRoot object This is a link to a collection ofstorage systems.
SubModel ComputerSystem string The sub-model for this system.
SubProcessors Processor object A reference to the collection ofSub-Processors associated withthis system, such as cores orthreads that are part of aprocessor.
Subject Certificate object The subject of the certificate.
SubmitTestEvent (Action) EventService (Actions) object This action is used to generate atest event.
SubmitTestMetricReport (Action) TelemetryService (Actions) object This action is used to generate ametric report.
SubordinateResources EventDestination boolean By setting this to true andspecifying OriginResources, thisindicates the subscription will befor events from theOriginsResources specified andalso all subordinate resources.Note that resources associated viathe Links section are notconsidered subordinate.
SubordinateResourcesSupported EventService boolean This indicates if the servicesupports the SubordinateResourceproperty on Event Subscriptions.
SubscriptionType EventDestination string(enum)
Indicates the subscription type forevents.
Subscriptions EventService object This is a reference to a collectionof Event Destination resources.
string The Subsystem Vendor ID of thisPCIe function.
SupplyingComputerSystems ComputerSystem (Links) array An array of references toComputerSystems that contribute,
Redfish Property Guide
redfish.dmtf.org 66 DSP2053 v2019.1
in whole or in part, to theimplementation of thisComputerSystem.
SupportedCollectionFunctions TelemetryService array The functions that can beperformed over each metric.
SupportedControllerProtocols Storage (StorageControllers) array This represents the protocols bywhich this storage controller canbe communicated to.
SupportedDeviceProtocols Storage (StorageControllers) array This represents the protocolswhich the storage controller canuse to communicate with attacheddevices.
SupportedEthernetCapabilities NetworkPort array The set of Ethernet capabilitiesthat this port supports.
SupportedLinkCapabilities NetworkPort array The self-described link capabilitiesof this port.
SupportedRAIDTypes Storage (StorageControllers) array This object describes the RAIDTypes supported by the storagecontroller.
SupportedSystems AttributeRegistry array Array of systems supported by thisattribute registry.
SuppressRepeatedMetricValue MetricReportDefinition boolean A value of true indicates that anyMetric in the MetricReportcurrently be generated will besuppressed and not included inthe MetricReport when the valueof the Metric equals the value ofthe same Metric in the previouslygenerated MetricReport. A valueof false means that thesuppression mechanism is notapplied to the MetricReport beinggenerated. A MetricReport may begenerated with no MetricPropertyarray values if all Metrics had thesame values as in the previouslygenerated MetricReport.
SwitchType Switch string(enum)
The protocol being sent over thisswitch.
Switches Chassis (Links) array An array of references to theSwitches located in this Chassis.
Fabric object A collection of references to theswitches contained in this fabric.
SystemId AttributeRegistry(SupportedSystems)
string The system ID of the system.
SystemType ComputerSystem string(enum)
The type of computer systemrepresented by this resource.
Systems ServiceRoot object This is a link to a collection ofSystems.
TDPWatts Processor integer The nominal Thermal Design
TaskMonitor Task string The URI of the Task Monitor forthis task.
TaskState Task string(enum)
The state of the task.
TaskStatus Task string(enum)
This is the completion status of thetask.
Tasks TaskService object References to the Taskscollection.
ServiceRoot object This is a link to the Task Service.
TelemetryService ServiceRoot object This is a link to theTelemetryService.
Telnet ManagerNetworkProtocol object Settings for this Manager's Telnetprotocol support.
Temperature MemoryMetrics (HealthData >AlarmTrips)
boolean Temperature threshold crossingalarm trip detected status.
TemperatureCelsius ProcessorMetrics number The temperature of the processor.
Temperatures Thermal array This is the definition fortemperature sensors.
Thermal Chassis object A reference to the thermalproperties (fans, cooling, sensors)of this chassis.
Thresholds Sensor object The set of thresholds defined forthis sensor.
ThrottlingCelsius ProcessorMetrics number The CPU margin to throttle(temperature offset in degreeCelsius).
TimeoutAction ComputerSystem(HostWatchdogTimer)
string(enum)
This property indicates the actionto perform when the WatchdogTimer reaches its timeout value.
Timestamp MetricReport string The time associated with themetric report in its entirety. Thetime of the metric report may berelevant when the time of
Redfish Property Guide
redfish.dmtf.org 68 DSP2053 v2019.1
individual metrics are minimallydifferent.
MetricReport (MetricValues) string The time when the value of themetric is obtained. A managementapplication may establish a timeseries of metric data by retrievingthe instances of metric value andsorting them according to theirTimestamp.
TimestampAccuracy MetricDefinition string Accuracy of the timestamp.
Specifies the actions to performwhen a trigger occurs.
TriggerActions Triggers array This property specifies the actionsto perform when the triggeroccurs.
Redfish Property Guide
redfish.dmtf.org 69 DSP2053 v2019.1
Triggers MetricReportDefinition (Links) array The triggers that will cause thismetric report definition to generatea new metric report upon a triggeroccurrence when theTriggerActions property containsthe value RedfishMetricReport.
TelemetryService object A link to the collection of Triggers,which apply to metrics.
TrustedModules ComputerSystem array This object describes the array ofTrusted Modules in the system.
Type AttributeRegistry(RegistryEntries > Attributes)
string The Universal Unique Identifier(UUID) for this device.
UefiDevicePath EthernetInterface string The UEFI device path for thisinterface.
AttributeRegistry(RegistryEntries > Attributes)
string The UEFI device path thatqualifies this attribute.
BootOption string The UEFI device path used toaccess this UEFI Boot Option.
SimpleStorage string The UEFI device path used toaccess this storage controller.
UefiDevicePaths SoftwareInventory array A list of strings representing theUEFI Device Path(s) of thecomponent(s) associated with thissoftware inventory item.
UefiTargetBootSourceOverride ComputerSystem (Boot) string This property is the UEFI DevicePath of the device to boot fromwhen BootSourceOverrideTargetis UefiTarget.
integer The upper limit of the value of anattribute of type 'Integer'.
UpperCaution Sensor (Thresholds) object Above normal range.
UpperCritical Triggers (NumericThresholds) object Above normal range and requiresattention.
Sensor (Thresholds) object Above normal range but not yetfatal.
UpperFatal Sensor (Thresholds) object Above normal range and fatal.
UpperThresholdCritical Thermal (Fans) integer Above normal range but not yetfatal.
Power (Voltages), Thermal (Temperatures)
number Above normal range but not yetfatal.
UpperThresholdFatal Thermal (Fans) integer Above normal range and is fatal.
Power (Voltages), Thermal (Temperatures)
number Above normal range and is fatal.
UpperThresholdNonCritical Thermal (Fans) integer Above normal range.
Power (Voltages), Thermal (Temperatures)
number Above normal range.
UpperWarning Triggers (NumericThresholds) object Above normal range.
Uri JsonSchemaFile (Location), MessageRegistryFile (Location)
string Link to locally available URI forschema.
UseDNSServers EthernetInterface (DHCPv4) boolean Determines whether to useDHCPv4-supplied DNS servers.
EthernetInterface (DHCPv6) boolean When enabled, DNS serveraddresses supplied throughDHCPv6 stateless mode will beused.
UseDomainName EthernetInterface (DHCPv4) boolean Determines whether to use aDHCPv4-supplied domain name.
EthernetInterface (DHCPv6) boolean When enabled, the domain namesupplied through DHCPv6stateless mode will be used.
UseGateway EthernetInterface (DHCPv4) boolean Determines whether to use aDHCPv4-supplied gateway.
UseNTPServers EthernetInterface (DHCPv4) boolean Determines whether to useDHCPv4-supplied NTP servers.
Redfish Property Guide
redfish.dmtf.org 71 DSP2053 v2019.1
EthernetInterface (DHCPv6) boolean When enabled, NTP serveraddresses supplied throughDHCPv6 stateless mode will beused.
UseRapidCommit EthernetInterface (DHCPv6) boolean Determines whether to useDHCPv6 rapid commit mode forstateful mode addressassignments. Do not enable innetworks where more than oneDHCPv6 server is configured toprovide address assignments.
UseStaticRoutes EthernetInterface (DHCPv4) boolean Determines whether to useDHCPv4-supplied static routes.
UserName Session string The UserName for the account forthis session.
VirtualMedia string The username to be used whenaccessing the URI specified by theImage parameter.
ManagerAccount string This property contains the username for the account.
UserPercent ProcessorMetrics number The percentage of time spent inuser mode.
VolatileRegionNumberLimit Memory integer Total number of volatile regionsthis Memory can support.
VolatileRegionSizeLimitMiB Memory integer Total size of volatile regions inmebibytes (MiB).
VolatileRegionSizeMaxMiB Memory integer Maximum size of a single volatileregion in mebibytes (MiB).
VolatileSizeMiB Memory integer Total size of the volitile portionmemory in MiB.
VoltageType Sensor string(enum)
The voltage type (AC or DC) forthis sensor.
Voltages Power array This is the definition for voltagesensors.
VolumeType Volume string(enum)
The type of this volume.
Volumes Drive (Links) array An array of references to thevolumes contained in this drive.This will reference Volumes thatare either wholly or only partlycontained by this drive.
Storage object The set of volumes produced bythe storage controllersrepresented by this resource.
WWNN NetworkDeviceFunction(FibreChannel)
string This is the currently configuredWWNN address of the networkdevice function (physical function).
WWNSource NetworkDeviceFunction(FibreChannel)
string(enum)
The configuration source of theWWNs for this connection (WWPNand WWNN).
Redfish documentation generatorThis document was created using the Redfish Documentation Generator utility, which uses the contents of the Redfishschema files (in JSON schema format) to automatically generate the bulk of the text. The source code for the utility isavailable for download at the DMTF's Github repository located at http://www.github.com/DMTF/Redfish-Tools.
ANNEX A
Change logVersion Date Description
2019.1 2019-5-03 Release built from Redfish schemas released in DSP8020 version 2019.1
2018.3 2019-1-15 Initial release. Release built from Redfish schemas released in DSP8010 version 2018.3