1 Overview
The Redfish standard comprises a set of specifications maintained by the Redfish Forum, a working group within 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 for data payloads.
1.1 Who should read this document?
This document is for Redfish service developers or application software developers that interface with a Redfish service. This document includes the informative and normative descriptions copied from the description and long description annotations in the Redfish Schema Bundle (DSP8010), and adds supplemental normative text to further explain the usage of particular properties or resources.
If mistakes or discrepancies arise in this document, the Redfish Schema Bundle (DSP8010) is the primary normative document.
1.2 How can I provide feedback?
Feedback on all Redfish specifications and documents is encouraged. Feedback can be directed to DMTF and the Redfish Forum by the following means:
- Redfish User Forum: https://redfishforum.com - User forum monitored by DMTF Redfish Forum personnel to answer questions about any Redfish-related topics.
- DMTF Feedback Portal: https://www.dmtf.org/standards/feedback - Formal submission portal for enhancements or proposals to DMTF and the Redfish Forum.
1.3 Where can I find more information?
The following web sites provide more information about the Redfish standard:
-
Resources for developers who use Redfish to build applications. Contains an interactive schema explorer, hosted schema, and other links.
-
DMTF Redfish-monitored user forum. Answers questions about Redfish-related topics.
-
Open source tools and libraries for working with Redfish.
-
Schemas, specifications, mockups, white papers, FAQ, educational material, and more.
-
Working group that maintains the Redfish standard. Site lists member companies, future work and schedules, charter, and information about joining.
1.4 Related documents
The following documents are part of the Redfish development effort. They can be accessed or downloaded from DMTF's Redfish Standards web site: https://www.dmtf.org/standards/redfish
- DSP0218 - Platform Level Data Model (PLDM) for Redfish Device Enablement Specification - Binary-encoded JSON (BEJ) and dictionary-based mapping of Redfish schemas and properties into PLDM messages.
- DSP0266 - Redfish Specification - Main Redfish Specification.
- DSP0268 - Redfish Data Model Specification - Normative descriptions and additional text for every schema defined in DSP8010 and example payloads for every resource.
- DSP0270 - Redfish Host Interface Specification - "In-band" or "OS-based" Redfish host interface.
- DSP0272 - Redfish Interoperability Profiles Specification - Structure and JSON document that is used to define and publish an interoperability profile that checks an implementation's conformance to a defined minimum set of functionality.
- DSP2043 - Redfish Mockups Bundle - Set of mockups that can be used as sample output from
GETresponses from a Redfish service. Informative in nature, it was used to develop the schema. A person can set up an NGINX or similar server and configure it to output JSON format and then use this directory for demonstration purposes. - DSP2044 - Redfish White Paper - Non-normative document helping those new to Redfish understand how to interact with the Redfish service and understand common functions and tasks.
- DSP2046 - Redfish Resource and Schema Guide - Informative documentation regarding common Redfish resource properties and a listing of properties that can be found in each of the Redfish resources.
- DSP2053 - Redfish Property Guide - Informative documentation providing an index to individual property definitions across all Redfish schema.
- DSP2065 - Redfish Message Registry Guide - Informative documentation providing details regarding the messages defined in Redfish standard message registries.
- DSP8010 - Redfish Schema - Redfish schema definitions. These files are normative in nature and are normatively referenced by the Redfish Specification. The three schema formats are CSDL (OData Common Schema Definition Language format, which is in XML), JSON Schema, and OpenAPI schema. These schema definitions should be functionally equivalent, thus specifying the schema in three different languages.
- DSP8011 - Redfish Standard Registries - Redfish registry definitions. This bundle of Redfish registries includes message registries used for Redfish-defined messages including events and privilege maps.
- DSP8013 - Redfish Interoperability Profiles Bundle - Bundle of published Redfish interoperability profile documents and supporting schema and sample documents used for creating profiles.
1.5 Terms, definitions, symbols, and abbreviated terms
Some terms and phrases in this document have specific meanings beyond their typical English meanings. This clause defines those terms and phrases.
The terms "shall" ("required"), "shall not", "should" ("recommended"), "should not" ("not recommended"), "may", "need not" ("not required"), "can" and "cannot" in this document are to be interpreted as described in ISO/IEC Directives, Part 2, Clause 7. The terms in parenthesis are alternatives for the preceding term, for use in exceptional cases when the preceding term cannot be used for linguistic reasons. Note that ISO/IEC Directives, Part 2, Clause 7 specifies additional alternatives. Occurrences of such additional alternatives shall be interpreted in their normal English meaning.
The terms "clause", "subclause", "paragraph", and "annex" in this document are to be interpreted as described in ISO/IEC Directives, Part 2, Clause 6.
The terms "normative" and "informative" in this document are to be interpreted as described in ISO/IEC Directives, Part 2, Clause 3. In this document, clauses, subclauses, or annexes labeled "(informative)" do not contain normative content. Notes and examples are always informative elements.
The term "deprecated" in this document is to be interpreted as material that is not recommended for use in new development efforts. Existing and new implementations may use this material, but they should move to the favored approach. Deprecated material may be implemented in order to achieve backwards compatibility. Deprecated material should contain references to the last published version that included the deprecated material as normative material and to a description of the favored approach. Deprecated material may be removed from the next major version of the specification.
2 Using this document
Every Redfish response consists of a JSON payload containing properties that are strictly defined by a schema for that resource. The schema that defines a resource can be determined from the value of the @odata.type property returned in every Redfish response. This document details the definitions for every Redfish standard schema.
Each schema section contains:
- The name, current version, and description of the schema.
- The release history of the schema. Lists each minor schema version and the DSP8010 release bundle that included it.
- List of the possible URIs where schema-defined resources can appear in a Redfish service following specification version v1.6 or later. See URI listings.
- Table that defines each property. Shows additional details for those properties when needed.
- List of available actions defined for the schema.
- Example JSON payload for a resource using the schema.
The property-level details include:
| Column | Purpose |
|---|---|
| Property | 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.
|
| Attributes | Designates whether:
|
| Descriptions | The descriptions of the property, as copied directly from the schema's definition of the property. The informational description of the property is listed first. The normative "long description" is shown as a separate, bulleted list. |
2.1 URI listings
The Redfish Specification v1.6.0 added mandatory support for the OpenAPI Specification v3.0. 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.
Support for v1.6.0 and OpenAPI can be determined by comparing the value of the RedfishVersion property in the service root (/redfish/v1/). Services that report a 1.6.0 or higher value, such as 1.6.1 or 1.7.0, adhere to the URI definitions.
The URI listings do not apply to Redfish services that support specification versions earlier than v1.6.0. For those services, clients must use the hypermedia features of the API to discover hyperlinks from the service root to each resource. While services typically match the URIs listed in this document for many of their resources, this match is not guaranteed and results in errors.
3 Common properties
3.1 Properties that all Redfish schemas define
The following properties are defined for inclusion in every Redfish schema and therefore may be encountered in any response payload. They are documented here in this guide to avoid repetition in the Reference guide property tables.
Note: Several of these properties are payload annotations but appear here because they are required for all Redfish resources.
3.1.1 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| @odata.context | string (URI) |
read-only | The value of this property shall be the context URL that describes the resource according to OData-Protocol and shall be of the form defined in the Redfish specification. |
| @odata.etag | string | read-only | The value of this property shall be a string that is defined by the ETag HTTP header definition in RFC7232. |
| @odata.id | string (URI) |
read-only required | The value of this property shall be the unique identifier for the resource and it shall be of the form defined in the Redfish specification. |
| @odata.type | string | read-only required | The value of this property shall be a URI fragment that specifies the type of the resource and it shall be of the form defined in the Redfish specification. |
| Description | string | read-only | This property shall contain the description of this resource. The value shall conform with the 'Description' clause of the Redfish Specification. |
| Id | string | read-only required | This property shall contain the identifier for this resource. The value shall conform with the 'Id' clause of the Redfish Specification. |
| Name | string | read-only required | This property shall contain the name of this resource or array member. The value shall conform with the 'Name' clause of the Redfish Specification. |
| Oem {} | object | The manufacturer- or provider-specific extension moniker that divides the Oem object into sections. |
3.2 Frequently used properties
In addition, the following properties are frequently defined in Redfish schemas. Their definition and usage is the same throughout the Redfish data model.
3.2.1 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Actions {} | object | The Redfish actions available for this Resource. | |
| Links {} | 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. | |
| RelatedItem [ { | 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 might 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. | |
| @odata.id | string (URI) |
read-only | The value of this property shall be the unique identifier for the resource and it shall be of the form defined in the Redfish specification. |
| } ] |
3.3 Payload annotations
Payload annotations are a mechanism in which a service provides additional information about a given property or object. Redfish limits usage of these annotations to OData core terms, Redfish extensions, or Redfish messages.
3.3.1 Property-level annotations
A payload annotation for a single property takes the form of an additional property named Property@Schema.Term, where Property is the JSON property being annotated, Schema is the schema file where the definition for the annotation is found, and Term is the name of the annotation.
3.3.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| @Message.ExtendedInfo {} | 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. |
|
| @odata.count | integer | read-only | The value of this property shall be an integer representing the number of items in a collection. |
| @Redfish.AllowableNumbers [ ] | array (string) | read-only | The numeric values or duration values, inclusive ranges of values, and (optional) incremental step values for a read-write property or action parameter, in a <min>:<max>:<step> format. |
| @Redfish.AllowablePattern | string | read-only | A regular expression that describes the allowable values for a read-write property or action parameter as supported by the service. |
| @Redfish.AllowableValues [ ] | array (string) | read-only | The string values that a service accepts for a property or action parameter. |
| @Redfish.Deprecated | string | read-only | Specifies that the property or value is deprecated. The string value explains the deprecation, including new property or properties or value to use. |
In the following example, the property ResetType is annotated with the Redfish schema-defined AllowableValues term. Redfish is an alias for RedfishExtensions. This term indicates to the client that the service supports the values On and ForceOff for ResetType.
{
"ResetType@Redfish.AllowableValues": [
"On",
"ForceOff"
]
}3.3.3 Resource-level or object-level annotations
A payload annotation for an entire Resource or a JSON object takes the @Schema.Term form, where Schema 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.
3.3.4 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| @Redfish.ActionInfo | string (URI) |
read-only | The URI to an ActionInfo Resource, which describes the parameters that this Action instance supports. |
| @Redfish.CollectionCapabilities {} | object | This type shall describe any capabilities of a resource collection in terms of how a client can create resources within the resource collection. For property details, see CollectionCapabilities. | |
| @Redfish.MaintenanceWindow {} | object | This type shall indicate that a resource has a maintenance window assignment for applying settings or operations. Other resources can link to this object to convey a common control surface for the configuration of the maintenance window. For property details, see MaintenanceWindow. | |
| @Redfish.OperationApplyTime | string (enum) |
read-write | 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. |
| @Redfish.OperationApplyTimeSupport {} | object | This type shall indicate that a client can request a specific apply time of a create, delete, or action operation of a resource. For property details, see OperationApplyTimeSupport. | |
| @Redfish.Settings {} | object | This type shall describe any settings of a resource. For property details, see Settings. | |
| @Redfish.SettingsApplyTime {} | object | This type shall be specified by client to indicate the preferred time to apply the configuration settings. For property details, see PreferredApplyTime. | |
| @Redfish.WriteableProperties [ ] | array (string) | read-only | Specifies the properties supported as read-write. The values contained are the names of the writable properties as defined in the Redfish schema that are available as read-write given the implementation, current configuration, and state of the resource. |
3.3.5 Property details
3.3.5.1 @Redfish.OperationApplyTime
The client's requested apply time to complete a create, delete, or action operation.
| string | Description |
|---|---|
| AtMaintenanceWindowStart | This value shall indicate the requested create, delete, or action operation is applied during the maintenance window that the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties specify. A service can complete resets during this maintenance window. |
| Immediate | This value shall indicate the requested create, delete, or action operation is applied immediately. This value may result in an immediate host reset, manager reset, or other side effects. |
| InMaintenanceWindowOnReset | This value shall indicate the requested create, delete, or action operation is applied during the maintenance window that the MaintenanceWindowStartTime and MaintenanceWindowDurationInSeconds properties specify, and if a reset occurs within the maintenance window. |
| OnReset | This value shall indicate the requested create, delete, or action operation is applied when the system or service is reset. |
| OnStartUpdateRequest | This value shall indicate the requested create, delete, or action operation is applied when the StartUpdate action of the update service is invoked. |
| OnTargetReset | This value shall indicate the requested create, delete, or action operation is applied when the target is reset. |
This example annotates the object with the Redfish schema-defined action info 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"
}
}4 Common objects
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.
4.1 Actions
The Actions object contains the available actions for a resource.
4.1.1 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| #{action name} { | object | A single Redfish action. | |
| @Redfish.ActionInfo | string | read-only | The URI for an ActionInfo Resource that describes this action. |
| target | string | read-only | The target URI for the POST operation to invoke the action. |
| } |
4.2 Capacity
4.2.1 Description
This is the schema definition for the Capacity of a device. It represents the properties for capacity for any data store.
- This composition may be used to represent storage capacity. The sum of the values in Data, Metadata, and Snapshot shall be equal to the total capacity for the data store.
4.2.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Data { | object | The capacity information relating to the user data.
|
|
| AllocatedBytes | integer (bytes) |
read-write (null) |
The number of bytes currently allocated by the storage system in this data store for this data type.
|
| ConsumedBytes | integer (bytes) |
read-only (null) |
The number of bytes consumed in this data store for this data type.
|
| GuaranteedBytes | integer (bytes) |
read-write (null) |
The number of bytes the storage system guarantees can be allocated in this data store for this data type.
|
| ProvisionedBytes | integer (bytes) |
read-write (null) |
The maximum number of bytes that can be allocated in this data store for this data type.
|
| } | |||
| IsThinProvisioned | boolean | read-only (null) |
Marks that the capacity is not necessarily fully allocated.
|
| Metadata { | object | The capacity information relating to metadata.
|
|
| AllocatedBytes | integer (bytes) |
read-write (null) |
The number of bytes currently allocated by the storage system in this data store for this data type.
|
| ConsumedBytes | integer (bytes) |
read-only (null) |
The number of bytes consumed in this data store for this data type.
|
| GuaranteedBytes | integer (bytes) |
read-write (null) |
The number of bytes the storage system guarantees can be allocated in this data store for this data type.
|
| ProvisionedBytes | integer (bytes) |
read-write (null) |
The maximum number of bytes that can be allocated in this data store for this data type.
|
| } | |||
| Snapshot { | object | The capacity information relating to snapshot or backup data.
|
|
| AllocatedBytes | integer (bytes) |
read-write (null) |
The number of bytes currently allocated by the storage system in this data store for this data type.
|
| ConsumedBytes | integer (bytes) |
read-only (null) |
The number of bytes consumed in this data store for this data type.
|
| GuaranteedBytes | integer (bytes) |
read-write (null) |
The number of bytes the storage system guarantees can be allocated in this data store for this data type.
|
| ProvisionedBytes | integer (bytes) |
read-write (null) |
The maximum number of bytes that can be allocated in this data store for this data type.
|
| } |
4.3 Condition
4.3.1 Description
A condition that requires attention.
- This type shall contain the description and details of a condition that exists within this resource or a related resource that requires attention.
4.3.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| LogEntry { | object | The link to the log entry created for this condition.
|
|
| @odata.id | string | read-only | Link to a LogEntry resource. See the Links section and the LogEntry schema for details. |
| } | |||
| Message | string | read-only | The human-readable message for this condition.
|
| MessageArgs [ ] | array (string) | read-only | An array of message arguments that are substituted for the arguments in the message when looked up in the message registry.
|
| MessageId | string | read-only required | The identifier for the message.
|
| OriginOfCondition { | object | A link to the resource or object that originated the condition.
|
|
| @odata.id | string (URI) |
read-only | The unique identifier for a resource.
|
| } | |||
| Resolution (v1.14+) | string | read-only | Suggestions on how to resolve the condition.
|
| ResolutionSteps (v1.18+) [ { } ] | array (object) | This type describes a recommended step of the service-defined resolution.
|
|
| Severity | string (enum) |
read-only | The severity of the condition.
|
| Timestamp | string (date-time) |
read-only | The time the condition occurred.
|
| UserAuthenticationSource (v1.20+) | string | read-only (null) |
The source of authentication for the username property associated with the condition.
|
| Username (v1.20+) | string | read-only (null) |
The username of the account associated with the condition.
|
4.3.3 Property details
4.3.3.1 Severity
The severity of the condition.
- This property shall contain the severity of the condition. Services can replace the value defined in the message registry with a value more applicable to the implementation.
| string | Description |
|---|---|
| Critical | A critical condition requires immediate attention. |
| OK | Normal. |
| Warning | A condition requires attention. |
4.4 Identifier
4.4.1 Description
Any additional identifiers for a resource.
- This type shall contain any additional identifiers for a resource.
4.4.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| DurableName (v1.1+) | string | read-only (null) |
The world-wide, persistent name of the resource.
|
| DurableNameFormat (v1.1+) | string (enum) |
read-only (null) |
The format of the durable name property.
|
4.4.3 Property details
4.4.3.1 DurableNameFormat
The format of the durable name property.
- This property shall represent the format of the
DurableNameproperty.
| string | Description |
|---|---|
| EUI | The IEEE-defined 64-bit Extended Unique Identifier (EUI).
|
| FC_WWN | The Fibre Channel (FC) World Wide Name (WWN).
|
| GCXLID (v1.15+) | The globally unique CXL logical device identifier (GCXLID).
|
| iQN | The iSCSI Qualified Name (iQN).
|
| MACAddress (v1.14+) | The media access control address (MAC address).
|
| 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+, deprecated v1.12) | The NVM Namespace Identifier (NSID).
NGUID should be used. |
| UUID | The Universally Unique Identifier (UUID).
|
4.5 IOStatistics
4.5.1 Description
The properties of this type represent IO statistics.
- The properties of this type shall be used to represent the IO statistics of the requested object.
4.5.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| @odata.id | string | read-only | Link to another IOStatistics resource. |
4.6 IPv4Address
4.6.1 Description
This type describes an IPv4 address.
- This type shall describe an IPv4 address assigned to an interface.
4.6.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Address | string | read-write (null) |
The IPv4 address.
^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$ |
| AddressOrigin | string (enum) |
read-only (null) |
This indicates how the address was determined.
|
| Gateway | string | read-write (null) |
The IPv4 gateway for this address.
^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$ |
| Oem {} | object | See the OEM object definition in the Using this guide clause. | |
| SubnetMask | string | read-write (null) |
The IPv4 subnet mask.
^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$ |
4.6.3 Property details
4.6.3.1 AddressOrigin
This indicates how the address was determined.
- This property shall contain the IP address origin for this network interface.
| 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. |
4.7 IPv6Address
4.7.1 Description
This type describes an IPv6 address.
- This type shall describe an IPv6 address assigned to an interface.
4.7.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Address | string | read-write (null) |
The IPv6 address.
|
| AddressOrigin | string (enum) |
read-only (null) |
This indicates how the address was determined.
|
| AddressState | string (enum) |
read-only (null) |
The current RFC4862-defined state of this address.
|
| Oem {} | object | See the OEM object definition in the Using this guide clause. | |
| PrefixLength | integer | read-only (null) |
The IPv6 address prefix Length.
|
4.7.3 Property details
4.7.3.1 AddressOrigin
This indicates how the address was determined.
- This property shall contain the IPv6 address origin for this interface.
| 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. |
4.7.3.2 AddressState
The current RFC4862-defined state of this address.
- This property shall contain the current RFC4862-defined state of this address. Preferred and Deprecated states follow the definitions in RFC4862, section 5.5.4. The Tentative state indicates that the address is undergoing Duplicate Address Detection (DAD), as defined in RFC4862, section 5.4. The Failed state indicates a static address that did not pass DAD. A static address in the Failed state is not in use on the network stack, and corrective action is required to remedy this condition.
| 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. |
4.8 IPv6GatewayStaticAddress
4.8.1 Description
This type represents a single IPv6 static address to be assigned on a network interface.
- This type shall represent a single IPv6 static address to be assigned on a network interface.
4.8.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Address (v1.1+) | string | read-write required (null) |
A valid IPv6 address.
|
| Oem (v1.1+) {} | object | See the OEM object definition in the Using this guide clause. | |
| PrefixLength (v1.1+) | integer | read-write (null) |
The IPv6 network prefix length, in bits, for this address.
|
4.9 IPv6StaticAddress
4.9.1 Description
This type represents a single IPv6 static address to be assigned on a network interface.
- This type shall represent a single IPv6 static address to be assigned on a network interface.
4.9.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Address | string | read-write required (null) |
A valid IPv6 address.
|
| Oem {} | object | See the OEM object definition in the Using this guide clause. | |
| PrefixLength | integer | read-write required (null) |
The prefix length, in bits, of this IPv6 address.
|
4.10 Location
4.10.1 Description
The location of a resource.
- This type shall describe the location of a resource.
4.10.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| AltitudeMeters (v1.6+) | number (meters) |
read-write (null) |
The altitude of the resource in meters.
|
| Contacts (v1.7+) [ { | array | An array of contact information.
|
|
| ContactName (v1.7+) | string | read-write (null) |
Name of this contact.
|
| EmailAddress (v1.7+) | string | read-write (null) |
Email address for this contact.
|
| PhoneNumber (v1.7+) | string | read-write (null) |
Phone number for this contact.
|
| } ] | |||
| Info (v1.1+, deprecated v1.5) | string | read-only (null) |
The location of the resource.
PostalAddress, Placement, and PartLocation properties. |
| InfoFormat (v1.1+, deprecated v1.5) | string | read-only (null) |
The format of the Info property.
PostalAddress, Placement, and PartLocation properties. |
| Latitude (v1.6+) | number (deg) |
read-write (null) |
The latitude of the resource.
|
| Longitude (v1.6+) | number (deg) |
read-write (null) |
The longitude of the resource in degree units.
|
| Oem (v1.1+) { | object | See the OEM object definition in the Using this guide clause. | |
| (pattern) {} | object | Property names follow regular expression pattern "^[A-Za-z0-9_]+$" | |
| } | |||
| PartLocation (v1.5+) { | object | The part location for a resource within an enclosure.
|
|
| LocationOrdinalValue (v1.5+) | integer | read-only (null) |
The number that represents the location of the part. For example, if LocationType is Slot and this unit is in slot 2, the LocationOrdinalValue is 2.
|
| LocationType (v1.5+) | string (enum) |
read-only (null) |
The type of location of the part.
|
| Orientation (v1.5+) | string (enum) |
read-only (null) |
The orientation for the ordering of the slot enumeration used by the LocationOrdinalValue property.
|
| Reference (v1.5+) | string (enum) |
read-only (null) |
The reference point for the part location. Provides guidance about the general location of the part.
|
| ServiceLabel (v1.5+) | string | read-only (null) |
The label of the part location, such as a silk-screened name or a printed label.
|
| } | |||
| PartLocationContext (v1.16+) | string | read-only (null) |
Human-readable string to enable differentiation between PartLocation values for parts in the same enclosure, which might include hierarchical information of containing PartLocation values for the part.
|
| PhysicalAddress (v1.17+) { | object | The physical address for a resource.
|
|
| City (v1.17+) | string | read-write (null) |
City, township, or shi (JP).
|
| Country (v1.17+) | string | read-write (null) |
The country.
|
| ISOCountryCode (v1.17+) | string | read-write (null) |
The ISO 3166-1 country code.
^([A-Z]{2}|[A-Z]{3})$ |
| ISOSubdivisionCode (v1.17+) | string | read-write (null) |
ISO 3166-2 subdivision code.
^[A-Z0-9]{1,3}$ |
| PostalCode (v1.17+) | string | read-write (null) |
The postal code.
|
| StateOrProvince (v1.17+) | string | read-write (null) |
State or province.
|
| StreetAddress (v1.17+) | string | read-write (null) |
The street-level address, including building, room, or other identifiers.
|
| } | |||
| Placement (v1.3+) { | object | A place within the addressed location.
|
|
| AdditionalInfo (v1.7+) | string | read-write (null) |
Area designation or other additional info.
|
| Rack (v1.3+) | string | read-write (null) |
The name of a rack location within a row.
|
| RackOffset (v1.3+) | integer | read-write (null) |
The vertical location of the item, in terms of RackOffsetUnits.
|
| RackOffsetUnits (v1.3+) | string (enum) |
read-write (null) |
The type of rack units in use.
|
| Row (v1.3+) | string | read-write (null) |
The name of the row.
|
| } | |||
| PostalAddress (v1.3+, deprecated v1.17) { | object | The postal address of the addressed resource.
PhysicalAddress. |
|
| AdditionalCode (v1.3+) | string | read-write (null) |
The additional code.
|
| AdditionalInfo (v1.7+) | string | read-write (null) |
The room designation or other additional information.
|
| Building (v1.3+) | string | read-write (null) |
The name of the building.
|
| City (v1.3+) | string | read-write (null) |
City, township, or shi (JP).
|
| Community (v1.3+) | string | read-write (null) |
The postal community name.
|
| Country (v1.3+) | string | read-write (null) |
The country.
|
| District (v1.3+) | string | read-write (null) |
A county, parish, gun (JP), or district (IN).
|
| Division (v1.3+) | string | read-write (null) |
City division, borough, city district, ward, or chou (JP).
|
| Floor (v1.3+) | string | read-write (null) |
The floor.
|
| GPSCoords (v1.3+, deprecated v1.6) | string | read-write (null) |
The GPS coordinates of the part.
|
| HouseNumber (v1.3+) | integer | read-write (null) |
The numeric portion of house number.
|
| HouseNumberSuffix (v1.3+) | string | read-write (null) |
The house number suffix.
|
| Landmark (v1.3+) | string | read-write (null) |
The landmark.
|
| LeadingStreetDirection (v1.3+) | string | read-write (null) |
A leading street direction.
|
| Location (v1.3+, deprecated v1.7) | string | read-write (null) |
The room designation or other additional information.
AdditionalInfo property. |
| Name (v1.3+) | string | read-write (null) |
The name.
|
| Neighborhood (v1.3+) | string | read-write (null) |
Neighborhood or block.
|
| PlaceType (v1.3+) | string | read-write (null) |
The description of the type of place that is addressed.
|
| POBox (v1.3+) | string | read-write (null) |
The post office box (PO box).
|
| PostalCode (v1.3+) | string | read-write (null) |
The postal code or zip code.
|
| Road (v1.3+) | string | read-write (null) |
The primary road or street.
|
| RoadBranch (v1.3+) | string | read-write (null) |
The road branch.
|
| RoadPostModifier (v1.3+) | string | read-write (null) |
The road post-modifier.
|
| RoadPreModifier (v1.3+) | string | read-write (null) |
The road pre-modifier.
|
| RoadSection (v1.3+) | string | read-write (null) |
The road section.
|
| RoadSubBranch (v1.3+) | string | read-write (null) |
The road sub branch.
|
| Room (v1.3+) | string | read-write (null) |
The name or number of the room.
|
| Seat (v1.3+) | string | read-write (null) |
The seat, such as the desk, cubicle, or workstation.
|
| Street (v1.3+) | string | read-write (null) |
Street name.
|
| StreetSuffix (v1.3+) | string | read-write (null) |
Avenue, Platz, Street, Circle.
|
| Territory (v1.3+) | string | read-write (null) |
A top-level subdivision within a country.
|
| TrailingStreetSuffix (v1.3+) | string | read-write (null) |
A trailing street suffix.
|
| Unit (v1.3+) | string | read-write (null) |
The name or number of the apartment unit or suite.
|
| } |
4.10.3 Property details
4.10.3.1 LocationType
The type of location of the part.
- This property shall contain the type of location of the part.
| string | Description |
|---|---|
| Backplane (v1.12+) | A backplane.
|
| Bay | A bay.
|
| Connector | A connector or port.
|
| Embedded (v1.13+) | Embedded within a part.
|
| Slot | A slot.
|
| Socket | A socket.
|
4.10.3.2 Orientation
The orientation for the ordering of the slot enumeration used by the LocationOrdinalValue property.
- This property shall contain the orientation for the ordering used by the
LocationOrdinalValueproperty.
| 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.
|
4.10.3.3 RackOffsetUnits
The type of rack units in use.
- This property shall contain a RackUnit enumeration literal that indicates 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).
|
4.10.3.4 Reference
The reference point for the part location. Provides guidance about the general location of the part.
- This property shall contain the general location within the unit 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 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.
|
4.11 Message
4.11.1 Description
The message that the Redfish service returns.
- This type shall contain a message that the Redfish service returns, as described in the Redfish Specification.
4.11.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Message | string | read-only | The human-readable message.
|
| MessageArgs [ ] | array (string) | read-only | An array of message arguments that are substituted for the arguments in the message when looked up in the message registry.
|
| MessageId | string | read-only required | The identifier for the message.
|
| MessageSeverity (v1.1+) | string (enum) |
read-only | The severity of the message.
|
| Oem {} | object | See the OEM object definition in the Using this guide clause. | |
| RelatedProperties [ ] | array (string) | read-only | A set of properties described by the message.
|
| Resolution | string | read-only | Used to provide suggestions on how to resolve the situation that caused the message.
|
| ResolutionSteps (v1.2+) [ { } ] | array (object) | This type describes a recommended step of the service-defined resolution.
|
|
| Severity (deprecated v1.1) | string | read-only | The severity of the message.
MessageSeverity, which ties the values to the enumerations defined for the Health property within Status. |
| UserAuthenticationSource (v1.3+) | string | read-only (null) |
The source of authentication for the username property associated with the message.
|
| Username (v1.3+) | string | read-only (null) |
The username of the account associated with the message.
|
4.11.3 Property details
4.11.3.1 MessageSeverity
The severity of the message.
- This property shall contain the severity of the message. Services can replace the value defined in the message registry with a value more applicable to the implementation.
| string | Description |
|---|---|
| Critical | A critical condition requires immediate attention. |
| OK | Normal. |
| Warning | A condition requires attention. |
4.12 Redundancy
4.12.1 Description
The common redundancy definition and structure used in other Redfish schemas.
- This object represents the redundancy element property.
4.12.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| @odata.id | string (URI) |
read-only required | The unique identifier for a resource.
|
| Actions (v1.2+) {} | object | The available actions for this resource.
|
|
| MaxNumSupported | integer | read-only (null) |
The maximum number of members allowable for this particular redundancy group.
|
| MemberId | string | read-only required | The unique identifier for the member within an array.
|
| MinNumNeeded | integer | read-only required (null) |
The minimum number of members needed for this group to be redundant.
|
| Mode | string (enum) |
read-write required (null) |
The redundancy mode of the group.
|
| Name | string | read-only required | The name of the resource or array member.
|
| Oem {} | object | See the OEM object definition in the Using this guide clause. | |
| RedundancyEnabled (v1.1+) | boolean | read-write (null) |
An indication of whether redundancy is enabled.
|
| RedundancySet [ { | array | required | The links to components of this redundancy set.
|
| @odata.id | string (URI) |
read-only | The unique identifier for a resource.
|
| } ] | |||
| Status {} | object | required | The status and health of the resource and its subordinate or dependent resources.
|
4.12.3 Property details
4.12.3.1 Mode
The redundancy mode of the group.
- This property shall contain the information about the redundancy mode of this subsystem.
| 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. |
4.13 RedundantGroup
4.13.1 Description
The redundancy information for the devices in a redundancy group.
- This type shall contain redundancy information for the set of devices in this redundancy group.
4.13.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| MaxSupportedInGroup (v1.4+) | integer | read-only (null) |
The maximum number of devices supported in this redundancy group.
|
| MinNeededInGroup (v1.4+) | integer | read-only required (null) |
The minimum number of devices needed for this group to be redundant.
|
| RedundancyGroup (v1.4+) [ { | array | required | The links to the devices included in this redundancy group.
|
| @odata.id | string (URI) |
read-only | The unique identifier for a resource.
|
| } ] | |||
| RedundancyType (v1.4+) | string (enum) |
read-write required (null) |
The redundancy mode of the group.
|
| Status (v1.4+) {} | object | required | The status and health of the resource and its subordinate or dependent resources.
|
4.13.3 Property details
4.13.3.1 RedundancyType
The redundancy mode of the group.
- This property shall contain the information about the redundancy mode of this redundancy 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. |
4.14 ReplicaInfo
4.14.1 Description
Defines the characteristics of a replica of a source.
- The value shall define the characteristics of a replica of a source.
4.14.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| ConsistencyEnabled | boolean | read-only (null) |
True if consistency is enabled.
|
| ConsistencyState | string (enum) |
read-only (null) |
The current state of consistency.
|
| ConsistencyStatus | string (enum) |
read-only (null) |
The current status of consistency.
|
| ConsistencyType | string (enum) |
read-only (null) |
Indicates the consistency type used by the source and its associated target group.
|
| DataProtectionLineOfService (v1.1+) { | object | A pointer to the DataProtection line of service element that describes this replica.
|
|
| @odata.id | string (URI) |
read-only | The unique identifier for a resource.
|
| } | |||
| FailedCopyStopsHostIO | boolean | read-only (null) |
If true, the storage array tells host to stop sending data to source element if copying to a remote element fails.
|
| PercentSynced | integer (%) |
read-only (null) |
Specifies the percent of the work completed to reach synchronization.
|
| RemoteSourceReplica (v1.4+) | string | read-only (null) |
ReplicaFaultDomain describes the fault domain (local or remote) of the replica relationship.
|
| Replica { | object | Deprecated - Use Source Replica. The resource that is the source of this replica.
|
|
| @odata.id | string (URI) |
read-only | The unique identifier for a resource.
|
| } | |||
| ReplicaFaultDomain (v1.3+) | string (enum) |
read-only (null) |
ReplicaFaultDomain describes the fault domain (local or remote) of the replica relationship.
|
| ReplicaPriority | string (enum) |
read-only (null) |
The priority of background copy engine I/O to be managed relative to host I/O operations during a sequential background copy operation.
|
| ReplicaProgressStatus | string (enum) |
read-only (null) |
The status of the session with respect to Replication activity.
|
| ReplicaReadOnlyAccess | string (enum) |
read-only (null) |
This property specifies whether the source, the target, or both elements are read only to the host.
|
| ReplicaRecoveryMode | string (enum) |
read-only (null) |
Describes whether the copy operation continues after a broken link is restored.
|
| ReplicaRole | string (enum) |
read-only (null) |
The source or target role of this replica.
|
| ReplicaSkewBytes | integer (bytes) |
read-only (null) |
Applies to Adaptive mode and it describes maximum number of bytes the SyncedElement (target) can be out of sync.
|
| ReplicaState | string (enum) |
read-only (null) |
ReplicaState describes the state of the relationship with respect to Replication activity.
|
| ReplicaType | string (enum) |
read-only (null) |
ReplicaType describes the intended outcome of the replication.
|
| ReplicaUpdateMode | string (enum) |
read-only (null) |
Describes whether the target elements will be updated synchronously or asynchronously.
|
| RequestedReplicaState | string (enum) |
read-only (null) |
The last requested or desired state for the relationship.
|
| SourceReplica (v1.2+) { | object | The URI to the source replica when located on a different Swordfish service instance.
|
|
| @odata.id | string (URI) |
read-only | The unique identifier for a resource.
|
| } | |||
| SyncMaintained | boolean | read-only (null) |
Synchronization is maintained.
|
| UndiscoveredElement | string (enum) |
read-only (null) |
This property specifies whether the source, the target, or both elements involved in a copy operation are undiscovered.
|
| WhenActivated | string (%) |
read-only (null) |
Specifies when point-in-time copy was taken or when the replication relationship is activated, reactivated, resumed or re-established.
|
| WhenDeactivated | string (%) |
read-only (null) |
Specifies when the replication relationship is deactivated.
|
| WhenEstablished | string (%) |
read-only (null) |
Specifies when the replication relationship is established.
|
| WhenSuspended | string (%) |
read-only (null) |
Specifies when the replication relationship is suspended.
|
| WhenSynced | string | read-only (null) |
The point in time that the Elements were synchronized.
|
| WhenSynchronized | string (%) |
read-only (null) |
Specifies when the replication relationship is synchronized.
|
4.14.3 Property details
4.14.3.1 ConsistencyState
The current state of consistency.
- The ConsistencyState enumeration literal shall indicate the current state of consistency.
| string | Description |
|---|---|
| Consistent | Consistent.
|
| Inconsistent | Not consistent.
|
4.14.3.2 ConsistencyStatus
The current status of consistency.
- The ConsistencyStatus enumeration literal shall specify the current status of consistency. Consistency may have been disabled or is experiencing an error condition.
| string | Description |
|---|---|
| Consistent | Consistent.
|
| Disabled | Consistency disabled.
|
| InError | Consistency error.
|
| InProgress | Becoming consistent.
|
4.14.3.3 ConsistencyType
Indicates the consistency type used by the source and its associated target group.
- The ConsistencyType enumeration literal shall indicate the consistency type used by the source and its associated target group.
| string | Description |
|---|---|
| SequentiallyConsistent | Sequentially consistent.
|
4.14.3.4 ReplicaFaultDomain
ReplicaFaultDomain describes the fault domain (local or remote) of the replica relationship.
- The ReplicaFaultDomain enumeration literal shall describe 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.
|
4.14.3.5 ReplicaPriority
The priority of background copy engine I/O to be managed relative to host I/O operations during a sequential background copy operation.
- The enumeration literal shall specify 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.
|
4.14.3.6 ReplicaProgressStatus
The status of the session with respect to Replication activity.
- The ReplicaProgressStatus enumeration literal shall specify 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.
|
4.14.3.7 ReplicaReadOnlyAccess
This property specifies whether the source, the target, or both elements are read only to the host.
- The enumeration literal shall specify 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.
|
4.14.3.8 ReplicaRecoveryMode
Describes whether the copy operation continues after a broken link is restored.
- The enumeration literal shall specify 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.
|
4.14.3.9 ReplicaRole
The source or target role of this replica.
- The ReplicaRole enumeration literal shall represent the source or target role of this replica as known to the containing resource.
| string | Description |
|---|---|
| Source | The source element.
|
| Target | The target element.
|
4.14.3.10 ReplicaState
ReplicaState describes the state of the relationship with respect to Replication activity.
- The ReplicaState enumeration literal shall specify 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.
|
4.14.3.11 ReplicaType
ReplicaType describes the intended outcome of the replication.
- The ReplicaType enumeration literal shall describe 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.
|
4.14.3.12 ReplicaUpdateMode
Describes whether the target elements will be updated synchronously or asynchronously.
- The enumeration literal shall specify 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.
|
4.14.3.13 RequestedReplicaState
The last requested or desired state for the relationship.
- The last requested or desired state for the relationship. The actual state of the relationship shall be represented by ReplicaState. When RequestedState reaches the requested state, this property shall be null.
| 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.
|
4.14.3.14 UndiscoveredElement
This property specifies whether the source, the target, or both elements involved in a copy operation are undiscovered.
- The enumeration literal shall specify whether the source, the target, or both elements involved in a copy operation are undiscovered. An element is considered undiscovered if its object model is not known to the service performing the copy operation.
| string | Description |
|---|---|
| ReplicaElement | The replica element is undiscovered.
|
| SourceElement | The source element is undiscovered.
|
4.15 ResolutionStep
4.15.1 Description
This type describes a recommended step of the service-defined resolution.
- This type shall describe a recommended step of the service-defined resolution. The set of recommended steps are used to resolve the cause of a log entry, an event, a condition, or an error message.
4.15.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| ActionParameters [ { | array | The parameters of the action URI for a resolution step.
|
|
| @odata.id | string | read-only | Link to a Parameters resource. See the Links section and the ActionInfo schema for details. |
| } ] | |||
| ActionURI | string (URI) |
read-only | The action URI for a resolution step.
|
| Oem {} | object | See the OEM object definition in the Using this guide clause. | |
| Priority | integer | read-only (null) |
The priority in the set of resolution steps.
|
| ResolutionType | string (enum) |
read-only required (null) |
The type of the resolution step.
|
| RetryCount | integer | read-only (null) |
The number of retries for a resolution step.
|
| RetryIntervalSeconds | integer (seconds) |
read-only (null) |
The interval between retries for a resolution step.
|
| TargetComponentURI | string (URI) |
read-only (null) |
The target URI of the component for a resolution step.
|
4.15.3 Property details
4.15.3.1 ResolutionType
The type of the resolution step.
- This property shall contain the type of the resolution step.
| string | Description |
|---|---|
| CollectDiagnosticData | Collect diagnostic data. |
| ContactVendor | Contact vendor for service. |
| FirmwareUpdate | Perform a firmware update operation. |
| OEM | Perform an OEM-defined resolution step. |
| PowerCycle | Perform a power cycle operation. |
| ReplaceComponent | Replace a component. |
| Reset | Perform a reset operation. |
| ResetToDefaults | Reset the settings to factory defaults. |
4.16 Schedule
4.16.1 Description
Schedule a series of occurrences.
- The properties of this type shall schedule a series of occurrences.
4.16.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| EnabledDaysOfMonth [ ] | array (integer, null) | read-write | Days of the month when scheduled occurrences are enabled. 0 indicates that every day of the month is enabled.
|
| EnabledDaysOfWeek [ ] | array (string (enum)) |
read-write (null) |
Days of the week.
|
| EnabledIntervals (v1.1+) [ ] | array (string, null) | read-write | Intervals when scheduled occurrences are enabled.
|
| EnabledMonthsOfYear [ ] | array (string (enum)) |
read-write (null) |
Months of the year.
|
| InitialStartTime | string (date-time) |
read-write (null) |
The date and time when the initial occurrence is scheduled to occur.
|
| Lifetime | string (duration) |
read-write (null) |
The time after provisioning when the schedule as a whole expires.
^P(\d+D)?(T(\d+H)?(\d+M)?(\d+(.\d+)?S)?)?$ |
| MaxOccurrences | integer | read-write (null) |
The maximum number of scheduled occurrences.
|
| Name | string | read-write (null) |
The schedule name.
|
| RecurrenceInterval | string (duration) |
read-write (null) |
The duration between consecutive occurrences.
^P(\d+D)?(T(\d+H)?(\d+M)?(\d+(.\d+)?S)?)?$ |
4.16.3 Property details
4.16.3.1 EnabledDaysOfWeek
Days of the week.
- 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 when scheduled occurrences are enabled. If not present, all days of the week shall be enabled.
| string | Description |
|---|---|
| Every | Every day of the week.
|
| Friday | Friday. |
| Monday | Monday. |
| Saturday | Saturday. |
| Sunday | Sunday. |
| Thursday | Thursday. |
| Tuesday | Tuesday. |
| Wednesday | Wednesday. |
4.16.3.2 EnabledMonthsOfYear
Months of the year.
- The months of the year when scheduled occurrences are enabled. If not present, all months of the year are enabled.
- This property shall contain the months of the year when scheduled occurrences are enabled, for enabled days of week and days of month. If not present, all months of the year shall be enabled.
| 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. |
4.17 Status
4.17.1 Description
The status and health of a resource and its children.
- This type shall contain any status or health properties of a resource.
4.17.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Conditions (v1.11+) [ { | array | Conditions in this resource that require attention.
|
|
| LogEntry { | object | The link to the log entry created for this condition.
|
|
| @odata.id | string | read-only | Link to a LogEntry resource. See the Links section and the LogEntry schema for details. |
| } | |||
| Message | string | read-only | The human-readable message for this condition.
|
| MessageArgs [ ] | array (string) | read-only | An array of message arguments that are substituted for the arguments in the message when looked up in the message registry.
|
| MessageId | string | read-only required | The identifier for the message.
|
| OriginOfCondition { | object | A link to the resource or object that originated the condition.
|
|
| @odata.id | string (URI) |
read-only | The unique identifier for a resource.
|
| } | |||
| Resolution (v1.14+) | string | read-only | Suggestions on how to resolve the condition.
|
| ResolutionSteps (v1.18+) [ { } ] | array (object) | This type describes a recommended step of the service-defined resolution.
|
|
| Severity | string (enum) |
read-only | The severity of the condition.
|
| Timestamp | string (date-time) |
read-only | The time the condition occurred.
|
| UserAuthenticationSource (v1.20+) | string | read-only (null) |
The source of authentication for the username property associated with the condition.
|
| Username (v1.20+) | string | read-only (null) |
The username of the account associated with the condition.
|
| } ] | |||
| Health | string (enum) |
read-only (null) |
The health state of this resource in the absence of its dependent resources.
|
| HealthRollup | string (enum) |
read-only (null) |
The overall health state from the view of this resource.
|
| Oem { | object | See the OEM object definition in the Using this guide clause. | |
| (pattern) {} | object | Property names follow regular expression pattern "^[A-Za-z0-9_]+$" | |
| } | |||
| State | string (enum) |
read-only (null) |
The state of the resource.
|
4.17.3 Property details
4.17.3.1 Health
The health state of this resource in the absence of its dependent resources.
- This property shall represent the health state of the resource without considering its dependent resources. The values shall conform to those defined in the Redfish Specification.
| string | Description |
|---|---|
| Critical | A critical condition requires immediate attention. |
| OK | Normal. |
| Warning | A condition requires attention. |
4.17.3.2 HealthRollup
The overall health state from the view of this resource.
- This property shall represent the health state of the resource and its dependent resources. The values shall conform to those defined in the Redfish Specification. For additional property requirements, see the corresponding definition in the Redfish Data Model Specification.
Methods used to determine the value of this property can vary between different architectures and requirements of the underlying product. This property does not necessarily surface the most degraded health from all subordinate resources. For example, if a PowerSupply resource contains Critical for its Health property, but belongs to a redundancy group that is still able to power the parent Chassis resource, the Chassis resource could report Warning for the HealthRollup property, depending on the redundancy policy for the Chassis resource. Using the same PowerSupply example, the ComputerSystem resource associated with this Chassis resource could degrade its HealthRollup, even though the PowerSupply resource is not subordinate to the ComputerSystem resource. In this case, the ComputerSystem resource is dependent on the PowerSupply, but are in two different resource hierarchies.
| string | Description |
|---|---|
| Critical | A critical condition requires immediate attention. |
| OK | Normal. |
| Warning | A condition requires attention. |
4.17.3.3 Severity
The severity of the condition.
- This property shall contain the severity of the condition. Services can replace the value defined in the message registry with a value more applicable to the implementation.
| string | Description |
|---|---|
| Critical | A critical condition requires immediate attention. |
| OK | Normal. |
| Warning | A condition requires attention. |
4.17.3.4 State
The state of the resource.
- This property shall indicate the state of the resource.
| string | Description |
|---|---|
| Absent | This function or device is not currently present or detected. This resource represents a capability or an available location where a device can be installed.
|
| Deferring (v1.2+) | The element does not process any commands but queues new requests.
|
| Degraded (v1.19+) | The function or resource is degraded.
|
| 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+, deprecated v1.19) | 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.
|
5 Resource collections
A resource collection is a core concept in Redfish. A resource 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 collection contains 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 will have the same resource type with the same major version but can vary in minor or errata schema versions.
The properties of a resource collection are:
5.0.1 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| @odata.context | string (URI) |
read-only | The value of this property shall be the context URL that describes the resource according to OData-Protocol and shall be of the form defined in the Redfish specification. |
| @odata.id | string (URI) |
read-only required | The value of this property shall be the unique identifier for the resource and it shall be of the form defined in the Redfish specification. |
| @odata.type | string | read-only required | The value of this property shall be a URI fragment that specifies the type of the resource and it shall be of the form defined in the Redfish specification. |
| Description | string | read-only (null) |
This property shall contain the description of this resource. The value shall conform with the 'Description' clause of the Redfish Specification. |
| Members [ { | array | required | The members of this collection. |
| @odata.id | string (URI) |
read-only | The link to a Resource instance, which is a member of this collection. |
| } ] | |||
| Members@odata.count | integer | read-only | The value of this property shall be an integer representing the number of items in a collection. |
| Members@odata.nextLink | string (URI) |
read-only | The value of this property shall be a URI to a resource, with the same @odata.type, containing the next set of partial members. |
| Name | string | read-only required | This property shall contain the name of this resource or array member. The value shall conform with the 'Name' clause of the Redfish Specification. |
| Oem {} | object | This string property shall be in the Oem reserved word format. |
As shown in the following example, a Redfish service may provide management functionality for several ComputerSystem resources, and therefore a ComputerSystemCollection resource is provided. This example shows a service with four ComputerSystem instances inside the Members array.
{
"@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.id": "/redfish/v1/Systems"
}5.1 Collection capabilities annotation (#CollectionCapabilities)
This annotation is used to inform the client how to form the request body for a create (POST) operation to a given collection based on a specified use case, which will result in a new member being added to the given collection.
5.1.1 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Capabilities [ { | array | This property shall contain an array of objects that describe the capabilities of this resource collection. | |
| CapabilitiesObject { | object | required | This property shall contain a link to a resource that matches the type for a resource collection and shall contain annotations that describe the properties allowed in the POST request. |
| @odata.id | string (URI) |
read-only | The value of this property shall be the unique identifier for the resource and it shall be of the form defined in the Redfish specification. |
| } | |||
| Links { | object | required | This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource. |
| Oem {} | object | This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements. For property details, see Oem. | |
| RelatedItem [ { | array | This property shall contain an array of links to resources that are related to this capability. | |
| @odata.id | string (URI) |
read-only | The value of this property shall be the unique identifier for the resource and it shall be of the form defined in the Redfish specification. |
| } ] | |||
| RelatedItem@odata.count | integer | read-only | The value of this property shall be an integer representing the number of items in a collection. |
| TargetCollection { | object | required | This property shall contain a link to a resource collection that this structure describes. A client can use this structure to understand how to form the POST request for the collection. |
| @odata.id | string (URI) |
read-only | The value of this property shall be the unique identifier for the resource and it shall be of the form defined in the Redfish specification. |
| } | |||
| } | |||
| UseCase | string (enum) |
read-only required | This property shall contain an enumerated value that describes the use case for this capability instance. For the possible property values, see UseCase in Property details. |
| } ] | |||
| MaxMembers (v1.2+) | integer | read-only | This property shall contain the maximum number of members allowed in this resource collection. |
5.1.2 Property details
5.1.2.1 UseCase
This property shall contain an enumerated value that describes the use case for this capability instance.
| string | Description |
|---|---|
| ComputerSystemComposition | This capability describes a client creating a new computer system resource from a set of disaggregated hardware. |
| ComputerSystemConstrainedComposition (v1.1+) | This capability describes a client creating a new computer system resource from a set of constraints. |
| ResourceBlockComposition (v1.3+) | This capability describes a client creating a new resource block from a set of other resource blocks. |
| ResourceBlockConstrainedComposition (v1.3+) | This capability describes a client creating a new resource block from a set of constraints. |
| VolumeCreation | This capability describes a client creating a new volume resource as part of an existing storage subsystem. |
5.1.3 Example collection capabilities annotation
{
"@Redfish.CollectionCapabilities": {
"@odata.type": "#CollectionCapabilities.v1_1_0.CollectionCapabilities",
"Capabilities": [
{
"CapabilitiesObject": {
"@odata.id": "/redfish/v1/Systems/Capabilities"
},
"UseCase": "ComputerSystemComposition",
"Links": {
"TargetCollection": {
"@odata.id": "/redfish/v1/Systems"
}
}
},
{
"CapabilitiesObject": {
"@odata.id": "/redfish/v1/Systems/ConstrainedCompositionCapabilities"
},
"UseCase": "ComputerSystemConstrainedComposition",
"Links": {
"TargetCollection": {
"@odata.id": "/redfish/v1/Systems"
}
}
}
]
},
...
}5.2 Resource collection URIs in Redfish v1.6 and later
The following table lists all Redfish-defined resource collections and the URIs where they can appear.
Note: The URIs listed are valid for Redfish services that conform to the Redfish Specification v1.6.0 or higher. Services built on earlier specification versions might use different URIs, which must be discovered by following the hyperlinks 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 |
| AllowDenyCollection | /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny /redfish/v1/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny /redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny |
| ApplicationCollection | /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/OperatingSystem/Applications /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/OperatingSystem/Applications /redfish/v1/Systems/{ComputerSystemId}/OperatingSystem/Applications |
| BatteryCollection | /redfish/v1/Chassis/{ChassisId}/PowerSubsystem/Batteries |
| BootOptionCollection | /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/BootOptions /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/BootOptions /redfish/v1/Systems/{ComputerSystemId}/BootOptions |
| CableCollection | /redfish/v1/Cables |
| 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/AccountService/MultiFactorAuth/ClientCertificate/Certificates /redfish/v1/AccountService/MultiFactorAuth/SecurID/Certificates /redfish/v1/AccountService/OutboundConnections/{OutboundConnectionId}/Certificates /redfish/v1/AccountService/OutboundConnections/{OutboundConnectionId}/ClientCertificates /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/Chassis/{ChassisId}/PowerSubsystem/PowerSupplies/{PowerSupplyId}/Certificates /redfish/v1/Chassis/{ChassisId}/TrustedComponents/{TrustedComponentId}/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}/KeyManagement/KMIPCertificates /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/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/Certificates /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/ClientCertificates /redfish/v1/EventService/Subscriptions/{EventDestinationId}/Certificates /redfish/v1/EventService/Subscriptions/{EventDestinationId}/ClientCertificates /redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Certificates /redfish/v1/Managers/{ManagerId}/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/Managers/{ManagerId}/RemoteAccountService/MultiFactorAuth/ClientCertificate/Certificates /redfish/v1/Managers/{ManagerId}/RemoteAccountService/MultiFactorAuth/SecurID/Certificates /redfish/v1/Managers/{ManagerId}/SecurityPolicy/SPDM/RevokedCertificates /redfish/v1/Managers/{ManagerId}/SecurityPolicy/SPDM/TrustedCertificates /redfish/v1/Managers/{ManagerId}/SecurityPolicy/TLS/Client/RevokedCertificates /redfish/v1/Managers/{ManagerId}/SecurityPolicy/TLS/Client/TrustedCertificates /redfish/v1/Managers/{ManagerId}/SecurityPolicy/TLS/Server/RevokedCertificates /redfish/v1/Managers/{ManagerId}/SecurityPolicy/TLS/Server/TrustedCertificates /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}/KeyManagement/KMIPCertificates /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/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/Certificates /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/ClientCertificates /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}/KeyManagement/KMIPCertificates /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}/Drives/{DriveId}/Certificates /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates /redfish/v1/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/Certificates /redfish/v1/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/ClientCertificates /redfish/v1/UpdateService/ClientCertificates /redfish/v1/UpdateService/RemoteServerCertificates |
| ChassisCollection | /redfish/v1/Chassis |
| CircuitCollection | /redfish/v1/PowerEquipment/ElectricalBuses/{PowerDistributionId}/Branches /redfish/v1/PowerEquipment/ElectricalBuses/{PowerDistributionId}/Mains /redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}/Branches /redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}/Mains /redfish/v1/PowerEquipment/FloorPDUs/{PowerDistributionId}/Subfeeds /redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/Branches /redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/Mains /redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Branches /redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Mains /redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}/Branches /redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}/Feeders /redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}/Mains /redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}/Subfeeds /redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Branches /redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Feeders /redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Mains |
| ComponentIntegrityCollection | /redfish/v1/ComponentIntegrity |
| CompositionReservationCollection | /redfish/v1/CompositionService/CompositionReservations |
| ComputerSystemCollection | /redfish/v1/Systems |
| ConnectionCollection | /redfish/v1/Fabrics/{FabricId}/Connections /redfish/v1/Storage/{StorageId}/Connections |
| ConnectionMethodCollection | /redfish/v1/AggregationService/ConnectionMethods |
| ContainerCollection | /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/OperatingSystem/Containers /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/OperatingSystem/Containers /redfish/v1/Systems/{ComputerSystemId}/OperatingSystem/Containers |
| ContainerImageCollection | /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/OperatingSystem/ContainerImages /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/OperatingSystem/ContainerImages /redfish/v1/Systems/{ComputerSystemId}/OperatingSystem/ContainerImages |
| ControlCollection | /redfish/v1/Chassis/{ChassisId}/Controls |
| CoolantConnectorCollection | /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/CoolantConnectors /redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/PrimaryCoolantConnectors /redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/SecondaryCoolantConnectors /redfish/v1/ThermalEquipment/CoolingLoops/{CoolingUnitId}/PrimaryCoolantConnectors /redfish/v1/ThermalEquipment/CoolingLoops/{CoolingUnitId}/SecondaryCoolantConnectors /redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/PrimaryCoolantConnectors /redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/SecondaryCoolantConnectors /redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/PrimaryCoolantConnectors /redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/SecondaryCoolantConnectors |
| CoolingLoopCollection | /redfish/v1/ThermalEquipment/CoolingLoops |
| CoolingUnitCollection | /redfish/v1/ThermalEquipment/CDUs /redfish/v1/ThermalEquipment/HeatExchangers /redfish/v1/ThermalEquipment/ImmersionUnits |
| CXLLogicalDeviceCollection | /redfish/v1/Chassis/{ChassisId}/PCIeDevices/{PCIeDeviceId}/CXLLogicalDevices |
| 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 /redfish/v1/Storage/{StorageId}/Endpoints (deprecated) /redfish/v1/StorageServices/{StorageServiceId}/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/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/EthernetInterfaces /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/EthernetInterfaces /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/OperatingSystem/Containers/EthernetInterfaces /redfish/v1/Managers/{ManagerId}/EthernetInterfaces /redfish/v1/Managers/{ManagerId}/HostInterfaces/{HostInterfaceId}/HostEthernetInterfaces /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/EthernetInterfaces /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/OperatingSystem/Containers/EthernetInterfaces /redfish/v1/Systems/{ComputerSystemId}/EthernetInterfaces /redfish/v1/Systems/{ComputerSystemId}/OperatingSystem/Containers/EthernetInterfaces |
| EventDestinationCollection | /redfish/v1/EventService/Subscriptions |
| ExternalAccountProviderCollection | /redfish/v1/AccountService/ExternalAccountProviders /redfish/v1/Managers/{ManagerId}/RemoteAccountService/ExternalAccountProviders |
| FabricAdapterCollection | /redfish/v1/Chassis/{ChassisId}/FabricAdapters /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters |
| FabricCollection | /redfish/v1/Fabrics |
| FacilityCollection | /redfish/v1/Facilities |
| FanCollection | /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Fans |
| FilterCollection | /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Pumps/{PumpId}/Filters /redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Filters /redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Pumps/{PumpId}/Filters /redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Reservoirs/{ReservoirId}/Filters /redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Filters /redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Pumps/{PumpId}/Filters /redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Reservoirs/{ReservoirId}/Filters /redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Filters /redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Pumps/{PumpId}/Filters /redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Reservoirs/{ReservoirId}/Filters |
| GraphicsControllerCollection | /redfish/v1/Systems/{ComputerSystemId}/GraphicsControllers |
| HeaterCollection | /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Heaters |
| HostInterfaceCollection | /redfish/v1/Managers/{ManagerId}/HostInterfaces |
| JobCollection | /redfish/v1/JobService/Jobs /redfish/v1/JobService/Jobs/{JobId}/Steps |
| JsonSchemaFileCollection | /redfish/v1/JsonSchemas |
| KeyCollection | /redfish/v1/AccountService/Accounts/{ManagerAccountId}/Keys /redfish/v1/AggregationService/AggregationSources/{AggregationSourceId}/TrustedPublicHostKeys /redfish/v1/KeyService/NVMeoFSecrets /redfish/v1/Managers/{ManagerId}/RemoteAccountService/Accounts/{ManagerAccountId}/Keys /redfish/v1/UpdateService/RemoteServerSSHKeys |
| KeyPolicyCollection | /redfish/v1/KeyService/NVMeoFKeyPolicies |
| LeakDetectorCollection | /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/LeakDetection/LeakDetectors /redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/LeakDetection/LeakDetectors /redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/LeakDetection/LeakDetectors/ /redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/LeakDetection/LeakDetectors |
| LicenseCollection | /redfish/v1/LicenseService/Licenses |
| LogEntryCollection | /redfish/v1/Chassis/{ChassisId}/LogServices/{LogServiceId}/Entries /redfish/v1/Chassis/{ChassisId}/PCIeDevices/{PCIeDeviceId}/CXLLogicalDevices/{CXLLogicalDeviceId}/DeviceLog/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/Systems/{ComputerSystemId}/Memory/{MemoryId}/DeviceLog/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 (deprecated) |
| 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 /redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/CacheMemory |
| 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 |
| MemoryRegionCollection | /redfish/v1/Chassis/{ChassisId}/PCIeDevices/{PCIeDeviceId}/CXLLogicalDevices/{CXLLogicalDeviceId}/MemoryRegions |
| 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 (deprecated) /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts (deprecated) /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts (deprecated) /redfish/v1/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts (deprecated) /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts (deprecated) /redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkPorts (deprecated) |
| OperatingConfigCollection | /redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/OperatingConfigs |
| OutboundConnectionCollection | /redfish/v1/AccountService/OutboundConnections |
| OutletCollection | /redfish/v1/PowerEquipment/ElectricalBuses/{PowerDistributionId}/Outlets /redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/Outlets /redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Outlets /redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Outlets |
| OutletGroupCollection | /redfish/v1/PowerEquipment/ElectricalBuses/{PowerDistributionId}/OutletGroups /redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/OutletGroups /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}/FabricAdapters/{FabricAdapterId}/Ports /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}/Processors/{ProcessorId}/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}/FabricAdapters/{FabricAdapterId}/Ports /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/GraphicsControllers/{ControllerId}/Ports /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/Ports /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/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/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/USBControllers/{ControllerId}/Ports /redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports /redfish/v1/Managers/{ManagerId}/DedicatedNetworkPorts /redfish/v1/Managers/{ManagerId}/SharedNetworkPorts /redfish/v1/Managers/{ManagerId}/USBPorts /redfish/v1/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}/Ports /redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/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}/FabricAdapters/{FabricAdapterId}/Ports /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/GraphicsControllers/{ControllerId}/Ports /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/Ports /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/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/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/USBControllers/{ControllerId}/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}/GraphicsControllers/{ControllerId}/Ports /redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/Ports /redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Ports /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Ports /redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Ports /redfish/v1/Systems/{ComputerSystemId}/USBControllers/{ControllerId}/Ports |
| PowerDistributionCollection | /redfish/v1/PowerEquipment/ElectricalBuses /redfish/v1/PowerEquipment/FloorPDUs /redfish/v1/PowerEquipment/PowerShelves /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 /redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/PowerSupplies (deprecated) |
| ProcessorCollection | /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/{ProcessorId}/SubProcessors /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors /redfish/v1/Chassis/{ChassisId}/Processors /redfish/v1/Chassis/{ChassisId}/Processors/{ProcessorId}/SubProcessors /redfish/v1/Chassis/{ChassisId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors /redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors /redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors /redfish/v1/Systems/{ComputerSystemId}/Processors /redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors /redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors |
| PumpCollection | /redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Pumps /redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Pumps /redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Pumps /redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Pumps |
| RegisteredClientCollection | /redfish/v1/RegisteredClients |
| ReservoirCollection | /redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Reservoirs /redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Reservoirs /redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Reservoirs |
| ResourceBlockCollection | /redfish/v1/CompositionService/ActivePool /redfish/v1/CompositionService/FreePool /redfish/v1/CompositionService/ResourceBlocks /redfish/v1/ResourceBlocks |
| RoleCollection | /redfish/v1/AccountService/Roles /redfish/v1/Managers/{ManagerId}/RemoteAccountService/Roles |
| RouteEntryCollection | /redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/GenZ/MSDT /redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/GenZ/SSDT /redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/MSDT (deprecated) /redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/LPRT /redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/MPRT /redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT (deprecated) /redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT (deprecated) /redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/SSDT (deprecated) /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/GenZ/MSDT /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/GenZ/SSDT /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/MSDT (deprecated) /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/LPRT /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/MPRT /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT (deprecated) /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT (deprecated) /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/SSDT (deprecated) /redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/GenZ/LPRT /redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/GenZ/MPRT /redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/LPRT (deprecated) /redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/MPRT (deprecated) /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/GenZ/MSDT /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/GenZ/SSDT /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/MSDT (deprecated) /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/LPRT /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/MPRT /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT (deprecated) /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT (deprecated) /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/SSDT (deprecated) /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/GenZ/MSDT /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/GenZ/SSDT /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/MSDT (deprecated) /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/LPRT /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/MPRT /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT (deprecated) /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT (deprecated) /redfish/v1/Systems/{ComputerSystemId}/FabricAdapters/{FabricAdapterId}/SSDT (deprecated) |
| RouteSetEntryCollection | /redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/MSDT/{MSDTId}/RouteSet /redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/LPRT/{LPRTId}/RouteSet /redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/MPRT/{MPRTId}/RouteSet /redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/SSDT/{SSDTId}/RouteSet /redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/LPRT/{LPRTId}/RouteSet /redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/MPRT/{MPRTId}/RouteSet /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/PowerEquipment/FloorPDUs/{PowerDistributionId}/Sensors (deprecated) /redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/Sensors (deprecated) /redfish/v1/PowerEquipment/RackPDUs/{PowerDistributionId}/Sensors (deprecated) /redfish/v1/PowerEquipment/Switchgear/{PowerDistributionId}/Sensors (deprecated) /redfish/v1/PowerEquipment/TransferSwitches/{PowerDistributionId}/Sensors (deprecated) |
| 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 |
| TrustedComponentCollection | /redfish/v1/Chassis/{ChassisId}/TrustedComponents |
| USBControllerCollection | /redfish/v1/Systems/{ComputerSystemId}/USBControllers |
| VCATEntryCollection | /redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/GenZ/REQ-VCAT /redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/GenZ/RSP-VCAT /redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/VCAT /redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/VCAT (deprecated) /redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/REQ-VCAT (deprecated) /redfish/v1/Chassis/{ChassisId}/FabricAdapters/{FabricAdapterId}/RSP-VCAT (deprecated) /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/GenZ/REQ-VCAT /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/GenZ/RSP-VCAT /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/VCAT /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/VCAT (deprecated) /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/REQ-VCAT (deprecated) /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/RSP-VCAT (deprecated) /redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/GenZ/VCAT /redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Ports/{PortId}/VCAT (deprecated) /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/GenZ/REQ-VCAT /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/GenZ/RSP-VCAT /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/VCAT /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/VCAT (deprecated) /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/REQ-VCAT (deprecated) /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/RSP-VCAT (deprecated) /redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/GenZ/REQ-VCAT /redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/GenZ/RSP-VCAT /redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/GenZ/VCAT /redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/Ports/{PortId}/VCAT (deprecated) /redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/REQ-VCAT (deprecated) /redfish/v1/Systems/{SystemId}/FabricAdapters/{FabricAdapterId}/RSP-VCAT (deprecated) |
| VirtualMediaCollection | /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/VirtualMedia /redfish/v1/Managers/{ManagerId}/VirtualMedia (deprecated) /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/VirtualMedia /redfish/v1/Systems/{ComputerSystemId}/VirtualMedia |
| VLanNetworkInterfaceCollection | /redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/Ethernet/VLANs (deprecated) /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs (deprecated) /redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs (deprecated) /redfish/v1/Managers/{ManagerId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs (deprecated) /redfish/v1/ResourceBlocks/{ResourceBlockId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs (deprecated) /redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs (deprecated) /redfish/v1/Systems/{ComputerSystemId}/EthernetInterfaces/{EthernetInterfaceId}/VLANs (deprecated) |
| 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 |
6 Schema reference
To produce this guide, DMTF's Redfish Documentation Generator merges DMTF's Redfish Schema Bundle (DSP8010) contents with supplemental text.
6.1 AccelerationFunction 1.0.5
| Version | v1.0 |
| Release | 2018.3 |
6.1.1 Description
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.
- This resource shall represent the acceleration function that a processor implements in a Redfish implementation. This can include functions such as audio processing, compression, encryption, packet inspection, packet switching, scheduling, or video processing.
6.1.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/AccelerationFunctions/{AccelerationFunctionId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/AccelerationFunctions/{AccelerationFunctionId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/AccelerationFunctions/{AccelerationFunctionId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/AccelerationFunctions/{AccelerationFunctionId}
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/AccelerationFunctions/{AccelerationFunctionId}
6.1.3 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| AccelerationFunctionType | string (enum) |
read-only (null) |
The acceleration function type.
|
| FpgaReconfigurationSlots [ ] | array (string) | read-only | An array of the reconfiguration slot identifiers of the FPGA that this acceleration function occupies.
|
| Links { | object | The links to other resources that are related to this resource.
|
|
| Endpoints [ { | array | An array of links to the endpoints that connect to this acceleration function.
|
|
| @odata.id | string | read-only | Link to a Endpoint resource. See the Links section and the Endpoint schema for details. |
| } ] | |||
| Oem {} | object | See the OEM object definition in the Using this guide clause. | |
| PCIeFunctions [ { | array | An array of links to the PCIe functions associated with this acceleration function.
|
|
| @odata.id | string | read-only | Link to a PCIeFunction resource. See the Links section and the PCIeFunction schema for details. |
| } ] | |||
| } | |||
| Manufacturer | string | read-only | The acceleration function code manufacturer.
|
| PowerWatts | integer (Watts) |
read-only | The acceleration function power consumption, in watt units.
|
| Status {} | object | The status and health of the resource and its subordinate or dependent resources.
|
|
| UUID | string (uuid) |
read-only (null) |
The UUID for this acceleration function.
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ |
| Version | string | read-only | The acceleration function version.
|
6.1.4 Property details
6.1.4.1 AccelerationFunctionType
The acceleration function type.
- This property shall contain the string that identifies 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. |
6.1.5 Example response
{
"@odata.type": "#AccelerationFunction.v1_0_5.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": []
},
"@odata.id": "/redfish/v1/Systems/1/Processors/FPGA1/AccelerationFunctions/Compression"
}6.2 AccountService 1.16.0
| Version | v1.16 | v1.15 | v1.14 | v1.13 | v1.12 | v1.11 | v1.10 | v1.9 | v1.8 | v1.7 | v1.6 | ... |
| Release | 2024.3 | 2023.3 | 2023.2 | 2023.1 | 2022.3 | 2022.1 | 2021.2 | 2021.1 | 2020.4 | 2019.4 | 2019.2 | ... |
6.2.1 Description
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. Properties and actions in this service specify general behavior that should be followed for typical accounts, however implementations might override these behaviors for special accounts or situations to avoid denial of service or other deadlock situations.
- This resource shall represent an account service for a Redfish implementation. 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. Properties and actions in this service specify general behavior that should be followed for typical accounts, however implementations may override these behaviors for special accounts or situations to avoid denial of service or other deadlock situations.
6.2.2 URIs
/redfish/v1/AccountService
/redfish/v1/Managers/{ManagerId}/RemoteAccountService
6.2.3 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| AccountLockoutCounterResetAfter | integer (seconds) |
read-write | 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.
|
| AccountLockoutCounterResetEnabled (v1.5+) | boolean | read-write | 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.
|
| AccountLockoutDuration | integer (seconds) |
read-write (null) |
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.
|
| AccountLockoutThreshold | integer | read-write (null) |
The number of allowed failed login attempts before a user account is locked for a specified duration. If 0, the account is never locked.
|
| Accounts { | object | The collection of manager accounts.
|
|
| @odata.id | string | read-only | Link to Collection of ManagerAccount. See the ManagerAccount schema for details. |
| } | |||
| ActiveDirectory (v1.3+) {} | object | The first Active Directory external account provider that this account service supports.
|
|
| AdditionalExternalAccountProviders (v1.3+) { | object | The additional external account providers that this account service uses.
|
|
| @odata.id | string | read-only | Link to Collection of ExternalAccountProvider. See the ExternalAccountProvider schema for details. |
| } | |||
| AuthFailureLoggingThreshold | integer | read-write | The number of authorization failures per account that are allowed before the failed attempt is logged to the manager log.
|
| HTTPBasicAuth (v1.15+) | string (enum) |
read-write (null) |
Indicates if HTTP Basic authentication is enabled for this service.
|
| LDAP (v1.3+) {} | object | The first LDAP external account provider that this account service supports.
|
|
| LocalAccountAuth (v1.3+) | string (enum) |
read-write | 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.
|
| MaxPasswordLength | integer | read-write | The maximum password length for this account service.
|
| MinPasswordLength | integer | read-write | The minimum password length for this account service.
|
| MultiFactorAuth (v1.12+) { | object | (null) |
The multi-factor authentication settings that this account service supports.
|
| ClientCertificate (v1.12+) { | object | (null) |
The settings related to client certificate authentication schemes such as mTLS or CAC/PIV.
|
| CertificateMappingAttribute (v1.12+) | string (enum) |
read-write (null) |
The client certificate attribute to map to a user.
|
| Certificates (v1.12+) { | object | The link to a collection of CA certificates used to validate client certificates.
|
|
| @odata.id | string | read-only | Link to Collection of Certificate. See the Certificate schema for details. |
| } | |||
| Enabled (v1.12+) | boolean | read-write (null) |
An indication of whether client certificate authentication is enabled.
|
| RespondToUnauthenticatedClients (v1.12+) | boolean | read-write (null) |
An indication of whether the service responds to clients that do not successfully authenticate.
|
| } | |||
| GoogleAuthenticator (v1.12+) { | object | (null) |
The settings related to Google Authenticator multi-factor authentication. For generic Time-Based One-Time Password (TOTP) multi-factor authentication, use the TimeBasedOneTimePassword property.
|
| Enabled (v1.12+) | boolean | read-write (null) |
An indication of whether multi-factor authentication with Google Authenticator is enabled.
|
| SecretKey (v1.12+) | string | read-write (null) |
The secret key to use when communicating with the Google Authenticator server. This property is null in responses.
|
| SecretKeySet (v1.12+) | boolean | read-only | Indicates if the SecretKey property is set.
|
| } | |||
| MicrosoftAuthenticator (v1.12+) { | object | (null) |
The settings related to Microsoft Authenticator multi-factor authentication. For generic Time-Based One-Time Password (TOTP) multi-factor authentication, use the TimeBasedOneTimePassword property.
|
| Enabled (v1.12+) | boolean | read-write (null) |
An indication of whether multi-factor authentication with Microsoft Authenticator is enabled.
|
| SecretKey (v1.12+) | string | read-write (null) |
The secret key to use when communicating with the Microsoft Authenticator server. This property is null in responses.
|
| SecretKeySet (v1.12+) | boolean | read-only | Indicates if the SecretKey property is set.
|
| } | |||
| OneTimePasscode (v1.14+) { | object | (null) |
The settings related to one-time passcode (OTP) multi-factor authentication.
|
| Enabled (v1.14+) | boolean | read-write (null) |
An indication of whether multi-factor authentication using a one-time passcode is enabled.
|
| } | |||
| SecurID (v1.12+) { | object | (null) |
The settings related to RSA SecurID multi-factor authentication.
|
| Certificates (v1.12+) { | object | The link to a collection of server certificates for the RSA SecurID server referenced by the ServerURI property.
|
|
| @odata.id | string | read-only | Link to Collection of Certificate. See the Certificate schema for details. |
| } | |||
| ClientId (v1.12+) | string | read-write (null) |
The client ID to use when communicating with the RSA SecurID server.
|
| ClientSecret (v1.12+) | string | read-write (null) |
The client secret to use when communicating with the RSA SecurID server. This property is null in responses.
|
| ClientSecretSet (v1.12+) | boolean | read-only | Indicates if the ClientSecret property is set.
|
| Enabled (v1.12+) | boolean | read-write (null) |
An indication of whether multi-factor authentication with RSA SecurID is enabled.
|
| ServerURI (v1.12+) | string (URI) |
read-write (null) |
The URI of the RSA SecurID server.
|
| } | |||
| TimeBasedOneTimePassword (v1.16+) { | object | (null) |
The settings related to Time-based One-Time Password (TOTP) multi-factor authentication.
|
| Enabled (v1.16+) | boolean | read-write (null) |
An indication of whether multi-factor authentication with a Time-based One-Time Password (TOTP) is enabled.
|
| TimeStepSeconds (v1.16+) | integer | read-write (null) |
The time step, in seconds, for calculating the one-time password.
|
| } | |||
| } | |||
| OAuth2 (v1.10+) {} | object | (null) |
The first OAuth 2.0 external account provider that this account service supports.
|
| OutboundConnections (v1.14+) { | object | (null) |
The collection of outbound connection configurations.
|
| @odata.id | string | read-only | Link to Collection of OutboundConnection. See the OutboundConnection schema for details. |
| } | |||
| PasswordExpirationDays (v1.9+) | integer | read-write (null) |
The number of days before account passwords in this account service will expire.
|
| PrivilegeMap (v1.1+) { | object | The link to the mapping of the privileges required to complete a requested operation on a URI associated with this service.
|
|
| @odata.id | string | read-only | Link to a PrivilegeRegistry resource. See the Links section and the PrivilegeRegistry schema for details. |
| } | |||
| RequireChangePasswordAction (v1.14+) | boolean | read-write (null) |
An indication of whether clients are required to invoke the ChangePassword action to modify account passwords.
|
| RestrictedOemPrivileges (v1.8+) [ ] | array (string) | read-only | The set of restricted OEM privileges.
|
| RestrictedPrivileges (v1.8+) [ ] | array (string (enum)) |
read-only |
|
| Roles { | object | The collection of Redfish roles.
|
|
| @odata.id | string | read-only | Link to Collection of Role. See the Role schema for details. |
| } | |||
| ServiceEnabled | boolean | read-write (null) |
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.
|
| Status {} | object | The status and health of the resource and its subordinate or dependent resources.
|
|
| SupportedAccountTypes (v1.8+) [ ] | array (string (enum)) |
read-only |
|
| SupportedOEMAccountTypes (v1.8+) [ ] | array (string) | read-only | The OEM account types supported by the service.
|
| TACACSplus (v1.8+) {} | object | (null) |
The first TACACS+ external account provider that this account service supports.
|
6.2.4 Property details
6.2.4.1 AccountProviderType
The type of external account provider to which this service connects.
- This property shall contain 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.
|
| OAuth2 (v1.10+) | An external OAuth 2.0 service.
|
| OEM | An OEM-specific external authentication or directory service. |
| RedfishService | An external Redfish service.
|
| TACACSplus (v1.8+) | An external TACACS+ service.
|
6.2.4.2 Authentication
The information required to authenticate to the external service.
| AuthenticationType (v1.3+) | string (enum) |
read-write (null) |
The type of authentication used to connect to the external account provider.
|
| EncryptionKey (v1.8+) | string | read-write (null) |
Specifies the encryption key.
^[0-9a-fA-F]+$ |
| EncryptionKeySet (v1.8+) | boolean | read-only (null) |
Indicates if the EncryptionKey property is set.
|
| KerberosKeytab (v1.3+) | string | read-write (null) |
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.
|
| Oem (v1.3+) {} | object | See the OEM object definition in the Using this guide clause. | |
| Password (v1.3+) | string | read-write (null) |
The password for this service. A PATCH or PUT request writes the password. This property is null in responses.
|
| Token (v1.3+) | string | read-write (null) |
The token for this service. A PATCH or PUT operation writes the token. This property is null in responses.
|
| Username (v1.3+) | string | read-write | The username for the service.
|
6.2.4.3 AuthenticationType
The type of authentication used to connect to the external account provider.
- This property shall contain 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 username and password combination. |
6.2.4.4 BypassTypes
- The types of multi-factor authentication this account or role mapping is allowed to bypass.
- This property shall contain the types of multi-factor authentication this account or role mapping is allowed to bypass. An empty array shall indicate this account or role mapping cannot bypass any multi-factor authentication types that are currently enabled.
| string | Description |
|---|---|
| All | Bypass all multi-factor authentication types.
|
| ClientCertificate | Bypass client certificate authentication.
|
| GoogleAuthenticator | Bypass Google Authenticator.
|
| MicrosoftAuthenticator | Bypass Microsoft Authenticator.
|
| OEM | Bypass OEM-defined multi-factor authentication.
|
| OneTimePasscode | Bypass one-time passcode authentication.
|
| SecurID | Bypass RSA SecurID.
|
| TimeBasedOneTimePassword | Bypass Time-based One-Time Password (TOTP) authentication.
|
6.2.4.5 CertificateMappingAttribute
The client certificate attribute to map to a user.
- This property shall contain the client certificate attribute to map to a user.
| string | Description |
|---|---|
| CommonName | Match the Common Name (CN) field in the provided certificate to the username.
|
| UserPrincipalName | Match the User Principal Name (UPN) field in the provided certificate to the username.
|
| Whole | Match the whole certificate.
|
6.2.4.6 ExternalAccountProvider
The external account provider services that can provide accounts for this manager to use for authentication.
| AccountProviderType (v1.3+, deprecated v1.5) | string (enum) |
read-only (null) |
The type of external account provider to which this service connects.
LDAP and ActiveDirectory objects. |
| Authentication (v1.3+) {} | object | The authentication information for the external account provider.
|
|
| Certificates (v1.4+) { | object | The link to a collection of certificates that the external account provider uses.
|
|
| @odata.id | string | read-only | Link to Collection of Certificate. See the Certificate schema for details. |
| } | |||
| LDAPService (v1.3+) {} | object | The additional mapping information needed to parse a generic LDAP service.
|
|
| OAuth2Service (v1.10+) {} | object | (null) |
The additional information needed to parse an OAuth 2.0 service.
|
| PasswordSet (v1.7+) | boolean | read-only | Indicates if the Password property is set.
|
| Priority (v1.8+) | integer | read-write (null) |
The authentication priority for the external account provider.
|
| RemoteRoleMapping (v1.3+) [ { | array | The mapping rules to convert the external account providers account information to the local Redfish role.
|
|
| LocalAccountTypes (v1.16+) [ ] | array (string (enum)) |
read-write (null) |
|
| LocalOEMAccountTypes (v1.16+) [ ] | array (string, null) | read-write | The OEM account types for the remote user or group.
|
| LocalRole (v1.3+) | string | read-write (null) |
The name of the local Redfish role to which to map the remote user or group.
|
| MFABypass (v1.12+) { | object | (null) |
The multi-factor authentication bypass settings.
|
| BypassTypes (v1.12+) [ ] | array (string (enum)) |
read-write (null) |
|
| } | |||
| Oem (v1.3+) {} | object | See the OEM object definition in the Using this guide clause. | |
| RemoteGroup (v1.3+) | string | read-write (null) |
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.
|
| RemoteUser (v1.3+) | string | read-write (null) |
The name of the remote user that maps to the local Redfish role to which this entity links.
|
| } ] | |||
| Retries (v1.13+) | integer | read-write (null) |
The number of times to retry connecting to an address in the ServiceAddresses property before attempting the next address in the array.
|
| ServiceAddresses (v1.3+) [ ] | array (string, null) | read-write | 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.
|
| ServiceEnabled (v1.3+) | boolean | read-write (null) |
An indication of whether this service is enabled.
|
| TACACSplusService (v1.8+) {} | object | (null) |
The additional information needed to parse a TACACS+ services.
|
| TimeoutSeconds (v1.13+) | integer | read-write (null) |
The period of time, in seconds, this account service will wait for a response from an address of a user account provider before timing out.
|
6.2.4.7 HTTPBasicAuth
Indicates if HTTP Basic authentication is enabled for this service.
- This property shall indicate whether clients are able to authenticate to the Redfish service with HTTP Basic authentication. This property should default to
Enabledfor client compatibility. If this property is not present in responses, the value shall be assumed to beEnabled.
| string | Description |
|---|---|
| Disabled | HTTP Basic authentication is disabled.
|
| Enabled | HTTP Basic authentication is enabled.
|
| Unadvertised | HTTP Basic authentication is enabled, but is not advertised with the WWW-Authenticate response header.
|
6.2.4.8 LDAPService
The settings required to parse a generic LDAP service.
| Oem (v1.3+) {} | object | See the OEM object definition in the Using this guide clause. | |
| SearchSettings (v1.3+) { | object | The required settings to search an external LDAP service.
|
|
| BaseDistinguishedNames (v1.3+) [ ] | array (string, null) | read-write | The base distinguished names to use to search an external LDAP service.
|
| EmailAttribute (v1.14+) | string | read-write (null) |
The attribute name that contains the LDAP user's email address.
|
| GroupNameAttribute (v1.3+) | string | read-write (null) |
The attribute name that contains the LDAP group name entry.
|
| GroupsAttribute (v1.3+) | string | read-write (null) |
The attribute name that contains the groups for a user on the LDAP user entry.
|
| SSHKeyAttribute (v1.11+) | string | read-write (null) |
The attribute name that contains the LDAP user's SSH public key entry.
|
| UsernameAttribute (v1.3+) | string | read-write (null) |
The attribute name that contains the LDAP username entry.
|
| } |
6.2.4.9 LocalAccountAuth
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.
- This property shall govern how the service uses the manager accounts resource 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.
|
6.2.4.10 LocalAccountTypes
- The list of local services in the manager that the remote user or group is allowed to access.
- This property shall contain an array of the various local manager services that the remote user or group is allowed to access. This shall not include functionality for receiving events or other notifications. If this property is not supported, the value shall be assumed to be an array that contains the value `Redfish`.
| string | Description |
|---|---|
| HostConsole | Allow access to the host's console, which could be connected through Telnet, SSH, or another 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 another 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.
|
6.2.4.11 Mode
The mode of operation for token validation.
- This property shall contain the mode of operation for token validation.
| string | Description |
|---|---|
| Discovery | OAuth 2.0 service information for token validation is downloaded by the service.
|
| Offline | OAuth 2.0 service information for token validation is configured by a client. Clients should configure the Issuer and OAuthServiceSigningKeys properties for this mode.
|
6.2.4.12 OAuth2Service
Various settings to parse an OAuth 2.0 service.
| Audience (v1.10+) [ ] | array (string) | read-only | The allowable audience strings of the Redfish service.
|
| Issuer (v1.10+) | string | read-write (null) |
The issuer string of the OAuth 2.0 service. Clients should configure this property if Mode contains Offline.
|
| Mode (v1.10+) | string (enum) |
read-write | The mode of operation for token validation.
|
| OAuthServiceSigningKeys (v1.10+) | string | read-write (null) |
The Base64-encoded signing keys of the issuer of the OAuth 2.0 service. Clients should configure this property if Mode contains Offline.
|
| Oem (v1.13+) {} | object | See the OEM object definition in the Using this guide clause. |
6.2.4.13 PasswordExchangeProtocols
- Indicates the allowed TACACS+ password exchange protocols.
- This property shall indicate all the allowed TACACS+ password exchange protocol described under section 5.4.2 of RFC8907.
| 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.
|
6.2.4.14 RestrictedPrivileges
- The set of restricted Redfish privileges.
- This property shall contain an array of Redfish privileges that are restricted by the service.
| string | Description |
|---|---|
| AdministrateStorage | Administrator for storage subsystems and storage systems found in the storage collection and storage system collection respectively. |
| AdministrateSystems | Administrator for systems found in the systems collection. Able to manage boot configuration, keys, and certificates for systems. |
| ConfigureComponents | Can configure components that this service manages. |
| ConfigureCompositionInfrastructure | Can view and configure composition service resources.
|
| ConfigureManager | Can configure managers. |
| ConfigureSelf | Can change the password for the current user account, log out of their own sessions, and perform operations on resources they created. Services will need to be aware of resource ownership to map this privilege to an operation from a particular user. |
| ConfigureUsers | Can configure users and their accounts. |
| Login | Can log in to the service and read resources. |
| NoAuth | Authentication is not required.
|
| OperateStorageBackup | Operator for storage backup functionality for storage subsystems and storage systems found in the storage collection and storage system collection respectively. |
| OperateSystems | Operator for systems found in the systems collection. Able to perform resets and configure interfaces. |
6.2.4.15 SupportedAccountTypes
- The account types supported by the service.
- This property shall contain an array of 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 another 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 another 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.
|
6.2.4.16 TACACSplusService
Various settings to parse a TACACS+ service.
| AuthorizationService (v1.13+) | string | read-write | The TACACS+ service authorization argument.
|
| Oem (v1.13+) {} | object | See the OEM object definition in the Using this guide clause. | |
| PasswordExchangeProtocols (v1.8+) [ ] | array (string (enum)) |
read-write (null) |
|
| PrivilegeLevelArgument (v1.8+) | string | read-write (null) |
Indicates the name of the TACACS+ argument name in an authorization request.
|
6.2.5 Example response
{
"@odata.type": "#AccountService.v1_16_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"
},
"RequireChangePasswordAction": false,
"@odata.id": "/redfish/v1/AccountService"
}6.3 ActionInfo 1.4.2
| Version | v1.4 | v1.3 | v1.2 | v1.1 | v1.0 |
| Release | 2023.2 | 2022.2 | 2021.2 | 2018.2 | 2016.2 |
6.3.1 Description
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.
- This resource shall represent the supported parameters and other information for a Redfish action on a target within a Redfish implementation. Supported parameters can differ among vendors and even among resource instances. This data can ensure that action requests from applications contain supported parameters.
6.3.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Parameters [ { | array | The list of parameters included in the specified Redfish action.
|
|
| AllowableNumbers (v1.3+) [ ] | array (string, null) | read-only | The allowable numeric values or duration values, inclusive ranges of values, and incremental step values for this parameter as applied to this action target.
|
| AllowablePattern (v1.3+) | string | read-only (null) |
The allowable pattern for this parameter as applied to this action target.
|
| AllowableValueDescriptions (v1.4+) [ ] | array (string, null) | read-only | Descriptions of allowable values for this parameter.
|
| AllowableValues [ ] | array (string, null) | read-only | The allowable values for this parameter as applied to this action target.
|
| ArraySizeMaximum (v1.2+) | integer | read-only (null) |
The maximum number of array elements allowed for this parameter.
|
| ArraySizeMinimum (v1.2+) | integer | read-only (null) |
The minimum number of array elements required for this parameter.
|
| DataType | string (enum) |
read-only (null) |
The JSON property type for this parameter.
|
| MaximumValue (v1.1+) | number | read-only (null) |
The maximum supported value for this parameter.
|
| MinimumValue (v1.1+) | number | read-only (null) |
The minimum supported value for this parameter.
|
| Name | string | read-only required | The name of the parameter for this action.
|
| ObjectDataType | string | read-only (null) |
The data type of an object-based parameter.
|
| Required | boolean | read-only | An indication of whether the parameter is required to complete this action.
|
| } ] |
6.3.3 Property details
6.3.3.1 DataType
The JSON property type for this parameter.
- This property shall contain 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. |
6.3.4 Example response
{
"@odata.type": "#ActionInfo.v1_4_2.ActionInfo",
"Id": "ResetActionInfo",
"Name": "Reset Action Info",
"Parameters": [
{
"Name": "ResetType",
"Required": true,
"DataType": "String",
"AllowableValues": [
"On",
"ForceOff",
"GracefulShutdown",
"GracefulRestart",
"ForceRestart",
"Nmi",
"ForceOn",
"PushPowerButton"
]
}
],
"@odata.id": "/redfish/v1/Systems/1/ResetActionInfo"
}6.4 AddressPool 1.3.0
| Version | v1.3 | v1.2 | v1.1 | v1.0 |
| Release | 2024.1 | 2021.2 | 2020.3 | 2019.4 |
6.4.1 Description
The AddressPool schema contains the definition of an address pool and its configuration.
- This resource shall represent an address pool in a Redfish implementation.
6.4.2 URIs
/redfish/v1/Fabrics/{FabricId}/AddressPools/{AddressPoolId}
6.4.3 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Ethernet (v1.1+) { | object | The Ethernet-related properties for this address pool.
|
|
| BFDSingleHopOnly (v1.1+) { | object | Bidirectional Forwarding Detection (BFD) related properties for this Ethernet fabric.
|
|
| DemandModeEnabled (v1.1+) | boolean | read-write (null) |
Bidirectional Forwarding Detection (BFD) Demand Mode status.
|
| DesiredMinTxIntervalMilliseconds (v1.1+) | integer | read-write (null) |
Desired Bidirectional Forwarding Detection (BFD) minimal transmit interval.
|
| KeyChain (v1.1+) | string | read-write (null) |
Bidirectional Forwarding Detection (BFD) Key Chain name.
|
| LocalMultiplier (v1.1+) | integer | read-write (null) |
Bidirectional Forwarding Detection (BFD) multiplier value.
|
| MeticulousModeEnabled (v1.1+) | boolean | read-write (null) |
Meticulous MD5 authentication of the Bidirectional Forwarding Detection (BFD) session.
|
| RequiredMinRxIntervalMilliseconds (v1.1+) | integer | read-write (null) |
Bidirectional Forwarding Detection (BFD) receive value.
|
| SourcePort (v1.1+) | integer | read-write (null) |
Bidirectional Forwarding Detection (BFD) source port.
|
| } | |||
| BGPEvpn (v1.1+) { | object | BGP Ethernet Virtual Private Network (EVPN) related properties for this Ethernet fabric.
|
|
| AnycastGatewayIPAddress (v1.1+) | string | read-write (null) |
The anycast gateway IPv4 address.
^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$ |
| AnycastGatewayMACAddress (v1.1+) | string | read-write (null) |
The anycast gateway MAC address.
^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ |
| ARPProxyEnabled (v1.1+) | boolean | read-write (null) |
Address Resolution Protocol (ARP) proxy status.
|
| ARPSuppressionEnabled (v1.3+) | boolean | read-write (null) |
Address Resolution Protocol (ARP) suppression status.
|
| ARPSupressionEnabled (v1.1+, deprecated v1.3) | boolean | read-write (null) |
Address Resolution Protocol (ARP) suppression status.
ARPSuppressionEnabled property. |
| ESINumberRange (v1.1+) { | object | The Ethernet Segment Identifier (ESI) number range for the fabric.
|
|
| Lower (v1.1+) | integer | read-write | Lower Ethernet Segment Identifier (ESI) number.
|
| Upper (v1.1+) | integer | read-write | Upper Ethernet Segment Identifier (ESI) number.
|
| } | |||
| EVINumberRange (v1.1+) { | object | The Ethernet Virtual Private Network (EVPN) Instance number (EVI) number range for the fabric.
|
|
| Lower (v1.1+) | integer | read-write | Lower Ethernet Virtual Private Network (EVPN) Instance (EVI) number.
|
| Upper (v1.1+) | integer | read-write | Upper Ethernet Virtual Private Network (EVPN) Instance (EVI) number.
|
| } | |||
| GatewayIPAddress (v1.1+) | string | read-write (null) |
The gateway IPv4 address.
^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$ |
| GatewayIPAddressRange (v1.2+) { | object | The IPv4 address range for gateways.
|
|
| Lower (v1.2+) | string | read-write (null) |
The lower IPv4 address.
^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$ |
| Upper (v1.2+) | string | read-write (null) |
The upper IPv4 address.
^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$ |
| } | |||
| NDPProxyEnabled (v1.1+) | boolean | read-write (null) |
Network Discovery Protocol (NDP) proxy status.
|
| NDPSuppressionEnabled (v1.3+) | boolean | read-write (null) |
Network Discovery Protocol (NDP) suppression status.
|
| NDPSupressionEnabled (v1.1+, deprecated v1.3) | boolean | read-write (null) |
Network Discovery Protocol (NDP) suppression status.
NDPSuppressionEnabled property. |
| RouteDistinguisherAdministratorSubfield (v1.2+) | string | read-write (null) |
The Route Distinguisher (RD) Administrator subfield.
|
| RouteDistinguisherRange (v1.1+) { | object | The Route Distinguisher (RD) number range for the fabric.
|
|
| Lower (v1.1+) | integer | read-write | Lower Route Distinguisher (RD) number.
|
| Upper (v1.1+) | integer | read-write | Upper Route Distinguisher (RD) number.
|
| } | |||
| RouteTargetAdministratorSubfield (v1.2+) | string | read-write (null) |
The Route Target (RT) Administrator Subfield.
|
| RouteTargetRange (v1.1+) { | object | The Route Target (RT) number range for the fabric.
|
|
| Lower (v1.1+) | integer | read-write (null) |
Lower Route Target (RT) number.
|
| Upper (v1.1+) | integer | read-write (null) |
Upper Route Target (RT) number.
|
| } | |||
| UnderlayMulticastEnabled (v1.1+) | boolean | read-write (null) |
Underlay multicast status.
|
| UnknownUnicastSuppressionEnabled (v1.1+) | boolean | read-write (null) |
Suppression of unknown unicast packets.
|
| VLANIdentifierAddressRange (v1.1+) { | object | Virtual LAN (VLAN) tag related address range applicable to this Ethernet fabric or for end-host subnets.
|
|
| Lower (v1.1+) | integer | read-write (null) |
Virtual LAN (VLAN) tag lower value.
|
| Upper (v1.1+) | integer | read-write (null) |
Virtual LAN (VLAN) tag upper value.
|
| } | |||
| } | |||
| EBGP (v1.1+) { | object | External BGP (eBGP) related properties for this Ethernet fabric.
|
|
| AllowDuplicateASEnabled (v1.1+) | boolean | read-write (null) |
Allow duplicate Autonomous System (AS) path.
|
| AllowOverrideASEnabled (v1.1+) | boolean | read-write (null) |
Option to override an Autonomous System (AS) number with the AS number of the sending peer.
|
| AlwaysCompareMEDEnabled (v1.1+) | boolean | read-write (null) |
Compare Multi Exit Discriminator (MED) status.
|
| ASNumberRange (v1.1+) { | object | Autonomous System (AS) number range.
|
|
| Lower (v1.1+) | integer | read-write | Lower Autonomous System (AS) number.
|
| Upper (v1.1+) | integer | read-write | Upper Autonomous System (AS) number.
|
| } | |||
| BGPLocalPreference (v1.1+) | integer | read-write (null) |
Local preference value.
|
| BGPNeighbor (v1.1+) { | object | Border Gateway Protocol (BGP) neighbor related properties.
|
|
| Address (v1.1+) | string | read-write (null) |
Border Gateway Protocol (BGP) neighbor address.
^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$ |
| AllowOwnASEnabled (v1.1+) | boolean | read-write (null) |
Allow own Autonomous System (AS) status.
|
| CIDR (v1.2+) | integer | read-write | The Classless Inter-Domain Routing (CIDR) value used for neighbor communication. This is the number of ones before the first zero in the subnet mask.
|
| ConnectRetrySeconds (v1.1+) | integer | read-write (null) |
Border Gateway Protocol (BGP) retry timer in seconds.
|
| Enabled (v1.2+) | boolean | read-write | An indication of whether BGP neighbor communication is enabled.
|
| HoldTimeSeconds (v1.1+) | integer | read-write (null) |
Border Gateway Protocol (BGP) hold timer in seconds.
|
| KeepaliveIntervalSeconds (v1.1+) | integer | read-write (null) |
Border Gateway Protocol (BGP) Keepalive timer in seconds.
|
| LocalAS (v1.1+) | integer | read-write (null) |
Local Autonomous System (AS) number.
|
| LogStateChangesEnabled (v1.1+) | boolean | read-write (null) |
Border Gateway Protocol (BGP) neighbor log state change status.
|
| MaxPrefix (v1.1+) { | object | Border Gateway Protocol (BGP) max prefix properties.
|
|
| MaxPrefixNumber (v1.1+) | integer | read-write (null) |
Maximum prefix number.
|
| RestartTimerSeconds (v1.1+) | integer | read-write (null) |
Border Gateway Protocol (BGP) restart timer in seconds.
|
| ShutdownThresholdPercentage (v1.1+) | number (%) |
read-write (null) |
Shutdown threshold status.
|
| ThresholdWarningOnlyEnabled (v1.1+) | boolean | read-write (null) |
Threshold warning only status.
|
| } | |||
| MinimumAdvertisementIntervalSeconds (v1.1+) | integer | read-write (null) |
Minimum Border Gateway Protocol (BGP) advertisement interval in seconds.
|
| PassiveModeEnabled (v1.1+) | boolean | read-write (null) |
Border Gateway Protocol (BGP) passive mode status.
|
| PathMTUDiscoveryEnabled (v1.1+) | boolean | read-write (null) |
Path MTU discovery status.
|
| PeerAS (v1.1+) | integer | read-write (null) |
Peer Autonomous System (AS) number.
|
| ReplacePeerASEnabled (v1.1+) | boolean | read-write (null) |
Replace Border Gateway Protocol (BGP) peer Autonomous System (AS) status.
|
| TCPMaxSegmentSizeBytes (v1.1+) | integer | read-write (null) |
TCP max segment size in bytes.
|
| TreatAsWithdrawEnabled (v1.1+) | boolean | read-write (null) |
Border Gateway Protocol (BGP) treat as withdraw status.
|
| } | |||
| BGPRoute (v1.1+) { | object | Border Gateway Protocol (BGP) route-related properties.
|
|
| AdvertiseInactiveRoutesEnabled (v1.1+) | boolean | read-write (null) |
Advertise inactive route status.
|
| DistanceExternal (v1.1+) | integer | read-write (null) |
Route distance for external routes.
|
| DistanceInternal (v1.1+) | integer | read-write (null) |
Route distance for internal routes.
|
| DistanceLocal (v1.1+) | integer | read-write (null) |
Route distance for local routes.
|
| ExternalCompareRouterIdEnabled (v1.1+) | boolean | read-write (null) |
Compare router identifier status.
|
| FlapDampingEnabled (v1.1+) | boolean | read-write (null) |
Route flap dampening status.
|
| SendDefaultRouteEnabled (v1.1+) | boolean | read-write (null) |
Send default route status.
|
| } | |||
| BGPWeight (v1.1+) | integer | read-write (null) |
BGP weight attribute.
|
| GracefulRestart (v1.1+) { | object | Graceful restart related properties.
|
|
| GracefulRestartEnabled (v1.1+) | boolean | read-write (null) |
Border Gateway Protocol (BGP) graceful restart status.
|
| HelperModeEnabled (v1.1+) | boolean | read-write (null) |
Graceful restart helper mode status.
|
| StaleRoutesTimeSeconds (v1.1+) | integer | read-write (null) |
Stale route timer in seconds.
|
| TimeSeconds (v1.1+) | integer | read-write (null) |
Graceful restart timer in seconds.
|
| } | |||
| MED (v1.1+) | integer | read-write (null) |
BGP Multi Exit Discriminator (MED) value.
|
| MultihopEnabled (v1.1+) | boolean | read-write (null) |
External BGP (eBGP) multihop status.
|
| MultihopTTL (v1.1+) | integer | read-write (null) |
External BGP (eBGP) multihop Time to Live (TTL) value.
|
| MultiplePaths (v1.1+) { | object | Multiple path related properties.
|
|
| MaximumPaths (v1.1+) | integer | read-write (null) |
Maximum paths number.
|
| UseMultiplePathsEnabled (v1.1+) | boolean | read-write (null) |
Border Gateway Protocol (BGP) multiple paths status.
|
| } | |||
| SendCommunityEnabled (v1.1+) | boolean | read-write (null) |
Indicates whether community attributes are sent.
|
| } | |||
| IPv4 (v1.1+) { | object | IPv4 and Virtual LAN (VLAN) related addressing for this Ethernet fabric.
|
|
| AnycastGatewayIPAddress (v1.1+) | string | read-write (null) |
The anycast gateway IPv4 address.
^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$ |
| AnycastGatewayMACAddress (v1.1+) | string | read-write (null) |
The anycast gateway MAC address.
^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ |
| DHCP (v1.1+) { | object | The Dynamic Host Configuration Protocol (DHCP) related addressing for this Ethernet fabric.
|
|
| DHCPInterfaceMTUBytes (v1.1+) | integer | read-write (null) |
Dynamic Host Configuration Protocol (DHCP) interface Maximum Transmission Unit (MTU).
|
| DHCPRelayEnabled (v1.1+) | boolean | read-write (null) |
Dynamic Host Configuration Protocol (DHCP) relay status.
|
| DHCPServer (v1.1+) [ ] | array (string, null) | read-write | The Dynamic Host Configuration Protocol (DHCP) IPv4 addresses for this Ethernet fabric.
|
| } | |||
| DistributeIntoUnderlayEnabled (v1.1+) | boolean | read-write (null) |
Indicates if host subnets should be distributed into the fabric underlay.
|
| DNSDomainName (v1.1+) | string | read-write (null) |
The Domain Name Service (DNS) domain name for this Ethernet fabric.
|
| DNSServer (v1.1+) [ ] | array (string, null) | read-write | The Domain Name Service (DNS) servers for this Ethernet fabric.
^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$ |
| EBGPAddressRange (v1.1+) {} | object | External BGP (eBGP) related addressing for this Ethernet fabric.
|
|
| FabricLinkAddressRange (v1.1+) {} | object | Link-related IPv4 addressing for this Ethernet fabric typically applied to connections between spine and leaf Ethernet switches.
|
|
| GatewayIPAddress (v1.1+) | string | read-write (null) |
The gateway IPv4 address.
^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$ |
| HostAddressRange (v1.1+) {} | object | IPv4-related host subnet addressing for physical device endpoints that connect to this Ethernet fabric.
|
|
| IBGPAddressRange (v1.1+) {} | object | Internal BGP (iBGP) related addressing for this Ethernet fabric.
|
|
| LoopbackAddressRange (v1.1+) {} | object | Loopback-related IPv4 addressing for this Ethernet fabric.
|
|
| ManagementAddressRange (v1.1+) {} | object | Management-related addressing for this Ethernet fabric.
|
|
| NativeVLAN (v1.1+) | integer | read-write (null) |
The untagged Virtual LAN (VLAN) ID value.
|
| NTPOffsetHoursMinutes (v1.1+) | integer | read-write (null) |
The Network Time Protocol (NTP) offset configuration.
|
| NTPServer (v1.1+) [ ] | array (string, null) | read-write | The Network Time Protocol (NTP) servers for this Ethernet fabric.
|
| NTPTimezone (v1.1+) | string | read-write (null) |
The Network Time Protocol (NTP) time zone for this Ethernet fabric.
|
| SystemMACRange (v1.2+) { | object | The MAC address range for systems in this subnet.
|
|
| Lower (v1.2+) | string | read-write (null) |
The lower system MAC address.
^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ |
| Upper (v1.2+) | string | read-write (null) |
The upper system MAC address.
^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ |
| } | |||
| VLANIdentifierAddressRange (v1.1+) { | object | Virtual LAN (VLAN) tag related addressing for this Ethernet fabric or for end-host networks.
|
|
| Lower (v1.1+) | integer | read-write (null) |
Virtual LAN (VLAN) tag lower value.
|
| Upper (v1.1+) | integer | read-write (null) |
Virtual LAN (VLAN) tag upper value.
|
| } | |||
| } | |||
| MultiProtocolEBGP (v1.1+) { | object | Multi Protocol eBGP (MP eBGP) related properties for this Ethernet fabric.
|
|
| AllowDuplicateASEnabled (v1.1+) | boolean | read-write (null) |
Allow duplicate Autonomous System (AS) path.
|
| AllowOverrideASEnabled (v1.1+) | boolean | read-write (null) |
Option to override an Autonomous System (AS) number with the AS number of the sending peer.
|
| AlwaysCompareMEDEnabled (v1.1+) | boolean | read-write (null) |
Compare Multi Exit Discriminator (MED) status.
|
| ASNumberRange (v1.1+) { | object | Autonomous System (AS) number range.
|
|
| Lower (v1.1+) | integer | read-write | Lower Autonomous System (AS) number.
|
| Upper (v1.1+) | integer | read-write | Upper Autonomous System (AS) number.
|
| } | |||
| BGPLocalPreference (v1.1+) | integer | read-write (null) |
Local preference value.
|
| BGPNeighbor (v1.1+) { | object | Border Gateway Protocol (BGP) neighbor related properties.
|
|
| Address (v1.1+) | string | read-write (null) |
Border Gateway Protocol (BGP) neighbor address.
^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$ |
| AllowOwnASEnabled (v1.1+) | boolean | read-write (null) |
Allow own Autonomous System (AS) status.
|
| CIDR (v1.2+) | integer | read-write | The Classless Inter-Domain Routing (CIDR) value used for neighbor communication. This is the number of ones before the first zero in the subnet mask.
|
| ConnectRetrySeconds (v1.1+) | integer | read-write (null) |
Border Gateway Protocol (BGP) retry timer in seconds.
|
| Enabled (v1.2+) | boolean | read-write | An indication of whether BGP neighbor communication is enabled.
|
| HoldTimeSeconds (v1.1+) | integer | read-write (null) |
Border Gateway Protocol (BGP) hold timer in seconds.
|
| KeepaliveIntervalSeconds (v1.1+) | integer | read-write (null) |
Border Gateway Protocol (BGP) Keepalive timer in seconds.
|
| LocalAS (v1.1+) | integer | read-write (null) |
Local Autonomous System (AS) number.
|
| LogStateChangesEnabled (v1.1+) | boolean | read-write (null) |
Border Gateway Protocol (BGP) neighbor log state change status.
|
| MaxPrefix (v1.1+) { | object | Border Gateway Protocol (BGP) max prefix properties.
|
|
| MaxPrefixNumber (v1.1+) | integer | read-write (null) |
Maximum prefix number.
|
| RestartTimerSeconds (v1.1+) | integer | read-write (null) |
Border Gateway Protocol (BGP) restart timer in seconds.
|
| ShutdownThresholdPercentage (v1.1+) | number (%) |
read-write (null) |
Shutdown threshold status.
|
| ThresholdWarningOnlyEnabled (v1.1+) | boolean | read-write (null) |
Threshold warning only status.
|
| } | |||
| MinimumAdvertisementIntervalSeconds (v1.1+) | integer | read-write (null) |
Minimum Border Gateway Protocol (BGP) advertisement interval in seconds.
|
| PassiveModeEnabled (v1.1+) | boolean | read-write (null) |
Border Gateway Protocol (BGP) passive mode status.
|
| PathMTUDiscoveryEnabled (v1.1+) | boolean | read-write (null) |
Path MTU discovery status.
|
| PeerAS (v1.1+) | integer | read-write (null) |
Peer Autonomous System (AS) number.
|
| ReplacePeerASEnabled (v1.1+) | boolean | read-write (null) |
Replace Border Gateway Protocol (BGP) peer Autonomous System (AS) status.
|
| TCPMaxSegmentSizeBytes (v1.1+) | integer | read-write (null) |
TCP max segment size in bytes.
|
| TreatAsWithdrawEnabled (v1.1+) | boolean | read-write (null) |
Border Gateway Protocol (BGP) treat as withdraw status.
|
| } | |||
| BGPRoute (v1.1+) { | object | Border Gateway Protocol (BGP) route-related properties.
|
|
| AdvertiseInactiveRoutesEnabled (v1.1+) | boolean | read-write (null) |
Advertise inactive route status.
|
| DistanceExternal (v1.1+) | integer | read-write (null) |
Route distance for external routes.
|
| DistanceInternal (v1.1+) | integer | read-write (null) |
Route distance for internal routes.
|
| DistanceLocal (v1.1+) | integer | read-write (null) |
Route distance for local routes.
|
| ExternalCompareRouterIdEnabled (v1.1+) | boolean | read-write (null) |
Compare router identifier status.
|
| FlapDampingEnabled (v1.1+) | boolean | read-write (null) |
Route flap dampening status.
|
| SendDefaultRouteEnabled (v1.1+) | boolean | read-write (null) |
Send default route status.
|
| } | |||
| BGPWeight (v1.1+) | integer | read-write (null) |
BGP weight attribute.
|
| GracefulRestart (v1.1+) { | object | Graceful restart related properties.
|
|
| GracefulRestartEnabled (v1.1+) | boolean | read-write (null) |
Border Gateway Protocol (BGP) graceful restart status.
|
| HelperModeEnabled (v1.1+) | boolean | read-write (null) |
Graceful restart helper mode status.
|
| StaleRoutesTimeSeconds (v1.1+) | integer | read-write (null) |
Stale route timer in seconds.
|
| TimeSeconds (v1.1+) | integer | read-write (null) |
Graceful restart timer in seconds.
|
| } | |||
| MED (v1.1+) | integer | read-write (null) |
BGP Multi Exit Discriminator (MED) value.
|
| MultihopEnabled (v1.1+) | boolean | read-write (null) |
External BGP (eBGP) multihop status.
|
| MultihopTTL (v1.1+) | integer | read-write (null) |
External BGP (eBGP) multihop Time to Live (TTL) value.
|
| MultiplePaths (v1.1+) { | object | Multiple path related properties.
|
|
| MaximumPaths (v1.1+) | integer | read-write (null) |
Maximum paths number.
|
| UseMultiplePathsEnabled (v1.1+) | boolean | read-write (null) |
Border Gateway Protocol (BGP) multiple paths status.
|
| } | |||
| SendCommunityEnabled (v1.1+) | boolean | read-write (null) |
Indicates whether community attributes are sent.
|
| } | |||
| MultiProtocolIBGP (v1.1+) { | object | Multi Protocol iBGP (MP iBGP) related properties for this Ethernet fabric.
|
|
| ASNumberRange (v1.1+) { | object | Autonomous System (AS) number range.
|
|
| Lower (v1.1+) | integer | read-write | Lower Autonomous System (AS) number.
|
| Upper (v1.1+) | integer | read-write | Upper Autonomous System (AS) number.
|
| } | |||
| BGPNeighbor (v1.1+) { | object | Border Gateway Protocol (BGP) neighbor related properties.
|
|
| Address (v1.1+) | string | read-write (null) |
Border Gateway Protocol (BGP) neighbor address.
^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$ |
| AllowOwnASEnabled (v1.1+) | boolean | read-write (null) |
Allow own Autonomous System (AS) status.
|
| CIDR (v1.2+) | integer | read-write | The Classless Inter-Domain Routing (CIDR) value used for neighbor communication. This is the number of ones before the first zero in the subnet mask.
|
| ConnectRetrySeconds (v1.1+) | integer | read-write (null) |
Border Gateway Protocol (BGP) retry timer in seconds.
|
| Enabled (v1.2+) | boolean | read-write | An indication of whether BGP neighbor communication is enabled.
|
| HoldTimeSeconds (v1.1+) | integer | read-write (null) |
Border Gateway Protocol (BGP) hold timer in seconds.
|
| KeepaliveIntervalSeconds (v1.1+) | integer | read-write (null) |
Border Gateway Protocol (BGP) Keepalive timer in seconds.
|
| LocalAS (v1.1+) | integer | read-write (null) |
Local Autonomous System (AS) number.
|
| LogStateChangesEnabled (v1.1+) | boolean | read-write (null) |
Border Gateway Protocol (BGP) neighbor log state change status.
|
| MaxPrefix (v1.1+) { | object | Border Gateway Protocol (BGP) max prefix properties.
|
|
| MaxPrefixNumber (v1.1+) | integer | read-write (null) |
Maximum prefix number.
|
| RestartTimerSeconds (v1.1+) | integer | read-write (null) |
Border Gateway Protocol (BGP) restart timer in seconds.
|
| ShutdownThresholdPercentage (v1.1+) | number (%) |
read-write (null) |
Shutdown threshold status.
|
| ThresholdWarningOnlyEnabled (v1.1+) | boolean | read-write (null) |
Threshold warning only status.
|
| } | |||
| MinimumAdvertisementIntervalSeconds (v1.1+) | integer | read-write (null) |
Minimum Border Gateway Protocol (BGP) advertisement interval in seconds.
|
| PassiveModeEnabled (v1.1+) | boolean | read-write (null) |
Border Gateway Protocol (BGP) passive mode status.
|
| PathMTUDiscoveryEnabled (v1.1+) | boolean | read-write (null) |
Path MTU discovery status.
|
| PeerAS (v1.1+) | integer | read-write (null) |
Peer Autonomous System (AS) number.
|
| ReplacePeerASEnabled (v1.1+) | boolean | read-write (null) |
Replace Border Gateway Protocol (BGP) peer Autonomous System (AS) status.
|
| TCPMaxSegmentSizeBytes (v1.1+) | integer | read-write (null) |
TCP max segment size in bytes.
|
| TreatAsWithdrawEnabled (v1.1+) | boolean | read-write (null) |
Border Gateway Protocol (BGP) treat as withdraw status.
|
| } | |||
| BGPRoute (v1.1+) { | object | Border Gateway Protocol (BGP) route-related properties.
|
|
| AdvertiseInactiveRoutesEnabled (v1.1+) | boolean | read-write (null) |
Advertise inactive route status.
|
| DistanceExternal (v1.1+) | integer | read-write (null) |
Route distance for external routes.
|
| DistanceInternal (v1.1+) | integer | read-write (null) |
Route distance for internal routes.
|
| DistanceLocal (v1.1+) | integer | read-write (null) |
Route distance for local routes.
|
| ExternalCompareRouterIdEnabled (v1.1+) | boolean | read-write (null) |
Compare router identifier status.
|
| FlapDampingEnabled (v1.1+) | boolean | read-write (null) |
Route flap dampening status.
|
| SendDefaultRouteEnabled (v1.1+) | boolean | read-write (null) |
Send default route status.
|
| } | |||
| GracefulRestart (v1.1+) { | object | Graceful restart related properties.
|
|
| GracefulRestartEnabled (v1.1+) | boolean | read-write (null) |
Border Gateway Protocol (BGP) graceful restart status.
|
| HelperModeEnabled (v1.1+) | boolean | read-write (null) |
Graceful restart helper mode status.
|
| StaleRoutesTimeSeconds (v1.1+) | integer | read-write (null) |
Stale route timer in seconds.
|
| TimeSeconds (v1.1+) | integer | read-write (null) |
Graceful restart timer in seconds.
|
| } | |||
| MultiplePaths (v1.1+) { | object | Multiple path related properties.
|
|
| MaximumPaths (v1.1+) | integer | read-write (null) |
Maximum paths number.
|
| UseMultiplePathsEnabled (v1.1+) | boolean | read-write (null) |
Border Gateway Protocol (BGP) multiple paths status.
|
| } | |||
| SendCommunityEnabled (v1.1+) | boolean | read-write (null) |
Indicates whether community attributes are sent.
|
| } | |||
| } | |||
| GenZ { | object | The Gen-Z related properties for this address pool.
|
|
| AccessKey | string | read-write (null) |
The Access Key required for this address pool.
^0[xX]([a-fA-F]|[0-9]){2}$ |
| MaxCID | integer | read-write (null) |
The maximum value for the Component Identifier (CID).
|
| MaxSID | integer | read-write (null) |
The maximum value for the Subnet Identifier (SID).
|
| MinCID | integer | read-write (null) |
The minimum value for the Component Identifier (CID).
|
| MinSID | integer | read-write (null) |
The minimum value for the Subnet Identifier (SID).
|
| } | |||
| Links { | object | The links to other resources that are related to this resource.
|
|
| Endpoints [ { | array | An array of links to the endpoints that this address pool contains.
|
|
| @odata.id | string | read-write | Link to a Endpoint resource. See the Links section and the Endpoint schema for details. |
| } ] | |||
| Oem {} | object | See the OEM object definition in the Using this guide clause. | |
| Zones [ { | array | An array of links to the zones that this address pool contains.
|
|
| @odata.id | string | read-write | Link to a Zone resource. See the Links section and the Zone schema for details. |
| } ] | |||
| } | |||
| Status {} | object | The status and health of the resource and its subordinate or dependent resources.
|
6.4.4 Property details
6.4.4.1 IPv4AddressRange
IPv4-related address range for an Ethernet fabric.
| Lower (v1.1+) | string | read-write (null) |
Lower IPv4 network address.
^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$ |
| Upper (v1.1+) | string | read-write (null) |
Upper IPv4 network address.
^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$ |
6.4.5 Example response
{
"@odata.type": "#AddressPool.v1_3_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"
}
]
},
"@odata.id": "/redfish/v1/Fabrics/GenZ/AddressPools/AP1"
}6.5 Aggregate 1.0.3
| Version | v1.0 |
| Release | 2020.2 |
6.5.1 Description
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.
- This resource shall represent an aggregation service grouping method for a Redfish implementation.
6.5.2 URIs
/redfish/v1/AggregationService/Aggregates/{AggregateId}
6.5.3 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Elements [ { | array | required | The elements of this aggregate.
|
| @odata.id | string (URI) |
read-only | The unique identifier for a resource.
|
| } ] | |||
| ElementsCount | integer | read-only (null) |
The number of entries in the Elements array.
|
6.5.4 Actions
6.5.4.1 AddElements
Description
This action is used to add one or more resources to the aggregate.
- This action shall add one or more resources to the aggregate, with the result that the resources are included in the
Elementsarray of the aggregate.
Action URI
{Base URI of target resource}/Actions/Aggregate.AddElements
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| Elements [ { | array | required | An array of resource links to add to the Elements array.
|
| @odata.id | string (URI) |
read-only | The unique identifier for a resource.
|
| } ] |
Request Example
{
"Elements": [
{
"@odata.id": "/redfish/v1/Systems/cluster-node7"
},
{
"@odata.id": "node8.intranet.contoso.com/redfish/v1/Systems/1"
}
]
}6.5.4.2 RemoveElements
Description
This action is used to remove one or more resources from the aggregate.
- This action shall remove one or more resources from the aggregate, with the result that the resources are removed from the
Elementsarray of the aggregate.
Action URI
{Base URI of target resource}/Actions/Aggregate.RemoveElements
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| Elements [ { | array | required | An array of resource links to remove from the Elements array.
|
| @odata.id | string (URI) |
read-only | The unique identifier for a resource.
|
| } ] |
Request Example
{
"Elements": [
{
"@odata.id": "node8.intranet.contoso.com/redfish/v1/Systems/1"
}
]
}6.5.4.3 Reset
Description
This action is used to reset a collection of resources. For example, this could be an aggregate or a list of computer systems.
- This action shall perform a reset of a collection of resources.
Action URI
{Base URI of target resource}/Actions/Aggregate.Reset
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| BatchSize | integer | optional | The number of elements in each batch being reset.
|
| DelayBetweenBatchesInSeconds | integer (seconds) |
optional | The delay of the batches of elements being reset in seconds.
|
| ResetType | string (enum) |
optional | The type of reset.
|
Request Example
{
"ResetType": "ForceRestart",
"BatchSize": 5,
"DelayBetweenBatchesInSeconds": 30
}6.5.4.4 SetDefaultBootOrder
Description
This action is used to restore the boot order to the default state for the computer systems that are members of this aggregate.
- This action shall 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.SetDefaultBootOrder
Action parameters
This action takes no parameters.
6.5.5 Property details
6.5.5.1 ResetType
The type of reset.
- This parameter shall contain the type of reset. The service can accept a request without the parameter and perform an implementation-specific default 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 unit.
|
| GracefulRestart | Shut down gracefully and restart the unit.
|
| 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.
|
| Pause | Pause execution on the unit but do not remove power. This is typically a feature of virtual machine hypervisors.
|
| 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.
|
| Resume | Resume execution on the paused unit. This is typically a feature of virtual machine hypervisors.
|
| Suspend | Write the state of the unit to disk before powering off. This allows for the state to be restored when powered back on.
|
6.5.6 Example response
{
"@odata.type": "#Aggregate.v1_0_3.Aggregate",
"Id": "Aggregate1",
"Name": "Aggregate One",
"ElementsCount": 2,
"Elements": [
{
"@odata.id": "/redfish/v1/Systems/cluster-node3"
},
{
"@odata.id": "/redfish/v1/Systems/cluster-node4"
}
],
"Actions": {
"#Aggregate.Reset": {
"target": "/redfish/v1/AggregationService/Aggregates/Aggregate1/Actions/Aggregate.Reset",
"@Redfish.ActionInfo": "/redfish/v1/AggregationService/Aggregates/Aggregate1/ResetActionInfo"
},
"#Aggregate.SetDefaultBootOrder": {
"target": "/redfish/v1/AggregationService/Aggregates/Aggregate1/Actions/Aggregate.SetDefaultBootOrder",
"@Redfish.ActionInfo": "/redfish/v1/AggregationService/Aggregates/Aggregate1/SetDefaultBootOrderActionInfo"
},
"#Aggregate.AddElements": {
"target": "/redfish/v1/AggregationService/Aggregates/Aggregate1/Actions/Aggregate.AddElements",
"@Redfish.ActionInfo": "/redfish/v1/AggregationService/Aggregates/Aggregate1/AddElementsActionInfo"
},
"#Aggregate.RemoveElements": {
"target": "/redfish/v1/AggregationService/Aggregates/Aggregate1/Actions/Aggregate.RemoveElements",
"@Redfish.ActionInfo": "/redfish/v1/AggregationService/Aggregates/Aggregate1/RemoveElementsActionInfo"
}
},
"@odata.id": "/redfish/v1/AggregationService/Aggregates/Aggregate1"
}6.6 AggregationService 1.0.3
| Version | v1.0 |
| Release | 2020.2 |
6.6.1 Description
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.
- This resource shall represent an aggregation service for a Redfish implementation.
6.6.2 URIs
/redfish/v1/AggregationService
6.6.3 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Aggregates { | object | The link to the collection of aggregates associated with this service.
|
|
| @odata.id | string | read-only | Link to Collection of Aggregate. See the Aggregate schema for details. |
| } | |||
| AggregationSources { | object | The link to the collection of aggregation sources associated with this service.
|
|
| @odata.id | string | read-only | Link to Collection of AggregationSource. See the AggregationSource schema for details. |
| } | |||
| ConnectionMethods { | object | The link to the collection of connection methods associated with this service.
|
|
| @odata.id | string | read-only | Link to Collection of ConnectionMethod. See the ConnectionMethod schema for details. |
| } | |||
| ServiceEnabled | boolean | read-write (null) |
An indication of whether the aggregation service is enabled.
|
| Status {} | object | The status and health of the resource and its subordinate or dependent resources.
|
6.6.4 Actions
6.6.4.1 Reset
Description
This action is used to reset a set of resources. For example this could be a list of computer systems.
- This action shall perform a reset of a set of resources.
Action URI
{Base URI of target resource}/Actions/AggregationService.Reset
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| BatchSize | integer | optional | The number of elements in each batch being reset.
|
| DelayBetweenBatchesInSeconds | integer (seconds) |
optional | The delay of the batches of elements being reset in seconds.
|
| ResetType | string (enum) |
optional | The type of reset.
|
| TargetURIs [ { | array | required | An array of links to the resources being reset.
|
| @odata.id | string (URI) |
read-only | The unique identifier for a resource.
|
| } ] |
Request Example
{
"ResetType": "ForceRestart",
"BatchSize": 1,
"DelayBetweenBatchesInSeconds": 30,
"TargetURIs": [
{
"@odata.id": "/redfish/v1/Systems/cluster-node3"
},
{
"@odata.id": "/redfish/v1/Systems/cluster-node4"
},
{
"@odata.id": "node7.intranet.contoso.com/redfish/v1/Systems/1"
}
]
}6.6.4.2 SetDefaultBootOrder
Description
This action is used to restore the boot order to the default state for the specified computer systems.
- This action shall restore the boot order to the default state for the specified computer systems.
Action URI
{Base URI of target resource}/Actions/AggregationService.SetDefaultBootOrder
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| Systems [ { | array | required | The computer systems to restore.
|
| @odata.id | string | read-only | Link to a ComputerSystem resource. See the Links section and the ComputerSystem schema for details. |
| } ] |
Request Example
{
"Systems": [
{
"@odata.id": "/redfish/v1/Systems/cluster-node3"
},
{
"@odata.id": "/redfish/v1/Systems/cluster-node4"
},
{
"@odata.id": "node7.intranet.contoso.com/redfish/v1/Systems/1"
}
]
}6.6.5 Property details
6.6.5.1 ResetType
The type of reset.
- This parameter shall contain the type of reset. The service can accept a request without the parameter and perform an implementation-specific default 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 unit.
|
| GracefulRestart | Shut down gracefully and restart the unit.
|
| 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.
|
| Pause | Pause execution on the unit but do not remove power. This is typically a feature of virtual machine hypervisors.
|
| 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.
|
| Resume | Resume execution on the paused unit. This is typically a feature of virtual machine hypervisors.
|
| Suspend | Write the state of the unit to disk before powering off. This allows for the state to be restored when powered back on.
|
6.6.6 Example response
{
"@odata.type": "#AggregationService.v1_0_3.AggregationService",
"Id": "AggregationService",
"Description": "Aggregation Service",
"Name": "Aggregation Service",
"ServiceEnabled": true,
"Status": {
"Health": "OK",
"HealthRollup": "OK",
"State": "Enabled"
},
"Aggregates": {
"@odata.id": "/redfish/v1/AggregationService/Aggregates"
},
"AggregationSources": {
"@odata.id": "/redfish/v1/AggregationService/AggregationSources"
},
"ConnectionMethods": {
"@odata.id": "/redfish/v1/AggregationService/ConnectionMethods"
},
"Actions": {
"#AggregationService.Reset": {
"target": "/redfish/v1/AggregationService/Actions/AggregationService.Reset",
"@Redfish.ActionInfo": "/redfish/v1/AggregationService/ResetActionInfo"
},
"#AggregationService.SetDefaultBootOrder": {
"target": "/redfish/v1/AggregationService/Actions/AggregationService.SetDefaultBootOrder",
"@Redfish.ActionInfo": "/redfish/v1/AggregationService/SetDefaultBootOrderActionInfo"
}
},
"@odata.id": "/redfish/v1/AggregationService/"
}6.7 AggregationSource 1.4.3
| Version | v1.4 | v1.3 | v1.2 | v1.1 | v1.0 |
| Release | 2023.3 | 2022.3 | 2021.3 | 2020.4 | 2020.2 |
6.7.1 Description
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.
- This resource shall represent an aggregation source for a Redfish implementation.
6.7.2 URIs
/redfish/v1/AggregationService/AggregationSources/{AggregationSourceId}
6.7.3 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| AggregationType (v1.2+) | string (enum) |
read-write | The type of aggregation used towards the aggregation source.
|
| HostName | string (URI) |
read-write (null) |
The URI of the system to be accessed.
|
| Links { | object | The links to other resources that are related to this resource.
|
|
| ConnectionMethod { | object | A link to the connection method used to contact this aggregation source.
|
|
| @odata.id | string | read-only | Link to a ConnectionMethod resource. See the Links section and the ConnectionMethod schema for details. |
| } | |||
| Oem {} | object | See the OEM object definition in the Using this guide clause. | |
| ResourcesAccessed [ { | 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.
|
|
| @odata.id | string (URI) |
read-only | The unique identifier for a resource.
|
| } ] | |||
| } | |||
| Password | string | read-write (null) |
The password for accessing the aggregation source. The value is null in responses.
|
| SNMP (v1.1+) { | object | SNMP settings of the aggregation source.
|
|
| AuthenticationKey (v1.1+) | string | read-write (null) |
The secret authentication key for SNMPv3.
(^[ -~]+$)|(^Passphrase:[ -~]+$)|(^Hex:[0-9A-Fa-f]{24,96}$)|(^\*+$) |
| AuthenticationKeySet (v1.1+) | boolean | read-only | Indicates if the AuthenticationKey property is set.
|
| AuthenticationProtocol (v1.1+) | string (enum) |
read-write (null) |
The authentication protocol for SNMPv3.
|
| EncryptionKey (v1.1+) | string | read-write (null) |
The secret authentication key for SNMPv3.
(^[ -~]+$)|(^Passphrase:[ -~]+$)|(^Hex:[0-9A-Fa-f]{16,64}$)|(^\*+$) |
| EncryptionKeySet (v1.1+) | boolean | read-only | Indicates if the EncryptionKey property is set.
|
| EncryptionProtocol (v1.1+) | string (enum) |
read-write (null) |
The encryption protocol for SNMPv3.
|
| TrapCommunity (v1.2+) | string | read-write (null) |
The SNMP trap community string.
|
| } | |||
| SSHSettings (v1.3+) { | object | Settings for an aggregation source using SSH as part of the associated connection method.
|
|
| PresentedPublicHostKey (v1.3+) { | object | A link to the last public host key presented by the remote service corresponding to the aggregation source. A client that trusts this public host key can add the public host key to the TrustedPublicHostKeys collection to allow SSH communication with the aggregation source.
|
|
| @odata.id | string | read-only | Link to a Key resource. See the Links section and the Key schema for details. |
| } | |||
| PresentedPublicHostKeyTimestamp (v1.3+) | string (date-time) |
read-only (null) |
The date and time when the key referenced by the PresentedPublicHostKey property was last updated.
|
| PublicIdentityKey (v1.3+) { | object | A link to the public key that is used with the aggregation source when the authentication method is configured to use a public key. The GenerateSSHIdentityKeyPair and RemoveSSHIdentityKeyPair are used to update the key for this aggregation source.
|
|
| @odata.id | string | read-only | Link to a Key resource. See the Links section and the Key schema for details. |
| } | |||
| TrustedPublicHostKeys (v1.3+) { | object | A link to the trusted public host keys of the remote service corresponding to the aggregation source. These trusted public host keys are used for authentication of the remote service with SSH. An SSH public host key of the remote service can be added to this collection to allow for public key-based SSH authentication.
|
|
| @odata.id | string | read-only | Link to Collection of Key. See the Key schema for details. |
| } | |||
| UserAuthenticationMethod (v1.3+) | string (enum) |
read-write (null) |
The client user authentication method.
|
| } | |||
| Status (v1.3+) {} | object | The status and health of the resource and its subordinate or dependent resources.
|
|
| UserName | string | read-write (null) |
The username for accessing the aggregation source.
|
6.7.4 Actions
6.7.4.1 GenerateSSHIdentityKeyPair (v1.3+)
Description
This action generates a new SSH identity key-pair to be used with this aggregation source. The generated public key is stored in the Key resource referenced by the PublicIdentityKey property in SSHSettings. Any existing key-pair is deleted and replaced by the new key-pair.
- This action shall generate a new SSH identity key-pair to be used with this aggregation source. The service shall store the generated public key in the
Keyresource referenced by thePublicIdentityKeyproperty inSSHSettings. If the aggregation source already has an associated SSH identity key-pair, the service shall delete the key-pair and replace it with the new key-pair.
Action URI
{Base URI of target resource}/Actions/AggregationSource.GenerateSSHIdentityKeyPair
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| Curve | string (enum) |
optional | The curve to use with the SSH key if the KeyType parameter contains ECDSA.
|
| KeyLength | integer | optional | The length of the SSH key, in bits, if the KeyType parameter contains RSA.
|
| KeyType | string (enum) |
required | The type of SSH key.
|
Request Example
{
"KeyType": "Ed25519"
}6.7.4.2 RemoveSSHIdentityKeyPair (v1.3+)
Description
This action removes the SSH identity key-pair used with this aggregation source.
- This action shall remove the private SSH identity key-pair used with this aggregation source.
Action URI
{Base URI of target resource}/Actions/AggregationSource.RemoveSSHIdentityKeyPair
Action parameters
This action takes no parameters.
6.7.5 Property details
6.7.5.1 AggregationType
The type of aggregation used towards the aggregation source.
- This property shall contain the type of aggregation used for the connection method towards the aggregation source. If this property is not present, the value shall be assumed to be
Full.
| string | Description |
|---|---|
| Full | Full aggregation according to connection method.
|
| NotificationsOnly | Only notifications are aggregated.
|
6.7.5.2 AuthenticationProtocol
The authentication protocol for SNMPv3.
- This property shall contain the SNMPv3 authentication protocol.
| 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.
|
6.7.5.3 Curve
The curve to use with the SSH key if the KeyType parameter contains ECDSA.
- This parameter shall contain the curve to use with the SSH key. This parameter shall be required if the
KeyTypeparameter containsECDSAand shall be rejected for other values.
| string | Description |
|---|---|
| NISTB233 | NIST B-233.
|
| NISTB409 | NIST B-409.
|
| NISTK163 | NIST K-163.
|
| NISTK233 | NIST K-233.
|
| NISTK283 | NIST K-283.
|
| NISTK409 | NIST K-409.
|
| NISTP192 | NIST P-192.
|
| NISTP224 | NIST P-224.
|
| NISTP256 | NIST P-256.
|
| NISTP384 | NIST P-384.
|
| NISTP521 | NIST P-521.
|
| NISTT571 | NIST T-571.
|
6.7.5.4 EncryptionProtocol
The encryption protocol for SNMPv3.
- This property shall contain the SNMPv3 encryption protocol.
| string | Description |
|---|---|
| CBC_DES | CBC-DES encryption.
|
| CFB128_AES128 | CFB128-AES-128 encryption.
|
| CFB128_AES192 (v1.4+) | CFB128-AES-192 encryption.
|
| CFB128_AES256 (v1.4+) | CFB128-AES-256 encryption.
|
| None | No encryption.
|
6.7.5.5 KeyType
The type of SSH key.
- This parameter shall contain the type of SSH key.
| string | Description |
|---|---|
| DSA | DSA.
|
| ECDSA | ECDSA.
|
| Ed25519 | Ed25519.
|
| RSA | RSA.
|
6.7.5.6 UserAuthenticationMethod
The client user authentication method.
- This property shall contain the client user authentication method.
| string | Description |
|---|---|
| Password | SSH user authentication with a password.
|
| PublicKey | SSH user authentication with a public key.
|
6.7.6 Example response
{
"@odata.type": "#AggregationSource.v1_4_3.AggregationSource",
"Id": "AggregationSource1",
"Name": "AggregationSource One",
"HostName": "https://Someserver.Contoso.com/redfish/v1",
"UserName": "root",
"Password": null,
"Links": {
"ConnectionMethod": {
"@odata.id": "/redfish/v1/AggregationService/ConnectionMethods/ConnectionMethod1"
},
"ResourcesAccessed": [
{
"@odata.id": "/redfish/v1/Managers/1"
}
]
},
"@odata.id": "/redfish/v1/AggregationService/AggregationSources/AggregationSource1"
}6.8 AllowDeny 1.0.3
| Version | v1.0 |
| Release | 2021.2 |
6.8.1 Description
The AllowDeny schema represents a set of allow or deny configurations.
- This resource shall represent an AllowDeny resource in a Redfish implementation.
6.8.2 URIs
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny/{AllowDenyId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny/{AllowDenyId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny/{AllowDenyId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny/{AllowDenyId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny/{AllowDenyId}
/redfish/v1/Systems/{ComputerSystemId}/NetworkInterfaces/{NetworkInterfaceId}/NetworkDeviceFunctions/{NetworkDeviceFunctionId}/AllowDeny/{AllowDenyId}
6.8.3 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| AllowType | string (enum) |
read-write (null) |
Indicates the type of permission.
|
| DestinationPortLower | integer | read-write (null) |
The TCP, UDP, or other destination port to which this rule begins application, inclusive.
|
| DestinationPortUpper | integer | read-write (null) |
The TCP, UDP, or other destination port to which this rule ends application, inclusive.
|
| Direction | string (enum) |
read-write (null) |
Indicates the direction of the data to which this permission applies.
|
| IANAProtocolNumber | integer | read-write (null) |
The IANA protocol number to which this permission applies. For TCP, this is 6. For UDP, this is 17.
|
| IPAddressLower | string | read-write (null) |
The lower IP address to which this permission applies.
|
| IPAddressType | string (enum) |
read-write (null) |
The type of IP address populated in the IPAddressLower and IPAddressUpper properties.
|
| IPAddressUpper | string | read-write (null) |
The upper IP address to which this permission applies.
|
| SourcePortLower | integer | read-write (null) |
The TCP, UDP, or other source port to which this rule begins application, inclusive.
|
| SourcePortUpper | integer | read-write (null) |
The TCP, UDP or other source port to which this rule ends application, inclusive.
|
| StatefulSession | boolean | read-write (null) |
Indicates if this is a permission that only applies to stateful connections.
|
6.8.4 Property details
6.8.4.1 AllowType
Indicates the type of permission.
- This property shall indicate the type of permission.
| string | Description |
|---|---|
| Allow | Indicates that traffic that matches the criteria in this resource is permitted. |
| Deny | Indicates that traffic that matches the criteria in this resource is not permitted. |
6.8.4.2 Direction
Indicates the direction of the data to which this permission applies.
- This value shall indicate the direction of the data to which this permission applies for this network device function.
| string | Description |
|---|---|
| Egress | Indicates that this limit is enforced on packets and bytes transmitted by the network device function. |
| Ingress | Indicates that this limit is enforced on packets and bytes received by the network device function. |
6.8.4.3 IPAddressType
The type of IP address populated in the IPAddressLower and IPAddressUpper properties.
- This property shall contain the type of IP address populated in the
IPAddressLowerandIPAddressUpperproperties. Services shall not permit mixing IPv6 and IPv4 addresses on the same resource.
| string | Description |
|---|---|
| IPv4 | IPv4 addressing is used for all IP-fields in this object. |
| IPv6 | IPv6 addressing is used for all IP-fields in this object. |
6.8.5 Example response
{
"@odata.type": "#AllowDeny.v1_0_3.AllowDeny",
"Id": "AllowDeny Rule 1",
"Name": "Allow Rule 1",
"Direction": "Ingress",
"AllowType": "Allow",
"StatefulSession": true,
"IPAddressType": "IPv4",
"IPAddressLower": "192.168.1.1",
"IPAddressUpper": "192.168.1.100",
"IANAProtocolNumber": 6,
"SourcePortLower": 5,
"SourcePortUpper": 65535,
"DestinationPortLower": 5,
"DestinationPortUpper": 65535,
"@odata.id": "/redfish/v1/Chassis/Card1/NetworkAdapters/Slot1/NetworkDeviceFunctions/SC2KP1F0/AllowDeny/Rule1"
}6.9 Application 1.0.1
| Version | v1.0 |
| Release | 2023.2 |
6.9.1 Description
The Application schema represents an application or service running on a computer system.
- This resource shall represent an application or service running on a computer system.
6.9.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/OperatingSystem/Applications/{ApplicationId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/OperatingSystem/Applications/{ApplicationId}
/redfish/v1/Systems/{ComputerSystemId}/OperatingSystem/Applications/{ApplicationId}
6.9.3 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| DestinationURIs [ ] | array (URI) (string, null) |
read-only | The URIs to which this application pushes data.
|
| Links { | object | The links to other resources that are related to this resource.
|
|
| Oem {} | object | See the OEM object definition in the Using this guide clause. | |
| SoftwareImage { | object | The link to the software image for this application.
|
|
| @odata.id | string | read-only | Link to a SoftwareInventory resource. See the Links section and the SoftwareInventory schema for details. |
| } | |||
| } | |||
| MetricsURIs [ ] | array (URI) (string, null) |
read-only | The URIs that provide access to data or other information in this application.
|
| StartTime | string (date-time) |
read-only (null) |
The date and time when the application started running.
|
| Status {} | object | The status and health of the resource and its subordinate or dependent resources.
|
|
| Vendor | string | read-only (null) |
The vendor of this application.
|
| Version | string | read-only (null) |
The version of this application.
|
6.9.4 Actions
6.9.4.1 Reset
Description
This action resets the application.
- This action shall reset the application.
Action URI
{Base URI of target resource}/Actions/Application.Reset
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| ResetType | string (enum) |
optional | The type of reset.
|
Request Example
{
"ResetType": "GracefulRestart"
}6.9.5 Property details
6.9.5.1 ResetType
The type of reset.
- This parameter shall contain the type of reset.
GracefulRestartandForceRestartshall indicate requests to restart the application.GracefulShutdownandForceOffshall indicate requests to stop or disable the application.OnandForceOnshall indicate requests to start or enable the application. The service can accept a request without the parameter and shall perform aGracefulRestart.
| 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 unit.
|
| GracefulRestart | Shut down gracefully and restart the unit.
|
| 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.
|
| Pause | Pause execution on the unit but do not remove power. This is typically a feature of virtual machine hypervisors.
|
| 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.
|
| Resume | Resume execution on the paused unit. This is typically a feature of virtual machine hypervisors.
|
| Suspend | Write the state of the unit to disk before powering off. This allows for the state to be restored when powered back on.
|
6.9.6 Example response
{
"@odata.type": "#Application.v1_0_1.Application",
"Id": "Logger",
"Name": "Logging Agent",
"Version": "1.5.1",
"Vendor": "Contoso",
"StartTime": "2021-10-29T10:42:38+06:00",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"DestinationURIs": [
"https://listeners.contoso.org:8000/handler"
],
"MetricsURIs": [
"https://192.168.0.12:7000"
],
"Actions": {
"#Application.Reset": {
"target": "/redfish/v1/Systems/VM1/OperatingSystem/Applications/Logger/Actions/Application.Reset",
"ResetType@Redfish.AllowableValues": [
"On",
"ForceOff",
"GracefulShutdown",
"GracefulRestart",
"ForceRestart",
"ForceOn"
]
}
},
"@odata.id": "/redfish/v1/Systems/VM1/OperatingSystem/Applications/Logger"
}6.10 Assembly 1.5.1
| Version | v1.5 | v1.4 | v1.3 | v1.2 | v1.1 | v1.0 |
| Release | 2022.3 | 2022.2 | 2020.3 | 2018.2 | 2018.1 | 2017.3 |
6.10.1 Description
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.
- This resource shall represent an assembly for a Redfish implementation. 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.
6.10.2 URIs
/redfish/v1/Chassis/{ChassisId}/Assembly
/redfish/v1/Chassis/{ChassisId}/Drives/{DriveId}/Assembly
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Assembly
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/{ProcessorId}/Assembly
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/Assembly
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}/Assembly
/redfish/v1/Chassis/{ChassisId}/PCIeDevices/{PCIeDeviceId}/Assembly
/redfish/v1/Chassis/{ChassisId}/Power/PowerSupplies/{PowerSupplyId}/Assembly
/redfish/v1/Chassis/{ChassisId}/PowerSubsystem/Batteries/{BatteryId}/Assembly
/redfish/v1/Chassis/{ChassisId}/PowerSubsystem/PowerSupplies/{PowerSupplyId}/Assembly
/redfish/v1/Chassis/{ChassisId}/Thermal/Fans/{FanId}/Assembly
/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Fans/{FanId}/Assembly
/redfish/v1/Chassis/{ChassisId}/ThermalSubsystem/Heaters/{HeaderId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/{DriveId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory/{MemoryId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/Assembly
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Assembly
/redfish/v1/PowerEquipment/PowerShelves/{PowerDistributionId}/PowerSupplies/{PowerSupplyId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/{DriveId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory/{MemoryId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/Assembly
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Assembly
/redfish/v1/Storage/{StorageId}/Controllers/{StorageControllerId}/Assembly
/redfish/v1/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Assembly
/redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}/Assembly
/redfish/v1/Systems/{ComputerSystemId}/PCIeDevices/{PCIeDeviceId}/Assembly
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Assembly
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/Assembly
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/SubProcessors/{ProcessorId2}/SubProcessors/{ProcessorId3}/Assembly
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Assembly
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/Assembly
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Assembly
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Assembly
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Filters/{FilterId}/Assembly
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Pumps/{PumpId}/Assembly
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Pumps/{PumpId}/Filters/{FilterId}/Assembly
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Reservoirs/{ReservoirId}/Assembly
/redfish/v1/ThermalEquipment/CDUs/{CoolingUnitId}/Reservoirs/{ReservoirId}/Filters/{FilterId}/Assembly
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Assembly
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Filters/{FilterId}/Assembly
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Pumps/{PumpId}/Assembly
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Pumps/{PumpId}/Filters/{FilterId}/Assembly
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Reservoirs/{ReservoirId}/Assembly
/redfish/v1/ThermalEquipment/HeatExchangers/{CoolingUnitId}/Reservoirs/{ReservoirId}/Filters/{FilterId}/Assembly
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Assembly
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Filters/{FilterId}/Assembly
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Pumps/{PumpId}/Assembly
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Pumps/{PumpId}/Filters/{FilterId}/Assembly
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Reservoirs/{ReservoirId}/Assembly
/redfish/v1/ThermalEquipment/ImmersionUnits/{CoolingUnitId}/Reservoirs/{ReservoirId}/Filters/{FilterId}/Assembly
6.10.3 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Assemblies [ { | array | The assembly records.
|
|
| @odata.id | string (URI) |
read-only required | The unique identifier for a resource.
|
| Actions {} | object | The available actions for this resource.
|
|
| BinaryDataURI | string (URI) |
read-only (null) |
The URI at which to access an image of the assembly information.
|
| Description | string | read-only (null) |
The description of the assembly.
|
| EngineeringChangeLevel | string | read-only (null) |
The engineering change level of the assembly.
|
| ISOCountryCodeOfOrigin (v1.5+) | string | read-only (null) |
The manufacturing country of origin, using the ISO 3166-1 country code.
^([A-Z]{2}|[A-Z]{3})$ |
| Location (v1.3+) {} | object | The location of the assembly.
|
|
| LocationIndicatorActive (v1.3+) | boolean | read-write (null) |
An indicator allowing an operator to physically locate this resource.
|
| MemberId | string | read-only required | The unique identifier for the member within an array.
|
| Model | string | read-only (null) |
The model number of the assembly.
|
| Name | string | read-only (null) |
The name of the assembly.
|
| Oem {} | object | See the OEM object definition in the Using this guide clause. | |
| PartNumber | string | read-only (null) |
The part number of the assembly.
|
| PhysicalContext (v1.2+) | string (enum) |
read-only | The area or device to which the assembly data applies.
|
| Producer | string | read-only (null) |
The producer or manufacturer of the assembly.
|
| ProductionDate | string (date-time) |
read-only (null) |
The production date of the assembly.
|
| Replaceable (v1.4+) | boolean | read-only (null) |
An indication of whether the component associated this assembly can be independently replaced as allowed by the vendor's replacement policy.
|
| SerialNumber (v1.2+) | string | read-only (null) |
The serial number of the assembly.
|
| SKU | string | read-only (null) |
The SKU of the assembly.
|
| SparePartNumber | string | read-only (null) |
The spare part number of the assembly.
|
| Status (v1.1+) {} | object | The status and health of the resource and its subordinate or dependent resources.
|
|
| Vendor | string | read-only (null) |
The vendor of the assembly.
|
| Version | string | read-only (null) |
The hardware version of the assembly.
|
| } ] |
6.10.4 Property details
6.10.4.1 PhysicalContext
The area or device to which the assembly data applies.
- This property shall contain a description of the physical context for the assembly data.
| string | Description |
|---|---|
| Accelerator | An accelerator. |
| ACInput | An AC electrical input or input-related circuit. |
| ACMaintenanceBypassInput | An AC electrical maintenance bypass input. |
| ACOutput | An AC electrical output or output-related circuit.
|
| ACStaticBypassInput | An AC electrical static bypass input. |
| ACUtilityInput | An AC electrical 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. |
| Battery | A battery. |
| Board | A circuit board.
|
| Chassis | The entire chassis. |
| ComputeBay | 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 electrical bus. |
| Exhaust | The air exhaust point or points or region of the chassis. |
| ExpansionBay | An expansion bay.
|
| ExpansionSubsystem | A group of expansion bays.
|
| Fan | A fan. |
| Filter | A filter. |
| 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. |
| Manager | A management controller, such as a BMC (baseboard management controller). |
| Memory | A memory device. |
| MemorySubsystem | The entire memory subsystem. |
| Motor | A motor. |
| NetworkBay | A networking bay.
|
| NetworkingDevice | A networking device. |
| PowerOutlet | An electrical outlet.
|
| PowerSubsystem | The entire power subsystem. |
| PowerSupply | A power supply. |
| PowerSupplyBay | A power supply bay.
|
| Pump | A pump. |
| Rectifier | A rectifier device. |
| Reservoir | A reservoir. |
| Room | The room. |
| StorageBay | A storage bay.
|
| StorageDevice | A storage device. |
| StorageSubsystem | A storage subsystem.
|
| Switch | A switch device. |
| SystemBoard | The system board (PCB). |
| Transceiver | A transceiver.
|
| Transformer | A transformer. |
| TrustedModule | A trusted module. |
| Upper | The upper portion of the chassis. |
| VoltageRegulator | A voltage regulator device. |
6.10.5 Example response
{
"@odata.type": "#Assembly.v1_5_1.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"
}6.11 AttributeRegistry 1.3.9
| Version | v1.3 | v1.2 | v1.1 | v1.0 |
| Release | 2018.3 | 2018.1 | 2017.1 | 2016.1 |
6.11.1 Description
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.
- This resource shall represent an attribute registry for a Redfish implementation.
6.11.2 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Language | string | read-only required | The RFC5646-conformant language code for the attribute registry.
|
| OwningEntity | string | read-only required | The organization or company that publishes this attribute registry.
|
| RegistryEntries { | object | The list of all attributes and their metadata for this component.
|
|
| Attributes [ { | array | An array of attributes and their possible values in the attribute registry.
|
|
| AttributeName | string | read-only required | The unique name for the attribute.
^[A-Za-z][A-Za-z0-9_]+$ |
| CurrentValue | string, boolean, number | read-only (null) |
The placeholder of the current value for the attribute.
|
| DefaultValue | string, boolean, number | read-only (null) |
The default value for the attribute.
|
| DisplayName | string | read-only (null) |
The user-readable display string for the attribute in the defined language.
|
| DisplayOrder | integer | read-only (null) |
The ascending order, as a number, in which this attribute appears relative to other attributes.
|
| GrayOut | boolean | read-only (null) |
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.
|
| HelpText | string | read-only (null) |
The help text for the attribute.
|
| Hidden | boolean | read-only (null) |
An indication of whether this attribute is hidden in user interfaces.
|
| Immutable | boolean | read-only (null) |
An indication of whether this attribute is immutable. Immutable attributes cannot be modified and typically reflect a hardware state.
|
| IsSystemUniqueProperty | boolean | read-only (null) |
An indication of whether this attribute is unique for this system and should not be replicated.
|
| LowerBound | integer | read-only (null) |
The lower limit for an integer attribute.
|
| MaxLength | integer | read-only (null) |
The maximum character length of a string attribute.
|
| MenuPath | string | read-only (null) |
The path that describes the menu hierarchy of this attribute.
^\.\/([^/]+(\/[^/]+)*)?$ |
| MinLength | integer | read-only (null) |
The minimum character length of the string attribute.
|
| Oem (v1.3+) {} | object | See the OEM object definition in the Using this guide clause. | |
| ReadOnly | boolean | read-only (null) |
An indication of whether this attribute is read-only. A read-only attribute cannot be modified, and should be grayed out in user interfaces.
|
| ResetRequired (v1.2+) | boolean | read-only (null) |
An indication of whether a system or device reset is required for this attribute value change to take effect.
|
| ScalarIncrement | integer | read-only (null) |
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.
|
| Type | string (enum) |
read-only | The attribute type.
|
| UefiDevicePath (v1.2+) | string | read-only (null) |
The UEFI device path that qualifies this attribute.
|
| UefiKeywordName (v1.2+) | string | read-only | The UEFI keyword string for this attribute.
|
| UefiNamespaceId (v1.2+) | string | read-only | The UEFI namespace ID for the attribute.
|
| UpperBound | integer | read-only (null) |
The upper limit for an integer attribute.
|
| Value [ { | array | An array of the possible values for enumerated attribute values.
|
|
| ValueDisplayName | string | read-only (null) |
A user-readable display string of the value for the attribute in the defined language.
|
| ValueName | string | read-only required | The unique value name for the attribute.
|
| } ] | |||
| ValueExpression | string | read-only (null) |
A valid regular expression, according to the Perl regular expression dialect, that validates the attribute value. Applies to only string and integer attributes.
|
| WarningText | string | read-only (null) |
The warning text for the attribute.
|
| WriteOnly | boolean | read-only (null) |
An indication of whether this attribute is write-only. A write-only attribute reverts to its initial value after settings are applied.
|
| } ] | |||
| Dependencies [ { | array | An array of dependencies of attributes on this component.
|
|
| Dependency { | object | The dependency expression for one or more attributes in this attribute registry.
|
|
| MapFrom [ { | array | An array of the map-from conditions for a mapping dependency.
|
|
| MapFromAttribute | string | read-only | The attribute to use to evaluate this dependency expression.
^[A-Za-z][A-Za-z0-9_]+$ |
| MapFromCondition | string (enum) |
read-only | The condition to use to evaluate this dependency expression.
|
| MapFromProperty | string (enum) |
read-only | The metadata property for the attribute that the MapFromAttribute property specifies to use to evaluate this dependency expression.
|
| MapFromValue | string, boolean, number | read-only (null) |
The value to use to evaluate this dependency expression.
|
| MapTerms | string (enum) |
read-only | 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.
|
| } ] | |||
| MapToAttribute | string | read-only | The AttributeName of the attribute that is affected by this dependency expression.
^[A-Za-z][A-Za-z0-9_]+$ |
| MapToProperty | string (enum) |
read-only | The metadata property for the attribute that contains the map-from condition that evaluates this dependency expression.
|
| MapToValue | string, boolean, number | read-only (null) |
The value that the map-to property changes to if the dependency expression evaluates to true.
|
| } | |||
| DependencyFor | string | read-only | The AttributeName of the attribute whose change triggers the evaluation of this dependency expression.
^[A-Za-z][A-Za-z0-9_]+$ |
| Type | string (enum) |
read-only | The type of the dependency structure.
|
| } ] | |||
| Menus [ { | array | An array for the attributes menus and their hierarchy in the attribute registry.
|
|
| DisplayName | string | read-only (null) |
The user-readable display string of this menu in the defined language.
|
| DisplayOrder | integer | read-only (null) |
The ascending order, as a number, in which this menu appears relative to other menus.
|
| GrayOut | boolean | read-only (null) |
An indication of whether this menu is grayed out. A grayed-only menu is not accessible in user interfaces.
|
| Hidden (v1.3+) | boolean | read-only (null) |
An indication of whether this menu is hidden in user interfaces.
|
| MenuName | string | read-only | The unique name string of this menu.
^[^/]+$ |
| MenuPath | string | read-only (null) |
The path to the menu names that describes this menu hierarchy relative to other menus.
^\.\/([^/]+(\/[^/]+)*)?$ |
| Oem (v1.3+) {} | object | See the OEM object definition in the Using this guide clause. | |
| ReadOnly | boolean | read-only (null) |
An indication of whether this menu is read-only. A read-only menu, its properties, and sub-menus are not accessible in user interfaces.
|
| } ] | |||
| } | |||
| RegistryVersion | string | read-only required | The attribute registry version.
^\d+\.\d+\.\d+$ |
| SupportedSystems [ { | array | An array of systems that this attribute registry supports.
|
|
| FirmwareVersion (v1.1+) | string | read-only (null) |
Firmware version.
|
| ProductName | string | read-only (null) |
The product name of the computer system to which this attribute registry applies.
|
| SystemId | string | read-only (null) |
The ID of the systems to which this attribute registry applies.
^[A-Za-z0-9]+$ |
| } ] |
6.11.3 Property details
6.11.3.1 MapFromCondition
The condition to use to evaluate this dependency expression.
- This property shall contain the condition to use to evaluate this dependency expression. For example,
EQUorNEQ.
| 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'. |
6.11.3.2 MapFromProperty
The metadata property for the attribute that the MapFromAttribute property specifies to use to evaluate this dependency expression.
- This property shall contain the metadata property for the attribute that the
MapFromAttributeproperty specifies to use to evaluate this dependency expression. For example, this value could be theMapFromAttributeCurrentValue, orReadOnlystate.
| 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. |
6.11.3.3 MapTerms
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.
- This property shall contain the logical term that combines two or more
MapFromconditions in this dependency expression. For example,ANDfor logical AND, orORfor logical OR. If multiple logical terms are present in a dependency expression, they should be evaluated in array order, meaning they are evaluated left-to-right when displayed as a logic expression.
| string | Description |
|---|---|
| AND | The operation used for logical 'AND' of dependency terms. |
| OR | The operation used for logical 'OR' of dependency terms. |
6.11.3.4 MapToProperty
The metadata property for the attribute that contains the map-from condition that evaluates this dependency expression.
- This property shall contain the metadata property for the attribute that the
MapFromAttributeproperty specifies that evaluates this dependency expression. For example, this value could be theMapFromAttributeCurrentValueorReadOnlystate.
| 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. |
6.11.3.5 Type
6.11.3.5.1 In RegistryEntries: Attributes:
The attribute type.
- This property shall contain an enumeration that describes 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 is null in responses. |
| String | Free-form text in their values. |
6.11.3.5.2 In RegistryEntries: Dependencies:
The type of the dependency structure.
- This property shall contain an enumeration that describes the type for the attribute dependency.
| string | Description |
|---|---|
| Map | A simple mapping dependency. If the condition evaluates to true, the attribute or state changes to the mapped value. |
6.11.4 Example response
{
"@odata.type": "#AttributeRegistry.v1_3_9.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
}
]
}
}6.12 Battery 1.3.0
| Version | v1.3 | v1.2 | v1.1 |
| Release | 2024.1 | 2022.2 | 2021.2 |
6.12.1 Description
The Battery schema describes a battery unit, such as those used to provide systems with power during a power-loss event. It also describes the location, such as a slot, socket, or bay, where a unit can be installed by populating a resource instance with an absent state if a unit is not present.
- This resource shall represent a battery for a Redfish implementation. It may also represent a location, such as a slot, socket, or bay, where a unit may be installed if the
Stateproperty within theStatusproperty containsAbsent.
6.12.2 URIs
/redfish/v1/Chassis/{ChassisId}/PowerSubsystem/Batteries/{BatteryId}
6.12.3 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Assembly { | object | The link to the assembly associated with this battery.
|
|
| @odata.id | string | read-only | Link to a Assembly resource. See the Links section and the Assembly schema for details. |
| } | |||
| CapacityActualAmpHours | number (A.h) |
read-only (null) |
The actual maximum capacity of this battery in amp-hour units.
|
| CapacityActualWattHours | number (W.h) |
read-only (null) |
The actual maximum capacity of this battery in watt-hour units.
|
| CapacityRatedAmpHours | number (A.h) |
read-only (null) |
The rated maximum capacity of this battery in amp-hour units.
|
| CapacityRatedWattHours | number (W.h) |
read-only (null) |
The rated maximum capacity of this battery in watt-hour units.
|
| ChargeState | string (enum) |
read-only (null) |
The charge state of this battery.
|
| FirmwareVersion | string | read-only (null) |
The firmware version for this battery.
|
| HotPluggable | boolean | read-only (null) |
An indication of whether this device can be inserted or removed while the equipment is in operation.
|
| Links (v1.1+) { | object | The links to other resources that are related to this resource.
|
|
| Memory (v1.1+) [ { | array | An array of links to the memory devices to which this battery provides power during a power-loss event.
|
|
| @odata.id | string | read-only | Link to a Memory resource. See the Links section and the Memory schema for details. |
| } ] | |||
| Oem {} | object | See the OEM object definition in the Using this guide clause. | |
| StorageControllers (v1.1+) [ { | array | An array of links to the storage controllers to which this battery provides power during a power-loss event.
|
|
| @odata.id | string | read-only | Link to a StorageController resource. See the Links section and the StorageController schema for details. |
| } ] | |||
| } | |||
| Location {} | object | The location of the battery.
|
|
| LocationIndicatorActive | boolean | read-write (null) |
An indicator allowing an operator to physically locate this resource.
|
| Manufacturer | string | read-only (null) |
The manufacturer of this battery.
|
| MaxChargeRateAmps | number (A) |
read-only (null) |
The maximum charge rate at the input of this battery in amp units.
|
| MaxChargeVoltage | number (Volts) |
read-only (null) |
The maximum charge voltage across the cell pack of this battery when it is fully charged.
|
| MaxDischargeRateAmps | number (A) |
read-only (null) |
The maximum discharge rate at the output of this battery in amp units.
|
| Metrics { | object | The link to the battery metrics resource associated with this battery.
|
|
| @odata.id | string | read-only | Link to a BatteryMetrics resource. See the Links section and the BatteryMetrics schema for details. |
| } | |||
| Model | string | read-only (null) |
The model number for this battery.
|
| NominalOutputVoltage (v1.3+) | number (Volts) |
read-only (null) |
The nominal output voltage of this battery.
|
| PartNumber | string | read-only (null) |
The part number for this battery.
|
| ProductionDate | string (date-time) |
read-only (null) |
The production or manufacturing date of this battery.
|
| Replaceable (v1.2+) | boolean | read-only (null) |
An indication of whether this component can be independently replaced as allowed by the vendor's replacement policy.
|
| SerialNumber | string | read-only (null) |
The serial number for this battery.
|
| SparePartNumber | string | read-only (null) |
The spare part number for this battery.
|
| StateOfHealthPercent { | object (excerpt) |
The state of health (percent) of this battery.
|
|
| DataSourceUri | string (URI) |
read-only (null) |
The link to the resource that provides the data for this sensor.
|
| Reading | number | read-only (null) |
The sensor value.
|
| } | |||
| Status {} | object | The status and health of the resource and its subordinate or dependent resources.
|
|
| Version | string | read-only (null) |
The hardware version of this battery.
|
6.12.4 Actions
6.12.4.1 Calibrate
Description
This action performs a self-calibration, or learn cycle, of the battery.
- This action shall perform a self-calibration, or learn cycle, of the battery.
Action URI
{Base URI of target resource}/Actions/Battery.Calibrate
Action parameters
This action takes no parameters.
6.12.4.2 Reset
Description
This action resets the battery.
- This action shall reset the battery.
Action URI
{Base URI of target resource}/Actions/Battery.Reset
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| ResetType | string (enum) |
optional | The type of reset.
|
Request Example
{
"ResetType": "PowerCycle"
}6.12.4.3 SelfTest
Description
This action performs a self-test of the battery.
- This action shall perform a self-test of the battery.
Action URI
{Base URI of target resource}/Actions/Battery.SelfTest
Action parameters
This action takes no parameters.
6.12.5 Property details
6.12.5.1 ChargeState
The charge state of this battery.
- This property shall contain the charge state of this battery.
| string | Description |
|---|---|
| Charging | The battery is charging.
|
| Discharging | The battery is discharging.
|
| Idle | The battery is idle.
|
6.12.5.2 ResetType
The type of reset.
- This parameter shall contain the type of reset. The service can accept a request without the parameter and shall perform a
GracefulRestart.
| 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 unit.
|
| GracefulRestart | Shut down gracefully and restart the unit.
|
| 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.
|
| Pause | Pause execution on the unit but do not remove power. This is typically a feature of virtual machine hypervisors.
|
| 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.
|
| Resume | Resume execution on the paused unit. This is typically a feature of virtual machine hypervisors.
|
| Suspend | Write the state of the unit to disk before powering off. This allows for the state to be restored when powered back on.
|
6.12.6 Example response
{
"@odata.type": "#Battery.v1_3_0.Battery",
"Id": "Module1",
"Name": "Battery 1",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"Actions": {
"#Battery.SelfTest": {
"target": "/redfish/v1/Chassis/1U/PowerSubsystem/Batteries/Module1/Actions/Battery.SelfTest"
},
"#Battery.Calibrate": {
"target": "/redfish/v1/Chassis/1U/PowerSubsystem/Batteries/Module1/Actions/Battery.Calibrate"
}
},
"Location": {
"PartLocation": {
"ServiceLabel": "Battery 1",
"LocationType": "Bay",
"LocationOrdinalValue": 0
}
},
"Model": "RKS-440DC",
"Manufacturer": "Contoso Power",
"FirmwareVersion": "1.00",
"Version": "A05",
"ProductionDate": "2019-10-01T06:00:00Z",
"SerialNumber": "3488247",
"PartNumber": "23456-133",
"SparePartNumber": "93284-133",
"LocationIndicatorActive": false,
"HotPluggable": true,
"CapacityRatedWattHours": 20,
"CapacityActualWattHours": 19.41,
"MaxDischargeRateAmps": 10,
"StateOfHealthPercent": {
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/Battery1StateOfHealth",
"Reading": 91
},
"ChargeState": "Idle",
"Metrics": {
"@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/Batteries/Module1/Metrics"
},
"@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/Batteries/Module1"
}6.13 BatteryMetrics 1.0.4
| Version | v1.0 |
| Release | 2021.2 |
6.13.1 Description
The BatteryMetrics schema contains definitions for the metrics of a battery unit.
- This resource shall be used to represent the metrics of a battery unit for a Redfish implementation.
6.13.2 URIs
/redfish/v1/Chassis/{ChassisId}/PowerSubsystem/Batteries/{BatteryId}/Metrics
6.13.3 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| CellVoltages [ { | array (excerpt) |
The cell voltages (V) for this battery.
|
|
| CrestFactor (v1.1+) | number | read-only (null) |
The crest factor for this sensor.
|
| DataSourceUri | string (URI) |
read-only (null) |
The link to the resource that provides the data for this sensor.
|
| Reading | number | read-only (null) |
The sensor value.
|
| THDPercent (v1.1+) | number (%) |
read-only (null) |
The total harmonic distortion percent (% THD).
|
| } ] | |||
| ChargePercent {} | object | The amount of charge available (percent) in this battery.
|
|
| DischargeCycles | number | read-only (null) |
The number of discharges this battery has sustained.
|
| InputCurrentAmps { | object (excerpt) |
The input current (A) for this battery.
|
|
| CrestFactor (v1.1+) | number | read-only (null) |
The crest factor for this sensor.
|
| DataSourceUri | string (URI) |
read-only (null) |
The link to the resource that provides the data for this sensor.
|
| Reading | number | read-only (null) |
The sensor value.
|
| THDPercent (v1.1+) | number (%) |
read-only (null) |
The total harmonic distortion percent (% THD).
|
| } | |||
| InputVoltage { | object (excerpt) |
The input voltage (V) for this battery.
|
|
| CrestFactor (v1.1+) | number | read-only (null) |
The crest factor for this sensor.
|
| DataSourceUri | string (URI) |
read-only (null) |
The link to the resource that provides the data for this sensor.
|
| Reading | number | read-only (null) |
The sensor value.
|
| THDPercent (v1.1+) | number (%) |
read-only (null) |
The total harmonic distortion percent (% THD).
|
| } | |||
| OutputCurrentAmps [ { | array (excerpt) |
The output currents (A) for this battery.
|
|
| CrestFactor (v1.1+) | number | read-only (null) |
The crest factor for this sensor.
|
| DataSourceUri | string (URI) |
read-only (null) |
The link to the resource that provides the data for this sensor.
|
| Reading | number | read-only (null) |
The sensor value.
|
| THDPercent (v1.1+) | number (%) |
read-only (null) |
The total harmonic distortion percent (% THD).
|
| } ] | |||
| OutputVoltages [ { | array (excerpt) |
The output voltages (V) for this battery.
|
|
| CrestFactor (v1.1+) | number | read-only (null) |
The crest factor for this sensor.
|
| DataSourceUri | string (URI) |
read-only (null) |
The link to the resource that provides the data for this sensor.
|
| Reading | number | read-only (null) |
The sensor value.
|
| THDPercent (v1.1+) | number (%) |
read-only (null) |
The total harmonic distortion percent (% THD).
|
| } ] | |||
| Status {} | object | The status and health of the resource and its subordinate or dependent resources.
|
|
| StoredChargeAmpHours {} | object | The charge (Ah) stored in this battery.
|
|
| StoredEnergyWattHours {} | object | The energy (Wh) stored in this battery.
|
|
| TemperatureCelsius {} | object | The temperature (C) for this battery.
|
6.13.4 Property details
6.13.4.1 SensorExcerpt
The Sensor schema describes a sensor and its properties. This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri.
| DataSourceUri | string (URI) |
read-only (null) |
The link to the resource that provides the data for this sensor.
|
| Reading | number | read-only (null) |
The sensor value.
|
6.13.5 Example response
{
"@odata.type": "#BatteryMetrics.v1_0_4.BatteryMetrics",
"Id": "Metrics",
"Name": "Metrics for Battery 1",
"DischargeCycles": 8.67,
"InputVoltage": {
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/Battery1InputVoltage",
"Reading": 12.22
},
"InputCurrentAmps": {
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/Battery1InputCurrent",
"Reading": 0
},
"OutputVoltages": [
{
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/Battery1OutputVoltage",
"Reading": 12.22
}
],
"OutputCurrentAmps": [
{
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/Battery1OutputCurrent",
"Reading": 0
}
],
"StoredEnergyWattHours": {
"Reading": 19.41
},
"TemperatureCelsius": {
"DataSourceUri": "/redfish/v1/Chassis/1U/Sensors/Battery1Temp",
"Reading": 33
},
"ChargePercent": {
"Reading": 100
},
"CellVoltages": [
{
"Reading": 3.44
},
{
"Reading": 3.45
},
{
"Reading": 3.43
},
{
"Reading": 3.43
},
{
"Reading": 3.45
},
{
"Reading": 3.44
},
{
"Reading": 3.43
},
{
"Reading": 3.44
}
],
"@odata.id": "/redfish/v1/Chassis/1U/PowerSubsystem/Batteries/Module1/Metrics"
}6.14 Bios 1.2.3
| Version | v1.2 | v1.1 | v1.0 |
| Release | 2021.1 | 2019.2 | 2016.1 |
6.14.1 Description
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.
- This resource shall represent BIOS attributes for a Redfish implementation.
6.14.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Bios
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Bios
/redfish/v1/Systems/{ComputerSystemId}/Bios
6.14.3 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| AttributeRegistry | string | read-only (null) |
The resource ID of the attribute registry that has the system-specific information about a BIOS resource.
|
| Attributes { | object | The list of BIOS attributes specific to the manufacturer or provider.
|
|
| (pattern) | string, boolean, number | read-write (null) |
Property names follow regular expression pattern "^[A-Za-z][A-Za-z0-9_]+$" |
| } | |||
| Links (v1.1+) { | object | The links to other resources that are related to this resource.
|
|
| ActiveSoftwareImage (v1.1+) { | object | The link to the software inventory that represents the active BIOS firmware image.
|
|
| @odata.id | string | read-write | Link to a SoftwareInventory resource. See the Links section and the SoftwareInventory schema for details. |
| } | |||
| Oem {} | object | See the OEM object definition in the Using this guide clause. | |
| SoftwareImages (v1.1+) [ { | array | The images that are associated with this BIOS.
|
|
| @odata.id | string | read-only | Link to a SoftwareInventory resource. See the Links section and the SoftwareInventory schema for details. |
| } ] | |||
| } | |||
| ResetBiosToDefaultsPending (v1.2+) | boolean | read-only (null) |
An indication of whether there is a pending request to reset the BIOS attributes to default values.
|
6.14.4 Actions
6.14.4.1 ChangePassword
Description
This action changes a BIOS password.
- This action shall change the selected BIOS password.
Action URI
{Base URI of target resource}/Actions/Bios.ChangePassword
Action parameters
| Parameter Name | Type | Attributes | Notes |
|---|---|---|---|
| NewPassword | string | required | The new BIOS password.
|
| OldPassword | string | required | The existing BIOS password.
|
| PasswordName | string | required | The name of the BIOS password to change.
|
Request Example
{
"OldPassword": "secret123",
"NewPassword": "B3tterS3cur1tY!",
"PasswordName": "Admin"
}6.14.4.2 ResetBios
Description
This action resets the BIOS attributes to default.
- This action shall reset the BIOS attributes to their default values. To apply the default values, a system reset may be required. This action can impact other resources. This action may clear pending values in the settings resource.
Action URI
{Base URI of target resource}/Actions/Bios.ResetBios
Action parameters
This action takes no parameters.
6.14.5 Example response
{
"@odata.type": "#Bios.v1_2_3.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_4_0.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"
}6.15 BootOption 1.0.6
| Version | v1.0 |
| Release | 2017.3 |
6.15.1 Description
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.
- This resource shall represent a single boot option within a system.
6.15.2 URIs
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/BootOptions/{BootOptionId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/BootOptions/{BootOptionId}
/redfish/v1/Systems/{ComputerSystemId}/BootOptions/{BootOptionId}
6.15.3 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Alias | string (enum) |
read-only (null) |
The alias of this boot source.
|
| BootOptionEnabled | boolean | read-write (null) |
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 influences the load option active flag for the boot option.
|
| BootOptionReference | string | read-only required (null) |
The unique boot option.
|
| DisplayName | string | read-only (null) |
The user-readable display name of the boot option that appears in the boot order list in the user interface.
|
| RelatedItem [ { | array | An array of links to resources or objects associated with this boot option.
|
|
| @odata.id | string (URI) |
read-only | The unique identifier for a resource.
|
| } ] | |||
| UefiDevicePath | string | read-only (null) |
The UEFI device path to access this UEFI boot option.
|
6.15.4 Property details
6.15.4.1 Alias
The alias of this boot source.
- This property shall contain the string alias of this boot source that describes the type of boot.
| 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 Environment (PXE). |
| Recovery | Boot to a system-designated recovery process or image. |
| 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. |
6.15.5 Example response
{
"@odata.type": "#BootOption.v1_0_6.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"
}
],
"@odata.id": "/redfish/v1/Systems/1/BootOptions/1"
}6.16 Cable 1.2.3
| Version | v1.2 | v1.1 | v1.0 |
| Release | 2021.4 | 2021.3 | 2021.2 |
6.16.1 Description
The Cable schema contains properties that describe a cable connecting endpoints of a chassis, port, or any other cable-compatible endpoint.
- This resource contains a simple cable for a Redfish implementation.
6.16.2 URIs
/redfish/v1/Cables/{CableId}
6.16.3 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| Assembly { | object | The link to the assembly associated with this cable.
|
|
| @odata.id | string | read-only | Link to a Assembly resource. See the Links section and the Assembly schema for details. |
| } | |||
| AssetTag | string | read-write (null) |
The user-assigned asset tag for this cable.
|
| CableClass | string (enum) |
read-write (null) |
The identifier for the downstream resource.
|
| CableStatus | string (enum) |
read-write | The user-reported status of this resource.
|
| CableType | string | read-write (null) |
The type of this cable.
|
| DownstreamConnectorTypes [ ] | array (string (enum)) |
read-write |
|
| DownstreamName | string | read-write (null) |
The identifier for the downstream resource.
|
| LengthMeters | number | read-write (null) |
The length of the cable in meters.
|
| Links { | object | The links to other resources that are related to this resource.
|
|
| DownstreamChassis [ { | array | An array of links to the downstream chassis connected to this cable.
|
|
| @odata.id | string | read-write | Link to a Chassis resource. See the Links section and the Chassis schema for details. |
| } ] | |||
| DownstreamPorts [ { | array | An array of links to the downstream ports connected to this cable.
|
|
| @odata.id | string | read-write | Link to a Port resource. See the Links section and the Port schema for details. |
| } ] | |||
| DownstreamResources [ { | array | An array of links to the downstream resources connected to this cable.
|
|
| @odata.id | string (URI) |
read-only | The unique identifier for a resource.
|
| } ] | |||
| Oem {} | object | See the OEM object definition in the Using this guide clause. | |
| UpstreamChassis [ { | array | An array of links to the upstream chassis connected to this cable.
|
|
| @odata.id | string | read-write | Link to a Chassis resource. See the Links section and the Chassis schema for details. |
| } ] | |||
| UpstreamPorts [ { | array | An array of links to the upstream ports connected to this cable.
|
|
| @odata.id | string | read-write | Link to a Port resource. See the Links section and the Port schema for details. |
| } ] | |||
| UpstreamResources [ { | array | An array of links to the upstream resources connected to this cable.
|
|
| @odata.id | string (URI) |
read-only | The unique identifier for a resource.
|
| } ] | |||
| } | |||
| Location {} | object | The location of the assembly.
|
|
| Manufacturer | string | read-write (null) |
The manufacturer of this cable.
|
| Model | string | read-write (null) |
The model number of the cable.
|
| PartNumber | string | read-write (null) |
The part number for this cable.
|
| SerialNumber | string | read-write (null) |
The serial number for this cable.
|
| SKU | string | read-write (null) |
The SKU for this cable.
|
| Status {} | object | The status and health of the resource and its subordinate or dependent resources.
|
|
| UpstreamConnectorTypes [ ] | array (string (enum)) |
read-write |
|
| UpstreamName | string | read-write (null) |
The identifier for the downstream resource.
|
| UserDescription | string | read-write (null) |
The description of this cable.
|
| UserLabel (v1.1+) | string | read-write | A user-assigned label.
|
| Vendor | string | read-write (null) |
The manufacturer of this cable.
|
6.16.4 Property details
6.16.4.1 CableClass
The identifier for the downstream resource.
- The property shall contain the cable class for this cable.
| string | Description |
|---|---|
| Fabric | This cable is used for connecting to a fabric. |
| Fan | This cable is used for connecting to a fan system. |
| General | This cable is used for providing general connectivity. |
| Network | This cable is used for connecting to a networking system. |
| PCIe | This cable is used for connecting to a PCIe endpoint. |
| Power | This cable is used for connecting to a power system. |
| Serial | This cable is used for connecting to a serial endpoint. |
| Storage | This cable is used for connecting to a storage system. |
| USB | This cable is used for connecting to a USB endpoint. |
| Video | This cable is used for connecting to a video system. |
6.16.4.2 CableStatus
The user-reported status of this resource.
- This property shall contain the user-reported status of this resource.
| string | Description |
|---|---|
| Degraded | The cable is degraded.
|
| Disabled | The cable is disabled.
|
| Failed | The cable has failed.
|
| Normal | The cable is operating normally.
|
| SetByService | The cable status is set by the service.
|
| Testing | The cable is under test.
|
6.16.4.3 DownstreamConnectorTypes
- The connector types this cable supports.
- The property shall contain an array of connector types this cable supports.
| string | Description |
|---|---|
| ACPower | This cable connects to an AC power connector. |
| CDFP | This cable connects to a CDFP connector. |
| DB9 | This cable connects to a DB9 connector. |
| DCPower | This cable connects to a DC power connector. |
| DisplayPort | This cable connects to a DisplayPort power connector. |
| HDMI | This cable connects to an HDMI connector. |
| ICI | This cable connects to an ICI connector. |
| IPASS | This cable connects to an IPASS connector. |
| OSFP | This cable connects to an OSFP connector. |
| PCIe | This cable connects to a PCIe connector. |
| Proprietary | This cable connects to a proprietary connector. |
| QSFP | This cable connects to a QSFP connector. |
| RJ45 | This cable connects to an RJ45 connector. |
| SATA | This cable connects to a SATA connector. |
| SCSI | This cable connects to a SCSI connector. |
| SFP | This cable connects to an SFP connector. |
| SFPPlus | This cable connects to an SFPPlus connector. |
| SlimSAS | This cable connects to a SlimSAS connector. |
| USBA | This cable connects to a USB-A connector. |
| USBC | This cable connects to a USB-C connector. |
6.16.4.4 UpstreamConnectorTypes
- The connector types this cable supports.
- The property shall contain an array of connector types this cable supports.
| string | Description |
|---|---|
| ACPower | This cable connects to an AC power connector. |
| CDFP | This cable connects to a CDFP connector. |
| DB9 | This cable connects to a DB9 connector. |
| DCPower | This cable connects to a DC power connector. |
| DisplayPort | This cable connects to a DisplayPort power connector. |
| HDMI | This cable connects to an HDMI connector. |
| ICI | This cable connects to an ICI connector. |
| IPASS | This cable connects to an IPASS connector. |
| OSFP | This cable connects to an OSFP connector. |
| PCIe | This cable connects to a PCIe connector. |
| Proprietary | This cable connects to a proprietary connector. |
| QSFP | This cable connects to a QSFP connector. |
| RJ45 | This cable connects to an RJ45 connector. |
| SATA | This cable connects to a SATA connector. |
| SCSI | This cable connects to a SCSI connector. |
| SFP | This cable connects to an SFP connector. |
| SFPPlus | This cable connects to an SFPPlus connector. |
| SlimSAS | This cable connects to a SlimSAS connector. |
| USBA | This cable connects to a USB-A connector. |
| USBC | This cable connects to a USB-C connector. |
6.16.5 Example response
{
"@odata.type": "#Cable.v1_2_3.Cable",
"Id": "hdmi_dp",
"Name": "HDMI to DP Cable",
"UserDescription": "HDMI to DisplayPort Cable",
"UpstreamName": "HDMI0",
"DownstreamName": "Video Out",
"CableType": "HDMI",
"LengthMeters": 0.1,
"CableClass": "Video",
"UpstreamConnectorTypes": [
"HDMI"
],
"DownstreamConnectorTypes": [
"DisplayPort"
],
"Links": {
"UpstreamChassis": [
{
"@odata.id": "/redfish/v1/Chassis/bmc"
}
]
},
"PartNumber": "934AMS02X",
"Manufacturer": "Cable Co.",
"SerialNumber": "2345791",
"Vendor": "Cablestore",
"Status": {
"State": "Enabled",
"Health": "OK"
},
"CableStatus": "Normal",
"@odata.id": "/redfish/v1/Cables/hdmi_dp"
}6.17 Certificate 1.9.0
| Version | v1.9 | v1.8 | v1.7 | v1.6 | v1.5 | v1.4 | v1.3 | v1.2 | v1.1 | v1.0 |
| Release | 2024.3 | 2023.2 | 2023.1 | 2022.1 | 2021.3 | 2021.2 | 2021.1 | 2020.1 | 2019.1 | 2018.3 |
6.17.1 Description
The Certificate schema describes a certificate that proves the identity of a component, account, or service.
- This resource shall represent a certificate for a Redfish implementation.
6.17.2 URIs
/redfish/v1/AccountService/Accounts/{ManagerAccountId}/Certificates/{CertificateId}
/redfish/v1/AccountService/ActiveDirectory/Certificates/{CertificateId}
/redfish/v1/AccountService/ExternalAccountProviders/{ExternalAccountProviderId}/Certificates/{CertificateId}
/redfish/v1/AccountService/LDAP/Certificates/{CertificateId}
/redfish/v1/AccountService/MultiFactorAuth/ClientCertificate/Certificates/{CertificateId}
/redfish/v1/AccountService/MultiFactorAuth/SecurID/Certificates/{CertificateId}
/redfish/v1/AccountService/OutboundConnections/{OutboundConnectionId}/Certificates/{CertificateId}
/redfish/v1/AccountService/OutboundConnections/{OutboundConnectionId}/ClientCertificates/{CertificateId}
/redfish/v1/Chassis/{ChassisId}/Certificates/{CertificateId}
/redfish/v1/Chassis/{ChassisId}/Drives/{DriveId}/Certificates/{CertificateId}
/redfish/v1/Chassis/{ChassisId}/Memory/{MemoryId}/Certificates/{CertificateId}
/redfish/v1/Chassis/{ChassisId}/NetworkAdapters/{NetworkAdapterId}/Certificates/{CertificateId}
/redfish/v1/Chassis/{ChassisId}/PowerSubsystem/PowerSupplies/{PowerSupplyId}/Certificates/{CertificateId}
/redfish/v1/Chassis/{ChassisId}/TrustedComponents/{TrustedComponentId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/{DriveId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Boot/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/KeyManagement/KMIPCertificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory/{MemoryId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases/{DatabaseId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/Certificates/{CertificateId}
/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/ClientCertificates/{CertificateId}
/redfish/v1/EventService/Subscriptions/{EventDestinationId}/Certificates/{CertificateId}
/redfish/v1/EventService/Subscriptions/{EventDestinationId}/ClientCertificates/{CertificateId}
/redfish/v1/Fabrics/{FabricId}/Switches/{SwitchId}/Certificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/Certificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/NetworkProtocol/HTTPS/Certificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/Accounts/{ManagerAccountId}/Certificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/ActiveDirectory/Certificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/ExternalAccountProviders/{ExternalAccountProviderId}/Certificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/LDAP/Certificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/MultiFactorAuth/ClientCertificate/Certificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/RemoteAccountService/MultiFactorAuth/SecurID/Certificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/SecurityPolicy/SPDM/RevokedCertificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/SecurityPolicy/SPDM/TrustedCertificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/SecurityPolicy/TLS/Client/RevokedCertificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/SecurityPolicy/TLS/Client/TrustedCertificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/SecurityPolicy/TLS/Server/RevokedCertificates/{CertificateId}
/redfish/v1/Managers/{ManagerId}/SecurityPolicy/TLS/Server/TrustedCertificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Drives/{DriveId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Memory/{MemoryId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Drives/{DriveId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Boot/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/KeyManagement/KMIPCertificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Memory/{MemoryId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases/{DatabaseId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/Certificates/{CertificateId}
/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/ClientCertificates/{CertificateId}
/redfish/v1/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/Boot/Certificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/Certificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/KeyManagement/KMIPCertificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/Memory/{MemoryId}/Certificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/Certificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/SecureBoot/SecureBootDatabases/{DatabaseId}/Certificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Drives/{DriveId}/Certificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/StorageControllers/{StorageControllerId}/Certificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/Certificates/{CertificateId}
/redfish/v1/Systems/{ComputerSystemId}/VirtualMedia/{VirtualMediaId}/ClientCertificates/{CertificateId}
/redfish/v1/UpdateService/ClientCertificates/{CertificateId}
/redfish/v1/UpdateService/RemoteServerCertificates/{CertificateId}
6.17.3 Properties
| Property | Type | Attributes | Notes |
|---|---|---|---|
| CertificateString | string | read-only required on create (null) |
The string for the certificate.
|
| CertificateType | string (enum) |
read-only required on create (null) |
The format of the certificate.
|
| CertificateUsageTypes (v1.4+) [ ] | array (string (enum)) |
read-only (null) |
|
| Fingerprint (v1.3+) | string | read-only | The fingerprint of the certificate.
^([0-9A-Fa-f]{2}:){0,}([0-9A-Fa-f]{2})$ |
| FingerprintHashAlgorithm (v1.3+) | string | read-only | The hash algorithm for the fingerprint of the certificate.
|
| Issuer { | object | The issuer of the certificate.
|
|
| AdditionalCommonNames (v1.6+) [ ] | array (string, null) | read-only | Additional common names of the entity.
|
| AdditionalOrganizationalUnits (v1.6+) [ ] | array (string, null) | read-only | Additional organizational units of the entity.
|
| AlternativeNames (v1.7+) [ ] | array (string, null) |