Redfish Property Guide - DMTF · Property Name The name of the JSON property as it will appear...

Document Identifier: DSP2053

Date: 2019-5-03

Version: 2019.1

Redfish Property Guide

Document Class: InformativeDocument Status: PublishedDocument Language: en-US

Copyright Notice

Copyright © 2019 DMTF. All rights reserved.

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.

http://www.dmtf.org/about/policies/disclosures.php

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.


redfish.dmtf.org 2 DSP2053 v2019.1

http://redfish.dmtf.org/

http://www.redfishforum.com/

http://www.github.com/DMTF

http://www.dmtf.org/standards/redfish

http://www.dmtf.org/standards/spmf

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.



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

AccelerationFunction Processor (FPGA >ReconfigurationSlots)

object A link to the Acceleration Functionprovided by the code programmedinto a reconfiguration slot.

AccelerationFunctionType AccelerationFunction string(enum)

The type of acceleration function.

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.

AccountProviderType AccountService(ActiveDirectory), AccountService (LDAP), ExternalAccountProvider

string(enum)

This property contains the type ofexternal account provider thisresource references.

AccountService ServiceRoot object This is a link to the AccountService.

Accounts AccountService object A link to a collection of ManagerAccounts.

Accuracy MetricDefinition, Sensor

number Estimated percent error ofmeasured vs. actual values.

Actions various(AccelerationFunction, AccountService ... )

object The available actions for thisresource.



Activation Sensor (Thresholds >LowerCaution), Sensor (Thresholds >LowerCritical), Sensor (Thresholds >LowerFatal), Sensor (Thresholds >UpperCaution), Sensor (Thresholds >UpperCritical), Sensor (Thresholds >UpperFatal), Triggers (NumericThresholds >LowerCritical), Triggers (NumericThresholds >LowerWarning), Triggers (NumericThresholds >UpperCritical), Triggers (NumericThresholds >UpperWarning)

string(enum)

The direction of crossing thatactivates this threshold.

ActiveDirectory AccountService object The first ActiveDirectory externalaccount provider thisAccountService supports.

ActiveLinkTechnology NetworkPort string(enum)

Network Port Active LinkTechnology.

AddResourceBlock (Action) ComputerSystem (Actions) object This action is used to add aResource Block to a system.

AdditionalExternalAccountProviders AccountService object The additional external accountproviders this AccountService isusing.

AddressParityError MemoryMetrics (HealthData >AlarmTrips)

boolean Address parity error detectedstatus.

AddressRangeType MemoryChunks string(enum)

Memory type of this memorychunk.

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.



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).

AllowFIPVLANDiscovery NetworkDeviceFunction(FibreChannel)

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



HttpPushUriApplyTime) HttpPushUri should be applied.

ArchiveFile JsonSchemaFile (Location), MessageRegistryFile (Location)

string If the schema is hosted on theservice in an archive file, this is thename of the file within the archive.

ArchiveUri JsonSchemaFile (Location), MessageRegistryFile (Location)

string If the schema is hosted on theservice in an archive file, this is thelink to the archive file.

Assemblies Assembly array This is the definition for anassembly information record.

Assembly Chassis, Drive, Memory, NetworkAdapter, PCIeDevice, Power (PowerSupplies), Processor, Storage (StorageControllers), Thermal (Fans)

object A reference to the Assemblyresource associated with this item.

AssetTag Chassis, ComputerSystem, Drive, PCIeDevice, Storage (StorageControllers), Switch

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.

AssociatedTask Drive (Operations), Volume (Operations)

object A reference to the task associatedwith the operation if any.

AttributeName AttributeRegistry(RegistryEntries > Attributes)

string The unique name of the attribute.

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



