Document Identifier: DSP2046
Date: 2021-01-18
Version: 2020.4
Document Class: Informative
Document Status: Published
Document Language: en-US
Copyright Notice
Copyright © 2016-2021 DMTF. All rights reserved.
DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems management and interoperability. Members and non-members may reproduce DMTF specifications and documents, provided that correct attribution is given. As DMTF specifications may be revised from time to time, the particular version and release date should always be noted.
Implementation of certain elements of this standard or proposed standard may be subject to third party patent rights, including provisional patent rights (herein "patent rights"). DMTF makes no representations to users of the standard as to the existence of such rights, and is not responsible to recognize, disclose, or identify any or all such third party patent right, owners or claimants, nor for any incomplete or inaccurate identification or disclosure of such rights, owners or claimants. DMTF shall have no liability to any party, in any manner or circumstance, under any legal theory whatsoever, for failure to recognize, disclose, or identify any such third party patent rights, or for such party's reliance on the standard or incorporation thereof in its product, protocols or testing procedures. DMTF shall have no liability to any party implementing such standard, whether such implementation is foreseeable or not, nor to any patent owner or claimant, and shall have no liability or responsibility for costs or losses incurred if a standard is withdrawn or modified after publication, and shall be indemnified and held harmless by any party implementing the standard from any and all claims of infringement by a patent owner for such implementations.
For information about patents held by third-parties that have notified the DMTF that, in their opinion, such patent may relate to or impact implementations of DMTF standards, visit http://www.dmtf.org/about/policies/disclosures.php.
This document's normative language is English. Translation into other languages is permitted.
The Redfish standard comprises a set of specifications maintained by the Redfish Forum, a working group within the DMTF. The standard defines a protocol that uses RESTful interfaces to provide access to data and operations associated with the management of systems and networks. One of the strengths of the Redfish protocol is that it works with a wide range of servers: from stand-alone servers to rack-mount and bladed environments to large-scale data centers and cloud environments.
The Redfish standard addresses several key issues for infrastructures that require scalability. Large infrastructures often consist of many simple servers of different makes and types. This hyper-scale usage model requires a new approach to systems management. The Redfish protocol addresses these needs by providing a standard protocol based on out-of-band systems management.
With these goals in mind, the Redfish protocol was designed as an open-industry standard to meet scalability requirements in multi-vendor deployments. It easily integrates with commonly used tools, using RESTful interfaces to perform operations and using JSON and OData formats for data payloads.
This document is useful to people who want to understand how to use the Redfish API. This includes application developers who want to create client-side software to communicate with a Redfish Service, and other consumers of the API.
Feedback on all Redfish specifications and documents is encouraged. Feedback can be directed to the DMTF and the Redfish Forum by the following means:
These web sites provide more information about the Redfish standard:
Every Redfish response consists of a JSON payload containing properties that are strictly defined by a schema for that Resource. The schema defining a particular Resource can be determined from the value of the "@odata.type" property returned in every Redfish response. This guide details the definitions for every Redfish standard schema.
Each schema section contains:
The property-level details include:
Column | Purpose |
---|---|
Property name | The case-sensitive name of the JSON property as it appears in the JSON payload. Lists the schema version in parentheses when properties were added to or deprecated in the schema after the initial v1.0.0 release. |
Type | The JSON data types for the property, which can include boolean, number, string, or object. The Number types that use units specify the units. |
Attributes | Designates whether:
|
Description | The normative description of the property, as copied directly from the schema |
The Redfish Specification v1.6.0 added mandatory OpenAPI Specification v3.0 support. As part of this support, the URIs for every Redfish Resource are defined to appear at known, fixed locations. Resource Collections also appear at fixed locations, with the members of each collection appearing at URIs constructed by using a fixed path structure, with appropriate path segments equal to the value of Id properties of members along the path.
To determine support for v1.6.0 and OpenAPI, compare the RedfishVersion property value in the Service root (\redfish\v1\
). Services that report a 1.6.0
or greater value, such as 1.6.1
or 1.7.0
, adhere to the URI definitions shown.
The URI listings do not apply to Redfish Services that report support of versions earlier than Specification v1.6.0. For those Services, clients must use the API's hypermedia features to discover links from the Service root to each Resource. While Services typically match the URIs listed in this documents for many of their Resources, this is not guaranteed and results in errors.
The following properties are defined for inclusion in every Redfish schema, and therefore may be encountered in any response payload. They are documented in this guide to avoid repetition in the Reference Guide property tables. Note that several of these properties are payload annotations, but appear in this guide because they are required for all Redfish Resources.
string (URI) | The URL to a metadata document with a fragment that describes the data, which is typically rooted at the top-level singleton or collection. Technically, the metadata document has to only define, or reference, any of the types that it directly uses, and different payloads could reference different metadata documents. However, because this property provides a root URL for resolving a relative reference, such as @odata.id , the API returns the canonical metadata document. | ||
string | The current ETag for the Resource. | ||
string (URI) | The unique ID for the Resource. | ||
string | The type of a resource. | ||
string | The human-readable description for the Resource. | ||
string | The ID that uniquely identifies the Resource within the collection that contains it. This value is unique within a collection. | ||
string | The human-readable moniker for a Resource. The type is string. The value is NOT necessarily unique across Resource instances within a collection. | ||
object | The manufacturer- or provider-specific extension moniker that divides the Oem object into sections. |
In addition, the following properties are frequently defined in Redfish schemas. Their definition and usage is the same throughout the Redfish data model.
object | The Redfish actions available for this Resource. | ||
object | The links associated with the Resource, as defined by that Resource's schema definition. All associated reference properties defined for a Resource are nested under the Links property. Find all directly referenced, or subordinate, Resource properties from the root of the Resource. | ||
array | An array of links. Each link points to a Resource or part of a Resource as defined by that Resource's schema. This representation is not intended to be a strong linking methodology like other references. Instead, it shows a relationship between elements or subelements in disparate parts of the service. For example, fans may be in one area of the system and processors in another. The relationship between the two might not be obvious. This property can show that one is related to the other. In this example, it might indicate that a specific fan cools a specific processor. | ||
} ] | string (URI) | The unique identifier for a resource. |
Payload annotations enable a Service to provide additional information about a property or object. Redfish limits usage of these annotations to OData core terms, Redfish extensions, or Redfish messages.
A payload annotation for a single property takes the form of an additional property:
Property@Schema.Term
where
Variable | Description |
---|---|
Property |
The JSON property being annotated. |
Schema |
The schema file that contains the definition for the annotation. |
Term |
The name of the annotation. |
object | The additional information for a set of message structures for a property. These messages can be useful when a property is null due to an error condition and the service wants to convey why the property is null . | ||
integer | The number of items in a collection. | ||
array (string) | The string values that a service accepts for a property or action parameter. |
In this example, the ResetType property is annotated with the AllowableValues term, which the Redfish schema defines. Redfish is an alias for RedfishExtensions. This code indicates to the client that the Service supports the On
and ForceOff
values for ResetType.
{ "ResetType@Redfish.AllowableValues": [ "On", "ForceOff" ] }
A payload annotation for an entire Resource or a JSON object takes the @Schema.Term
form, where Namespace
is the schema file where the definition is found and Term
is the name of the Annotation. These payload annotations are used to provide further information about the object itself.
string (URI) | The URI to an ActionInfo Resource, which describes the parameters that this Action instance supports. | ||
object | The reference to the Resource that represents the POST capabilities of a collection. For property details, see CollectionCapabilities. | ||
object | The maintenance window configuration that defines when to apply settings or operations to a Resource. For property details, see MaintenanceWindow. | ||
string (enum) | The client's requested apply time to complete a create, delete, or action operation. For the possible property values, see @Redfish.OperationApplyTime in Property details. | ||
object | An indication of whether a client can request a specific apply time for a create, delete, or action operation for a Resource through the OperationApplyTime term. For property details, see OperationApplyTimeSupport. | ||
object | The reference to the Resource that represents the settings to apply to this object. For property details, see Settings. | ||
object | The configuration settings that define when to apply the settings to a Resource. For property details, see PreferredApplyTime. |
The client's requested apply time to complete a create, delete, or action operation.
string | Description |
---|---|
AtMaintenanceWindowStart | The requested operation is applied within the administrator-specified maintenance window. |
Immediate | The requested operation is applied immediately. |
InMaintenanceWindowOnReset | The requested operation is applied after a reset but within the administrator-specified maintenance window. |
OnReset | The requested operation is applied on a reset. |
OnStartUpdateRequest | The requested operation is applied when the StartUpdate action of the update service is invoked. |
This example annotates the object with the Redfish schema-defined ActionInfo term. Redfish is an alias for RedfishExtensions. This term indicates that the client can find more information about the #ComputerSystem.Reset
action at the /redfish/v1/Systems/1/ResetActionInfo
URI:
{ "#ComputerSystem.Reset": { "target": "/redfish/v1/Systems/1/Actions/ComputerSystem.Reset", "@Redfish.ActionInfo": "/redfish/v1/Systems/1/ResetActionInfo" } }
Redfish schemas frequently define the following JSON objects. Like the individual common properties listed above, these objects share a common definition that is shown here to avoid repetition in the Reference Guide property tables.
The Actions object contains descriptions of the defined and available actions for this Resource.
object | A single Redfish action. | ||
| string | The URI for an ActionInfo Resource that describes this action. | |
} | string | The target URI for the POST operation to invoke the action. |
This is the schema definition for the Capacity of a device. It represents the properties for capacity for any data store.
object | The capacity information relating to the user data. | ||
| integer (bytes) | The number of bytes currently allocated by the storage system in this data store for this data type. | |
| integer (bytes) | The number of bytes consumed in this data store for this data type. | |
| integer (bytes) | The number of bytes the storage system guarantees can be allocated in this data store for this data type. | |
} | integer (bytes) | The maximum number of bytes that can be allocated in this data store for this data type. | |
boolean | Marks that the capacity is not necessarily fully allocated. | ||
object | The capacity information relating to metadata. | ||
| integer (bytes) | The number of bytes currently allocated by the storage system in this data store for this data type. | |
| integer (bytes) | The number of bytes consumed in this data store for this data type. | |
| integer (bytes) | The number of bytes the storage system guarantees can be allocated in this data store for this data type. | |
} | integer (bytes) | The maximum number of bytes that can be allocated in this data store for this data type. | |
object | The capacity information relating to snapshot or backup data. | ||
| integer (bytes) | The number of bytes currently allocated by the storage system in this data store for this data type. | |
| integer (bytes) | The number of bytes consumed in this data store for this data type. | |
| integer (bytes) | The number of bytes the storage system guarantees can be allocated in this data store for this data type. | |
} | integer (bytes) | The maximum number of bytes that can be allocated in this data store for this data type. |
Any additional identifiers for a resource.
string | The world-wide, persistent name of the resource. | ||
string (enum) | The format of the durable name property. For the possible property values, see DurableNameFormat in Property details. |
The format of the durable name property.
string | Description |
---|---|
EUI | The IEEE-defined 64-bit Extended Unique Identifier (EUI). |
FC_WWN | The Fibre Channel (FC) World Wide Name (WWN). |
iQN | The iSCSI Qualified Name (iQN). |
NAA | The Name Address Authority (NAA) format. |
NGUID (v1.10+) | The Namespace Globally Unique Identifier (NGUID). |
NQN (v1.6+) | The NVMe Qualified Name (NQN). |
NSID (v1.6+) | The NVM Namespace Identifier (NSID). |
UUID | The Universally Unique Identifier (UUID). |
The properties of this type represent IO statistics.
integer ({tot}) | Count of non IO requests. | ||
string | The time that the resource is busy processing write requests. | ||
integer ({tot}) | Count of read IO requests satisfied from memory. | ||
integer (KiBy) | Number of kibibytes read. | ||
integer ({tot}) | Count of read IO requests. | ||
string | The time that the resource is busy processing read requests. | ||
integer ({tot}) | Count of write IO requests coalesced into memory. | ||
integer (KiBy) | Number of kibibytes written. | ||
integer ({tot}) | Count of write IO requests. | ||
string | The time that the resource is busy processing write requests. |
This type describes an IPv4 address.
string | The IPv4 address. | ||
string (enum) | This indicates how the address was determined. For the possible property values, see AddressOrigin in Property details. | ||
string | The IPv4 gateway for this address. | ||
object | See the Oem object definition in the Common properties section. | ||
string | The IPv4 subnet mask. |
This indicates how the address was determined.
string | Description |
---|---|
BOOTP | A BOOTP service-provided address. |
DHCP | A DHCPv4 service-provided address. |
IPv4LinkLocal | The address is valid for only this network segment, or link. |
Static | A user-configured static address. |
This type describes an IPv6 address.
string | The IPv6 address. | ||
string (enum) | This indicates how the address was determined. For the possible property values, see AddressOrigin in Property details. | ||
string (enum) | The current RFC4862-defined state of this address. For the possible property values, see AddressState in Property details. | ||
object | See the Oem object definition in the Common properties section. | ||
integer | The IPv6 address prefix Length. |
This indicates how the address was determined.
string | Description |
---|---|
DHCPv6 | A DHCPv6 service-provided address. |
LinkLocal | The address is valid for only this network segment, or link. |
SLAAC | A stateless autoconfiguration (SLAAC) service-provided address. |
Static | A static user-configured address. |
The current RFC4862-defined state of this address.
string | Description |
---|---|
Deprecated | This address is currently within its valid lifetime but is now outside its RFC4862-defined preferred lifetime. |
Failed | This address has failed Duplicate Address Detection (DAD) testing, as defined in RFC4862, section 5.4, and is not currently in use. |
Preferred | This address is currently within both its RFC4862-defined valid and preferred lifetimes. |
Tentative | This address is currently undergoing Duplicate Address Detection (DAD) testing, as defined in RFC4862, section 5.4. |
This type represents a single IPv6 static address to be assigned on a network interface.
string | A valid IPv6 address. | ||
object | See the Oem object definition in the Common properties section. | ||
integer | The IPv6 network prefix length, in bits, for this address. |
This type represents a single IPv6 static address to be assigned on a network interface.
string | A valid IPv6 address. | ||
object | See the Oem object definition in the Common properties section. | ||
integer | The prefix length, in bits, of this IPv6 address. |
The location of a resource.
number (meters) | The altitude of the resource in meters. | ||
array | An array of contact information. | ||
| string | Name of this contact. | |
| string | Email address for this contact. | |
} ] | string | Phone number for this contact. | |
string | The location of the resource. Deprecated in v1.5 and later. This property has been deprecated in favor of the PostalAddress, Placement, and PartLocation properties. | ||
string | The format of the Info property. Deprecated in v1.5 and later. This property has been deprecated in favor of the PostalAddress, Placement, and PartLocation properties. | ||
number (deg) | The latitude of the resource. | ||
number (deg) | The longitude of the resource in degrees. | ||
object | See the Oem object definition in the Common properties section. | ||
} | object | Property names follow regular expression pattern "^[A-Za-z0-9_]+$" | |
object | The part location within the placement. | ||
| integer | The number that represents the location of the part. If LocationType is slot and this unit is in slot 2, the LocationOrdinalValue is 2. | |
| string (enum) | The type of location of the part, such as slot, bay, socket and slot. For the possible property values, see LocationType in Property details. | |
| string (enum) | The orientation for the ordering of the slot enumeration used by the LocationOrdinalValue property. For the possible property values, see Orientation in Property details. | |
| string (enum) | The reference point for the part location. Provides guidance about the general location of the part. For the possible property values, see Reference in Property details. | |
} | string | The label of the part location, such as a silk-screened name or a printed label. | |
object | A place within the addressed location. | ||
| string | Area designation or other additional info. | |
| string | The name of a rack location within a row. | |
| integer | The vertical location of the item, in terms of RackOffsetUnits. | |
| string (enum) | The type of rack units in use. For the possible property values, see RackOffsetUnits in Property details. | |
} | string | The name of the row. | |
object | The postal address of the addressed resource. | ||
| string | The additional code. | |
| string | The room designation or other additional information. | |
| string | The name of the building. | |
| string | City, township, or shi (JP). | |
| string | The postal community name. | |
| string | The country. | |
| string | A county, parish, gun (JP), or district (IN). | |
| string | City division, borough, city district, ward, or chou (JP). | |
| string | The floor. | |
| string | The GPS coordinates of the part. Deprecated in v1.6 and later. This property has been deprecated in favor of the Longitude and Latitude properties. | |
| integer | The numeric portion of house number. | |
| string | The house number suffix. | |
| string | The landmark. | |
| string | A leading street direction. | |
| string | The room designation or other additional information. Deprecated in v1.7 and later. This property has been deprecated in favor of the AdditionalInfo property. | |
| string | The name. | |
| string | Neighborhood or block. | |
| string | The description of the type of place that is addressed. | |
| string | The post office box (PO box). | |
| string | The postal code or zip code. | |
| string | The primary road or street. | |
| string | The road branch. | |
| string | The road post-modifier. | |
| string | The road pre-modifier. | |
| string | The road section. | |
| string | The road sub branch. | |
| string | The name or number of the room. | |
| string | The seat, such as the desk, cubicle, or workstation. | |
| string | Street name. | |
| string | Avenue, Platz, Street, Circle. | |
| string | A top-level subdivision within a country. | |
| string | A trailing street suffix. | |
} | string | The name or number of the apartment unit or suite. |
The type of location of the part, such as slot, bay, socket and slot.
string | Description |
---|---|
Bay | The bay as the type of location. |
Connector | The connector as the type of location. |
Slot | The slot as the type of location. |
Socket | The socket as the type of location. |
The orientation for the ordering of the slot enumeration used by the LocationOrdinalValue property.
string | Description |
---|---|
BackToFront | The ordering for the LocationOrdinalValue is back to front. |
BottomToTop | The ordering for LocationOrdinalValue is bottom to top. |
FrontToBack | The ordering for LocationOrdinalValue is front to back. |
LeftToRight | The ordering for the LocationOrdinalValue is left to right. |
RightToLeft | The ordering for the LocationOrdinalValue is right to left. |
TopToBottom | The ordering for the LocationOrdinalValue is top to bottom. |
The type of rack units in use.
string | Description |
---|---|
EIA_310 | A rack unit that is equal to 1.75 in (44.45 mm). |
OpenU | A rack unit that is equal to 48 mm (1.89 in). |
The reference point for the part location. Provides guidance about the general location of the part.
string | Description |
---|---|
Bottom | The part is in the bottom of the unit. |
Front | The part is in the front of the unit. |
Left | The part is on the left side of of the unit. |
Middle | The part is in the middle of the unit. |
Rear | The part is in the rear of the unit. |
Right | The part is on the right side of the unit. |
Top | The part is in the top of the unit. |
The maintenance window assignment for applying settings or operations to a resource.
integer (seconds) | The expiry time of maintenance window in seconds. | ||
string (date-time) | The start time of a maintenance window. |
The message that the Redfish service returns.
string | The human-readable message. | ||
array (string) | An array of message arguments that are substituted for the arguments in the message when looked up in the message registry. | ||
string | The identifier for the message. | ||
string (enum) | The severity of the message. For the possible property values, see MessageSeverity in Property details. | ||
object | See the Oem object definition in the Common properties section. | ||
array (string) | A set of properties described by the message. | ||
string | Used to provide suggestions on how to resolve the situation that caused the message. | ||
string | The severity of the message. Deprecated in v1.1 and later. This property has been deprecated in favor of MessageSeverity, which ties the values to the enumerations defined for the Health property within Status. |
The severity of the message.
string | Description |
---|---|
Critical | A critical condition requires immediate attention. |
OK | Normal. |
Warning | A condition requires attention. |
The client can request a specific apply time of a create, delete, or action operation of a resource.
integer (seconds) | The expiry time of maintenance window in seconds. | ||
object | The location of the maintenance window settings. | ||
} | string (URI) | The unique identifier for a resource. | |
string (date-time) | The start time of a maintenance window. | ||
array (string (enum)) | The types of apply times that the client can request when performing a create, delete, or action operation. For the possible property values, see SupportedValues in Property details. |
The types of apply times that the client can request when performing a create, delete, or action operation.
string | Description |
---|---|
AtMaintenanceWindowStart | The requested operation is applied within the administrator-specified maintenance window. |
Immediate | The requested operation is applied immediately. |
InMaintenanceWindowOnReset | The requested operation is applied after a reset but within the administrator-specified maintenance window. |
OnReset | The requested operation is applied on a reset. |
OnStartUpdateRequest | The requested operation is applied when the StartUpdate action of the update service is invoked. |
The preferred time to apply configuration settings.
string (enum) | The time when to apply the settings. For the possible property values, see ApplyTime in Property details. | ||
integer (seconds) | The expiry time of maintenance window in seconds. | ||
string (date-time) | The start time of a maintenance window. |
The time when to apply the settings.
string | Description |
---|---|
AtMaintenanceWindowStart | Apply during a maintenance window as specified by an administrator. |
Immediate | Apply immediately. |
InMaintenanceWindowOnReset | Apply after a reset but within maintenance window as specified by an administrator. |
OnReset | Apply on a reset. |
A reference to a set of Redundancy entities that provide redundant Services for this Resource. See the Redundancy object definition in the Common objects section.
string (URI) | The unique identifier for a resource. | ||
object | The available actions for this resource. | ||
integer | The maximum number of members allowable for this particular redundancy group. | ||
string | The identifier for the member within the collection. | ||
integer | The minimum number of members needed for this group to be redundant. | ||
string (enum) | The redundancy mode of the group. For the possible property values, see Mode in Property details. | ||
string | The name of the resource or array member. | ||
object | See the Oem object definition in the Common properties section. | ||
boolean | An indication of whether redundancy is enabled. | ||
array | | The links to components of this redundancy set. | |
} ] | string (URI) | The unique identifier for a resource. | |
object | | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. |
The redundancy mode of the group.
string | Description |
---|---|
Failover | Failure of one unit automatically causes a standby or offline unit in the redundancy set to take over its functions. |
N+m | Multiple units are available and active such that normal operation will continue if one or more units fail. |
NotRedundant (v1.3+) | The subsystem is not configured in a redundancy mode, either due to configuration or the functionality has been disabled by the user. |
Sharing | Multiple units contribute or share such that operation will continue, but at a reduced capacity, if one or more units fail. |
Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. |
The redundancy information for the devices in a redundancy group.
integer | The maximum number of devices supported in this redundancy group. | ||
integer | The minimum number of devices needed for this group to be redundant. | ||
array | | The links to the devices included in this redundancy group. | |
} ] | |||
string (enum) | The redundancy mode of the group. For the possible property values, see RedundancyType in Property details. | ||
object | | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. |
The redundancy mode of the group.
string | Description |
---|---|
Failover | Failure of one unit automatically causes a standby or offline unit in the redundancy set to take over its functions. |
NotRedundant | The subsystem is not configured in a redundancy mode, either due to configuration or the functionality has been disabled by the user. |
NPlusM | Multiple units are available and active such that normal operation will continue if one or more units fail. |
Sharing | Multiple units contribute or share such that operation will continue, but at a reduced capacity, if one or more units fail. |
Sparing | One or more spare units are available to take over the function of a failed unit, but takeover is not automatic. |
Defines the characteristics of a replica of a source.
boolean | True if consistency is enabled. | ||
string (enum) | The current state of consistency. For the possible property values, see ConsistencyState in Property details. | ||
string (enum) | The current status of consistency. For the possible property values, see ConsistencyStatus in Property details. | ||
string (enum) | Indicates the consistency type used by the source and its associated target group. For the possible property values, see ConsistencyType in Property details. | ||
object | A pointer to the DataProtection line of service element that describes this replica. | ||
} | string (URI) | The unique identifier for a resource. | |
boolean | If true, the storage array tells host to stop sending data to source element if copying to a remote element fails. | ||
integer (%) | Specifies the percent of the work completed to reach synchronization. | ||
object | Deprecated - Use Source Replica. The resource that is the source of this replica. | ||
} | string (URI) | The unique identifier for a resource. | |
string (enum) | ReplicaFaultDomain describes the fault domain (local or remote) of the replica relationship. For the possible property values, see ReplicaFaultDomain in Property details. | ||
string (enum) | The priority of background copy engine I/O to be managed relative to host I/O operations during a sequential background copy operation. For the possible property values, see ReplicaPriority in Property details. | ||
string (enum) | The status of the session with respect to Replication activity. For the possible property values, see ReplicaProgressStatus in Property details. | ||
string (enum) | This property specifies whether the source, the target, or both elements are read only to the host. For the possible property values, see ReplicaReadOnlyAccess in Property details. | ||
string (enum) | Describes whether the copy operation continues after a broken link is restored. For the possible property values, see ReplicaRecoveryMode in Property details. | ||
string (enum) | The source or target role of this replica. For the possible property values, see ReplicaRole in Property details. | ||
integer (bytes) | Applies to Adaptive mode and it describes maximum number of bytes the SyncedElement (target) can be out of sync. | ||
string (enum) | ReplicaState describes the state of the relationship with respect to Replication activity. For the possible property values, see ReplicaState in Property details. | ||
string (enum) | ReplicaType describes the intended outcome of the replication. For the possible property values, see ReplicaType in Property details. | ||
string (enum) | Describes whether the target elements will be updated synchronously or asynchronously. For the possible property values, see ReplicaUpdateMode in Property details. | ||
string (enum) | The last requested or desired state for the relationship. For the possible property values, see RequestedReplicaState in Property details. | ||
object | The resource that is the source of this replica. | ||
} | string (URI) | The unique identifier for a resource. | |
boolean | Synchronization is maintained. | ||
string (enum) | This property specifies whether the source, the target, or both elements involved in a copy operation are undiscovered. For the possible property values, see UndiscoveredElement in Property details. | ||
string (%) | Specifies when point-in-time copy was taken or when the replication relationship is activated, reactivated, resumed or re-established. | ||
string (%) | Specifies when the replication relationship is deactivated. | ||
string (%) | Specifies when the replication relationship is established. | ||
string (%) | Specifies when the replication relationship is suspended. | ||
string | The point in time that the Elements were synchronized. | ||
string (%) | Specifies when the replication relationship is synchronized. |
The current state of consistency.
string | Description |
---|---|
Consistent | Consistent. |
Inconsistent | Not consistent. |
The current status of consistency.
string | Description |
---|---|
Consistent | Consistent. |
Disabled | Consistency disabled. |
InError | Consistency error. |
InProgress | Becoming consistent. |
Indicates the consistency type used by the source and its associated target group.
string | Description |
---|---|
SequentiallyConsistent | Sequentially consistent. |
ReplicaFaultDomain describes the fault domain (local or remote) of the replica relationship.
string | Description |
---|---|
Local | Local indicates that the source and target replicas are contained within a single fault domain. |
Remote | Remote indicates that the source and target replicas are in separate fault domains. |
The priority of background copy engine I/O to be managed relative to host I/O operations during a sequential background copy operation.
string | Description |
---|---|
High | Copy engine I/O has higher priority than host I/O. |
Low | Copy engine I/O lower priority than host I/O. |
Same | Copy engine I/O has the same priority as host I/O. |
Urgent | Copy operation to be performed as soon as possible, regardless of the host I/O requests. |
The status of the session with respect to Replication activity.
string | Description |
---|---|
Aborting | Abort in progress. |
Completed | The request is completed. Data flow is idle. |
Detaching | Detach in progress. |
Dormant | Indicates that the data flow is inactive, suspended or quiesced. |
FailingBack | Undoing the result of failover. |
FailingOver | In the process of switching source and target. |
Fracturing | Fracture in progress. |
Initializing | In the process of establishing source/replica relationship and the data flow has not started. |
Mixed | Applies to groups with element pairs with different statuses. Generally, the individual statuses need to be examined. |
Pending | The flow of data has stopped momentarily due to limited bandwidth or a busy system. |
Preparing | Preparation in progress. |
RequiresActivate | The requested operation has completed, however, the synchronization relationship needs to be activated before further copy operations can be issued. |
RequiresDetach | The requested operation has completed, however, the synchronization relationship needs to be detached before further copy operations can be issued. |
RequiresFracture | The requested operation has completed, however, the synchronization relationship needs to be fractured before further copy operations can be issued. |
RequiresResume | The requested operation has completed, however, the synchronization relationship needs to be resumed before further copy operations can be issued. |
RequiresResync | The requested operation has completed, however, the synchronization relationship needs to be resynced before further copy operations can be issued. |
RequiresSplit | The requested operation has completed, however, the synchronization relationship needs to be split before further copy operations can be issued. |
Restoring | Restore in progress. |
Resyncing | Resync in progress. |
Splitting | Split in progress. |
Suspending | The copy operation is in the process of being suspended. |
Synchronizing | Sync in progress. |
Terminating | The relationship is in the process of terminating. |
This property specifies whether the source, the target, or both elements are read only to the host.
string | Description |
---|---|
Both | Both the source and the target elements are read only to the host. |
ReplicaElement | The replica element. |
SourceElement | The source element. |
Describes whether the copy operation continues after a broken link is restored.
string | Description |
---|---|
Automatic | Copy operation resumes automatically. |
Manual | ReplicaState is set to Suspended after the link is restored. It is required to issue the Resume operation to continue. |
The source or target role of this replica.
string | Description |
---|---|
Source | The source element. |
Target | The target element. |
ReplicaState describes the state of the relationship with respect to Replication activity.
string | Description |
---|---|
Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. |
Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. |
Failedover | Reads and writes are sent to the target element. Source element is not reachable. |
Fractured | Target is split from the source. |
Inactive | Data flow has stopped, writes to source element will not be sent to target element. |
Initialized | The link to enable replication is established and source/replica elements are associated, but the data flow has not started. |
Invalid | The array is unable to determine the state of the replication relationship, for example, after the connection is restored; however, either source or target elements have an unknown status. |
Mixed | Applies to the ReplicaState of GroupSynchronized. It indicates the StorageSynchronized relationships of the elements in the groups have different ReplicaState values. |
Partitioned | State of replication relationship can not be determined, for example, due to a connection problem. |
Prepared | Initialization is completed, however, the data flow has not started. |
Restored | It indicates the source element was restored from the target element. |
Skewed | The target has been modified and is no longer synchronized with the source element or the point-in-time view. |
Split | The target element was gracefully (or systematically) split from its source element -- consistency is guaranteed. |
Suspended | Data flow between the source and target elements has stopped. Writes to source element are held until the relationship is Resumed. |
Synchronized | For the Mirror, Snapshot, or Clone replication, the target represents a copy of the source. |
Unsynchronized | Not all the source element data has been copied to the target element. |
ReplicaType describes the intended outcome of the replication.
string | Description |
---|---|
Clone | Create a point in time, full copy the source. |
Mirror | Create and maintain a copy of the source. |
Snapshot | Create a point in time, virtual copy of the source. |
TokenizedClone | Create a token based clone. |
Describes whether the target elements will be updated synchronously or asynchronously.
string | Description |
---|---|
Active | Active-Active (i.e. bidirectional) synchronous updates. |
Adaptive | Allows implementation to switch between synchronous and asynchronous modes. |
Asynchronous | Asynchronous updates. |
Synchronous | Synchronous updates. |
The last requested or desired state for the relationship.
string | Description |
---|---|
Aborted | The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation. |
Broken | The relationship is non-functional due to errors in the source, the target, the path between the two or space constraints. |
Failedover | Reads and writes are sent to the target element. Source element is not reachable. |
Fractured | Target is split from the source. |
Inactive | Data flow has stopped, writes to source element will not be sent to target element. |
Initialized | The link to enable replication is established and source/replica elements are associated, but the data flow has not started. |
Invalid | The array is unable to determine the state of the replication relationship, for example, after the connection is restored; however, either source or target elements have an unknown status. |
Mixed | Applies to the ReplicaState of GroupSynchronized. It indicates the StorageSynchronized relationships of the elements in the groups have different ReplicaState values. |
Partitioned | State of replication relationship can not be determined, for example, due to a connection problem. |
Prepared | Initialization is completed, however, the data flow has not started. |
Restored | It indicates the source element was restored from the target element. |
Skewed | The target has been modified and is no longer synchronized with the source element or the point-in-time view. |
Split | The target element was gracefully (or systematically) split from its source element -- consistency is guaranteed. |
Suspended | Data flow between the source and target elements has stopped. Writes to source element are held until the relationship is Resumed. |
Synchronized | For the Mirror, Snapshot, or Clone replication, the target represents a copy of the source. |
Unsynchronized | Not all the source element data has been copied to the target element. |
This property specifies whether the source, the target, or both elements involved in a copy operation are undiscovered.
string | Description |
---|---|
ReplicaElement | The replica element is undiscovered. |
SourceElement | The source element is undiscovered. |
Schedule a series of occurrences.
array (integer, null) | Days of the month when scheduled occurrences are enabled. 0 indicates that every day of the month is enabled. | ||
array (string (enum)) | Days of the week when scheduled occurrences are enabled, for enabled days of the month and months of the year. If not present, all days of the week are enabled. Days of the week. For the possible property values, see EnabledDaysOfWeek in Property details. | ||
array (string, null) | Intervals when scheduled occurrences are enabled. | ||
array (string (enum)) | The months of the year when scheduled occurrences are enabled. If not present, all months of the year are enabled. Months of the year. For the possible property values, see EnabledMonthsOfYear in Property details. | ||
string (date-time) | The date and time when the initial occurrence is scheduled to occur. | ||
string | The time after provisioning when the schedule as a whole expires. | ||
integer | The maximum number of scheduled occurrences. | ||
string | The schedule name. | ||
string | The amount of time until the next occurrence occurs. |
Days of the week when scheduled occurrences are enabled, for enabled days of the month and months of the year. If not present, all days of the week are enabled. Days of the week.
string | Description |
---|---|
Every | Every day of the week. |
Friday | Friday. |
Monday | Monday. |
Saturday | Saturday. |
Sunday | Sunday. |
Thursday | Thursday. |
Tuesday | Tuesday. |
Wednesday | Wednesday. |
The months of the year when scheduled occurrences are enabled. If not present, all months of the year are enabled. Months of the year.
string | Description |
---|---|
April | April. |
August | August. |
December | December. |
Every | Every month of the year. |
February | February. |
January | January. |
July | July. |
June | June. |
March | March. |
May | May. |
November | November. |
October | October. |
September | September. |
The resource settings.
string | The entity tag (ETag) of the resource to which the settings were applied, after the application. | ||
object | The location of the maintenance window settings. | ||
} | string (URI) | The unique identifier for a resource. | |
array (object) | An array of messages associated with the settings. The message that the Redfish service returns. For property details, see Message. | ||
object | The link to the resource that the client can PUT or PATCH to modify the resource. | ||
} | string (URI) | The unique identifier for a resource. | |
array (string (enum)) | The time when the settings can be applied. For the possible property values, see SupportedApplyTimes in Property details. | ||
string (date-time) | The time when the settings were applied. |
The time when the settings can be applied.
string | Description |
---|---|
AtMaintenanceWindowStart | Apply during a maintenance window as specified by an administrator. |
Immediate | Apply immediately. |
InMaintenanceWindowOnReset | Apply after a reset but within maintenance window as specified by an administrator. |
OnReset | Apply on a reset. |
The status and health of a resource and its children.
array | Conditions in this resource that require attention. | ||
| object | The link to the log entry created for this condition. See the LogEntry schema for details on this property. | |
} | string | Link to a LogEntry resource. See the Links section and the LogEntry schema for details. | |
| string | The human-readable message for this condition. | |
| array (string) | An array of message arguments that are substituted for the arguments in the message when looked up in the message registry. | |
| string | The identifier for the message. | |
| object | A link to the resource or object that originated the condition. | |
} | string (URI) | The unique identifier for a resource. | |
| string (enum) | The severity of the condition. For the possible property values, see Severity in Property details. | |
} ] | string (date-time) | The time the condition occurred. | |
string (enum) | The health state of this resource in the absence of its dependent resources. For the possible property values, see Health in Property details. | ||
string (enum) | The overall health state from the view of this resource. For the possible property values, see HealthRollup in Property details. | ||
object | See the Oem object definition in the Common properties section. | ||
} | object | Property names follow regular expression pattern "^[A-Za-z0-9_]+$" | |
string (enum) | The known state of the resource, such as, enabled. For the possible property values, see State in Property details. |
The health state of this resource in the absence of its dependent resources.
string | Description |
---|---|
Critical | A critical condition requires immediate attention. |
OK | Normal. |
Warning | A condition requires attention. |
The overall health state from the view of this resource.
string | Description |
---|---|
Critical | A critical condition requires immediate attention. |
OK | Normal. |
Warning | A condition requires attention. |
The severity of the condition.
string | Description |
---|---|
Critical | A critical condition requires immediate attention. |
OK | Normal. |
Warning | A condition requires attention. |
The known state of the resource, such as, enabled.
string | Description |
---|---|
Absent | This function or resource is either not present or detected. |
Deferring (v1.2+) | The element does not process any commands but queues new requests. |
Disabled | This function or resource is disabled. |
Enabled | This function or resource is enabled. |
InTest | This function or resource is undergoing testing, or is in the process of capturing information for debugging. |
Qualified (v1.9+) | The element quality is within the acceptable range of operation. |
Quiesced (v1.2+) | The element is enabled but only processes a restricted set of commands. |
StandbyOffline | This function or resource is enabled but awaits an external action to activate it. |
StandbySpare | This function or resource is part of a redundancy set and awaits a failover or other external action to activate it. |
Starting | This function or resource is starting. |
UnavailableOffline (v1.1+) | This function or resource is present but cannot be used. |
Updating (v1.2+) | The element is updating and might be unavailable or degraded. |
A core concept in Redfish is a collection of Resources. A collection is a group of like Resources where the number of instances in the group can shrink or grow depending on the scope of the Redfish Service or the configuration of the devices being managed. Every Resource in a collection has the same set of supported properties, and all contain Collection
in the name of their schema. Every Resource linked in the Members array within a Resource Collection have the same Resource type, or the same schema with the same major version, but can vary in minor or errata schema versions, which are all compatible.
The properties of a Resource Collection are as follows:
string (URI) | The OData description of a payload. | ||
string (URI) | The unique identifier for a resource. | ||
string | The type of a resource. | ||
string | The description of this resource. Used for commonality in the schema definitions. | ||
array | | The members of this collection. | |
} ] | string (URI) | The link to a Resource instance, which is a member of this collection. | |
integer | The number of items in a collection. | ||
string (URI) | |||
string | The name of the resource or array member. | ||
object | The manufacturer- or provider-specific extension moniker that divides the Oem object into sections. |
As shown in the following example, a Redfish Service may provide management functionality for several Computer Systems, and therefore a ComputerSystemCollection Resource is provided. This example shows a Service with multiple ComputerSystem instances, or members.
{ "@odata.type": "#ComputerSystemCollection.ComputerSystemCollection", "Name": "Computer System Collection", "Members@odata.count": 4, "Members": [{ "@odata.id": "/redfish/v1/Systems/529QB9450R6" }, { "@odata.id": "/redfish/v1/Systems/529QB9451R6" }, { "@odata.id": "/redfish/v1/Systems/529QB9452R6" }, { "@odata.id": "/redfish/v1/Systems/529QB9453R6" } ], "@odata.context": "/redfish/v1/$metadata#ComputerSystemCollection.ComputerSystemCollection", "@odata.id": "/redfish/v1/Systems" }
The following table lists the Redfish-defined Resource Collections and the URIs where they can appear. NOTE: The URIs listed are valid for Redfish Services conforming to the Redfish Specification v1.6.0 or higher. Services built on earlier versions of the Specification may use different URIs. To discover these URIs, follow the links from the Service Root (/redfish/v1/
).
Collection Type | URIs |
---|---|
AccelerationFunctionCollection | /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/AccelerationFunctions /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/AccelerationFunctions /redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/AccelerationFunctions /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/AccelerationFunctions /redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/AccelerationFunctions |
AddressPoolCollection | /redfish/v1/Fabrics/{FabricId}/AddressPools |
AggregateCollection | /redfish/v1/AggregationService/Aggregates |
AggregationSourceCollection | /redfish/v1/AggregationService/AggregationSources |
BootOptionCollection | /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/BootOptions /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/BootOptions /redfish/v1/Systems/{ComputerSystemId}/BootOptions |
CertificateCollection | /redfish/v1/AccountService/Accounts/{ManagerAccountId}/Certificates /redfish/v1/AccountService/ActiveDirectory/Certificates /redfish/v1/AccountService/ExternalAccountProviders/{ExternalAccountProviderId}/Certificates /redfish/v1/AccountService/LDAP/Certificates /redfish/v1/Chassis/{ChassisId}/Certificates /redfish/v1/Chassis/{ChassisId}/Drives/{DriveId}/Certificates /redfish/v1/Chassis/{ChassisId}/Memory/{MemoryId}/Certificates /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Certificates /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}/Certificates /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/Certificates /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Certificates /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/{DriveId}/Certificates /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Boot/Certificates /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Certificates /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory/{MemoryId}/Certificates /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Certificates /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases/{DatabaseId}/Certificates /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/Certificates /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates /redfish/v1/EventService/Subscriptions/{EventDestinationId}/Certificates /redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Certificates /redfish/v1/Managers/{ManagerId}/NetworkProtocol/HTTPS/Certificates /redfish/v1/Managers/{ManagerId}/RemoteAccountService/Accounts/{ManagerAccountId}/Certificates /redfish/v1/Managers/{ManagerId}/RemoteAccountService/ActiveDirectory/Certificates /redfish/v1/Managers/{ManagerId}/RemoteAccountService/ExternalAccountProviders/{ExternalAccountProviderId}/Certificates /redfish/v1/Managers/{ManagerId}/RemoteAccountService/LDAP/Certificates /redfish/v1/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}/Certificates /redfish/v1/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/Certificates /redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Certificates /redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates /redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/{DriveId}/Certificates /redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Boot/Certificates /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Certificates /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory/{MemoryId}/Certificates /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Certificates /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases/{DatabaseId}/Certificates /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/Certificates /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates /redfish/v1/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates /redfish/v1/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates /redfish/v1/Systems/{ComputerSystemId}/Boot/Certificates /redfish/v1/Systems/{ComputerSystemId}/Certificates /redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}/Certificates /redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Certificates /redfish/v1/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases/{DatabaseId}/Certificates /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates |
ChassisCollection | /redfish/v1/Chassis |
CircuitCollection | /redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}/Branches /redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}/Mains /redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}/Subfeeds /redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Branches /redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Mains /redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Branches /redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Feeders /redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Mains |
ComputerSystemCollection | /redfish/v1/Systems |
ConnectionCollection | /redfish/v1/Fabrics/{FabricId}/Connections |
ConnectionMethodCollection | /redfish/v1/AggregationService/ConnectionMethods |
DriveCollection | /redfish/v1/Chassis/{ChassisId}/Drives /redfish/v1/Storage/{StorageId}/FileSystems/{FileSystemId}/CapacitySources/{CapacitySourceId}/ProvidingDrives /redfish/v1/Storage/{StorageId}/StoragePools/{StoragePoolId}/CapacitySources/{CapacitySourceId}/ProvidingDrives /redfish/v1/Storage/{StorageId}/Volumes/{VolumeId}/CapacitySources/{CapacitySourceId}/ProvidingDrives /redfish/v1/StorageServices/{StorageServiceId}/Drives /redfish/v1/StorageServices/{StorageServiceId}/FileSystems/{FileSystemId}/CapacitySources/{CapacitySourceId}/ProvidingDrives /redfish/v1/StorageServices/{StorageServiceId}/StoragePools/{StoragePoolId}/CapacitySources/{CapacitySourceId}/ProvidingDrives /redfish/v1/StorageServices/{StorageServiceId}/Volumes/{VolumeId}/CapacitySources/{CapacitySourceId}/ProvidingDrives /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/FileSystems/{FileSystemId}/CapacitySources/{CapacitySourceId}/ProvidingDrives /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StoragePools/{StoragePoolId}/CapacitySources/{CapacitySourceId}/ProvidingDrives /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes/{VolumeId}/CapacitySources/{CapacitySourceId}/ProvidingDrives |
EndpointCollection | /redfish/v1/Fabrics/{FabricId}/Endpoints |
EndpointGroupCollection | /redfish/v1/Fabrics/{FabricId}/EndpointGroups /redfish/v1/Storage/{StorageId}/EndpointGroups /redfish/v1/StorageServices/{StorageServiceId}/EndpointGroups /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/EndpointGroups |
EthernetInterfaceCollection | /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/EthernetInterfaces /redfish/v1/Managers/{ManagerId}/EthernetInterfaces /redfish/v1/Managers/{ManagerId}/HostInterfaces/{HostInterfaceId}/HostEthernetInterfaces /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/EthernetInterfaces /redfish/v1/Systems/{ComputerSystemId}/EthernetInterfaces |
EventDestinationCollection | /redfish/v1/EventService/Subscriptions |
ExternalAccountProviderCollection | /redfish/v1/AccountService/ExternalAccountProviders /redfish/v1/Managers/{ManagerId}/RemoteAccountService/ExternalAccountProviders |
FabricAdapterCollection | /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters |
FabricCollection | /redfish/v1/Fabrics |
FacilityCollection | /redfish/v1/Facilities |
FanCollection | /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Fans |
HostInterfaceCollection | /redfish/v1/Managers/{ManagerId}/HostInterfaces |
JobCollection | /redfish/v1/JobService/Jobs /redfish/v1/JobService/Jobs/{JobId}/Steps |
JsonSchemaFileCollection | /redfish/v1/JsonSchemas |
LogEntryCollection | /redfish/v1/Chassis/{ChassisId}/LogServices/{LogServiceId}/Entries /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/{LogServiceId}/Entries /redfish/v1/JobService/Log/Entries /redfish/v1/Managers/{ManagerId}/LogServices/{LogServiceId}/Entries /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices/{LogServiceId}/Entries /redfish/v1/Systems/{ComputerSystemId}/LogServices/{LogServiceId}/Entries /redfish/v1/TelemetryService/LogService/Entries |
LogServiceCollection | /redfish/v1/Chassis/{ChassisId}/LogServices /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices /redfish/v1/Managers/{ManagerId}/LogServices /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/LogServices /redfish/v1/Systems/{ComputerSystemId}/LogServices |
ManagerAccountCollection | /redfish/v1/AccountService/Accounts /redfish/v1/Managers/{ManagerId}/RemoteAccountService/Accounts |
ManagerCollection | /redfish/v1/Managers |
MediaControllerCollection | /redfish/v1/Chassis/{ChassisId}/MediaControllers |
MemoryChunksCollection | /redfish/v1/Chassis/{ChassisId}/MemoryDomains/{MemoryDomainId}/MemoryChunks /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/MemoryDomains/{MemoryDomainId}/MemoryChunks /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/MemoryDomains/{MemoryDomainId}/MemoryChunks /redfish/v1/Systems/{ComputerSystemId}/MemoryDomains/{MemoryDomainId}/MemoryChunks |
MemoryCollection | /redfish/v1/Chassis/{ChassisId}/Memory /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory /redfish/v1/Systems/{ComputerSystemId}/Memory |
MemoryDomainCollection | /redfish/v1/Chassis/{ChassisId}/MemoryDomains /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/MemoryDomains /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/MemoryDomains /redfish/v1/Systems/{ComputerSystemId}/MemoryDomains |
MessageRegistryCollection | |
MessageRegistryFileCollection | /redfish/v1/Registries |
MetricDefinitionCollection | /redfish/v1/TelemetryService/MetricDefinitions |
MetricReportCollection | /redfish/v1/TelemetryService/MetricReports |
MetricReportDefinitionCollection | /redfish/v1/TelemetryService/MetricReportDefinitions |
NetworkAdapterCollection | /redfish/v1/Chassis/{ChassisId}/NetworkAdapters |
NetworkDeviceFunctionCollection | /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions /redfish/v1/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions /redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions |
NetworkInterfaceCollection | /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces /redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces |
NetworkPortCollection | /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkPorts /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts /redfish/v1/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts /redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts |
OperatingConfigCollection | /redfish/v1/Systems/{ComputerSystemId}/OperatingConfigs /redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/OperatingConfigs |
OutletCollection | /redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Outlets /redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Outlets |
OutletGroupCollection | /redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/OutletGroups /redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/OutletGroups |
PCIeDeviceCollection | /redfish/v1/Chassis/{ChassisId}/PCIeDevices /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/PCIeDevices /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/PCIeDevices /redfish/v1/Systems/{ComputerSystemId}/PCIeDevices |
PCIeFunctionCollection | /redfish/v1/Chassis/{ChassisId}/PCIeDevices/{PCIeDeviceId}/PCIeFunctions /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/PCIeDevices/{PCIeDeviceId}/PCIeFunctions /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/PCIeDevices/{PCIeDeviceId}/PCIeFunctions /redfish/v1/Systems/{ComputerSystemId}/PCIeDevices/{PCIeDeviceId}/PCIeFunctions |
PortCollection | /redfish/v1/Chassis/{ChassisId}/MediaControllers/{MediaControllerId}/Ports /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Ports /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}/Ports /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Ports /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/Ports /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Ports /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports /redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports /redfish/v1/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}/Ports /redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Ports /redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/Ports /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Ports /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports /redfish/v1/Storage/{StorageId}/Controllers/{StorageControllerId}/Ports /redfish/v1/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports /redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/Ports /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Ports /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports |
PowerDistributionCollection | /redfish/v1/PowerEquipment/FloorPDUs /redfish/v1/PowerEquipment/RackPDUs /redfish/v1/PowerEquipment/Switchgear /redfish/v1/PowerEquipment/TransferSwitches |
PowerDomainCollection | /redfish/v1/Facilities/{FacilityId}/PowerDomains |
PowerSupplyCollection | /redfish/v1/Chassis/{ChassisId}/PowerSubsystem/PowerSupplies |
ProcessorCollection | /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors /redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors /redfish/v1/Systems/{ComputerSystemId}/Processors /redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors |
ResourceBlockCollection | /redfish/v1/CompositionService/ResourceBlocks /redfish/v1/ResourceBlocks |
RoleCollection | /redfish/v1/AccountService/Roles /redfish/v1/Managers/{ManagerId}/RemoteAccountService/Roles |
RouteEntryCollection | /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/MSDT /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/SSDT |
RouteSetEntryCollection | /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/MSDT/{MSDTId}/RouteSet /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT/{LPRTId}/RouteSet /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT/{MPRTId}/RouteSet /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/SSDT/{SSDTId}/RouteSet |
SecureBootDatabaseCollection | /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases /redfish/v1/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases |
SensorCollection | /redfish/v1/Chassis/{ChassisId}/Sensors /redfish/v1/Facilities/{FacilityId}/Sensors /redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}/Sensors /redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Sensors /redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}/Sensors /redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Sensors |
SerialInterfaceCollection | /redfish/v1/Managers/{ManagerId}/SerialInterfaces |
SessionCollection | /redfish/v1/SessionService/Sessions |
SignatureCollection | /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases/{DatabaseId}/Signatures /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases/{DatabaseId}/Signatures /redfish/v1/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases/{DatabaseId}/Signatures |
SimpleStorageCollection | /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SimpleStorage /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SimpleStorage /redfish/v1/Systems/{ComputerSystemId}/SimpleStorage |
SoftwareInventoryCollection | /redfish/v1/UpdateService/FirmwareInventory /redfish/v1/UpdateService/SoftwareInventory |
StorageCollection | /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage /redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage /redfish/v1/Storage /redfish/v1/Systems/{ComputerSystemId}/Storage |
StorageControllerCollection | /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers /redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers /redfish/v1/Storage/{StorageId}/Controllers /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers |
SwitchCollection | /redfish/v1/Fabrics/{FabricId}/Switches |
TaskCollection | /redfish/v1/TaskService/Tasks /redfish/v1/TaskService/Tasks/{TaskId}/SubTasks |
TriggersCollection | /redfish/v1/TelemetryService/Triggers |
VCATEntryCollection | /redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/VCAT /redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/REQ-VCAT /redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/RSP-VCAT |
VirtualMediaCollection | /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/VirtualMedia /redfish/v1/Managers/{ManagerId}/VirtualMedia /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/VirtualMedia /redfish/v1/Systems/{ComputerSystemId}/VirtualMedia |
VLanNetworkInterfaceCollection | /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/Ethernet/VLANs /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs /redfish/v1/Managers/{ManagerId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs /redfish/v1/ResourceBlocks/{ResourceBlockId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs /redfish/v1/Systems/{ComputerSystemId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs |
VolumeCollection | /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Volumes /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes /redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Volumes /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes /redfish/v1/Storage/{StorageId}/ConsistencyGroups/{ConsistencyGroupId}/Volumes /redfish/v1/Storage/{StorageId}/FileSystems/{FileSystemId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes /redfish/v1/Storage/{StorageId}/StoragePools/{StoragePoolId}/AllocatedVolumes /redfish/v1/Storage/{StorageId}/StoragePools/{StoragePoolId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes /redfish/v1/Storage/{StorageId}/Volumes /redfish/v1/StorageServices/{StorageServiceId}/ConsistencyGroups/{ConsistencyGroupId}/Volumes /redfish/v1/StorageServices/{StorageServiceId}/FileSystems/{FileSystemId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes /redfish/v1/StorageServices/{StorageServiceId}/StoragePools/{StoragePoolId}/AllocatedVolumes /redfish/v1/StorageServices/{StorageServiceId}/StoragePools/{StoragePoolId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes /redfish/v1/StorageServices/{StorageServiceId}/Volumes /redfish/v1/StorageServices/{StorageServiceId}/Volumes/{VolumeId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/ConsistencyGroups/{ConsistencyGroupId}/Volumes /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/FileSystems/{FileSystemId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StoragePools/{StoragePoolId}/AllocatedVolumes /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StoragePools/{StoragePoolId}/CapacitySources/{CapacitySourceId}/ProvidingVolumes /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Volumes |
ZoneCollection | /redfish/v1/CompositionService/ResourceZones /redfish/v1/Fabrics/{FabricId}/Zones |
To produce this guide, DMTF's Redfish Documentation Generator merges the DMTF Redfish Schema bundle (DSP8010) contents with supplemental text.
v1.0 |
2018.3 |
The AccelerationFunction schema describes an acceleration function that a processor implements. This can include functions such as audio processing, compression, encryption, packet inspection, packet switching, scheduling, or video processing.
string (enum) | The acceleration function type. For the possible property values, see AccelerationFunctionType in Property details. | ||
array (string) | An array of the reconfiguration slot identifiers of the FPGA that this acceleration function occupies. | ||
object | The links to other Resources that are related to this Resource. | ||
| array | An array of links to the endpoints that connect to this acceleration function. | |
} ] | string | Link to a Endpoint resource. See the Links section and the Endpoint schema for details. | |
| object | See the Oem object definition in the Common properties section. | |
| array | An array of links to the PCIeFunctions associated with this acceleration function. | |
} ] } | string | Link to a PCIeFunction resource. See the Links section and the PCIeFunction schema for details. | |
string | The acceleration function code manufacturer. | ||
integer (Watts) | The acceleration function power consumption, in watts. | ||
object | The status and health of the Resource and its subordinate or dependent Resources. For property details, see Status. | ||
string | The UUID for this acceleration function. | ||
string | The acceleration function version. |
The acceleration function type.
string | Description |
---|---|
AudioProcessing | An audio processing function. |
Compression | A compression function. |
Encryption | An encryption function. |
OEM | An OEM-defined acceleration function. |
PacketInspection | A packet inspection function. |
PacketSwitch | A packet switch function. |
Scheduler | A scheduler function. |
VideoProcessing | A video processing function. |
{ "@odata.type": "#AccelerationFunction.v1_0_3.AccelerationFunction", "Id": "Compression", "Name": "Compression Accelerator", "Status": { "State": "Enabled", "Health": "OK" }, "FpgaReconfigurationSlots": [ "AFU0" ], "AccelerationFunctionType": "Compression", "Manufacturer": "Intel (R) Corporation", "Version": "Green Compression Type 1 v.1.00.86", "PowerWatts": 15, "Links": { "Endpoints": [], "PCIeFunctions": [] }, "Oem": {}, "@odata.id": "/redfish/v1/Systems/1/Processors/FPGA1/AccelerationFunctions/Compression" }
v1.8 | v1.7 | v1.6 | v1.5 | v1.4 | v1.3 | v1.2 | v1.1 | v1.0 |
2020.4 | 2019.4 | 2019.2 | 2019.1 | 2018.3 | 2018.1 | 2017.1 | 2016.3 | 1.0 |
The AccountService schema defines an account service. The properties are common to, and enable management of, all user accounts. The properties include the password requirements and control features, such as account lockout. The schema also contains links to the manager accounts and roles.
integer (seconds) | The period of time, in seconds, between the last failed login attempt and the reset of the lockout threshold counter. This value must be less than or equal to the AccountLockoutDuration value. A reset sets the counter to 0 . | ||
boolean | An indication of whether the threshold counter is reset after AccountLockoutCounterResetAfter expires. If true , it is reset. If false , only a successful login resets the threshold counter and if the user reaches the AccountLockoutThreshold limit, the account will be locked out indefinitely and only an administrator-issued reset clears the threshold counter. If this property is absent, the default is true . | ||
integer (seconds) | The period of time, in seconds, that an account is locked after the number of failed login attempts reaches the account lockout threshold, within the period between the last failed login attempt and the reset of the lockout threshold counter. If this value is 0 , no lockout will occur. If the AccountLockoutCounterResetEnabled value is false , this property is ignored. | ||
integer | The number of allowed failed login attempts before a user account is locked for a specified duration. If 0 , the account is never locked. | ||
object | The collection of manager accounts. Contains a link to a resource. | ||
} | string | Link to Collection of ManagerAccount. See the ManagerAccount schema for details. | |
object | The first Active Directory external account provider that this account service supports. For more information about this property, see ExternalAccountProvider in Property Details. | ||
object | The additional external account providers that this account service uses. Contains a link to a resource. | ||
} | string | Link to Collection of ExternalAccountProvider. See the ExternalAccountProvider schema for details. | |
integer | The number of authorization failures per account that are allowed before the failed attempt is logged to the manager log. | ||
object | The first LDAP external account provider that this account service supports. For more information about this property, see ExternalAccountProvider in Property Details. | ||
string (enum) | An indication of how the service uses the accounts collection within this account service as part of authentication. The enumerated values describe the details for each mode. For the possible property values, see LocalAccountAuth in Property details. | ||
integer | The maximum password length for this account service. | ||
integer | The minimum password length for this account service. | ||
object | The link to the mapping of the privileges required to complete a requested operation on a URI associated with this service. See the PrivilegeRegistry schema for details on this property. | ||
} | string | Link to a PrivilegeRegistry resource. See the Links section and the PrivilegeRegistry schema for details. | |
array (string) | The set of restricted OEM privileges. | ||
array (string (enum)) | The set of restricted Redfish privileges. For the possible property values, see RestrictedPrivileges in Property details. | ||
object | The collection of Redfish roles. Contains a link to a resource. | ||
} | string | Link to Collection of Role. See the Role schema for details. | |
boolean | An indication of whether the account service is enabled. If true , it is enabled. If false , it is disabled and users cannot be created, deleted, or modified, and new sessions cannot be started. However, established sessions might still continue to run. Any service, such as the session service, that attempts to access the disabled account service fails. However, this does not affect HTTP Basic Authentication connections. | ||
object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. | ||
array (string (enum)) | The account types supported by the service. For the possible property values, see SupportedAccountTypes in Property details. | ||
array (string) | The OEM account types supported by the service. | ||
object | (null) | The first TACACS+ external account provider that this account service supports. For more information about this property, see ExternalAccountProvider in Property Details. |
The type of external account provider to which this service connects.
string | Description |
---|---|
ActiveDirectoryService | An external Active Directory service. |
LDAPService | A generic external LDAP service. |
OEM | An OEM-specific external authentication or directory service. |
RedfishService | An external Redfish service. |
TACACSplus (v1.8+) | An external TACACS+ service. |
The information required to authenticate to the external service.
string (enum) | The type of authentication used to connect to the external account provider. For the possible property values, see AuthenticationType in Property details. | ||
string | Specifies the encryption key. | ||
boolean | Indicates if the EncryptionKey property is set. | ||
string | The Base64-encoded version of the Kerberos keytab for this service. A PATCH or PUT operation writes the keytab. This property is null in responses. | ||
object | See the Oem object definition in the Common properties section. | ||
string | The password for this service. A PATCH or PUT request writes the password. This property is null in responses. | ||
string | The token for this service. A PATCH or PUT operation writes the token. This property is null in responses. | ||
string | The user name for the service. |
The type of authentication used to connect to the external account provider.
string | Description |
---|---|
KerberosKeytab | A Kerberos keytab. |
OEM | An OEM-specific authentication mechanism. |
Token | An opaque authentication token. |
UsernameAndPassword | A user name and password combination. |
The external account provider services that can provide accounts for this manager to use for authentication.
string (enum) | The type of external account provider to which this service connects. For the possible property values, see AccountProviderType in Property details. Deprecated in v1.5 and later. This property is deprecated because the account provider type is known when used in the LDAP and ActiveDirectory objects. | ||
object | The authentication information for the external account provider. For more information about this property, see Authentication in Property Details. | ||
object | The link to a collection of certificates that the external account provider uses. Contains a link to a resource. | ||
} | string | Link to Collection of Certificate. See the Certificate schema for details. | |
object | The additional mapping information needed to parse a generic LDAP service. For more information about this property, see LDAPService in Property Details. | ||
boolean | Indicates if the Password property is set. | ||
integer | The authentication priority for the external account provider. | ||
array | The mapping rules to convert the external account providers account information to the local Redfish role. | ||
| string | The name of the local Redfish role to which to map the remote user or group. | |
| object | See the Oem object definition in the Common properties section. | |
| string | The name of the remote group, or the remote role in the case of a Redfish service, that maps to the local Redfish role to which this entity links. | |
} ] | string | The name of the remote user that maps to the local Redfish role to which this entity links. | |
array (string, null) | The addresses of the user account providers to which this external account provider links. The format of this field depends on the type of external account provider. | ||
boolean | An indication of whether this service is enabled. | ||
object | (null) | The additional information needed to parse a TACACS+ services. For more information about this property, see TACACSplusService in Property Details. |
The settings required to parse a generic LDAP service.
object | See the Oem object definition in the Common properties section. | ||
object | The required settings to search an external LDAP service. | ||
| array (string, null) | The base distinguished names to use to search an external LDAP service. | |
| string | The attribute name that contains the LDAP group name entry. | |
| string | The attribute name that contains the groups for a user on the LDAP user entry. | |
} | string | The attribute name that contains the LDAP user name entry. |
An indication of how the service uses the accounts collection within this account service as part of authentication. The enumerated values describe the details for each mode.
string | Description |
---|---|
Disabled | The service never authenticates users based on the account service-defined accounts collection. |
Enabled | The service authenticates users based on the account service-defined accounts collection. |
Fallback | The service authenticates users based on the account service-defined accounts collection only if any external account providers are currently unreachable. |
LocalFirst (v1.6+) | The service first authenticates users based on the account service-defined accounts collection. If authentication fails, the service authenticates by using external account providers. |
Indicates the allowed TACACS+ password exchange protocols.
string | Description |
---|---|
ASCII | The ASCII Login method. |
CHAP | The CHAP Login method. |
MSCHAPv1 | The MS-CHAP v1 Login method. |
MSCHAPv2 | The MS-CHAP v2 Login method. |
PAP | The PAP Login method. |
The set of restricted Redfish privileges.
string | Description |
---|---|
ConfigureComponents | Can configure components that this service manages. |
ConfigureManager | Can configure managers. |
ConfigureSelf | Can change the password for the current user account and log out of their own sessions. |
ConfigureUsers | Can configure users and their accounts. |
Login | Can log in to the service and read Resources. |
NoAuth | Authentication is not required. |
The account types supported by the service.
string | Description |
---|---|
HostConsole | Allow access to the host's console, which could be connected through Telnet, SSH, or other protocol. |
IPMI | Allow access to the Intelligent Platform Management Interface service. |
KVMIP | Allow access to a Keyboard-Video-Mouse over IP session. |
ManagerConsole | Allow access to the manager's console, which could be connected through Telnet, SSH, SM CLP, or other protocol. |
OEM | OEM account type. See the OEMAccountTypes property. |
Redfish | Allow access to the Redfish service. |
SNMP | Allow access to SNMP services. |
VirtualMedia | Allow access to control virtual media. |
WebUI | Allow access to a web user interface session, such as a graphical interface or another web-based protocol. |
Various settings to parse a TACACS+ service.
array (string (enum)) | Indicates the allowed TACACS+ password exchange protocols. For the possible property values, see PasswordExchangeProtocols in Property details. | ||
string | Indicates the name of the TACACS+ argument name in an authorization request. |
{ "@odata.type": "#AccountService.v1_8_0.AccountService", "Id": "AccountService", "Name": "Account Service", "Description": "Local Manager Account Service", "Status": { "State": "Enabled", "Health": "OK" }, "ServiceEnabled": true, "AuthFailureLoggingThreshold": 3, "MinPasswordLength": 8, "AccountLockoutThreshold": 5, "AccountLockoutDuration": 30, "AccountLockoutCounterResetAfter": 30, "AccountLockoutCounterResetEnabled": true, "Accounts": { "@odata.id": "/redfish/v1/AccountService/Accounts" }, "Roles": { "@odata.id": "/redfish/v1/AccountService/Roles" }, "LocalAccountAuth": "Enabled", "LDAP": { "AccountProviderType": "LDAPService", "ServiceEnabled": false, "ServiceAddresses": [ "ldaps://ldap.example.org:636" ], "Authentication": { "AuthenticationType": "UsernameAndPassword", "Username": "cn=Manager,dc=example,dc=org", "Password": null }, "LDAPService": { "SearchSettings": { "BaseDistinguishedNames": [ "dc=example,dc=org" ], "UsernameAttribute": "uid", "GroupsAttribute": "memberof" } }, "RemoteRoleMapping": [ { "RemoteUser": "cn=Manager,dc=example,dc=org", "LocalRole": "Administrator" }, { "RemoteGroup": "cn=Admins,ou=Groups,dc=example,dc=org", "LocalRole": "Administrator" }, { "RemoteGroup": "cn=PowerUsers,ou=Groups,dc=example,dc=org", "LocalRole": "Operator" }, { "RemoteGroup": "(cn=*)", "LocalRole": "ReadOnly" } ] }, "ActiveDirectory": { "AccountProviderType": "ActiveDirectoryService", "ServiceEnabled": true, "ServiceAddresses": [ "ad1.example.org", "ad2.example.org", null, null ], "Authentication": { "AuthenticationType": "KerberosKeytab", "KerberosKeytab": null }, "RemoteRoleMapping": [ { "RemoteGroup": "Administrators", "LocalRole": "Administrator" }, { "RemoteUser": "DOMAIN\\Bob", "LocalRole": "Operator" }, { "RemoteGroup": "PowerUsers", "LocalRole": "Operator" }, { "RemoteGroup": "Everybody", "LocalRole": "ReadOnly" } ] }, "AdditionalExternalAccountProviders": { "@odata.id": "/redfish/v1/AccountService/ExternalAccountProviders" }, "@odata.id": "/redfish/v1/AccountService" }
v1.1 | v1.0 |
2018.2 | 2016.2 |
The ActionInfo schema defines the supported parameters and other information for a Redfish action. Supported parameters can differ among vendors and even among Resource instances. This data can ensure that action requests from applications contain supported parameters.
array | The list of parameters included in the specified Redfish action. | ||
| array (string, null) | The allowable values for this parameter as applied to this action target. | |
| string (enum) | The JSON property type for this parameter. For the possible property values, see DataType in Property details. | |
| number | The maximum supported value for this parameter. | |
| number | The minimum supported value for this parameter. | |
| string | The name of the parameter for this action. | |
| string | The data type of an object-based parameter. | |
} ] | boolean | An indication of whether the parameter is required to complete this action. |
The JSON property type for this parameter.
string | Description |
---|---|
Boolean | A boolean. |
Number | A number. |
NumberArray | An array of numbers. |
Object | An embedded JSON object. |
ObjectArray | An array of JSON objects. |
String | A string. |
StringArray | An array of strings. |
{ "@odata.type": "#ActionInfo.v1_1_2.ActionInfo", "Id": "ResetActionInfo", "Name": "Reset Action Info", "Parameters": [ { "Name": "ResetType", "Required": true, "DataType": "String", "AllowableValues": [ "On", "ForceOff", "GracefulShutdown", "GracefulRestart", "ForceRestart", "Nmi", "ForceOn", "PushPowerButton" ] } ], "Oem": {}, "@odata.id": "/redfish/v1/Systems/1/ResetActionInfo" }
v1.1 | v1.0 |
2020.3 | 2019.4 |
The schema definition of an address pool and its configuration.
object | The Ethernet related properties for this address pool. | ||
| object | (null) | Bidirectional Forwarding Detection (BFD) related properties for this Ethernet fabric. |
| boolean | Bidirectional Forwarding Detection (BFD) Demand Mode status. | |
| integer | Desired Bidirectional Forwarding Detection (BFD) minimal transmit interval. | |
| string | Bidirectional Forwarding Detection (BFD) Key Chain name. | |
| integer | Bidirectional Forwarding Detection (BFD) multiplier value. | |
| boolean | Meticulous MD5 authentication of the Bidirectional Forwarding Detection (BFD) session. | |
| integer | Bidirectional Forwarding Detection (BFD) receive value. | |
} | integer | Bidirectional Forwarding Detection (BFD) source port. | |
| object | (null) | BGP Ethernet Virtual Private Network (EVPN) related properties for this Ethernet fabric. |
| string | The anycast gateway IPv4 address. | |
| string | The anycast gateway MAC address. | |
| boolean | Address Resolution Protocol (ARP) proxy status. | |
| boolean | Address Resolution Protocol (ARP) suppression status. | |
| object | (null) | The Ethernet Segment Identifier (ESI) number range for the fabric. |
| integer | Lower Ethernet Segment Identifier (ESI) number. | |
} | integer | Upper Ethernet Segment Identifier (ESI) number. | |
| object | (null) | The Ethernet Virtual Private Network (EVPN) Instance number (EVI) number range for the fabric. |
| integer | Lower Ethernet Virtual Private Network (EVPN) Instance (EVI) number. | |
} | integer | Upper Ethernet Virtual Private Network (EVPN) Instance (EVI) number. | |
| string | The gateway IPv4 address. | |
| boolean | Network Discovery Protocol (NDP) proxy status. | |
| boolean | Network Discovery Protocol (NDP) suppression status. | |
| object | (null) | The Route Distinguisher (RD) number range for the fabric. |
| integer | Lower Route Distinguisher (RD) number. | |
} | integer | Upper Route Distinguisher (RD) number. | |
| object | (null) | The Route Target (RT) number range for the fabric. |
| integer | Lower Route Target (RT) number. | |
} | integer | Upper Route Target (RT) number. | |
| boolean | Underlay multicast status. | |
| boolean | Suppression of unknown unicast packets. | |
| object | (null) | The VLAN tag range for the fabric. |
| integer | Virtual LAN (VLAN) tag lower value. | |
} } | integer | Virtual LAN (VLAN) tag upper value. | |
| object | (null) | External BGP (eBGP) related properties for this Ethernet fabric. |
| boolean | Allow duplicate Autonomous System (AS) path. | |
| boolean | Option to override an Autonomous System (AS) number with the AS number of the sending peer . | |
| boolean | Compare Multi Exit Discriminator (MED) status. | |
| object | (null) | Autonomous System (AS) number range. |
| integer | Lower Autonomous System (AS) number. | |
} | integer | Upper Autonomous System (AS) number. | |
| integer | Local preference value. | |
| object | (null) | Border Gateway Protocol (BGP) neighbor related properties. |
| string | Border Gateway Protocol (BGP) neighbor address. | |
| boolean | Allow own Autonomous System (AS) status. | |
| integer | Border Gateway Protocol (BGP) retry timer in seconds. | |
| integer | Border Gateway Protocol (BGP) hold timer in seconds. | |
| integer | Border Gateway Protocol (BGP) Keepalive timer in seconds. | |
| integer | Local Autonomous System (AS) number. | |
| boolean | Border Gateway Protocol (BGP) neighbor log state change status. | |
| object | (null) | Border Gateway Protocol (BGP) max prefix properties. |
| integer | Maximum prefix number. | |
| integer | Border Gateway Protocol (BGP) restart timer in seconds. | |
| number (%) | Shutdown threshold status. | |
} | boolean | Threshold warning only status. | |
| integer | Minimum Border Gateway Protocol (BGP) advertisement interval in seconds. | |
| boolean | Border Gateway Protocol (BGP) passive mode status. | |
| boolean | Path MTU discovery status. | |
| integer | Peer Autonomous System (AS) number. | |
| boolean | Replace Border Gateway Protocol (BGP) peer Autonomous System (AS) status. | |
| integer | TCP max segment size in Bytes. | |
} | boolean | Border Gateway Protocol (BGP) treat as withdraw status. | |
| object | (null) | Border Gateway Protocol (BGP) route related properties. |
| boolean | Advertise inactive route status. | |
| integer | Route distance for external routes. | |
| integer | Route distance for internal routes. | |
| integer | Route distance for local routes. | |
| boolean | Compare router id status. | |
| boolean | Route flap dampening status. | |
} | boolean | Send default route status. | |
| integer | BGP weight attribute. | |
| object | (null) | Graceful restart related properties. |
| boolean | Border Gateway Protocol (BGP) graceful restart status. | |
| boolean | Graceful restart helper mode status. | |
| integer | Stale route timer in seconds. | |
} | integer | Graceful restart timer in seconds. | |
| integer | BGP Multi Exit Discriminator (MED) value. | |
| boolean | External BGP (eBGP) multihop status. | |
| integer | External BGP (eBGP) multihop Time to Live (TTL) value. | |
| object | (null) | Multiple path related properties. |
| integer | Maximum paths number. | |
} | boolean | Border Gateway Protocol (BGP) multiple paths status. | |
} | boolean | This property shall indicate whether community attributes are sent. | |
| object | (null) | IPv4 and Virtual LAN (VLAN) related addressing for this Ethernet fabric. |
| string | The anycast gateway IPv4 address. | |
| string | The anycast gateway MAC address. | |
| object | (null) | The Dynamic Host Configuration Protocol (DHCP) related addressing for this Ethernet fabric. |
| integer | Dynamic Host Configuration Protocol (DHCP) interface Maximum Transmission Unit (MTU). | |
| boolean | Dynamic Host Configuration Protocol (DHCP) relay status. | |
} | array (string, null) | The Dynamic Host Configuration Protocol (DHCP) IPv4 addresses for this Ethernet fabric. | |
| boolean | Indicates if host subnets should be distributed into the fabric underlay. | |
| string | The Domain Name Service (DNS) domain name for this Ethernet fabric. | |
| array (string, null) | The Domain Name Service (DNS) servers for this Ethernet fabric. | |
| object | (null) | External BGP (eBGP) related addressing for this Ethernet fabric. For more information about this property, see IPv4AddressRange in Property Details. |
| object | (null) | Link related addressing for this Ethernet fabric. For more information about this property, see IPv4AddressRange in Property Details. |
| string | The gateway IPv4 address. | |
| object | (null) | IPv4 related end host subnet addressing for this Ethernet fabric. For more information about this property, see IPv4AddressRange in Property Details. |
| object | (null) | Internal BGP (iBGP) related addressing for this Ethernet fabric. For more information about this property, see IPv4AddressRange in Property Details. |
| object | (null) | Loopback related addressing for this Ethernet fabric. For more information about this property, see IPv4AddressRange in Property Details. |
| object | (null) | Management related addressing for this Ethernet fabric. For more information about this property, see IPv4AddressRange in Property Details. |
| integer | The native Virtual LAN (VLAN) tag value. | |
| integer | The Network Time Protocol (NTP) offset configuration. | |
| array (string, null) | The Network Time Protocol (NTP) servers for this Ethernet fabric. | |
| string | The Network Time Protocol (NTP) timezone for this Ethernet fabric. | |
| object | (null) | Virtual LAN (VLAN) tag related addressing for this Ethernet fabric or for end host networks. |
| integer | Virtual LAN (VLAN) tag lower value. | |
} } | integer | Virtual LAN (VLAN) tag upper value. | |
| object | (null) | Multi Protocol eBGP (MP eBGP) related properties for this Ethernet fabric. |
| boolean | Allow duplicate Autonomous System (AS) path. | |
| boolean | Option to override an Autonomous System (AS) number with the AS number of the sending peer . | |
| boolean | Compare Multi Exit Discriminator (MED) status. | |
| object | (null) | Autonomous System (AS) number range. |
| integer | Lower Autonomous System (AS) number. | |
} | integer | Upper Autonomous System (AS) number. | |
| integer | Local preference value. | |
| object | (null) | Border Gateway Protocol (BGP) neighbor related properties. |
| string | Border Gateway Protocol (BGP) neighbor address. | |
| boolean | Allow own Autonomous System (AS) status. | |
| integer | Border Gateway Protocol (BGP) retry timer in seconds. | |
| integer | Border Gateway Protocol (BGP) hold timer in seconds. | |
| integer | Border Gateway Protocol (BGP) Keepalive timer in seconds. | |
| integer | Local Autonomous System (AS) number. | |
| boolean | Border Gateway Protocol (BGP) neighbor log state change status. | |
| object | (null) | Border Gateway Protocol (BGP) max prefix properties. |
| integer | Maximum prefix number. | |
| integer | Border Gateway Protocol (BGP) restart timer in seconds. | |
| number (%) | Shutdown threshold status. | |
} | boolean | Threshold warning only status. | |
| integer | Minimum Border Gateway Protocol (BGP) advertisement interval in seconds. | |
| boolean | Border Gateway Protocol (BGP) passive mode status. | |
| boolean | Path MTU discovery status. | |
| integer | Peer Autonomous System (AS) number. | |
| boolean | Replace Border Gateway Protocol (BGP) peer Autonomous System (AS) status. | |
| integer | TCP max segment size in Bytes. | |
} | boolean | Border Gateway Protocol (BGP) treat as withdraw status. | |
| object | (null) | Border Gateway Protocol (BGP) route related properties. |
| boolean | Advertise inactive route status. | |
| integer | Route distance for external routes. | |
| integer | Route distance for internal routes. | |
| integer | Route distance for local routes. | |
| boolean | Compare router id status. | |
| boolean | Route flap dampening status. | |
} | boolean | Send default route status. | |
| integer | BGP weight attribute. | |
| object | (null) | Graceful restart related properties. |
| boolean | Border Gateway Protocol (BGP) graceful restart status. | |
| boolean | Graceful restart helper mode status. | |
| integer | Stale route timer in seconds. | |
} | integer | Graceful restart timer in seconds. | |
| integer | BGP Multi Exit Discriminator (MED) value. | |
| boolean | External BGP (eBGP) multihop status. | |
| integer | External BGP (eBGP) multihop Time to Live (TTL) value. | |
| object | (null) | Multiple path related properties. |
| integer | Maximum paths number. | |
} | boolean | Border Gateway Protocol (BGP) multiple paths status. | |
} | boolean | This property shall indicate whether community attributes are sent. | |
| object | (null) | Multi Protocol iBGP (MP iBGP) related properties for this Ethernet fabric. |
| object | (null) | Autonomous System (AS) number range. |
| integer | Lower Autonomous System (AS) number. | |
} | integer | Upper Autonomous System (AS) number. | |
| object | (null) | Border Gateway Protocol (BGP) neighbor related properties. |
| string | Border Gateway Protocol (BGP) neighbor address. | |
| boolean | Allow own Autonomous System (AS) status. | |
| integer | Border Gateway Protocol (BGP) retry timer in seconds. | |
| integer | Border Gateway Protocol (BGP) hold timer in seconds. | |
| integer | Border Gateway Protocol (BGP) Keepalive timer in seconds. | |
| integer | Local Autonomous System (AS) number. | |
| boolean | Border Gateway Protocol (BGP) neighbor log state change status. | |
| object | (null) | Border Gateway Protocol (BGP) max prefix properties. |
| integer | Maximum prefix number. | |
| integer | Border Gateway Protocol (BGP) restart timer in seconds. | |
| number (%) | Shutdown threshold status. | |
} | boolean | Threshold warning only status. | |
| integer | Minimum Border Gateway Protocol (BGP) advertisement interval in seconds. | |
| boolean | Border Gateway Protocol (BGP) passive mode status. | |
| boolean | Path MTU discovery status. | |
| integer | Peer Autonomous System (AS) number. | |
| boolean | Replace Border Gateway Protocol (BGP) peer Autonomous System (AS) status. | |
| integer | TCP max segment size in Bytes. | |
} | boolean | Border Gateway Protocol (BGP) treat as withdraw status. | |
| object | (null) | Border Gateway Protocol (BGP) route related properties. |
| boolean | Advertise inactive route status. | |
| integer | Route distance for external routes. | |
| integer | Route distance for internal routes. | |
| integer | Route distance for local routes. | |
| boolean | Compare router id status. | |
| boolean | Route flap dampening status. | |
} | boolean | Send default route status. | |
| object | (null) | Graceful restart related properties. |
| boolean | Border Gateway Protocol (BGP) graceful restart status. | |
| boolean | Graceful restart helper mode status. | |
| integer | Stale route timer in seconds. | |
} | integer | Graceful restart timer in seconds. | |
| object | (null) | Multiple path related properties. |
| integer | Maximum paths number. | |
} | boolean | Border Gateway Protocol (BGP) multiple paths status. | |
} } | boolean | This property shall indicate whether community attributes are sent. | |
object | The Gen-Z related properties for this address pool. | ||
| string | The Access Key required for this address pool. | |
| integer | The maximum value for the Component Identifier (CID). | |
| integer | The maximum value for the Subnet Identifier (SID). | |
| integer | The minimum value for the Component Identifier (CID). | |
} | integer | The minimum value for the Subnet Identifier (SID). | |
object | The links to other resources that are related to this resource. | ||
| array | An array of links to the endpoints that this address pool contains. | |
} ] | string | Link to a Endpoint resource. See the Links section and the Endpoint schema for details. | |
| object | See the Oem object definition in the Common properties section. | |
| array | An array of links to the zones that this address pool contains. | |
} ] } | string | Link to a Zone resource. See the Links section and the Zone schema for details. | |
object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. |
IPv4 related address range for an Ethernet fabric.
string | Lower IPv4 network address. | ||
string | Upper IPv4 network address. |
{ "@odata.type": "#AddressPool.v1_0_0.AddressPool", "Id": "AP1", "Name": "Address Pool 1", "Description": "Address Pool 1", "Status": { "State": "Enabled", "Health": "OK" }, "GenZ": { "MinCID": 1, "MaxCID": 4096, "MinSID": 100, "MaxSID": 8192, "AccessKey": "0x1A" }, "Links": { "Endpoints": [ { "@odata.id": "/redfish/v1/Fabrics/GenZ/Endpoints/1" } ] }, "Oem": {}, "@odata.id": "/redfish/v1/Fabrics/GenZ/AddressPools/AP1" }
v1.0 |
2020.2 |
The Aggregate schema describes a grouping method for an aggregation service. Aggregates are formal groups of resources that are more persistent than ad hoc groupings.
array | | The elements of this aggregate. | |
} ] | |||
integer | The number of entries in the Elements array. |
This action is used to add one or more resources to the aggregate.
Action URI: {Base URI of target resource}/Actions/Aggregate.AddElementsPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| array | | An array of resource links to add to the Elements array. |
} ] } |
This action is used to remove one or more resources from the aggregate.
Action URI: {Base URI of target resource}/Actions/Aggregate.RemoveElementsPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| array | | An array of resource links to remove from the Elements array. |
} ] } |
This action is used to reset a collection of resources. For example, this could be an aggregate or a list of computer systems.
Action URI: {Base URI of target resource}/Actions/Aggregate.ResetPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| integer | optional | The number of elements in each batch being reset. |
| integer (seconds) | optional | The delay of the batches of elements being reset in seconds. |
} | string (enum) | optional | The type of reset. For the possible property values, see ResetType in Property details. |
This action is used to restore the boot order to the default state for the computer systems that are members of this aggregate.
Action URI: {Base URI of target resource}/Actions/Aggregate.SetDefaultBootOrderPerform the action using a POST to the specific Action URI for this resource. This action takes no parameters.
The type of reset.
string | Description |
---|---|
ForceOff | Turn off the unit immediately (non-graceful shutdown). |
ForceOn | Turn on the unit immediately. |
ForceRestart | Shut down immediately and non-gracefully and restart the system. |
GracefulRestart | Shut down gracefully and restart the system. |
GracefulShutdown | Shut down gracefully and power off. |
Nmi | Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system. |
On | Turn on the unit. |
PowerCycle | Power cycle the unit. Behaves like a full power removal, followed by a power restore to the resource. |
PushPowerButton | Simulate the pressing of the physical power button on this unit. |
v1.0 |
2020.2 |
The AggregationService schema contains properties for managing aggregation operations, either on ad hoc combinations of resources or on defined sets of resources called aggregates. Access points define the properties needed to access the entity being aggregated and connection methods describe the protocol or other semantics of the connection.
object | The link to the collection of aggregates associated with this service. Contains a link to a resource. | ||
} | string | Link to Collection of Aggregate. See the Aggregate schema for details. | |
object | The link to the collection of aggregation sources associated with this service. Contains a link to a resource. | ||
} | string | Link to Collection of AggregationSource. See the AggregationSource schema for details. | |
object | The link to the collection of connection methods associated with this service. Contains a link to a resource. | ||
} | string | Link to Collection of ConnectionMethod. See the ConnectionMethod schema for details. | |
boolean | An indication of whether the aggregation service is enabled. | ||
object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. |
This action is used to reset a set of resources. For example this could be a list of computer systems.
Action URI: {Base URI of target resource}/Actions/AggregationService.ResetPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| integer | optional | The number of elements in each batch being reset. |
| integer (seconds) | optional | The delay of the batches of elements being reset in seconds. |
| string (enum) | optional | The type of reset. For the possible property values, see ResetType in Property details. |
| array | | An array of links to the resources being reset. |
} ] } |
This action is used to restore the boot order to the default state for the specified computer systems.
Action URI: {Base URI of target resource}/Actions/AggregationService.SetDefaultBootOrderPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| array | | The computer systems to restore. |
} ] } | string | Link to a ComputerSystem resource. See the Links section and the ComputerSystem schema for details. |
The type of reset.
string | Description |
---|---|
ForceOff | Turn off the unit immediately (non-graceful shutdown). |
ForceOn | Turn on the unit immediately. |
ForceRestart | Shut down immediately and non-gracefully and restart the system. |
GracefulRestart | Shut down gracefully and restart the system. |
GracefulShutdown | Shut down gracefully and power off. |
Nmi | Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system. |
On | Turn on the unit. |
PowerCycle | Power cycle the unit. Behaves like a full power removal, followed by a power restore to the resource. |
PushPowerButton | Simulate the pressing of the physical power button on this unit. |
v1.1 | v1.0 |
2020.4 | 2020.2 |
The AggregationSource schema is used to represent the source of information for a subset of the resources provided by a Redfish service. It can be thought of as a provider of information. As such, most such interfaces have requirements to support the gathering of information like address and account used to access the information.
string (URI) | The URI of the system to be accessed. | ||
object | The links to other resources that are related to this resource. | ||
| object | (null) | An array of links to the connection methods used to contact this aggregation source. See the ConnectionMethod schema for details on this property. |
} | string | Link to a ConnectionMethod resource. See the Links section and the ConnectionMethod schema for details. | |
| object | See the Oem object definition in the Common properties section. | |
| array | An array links to the resources added to the service through this aggregation source. It is recommended that this be the minimal number of properties needed to find the resources that would be lost when the aggregation source is deleted. | |
} ] } | |||
string | The password for accessing the aggregation source. The value is null in responses. | ||
object | (null) | SNMP settings of the aggregation source. | |
| string | The secret authentication key for SNMPv3. | |
| boolean | Indicates if the AuthenticationKey property is set. | |
| string (enum) | The authentication protocol for SNMPv3. For the possible property values, see AuthenticationProtocol in Property details. | |
| string | The secret authentication key for SNMPv3. | |
| boolean | Indicates if the EncryptionKey property is set. | |
} | string (enum) | The encryption protocol for SNMPv3. For the possible property values, see EncryptionProtocol in Property details. | |
string | The user name for accessing the aggregation source. |
The authentication protocol for SNMPv3.
string | Description |
---|---|
CommunityString | Trap community string authentication. |
HMAC128_SHA224 | HMAC-128-SHA-224 authentication. |
HMAC192_SHA256 | HMAC-192-SHA-256 authentication. |
HMAC256_SHA384 | HMAC-256-SHA-384 authentication. |
HMAC384_SHA512 | HMAC-384-SHA-512 authentication. |
HMAC_MD5 | HMAC-MD5-96 authentication. |
HMAC_SHA96 | HMAC-SHA-96 authentication. |
None | No authentication. |
The encryption protocol for SNMPv3.
string | Description |
---|---|
CBC_DES | CBC-DES encryption. |
CFB128_AES128 | CFB128-AES-128 encryption. |
None | No encryption. |
v1.3 | v1.2 | v1.1 | v1.0 |
2020.3 | 2018.2 | 2018.1 | 2017.3 |
The Assembly schema defines an assembly. Assembly information contains details about a device, such as part number, serial number, manufacturer, and production date. It also provides access to the original data for the assembly.
array | The assembly records. | ||
| string (URI) | The unique identifier for a resource. | |
| object | The available actions for this Resource. | |
| string (URI) | The URI at which to access an image of the assembly information. | |
| string | The description of the assembly. | |
| string | The engineering change level of the assembly. | |
| object | The location of the assembly. For property details, see Location. | |
| boolean | An indicator allowing an operator to physically locate this resource. | |
| string | The identifier for the member within the collection. | |
| string | The model number of the assembly. | |
| string | The name of the assembly. | |
| object | See the Oem object definition in the Common properties section. | |
| string | The part number of the assembly. | |
| string (enum) | The area or device to which the assembly data applies. For the possible property values, see PhysicalContext in Property details. | |
| string | The producer or manufacturer of the assembly. | |
| string (date-time) | The production date of the assembly. | |
| string | The serial number of the assembly. | |
| string | The SKU of the assembly. | |
| string | The spare part number of the assembly. | |
| object | The status and health of the Resource and its subordinate or dependent Resources. For property details, see Status. | |
| string | The vendor of the assembly. | |
} ] | string | The hardware version of the assembly. |
The area or device to which the assembly data applies.
string | Description |
---|---|
Accelerator | An accelerator. |
ACInput | An AC input. |
ACMaintenanceBypassInput | An AC maintenance bypass input. |
ACOutput | An AC output. |
ACStaticBypassInput | An AC static bypass input. |
ACUtilityInput | An AC utility input. |
ASIC | An ASIC device, such as a networking chip or chipset component. |
Back | The back of the chassis. |
Backplane | A backplane within the chassis. |
Chassis | The entire chassis. |
ComputeBay | Within a compute bay. |
CoolingSubsystem | The entire cooling, or air and liquid, subsystem. |
CPU | A processor (CPU). |
CPUSubsystem | The entire processor (CPU) subsystem. |
DCBus | A DC bus. |
Exhaust | The air exhaust point or points or region of the chassis. |
ExpansionBay | Within an expansion bay. |
Fan | A fan. |
FPGA | An FPGA. |
Front | The front of the chassis. |
GPU | A graphics processor (GPU). |
GPUSubsystem | The entire graphics processor (GPU) subsystem. |
Intake | The air intake point or points or region of the chassis. |
LiquidInlet | The liquid inlet point of the chassis. |
LiquidOutlet | The liquid outlet point of the chassis. |
Lower | The lower portion of the chassis. |
Memory | A memory device. |
MemorySubsystem | The entire memory subsystem. |
Motor | A motor. |
NetworkBay | Within a networking bay. |
NetworkingDevice | A networking device. |
PowerSubsystem | The entire power subsystem. |
PowerSupply | A power supply. |
PowerSupplyBay | Within a power supply bay. |
Rectifier | A rectifier device. |
Room | The room. |
StorageBay | Within a storage bay. |
StorageDevice | A storage device. |
SystemBoard | The system board (PCB). |
Transformer | A transformer. |
TrustedModule | A trusted module. |
Upper | The upper portion of the chassis. |
VoltageRegulator | A voltage regulator device. |
{ "@odata.type": "#Assembly.v1_3_0.Assembly", "Id": "Assembly", "Name": "System-related Assembly data", "Assemblies": [ { "@odata.id": "/redfish/v1/Chassis/1/Assembly#/Assemblies/0", "MemberId": "0", "Name": "System Board", "Description": "PCA System Board", "Model": "345TTT", "PartNumber": "923943", "SparePartNumber": "55-434", "SKU": "55ZZATR", "SerialNumber": "345394834", "Vendor": "Contoso", "ProductionDate": "2017-04-01T14:55:33+03:00", "Producer": "Contoso Supply Co.", "Version": "1.44B", "EngineeringChangeLevel": "9", "BinaryDataURI": "/dumpster/434", "Oem": { "Contoso": { "Region": "C", "Packaging": "Retail" } } }, { "@odata.id": "/redfish/v1/Chassis/1/Assembly#/Assemblies/1", "MemberId": "1", "Name": "Fan Controller", "Description": "PCA Fan Controller", "Model": "F58AS", "PartNumber": "3434-149", "Vendor": "Contoso", "Version": "2.4.481", "BinaryDataURI": "/dumpster/422", "Status": { "State": "Enabled", "Health": "Warning" } } ], "@odata.id": "/redfish/v1/Chassis/1/Assembly" }
v1.3 | v1.2 | v1.1 | v1.0 |
2018.3 | 2018.1 | 2017.1 | 2016.1 |
The AttributeRegistry schema contains a set of key-value pairs that represent the structure of an attribute registry. It includes mechanisms for building user interfaces, or menus, allowing consistent navigation of the contents. The attribute registry is specific to an implementation or product. The attributes and property names are not standardized.
string | The RFC5646-conformant language code for the attribute registry. | ||
string | The organization or company that publishes this attribute registry. | ||
object | The list of all attributes and their metadata for this component. | ||
| array | An array of attributes and their possible values in the attribute registry. | |
| string | The unique name for the attribute. | |
| string, boolean, number | The placeholder of the current value for the attribute. | |
| string, boolean, number | The default value for the attribute. | |
| string | The user-readable display string for the attribute in the defined language. | |
| integer | The ascending order, as a number, in which this attribute appears relative to other attributes. | |
| boolean | An indication of whether this attribute is grayed out. A grayed-out attribute is not active and is grayed out in user interfaces but the attribute value can be modified. | |
| string | The help text for the attribute. | |
| boolean | An indication of whether this attribute is hidden in user interfaces. | |
| boolean | An indication of whether this attribute is immutable. Immutable attributes shall not be modified and typically reflect a hardware state. | |
| boolean | An indication of whether this attribute is unique for this system and should not be replicated. | |
| integer | The lower limit for an integer attribute. | |
| integer | The maximum character length of a string attribute. | |
| string | The path that describes the menu hierarchy of this attribute. | |
| integer | The minimum character length of the string attribute. | |
| object | See the Oem object definition in the Common properties section. | |
| boolean | An indication of whether this attribute is read-only. A read-only attribute cannot be modified, and should be grayed out in user interfaces. | |
| boolean | An indication of whether a system or device reset is required for this attribute value change to take effect. | |
| integer | The amount to increment or decrement an integer attribute each time a user requests a value change. The 0 value indicates a free-form numeric user-input attribute. | |
| string (enum) | The attribute type. For the possible property values, see Type in Property details. | |
| string | The UEFI device path that qualifies this attribute. | |
| string | The UEFI keyword string for this attribute. | |
| string | The UEFI namespace ID for the attribute. | |
| integer | The upper limit for an integer attribute. | |
| array | An array of the possible values for enumerated attribute values. | |
| string | A user-readable display string of the value for the attribute in the defined language. | |
} ] | string | The unique value name for the attribute. | |
| string | A valid regular expression, according to the Perl regular expression dialect, that validates the attribute value. Applies to only string and integer attributes. | |
| string | The warning text for the attribute. | |
} ] | boolean | An indication of whether this attribute is write-only. A write-only attribute reverts to its initial value after settings are applied. | |
| array | An array of dependencies of attributes on this component. | |
| object | The dependency expression for one or more attributes in this attribute registry. | |
| array | An array of the map-from conditions for a mapping dependency. | |
| string | The attribute to use to evaluate this dependency expression. | |
| string (enum) | The condition to use to evaluate this dependency expression. For the possible property values, see MapFromCondition in Property details. | |
| string (enum) | The metadata property for the attribute that the MapFromAttribute property specifies to use to evaluate this dependency expression. For the possible property values, see MapFromProperty in Property details. | |
| string, boolean, number | The value to use to evaluate this dependency expression. | |
} ] | string (enum) | The logical term that combines two or more map-from conditions in this dependency expression. For example, AND for logical AND, or OR for logical OR.For the possible property values, see MapTerms in Property details. | |
| string | The AttributeName of the attribute that is affected by this dependency expression. | |
| string (enum) | The metadata property for the attribute that contains the map-from condition that evaluates this dependency expression. For the possible property values, see MapToProperty in Property details. | |
} | string, boolean, number | The value that the map-to property changes to if the dependency expression evaluates to true . | |
| string | The AttributeName of the attribute whose change triggers the evaluation of this dependency expression. | |
} ] | string (enum) | The type of the dependency structure. For the possible property values, see Type in Property details. | |
| array | An array for the attributes menus and their hierarchy in the attribute registry. | |
| string | The user-readable display string of this menu in the defined language. | |
| integer | The ascending order, as a number, in which this menu appears relative to other menus. | |
| boolean | An indication of whether this menu is grayed out. A grayed-only menu is not accessible in user interfaces. | |
| boolean | An indication of whether this menu is hidden in user interfaces. | |
| string | The unique name string of this menu. | |
| string | The path to the menu names that describes this menu hierarchy relative to other menus. | |
| object | See the Oem object definition in the Common properties section. | |
} ] } | boolean | An indication of whether this menu is read-only. A read-only menu, its properties, and sub-menus are not accessible in user interfaces. | |
string | The attribute registry version. | ||
array | An array of systems that this attribute registry supports. | ||
| string | Firmware version. | |
| string | The product name of the computer system to which this attribute registry applies. | |
} ] | string | The ID of the systems to which this attribute registry applies. |
The condition to use to evaluate this dependency expression.
string | Description |
---|---|
EQU | The logical operation for 'Equal'. |
GEQ | The logical operation for 'Greater than or Equal'. |
GTR | The logical operation for 'Greater than'. |
LEQ | The logical operation for 'Less than or Equal'. |
LSS | The logical operation for 'Less than'. |
NEQ | The logical operation for 'Not Equal'. |
The metadata property for the attribute that the MapFromAttribute property specifies to use to evaluate this dependency expression.
string | Description |
---|---|
CurrentValue | The dependency on an attribute's CurrentValue. |
DefaultValue | The dependency on an attribute's DefaultValue. |
GrayOut | The dependency on an attribute's GrayOut state. |
Hidden | The dependency on an attribute's Hidden state. |
LowerBound | The dependency on an attribute's LowerBound. |
MaxLength | The dependency on an attribute's MaxLength. |
MinLength | The dependency on an attribute's MinLength. |
ReadOnly | The dependency on an attribute's ReadOnly state. |
ScalarIncrement | The dependency on an attribute's ScalarIncrement. |
UpperBound | The dependency on an attribute's UpperBound. |
WriteOnly | The dependency on an attribute's WriteOnly state. |
The logical term that combines two or more map-from conditions in this dependency expression. For example, `AND` for logical AND, or `OR` for logical OR.
string | Description |
---|---|
AND | The operation used for logical 'AND' of dependency terms. |
OR | The operation used for logical 'OR' of dependency terms. |
The metadata property for the attribute that contains the map-from condition that evaluates this dependency expression.
string | Description |
---|---|
CurrentValue | The dependency that affects an attribute's CurrentValue. |
DefaultValue | The dependency that affects an attribute's DefaultValue. |
DisplayName | The dependency that affects an attribute's DisplayName. |
DisplayOrder | The dependency that affects an attribute's DisplayName. |
GrayOut | The dependency that affects an attribute's GrayOut state. |
HelpText | The dependency that affects an attribute's HelpText. |
Hidden | The dependency that affects an attribute's Hidden state. |
Immutable | The dependency that affects an attribute's Immutable state. |
LowerBound | The dependency that affects an attribute's LowerBound. |
MaxLength | The dependency that affects an attribute's MaxLength. |
MinLength | The dependency that affects an attribute's MinLength. |
ReadOnly | The dependency that affects an attribute's ReadOnly state. |
ScalarIncrement | The dependency that affects an attribute's ScalarIncrement. |
UpperBound | The dependency that affects an attribute's UpperBound. |
ValueExpression | The dependency that affects an attribute's ValueExpression. |
WarningText | The dependency that affects an attribute's WarningText. |
WriteOnly | The dependency that affects an attribute's WriteOnly state. |
The attribute type.
string | Description |
---|---|
Boolean | A flag with a `true` or `false` value. |
Enumeration | A list of the known possible enumerated values. |
Integer | An integer value. |
Password | Password values that do not appear as plain text. The value shall be null in responses. |
String | Free-form text in their values. |
The type of the dependency structure.
string | Description |
---|---|
Map | A simple mapping dependency. If the condition evaluates to `true`, the attribute or state changes to the mapped value. |
{ "@odata.type": "#AttributeRegistry.v1_3_5.AttributeRegistry", "Description": "This registry defines a representation of BIOS Attribute instances", "Id": "BiosAttributeRegistryG9000.v1_0_0", "Language": "en", "Name": "G9000 BIOS Attribute Registry", "OwningEntity": "Contoso", "RegistryVersion": "1.0.0", "SupportedSystems": [ { "ProductName": "Contoso Server GLH9000", "SystemId": "G9000", "FirmwareVersion": "v1.00 (06/02/2014)" } ], "RegistryEntries": { "Attributes": [ { "CurrentValue": null, "DisplayName": "Embedded NIC 1 Boot", "DisplayOrder": 5, "HelpText": "Select this option to enable network boot (PXE, iSCSI, or FCoE) for the selected NIC. You may need to configure the NIC firmware for the boot option to be active.", "MenuPath": "./SystemOptions/NetworkBootOptions", "AttributeName": "NicBoot1", "ReadOnly": false, "Hidden": false, "Type": "Enumeration", "Value": [ { "ValueDisplayName": "Network Boot", "ValueName": "NetworkBoot" }, { "ValueDisplayName": "Disabled", "ValueName": "Disabled" } ], "WarningText": "Important: When enabling network boot support for an embedded NIC, the NIC boot option does not appear in the UEFI Boot Order or Legacy IPL lists until the next system reboot." }, { "CurrentValue": null, "DisplayName": "Embedded SATA Configuration", "DisplayOrder": 74, "HelpText": "Important: Select this option to configure the embedded chipset SATA controller.", "MenuPath": "./SystemOptions/SataOptions", "AttributeName": "EmbeddedSata", "ReadOnly": false, "Hidden": false, "Type": "Enumeration", "Value": [ { "ValueDisplayName": "Enable SATA AHCI Support", "ValueName": "Ahci" }, { "ValueDisplayName": "Enable Software RAID Support", "ValueName": "Raid" } ], "WarningText": "Important: Software RAID is not supported when the Boot Mode is configured in Legacy BIOS Mode." } ], "Dependencies": [ { "Dependency": { "MapFrom": [ { "MapFromAttribute": "BootMode", "MapFromCondition": "EQU", "MapFromProperty": "CurrentValue", "MapFromValue": "LegacyBios" } ], "MapToAttribute": "EmbeddedSata", "MapToProperty": "ReadOnly", "MapToValue": true }, "DependencyFor": "EmbeddedSata", "Type": "Map" } ], "Menus": [ { "DisplayName": "BIOS Configuration", "DisplayOrder": 1, "MenuPath": "./", "MenuName": "BiosMainMenu", "Hidden": false, "ReadOnly": false }, { "DisplayName": "System Options", "DisplayOrder": 2, "MenuPath": "./SystemOptions", "MenuName": "SystemOptions", "Hidden": false, "ReadOnly": false } ] } }
v1.1 | v1.0 |
2019.2 | 2016.1 |
The Bios schema contains properties related to the BIOS attribute registry. The attribute registry describes the system-specific BIOS attributes and actions for changing to BIOS settings. Changes to the BIOS typically require a system reset before they take effect. It is likely that a client finds the @Redfish.Settings
term in this resource, and if it is found, the client makes requests to change BIOS settings by modifying the resource identified by the @Redfish.Settings
term.
string | The resource ID of the attribute registry that has the system-specific information about a BIOS resource. | ||
object | The list of BIOS attributes specific to the manufacturer or provider. | ||
} | string, boolean, number | Property names follow regular expression pattern "^[A-Za-z][A-Za-z0-9_]+$" | |
object | The links to other resources that are related to this resource. | ||
| object | The link to the software inventory that represents the active BIOS firmware image. See the SoftwareInventory schema for details on this property. | |
} | string | Link to a SoftwareInventory resource. See the Links section and the SoftwareInventory schema for details. | |
| object | See the Oem object definition in the Common properties section. | |
| array | The images that are associated with this BIOS. | |
} ] } | string | Link to a SoftwareInventory resource. See the Links section and the SoftwareInventory schema for details. |
This action changes a BIOS password.
Action URI: {Base URI of target resource}/Actions/Bios.ChangePasswordPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| string | | The new BIOS password. |
| string | | The existing BIOS password. |
} | string | | The name of the BIOS password to change. |
This action resets the BIOS attributes to default.
Action URI: {Base URI of target resource}/Actions/Bios.ResetBiosPerform the action using a POST to the specific Action URI for this resource. This action takes no parameters.
{ "@odata.type": "#Bios.v1_1_1.Bios", "Id": "BIOS", "Name": "BIOS Configuration Current Settings", "AttributeRegistry": "BiosAttributeRegistryP89.v1_0_0", "Attributes": { "AdminPhone": "", "BootMode": "Uefi", "EmbeddedSata": "Raid", "NicBoot1": "NetworkBoot", "NicBoot2": "Disabled", "PowerProfile": "MaxPerf", "ProcCoreDisable": 0, "ProcHyperthreading": "Enabled", "ProcTurboMode": "Enabled", "UsbControl": "UsbEnabled" }, "@Redfish.Settings": { "@odata.type": "#Settings.v1_3_3.Settings", "ETag": "9234ac83b9700123cc32", "Messages": [ { "MessageId": "Base.1.0.SettingsFailed", "RelatedProperties": [ "#/Attributes/ProcTurboMode" ] } ], "SettingsObject": { "@odata.id": "/redfish/v1/Systems/437XR1138R2/Bios/Settings" }, "Time": "2016-03-07T14:44.30-05:00" }, "Actions": { "#Bios.ResetBios": { "target": "/redfish/v1/Systems/437XR1138R2/Bios/Actions/Bios.ResetBios" }, "#Bios.ChangePassword": { "target": "/redfish/v1/Systems/437XR1138R2/Bios/Actions/Bios.ChangePassword" } }, "@odata.id": "/redfish/v1/Systems/437XR1138R2/Bios" }
v1.0 |
2017.3 |
The BootOption schema reports information about a single boot option in a system. It represents the properties of a bootable device available in the system.
string (enum) | The alias of this boot source. For the possible property values, see Alias in Property details. | ||
boolean | An indication of whether the boot option is enabled. If true , it is enabled. If false , the boot option that the boot order array on the computer system contains is skipped. In the UEFI context, this property shall influence the load option active flag for the boot option. | ||
string | The unique boot option. | ||
string | The user-readable display name of the boot option that appears in the boot order list in the user interface. | ||
array | An array of links to resources or objects associated with this boot option. | ||
} ] | string (URI) | The unique identifier for a resource. | |
string | The UEFI device path to access this UEFI boot option. |
The alias of this boot source.
string | Description |
---|---|
BiosSetup | Boot to the BIOS setup utility. |
Cd | Boot from the CD or DVD. |
Diags | Boot to the manufacturer's diagnostics program. |
Floppy | Boot from the floppy disk drive. |
Hdd | Boot from a hard drive. |
None | Boot from the normal boot device. |
Pxe | Boot from the Pre-Boot EXecution (PXE) environment. |
RemoteDrive | Boot from a remote drive, such as an iSCSI target. |
SDCard | Boot from an SD card. |
UefiBootNext | Boot to the UEFI device that the BootNext property specifies. |
UefiHttp | Boot from a UEFI HTTP network location. |
UefiShell | Boot to the UEFI Shell. |
UefiTarget | Boot to the UEFI device specified in the UefiTargetBootSourceOverride property. |
Usb | Boot from a system BIOS-specified USB device. |
Utilities | Boot to the manufacturer's utilities program or programs. |
{ "@odata.type": "#BootOption.v1_0_4.BootOption", "Id": "1", "Name": "Boot Option", "Description": "UEFI Boot Option", "BootOptionReference": "Boot0000", "DisplayName": "Windows Boot Manager", "UefiDevicePath": "PciRoot(0x0)/Pci(0x1,0x0)/Pci(0x0,0x0)/Scsi(0x0,0x0)/HD(2,GPT,B02BF459-8975-4222-A1C4-17915C29E5E5,0x96800,0x31800)/\\EFI\\Microsoft\\Boot\\bootmgfw.efi", "Alias": "Hdd", "RelatedItem": [ { "@odata.id": "/redfish/v1/Systems/1/SimpleStorage/1" } ], "Oem": {}, "@odata.id": "/redfish/v1/Systems/1/BootOptions/1" }
v1.2 | v1.1 | v1.0 |
2020.1 | 2019.1 | 2018.3 |
The Certificate schema describes a certificate that proves the identify of a component, account, or service.
string | The string for the certificate. | ||
string (enum) | The format of the certificate. For the possible property values, see CertificateType in Property details. | ||
object | The issuer of the certificate. | ||
| string | The city or locality of the organization of the entity. | |
| string | The fully qualified domain name of the entity. | |
| string | The country of the organization of the entity. | |
| string | The email address of the contact within the organization of the entity. | |
| string | The name of the organization of the entity. | |
| string | The name of the unit or division of the organization of the entity. | |
} | string | The state, province, or region of the organization of the entity. | |
array (string (enum)) | The key usage extension, which defines the purpose of the public keys in this certificate. The usages of a key contained within a certificate. For the possible property values, see KeyUsage in Property details. | ||
object | The subject of the certificate. | ||
| string | The city or locality of the organization of the entity. | |
| string | The fully qualified domain name of the entity. | |
| string | The country of the organization of the entity. | |
| string | The email address of the contact within the organization of the entity. | |
| string | The name of the organization of the entity. | |
| string | The name of the unit or division of the organization of the entity. | |
} | string | The state, province, or region of the organization of the entity. | |
string | The UEFI signature owner for this certificate. | ||
string (date-time) | The date when the certificate is no longer valid. | ||
string (date-time) | The date when the certificate becomes valid. |
This action generates a new key-pair for a certificate and produces a certificate signing request.
Action URI: {Base URI of target resource}/Actions/Certificate.RekeyPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| string | optional | The challenge password to apply to the certificate for revocation requests. |
| integer | optional | The length of the key, in bits, if needed based on the KeyPairAlgorithm parameter value. |
| string | optional | The curve ID to use with the key, if needed based on the KeyPairAlgorithm parameter value. |
} | string | optional | The type of key-pair for use with signing algorithms. |
Response Payload
{ | |||
| object | | The link to the certificate being rekeyed. |
} | string | Link to another Certificate resource. | |
} | string | The string for the certificate signing request. |
This action generates a certificate signing request by using the existing information and key-pair of the certificate.
Action URI: {Base URI of target resource}/Actions/Certificate.RenewPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
} | string | optional | The challenge password to apply to the certificate for revocation requests. |
Response Payload
{ | |||
| object | | The link to the certificate being renewed. |
} | string | Link to another Certificate resource. | |
} | string | The string for the certificate signing request. |
The format of the certificate.
string | Description |
---|---|
PEM | A Privacy Enhanced Mail (PEM)-encoded certificate. |
PKCS7 | A Privacy Enhanced Mail (PEM)-encoded PKCS7 certificate. |
The key usage extension, which defines the purpose of the public keys in this certificate. The usages of a key contained within a certificate.
string | Description |
---|---|
ClientAuthentication | TLS WWW client authentication. |
CodeSigning | Signs downloadable executable code. |
CRLSigning | Verifies signatures on certificate revocation lists (CRLs). |
DataEncipherment | Directly enciphers raw user data without an intermediate symmetric cipher. |
DecipherOnly | Deciphers data while performing a key agreement. |
DigitalSignature | Verifies digital signatures, other than signatures on certificates and CRLs. |
EmailProtection | Email protection. |
EncipherOnly | Enciphers data while performing a key agreement. |
KeyAgreement | Key agreement. |
KeyCertSign | Verifies signatures on public key certificates. |
KeyEncipherment | Enciphers private or secret keys. |
NonRepudiation | Verifies digital signatures, other than signatures on certificates and CRLs, and provides a non-repudiation service that protects against the signing entity falsely denying some action. |
OCSPSigning | Signs OCSP responses. |
ServerAuthentication | TLS WWW server authentication. |
Timestamping | Binds the hash of an object to a time. |
{ "@odata.type": "#Certificate.v1_2_2.Certificate", "Id": "1", "Name": "HTTPS Certificate", "CertificateString": "-----BEGIN CERTIFICATE-----\nMIIFsTCC [**truncated example**] GXG5zljlu\n-----END CERTIFICATE-----", "CertificateType": "PEM", "Issuer": { "Country": "US", "State": "Oregon", "City": "Portland", "Organization": "Contoso", "OrganizationalUnit": "ABC", "CommonName": "manager.contoso.org" }, "Subject": { "Country": "US", "State": "Oregon", "City": "Portland", "Organization": "Contoso", "OrganizationalUnit": "ABC", "CommonName": "manager.contoso.org" }, "ValidNotBefore": "2018-09-07T13:22:05Z", "ValidNotAfter": "2019-09-07T13:22:05Z", "KeyUsage": [ "KeyEncipherment", "ServerAuthentication" ], "Oem": {}, "@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates/1" }
v1.0 |
2018.3 |
The CertificateLocations schema describes a Resource that an administrator can use in order to locate all certificates installed on a given service.
object | The links to other Resources that are related to this Resource. | ||
| array | An array of links to the certificates installed on this service. | |
} ] | string | Link to a Certificate resource. See the Links section and the Certificate schema for details. | |
} | object | See the Oem object definition in the Common properties section. |
{ "@odata.type": "#CertificateLocations.v1_0_2.CertificateLocations", "Id": "CertificateLocations", "Name": "Certificate Locations", "Links": { "Certificates": [ { "@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates/1" } ] }, "Oem": {}, "@odata.id": "/redfish/v1/CertificateService/CertificateLocations" }
v1.0 |
2018.3 |
The CertificateService schema describes a certificate service that represents the actions available to manage certificates and links to the certificates.
object | The information about the location of certificates. See the CertificateLocations schema for details on this property. | ||
} | string | Link to a CertificateLocations resource. See the Links section and the CertificateLocations schema for details. |
This action makes a certificate signing request.
Action URI: {Base URI of target resource}/Actions/CertificateService.GenerateCSRPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| array (string) | optional | The additional host names of the component to secure. |
| object | | The link to the certificate collection where the certificate is installed after the certificate authority (CA) signs the certificate. Contains a link to a resource. |
} | string | Link to Collection of Certificate. See the Certificate schema for details. | |
| string | optional | The challenge password to apply to the certificate for revocation requests. |
| string | | The city or locality of the organization making the request. |
| string | | The fully qualified domain name of the component to secure. |
| string | optional | The name of the user making the request. |
| string | | The two-letter country code of the organization making the request. |
| string | optional | The email address of the contact within the organization making the request. |
| string | optional | The given name of the user making the request. |
| string | optional | The initials of the user making the request. |
| integer | optional | The length of the key, in bits, if needed based on the KeyPairAlgorithm parameter value. |
| string | optional | The curve ID to use with the key, if needed based on the KeyPairAlgorithm parameter value. |
| string | optional | The type of key-pair for use with signing algorithms. |
| array (string (enum)) | The usage of the key contained in the certificate. The usages of a key contained within a certificate. For the possible property values, see KeyUsage in Property details. | |
| string | | The name of the organization making the request. |
| string | | The name of the unit or division of the organization making the request. |
| string | | The state, province, or region of the organization making the request. |
| string | optional | The surname of the user making the request. |
} | string | optional | The unstructured name of the subject. |
Response Payload
{ | |||
| object | | The link to the certificate collection where the certificate is installed. Contains a link to a resource. |
} | string | Link to Collection of Certificate. See the Certificate schema for details. | |
} | string | The string for the certificate signing request. |
This action replaces a certificate.
Action URI: {Base URI of target resource}/Actions/CertificateService.ReplaceCertificatePerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| string | | The string for the certificate. |
| string (enum) | | The format of the certificate. For the possible property values, see CertificateType in Property details. |
| object | | The link to the certificate that is being replaced. See the Certificate schema for details on this property. |
} } | string | Link to a Certificate resource. See the Links section and the Certificate schema for details. |
The format of the certificate.
string | Description |
---|---|
PEM | A Privacy Enhanced Mail (PEM)-encoded certificate. |
PKCS7 | A Privacy Enhanced Mail (PEM)-encoded PKCS7 certificate. |
The usage of the key contained in the certificate. The usages of a key contained within a certificate.
string | Description |
---|---|
ClientAuthentication | TLS WWW client authentication. |
CodeSigning | Signs downloadable executable code. |
CRLSigning | Verifies signatures on certificate revocation lists (CRLs). |
DataEncipherment | Directly enciphers raw user data without an intermediate symmetric cipher. |
DecipherOnly | Deciphers data while performing a key agreement. |
DigitalSignature | Verifies digital signatures, other than signatures on certificates and CRLs. |
EmailProtection | Email protection. |
EncipherOnly | Enciphers data while performing a key agreement. |
KeyAgreement | Key agreement. |
KeyCertSign | Verifies signatures on public key certificates. |
KeyEncipherment | Enciphers private or secret keys. |
NonRepudiation | Verifies digital signatures, other than signatures on certificates and CRLs, and provides a non-repudiation service that protects against the signing entity falsely denying some action. |
OCSPSigning | Signs OCSP responses. |
ServerAuthentication | TLS WWW server authentication. |
Timestamping | Binds the hash of an object to a time. |
{ "@odata.type": "#CertificateService.v1_0_4.CertificateService", "Id": "CertificateService", "Name": "Certificate Service", "Actions": { "#CertificateService.GenerateCSR": { "target": "/redfish/v1/CertificateService/Actions/CertificateService.GenerateCSR", "@Redfish.ActionInfo": "/redfish/v1/CertificateService/GenerateCSRActionInfo" }, "#CertificateService.ReplaceCertificate": { "target": "/redfish/v1/CertificateService/Actions/CertificateService.ReplaceCertificate", "@Redfish.ActionInfo": "/redfish/v1/CertificateService/ReplaceCertificateActionInfo" } }, "CertificateLocations": { "@odata.id": "/redfish/v1/CertificateService/CertificateLocations" }, "Oem": {}, "@odata.id": "/redfish/v1/CertificateService" }
v1.15 | v1.14 | v1.13 | v1.12 | v1.11 | v1.10 | v1.9 | v1.8 | v1.7 | v1.6 | v1.5 | ... |
2020.4 | 2020.3 | 2020.2 | 2020.1 | 2019.4 | 2019.2 | 2018.3 | 2018.2 | 2018.1 | 2017.3 | 2017.1 | ... |
The Chassis schema represents the physical components of a system. This resource represents the sheet-metal confined spaces and logical zones such as racks, enclosures, chassis and all other containers. Subsystems, such as sensors, that operate outside of a system's data plane are linked either directly or indirectly through this resource. A subsystem that operates outside of a system's data plane are not accessible to software that runs on the system.
object | The link to the assembly associated with this chassis. See the Assembly schema for details on this property. | ||
} | string | Link to a Assembly resource. See the Links section and the Assembly schema for details. | |
string | The user-assigned asset tag of this chassis. | ||
object | The link to a collection of certificates for device identity and attestation. Contains a link to a resource. | ||
} | string | Link to Collection of Certificate. See the Certificate schema for details. | |
string (enum) | The type of physical form factor of the chassis. For the possible property values, see ChassisType in Property details. | ||
number (mm) | The depth of the chassis. | ||
object | The link to the collection of drives within this chassis. Contains a link to a resource. | ||
} | string | Link to Collection of Drive. See the Drive schema for details. | |
string (enum) | The ASHRAE Environmental Class for this chassis. For the possible property values, see EnvironmentalClass in Property details. | ||
object | The link to the environment metrics for this chassis. See the EnvironmentMetrics schema for details on this property. | ||
} | string | Link to a EnvironmentMetrics resource. See the Links section and the EnvironmentMetrics schema for details. | |
number (mm) | The height of the chassis. | ||
string (enum) | The state of the indicator LED, which identifies the chassis. For the possible property values, see IndicatorLED in Property details. Deprecated in v1.14 and later. This property has been deprecated in favor of the LocationIndicatorActive property. | ||
object | The links to other resources that are related to this resource. | ||
| array | An array of links to the computer systems that this chassis directly and wholly contains. | |
} ] | string | Link to a ComputerSystem resource. See the Links section and the ComputerSystem schema for details. | |
| object | The link to the chassis that contains this chassis. | |
} | string | Link to another Chassis resource. | |
| array | An array of links to any other chassis that this chassis has in it. | |
} ] | string | Link to another Chassis resource. | |
| array | An array of links to resources or objects that cool this chassis. Normally, the link is for either a chassis or a specific set of fans. | |
} ] | string (URI) | The unique identifier for a resource. | |
| array | An array of links to the drives located in this chassis. | |
} ] | string | Link to a Drive resource. See the Links section and the Drive schema for details. | |
| object | The link to the facility that contains this chassis. See the Facility schema for details on this property. | |
} | string | Link to a Facility resource. See the Links section and the Facility schema for details. | |
| array | An array of links to the managers responsible for managing this chassis. | |
} ] | string | Link to a Manager resource. See the Links section and the Manager schema for details. | |
| array | An array of links to the managers located in this chassis. | |
} ] | string | Link to a Manager resource. See the Links section and the Manager schema for details. | |
| object | See the Oem object definition in the Common properties section. | |
| array | An array of links to the PCIe devices located in this chassis. Deprecated in v1.10 and later. This property has been deprecated in favor of the PCIeDevices resource collection in the root of this resource. | |
} ] | string | Link to a PCIeDevice resource. See the Links section and the PCIeDevice schema for details. | |
| array | An array of links to resources or objects that power this chassis. Normally, the link is for either a chassis or a specific set of power supplies. | |
} ] | string (URI) | The unique identifier for a resource. | |
| array | An array of links to the processors located in this chassis. | |
} ] | string | Link to a Processor resource. See the Links section and the Processor schema for details. | |
| array | An array of links to the resource blocks located in this chassis. | |
} ] | string | Link to a ResourceBlock resource. See the Links section and the ResourceBlock schema for details. | |
| array | An array of links to the storage subsystems connected to or inside this chassis. | |
} ] | string | Link to a Storage resource. See the Links section and the Storage schema for details. | |
| array | An array of links to the switches located in this chassis. | |
} ] } | string | Link to a Switch resource. See the Links section and the Switch schema for details. | |
object | The location of the chassis. For property details, see Location. | ||
boolean | An indicator allowing an operator to physically locate this resource. | ||
object | The link to the logs for this chassis. Contains a link to a resource. | ||
} | string | Link to Collection of LogService. See the LogService schema for details. | |
string | The manufacturer of this chassis. | ||
number (Watts) | The upper bound of the total power consumed by the chassis. | ||
array | An array of DSP0274-defined measurement blocks. | ||
} ] | string | Link to a MeasurementBlock resource. See the Links section and the SoftwareInventory schema for details. | |
object | The link to the collection of media controllers located in this chassis. Contains a link to a resource. | ||
} | string | Link to Collection of MediaController. See the MediaController schema for details. | |
object | The link to the collection of memory located in this chassis. Contains a link to a resource. | ||
} | string | Link to Collection of Memory. See the Memory schema for details. | |
object | The link to the collection of memory domains located in this chassis. Contains a link to a resource. | ||
} | string | Link to Collection of MemoryDomain. See the MemoryDomain schema for details. | |
number (Watts) | The lower bound of the total power consumed by the chassis. | ||
string | The model number of the chassis. | ||
object | The link to the collection of network adapters associated with this chassis. Contains a link to a resource. | ||
} | string | Link to Collection of NetworkAdapter. See the NetworkAdapter schema for details. | |
string | The part number of the chassis. | ||
object | The link to the collection of PCIe devices located in this chassis. Contains a link to a resource. | ||
} | string | Link to Collection of PCIeDevice. See the PCIeDevice schema for details. | |
object | The link to the PCIe slot properties for this chassis. See the PCIeSlots schema for details on this property. | ||
} | string | Link to a PCIeSlots resource. See the Links section and the PCIeSlots schema for details. | |
object | The state of the physical security sensor. | ||
| string (enum) | This indicates the known state of the physical security sensor, such as if it is hardware intrusion detected. For the possible property values, see IntrusionSensor in Property details. | |
| integer | A numerical identifier to represent the physical security sensor. | |
} | string (enum) | The method that restores this physical security sensor to the normal state. For the possible property values, see IntrusionSensorReArm in Property details. | |
object | The link to the power properties, or power supplies, power policies, and sensors, for this chassis. See the Power schema for details on this property. Deprecated in v1.15 and later. This link has been deprecated in favor of the PowerSubsystem link property. | ||
} | string | Link to a Power resource. See the Links section and the Power schema for details. | |
string (enum) | The current power state of the chassis. For the possible property values, see PowerState in Property details. | ||
object | The link to the power subsystem properties for this chassis. See the PowerSubsystem schema for details on this property. | ||
} | string | Link to a PowerSubsystem resource. See the Links section and the PowerSubsystem schema for details. | |
object | The link to the collection of sensors located in the equipment and sub-components. Contains a link to a resource. | ||
} | string | Link to Collection of Sensor. See the Sensor schema for details. | |
string | The serial number of the chassis. | ||
string | The SKU of the chassis. | ||
object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. | ||
object | The link to the thermal properties, such as fans, cooling, and sensors, for this chassis. See the Thermal schema for details on this property. Deprecated in v1.15 and later. This link has been deprecated in favor of the ThermalSubsystem link property. | ||
} | string | Link to a Thermal resource. See the Links section and the Thermal schema for details. | |
object | The link to the thermal subsystem properties for this chassis. See the ThermalSubsystem schema for details on this property. | ||
} | string | Link to a ThermalSubsystem resource. See the Links section and the ThermalSubsystem schema for details. | |
string | The UUID for this chassis. | ||
number (kg) | The weight of the chassis. | ||
number (mm) | The width of the chassis. |
This action resets the chassis but does not reset systems or other contained resources, although side effects might occur that affect those resources.
Action URI: {Base URI of target resource}/Actions/Chassis.ResetPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
} | string (enum) | optional | The type of reset. For the possible property values, see ResetType in Property details. |
The type of physical form factor of the chassis.
string | Description |
---|---|
Blade | An enclosed or semi-enclosed, typically vertically-oriented, system chassis that must be plugged into a multi-system chassis to function normally. |
Card | A loose device or circuit board intended to be installed in a system or other enclosure. |
Cartridge | A small self-contained system intended to be plugged into a multi-system chassis. |
Component | A small chassis, card, or device that contains devices for a particular subsystem or function. |
Drawer | An enclosed or semi-enclosed, typically horizontally-oriented, system chassis that can be slid into a multi-system chassis. |
Enclosure | A generic term for a chassis that does not fit any other description. |
Expansion | A chassis that expands the capabilities or capacity of another chassis. |
IPBasedDrive (v1.3+) | A chassis in a drive form factor with IP-based network connections. |
Module | A small, typically removable, chassis or card that contains devices for a particular subsystem or function. |
Other | A chassis that does not fit any of these definitions. |
Pod | A collection of equipment racks in a large, likely transportable, container. |
Rack | An equipment rack, typically a 19-inch wide freestanding unit. |
RackGroup (v1.4+) | A group of racks that form a single entity or share infrastructure. |
RackMount | A single-system chassis designed specifically for mounting in an equipment rack. |
Row | A collection of equipment racks. |
Shelf | An enclosed or semi-enclosed, typically horizontally-oriented, system chassis that must be plugged into a multi-system chassis to function normally. |
Sidecar | A chassis that mates mechanically with another chassis to expand its capabilities or capacity. |
Sled | An enclosed or semi-enclosed, system chassis that must be plugged into a multi-system chassis to function normally similar to a blade type chassis. |
StandAlone | A single, free-standing system, commonly called a tower or desktop chassis. |
StorageEnclosure (v1.6+) | A chassis that encloses storage. |
Zone | A logical division or portion of a physical chassis that contains multiple devices or systems that cannot be physically separated. |
The ASHRAE Environmental Class for this chassis.
string | Description |
---|---|
A1 | ASHRAE Environmental Class 'A1'. |
A2 | ASHRAE Environmental Class 'A2'. |
A3 | ASHRAE Environmental Class 'A3'. |
A4 | ASHRAE Environmental Class 'A4'. |
The state of the indicator LED, which identifies the chassis.
string | Description |
---|---|
Blinking | The indicator LED is blinking. |
Lit | The indicator LED is lit. |
Off | The indicator LED is off. |
Unknown (deprecated v1.2) | The state of the indicator LED cannot be determined. This value has been deprecated in favor of returning null if the state is unknown. |
This indicates the known state of the physical security sensor, such as if it is hardware intrusion detected.
string | Description |
---|---|
HardwareIntrusion | A door, lock, or other mechanism protecting the internal system hardware from being accessed is detected to be in an insecure state. |
Normal | No abnormal physical security condition is detected at this time. |
TamperingDetected | Physical tampering of the monitored entity is detected. |
The method that restores this physical security sensor to the normal state.
string | Description |
---|---|
Automatic | Because no abnormal physical security condition is detected, this sensor is automatically restored to the normal state. |
Manual | A manual re-arm of this sensor restores it to the normal state. |
The current power state of the chassis.
string | Description |
---|---|
Off | The components within the chassis have no power, except some components might continue to have AUX power, such as the management controller. |
On | The components within the chassis have power. |
PoweringOff | A temporary state between on and off. The components within the chassis can take time to process the power off action. |
PoweringOn | A temporary state between off and on. The components within the chassis can take time to process the power on action. |
The type of reset.
string | Description |
---|---|
ForceOff | Turn off the unit immediately (non-graceful shutdown). |
ForceOn | Turn on the unit immediately. |
ForceRestart | Shut down immediately and non-gracefully and restart the system. |
GracefulRestart | Shut down gracefully and restart the system. |
GracefulShutdown | Shut down gracefully and power off. |
Nmi | Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system. |
On | Turn on the unit. |
PowerCycle | Power cycle the unit. Behaves like a full power removal, followed by a power restore to the resource. |
PushPowerButton | Simulate the pressing of the physical power button on this unit. |
{ "@odata.type": "#Chassis.v1_15_0.Chassis", "Id": "1U", "Name": "Computer System Chassis", "ChassisType": "RackMount", "AssetTag": "Chicago-45Z-2381", "Manufacturer": "Contoso", "Model": "3500RX", "SKU": "8675309", "SerialNumber": "437XR1138R2", "PartNumber": "224071-J23", "PowerState": "On", "LocationIndicatorActive": true, "Location": { "Placement": { "Row": "North", "Rack": "WEB43", "RackOffsetUnits": "EIA_310", "RackOffset": 12 } }, "Status": { "State": "Enabled", "Health": "OK" }, "HeightMm": 44.45, "WidthMm": 431.8, "DepthMm": 711, "WeightKg": 15.31, "EnvironmentalClass": "A3", "Sensors": { "@odata.id": "/redfish/v1/Chassis/1U/Sensors" }, "PowerSubsystem": { "@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem" }, "ThermalSubsystem": { "@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem" }, "EnvironmentMetrics": { "@odata.id": "/redfish/v1/Chassis/1U/EnvironmentMetrics" }, "Links": { "ComputerSystems": [ { "@odata.id": "/redfish/v1/Systems/437XR1138R2" } ], "ManagedBy": [ { "@odata.id": "/redfish/v1/Managers/BMC" } ], "ManagersInChassis": [ { "@odata.id": "/redfish/v1/Managers/BMC" } ], "Oem": {} }, "Oem": {}, "@odata.id": "/redfish/v1/Chassis/1U" }
v1.2 | v1.1 | v1.0 |
2020.4 | 2020.3 | 2019.4 |
This is the schema definition for an electrical circuit.
string (enum) | The state of the over current protection device. For the possible property values, see BreakerState in Property details. | ||
string (enum) | The type of circuit. For the possible property values, see CircuitType in Property details. | ||
boolean | Designates if this is a critical circuit. | ||
object (excerpt) | The current reading for this single phase circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | ||
| number | The crest factor for this sensor. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The sensor value. | |
} | number | The total harmonic distortion (THD). | |
string (enum) | The combination of current-carrying conductors. For the possible property values, see ElectricalContext in Property details. | ||
object (excerpt) | The energy reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | ||
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The total accumulation value for this sensor. | |
| number | The sensor value. | |
} | string (date-time) | The date and time when the time-based properties were last reset. | |
object (excerpt) | The frequency reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | ||
| string (URI) | The link to the resource that provides the data for this sensor. | |
} | number | The sensor value. | |
string (enum) | The state of the indicator LED, which identifies the circuit. For the possible property values, see IndicatorLED in Property details. Deprecated in v1.1 and later. This property has been deprecated in favor of the LocationIndicatorActive property. | ||
object | The links to other resources that are related to this resource. | ||
| object | (null) | A reference to the branch circuit related to this circuit. |
} | string | Link to another Circuit resource. | |
| object | See the Oem object definition in the Common properties section. | |
| array | An array of references to the outlets contained by this circuit. | |
} ] } | string | Link to a Outlet resource. See the Links section and the Outlet schema for details. | |
boolean | An indicator allowing an operator to physically locate this resource. | ||
string (enum) | The nominal voltage for this circuit. For the possible property values, see NominalVoltage in Property details. | ||
string (enum) | The number of ungrounded current-carrying conductors (phases) and the total number of conductors (wires). For the possible property values, see PhaseWiringType in Property details. | ||
string (enum) | The type of plug according to NEMA, IEC, or regional standards. For the possible property values, see PlugType in Property details. | ||
object | (null) | The current readings for this circuit. | |
| object (excerpt) | Line 1 current sensor. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| number | The crest factor for this sensor. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The sensor value. | |
} | number | The total harmonic distortion (THD). | |
| object (excerpt) | Line 2 current sensor. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| number | The crest factor for this sensor. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The sensor value. | |
} | number | The total harmonic distortion (THD). | |
| object (excerpt) | Line 3 current sensor. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| number | The crest factor for this sensor. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The sensor value. | |
} | number | The total harmonic distortion (THD). | |
| object (excerpt) | Neutral line current sensor. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| number | The crest factor for this sensor. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The sensor value. | |
} } | number | The total harmonic distortion (THD). | |
object | (null) | The energy readings for this circuit. | |
| object (excerpt) | The Line 1 to Line 2 energy reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The total accumulation value for this sensor. | |
| number | The sensor value. | |
} | string (date-time) | The date and time when the time-based properties were last reset. | |
| object (excerpt) | The Line 1 to Neutral energy reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The total accumulation value for this sensor. | |
| number | The sensor value. | |
} | string (date-time) | The date and time when the time-based properties were last reset. | |
| object (excerpt) | The Line 2 to Line 3 energy reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The total accumulation value for this sensor. | |
| number | The sensor value. | |
} | string (date-time) | The date and time when the time-based properties were last reset. | |
| object (excerpt) | The Line 2 to Neutral energy reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The total accumulation value for this sensor. | |
| number | The sensor value. | |
} | string (date-time) | The date and time when the time-based properties were last reset. | |
| object (excerpt) | The Line 3 to Line 1 energy reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The total accumulation value for this sensor. | |
| number | The sensor value. | |
} | string (date-time) | The date and time when the time-based properties were last reset. | |
| object (excerpt) | The Line 3 to Neutral energy reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The total accumulation value for this sensor. | |
| number | The sensor value. | |
} } | string (date-time) | The date and time when the time-based properties were last reset. | |
object | (null) | The power readings for this circuit. | |
| object (excerpt) | The Line 1 to Line 2 power reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| number (V.A) | The product of voltage and current for an AC circuit, in Volt-Ampere units. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The power factor for this sensor. | |
| number (V.A) | The square root of the difference term of squared ApparentVA and squared Power (Reading) for a circuit, in var units. | |
} | number | The sensor value. | |
| object (excerpt) | The Line 1 to Neutral power reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| number (V.A) | The product of voltage and current for an AC circuit, in Volt-Ampere units. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The power factor for this sensor. | |
| number (V.A) | The square root of the difference term of squared ApparentVA and squared Power (Reading) for a circuit, in var units. | |
} | number | The sensor value. | |
| object (excerpt) | The Line 2 to Line 3 power reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| number (V.A) | The product of voltage and current for an AC circuit, in Volt-Ampere units. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The power factor for this sensor. | |
| number (V.A) | The square root of the difference term of squared ApparentVA and squared Power (Reading) for a circuit, in var units. | |
} | number | The sensor value. | |
| object (excerpt) | The Line 2 to Neutral power reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| number (V.A) | The product of voltage and current for an AC circuit, in Volt-Ampere units. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The power factor for this sensor. | |
| number (V.A) | The square root of the difference term of squared ApparentVA and squared Power (Reading) for a circuit, in var units. | |
} | number | The sensor value. | |
| object (excerpt) | The Line 3 to Line 1 power reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| number (V.A) | The product of voltage and current for an AC circuit, in Volt-Ampere units. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The power factor for this sensor. | |
| number (V.A) | The square root of the difference term of squared ApparentVA and squared Power (Reading) for a circuit, in var units. | |
} | number | The sensor value. | |
| object (excerpt) | The Line 3 to Neutral power reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| number (V.A) | The product of voltage and current for an AC circuit, in Volt-Ampere units. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The power factor for this sensor. | |
| number (V.A) | The square root of the difference term of squared ApparentVA and squared Power (Reading) for a circuit, in var units. | |
} } | number | The sensor value. | |
object | (null) | The voltage readings for this circuit. | |
| object (excerpt) | The Line 1 to Line 2 voltage reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| number | The crest factor for this sensor. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The sensor value. | |
} | number | The total harmonic distortion (THD). | |
| object (excerpt) | The Line 1 to Neutral voltage reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| number | The crest factor for this sensor. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The sensor value. | |
} | number | The total harmonic distortion (THD). | |
| object (excerpt) | The Line 2 to Line 3 voltage reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| number | The crest factor for this sensor. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The sensor value. | |
} | number | The total harmonic distortion (THD). | |
| object (excerpt) | The Line 2 to Neutral voltage reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| number | The crest factor for this sensor. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The sensor value. | |
} | number | The total harmonic distortion (THD). | |
| object (excerpt) | The Line 3 to Line 1 voltage reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| number | The crest factor for this sensor. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The sensor value. | |
} | number | The total harmonic distortion (THD). | |
| object (excerpt) | The Line 3 to Neutral voltage reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | |
| number | The crest factor for this sensor. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The sensor value. | |
} } | number | The total harmonic distortion (THD). | |
number | The number of seconds to delay power on after a PowerControl action to cycle power. Zero seconds indicates no delay. | ||
boolean | Indicates if the circuit can be powered. | ||
number | The number of seconds to delay power off after a PowerControl action. Zero seconds indicates no delay to power off. | ||
number | The number of seconds to delay power up after a power cycle or a PowerControl action. Zero seconds indicates no delay to power up. | ||
number | The number of seconds to delay power on after power has been restored. Zero seconds indicates no delay. | ||
string (enum) | The desired power state of the circuit when power is restored after a power loss. For the possible property values, see PowerRestorePolicy in Property details. | ||
string (enum) | The power state of the circuit. For the possible property values, see PowerState in Property details. | ||
object (excerpt) | The power reading for this circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | ||
| number (V.A) | The product of voltage and current for an AC circuit, in Volt-Ampere units. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The power factor for this sensor. | |
| number (V.A) | The square root of the difference term of squared ApparentVA and squared Power (Reading) for a circuit, in var units. | |
} | number | The sensor value. | |
number (A) | The rated maximum current allowed for this circuit. | ||
object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. | ||
object (excerpt) | The voltage reading for this single phase circuit. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | ||
| number | The crest factor for this sensor. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The sensor value. | |
} | number | The total harmonic distortion (THD). | |
string (enum) | The type of voltage applied to the circuit. For the possible property values, see VoltageType in Property details. |
This action attempts to reset the circuit breaker.
Action URI: {Base URI of target resource}/Actions/Circuit.BreakerControlPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
} | string (enum) | optional | The desired power state of the circuit if the breaker is reset successfully. For the possible property values, see PowerState in Property details. |
This action turns the circuit on or off.
Action URI: {Base URI of target resource}/Actions/Circuit.PowerControlPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
} | string (enum) | optional | The desired power state of the circuit. For the possible property values, see PowerState in Property details. |
This action resets metrics related to this circuit.
Action URI: {Base URI of target resource}/Actions/Circuit.ResetMetricsPerform the action using a POST to the specific Action URI for this resource. This action takes no parameters.
The state of the over current protection device.
string | Description |
---|---|
Normal | The breaker is powered on. |
Off | The breaker is off. |
Tripped | The breaker has been tripped. |
The type of circuit.
string | Description |
---|---|
Branch | A branch (output) circuit. |
Feeder | A feeder (output) circuit. |
Mains | A mains input or utility circuit. |
Subfeed | A subfeed (output) circuit. |
The combination of current-carrying conductors.
string | Description |
---|---|
Line1 | The circuits that share the L1 current-carrying conductor. |
Line1ToLine2 | The circuit formed by L1 and L2 current-carrying conductors. |
Line1ToNeutral | The circuit formed by L1 and neutral current-carrying conductors. |
Line1ToNeutralAndL1L2 | The circuit formed by L1, L2, and neutral current-carrying conductors. |
Line2 | The circuits that share the L2 current-carrying conductor. |
Line2ToLine3 | The circuit formed by L2 and L3 current-carrying conductors. |
Line2ToNeutral | The circuit formed by L2 and neutral current-carrying conductors. |
Line2ToNeutralAndL1L2 | The circuit formed by L1, L2, and Neutral current-carrying conductors. |
Line2ToNeutralAndL2L3 | The circuits formed by L2, L3, and neutral current-carrying conductors. |
Line3 | The circuits that share the L3 current-carrying conductor. |
Line3ToLine1 | The circuit formed by L3 and L1 current-carrying conductors. |
Line3ToNeutral | The circuit formed by L3 and neutral current-carrying conductors. |
Line3ToNeutralAndL3L1 | The circuit formed by L3, L1, and neutral current-carrying conductors. |
LineToLine | The circuit formed by two current-carrying conductors. |
LineToNeutral | The circuit formed by a line and neutral current-carrying conductor. |
Neutral | The grounded current-carrying return circuit of current-carrying conductors. |
Total | The circuit formed by all current-carrying conductors. |
The state of the indicator LED, which identifies the circuit.
string | Description |
---|---|
Blinking | The indicator LED is blinking. |
Lit | The indicator LED is lit. |
Off | The indicator LED is off. |
The nominal voltage for this circuit.
string | Description |
---|---|
AC100To240V | AC 100-240V nominal. |
AC100To277V | AC 100-277V nominal. |
AC120V | AC 120V nominal. |
AC200To240V | AC 200-240V nominal. |
AC200To277V | AC 200-277V nominal. |
AC208V | AC 208V nominal. |
AC230V | AC 230V nominal. |
AC240AndDC380V | AC 200-240V and DC 380V. |
AC240V | AC 240V nominal. |
AC277AndDC380V | AC 200-277V and DC 380V. |
AC277V | AC 277V nominal. |
AC400V | AC 400V or 415V nominal. |
AC480V | AC 480V nominal. |
DC240V | DC 240V nominal. |
DC380V | High Voltage DC (380V). |
DC48V (v1.2+) | DC 48V nominal. |
DCNeg48V | -48V DC. |
The number of ungrounded current-carrying conductors (phases) and the total number of conductors (wires).
string | Description |
---|---|
OneOrTwoPhase3Wire | Single or Two-Phase / 3-Wire (Line1, Line2 or Neutral, Protective Earth). |
OnePhase3Wire | Single-phase / 3-Wire (Line1, Neutral, Protective Earth). |
ThreePhase4Wire | Three-phase / 4-Wire (Line1, Line2, Line3, Protective Earth). |
ThreePhase5Wire | Three-phase / 5-Wire (Line1, Line2, Line3, Neutral, Protective Earth). |
TwoPhase3Wire | Two-phase / 3-Wire (Line1, Line2, Protective Earth). |
TwoPhase4Wire | Two-phase / 4-Wire (Line1, Line2, Neutral, Protective Earth). |
The type of plug according to NEMA, IEC, or regional standards.
string | Description |
---|---|
California_CS8265 | California Standard CS8265 (Single-phase 250V; 50A; 2P3W). |
California_CS8365 | California Standard CS8365 (Three-phase 250V; 50A; 3P4W). |
Field_208V_3P4W_60A | Field-wired; Three-phase 200-250V; 60A; 3P4W. |
Field_400V_3P5W_32A | Field-wired; Three-phase 200-240/346-415V; 32A; 3P5W. |
IEC_60309_316P6 | IEC 60309 316P6 (Single-phase 200-250V; 16A; 1P3W; Blue, 6-hour). |
IEC_60309_332P6 | IEC 60309 332P6 (Single-phase 200-250V; 32A; 1P3W; Blue, 6-hour). |
IEC_60309_363P6 | IEC 60309 363P6 (Single-phase 200-250V; 63A; 1P3W; Blue, 6-hour). |
IEC_60309_460P9 | IEC 60309 460P9 (Three-phase 200-250V; 60A; 3P4W; Blue; 9-hour). |
IEC_60309_516P6 | IEC 60309 516P6 (Three-phase 200-240/346-415V; 16A; 3P5W; Red; 6-hour). |
IEC_60309_532P6 | IEC 60309 532P6 (Three-phase 200-240/346-415V; 32A; 3P5W; Red; 6-hour). |
IEC_60309_560P9 | IEC 60309 560P9 (Three-phase 120-144/208-250V; 60A; 3P5W; Blue; 9-hour). |
IEC_60309_563P6 | IEC 60309 563P6 (Three-phase 200-240/346-415V; 63A; 3P5W; Red; 6-hour). |
IEC_60320_C14 | IEC C14 (Single-phase 250V; 10A; 1P3W). |
IEC_60320_C20 | IEC C20 (Single-phase 250V; 16A; 1P3W). |
NEMA_5_15P | NEMA 5-15P (Single-phase 125V; 15A; 1P3W). |
NEMA_5_20P | NEMA 5-20P (Single-phase 125V; 20A; 1P3W). |
NEMA_6_15P | NEMA 6-15P (Single-phase 250V; 15A; 2P3W). |
NEMA_6_20P | NEMA 6-20P (Single-phase 250V; 20A; 2P3W). |
NEMA_L14_20P | NEMA L14-20P (Split-phase 125/250V; 20A; 2P4W). |
NEMA_L14_30P | NEMA L14-30P (Split-phase 125/250V; 30A; 2P4W). |
NEMA_L15_20P | NEMA L15-20P (Three-phase 250V; 20A; 3P4W). |
NEMA_L15_30P | NEMA L15-30P (Three-phase 250V; 30A; 3P4W). |
NEMA_L21_20P | NEMA L21-20P (Three-phase 120/208V; 20A; 3P5W). |
NEMA_L21_30P | NEMA L21-30P (Three-phase 120/208V; 30A; 3P5W). |
NEMA_L22_20P | NEMA L22-20P (Three-phase 277/480V; 20A; 3P5W). |
NEMA_L22_30P | NEMA L22-30P (Three-phase 277/480V; 30A; 3P5W). |
NEMA_L5_15P | NEMA L5-15P (Single-phase 125V; 15A; 1P3W). |
NEMA_L5_20P | NEMA L5-20P (Single-phase 125V; 20A; 1P3W). |
NEMA_L5_30P | NEMA L5-30P (Single-phase 125V; 30A; 1P3W). |
NEMA_L6_15P | NEMA L6-15P (Single-phase 250V; 15A; 2P3W). |
NEMA_L6_20P | NEMA L6-20P (Single-phase 250V; 20A; 2P3W). |
NEMA_L6_30P | NEMA L6-30P (Single-phase 250V; 30A; 2P3W). |
The desired power state of the circuit when power is restored after a power loss.
string | Description |
---|---|
AlwaysOff | Always remain powered off when external power is applied. |
AlwaysOn | Always power on when external power is applied. |
LastState | Return to the last power state (on or off) when external power is applied. |
The desired power state of the circuit if the breaker is reset successfully.
string | Description |
---|---|
Off | The circuit is powered off. |
On | The circuit is powered on. |
The desired power state of the circuit.
string | Description |
---|---|
Off | The state is powered off. |
On | The state is powered on. |
PoweringOff | A temporary state between on and off. |
PoweringOn | A temporary state between off and on. |
The type of voltage applied to the circuit.
string | Description |
---|---|
AC | Alternating Current (AC) circuit. |
DC | Direct Current (DC) circuit. |
{ "@odata.type": "#Circuit.v1_2_0.Circuit", "Id": "A", "Name": "Branch Circuit A", "Status": { "State": "Enabled", "Health": "OK" }, "CircuitType": "Branch", "PhaseWiringType": "TwoPhase3Wire", "NominalVoltage": "AC200To240V", "RatedCurrentAmps": 16, "BreakerState": "Normal", "PolyPhaseVoltage": { "Line1ToNeutral": { "DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/VoltageAL1N", "Reading": 118.2 }, "Line1ToLine2": { "DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/VoltageAL1L2", "Reading": 203.5 } }, "CurrentAmps": { "DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/CurrentA", "Reading": 5.19 }, "PolyPhaseCurrentAmps": { "Line1": { "DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/CurrentA", "Reading": 5.19 } }, "PowerWatts": { "DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/PowerA", "Reading": 937.4, "ApparentVA": 937.4, "ReactiveVAR": 0, "PowerFactor": 1 }, "PolyPhasePowerWatts": { "Line1ToNeutral": { "DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/PowerA1", "Reading": 937.4, "PeakReading": 1000.5, "ApparentVA": 937.4, "ReactiveVAR": 0, "PowerFactor": 1 } }, "FrequencyHz": { "DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/FrequencyA", "Reading": 60 }, "EnergykWh": { "DataSourceUri": "/redfish/v1/PowerEquipment/RackPDUs/1/Sensors/EnergyA", "Reading": 325675 }, "Links": { "Outlets": [ { "@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Outlets/A1" }, { "@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Outlets/A2" }, { "@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Outlets/A3" } ] }, "Actions": { "#Circuit.BreakerControl": { "target": "/redfish/v1/PowerEquipment/RackPDUs/1/Branches/A/Circuit.BreakerControl" }, "#Outlet.ResetMetrics": { "target": "/redfish/v1/PowerEquipment/RackPDUs/1/Branches/A/Circuit.ResetMetrics" } }, "@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1/Branches/A" }
v1.1 | v1.0 |
2018.2 | 2017.1 |
The CompositionService schema describes a Composition Service and its properties and links to the Resources available for composition.
boolean | An indication of whether this service is allowed to overprovision a composition relative to the composition request. | ||
boolean | An indication of whether a client can request that a specific Resource Zone fulfill a composition request. | ||
object | The Resource Blocks available on the service. Contains a link to a resource. | ||
} | string | Link to Collection of ResourceBlock. See the ResourceBlock schema for details. | |
object | The Resource Zones available on the service. Contains a link to a resource. | ||
} | string | Link to Collection of Zone. See the Zone schema for details. | |
boolean | An indication of whether this service is enabled. | ||
object | The status and health of the Resource and its subordinate or dependent Resources. For property details, see Status. |
{ "@odata.type": "#CompositionService.v1_1_2.CompositionService", "Id": "CompositionService", "Name": "Composition Service", "Status": { "State": "Enabled", "Health": "OK" }, "ServiceEnabled": true, "AllowOverprovisioning": true, "AllowZoneAffinity": true, "ResourceBlocks": { "@odata.id": "/redfish/v1/CompositionService/ResourceBlocks" }, "ResourceZones": { "@odata.id": "/redfish/v1/CompositionService/ResourceZones" }, "Oem": {}, "@odata.id": "/redfish/v1/CompositionService" }
v1.14 | v1.13 | v1.12 | v1.11 | v1.10 | v1.9 | v1.8 | v1.7 | v1.6 | v1.5 | v1.4 | ... |
2020.4 | 2020.3 | 2020.2 | 2020.1 | 2019.4 | 2019.3 | 2019.2 | 2019.1 | 2018.3 | 2017.3 | 2017.1 | ... |
The ComputerSystem schema represents a computer or system instance and the software-visible resources, or items within the data plane, such as memory, CPU, and other devices that it can access. Details of those resources or subsystems are also linked through this resource.
string | The user-definable tag that can track this computer system for inventory or other client purposes. | ||
object | The link to the BIOS settings associated with this system. See the Bios schema for details on this property. | ||
} | string | Link to a Bios resource. See the Links section and the Bios schema for details. | |
string | The version of the system BIOS or primary system firmware. | ||
object | The boot settings for this system. | ||
| array (string (enum)) | Ordered array of boot source aliases representing the persistent boot order associated with this computer system. For the possible property values, see AliasBootOrder in Property details. | |
| integer | The number of attempts the system will automatically retry booting. | |
| string (enum) | The configuration of how the system retries booting automatically. For the possible property values, see AutomaticRetryConfig in Property details. | |
| string | The BootOptionReference of the Boot Option to perform a one-time boot from when BootSourceOverrideTarget is UefiBootNext . | |
| object | The link to the collection of the UEFI boot options associated with this computer system. Contains a link to a resource. | |
} | string | Link to Collection of BootOption. See the BootOption schema for details. | |
| array (string, null) | An array of BootOptionReference strings that represent the persistent boot order for with this computer system. | |
| string (enum) | The name of the boot order property that the system uses for the persistent boot order. For the possible property values, see BootOrderPropertySelection in Property details. | |
| string (enum) | The state of the boot source override feature. For the possible property values, see BootSourceOverrideEnabled in Property details. | |
| string (enum) | The BIOS boot mode to use when the system boots from the BootSourceOverrideTarget boot source. For the possible property values, see BootSourceOverrideMode in Property details. | |
| string (enum) | The current boot source to use at the next boot instead of the normal boot device, if BootSourceOverrideEnabled is true .For the possible property values, see BootSourceOverrideTarget in Property details. | |
| object | The link to a collection of certificates used for booting through HTTPS by this computer system. Contains a link to a resource. | |
} | string | Link to Collection of Certificate. See the Certificate schema for details. | |
| string (URI) | The URI to boot from when BootSourceOverrideTarget is set to UefiHttp . | |
| integer | The number of remaining automatic retry boots. | |
| string (enum) | The Trusted Module boot requirement. For the possible property values, see TrustedModuleRequiredToBoot in Property details. | |
} | string | The UEFI device path of the device from which to boot when BootSourceOverrideTarget is UefiTarget . | |
object | (null) | This object describes the last boot progress state. | |
| string (enum) | The last boot progress state. For the possible property values, see LastState in Property details. | |
| string (date-time) | The date and time when the last boot state was updated. | |
| object | See the Oem object definition in the Common properties section. | |
} | string | The OEM-specific last state, if the LastState type is OEM . | |
object | The link to a collection of certificates for device identity and attestation. Contains a link to a resource. | ||
} | string | Link to Collection of Certificate. See the Certificate schema for details. | |
object | The link to the collection of Ethernet interfaces associated with this system. Contains a link to a resource. | ||
} | string | Link to Collection of EthernetInterface. See the EthernetInterface schema for details. | |
object | The link to the collection of fabric adapters associated with this system. Contains a link to a resource. | ||
} | string | Link to Collection of FabricAdapter. See the FabricAdapter schema for details. | |
object | The information about the graphical console (KVM-IP) service of this system. | ||
| array (string (enum)) | This property enumerates the graphical console connection types that the implementation allows. For the possible property values, see ConnectTypesSupported in Property details. | |
| integer | The maximum number of service sessions, regardless of protocol, that this system can support. | |
| integer | The protocol port. | |
} | boolean | An indication of whether the service is enabled for this system. | |
object | The services that this computer system supports. | ||
| object | See the Oem object definition in the Common properties section. | |
| object | The link to a collection of storage services that this computer system supports. | |
} } | string (URI) | The unique identifier for a resource. | |
array (string (enum)) | The hosting roles that this computer system supports. The enumerations of HostingRoles specify different features that the hosting ComputerSystem supports. For the possible property values, see HostingRoles in Property details. | ||
string | The DNS host name, without any domain information. | ||
object | The host watchdog timer functionality for this system. | ||
| boolean | An indication of whether a user has enabled the host watchdog timer functionality. This property indicates only that a user has enabled the timer. To activate the timer, installation of additional host-based software is necessary; an update to this property does not initiate the timer. | |
| object | See the Oem object definition in the Common properties section. | |
| object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. | |
| string (enum) | The action to perform when the watchdog timer reaches its timeout value. For the possible property values, see TimeoutAction in Property details. | |
} | string (enum) | The action to perform when the watchdog timer is close to reaching its timeout value. This action typically occurs from three to ten seconds before to the timeout value, but the exact timing is dependent on the implementation. For the possible property values, see WarningAction in Property details. | |
string (enum) | The state of the indicator LED, which identifies the system. For the possible property values, see IndicatorLED in Property details. Deprecated in v1.13 and later. This property has been deprecated in favor of the LocationIndicatorActive property. | ||
string (date-time) | The date and time when the system was last reset or rebooted. | ||
object | The links to other resources that are related to this resource. | ||
| array | An array of links to the chassis that contains this system. | |
} ] | string | Link to a Chassis resource. See the Links section and the Chassis schema for details. | |
| array | An array of links to ComputerSystems that are realized, in whole or in part, from this ComputerSystem. | |
} ] | string | Link to another ComputerSystem resource. | |
| array | An array of links to resources or objects that that cool this computer system. Normally, the link is for either a chassis or a specific set of fans. | |
} ] | string (URI) | The unique identifier for a resource. | |
| array | An array of links to the endpoints that connect to this system. | |
} ] | string | Link to a Endpoint resource. See the Links section and the Endpoint schema for details. | |
| array | An array of links to the managers responsible for this system. | |
} ] | string | Link to a Manager resource. See the Links section and the Manager schema for details. | |
| object | See the Oem object definition in the Common properties section. | |
| array | An array of links to resources or objects that power this computer system. Normally, the link is for either a chassis or a specific set of power supplies. | |
} ] | string (URI) | The unique identifier for a resource. | |
| array | An array of links to the resource blocks that are used in this computer system. | |
} ] | string | Link to a ResourceBlock resource. See the Links section and the ResourceBlock schema for details. | |
| array | An array of links to ComputerSystems that contribute, in whole or in part, to the implementation of this ComputerSystem. | |
} ] } | string | Link to another ComputerSystem resource. | |
boolean | An indicator allowing an operator to physically locate this resource. | ||
object | The link to the collection of log services associated with this system. Contains a link to a resource. | ||
} | string | Link to Collection of LogService. See the LogService schema for details. | |
string | The manufacturer or OEM of this system. | ||
array | An array of DSP0274-defined measurement blocks. | ||
} ] | string | Link to a MeasurementBlock resource. See the Links section and the SoftwareInventory schema for details. | |
object | The link to the collection of memory associated with this system. Contains a link to a resource. | ||
} | string | Link to Collection of Memory. See the Memory schema for details. | |
object | The link to the collection of memory domains associated with this system. Contains a link to a resource. | ||
} | string | Link to Collection of MemoryDomain. See the MemoryDomain schema for details. | |
object | The central memory of the system in general detail. | ||
| string (enum) | The ability and type of memory mirroring that this computer system supports. For the possible property values, see MemoryMirroring in Property details. | |
| object | The link to the metrics associated with all memory in this system. See the MemoryMetrics schema for details on this property. | |
} | string | Link to a MemoryMetrics resource. See the Links section and the MemoryMetrics schema for details. | |
| object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. | |
| number (GiBy) | The total configured operating system-accessible memory (RAM), measured in GiB. | |
} | number (GiBy) | The total configured, system-accessible persistent memory, measured in GiB. | |
string | The product name for this system, without the manufacturer name. | ||
object | The link to the collection of Network Interfaces associated with this system. Contains a link to a resource. | ||
} | string | Link to Collection of NetworkInterface. See the NetworkInterface schema for details. | |
string | The part number for this system. | ||
array | The link to a collection of PCIe devices that this computer system uses. | ||
} ] | string | Link to a PCIeDevice resource. See the Links section and the PCIeDevice schema for details. | |
array | The link to a collection of PCIe functions that this computer system uses. | ||
} ] | string | Link to a PCIeFunction resource. See the Links section and the PCIeFunction schema for details. | |
number | The number of seconds to delay power on after a Reset action requesting PowerCycle . Zero seconds indicates no delay. | ||
number | The number of seconds to delay power off during a reset. Zero seconds indicates no delay to power off. | ||
number | The number of seconds to delay power on after a power cycle or during a reset. Zero seconds indicates no delay to power up. | ||
string (enum) | The desired power state of the system when power is restored after a power loss. For the possible property values, see PowerRestorePolicy in Property details. | ||
string (enum) | The current power state of the system. For the possible property values, see PowerState in Property details. | ||
object | The link to the collection of processors associated with this system. Contains a link to a resource. | ||
} | string | Link to Collection of Processor. See the Processor schema for details. | |
object | The central processors of the system in general detail. | ||
| integer | The number of processor cores in the system. | |
| integer | The number of physical processors in the system. | |
| integer | The number of logical processors in the system. | |
| object | The link to the metrics associated with all processors in this system. See the ProcessorMetrics schema for details on this property. | |
} | string | Link to a ProcessorMetrics resource. See the Links section and the ProcessorMetrics schema for details. | |
| string | The processor model for the primary or majority of processors in this system. | |
} | object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. | |
array (object) | A reference to a set of Redundancy entities that provide redundant Services for this Resource. See the Redundancy object definition in the Common objects section. For property details, see Redundancy. | ||
object | The link to the UEFI Secure Boot associated with this system. See the SecureBoot schema for details on this property. | ||
} | string | Link to a SecureBoot resource. See the Links section and the SecureBoot schema for details. | |
object | The serial console services that this system provides. | ||
| object | The connection details for an IPMI Serial-over-LAN service. For more information about this property, see SerialConsoleProtocol in Property Details. | |
| integer | The maximum number of service sessions, regardless of protocol, that this system can support. | |
| object | The connection details for an SSH serial console service. For more information about this property, see SerialConsoleProtocol in Property Details. | |
} | object | The connection details for a Telnet serial console service. For more information about this property, see SerialConsoleProtocol in Property Details. | |
string | The serial number for this system. | ||
object | The link to the collection of storage devices associated with this system. Contains a link to a resource. | ||
} | string | Link to Collection of SimpleStorage. See the SimpleStorage schema for details. | |
string | The manufacturer SKU for this system. | ||
object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. | ||
object | The link to the collection of storage devices associated with this system. Contains a link to a resource. | ||
} | string | Link to Collection of Storage. See the Storage schema for details. | |
string | The sub-model for this system. | ||
string (enum) | The type of computer system that this resource represents. For the possible property values, see SystemType in Property details. | ||
array | An array of trusted modules in the system. | ||
| string | The firmware version of this Trusted Module. | |
| string | The second firmware version of this Trusted Module, if applicable. | |
| string (enum) | The interface type of the Trusted Module. For the possible property values, see InterfaceType in Property details. | |
| string (enum) | The interface type selection supported by this Trusted Module. For the possible property values, see InterfaceTypeSelection in Property details. | |
| object | See the Oem object definition in the Common properties section. | |
} ] | object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. | |
string | The UUID for this system. For more information about this property, see Property details. | ||
object | The link to the virtual media services for this system. Contains a link to a resource. | ||
} | string | Link to Collection of VirtualMedia. See the VirtualMedia schema for details. | |
object | The information about the virtual media service of this system. | ||
| integer | The protocol port. | |
} | boolean | An indication of whether the service is enabled for this system. |
This action adds a resource block to a system.
Action URI: {Base URI of target resource}/Actions/ComputerSystem.AddResourceBlockPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| string | optional | The current ETag of the system. |
| object | | The resource block to add to the system. See the ResourceBlock schema for details on this property. |
} | string | Link to a ResourceBlock resource. See the Links section and the ResourceBlock schema for details. | |
} | string | optional | The current ETag of the resource block to add to the system. |
This action removes a resource block from a system.
Action URI: {Base URI of target resource}/Actions/ComputerSystem.RemoveResourceBlockPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| string | optional | The current ETag of the system. |
| object | | The resource block to remove from the system. See the ResourceBlock schema for details on this property. |
} | string | Link to a ResourceBlock resource. See the Links section and the ResourceBlock schema for details. | |
} | string | optional | The current ETag of the resource block to remove from the system. |
This action resets the system.
Action URI: {Base URI of target resource}/Actions/ComputerSystem.ResetPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
} | string (enum) | optional | The type of reset. For the possible property values, see ResetType in Property details. |
This action sets the BootOrder to the default settings.
Action URI: {Base URI of target resource}/Actions/ComputerSystem.SetDefaultBootOrderPerform the action using a POST to the specific Action URI for this resource. This action takes no parameters.
Ordered array of boot source aliases representing the persistent boot order associated with this computer system.
string | Description |
---|---|
BiosSetup | Boot to the BIOS setup utility. |
Cd | Boot from the CD or DVD. |
Diags | Boot to the manufacturer's diagnostics program. |
Floppy | Boot from the floppy disk drive. |
Hdd | Boot from a hard drive. |
None | Boot from the normal boot device. |
Pxe | Boot from the Pre-Boot EXecution (PXE) environment. |
RemoteDrive | Boot from a remote drive, such as an iSCSI target. |
SDCard | Boot from an SD card. |
UefiBootNext | Boot to the UEFI device that the BootNext property specifies. |
UefiHttp | Boot from a UEFI HTTP network location. |
UefiShell | Boot to the UEFI Shell. |
UefiTarget | Boot to the UEFI device specified in the UefiTargetBootSourceOverride property. |
Usb | Boot from a system BIOS-specified USB device. |
Utilities | Boot to the manufacturer's utilities program or programs. |
The configuration of how the system retries booting automatically.
string | Description |
---|---|
Disabled | Disable automatic retrying of booting. |
RetryAlways | Always automatically retry booting. |
RetryAttempts | Automatic retrying of booting is based on a specified retry count. |
The name of the boot order property that the system uses for the persistent boot order.
string | Description |
---|---|
AliasBootOrder | The system uses the AliasBootOrder property to specify the persistent boot order. |
BootOrder | The system uses the BootOrder property to specify the persistent boot order. |
The state of the boot source override feature.
string | Description |
---|---|
Continuous | The system boots to the target specified in the BootSourceOverrideTarget property until this property is `Disabled`. |
Disabled | The system boots normally. |
Once | On its next boot cycle, the system boots one time to the boot source override target. Then, the BootSourceOverrideEnabled value is reset to `Disabled`. |
The BIOS boot mode to use when the system boots from the BootSourceOverrideTarget boot source.
string | Description |
---|---|
Legacy | The system boots in non-UEFI boot mode to the boot source override target. |
UEFI | The system boots in UEFI boot mode to the boot source override target. |
The current boot source to use at the next boot instead of the normal boot device, if BootSourceOverrideEnabled is `true`.
string | Description |
---|---|
BiosSetup | Boot to the BIOS setup utility. |
Cd | Boot from the CD or DVD. |
Diags | Boot to the manufacturer's diagnostics program. |
Floppy | Boot from the floppy disk drive. |
Hdd | Boot from a hard drive. |
None | Boot from the normal boot device. |
Pxe | Boot from the Pre-Boot EXecution (PXE) environment. |
RemoteDrive (v1.2+) | Boot from a remote drive, such as an iSCSI target. |
SDCard (v1.1+) | Boot from an SD card. |
UefiBootNext (v1.5+) | Boot to the UEFI device that the BootNext property specifies. |
UefiHttp (v1.1+) | Boot from a UEFI HTTP network location. |
UefiShell | Boot to the UEFI Shell. |
UefiTarget | Boot to the UEFI device specified in the UefiTargetBootSourceOverride property. |
Usb | Boot from a system BIOS-specified USB device. |
Utilities | Boot to the manufacturer's utilities program or programs. |
This property enumerates the graphical console connection types that the implementation allows.
string | Description |
---|---|
KVMIP | The controller supports a graphical console connection through a KVM-IP (redirection of Keyboard, Video, Mouse over IP) protocol. |
OEM | The controller supports a graphical console connection through an OEM-specific protocol. |
The hosting roles that this computer system supports. The enumerations of HostingRoles specify different features that the hosting ComputerSystem supports.
string | Description |
---|---|
Appliance | The system hosts functionality that supports the system acting as an appliance. |
ApplicationServer | The system hosts functionality that supports general purpose applications. |
BareMetalServer | The system hosts functionality that supports the system acting as a bare metal server. |
ContainerServer | The system hosts functionality that supports the system acting as a container server. |
StorageServer | The system hosts functionality that supports the system acting as a storage server. |
Switch | The system hosts functionality that supports the system acting as a switch. |
VirtualMachineServer | The system hosts functionality that supports the system acting as a virtual machine server. |
The state of the indicator LED, which identifies the system.
string | Description |
---|---|
Blinking | The indicator LED is blinking. |
Lit | The indicator LED is lit. |
Off | The indicator LED is off. |
Unknown (deprecated v1.1) | The state of the indicator LED cannot be determined. This value has been deprecated in favor of returning null if the state is unknown. |
The interface type of the Trusted Module.
string | Description |
---|---|
TCM1_0 | Trusted Cryptography Module (TCM) 1.0. |
TPM1_2 | Trusted Platform Module (TPM) 1.2. |
TPM2_0 | Trusted Platform Module (TPM) 2.0. |
The interface type selection supported by this Trusted Module.
string | Description |
---|---|
BiosSetting | The TrustedModule supports switching InterfaceType through platform software, such as a BIOS configuration attribute. |
FirmwareUpdate | The TrustedModule supports switching InterfaceType through a firmware update. |
None | The TrustedModule does not support switching the InterfaceType. |
OemMethod | The TrustedModule supports switching InterfaceType through an OEM proprietary mechanism. |
The last boot progress state.
string | Description |
---|---|
BusInitializationStarted | The system has started initializing the buses. |
MemoryInitializationStarted | The system has started initializing the memory. |
None | The system is not booting. |
OEM | A boot progress state in an OEM-defined format. |
OSBootStarted | The operating system has started booting. |
OSRunning | The operating system is running. |
PCIResourceConfigStarted | The system has started initializing the PCI resources. |
PrimaryProcessorInitializationStarted | The system has started initializing the primary processor. |
SecondaryProcessorInitializationStarted | The system has started initializing the remaining processors. |
SystemHardwareInitializationComplete | The system has completed initializing all hardware. |
The ability and type of memory mirroring that this computer system supports.
string | Description |
---|---|
DIMM | The system supports DIMM mirroring at the DIMM level. Individual DIMMs can be mirrored. |
Hybrid | The system supports a hybrid mirroring at the system and DIMM levels. Individual DIMMs can be mirrored. |
None | The system does not support DIMM mirroring. |
System | The system supports DIMM mirroring at the system level. Individual DIMMs are not paired for mirroring in this mode. |
The desired power state of the system when power is restored after a power loss.
string | Description |
---|---|
AlwaysOff | The system always remains powered off when power is applied. |
AlwaysOn | The system always powers on when power is applied. |
LastState | The system returns to its last on or off power state when power is applied. |
The current power state of the system.
string | Description |
---|---|
Off | The system is powered off, although some components might continue to have AUX power such as management controller. |
On | The system is powered on. |
PoweringOff | A temporary state between on and off. The power off action can take time while the OS is in the shutdown process. |
PoweringOn | A temporary state between off and on. This temporary state can be very short. |
The type of reset.
string | Description |
---|---|
ForceOff | Turn off the unit immediately (non-graceful shutdown). |
ForceOn | Turn on the unit immediately. |
ForceRestart | Shut down immediately and non-gracefully and restart the system. |
GracefulRestart | Shut down gracefully and restart the system. |
GracefulShutdown | Shut down gracefully and power off. |
Nmi | Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system. |
On | Turn on the unit. |
PowerCycle | Power cycle the unit. Behaves like a full power removal, followed by a power restore to the resource. |
PushPowerButton | Simulate the pressing of the physical power button on this unit. |
The information about a serial console service that this system provides.
string | The command string passed to the service to select or enter the system's serial console. | ||
string | The hotkey sequence available for the user to exit the serial console session. | ||
integer | The protocol port. | ||
boolean | An indication of whether the service is enabled for this system. | ||
boolean | Indicates whether the serial console service is shared with access to the manager's command-line interface (CLI). |
The type of computer system that this resource represents.
string | Description |
---|---|
Composed (v1.4+) | A computer system constructed by binding resource blocks together. |
OS | An operating system instance. |
Physical | A computer system. |
PhysicallyPartitioned | A hardware-based partition of a computer system. |
Virtual | A virtual machine instance running on this system. |
VirtuallyPartitioned | A virtual or software-based partition of a computer system. |
The action to perform when the watchdog timer reaches its timeout value.
string | Description |
---|---|
None | No action taken. |
OEM | Perform an OEM-defined action. |
PowerCycle | Power cycle the system. |
PowerDown | Power down the system. |
ResetSystem | Reset the system. |
The Trusted Module boot requirement.
string | Description |
---|---|
Disabled | No Trusted Module requirement to boot. |
Required | A functional Trusted Module is required to boot. |
The UUID for this system.
The UUID property contains a value that represents the universal unique identifier number (UUID) of a system.
The UUID property is a string data type. The RFC4122-specified 35-character string format is xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
, where each x
represents a hexadecimal value from 0
to f
.
Regarding the case of the hexadecimal values, RFC4122 specifies that the hexadecimal values should be lowercase characters. Most modern scripting languages typically also represent hexadecimal values in lowercase characters following the RFC. However, dmidecode, WMI and some Redfish implementations currently use uppercase characters for UUID on output.
The action to perform when the watchdog timer is close to reaching its timeout value. This action typically occurs from three to ten seconds before to the timeout value, but the exact timing is dependent on the implementation.
string | Description |
---|---|
DiagnosticInterrupt | Raise a (typically non-maskable) Diagnostic Interrupt. |
MessagingInterrupt | Raise a legacy IPMI messaging interrupt. |
None | No action taken. |
OEM | Perform an OEM-defined action. |
SCI | Raise an interrupt using the ACPI System Control Interrupt (SCI). |
SMI | Raise a Systems Management Interrupt (SMI). |
{ "@odata.type": "#ComputerSystem.v1_14_0.ComputerSystem", "Id": "437XR1138R2", "Name": "WebFrontEnd483", "SystemType": "Physical", "AssetTag": "Chicago-45Z-2381", "Manufacturer": "Contoso", "Model": "3500RX", "SKU": "8675309", "SerialNumber": "437XR1138R2", "PartNumber": "224071-J23", "Description": "Web Front End node", "UUID": "38947555-7742-3448-3784-823347823834", "HostName": "web483", "Status": { "State": "Enabled", "Health": "OK", "HealthRollup": "OK" }, "HostingRoles": [ "ApplicationServer" ], "IndicatorLED": "Off", "PowerState": "On", "Boot": { "BootSourceOverrideEnabled": "Once", "BootSourceOverrideTarget": "Pxe", "BootSourceOverrideTarget@Redfish.AllowableValues": [ "None", "Pxe", "Cd", "Usb", "Hdd", "BiosSetup", "Utilities", "Diags", "SDCard", "UefiTarget" ], "BootSourceOverrideMode": "UEFI", "UefiTargetBootSourceOverride": "/0x31/0x33/0x01/0x01" }, "TrustedModules": [ { "FirmwareVersion": "1.13b", "InterfaceType": "TPM1_2", "Status": { "State": "Enabled", "Health": "OK" } } ], "Oem": { "Contoso": { "@odata.type": "#Contoso.ComputerSystem", "ProductionLocation": { "FacilityName": "PacWest Production Facility", "Country": "USA" } }, "Chipwise": { "@odata.type": "#Chipwise.ComputerSystem", "Style": "Executive" } }, "BiosVersion": "P79 v1.33 (02/28/2015)", "ProcessorSummary": { "Count": 2, "Model": "Multi-Core Intel(R) Xeon(R) processor 7xxx Series", "Status": { "State": "Enabled", "Health": "OK", "HealthRollup": "OK" } }, "MemorySummary": { "TotalSystemMemoryGiB": 96, "TotalSystemPersistentMemoryGiB": 0, "MemoryMirroring": "None", "Status": { "State": "Enabled", "Health": "OK", "HealthRollup": "OK" } }, "Bios": { "@odata.id": "/redfish/v1/Systems/437XR1138R2/BIOS" }, "Processors": { "@odata.id": "/redfish/v1/Systems/437XR1138R2/Processors" }, "Memory": { "@odata.id": "/redfish/v1/Systems/437XR1138R2/Memory" }, "EthernetInterfaces": { "@odata.id": "/redfish/v1/Systems/437XR1138R2/EthernetInterfaces" }, "SimpleStorage": { "@odata.id": "/redfish/v1/Systems/437XR1138R2/SimpleStorage" }, "LogServices": { "@odata.id": "/redfish/v1/Systems/437XR1138R2/LogServices" }, "Links": { "Chassis": [ { "@odata.id": "/redfish/v1/Chassis/1U" } ], "ManagedBy": [ { "@odata.id": "/redfish/v1/Managers/BMC" } ] }, "Actions": { "#ComputerSystem.Reset": { "target": "/redfish/v1/Systems/437XR1138R2/Actions/ComputerSystem.Reset", "ResetType@Redfish.AllowableValues": [ "On", "ForceOff", "GracefulShutdown", "GracefulRestart", "ForceRestart", "Nmi", "ForceOn", "PushPowerButton" ] }, "Oem": { "#Contoso.Reset": { "target": "/redfish/v1/Systems/437XR1138R2/Oem/Contoso/Actions/Contoso.Reset" } } }, "@odata.id": "/redfish/v1/Systems/437XR1138R2" }
v1.0 |
2020.3 |
The Connection schema describes the access permissions endpoints, or groups of endpoints, have with other resources in the service.
string (enum) | The type of resources this connection specifies. For the possible property values, see ConnectionType in Property details. | ||
object | The links to other resources that are related to this resource. | ||
| array | An array of links to the initiator endpoint groups that are associated with this connection. | |
} ] | string | Link to a EndpointGroup resource. See the Links section and the EndpointGroup schema for details. | |
| array | An array of links to the initiator endpoints that are associated with this connection. | |
} ] | string | Link to a Endpoint resource. See the Links section and the Endpoint schema for details. | |
| object | See the Oem object definition in the Common properties section. | |
| array | An array of links to the target endpoint groups that are associated with this connection. | |
} ] | string | Link to a EndpointGroup resource. See the Links section and the EndpointGroup schema for details. | |
| array | An array of links to the target endpoints that are associated with this connection. | |
} ] } | string | Link to a Endpoint resource. See the Links section and the Endpoint schema for details. | |
object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. | ||
array | The set of volumes and access capabilities specified for this connection. | ||
| array (string (enum)) | Supported IO access capabilities. For the possible property values, see AccessCapabilities in Property details. | |
| string (enum) | The access state for this connection. For the possible property values, see AccessState in Property details. | |
| object | The specified volume. | |
} } ] | string (URI) | The unique identifier for a resource. |
Supported IO access capabilities.
string | Description |
---|---|
Read | Endpoints are allowed to perform reads from the specified resource. |
Write | Endpoints are allowed to perform writes to the specified resource. |
The access state for this connection.
string | Description |
---|---|
NonOptimized | The resource is in an active and non-optimized state. |
Optimized | The resource is in an active and optimized state. |
Standby | The resource is in a standby state. |
Transitioning | The resource is transitioning to a new state. |
Unavailable | The resource is in an unavailable state. |
The type of resources this connection specifies.
string | Description |
---|---|
Memory | A connection to memory related resources. |
Storage | A connection to storage related resources, such as volumes. |
v1.0 |
2020.2 |
The ConnectionMethod schema describes the protocol, provider, or other method used to communicate to a given access point for a Redfish aggregation service.
string (enum) | The type of connection method. For the possible property values, see ConnectionMethodType in Property details. | ||
string | The variant of connection method. | ||
object | The links to other resources that are related to this resource. | ||
| array | An array of links to the access points using this connection method. | |
} ] | string | Link to a AggregationSource resource. See the Links section and the AggregationSource schema for details. | |
} | object | See the Oem object definition in the Common properties section. |
The type of connection method.
string | Description |
---|---|
IPMI15 | IPMI 1.5 connection method. |
IPMI20 | IPMI 2.0 connection method. |
NETCONF | NETCONF connection method. |
OEM | OEM connection method. |
Redfish | Redfish connection method. |
SNMP | SNMP connection method. |
v1.12 | v1.11 | v1.10 | v1.9 | v1.8 | v1.7 | v1.6 | v1.5 | v1.4 | v1.3 | v1.2 | ... |
2020.4 | 2020.3 | 2020.2 | 2019.4 | 2019.3 | 2019.2 | 2019.1 | 2018.2 | 2018.1 | 2017.3 | 2017.1 | ... |
The Drive schema represents a single physical drive for a system, including links to associated volumes.
object | The link to the assembly associated with this drive. See the Assembly schema for details on this property. | ||
} | string | Link to a Assembly resource. See the Links section and the Assembly schema for details. | |
string | The user-assigned asset tag for this drive. | ||
integer (bytes) | The size, in bytes, of the smallest addressable unit, or block. | ||
number (Gbit/s) | The speed, in gigabit per second (Gbit/s), at which this drive can communicate to a storage controller in ideal conditions. | ||
integer (bytes) | The size, in bytes, of this drive. | ||
object | The link to a collection of certificates for device identity and attestation. Contains a link to a resource. | ||
} | string | Link to Collection of Certificate. See the Certificate schema for details. | |
string (enum) | The encryption ability of this drive. For the possible property values, see EncryptionAbility in Property details. | ||
string (enum) | The status of the encryption of this drive. For the possible property values, see EncryptionStatus in Property details. | ||
object | The link to the environment metrics for this drive. See the EnvironmentMetrics schema for details on this property. | ||
} | string | Link to a EnvironmentMetrics resource. See the Links section and the EnvironmentMetrics schema for details. | |
boolean | An indication of whether this drive currently predicts a failure in the near future. | ||
string (enum) | The replacement mode for the hot spare drive. For the possible property values, see HotspareReplacementMode in Property details. | ||
string (enum) | The type of hot spare that this drive currently serves as. For the possible property values, see HotspareType in Property details. | ||
array (object) | The durable names for the drive. Any additional identifiers for a resource. For property details, see Identifier. | ||
string (enum) | The state of the indicator LED, that identifies the drive. For the possible property values, see IndicatorLED in Property details. Deprecated in v1.11 and later. This property has been deprecated in favor of the LocationIndicatorActive property. | ||
object | The links to other resources that are related to this resource. | ||
| object | The link to the chassis that contains this drive. See the Chassis schema for details on this property. | |
} | string | Link to a Chassis resource. See the Links section and the Chassis schema for details. | |
| array | An array of links to the endpoints that connect to this drive. | |
} ] | string | Link to a Endpoint resource. See the Links section and the Endpoint schema for details. | |
| object | See the Oem object definition in the Common properties section. | |
| array | An array of links to the PCIe functions that the drive produces. | |
} ] | string | Link to a PCIeFunction resource. See the Links section and the PCIeFunction schema for details. | |
| array | An array of links to the storage pools to which this drive belongs. | |
} ] | string (URI) | The unique identifier for a resource. | |
| array | An array of links to the volumes that this drive either wholly or only partially contains. | |
} ] } | string (URI) | The unique identifier for a resource. | |
array (object) | The location of the drive. The location of a resource. For property details, see Location. Deprecated in v1.4 and later. This property has been deprecated in favor of the singular property PhysicalLocation found in Drive.v1_4_0. | ||
boolean | An indicator allowing an operator to physically locate this resource. | ||
string | The manufacturer of this drive. | ||
array | An array of DSP0274-defined measurement blocks. | ||
} ] | string | Link to a MeasurementBlock resource. See the Links section and the SoftwareInventory schema for details. | |
string (enum) | The type of media contained in this drive. For the possible property values, see MediaType in Property details. | ||
string | The model number for the drive. | ||
boolean | An indication of whether the drive is accessible from multiple paths. | ||
number (Gbit/s) | The speed, in gigabit per second (Gbit/s), at which this drive currently communicates to the storage controller. | ||
array | The operations currently running on the Drive. | ||
| object | The link to the task associated with the operation, if any. See the Task schema for details on this property. | |
} | string | Link to a Task resource. See the Links section and the Task schema for details. | |
| string | The name of the operation. | |
} ] | integer (%) | The percentage of the operation that has been completed. | |
string | The part number for this drive. | ||
object | The location of the drive. For property details, see Location. | ||
number (%) | The percentage of reads and writes that are predicted to be available for the media. | ||
string (enum) | The protocol that this drive currently uses to communicate to the storage controller. For the possible property values, see Protocol in Property details. | ||
boolean | An indication of whether the drive is prepared by the system for removal. | ||
string | The revision of this drive. This is typically the firmware or hardware version of the drive. | ||
number (RPM) | The rotation speed of this drive, in revolutions per minute (RPM). | ||
string | The serial number for this drive. | ||
string | The SKU for this drive. | ||
object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. | ||
string (enum) | The state of the status indicator, which communicates status information about this drive. For the possible property values, see StatusIndicator in Property details. | ||
boolean | An indication of whether the drive write cache is enabled. |
This action resets this drive.
Action URI: {Base URI of target resource}/Actions/Drive.ResetPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
} | string (enum) | optional | The type of reset. For the possible property values, see ResetType in Property details. |
This action securely erases the contents of the drive.
Action URI: {Base URI of target resource}/Actions/Drive.SecureErasePerform the action using a POST to the specific Action URI for this resource. This action takes no parameters.
The encryption ability of this drive.
string | Description |
---|---|
None | The drive is not capable of self-encryption. |
Other | The drive is capable of self-encryption through some other means. |
SelfEncryptingDrive | The drive is capable of self-encryption per the Trusted Computing Group's Self Encrypting Drive Standard. |
The status of the encryption of this drive.
string | Description |
---|---|
Foreign | The drive is currently encrypted, the data is not accessible to the user, and the system requires user intervention to expose the data. |
Locked | The drive is currently encrypted and the data is not accessible to the user. However, the system can unlock the drive automatically. |
Unecrypted (deprecated v1.1) | The drive is not currently encrypted. This value has been deprecated in favor of Unencrypted. |
Unencrypted (v1.1+) | The drive is not currently encrypted. |
Unlocked | The drive is currently encrypted but the data is accessible to the user in unencrypted form. |
The replacement mode for the hot spare drive.
string | Description |
---|---|
NonRevertible | The hot spare drive that is commissioned due to a drive failure remains as a data drive and does not revert to a hot spare if the failed drive is replaced. |
Revertible | The hot spare drive that is commissioned due to a drive failure reverts to a hot spare after the failed drive is replaced and rebuilt. |
The type of hot spare that this drive currently serves as.
string | Description |
---|---|
Chassis | The drive is currently serving as a hot spare for all other drives in the chassis. |
Dedicated | The drive is currently serving as a hot spare for a user-defined set of drives. |
Global | The drive is currently serving as a hot spare for all other drives in the storage system. |
None | The drive is not currently a hot spare. |
The state of the indicator LED, that identifies the drive.
string | Description |
---|---|
Blinking | The indicator LED is blinking. |
Lit | The indicator LED is lit. |
Off | The indicator LED is off. |
The type of media contained in this drive.
string | Description |
---|---|
HDD | The drive media type is traditional magnetic platters. |
SMR | The drive media type is shingled magnetic recording. |
SSD | The drive media type is solid state or flash memory. |
The protocol that this drive currently uses to communicate to the storage controller.
string | Description |
---|---|
AHCI | Advanced Host Controller Interface (AHCI). |
Ethernet | Ethernet. |
FC | Fibre Channel. |
FCoE | Fibre Channel over Ethernet (FCoE). |
FCP | Fibre Channel Protocol for SCSI. |
FICON | FIbre CONnection (FICON). |
FTP | File Transfer Protocol (FTP). |
GenZ | GenZ. |
HTTP | Hypertext Transport Protocol (HTTP). |
HTTPS | Hypertext Transfer Protocol Secure (HTTPS). |
I2C | Inter-Integrated Circuit Bus. |
InfiniBand | InfiniBand. |
iSCSI | Internet SCSI. |
iWARP | Internet Wide Area RDMA Protocol (iWARP). |
MultiProtocol | Multiple Protocols. |
NFSv3 | Network File System (NFS) version 3. |
NFSv4 | Network File System (NFS) version 4. |
NVMe | Non-Volatile Memory Express (NVMe). |
NVMeOverFabrics | NVMe over Fabrics. |
OEM | OEM-specific. |
PCIe | PCI Express. |
RoCE | RDMA over Converged Ethernet Protocol. |
RoCEv2 | RDMA over Converged Ethernet Protocol Version 2. |
SAS | Serial Attached SCSI. |
SATA | Serial AT Attachment. |
SFTP | SSH File Transfer Protocol (SFTP). |
SMB | Server Message Block (SMB). Also known as the Common Internet File System (CIFS). |
TCP | Transmission Control Protocol (TCP). |
TFTP | Trivial File Transfer Protocol (TFTP). |
UDP | User Datagram Protocol (UDP). |
UHCI | Universal Host Controller Interface (UHCI). |
USB | Universal Serial Bus (USB). |
The type of reset.
string | Description |
---|---|
ForceOff | Turn off the unit immediately (non-graceful shutdown). |
ForceOn | Turn on the unit immediately. |
ForceRestart | Shut down immediately and non-gracefully and restart the system. |
GracefulRestart | Shut down gracefully and restart the system. |
GracefulShutdown | Shut down gracefully and power off. |
Nmi | Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system. |
On | Turn on the unit. |
PowerCycle | Power cycle the unit. Behaves like a full power removal, followed by a power restore to the resource. |
PushPowerButton | Simulate the pressing of the physical power button on this unit. |
The state of the status indicator, which communicates status information about this drive.
string | Description |
---|---|
Fail | The drive has failed. |
Hotspare | The drive has been marked to automatically rebuild and replace a failed drive. |
InACriticalArray | The array to which this drive belongs has been degraded. |
InAFailedArray | The array to which this drive belongs has failed. |
OK | The drive is OK. |
PredictiveFailureAnalysis | The drive still works but is predicted to fail soon. |
Rebuild | The drive is being rebuilt. |
{ "@odata.type": "#Drive.v1_12_0.Drive", "Id": "3D58ECBC375FD9F2", "Name": "Drive Sample", "IndicatorLED": "Lit", "Model": "C123", "Revision": "100A", "Status": { "State": "Enabled", "Health": "OK" }, "CapacityBytes": 899527000000, "FailurePredicted": false, "Protocol": "SAS", "MediaType": "HDD", "Manufacturer": "Contoso", "SerialNumber": "1234568", "PartNumber": "C123-1111", "Identifiers": [ { "DurableNameFormat": "NAA", "DurableName": "32ADF365C6C1B7BD" } ], "HotspareType": "None", "EncryptionAbility": "SelfEncryptingDrive", "EncryptionStatus": "Unlocked", "RotationSpeedRPM": 15000, "BlockSizeBytes": 512, "CapableSpeedGbs": 12, "NegotiatedSpeedGbs": 12, "Links": { "Volumes": [ { "@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Volumes/2" }, { "@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Volumes/3" } ] }, "Actions": { "#Drive.SecureErase": { "target": "/redfish/v1/Systems/437XR1138R2/Storage/1/Drives/3D58ECBC375FD9F2/Actions/Drive.SecureErase" } }, "@odata.id": "/redfish/v1/Systems/437XR1138R2/Storage/1/Drives/3D58ECBC375FD9F2" }
v1.5 | v1.4 | v1.3 | v1.2 | v1.1 | v1.0 |
2020.3 | 2019.4 | 2018.3 | 2018.2 | 2017.3 | 2016.2 |
The Endpoint schema contains the properties of an endpoint resource that represents the properties of an entity that sends or receives protocol-defined messages over a transport.
array | All the entities connected to this endpoint. | ||
| The link to the associated entity. | ||
| object | The PCI ID of the connected entity. | |
| string | The Class Code, Subclass, and Programming Interface code of this PCIe function. | |
| string | The Device ID of this PCIe function. | |
| integer | The PCI ID of the connected entity. | |
| string | The Subsystem ID of this PCIe function. | |
| string | The Subsystem Vendor ID of this PCIe function. | |
} | string | The Vendor ID of this PCIe function. | |
| string (enum) | The role of the connected entity. For the possible property values, see EntityRole in Property details. | |
| string (enum) | The type of the connected entity. For the possible property values, see EntityType in Property details. | |
| object | (null) | The Gen-Z related properties for the entity. |
| string | The Access Key for the entity. | |
| object | (null) | The Global Component ID (GCID) for the entity. |
| string | The component identifier portion of the GCID for the entity. | |
} | string | The subnet identifier portion of the GCID for the entity. | |
} | string | The Region Key for the entity. | |
| array (object) | Identifiers for the remote entity. Any additional identifiers for a resource. For property details, see Identifier. | |
| object | See the Oem object definition in the Common properties section. | |
| string | The Class Code, Subclass, and Programming Interface code of this PCIe function. Deprecated in v1.2 and later. This property has been deprecated in favor of the ClassCode property inside the EntityPciId object. | |
} ] | integer | The PCI ID of the connected entity. Deprecated in v1.2 and later. This property has been deprecated in favor of the FunctionNumber property inside the EntityPciId object. | |
string (enum) | The protocol supported by this endpoint. For the possible property values, see EndpointProtocol in Property details. | ||
integer (bytes) | The amount of memory in bytes that the host should allocate to connect to this endpoint. | ||
array (object) | Identifiers for this endpoint. Any additional identifiers for a resource. For property details, see Identifier. | ||
array | An array of details for each IP transport supported by this endpoint. The array structure can model multiple IP addresses for this endpoint. | ||
| object | The IPv4 addresses assigned to the endpoint. For property details, see IPv4Address. | |
| object | The IPv6 addresses assigned to the endpoint. For property details, see IPv6Address. | |
| number | The UDP or TCP port number used by the endpoint. | |
} ] | string (enum) | The protocol used by the connection entity. For the possible property values, see TransportProtocol in Property details. | |
object | The links to other resources that are related to this resource. | ||
| array | An array of links to the address pools associated with this endpoint. | |
} ] | string | Link to a AddressPool resource. See the Links section and the AddressPool schema for details. | |
| array | An array of links to the ports that connect to this endpoint. | |
} ] | string | Link to a Port resource. See the Links section and the Port schema for details. | |
| array | The connections to which this endpoint belongs. | |
} ] | string | Link to a Connection resource. See the Links section and the Connection schema for details. | |
| array | An array of links to the endpoints that cannot be used in zones if this endpoint is in a zone. | |
} ] | string | Link to another Endpoint resource. | |
| array | When NetworkDeviceFunction resources are present, this array contains links to the network device functions that connect to this endpoint. | |
} ] | string | Link to a NetworkDeviceFunction resource. See the Links section and the NetworkDeviceFunction schema for details. | |
| object | See the Oem object definition in the Common properties section. | |
| array | An array of links to the physical ports associated with this endpoint. | |
} ] } | string | Link to a Port resource. See the Links section and the Port schema for details. | |
object | The PCI ID of the endpoint. | ||
| string | The Class Code, Subclass, and Programming Interface code of this PCIe function. | |
| string | The Device ID of this PCIe function. | |
| integer | The PCI ID of the connected entity. | |
| string | The Subsystem ID of this PCIe function. | |
| string | The Subsystem Vendor ID of this PCIe function. | |
} | string | The Vendor ID of this PCIe function. | |
array (object) | A reference to a set of Redundancy entities that provide redundant Services for this Resource. See the Redundancy object definition in the Common objects section. For property details, see Redundancy. | ||
object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. |
The protocol supported by this endpoint.
string | Description |
---|---|
AHCI | Advanced Host Controller Interface (AHCI). |
Ethernet | Ethernet. |
FC | Fibre Channel. |
FCoE | Fibre Channel over Ethernet (FCoE). |
FCP | Fibre Channel Protocol for SCSI. |
FICON | FIbre CONnection (FICON). |
FTP | File Transfer Protocol (FTP). |
GenZ | GenZ. |
HTTP | Hypertext Transport Protocol (HTTP). |
HTTPS | Hypertext Transfer Protocol Secure (HTTPS). |
I2C | Inter-Integrated Circuit Bus. |
InfiniBand | InfiniBand. |
iSCSI | Internet SCSI. |
iWARP | Internet Wide Area RDMA Protocol (iWARP). |
MultiProtocol | Multiple Protocols. |
NFSv3 | Network File System (NFS) version 3. |
NFSv4 | Network File System (NFS) version 4. |
NVMe | Non-Volatile Memory Express (NVMe). |
NVMeOverFabrics | NVMe over Fabrics. |
OEM | OEM-specific. |
PCIe | PCI Express. |
RoCE | RDMA over Converged Ethernet Protocol. |
RoCEv2 | RDMA over Converged Ethernet Protocol Version 2. |
SAS | Serial Attached SCSI. |
SATA | Serial AT Attachment. |
SFTP | SSH File Transfer Protocol (SFTP). |
SMB | Server Message Block (SMB). Also known as the Common Internet File System (CIFS). |
TCP | Transmission Control Protocol (TCP). |
TFTP | Trivial File Transfer Protocol (TFTP). |
UDP | User Datagram Protocol (UDP). |
UHCI | Universal Host Controller Interface (UHCI). |
USB | Universal Serial Bus (USB). |
The role of the connected entity.
string | Description |
---|---|
Both | The entity can both send and receive commands, messages, and other requests to or from other entities on the fabric. |
Initiator | The entity sends commands, messages, or other types of requests to other entities on the fabric, but cannot receive commands from other entities. |
Target | The entity receives commands, messages, or other types of requests from other entities on the fabric, but cannot send commands to other entities. |
The type of the connected entity.
string | Description |
---|---|
AccelerationFunction (v1.3+) | The entity is an acceleration function realized through a device, such as an FPGA. The EntityLink property, if present, should be an AccelerationFunction type. |
Bridge | The entity is a PCI(e) bridge. |
DisplayController | The entity is a display controller. |
Drive | The entity is a disk drive. The EntityLink property, if present, should be a Drive type. |
FabricBridge (v1.4+) | The entity is a fabric bridge. The EntityLink property, if present, should be a FabricAdapter type. |
Manager (v1.5+) | The entity is a manager. The EntityLink property, if present, should be a Manager type. |
MediaController (v1.4+) | The entity is a media controller. The EntityLink property, if present, should be a MediaController type. |
MemoryChunk (v1.4+) | The entity is a memory chunk. The EntityLink property, if present, should be a MemoryChunk type. |
NetworkController | The entity is a network controller. The EntityLink property, if present, should contain an EthernetInterface type. |
Processor | The entity is a processor device. |
RootComplex | The entity is a PCI(e) root complex. The EntityLink property, if present, should be a ComputerSystem type. |
StorageExpander | The entity is a storage expander. The EntityLink property, if present, should be a Chassis type. |
StorageInitiator | The entity is a storage initiator. The EntityLink property, if present, should be a StorageController type. |
Switch (v1.4+) | The entity is a switch, not an expander. Use `Expander` for expanders. The EntityLink property, if present, should be a Switch type. |
Volume (v1.1+) | The entity is a volume. The EntityLink property, if present, should be a Volume type. |
The protocol used by the connection entity.
string | Description |
---|---|
AHCI | Advanced Host Controller Interface (AHCI). |
Ethernet | Ethernet. |
FC | Fibre Channel. |
FCoE | Fibre Channel over Ethernet (FCoE). |
FCP | Fibre Channel Protocol for SCSI. |
FICON | FIbre CONnection (FICON). |
FTP | File Transfer Protocol (FTP). |
GenZ | GenZ. |
HTTP | Hypertext Transport Protocol (HTTP). |
HTTPS | Hypertext Transfer Protocol Secure (HTTPS). |
I2C | Inter-Integrated Circuit Bus. |
InfiniBand | InfiniBand. |
iSCSI | Internet SCSI. |
iWARP | Internet Wide Area RDMA Protocol (iWARP). |
MultiProtocol | Multiple Protocols. |
NFSv3 | Network File System (NFS) version 3. |
NFSv4 | Network File System (NFS) version 4. |
NVMe | Non-Volatile Memory Express (NVMe). |
NVMeOverFabrics | NVMe over Fabrics. |
OEM | OEM-specific. |
PCIe | PCI Express. |
RoCE | RDMA over Converged Ethernet Protocol. |
RoCEv2 | RDMA over Converged Ethernet Protocol Version 2. |
SAS | Serial Attached SCSI. |
SATA | Serial AT Attachment. |
SFTP | SSH File Transfer Protocol (SFTP). |
SMB | Server Message Block (SMB). Also known as the Common Internet File System (CIFS). |
TCP | Transmission Control Protocol (TCP). |
TFTP | Trivial File Transfer Protocol (TFTP). |
UDP | User Datagram Protocol (UDP). |
UHCI | Universal Host Controller Interface (UHCI). |
USB | Universal Serial Bus (USB). |
{ "@odata.type": "#Endpoint.v1_5_1.Endpoint", "Id": "Drive1", "Name": "SAS Drive", "Description": "The SAS Drive in Enclosure 2 Bay 0", "EndpointProtocol": "SAS", "ConnectedEntities": [ { "EntityType": "Drive", "EntityRole": "Target", "Identifiers": [ { "DurableNameFormat": "NAA", "DurableName": "32ADF365C6C1B7C3" } ], "Oem": {} } ], "Links": { "MutuallyExclusiveEndpoints": [ { "@odata.id": "/redfish/v1/Fabrics/SAS/Endpoints/Enclosure2" } ], "Ports": [ { "@odata.id": "/redfish/v1/Fabrics/SAS/Switches/Switch1/Ports/8" }, { "@odata.id": "/redfish/v1/Fabrics/SAS/Switches/Switch2/Ports/8" } ], "Oem": {} }, "Oem": {}, "@odata.id": "/redfish/v1/Fabrics/SAS/Endpoints/Drive1" }
v1.3 | v1.2 | v1.1 | v1.0 |
2020.3 | WIP v1.1.0 | WIP v1.0.5 | TP v1.0.3 |
The EndpointGroup schema describes group of endpoints that are managed as a unit.
string (enum) | The access state for this group. For the possible property values, see AccessState in Property details. Deprecated in v1.3 and later. This property has been deprecated in favor of the AccessState property in the connection resource. | ||
array | The endpoints in this endpoint group. Deprecated in v1.3 and later. This property has been deprecated in favor of the Endpoints property within Links. | ||
} ] | string | Link to a Endpoint resource. See the Links section and the Endpoint schema for details. | |
string (enum) | The endpoint group type. For the possible property values, see GroupType in Property details. | ||
object | The durable name for the endpoint group. For property details, see Identifier. | ||
object | The links to other resources that are related to this resource. | ||
| array | The connections to which this endpoint group belongs. | |
} ] | string | Link to a Connection resource. See the Links section and the Connection schema for details. | |
| array | The endpoints in this endpoint group. | |
} ] | string | Link to a Endpoint resource. See the Links section and the Endpoint schema for details. | |
} | object | See the Oem object definition in the Common properties section. | |
boolean | An indication if access to the resources through the endpoint group is preferred. Deprecated in v1.2 and later. This property has been deprecated in favor of the AccessState property in the connection resource. | ||
integer | The SCSI-defined identifier for this group. |
The access state for this group.
string | Description |
---|---|
NonOptimized | The endpoints are in an active and non-optimized state. |
Optimized | The endpoints are in an active and optimized state. |
Standby | The endpoints are in a standby state. |
Transitioning | The endpoints are transitioning to a new state. |
Unavailable | The endpoints are in an unavailable state. |
The endpoint group type.
string | Description |
---|---|
Client (deprecated v1.3) | The group contains the client (initiator) endpoints. This value has been deprecated in favor of `Initiator`. |
Initiator (v1.3+) | The group contains the initiator endpoints. |
Server (deprecated v1.3) | The group contains the server (target) endpoints. This value has been deprecated in favor of `Target`. |
Target (v1.3+) | The group contains the target endpoints. |
v1.0 |
2020.4 |
The EnvironmentMetrics schema represents the environmental metrics of a device.
object (excerpt) | Energy consumption (kWh). This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | ||
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The total accumulation value for this sensor. | |
| number | The sensor value. | |
} | string (date-time) | The date and time when the time-based properties were last reset. | |
array (excerpt) | Fan speeds (percent). This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | ||
| string (URI) | The link to the resource that provides the data for this sensor. | |
| string | The name of the device. | |
| string (enum) | The area or device to which this sensor measurement applies. For the possible property values, see PhysicalContext in Property details. | |
| string (enum) | The usage or location within a device to which this sensor measurement applies. For the possible property values, see PhysicalSubContext in Property details. | |
| number | The sensor value. | |
} ] | number (RPM) | The rotational speed. | |
object (excerpt) | Humidity (percent). This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | ||
| string (URI) | The link to the resource that provides the data for this sensor. | |
} | number | The sensor value. | |
object (excerpt) | Power consumption (Watts). This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | ||
| number (V.A) | The product of voltage and current for an AC circuit, in Volt-Ampere units. | |
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The power factor for this sensor. | |
| number (V.A) | The square root of the difference term of squared ApparentVA and squared Power (Reading) for a circuit, in var units. | |
} | number | The sensor value. | |
object (excerpt) | Temperature (Celsius). This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | ||
| string (URI) | The link to the resource that provides the data for this sensor. | |
} | number | The sensor value. |
This action resets the summary metrics related to this equipment.
Action URI: {Base URI of target resource}/Actions/EnvironmentMetrics.ResetMetricsPerform the action using a POST to the specific Action URI for this resource. This action takes no parameters.
The area or device to which this sensor measurement applies.
string | Description |
---|---|
Accelerator | An accelerator. |
ACInput | An AC input. |
ACMaintenanceBypassInput | An AC maintenance bypass input. |
ACOutput | An AC output. |
ACStaticBypassInput | An AC static bypass input. |
ACUtilityInput | An AC utility input. |
ASIC | An ASIC device, such as a networking chip or chipset component. |
Back | The back of the chassis. |
Backplane | A backplane within the chassis. |
Chassis | The entire chassis. |
ComputeBay | Within a compute bay. |
CoolingSubsystem | The entire cooling, or air and liquid, subsystem. |
CPU | A processor (CPU). |
CPUSubsystem | The entire processor (CPU) subsystem. |
DCBus | A DC bus. |
Exhaust | The air exhaust point or points or region of the chassis. |
ExpansionBay | Within an expansion bay. |
Fan | A fan. |
FPGA | An FPGA. |
Front | The front of the chassis. |
GPU | A graphics processor (GPU). |
GPUSubsystem | The entire graphics processor (GPU) subsystem. |
Intake | The air intake point or points or region of the chassis. |
LiquidInlet | The liquid inlet point of the chassis. |
LiquidOutlet | The liquid outlet point of the chassis. |
Lower | The lower portion of the chassis. |
Memory | A memory device. |
MemorySubsystem | The entire memory subsystem. |
Motor | A motor. |
NetworkBay | Within a networking bay. |
NetworkingDevice | A networking device. |
PowerSubsystem | The entire power subsystem. |
PowerSupply | A power supply. |
PowerSupplyBay | Within a power supply bay. |
Rectifier | A rectifier device. |
Room | The room. |
StorageBay | Within a storage bay. |
StorageDevice | A storage device. |
SystemBoard | The system board (PCB). |
Transformer | A transformer. |
TrustedModule | A trusted module. |
Upper | The upper portion of the chassis. |
VoltageRegulator | A voltage regulator device. |
The usage or location within a device to which this sensor measurement applies.
string | Description |
---|---|
Input | The input. |
Output | The output. |
{ "@odata.type": "#EnvironmentMetrics.v1_0_0.EnvironmentMetrics", "Name": "Processor Environment Metrics", "TemperatureCelsius": { "DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/CPU1Temp", "Reading": 44 }, "PowerWatts": { "DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/CPU1Power", "Reading": 12.87 }, "FanSpeedsPercent": [ { "DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/CPUFan1", "DeviceName": "CPU #1 Fan Speed", "Reading": 80 } ], "Oem": {}, "@odata.id": "/redfish/v1/Systems/437XR1138R2/Processors/1/EnvironmentMetrics" }
v1.6 | v1.5 | v1.4 | v1.3 | v1.2 | v1.1 | v1.0 |
2020.1 | 2019.1 | 2017.3 | 2017.1 | 2016.3 | 2016.2 | 1.0 |
The EthernetInterface schema represents a single, logical Ethernet interface or network interface controller (NIC).
boolean | An indication of whether the speed and duplex are automatically negotiated and configured on this interface. | ||
object | DHCPv4 configuration for this interface. | ||
| boolean | An indication of whether DHCP v4 is enabled on this Ethernet interface. | |
| string (enum) | DHCPv4 fallback address method for this interface. For the possible property values, see FallbackAddress in Property details. | |
| boolean | An indication of whether this interface uses DHCP v4-supplied DNS servers. | |
| boolean | An indication of whether this interface uses a DHCP v4-supplied domain name. | |
| boolean | An indication of whether this interface uses a DHCP v4-supplied gateway. | |
| boolean | An indication of whether the interface uses DHCP v4-supplied NTP servers. | |
} | boolean | An indication of whether the interface uses DHCP v4-supplied static routes. | |
object | DHCPv6 configuration for this interface. | ||
| string (enum) | Determines the DHCPv6 operating mode for this interface. For the possible property values, see OperatingMode in Property details. | |
| boolean | An indication of whether the interface uses DHCP v6-supplied DNS servers. | |
| boolean | An indication of whether the interface uses a domain name supplied through DHCP v6 stateless mode. | |
| boolean | An indication of whether the interface uses DHCP v6-supplied NTP servers. | |
} | boolean | An indication of whether the interface uses DHCP v6 rapid commit mode for stateful mode address assignments. Do not enable this option in networks where more than one DHCP v6 server is configured to provide address assignments. | |
string (enum) | The type of interface. For the possible property values, see EthernetInterfaceType in Property details. | ||
string | The complete, fully qualified domain name that DNS obtains for this interface. | ||
boolean | An indication of whether full-duplex mode is enabled on the Ethernet connection for this interface. | ||
string | The DNS host name, without any domain information. | ||
boolean | An indication of whether this interface is enabled. | ||
array (object) | The IPv4 addresses currently in use by this interface. This type describes an IPv4 address. For property details, see IPv4Address. | ||
array (object) | (null) | The IPv4 static addresses assigned to this interface. See IPv4Addresses for the addresses in use by this interface. This type describes an IPv4 address. For property details, see IPv4Address. | |
array (object) | The IPv6 addresses currently in use by this interface. This type describes an IPv6 address. For property details, see IPv6Address. | ||
array | An array that represents the RFC6724-defined address selection policy table. | ||
| integer | The IPv6 label, as defined in RFC6724, section 2.1. | |
| integer | The IPv6 precedence, as defined in RFC6724, section 2.1. | |
} ] | string | The IPv6 address prefix, as defined in RFC6724, section 2.1. | |
string | The IPv6 default gateway address in use on this interface. | ||
array (object) | (null) | The IPv6 static addresses assigned to this interface. See IPv6Addresses for the addresses in use by this interface. This type represents a single IPv6 static address to be assigned on a network interface. For property details, see IPv6StaticAddress. | |
array (object) | (null) | The IPv6 static default gateways for this interface. This type represents a single IPv6 static address to be assigned on a network interface. For property details, see IPv6GatewayStaticAddress v1.1.3). | |
object | The links to other resources that are related to this resource. | ||
| object | The link to the chassis that contains this Ethernet interface. See the Chassis schema for details on this property. | |
} | string | Link to a Chassis resource. See the Links section and the Chassis schema for details. | |
| array | An array of links to the endpoints that connect to this Ethernet interface. | |
} ] | string | Link to a Endpoint resource. See the Links section and the Endpoint schema for details. | |
| object | The link to a Host Interface that is associated with this Ethernet interface. See the HostInterface schema for details on this property. | |
} | string | Link to a HostInterface resource. See the Links section and the HostInterface schema for details. | |
| object | (null) | The link to the parent network device function and is only used when representing one of the VLANs on that network device function, such as is done in Unix. See the NetworkDeviceFunction schema for details on this property. |
} | string | Link to a NetworkDeviceFunction resource. See the Links section and the NetworkDeviceFunction schema for details. | |
} | object | See the Oem object definition in the Common properties section. | |
string (enum) | The link status of this interface, or port. For the possible property values, see LinkStatus in Property details. | ||
string | The currently configured MAC address of the interface, or logical port. | ||
integer | The maximum number of static IPv6 addresses that can be configured on this interface. | ||
integer | The currently configured maximum transmission unit (MTU), in bytes, on this interface. | ||
array (string) | The DNS servers in use on this interface. | ||
string | The permanent MAC address assigned to this interface, or port. | ||
integer (Mbit/s) | The current speed, in Mbit/s, of this interface. | ||
object | Stateless address autoconfiguration (SLAAC) parameters for this interface. | ||
| boolean | An indication of whether IPv4 stateless address autoconfiguration (SLAAC) is enabled for this interface. | |
} | boolean | An indication of whether IPv6 stateless address autoconfiguration (SLAAC) is enabled for this interface. | |
array (string, null) | The statically-defined set of DNS server IPv4 and IPv6 addresses. | ||
object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. | ||
string | The UEFI device path for this interface. | ||
object | If this network interface supports more than one VLAN, this property is absent. VLAN collections appear in the Links property of this resource. | ||
| boolean | An indication of whether this VLAN is enabled for this VLAN network interface. | |
| integer | The ID for this VLAN. | |
} | integer | The priority for this VLAN. | |
object | The link to a collection of VLANs, which applies only if the interface supports more than one VLAN. If this property applies, the VLANEnabled and VLANId properties do not apply. Contains a link to a resource. | ||
} | string | Link to Collection of VLanNetworkInterface. See the VLanNetworkInterface schema for details. |
The type of interface.
string | Description |
---|---|
Physical | A physical Ethernet interface. |
Virtual | A virtual Ethernet interface. |
DHCPv4 fallback address method for this interface.
string | Description |
---|---|
AutoConfig | Fall back to an autoconfigured address. |
None | Continue attempting DHCP without a fallback address. |
Static | Fall back to a static address specified by IPv4StaticAddresses. |
The link status of this interface, or port.
string | Description |
---|---|
LinkDown | No link is detected on this interface, but the interface is connected. |
LinkUp | The link is available for communication on this interface. |
NoLink | No link or connection is detected on this interface. |
Determines the DHCPv6 operating mode for this interface.
string | Description |
---|---|
Disabled | DHCPv6 is disabled. |
Stateful | DHCPv6 stateful mode. |
Stateless | DHCPv6 stateless mode. |
{ "@odata.type": "#EthernetInterface.v1_6_3.EthernetInterface", "Id": "1", "Name": "Ethernet Interface", "Description": "Manager NIC 1", "Status": { "State": "Enabled", "Health": "OK" }, "LinkStatus": "LinkUp", "PermanentMACAddress": "12:44:6A:3B:04:11", "MACAddress": "12:44:6A:3B:04:11", "SpeedMbps": 1000, "AutoNeg": true, "FullDuplex": true, "MTUSize": 1500, "HostName": "web483", "FQDN": "web483.contoso.com", "NameServers": [ "names.contoso.com" ], "IPv4Addresses": [ { "Address": "192.168.0.10", "SubnetMask": "255.255.252.0", "AddressOrigin": "DHCP", "Gateway": "192.168.0.1" } ], "DHCPv4": { "DHCPEnabled": true, "UseDNSServers": true, "UseGateway": true, "UseNTPServers": false, "UseStaticRoutes": true, "UseDomainName": true }, "DHCPv6": { "OperatingMode": "Stateful", "UseDNSServers": true, "UseDomainName": false, "UseNTPServers": false, "UseRapidCommit": false }, "StatelessAddressAutoConfig": { "IPv4AutoConfigEnabled": false, "IPv6AutoConfigEnabled": true }, "IPv4StaticAddresses": [ { "Address": "192.168.88.130", "SubnetMask": "255.255.0.0", "Gateway": "192.168.0.1" } ], "IPv6AddressPolicyTable": [ { "Prefix": "::1/128", "Precedence": 50, "Label": 0 } ], "MaxIPv6StaticAddresses": 1, "IPv6StaticAddresses": [ { "Address": "fc00:1234::a:b:c:d", "PrefixLength": 64 } ], "IPv6StaticDefaultGateways": [ { "Address": "fe80::fe15:b4ff:fe97:90cd", "PrefixLength": 64 } ], "IPv6DefaultGateway": "fe80::214:c1ff:fe4c:5c4d", "IPv6Addresses": [ { "Address": "fe80::1ec1:deff:fe6f:1e24", "PrefixLength": 64, "AddressOrigin": "SLAAC", "AddressState": "Preferred", "Oem": {} }, { "Address": "fc00:1234::a:b:c:d", "PrefixLength": 64, "AddressOrigin": "Static", "AddressState": "Preferred", "Oem": {} }, { "Address": "2001:1:3:5::100", "PrefixLength": 64, "AddressOrigin": "DHCPv6", "AddressState": "Preferred", "Oem": {} }, { "Address": "2002:2:5::1ec1:deff:fe6f:1e24", "PrefixLength": 64, "AddressOrigin": "SLAAC", "AddressState": "Preferred", "Oem": {} } ], "StaticNameServers": [ "192.168.150.1", "fc00:1234:200:2500" ], "VLAN": { "VLANEnable": true, "VLANId": 101 }, "@odata.id": "/redfish/v1/Systems/437XR1138R2/EthernetInterfaces/12446A3B0411" }
v1.6 | v1.5 | v1.4 | v1.3 | v1.2 | v1.1 | v1.0 |
2020.3 | 2020.2 | 2019.1 | 2018.2 | 2017.1 | 2016.1 | 1.0 |
The Event schema describes the JSON payload received by an event destination, which has subscribed to event notification, when events occur. This resource contains data about events, including descriptions, severity, and a message identifier to a message registry that can be accessed for further information.
string | A context can be supplied at subscription time. This property is the context value supplied by the subscriber. | ||
array | | Each event in this array has a set of properties that describe the event. Because this is an array, more than one event can be sent simultaneously. | |
| object | The available actions for this resource. | |
| string | A context can be supplied at subscription time. This property is the context value supplied by the subscriber. Deprecated in v1.1 and later. Events are triggered independently from subscriptions to those events. This property has been deprecated in favor of the Context property found at the root level of the object. | |
| integer | The identifier that correlates events with the same root cause. If 0 , no other event is related to this event. | |
| string | The unique instance identifier of an event. | |
| string (date-time) | The time the event occurred. | |
| string (enum) | The type of event. For the possible property values, see EventType in Property details. Deprecated in v1.3 and later. This property has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property. | |
| string | The identifier for the member within the collection. | |
| string | The human-readable event message. | |
| array (string) | An array of message arguments that are substituted for the arguments in the message when looked up in the message registry. | |
| string | The identifier for the message. | |
| string (enum) | The severity of the message in this event. For the possible property values, see MessageSeverity in Property details. | |
| object | See the Oem object definition in the Common properties section. | |
| object | A link to the resource or object that originated the condition that caused the event to be generated. | |
} | string (URI) | The unique identifier for a resource. | |
| string | The severity of the event. Deprecated in v1.5 and later. This property has been deprecated in favor of MessageSeverity, which ties the values to the enumerations defined for the Health property within Status. | |
} ] | boolean | Indicates this event is equivalent to a more specific event in this Event Group. |
The type of event.
string | Description |
---|---|
Alert | A condition requires attention. |
MetricReport (v1.3+) | The telemetry service is sending a metric report. |
Other (v1.4+) | Because EventType is deprecated as of Redfish Specification v1.6, the event is based on a registry or resource but not an EventType. |
ResourceAdded | A resource has been added. |
ResourceRemoved | A resource has been removed. |
ResourceUpdated | A resource has been updated. |
StatusChange | The status of a resource has changed. |
The severity of the message in this event.
string | Description |
---|---|
Critical | A critical condition requires immediate attention. |
OK | Normal. |
Warning | A condition requires attention. |
v1.10 | v1.9 | v1.8 | v1.7 | v1.6 | v1.5 | v1.4 | v1.3 | v1.2 | v1.1 | v1.0 |
2020.4 | 2020.3 | 2020.1 | 2019.3 | 2019.2 | 2019.1 | 2018.2 | 2018.1 | 2017.1 | 2016.2 | 1.0 |
The EventDestination schema defines the target of an event subscription, including the event types and context to provide to the target in the Event payload.
object | The link to a collection of server certificates for the server referenced by the Destination property. Contains a link to a resource. | ||
} | string | Link to Collection of Certificate. See the Certificate schema for details. | |
string | A client-supplied string that is stored with the event destination subscription. | ||
string (enum) | The subscription delivery retry policy for events, where the subscription type is RedfishEvent. For the possible property values, see DeliveryRetryPolicy in Property details. | ||
string (URI) | The URI of the destination event receiver. | ||
string (enum) | The content types of the message that are sent to the EventDestination. For the possible property values, see EventFormatType in Property details. | ||
array (string (enum)) | The types of events that are sent to the destination. For the possible property values, see EventTypes in Property details. Deprecated in v1.5 and later. This property has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property. Use EventFormatType to create subscriptions for Metric Reports. If the subscription does not include this property, the service shall use a single element with a default of `Other`. | ||
array | An array of settings for HTTP headers, such as authorization information. This array is null or an empty array in responses. An empty array is the preferred return value on read operations. | ||
} ] | string | Property names follow regular expression pattern "^[^:\\s]+$" | |
boolean | An indication of whether the events subscribed to will also include the entire resource or object referenced the OriginOfCondition property in the event payload. | ||
array (string, null) | The list of MessageIds that the service sends. If this property is absent or the array is empty, events with any MessageId are sent to the subscriber. | ||
array | A list of metric report definitions for which the service only sends related metric reports. If this property is absent or the array is empty, metric reports that originate from any metric report definition are sent to the subscriber. | ||
} ] | string | Link to a MetricReportDefinition resource. See the Links section and the MetricReportDefinition schema for details. | |
string | The OEM-defined protocol type of the event connection. | ||
string | The OEM-defined subscription type for events. | ||
array | The array of Resources for which the service sends only related events. If this property is absent or the array is empty, the service sends the events that originate from any Resource to the subscriber. | ||
} ] | string (URI) | The unique identifier for a resource. | |
string (enum) | The protocol type of the event connection. For the possible property values, see Protocol in Property details. | ||
array (string, null) | The list of the prefixes for the Message Registries that contain the MessageIds that are sent to this event destination. | ||
array (string, null) | The list of Resource Type values (Schema names) that correspond to the OriginOfCondition. The version and full namespace should not be specified. | ||
object | Settings for an SNMP event destination. | ||
| string | The secret authentication key for SNMPv3. | |
| boolean | Indicates if the AuthenticationKey property is set. | |
| string (enum) | The authentication protocol for SNMPv3. For the possible property values, see AuthenticationProtocol in Property details. | |
| string | The secret authentication key for SNMPv3. | |
| boolean | Indicates if the EncryptionKey property is set. | |
| string (enum) | The encryption protocol for SNMPv3. For the possible property values, see EncryptionProtocol in Property details. | |
} | string | The SNMP trap community string. | |
object | This property shall contain the status of the subscription. For property details, see Status. | ||
boolean | An indication of whether the subscription is for events in the OriginResources array and its subordinate Resources. If true and the OriginResources array is specified, the subscription is for events in the OriginResources array and its subordinate Resources. Note that Resources associated through the Links section are not considered subordinate. If false and the OriginResources array is specified, the subscription shall be for events in the OriginResources array only. If the OriginResources array is not present, this property shall have no relevance. | ||
string (enum) | The subscription type for events. For the possible property values, see SubscriptionType in Property details. | ||
array | A list of syslog message filters to send to a remote syslog server. | ||
| array (string (enum)) | The types of programs that can log messages. The syslog facility code is an enumeration of program types. For the possible property values, see LogFacilities in Property details. | |
} ] | string (enum) | The lowest severity level message that will be forwarded. For the possible property values, see LowestSeverity in Property details. | |
boolean | An indication of whether the service will verify the certificate of the server referenced by the Destination property prior to sending the event. |
This action resumes a suspended event subscription.
Action URI: {Base URI of target resource}/Actions/EventDestination.ResumeSubscriptionPerform the action using a POST to the specific Action URI for this resource. This action takes no parameters.
The authentication protocol for SNMPv3.
string | Description |
---|---|
CommunityString | Trap community string authentication. |
HMAC128_SHA224 (v1.10+) | HMAC-128-SHA-224 authentication. |
HMAC192_SHA256 (v1.10+) | HMAC-192-SHA-256 authentication. |
HMAC256_SHA384 (v1.10+) | HMAC-256-SHA-384 authentication. |
HMAC384_SHA512 (v1.10+) | HMAC-384-SHA-512 authentication. |
HMAC_MD5 | HMAC-MD5-96 authentication. |
HMAC_SHA96 | HMAC-SHA-96 authentication. |
None | No authentication. |
The subscription delivery retry policy for events, where the subscription type is RedfishEvent.
string | Description |
---|---|
RetryForever | The subscription is not suspended or terminated, and attempts at delivery of future events shall continue regardless of the number of retries. |
RetryForeverWithBackoff (v1.10+) | The subscription is not suspended or terminated, and attempts at delivery of future events shall continue regardless of the number of retries, but issued over time according to a service-defined backoff algorithm. |
SuspendRetries | The subscription is suspended after the maximum number of retries is reached. |
TerminateAfterRetries | The subscription is terminated after the maximum number of retries is reached. |
The encryption protocol for SNMPv3.
string | Description |
---|---|
CBC_DES | CBC-DES encryption. |
CFB128_AES128 | CFB128-AES-128 encryption. |
None | No encryption. |
The content types of the message that are sent to the EventDestination.
string | Description |
---|---|
Event | The subscription destination receives an event payload. |
MetricReport | The subscription destination receives a metric report. |
The types of events that are sent to the destination.
string | Description |
---|---|
Alert | A condition requires attention. |
MetricReport | The telemetry service is sending a metric report. |
Other | Because EventType is deprecated as of Redfish Specification v1.6, the event is based on a registry or resource but not an EventType. |
ResourceAdded | A resource has been added. |
ResourceRemoved | A resource has been removed. |
ResourceUpdated | A resource has been updated. |
StatusChange | The status of a resource has changed. |
The types of programs that can log messages. The syslog facility code is an enumeration of program types.
string | Description |
---|---|
Auth | Security/authentication messages. |
Authpriv | Security/authentication messages. |
Console | Log alert. |
Cron | Clock daemon. |
Daemon | System daemons. |
FTP | FTP daemon. |
Kern | Kernel messages. |
Local0 | Locally used facility 0. |
Local1 | Locally used facility 1. |
Local2 | Locally used facility 2. |
Local3 | Locally used facility 3. |
Local4 | Locally used facility 4. |
Local5 | Locally used facility 5. |
Local6 | Locally used facility 6. |
Local7 | Locally used facility 7. |
LPR | Line printer subsystem. |
Mail system. | |
News | Network news subsystem. |
NTP | NTP subsystem. |
Security | Log audit. |
SolarisCron | Scheduling daemon. |
Syslog | Messages generated internally by syslogd. |
User | User-level messages. |
UUCP | UUCP subsystem. |
The lowest severity level message that will be forwarded.
string | Description |
---|---|
Alert | A condition that should be corrected immediately, such as a corrupted system database. |
All | A message of any severity. |
Critical | Hard device errors. |
Debug | Messages that contain information normally of use only when debugging a program. |
Emergency | A panic condition. |
Error | An Error. |
Informational | Informational only. |
Notice | Conditions that are not error conditions, but that may require special handling. |
Warning | A Warning. |
The protocol type of the event connection.
string | Description |
---|---|
OEM (v1.9+) | The destination follows an OEM protocol for event notifications. |
Redfish | The destination follows the Redfish Specification for event notifications. |
SMTP (v1.7+) | The destination follows the SMTP specification for event notifications. |
SNMPv1 (v1.7+) | The destination follows the SNMPv1 protocol for event notifications. |
SNMPv2c (v1.7+) | The destination follows the SNMPv2c protocol for event notifications. |
SNMPv3 (v1.7+) | The destination follows the SNMPv3 protocol for event notifications. |
SyslogRELP (v1.9+) | The destination follows syslog RELP for event notifications. |
SyslogTCP (v1.9+) | The destination follows syslog TCP-based for event notifications. |
SyslogTLS (v1.9+) | The destination follows syslog TLS-based for event notifications. |
SyslogUDP (v1.9+) | The destination follows syslog UDP-based for event notifications. |
The subscription type for events.
string | Description |
---|---|
OEM (v1.9+) | The subscription is an OEM subscription. |
RedfishEvent | The subscription follows the Redfish Specification for event notifications. To send an event notification, a service sends an HTTP POST to the subscriber's destination URI. |
SNMPInform (v1.7+) | The subscription follows versions 2 and 3 of SNMP Inform for event notifications. |
SNMPTrap (v1.7+) | The subscription follows the various versions of SNMP Traps for event notifications. |
SSE | The subscription follows the HTML5 Server-Sent Event definition for event notifications. |
Syslog (v1.9+) | The subscription sends Syslog messages for event notifications. |
{ "@odata.type": "#EventDestination.v1_10_0.EventDestination", "Id": "1", "Name": "EventSubscription 1", "Destination": "http://www.dnsname.com/Destination1", "SubscriptionType": "RedfishEvent", "DeliveryRetryPolicy": "TerminateAfterRetries", "Status": { "State": "Enabled" }, "Actions": { "#EventDestination.ResumeSubscription": { "target": "/redfish/v1/EventService/Subscriptions/1/Actions/EventDestination.ResumeSubscription" } }, "EventTypes": [ "Alert" ], "Context": "WebUser3", "Protocol": "Redfish", "@odata.id": "/redfish/v1/EventService/Subscriptions/1" }
v1.7 | v1.6 | v1.5 | v1.4 | v1.3 | v1.2 | v1.1 | v1.0 |
2020.2 | 2020.1 | 2019.3 | 2019.2 | 2019.1 | 2018.2 | 2018.1 | 1.0 |
The EventService schema contains properties for managing event subscriptions and generates the events sent to subscribers. The resource has links to the actual collection of subscriptions, which are called event destinations.
integer | The number of times that the POST of an event is retried before the subscription terminates. This retry occurs at the service level, which means that the HTTP POST to the event destination fails with an HTTP 4XX or 5XX status code or an HTTP timeout occurs this many times before the event destination subscription terminates. | ||
integer (seconds) | The interval, in seconds, between retry attempts for sending any event. | ||
array (string (enum)) | The content types of the message that this service can send to the event destination. For the possible property values, see EventFormatTypes in Property details. | ||
array (string (enum)) | The types of events to which a client can subscribe. For the possible property values, see EventTypesForSubscription in Property details. Deprecated in v1.3 and later. This property has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property. | ||
boolean | An indication of whether the service supports including the resource payload of the origin of condition in the event payload. | ||
array (string, null) | The list of the prefixes of the message registries that can be used for the RegistryPrefix property on a subscription. If this property is absent or contains an empty array, the service does not support RegistryPrefix-based subscriptions. | ||
array (string, null) | The list of @odata.type values, or schema names, that can be specified in the ResourceTypes array in a subscription. If this property is absent or contains an empty array, the service does not support resource type-based subscriptions. | ||
string (URI) | The link to a URI for receiving Server-Sent Event representations for the events that this service generates. | ||
boolean | An indication of whether this service is enabled. | ||
object | Settings for SMTP event delivery. | ||
| string (enum) | The authentication method for the SMTP server. For the possible property values, see Authentication in Property details. | |
| string (enum) | The connection type to the outgoing SMTP server. For the possible property values, see ConnectionProtocol in Property details. | |
| string | The 'from' email address of the outgoing email. | |
| string | The password for authentication with the SMTP server. The value is null in responses. | |
| integer | The destination SMTP port. | |
| string | The address of the SMTP server. | |
| boolean | An indication if SMTP for event delivery is enabled. | |
} | string | The username for authentication with the SMTP server. | |
object | The set of properties that are supported in the $filter query parameter for the ServerSentEventUri. | ||
| boolean | An indication of whether the service supports filtering by the EventFormatType property. | |
| boolean | An indication of whether the service supports filtering by the EventType property. Deprecated in v1.3 and later. This property has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property. | |
| boolean | An indication of whether the service supports filtering by the MessageId property. | |
| boolean | An indication of whether the service supports filtering by the MetricReportDefinition property. | |
| boolean | An indication of whether the service supports filtering by the OriginResource property. | |
| boolean | An indication of whether the service supports filtering by the RegistryPrefix property. | |
| boolean | An indication of whether the service supports filtering by the ResourceType property. | |
} | boolean | An indication of whether the service supports filtering by the SubordinateResources property. | |
object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. | ||
boolean | An indication of whether the service supports the SubordinateResources property on both event subscriptions and generated events. | ||
object | The link to a collection of event destinations. Contains a link to a resource. | ||
} | string | Link to Collection of EventDestination. See the EventDestination schema for details. |
This action generates a test event.
Action URI: {Base URI of target resource}/Actions/EventService.SubmitTestEventPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| integer | optional | The group identifier for the event. |
| string | optional | The ID for the event to add. |
| string (date-time) | optional | The date and time for the event to add. |
| string (enum) | optional | The type for the event to add. For the possible property values, see EventType in Property details. Deprecated in v1.3 and later. This parameter has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property. |
| string | optional | The human-readable message for the event to add. |
| array (string) | optional | An array of message arguments for the event to add. |
| string | | The MessageId for the event to add. |
| string (URI) | optional | The URL in the OriginOfCondition property of the event to add. It is not a reference object. |
} | string | optional | The severity for the event to add. |
The authentication method for the SMTP server.
string | Description |
---|---|
AutoDetect | Auto-detect. |
CRAM_MD5 | CRAM-MD5 authentication. |
Login (deprecated v1.7) | LOGIN authentication. This value has been deprecated in favor of `Plain`, which supersedes the LOGIN authentication method for SASL. |
None | No authentication. |
Plain | PLAIN authentication. |
The connection type to the outgoing SMTP server.
string | Description |
---|---|
AutoDetect | Auto-detect. |
None | Clear text. |
StartTLS | StartTLS. |
TLS_SSL | TLS/SSL. |
The content types of the message that this service can send to the event destination.
string | Description |
---|---|
Event | The subscription destination receives an event payload. |
MetricReport | The subscription destination receives a metric report. |
The type for the event to add.
string | Description |
---|---|
Alert | A condition requires attention. |
MetricReport | The telemetry service is sending a metric report. |
Other | Because EventType is deprecated as of Redfish Specification v1.6, the event is based on a registry or resource but not an EventType. |
ResourceAdded | A resource has been added. |
ResourceRemoved | A resource has been removed. |
ResourceUpdated | A resource has been updated. |
StatusChange | The status of a resource has changed. |
The types of events to which a client can subscribe.
string | Description |
---|---|
Alert | A condition requires attention. |
MetricReport | The telemetry service is sending a metric report. |
Other | Because EventType is deprecated as of Redfish Specification v1.6, the event is based on a registry or resource but not an EventType. |
ResourceAdded | A resource has been added. |
ResourceRemoved | A resource has been removed. |
ResourceUpdated | A resource has been updated. |
StatusChange | The status of a resource has changed. |
{ "@odata.type": "#EventService.v1_7_1.EventService", "Id": "EventService", "Name": "Event Service", "Status": { "State": "Enabled", "Health": "OK" }, "ServiceEnabled": true, "DeliveryRetryAttempts": 3, "DeliveryRetryIntervalSeconds": 60, "EventTypesForSubscription": [ "StatusChange", "ResourceUpdated", "ResourceAdded", "ResourceRemoved", "Alert" ], "ServerSentEventUri": "/redfish/v1/EventService/SSE", "SSEFilterPropertiesSupported": { "EventType": true, "MetricReportDefinition": false, "RegistryPrefix": true, "ResourceType": true, "EventFormatType": false, "MessageId": true, "OriginResource": true, "SubordinateResources": true }, "Subscriptions": { "@odata.id": "/redfish/v1/EventService/Subscriptions" }, "Actions": { "#EventService.SubmitTestEvent": { "target": "/redfish/v1/EventService/Actions/EventService.SubmitTestEvent", "@Redfish.ActionInfo": "/redfish/v1/EventService/SubmitTestEventActionInfo" }, "Oem": {} }, "Oem": {}, "@odata.id": "/redfish/v1/EventService" }
v1.2 | v1.1 | v1.0 |
2020.4 | 2018.3 | 2018.1 |
The ExternalAccountProvider schema represents a remote service that provides accounts for this manager to use for authentication.
string (enum) | The type of external account provider to which this service connects. For the possible property values, see AccountProviderType in Property details. | ||
object | The authentication information for the external account provider. | ||
| string (enum) | The type of authentication used to connect to the external account provider. For the possible property values, see AuthenticationType in Property details. | |
| string | Specifies the encryption key. | |
| boolean | Indicates if the EncryptionKey property is set. | |
| string | The Base64-encoded version of the Kerberos keytab for this service. A PATCH or PUT operation writes the keytab. This property is null in responses. | |
| object | See the Oem object definition in the Common properties section. | |
| string | The password for this service. A PATCH or PUT request writes the password. This property is null in responses. | |
| string | The token for this service. A PATCH or PUT operation writes the token. This property is null in responses. | |
} | string | The user name for the service. | |
object | The link to a collection of certificates that the external account provider uses. Contains a link to a resource. | ||
} | string | Link to Collection of Certificate. See the Certificate schema for details. | |
object | The additional mapping information needed to parse a generic LDAP service. | ||
| object | See the Oem object definition in the Common properties section. | |
| object | The required settings to search an external LDAP service. | |
| array (string, null) | The base distinguished names to use to search an external LDAP service. | |
| string | The attribute name that contains the LDAP group name entry. | |
| string | The attribute name that contains the groups for a user on the LDAP user entry. | |
} } | string | The attribute name that contains the LDAP user name entry. | |
object | The links to other resources that are related to this resource. | ||
} | object | See the Oem object definition in the Common properties section. | |
integer | The authentication priority for the external account provider. | ||
array | The mapping rules to convert the external account providers account information to the local Redfish role. | ||
| string | The name of the local Redfish role to which to map the remote user or group. | |
| object | See the Oem object definition in the Common properties section. | |
| string | The name of the remote group, or the remote role in the case of a Redfish service, that maps to the local Redfish role to which this entity links. | |
} ] | string | The name of the remote user that maps to the local Redfish role to which this entity links. | |
array (string, null) | The addresses of the user account providers to which this external account provider links. The format of this field depends on the type of external account provider. | ||
boolean | An indication of whether this service is enabled. | ||
object | (null) | The additional information needed to parse a TACACS+ services. | |
| array (string (enum)) | Indicates the allowed TACACS+ password exchange protocols. For the possible property values, see PasswordExchangeProtocols in Property details. | |
} | string | Indicates the name of the TACACS+ argument name in an authorization request. |
The type of external account provider to which this service connects.
string | Description |
---|---|
ActiveDirectoryService | An external Active Directory service. |
LDAPService | A generic external LDAP service. |
OEM | An OEM-specific external authentication or directory service. |
RedfishService | An external Redfish service. |
The type of authentication used to connect to the external account provider.
string | Description |
---|---|
KerberosKeytab | A Kerberos keytab. |
OEM | An OEM-specific authentication mechanism. |
Token | An opaque authentication token. |
UsernameAndPassword | A user name and password combination. |
Indicates the allowed TACACS+ password exchange protocols.
string | Description |
---|---|
ASCII | The ASCII Login method. |
CHAP | The CHAP Login method. |
MSCHAPv1 | The MS-CHAP v1 Login method. |
MSCHAPv2 | The MS-CHAP v2 Login method. |
PAP | The PAP Login method. |
{ "@odata.type": "#ExternalAccountProvider.v1_2_0.ExternalAccountProvider", "Id": "ExternalRedfishService", "Name": "Remote Redfish Service", "Description": "Remote Redfish Service providing additional Accounts to this Redfish Service", "AccountProviderType": "RedfishService", "ServiceAddresses": [ "http://redfish.dmtf.org/redfish/v1/AccountService" ], "Authentication": { "AuthenticationType": "Token", "Token": null }, "RemoteRoleMapping": [ { "RemoteGroup": "Admin", "LocalRole": "Administrator" }, { "RemoteGroup": "Operator", "LocalRole": "Operator" }, { "RemoteGroup": "ReadOnly", "LocalRole": "ReadOnly" } ], "@odata.id": "/redfish/v1/AccountService/ExternalAccountProviders/ExternalRedfishService" }
v1.2 | v1.1 | v1.0 |
2020.3 | 2019.4 | 2016.2 |
The Fabric schema represents a simple fabric consisting of one or more switches, zero or more endpoints, and zero or more zones.
object | The collection of links to the address pools that this fabric contains. Contains a link to a resource. | ||
} | string | Link to Collection of AddressPool. See the AddressPool schema for details. | |
object | The collection of links to the connections that this fabric contains. Contains a link to a resource. | ||
} | string | Link to Collection of Connection. See the Connection schema for details. | |
object | The collection of links to the endpoint groups that this fabric contains. Contains a link to a resource. | ||
} | string | Link to Collection of EndpointGroup. See the EndpointGroup schema for details. | |
object | The collection of links to the endpoints that this fabric contains. Contains a link to a resource. | ||
} | string | Link to Collection of Endpoint. See the Endpoint schema for details. | |
string (enum) | The protocol being sent over this fabric. For the possible property values, see FabricType in Property details. | ||
object | The links to other resources that are related to this resource. | ||
} | object | See the Oem object definition in the Common properties section. | |
integer | The maximum number of zones the switch can currently configure. | ||
object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. | ||
object | The collection of links to the switches that this fabric contains. Contains a link to a resource. | ||
} | string | Link to Collection of Switch. See the Switch schema for details. | |
object | The collection of links to the zones that this fabric contains. Contains a link to a resource. | ||
} | string | Link to Collection of Zone. See the Zone schema for details. |
The protocol being sent over this fabric.
string | Description |
---|---|
AHCI | Advanced Host Controller Interface (AHCI). |
Ethernet | Ethernet. |
FC | Fibre Channel. |
FCoE | Fibre Channel over Ethernet (FCoE). |
FCP | Fibre Channel Protocol for SCSI. |
FICON | FIbre CONnection (FICON). |
FTP | File Transfer Protocol (FTP). |
GenZ | GenZ. |
HTTP | Hypertext Transport Protocol (HTTP). |
HTTPS | Hypertext Transfer Protocol Secure (HTTPS). |
I2C | Inter-Integrated Circuit Bus. |
InfiniBand | InfiniBand. |
iSCSI | Internet SCSI. |
iWARP | Internet Wide Area RDMA Protocol (iWARP). |
MultiProtocol | Multiple Protocols. |
NFSv3 | Network File System (NFS) version 3. |
NFSv4 | Network File System (NFS) version 4. |
NVMe | Non-Volatile Memory Express (NVMe). |
NVMeOverFabrics | NVMe over Fabrics. |
OEM | OEM-specific. |
PCIe | PCI Express. |
RoCE | RDMA over Converged Ethernet Protocol. |
RoCEv2 | RDMA over Converged Ethernet Protocol Version 2. |
SAS | Serial Attached SCSI. |
SATA | Serial AT Attachment. |
SFTP | SSH File Transfer Protocol (SFTP). |
SMB | Server Message Block (SMB). Also known as the Common Internet File System (CIFS). |
TCP | Transmission Control Protocol (TCP). |
TFTP | Trivial File Transfer Protocol (TFTP). |
UDP | User Datagram Protocol (UDP). |
UHCI | Universal Host Controller Interface (UHCI). |
USB | Universal Serial Bus (USB). |
{ "@odata.type": "#Fabric.v1_2_1.Fabric", "Id": "SAS", "Name": "SAS Fabric", "FabricType": "SAS", "Description": "A SAS Fabric with redundant switches connected to two initiators", "Status": { "State": "Enabled", "Health": "OK" }, "Zones": { "@odata.id": "/redfish/v1/Fabrics/SAS/Zones" }, "Endpoints": { "@odata.id": "/redfish/v1/Fabrics/SAS/Endpoints" }, "Switches": { "@odata.id": "/redfish/v1/Fabrics/SAS/Switches" }, "Links": { "Oem": {} }, "Actions": { "Oem": {} }, "Oem": {}, "@odata.id": "/redfish/v1/Fabrics/SAS" }
v1.0 |
2019.4 |
A FabricAdapter represents the physical fabric adapter capable of connecting to an interconnect fabric. Examples include but are not limited to Ethernet, NVMe over Fabrics, Gen-Z, and SAS fabric adapters.
string | The manufacturer name for the ASIC of this fabric adapter. | ||
string | The part number for the ASIC on this fabric adapter. | ||
string | The revision identifier for the ASIC on this fabric adapter. | ||
string | The firmware version of this fabric adapter. | ||
object | The Gen-Z specific properties for this fabric adapter. | ||
| object | The Multi Subnet Destination Table for the component. Contains a link to a resource. | |
} | string | Link to Collection of RouteEntry. See the RouteEntry schema for details. | |
| array (string, null) | An array of table entry values for the Packet Injection Delay Table. | |
| object | The Requestor Virtual Channel Action Table for the component. Contains a link to a resource. | |
} | string | Link to Collection of VCATEntry. See the VCATEntry schema for details. | |
| object | The Responder Virtual Channel Action Table for the component. Contains a link to a resource. | |
} | string | Link to Collection of VCATEntry. See the VCATEntry schema for details. | |
| array (string, null) | An array of table entry values for the Responder Interface Table. | |
| object | The Single Subnet Destination Table for the component. Contains a link to a resource. | |
} } | string | Link to Collection of RouteEntry. See the RouteEntry schema for details. | |
object | The links to other Resources that are related to this Resource. | ||
| array | An array of links to the endpoints that represent the logical fabric connection to this fabric adapter. | |
} ] | string | Link to a Endpoint resource. See the Links section and the Endpoint schema for details. | |
} | object | See the Oem object definition in the Common properties section. | |
string | The manufacturer or OEM of this fabric adapter. | ||
string | The model string for this fabric adapter. | ||
string | The part number for this fabric adapter. | ||
object | The PCIe interface details for this fabric adapter. | ||
| integer | The number of PCIe lanes in use by this device. | |
| integer | The number of PCIe lanes supported by this device. | |
| string (enum) | The highest version of the PCIe specification supported by this device. For the possible property values, see MaxPCIeType in Property details. | |
| object | See the Oem object definition in the Common properties section. | |
} | string (enum) | The version of the PCIe specification in use by this device. For the possible property values, see PCIeType in Property details. | |
object | The link to the collection of ports that exist on the fabric adapter. Contains a link to a resource. | ||
} | string | Link to Collection of Port. See the Port schema for details. | |
string | The serial number for this fabric adapter. | ||
string | The manufacturer SKU for this fabric adapter. | ||
string | The spare part number for this fabric adapter. | ||
object | The status and health of the Resource and its subordinate or dependent Resources. For property details, see Status. | ||
string | The UUID for this fabric adapter. |
The highest version of the PCIe specification supported by this device.
string | Description |
---|---|
Gen1 | A PCIe v1.0 slot. |
Gen2 | A PCIe v2.0 slot. |
Gen3 | A PCIe v3.0 slot. |
Gen4 | A PCIe v4.0 slot. |
Gen5 | A PCIe v5.0 slot. |
The version of the PCIe specification in use by this device.
string | Description |
---|---|
Gen1 | A PCIe v1.0 slot. |
Gen2 | A PCIe v2.0 slot. |
Gen3 | A PCIe v3.0 slot. |
Gen4 | A PCIe v4.0 slot. |
Gen5 | A PCIe v5.0 slot. |
{ "@odata.type": "#FabricAdapter.v1_0_0.FabricAdapter", "Id": "Bridge", "Name": "Gen-Z Bridge", "Manufacturer": "Contoso", "Model": "Gen-Z Bridge Model X", "PartNumber": "975999-001", "SparePartNumber": "152111-A01", "SKU": "Contoso 2-port Gen-Z Bridge", "SerialNumber": "2M220100SL", "ASICRevisionIdentifier": "A0", "ASICPartNumber": "53312", "ASICManufacturer": "Contoso", "FirmwareVersion": "7.4.10", "Status": { "State": "Enabled", "Health": "OK" }, "Ports": { "@odata.id": "/redfish/v1/Systems/GenZ-example/FabricAdapters/1/Ports" }, "PCIeInterface": { "MaxPCIeType": "Gen4", "MaxLanes": 64, "PCIeType": "Gen4", "LanesInUse": 64 }, "UUID": "45724775-ed3b-2214-1313-9865200c1cc1", "Links": { "Endpoints": [ { "@odata.id": "/redfish/v1/Fabrics/GenZ/Endpoints/3" } ] }, "GenZ": { "SSDT": { "@odata.id": "/redfish/v1/Systems/GenZ-example/FabricAdapters/1/SSDT" }, "MSDT": { "@odata.id": "/redfish/v1/Systems/GenZ-example/FabricAdapters/1/MSDT" }, "RequestorVCAT": { "@odata.id": "/redfish/v1/Systems/GenZ-example/FabricAdapters/1/REQ-VCAT" }, "ResponderVCAT": { "@odata.id": "/redfish/v1/Systems/GenZ-example/FabricAdapters/1/RSP-VCAT" }, "RITable": [ "0x12", "0x3E", "0x12", "0x3E", "0x12", "0x3E", "0x12", "0x3E", "0x12", "0x3E", "0x12", "0x3E", "0x12", "0x3E", "0x12", "0x3E" ], "PIDT": [ "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568", "0x12234568" ] }, "Oem": {}, "@odata.id": "/redfish/v1/Systems/GenZ-example/FabricAdapters/1" }
v1.1 | v1.0 |
2020.4 | 2019.4 |
The Facility schema represents the physical location containing equipment, such as a room, building, or campus.
object | The link to the ambient environment metrics for this facility. See the EnvironmentMetrics schema for details on this property. | ||
} | string | Link to a EnvironmentMetrics resource. See the Links section and the EnvironmentMetrics schema for details. | |
object | The link to the environment metrics for this facility. See the EnvironmentMetrics schema for details on this property. | ||
} | string | Link to a EnvironmentMetrics resource. See the Links section and the EnvironmentMetrics schema for details. | |
string (enum) | The type of location this resource represents. For the possible property values, see FacilityType in Property details. | ||
object | The links to other resources that are related to this resource. | ||
| object | The link to the facility that contains this facility. | |
} | string | Link to another Facility resource. | |
| array | An array of links to outermost chassis contained within this facility. | |
} ] | string | Link to a Chassis resource. See the Links section and the Chassis schema for details. | |
| array | An array of links to other facilities contained within this facility. | |
} ] | string | Link to another Facility resource. | |
| array | An array of links to the floor power distribution units in this facility. | |
} ] | string | Link to a PowerDistribution resource. See the Links section and the PowerDistribution schema for details. | |
| array | An array of links to the managers responsible for managing this facility. | |
} ] | string | Link to a Manager resource. See the Links section and the Manager schema for details. | |
| object | See the Oem object definition in the Common properties section. | |
| array | An array of links to the rack-level power distribution units in this facility. | |
} ] | string | Link to a PowerDistribution resource. See the Links section and the PowerDistribution schema for details. | |
| array | An array of links to the switchgear in this facility. | |
} ] | string | Link to a PowerDistribution resource. See the Links section and the PowerDistribution schema for details. | |
| array | An array of links to the transfer switches in this facility. | |
} ] } | string | Link to a PowerDistribution resource. See the Links section and the PowerDistribution schema for details. | |
object | The location of the facility. For property details, see Location. | ||
object | Link to the power domains in this facility. Contains a link to a resource. | ||
} | string | Link to Collection of PowerDomain. See the PowerDomain schema for details. | |
object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. |
The type of location this resource represents.
string | Description |
---|---|
Building | A structure with a roof and walls. |
Floor | A floor inside of a building. |
Room | A room inside of a building or floor. |
Site | A small area consisting of several buildings. |
{ "@odata.type": "#Facility.v1_1_0.Facility", "Id": "Room237", "Name": "Room #237, 2nd Floor", "FacilityType": "Room", "Status": { "State": "Enabled", "Health": "OK" }, "Location": { "PostalAddress": { "Country": "US", "Territory": "OR", "City": "Portland", "Street": "1001 SW 5th Avenue", "HouseNumber": 1100, "Name": "DMTF, Inc.", "PostalCode": "97204", "Floor": "2", "Room": "237" } }, "PowerDomains": { "@odata.id": "/redfish/v1/Facilities/Room237/PowerDomains" }, "Links": { "ContainedByFacility": { "@odata.id": "/redfish/v1/Facilities/Building" }, "RackPDUs": [ { "@odata.id": "/redfish/v1/PowerEquipment/RackPDUs/1" } ] }, "@odata.id": "/redfish/v1/Facilities/Room237" }
v1.0 |
2020.4 |
The Fan schema describes a cooling fan unit for a computer system or similar devices contained within a chassis.
object | The link to the assembly associated with this fan. See the Assembly schema for details on this property. | ||
} | string | Link to a Assembly resource. See the Links section and the Assembly schema for details. | |
boolean | An indication of whether this device can be inserted or removed while the equipment is in operation. | ||
object | The location of the fan. For property details, see Location. | ||
boolean | An indicator allowing an operator to physically locate this resource. | ||
string | The manufacturer of this fan. | ||
string | The model number for this fan. | ||
string | The part number for this fan. | ||
string (enum) | The area or device associated with this fan. For the possible property values, see PhysicalContext in Property details. | ||
string | The serial number for this fan. | ||
string | The spare part number for this fan. | ||
object (excerpt) | The fan speed reading. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri. | ||
| string (URI) | The link to the resource that provides the data for this sensor. | |
| number | The sensor value. | |
} | number (RPM) | The rotational speed. | |
object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. |
The area or device associated with this fan.
string | Description |
---|---|
Accelerator | An accelerator. |
ACInput | An AC input. |
ACMaintenanceBypassInput | An AC maintenance bypass input. |
ACOutput | An AC output. |
ACStaticBypassInput | An AC static bypass input. |
ACUtilityInput | An AC utility input. |
ASIC | An ASIC device, such as a networking chip or chipset component. |
Back | The back of the chassis. |
Backplane | A backplane within the chassis. |
Chassis | The entire chassis. |
ComputeBay | Within a compute bay. |
CoolingSubsystem | The entire cooling, or air and liquid, subsystem. |
CPU | A processor (CPU). |
CPUSubsystem | The entire processor (CPU) subsystem. |
DCBus | A DC bus. |
Exhaust | The air exhaust point or points or region of the chassis. |
ExpansionBay | Within an expansion bay. |
Fan | A fan. |
FPGA | An FPGA. |
Front | The front of the chassis. |
GPU | A graphics processor (GPU). |
GPUSubsystem | The entire graphics processor (GPU) subsystem. |
Intake | The air intake point or points or region of the chassis. |
LiquidInlet | The liquid inlet point of the chassis. |
LiquidOutlet | The liquid outlet point of the chassis. |
Lower | The lower portion of the chassis. |
Memory | A memory device. |
MemorySubsystem | The entire memory subsystem. |
Motor | A motor. |
NetworkBay | Within a networking bay. |
NetworkingDevice | A networking device. |
PowerSubsystem | The entire power subsystem. |
PowerSupply | A power supply. |
PowerSupplyBay | Within a power supply bay. |
Rectifier | A rectifier device. |
Room | The room. |
StorageBay | Within a storage bay. |
StorageDevice | A storage device. |
SystemBoard | The system board (PCB). |
Transformer | A transformer. |
TrustedModule | A trusted module. |
Upper | The upper portion of the chassis. |
VoltageRegulator | A voltage regulator device. |
{ "@odata.type": "#Fan.v1_0_0.Fan", "Id": "Bay1", "Name": "Fan Bay 1", "Status": { "State": "Enabled", "Health": "OK" }, "PhysicalContext": "Chassis", "Model": "RKS-440DC", "Manufacturer": "Contoso Fans", "PartNumber": "23456-133", "SparePartNumber": "93284-133", "LocationIndicatorActive": true, "HotPluggable": true, "SpeedPercent": { "Reading": 45, "SpeedRPM": 2200, "DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/FanBay1" }, "Location": { "PartLocation": { "ServiceLabel": "Chassis Fan Bay 1", "LocationType": "Bay", "LocationOrdinalValue": 0 } }, "@odata.id": "/redfish/v1/Chassis/1U/ThermalSubsystem/Fans/Bay1" }
v1.3 | v1.2 | v1.1 | v1.0 |
2020.3 | 2018.2 | 2017.1 | 2016.3 |
The properties associated with a Host Interface. A Host Interface is a connection between host software and a Redfish Service.
array (string (enum)) | The authentication modes available on this interface. For the possible property values, see AuthenticationModes in Property details. | ||
string | The role when no authentication on this interface is used. | ||
object | The credential bootstrapping settings for this interface. | ||
| boolean | An indication of whether credential bootstrapping is enabled after a reset for this interface. | |
| boolean | An indication of whether credential bootstrapping is enabled for this interface. | |
} | string | The role used for the bootstrap account created for this interface. | |
boolean | An indication of whether external entities can access this interface. External entities are non-host entities. For example, if the host and manager are connected through a switch and the switch also exposes an external port on the system, external clients can also use the interface, and this property value is true . | ||
boolean | An indication of whether this firmware authentication is enabled for this interface. Deprecated in v1.3 and later. This property has been deprecated in favor of newer methods of negotiating credentials. | ||
string | The Role used for firmware authentication on this interface. Deprecated in v1.3 and later. This property has been deprecated in favor of newer methods of negotiating credentials. | ||
object | A link to the collection of network interface controllers or cards (NICs) that a computer system uses to communicate with this Host Interface. Contains a link to a resource. | ||
} | string | Link to Collection of EthernetInterface. See the EthernetInterface schema for details. | |
string (enum) | The Host Interface type for this interface. For the possible property values, see HostInterfaceType in Property details. | ||
boolean | An indication of whether this interface is enabled. | ||
boolean | An indication of whether this kernel authentication is enabled for this interface. Deprecated in v1.3 and later. This property has been deprecated in favor of newer methods of negotiating credentials. | ||
string | The Role used for kernel authentication on this interface. Deprecated in v1.3 and later. This property has been deprecated in favor of newer methods of negotiating credentials. | ||
object | The links to other Resources that are related to this Resource. | ||
| object | The link to the Redfish Role that contains the privileges on this Host Interface when no authentication is performed. See the Role schema for details on this property. | |
} | string | Link to a Role resource. See the Links section and the Role schema for details. | |
| array | An array of links to the computer systems connected to this Host Interface. | |
} ] | string | Link to a ComputerSystem resource. See the Links section and the ComputerSystem schema for details. | |
| object | The link to the role that contains the privileges for the bootstrap account created for this interface. See the Role schema for details on this property. | |
} | string | Link to a Role resource. See the Links section and the Role schema for details. | |
| object | The link to the Redfish Role that has firmware authentication privileges on this Host Interface. See the Role schema for details on this property. Deprecated in v1.3 and later. This property has been deprecated in favor of newer methods of negotiating credentials. | |
} | string | Link to a Role resource. See the Links section and the Role schema for details. | |
| object | The link to the Redfish Role defining privileges for this Host Interface when using kernel authentication. See the Role schema for details on this property. Deprecated in v1.3 and later. This property has been deprecated in favor of newer methods of negotiating credentials. | |
} | string | Link to a Role resource. See the Links section and the Role schema for details. | |
} | object | See the Oem object definition in the Common properties section. | |
object | A link to a single network interface controllers or cards (NIC) that this manager uses for network communication with this Host Interface. See the EthernetInterface schema for details on this property. | ||
} | string | Link to a EthernetInterface resource. See the Links section and the EthernetInterface schema for details. | |
object | A link to the network services and their settings that the manager controls. In this property, clients find configuration options for the network and network services. See the ManagerNetworkProtocol schema for details on this property. | ||
} | string | Link to a ManagerNetworkProtocol resource. See the Links section and the ManagerNetworkProtocol schema for details. | |
object | The status and health of the Resource and its subordinate or dependent Resources. For property details, see Status. |
The authentication modes available on this interface.
string | Description |
---|---|
AuthNone | Requests without any sort of authentication are allowed. |
BasicAuth | Requests using HTTP Basic Authentication are allowed. |
OemAuth | Requests using OEM authentication mechanisms are allowed. |
RedfishSessionAuth | Requests using Redfish Session Authentication are allowed. |
The Host Interface type for this interface.
string | Description |
---|---|
NetworkHostInterface | This interface is a Network Host Interface. |
{ "@odata.type": "#HostInterface.v1_3_0.HostInterface", "Id": "1", "Name": "Host Interface", "Description": "Management Host Interface", "HostInterfaceType": "NetworkHostInterface", "Status": { "State": "Enabled", "Health": "OK" }, "InterfaceEnabled": true, "ExternallyAccessible": false, "AuthenticationModes": [ "AuthNone", "BasicAuth", "RedfishSessionAuth", "OemAuth" ], "KernelAuthRoleId": "Administrator", "KernelAuthEnabled": true, "FirmwareAuthRoleId": "Administrator", "FirmwareAuthEnabled": true, "HostEthernetInterfaces": { "@odata.id": "/redfish/v1/Managers/BMC/HostInterfaces/1/HostEthernetInterfaces" }, "ManagerEthernetInterface": { "@odata.id": "/redfish/v1/Managers/BMC/EthernetInterfaces/ToHost" }, "NetworkProtocol": { "@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol" }, "Links": { "ComputerSystems": [ { "@odata.id": "/redfish/v1/Systems/ORD144" } ], "KernelAuthRole": { "@odata.id": "/redfish/v1/AccountService/Roles/Administrator" }, "FirmwareAuthRole": { "@odata.id": "/redfish/v1/AccountService/Roles/Administrator" } }, "Oem": {}, "@odata.id": "/redfish/v1/Managers/BMC/HostInterfaces/1" }
v1.0 |
2018.2 |
The Job schema contains information about a job that a Redfish job service schedules or executes. Clients create jobs to describe a series of operations that occur at periodic intervals.
string | The person or program that created this job entry. | ||
string (date-time) | The date and time when the job was completed. | ||
boolean | An indication of whether the contents of the payload should be hidden from view after the job has been created. If true , responses do not return the payload. If false , responses return the payload. If this property is not present when the job is created, the default is false . | ||
string (enum) | The state of the job. For the possible property values, see JobState in Property details. | ||
string (enum) | The status of the job. For the possible property values, see JobStatus in Property details. | ||
string | The maximum amount of time the job is allowed to execute. | ||
array (object) | An array of messages associated with the job. The message that the Redfish service returns. For property details, see Message. | ||
object | The HTTP and JSON payload details for this job. | ||
| array (string) | An array of HTTP headers in this job. | |
| string | The HTTP operation that executes this job. | |
| string | The JSON payload to use in the execution of this job. | |
} | string (URI) | The link to the target for this job. | |
integer (%) | The completion percentage of this job. | ||
object | The schedule settings for this job. For property details, see Schedule. | ||
string (date-time) | The date and time when the job was started or is scheduled to start. | ||
array (string) | The serialized execution order of the job steps. | ||
object | The link to a collection of steps for this job. Contains a link to a resource. | ||
} | string | Link to Collection of Job. See the Job schema for details. |
The state of the job.
string | Description |
---|---|
Cancelled | Job was canceled. |
Completed | Job was completed. |
Continue | Job is to resume operation. |
Exception | Job has stopped due to an exception condition. |
Interrupted | Job has been interrupted. |
New | A new job. |
Pending | Job is pending and has not started. |
Running | Job is running normally. |
Service | Job is running as a service. |
Starting | Job is starting. |
Stopping | Job is in the process of stopping. |
Suspended | Job has been suspended. |
UserIntervention | Job is waiting for user intervention. |
The status of the job.
string | Description |
---|---|
Critical | A critical condition requires immediate attention. |
OK | Normal. |
Warning | A condition requires attention. |
{ "@odata.type": "#Job.v1_0_6.Job", "Id": "RebootRack", "Name": "Scheduled Nightly Reboot of the rack", "JobStatus": "OK", "JobState": "Running", "StartTime": "2018-04-01T00:01+6:00", "PercentComplete": 24, "Schedule": { "Lifetime": "P4Y", "InitialStartTime": "2018-01-01T01:00:00+06:00", "RecurrenceInterval": "P1D", "EnabledDaysOfWeek": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ] }, "Steps": { "@odata.id": "/redfish/v1/JobService/Jobs/RebootRack/Steps" }, "StepOrder": [ "Red", "Orange", "Yellow", "Green", "Blue", "Indigo", "Violet" ], "@odata.id": "/redfish/v1/JobService/Jobs/RebootRack" }
v1.0 |
2018.2 |
The JobService schema contains properties for scheduling and execution of operations, represents the properties for the job service itself, and has links to jobs managed by the job service.
string (date-time) | The current date and time setting for the job service. | ||
object | The links to the jobs collection. Contains a link to a resource. | ||
} | string | Link to Collection of Job. See the Job schema for details. | |
object | The link to a log service that the job service uses. This service can be a dedicated log service or a pointer a log service under another resource, such as a manager. See the LogService schema for details on this property. | ||
} | string | Link to a LogService resource. See the Links section and the LogService schema for details. | |
object | The supported capabilities of this job service implementation. | ||
| integer | The maximum number of jobs supported. | |
| integer | The maximum number of job steps supported. | |
} | boolean | An indication of whether scheduling of jobs is supported. | |
boolean | An indication of whether this service is enabled. | ||
object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. |
{ "@odata.type": "#JobService.v1_0_4.JobService", "Id": "JobService", "Name": "Job Service", "DateTime": "2018-06-13T04:14+06:00", "Status": { "State": "Enabled", "Health": "OK" }, "ServiceEnabled": true, "ServiceCapabilities": { "MaxJobs": 100, "MaxSteps": 50, "Scheduling": true }, "Jobs": { "@odata.id": "/redfish/v1/JobService/Jobs" }, "Log": { "@odata.id": "/redfish/v1/JobService/Log" }, "Actions": { "Oem": { "#Contoso.EasyButton": { "target": "/redfish/v1/JobService/Contoso.EasyButton", "@Redfish.ActionInfo": "/redfish/v1/JobService/EasyButtonActionInfo" } } }, "Oem": {}, "@odata.id": "/redfish/v1/JobService" }
v1.1 | v1.0 |
2017.1 | 1.0 |
The JsonSchemaFile schema contains the properties that describe the locations, as URIs, of a Redfish Schema definition that a Redfish Service implements or references.
array (string) | The RFC5646-conformant language codes for the available schemas. | ||
array | | Location information for this schema file. | |
| string | The name of the file in the archive, if the schema is hosted on the service in an archive file. | |
| string (URI) | The link to an archive file, if the schema is hosted on the service in an archive file. | |
| string | The language code for the schema file. | |
| string (URI) | The link to publicly available (canonical) URI for schema. | |
} ] | string (URI) | The link to locally available URI for schema. | |
string | The @odata.type name this schema describes. |
{ "@odata.type": "#JsonSchemaFile.v1_1_4.JsonSchemaFile", "Id": "Chassis.v1_11_0", "Name": "Chassis Schema File", "Description": "Chassis Schema File Location", "Languages": [ "en" ], "Schema": "#Chassis.v1_11_0.Chassis", "Oem": {}, "Location": [ { "Language": "en", "ArchiveUri": "/Schemas.gz", "PublicationUri": "http://redfish.dmtf.org/schemas/v1/Chassis.v1_11_0.json", "ArchiveFile": "Chassis.v1_11_0.json" }, { "Language": "zh", "ArchiveUri": "/Schemas.zh.gz", "PublicationUri": "http://schemas.contoso.com/Chassis.v1_11_0.zh.json", "ArchiveFile": "Chassis.v1_11_0.zh.json" }, { "Language": "xy", "Uri": "/redfish/v1/JsonSchemas/Chassis.v1_11_0.xy.json", "PublicationUri": "http://schemas.contoso.com/Chassis.v1_11_0.xy.json" } ], "@odata.id": "/redfish/v1/JsonSchemas/Chassis.v1_11_0" }
v1.8 | v1.7 | v1.6 | v1.5 | v1.4 | v1.3 | v1.2 | v1.1 | v1.0 |
2020.4 | 2020.3 | 2020.1 | 2019.3 | 2018.2 | 2017.3 | 2017.1 | 2016.2 | 1.0 |
The LogEntry schema defines the record format for a log. It is designed for Redfish event logs, OEM-specific log formats, and the IPMI System Event Log (SEL). The EntryType field indicates the type of log and the resource includes several additional properties dependent on the EntryType.
integer (bytes) | The size of the additional data for the log entry. | ||
string (URI) | The URI at which to access the additional data for the log entry, such as diagnostic data, image captures, or other files. | ||
string (date-time) | The date and time when the log entry was created. | ||
string (enum) | The type of diagnostic data. For the possible property values, see DiagnosticDataType in Property details. | ||
string (enum) | The entry code for the log entry if the entry type is SEL .For the possible property values, see EntryCode in Property details. | ||
string (enum) | The type of log entry. For the possible property values, see EntryType in Property details. | ||
integer | An identifier that correlates events with the same cause. | ||
string | The unique instance identifier for an event. | ||
string (date-time) | The date and time when the event occurred. | ||
string (enum) | The type of event recorded in this log. For the possible property values, see EventType in Property details. Deprecated in v1.4 and later. This property has been deprecated. Starting with Redfish Specification v1.6 (Event v1.3), subscriptions are based on the RegistryPrefix and ResourceType properties and not on the EventType property. | ||
string | An identifier of the device that has generated the IPMI SEL Event Record. | ||
object | The links to other resources that are related to this resource. | ||
| object | See the Oem object definition in the Common properties section. | |
| object | The link to the resource that caused the log entry. | |
} } | string (URI) | The unique identifier for a resource. | |
string | The message of the log entry. This property decodes from the entry type. If the entry type is Event , this property contains a message. If the entry type is SEL , this property contains an SEL-specific message. Otherwise, this property contains an OEM-specific log entry. In most cases, this property contains the actual log entry. | ||
array (string) | The arguments for the message. | ||
string | The MessageId, event data, or OEM-specific information. This property decodes from the entry type. If the entry type is Event , this property contains a Redfish Specification-defined MessageId. If the entry type is SEL , this property contains the Event Data. Otherwise, this property contains OEM-specific information. | ||
string (date-time) | The date and time when the log entry was last modified. | ||
string | The OEM-defined type of diagnostic data. | ||
string | The OEM-specific entry code, if the LogEntryCode type is OEM . | ||
string | The OEM-specific format of the entry. If the entry type is Oem , this property contains more information about the record format from the OEM. | ||
string | The OEM-specific sensor type if the sensor type is OEM . | ||
boolean | Indicates if the cause of the log entry has been resolved or repaired. | ||
integer | The IPMI-defined sensor number. | ||
string (enum) | The sensor type to which the log entry pertains if the entry type is SEL .For the possible property values, see SensorType in Property details. | ||
string (enum) | The severity of the log entry. For the possible property values, see Severity in Property details. |
The type of diagnostic data.
string | Description |
---|---|
Manager | Manager diagnostic data. |
OEM | OEM diagnostic data. |
OS | Operating system (OS) diagnostic data. |
PreOS | Pre-OS diagnostic data. |
The entry code for the log entry if the entry type is `SEL`.
string | Description |
---|---|
Assert | The condition has been asserted. |
D0 Power State | The ACPI-defined D0 power state. |
D1 Power State | The ACPI-defined D1 power state. |
D2 Power State | The ACPI-defined D2 power state. |
D3 Power State | The ACPI-defined D3 power state. |
Deassert | The condition has been deasserted. |
Device Disabled | A device has been disabled. |
Device Enabled | A device has been enabled. |
Device Inserted / Device Present | A device has been inserted or is present. |
Device Removed / Device Absent | A device has been removed or is absent. |
Fully Redundant | Indicates that full redundancy has been regained. |
Informational | An informational event. |
Install Error | An install error has been detected. |
Limit Exceeded | A limit has been exceeded. |
Limit Not Exceeded | A limit has not been exceeded. |
Lower Critical - going high | The reading crossed the Lower Critical threshold while going high. |
Lower Critical - going low | The reading crossed the Lower Critical threshold while going low. |
Lower Non-critical - going high | The reading crossed the Lower Non-critical threshold while going high. |
Lower Non-critical - going low | The reading crossed the Lower Non-critical threshold while going low. |
Lower Non-recoverable - going high | The reading crossed the Lower Non-recoverable threshold while going high. |
Lower Non-recoverable - going low | The reading crossed the Lower Non-recoverable threshold while going low. |
Monitor | A monitor event. |
Non-redundant:Insufficient Resources | Unit is non-redundant and has insufficient resources to maintain normal operation. |
Non-redundant:Sufficient Resources from Insufficient Resources | Unit has regained minimum resources needed for normal operation. |
Non-redundant:Sufficient Resources from Redundant | Redundancy has been lost but unit is functioning with minimum resources needed for normal operation. |
OEM (v1.3+) | An OEM-defined event. |
Performance Lags | Performance does not meet expectations. |
Performance Met | Performance meets expectations. |
Predictive Failure asserted | A Predictive Failure has been detected. |
Predictive Failure deasserted | A Predictive Failure is no longer present. |
Redundancy Degraded | Redundancy still exists, but at less than full level. |
Redundancy Degraded from Fully Redundant | Unit has lost some redundant resource(s) but is still in a redundant state. |
Redundancy Degraded from Non-redundant | Unit has regained some resource(s) and is redundant but not fully redundant. |
Redundancy Lost | Entered any non-redundant state, including Non-redundant: Insufficient Resources. |
State Asserted | The state has been asserted. |
State Deasserted | The state has been deasserted. |
Transition to Active | The state transitioned to active. |
Transition to Busy | The state transitioned to busy. |
Transition to Critical from less severe | A state has changed to Critical from less severe. |
Transition to Critical from Non-recoverable | A state has changed to Critical from Non-recoverable. |
Transition to Degraded | A state has transitioned to Degraded. |
Transition to Idle | The state transitioned to idle. |
Transition to In Test | A state has transitioned to In Test. |
Transition to Non-Critical from more severe | A state has changed to Non-Critical from more severe. |
Transition to Non-Critical from OK | A state has changed to Non-Critical from OK. |
Transition to Non-recoverable | A state has changed to Non-recoverable. |
Transition to Non-recoverable from less severe | A state has changed to Non-recoverable from less severe. |
Transition to Off Duty | A state has transitioned to Off Duty. |
Transition to Off Line | A state has transitioned to Off Line. |
Transition to OK | A state has changed to OK. |
Transition to On Line | A state has transitioned to On Line. |
Transition to Power Off | A state has transitioned to Power Off. |
Transition to Power Save | A state has transitioned to Power Save. |
Transition to Running | A state has transitioned to Running. |
Upper Critical - going high | The reading crossed the Upper Critical threshold while going high. |
Upper Critical - going low | The reading crossed the Upper Critical threshold while going low. |
Upper Non-critical - going high | The reading crossed the Upper Non-critical threshold while going high. |
Upper Non-critical - going low | The reading crossed the Upper Non-critical threshold while going low. |
Upper Non-recoverable - going high | The reading crossed the Upper Non-recoverable threshold while going high. |
Upper Non-recoverable - going low | The reading crossed the Upper Non-recoverable threshold while going low. |
The type of log entry.
string | Description |
---|---|
Event | A Redfish-defined message. |
Oem | An entry in an OEM-defined format. |
SEL | A legacy IPMI System Event Log (SEL) entry. |
The type of event recorded in this log.
string | Description |
---|---|
Alert | A condition requires attention. |
MetricReport | The telemetry service is sending a metric report. |
Other | Because EventType is deprecated as of Redfish Specification v1.6, the event is based on a registry or resource but not an EventType. |
ResourceAdded | A resource has been added. |
ResourceRemoved | A resource has been removed. |
ResourceUpdated | A resource has been updated. |
StatusChange | The status of a resource has changed. |
The sensor type to which the log entry pertains if the entry type is `SEL`.
string | Description |
---|---|
Add-in Card | A sensor for an add-in card. |
BaseOSBoot/InstallationStatus | A sensor for a base OS boot or installation status event. |
Battery | A sensor for a battery. |
Boot Error | A sensor for a boot error event. |
Button/Switch | A sensor for a button or switch. |
Cable/Interconnect | A sensor for a cable or interconnect device type. |
Chassis | A sensor for a chassis. |
ChipSet | A sensor for a chipset. |
CoolingDevice | A sensor for a cooling device. |
Critical Interrupt | A sensor for a critical interrupt event. |
Current | A current sensor. |
Drive Slot/Bay | A sensor for a drive slot or bay. |
Entity Presence | A sensor for an entity presence event. |
Event Logging Disabled | A sensor for the event log. |
Fan | A fan sensor. |
FRUState | A sensor for a FRU state event. |
LAN | A sensor for a LAN device. |
Management Subsystem Health | A sensor for a management subsystem health event. |
Memory | A sensor for a memory device. |
Microcontroller/Coprocessor | A sensor for a microcontroller or coprocessor. |
Module/Board | A sensor for a module or board. |
Monitor ASIC/IC | A sensor for a monitor ASIC or IC. |
OEM (v1.3+) | An OEM-defined sensor. |
OS Stop/Shutdown | A sensor for an OS stop or shutdown event |
Other FRU | A sensor for another type of FRU. |
Other Units-based Sensor | A sensor for a miscellaneous analog sensor. |
Physical Chassis Security | A physical security sensor. |
Platform Alert | A sensor for a platform alert event. |
Platform Security Violation Attempt | A platform security sensor. |
POST Memory Resize | A sensor for a POST memory resize event. |
Power Supply / Converter | A sensor for a power supply or DC-to-DC converter. |
PowerUnit | A sensor for a power unit. |
Processor | A sensor for a processor. |
Session Audit | A sensor for a session audit event. |
Slot/Connector | A sensor for a slot or connector. |
System ACPI PowerState | A sensor for an ACPI power state event. |
System Event | A sensor for a system event. |
System Firmware Progress | A sensor for a system firmware progress event. |
SystemBoot/Restart | A sensor for a system boot or restart event. |
Temperature | A temperature sensor. |
Terminator | A sensor for a terminator. |
Version Change | A sensor for a version change event. |
Voltage | A voltage sensor. |
Watchdog | A sensor for a watchdog event. |
The severity of the log entry.
string | Description |
---|---|
Critical | A critical condition that requires immediate attention. |
OK | Informational or operating normally. |
Warning | A condition that requires attention. |
{ "@odata.type": "#LogEntry.v1_8_0.LogEntry", "Id": "1", "Name": "Log Entry 1", "EntryType": "Event", "Severity": "Critical", "Created": "2012-03-07T14:44:00Z", "Resolved": false, "Message": "Temperature threshold exceeded", "MessageId": "Contoso.1.0.TempAssert", "MessageArgs": [ "42" ], "Links": { "OriginOfCondition": { "@odata.id": "/redfish/v1/Chassis/1U/Thermal" }, "Oem": {} }, "Oem": {}, "@odata.id": "/redfish/v1/Systems/437XR1138R2/LogServices/Log1/Entries/1" }
v1.2 | v1.1 | v1.0 |
2020.3 | 2017.3 | 1.0 |
The LogService schema contains properties for monitoring and configuring a Log Service.
string (date-time) | The current date and time, with UTC offset, that the Log Service uses to set or read time. | ||
string | The UTC offset that the current DateTime property value contains in the +HH:MM format. | ||
object | The link to the log entry collection. Contains a link to a resource. | ||
} | string | Link to Collection of LogEntry. See the LogEntry schema for details. | |
string (enum) | The format of the log entries. For the possible property values, see LogEntryType in Property details. | ||
integer | The maximum number of log entries that this service can have. | ||
string (enum) | The overwrite policy for this service that takes place when the log is full. For the possible property values, see OverWritePolicy in Property details. | ||
boolean | An indication of whether this service is enabled. | ||
object | The status and health of the Resource and its subordinate or dependent Resources. For property details, see Status. | ||
array | A list of syslog message filters to be logged locally. | ||
| array (string (enum)) | The types of programs that can log messages. The syslog facility code is an enumeration of program types. For the possible property values, see LogFacilities in Property details. | |
} ] | string (enum) | The lowest severity level message that will be logged. For the possible property values, see LowestSeverity in Property details. |
The action to clear the log for this Log Service.
Action URI: {Base URI of target resource}/Actions/LogService.ClearLogPerform the action using a POST to the specific Action URI for this resource. This action takes no parameters.
The action to collect the diagnostic data for the given type.
Action URI: {Base URI of target resource}/Actions/LogService.CollectDiagnosticDataPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| string (enum) | | The type of diagnostic data to collect. For the possible property values, see DiagnosticDataType in Property details. |
} | string | optional | The OEM-defined type of diagnostic data to collect. |
The type of diagnostic data to collect.
string | Description |
---|---|
Manager | Manager diagnostic data. |
OEM | OEM diagnostic data. |
OS | Operating system (OS) diagnostic data. |
PreOS | Pre-OS diagnostic data. |
The format of the log entries.
string | Description |
---|---|
Event | The log contains Redfish-defined messages. |
Multiple | The log contains multiple log entry types and, therefore, the Log Service cannot guarantee a single entry type. |
OEM | The log contains entries in an OEM-defined format. |
SEL | The log contains legacy IPMI System Event Log (SEL) entries. |
The types of programs that can log messages. The syslog facility code is an enumeration of program types.
string | Description |
---|---|
Auth | Security/authentication messages. |
Authpriv | Security/authentication messages. |
Console | Log alert. |
Cron | Clock daemon. |
Daemon | System daemons. |
FTP | FTP daemon. |
Kern | Kernel messages. |
Local0 | Locally used facility 0. |
Local1 | Locally used facility 1. |
Local2 | Locally used facility 2. |
Local3 | Locally used facility 3. |
Local4 | Locally used facility 4. |
Local5 | Locally used facility 5. |
Local6 | Locally used facility 6. |
Local7 | Locally used facility 7. |
LPR | Line printer subsystem. |
Mail system. | |
News | Network news subsystem. |
NTP | NTP subsystem. |
Security | Log audit. |
SolarisCron | Scheduling daemon. |
Syslog | Messages generated internally by syslogd. |
User | User-level messages. |
UUCP | UUCP subsystem. |
The lowest severity level message that will be logged.
string | Description |
---|---|
Alert | A condition that should be corrected immediately, such as a corrupted system database. |
All | A message of any severity. |
Critical | Hard device errors. |
Debug | Messages that contain information normally of use only when debugging a program. |
Emergency | A panic condition. |
Error | An Error. |
Informational | Informational only. |
Notice | Conditions that are not error conditions, but that may require special handling. |
Warning | A Warning. |
The overwrite policy for this service that takes place when the log is full.
string | Description |
---|---|
NeverOverWrites | When full, new entries to the log are discarded. |
Unknown | The overwrite policy is not known or is undefined. |
WrapsWhenFull | When full, new entries to the log overwrite earlier entries. |
{ "@odata.type": "#LogService.v1_2_0.LogService", "Id": "Log1", "Name": "System Log Service", "Description": "This log contains entries related to the operation of the host Computer System.", "MaxNumberOfRecords": 1000, "OverWritePolicy": "WrapsWhenFull", "DateTime": "2015-03-13T04:14:33+06:00", "DateTimeLocalOffset": "+06:00", "ServiceEnabled": true, "LogEntryType": "Event", "Status": { "State": "Enabled", "Health": "OK" }, "Oem": {}, "Actions": { "#LogService.ClearLog": { "target": "/redfish/v1/Managers/1/LogServices/Log1/Actions/LogService.ClearLog" }, "Oem": {} }, "Entries": { "@odata.id": "/redfish/v1/Managers/1/LogServices/Log1/Entries" }, "@odata.id": "/redfish/v1/Managers/1/LogServices/Log1" }
v1.11 | v1.10 | v1.9 | v1.8 | v1.7 | v1.6 | v1.5 | v1.4 | v1.3 | v1.2 | v1.1 | ... |
2020.4 | 2020.3 | 2020.2 | 2020.1 | 2019.4 | 2019.2 | 2018.2 | 2018.1 | 2016.3 | 2016.2 | 2016.1 | ... |
In Redfish, a manager is a systems management entity that can implement or provide access to a Redfish service. Examples of managers are BMCs, enclosure managers, management controllers, and other subsystems that are assigned manageability functions. An implementation can have multiple managers, which might be directly accessible through a Redfish-defined interface.
boolean | An indication of whether the manager is configured for automatic Daylight Saving Time (DST) adjustment. | ||
object | The command shell service that this manager provides. | ||
| array (string (enum)) | This property enumerates the command shell connection types that the implementation allows. For the possible property values, see ConnectTypesSupported in Property details. | |
| integer | The maximum number of service sessions, regardless of protocol, that this manager can support. | |
} | boolean | An indication of whether the service is enabled for this manager. | |
string (date-time) | The current date and time with UTC offset that the manager uses to set or read time. | ||
string | The time offset from UTC that the DateTime property is in +HH:MM format. | ||
object | The link to a collection of NICs that this manager uses for network communication. Contains a link to a resource. | ||
} | string | Link to Collection of EthernetInterface. See the EthernetInterface schema for details. | |
string | The firmware version of this manager. | ||
object | The information about the graphical console service of this manager. | ||
| array (string (enum)) | This property enumerates the graphical console connection types that the implementation allows. For the possible property values, see ConnectTypesSupported in Property details. | |
| integer | The maximum number of service sessions, regardless of protocol, that this manager can support. | |
} | boolean | An indication of whether the service is enabled for this manager. | |
object | The link to a collection of host interfaces that this manager uses for local host communication. Clients can find host interface configuration options and settings in this navigation property. Contains a link to a resource. | ||
} | string | Link to Collection of HostInterface. See the HostInterface schema for details. | |
string (date-time) | The date and time when the manager was last reset or rebooted. | ||
object | The links to other resources that are related to this resource. | ||
| object | The link to the software inventory resource that represents the active firmware image for this manager. See the SoftwareInventory schema for details on this property. | |
} | string | Link to a SoftwareInventory resource. See the Links section and the SoftwareInventory schema for details. | |
| array | The array of links to the managers responsible for managing this manager. | |
} ] | string | Link to another Manager resource. | |
| array | An array of links to the chassis this manager controls. | |
} ] | string | Link to a Chassis resource. See the Links section and the Chassis schema for details. | |
| array | An array of links to the managers that are managed by this manager. | |
} ] | string | Link to another Manager resource. | |
| array | An array of links to the systems that this manager controls. | |
} ] | string | Link to a ComputerSystem resource. See the Links section and the ComputerSystem schema for details. | |
| array | An array of links to the switches that this manager controls. | |
} ] | string | Link to a Switch resource. See the Links section and the Switch schema for details. | |
| object | The link to the chassis where this manager is located. See the Chassis schema for details on this property. | |
} | string | Link to a Chassis resource. See the Links section and the Chassis schema for details. | |
| object | See the Oem object definition in the Common properties section. | |
| array | The images that are associated with this manager. | |
} ] } | string | Link to a SoftwareInventory resource. See the Links section and the SoftwareInventory schema for details. | |
object | The location of the manager. For property details, see Location. | ||
boolean | An indicator allowing an operator to physically locate this resource. | ||
object | The link to a collection of logs that the manager uses. Contains a link to a resource. | ||
} | string | Link to Collection of LogService. See the LogService schema for details. | |
string (enum) | The type of manager that this resource represents. For the possible property values, see ManagerType in Property details. | ||
string | The manufacturer of this manager. | ||
string | The model information of this manager, as defined by the manufacturer. | ||
object | The link to the network services and their settings that the manager controls. See the ManagerNetworkProtocol schema for details on this property. | ||
} | string | Link to a ManagerNetworkProtocol resource. See the Links section and the ManagerNetworkProtocol schema for details. | |
string | The part number of the manager. | ||
string (enum) | The current power state of the manager. For the possible property values, see PowerState in Property details. | ||
array (object) | A reference to a set of Redundancy entities that provide redundant Services for this Resource. See the Redundancy object definition in the Common objects section. For property details, see Redundancy. | ||
object | The link to the account service resource for the remote manager that this resource represents. See the AccountService schema for details on this property. | ||
} | string | Link to a AccountService resource. See the Links section and the AccountService schema for details. | |
string (URI) | The URI of the Redfish service root for the remote manager that this resource represents. | ||
object | The serial console service that this manager provides. Deprecated in v1.10 and later. This property has been deprecated in favor of the SerialConsole property in the ComputerSystem resource. | ||
| array (string (enum)) | This property enumerates the serial console connection types that the implementation allows. For the possible property values, see ConnectTypesSupported in Property details. | |
| integer | The maximum number of service sessions, regardless of protocol, that this manager can support. | |
} | boolean | An indication of whether the service is enabled for this manager. | |
object | The link to a collection of serial interfaces that this manager uses for serial and console communication. Contains a link to a resource. | ||
} | string | Link to Collection of SerialInterface. See the SerialInterface schema for details. | |
string | The serial number of the manager. | ||
string | The UUID of the Redfish service that is hosted by this manager. | ||
string | The spare part number of the manager. | ||
object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. | ||
string | The time zone of the manager. | ||
string | The UUID for this manager. | ||
object | The link to the Virtual Media services for this particular manager. Contains a link to a resource. Deprecated in v1.10 and later. This property has been deprecated in favor of the VirtualMedia property in the ComputerSystem resource. | ||
} | string | Link to Collection of VirtualMedia. See the VirtualMedia schema for details. |
The ForceFailover action forces a failover of this manager to the manager used in the parameter.
Action URI: {Base URI of target resource}/Actions/Manager.ForceFailoverPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| object | | The manager to which to fail over. |
} } | string | Link to another Manager resource. |
The ModifyRedundancySet operation adds members to or removes members from a redundant group of managers.
Action URI: {Base URI of target resource}/Actions/Manager.ModifyRedundancySetPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| array | optional | An array of managers to add to the redundancy set. |
} ] | string | Link to another Manager resource. | |
| array | optional | An array of managers to remove from the redundancy set. |
} ] } | string | Link to another Manager resource. |
The reset action resets/reboots the manager.
Action URI: {Base URI of target resource}/Actions/Manager.ResetPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
} | string (enum) | optional | The type of reset. For the possible property values, see ResetType in Property details. |
The reset action resets the manager settings to factory defaults. This might cause the manager to reset.
Action URI: {Base URI of target resource}/Actions/Manager.ResetToDefaultsPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
} | string (enum) | | The type of reset to defaults. For the possible property values, see ResetType in Property details. |
This property enumerates the command shell connection types that the implementation allows.
string | Description |
---|---|
IPMI | The controller supports a command shell connection through the IPMI Serial Over LAN (SOL) protocol. |
Oem | The controller supports a command shell connection through an OEM-specific protocol. |
SSH | The controller supports a command shell connection through the SSH protocol. |
Telnet | The controller supports a command shell connection through the Telnet protocol. |
This property enumerates the graphical console connection types that the implementation allows.
string | Description |
---|---|
KVMIP | The controller supports a graphical console connection through a KVM-IP (redirection of Keyboard, Video, Mouse over IP) protocol. |
Oem | The controller supports a graphical console connection through an OEM-specific protocol. |
This property enumerates the serial console connection types that the implementation allows.
string | Description |
---|---|
IPMI | The controller supports a serial console connection through the IPMI Serial Over LAN (SOL) protocol. |
Oem | The controller supports a serial console connection through an OEM-specific protocol. |
SSH | The controller supports a serial console connection through the SSH protocol. |
Telnet | The controller supports a serial console connection through the Telnet protocol. |
The type of manager that this resource represents.
string | Description |
---|---|
AuxiliaryController | A controller that provides management functions for a particular subsystem or group of devices. |
BMC | A controller that provides management functions for a single computer system. |
EnclosureManager | A controller that provides management functions for a chassis or group of devices or systems. |
ManagementController | A controller that primarily monitors or manages the operation of a device or system. |
RackManager | A controller that provides management functions for a whole or part of a rack. |
Service (v1.4+) | A software-based service that provides management functions. |
The current power state of the manager.
string | Description |
---|---|
Off | The state is powered off. |
On | The state is powered on. |
PoweringOff | A temporary state between on and off. |
PoweringOn | A temporary state between off and on. |
The type of reset.
string | Description |
---|---|
ForceOff | Turn off the unit immediately (non-graceful shutdown). |
ForceOn | Turn on the unit immediately. |
ForceRestart | Shut down immediately and non-gracefully and restart the system. |
GracefulRestart | Shut down gracefully and restart the system. |
GracefulShutdown | Shut down gracefully and power off. |
Nmi | Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system. |
On | Turn on the unit. |
PowerCycle | Power cycle the unit. Behaves like a full power removal, followed by a power restore to the resource. |
PushPowerButton | Simulate the pressing of the physical power button on this unit. |
The type of reset to defaults.
string | Description |
---|---|
PreserveNetwork | Reset all settings except network settings to factory defaults. |
PreserveNetworkAndUsers | Reset all settings except network and local user names/passwords to factory defaults. |
ResetAll | Reset all settings to factory defaults. |
{ "@odata.type": "#Manager.v1_11_0.Manager", "Id": "BMC", "Name": "Manager", "ManagerType": "BMC", "Description": "Contoso BMC", "ServiceEntryPointUUID": "92384634-2938-2342-8820-489239905423", "UUID": "58893887-8974-2487-2389-841168418919", "Model": "Joo Janta 200", "FirmwareVersion": "4.4.6521", "DateTime": "2015-03-13T04:14:33+06:00", "DateTimeLocalOffset": "+06:00", "Status": { "State": "Enabled", "Health": "OK" }, "PowerState": "On", "GraphicalConsole": { "ServiceEnabled": true, "MaxConcurrentSessions": 2, "ConnectTypesSupported": [ "KVMIP" ] }, "SerialConsole": { "ServiceEnabled": true, "MaxConcurrentSessions": 1, "ConnectTypesSupported": [ "Telnet", "SSH", "IPMI" ] }, "CommandShell": { "ServiceEnabled": true, "MaxConcurrentSessions": 4, "ConnectTypesSupported": [ "Telnet", "SSH" ] }, "HostInterfaces": { "@odata.id": "/redfish/v1/Managers/9/HostInterfaces" }, "NetworkProtocol": { "@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol" }, "EthernetInterfaces": { "@odata.id": "/redfish/v1/Managers/BMC/NICs" }, "SerialInterfaces": { "@odata.id": "/redfish/v1/Managers/BMC/SerialInterfaces" }, "LogServices": { "@odata.id": "/redfish/v1/Managers/BMC/LogServices" }, "VirtualMedia": { "@odata.id": "/redfish/v1/Managers/BMC/VirtualMedia" }, "Links": { "ManagerForServers": [ { "@odata.id": "/redfish/v1/Systems/437XR1138R2" } ], "ManagerForChassis": [ { "@odata.id": "/redfish/v1/Chassis/1U" } ], "ManagerInChassis": { "@odata.id": "/redfish/v1/Chassis/1U" }, "Oem": {} }, "Actions": { "#Manager.Reset": { "target": "/redfish/v1/Managers/BMC/Actions/Manager.Reset", "ResetType@Redfish.AllowableValues": [ "ForceRestart", "GracefulRestart" ] }, "Oem": {} }, "Oem": {}, "@odata.id": "/redfish/v1/Managers/BMC" }
v1.7 | v1.6 | v1.5 | v1.4 | v1.3 | v1.2 | v1.1 | v1.0 |
2020.4 | 2020.1 | 2019.4 | 2019.3 | 2019.1 | 2018.3 | 2017.1 | 1.0 |
The ManagerAccount schema defines the user accounts that are owned by a manager. Changes to a manager account might affect the current Redfish service connection if this manager is responsible for the Redfish service.
array (string (enum)) | The account types. For the possible property values, see AccountTypes in Property details. | ||
object | The link to a collection of certificates used for this account. Contains a link to a resource. | ||
} | string | Link to Collection of Certificate. See the Certificate schema for details. | |
boolean | An indication of whether an account is enabled. An administrator can disable it without deleting the user information. If true , the account is enabled and the user can log in. If false , the account is disabled and, in the future, the user cannot log in. | ||
object | The links to other resources that are related to this resource. | ||
| object | See the Oem object definition in the Common properties section. | |
| object | The link to the Redfish role that defines the privileges for this account. See the Role schema for details on this property. | |
} } | string | Link to a Role resource. See the Links section and the Role schema for details. | |
boolean | An indication of whether the account service automatically locked the account because the lockout threshold was exceeded. To manually unlock the account before the lockout duration period, an administrator can change the property to false to clear the lockout condition. | ||
array (string, null) | The OEM account types. | ||
string | The password. Use this property with a PATCH or PUT to write the password for the account. This property is null in responses. | ||
boolean | An indication of whether the service requires that the password for this account be changed before further access to the account is allowed. | ||
string (date-time) | Indicates the date and time when this account password expires. If null , the account password never expires. | ||
string | The role for this account. | ||
object | (null) | The SNMP settings for this account. | |
| string | The secret authentication key for SNMPv3. | |
| boolean | Indicates if the AuthenticationKey property is set. | |
| string (enum) | The authentication protocol for SNMPv3. For the possible property values, see AuthenticationProtocol in Property details. | |
| string | The secret encryption key used in SNMPv3. | |
| boolean | Indicates if the EncryptionKey property is set. | |
} | string (enum) | The encryption protocol for SNMPv3. For the possible property values, see EncryptionProtocol in Property details. | |
boolean | Indicates if the service needs to use the account types exactly as specified when the account is created or updated. | ||
string | The user name for the account. |
The account types.
string | Description |
---|---|
HostConsole | Allow access to the host's console, which could be connected through Telnet, SSH, or other protocol. |
IPMI | Allow access to the Intelligent Platform Management Interface service. |
KVMIP | Allow access to a Keyboard-Video-Mouse over IP session. |
ManagerConsole | Allow access to the manager's console, which could be connected through Telnet, SSH, SM CLP, or other protocol. |
OEM | OEM account type. See the OEMAccountTypes property. |
Redfish | Allow access to the Redfish service. |
SNMP | Allow access to SNMP services. |
VirtualMedia | Allow access to control virtual media. |
WebUI | Allow access to a web user interface session, such as a graphical interface or another web-based protocol. |
The authentication protocol for SNMPv3.
string | Description |
---|---|
HMAC128_SHA224 (v1.7+) | HMAC-128-SHA-224 authentication. |
HMAC192_SHA256 (v1.7+) | HMAC-192-SHA-256 authentication. |
HMAC256_SHA384 (v1.7+) | HMAC-256-SHA-384 authentication. |
HMAC384_SHA512 (v1.7+) | HMAC-384-SHA-512 authentication. |
HMAC_MD5 | HMAC-MD5-96 authentication. |
HMAC_SHA96 | HMAC-SHA-96 authentication. |
None | No authentication. |
The encryption protocol for SNMPv3.
string | Description |
---|---|
CBC_DES | CBC-DES encryption. |
CFB128_AES128 | CFB128-AES-128 encryption. |
None | No encryption. |
{ "@odata.type": "#ManagerAccount.v1_7_0.ManagerAccount", "Id": "1", "Name": "User Account", "Description": "User Account", "Enabled": true, "Password": null, "UserName": "Administrator", "RoleId": "Administrator", "Locked": false, "Links": { "Role": { "@odata.id": "/redfish/v1/AccountService/Roles/Administrator" } }, "@odata.id": "/redfish/v1/AccountService/Accounts/1" }
v1.7 | v1.6 | v1.5 | v1.4 | v1.3 | v1.2 | v1.1 | v1.0 |
2020.4 | 2020.1 | 2019.3 | 2018.3 | 2018.2 | 2017.1 | 2016.3 | 1.0 |
The network service settings for the manager.
object | The settings for this manager's DHCPv4 protocol support. For more information about this property, see Protocol in Property Details. | ||
object | The settings for this manager's DHCPv6 protocol support. For more information about this property, see Protocol in Property Details. | ||
string | The fully qualified domain name for the manager obtained by DNS including the host name and top-level domain name. | ||
string | The DNS host name of this manager, without any domain information. | ||
object | The settings for this manager's HTTP protocol support. For more information about this property, see Protocol in Property Details. | ||
object | The settings for this manager's HTTPS protocol support. | ||
| object | The link to a collection of certificates used for HTTPS by this manager. Contains a link to a resource. | |
} | string | Link to Collection of Certificate. See the Certificate schema for details. | |
| integer | The protocol port. | |
} | boolean | An indication of whether the protocol is enabled. | |
object | The settings for this manager's IPMI-over-LAN protocol support. For more information about this property, see Protocol in Property Details. | ||
object | The settings for this manager's KVM-IP protocol support that apply to all system instances controlled by this manager. For more information about this property, see Protocol in Property Details. | ||
object | The settings for this manager's NTP protocol support. | ||
| array (string, null) | Indicates to which NTP servers this manager is subscribed. | |
| integer | The protocol port. | |
} | boolean | An indication of whether the protocol is enabled. | |
object | The settings for this manager's Remote Desktop Protocol support. For more information about this property, see Protocol in Property Details. | ||
object | The settings for this manager's Remote Frame Buffer protocol support, which can support VNC. For more information about this property, see Protocol in Property Details. | ||
object | The settings for this manager's SNMP support. | ||
| string (enum) | The authentication protocol used for SNMP access to this manager. For the possible property values, see AuthenticationProtocol in Property details. | |
| string (enum) | The access level of the SNMP community. For the possible property values, see CommunityAccessMode in Property details. | |
| array | The SNMP community strings. | |
| string (enum) | The access level of the SNMP community. For the possible property values, see AccessMode in Property details. | |
| string | The SNMP community string. | |
} ] | string | The name of the SNMP community. | |
| boolean | Indicates if access via SNMPv1 is enabled. | |
| boolean | Indicates if access via SNMPv2c is enabled. | |
| boolean | Indicates if access via SNMPv3 is enabled. | |
| string (enum) | The encryption protocol used for SNMPv3 access to this manager. For the possible property values, see EncryptionProtocol in Property details. | |
| object | (null) | The engine ID. |
| string | The architecture identifier. | |
| string | The enterprise specific method. | |
} | string | The private enterprise ID. | |
| boolean | Indicates if the community strings should be hidden. | |
| integer | The protocol port. | |
} | boolean | An indication of whether the protocol is enabled. | |
object | The settings for this manager's SSDP support. | ||
| string (enum) | The IPv6 scope for multicast NOTIFY messages for SSDP. For the possible property values, see NotifyIPv6Scope in Property details. | |
| integer (seconds) | The time interval, in seconds, between transmissions of the multicast NOTIFY ALIVE message from this service for SSDP. | |
| integer | The time-to-live hop count for SSDP multicast NOTIFY messages. | |
| integer | The protocol port. | |
} | boolean | An indication of whether the protocol is enabled. | |
object | The settings for this manager's Secure Shell (SSH) protocol support. For more information about this property, see Protocol in Property Details. | ||
object | The status and health of the Resource and its subordinate or dependent Resources. For property details, see Status. | ||
object | The settings for this manager's Telnet protocol support. For more information about this property, see Protocol in Property Details. | ||
object | The settings for this manager's virtual media support that apply to all system instances controlled by this manager. For more information about this property, see Protocol in Property Details. |
The access level of the SNMP community.
string | Description |
---|---|
Full | READ-WRITE access mode. |
Limited | READ-ONLY access mode. |
The authentication protocol used for SNMP access to this manager.
string | Description |
---|---|
Account | Authentication is determined by account settings. |
CommunityString | SNMP community string authentication. |
HMAC128_SHA224 (v1.7+) | HMAC-128-SHA-224 authentication. |
HMAC192_SHA256 (v1.7+) | HMAC-192-SHA-256 authentication. |
HMAC256_SHA384 (v1.7+) | HMAC-256-SHA-384 authentication. |
HMAC384_SHA512 (v1.7+) | HMAC-384-SHA-512 authentication. |
HMAC_MD5 | HMAC-MD5-96 authentication. |
HMAC_SHA96 | HMAC-SHA-96 authentication. |
The access level of the SNMP community.
string | Description |
---|---|
Full | READ-WRITE access mode. |
Limited | READ-ONLY access mode. |
The encryption protocol used for SNMPv3 access to this manager.
string | Description |
---|---|
Account | Encryption is determined by account settings. |
CBC_DES | CBC-DES encryption. |
CFB128_AES128 | CFB128-AES-128 encryption. |
None | No encryption. |
The IPv6 scope for multicast NOTIFY messages for SSDP.
string | Description |
---|---|
Link | SSDP NOTIFY messages are sent to addresses in the IPv6 local link scope. |
Organization | SSDP NOTIFY messages are sent to addresses in the IPv6 local organization scope. |
Site | SSDP NOTIFY messages are sent to addresses in the IPv6 local site scope. |
The settings for a network protocol associated with a manager.
integer | The protocol port. | ||
boolean | An indication of whether the protocol is enabled. |
{ "@odata.type": "#ManagerNetworkProtocol.v1_7_0.ManagerNetworkProtocol", "Id": "NetworkProtocol", "Name": "Manager Network Protocol", "Description": "Manager Network Service", "Status": { "State": "Enabled", "Health": "OK" }, "HostName": "web483-bmc", "FQDN": "web483-bmc.dmtf.org", "HTTP": { "ProtocolEnabled": true, "Port": 80 }, "HTTPS": { "ProtocolEnabled": true, "Port": 443 }, "IPMI": { "ProtocolEnabled": true, "Port": 623 }, "SSH": { "ProtocolEnabled": true, "Port": 22 }, "SNMP": { "ProtocolEnabled": true, "Port": 161 }, "VirtualMedia": { "ProtocolEnabled": true, "Port": 17988 }, "SSDP": { "ProtocolEnabled": true, "Port": 1900, "NotifyMulticastIntervalSeconds": 600, "NotifyTTL": 5, "NotifyIPv6Scope": "Site" }, "Telnet": { "ProtocolEnabled": true, "Port": 23 }, "KVMIP": { "ProtocolEnabled": true, "Port": 5288 }, "@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol" }
v1.1 | v1.0 |
2020.2 | 2019.4 |
The MediaController schema contains the definition of the media controller and its configuration.
object | The links to other resources that are related to this resource. | ||
| array | An array of links to the endpoints that connect to this media controller. | |
} ] | string | Link to a Endpoint resource. See the Links section and the Endpoint schema for details. | |
| array | An array of links to the memory domains associated with this media controller. | |
} ] | string | Link to a MemoryDomain resource. See the Links section and the MemoryDomain schema for details. | |
} | object | See the Oem object definition in the Common properties section. | |
string | The manufacturer of this media controller. | ||
string (enum) | The type of media controller. For the possible property values, see MediaControllerType in Property details. | ||
string | The model of this media controller. | ||
string | The part number of this media controller. | ||
object | The link to the collection of ports associated with this media controller. Contains a link to a resource. | ||
} | string | Link to Collection of Port. See the Port schema for details. | |
string | The serial number of this media controller. | ||
object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. | ||
string | The UUID for this media controller. |
This action resets this media controller.
Action URI: {Base URI of target resource}/Actions/MediaController.ResetPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
} | string (enum) | optional | The type of reset. For the possible property values, see ResetType in Property details. |
The type of media controller.
string | Description |
---|---|
Memory | The media controller is for memory. |
The type of reset.
string | Description |
---|---|
ForceOff | Turn off the unit immediately (non-graceful shutdown). |
ForceOn | Turn on the unit immediately. |
ForceRestart | Shut down immediately and non-gracefully and restart the system. |
GracefulRestart | Shut down gracefully and restart the system. |
GracefulShutdown | Shut down gracefully and power off. |
Nmi | Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system. |
On | Turn on the unit. |
PowerCycle | Power cycle the unit. Behaves like a full power removal, followed by a power restore to the resource. |
PushPowerButton | Simulate the pressing of the physical power button on this unit. |
{ "@odata.type": "#MediaController.v1_1_0.MediaController", "Id": "MediaController1", "Name": "Media Controller 1", "MediaControllerType": "Memory", "Manufacturer": "Contoso", "Model": "Contoso MediaController", "SerialNumber": "2M220100SL", "Status": { "State": "Enabled", "Health": "OK" }, "UUID": "41784113-ed6b-2284-1414-916520dc1dd1", "Ports": { "@odata.id": "/redfish/v1/Chassis/GenZ/MediaControllers/1/Ports" }, "Actions": { "#MediaController.Reset": { "target": "/redfish/v1/Chassis/GenZ/MediaControllers/1/Actions/MediaController.Reset", "ResetType@Redfish.AllowableValues": [ "ForceRestart" ] } }, "Links": { "Endpoints": [ { "@odata.id": "/redfish/v1/Fabrics/GenZ/Endpoints/1" } ], "MemoryDomains": [ { "@odata.id": "/redfish/v1/Chassis/GenZ/MemoryDomains/1" } ] }, "Oem": {}, "@odata.id": "/redfish/v1/Chassis/GenZ/MediaControllers/1" }
v1.11 | v1.10 | v1.9 | v1.8 | v1.7 | v1.6 | v1.5 | v1.4 | v1.3 | v1.2 | v1.1 | ... |
2020.4 | 2020.3 | 2019.4 | 2019.2 | 2018.3 | 2018.2 | 2018.1 | 2017.3 | 2017.2 | 2017.1 | 2016.3 | ... |
The Memory schema represents a memory device, such as a DIMM, and its configuration.
integer (mebibytes) | The boundary that memory regions are allocated on, measured in mebibytes (MiB). | ||
integer (mebibytes) | The size of the smallest unit of allocation for a memory region in mebibytes (MiB). | ||
array (MHz) (integer) | Speeds supported by this memory device. | ||
object | The link to the assembly resource associated with this memory device. See the Assembly schema for details on this property. | ||
} | string | Link to a Assembly resource. See the Links section and the Assembly schema for details. | |
string (enum) | The base module type of the memory device. For the possible property values, see BaseModuleType in Property details. | ||
integer | The bus width, in bits. | ||
integer (mebibytes) | Total size of the cache portion memory in MiB. | ||
integer (mebibytes) | Memory capacity in mebibytes (MiB). | ||
object | The link to a collection of certificates for device identity and attestation. Contains a link to a resource. | ||
} | string | Link to Collection of Certificate. See the Certificate schema for details. | |
boolean | An indication of whether the configuration of this memory device is locked and cannot be altered. | ||
integer | Data width in bits. | ||
string | Device ID. Deprecated in v1.3 and later. This property has been deprecated in favor of ModuleProductID. | ||
string | Location of the memory device in the platform. Deprecated in v1.9 and later. This property has been deprecated in favor of the ServiceLabel property within Location. | ||
object | The link to the environment metrics for this memory. See the EnvironmentMetrics schema for details on this property. | ||
} | string | Link to a EnvironmentMetrics resource. See the Links section and the EnvironmentMetrics schema for details. | |
string (enum) | Error correction scheme supported for this memory device. For the possible property values, see ErrorCorrection in Property details. | ||
string | Version of API supported by the firmware. | ||
string | Revision of firmware on the memory controller. | ||
array (string) | Function classes by the memory device. Deprecated in v1.3 and later. This property has been deprecated in favor of OperatingMemoryModes at the root of the resource, or MemoryClassification found within RegionSet. | ||
boolean | An indication of whether rank spare is enabled for this memory device. | ||
boolean | An indication of whether a spare device is enabled for this memory device. | ||
object | The links to other resources that are related to this resource. | ||
| object | The link to the chassis that contains this memory device. See the Chassis schema for details on this property. | |
} | string | Link to a Chassis resource. See the Links section and the Chassis schema for details. | |
| object | See the Oem object definition in the Common properties section. | |
| array | An array of links to the processors associated with this memory device. | |
} ] } | string | Link to a Processor resource. See the Links section and the Processor schema for details. | |
object | The location of the memory device. For property details, see Location. | ||
boolean | An indicator allowing an operator to physically locate this resource. | ||
integer (mebibytes) | Total size of the logical memory in MiB. | ||
string | The memory device manufacturer. | ||
array (milliWatts) (integer) | Set of maximum power budgets supported by the memory device in milliwatts. | ||
array | An array of DSP0274-defined measurement blocks. | ||
} ] | string | Link to a MeasurementBlock resource. See the Links section and the SoftwareInventory schema for details. | |
string (enum) | Type details of the memory device. For the possible property values, see MemoryDeviceType in Property details. | ||
object | Memory connection information to sockets and memory controllers. | ||
| integer | The channel number to which the memory device is connected. | |
| integer | The memory controller number to which the memory device is connected. | |
| integer | The slot number to which the memory device is connected. | |
} | integer | The socket number to which the memory device is connected. | |
array (string (enum)) | Media of this memory device. For the possible property values, see MemoryMedia in Property details. | ||
string | The manufacturer ID of the memory subsystem controller of this memory device. | ||
string | The product ID of the memory subsystem controller of this memory device. | ||
string (enum) | The type of memory device. For the possible property values, see MemoryType in Property details. | ||
object | The link to the metrics associated with this memory device. See the MemoryMetrics schema for details on this property. | ||
} | string | Link to a MemoryMetrics resource. See the Links section and the MemoryMetrics schema for details. | |
string | The product model number of this device. | ||
string | The manufacturer ID of this memory device. | ||
string | The product ID of this memory device. | ||
integer (mebibytes) | Total size of the non-volatile portion memory in MiB. | ||
array (string (enum)) | Memory modes supported by the memory device. For the possible property values, see OperatingMemoryModes in Property details. | ||
integer (MHz) | Operating speed of the memory device in MHz or MT/s as appropriate. | ||
string | The product part number of this device. | ||
integer | Total number of persistent regions this memory device can support. | ||
integer (mebibytes) | Total size of persistent regions in mebibytes (MiB). | ||
integer (mebibytes) | Maximum size of a single persistent region in mebibytes (MiB). | ||
object | Power management policy information. | ||
| integer (milliWatts) | Average power budget, in milliwatts. | |
| integer (milliWatts) | Maximum TDP in milliwatts. | |
| integer (milliWatts) | Peak power budget, in milliwatts. | |
} | boolean | An indication of whether the power management policy is enabled. | |
integer | Number of ranks available in the memory device. | ||
array | Memory regions information within the memory device. | ||
| string (enum) | The classification of memory that the memory region occupies. For the possible property values, see MemoryClassification in Property details. | |
| integer (mebibytes) | Offset within the memory that corresponds to the start of this memory region in mebibytes (MiB). | |
| boolean | An indication of whether the passphrase is enabled for this region. | |
| boolean | An indication of whether the state of the passphrase for this region is enabled. Deprecated in v1.5 and later. This property has been deprecated in favor of PassphraseEnabled found within RegionSet. | |
| string | Unique region ID representing a specific region within the memory device. | |
} ] | integer (mebibytes) | Size of this memory region in mebibytes (MiB). | |
object | Security capabilities of the memory device. | ||
| boolean | An indication of whether this memory device supports the locking, or freezing, of the configuration. | |
| boolean | An indication of whether this memory device supports data locking. | |
| integer | Maximum number of passphrases supported for this memory device. | |
| boolean | An indication of whether the memory device is passphrase capable. | |
| integer | The maximum number of incorrect passphrase attempts allowed before memory device is locked. | |
} | array (string (enum)) | Security states supported by the memory device. For the possible property values, see SecurityStates in Property details. Deprecated in v1.7 and later. This property has been deprecated in favor of using the individual PassphraseCapable, DataLockCapable and ConfigurationLockCapable properties. | |
string (enum) | The current security state of this memory device. For the possible property values, see SecurityState in Property details. | ||
string | The product serial number of this device. | ||
integer | Number of unused spare devices available in the memory device. | ||
string | The spare part number of the memory. | ||
object | The status and health of the resource and its subordinate or dependent resources. For property details, see Status. | ||
string | Subsystem device ID. Deprecated in v1.3 and later. This property has been deprecated in favor of MemorySubsystemControllerProductID. | ||
string | SubSystem vendor ID. Deprecated in v1.3 and later. This property has been deprecated in favor of MemorySubsystemControllerManufacturerID. | ||
string | Vendor ID. Deprecated in v1.3 and later. This property has been deprecated in favor of ModuleManufacturerID. | ||
integer | Total number of volatile regions this memory device can support. | ||
integer (mebibytes) | Total size of volatile regions in mebibytes (MiB). | ||
integer (mebibytes) | Maximum size of a single volatile region in mebibytes (MiB). | ||
integer (mebibytes) | Total size of the volatile portion memory in MiB. |
Disable passphrase for given regions.
Action URI: {Base URI of target resource}/Actions/Memory.DisablePassphrasePerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| string | | Passphrase for doing the operation. |
} | string | | The memory region ID to which to apply this action. |
This contains the action for securely erasing given regions using the NIST SP800-88 Purge: Overwrite.
Action URI: {Base URI of target resource}/Actions/Memory.OverwriteUnitPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| string | | Passphrase for doing the operation. |
} | string | | The memory region ID to which to apply this action. |
This action resets this memory device.
Action URI: {Base URI of target resource}/Actions/Memory.ResetPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
} | string (enum) | optional | The type of reset. For the possible property values, see ResetType in Property details. |
This contains the action for securely erasing given regions using the NIST SP800-88 Purge: Cryptographic Erase.
Action URI: {Base URI of target resource}/Actions/Memory.SecureEraseUnitPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| string | | Passphrase for doing the operation. |
} | string | | The memory region ID to which to apply this action. |
Set passphrase for the given regions.
Action URI: {Base URI of target resource}/Actions/Memory.SetPassphrasePerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| string | | Passphrase for doing the operation. |
} | string | | The memory region ID to which to apply this action. |
This contains the action for unlocking given regions.
Action URI: {Base URI of target resource}/Actions/Memory.UnlockUnitPerform the action using a POST to the specific Action URI for this resource. Parameters for the action are passed in a JSON body and are defined as follows:
{ | |||
| string | | The passphrase required to complete the operation. |
} | string | | The memory region ID to which to apply this action. |
The base module type of the memory device.
string | Description |
---|---|
Die (v1.7+) | A die within a package. |
LRDIMM | Load Reduced. |
Mini_RDIMM | Mini_RDIMM. |
Mini_UDIMM | Mini_UDIMM. |
RDIMM | Registered DIMM. |
SO_DIMM | SO_DIMM. |
SO_DIMM_16b | SO_DIMM_16b. |
SO_DIMM_32b | SO_DIMM_32b. |
SO_RDIMM_72b | SO_RDIMM_72b. |
SO_UDIMM_72b | SO_UDIMM_72b. |
UDIMM | UDIMM. |
Error correction scheme supported for this memory device.
string | Description |
---|---|
AddressParity | Address parity errors can be corrected. |
MultiBitECC | Multibit data errors can be corrected by ECC. |
NoECC | No ECC available. |
SingleBitECC | Single bit data errors can be corrected by ECC. |
The classification of memory that the memory region occupies.
string | Description |
---|---|
Block | Block-accessible memory. |
ByteAccessiblePersistent | Byte-accessible persistent memory. |
Volatile | Volatile memory. |
Type details of the memory device.
string | Description |
---|---|
DDR | DDR. |
DDR2 | DDR2. |
DDR2_SDRAM | DDR2 SDRAM. |
DDR2_SDRAM_FB_DIMM | DDR2 SDRAM FB_DIMM. |
DDR2_SDRAM_FB_DIMM_PROBE | DDR2 SDRAM FB_DIMM PROBE. |
DDR3 | DDR3. |
DDR3_SDRAM | DDR3 SDRAM. |
DDR4 | DDR4. |
DDR4_SDRAM | DDR4 SDRAM. |
DDR4E_SDRAM | DDR4E SDRAM. |
DDR5 (v1.11+) | Double data rate type five synchronous dynamic random-access memory. |
DDR_SDRAM | DDR SDRAM. |
DDR_SGRAM | DDR SGRAM. |
EDO | EDO. |
FastPageMode | Fast Page Mode. |
GDDR (v1.11+) | Synchronous graphics random-access memory. |
GDDR2 (v1.11+) | Double data rate type two synchronous graphics random-access memory. |
GDDR3 (v1.11+) | Double data rate type three synchronous graphics random-access memory. |
GDDR4 (v1.11+) | Double data rate type four synchronous graphics random-access memory. |
GDDR5 (v1.11+) | Double data rate type five synchronous graphics random-access memory. |
GDDR5X (v1.11+) | Double data rate type five X synchronous graphics random-access memory. |
GDDR6 (v1.11+) | Double data rate type six synchronous graphics random-access memory. |
HBM (v1.7+) | High Bandwidth Memory. |
HBM2 (v1.7+) | The second generation of High Bandwidth Memory. |
HBM3 (v1.11+) | The third generation of High Bandwidth Memory. |
Logical (v1.4+) | Logical Non-volatile device. |
LPDDR3_SDRAM | LPDDR3 SDRAM. |
LPDDR4_SDRAM | LPDDR4 SDRAM. |
OEM (v1.11+) | OEM-defined. |
PipelinedNibble | Pipelined Nibble. |
ROM | ROM. |
SDRAM | SDRAM. |
Media of this memory device.
string | Description |
---|---|
DRAM | DRAM media. |
Intel3DXPoint | Intel 3D XPoint media. |
NAND | NAND media. |
Proprietary | Proprietary media. |
The type of memory device.
string | Description |
---|---|
DRAM | The memory device is comprised of volatile memory. |
IntelOptane (v1.6+) | The memory device is an Intel Optane Persistent Memory Module. |
NVDIMM_F | The memory device is comprised of non-volatile memory. |
NVDIMM_N | The memory device is comprised of volatile memory backed by non-volatile memory. |
NVDIMM_P | The memory device is comprised of a combination of non-volatile and volatile memory. |
Memory modes supported by the memory device.
string | Description |
---|---|
Block | Block-accessible system memory. |
PMEM | Persistent memory, byte-accessible through system address space. |
Volatile | Volatile memory. |
The type of reset.
string | Description |
---|---|
ForceOff | Turn off the unit immediately (non-graceful shutdown). |
ForceOn | Turn on the unit immediately. |
ForceRestart | Shut down immediately and non-gracefully and restart the system. |
GracefulRestart | Shut down gracefully and restart the system. |
GracefulShutdown | Shut down gracefully and power off. |
Nmi | Generate a diagnostic interrupt, which is usually an NMI on x86 systems, to stop normal operations, complete diagnostic actions, and, typically, halt the system. |
On | Turn on the unit. |
PowerCycle | Power cycle the unit. Behaves like a full power removal, followed by a power restore to the resource. |
PushPowerButton | Simulate the pressing of the physical power button on this unit. |
The current security state of this memory device.
string | Description |
---|---|
Disabled | Secure mode is disabled. |
Enabled | Secure mode is enabled and access to the data is allowed. |
Frozen (deprecated v1.7) | Secure state is frozen and cannot be modified until reset. This value has been deprecated in favor of using the ConfigurationLocked to indicate that the configuration has been frozen. |
Locked | Secure mode is enabled and access to the data is locked. |
Passphraselimit | Number of attempts to unlock the memory exceeded limit. |
Unlocked (deprecated v1.7) | Secure mode is enabled and access to the data is unlocked. This value has been deprecated in favor of 'Enabled' to indicate normal security operation. |
Security states supported by the memory device.
string | Description |
---|---|
Disabled | Secure mode is disabled. |
Enabled | Secure mode is enabled and access to the data is allowed. |
Frozen | Secure state is frozen and cannot be modified until reset. |
Locked | Secure mode is enabled and access to the data is locked. |
Passphraselimit | Number of attempts to unlock the memory exceeded limit. |
Unlocked | Secure mode is enabled and access to the data is unlocked. |
{ "@odata.type": "#Memory.v1_11_0.Memory", "Name": "Regular Memory", "Id": "1", "RankCount": 1, "MaxTDPMilliWatts": [ 12000 ], "CapacityMiB": 8192, "DataWidthBits": 64, "BusWidthBits": 72, "ErrorCorrection": "MultiBitECC", "MemoryLocation": { "Socket": 1, "MemoryController": 1, "Channel": 1, "Slot": 1 }, "MemoryType": "DRAM", "MemoryDeviceType": "DDR4", "BaseModuleType": "RDIMM", "MemoryMedia": [ "DRAM" ], "Status": { "State": "Enabled", "Health": "OK" }, "Metrics": { "@odata.id": "/redfish/v1/Systems/437XR1138R2/Memory/1/MemoryMetrics" }, "EnvironmentMetrics": { "@odata.id": "/redfish/v1/Systems/437XR1138R2/Memory/1/EnvironmentMetrics" }, "Location": { "PartLocation": { "ServiceLabel": "Socket 1_A", "LocationType": "Socket", "LocationOrdinalValue": 0 } }, "@odata.id": "/redfish/v1/Systems/437XR1138R2/Memory/1" }
v1.4 | v1.3 | v1.2 | v1.1 | v1.0 |
2020.3 | 2019.4 | 2017.3 | 2017.1 | 2016.2 |
The schema definition of a memory chunk and its configuration.