(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.

Authentication AccountService(ActiveDirectory), AccountService (LDAP), ExternalAccountProvider

object This property contains theauthentication information for theexternal account provider.

AuthenticationMethod NetworkDeviceFunction(iSCSIBoot)

string(enum)

The iSCSI boot authenticationmethod for this network devicefunction.

AuthenticationModes HostInterface array Indicates the authentication modesavailable on this interface.

AuthenticationType AccountService (ActiveDirectory> Authentication), AccountService (LDAP >Authentication), ExternalAccountProvider(Authentication)

string(enum)

This property contains the type ofauthentication used to connect tothe external account provider.

AutoDSTEnabled Manager boolean Indicates whether the manager isconfigured for automatic DSTadjustment.

AutoNeg EthernetInterface boolean This indicates if the speed andduplex are automaticallynegotiated and configured on thisinterface.

AutoSpeedNegotiation NetworkPort(SupportedLinkCapabilities)

boolean Indicates whether the port has thecapability to auto negotiate speed.

AverageConsumedWatts Power (PowerControl >PowerMetrics)

number The average power level over themeasurement window (the lastIntervalInMin minutes).

AverageFrequencyMHz ProcessorMetrics number The average frequency of theprocessor.

AveragePowerBudgetMilliWatts Memory(PowerManagementPolicy)

integer Average power budget in milliwatts.

BandwidthPercent ProcessorMetrics number The CPU bandwidth as apercentage.

BaseDistinguishedNames AccountService (ActiveDirectory> LDAPService >

array The base distinguished names touse when searching the LDAP



SearchSettings), AccountService (LDAP >LDAPService >SearchSettings), ExternalAccountProvider(LDAPService >SearchSettings)

service.

BaseModuleType Memory string(enum)

The base module type of Memory.

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.



BootOrder ComputerSystem (Boot) array Ordered array ofBootOptionReference stringsrepresenting the persistent BootOrder associated with thiscomputer system.

BootOrderPropertySelection ComputerSystem (Boot) string(enum)

Choice of which boot orderproperty to use when specifyingthe boot order.

BootPriority NetworkDeviceFunction(FibreChannel > BootTargets)

integer The relative priority for this entry inthe boot targets array.

BootSourceOverrideEnabled ComputerSystem (Boot) string(enum)

Describes the state of the BootSource Override feature.

BootSourceOverrideMode ComputerSystem (Boot) string(enum)

The BIOS Boot Mode (eitherLegacy or UEFI) to be used whenBootSourceOverrideTarget bootsource is booted from.

BootSourceOverrideTarget ComputerSystem (Boot) string(enum)

The current boot source to beused at next boot instead of thenormal boot device, ifBootSourceOverrideEnabled istrue.

BootTargets NetworkDeviceFunction(FibreChannel)

array An array of Fibre Channel boottargets configured for this networkdevice function.

BusWidthBits Memory integer Bus Width in bits.

CHAPSecret NetworkDeviceFunction(iSCSIBoot)

string The shared secret for CHAPauthentication.

CHAPUsername NetworkDeviceFunction(iSCSIBoot)

string The username for CHAPauthentication.

CStateResidency ProcessorMetrics (CoreMetrics) array The C-state residency of this corein the processor.

Cache ProcessorMetrics array The processor cache metrics.

CacheMiss ProcessorMetrics (Cache), ProcessorMetrics (CoreMetrics> CoreCache)

number The number of cache line missesin millions.

CacheMissesPerInstruction ProcessorMetrics (Cache), ProcessorMetrics (CoreMetrics> CoreCache)

number The number of cache misses perinstruction.

CacheSizeMiB Memory integer Total size of the cache portionmemory in MiB.

CacheSummary Storage (StorageControllers) object This object describes the cachememory of the storage controller ingeneral detail.

Calculable MetricDefinition string(enum)

Indicates whether the metric canbe used in a calculation.

CalculationAlgorithm MetricDefinition string(enum)

The calculation which is performedon a source metric to obtain themetric being defined.



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.

Capable NetworkAdapter (Controllers >ControllerCapabilities >DataCenterBridging)

boolean Whether this controller is capableof Data Center Bridging (DCB).

CapableLinkSpeedMbps NetworkPort(SupportedLinkCapabilities)

array The self-described link networkspeed capabilities of this port.Note: Should this be a newenumerated type of link speeds?.

CapableSpeedGbs Drive number The speed which this drive cancommunicate to a storagecontroller in ideal conditions inGigabits per second.

CapacityBytes Drive, SimpleStorage (Devices)

integer The capacity of the device inbytes.

Volume number The size in bytes of this Volume.

CapacityMiB Memory, Processor (ProcessorMemory)

integer Memory Capacity in mebibytes(MiB).

CertificateLocations CertificateService object Information regarding the locationof certificates.

CertificateService ServiceRoot object This is a link to theCertificateService.

CertificateString Certificate string The string for the certificate.

CertificateType Certificate string(enum)

The format of the certificate.

Certificates CertificateLocations (Links) array This property is an array ofreferences to the certificatesinstalled on this service.

ManagerNetworkProtocol(HTTPS)

object This is a reference to a collectionof certificates used for HTTPS bythis manager.

ComputerSystem (Boot) object This is a reference to a collectionof certificates used for booting viaHTTPS by this ComputerSystem.

AccountService(ActiveDirectory), AccountService (LDAP), ExternalAccountProvider

object This is a reference to a collectionof certificates used for the externalaccount provider.

ManagerAccount object This is a reference to a collectionof certificates used for this



account.

ChangePassword (Action) Bios (Actions) object This action is used to change theBIOS passwords.

Channel Memory (MemoryLocation) integer Channel number in which Memoryis connected.

Chassis ComputerSystem (Links), PCIeDevice (Links), ResourceBlock (Links)

array An array of references to theChassis that is related or containsthis resource.

Drive (Links), EthernetInterface (Links), Memory (Links), Processor (Links), SimpleStorage (Links), Switch (Links)

object A reference to the Chassis whichcontains this resource.

ServiceRoot object This is a link to a collection ofChassis.

ChassisType Chassis string(enum)

The type of physical form factor ofthe chassis.

City Certificate (Issuer), Certificate (Subject)

string The city or locality of theorganization of the entity.

ClassCode PCIeFunction string The Class Code of this PCIefunction.

Endpoint (ConnectedEntities >EntityPciId), Endpoint (PciId)

string The Class Code, Subclass code,and Programming Interface codeof this PCIe function.

ClearCurrentPeriod (Action) MemoryMetrics (Actions) object This sets the CurrentPeriod objectvalues to zero.

ClearLog (Action) LogService (Actions) object This action is used to clear the logfor this Log Service.

CollectionDuration MetricReportDefinition (Metrics) string Specifies the duration over whichthe function is computed.

CollectionFunction TelemetryService(SupportedCollectionFunctions)

string(enum)

An operation to perform over thesample.

MetricReportDefinition (Metrics) string(enum)

Specified the function to performon each of the metric propertieslisted in the MetricPropertiesproperty.

CollectionTimeScope MetricReportDefinition (Metrics) string(enum)

Specifies the scope of time scopeover which the function is applied.

CommandShell Manager object Information about the CommandShell service provided by thismanager.

CommonName Certificate (Issuer), Certificate (Subject)

string The fully qualified domain name ofthe entity.

CompletedTaskOverWritePolicy TaskService string(enum)

Overwrite policy of completedtasks.



CompositionService ServiceRoot object This is a link to theCompositionService.

CompositionState ResourceBlock(CompositionStatus)

string(enum)

This property represents thecurrent state of the ResourceBlock from a compositionperspective.

CompositionStatus ResourceBlock object This property describes thecomposition status details for thisResource Block.

ComputerSystems Chassis (Links), HostInterface (Links), ResourceBlock, ResourceBlock (Links)

array An array of references to theComputer Systems related to thisresource.

ConfigurationLockCapable Memory (SecurityCapabilities) boolean Support for locking theconfiguration.

ConfigurationLocked Memory boolean Indicates that the configuration ofthis memory has been locked.

ConnectTypesSupported Manager (CommandShell), Manager (GraphicalConsole), Manager (SerialConsole)

array This object is used to enumerateconnection types allowed by theimplementation.

ConnectedEntities Endpoint array All the entities connected to thisendpoint.

ConnectedProcessors Processor (Links) array An array of references to theprocessors directly connected tothis processor.

ConnectedSwitchPorts Port (Links) array An array of references to the portsthat connect to the switch throughthis port.

ConnectedSwitches Port (Links) array An array of references to theswitches that connect to thedevice through this port.

ConnectedVia VirtualMedia string(enum)

Current virtual media connectionmethods.

ConnectorType SerialInterface string(enum)

The type of connector used for thisinterface.

ConsistencyCheckRatePercent Storage (StorageControllers >ControllerRates)

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



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.

CorrectableECCError MemoryMetrics (HealthData >AlarmTrips)

boolean Correctable data error thresholdcrossing alarm trip detectedstatus.

CorrectionInMs Power (PowerControl >PowerLimit)

integer The time required for the limitingprocess to reduce powerconsumption to below the limit.

Count ComputerSystem(ProcessorSummary)

integer The number of physicalprocessors in the system.

Country Certificate (Issuer), Certificate (Subject)

string The country of the organization ofthe entity.

Created LogEntry string The time the log entry wascreated.

CreatedBy Job string The person or program thatcreated this job entry.

CurrentLinkSpeedMbps NetworkPort integer Network Port Current Link Speed.

CurrentPeriod MemoryMetrics object This object contains the Memorymetrics since last reset orClearCurrentPeriod action.

CurrentSpeedGbps Port number The current speed of this port.

CurrentValue AttributeRegistry(RegistryEntries > Attributes)

boolean,number,string

Placeholder of the current value ofthe attribute.

DELETE PrivilegeRegistry (Mappings >OperationMap), PrivilegeRegistry (Mappings >PropertyOverrides >

array Indicates privilege required forHTTP DELETE operation.



OperationMap), PrivilegeRegistry (Mappings >ResourceURIOverrides >OperationMap), PrivilegeRegistry (Mappings >SubordinateOverrides >OperationMap)

DHCP ManagerNetworkProtocol object Settings for this Manager'sDHCPv4 protocol support.

DHCPEnabled EthernetInterface (DHCPv4) boolean Determines whether DHCPv4 isenabled on this interface.

DHCPv4 EthernetInterface object DHCPv4 configuration for thisinterface.

DHCPv6 EthernetInterface object DHCPv6 configuration for thisinterface.

ManagerNetworkProtocol object Settings for this Manager'sDHCPv6 protocol support.

DataBits SerialInterface string(enum)

The number of data bits that willfollow the start bit over the serialconnection.

DataCenterBridging NetworkAdapter (Controllers >ControllerCapabilities)

object Data Center Bridging (DCB) forthis controller.

DataLockCapable Memory (SecurityCapabilities) boolean Support for data locking.

DataLossDetected MemoryMetrics (HealthData) boolean Data loss detection status.

DataType ActionInfo (Parameters) string(enum)

The JSON property type used forthis parameter.

DataWidthBits Memory integer Data Width in bits.

DateTime LogService string The current DateTime (with offset)for the log service, used to set orread time.

Manager string The current DateTime (with offset)for the manager, used to set orread time.

JobService string The current DateTime (with offset)setting that the job service isusing.

TaskService string The current DateTime (with offset)setting that the task service isusing.

DateTimeLocalOffset LogService, Manager

string The time offset from UTC that theDateTime property is set to informat: +06:00 .

DefaultValue AttributeRegistry(RegistryEntries > Attributes)


The default current value of theattribute.

DeliveryRetryAttempts EventService integer This is the number of attempts anevent posting is retried before the



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.

DeltaPhysicalContext Thermal (Temperatures) string(enum)

Describes the area or device towhich the DeltaReadingCelsiustemperature measurementapplies, relative toPhysicalContext.

DeltaReadingCelsius Thermal (Temperatures) number Delta Temperature reading.

Dependencies AttributeRegistry(RegistryEntries)

array The array containing a list ofdependencies of attributes on thiscomponent.

Dependency AttributeRegistry(RegistryEntries >Dependencies)

object The dependency expression forone or more Attributes in thisAttribute Registry.

DependencyFor AttributeRegistry(RegistryEntries >Dependencies)

string The AttributeName of the attributewhose change triggers theevaluation of this dependencyexpression.

DepthMm Chassis number The depth of the chassis.

Description Assembly (Assemblies) string Description of the Assembly.

various(AccelerationFunction, AccelerationFunctionCollection... )

string Provides a description of thisresource and is used forcommonality in the schemadefinitions.

Destination EventDestination string The URI of the destination EventService.

DeviceClass PCIeFunction string(enum)

The class for this PCIe Function.

DeviceEnabled NetworkDeviceFunction boolean Whether the network devicefunction is enabled.

DeviceID Memory string Device ID.

DeviceId Endpoint (ConnectedEntities >EntityPciId), Endpoint (PciId), PCIeFunction

string The Device ID of this PCIefunction.

DeviceLocator Memory string Location of the Memory in theplatform.

DeviceMaxCount NetworkAdapter (Controllers > integer The maximum number of Virtual



ControllerCapabilities >VirtualizationOffload >VirtualFunction)

Functions (VFs) supported by thiscontroller.

DeviceType PCIeDevice string(enum)

The device type for this PCIedevice.

Devices SimpleStorage array The storage devices associatedwith this resource.

DisablePassphrase (Action) Memory (Actions) object Disable passphrase for givenregions.

DiscreteTriggerCondition Triggers string(enum)

Specifies the conditions when adiscrete metric triggers.

DiscreteTriggers Triggers array List of discrete triggers.

DiscreteValues MetricDefinition array This array property specifiespossible values of a discretemetric.

DisplayName BootOption string The user-readable display string ofthe Boot Option.

AttributeRegistry(RegistryEntries > Attributes)

string The user-readable display string ofthe attribute in the defined'Language'.

AttributeRegistry(RegistryEntries > Menus)

string The user-readable display string ofthis menu in the defined'Language'.

DisplayOrder AttributeRegistry(RegistryEntries > Menus)

integer The numeric value describing theascending order in which thismenu is displayed relative to othermenus.


integer The numeric value describing theascending order that the attributeis displayed relative to otherattributes.

DomainID Switch integer The Domain ID for this switch.

Drives Chassis (Links), PCIeFunction (Links), ResourceBlock, Storage, Volume (Links)

array An array of references to theDrives associated with thisresource.

DwellTime various(Sensor (Thresholds >LowerCaution), Sensor (Thresholds >LowerCritical) ... )

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



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.

EndpointProtocol Endpoint string(enum)

The protocol supported by thisendpoint.

Endpoints AccelerationFunction (Links), ComputerSystem (Links), Drive (Links), EthernetInterface (Links), NetworkDeviceFunction (Links),

Processor (Links), Storage (StorageControllers >Links), Zone (Links)

array An array of references toendpoints associated with thisresource.

Fabric object A collection of references to theendpoints contained in this fabric.

EngineeringChangeLevel Assembly (Assemblies) string Engineering change level of theAssembly.

Entity PrivilegeRegistry (Mappings) string Indicates entity name. e.g.,Manager.



EntityLink Endpoint (ConnectedEntities) A link to the associated entity.

EntityPciId Endpoint (ConnectedEntities) object The PCI ID of the connectedentity.

EntityRole Endpoint (ConnectedEntities) string(enum)

The role of the connected entity.

EntityType Endpoint (ConnectedEntities) string(enum)

The type of the connected entity.

Entries LogService object References to the log entrycollection.

EntryCode LogEntry string(enum)

If the EntryType is SEL, this willhave the entry code for the logentry.

EntryType LogEntry string(enum)

This is the type of log entry.

EnvironmentalClass Chassis string(enum)

The ASHRAE EnvironmentalClass for this Chassis.

ErrorCorrection Memory string(enum)

Error correction scheme supportedfor this memory.

Ethernet NetworkDeviceFunction, Processor (FPGA >ExternalInterfaces), Processor (FPGA >HostInterface)

object Describes the Ethernet relatedinformation about this device orinterface.

EthernetInterfaces PCIeFunction (Links), ResourceBlock

array An array of references to theEthernet Interfaces related to thisresource.

ComputerSystem, Manager

object A reference to the collection ofEthernet interfaces associatedwith this resource.

EventFormatType EventService(SSEFilterPropertiesSupported)

boolean This indicates if theEventFormatType property issupported.

EventDestination string(enum)

Indicates the content types of themessage that will be sent to theEventDestination.

EventFormatTypes EventService array Indicates the content types of themessage that this service cansend to the event destination.

EventGroupId Event (Events), LogEntry

integer This value is the identifier used tocorrelate events that came fromthe same cause.

EventId Event (Events), LogEntry

string This is a unique instance identifierof an event.

EventService ServiceRoot object This is a link to the EventService.

EventTimestamp Event (Events), LogEntry

string This is time the event occurred.



EventTriggers Triggers array A list of MessageIds that specifywhen a trigger occurs based on anevent.

EventType EventService(SSEFilterPropertiesSupported)

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.

ExcerptQuery ServiceRoot(ProtocolFeaturesSupported)

boolean This indicates whether the'excerpt' query parameter issupported.

ExpandAll ServiceRoot(ProtocolFeaturesSupported >ExpandQuery)

boolean This indicates whether the$expand support of asterisk(expand all entries) is supported.

ExpandQuery ServiceRoot(ProtocolFeaturesSupported)

object Contains information about theuse of $expand in the service.

ExternalAccessibility Zone string(enum)

How is this zone accessible toendpoints not explicitly listed.

ExternalInterfaces Processor (FPGA) array An array of the FPGA externalinterfaces.

ExternallyAccessible HostInterface boolean Indicates whether this interface isaccessible by external entities.

FCFabricName NetworkPort string The FC Fabric Name provided bythe switch.

FCPortConnectionType NetworkPort string(enum)

This is the connection type of thisport.

FCoEActiveVLANId NetworkDeviceFunction(FibreChannel)

integer The active FCoE VLAN ID.

FCoELocalVLANId NetworkDeviceFunction(FibreChannel)

integer The locally configured FCoE VLANID.

FPGA Processor object The properties specific forProcessors of type FPGA.

FQDN EthernetInterface, ManagerNetworkProtocol

string This is the fully qualified domainname obtained by DNS includingthe host name and top-level



domain name.

FabricType Fabric string(enum)

The protocol being sent over thisfabric.

Fabrics ServiceRoot object A link to a collection of all fabricentities.

FailurePredicted Drive boolean Is this drive currently predicting afailure in the near future.

FallbackAddress EthernetInterface (DHCPv4) string(enum)

DHCPv4 fallback address methodfor this interface.

FanName Thermal (Fans) string Name of the fan.

Fans Thermal array This is the definition for fans.

FibreChannel NetworkDeviceFunction object Fibre Channel.

FibreChannelId NetworkDeviceFunction(FibreChannel)

string The Fibre Channel Id assigned bythe switch for this interface.

FilterQuery ServiceRoot(ProtocolFeaturesSupported)

boolean This indicates whether the $filterquery parameter is supported.

FirmwareApiVersion Memory string Version of API supported by thefirmware.

FirmwareAuthEnabled HostInterface boolean Indicates whether this firmwareauthentication is enabled for thisinterface.

FirmwareAuthRole HostInterface (Links) object A reference to the Role that hasfirmware authentication privilegeson this Host Interface.

FirmwareAuthRoleId HostInterface string The Role used for firmwareauthentication on this interface.

FirmwareId Processor (FPGA) string The FPGA firmware identifier.

FirmwareInventory UpdateService object An inventory of firmware.

FirmwareManufacturer Processor (FPGA) string The FPGA firmware manufacturer.

FirmwarePackageVersion NetworkAdapter (Controllers) string The version of the user-facingfirmware package.

FirmwareRevision Memory string Revision of firmware on theMemory controller.

FirmwareVersion AttributeRegistry(SupportedSystems), ComputerSystem(TrustedModules), Manager, PCIeDevice, Power (PowerSupplies), Processor (FPGA), Storage (StorageControllers)

string The firmware version for thisdevice.

FirmwareVersion2 ComputerSystem(TrustedModules)

string The 2nd firmware version of thisTrusted Module, if applicable.

FlowControl SerialInterface string The type of flow control, if any,



(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.

FunctionNumber Endpoint (ConnectedEntities >EntityPciId), Endpoint (PciId)

integer The PCI ID of the connectedentity.

FunctionType PCIeFunction string(enum)

The type of the PCIe Function.

GET PrivilegeRegistry (Mappings >OperationMap), PrivilegeRegistry (Mappings >PropertyOverrides >OperationMap), PrivilegeRegistry (Mappings >ResourceURIOverrides >OperationMap), PrivilegeRegistry (Mappings >SubordinateOverrides >OperationMap)

array Indicates privilege required forHTTP GET operation.

GenerateCSR (Action) CertificateService (Actions) object This action is used to perform acertificate signing request.

GraphicalConsole Manager object The value of this property shallcontain the information about theGraphical Console (KVM-IP)service of this manager.

GrayOut AttributeRegistry boolean The gray-out state of this attribute



(RegistryEntries > Attributes), AttributeRegistry(RegistryEntries > Menus)

or menu. A grayed-only menu isnot accessible in user interfaces.

GroupNameAttribute AccountService (ActiveDirectory> LDAPService >SearchSettings), AccountService (LDAP >LDAPService >SearchSettings), ExternalAccountProvider(LDAPService >SearchSettings)

string The attribute name that containsthe name of the Group on thegroup LDAP entry.

GroupsAttribute AccountService (ActiveDirectory> LDAPService >SearchSettings), AccountService (LDAP >LDAPService >SearchSettings), ExternalAccountProvider(LDAPService >SearchSettings)

string The attribute name that containsthe Groups for a user on the userLDAP entry.

HEAD PrivilegeRegistry (Mappings >OperationMap), PrivilegeRegistry (Mappings >PropertyOverrides >OperationMap), PrivilegeRegistry (Mappings >ResourceURIOverrides >OperationMap), PrivilegeRegistry (Mappings >SubordinateOverrides >OperationMap)

array Indicates privilege required forHTTP HEAD operation.

HTTP ManagerNetworkProtocol object Settings for this Manager's HTTPprotocol support.

HTTPS ManagerNetworkProtocol object Settings for this Manager's HTTPSprotocol support.

HealthData MemoryMetrics object This object describes the healthinformation of the memory.

HeightMm Chassis number The height of the chassis.

HelpText AttributeRegistry(RegistryEntries > Attributes)

string The help text for the attribute.

Hidden AttributeRegistry(RegistryEntries > Attributes), AttributeRegistry(RegistryEntries > Menus)

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.

HitRatio ProcessorMetrics (Cache), ProcessorMetrics (CoreMetrics

number The cache line hit ratio.



> CoreCache)

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.

HostName ComputerSystem, EthernetInterface, ManagerNetworkProtocol

string The DNS Host Name, without anydomain information.

HostReservationMemoryBytes Endpoint integer The amount of memory in Bytesthat the Host should allocate toconnect to this endpoint.

HostWatchdogTimer ComputerSystem object This object describes the HostWatchdog Timer functionality forthis system.

HostedServices ComputerSystem object The services that this computersystem supports.

HostingRole ComputerSystem(HostingRoles)

string(enum)

The enumerations of HostingRolesspecify different features that thehosting ComputerSystemsupports.

HostingRoles ComputerSystem array The hosing roles that thiscomputer system supports.

HotPluggable Power (PowerSupplies), Thermal (Fans)

boolean Indicates if this device can beinserted or removed while theequipment is in operation.

PCIeSlots boolean Indicates whether the PCIe slotsupports hotplug.

HotspareReplacementMode Drive string(enum)

The replacement mode for thehotspare drive.

HotspareType Drive string(enum)

The type of hotspare this drive iscurrently serving as.

HttpHeaders EventDestination, Job (Payload), Task (Payload)

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



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.

HttpPushUriApplyTime UpdateService(HttpPushUriOptions)

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.

EthernetInterface(IPv4Addresses), EthernetInterface(IPv4StaticAddresses)

object This type describes an IPv4Address.

IPv4Addresses EthernetInterface array The IPv4 addresses currentlyassigned to this interface.

IPv4AutoConfigEnabled EthernetInterface(StatelessAddressAutoConfig)

boolean Indicates whether IPv4 SLAAC isenabled for this interface.



IPv4StaticAddresses EthernetInterface array The IPv4 static addressesassigned to this interface.

IPv6Address Endpoint (IPTransportDetails) object The IPv6 addresses assigned tothe Endpoint.

EthernetInterface(IPv6Addresses)

object This type describes an IPv6Address.

IPv6AddressPolicyTable EthernetInterface array An array representing the RFC6724 Address Selection PolicyTable.

IPv6Addresses EthernetInterface array Enumerates in an array all of thecurrently assigned IPv6 addresseson this interface.

IPv6AutoConfigEnabled EthernetInterface(StatelessAddressAutoConfig)

boolean Indicates whether IPv6 SLAAC isenabled for this interface.

IPv6DefaultGateway EthernetInterface string This is the IPv6 default gatewayaddress that is currently in use onthis interface.

IPv6GatewayStaticAddress EthernetInterface(IPv6StaticDefaultGateways)

object This object represents a singleIPv6 static address to be assignedon a network interface.

IPv6StaticAddress EthernetInterface(IPv6StaticAddresses)

object This object represents a singleIPv6 static address to be assignedon a network interface.

IPv6StaticAddresses EthernetInterface array Represents in an array all of theIPv6 static addresses to beassigned on this interface.

IPv6StaticDefaultGateways EthernetInterface array The IPv6 static default gatewaysfor this interface.

Id various(AccelerationFunction, AccountService ... )

string The identifier for this resource.

IdentificationRegisters Processor (ProcessorId) string The contents of the IdentificationRegisters (CPUID) for thisprocessor.

Identifier Drive (Identifiers), Endpoint (ConnectedEntities >Identifiers), Endpoint (Identifiers), Storage (StorageControllers >Identifiers), Zone (Identifiers)

object This type describes any additionalidentifiers for a resource.

Identifiers Endpoint (ConnectedEntities) array Identifiers for the remote entity.

Endpoint array Identifiers for this endpoint.

Zone array Identifiers for this zone.

Drive array The Durable names for the drive.

Storage (StorageControllers) array The Durable names for thestorage controller.



Volume array The Durable names for thevolume.

Image VirtualMedia string A URI providing the location of theselected image.

ImageName VirtualMedia string The current image name.

Immutable AttributeRegistry(RegistryEntries > Attributes)

boolean Defines whether this attribute isimmutable or not.

Implementation MetricDefinition string(enum)

The implementation of the metric.

IndicatorLED Chassis string(enum)

The state of the indicator LED,used to identify the chassis.

Drive string(enum)

The state of the indicator LED,used to identify the drive.

Power (PowerSupplies) string(enum)

The state of the indicator LED,used to identify the power supply.

Switch string(enum)

The state of the indicator LED,used to identify the switch.

ComputerSystem string(enum)

The state of the indicator LED,used to identify the system.

Thermal (Fans) string(enum)

The state of the indicator LED,used to identify this Fan.

Initialize (Action) Volume (Actions) object This action is used to prepare thecontents of the volume for use bythe system.

InitiatorDefaultGateway NetworkDeviceFunction(iSCSIBoot)

string The IPv6 or IPv4 iSCSI bootdefault gateway.

InitiatorIPAddress NetworkDeviceFunction(iSCSIBoot)

string The IPv6 or IPv4 address of theiSCSI initiator.

InitiatorName NetworkDeviceFunction(iSCSIBoot)

string The iSCSI initiator name.

InitiatorNetmask NetworkDeviceFunction(iSCSIBoot)

string The IPv6 or IPv4 netmask of theiSCSI boot initiator.

InputRanges Power (PowerSupplies) array This is the input ranges that thepower supply can use.

InputType Power (PowerSupplies >InputRanges)

string(enum)

The Input type (AC or DC).

InsertMedia (Action) VirtualMedia (Actions) object This action is used to attachremote media to virtual media.

Inserted VirtualMedia boolean Indicates if virtual media isinserted in the virtual device.

InstructionSet Processor string(enum)

The instruction set of theprocessor.

InstructionsPerCycle ProcessorMetrics (CoreMetrics) number The number of instructions perclock cycle of this core.



IntegratedMemory Processor (ProcessorMemory) boolean This indicates whether thismemory is integrated within theProcessor.

InterfaceEnabled EthernetInterface, HostInterface, SerialInterface

boolean Indicates whether this interface isenabled.

InterfaceType Processor (FPGA >ExternalInterfaces), Processor (FPGA >HostInterface)

string(enum)

The FPGA interface type.

ComputerSystem(TrustedModules)

string(enum)

This property indicates theinterface type of the TrustedModule.

InterfaceTypeSelection ComputerSystem(TrustedModules)

string(enum)

The Interface Type selectionsupported by this Trusted Module.

InterleavableMemorySets MemoryDomain array This is the interleave sets for thememory chunk.

InterleaveSets MemoryChunks array This is the interleave sets for thememory chunk.

IntervalInMin Power (PowerControl >PowerMetrics)

integer The time interval (or window) inwhich the PowerMetrics aremeasured over.

IntrusionSensor Chassis (PhysicalSecurity) string(enum)

This indicates the known state ofthe physical security sensor, suchas if it is hardware intrusiondetected.

IntrusionSensorNumber Chassis (PhysicalSecurity) integer A numerical identifier to representthe physical security sensor.

IntrusionSensorReArm Chassis (PhysicalSecurity) string(enum)

This indicates how the Normalstate to be restored.

InvolvedSwitches Zone (Links) array Represents an array of referencesto the switches in this zone.

IsLinear MetricDefinition boolean Indicates whether the metricvalues are linear (vs non-linear).

IsManaged Switch boolean This indicates whether the switchis in a managed or unmanagedstate.

IsMirrorEnabled MemoryChunks boolean Mirror Enabled status.

IsPredefined Role boolean This property is used to indicate ifthe Role is one of the RedfishPredefined Roles vs a Customrole.

IsRankSpareEnabled Memory boolean Rank spare enabled status.

IsSpare MemoryChunks boolean Spare enabled status.

IsSpareDeviceEnabled Memory boolean Spare device enabled status.

IsSystemUniqueProperty AttributeRegistry boolean Defines whether this attribute is



(RegistryEntries > Attributes) unique for this system and shouldnot be replicated.

Issuer Certificate object The issuer of the certificate.

JobService ServiceRoot object This is a link to the JobService.

JobState Job string(enum)

The state of the job.

JobStatus Job string(enum)

The status of the job.

Jobs JobService object References to the Jobs collection.

JsonBody Job (Payload), Task (Payload)

string This property contains the JSONpayload to use in the execution ofthis Job or Task.

JsonSchemas ServiceRoot object This is a link to a collection ofJson-Schema files.

KVMIP ManagerNetworkProtocol object Settings for this Manager's KVM-IP protocol support.

KerberosKeytab AccountService (ActiveDirectory> Authentication), AccountService (LDAP >Authentication), ExternalAccountProvider(Authentication)

string This property is used with aPATCH or PUT to write a base64encoded version of the kerberoskeytab for the account. Thisproperty is null on a GET.

KernelAuthEnabled HostInterface boolean Indicates whether this kernelauthentication is enabled for thisinterface.

KernelAuthRole HostInterface (Links) object A reference to the Role objectdefining Privileges for this HostInterface when using kernelauthentication.

KernelAuthRoleId HostInterface string The Role used for kernelauthentication on this interface.

KernelPercent ProcessorMetrics number The percentage of time spent inkernel mode.

KeyUsage Certificate array The usage of the key contained inthe certificate.

Certificate (KeyUsage) string(enum)

The usages of a key containedwithin a certificate.

Keys MetricReportDefinition(Wildcards)

array An array of values to substitute forthe wildcard.

LDAP AccountService object The first LDAP external accountprovider this AccountServicesupports.

LDAPService AccountService(ActiveDirectory), AccountService (LDAP), ExternalAccountProvider

object This property contains additionalmapping information needed toparse a generic LDAP service.



LUNID NetworkDeviceFunction(FibreChannel > BootTargets)

string The Logical Unit Number (LUN) IDto boot from on the device referredto by the corresponding WWPN.

Label EthernetInterface(IPv6AddressPolicyTable)

integer The IPv6 Label (as defined in RFC6724 section 2.1).

Lanes PCIeSlots (Slots) integer This is the number of PCIe lanessupported by this slot.

LanesInUse PCIeDevice (PCIeInterface) integer This is the number of PCIe lanesin use by this device.

Language JsonSchemaFile (Location), MessageRegistryFile (Location)

string The language code for the file theschema is in.

AttributeRegistry, MessageRegistry

string This is the RFC 5646 compliantlanguage code for the registry.

Languages JsonSchemaFile, MessageRegistryFile

array Language codes for the schemasavailable.

LastPowerOutputWatts Power (PowerSupplies) number The average power output of thisPower Supply.

LastShutdownSuccess MemoryMetrics (HealthData) boolean Status of last shutdown.

Level ProcessorMetrics (Cache), ProcessorMetrics (CoreMetrics> CoreCache)

string The cache level.

ProcessorMetrics (CoreMetrics> CStateResidency)

string The level of C-state, e.g. C0, C1,C2.

Levels ServiceRoot(ProtocolFeaturesSupported >ExpandQuery)

boolean This indicates whether the expandsupport of the $levels qualifier issupported by the service.

LifeCycleEventOnTaskStateChange TaskService boolean Send an Event upon Task StateChange.

LifeTime MemoryMetrics object This object contains the Memorymetrics for the lifetime of theMemory.

LimitException Power (PowerControl >PowerLimit)

string(enum)

The action that is taken if thepower cannot be maintained belowthe LimitInWatts.

LimitInWatts Power (PowerControl >PowerLimit)

number The Power limit in watts. Set tonull to disable power capping.

LineInputVoltage Power (PowerSupplies) number The line input voltage at which thePower Supply is operating.

LineInputVoltageType Power (PowerSupplies) string(enum)

The line voltage type supported asan input to this Power Supply.

LinkNetworkTechnology NetworkPort(SupportedLinkCapabilities)

string(enum)

The self-described link networktechnology capabilities of this port.

LinkSpeedMbps NetworkPort(SupportedLinkCapabilities)

integer The speed of the link in Mbpswhen this link network technologyis active.

LinkStatus EthernetInterface string The link status of this interface



(enum) (port).

NetworkPort string(enum)

The status of the link between thisport and its link partner.

Links ServiceRoot(ProtocolFeaturesSupported >ExpandQuery)

boolean This indicates whether the$expand support of tilde (expandonly entries in the Links section) issupported.

various(AccelerationFunction, CertificateLocations ... )

object Contains references to otherresources that are related to thisresource.

LoadPercent Sensor number The power load utilization for thisSensor.

LocalAccountAuth AccountService string(enum)

Controls when this service will usethe accounts defined withing thisAccountService as part ofauthentication.

LocalMemoryBandwidthBytes ProcessorMetrics integer The local memory bandwidthusage in bytes.

LocalRole AccountService (ActiveDirectory> RemoteRoleMapping), AccountService (LDAP >RemoteRoleMapping), ExternalAccountProvider(RemoteRoleMapping)

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



system.

Chassis object A reference to the logs for thischassis.

Manager object This is a reference to a collectionof Logs used by the manager.

LogicalProcessorCount ComputerSystem(ProcessorSummary)

integer The number of logical processorsin the system.

LogicalSizeMiB Memory integer Total size of the logical memory inMiB.

LowerBound AttributeRegistry(RegistryEntries > Attributes)

integer The lower limit of the value of anattribute of type 'Integer'.

LowerCaution Sensor (Thresholds) object Below normal range.

LowerCritical Triggers (NumericThresholds) object Below normal range and requiresattention.

Sensor (Thresholds) object Below normal range but not yetfatal.

LowerFatal Sensor (Thresholds) object Below normal range and fatal.

LowerThresholdCritical Thermal (Fans) integer Below normal range but not yetfatal.

Power (Voltages), Thermal (Temperatures)

number Below normal range but not yetfatal.

LowerThresholdFatal Thermal (Fans) integer Below normal range and is fatal.


number Below normal range and is fatal.

LowerThresholdNonCritical Thermal (Fans) integer Below normal range.


number Below normal range.

LowerWarning Triggers (NumericThresholds) object Below normal range.

LowestSupportedVersion SoftwareInventory string A string representing the lowestsupported version of this software.

MACAddress EthernetInterface, NetworkDeviceFunction(Ethernet)

string This is the currently configuredMAC address of the interface.

MTUSize EthernetInterface, NetworkDeviceFunction(Ethernet)

integer The Maximum Transmission Unit(MTU) configured for this interface.

MaintenanceWindowDurationInSeconds UpdateService(HttpPushUriOptions >HttpPushUriApplyTime)

integer The value of this property asspecified by client indicates theexpiry time of maintenancewindow in seconds.

MaintenanceWindowStartTime UpdateService(HttpPushUriOptions >HttpPushUriApplyTime)

string The value of this property asspecified by client to indicate thestart time of a maintenancewindow.



ManagedBy Chassis (Links), ComputerSystem (Links), Switch (Links)

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.

Manufacturer various(AccelerationFunction, Chassis ... )

string A the manufacturer/producer ofthis device or resource.

MapFrom AttributeRegistry(RegistryEntries >Dependencies > Dependency)

array Array of the map-from conditionsfor mapping dependency.

MapFromAttribute AttributeRegistry(RegistryEntries >Dependencies > Dependency >MapFrom)

string The attribute that is used toevaluate this dependencyexpression.

MapFromCondition AttributeRegistry(RegistryEntries >Dependencies > Dependency >MapFrom)

string(enum)

The condition that is used toevaluate this dependencyexpression.

MapFromProperty AttributeRegistry(RegistryEntries >Dependencies > Dependency >MapFrom)

string(enum)

The meta-data property of theattribute specified inMapFromAttribute that is used toevaluate this dependencyexpression.

MapFromValue AttributeRegistry(RegistryEntries >Dependencies > Dependency >MapFrom)


The value that the is used propertyspecified in MapFromProperty thatis used to evaluate thisdependency expression.



MapTerms AttributeRegistry(RegistryEntries >Dependencies > Dependency >MapFrom)

string(enum)

The logical term used to combinetwo or more MapFrom conditionsin this dependency expression.

MapToAttribute AttributeRegistry(RegistryEntries >Dependencies > Dependency)

string The Name of the attribute that isaffected by this dependencyexpression.

MapToProperty AttributeRegistry(RegistryEntries >Dependencies > Dependency)

string(enum)

The meta-data property of theattribute specified inMapFromAttribute that is used toevaluate this dependencyexpression.

MapToValue AttributeRegistry(RegistryEntries >Dependencies > Dependency)


The value that MapToProperty ischanged to if the dependencyexpression evaluates to true.

Mappings PrivilegeRegistry array This property describes themappings between entities and therelevant privileges used to accessthem.

MaxAllowableOperatingValue Thermal (Temperatures) integer Maximum allowable operatingtemperature for this equipment.

Sensor number Maximum allowable operatingvalue for this equipment.

MaxBWAllocPercent NetworkPort(NetDevFuncMaxBWAlloc)

integer The maximum bandwidthallocation percentage allocated tothe corresponding network devicefunction instance.

MaxCompositions ResourceBlock(CompositionStatus)

integer The maximum number ofcompositions in which thisResource Block is capable ofparticipating simultaneously.

MaxConcurrentSessions Manager (CommandShell), Manager (GraphicalConsole), Manager (SerialConsole)

integer Indicates the maximum number ofservice sessions, regardless ofprotocol, this manager is able tosupport.

MaxConsumedWatts Power (PowerControl >PowerMetrics)

number The highest power consumptionlevel that has occured over themeasurement window (the lastIntervalInMin minutes).

MaxDeviceLogins NetworkAdapter (Controllers >ControllerCapabilities > NPIV)

integer The maximum number of N_PortID Virtualization (NPIV) loginsallowed simultaneously from allports on this controller.

MaxExecutionTime Job string The maximum amount of time thejob is allowed to execute.

MaxFrameSize NetworkPort integer The maximum frame sizesupported by the port.

MaxIPv6StaticAddresses EthernetInterface integer This indicates the maximumnumber of Static IPv6 addressesthat can be configured on thisinterface.



MaxImageSizeBytes UpdateService integer The maximum size in bytes of thesoftware update image that thisservice supports.

MaxJobs JobService(ServiceCapabilities)

integer Maximum number of Jobssupported.

MaxLanes PCIeDevice (PCIeInterface), Processor (FPGA >ExternalInterfaces > Ethernet), Processor (FPGA >HostInterface > Ethernet)

integer This is the number of lanessupported by this interface.

MaxLength AttributeRegistry(RegistryEntries > Attributes)

integer The maximum character length ofthe value of an attribute of type'String'.

MaxLevels ServiceRoot(ProtocolFeaturesSupported >ExpandQuery)

integer This indicates the maximumnumber value of the $levelsqualifier in $expand operations.

MaxNumberOfRecords LogService integer The maximum number of logentries this service can have.

MaxPCIeType PCIeDevice (PCIeInterface) string(enum)

The highest version of the PCIespecification supported by thisdevice.

MaxPassphraseCount Memory (SecurityCapabilities) integer Maximum number of passphrasessupported for this Memory.

MaxPasswordLength AccountService integer The maximum password length forthis service.

MaxPortLogins NetworkAdapter (Controllers >ControllerCapabilities > NPIV)

integer The maximum number of N_PortID Virtualization (NPIV) loginsallowed per physical port on thiscontroller.

MaxReadingRange Thermal (Fans) integer Maximum value for Reading.

MetricDefinition number Maximum value for metric reading.

Power (Voltages) number Maximum value for this Voltagesensor.

MaxReadingRangeTemp Thermal (Temperatures) number Maximum value forReadingCelsius.

MaxReports TelemetryService integer The maximum number of metricreports supported by this service.

MaxSpeedGbps Port number The maximum speed of this portas currently configured.

MaxSpeedMHz Processor integer The maximum clock speed of theprocessor.

MaxSpeedMbps Processor (FPGA >ExternalInterfaces > Ethernet), Processor (FPGA >HostInterface > Ethernet)

integer The maximum speed supported bythis interface.

MaxSteps JobService integer Maximum number of Job Steps



(ServiceCapabilities) supported.

MaxTDPMilliWatts Memory array Maximum TDPs in milli Watts.

Memory(PowerManagementPolicy)

integer Maximum TDP in milli watts.

MaxTDPWatts Processor integer The maximum Thermal DesignPower (TDP) in watts.

MaxVirtualFunctions NetworkDeviceFunction integer The number of virtual functions(VFs) that are available for thisNetwork Device Function.

MaxZones Fabric integer The value of this property shallcontain the maximum number ofzones the switch can currentlyconfigure.

MaximumFrequencyHz Power (PowerSupplies >InputRanges)

number The maximum line input frequencyat which this power supply inputrange is effective.

MaximumValue ActionInfo (Parameters) number The maximum supported value ofthis parameter.

MaximumVoltage Power (PowerSupplies >InputRanges)

number The maximum line input voltage atwhich this power supply inputrange is effective.

MediaType Drive string(enum)

The type of media contained inthis drive.

MediaTypes VirtualMedia array This is the media types supportedas virtual media.

MemberId Assembly (Assemblies), Event (Events), Power (PowerControl), Power (PowerSupplies), Power (Voltages), Storage (StorageControllers), Thermal (Fans), Thermal (Temperatures)

string This is the identifier for themember within the collection.

Members various(AccelerationFunctionCollection,

BootOptionCollection ... )

array Contains the members of thiscollection.

[email protected] various(AccelerationFunctionCollection,

BootOptionCollection ... )

string The URI to the resourcecontaining the next set of partialmembers.

Memory ResourceBlock array An array of references to theMemory available in this ResourceBlock.

ComputerSystem object A reference to the collection ofMemory associated with thissystem.

MemoryChunks (InterleaveSets) object Describes a memory device of theinterleave set.



MemoryChunkSizeMiB MemoryChunks integer Size of the memory chunkmeasured in mebibytes (MiB).

MemoryChunks MemoryDomain object A reference to the collection ofMemory Chunks associated withthis Memory Domain.

MemoryClassification Memory (Regions) string(enum)

Classification of memory occupiedby the given memory region.

MemoryController Memory (MemoryLocation) integer Memory controller number inwhich Memory is connected.

MemoryDeviceType Memory string(enum)

Type details of the Memory.

MemoryDomains ComputerSystem object A reference to the collection ofMemory Domains associated withthis system.

MemoryLevel MemoryChunks (InterleaveSets) integer Level of the interleave set formulti-level tiered memory.

MemoryLocation Memory object Memory connection information tosockets and memory controllers.

MemoryMedia Memory array Media of this Memory.

MemoryMirroring ComputerSystem(MemorySummary)

string(enum)

The ability and type of memorymirroring supported by thissystem.

MemorySet MemoryDomain(InterleavableMemorySets)

array This is the collection of memory fora particular interleave set.

MemoryStallCount ProcessorMetrics (CoreMetrics) number The number of stalled cycles dueto memory operations.

MemorySubsystemControllerManufacturerID Memory string The manufacturer ID of thememory subsystem controller ofthis memory module.

MemorySubsystemControllerProductID Memory string The product ID of the memorysubsystem controller of thismemory module.

MemorySummary ComputerSystem object This object describes the centralmemory of the system in generaldetail.

MemoryType Memory string(enum)

The type of Memory.

Processor (ProcessorMemory) string(enum)

The type of memory used by thisprocessor.

MenuName AttributeRegistry(RegistryEntries > Menus)

string The unique name string of thismenu.

MenuPath AttributeRegistry(RegistryEntries > Attributes)

string A path that describes the menuhierarchy of this attribute.


string A path that describes this menuhierarchy relative to other menus.



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.

MessageId EventService(SSEFilterPropertiesSupported)

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.



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.

MetricReportDefinition EventService(SSEFilterPropertiesSupported)

boolean This indicates if theMetricReportDefinition property issupported.

MetricReport object The metric definitions used tocreate a metric report.

MetricReportDefinitionEnabled MetricReportDefinition boolean This indicates whether thisMetricReportDefinition is enabled.

MetricReportDefinitionType MetricReportDefinition string(enum)

Specifies when the metric report isgenerated.

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



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.

MinAssignmentGroupSize NetworkAdapter (Controllers >ControllerCapabilities >VirtualizationOffload >VirtualFunction)

integer The minimum number of VirtualFunctions (VFs) that can beallocated or moved betweenphysical functions for thiscontroller.

MinBWAllocPercent NetworkPort(NetDevFuncMinBWAlloc)

integer The minimum bandwidth allocationpercentage allocated to thecorresponding network devicefunction instance.

MinCollectionInterval TelemetryService string The minimum time intervalbetween collections supported bythis service.



MinConsumedWatts Power (PowerControl >PowerMetrics)

number The lowest power consumptionlevel over the measurementwindow (the last IntervalInMinminutes).

MinLength AttributeRegistry(RegistryEntries > Attributes)

integer The minimum character length ofthe value of an attribute of type'String'.

MinPasswordLength AccountService integer The minimum password length forthis service.

MinReadingRange Thermal (Fans) integer Minimum value for Reading.

MetricDefinition number Minimum value for metric reading.

Power (Voltages) number Minimum value for this Voltagesensor.

MinReadingRangeTemp Thermal (Temperatures) number Minimum value forReadingCelsius.

MinimumFrequencyHz Power (PowerSupplies >InputRanges)

number The minimum line input frequencyat which this power supply inputrange is effective.

MinimumValue ActionInfo (Parameters) number The minimum supported value forthis parameter.

MinimumVoltage Power (PowerSupplies >InputRanges)

number The minimum line input voltage atwhich this power supply inputrange is effective.

Model various(Assembly (Assemblies), Chassis ... )

string Model number for this product ordevice.

ModifyRedundancySet (Action) Manager (Actions) object The ModifyRedundancySetoperation is used to add or removemembers to a redundant group ofmanager.

ModuleManufacturerID Memory string The manufacturer ID of thismemory module.

ModuleProductID Memory string The product ID of this memorymodule.

MutualCHAPSecret NetworkDeviceFunction(iSCSIBoot)

string The CHAP Secret for 2-way CHAPauthentication.

MutualCHAPUsername NetworkDeviceFunction(iSCSIBoot)

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.

NPAR NetworkAdapter (Controllers >ControllerCapabilities)

object NIC Partitioning (NPAR)capabilities for this controller.

NPIV NetworkAdapter (Controllers >ControllerCapabilities)

object N_Port ID Virtualization (NPIV)capabilties for this controller.



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.

NetworkPort(NetDevFuncMaxBWAlloc), NetworkPort(NetDevFuncMinBWAlloc)

object A reference to theNetworkDeviceFunctionassociated with this bandwidthsetting of this Network Port.

NetworkDeviceFunctionCount NetworkAdapter (Controllers >ControllerCapabilities)

integer The maximum number of physicalfunctions available on thiscontroller.

NetworkDeviceFunctions PCIeFunction (Links) array An array of references to theNetwork Device Functions whichthe PCIe device produces.

NetworkAdapter (Controllers >Links)

array An array of references to theNetworkDeviceFunctions



associated with this NetworkController.

NetworkAdapter object A reference to the collection ofNetworkDeviceFunctionsassociated with thisNetworkAdapter.

NetworkInterface object A reference to the collection ofNetworkDeviceFunctionsassociated with thisNetworkInterface.

NetworkInterfaces ResourceBlock array An array of references to theNetwork Interfaces available in thisResource Block.

ComputerSystem object A reference to the collection ofNetwork Interfaces associated withthis system.

NetworkPortCount NetworkAdapter (Controllers >ControllerCapabilities)

integer The number of physical ports onthis controller.

NetworkPortMaxCount NetworkAdapter (Controllers >ControllerCapabilities >VirtualizationOffload >VirtualFunction)

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.

NoLinks ServiceRoot(ProtocolFeaturesSupported >ExpandQuery)

boolean This indicates whether the$expand support of period(expand only entries not in theLinks section) is supported.

NonVolatileSizeMiB Memory integer Total size of the non-volatileportion memory in MiB.

NotifyIPv6Scope ManagerNetworkProtocol(SSDP)

string(enum)

Indicates the scope for the IPv6Notify messages for SSDP.



NotifyMulticastIntervalSeconds ManagerNetworkProtocol(SSDP)

integer Indicates how often the Multicastis done from this service forSSDP.

NotifyTTL ManagerNetworkProtocol(SSDP)

integer Indicates the time to live hop countfor SSDPs Notify messages.

NparCapable NetworkAdapter (Controllers >ControllerCapabilities > NPAR)

boolean Indicates whether or not NICfunction partitioning is supportedby a controller.

NparEnabled NetworkAdapter (Controllers >ControllerCapabilities > NPAR)

boolean When true, NIC functionpartitioning is active on thiscontroller.

NumberDiscoveredRemotePorts NetworkPort integer The number of ports not on thisadapter that this port hasdiscovered.

NumberOfCompositions ResourceBlock(CompositionStatus)

integer The number of compositions inwhich this Resource Block iscurrently participating.

NumericThresholds Triggers object Specifies the thresholds when anumeric metric triggers.

OEMPrivilegesUsed PrivilegeRegistry array Lists the set of OEM Priviligesused in building this mapping.

ObjectDataType ActionInfo (Parameters) string The OData Type of an object-based parameter.

OccupancyBytes ProcessorMetrics (Cache), ProcessorMetrics (CoreMetrics> CoreCache)

integer The total cache level occupancy inbytes.

OccupancyPercent ProcessorMetrics (Cache), ProcessorMetrics (CoreMetrics> CoreCache)

number The total cache occupancypercentage.

Oem various(AccelerationFunction (Links), AccelerationFunction ... )

object The OEM extension object.

OemLogEntryCode LogEntry string If the LogEntryCode type is OEM,this will contain the OEM-specificentry code.

OemPrivileges Role array The OEM privileges that this roleincludes.

OemRecordFormat LogEntry string If the EntryType is Oem, this willcontain more information about therecord format from the Oem.

OemSensorType LogEntry string If the Sensor Type is OEM, thiswill contain the OEM-specificsensor type.

OffsetMiB Memory (Regions) integer Offset with in the Memory thatcorresponds to the starting of thismemory region in mebibytes(MiB).



MemoryChunks (InterleaveSets) integer Offset within the DIMM thatcorresponds to the start of thismemory region, measured inmebibytes (MiB).

OnlyMemberQuery ServiceRoot(ProtocolFeaturesSupported)

boolean This indicates whether the 'only'query parameter is supported.

OperatingMemoryModes Memory array Memory modes supported by theMemory.

OperatingMode EthernetInterface (DHCPv6) string(enum)

Determines the DHCPv6 operatingmode for this interface.

OperatingSpeedMhz Memory integer Operating speed of Memory inMHz or MT/s as appropriate.

OperationMap PrivilegeRegistry (Mappings) object List mapping between HTTPmethod and privilege required forentity.

PrivilegeRegistry (Mappings >PropertyOverrides), PrivilegeRegistry (Mappings >ResourceURIOverrides), PrivilegeRegistry (Mappings >SubordinateOverrides)

object List mapping between HTTPoperation and privilege needed toperform operation.

OperationName Drive (Operations), Volume (Operations)

string The name of the operation.

Operations Drive array The operations currently runningon the Drive.

Volume array The operations currently runningon the Volume.

OptimumIOSizeBytes Volume number The size in bytes of this Volume'soptimum IO size.

Organization Certificate (Issuer), Certificate (Subject)

string The name of the organization ofthe entity.

OrganizationalUnit Certificate (Issuer), Certificate (Subject)

string The name of the unit or division ofthe organization of the entity.

OriginOfCondition Event (Events) object This indicates the resource thatoriginated the condition thatcaused the event to be generated.

LogEntry (Links) object This is the URI of the resource thatcaused the log entry.

OriginResource EventService(SSEFilterPropertiesSupported)

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



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.

PATCH PrivilegeRegistry (Mappings >OperationMap), PrivilegeRegistry (Mappings >PropertyOverrides >OperationMap), PrivilegeRegistry (Mappings >ResourceURIOverrides >OperationMap), PrivilegeRegistry (Mappings >SubordinateOverrides >OperationMap)

array Indicates privilege required forHTTP PATCH operation.

PCIe Processor (FPGA >ExternalInterfaces), Processor (FPGA >HostInterface)

object Describes the PCI-e relatedinformation about this FPGAinterface.

PCIeDevice PCIeSlots (Slots > Links) array An array of references to the PCIeDevices contained in this slot.

Processor (Links) object A reference to the PCIeDeviceassociated with this Processor.

PCIeFunction (Links) object A reference to the PCIeDevice onwhich this function resides.

PCIeDevices ComputerSystem array A reference to a collection of PCIeDevices used by this computersystem.

Chassis (Links) array An array of references to the PCIeDevices located in this Chassis.

NetworkAdapter (Controllers >Links)

array An array of references to thePCIeDevices associated with thisNetwork Controller.

PCIeFunction NetworkDeviceFunction (Links) object A reference to the PCIeFunctionassociated with this NetworkDevice Function.

PCIeFunctions ComputerSystem array A reference to a collection of PCIeFunctions used by this computersystem.

PCIeDevice (Links) array An array of references toPCIeFunctions exposed by thisdevice.

Drive (Links) array An array of references to the PCIe



Functions which the driveproduces.

Storage (StorageControllers >Links)

array An array of references to the PCIeFunctions which the stroagecontroller produces.

Processor (Links) array An array of references to thePCIeFunctions associated withthis Processor.

AccelerationFunction (Links) array An array of references to thePCIeFunctions associated withthis acceleration function.

PCIeInterface PCIeDevice object The PCIe interface details for thisPCIe device.

NetworkAdapter (Controllers), Storage (StorageControllers)

object The PCIe interface details for thiscontroller.

PCIeSlots Chassis object A reference to the PCIe Slotproperties of this chassis.

PCIeType PCIeDevice (PCIeInterface) string(enum)

The version of the PCIespecification in use by this device.

PCIeSlots (Slots) string(enum)

This is the PCIe specificationsupported by this slot.

PCIeVirtualFunctions Processor (FPGA) integer The number of the PCIe VirtualFunctions.

POST PrivilegeRegistry (Mappings >OperationMap), PrivilegeRegistry (Mappings >PropertyOverrides >OperationMap), PrivilegeRegistry (Mappings >ResourceURIOverrides >OperationMap), PrivilegeRegistry (Mappings >SubordinateOverrides >OperationMap)

array Indicates privilege required forHTTP POST operation.

PUT PrivilegeRegistry (Mappings >OperationMap), PrivilegeRegistry (Mappings >PropertyOverrides >OperationMap), PrivilegeRegistry (Mappings >ResourceURIOverrides >OperationMap), PrivilegeRegistry (Mappings >SubordinateOverrides >OperationMap)

array Indicates privilege required forHTTP PUT operation.

Parameters ActionInfo array The parameters associated withthe specified Redfish Action.

Parity SerialInterface string(enum)

The type of parity used by thesender and receiver in order todetect errors over the serialconnection.



PartNumber various(Assembly (Assemblies), Chassis ... )

string Part number for this resource ordevice.

PassphraseCapable Memory (SecurityCapabilities) boolean Memory passphrase set capability.

PassphraseEnabled Memory (Regions) boolean Indicates if the passphrase isenabled for this region.

PassphraseLockLimit Memory (SecurityCapabilities) integer Maximum number of incorrectpassphrase attempts allowedbefore memory is locked.

PassphraseState Memory (Regions) boolean State of the passphrase for thisregion.

Password VirtualMedia string The password to be used whenaccessing the URI specified by theImage parameter. This property isnull on a GET.

Session string This property is used in a POST tospecify a password when creatinga new session. This property isnull on a GET.

AccountService (ActiveDirectory> Authentication), AccountService (LDAP >Authentication), ExternalAccountProvider(Authentication)

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.

PciId Endpoint object The PCI ID of the endpoint.

PeakPowerBudgetMilliWatts Memory(PowerManagementPolicy)

integer Peak power budget in milli watts.

PeakReading Sensor number The peak reading value for thissensor.



PeakReadingTime Sensor string The time at which the PeakReading value occurred.

PercentComplete Task integer The completion percentage of thisTask.

Job integer The completion percentage of thisjob.

PercentageComplete Drive (Operations) integer The percentage of the operationthat has been completed.

Volume (Operations) number The percentage of the operationthat has been completed.

PerformanceDegraded MemoryMetrics (HealthData) boolean Performance degraded modestatus.

PermanentMACAddress EthernetInterface string This is the permanent MACaddress assigned to this interface(port).

NetworkDeviceFunction(Ethernet)

string This is the permanent MACaddress assigned to this networkdevice function (physical function).

PermanentWWNN NetworkDeviceFunction(FibreChannel)

string This is the permanent WWNNaddress assigned to this networkdevice function (physical function).

PermanentWWPN NetworkDeviceFunction(FibreChannel)

string This is the permanent WWPNaddress assigned to this networkdevice function (physical function).

PersistentCacheSizeMiB Storage (StorageControllers >CacheSummary)

integer The portion of the cache memorythat is persistent, measured inMiB.

PersistentRegionNumberLimit Memory integer Total number of persistent regionsthis Memory can support.

PersistentRegionSizeLimitMiB Memory integer Total size of persistent regions inmebibytes (MiB).

PersistentRegionSizeMaxMiB Memory integer Maximum size of a singlepersistent region in mebibytes(MiB).

PhysicalContext Thermal (Fans) string(enum)

Describes the area or deviceassociated with this fan.

Assembly (Assemblies) string(enum)

Describes the area or device towhich this assembly data applies.

Sensor string(enum)

Describes the area or device towhich this sensor measurementapplies.

Thermal (Temperatures) string(enum)

Describes the area or device towhich this temperaturemeasurement applies.

Power (Voltages) string(enum)

Describes the area or device towhich this voltage measurementapplies.



Power (PowerControl) string(enum)

Describes the area, device, or setof devices to which this powercontrol applies.

MetricDefinition string(enum)

Specifies the physical context ofthe metric.

PhysicalLocation Drive object The Location of the drive.

PhysicalPortAssignment NetworkDeviceFunction (Links),

NetworkDeviceFunction

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.



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.



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.

Precedence EthernetInterface(IPv6AddressPolicyTable)

integer The IPv6 Precedence (as definedin RFC 6724 section 2.1.

Precision MetricDefinition integer Number of significant digits in themetric reading.

Sensor number Number of significant digits in theReading.

PredictedMediaLifeLeftPercent Drive, MemoryMetrics (HealthData)

number The percentage of reads andwrites that are predicted to still beavailable for the media.

Prefix EthernetInterface(IPv6AddressPolicyTable)

string The IPv6 Address Prefix (asdefined in RFC 6724 section 2.1).

PrimaryDNS NetworkDeviceFunction(iSCSIBoot)

string The IPv6 or IPv4 address of theprimary DNS server for the iSCSIboot initiator.

PrimaryLUN NetworkDeviceFunction(iSCSIBoot)

integer The logical unit number (LUN) forthe primary iSCSI boot target.

PrimaryTargetIPAddress NetworkDeviceFunction(iSCSIBoot)

string The IP address (IPv6 or IPv4) forthe primary iSCSI boot target.

PrimaryTargetName NetworkDeviceFunction(iSCSIBoot)

string The name of the iSCSI primaryboot target.

PrimaryTargetTCPPort NetworkDeviceFunction(iSCSIBoot)

integer The TCP port for the primaryiSCSI boot target.

PrimaryVLANEnable NetworkDeviceFunction(iSCSIBoot)

boolean This indicates if the primary VLANis enabled.

PrimaryVLANId NetworkDeviceFunction(iSCSIBoot)

integer The 802.1q VLAN ID to use foriSCSI boot from the primary target.

Privilege various(PrivilegeRegistry (Mappings >OperationMap > DELETE),

array Lists the privileges that areallowed to perform the given typeof HTTP operation on the entity



PrivilegeRegistry (Mappings >OperationMap > GET) ... )

type.

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.



Protocol Drive string(enum)

The protocol this drive is using tocommunicate to the storagecontroller.

EventDestination string(enum)

The protocol type of the eventconnection.

ProtocolEnabled various(ManagerNetworkProtocol(DHCP), ManagerNetworkProtocol(DHCPv6) ... )

boolean Indicates if the protocol is enabledor disabled.

ProtocolFeaturesSupported ServiceRoot object Contains information aboutprotocol features supported by theservice.

PublicationUri JsonSchemaFile (Location), MessageRegistryFile (Location)

string Link to publicly available(canonical) URI for schema.

RDP ManagerNetworkProtocol object Settings for this Manager'sRemote Desktop Protocol support.

RFB ManagerNetworkProtocol object Settings for this Manager'sRemote Frame Buffer protocolsupport, which can be used tosupport VNC.

RankCount Memory integer Number of ranks available in theMemory.

ReactiveVAR Sensor number The square root of the differenceterm of squared ApparentVA andsquared Power (Reading) for acircuit, expressed in VAR units.

ReadOnly AttributeRegistry(RegistryEntries > Attributes)

boolean The read-only state of thisattribute.


boolean The read-only state of this menu.

Reading Thermal (Fans) integer Current fan speed.

Sensor number The present value for this Sensor.

Sensor (Thresholds >LowerCaution), Sensor (Thresholds >LowerCritical), Sensor (Thresholds >LowerFatal), Sensor (Thresholds >UpperCaution), Sensor (Thresholds >UpperCritical), Sensor (Thresholds >UpperFatal), Triggers (NumericThresholds >LowerCritical), Triggers (NumericThresholds >LowerWarning), Triggers (NumericThresholds >UpperCritical),

number The threshold value.



Triggers (NumericThresholds >UpperWarning)

ReadingCelsius Thermal (Temperatures) number Temperature.

ReadingRangeMax Sensor number The maximum value of Readingpossible for this Sensor.

ReadingRangeMin Sensor number The minimum value of Readingpossible for this Sensor.

ReadingType Sensor string(enum)

The kind of sensor beingrepresented.

ReadingUnits Sensor string Units in which the reading andthresholds are measured.

Thermal (Fans) string(enum)

Units in which the reading andthresholds are measured.

ReadingVolts Power (Voltages) number The present reading of the voltagesensor.

RebuildRatePercent Storage (StorageControllers >ControllerRates)

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.



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.

RegistryPrefix EventService(SSEFilterPropertiesSupported)

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.



SoftwareInventory, Thermal (Fans), Thermal (Temperatures)

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.

RemoteGroup AccountService (ActiveDirectory> RemoteRoleMapping), AccountService (LDAP >RemoteRoleMapping), ExternalAccountProvider(RemoteRoleMapping)

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.

RemoteRoleMapping AccountService(ActiveDirectory), AccountService (LDAP), ExternalAccountProvider

array This property contains a collectionof the mapping rules to convert theexternal account providersaccount information to the localRedfish Role.

RemoteUser AccountService (ActiveDirectory> RemoteRoleMapping), AccountService (LDAP >RemoteRoleMapping), ExternalAccountProvider(RemoteRoleMapping)

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.

ReportActionsEnum MetricReportDefinition(ReportActions)

string(enum)

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



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.

ResetRequired AttributeRegistry(RegistryEntries > Attributes)

boolean True if changing the value of thisattribute requires a system ordevice reset in order to take effect.

ResetSettingsToDefault (Action) NetworkAdapter (Actions) object This action is to clear the settingsback to factory defaults.

ResetStatistics (Action) Sensor (Actions) object This action is used to resetstatistics related to this sensor.

ResidencyPercent ProcessorMetrics (CoreMetrics> CStateResidency)

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



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.

ResourceType EventService(SSEFilterPropertiesSupported)

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.

ResourceURIOverrides PrivilegeRegistry (Mappings) array Indicates privilege overrides ofResource URI.

ResourceZones CompositionService object The resource zones available onthe service.

ResultMetric MetricDefinition(CalculationParameters)

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).

RouterAdvertisementEnabled NetworkDeviceFunction boolean Whether IPv6 router



(iSCSIBoot) advertisement is enabled for theiSCSI boot target.

SKU Assembly (Assemblies), Chassis, ComputerSystem, Drive, NetworkAdapter, PCIeDevice, Storage (StorageControllers), Switch

string SKU of the product or device.

SNMP ManagerNetworkProtocol object Settings for this Manager's SNMPsupport.

SRIOV NetworkAdapter (Controllers >ControllerCapabilities >VirtualizationOffload)

object Single-Root Input/OutputVirtualization (SR-IOV)capabilities.

SRIOVVEPACapable NetworkAdapter (Controllers >ControllerCapabilities >VirtualizationOffload > SRIOV)

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.

ScalarIncrement AttributeRegistry(RegistryEntries > Attributes)

integer The amount to increment ordecrement the value of an attributeof type 'Integer' each time a userrequests a value change.

Schedule Job, MetricReportDefinition

object Specifies the schedule for this jobor metric report.

Scheduling JobService(ServiceCapabilities)

boolean Indicates whether scheduling ofJobs is supported.

Schema JsonSchemaFile string The @odata.type name thisschema describes.

SearchSettings AccountService (ActiveDirectory> LDAPService), AccountService (LDAP >LDAPService), ExternalAccountProvider(LDAPService)

object This property contains the settingsneeded to search an externalLDAP service.

SecondaryDNS NetworkDeviceFunction(iSCSIBoot)

string The IPv6 or IPv4 address of thesecondary DNS server for theiSCSI boot initiator.

SecondaryLUN NetworkDeviceFunction(iSCSIBoot)

integer The logical unit number (LUN) forthe secondary iSCSI boot target.



SecondaryTargetIPAddress NetworkDeviceFunction(iSCSIBoot)

string The IP address (IPv6 or IPv4) forthe secondary iSCSI boot target.

SecondaryTargetName NetworkDeviceFunction(iSCSIBoot)

string The name of the iSCSI secondaryboot target.

SecondaryTargetTCPPort NetworkDeviceFunction(iSCSIBoot)

integer The TCP port for the secondaryiSCSI boot target.

SecondaryVLANEnable NetworkDeviceFunction(iSCSIBoot)

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.

SelectQuery ServiceRoot(ProtocolFeaturesSupported)

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



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.

SerialNumber various(Assembly (Assemblies), Chassis ... )

string The serial number of this device.

ServerSentEventUri EventService string Link to a URI for receiving SeverSent Event representations of theevents generated by this service.

ServiceAddresses AccountService(ActiveDirectory), AccountService (LDAP), ExternalAccountProvider

array This property contains theaddresses of the user accountproviders this resource references.The format of this field depends onthe Type.

ServiceCapabilities JobService object This object describes thesupported capabilities of this JobService implementation.

ServiceEnabled Manager (CommandShell), Manager (GraphicalConsole), Manager (SerialConsole)

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.



AccountService(ActiveDirectory), AccountService (LDAP), CompositionService, EventService, ExternalAccountProvider, JobService, LogService, TaskService, UpdateService

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



(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.

SourceMetric MetricDefinition(CalculationParameters)

string The metric property used as theinput into the calculation.

SpareBlock MemoryMetrics (HealthData >AlarmTrips)

boolean Spare block capacity crossingalarm trip detected status.

SpareDeviceCount Memory integer Number of unused spare devicesavailable in the Memory.

SparePartNumber Assembly (Assemblies) string Spare part number of theAssembly.

Thermal (Fans) string The spare part number for thisFan.

Power (PowerSupplies) string The spare part number for thisPower Supply.

SpeedGbps Storage (StorageControllers) number The maximum speed of thestorage controller's deviceinterface.

SpeedMHz Processor (ProcessorMemory) integer The operating speed of the



memory in MHz.

SpeedMbps EthernetInterface integer This is the current speed in Mbpsof this interface.

StartTime Job string The date-time stamp that the jobwas started or is scheduled tostart.

Task string The date-time stamp that the taskwas last started.

State Certificate (Issuer), Certificate (Subject)

string The state, province, or region ofthe organization of the entity.

StatelessAddressAutoConfig EthernetInterface object Stateless Address AutomaticConfiguration (SLAAC)parameters for this interface.

StaticNameServers EthernetInterface array A statically defined set of DNSserver IP addresses (both IPv4and IPv6).

Status various(AccelerationFunction, AccountService ... )

object This object describes the state andhealth of the resource and itschildren.

StatusIndicator Drive string(enum)

The state of the status indicator,used to communicate statusinformation about this drive.

Step Processor (ProcessorId) string The Step value for this processor.

StepOrder Job array This represents the serializedexecution order of the Job Steps.

Steps Job object A link to a collection of Steps forthis Job.

StopBits SerialInterface string(enum)

The period of time before the nextstart bit is transmitted.

Storage ResourceBlock array An array of references to theStorage available in this ResourceBlock.

Chassis (Links) array An array of references to thestorage subsystems connected toor inside this Chassis.

ComputerSystem object A reference to the collection ofstorage devices associated withthis system.

StorageControllers PCIeFunction (Links) array An array of references to thestorage controllers which the PCIedevice produces.

Storage array The set of storage controllersrepresented by this resource.

StorageServices Storage (StorageControllers >Links)

array An array of references to theStorageServices that connect tothis controller.



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.

SubordinateOverrides PrivilegeRegistry (Mappings) array Indicates privilege overrides ofsubordinate resource.

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.

SubsystemDeviceID Memory string Subsystem Device ID.

SubsystemId Endpoint (ConnectedEntities >EntityPciId), Endpoint (PciId), PCIeFunction

string The Subsystem ID of this PCIefunction.

SubsystemVendorID Memory string SubSystem Vendor ID.

SubsystemVendorId Endpoint (ConnectedEntities >EntityPciId), Endpoint (PciId), PCIeFunction

string The Subsystem Vendor ID of thisPCIe function.

SupplyingComputerSystems ComputerSystem (Links) array An array of references toComputerSystems that contribute,



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



Power (TDP) in watts.

TargetInfoViaDHCP NetworkDeviceFunction(iSCSIBoot)

boolean Whether the iSCSI boot targetname, LUN, IP address, andnetmask should be obtained fromDHCP.

TargetUri Job (Payload) string The URI of the target for this job.

Task (Payload) string The URI of the target for this task.

Targets PrivilegeRegistry (Mappings >PropertyOverrides), PrivilegeRegistry (Mappings >ResourceURIOverrides), PrivilegeRegistry (Mappings >SubordinateOverrides)

array Indicates the URI or Entity.

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



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.

Token AccountService (ActiveDirectory> Authentication), AccountService (LDAP >Authentication), ExternalAccountProvider(Authentication)

string This property is used with aPATCH or PUT to write the tokenfor the account. This property isnull on a GET.

TotalCacheSizeMiB Storage (StorageControllers >CacheSummary)

integer The total configured cachememory, measured in MiB.

TotalCores Processor integer The total number of corescontained in this processor.

TotalEnabledCores Processor integer The total number of enabled corescontained in this processor.

TotalSwitchWidth Switch integer The total number of lanes, phys, orother physical transport links thatthis switch contains.

TotalSystemMemoryGiB ComputerSystem(MemorySummary)

number The total configured operatingsystem-accessible memory(RAM), measured in GiB.

TotalSystemPersistentMemoryGiB ComputerSystem(MemorySummary)

number The total configured, system-accessible persistent memory,measured in GiB.

TotalThreads Processor integer The total number of executionthreads supported by thisprocessor.

TransferMethod VirtualMedia string(enum)

Transfer method to use with thegiven Image.

TransferProtocolType VirtualMedia string(enum)

Network protocol to use with theimage.

TransformationRatePercent Storage (StorageControllers >ControllerRates)

integer The percentage of controllerresources used for transformingvolumes from one configuration toanother.

TransportProtocol Endpoint (IPTransportDetails) string(enum)

The protocol used by theconnection entity.

TriggerActionEnum Triggers (TriggerActions) string(enum)

Specifies the actions to performwhen a trigger occurs.

TriggerActions Triggers array This property specifies the actionsto perform when the triggeroccurs.



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(enum)

The type of the attribute.

AttributeRegistry(RegistryEntries >Dependencies)

string(enum)

The type of the dependencystructure.

UUID AccelerationFunction, Chassis, ComputerSystem, Manager, Processor (FPGA >ReconfigurationSlots), Processor, ServiceRoot

string The Universal Unique Identifier(UUID) for this device.

UefiDevicePath EthernetInterface string The UEFI device path for thisinterface.


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.

UefiKeywordName AttributeRegistry(RegistryEntries > Attributes)

string The UEFI KeywordString of theattribute.

UefiNamespaceId AttributeRegistry(RegistryEntries > Attributes)

string The UEFI NamespaceId of theattribute.

UefiTargetBootSourceOverride ComputerSystem (Boot) string This property is the UEFI DevicePath of the device to boot fromwhen BootSourceOverrideTargetis UefiTarget.

UncorrectableECCError MemoryMetrics (HealthData >AlarmTrips)

boolean Uncorrectable data error thresholdcrossing alarm trip detectedstatus.

UnhaltedCycles ProcessorMetrics (CoreMetrics) number The unhalted cycles count of thiscore.



Units MetricDefinition string The units of measure for thismetric.

UnlockUnit (Action) Memory (Actions) object This defines the action forunlocking given regions.

UpdateService ServiceRoot object This is a link to the UpdateService.

Updateable SoftwareInventory boolean Indicates whether this softwarecan be updated by the updateservice.

UpperBound AttributeRegistry(RegistryEntries > Attributes)

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.


number Above normal range but not yetfatal.

UpperThresholdFatal Thermal (Fans) integer Above normal range and is fatal.


number Above normal range and is fatal.

UpperThresholdNonCritical Thermal (Fans) integer Above normal range.


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.



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.

Username AccountService (ActiveDirectory> Authentication), AccountService (LDAP >Authentication), ExternalAccountProvider(Authentication)

string This property contains the username for the account service.

UsernameAttribute AccountService (ActiveDirectory> LDAPService >SearchSettings), AccountService (LDAP >LDAPService >SearchSettings), ExternalAccountProvider(LDAPService >SearchSettings)

string The attribute name that containsthe Username on the user LDAPentry.

VLAN EthernetInterface, NetworkDeviceFunction(Ethernet)

object If this Network Interface supportsmore than one VLAN, this propertyis not present. VLANs collectionsappear in the Link section of thisresource.

VLANEnable VLanNetworkInterface boolean This indicates if this VLAN isenabled.

VLANId VLanNetworkInterface integer This indicates the VLAN identifierfor this VLAN.

VLANs EthernetInterface, NetworkDeviceFunction(Ethernet)

object This is a reference to a collectionof VLANs and is only used if theinterface supports more than oneVLANs.

ValidNotAfter Certificate string The date when the certificate is no



longer valid.

ValidNotBefore Certificate string The date when the certificatebecomes valid.

Value AttributeRegistry(RegistryEntries > Attributes)

array The array containing possiblevalues for attributes of type'Enumeration'.

Triggers (DiscreteTriggers) string The value of the discrete metricthat constitutes a triggeroccurance.

ValueDisplayName AttributeRegistry(RegistryEntries > Attributes >Value)

string A user-readable display string ofthe value of the attribute in thedefined 'Language'.

ValueExpression AttributeRegistry(RegistryEntries > Attributes)

string A regular expression that is usedto validate the value of theattribute. This is only applicable toattributes of type 'String' or'Integer'.

ValueName AttributeRegistry(RegistryEntries > Attributes >Value)

string The unique value name of theattribute.

Values MetricDefinition (Wildcards), MetricReportDefinition(Wildcards), Triggers (Wildcards)

array An array of values to substitute forthe wildcard.

Vendor ServiceRoot string The vendor or manufacturerassociated with this Redfishservice.

Assembly (Assemblies) string Vendor of the Assembly.

VendorID Memory string Vendor ID.

VendorId Endpoint (ConnectedEntities >EntityPciId), Endpoint (PciId), PCIeFunction

string The Vendor ID of this PCIefunction.

NetworkPort string The Vendor Identification for thisport.

Processor (ProcessorId) string The Vendor Identification for thisprocessor.

Version SoftwareInventory string A string representing the versionof this software.

AccelerationFunction string The acceleration function version.

Assembly (Assemblies) string Version of the Assembly.

VirtualFunction NetworkAdapter (Controllers >ControllerCapabilities >VirtualizationOffload)

object The virtual function of thecontroller.

VirtualFunctionsEnabled NetworkDeviceFunction boolean Whether Single Root I/OVirtualization (SR-IOV) VirualFunctions (VFs) are enabled for



this Network Device Function.

VirtualMedia ManagerNetworkProtocol object Settings for this Manager's VirtualMedia support.

Manager object This is a reference to the VirtualMedia services for this particularmanager.

VirtualizationOffload NetworkAdapter (Controllers >ControllerCapabilities)

object Virtualization offload for thiscontroller.

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).

WWPN NetworkDeviceFunction(FibreChannel > BootTargets)

string The World-Wide Port Name toboot from.

NetworkDeviceFunction(FibreChannel)

string This is the currently configuredWWPN address of the networkdevice function (physical function).

WakeOnLANEnabled NetworkPort boolean Whether Wake on LAN (WoL) isenabled for this network port.

WarningAction ComputerSystem(HostWatchdogTimer)

string(enum)

This property indicates the actionto perform when the WatchdogTimer is close (typically 3-10seconds) to reaching its timeout



value.

WarningText AttributeRegistry(RegistryEntries > Attributes)

string The warning text for changing theattribute.

WeightKg Chassis number The weight of the chassis.

Width Port integer The number of lanes, phys, orother physical transport links thatthis port contains.

WidthMm Chassis number The width of the chassis.

Wildcards MetricDefinition, MetricReportDefinition, Triggers

array A list of wildcards and theirsubstitution values to be applied tothe entries in the MetricPropertiesarray property.

WriteOnly AttributeRegistry(RegistryEntries > Attributes)

boolean Defines whether this attribute iswrite-only. Such attributes revertback to their initial value aftersettings are applied.

WriteProtected VirtualMedia boolean Indicates the media is writeprotected.

Zones ResourceBlock (Links) array An array of references to theZones in which this ResourceBlock is bound.

Fabric object A collection of references to thezones contained in this fabric.

iSCSIBoot NetworkDeviceFunction object iSCSI Boot.



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



http://www.github.com/DMTF/Redfish-Tools

Redfish Property Guide - DMTF · Property Name The name of the JSON property as it will appear...

Documents

Transcript of Redfish Property Guide - DMTF · Property Name The name of the JSON property as it will appear...