Redfish DMTF Logo

Document Identifier: DSP0268

Date: 2022-08-04

Version: 2022.2

Redfish Data Model Specification






Supersedes: 2022.1

Document Class: Normative

Document Status: Published

Document Language: en-US

DMTF is a not-for-profit association of industry members dedicated to promoting enterprise and systems management and interoperability. Members and non-members may reproduce DMTF specifications and documents, provided that correct attribution is given. As DMTF specifications may be revised from time to time, the particular version and release date should always be noted.

Implementation of certain elements of this standard or proposed standard may be subject to third party patent rights, including provisional patent rights (herein "patent rights"). DMTF makes no representations to users of the standard as to the existence of such rights, and is not responsible to recognize, disclose, or identify any or all such third party patent right, owners or claimants, nor for any incomplete or inaccurate identification or disclosure of such rights, owners or claimants. DMTF shall have no liability to any party, in any manner or circumstance, under any legal theory whatsoever, for failure to recognize, disclose, or identify any such third party patent rights, or for such party's reliance on the standard or incorporation thereof in its product, protocols or testing procedures. DMTF shall have no liability to any party implementing such standard, whether such implementation is foreseeable or not, nor to any patent owner or claimant, and shall have no liability or responsibility for costs or losses incurred if a standard is withdrawn or modified after publication, and shall be indemnified and held harmless by any party implementing the standard from any and all claims of infringement by a patent owner for such implementations.

For information about patents held by third-parties which have notified the DMTF that, in their opinion, such patent may relate to or impact implementations of DMTF standards, visit http://www.dmtf.org/about/policies/disclosures.php.

This document's normative language is English. Translation into other languages is permitted.

CONTENTS

1 Overview

The Redfish standard comprises a set of specifications maintained by the Redfish Forum, a working group within the DMTF. The standard defines a protocol that uses RESTful interfaces to provide access to data and operations associated with the management of systems and networks. One of the strengths of the Redfish protocol is that it works with a wide range of servers: from stand-alone servers to rack-mount and bladed environments to large-scale data centers and cloud environments.

The Redfish standard addresses several key issues for infrastructures that require scalability. Large infrastructures often consist of many simple servers of different makes and types. This hyper-scale usage model requires a new approach to systems management. The Redfish 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 discrepencies 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 the DMTF and the Redfish Forum by the following means:

1.3 Where can I find more information?

The following web sites provide more information about the Redfish standard:

The following documents are part of the Redfish development effort. They can be accessed or downloaded from the DMTF Redfish Standards web site: http://www.dmtf.org/standards/redfish

2 Using this guide

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 guide details the definitions for every Redfish standard schema.

Each schema section contains:

The property-level details include:

Column Purpose
Property name

The case-sensitive name of the JSON property as it appears in the JSON payload.

Lists the schema version in parentheses when properties were added to or deprecated in the schema after the initial v1.0.0 release.

Type

The JSON data types for the property, which can include boolean, number, string, or object.

The string (enum) tag identifies enumerated strings.

Number types that use units specify the units.

Attributes

Designates whether:

  • The property is read-only or read-write, if supported by the implementation.
  • The service might return a null value if the property value is temporarily unavailable.
Description

The description of the property, as copied directly from the schema's definition of the property.

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-write This property shall contain the description of this resource. The value shall conform with the 'Description' clause of the Redfish Specification.
Id string read-write This property shall contain the identifier for this resource. The value shall conform with the 'Id' clause of the Redfish Specification.
Name string read-write 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.AllowableValues [ ] array (string) read-only The string values that a service accepts for a property or action parameter.

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.

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.

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

4.2.2 Properties

Property Type Attributes Notes
Data { object The capacity information relating to the user data.
  • The value shall be capacity information relating to provisioned 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.
  • The value shall be 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.
  • The value shall be the number of logical bytes currently 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.
  • The value shall be 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.
  • The value shall be 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.
  • If the value is false, the capacity shall be fully allocated. The default value shall be false.
Metadata { object The capacity information relating to metadata.
  • The value shall be capacity information relating to provisioned system (non-user accessible) 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.
  • The value shall be 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.
  • The value shall be the number of logical bytes currently 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.
  • The value shall be 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.
  • The value shall be 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.
  • The value shall be capacity information relating to provisioned 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.
  • The value shall be 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.
  • The value shall be the number of logical bytes currently 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.
  • The value shall be 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.
  • The value shall be 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.

4.3.2 Properties

Property Type Attributes Notes
LogEntry { object The link to the log entry created for this condition.
  • This property shall contain a link to a resource of type LogEntry that represents the log entry created for this condition.
See the LogEntry schema for details on this property.
      @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.
  • This property shall contain a human-readable message describing 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.
  • This property shall contain an array of message arguments that are substituted for the arguments in the message when looked up in the message registry. It has the same semantics as the MessageArgs property in the Redfish MessageRegistry schema.
MessageId string read-only required The identifier for the message.
  • This property shall contain a MessageId, as defined in the 'MessageId format' clause of the Redfish Specification.
OriginOfCondition { object A link to the resource or object that originated the condition.
  • This property shall contain a link to the resource or object that originated the condition. This property shall not be present if the condition was caused by this resource.
      @odata.id string
(URI)
read-only The unique identifier for a resource.
  • 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.
}
Resolution (v1.14+) string read-only Suggestions on how to resolve the condition.
  • This property shall contain the resolution of the condition. Services should replace the resolution defined in the message registry with a more specific resolution.
Severity string
(enum)
read-only 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.
For the possible property values, see Severity in Property details.
Timestamp string
(date-time)
read-only The time the condition occurred.
  • This property shall indicate the time the condition occurred.

4.3.3 Property details

4.3.3.1 Severity:

The severity of the condition.

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.

4.4.2 Properties

Property Type Attributes Notes
DurableName (v1.1+) string read-only
(null)
The world-wide, persistent name of the resource.
  • This property shall contain the world-wide unique identifier for the resource. The string shall be in the Identifier.DurableNameFormat property value format.
DurableNameFormat (v1.1+) string
(enum)
read-only
(null)
The format of the durable name property.
  • This property shall represent the format of the DurableName property.
For the possible property values, see DurableNameFormat in Property details.

4.4.3 Property details

4.4.3.1 DurableNameFormat:

The format of the durable name property.

string Description
EUI The IEEE-defined 64-bit Extended Unique Identifier (EUI).
  • This durable name shall contain the hexadecimal representation of the IEEE-defined 64-bit Extended Unique Identifier (EUI), as defined in the IEEE's Guidelines for 64-bit Global Identifier (EUI-64) Specification. The DurableName property shall follow the regular expression pattern '^([0-9A-Fa-f]{2}[:-]){7}([0-9A-Fa-f]{2})$', where the most significant octet is first.
FC_WWN The Fibre Channel (FC) World Wide Name (WWN).
  • This durable name shall contain a hexadecimal representation of the World-Wide Name (WWN) format, as defined in the T11 Fibre Channel Physical and Signaling Interface Specification. The DurableName property shall follow the regular expression pattern '^([0-9A-Fa-f]{2}[:-]){7}([0-9A-Fa-f]{2})$', where the most significant octet is first.
iQN The iSCSI Qualified Name (iQN).
  • This durable name shall be in the iSCSI Qualified Name (iQN) format, as defined in RFC3720 and RFC3721.
MACAddress (v1.14+) The media access control address (MAC address).
  • This durable name shall be a media access control address (MAC address), which is a unique identifier assigned to a network interface controller (NIC) for use as a network address. This value should not be used if a more specific type of identifier is available. The DurableName property shall follow the regular expression pattern '^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$', where the most significant octet is first.
NAA The Name Address Authority (NAA) format.
  • This durable name shall contain a hexadecimal representation of the Name Address Authority structure, as defined in the T11 Fibre Channel - Framing and Signaling - 3 (FC-FS-3) specification. The DurableName property shall follow the regular expression pattern '^(([0-9A-Fa-f]{2}){8}){1,2}$', where the most significant octet is first.
NGUID (v1.10+) The Namespace Globally Unique Identifier (NGUID).
  • This durable name shall be in the Namespace Globally Unique Identifier (NGUID), as defined in the NVN Express Specification. The DurableName property shall follow the regular expression pattern '^([0-9A-Fa-f]{2}){16}$', where the most significant octet is first.
NQN (v1.6+) The NVMe Qualified Name (NQN).
  • This durable name shall be in the NVMe Qualified Name (NQN) format, as defined in the NVN Express over Fabric Specification.
NSID (v1.6+, deprecated v1.12) The NVM Namespace Identifier (NSID).
  • This durable name shall be in the NVM Namespace Identifier (NSID) format, as defined in the NVN Express Specification.
Deprecated in v1.12 and later. This value has been deprecated due to its non-uniqueness and NGUID should be used.
UUID The Universally Unique Identifier (UUID).
  • This durable name shall contain the hexadecimal representation of the UUID, as defined by RFC4122. The DurableName property shall follow the regular expression pattern '([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})'.

4.5 IOStatistics

4.5.1 Description

The properties of this type represent IO statistics.

4.5.2 Properties

Property Type Attributes Notes
NonIORequests integer
({tot})
read-write
(null)
Count of non IO requests.
  • The value shall represent the total count from the time of last reset or wrap of non IO requests.
NonIORequestTime string read-write
(null)
The time that the resource is busy processing write requests.
  • The value shall be an ISO 8601 conformant duration describing the time that the resource is busy processing non IO requests from the time of last reset or wrap.
ReadHitIORequests integer
({tot})
read-write
(null)
Count of read IO requests satisfied from memory.
  • The value shall represent the total count from the time of last reset or wrap of read IO requests satisfied from memory.
ReadIOKiBytes integer
(KiBy)
read-write
(null)
Number of kibibytes read.
  • The value shall represent the total number of kibibytes read from the time of last reset or wrap.
ReadIORequests integer
({tot})
read-write
(null)
Count of read IO requests.
  • The value shall represent the total count from the time of last reset or wrap of read IO requests satisfied from either media or memory (i.e. from a storage device or from a cache).
ReadIORequestTime string read-write
(null)
The time that the resource is busy processing read requests.
  • The value shall be an ISO 8601 conformant duration describing the time that the resource is busy processing read requests from the time of last reset or wrap.
WriteHitIORequests integer
({tot})
read-write
(null)
Count of write IO requests coalesced into memory.
  • The value shall represent the total count from the time of last reset or wrap of write IO requests coalesced into memory.
WriteIOKiBytes integer
(KiBy)
read-write
(null)
Number of kibibytes written.
  • The value shall represent the total number of kibibytes written from the time of last reset or wrap.
WriteIORequests integer
({tot})
read-write
(null)
Count of write IO requests.
  • The value shall represent the total count from the time of last reset or wrap of write IO requests.
WriteIORequestTime string read-write
(null)
The time that the resource is busy processing write requests.
  • The value shall be an ISO 8601 conformant duration describing the time that the resource is busy processing write requests from the time of last reset or wrap.

4.6 IPv4Address

4.6.1 Description

This type describes an IPv4 address.

4.6.2 Properties

Property Type Attributes Notes
Address string read-write
(null)
The IPv4 address.
  • This property shall contain an IPv4 address assigned to this interface. If DHCPv4 is enabled on the interface, this property becomes read-only.
Pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$
AddressOrigin string
(enum)
read-only
(null)
This indicates how the address was determined.
  • This property shall contain the IP address origin for this network interface.
For the possible property values, see AddressOrigin in Property details.
Gateway string read-write
(null)
The IPv4 gateway for this address.
  • This property shall contain the IPv4 default gateway address for this interface. If DHCPv4 is enabled on the interface and is configured to set the IPv4 default gateway address, this property becomes read-only. If multiple IPv4 addresses are present on the same interface only a single default gateway is allowed. Any additional IPv4 addresses shall not have a default gateway specified.
Pattern: ^(?:[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.
  • This property shall contain the IPv4 subnet mask for this address. If DHCPv4 is enabled on the interface, this property becomes read-only.
Pattern: ^(?:[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.

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.

4.7.2 Properties

Property Type Attributes Notes
Address string read-write
(null)
The IPv6 address.
  • This property lists an IPv6 address that is currently assigned on this interface.
AddressOrigin string
(enum)
read-only
(null)
This indicates how the address was determined.
  • This property shall contain the IPv6 address origin for this interface.
For the possible property values, see AddressOrigin in Property details.
AddressState string
(enum)
read-only
(null)
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.
For the possible property values, see AddressState in Property details.
Oem {} object See the OEM object definition in the Using this guide clause.
PrefixLength integer read-only
(null)
The IPv6 address prefix Length.
  • This property shall contain the IPv6 address prefix length for this interface.

4.7.3 Property details

4.7.3.1 AddressOrigin:

This indicates how the address was determined.

string Description
DHCPv6 A DHCPv6 service-provided address.
LinkLocal The address is valid for only this network segment, or link.
SLAAC A stateless autoconfiguration (SLAAC) service-provided address.
Static A static user-configured address.

4.7.3.2 AddressState:

The current RFC4862-defined state of this address.

string Description
Deprecated This address is currently within its valid lifetime but is now outside its RFC4862-defined preferred lifetime.
Failed This address has failed Duplicate Address Detection (DAD) testing, as defined in RFC4862, section 5.4, and is not currently in use.
Preferred This address is currently within both its RFC4862-defined valid and preferred lifetimes.
Tentative This address is currently undergoing Duplicate Address Detection (DAD) testing, as defined in RFC4862, section 5.4.

4.8 IPv6GatewayStaticAddress

4.8.1 Description

This type represents 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.
  • This property provides access to a static IPv6 address that is currently assigned on a network interface.
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.
  • Provides 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.

4.9.2 Properties

Property Type Attributes Notes
Address string read-write required
(null)
A valid IPv6 address.
  • This property provides access to a static IPv6 address that is currently assigned on a network interface.
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.
  • This property shall contain the IPv6 network prefix length, in bits, for this address.

4.10 Location

4.10.1 Description

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.
  • This property shall contain the altitude of the resource, in meters units, defined as the elevation above sea level.
Contacts (v1.7+) [ { array An array of contact information.
  • This property shall contain an array of contact information for an individual or organization responsible for this resource.
      ContactName (v1.7+) string read-write
(null)
Name of this contact.
  • This property shall contain the name of a person or organization to contact for information about this resource.
      EmailAddress (v1.7+) string read-write
(null)
Email address for this contact.
  • This property shall contain the email address for a person or organization to contact for information about this resource.
      PhoneNumber (v1.7+) string read-write
(null)
Phone number for this contact.
  • This property shall contain the phone number for a person or organization to contact for information about this resource.
} ]
Info (v1.1+, deprecated v1.5 string read-only
(null)
The location of the resource.
  • This property shall represent the location of the resource.
Deprecated in v1.5 and later. This property has been deprecated in favor of the PostalAddress, Placement, and PartLocation properties.
InfoFormat (v1.1+, deprecated v1.5 string read-only
(null)
The format of the Info property.
  • This property shall represent the Info property format.
Deprecated in v1.5 and later. This property has been deprecated in favor of the PostalAddress, Placement, and PartLocation properties.
Latitude (v1.6+) number
(deg)
read-write
(null)
The latitude of the resource.
  • This property shall contain the latitude of the resource specified in degrees using a decimal format and not minutes or seconds.
Longitude (v1.6+) number
(deg)
read-write
(null)
The longitude of the resource in degrees.
  • This property shall contain the longitude of the resource specified in degrees using a decimal format and not minutes or seconds.
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.
  • This property shall contain the part location for a resource within an enclosure. This representation shall indicate the location of a part within a location specified by the Placement property.
      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.
  • This property shall contain the number that represents the location of the part based on the LocationType. LocationOrdinalValue shall be measured based on the Orientation value starting with 0.
      LocationType (v1.5+) string
(enum)
read-only
(null)
The type of location of the part.
  • This property shall contain the type of location of the part.
For the possible property values, see LocationType in Property details.
      Orientation (v1.5+) string
(enum)
read-only
(null)
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 LocationOrdinalValue property.
For the possible property values, see Orientation in Property details.
      Reference (v1.5+) string
(enum)
read-only
(null)
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.
For the possible property values, see Reference in Property details.
      ServiceLabel (v1.5+) string read-only
(null)
The label of the part location, such as a silk-screened name or a printed label.
  • This property shall contain the label assigned for service at the part location.
}
Placement (v1.3+) { object A place within the addressed location.
  • This property shall contain a place within the addressed location.
      AdditionalInfo (v1.7+) string read-write
(null)
Area designation or other additional info.
  • This property shall contain additional information, such as Tile, Column (Post), Wall, or other designation that describes a location that cannot be conveyed with other properties defined for the Placement object.
      Rack (v1.3+) string read-write
(null)
The name of a rack location within a row.
  • This property shall contain the name of the rack within a row.
      RackOffset (v1.3+) integer read-write
(null)
The vertical location of the item, in terms of RackOffsetUnits.
  • The vertical location of the item in the rack. Rack offset units shall be measured from bottom to top, starting with 0.
      RackOffsetUnits (v1.3+) string
(enum)
read-write
(null)
The type of rack units in use.
  • This property shall contain a RackUnit enumeration literal that indicates the type of rack units in use.
For the possible property values, see RackOffsetUnits in Property details.
      Row (v1.3+) string read-write
(null)
The name of the row.
  • This property shall contain the name of the row.
}
PostalAddress (v1.3+) { object The postal address of the addressed resource.
  • This property shall contain a postal address of the resource.
      AdditionalCode (v1.3+) string read-write
(null)
The additional code.
  • The value shall conform to the RFC5139-defined requirements of the ADDCODE field.
      AdditionalInfo (v1.7+) string read-write
(null)
The room designation or other additional information.
  • The value shall conform to the requirements of the LOC field as defined in RFC5139. Provides additional information.
      Building (v1.3+) string read-write
(null)
The name of the building.
  • The value shall conform to the RFC5139-defined requirements of the BLD field. Names the building.
      City (v1.3+) string read-write
(null)
City, township, or shi (JP).
  • The value shall conform to the RFC5139-defined requirements of the A3 field. Names a city, township, or shi (JP).
      Community (v1.3+) string read-write
(null)
The postal community name.
  • The value shall conform to the RFC5139-defined requirements of the PCN field. A postal community name.
      Country (v1.3+) string read-write
(null)
The country.
  • The value shall conform to the RFC5139-defined requirements of the Country field.
      District (v1.3+) string read-write
(null)
A county, parish, gun (JP), or district (IN).
  • The value shall conform to the RFC5139-defined requirements of the A2 field. Names a county, parish, gun (JP), or district (IN).
      Division (v1.3+) string read-write
(null)
City division, borough, city district, ward, or chou (JP).
  • The value shall conform to the RFC5139-defined requirements of the A4 field. Names a city division, borough, city district, ward, or chou (JP).
      Floor (v1.3+) string read-write
(null)
The floor.
  • The value shall conform to the RFC5139-defined requirements of the FLR field. Provides a floor designation.
      GPSCoords (v1.3+, deprecated v1.6 string read-write
(null)
The GPS coordinates of the part.
  • The value shall conform to the RFC5139-defined requirements of the ADDCODE field. Shall contain the GPS coordinates of the location. If furnished, expressed in the '[-][nn]n.nnnnnn, [-][nn]n.nnnnn' format. For example, two comma-separated positive or negative numbers with six decimal places of precision.
Deprecated in v1.6 and later. This property has been deprecated in favor of the Longitude and Latitude properties.
      HouseNumber (v1.3+) integer read-write
(null)
The numeric portion of house number.
  • The value shall conform to the RFC5139-defined requirements of the HNO field. The numeric portion of the house number.
      HouseNumberSuffix (v1.3+) string read-write
(null)
The house number suffix.
  • The value shall conform to the RFC5139-defined requirements of the HNS field. Provides a suffix to a house number, (F, B, or 1/2).
      Landmark (v1.3+) string read-write
(null)
The landmark.
  • The value shall conform to the RFC5139-defined requirements of the LMK field. Identifies a landmark or vanity address.
      LeadingStreetDirection (v1.3+) string read-write
(null)
A leading street direction.
  • The value shall conform to the requirements of the PRD field as defined in RFC5139. Names a leading street direction, (N, W, or SE).
      Location (v1.3+, deprecated v1.7 string read-write
(null)
The room designation or other additional information.
  • The value shall conform to the RFC5139-defined requirements of the LOC field. Provides additional information.
Deprecated in v1.7 and later. This property has been deprecated in favor of the AdditionalInfo property.
      Name (v1.3+) string read-write
(null)
The name.
  • The value shall conform to the RFC5139-defined requirements of the NAM field. Names the occupant.
      Neighborhood (v1.3+) string read-write
(null)
Neighborhood or block.
  • The value shall conform to the RFC5139-defined requirements of the A5 field. Names a neighborhood or block.
      PlaceType (v1.3+) string read-write
(null)
The description of the type of place that is addressed.
  • The value shall conform to the RFC5139-defined requirements of the PLC field. Examples include office and residence.
      POBox (v1.3+) string read-write
(null)
The post office box (PO box).
  • The value shall conform to the RFC5139-defined requirements of the POBOX field. A post office box (PO box).
      PostalCode (v1.3+) string read-write
(null)
The postal code or zip code.
  • The value shall conform to the RFC5139-defined requirements of the PC field. A postal code (or zip code).
      Road (v1.3+) string read-write
(null)
The primary road or street.
  • The value shall conform to the RFC5139-defined requirements of the RD field. Designates a primary road or street.
      RoadBranch (v1.3+) string read-write
(null)
The road branch.
  • The value shall conform to the RFC5139-defined requirements of the RDBR field. Shall contain a post office box (PO box) road branch.
      RoadPostModifier (v1.3+) string read-write
(null)
The road post-modifier.
  • The value shall conform to the RFC5139-defined requirements of the POM field. For example, Extended.
      RoadPreModifier (v1.3+) string read-write
(null)
The road pre-modifier.
  • The value shall conform to the RFC5139-defined requirements of the PRM field. For example, Old or New.
      RoadSection (v1.3+) string read-write
(null)
The road section.
  • The value shall conform to the RFC5139-defined requirements of the RDSEC field. A road section.
      RoadSubBranch (v1.3+) string read-write
(null)
The road sub branch.
  • The value shall conform to the RFC5139-defined requirements of the RDSUBBR field.
      Room (v1.3+) string read-write
(null)
The name or number of the room.
  • The value shall conform to the RFC5139-defined requirements of the ROOM field. A name or number of a room to locate the resource within the unit.
      Seat (v1.3+) string read-write
(null)
The seat, such as the desk, cubicle, or workstation.
  • The value shall conform to the RFC5139-defined requirements of the SEAT field. A name or number of a seat, such as the desk, cubicle, or workstation.
      Street (v1.3+) string read-write
(null)
Street name.
  • The value shall conform to the RFC5139-defined requirements of the A6 field. Names a street.
      StreetSuffix (v1.3+) string read-write
(null)
Avenue, Platz, Street, Circle.
  • The value shall conform to the RFC5139-defined requirements of the STS field. Names a street suffix.
      Territory (v1.3+) string read-write
(null)
A top-level subdivision within a country.
  • The value shall conform to the RFC5139-defined requirements of the A1 field when it names a territory, state, region, province, or prefecture within a country.
      TrailingStreetSuffix (v1.3+) string read-write
(null)
A trailing street suffix.
  • The value shall conform to the RFC5139-defined requirements of the POD field. Names a trailing street suffix.
      Unit (v1.3+) string read-write
(null)
The name or number of the apartment unit or suite.
  • The value shall conform to the RFC5139-defined requirements of the UNIT field. The name or number of a unit, such as the apartment or suite, to locate the resource.
}

4.10.3 Property details

4.10.3.1 LocationType:

The type of location of the part.

string Description
Backplane (v1.12+) A backplane.
  • This value shall indicate the part is a backplane in an enclosure.
Bay A bay.
  • This value shall indicate the part is located in a bay.
Connector A connector or port.
  • This value shall indicate the part is located in a connector or port.
Embedded (v1.13+) Embedded within a part.
  • This value shall indicate the part is embedded or otherwise permanently incorporated into a larger part or device. This value shall not be used for parts that can be removed by a user or are considered field-replaceable.
Slot A slot.
  • This value shall indicate the part is located in a slot.
Socket A socket.
  • This value shall indicate the part is located in a socket.

4.10.3.2 Orientation:

The orientation for the ordering of the slot enumeration used by the LocationOrdinalValue property.

string Description
BackToFront The ordering for the LocationOrdinalValue is back to front.
  • This value shall indicate the ordering for LocationOrdinalValue is back to front.
BottomToTop The ordering for LocationOrdinalValue is bottom to top.
  • This value shall indicate the ordering for LocationOrdinalValue is bottom to top.
FrontToBack The ordering for LocationOrdinalValue is front to back.
  • This value shall indicate the ordering for LocationOrdinalValue is front to back.
LeftToRight The ordering for the LocationOrdinalValue is left to right.
  • This value shall indicate the ordering for LocationOrdinalValue is left to right.
RightToLeft The ordering for the LocationOrdinalValue is right to left.
  • This value shall indicate the ordering for LocationOrdinalValue is right to left.
TopToBottom The ordering for the LocationOrdinalValue is top to bottom.
  • This value shall indicate the ordering for LocationOrdinalValue is top to bottom.

4.10.3.3 RackOffsetUnits:

The type of rack units in use.

string Description
EIA_310 A rack unit that is equal to 1.75 in (44.45 mm).
  • Rack units shall conform to the EIA-310 standard.
OpenU A rack unit that is equal to 48 mm (1.89 in).
  • Rack units shall be specified in terms of the Open Compute Open Rack Specification.

4.10.3.4 Reference:

The reference point for the part location. Provides guidance about the general location of the part.

string Description
Bottom The part is in the bottom of the unit.
  • This value shall indicate the part is in the bottom of the unit.
Front The part is in the front of the unit.
  • This value shall indicate the part is in the front of the unit.
Left The part is on the left side of of the unit.
  • This value shall indicate the part is on the left side of of the unit.
Middle The part is in the middle of the unit.
  • This value shall indicate the part is in the middle of the unit.
Rear The part is in the rear of the unit.
  • This value shall indicate the part is in the rear of the unit.
Right The part is on the right side of the unit.
  • This value shall indicate the part is on the right side of the unit.
Top The part is in the top of the unit.
  • This value shall indicate the part is in the top of the unit.

4.11 Message

4.11.1 Description

The message that the Redfish service returns.

4.11.2 Properties

Property Type Attributes Notes
Message string read-only The human-readable message.
  • This property shall contain a 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.
  • This property shall contain an array of message arguments that are substituted for the arguments in the message when looked up in the message registry. It has the same semantics as the MessageArgs property in the Redfish MessageRegistry schema.
MessageId string read-only required The identifier for the message.
  • This property shall contain a MessageId, as defined in the 'MessageId format' clause of the Redfish Specification.
MessageSeverity (v1.1+) string
(enum)
read-only 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.
For the possible property values, see MessageSeverity in Property details.
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.
  • This property shall contain an array of RFC6901-defined JSON pointers indicating the properties described by the message, if appropriate for the message.
Resolution string read-only Used to provide suggestions on how to resolve the situation that caused the message.
  • This property shall contain the resolution of the message. Services can replace the resolution defined in the message registry with a more specific resolution in message payloads.
Severity (deprecated v1.1) string read-only The severity of the message.
  • This property shall contain the severity of the message, as defined in the 'Status' clause of the Redfish Specification. Services can replace the value defined in the message registry with a value more applicable to the implementation.
Deprecated in v1.1 and later. This property has been deprecated in favor of MessageSeverity, which ties the values to the enumerations defined for the Health property within Status.

4.11.3 Property details

4.11.3.1 MessageSeverity:

The severity of the message.

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.

4.12.2 Properties

Property Type Attributes Notes
@odata.id string
(URI)
read-only required The unique identifier for a resource.
  • 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.
Actions (v1.2+) {} object The available actions for this resource.
  • This property shall contain the available actions for this resource.
MaxNumSupported integer read-only
(null)
The maximum number of members allowable for this particular redundancy group.
  • This property shall contain the maximum number of members allowed in the redundancy group.
MemberId string read-only required The unique identifier for the member within an array.
  • This property shall contain the unique identifier for this member within an array. For services supporting Redfish v1.6 or higher, this value shall contain the zero-based array index.
MinNumNeeded integer read-only required
(null)
The minimum number of members needed for this group to be redundant.
  • This property shall contain the minimum number of members allowed in the redundancy group for the current redundancy mode to still be fault tolerant.
Mode string
(enum)
read-write required
(null)
The redundancy mode of the group.
  • This property shall contain the information about the redundancy mode of this subsystem.
For the possible property values, see Mode in Property details.
Name string read-only required The name of the resource or array member.
  • This object represents the name of this resource or array member. The resource values shall comply with the Redfish Specification-described requirements. This string value shall be of the 'Name' reserved word format.
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.
  • This property shall indicate whether the redundancy is enabled.
RedundancySet [ { array required The links to components of this redundancy set.
  • This property shall contain the links to components that are part of this redundancy set.
      @odata.id string
(URI)
read-only The unique identifier for a resource.
  • 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.
} ]
Status {} object required The status and health of the resource and its subordinate or dependent resources.
  • This property shall contain any status or health properties of the resource.
For property details, see Status.

4.12.3 Property details

4.12.3.1 Mode:

The redundancy mode of the group.

string Description
Failover Failure of one unit automatically causes a standby or offline unit in the redundancy set to take over its functions.
N+m Multiple units are available and active such that normal operation will continue if one or more units fail.
NotRedundant (v1.3+) The subsystem is not configured in a redundancy mode, either due to configuration or the functionality has been disabled by the user.
Sharing Multiple units contribute or share such that operation will continue, but at a reduced capacity, if one or more units fail.
Sparing One or more spare units are available to take over the function of a failed unit, but takeover is not automatic.

4.13 RedundantGroup

4.13.1 Description

The redundancy information for the devices in a 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.
  • This property shall contain the maximum number of devices allowed in the redundancy group.
MinNeededInGroup (v1.4+) integer read-only required
(null)
The minimum number of devices needed for this group to be redundant.
  • This property shall contain the minimum number of functional devices needed in the redundancy group for the current redundancy mode to be fault tolerant.
RedundancyGroup (v1.4+) [ { array required The links to the devices included in this redundancy group.
  • This property shall contain the links to the resources that represent the devices that are part of this redundancy group.
      @odata.id string
(URI)
read-only The unique identifier for a resource.
  • 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.
} ]
RedundancyType (v1.4+) string
(enum)
read-write required
(null)
The redundancy mode of the group.
  • This property shall contain the information about the redundancy mode of this redundancy group.
For the possible property values, see RedundancyType in Property details.
Status (v1.4+) {} object required The status and health of the resource and its subordinate or dependent resources.
  • This property shall contain any status or health properties of the resource.
For property details, see Status.

4.13.3 Property details

4.13.3.1 RedundancyType:

The redundancy mode of the group.

string Description
Failover Failure of one unit automatically causes a standby or offline unit in the redundancy set to take over its functions.
  • This value shall indicate that a 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.
  • This value shall indicate that the capacity or services provided by the set of N+M devices can withstand failure of up to M units, with all units in the group normally providing capacity or service.
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.

4.14.2 Properties

Property Type Attributes Notes
ConsistencyEnabled boolean read-only
(null)
True if consistency is enabled.
  • If true, consistency shall be enabled across the source and its associated target replica(s). The default value for this property is false.
ConsistencyState string
(enum)
read-only
(null)
The current state of consistency.
  • The ConsistencyState enumeration literal shall indicate the current state of consistency.
For the possible property values, see ConsistencyState in Property details.
ConsistencyStatus string
(enum)
read-only
(null)
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.
For the possible property values, see ConsistencyStatus in Property details.
ConsistencyType string
(enum)
read-only
(null)
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.
For the possible property values, see ConsistencyType in Property details.
DataProtectionLineOfService (v1.1+) { object A pointer to the DataProtection line of service element that describes this replica.
  • The value shall be a pointer to the data protection line of service that describes this replica.
      @odata.id string
(URI)
read-only The unique identifier for a resource.
  • 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.
}
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.
  • If true, the storage array shall stop receiving data to the source element if copying to a remote element fails. The default value for this property is false.
PercentSynced integer
(%)
read-only
(null)
Specifies the percent of the work completed to reach synchronization.
  • Specifies the percent of the work completed to reach synchronization. Shall not be instantiated if implementation is not capable of providing this information. If related to a group, then PercentSynced shall be an average of the PercentSynced across all members of the group.
Replica { object Deprecated - Use Source Replica. The resource that is the source of this replica.
  • Deprecated - Use Source Replica. The value shall reference the resource that is the source of this replica.
      @odata.id string
(URI)
read-only The unique identifier for a resource.
  • 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.
}
ReplicaFaultDomain (v1.3+) string
(enum)
read-only
(null)
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.
For the possible property values, see ReplicaFaultDomain in Property details.
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.
  • 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.
For the possible property values, see ReplicaPriority in Property details.
ReplicaProgressStatus string
(enum)
read-only
(null)
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.
For the possible property values, see ReplicaProgressStatus in Property details.
ReplicaReadOnlyAccess string
(enum)
read-only
(null)
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.
For the possible property values, see ReplicaReadOnlyAccess in Property details.
ReplicaRecoveryMode string
(enum)
read-only
(null)
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.
For the possible property values, see ReplicaRecoveryMode in Property details.
ReplicaRole string
(enum)
read-only
(null)
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.
For the possible property values, see ReplicaRole in Property details.
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.
  • Applies to Adaptive mode and it describes maximum number of bytes the SyncedElement (target) can be out of sync. If the number of out-of-sync bytes exceeds the skew value, ReplicaUpdateMode shall be switched to synchronous.
ReplicaState string
(enum)
read-only
(null)
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.
For the possible property values, see ReplicaState in Property details.
ReplicaType string
(enum)
read-only
(null)
ReplicaType describes the intended outcome of the replication.
  • The ReplicaType enumeration literal shall describe the intended outcome of the replication.
For the possible property values, see ReplicaType in Property details.
ReplicaUpdateMode string
(enum)
read-only
(null)
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.
For the possible property values, see ReplicaUpdateMode in Property details.
RequestedReplicaState string
(enum)
read-only
(null)
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.
For the possible property values, see RequestedReplicaState in Property details.
SourceReplica (v1.2+) { object The resource that is the source of this replica.
  • The value shall reference the resource that is the source of this replica.
      @odata.id string
(URI)
read-only The unique identifier for a resource.
  • 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.
}
SyncMaintained boolean read-only
(null)
Synchronization is maintained.
  • If true, Synchronization shall be maintained. The default value for this property is false.
UndiscoveredElement string
(enum)
read-only
(null)
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.
For the possible property values, see UndiscoveredElement in Property details.
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.
  • The value shall be an ISO 8601 conformant time of day that specifies when the point-in-time copy was taken or when the replication relationship is activated, reactivated, resumed or re-established. This property shall be null if the implementation is not capable of providing this information.
WhenDeactivated string
(%)
read-only
(null)
Specifies when the replication relationship is deactivated.
  • The value shall be an ISO 8601 conformant time of day that specifies when the replication relationship is deactivated. Do not instantiate this property if implementation is not capable of providing this information.
WhenEstablished string
(%)
read-only
(null)
Specifies when the replication relationship is established.
  • The value shall be an ISO 8601 conformant time of day that specifies when the replication relationship is established. Do not instantiate this property if implementation is not capable of providing this information.
WhenSuspended string
(%)
read-only
(null)
Specifies when the replication relationship is suspended.
  • The value shall be an ISO 8601 conformant time of day that specifies when the replication relationship is suspended. Do not instantiate this property if implementation is not capable of providing this information.
WhenSynced string read-only
(null)
The point in time that the Elements were synchronized.
  • The value shall be an ISO 8601 conformant time of day that specifies when the elements were synchronized.
WhenSynchronized string
(%)
read-only
(null)
Specifies when the replication relationship is synchronized.
  • The value shall be an ISO 8601 conformant time of day that specifies when the replication relationship is synchronized. Do not instantiate this property if implementation is not capable of providing this information.

4.14.3 Property details

4.14.3.1 ConsistencyState:

The current state of consistency.

string Description
Consistent Consistent.
  • This enumeration literal shall indicate that the source and target shall be consistent.
Inconsistent Not consistent.
  • This enumeration literal shall indicate that the source and target are not required to be consistent.

4.14.3.2 ConsistencyStatus:

The current status of consistency.

string Description
Consistent Consistent.
  • This enumeration literal shall indicate that the source and target are consistent.
Disabled Consistency disabled.
  • This enumeration literal shall indicate that the source and target have consistency disabled.
InError Consistency error.
  • This enumeration literal shall indicate that the source and target are not consistent.
InProgress Becoming consistent.
  • This enumeration literal shall indicate that the source and target are becoming consistent.

4.14.3.3 ConsistencyType:

Indicates the consistency type used by the source and its associated target group.

string Description
SequentiallyConsistent Sequentially consistent.
  • This enumeration literal shall indicate that the source and target shall be sequentially consistent.

4.14.3.4 ReplicaFaultDomain:

ReplicaFaultDomain describes the fault domain (local or remote) of the replica relationship.

string Description
Local Local indicates that the source and target replicas are contained within a single fault domain.
  • This enumeration literal shall indicate 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.
  • This enumeration literal shall indicate 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.

string Description
High Copy engine I/O has higher priority than host I/O.
  • Copy engine I/O shall have a higher priority than host I/O.
Low Copy engine I/O lower priority than host I/O.
  • Copy engine I/O shall have a lower priority than host I/O.
Same Copy engine I/O has the same priority as host I/O.
  • Copy engine I/O shall have the same priority as host I/O.
Urgent Copy operation to be performed as soon as possible, regardless of the host I/O requests.
  • Regardless of the host I/O requests, the Copy operation shall be performed as soon as possible.

4.14.3.6 ReplicaProgressStatus:

The status of the session with respect to Replication activity.

string Description
Aborting Abort in progress.
  • This enumeration literal shall indicate that replication has an abort in progress.
Completed The request is completed. Data flow is idle.
  • This enumeration literal shall indicate that the request is completed. Data flow is idle.
Detaching Detach in progress.
  • This enumeration literal shall indicate that replication has a detach in progress.
Dormant Indicates that the data flow is inactive, suspended or quiesced.
  • This enumeration literal shall indicate that the data flow is inactive, suspended or quiesced.
FailingBack Undoing the result of failover.
  • This enumeration literal shall indicate that replication is undoing the result of failover.
FailingOver In the process of switching source and target.
  • This enumeration literal shall indicate that replication is in the process of switching source and target.
Fracturing Fracture in progress.
  • This enumeration literal shall indicate that replication has a fracture in progress.
Initializing In the process of establishing source/replica relationship and the data flow has not started.
  • This enumeration literal shall indicate that replication is 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.
  • This enumeration literal shall indicate that replication status is mixed across element pairs in a replication group. Generally, the individual statuses need to be examined.
Pending The flow of data has stopped momentarily due to limited bandwidth or a busy system.
  • This enumeration literal shall indicate that the flow of data has stopped momentarily due to limited bandwidth or a busy system.
Preparing Preparation in progress.
  • This enumeration literal shall indicate that replication has preparation in progress.
RequiresActivate The requested operation has completed, however, the synchronization relationship needs to be activated before further copy operations can be issued.
  • This enumeration literal shall indicate that 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.
  • This enumeration literal shall indicate that 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.
  • This enumeration literal shall indicate that 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.
  • This enumeration literal shall indicate that 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.
  • This enumeration literal shall indicate that 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.
  • This enumeration literal shall indicate that the requested operation has completed, however, the synchronization relationship needs to be split before further copy operations can be issued.
Restoring Restore in progress.
  • This enumeration literal shall indicate that replication has a restore in progress.
Resyncing Resync in progress.
  • This enumeration literal shall indicate that replication has resynchronization in progress.
Splitting Split in progress.
  • This enumeration literal shall indicate that replication has a split in progress.
Suspending The copy operation is in the process of being suspended.
  • This enumeration literal shall indicate that replication has a copy operation in the process of being suspended.
Synchronizing Sync in progress.
  • This enumeration literal shall indicate that replication has synchronization in progress.
Terminating The relationship is in the process of terminating.
  • This enumeration literal shall indicate that the replication 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.

string Description
Both Both the source and the target elements are read only to the host.
  • Both the source and the target elements shall be read only to the host.
ReplicaElement The replica element.
  • The replica element shall be read-only to the host.
SourceElement The source element.
  • The source element shall be read-only to the host.

4.14.3.8 ReplicaRecoveryMode:

Describes whether the copy operation continues after a broken link is restored.

string Description
Automatic Copy operation resumes automatically.
  • The copy operation shall resume automatically.
Manual ReplicaState is set to Suspended after the link is restored. It is required to issue the Resume operation to continue.
  • The ReplicaState shall be 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.

string Description
Source The source element.
  • This enumeration literal shall indicate a source element.
Target The target element.
  • This enumeration literal shall indicate target element.

4.14.3.10 ReplicaState:

ReplicaState describes the state of the relationship with respect to Replication activity.

string Description
Aborted The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation.
  • This enumeration literal shall indicate that the copy operation is aborted with the Abort operation. The Resync Replica operation can be used 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.
  • This enumeration literal shall indicate that 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.
  • This enumeration literal shall indicate that the reads and writes are sent to the target element. The source element may not be reachable.
Fractured Target is split from the source.
  • This enumeration literal shall indicate that the Target is split from the source. The target may not be consistent.
Inactive Data flow has stopped, writes to source element will not be sent to target element.
  • This enumeration literal shall indicate that data flow has stopped, writes to source element shall 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.
  • This enumeration literal shall indicate that 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.
  • This enumeration literal shall indicate that the storage server 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.
  • This enumeration literal shall indicate the ReplicaState of GroupSynchronized. The value indicates the StorageSynchronized relationships of the elements in the group have different ReplicaState values.
Partitioned State of replication relationship can not be determined, for example, due to a connection problem.
  • This enumeration literal shall indicate that the 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.
  • This enumeration literal shall indicate that initialization is completed, however, the data flow has not started.
Restored It indicates the source element was restored from the target element.
  • This enumeration literal shall indicate that 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.
  • This enumeration literal shall indicate that 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.
  • This enumeration literal shall indicate that the target element was gracefully (or systematically) split from its source element -- consistency shall be guaranteed.
Suspended Data flow between the source and target elements has stopped. Writes to source element are held until the relationship is Resumed.
  • This enumeration literal shall indicate that the data flow between the source and target elements has stopped. Writes to source element shall be held until the relationship is Resumed.
Synchronized For the Mirror, Snapshot, or Clone replication, the target represents a copy of the source.
  • This enumeration literal shall indicate that for Mirror, Snapshot, or Clone replication, the target represents a copy of the source.
Unsynchronized Not all the source element data has been copied to the target element.
  • This enumeration literal shall indicate that 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.

string Description
Clone Create a point in time, full copy the source.
  • This enumeration literal shall indicate that replication shall create a point in time, full copy the source.
Mirror Create and maintain a copy of the source.
  • This enumeration literal shall indicate that replication shall create and maintain a copy of the source.
Snapshot Create a point in time, virtual copy of the source.
  • This enumeration literal shall indicate that replication shall create a point in time, virtual copy of the source.
TokenizedClone Create a token based clone.
  • This enumeration literal shall indicate that replication shall create a token based clone.

4.14.3.12 ReplicaUpdateMode:

Describes whether the target elements will be updated synchronously or asynchronously.

string Description
Active Active-Active (i.e. bidirectional) synchronous updates.
  • This enumeration literal shall indicate Active-Active (i.e. bidirectional) synchronous updates.
Adaptive Allows implementation to switch between synchronous and asynchronous modes.
  • This enumeration literal shall indicate that an implementation may switch between synchronous and asynchronous modes.
Asynchronous Asynchronous updates.
  • This enumeration literal shall indicate Asynchronous updates.
Synchronous Synchronous updates.
  • This enumeration literal shall indicate Synchronous updates.

4.14.3.13 RequestedReplicaState:

The last requested or desired state for the relationship.

string Description
Aborted The copy operation is aborted with the Abort operation. Use the Resync Replica operation to restart the copy operation.
  • This enumeration literal shall indicate that the copy operation is aborted with the Abort operation. The Resync Replica operation can be used 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.
  • This enumeration literal shall indicate that 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.
  • This enumeration literal shall indicate that the reads and writes are sent to the target element. The source element may not be reachable.
Fractured Target is split from the source.
  • This enumeration literal shall indicate that the Target is split from the source. The target may not be consistent.
Inactive Data flow has stopped, writes to source element will not be sent to target element.
  • This enumeration literal shall indicate that data flow has stopped, writes to source element shall 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.
  • This enumeration literal shall indicate that 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.
  • This enumeration literal shall indicate that the storage server 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.
  • This enumeration literal shall indicate the ReplicaState of GroupSynchronized. The value indicates the StorageSynchronized relationships of the elements in the group have different ReplicaState values.
Partitioned State of replication relationship can not be determined, for example, due to a connection problem.
  • This enumeration literal shall indicate that the 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.
  • This enumeration literal shall indicate that initialization is completed, however, the data flow has not started.
Restored It indicates the source element was restored from the target element.
  • This enumeration literal shall indicate that 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.
  • This enumeration literal shall indicate that 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.
  • This enumeration literal shall indicate that the target element was gracefully (or systematically) split from its source element -- consistency shall be guaranteed.
Suspended Data flow between the source and target elements has stopped. Writes to source element are held until the relationship is Resumed.
  • This enumeration literal shall indicate that the data flow between the source and target elements has stopped. Writes to source element shall be held until the relationship is Resumed.
Synchronized For the Mirror, Snapshot, or Clone replication, the target represents a copy of the source.
  • This enumeration literal shall indicate that for Mirror, Snapshot, or Clone replication, the target represents a copy of the source.
Unsynchronized Not all the source element data has been copied to the target element.
  • This enumeration literal shall indicate that 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.

string Description
ReplicaElement The replica element is undiscovered.
  • This enumeration literal shall indicate that the replica element is undiscovered.
SourceElement The source element is undiscovered.
  • This enumeration literal shall indicate that the source element is undiscovered.

4.15 Schedule

4.15.1 Description

Schedule a series of occurrences.

4.15.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.
  • This property shall contain the days of the month when scheduled occurrences are enabled, for enabled days of week and months of year. If the array contains a single value of 0, or if the property is not present, all days of the month shall be enabled.
EnabledDaysOfWeek [ ] array (string
(enum))
read-write
(null)
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.
For the possible property values, see EnabledDaysOfWeek in Property details.
EnabledIntervals (v1.1+) [ ] array (string, null) read-write Intervals when scheduled occurrences are enabled.
  • Each value shall be an ISO 8601 conformant interval specifying when occurrences are enabled.
EnabledMonthsOfYear [ ] array (string
(enum))
read-write
(null)
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.
For the possible property values, see EnabledMonthsOfYear in Property details.
InitialStartTime string
(date-time)
read-write
(null)
The date and time when the initial occurrence is scheduled to occur.
  • This property shall contain the date and time when the initial occurrence is scheduled to occur.
Lifetime string read-write
(null)
The time after provisioning when the schedule as a whole expires.
  • This property shall contain a Redfish Duration that describes the time after provisioning when the schedule expires.
Pattern: -?P(\d+D)?(T(\d+H)?(\d+M)?(\d+(.\d+)?S)?)?
MaxOccurrences integer read-write
(null)
The maximum number of scheduled occurrences.
  • This property shall contain the maximum number of scheduled occurrences.
Name string read-write
(null)
The schedule name.
  • The name of the schedule, which is constructed as OrgID:ScheduleName. Examples include ACME:Daily, ACME:Weekly, and ACME:FirstTuesday.
RecurrenceInterval string read-write
(null)
The duration between consecutive occurrences.
  • This property shall contain the duration between consecutive occurrences.
Pattern: -?P(\d+D)?(T(\d+H)?(\d+M)?(\d+(.\d+)?S)?)?

4.15.3 Property details

4.15.3.1 EnabledDaysOfWeek:

Days of the week.

string Description
Every Every day of the week.
  • This value indicates that every day of the week has been selected. When used in array properties, such as for enabling a function on certain days, it shall be the only member in the array.
Friday Friday.
Monday Monday.
Saturday Saturday.
Sunday Sunday.
Thursday Thursday.
Tuesday Tuesday.
Wednesday Wednesday.

4.15.3.2 EnabledMonthsOfYear:

Months of the year.

string Description
April April.
August August.
December December.
Every Every month of the year.
  • This value indicates that every month of the year has been selected. When used in array properties, such as for enabling a function for certain months, it shall be the only member in the array.
February February.
January January.
July July.
June June.
March March.
May May.
November November.
October October.
September September.

4.16 Status

4.16.1 Description

The status and health of a resource and its children.

4.16.2 Properties

Property Type Attributes Notes
Conditions (v1.11+) [ { array Conditions in this resource that require attention.
  • This property shall represent the active conditions requiring attention in this or a related resource that affects the Health or HealthRollup of this resource. The service may roll up multiple conditions originating from a resource, using the ConditionInRelatedResource message from Base Message Registry.
      LogEntry { object The link to the log entry created for this condition.
  • This property shall contain a link to a resource of type LogEntry that represents the log entry created for this condition.
See the LogEntry schema for details on this property.
            @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.
  • This property shall contain a human-readable message describing 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.
  • This property shall contain an array of message arguments that are substituted for the arguments in the message when looked up in the message registry. It has the same semantics as the MessageArgs property in the Redfish MessageRegistry schema.
      MessageId string read-only required The identifier for the message.
  • This property shall contain a MessageId, as defined in the 'MessageId format' clause of the Redfish Specification.
      OriginOfCondition { object A link to the resource or object that originated the condition.
  • This property shall contain a link to the resource or object that originated the condition. This property shall not be present if the condition was caused by this resource.
            @odata.id string
(URI)
read-only The unique identifier for a resource.
  • 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.
      }
      Resolution (v1.14+) string read-only Suggestions on how to resolve the condition.
  • This property shall contain the resolution of the condition. Services should replace the resolution defined in the message registry with a more specific resolution.
      Severity string
(enum)
read-only 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.
For the possible property values, see Severity in Property details.
      Timestamp string
(date-time)
read-only The time the condition occurred.
  • This property shall indicate the time the condition occurred.
} ]
Health string
(enum)
read-only
(null)
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.
For the possible property values, see Health in Property details.
HealthRollup string
(enum)
read-only
(null)
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 the possible property values, see HealthRollup in Property details.
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 known state of the resource, such as, enabled.
  • This property shall indicate whether and why this component is available. Enabled indicates the resource is available. Disabled indicates the resource has been intentionally made unavailable but it can be enabled. Offline indicates the resource is unavailable intentionally and requires action to make it available. InTest indicates that the component is undergoing testing. Starting indicates that the resource is becoming available. Absent indicates the resource is physically unavailable.
For the possible property values, see State in Property details.

4.16.3 Property details

4.16.3.1 Health:

The health state of this resource in the absence of its dependent resources.

string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.

4.16.3.2 HealthRollup:

The overall health state from the view of this resource.

string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.

4.16.3.3 Severity:

The severity of the condition.

string Description
Critical A critical condition requires immediate attention.
OK Normal.
Warning A condition requires attention.

4.16.3.4 State:

The known state of the resource, such as, enabled.

string Description
Absent This function or resource is either not present or detected.
Deferring (v1.2+) The element does not process any commands but queues new requests.
Disabled This function or resource is disabled.
Enabled This function or resource is enabled.
InTest This function or resource is undergoing testing, or is in the process of capturing information for debugging.
Qualified (v1.9+) The element quality is within the acceptable range of operation.
Quiesced (v1.2+) The element is enabled but only processes a restricted set of commands.
StandbyOffline This function or resource is enabled but awaits an external action to activate it.
StandbySpare This function or resource is part of a redundancy set and awaits a failover or other external action to activate it.
Starting This function or resource is starting.
UnavailableOffline (v1.1+) This function or resource is present but cannot be used.
Updating (v1.2+) The element is updating and might be unavailable or degraded.

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.
} ]
integer read-only The value of this property shall be an integer representing the number of items in a collection.
string
(URI)
read-write
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.
            } ]
             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
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/​Chassis/​{ChassisId}/​Certificates
/​redfish/​v1/​Chassis/​{ChassisId}/​Drives/​{DriveId}/​Certificates
/​redfish/​v1/​Chassis/​{ChassisId}/​Memory/​{MemoryId}/​Certificates
/​redfish/​v1/​Chassis/​{ChassisId}/​NetworkAdapters/​{NetworkAdapterId}/​Certificates
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Drives/​{DriveId}/​Certificates
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Memory/​{MemoryId}/​Certificates
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Processors/​{ProcessorId}/​Certificates
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Storage/​{StorageId}/​Controllers/​{StorageControllerId}/​Certificates
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Storage/​{StorageId}/​Drives/​{DriveId}/​Certificates
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Storage/​{StorageId}/​StorageControllers/​{StorageControllerId}/​Certificates
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​Boot/​Certificates
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​Certificates
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​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}/​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
ConnectionMethodCollection /​redfish/​v1/​AggregationService/​ConnectionMethods
ControlCollection /​redfish/​v1/​Chassis/​{ChassisId}/​Controls
/​redfish/​v1/​PowerEquipment/​FloorPDUs/​{PowerDistributionId}/​Controls
/​redfish/​v1/​PowerEquipment/​PowerShelves/​{PowerDistributionId}/​Controls
/​redfish/​v1/​PowerEquipment/​RackPDUs/​{PowerDistributionId}/​Controls
/​redfish/​v1/​PowerEquipment/​Switchgear/​{PowerDistributionId}/​Controls
/​redfish/​v1/​PowerEquipment/​TransferSwitches/​{PowerDistributionId}/​Controls
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
/​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/​{NetworkAdaptersId}/​NetworkDeviceFunctions/​{NetworkDeviceFunctionId}/​EthernetInterfaces
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​EthernetInterfaces
/​redfish/​v1/​Managers/​{ManagerId}/​EthernetInterfaces
/​redfish/​v1/​Managers/​{ManagerId}/​HostInterfaces/​{HostInterfaceId}/​HostEthernetInterfaces
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​EthernetInterfaces
/​redfish/​v1/​Systems/​{ComputerSystemId}/​EthernetInterfaces
EventDestinationCollection /​redfish/​v1/​EventService/​Subscriptions
ExternalAccountProviderCollection /​redfish/​v1/​AccountService/​ExternalAccountProviders
/​redfish/​v1/​Managers/​{ManagerId}/​RemoteAccountService/​ExternalAccountProviders
FabricAdapterCollection /​redfish/​v1/​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
GraphicsControllerCollection /​redfish/​v1/​Systems/​{ComputerSystemId}/​GraphicsControllers
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/​KeyService/​NVMeoFSecrets
/​redfish/​v1/​Managers/​{ManagerId}/​RemoteAccountService/​Accounts/​{ManagerAccountId}/​Keys
KeyPolicyCollection /​redfish/​v1/​KeyService/​NVMeoFKeyPolicies
LicenseCollection /​redfish/​v1/​LicenseService/​Licenses
LogEntryCollection /​redfish/​v1/​Chassis/​{ChassisId}/​LogServices/​{LogServiceId}/​Entries
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​LogServices/​{LogServiceId}/​Entries
/​redfish/​v1/​JobService/​Log/​Entries
/​redfish/​v1/​Managers/​{ManagerId}/​LogServices/​{LogServiceId}/​Entries
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​LogServices/​{LogServiceId}/​Entries
/​redfish/​v1/​Systems/​{ComputerSystemId}/​LogServices/​{LogServiceId}/​Entries
/​redfish/​v1/​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
MemoryChunksCollection /​redfish/​v1/​Chassis/​{ChassisId}/​MemoryDomains/​{MemoryDomainId}/​MemoryChunks
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​MemoryDomains/​{MemoryDomainId}/​MemoryChunks
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​MemoryDomains/​{MemoryDomainId}/​MemoryChunks
/​redfish/​v1/​Systems/​{ComputerSystemId}/​MemoryDomains/​{MemoryDomainId}/​MemoryChunks
MemoryCollection /​redfish/​v1/​Chassis/​{ChassisId}/​Memory
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​Memory
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​Memory
/​redfish/​v1/​Systems/​{ComputerSystemId}/​Memory
MemoryDomainCollection /​redfish/​v1/​Chassis/​{ChassisId}/​MemoryDomains
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​MemoryDomains
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​MemoryDomains
/​redfish/​v1/​Systems/​{ComputerSystemId}/​MemoryDomains
MessageRegistryCollection
MessageRegistryFileCollection /​redfish/​v1/​Registries
MetricDefinitionCollection /​redfish/​v1/​TelemetryService/​MetricDefinitions
MetricReportCollection /​redfish/​v1/​TelemetryService/​MetricReports
MetricReportDefinitionCollection /​redfish/​v1/​TelemetryService/​MetricReportDefinitions
NetworkAdapterCollection /​redfish/​v1/​Chassis/​{ChassisId}/​NetworkAdapters
NetworkDeviceFunctionCollection /​redfish/​v1/​Chassis/​{ChassisId}/​NetworkAdapters/​{NetworkAdapterId}/​NetworkDeviceFunctions
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​NetworkInterfaces/​{NetworkInterfaceId}/​NetworkDeviceFunctions
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​NetworkInterfaces/​{NetworkInterfaceId}/​NetworkDeviceFunctions
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​NetworkInterfaces/​{NetworkInterfaceId}/​NetworkDeviceFunctions
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​NetworkInterfaces/​{NetworkInterfaceId}/​NetworkDeviceFunctions
/​redfish/​v1/​Systems/​{ComputerSystemId}/​NetworkInterfaces/​{NetworkInterfaceId}/​NetworkDeviceFunctions
NetworkInterfaceCollection /​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​NetworkInterfaces
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​NetworkInterfaces
/​redfish/​v1/​Systems/​{ComputerSystemId}/​NetworkInterfaces
NetworkPortCollection /​redfish/​v1/​Chassis/​{ChassisId}/​NetworkAdapters/​{NetworkAdapterId}/​NetworkPorts
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​NetworkInterfaces/​{NetworkInterfaceId}/​NetworkPorts
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​NetworkInterfaces/​{NetworkInterfaceId}/​NetworkPorts
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​NetworkInterfaces/​{NetworkInterfaceId}/​NetworkPorts
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​NetworkInterfaces/​{NetworkInterfaceId}/​NetworkPorts
/​redfish/​v1/​Systems/​{ComputerSystemId}/​NetworkInterfaces/​{NetworkInterfaceId}/​NetworkPorts
OperatingConfigCollection /​redfish/​v1/​Systems/​{ComputerSystemId}/​OperatingConfigs
/​redfish/​v1/​Systems/​{ComputerSystemId}/​Processors/​{ProcessorId}/​OperatingConfigs
OutletCollection /​redfish/​v1/​PowerEquipment/​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
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/​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
RegisteredClientCollection /​redfish/​v1/​RegisteredClients
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}/​MSDT
/​redfish/​v1/​Chassis/​{ChassisId}/​FabricAdapters/​{FabricAdapterId}/​Ports/​{PortId}/​LPRT
/​redfish/​v1/​Chassis/​{ChassisId}/​FabricAdapters/​{FabricAdapterId}/​Ports/​{PortId}/​MPRT
/​redfish/​v1/​Chassis/​{ChassisId}/​FabricAdapters/​{FabricAdapterId}/​SSDT
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​FabricAdapters/​{FabricAdapterId}/​MSDT
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​FabricAdapters/​{FabricAdapterId}/​Ports/​{PortId}/​LPRT
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​FabricAdapters/​{FabricAdapterId}/​Ports/​{PortId}/​MPRT
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​FabricAdapters/​{FabricAdapterId}/​SSDT
/​redfish/​v1/​Fabrics/​{FabricId}/​Switches/​{SwitchId}/​Ports/​{PortId}/​LPRT
/​redfish/​v1/​Fabrics/​{FabricId}/​Switches/​{SwitchId}/​Ports/​{PortId}/​MPRT
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​FabricAdapters/​{FabricAdapterId}/​MSDT
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​FabricAdapters/​{FabricAdapterId}/​Ports/​{PortId}/​LPRT
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​FabricAdapters/​{FabricAdapterId}/​Ports/​{PortId}/​MPRT
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​FabricAdapters/​{FabricAdapterId}/​SSDT
/​redfish/​v1/​Systems/​{ComputerSystemId}/​FabricAdapters/​{FabricAdapterId}/​MSDT
/​redfish/​v1/​Systems/​{ComputerSystemId}/​FabricAdapters/​{FabricAdapterId}/​Ports/​{PortId}/​LPRT
/​redfish/​v1/​Systems/​{ComputerSystemId}/​FabricAdapters/​{FabricAdapterId}/​Ports/​{PortId}/​MPRT
/​redfish/​v1/​Systems/​{ComputerSystemId}/​FabricAdapters/​{FabricAdapterId}/​SSDT
RouteSetEntryCollection /​redfish/​v1/​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/​Facilities/​{FacilityId}/​Sensors
/​redfish/​v1/​PowerEquipment/​FloorPDUs/​{PowerDistributionId}/​Sensors
/​redfish/​v1/​PowerEquipment/​PowerShelves/​{PowerDistributionId}/​Sensors
/​redfish/​v1/​PowerEquipment/​RackPDUs/​{PowerDistributionId}/​Sensors
/​redfish/​v1/​PowerEquipment/​Switchgear/​{PowerDistributionId}/​Sensors
/​redfish/​v1/​PowerEquipment/​TransferSwitches/​{PowerDistributionId}/​Sensors
SerialInterfaceCollection /​redfish/​v1/​Managers/​{ManagerId}/​SerialInterfaces
SessionCollection /​redfish/​v1/​SessionService/​Sessions
SignatureCollection /​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​SecureBoot/​SecureBootDatabases/​{DatabaseId}/​Signatures
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​SecureBoot/​SecureBootDatabases/​{DatabaseId}/​Signatures
/​redfish/​v1/​Systems/​{ComputerSystemId}/​SecureBoot/​SecureBootDatabases/​{DatabaseId}/​Signatures
SimpleStorageCollection /​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​SimpleStorage
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​SimpleStorage
/​redfish/​v1/​Systems/​{ComputerSystemId}/​SimpleStorage
SoftwareInventoryCollection /​redfish/​v1/​UpdateService/​FirmwareInventory
/​redfish/​v1/​UpdateService/​SoftwareInventory
StorageCollection /​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Storage
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​Storage
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Storage
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​Storage
/​redfish/​v1/​Storage
/​redfish/​v1/​Systems/​{ComputerSystemId}/​Storage
StorageControllerCollection /​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Storage/​{StorageId}/​Controllers
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​Storage/​{StorageId}/​Controllers
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Storage/​{StorageId}/​Controllers
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​Storage/​{StorageId}/​Controllers
/​redfish/​v1/​Storage/​{StorageId}/​Controllers
/​redfish/​v1/​Systems/​{ComputerSystemId}/​Storage/​{StorageId}/​Controllers
SwitchCollection /​redfish/​v1/​Fabrics/​{FabricId}/​Switches
TaskCollection /​redfish/​v1/​TaskService/​Tasks
/​redfish/​v1/​TaskService/​Tasks/​{TaskId}/​SubTasks
TriggersCollection /​redfish/​v1/​TelemetryService/​Triggers
TrustedComponentCollection /​redfish/​v1/​Chassis/​{ChassisId}/​TrustedComponents
USBControllerCollection /​redfish/​v1/​Systems/​{ComputerSystemId}/​USBControllers
VCATEntryCollection /​redfish/​v1/​Chassis/​{ChassisId}/​FabricAdapters/​{FabricAdapterId}/​Ports/​{PortId}/​VCAT
/​redfish/​v1/​Chassis/​{ChassisId}/​FabricAdapters/​{FabricAdapterId}/​REQ-VCAT
/​redfish/​v1/​Chassis/​{ChassisId}/​FabricAdapters/​{FabricAdapterId}/​RSP-VCAT
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{SystemId}/​FabricAdapters/​{FabricAdapterId}/​Ports/​{PortId}/​VCAT
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{SystemId}/​FabricAdapters/​{FabricAdapterId}/​REQ-VCAT
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{SystemId}/​FabricAdapters/​{FabricAdapterId}/​RSP-VCAT
/​redfish/​v1/​Fabrics/​{FabricId}/​Switches/​{SwitchId}/​Ports/​{PortId}/​VCAT
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{SystemId}/​FabricAdapters/​{FabricAdapterId}/​Ports/​{PortId}/​VCAT
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{SystemId}/​FabricAdapters/​{FabricAdapterId}/​REQ-VCAT
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{SystemId}/​FabricAdapters/​{FabricAdapterId}/​RSP-VCAT
/​redfish/​v1/​Systems/​{SystemId}/​FabricAdapters/​{FabricAdapterId}/​Ports/​{PortId}/​VCAT
/​redfish/​v1/​Systems/​{SystemId}/​FabricAdapters/​{FabricAdapterId}/​REQ-VCAT
/​redfish/​v1/​Systems/​{SystemId}/​FabricAdapters/​{FabricAdapterId}/​RSP-VCAT
VirtualMediaCollection /​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​VirtualMedia
/​redfish/​v1/​Managers/​{ManagerId}/​VirtualMedia
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​VirtualMedia
/​redfish/​v1/​Systems/​{ComputerSystemId}/​VirtualMedia
VLanNetworkInterfaceCollection /​redfish/​v1/​Chassis/​{ChassisId}/​NetworkAdapters/​{NetworkAdapterId}/​NetworkDeviceFunctions/​{NetworkDeviceFunctionId}/​Ethernet/​VLANs
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​EthernetInterfaces/​{EthernetInterfaceId}/​VLANs
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​EthernetInterfaces/​{EthernetInterfaceId}/​VLANs
/​redfish/​v1/​Managers/​{ManagerId}/​EthernetInterfaces/​{EthernetInterfaceId}/​VLANs
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​EthernetInterfaces/​{EthernetInterfaceId}/​VLANs
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​EthernetInterfaces/​{EthernetInterfaceId}/​VLANs
/​redfish/​v1/​Systems/​{ComputerSystemId}/​EthernetInterfaces/​{EthernetInterfaceId}/​VLANs
VolumeCollection /​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Storage/​{StorageId}/​Volumes
/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​Storage/​{StorageId}/​Volumes
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Storage/​{StorageId}/​Volumes
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​Storage/​{StorageId}/​Volumes
/​redfish/​v1/​Storage/​{StorageId}/​ConsistencyGroups/​{ConsistencyGroupId}/​Volumes
/​redfish/​v1/​Storage/​{StorageId}/​FileSystems/​{FileSystemId}/​CapacitySources/​{CapacitySourceId}/​ProvidingVolumes
/​redfish/​v1/​Storage/​{StorageId}/​StoragePools/​{StoragePoolId}/​AllocatedVolumes
/​redfish/​v1/​Storage/​{StorageId}/​StoragePools/​{StoragePoolId}/​CapacitySources/​{CapacitySourceId}/​ProvidingVolumes
/​redfish/​v1/​Storage/​{StorageId}/​Volumes
/​redfish/​v1/​StorageServices/​{StorageServiceId}/​ConsistencyGroups/​{ConsistencyGroupId}/​Volumes
/​redfish/​v1/​StorageServices/​{StorageServiceId}/​FileSystems/​{FileSystemId}/​CapacitySources/​{CapacitySourceId}/​ProvidingVolumes
/​redfish/​v1/​StorageServices/​{StorageServiceId}/​StoragePools/​{StoragePoolId}/​AllocatedVolumes
/​redfish/​v1/​StorageServices/​{StorageServiceId}/​StoragePools/​{StoragePoolId}/​CapacitySources/​{CapacitySourceId}/​ProvidingVolumes
/​redfish/​v1/​StorageServices/​{StorageServiceId}/​Volumes
/​redfish/​v1/​StorageServices/​{StorageServiceId}/​Volumes/​{VolumeId}/​CapacitySources/​{CapacitySourceId}/​ProvidingVolumes
/​redfish/​v1/​Systems/​{ComputerSystemId}/​Storage/​{StorageId}/​ConsistencyGroups/​{ConsistencyGroupId}/​Volumes
/​redfish/​v1/​Systems/​{ComputerSystemId}/​Storage/​{StorageId}/​FileSystems/​{FileSystemId}/​CapacitySources/​{CapacitySourceId}/​ProvidingVolumes
/​redfish/​v1/​Systems/​{ComputerSystemId}/​Storage/​{StorageId}/​StoragePools/​{StoragePoolId}/​AllocatedVolumes
/​redfish/​v1/​Systems/​{ComputerSystemId}/​Storage/​{StorageId}/​StoragePools/​{StoragePoolId}/​CapacitySources/​{CapacitySourceId}/​ProvidingVolumes
/​redfish/​v1/​Systems/​{ComputerSystemId}/​Storage/​{StorageId}/​Volumes
ZoneCollection /​redfish/​v1/​CompositionService/​ResourceZones
/​redfish/​v1/​Fabrics/​{FabricId}/​Zones

6 Reference guide

To produce this guide, the DMTF's Redfish Documentation Generator merges the DMTF Redfish Schema Bundle (DSP8010) contents with supplemental text.

6.1 AccelerationFunction 1.0.3

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.

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.
  • This property shall contain the string that identifies the acceleration function type.
For the possible property values, see AccelerationFunctionType in Property details.
FpgaReconfigurationSlots [ ] array (string) read-only An array of the reconfiguration slot identifiers of the FPGA that this acceleration function occupies.
  • This property shall contain an array of the FPGA reconfiguration slot identifiers that this acceleration function occupies.
Links { object The links to other Resources that are related to this Resource.
  • This property shall contain links to Resources that are related to but are not contained by, or subordinate to, this Resource.
      Endpoints [ { array An array of links to the endpoints that connect to this acceleration function.
  • This property shall contain an array of links to Resources of the Endpoint type that are associated with 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 PCIeFunctions associated with this acceleration function.
  • This property shall contain an array of links of the PCIeFunction type that represent 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.
  • This property shall contain a string that identifies the manufacturer of the acceleration function.
PowerWatts integer
(Watts)
read-only The acceleration function power consumption, in watts.
  • This property shall contain the total acceleration function power consumption, in watts.
Status {} object The status and health of the Resource and its subordinate or dependent Resources.
  • This property shall contain any status or health properties of the Resource.
For property details, see Status.
UUID string read-only
(null)
The UUID for this acceleration function.
  • This property shall contain a UUID for the acceleration function. RFC4122 describes methods that can create the value. The value should be considered to be opaque. Client software should only treat the overall value as a UUID and should not interpret any sub-fields within the UUID.
Pattern: ([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.
  • This property shall describe the acceleration function version.

6.1.4 Property details

6.1.4.1 AccelerationFunctionType:

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_3.AccelerationFunction",
    "Id": "Compression",
    "Name": "Compression Accelerator",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "FpgaReconfigurationSlots": [
        "AFU0"
    ],
    "AccelerationFunctionType": "Compression",
    "Manufacturer": "Intel (R) Corporation",
    "Version": "Green Compression Type 1 v.1.00.86",
    "PowerWatts": 15,
    "Links": {
        "Endpoints": [],
        "PCIeFunctions": []
    },
    "Oem": {},
    "@odata.id": "/redfish/v1/Systems/1/Processors/FPGA1/AccelerationFunctions/Compression"
}

6.2 AccountService 1.11.1

Version v1.11 v1.10 v1.9 v1.8 v1.7 v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 ...
Release 2022.1 2021.2 2021.1 2020.4 2019.4 2019.2 2019.1 2018.3 2018.1 2017.1 2016.3 ...

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 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.
  • This property shall contain the period of time, in seconds, from the last failed login attempt when the AccountLockoutThreshold counter, which counts the number of failed login attempts, is reset to 0. Then, AccountLockoutThreshold failures are required before the account is locked. This value shall be less than or equal to the AccountLockoutDuration value. The threshold counter also resets to 0 after each successful login. If the AccountLockoutCounterResetEnabled value is false, this property shall be ignored.
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.
  • This property shall indicate whether the threshold counter is reset after the 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 shall 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.
  • This property shall contain the period of time, in seconds, that an account is locked after the number of failed login attempts reaches the AccountLockoutThreshold value, within the AccountLockoutCounterResetAfter window of time. The value shall be greater than or equal to the AccountLockoutCounterResetAfter value. If this value is 0, no lockout shall occur. If AccountLockoutCounterResetEnabled value is false, this property shall be 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.
  • This property shall contain the threshold of failed login attempts before a user account is locked. If 0, the account shall never be locked.
Accounts { object The collection of manager accounts.
  • This property shall contain a link to a resource collection of type ManagerAccountCollection.
Contains a link to a resource.
      @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.
  • This property shall contain the first Active Directory external account provider that this account service supports. If the account service supports one or more Active Directory services as an external account provider, this entity shall be populated by default. This entity shall not be present in the additional external account providers resource collection.
For more information about this property, see ExternalAccountProvider in Property Details.
AdditionalExternalAccountProviders (v1.3+) { object The additional external account providers that this account service uses.
  • This property shall contain a link to a resource collection of type ExternalAccountProviderCollection that represents the additional external account providers that this account service uses.
Contains a link to a resource.
      @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.
  • This property shall contain the threshold for when an authorization failure is logged. Logging shall occur after every n occurrences of an authorization failure on the same account, where n represents the value of this property. If the value is 0, logging of authorization failures shall be disabled.
LDAP (v1.3+) {} object The first LDAP external account provider that this account service supports.
  • This property shall contain the first LDAP external account provider that this account service supports. If the account service supports one or more LDAP services as an external account provider, this entity shall be populated by default. This entity shall not be present in the additional external account providers resource collection.
For more information about this property, see ExternalAccountProvider in Property Details.
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.
  • 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.
For the possible property values, see LocalAccountAuth in Property details.
MaxPasswordLength integer read-write The maximum password length for this account service.
  • This property shall contain the maximum password length that the implementation allows for this account service. This property does not apply to accounts from external account providers.
MinPasswordLength integer read-write The minimum password length for this account service.
  • This property shall contain the minimum password length that the implementation allows for this account service. This property does not apply to accounts from external account providers.
OAuth2 (v1.10+) {} object
(null)
The first OAuth 2.0 external account provider that this account service supports.
  • This property shall contain the first OAuth 2.0 external account provider that this account service supports. If the account service supports one or more OAuth 2.0 services as an external account provider, this entity shall be populated by default. This entity shall not be present in the additional external account providers resource collection.
For more information about this property, see ExternalAccountProvider in Property Details.
PasswordExpirationDays (v1.9+) integer read-write
(null)
The number of days before account passwords in this account service will expire.
  • This property shall contain the number of days before account passwords in this account service will expire. The value shall be applied during account creation and password modification unless the PasswordExpiration property is provided. The value null shall indicate that account passwords never expire. This property does not apply to accounts from external account providers.
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.
  • This property shall contain a link to a resource of type PrivilegeMapping that contains the privileges that are required for a user context to complete a requested operation on a URI associated with this service.
See the PrivilegeRegistry schema for details on this property.
      @odata.id string read-only Link to a PrivilegeRegistry resource. See the Links section and the PrivilegeRegistry schema for details.
}
RestrictedOemPrivileges (v1.8+) [ ] array (string) read-only The set of restricted OEM privileges.
  • This property shall contain an array of OEM privileges that are restricted by the service.
RestrictedPrivileges (v1.8+) [ ] array (string
(enum))
read-only
  • The set of restricted Redfish privileges.
    • This property shall contain an array of Redfish privileges that are restricted by the service.
For the possible property values, see RestrictedPrivileges in Property details.
Roles { object The collection of Redfish roles.
  • This property shall contain a link to a resource collection of type RoleCollection.
Contains a link to a resource.
      @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.
  • This property shall indicate 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 may 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.
  • This property shall contain any status or health properties of the resource.
For property details, see Status.
SupportedAccountTypes (v1.8+) [ ] array (string
(enum))
read-only
  • The account types supported by the service.
    • This property shall contain an array of the account types supported by the service.
For the possible property values, see SupportedAccountTypes in Property details.
SupportedOEMAccountTypes (v1.8+) [ ] array (string) read-only The OEM account types supported by the service.
  • This property shall contain an array of the OEM account types supported by the service.
TACACSplus (v1.8+) {} object
(null)
The first TACACS+ external account provider that this account service supports.
  • This property shall contain the first TACACS+ external account provider that this account service supports. If the account service supports one or more TACACS+ services as an external account provider, this entity shall be populated by default. This entity shall not be present in the additional external account providers resource collection.
For more information about this property, see ExternalAccountProvider in Property Details.

6.2.4 Property details

6.2.4.1 AccountProviderType:

The type of external account provider to which this service connects.

string Description
ActiveDirectoryService An external Active Directory service.
  • The external account provider shall be a Microsoft Active Directory Technical Specification-conformant service. The ServiceAddresses format shall contain a set of fully qualified domain names (FQDN) or NetBIOS names that links to the set of domain servers for the Active Directory service.
LDAPService A generic external LDAP service.
  • The external account provider shall be an RFC4511-conformant service. The ServiceAddresses format shall contain a set of fully qualified domain names (FQDN) that links to the set of LDAP servers for the service.
OAuth2 (v1.10+) An external OAuth 2.0 service.
  • The external account provider shall be an RFC6749-conformant service. The ServiceAddresses format shall contain a set of URIs that correspond to the RFC8414-defined metadata for the OAuth 2.0 service.
OEM An OEM-specific external authentication or directory service.
RedfishService An external Redfish service.
  • The external account provider shall be a DMTF Redfish Specification-conformant service. The ServiceAddresses format shall contain a set of URIs that correspond to a Redfish account service.
TACACSplus (v1.8+) An external TACACS+ service.
  • The external account provider shall be an RFC8907-conformant service. The ServiceAddresses format shall contain a set of host:port that correspond to a TACACS+ service and where the format for host and port are defined in RFC3986.

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.
  • This property shall contain the type of authentication used to connect to the external account provider.
For the possible property values, see AuthenticationType in Property details.
EncryptionKey (v1.8+) string read-write
(null)
Specifies the encryption key.
  • This property shall contain the value of a symmetric encryption key for account services that support some form of encryption, obfuscation, or authentication such as TACACS+. The value shall be null in responses. The property shall accept a hexadecimal string whose length depends on the external account service, such as TACACS+. A TACACS+ service shall use this property to specify the secret key as defined in RFC8907.
Pattern: ^[0-9a-fA-F]+$
EncryptionKeySet (v1.8+) boolean read-only
(null)
Indicates if the EncryptionKey property is set.
  • This property shall contain true if a valid value was provided for the EncryptionKey property. Otherwise, the property shall contain false. For a TACACS+ service, the value false shall indicate data obfuscation, as defined in section 4.5 of RFC8907, is disabled.
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.
  • This property shall contain a Base64-encoded version of the Kerberos keytab for this service. A PATCH or PUT operation writes the keytab. The value shall be 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.
  • This property shall contain the password for this service. A PATCH or PUT operation writes the password. The value shall be 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.
  • This property shall contain the token for this service. A PATCH or PUT operation writes the token. The value shall be null in responses.
Username (v1.3+) string read-write The user name for the service.
  • This property shall contain the user name for this service.

6.2.4.3 AuthenticationType:

The type of authentication used to connect to the external account provider.

string Description
KerberosKeytab A Kerberos keytab.
OEM An OEM-specific authentication mechanism.
Token An opaque authentication token.
UsernameAndPassword A user name and password combination.

6.2.4.4 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.
  • This property shall contain the type of external account provider to which this service connects.
For the possible property values, see AccountProviderType in Property details. Deprecated in v1.5 and later. This property is deprecated because the account provider type is known when used in the LDAP and ActiveDirectory objects.
Authentication (v1.3+) {} object The authentication information for the external account provider.
  • This property shall contain the authentication information for the external account provider.
For more information about this property, see Authentication in Property Details.
Certificates (v1.4+) { object The link to a collection of certificates that the external account provider uses.
  • This property shall contain a link to a resource collection of type CertificateCollection that contains certificates the external account provider uses.
Contains a link to a resource.
      @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.
  • This property shall contain any additional mapping information needed to parse a generic LDAP service. This property should only be present inside the LDAP property.
For more information about this property, see LDAPService in Property Details.
OAuth2Service (v1.10+) {} object
(null)
The additional information needed to parse an OAuth 2.0 service.
  • This property shall contain additional information needed to parse an OAuth 2.0 service. This property should only be present inside an OAuth2 property.
For more information about this property, see OAuth2Service in Property Details.
PasswordSet (v1.7+) boolean read-only Indicates if the Password property is set.
  • This property shall contain true if a valid value was provided for the Password property. Otherwise, the property shall contain false.
Priority (v1.8+) integer read-write
(null)
The authentication priority for the external account provider.
  • This property shall contain the assigned priority for the specified external account provider. The value 0 value shall indicate the highest priority. Increasing values shall represent decreasing priority. If an external provider does not have a priority assignment or two or more external providers have the same priority, the behavior shall be determined by the Redfish service. The priority is used to determine the order of authentication and authorization for each external account provider.
RemoteRoleMapping (v1.3+) [ { array The mapping rules to convert the external account providers account information to the local Redfish role.
  • This property shall contain a set of the mapping rules that are used to convert the external account providers account information to the local Redfish role.
      LocalRole (v1.3+) string read-write
(null)
The name of the local Redfish role to which to map the remote user or group.
  • This property shall contain the RoleId property value within a role resource on this Redfish service to which to map the remote user or group.
      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.
  • This property shall contain 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.
  • This property shall contain the name of the remote user that maps to the local Redfish role to which this entity links.
} ]
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.
  • This property shall contain the addresses of the account providers to which this external account provider links. The format of this field depends on the type of external account provider. Each item in the array shall contain a single address. Services can define their own behavior for managing multiple addresses.
ServiceEnabled (v1.3+) boolean read-write
(null)
An indication of whether this service is enabled.
  • This property shall indicate whether this service is enabled.
TACACSplusService (v1.8+) {} object
(null)
The additional information needed to parse a TACACS+ services.
  • This property shall contain additional information needed to parse a TACACS+ services. This property should only be present inside a TACACSplus property.
For more information about this property, see TACACSplusService in Property Details.

6.2.4.5 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.
  • This property shall contain 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.
  • This property shall contain an array of base distinguished names to use to search an external LDAP service.
      GroupNameAttribute (v1.3+) string read-write
(null)
The attribute name that contains the LDAP group name entry.
  • This property shall contain the attribute name that contains the LDAP group name.
      GroupsAttribute (v1.3+) string read-write
(null)
The attribute name that contains the groups for a user on the LDAP user entry.
  • This property shall contain the attribute name that contains the groups for an LDAP user entry.
      SSHKeyAttribute (v1.11+) string read-write
(null)
The attribute name that contains the LDAP user's SSH public key entry.
  • This property shall contain the attribute name that contains the LDAP user's SSH public key.
      UsernameAttribute (v1.3+) string read-write
(null)
The attribute name that contains the LDAP user name entry.
  • This property shall contain the attribute name that contains the LDAP user name.
}

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

string Description
Disabled The service never authenticates users based on the account service-defined accounts collection.
  • The service shall never authenticate users based on the account service-defined manager accounts resource collection.
Enabled The service authenticates users based on the account service-defined accounts collection.
  • The service shall authenticate users based on the account service-defined manager accounts resource collection.
Fallback The service authenticates users based on the account service-defined accounts collection only if any external account providers are currently unreachable.
  • The service shall authenticate users based on the account service-defined manager accounts resource 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.
  • The service shall first authenticate users based on the account service-defined manager accounts resource collection. If authentication fails, the service shall authenticate by using external account providers.

6.2.4.7 Mode:

The mode of operation for token validation.

string Description
Discovery OAuth 2.0 service information for token validation is downloaded by the service.
  • This value shall indicate the service performs token validation from information found at the URIs specified by the ServiceAddresses property. Services shall implement a caching method of this information so it's not necessary to retrieve metadata and key information for every request containing a token.
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.
  • This value shall indicate the service performs token validation from properties configured by a client. Clients should configure the Issuer and OAuthServiceSigningKeys properties for this mode.

6.2.4.8 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.
  • This property shall contain an array of allowable RFC7519-defined audience strings of the Redfish service. The values shall uniquely identify the Redfish service. For example, a MAC address or UUID for the manager can uniquely identify the 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.
  • This property shall contain the RFC8414-defined issuer string of the OAuth 2.0 service. If the Mode property contains the value Discovery, this property shall contain the value of the issuer string from the OAuth 2.0 service's metadata and this property shall be read-only. Clients should configure this property if Mode contains Offline.
Mode (v1.10+) string
(enum)
read-write The mode of operation for token validation.
  • This property shall contain the mode of operation for token validation.
For the possible property values, see Mode in Property details.
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.
  • This property shall contain a Base64-encoded string of the RFC7517-defined signing keys of the issuer of the OAuth 2.0 service. If the Mode property contains the value Discovery, this property shall contain the keys found at the URI specified by the jwks_uri string from the OAuth 2.0 service's metadata and this property shall be read-only. Clients should configure this property if Mode contains Offline.

6.2.4.9 PasswordExchangeProtocols:

string Description
ASCII The ASCII Login method.
  • This value shall indicate the ASCII Login flow as described under section 5.4.2 of RFC8907.
CHAP The CHAP Login method.
  • This value shall indicate the CHAP Login flow as described under section 5.4.2 of RFC8907.
MSCHAPv1 The MS-CHAP v1 Login method.
  • This value shall indicate the MS-CHAP v1 Login flow as described under section 5.4.2 of RFC8907.
MSCHAPv2 The MS-CHAP v2 Login method.
  • This value shall indicate the MS-CHAP v2 Login flow as described under section 5.4.2 of RFC8907.
PAP The PAP Login method.
  • This value shall indicate the PAP Login flow as described under section 5.4.2 of RFC8907.

6.2.4.10 RestrictedPrivileges:

string Description
AdministrateStorage Administrator for storage subsystems and storage systems found in the storage collection and storage system collection respectively.
AdministrateSystems Adminsitrator 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.
  • This value shall be used to indicate the user can view and configure composition service resources without matching the Client property in the ResourceBlock or CompositionReservation resources.
ConfigureManager Can configure managers.
ConfigureSelf Can change the password for the current user account and log out of their own sessions.
ConfigureUsers Can configure users and their accounts.
Login Can log in to the service and read Resources.
NoAuth Authentication is not required.
  • This value shall be used to indicate an operation does not require authentication. This privilege shall not be used in Redfish Roles.
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 colletion. Able to perform resets and configure interfaces.

6.2.4.11 SupportedAccountTypes:

string Description
HostConsole Allow access to the host's console, which could be connected through Telnet, SSH, or other protocol.
  • This value shall indicate the account is allowed to access the host console.
IPMI Allow access to the Intelligent Platform Management Interface service.
  • This value shall indicate the account is allowed to access the Intelligent Platform Management Interface service.
KVMIP Allow access to a Keyboard-Video-Mouse over IP session.
  • This value shall indicate the account is allowed to access the Keyboard-Video-Mouse over IP session service.
ManagerConsole Allow access to the manager's console, which could be connected through Telnet, SSH, SM CLP, or other protocol.
  • This value shall indicate the account is allowed to access the manager console.
OEM OEM account type. See the OEMAccountTypes property.
  • This value shall indicate the account is allowed to access the services listed in the OEMAccountTypes property.
Redfish Allow access to the Redfish service.
  • This value shall indicate the account is allowed to access Redfish services. If the version of the ManagerAccount resource is lower than the schema version when another enumeration value in this list was added, the implementation may include that functionality as part of the Redfish value.
SNMP Allow access to SNMP services.
  • This value shall indicate the account is allowed to access SNMP services.
VirtualMedia Allow access to control virtual media.
  • This value shall indicate the account is allowed to control virtual media.
WebUI Allow access to a web user interface session, such as a graphical interface or another web-based protocol.
  • This value shall indicate the account is allowed to access the web interface.

6.2.4.12 TACACSplusService:

Various settings to parse a TACACS+ service.

PasswordExchangeProtocols (v1.8+) [ ] array (string
(enum))
read-write
(null)
  • 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.
For the possible property values, see PasswordExchangeProtocols in Property details.
PrivilegeLevelArgument (v1.8+) string read-write
(null)
Indicates the name of the TACACS+ argument name in an authorization request.
  • This property shall specify the name of the argument in a TACACS+ Authorization REPLY packet body, as defined in RFC8907, that contains the user's privilege level.

6.2.5 Example response

{
    "@odata.type": "#AccountService.v1_11_1.AccountService",
    "Id": "AccountService",
    "Name": "Account Service",
    "Description": "Local Manager Account Service",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "ServiceEnabled": true,
    "AuthFailureLoggingThreshold": 3,
    "MinPasswordLength": 8,
    "AccountLockoutThreshold": 5,
    "AccountLockoutDuration": 30,
    "AccountLockoutCounterResetAfter": 30,
    "AccountLockoutCounterResetEnabled": true,
    "Accounts": {
        "@odata.id": "/redfish/v1/AccountService/Accounts"
    },
    "Roles": {
        "@odata.id": "/redfish/v1/AccountService/Roles"
    },
    "LocalAccountAuth": "Enabled",
    "LDAP": {
        "AccountProviderType": "LDAPService",
        "ServiceEnabled": false,
        "ServiceAddresses": [
            "ldaps://ldap.example.org:636"
        ],
        "Authentication": {
            "AuthenticationType": "UsernameAndPassword",
            "Username": "cn=Manager,dc=example,dc=org",
            "Password": null
        },
        "LDAPService": {
            "SearchSettings": {
                "BaseDistinguishedNames": [
                    "dc=example,dc=org"
                ],
                "UsernameAttribute": "uid",
                "GroupsAttribute": "memberof"
            }
        },
        "RemoteRoleMapping": [
            {
                "RemoteUser": "cn=Manager,dc=example,dc=org",
                "LocalRole": "Administrator"
            },
            {
                "RemoteGroup": "cn=Admins,ou=Groups,dc=example,dc=org",
                "LocalRole": "Administrator"
            },
            {
                "RemoteGroup": "cn=PowerUsers,ou=Groups,dc=example,dc=org",
                "LocalRole": "Operator"
            },
            {
                "RemoteGroup": "(cn=*)",
                "LocalRole": "ReadOnly"
            }
        ]
    },
    "ActiveDirectory": {
        "AccountProviderType": "ActiveDirectoryService",
        "ServiceEnabled": true,
        "ServiceAddresses": [
            "ad1.example.org",
            "ad2.example.org",
            null,
            null
        ],
        "Authentication": {
            "AuthenticationType": "KerberosKeytab",
            "KerberosKeytab": null
        },
        "RemoteRoleMapping": [
            {
                "RemoteGroup": "Administrators",
                "LocalRole": "Administrator"
            },
            {
                "RemoteUser": "DOMAIN\\Bob",
                "LocalRole": "Operator"
            },
            {
                "RemoteGroup": "PowerUsers",
                "LocalRole": "Operator"
            },
            {
                "RemoteGroup": "Everybody",
                "LocalRole": "ReadOnly"
            }
        ]
    },
    "AdditionalExternalAccountProviders": {
        "@odata.id": "/redfish/v1/AccountService/ExternalAccountProviders"
    },
    "@odata.id": "/redfish/v1/AccountService"
}

6.3 ActionInfo 1.3.0

Version v1.3 v1.2 v1.1 v1.0
Release 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.

6.3.2 Properties

Property Type Attributes Notes
Parameters [ { array The list of parameters included in the specified Redfish action.
  • This property shall list the parameters included in the specified Redfish action for this resource.
      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.
  • This property shall indicate the allowable numeric values, inclusive ranges of values, and incremental step values values for this parameter as applied to this action target, as defined in the 'Allowable values for numbers and durations' clause of the Redfish Specification. For arrays, this property shall represent the allowable values for each array member. This property shall only be present for numeric parameters or string parameters that specify a duration.
      AllowablePattern (v1.3+) string read-only
(null)
The allowable pattern for this parameter as applied to this action target.
  • This property shall contain a regular expression that describes the allowable values for this parameter as applied to this action target. For arrays, this property shall represent the allowable values for each array member. This property shall only be present for string parameters.
      AllowableValues [ ] array (string, null) read-only The allowable values for this parameter as applied to this action target.
  • This property shall indicate the allowable values for this parameter as applied to this action target. For arrays, this property shall represent the allowable values for each array member.
      ArraySizeMaximum (v1.2+) integer read-only
(null)
The maximum number of array elements allowed for this parameter.
  • This property shall contain the maximum number of array elements that this service supports for this parameter. This property shall not be present for non-array parameters.
      ArraySizeMinimum (v1.2+) integer read-only
(null)
The minimum number of array elements required for this parameter.
  • This property shall contain the minimum number of array elements required by this service for this parameter. This property shall not be present for non-array parameters.
      DataType string
(enum)
read-only
(null)
The JSON property type for this parameter.
  • This property shall contain the JSON property type for this parameter.
For the possible property values, see DataType in Property details.
      MaximumValue (v1.1+) number read-only
(null)
The maximum supported value for this parameter.
  • This integer or number property shall contain the maximum value that this service supports. For arrays, this property shall represent the maximum value for each array member. This property shall not be present for non-integer or number parameters.
      MinimumValue (v1.1+) number read-only
(null)
The minimum supported value for this parameter.
  • This integer or number property shall contain the minimum value that this service supports. For arrays, this property shall represent the minimum value for each array member. This property shall not be present for non-integer or number parameters.
      Name string read-only required The name of the parameter for this action.
  • This property shall contain the name of the parameter included in a Redfish action.
      ObjectDataType string read-only
(null)
The data type of an object-based parameter.
  • This property shall describe the entity type definition in @odata.type format for the parameter. This property shall be required for parameters with a data type of Object or ObjectArray, and shall not be present for parameters with other data types.
      Required boolean read-only An indication of whether the parameter is required to complete this action.
  • This property shall indicate 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.

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_3_0.ActionInfo",
    "Id": "ResetActionInfo",
    "Name": "Reset Action Info",
    "Parameters": [
        {
            "Name": "ResetType",
            "Required": true,
            "DataType": "String",
            "AllowableValues": [
                "On",
                "ForceOff",
                "GracefulShutdown",
                "GracefulRestart",
                "ForceRestart",
                "Nmi",
                "ForceOn",
                "PushPowerButton"
            ]
        }
    ],
    "Oem": {},
    "@odata.id": "/redfish/v1/Systems/1/ResetActionInfo"
}

6.4 AddressPool 1.2.1

Version v1.2 v1.1 v1.0
Release 2021.2 2020.3 2019.4

6.4.1 Description

The schema definition of an address pool and its configuration.

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.
  • This property shall contain the Ethernet related properties to this address pool.
      BFDSingleHopOnly (v1.1+) { object
(null)
Bidirectional Forwarding Detection (BFD) related properties for this Ethernet fabric.
  • This property shall contain the Bidirectional Forwarding Detection (BFD) related properties for this Ethernet fabric.
            DemandModeEnabled (v1.1+) boolean read-write
(null)
Bidirectional Forwarding Detection (BFD) Demand Mode status.
  • This property shall indicate if Bidirectional Forwarding Detection (BFD) Demand Mode is enabled. In Demand mode, no periodic BFD Control packets will flow in either direction.
            DesiredMinTxIntervalMilliseconds (v1.1+) integer read-write
(null)
Desired Bidirectional Forwarding Detection (BFD) minimal transmit interval.
  • This property shall contain the minimum interval, in milliseconds, that the local system would like to use when transmitting Bidirectional Forwarding Detection (BFD) Control packets, less any jitter applied.
            KeyChain (v1.1+) string read-write
(null)
Bidirectional Forwarding Detection (BFD) Key Chain name.
  • This property shall contain the name of the Bidirectional Forwarding Detection (BFD) Key Chain.
            LocalMultiplier (v1.1+) integer read-write
(null)
Bidirectional Forwarding Detection (BFD) multiplier value.
  • This property shall contain the Bidirectional Forwarding Detection (BFD) multiplier value. A BFD multiplier consists of the number of consecutive BFD packets that shall be missed from a BFD peer before declaring that peer unavailable, and informing the higher-layer protocols of the failure.
            MeticulousModeEnabled (v1.1+) boolean read-write
(null)
Meticulous MD5 authentication of the Bidirectional Forwarding Detection (BFD) session.
  • This property shall indicate whether the keyed MD5 sequence number is updated with every packet. If true, the keyed MD5 sequence number is updated with every packet, if false it is updated periodically.
            RequiredMinRxIntervalMilliseconds (v1.1+) integer read-write
(null)
Bidirectional Forwarding Detection (BFD) receive value.
  • This property shall contain the Bidirectional Forwarding Detection (BFD) receive value. The BFD receive value determines how frequently (in milliseconds) BFD packets will be expected to be received from BFD peers.
            SourcePort (v1.1+) integer read-write
(null)
Bidirectional Forwarding Detection (BFD) source port.
  • This property shall contain the Bidirectional Forwarding Detection (BFD) source port.
      }
      BGPEvpn (v1.1+) { object
(null)
BGP Ethernet Virtual Private Network (EVPN) related properties for this Ethernet fabric.
  • This property shall contain the BGP Ethernet Virtual Private Network (EVPN) related properties for this Ethernet fabric.
            AnycastGatewayIPAddress (v1.1+) string read-write
(null)
The anycast gateway IPv4 address.
  • This property shall contain the anycast gateway IPv4 address for a host subnet.
Pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$
            AnycastGatewayMACAddress (v1.1+) string read-write
(null)
The anycast gateway MAC address.
  • This property shall contain the anycast gateway MAC address for a host subnet.
Pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$
            ARPProxyEnabled (v1.1+) boolean read-write
(null)
Address Resolution Protocol (ARP) proxy status.
  • This property shall indicate whether proxy Address Resolution Protocol (ARP) is enabled.
            ARPSupressionEnabled (v1.1+) boolean read-write
(null)
Address Resolution Protocol (ARP) suppression status.
  • This property shall indicate whether Address Resolution Protocol (ARP) suppression is enabled.
            ESINumberRange (v1.1+) { object
(null)
The Ethernet Segment Identifier (ESI) number range for the fabric.
  • This property shall contain Ethernet Segment Identifier (ESI) number ranges for allocation in supporting functions such as multihoming.
                  Lower (v1.1+) integer read-write Lower Ethernet Segment Identifier (ESI) number.
  • This property shall contain the lower Ethernet Segment Identifier (ESI) number to be used as part of a range of ESI numbers.
                  Upper (v1.1+) integer read-write Upper Ethernet Segment Identifier (ESI) number.
  • This property shall contain the upper Ethernet Segment Identifier (ESI) number to be used as part of a range of ESI numbers.
            }
            EVINumberRange (v1.1+) { object
(null)
The Ethernet Virtual Private Network (EVPN) Instance number (EVI) number range for the fabric.
  • This property shall contain the Ethernet Virtual Private Network (EVPN) Instance number (EVI) range for EVPN based fabrics.
                  Lower (v1.1+) integer read-write Lower Ethernet Virtual Private Network (EVPN) Instance (EVI) number.
  • This property shall contain the lower Ethernet Virtual Private Network (EVPN) Instance (EVI) number to be used as part of a range of EVI numbers.
                  Upper (v1.1+) integer read-write Upper Ethernet Virtual Private Network (EVPN) Instance (EVI) number.
  • This property shall contain the upper Ethernet Virtual Private Network (EVPN) Instance (EVI) number to be used as part of a range of EVI numbers.
            }
            GatewayIPAddress (v1.1+) string read-write
(null)
The gateway IPv4 address.
  • This property shall contain the Gateway IPv4 address for a host subnet.
Pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$
            GatewayIPAddressRange (v1.2+) { object
(null)
The IPv4 address range for gateways.
  • This property shall contain the IPv4 address range for gateway nodes on this subnet.
                  Lower (v1.2+) string read-write
(null)
The lower IPv4 address.
  • This property shall contain the lower IP address to be used as part of a range of addresses for gateway nodes in Ethernet Virtual Private Network (EVPN) based fabrics.
Pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$
                  Upper (v1.2+) string read-write
(null)
The upper IPv4 address.
  • This property shall contain the upper IP address to be used as part of a range of addresses for gateway nodes in Ethernet Virtual Private Network (EVPN) based fabrics.
Pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$
            }
            NDPProxyEnabled (v1.1+) boolean read-write
(null)
Network Discovery Protocol (NDP) proxy status.
  • This property shall indicate whether Network Discovery Protocol (NDP) proxy is enabled.
            NDPSupressionEnabled (v1.1+) boolean read-write
(null)
Network Discovery Protocol (NDP) suppression status.
  • This property shall indicate whether Network Discovery Protocol (NDP) suppression is enabled.
            RouteDistinguisherAdministratorSubfield (v1.2+) string read-write
(null)
The Route Distinguisher (RD) Administrator subfield.
  • This property shall contain the RFC4364-defined Route Distinguisher (RD) Administrator subfield.
            RouteDistinguisherRange (v1.1+) { object
(null)
The Route Distinguisher (RD) number range for the fabric.
  • This property shall contain the Route Distinguisher (RD) Instance number range for Ethernet Virtual Private Network (EVPN) based fabrics.
                  Lower (v1.1+) integer read-write Lower Route Distinguisher (RD) number.
  • This property shall contain the lower Route Distinguisher (RD) number to be used as part of a range of Route Distinguisher values.
                  Upper (v1.1+) integer read-write Upper Route Distinguisher (RD) number.
  • This property shall contain the upper Route Distinguisher (RD) number to be used as part of a range of Route Distinguisher values.
            }
            RouteTargetAdministratorSubfield (v1.2+) string read-write
(null)
The Route Target (RT) Administrator Subfield.
  • This property shall contain the RFC4364-defined Route Target (RT) Administrator subfield.
            RouteTargetRange (v1.1+) { object
(null)
The Route Target (RT) number range for the fabric.
  • This property shall contain the Route Target (RT) Instance number range for Ethernet Virtual Private Network (EVPN) based fabrics.
                  Lower (v1.1+) integer read-write
(null)
Lower Route Target (RT) number.
  • This property shall contain the lower Route Target (RT) number to be used as part of a range of Route Target values.
                  Upper (v1.1+) integer read-write
(null)
Upper Route Target (RT) number.
  • This property shall contain the upper Route Target (RT) number to be used as part of a range of Route Target values.
            }
            UnderlayMulticastEnabled (v1.1+) boolean read-write
(null)
Underlay multicast status.
  • This property shall indicate whether multicast is enabled on the Ethernet fabric underlay.
            UnknownUnicastSuppressionEnabled (v1.1+) boolean read-write
(null)
Suppression of unknown unicast packets.
  • This property shall indicate whether unknown unicast packets should be suppressed.
            VLANIdentifierAddressRange (v1.1+) { object
(null)
Virtual LAN (VLAN) tag related address range applicable to this Ethernet fabric or for end host subnets.
  • This property shall contain Virtual LAN (VLAN) tag related address range applicable to this Ethernet fabric or for endpoint host subnets. VLAN tags can be used for the purpose of identifying packets belonging to different networks.
                  Lower (v1.1+) integer read-write
(null)
Virtual LAN (VLAN) tag lower value.
  • This property shall contain the Virtual LAN (VLAN) tag lower value.
                  Upper (v1.1+) integer read-write
(null)
Virtual LAN (VLAN) tag upper value.
  • This property shall contain the Virtual LAN (VLAN) tag upper value.
            }
      }
      EBGP (v1.1+) { object
(null)
External BGP (eBGP) related properties for this Ethernet fabric.
  • This property shall contain the External BGP (eBGP) related properties for this Ethernet fabric.
            AllowDuplicateASEnabled (v1.1+) boolean read-write
(null)
Allow duplicate Autonomous System (AS) path.
  • This property shall indicate whether duplicate Autonomous System (AS) numbers are allowed. If true, routes with the same AS number as the receiving router should be allowed. If false,routes should be dropped if the router receives its own AS number in a Border Gateway Protocol (BGP) update.
            AllowOverrideASEnabled (v1.1+) boolean read-write
(null)
Option to override an Autonomous System (AS) number with the AS number of the sending peer .
  • This property shall indicate whether Autonomous System (AS) numbers should be overridden. If true, AS number should be overridden with the AS number of the sending peer. If false, AS number override is disabled.
            AlwaysCompareMEDEnabled (v1.1+) boolean read-write
(null)
Compare Multi Exit Discriminator (MED) status.
  • This property shall indicate whether neighbor Multi Exit Discriminator (MED) attributes should be compared.
            ASNumberRange (v1.1+) { object
(null)
Autonomous System (AS) number range.
  • This property shall contain the range of Autonomous System (AS) numbers assigned to each Border Gateway Protocol (BGP) peer within the fabric.
                  Lower (v1.1+) integer read-write Lower Autonomous System (AS) number.
  • This property shall contain the lower Autonomous System (AS) number to be used as part of a range of ASN values.
                  Upper (v1.1+) integer read-write Upper Autonomous System (AS) number.
  • This property shall contain the upper Autonomous System (AS) number to be used as part of a range of ASN values.
            }
            BGPLocalPreference (v1.1+) integer read-write
(null)
Local preference value.
  • This property shall contain the local preference value. Highest local preference value is preferred for Border Gateway Protocol (BGP) best path selection.
            BGPNeighbor (v1.1+) { object
(null)
Border Gateway Protocol (BGP) neighbor related properties.
  • This property shall contain all Border Gateway Protocol (BGP) neighbor related properties.
                  Address (v1.1+) string read-write
(null)
Border Gateway Protocol (BGP) neighbor address.
  • This property shall contain the IPv4 address assigned to a Border Gateway Protocol (BGP) neighbor.
Pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$
                  AllowOwnASEnabled (v1.1+) boolean read-write
(null)
Allow own Autonomous System (AS) status.
  • This property shall indicate whether the Autonomous System (AS) of the receiving router is permitted in a Border Gateway Protocol (BGP) update. If true, routes should be received and processed even if the router detects its own ASN in the AS-Path. If false, they should be dropped.
                  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.
  • The value of this property shall contain the RFC4271-defined Classless Inter-Domain Routing (CIDR) value.
                  ConnectRetrySeconds (v1.1+) integer read-write
(null)
Border Gateway Protocol (BGP) retry timer in seconds.
  • This property shall contain the Border Gateway Protocol (BGP) Retry Timer. The BGP Retry Timer allows the administrator to set the amount of time in seconds between retries to establish a connection to configured peers which have gone down.
                  Enabled (v1.2+) boolean read-write An indication of whether BGP neighbor communication is enabled.
  • The value of this property shall indicate whether BGP neighbor communication is enabled.
                  HoldTimeSeconds (v1.1+) integer read-write
(null)
Border Gateway Protocol (BGP) hold timer in seconds.
  • This property shall contain the Border Gateway Protocol (BGP) Hold Timer agreed upon between peers.
                  KeepaliveIntervalSeconds (v1.1+) integer read-write
(null)
Border Gateway Protocol (BGP) Keepalive timer in seconds.
  • This property shall contain the Keepalive timer in seconds. It is used in conjunction with the Border Gateway Protocol (BGP) hold timer.
                  LocalAS (v1.1+) integer read-write
(null)
Local Autonomous System (AS) number.
  • This property shall contain the Autonomous System (AS) number of the local Border Gateway Protocol (BGP) peer.
                  LogStateChangesEnabled (v1.1+) boolean read-write
(null)
Border Gateway Protocol (BGP) neighbor log state change status.
  • This property shall indicate whether Border Gateway Protocol (BGP) neighbor state changes are logged.
                  MaxPrefix (v1.1+) { object
(null)
Border Gateway Protocol (BGP) max prefix properties.
  • These properties are applicable to configuring Border Gateway Protocol (BGP) max prefix related properties.
                        MaxPrefixNumber (v1.1+) integer read-write
(null)
Maximum prefix number.
  • This property shall contain the maximum number of prefixes allowed from the neighbor.
                        RestartTimerSeconds (v1.1+) integer read-write
(null)
Border Gateway Protocol (BGP) restart timer in seconds.
  • This property determines how long peer routers will wait to delete stale routes before a Border Gateway Protocol (BGP) open message is received. This timer should be less than the BGP HoldTimeSeconds property.
                        ShutdownThresholdPercentage (v1.1+) number
(%)
read-write
(null)
Shutdown threshold status.
  • This property shall contain the percentage of the maximum prefix received value at which the router starts to generate a warning message.
                        ThresholdWarningOnlyEnabled (v1.1+) boolean read-write
(null)
Threshold warning only status.
  • This property shall indicate what action to take if the Border Gateway Protocol (BGP) route threshold is reached. If true, when the Maximum-Prefix limit is exceeded, a log message is generated. If false, when the Maximum-Prefix limit is exceeded, the peer session is terminated.
                  }
                  MinimumAdvertisementIntervalSeconds (v1.1+) integer read-write
(null)
Minimum Border Gateway Protocol (BGP) advertisement interval in seconds.
  • This property shall contain the minimum time between Border Gateway Protocol (BGP) route advertisements in seconds.
                  PassiveModeEnabled (v1.1+) boolean read-write
(null)
Border Gateway Protocol (BGP) passive mode status.
  • This property shall indicate whether Border Gateway Protocol (BGP) passive mode is enabled.
                  PathMTUDiscoveryEnabled (v1.1+) boolean read-write
(null)
Path MTU discovery status.
  • This property shall indicate whether MTU discovery is permitted.
                  PeerAS (v1.1+) integer read-write
(null)
Peer Autonomous System (AS) number.
  • This property shall contain the Autonomous System (AS) number of the external Border Gateway Protocol (BGP) peer.
                  ReplacePeerASEnabled (v1.1+) boolean read-write
(null)
Replace Border Gateway Protocol (BGP) peer Autonomous System (AS) status.
  • This property shall indicate whether peer Autonomous System (AS) numbers should be replaced. If true, private ASNs are removed and replaced with the peer AS. If false, they remain unchanged.
                  TCPMaxSegmentSizeBytes (v1.1+) integer read-write
(null)
TCP max segment size in Bytes.
  • This property shall contain the TCP max segment size in Bytes signifying the number of bytes that shall be transported in a single packet.
                  TreatAsWithdrawEnabled (v1.1+) boolean read-write
(null)
Border Gateway Protocol (BGP) treat as withdraw status.
  • This property shall indicate Border Gateway Protocol (BGP) withdraw status. If true, the UPDATE message containing the path attribute shall be treated as though all contained routes had been withdrawn. If false, they should remain.
            }
            BGPRoute (v1.1+) { object
(null)
Border Gateway Protocol (BGP) route related properties.
  • This property shall contain Border Gateway Protocol (BGP) route related properties.
                  AdvertiseInactiveRoutesEnabled (v1.1+) boolean read-write
(null)
Advertise inactive route status.
  • This property shall indicate whether inactive routes should be advertised. If true, advertise the best Border Gateway Protocol (BGP) route that is inactive because of Interior Gateway Protocol (IGP) preference. If false, do not use as part of BGP best path selection.
                  DistanceExternal (v1.1+) integer read-write
(null)
Route distance for external routes.
  • This property shall modify the administrative distance for routes learned via External BGP (eBGP).
                  DistanceInternal (v1.1+) integer read-write
(null)
Route distance for internal routes.
  • This property shall modify the administrative distance for routes learned via Internal BGP (iBGP).
                  DistanceLocal (v1.1+) integer read-write
(null)
Route distance for local routes.
  • This property shall modify the administrative distance for routes configured on a local router.
                  ExternalCompareRouterIdEnabled (v1.1+) boolean read-write
(null)
Compare router id status.
  • This property shall indicate whether external router ids should be compared. If true, prefer the route that comes from the Border Gateway Protocol (BGP) router with the lowest router ID. If false, do not use as part of BGP best path selection.
                  FlapDampingEnabled (v1.1+) boolean read-write
(null)
Route flap dampening status.
  • This property shall indicate whether route flap dampening should be enabled.
                  SendDefaultRouteEnabled (v1.1+) boolean read-write
(null)
Send default route status.
  • This property shall indicate whether the default route should be advertised. If true, the default route is advertised to all Border Gateway Protocol (BGP) neighbors unless specifically denied. If false, the default route is not advertised.
            }
            BGPWeight (v1.1+) integer read-write
(null)
BGP weight attribute.
  • This property shall contain the Border Gateway Protocol (BGP) weight attribute value for external peers. A higher BGP weight value is preferred for BGP best path selection.
            GracefulRestart (v1.1+) { object
(null)
Graceful restart related properties.
  • This property shall contain all graceful restart related properties.
                  GracefulRestartEnabled (v1.1+) boolean read-write
(null)
Border Gateway Protocol (BGP) graceful restart status.
  • This property shall indicate whether to enable Border Gateway Protocol (BGP) graceful restart features.
                  HelperModeEnabled (v1.1+) boolean read-write
(null)
Graceful restart helper mode status.
  • This property shall indicate what to do with stale routes. If true, the router continues to be forward packets to stale routes, if false, it does not forward packets to stale routes.
                  StaleRoutesTimeSeconds (v1.1+) integer read-write
(null)
Stale route timer in seconds.
  • This property shall contain the time in seconds to hold stale routes for a restarting peer.
                  TimeSeconds (v1.1+) integer read-write
(null)
Graceful restart timer in seconds.
  • This property shall contain the time in seconds to wait for a graceful restart capable neighbor to re-establish Border Gateway Protocol (BGP) peering.
            }
            MED (v1.1+) integer read-write
(null)
BGP Multi Exit Discriminator (MED) value.
  • This property shall contain the Border Gateway Protocol (BGP) Multi Exit Discriminator (MED) value. A lower MED value is preferred for BGP best path selection.
            MultihopEnabled (v1.1+) boolean read-write
(null)
External BGP (eBGP) multihop status.
  • This property shall indicate whether External BGP (eBGP) multihop is enabled.
            MultihopTTL (v1.1+) integer read-write
(null)
External BGP (eBGP) multihop Time to Live (TTL) value.
  • This property shall contain the External BGP (eBGP) multihop Time to Live (TTL) value.
            MultiplePaths (v1.1+) { object
(null)
Multiple path related properties.
  • This property shall contain all multiple path related properties.
                  MaximumPaths (v1.1+) integer read-write
(null)
Maximum paths number.
  • This property shall contain the maximum number of paths for multi path operation.
                  UseMultiplePathsEnabled (v1.1+) boolean read-write
(null)
Border Gateway Protocol (BGP) multiple paths status.
  • This property shall indicate whether multiple paths should be advertised. If true, Border Gateway Protocol (BGP) advertises multiple paths for the same prefix for path diversity. If false, it advertises based on best path selection.
            }
            SendCommunityEnabled (v1.1+) boolean read-write
(null)
This property shall indicate whether community attributes are sent.
  • This property shall indicate whether community attributes are sent to BGP neighbors.
      }
      IPv4 (v1.1+) { object
(null)
IPv4 and Virtual LAN (VLAN) related addressing for this Ethernet fabric.
  • This property shall contain IPv4 and Virtual LAN (VLAN) addressing related properties for this Ethernet fabric.
            AnycastGatewayIPAddress (v1.1+) string read-write
(null)
The anycast gateway IPv4 address.
  • This property shall contain the anycast gateway IPv4 address for a host subnet.
Pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$
            AnycastGatewayMACAddress (v1.1+) string read-write
(null)
The anycast gateway MAC address.
  • This property shall contain the anycast gateway MAC address for a host subnet.
Pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$
            DHCP (v1.1+) { object
(null)
The Dynamic Host Configuration Protocol (DHCP) related addressing for this Ethernet fabric.
  • This property shall contain the primary and secondary Dynamic Host Configuration Protocol (DHCP) server addressing for this Ethernet fabric.
                  DHCPInterfaceMTUBytes (v1.1+) integer read-write
(null)
Dynamic Host Configuration Protocol (DHCP) interface Maximum Transmission Unit (MTU).
  • This property shall contain the Maximum Transmission Unit (MTU) to use on this interface in bytes.
                  DHCPRelayEnabled (v1.1+) boolean read-write
(null)
Dynamic Host Configuration Protocol (DHCP) relay status.
  • This property shall indicate whether Dynamic Host Configuration Protocol (DHCP) Relay is enabled.
                  DHCPServer (v1.1+) [ ] array (string, null) read-write The Dynamic Host Configuration Protocol (DHCP) IPv4 addresses for this Ethernet fabric.
  • This property shall contain an array of addresses assigned to the Dynamic Host Configuration Protocol (DHCP) server for this Ethernet fabric.
            }
            DistributeIntoUnderlayEnabled (v1.1+) boolean read-write
(null)
Indicates if host subnets should be distributed into the fabric underlay.
  • This property shall indicate whether host subnets are distributed into the fabric underlay.
            DNSDomainName (v1.1+) string read-write
(null)
The Domain Name Service (DNS) domain name for this Ethernet fabric.
  • This property shall contain 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.
  • This property shall contain an array of the Domain Name Service (DNS) servers for this Ethernet fabric.
Pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$
            EBGPAddressRange (v1.1+) {} object
(null)
External BGP (eBGP) related addressing for this Ethernet fabric.
  • This property shall contain the range of IPv4 addresses assigned to External BGP (eBGP) neighbors belonging to different ASes (Autonomous Systems).
For more information about this property, see IPv4AddressRange in Property Details.
            FabricLinkAddressRange (v1.1+) {} object
(null)
Link related IPv4 addressing for this Ethernet fabric typically applied to connections between spine and leaf Ethernet switches.
  • This property shall contain link related IPv4 addressing for this Ethernet fabric typically applied to connections between spine and leaf Ethernet switches.
For more information about this property, see IPv4AddressRange in Property Details.
            GatewayIPAddress (v1.1+) string read-write
(null)
The gateway IPv4 address.
  • This property shall contain the gateway IPv4 address for a host subnet.
Pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$
            HostAddressRange (v1.1+) {} object
(null)
IPv4 related host subnet addressing for physical device endpoints that connect to this Ethernet fabric.
  • This property shall contain the IP subnet range for host addressing for physical device endpoints that connect to this Ethernet fabric. An endpoint shall be allocated an IP address from this host address range. The Ethernet fabric should provide IP unicast or multicast connectivity for host device endpoints belonging to this host address range.
For more information about this property, see IPv4AddressRange in Property Details.
            IBGPAddressRange (v1.1+) {} object
(null)
Internal BGP (iBGP) related addressing for this Ethernet fabric.
  • This property shall contain the range of IPv4 addresses assigned to Internal BGP (iBGP) neighbors belonging to the same AS (Autonomous System).
For more information about this property, see IPv4AddressRange in Property Details.
            LoopbackAddressRange (v1.1+) {} object
(null)
Loopback related IPv4 addressing for this Ethernet fabric.
  • This property shall contain the range of loopback related IPv4 addresses assigned to this Ethernet fabric's Ethernet switches. A loopback interface provides a stable interface to which a IP address is then assigned. This address can be configured as the source address when the networking device needs to send data for control plane protocols such as BGP and OSPF.
For more information about this property, see IPv4AddressRange in Property Details.
            ManagementAddressRange (v1.1+) {} object
(null)
Management related addressing for this Ethernet fabric.
  • This property shall contain the range of management IPv4 addresses assigned to manage this Ethernet fabric's Ethernet switches.
For more information about this property, see IPv4AddressRange in Property Details.
            NativeVLAN (v1.1+) integer read-write
(null)
The native Virtual LAN (VLAN) tag value.
  • This property shall contain native Virtual LAN (VLAN) tag value for untagged traffic.
            NTPOffsetHoursMinutes (v1.1+) integer read-write
(null)
The Network Time Protocol (NTP) offset configuration.
  • This property shall contain the Network Time Protocol (NTP) offset. The NTP offset property is used to calculate the time from UTC (Universal Time Coordinated) time in hours and minutes.
            NTPServer (v1.1+) [ ] array (string, null) read-write The Network Time Protocol (NTP) servers for this Ethernet fabric.
  • This property shall contain an array of the Network Time Protocol (NTP) servers for this Ethernet fabric.
            NTPTimezone (v1.1+) string read-write
(null)
The Network Time Protocol (NTP) timezone for this Ethernet fabric.
  • This property shall contain the Network Time Protocol (NTP) timezone name assigned to this Ethernet fabric.
            SystemMACRange (v1.2+) { object
(null)
The MAC address range for systems in this subnet.
  • This property shall contain the Media Access Control (MAC) address range for systems in Ethernet Virtual Private Network (EVPN) based fabrics.
                  Lower (v1.2+) string read-write
(null)
The lower system MAC address.
  • This property shall contain the lower system Media Access Control (MAC) address to be used as part of a range of system MAC addresses.
Pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$
                  Upper (v1.2+) string read-write
(null)
The upper system MAC address.
  • This property shall contain the upper system Media Access Control (MAC) address to be used as part of a range of system MAC addresses.
Pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$
            }
            VLANIdentifierAddressRange (v1.1+) { object
(null)
Virtual LAN (VLAN) tag related addressing for this Ethernet fabric or for end host networks.
  • This property shall contain Virtual LAN (VLAN) tags for the entire fabric as well as to end hosts.
                  Lower (v1.1+) integer read-write
(null)
Virtual LAN (VLAN) tag lower value.
  • This property shall contain the Virtual LAN (VLAN) tag lower value.
                  Upper (v1.1+) integer read-write
(null)
Virtual LAN (VLAN) tag upper value.
  • This property shall contain the Virtual LAN (VLAN) tag upper value.
            }
      }
      MultiProtocolEBGP (v1.1+) { object
(null)
Multi Protocol eBGP (MP eBGP) related properties for this Ethernet fabric.
  • This property shall contain the Multi Protocol eBGP (MP eBGP) related properties for this Ethernet fabric.
            AllowDuplicateASEnabled (v1.1+) boolean read-write
(null)
Allow duplicate Autonomous System (AS) path.
  • This property shall indicate whether duplicate Autonomous System (AS) numbers are allowed. If true, routes with the same AS number as the receiving router should be allowed. If false,routes should be dropped if the router receives its own AS number in a Border Gateway Protocol (BGP) update.
            AllowOverrideASEnabled (v1.1+) boolean read-write
(null)
Option to override an Autonomous System (AS) number with the AS number of the sending peer .
  • This property shall indicate whether Autonomous System (AS) numbers should be overridden. If true, AS number should be overridden with the AS number of the sending peer. If false, AS number override is disabled.
            AlwaysCompareMEDEnabled (v1.1+) boolean read-write
(null)
Compare Multi Exit Discriminator (MED) status.
  • This property shall indicate whether neighbor Multi Exit Discriminator (MED) attributes should be compared.
            ASNumberRange (v1.1+) { object
(null)
Autonomous System (AS) number range.
  • This property shall contain the range of Autonomous System (AS) numbers assigned to each Border Gateway Protocol (BGP) peer within the fabric.
                  Lower (v1.1+) integer read-write Lower Autonomous System (AS) number.
  • This property shall contain the lower Autonomous System (AS) number to be used as part of a range of ASN values.
                  Upper (v1.1+) integer read-write Upper Autonomous System (AS) number.
  • This property shall contain the upper Autonomous System (AS) number to be used as part of a range of ASN values.
            }
            BGPLocalPreference (v1.1+) integer read-write
(null)
Local preference value.
  • This property shall contain the local preference value. Highest local preference value is preferred for Border Gateway Protocol (BGP) best path selection.
            BGPNeighbor (v1.1+) { object
(null)
Border Gateway Protocol (BGP) neighbor related properties.
  • This property shall contain all Border Gateway Protocol (BGP) neighbor related properties.
                  Address (v1.1+) string read-write
(null)
Border Gateway Protocol (BGP) neighbor address.
  • This property shall contain the IPv4 address assigned to a Border Gateway Protocol (BGP) neighbor.
Pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$
                  AllowOwnASEnabled (v1.1+) boolean read-write
(null)
Allow own Autonomous System (AS) status.
  • This property shall indicate whether the Autonomous System (AS) of the receiving router is permitted in a Border Gateway Protocol (BGP) update. If true, routes should be received and processed even if the router detects its own ASN in the AS-Path. If false, they should be dropped.
                  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.
  • The value of this property shall contain the RFC4271-defined Classless Inter-Domain Routing (CIDR) value.
                  ConnectRetrySeconds (v1.1+) integer read-write
(null)
Border Gateway Protocol (BGP) retry timer in seconds.
  • This property shall contain the Border Gateway Protocol (BGP) Retry Timer. The BGP Retry Timer allows the administrator to set the amount of time in seconds between retries to establish a connection to configured peers which have gone down.
                  Enabled (v1.2+) boolean read-write An indication of whether BGP neighbor communication is enabled.
  • The value of this property shall indicate whether BGP neighbor communication is enabled.
                  HoldTimeSeconds (v1.1+) integer read-write
(null)
Border Gateway Protocol (BGP) hold timer in seconds.
  • This property shall contain the Border Gateway Protocol (BGP) Hold Timer agreed upon between peers.
                  KeepaliveIntervalSeconds (v1.1+) integer read-write
(null)
Border Gateway Protocol (BGP) Keepalive timer in seconds.
  • This property shall contain the Keepalive timer in seconds. It is used in conjunction with the Border Gateway Protocol (BGP) hold timer.
                  LocalAS (v1.1+) integer read-write
(null)
Local Autonomous System (AS) number.
  • This property shall contain the Autonomous System (AS) number of the local Border Gateway Protocol (BGP) peer.
                  LogStateChangesEnabled (v1.1+) boolean read-write
(null)
Border Gateway Protocol (BGP) neighbor log state change status.
  • This property shall indicate whether Border Gateway Protocol (BGP) neighbor state changes are logged.
                  MaxPrefix (v1.1+) { object
(null)
Border Gateway Protocol (BGP) max prefix properties.
  • These properties are applicable to configuring Border Gateway Protocol (BGP) max prefix related properties.
                        MaxPrefixNumber (v1.1+) integer read-write
(null)
Maximum prefix number.
  • This property shall contain the maximum number of prefixes allowed from the neighbor.
                        RestartTimerSeconds (v1.1+) integer read-write
(null)
Border Gateway Protocol (BGP) restart timer in seconds.
  • This property determines how long peer routers will wait to delete stale routes before a Border Gateway Protocol (BGP) open message is received. This timer should be less than the BGP HoldTimeSeconds property.
                        ShutdownThresholdPercentage (v1.1+) number
(%)
read-write
(null)
Shutdown threshold status.
  • This property shall contain the percentage of the maximum prefix received value at which the router starts to generate a warning message.
                        ThresholdWarningOnlyEnabled (v1.1+) boolean read-write
(null)
Threshold warning only status.
  • This property shall indicate what action to take if the Border Gateway Protocol (BGP) route threshold is reached. If true, when the Maximum-Prefix limit is exceeded, a log message is generated. If false, when the Maximum-Prefix limit is exceeded, the peer session is terminated.
                  }
                  MinimumAdvertisementIntervalSeconds (v1.1+) integer read-write
(null)
Minimum Border Gateway Protocol (BGP) advertisement interval in seconds.
  • This property shall contain the minimum time between Border Gateway Protocol (BGP) route advertisements in seconds.
                  PassiveModeEnabled (v1.1+) boolean read-write
(null)
Border Gateway Protocol (BGP) passive mode status.
  • This property shall indicate whether Border Gateway Protocol (BGP) passive mode is enabled.
                  PathMTUDiscoveryEnabled (v1.1+) boolean read-write
(null)
Path MTU discovery status.
  • This property shall indicate whether MTU discovery is permitted.
                  PeerAS (v1.1+) integer read-write
(null)
Peer Autonomous System (AS) number.
  • This property shall contain the Autonomous System (AS) number of the external Border Gateway Protocol (BGP) peer.
                  ReplacePeerASEnabled (v1.1+) boolean read-write
(null)
Replace Border Gateway Protocol (BGP) peer Autonomous System (AS) status.
  • This property shall indicate whether peer Autonomous System (AS) numbers should be replaced. If true, private ASNs are removed and replaced with the peer AS. If false, they remain unchanged.
                  TCPMaxSegmentSizeBytes (v1.1+) integer read-write
(null)
TCP max segment size in Bytes.
  • This property shall contain the TCP max segment size in Bytes signifying the number of bytes that shall be transported in a single packet.
                  TreatAsWithdrawEnabled (v1.1+) boolean read-write
(null)
Border Gateway Protocol (BGP) treat as withdraw status.
  • This property shall indicate Border Gateway Protocol (BGP) withdraw status. If true, the UPDATE message containing the path attribute shall be treated as though all contained routes had been withdrawn. If false, they should remain.
            }
            BGPRoute (v1.1+) { object
(null)
Border Gateway Protocol (BGP) route related properties.
  • This property shall contain Border Gateway Protocol (BGP) route related properties.
                  AdvertiseInactiveRoutesEnabled (v1.1+) boolean read-write
(null)
Advertise inactive route status.
  • This property shall indicate whether inactive routes should be advertised. If true, advertise the best Border Gateway Protocol (BGP) route that is inactive because of Interior Gateway Protocol (IGP) preference. If false, do not use as part of BGP best path selection.
                  DistanceExternal (v1.1+) integer read-write
(null)
Route distance for external routes.
  • This property shall modify the administrative distance for routes learned via External BGP (eBGP).
                  DistanceInternal (v1.1+) integer read-write
(null)
Route distance for internal routes.
  • This property shall modify the administrative distance for routes learned via Internal BGP (iBGP).
                  DistanceLocal (v1.1+) integer read-write
(null)
Route distance for local routes.
  • This property shall modify the administrative distance for routes configured on a local router.
                  ExternalCompareRouterIdEnabled (v1.1+) boolean read-write
(null)
Compare router id status.
  • This property shall indicate whether external router ids should be compared. If true, prefer the route that comes from the Border Gateway Protocol (BGP) router with the lowest router ID. If false, do not use as part of BGP best path selection.
                  FlapDampingEnabled (v1.1+) boolean read-write
(null)
Route flap dampening status.
  • This property shall indicate whether route flap dampening should be enabled.
                  SendDefaultRouteEnabled (v1.1+) boolean read-write
(null)
Send default route status.
  • This property shall indicate whether the default route should be advertised. If true, the default route is advertised to all Border Gateway Protocol (BGP) neighbors unless specifically denied. If false, the default route is not advertised.
            }
            BGPWeight (v1.1+) integer read-write
(null)
BGP weight attribute.
  • This property shall contain the Border Gateway Protocol (BGP) weight attribute value for external peers. A higher BGP weight value is preferred for BGP best path selection.
            GracefulRestart (v1.1+) { object
(null)
Graceful restart related properties.
  • This property shall contain all graceful restart related properties.
                  GracefulRestartEnabled (v1.1+) boolean read-write
(null)
Border Gateway Protocol (BGP) graceful restart status.
  • This property shall indicate whether to enable Border Gateway Protocol (BGP) graceful restart features.
                  HelperModeEnabled (v1.1+) boolean read-write
(null)
Graceful restart helper mode status.
  • This property shall indicate what to do with stale routes. If true, the router continues to be forward packets to stale routes, if false, it does not forward packets to stale routes.
                  StaleRoutesTimeSeconds (v1.1+) integer read-write
(null)
Stale route timer in seconds.
  • This property shall contain the time in seconds to hold stale routes for a restarting peer.
                  TimeSeconds (v1.1+) integer read-write
(null)
Graceful restart timer in seconds.
  • This property shall contain the time in seconds to wait for a graceful restart capable neighbor to re-establish Border Gateway Protocol (BGP) peering.
            }
            MED (v1.1+) integer read-write
(null)
BGP Multi Exit Discriminator (MED) value.
  • This property shall contain the Border Gateway Protocol (BGP) Multi Exit Discriminator (MED) value. A lower MED value is preferred for BGP best path selection.
            MultihopEnabled (v1.1+) boolean read-write
(null)
External BGP (eBGP) multihop status.
  • This property shall indicate whether External BGP (eBGP) multihop is enabled.
            MultihopTTL (v1.1+) integer read-write
(null)
External BGP (eBGP) multihop Time to Live (TTL) value.
  • This property shall contain the External BGP (eBGP) multihop Time to Live (TTL) value.
            MultiplePaths (v1.1+) { object
(null)
Multiple path related properties.
  • This property shall contain all multiple path related properties.
                  MaximumPaths (v1.1+) integer read-write
(null)
Maximum paths number.
  • This property shall contain the maximum number of paths for multi path operation.
                  UseMultiplePathsEnabled (v1.1+) boolean read-write
(null)
Border Gateway Protocol (BGP) multiple paths status.
  • This property shall indicate whether multiple paths should be advertised. If true, Border Gateway Protocol (BGP) advertises multiple paths for the same prefix for path diversity. If false, it advertises based on best path selection.
            }
            SendCommunityEnabled (v1.1+) boolean read-write
(null)
This property shall indicate whether community attributes are sent.
  • This property shall indicate whether community attributes are sent to BGP neighbors.
      }
      MultiProtocolIBGP (v1.1+) { object
(null)
Multi Protocol iBGP (MP iBGP) related properties for this Ethernet fabric.
  • This property shall contain the Multi Protocol iBGP (MP iBGP) related properties for this Ethernet fabric.
            ASNumberRange (v1.1+) { object
(null)
Autonomous System (AS) number range.
  • This property shall contain the range of Autonomous System (AS) numbers assigned to each Border Gateway Protocol (BGP) peer within the fabric.
                  Lower (v1.1+) integer read-write Lower Autonomous System (AS) number.
  • This property shall contain the lower Autonomous System (AS) number to be used as part of a range of ASN values.
                  Upper (v1.1+) integer read-write Upper Autonomous System (AS) number.
  • This property shall contain the upper Autonomous System (AS) number to be used as part of a range of ASN values.
            }
            BGPNeighbor (v1.1+) { object
(null)
Border Gateway Protocol (BGP) neighbor related properties.
  • This property shall contain all Border Gateway Protocol (BGP) neighbor related properties.
                  Address (v1.1+) string read-write
(null)
Border Gateway Protocol (BGP) neighbor address.
  • This property shall contain the IPv4 address assigned to a Border Gateway Protocol (BGP) neighbor.
Pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$
                  AllowOwnASEnabled (v1.1+) boolean read-write
(null)
Allow own Autonomous System (AS) status.
  • This property shall indicate whether the Autonomous System (AS) of the receiving router is permitted in a Border Gateway Protocol (BGP) update. If true, routes should be received and processed even if the router detects its own ASN in the AS-Path. If false, they should be dropped.
                  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.
  • The value of this property shall contain the RFC4271-defined Classless Inter-Domain Routing (CIDR) value.
                  ConnectRetrySeconds (v1.1+) integer read-write
(null)
Border Gateway Protocol (BGP) retry timer in seconds.
  • This property shall contain the Border Gateway Protocol (BGP) Retry Timer. The BGP Retry Timer allows the administrator to set the amount of time in seconds between retries to establish a connection to configured peers which have gone down.
                  Enabled (v1.2+) boolean read-write An indication of whether BGP neighbor communication is enabled.
  • The value of this property shall indicate whether BGP neighbor communication is enabled.
                  HoldTimeSeconds (v1.1+) integer read-write
(null)
Border Gateway Protocol (BGP) hold timer in seconds.
  • This property shall contain the Border Gateway Protocol (BGP) Hold Timer agreed upon between peers.
                  KeepaliveIntervalSeconds (v1.1+) integer read-write
(null)
Border Gateway Protocol (BGP) Keepalive timer in seconds.
  • This property shall contain the Keepalive timer in seconds. It is used in conjunction with the Border Gateway Protocol (BGP) hold timer.
                  LocalAS (v1.1+) integer read-write
(null)
Local Autonomous System (AS) number.
  • This property shall contain the Autonomous System (AS) number of the local Border Gateway Protocol (BGP) peer.
                  LogStateChangesEnabled (v1.1+) boolean read-write
(null)
Border Gateway Protocol (BGP) neighbor log state change status.
  • This property shall indicate whether Border Gateway Protocol (BGP) neighbor state changes are logged.
                  MaxPrefix (v1.1+) { object
(null)
Border Gateway Protocol (BGP) max prefix properties.
  • These properties are applicable to configuring Border Gateway Protocol (BGP) max prefix related properties.
                        MaxPrefixNumber (v1.1+) integer read-write
(null)
Maximum prefix number.
  • This property shall contain the maximum number of prefixes allowed from the neighbor.
                        RestartTimerSeconds (v1.1+) integer read-write
(null)
Border Gateway Protocol (BGP) restart timer in seconds.
  • This property determines how long peer routers will wait to delete stale routes before a Border Gateway Protocol (BGP) open message is received. This timer should be less than the BGP HoldTimeSeconds property.
                        ShutdownThresholdPercentage (v1.1+) number
(%)
read-write
(null)
Shutdown threshold status.
  • This property shall contain the percentage of the maximum prefix received value at which the router starts to generate a warning message.
                        ThresholdWarningOnlyEnabled (v1.1+) boolean read-write
(null)
Threshold warning only status.
  • This property shall indicate what action to take if the Border Gateway Protocol (BGP) route threshold is reached. If true, when the Maximum-Prefix limit is exceeded, a log message is generated. If false, when the Maximum-Prefix limit is exceeded, the peer session is terminated.
                  }
                  MinimumAdvertisementIntervalSeconds (v1.1+) integer read-write
(null)
Minimum Border Gateway Protocol (BGP) advertisement interval in seconds.
  • This property shall contain the minimum time between Border Gateway Protocol (BGP) route advertisements in seconds.
                  PassiveModeEnabled (v1.1+) boolean read-write
(null)
Border Gateway Protocol (BGP) passive mode status.
  • This property shall indicate whether Border Gateway Protocol (BGP) passive mode is enabled.
                  PathMTUDiscoveryEnabled (v1.1+) boolean read-write
(null)
Path MTU discovery status.
  • This property shall indicate whether MTU discovery is permitted.
                  PeerAS (v1.1+) integer read-write
(null)
Peer Autonomous System (AS) number.
  • This property shall contain the Autonomous System (AS) number of the external Border Gateway Protocol (BGP) peer.
                  ReplacePeerASEnabled (v1.1+) boolean read-write
(null)
Replace Border Gateway Protocol (BGP) peer Autonomous System (AS) status.
  • This property shall indicate whether peer Autonomous System (AS) numbers should be replaced. If true, private ASNs are removed and replaced with the peer AS. If false, they remain unchanged.
                  TCPMaxSegmentSizeBytes (v1.1+) integer read-write
(null)
TCP max segment size in Bytes.
  • This property shall contain the TCP max segment size in Bytes signifying the number of bytes that shall be transported in a single packet.
                  TreatAsWithdrawEnabled (v1.1+) boolean read-write
(null)
Border Gateway Protocol (BGP) treat as withdraw status.
  • This property shall indicate Border Gateway Protocol (BGP) withdraw status. If true, the UPDATE message containing the path attribute shall be treated as though all contained routes had been withdrawn. If false, they should remain.
            }
            BGPRoute (v1.1+) { object
(null)
Border Gateway Protocol (BGP) route related properties.
  • This property shall contain Border Gateway Protocol (BGP) route related properties.
                  AdvertiseInactiveRoutesEnabled (v1.1+) boolean read-write
(null)
Advertise inactive route status.
  • This property shall indicate whether inactive routes should be advertised. If true, advertise the best Border Gateway Protocol (BGP) route that is inactive because of Interior Gateway Protocol (IGP) preference. If false, do not use as part of BGP best path selection.
                  DistanceExternal (v1.1+) integer read-write
(null)
Route distance for external routes.
  • This property shall modify the administrative distance for routes learned via External BGP (eBGP).
                  DistanceInternal (v1.1+) integer read-write
(null)
Route distance for internal routes.
  • This property shall modify the administrative distance for routes learned via Internal BGP (iBGP).
                  DistanceLocal (v1.1+) integer read-write
(null)
Route distance for local routes.
  • This property shall modify the administrative distance for routes configured on a local router.
                  ExternalCompareRouterIdEnabled (v1.1+) boolean read-write
(null)
Compare router id status.
  • This property shall indicate whether external router ids should be compared. If true, prefer the route that comes from the Border Gateway Protocol (BGP) router with the lowest router ID. If false, do not use as part of BGP best path selection.
                  FlapDampingEnabled (v1.1+) boolean read-write
(null)
Route flap dampening status.
  • This property shall indicate whether route flap dampening should be enabled.
                  SendDefaultRouteEnabled (v1.1+) boolean read-write
(null)
Send default route status.
  • This property shall indicate whether the default route should be advertised. If true, the default route is advertised to all Border Gateway Protocol (BGP) neighbors unless specifically denied. If false, the default route is not advertised.
            }
            GracefulRestart (v1.1+) { object
(null)
Graceful restart related properties.
  • This property shall contain all graceful restart related properties.
                  GracefulRestartEnabled (v1.1+) boolean read-write
(null)
Border Gateway Protocol (BGP) graceful restart status.
  • This property shall indicate whether to enable Border Gateway Protocol (BGP) graceful restart features.
                  HelperModeEnabled (v1.1+) boolean read-write
(null)
Graceful restart helper mode status.
  • This property shall indicate what to do with stale routes. If true, the router continues to be forward packets to stale routes, if false, it does not forward packets to stale routes.
                  StaleRoutesTimeSeconds (v1.1+) integer read-write
(null)
Stale route timer in seconds.
  • This property shall contain the time in seconds to hold stale routes for a restarting peer.
                  TimeSeconds (v1.1+) integer read-write
(null)
Graceful restart timer in seconds.
  • This property shall contain the time in seconds to wait for a graceful restart capable neighbor to re-establish Border Gateway Protocol (BGP) peering.
            }
            MultiplePaths (v1.1+) { object
(null)
Multiple path related properties.
  • This property shall contain all multiple path related properties.
                  MaximumPaths (v1.1+) integer read-write
(null)
Maximum paths number.
  • This property shall contain the maximum number of paths for multi path operation.
                  UseMultiplePathsEnabled (v1.1+) boolean read-write
(null)
Border Gateway Protocol (BGP) multiple paths status.
  • This property shall indicate whether multiple paths should be advertised. If true, Border Gateway Protocol (BGP) advertises multiple paths for the same prefix for path diversity. If false, it advertises based on best path selection.
            }
            SendCommunityEnabled (v1.1+) boolean read-write
(null)
This property shall indicate whether community attributes are sent.
  • This property shall indicate whether community attributes are sent to BGP neighbors.
      }
}
GenZ { object The Gen-Z related properties for this address pool.
  • This property shall contain the Gen-Z related properties to this address pool.
      AccessKey string read-write
(null)
The Access Key required for this address pool.
  • This property shall contain the Gen-Z Core Specification-defined Access Key required for this address pool.
Pattern: ^0[xX]([a-fA-F]|[0-9]){2}$
      MaxCID integer read-write
(null)
The maximum value for the Component Identifier (CID).
  • This property shall contain the maximum value for the Gen-Z Core Specification-defined Component Identifier (CID).
      MaxSID integer read-write
(null)
The maximum value for the Subnet Identifier (SID).
  • This property shall contain the maximum value for the Gen-Z Core Specification-defined Subnet Identifier (SID).
      MinCID integer read-write
(null)
The minimum value for the Component Identifier (CID).
  • This property shall contain the minimum value for the Gen-Z Core Specification-defined Component Identifier (CID).
      MinSID integer read-write
(null)
The minimum value for the Subnet Identifier (SID).
  • This property shall contain the minimum value for the Gen-Z Core Specification-defined Subnet Identifier (SID).
}
Links { object The links to other resources that are related to this resource.
  • This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.
      Endpoints [ { array An array of links to the endpoints that this address pool contains.
  • This property shall contain an array of links to resources of type Endpoint 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.
  • This property shall contain an array of links to resources of type Zone 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.
  • This property shall contain any status or health properties of the resource.
For property details, see Status.

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.
  • This property shall contain the lower IPv4 network address to be used as part of a subnet.
Pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$
Upper (v1.1+) string read-write
(null)
Upper IPv4 network address.
  • This property shall contain the upper IPv4 network address to be used as part of a host subnet.
Pattern: ^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$

6.4.5 Example response

{
    "@odata.type": "#AddressPool.v1_2_1.AddressPool",
    "Id": "AP1",
    "Name": "Address Pool 1",
    "Description": "Address Pool 1",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "GenZ": {
        "MinCID": 1,
        "MaxCID": 4096,
        "MinSID": 100,
        "MaxSID": 8192,
        "AccessKey": "0x1A"
    },
    "Links": {
        "Endpoints": [
            {
                "@odata.id": "/redfish/v1/Fabrics/GenZ/Endpoints/1"
            }
        ]
    },
    "Oem": {},
    "@odata.id": "/redfish/v1/Fabrics/GenZ/AddressPools/AP1"
}

6.5 Aggregate 1.0.1

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.

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.
  • This property shall contain an array of links to the elements of this aggregate.
      @odata.id string
(URI)
read-only The unique identifier for a resource.
  • 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.
} ]
ElementsCount integer read-only
(null)
The number of entries in the Elements array.
  • This property shall contain 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.

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.
  • This parameter shall contain an array of links to the specified resources to add to the aggregate's Elements array.
            @odata.id string
(URI)
read-only The unique identifier for a resource.
  • 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.
      } ]

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.

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.
  • This parameter shall contain an array of links to the specified resources to remove from the aggregate's Elements array.
            @odata.id string
(URI)
read-only The unique identifier for a resource.
  • 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.
      } ]

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.

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.
  • This parameter shall contain the number of elements in each batch simultaneously being issued a reset.
      DelayBetweenBatchesInSeconds integer
(seconds)
optional The delay of the batches of elements being reset in seconds.
  • This parameter shall contain the delay of the batches of elements being reset in seconds.
      ResetType string
(enum)
optional 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.
For the possible property values, see ResetType in Property details.

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.

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.

string Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
  • This value shall indicate the resource will transition to a power off state. The transition will start immediately. Upon successful completion, the PowerState property, if supported, shall contain the value Off.
ForceOn Turn on the unit immediately.
  • This value shall indicate the resource will transition to a power on state. The transition will start immediately. Upon successful completion, the PowerState property shall contain the value On.
ForceRestart Shut down immediately and non-gracefully and restart the system.
  • This value shall indicate the resource will transition to a power on state, after transiting through a restart. The transition will start immediately. Upon successful completion, the PowerState property, if supported, shall shall contain the value On.
GracefulRestart Shut down gracefully and restart the system.
  • This value shall indicate the resource will transition to a power on state, after transiting through a restart. The transition will start after first performing tasks to safely shutdown the resource. For example, when shutting down a computer system, the hosted operating system is allowed to safely shutting down processes and close connections. Upon successful completion, the PowerState property, if supported, shall contain the value On.
GracefulShutdown Shut down gracefully and power off.
  • This value shall indicate the resource will transition to a power off state. The transition will start after first performing tasks to safely shutdown the resource. For example, when shutting down a computer system, the hosted operating system is allowed to safely shutdown processes and close connections. Upon successful completion, the PowerState property, if supported, shall contain the value 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.
  • This value shall indicate the resource will generate a diagnostic interrupt.
On Turn on the unit.
  • This value shall indicate the resource will transition to a power on state. Upon successful completion, the PowerState property, if supported, shall contain the value On.
Pause Pause execution on the unit but do not remove power. This is typically a feature of virtual machine hypervisors.
  • This value shall indicate the resource will transition to a paused state. Upon successful completion, the PowerState property, if supported, shall contain the value Paused.
PowerCycle Power cycle the unit. Behaves like a full power removal, followed by a power restore to the resource.
  • This value shall indicate the resource will transition to a power off state, then transition to a power on state. Upon successful completion, the PowerState property, if supported, shall contain the value On.
PushPowerButton Simulate the pressing of the physical power button on this unit.
  • This value shall indicate the resource will behave as if the physical power button is pressed. The behavior of pressing the physical power button may be dependent on the state of the unit and the behavior may be configurable.
Resume Resume execution on the paused unit. This is typically a feature of virtual machine hypervisors.
  • This value shall indicate the resource will transition to a power on state. Upon successful completion, the PowerState property, if supported, shall contain the value On.
Suspend Write the state of the unit to disk before powering off. This allows for the state to be restored when powered back on.
  • This value shall indicate the resource will have any state information written to persistent memory and then transition to a power off state. Upon successful completion, the PowerState property, if supported, shall contain the value Off.

6.5.6 Example response

{
    "@odata.type": "#Aggregate.v1_0_1.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.1

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.

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.
  • This property shall contain a link to a resource collection of type AggregateCollection.
Contains a link to a resource.
      @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.
  • This property shall contain a link to a resource collection of type AggregationSourceCollection.
Contains a link to a resource.
      @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.
  • This property shall contain a link to a resource collection of type ConnectionMethodCollection.
Contains a link to a resource.
      @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.
  • This property shall indicate whether the aggregation service is enabled.
Status {} object The status and health of the resource and its subordinate or dependent resources.
  • This property shall contain any status or health properties of the resource.
For property details, see Status.

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.

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.
  • This parameter shall contain the number of elements in each batch simultaneously being issued a reset.
      DelayBetweenBatchesInSeconds integer
(seconds)
optional The delay of the batches of elements being reset in seconds.
  • This parameter shall contain the delay of the batches of elements being reset in seconds.
      ResetType string
(enum)
optional 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.
For the possible property values, see ResetType in Property details.
      TargetURIs [ { array required An array of links to the resources being reset.
  • This parameter shall contain an array of links to the resources being reset.
            @odata.id string
(URI)
read-only The unique identifier for a resource.
  • 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.
      } ]

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.

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.
  • This parameter shall contain an array of links to resources of type ComputerSystem.
            @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.

string Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
  • This value shall indicate the resource will transition to a power off state. The transition will start immediately. Upon successful completion, the PowerState property, if supported, shall contain the value Off.
ForceOn Turn on the unit immediately.
  • This value shall indicate the resource will transition to a power on state. The transition will start immediately. Upon successful completion, the PowerState property shall contain the value On.
ForceRestart Shut down immediately and non-gracefully and restart the system.
  • This value shall indicate the resource will transition to a power on state, after transiting through a restart. The transition will start immediately. Upon successful completion, the PowerState property, if supported, shall shall contain the value On.
GracefulRestart Shut down gracefully and restart the system.
  • This value shall indicate the resource will transition to a power on state, after transiting through a restart. The transition will start after first performing tasks to safely shutdown the resource. For example, when shutting down a computer system, the hosted operating system is allowed to safely shutting down processes and close connections. Upon successful completion, the PowerState property, if supported, shall contain the value On.
GracefulShutdown Shut down gracefully and power off.
  • This value shall indicate the resource will transition to a power off state. The transition will start after first performing tasks to safely shutdown the resource. For example, when shutting down a computer system, the hosted operating system is allowed to safely shutdown processes and close connections. Upon successful completion, the PowerState property, if supported, shall contain the value 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.
  • This value shall indicate the resource will generate a diagnostic interrupt.
On Turn on the unit.
  • This value shall indicate the resource will transition to a power on state. Upon successful completion, the PowerState property, if supported, shall contain the value On.
Pause Pause execution on the unit but do not remove power. This is typically a feature of virtual machine hypervisors.
  • This value shall indicate the resource will transition to a paused state. Upon successful completion, the PowerState property, if supported, shall contain the value Paused.
PowerCycle Power cycle the unit. Behaves like a full power removal, followed by a power restore to the resource.
  • This value shall indicate the resource will transition to a power off state, then transition to a power on state. Upon successful completion, the PowerState property, if supported, shall contain the value On.
PushPowerButton Simulate the pressing of the physical power button on this unit.
  • This value shall indicate the resource will behave as if the physical power button is pressed. The behavior of pressing the physical power button may be dependent on the state of the unit and the behavior may be configurable.
Resume Resume execution on the paused unit. This is typically a feature of virtual machine hypervisors.
  • This value shall indicate the resource will transition to a power on state. Upon successful completion, the PowerState property, if supported, shall contain the value On.
Suspend Write the state of the unit to disk before powering off. This allows for the state to be restored when powered back on.
  • This value shall indicate the resource will have any state information written to persistent memory and then transition to a power off state. Upon successful completion, the PowerState property, if supported, shall contain the value Off.

6.6.6 Example response

{
    "@odata.type": "#AggregationService.v1_0_1.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.2.0

Version v1.2 v1.1 v1.0
Release 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.

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.
  • 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 Complete.
For the possible property values, see AggregationType in Property details.
HostName string
(URI)
read-write
(null)
The URI of the system to be accessed.
  • This property shall contain the URI of the system to be aggregated. This property shall not be required when the aggregation source is configured to only receive notifications from the aggregated system and the AggregationType property contains the value NotificationsOnly.
Links { object The links to other resources that are related to this resource.
  • This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.
      ConnectionMethod { object
(null)
An array of links to the connection methods used to contact this aggregation source.
  • This property shall contain an array of links to resources of type ConnectionMethod that are used to connect to the aggregation source.
See the ConnectionMethod schema for details on this property.
            @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.
  • This property shall contain an array of links to the resources added to the service through the 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. For example, this could be the pointers to the members of the root level collections or the manager of a BMC.
            @odata.id string
(URI)
read-only The unique identifier for a resource.
  • 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.
      } ]
}
Password string read-write
(null)
The password for accessing the aggregation source. The value is null in responses.
  • This property shall contain a password for accessing the aggregation source. The value shall be null in responses.
SNMP (v1.1+) { object
(null)
SNMP settings of the aggregation source.
  • This property shall contain the SNMP settings of the aggregation source.
      AuthenticationKey (v1.1+) string read-write
(null)
The secret authentication key for SNMPv3.
  • This property shall contain the key for SNMPv3 authentication. The value shall be null in responses. This property accepts a passphrase or a hex-encoded key. If the string starts with Passphrase:, the remainder of the string shall be the passphrase and shall be converted to the key as described in the 'Password to Key Algorithm' section of RFC3414. If the string starts with Hex:, then the remainder of the string shall be the key encoded in hexadecimal notation. If the string starts with neither, the full string shall be a passphrase and shall be converted to the key as described in the 'Password to Key Algorithm' section of RFC3414. The passphrase can contain any printable characters except for the double quotation mark.
Pattern: (^[ !#-~]+$)|(^Passphrase:[ ^[ !#-~]+$)|(^Hex:[0-9A-Fa-f]{24,96})|(^\*+$)
      AuthenticationKeySet (v1.1+) boolean read-only Indicates if the AuthenticationKey property is set.
  • This property shall contain true if a valid value was provided for the AuthenticationKey property. Otherwise, the property shall contain false.
      AuthenticationProtocol (v1.1+) string
(enum)
read-write
(null)
The authentication protocol for SNMPv3.
  • This property shall contain the SNMPv3 authentication protocol.
For the possible property values, see AuthenticationProtocol in Property details.
      EncryptionKey (v1.1+) string read-write
(null)
The secret authentication key for SNMPv3.
  • This property shall contain the key for SNMPv3 encryption. The value shall be null in responses. This property accepts a passphrase or a hex-encoded key. If the string starts with Passphrase:, the remainder of the string shall be the passphrase and shall be converted to the key as described in the 'Password to Key Algorithm' section of RFC3414. If the string starts with Hex:, then the remainder of the string shall be the key encoded in hexadecimal notation. If the string starts with neither, the full string shall be a passphrase and shall be converted to the key as described in the 'Password to Key Algorithm' section of RFC3414. The passphrase can contain any printable characters except for the double quotation mark.
Pattern: (^[A-Za-z0-9]+$)|(^\*+$)
      EncryptionKeySet (v1.1+) boolean read-only Indicates if the EncryptionKey property is set.
  • This property shall contain true if a valid value was provided for the EncryptionKey property. Otherwise, the property shall contain false.
      EncryptionProtocol (v1.1+) string
(enum)
read-write
(null)
The encryption protocol for SNMPv3.
  • This property shall contain the SNMPv3 encryption protocol.
For the possible property values, see EncryptionProtocol in Property details.
      TrapCommunity (v1.2+) string read-write
(null)
The SNMP trap community string.
  • This property shall contain the SNMP trap community string. The value shall be null in responses. Services may provide a common trap community if not specified by the client when creating the aggregation source.
}
UserName string read-write
(null)
The user name for accessing the aggregation source.
  • This property shall contain the user name for accessing the aggregation source.

6.7.4 Property details

6.7.4.1 AggregationType:

The type of aggregation used towards the aggregation source.

string Description
Full Full aggregation according to connection method.
  • This value shall indicate that the aggregator is performing full aggregation according to the connection method without any limitation such as only receiving notifications.
NotificationsOnly Only notifications are aggregated.
  • This value shall indicate that the aggregator is only aggregating notifications or events from the aggregation source according to the connection method used. This value shall not be used with connection methods that do not include notifications.

6.7.4.2 AuthenticationProtocol:

The authentication protocol for SNMPv3.

string Description
CommunityString Trap community string authentication.
  • This value shall indicate authentication using SNMP community strings and the value of TrapCommunity.
HMAC128_SHA224 HMAC-128-SHA-224 authentication.
  • This value shall indicate authentication for SNMPv3 access conforms to the RFC7860-defined usmHMAC128SHA224AuthProtocol.
HMAC192_SHA256 HMAC-192-SHA-256 authentication.
  • This value shall indicate authentication for SNMPv3 access conforms to the RFC7860-defined usmHMAC192SHA256AuthProtocol.
HMAC256_SHA384 HMAC-256-SHA-384 authentication.
  • This value shall indicate authentication for SNMPv3 access conforms to the RFC7860-defined usmHMAC256SHA384AuthProtocol.
HMAC384_SHA512 HMAC-384-SHA-512 authentication.
  • This value shall indicate authentication for SNMPv3 access conforms to the RFC7860-defined usmHMAC384SHA512AuthProtocol.
HMAC_MD5 HMAC-MD5-96 authentication.
  • This value shall indicate authentication conforms to the RFC3414-defined HMAC-MD5-96 authentication protocol.
HMAC_SHA96 HMAC-SHA-96 authentication.
  • This value shall indicate authentication conforms to the RFC3414-defined HMAC-SHA-96 authentication protocol.
None No authentication.
  • This value shall indicate authentication is not required.

6.7.4.3 EncryptionProtocol:

The encryption protocol for SNMPv3.

string Description
CBC_DES CBC-DES encryption.
  • This value shall indicate encryption conforms to the RFC3414-defined CBC-DES encryption protocol.
CFB128_AES128 CFB128-AES-128 encryption.
  • This value shall indicate encryption conforms to the RFC3414-defined CFB128-AES-128 encryption protocol.
None No encryption.
  • This value shall indicate there is no encryption.

6.7.5 Example response

{
    "@odata.type": "#AggregationSource.v1_2_0.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"
            }
        ]
    },
    "Actions": {},
    "@odata.id": "/redfish/v1/AggregationService/AggregationSources/AggregationSource1"
}

6.8 AllowDeny 1.0.0

Version v1.0
Release 2021.2

6.8.1 Description

The AllowDeny schema represents a set of allow or deny configurations.

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.
  • This property shall indicate the type of permission.
For the possible property values, see AllowType in Property details.
DestinationPortLower integer read-write
(null)
The TCP, UDP, or other destination port to which this rule begins to application, inclusive.
  • This property shall contain 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.
  • This property shall contain 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.
  • This value shall indicate the direction of the data to which this permission applies for this network device function.
For the possible property values, see Direction in Property details.
IANAProtocolNumber integer read-write
(null)
The IANA protocol number to which this permission applies. For TCP, this is 6. For UDP, this is 17.
  • This property shall contain the IANA protocol number to which this permission applies.
IPAddressLower string read-write
(null)
The lower IP address to which this permission applies.
  • This property shall contain 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.
  • This property shall contain the type of IP address populated in the IPAddressLower and IPAddressUpper properties. Services shall not permit mixing IPv6 and IPv4 addresses on the same resource.
For the possible property values, see IPAddressType in Property details.
IPAddressUpper string read-write
(null)
The upper IP address to which this permission applies.
  • This property shall contain 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.
  • This property shall contain 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.
  • This property shall contain 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 connection.
  • This property shall indicate if this permission only applies to stateful connection, which are those using SYN, ACK, and FIN.

6.8.4 Property details

6.8.4.1 AllowType:

Indicates the type of permission.

string Description
Allow Indicates that traffic that matches the criteria in this resource shall be permitted.
Deny Indicates that traffic that matches the criteria in this resource shall not be permitted.

6.8.4.2 Direction:

Indicates the direction of the data to which this permission applies.

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.

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_0.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 Assembly 1.4.0

Version v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.2 2020.3 2018.2 2018.1 2017.3

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

6.9.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/​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

6.9.3 Properties

Property Type Attributes Notes
Assemblies [ { array The assembly records.
  • These properties shall define assembly records for a Redfish implementation.
      @odata.id string
(URI)
read-only required The unique identifier for a resource.
  • 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.
      Actions {} object The available actions for this Resource.
  • This property shall contain the available actions for this Resource.
      BinaryDataURI string
(URI)
read-only
(null)
The URI at which to access an image of the assembly information.
  • This property shall contain the URI at which to access an image of the assembly information, using the Redfish protocol and authentication methods. The Service provides this URI for the download of the OEM-specific binary image of the assembly data. An HTTP GET from this URI shall return a response payload of MIME time application/octet-stream. If the service supports it, an HTTP PUT to this URI shall replace the binary image of the assembly.
      Description string read-only
(null)
The description of the assembly.
  • This property shall contain the description of the assembly.
      EngineeringChangeLevel string read-only
(null)
The engineering change level of the assembly.
  • This property shall contain the engineering change level or revision of the assembly.
      Location (v1.3+) {} object The location of the assembly.
  • This property shall contain location information of the associated assembly.
For property details, see Location.
      LocationIndicatorActive (v1.3+) boolean read-write
(null)
An indicator allowing an operator to physically locate this resource.
  • This property shall contain the state of the indicator used to physically identify or locate this resource.
      MemberId string read-only required The unique identifier for the member within an array.
  • This property shall contain the unique identifier for this member within an array. For services supporting Redfish v1.6 or higher, this value shall contain the zero-based array index.
      Model string read-only
(null)
The model number of the assembly.
  • This property shall contain the name by which the manufacturer generally refers to the assembly.
      Name string read-only
(null)
The name of the assembly.
  • This property shall contain 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.
  • This property shall contain the part number of the assembly.
      PhysicalContext (v1.2+) string
(enum)
read-only The area or device to which the assembly data applies.
  • This property shall contain a description of the physical context for the assembly data.
For the possible property values, see PhysicalContext in Property details.
      Producer string read-only
(null)
The producer or manufacturer of the assembly.
  • This property shall contain the name of the company that produced or manufactured the assembly. This value shall be equal to the 'Manufacturer' field value in a PLDM FRU structure, if applicable, for the assembly.
      ProductionDate string
(date-time)
read-only
(null)
The production date of the assembly.
  • This property shall contain the date of production or manufacture for the assembly. The time of day portion of the property shall be 00:00:00Z, if the time of day is unknown.
      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.
  • This property shall indicate whether the component associated this assembly can be independently replaced as allowed by the vendor's replacement policy. A value of false indicates the component needs to be replaced by policy, as part of another component. If the LocationType property of this assembly contains Embedded, this property shall contain false.
      SerialNumber (v1.2+) string read-only
(null)
The serial number of the assembly.
  • This property shall contain a manufacturer-allocated number that identifies the assembly.
      SKU string read-only
(null)
The SKU of the assembly.
  • This property shall contain the SKU of the assembly.
      SparePartNumber string read-only
(null)
The spare part number of the assembly.
  • This property shall contain the spare part number of the assembly.
      Status (v1.1+) {} object The status and health of the Resource and its subordinate or dependent Resources.
  • This property shall contain any status or health properties of the Resource.
For property details, see Status.
      Vendor string read-only
(null)
The vendor of the assembly.
  • This property shall contain the name of the company that provides the final product that includes this assembly. This value shall be equal to the 'Vendor' field value in a PLDM FRU structure, if applicable, for the assembly.
      Version string read-only
(null)
The hardware version of the assembly.
  • This property shall contain the hardware version of the assembly as determined by the vendor or supplier.
} ]

6.9.4 Property details

6.9.4.1 PhysicalContext:

The area or device to which the assembly data applies.

string Description
Accelerator An accelerator.
ACInput An AC input.
ACMaintenanceBypassInput An AC maintenance bypass input.
ACOutput An AC output.
ACStaticBypassInput An AC static bypass input.
ACUtilityInput An AC utility input.
ASIC An ASIC device, such as a networking chip or chipset component.
Back The back of the chassis.
Backplane A backplane within the chassis.
Battery A battery.
Board A circuit board.
  • This value shall indicate a circuit board that is not the primary or system board within a context that cannot be described by other defined values.
Chassis The entire chassis.
ComputeBay Within a compute bay.
CoolingSubsystem The entire cooling, or air and liquid, subsystem.
CPU A processor (CPU).
CPUSubsystem The entire processor (CPU) subsystem.
DCBus A DC bus.
Exhaust The air exhaust point or points or region of the chassis.
ExpansionBay Within an expansion bay.
Fan A fan.
FPGA An FPGA.
Front The front of the chassis.
GPU A graphics processor (GPU).
GPUSubsystem The entire graphics processor (GPU) subsystem.
Intake The air intake point or points or region of the chassis.
LiquidInlet The liquid inlet point of the chassis.
LiquidOutlet The liquid outlet point of the chassis.
Lower The lower portion of the chassis.
Memory A memory device.
MemorySubsystem The entire memory subsystem.
Motor A motor.
NetworkBay Within a networking bay.
NetworkingDevice A networking device.
PowerSubsystem The entire power subsystem.
PowerSupply A power supply.
PowerSupplyBay Within a power supply bay.
Pump A pump.
Rectifier A rectifier device.
Room The room.
StorageBay Within a storage bay.
StorageDevice A storage device.
SystemBoard The system board (PCB).
Transceiver A transceiver.
  • This value shall indicate a transceiver attached to a device.
Transformer A transformer.
TrustedModule A trusted module.
Upper The upper portion of the chassis.
VoltageRegulator A voltage regulator device.

6.9.5 Example response

{
    "@odata.type": "#Assembly.v1_4_0.Assembly",
    "Id": "Assembly",
    "Name": "System-related Assembly data",
    "Assemblies": [
        {
            "@odata.id": "/redfish/v1/Chassis/1/Assembly#/Assemblies/0",
            "MemberId": "0",
            "Name": "System Board",
            "Description": "PCA System Board",
            "Model": "345TTT",
            "PartNumber": "923943",
            "SparePartNumber": "55-434",
            "SKU": "55ZZATR",
            "SerialNumber": "345394834",
            "Vendor": "Contoso",
            "ProductionDate": "2017-04-01T14:55:33+03:00",
            "Producer": "Contoso Supply Co.",
            "Version": "1.44B",
            "EngineeringChangeLevel": "9",
            "BinaryDataURI": "/dumpster/434",
            "Oem": {
                "Contoso": {
                    "Region": "C",
                    "Packaging": "Retail"
                }
            }
        },
        {
            "@odata.id": "/redfish/v1/Chassis/1/Assembly#/Assemblies/1",
            "MemberId": "1",
            "Name": "Fan Controller",
            "Description": "PCA Fan Controller",
            "Model": "F58AS",
            "PartNumber": "3434-149",
            "Vendor": "Contoso",
            "Version": "2.4.481",
            "BinaryDataURI": "/dumpster/422",
            "Status": {
                "State": "Enabled",
                "Health": "Warning"
            }
        }
    ],
    "@odata.id": "/redfish/v1/Chassis/1/Assembly"
}

6.10 AttributeRegistry 1.3.6

Version v1.3 v1.2 v1.1 v1.0
Release 2018.3 2018.1 2017.1 2016.1

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

6.10.2 Properties

Property Type Attributes Notes
Language string read-only required The RFC5646-conformant language code for the attribute registry.
  • This property shall contain an RFC5646-conformant language code.
OwningEntity string read-only required The organization or company that publishes this attribute registry.
  • This property shall represent the publisher of this attribute registry.
RegistryEntries { object The list of all attributes and their metadata for this component.
  • This property shall list attributes for this component, along with their possible values, dependencies, and other metadata.
      Attributes [ { array An array of attributes and their possible values in the attribute registry.
  • This property shall contain an array containing the attributes and their possible values and other metadata in the attribute registry.
            AttributeName string read-only required The unique name for the attribute.
  • This property shall contain the name of this attribute that is unique in this attribute registry.
Pattern: ^[A-Za-z][A-Za-z0-9_]+$
            CurrentValue string, boolean, number read-only
(null)
The placeholder of the current value for the attribute.
  • This property shall contain the placeholder of the current value for the attribute, to aid in evaluating dependencies. The evaluation results of the Dependencies array may affect the current attribute value.
            DefaultValue string, boolean, number read-only
(null)
The default value for the attribute.
  • This property shall contain the default value for the attribute.
            DisplayName string read-only
(null)
The user-readable display string for the attribute in the defined language.
  • This property shall contain 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.
  • This property shall contain 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.
  • This property shall indicate 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. The evaluation results of the Dependencies array may affect the grayed-out state of an attribute.
            HelpText string read-only
(null)
The help text for the attribute.
  • This property shall contain the help text for the attribute.
            Hidden boolean read-only
(null)
An indication of whether this attribute is hidden in user interfaces.
  • This property shall indicate whether this attribute is hidden in user interfaces. The evaluation results of the Dependencies array may affect the hidden state of an attribute.
            Immutable boolean read-only
(null)
An indication of whether this attribute is immutable. Immutable attributes shall not be modified and typically reflect a hardware state.
  • This property shall indicate whether this attribute is immutable. Immutable attributes shall not 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.
  • This property shall indicate whether this attribute is unique.
            LowerBound integer read-only
(null)
The lower limit for an integer attribute.
  • This property shall contain a number indicating the lower limit for an integer attribute.
            MaxLength integer read-only
(null)
The maximum character length of a string attribute.
  • This numeric property shall contain the maximum character length of an attribute of the String type.
            MenuPath string read-only
(null)
The path that describes the menu hierarchy of this attribute.
  • This property shall contain the menu hierarchy of this attribute, in the form of a path to the menu names. It shall start with ./ to indicate the root menu, followed by the menu names with / characters to delineate the menu traversal.
Pattern: ^\.\/([^/]+(\/[^/]+)*)?$
            MinLength integer read-only
(null)
The minimum character length of the string attribute.
  • This property shall contain a number indicating the minimum character length of an attribute of the String type.
            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.
  • This property shall indicate whether this attribute is read-only. A read-only attribute cannot be modified, and should be grayed out in user interfaces. The evaluation results of the Dependencies array may affect the read-only state of an attribute.
            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.
  • This property shall indicate 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.
  • This property shall contain a number indicating 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.
  • This property shall contain an enumeration that describes the attribute type.
For the possible property values, see Type in Property details.
            UefiDevicePath (v1.2+) string read-only
(null)
The UEFI device path that qualifies this attribute.
  • This property shall contain the UEFI Specification-defined UEFI device path that qualifies and locates this device for this attribute.
            UefiKeywordName (v1.2+) string read-only The UEFI keyword string for this attribute.
  • This property shall contain the UEFI Specification-defined keyword for this attribute.
            UefiNamespaceId (v1.2+) string read-only The UEFI namespace ID for the attribute.
  • This property shall contain the UEFI Specification-defined namespace ID for this attribute.
            UpperBound integer read-only
(null)
The upper limit for an integer attribute.
  • This property shall contain a number indicating the upper limit for an integer attribute.
            Value [ { array An array of the possible values for enumerated attribute values.
  • This property shall contain an array containing the possible values of an attribute of the Enumeration type.
                  ValueDisplayName string read-only
(null)
A user-readable display string of the value for the attribute in the defined language.
  • This property shall contain a string representing the 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.
  • This property shall contain a string representing the value name for the attribute. ValueName is a unique string within the list of possible values in the Value array for an 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.
  • This property shall contain 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.
  • This property shall contain 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.
  • This property shall indicate 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.
  • This property shall contain an array containing a list of dependencies of attributes on this component.
            Dependency { object The dependency expression for one or more attributes in this attribute registry.
  • This property shall contain 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.
  • This property shall contain an array containing the map-from conditions for a dependency of the Map type.
                        MapFromAttribute string read-only The attribute to use to evaluate this dependency expression.
  • This property shall contain the AttributeName for the attribute to use to evaluate this dependency expression term.
Pattern: ^[A-Za-z][A-Za-z0-9_]+$
                        MapFromCondition string
(enum)
read-only The condition to use to evaluate this dependency expression.
  • This property shall contain the condition to use to evaluate this dependency expression. For example, EQU or NEQ.
For the possible property values, see MapFromCondition in Property details.
                        MapFromProperty string
(enum)
read-only 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 MapFromAttribute property specifies to use to evaluate this dependency expression. For example, this value could be the MapFromAttribute CurrentValue, or ReadOnly state.
For the possible property values, see MapFromProperty in Property details.
                        MapFromValue string, boolean, number read-only
(null)
The value to use to evaluate this dependency expression.
  • The value that the property in MapFromProperty in the attribute in MapFromAttribute 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.
  • This property shall contain the logical term that combines two or more MapFrom conditions in this dependency expression. For example, AND for logical AND, or OR for 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.
For the possible property values, see MapTerms in Property details.
                  } ]
                  MapToAttribute string read-only The AttributeName of the attribute that is affected by this dependency expression.
  • This property shall contain the AttributeName of the attribute that is affected by this dependency expression.
Pattern: ^[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.
  • This property shall contain the metadata property for the attribute that the MapFromAttribute property specifies that evaluates this dependency expression. For example, this value could be the MapFromAttribute CurrentValue or ReadOnly state.
For the possible property values, see MapToProperty in Property details.
                  MapToValue string, boolean, number read-only
(null)
The value that the map-to property changes to if the dependency expression evaluates to true.
  • The value that the property in MapToProperty in the attribute specified in MapToAttribute 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.
  • This property shall contain the AttributeName of the attribute whose change triggers the evaluation of this dependency expression.
Pattern: ^[A-Za-z][A-Za-z0-9_]+$
            Type string
(enum)
read-only The type of the dependency structure.
  • This property shall contain an enumeration that describes the type for the attribute dependency.
For the possible property values, see Type in Property details.
      } ]
      Menus [ { array An array for the attributes menus and their hierarchy in the attribute registry.
  • This property shall contain an array containing 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.
  • This property shall contain the user-readable display string of the 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.
  • This property shall contain 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.
  • This property shall indicate 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.
  • This property shall indicate whether this menu is hidden in user interfaces. The evaluation results of the Dependencies array may affect the hidden state of a menu.
            MenuName string read-only The unique name string of this menu.
  • This property shall contain the name of this menu that is unique in this attribute registry.
Pattern: ^[^/]+$
            MenuPath string read-only
(null)
The path to the menu names that describes this menu hierarchy relative to other menus.
  • This property shall contain the menu hierarchy of this menu, in the form of a path to the menu names. It shall start with ./ to indicate the root menu, followed by the menu names with / characters to delineate the menu traversal.
Pattern: ^\.\/([^/]+(\/[^/]+)*)?$
            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.
  • This property shall indicate whether this menu is read-only. A read-only menu is not accessible in user interfaces, and all properties contained in that menu and its sub-menus are read-only.
      } ]
}
RegistryVersion string read-only required The attribute registry version.
  • This property shall contain the version of this attribute registry.
Pattern: ^\d+\.\d+\.\d+$
SupportedSystems [ { array An array of systems that this attribute registry supports.
  • This property shall contain an array containing a list of systems that this attribute registry supports.
      FirmwareVersion (v1.1+) string read-only
(null)
Firmware version.
  • The version of the component firmware image to which this attribute registry applies.
      ProductName string read-only
(null)
The product name of the computer system to which this attribute registry applies.
  • This property shall contain 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.
  • This property shall contain the system ID that identifies the systems to which this attribute registry applies. This can be identified by one or more properties in the computer system resource, such as Model, SubModel, or SKU.
Pattern: ^[A-Za-z0-9]+$
} ]

6.10.3 Property details

6.10.3.1 MapFromCondition:

The condition to use to evaluate this dependency expression.

string Description
EQU The logical operation for 'Equal'.
GEQ The logical operation for 'Greater than or Equal'.
GTR The logical operation for 'Greater than'.
LEQ The logical operation for 'Less than or Equal'.
LSS The logical operation for 'Less than'.
NEQ The logical operation for 'Not Equal'.

6.10.3.2 MapFromProperty:

The metadata property for the attribute that the MapFromAttribute property specifies to use to evaluate this dependency expression.

string Description
CurrentValue The dependency on an attribute's CurrentValue.
DefaultValue The dependency on an attribute's DefaultValue.
GrayOut The dependency on an attribute's GrayOut state.
Hidden The dependency on an attribute's Hidden state.
LowerBound The dependency on an attribute's LowerBound.
MaxLength The dependency on an attribute's MaxLength.
MinLength The dependency on an attribute's MinLength.
ReadOnly The dependency on an attribute's ReadOnly state.
ScalarIncrement The dependency on an attribute's ScalarIncrement.
UpperBound The dependency on an attribute's UpperBound.
WriteOnly The dependency on an attribute's WriteOnly state.

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

string Description
AND The operation used for logical 'AND' of dependency terms.
OR The operation used for logical 'OR' of dependency terms.

6.10.3.4 MapToProperty:

The metadata property for the attribute that contains the map-from condition that evaluates this dependency expression.

string Description
CurrentValue The dependency that affects an attribute's CurrentValue.
DefaultValue The dependency that affects an attribute's DefaultValue.
DisplayName The dependency that affects an attribute's DisplayName.
DisplayOrder The dependency that affects an attribute's DisplayName.
GrayOut The dependency that affects an attribute's GrayOut state.
HelpText The dependency that affects an attribute's HelpText.
Hidden The dependency that affects an attribute's Hidden state.
Immutable The dependency that affects an attribute's Immutable state.
LowerBound The dependency that affects an attribute's LowerBound.
MaxLength The dependency that affects an attribute's MaxLength.
MinLength The dependency that affects an attribute's MinLength.
ReadOnly The dependency that affects an attribute's ReadOnly state.
ScalarIncrement The dependency that affects an attribute's ScalarIncrement.
UpperBound The dependency that affects an attribute's UpperBound.
ValueExpression The dependency that affects an attribute's ValueExpression.
WarningText The dependency that affects an attribute's WarningText.
WriteOnly The dependency that affects an attribute's WriteOnly state.

6.10.3.5 Type:

6.10.3.5.1 In RegistryEntries: Attributes:

The attribute type.

string Description
Boolean A flag with a true or false value.
Enumeration A list of the known possible enumerated values.
Integer An integer value.
Password Password values that do not appear as plain text. The value shall be null in responses.
String Free-form text in their values.
6.10.3.5.2 In RegistryEntries: Dependencies:

The type of the dependency structure.

string Description
Map A simple mapping dependency. If the condition evaluates to true, the attribute or state changes to the mapped value.

6.10.4 Example response

{
    "@odata.type": "#AttributeRegistry.v1_3_6.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.11 Battery 1.2.0

Version v1.2 v1.1
Release 2022.2 2021.2

6.11.1 Description

The Battery schema describes a battery unit, such as those used to provide systems with power during a power loss event.

6.11.2 URIs

/​redfish/​v1/​Chassis/​{ChassisId}/​PowerSubsystem/​Batteries/​{BatteryId}

6.11.3 Properties

Property Type Attributes Notes
Assembly { object The link to the assembly associated with this battery.
  • This property shall contain a link to a resource of type Assembly.
See the Assembly schema for details on this property.
      @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-hours.
  • This property shall contain the actual maximum capacity of this battery in amp-hours.
CapacityActualWattHours number
(W.h)
read-only
(null)
The actual maximum capacity of this battery in watt-hours.
  • This property shall contain the actual maximum capacity of this battery in watt-hours.
CapacityRatedAmpHours number
(A.h)
read-only
(null)
The rated maximum capacity of this battery in amp-hours.
  • This property shall contain the rated maximum capacity of this battery in amp-hours.
CapacityRatedWattHours number
(W.h)
read-only
(null)
The rated maximum capacity of this battery in watt-hours.
  • This property shall contain the rated maximum capacity of this battery in watt-hours.
ChargeState string
(enum)
read-only
(null)
The charge state of this battery.
  • This property shall contain the charge state of this battery.
For the possible property values, see ChargeState in Property details.
FirmwareVersion string read-only
(null)
The firmware version for this battery.
  • This property shall contain the firmware version as defined by the manufacturer 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.
  • This property shall indicate whether the device can be inserted or removed while the underlying equipment otherwise remains in its current operational state. Devices indicated as hot-pluggable shall allow the device to become operable without altering the operational state of the underlying equipment. Devices that cannot be inserted or removed from equipment in operation, or devices that cannot become operable without affecting the operational state of that equipment, shall be indicated as not hot-pluggable.
Links (v1.1+) { object The links to other resources that are related to this resource.
  • This property shall contain links to resources that are related to but are not contained by, or subordinate 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.
  • This property shall contain an array of links to resources of type Memory that represent the memory devices to which this battery provides power during a power loss event, such as battery-backed NVDIMMs. This property shall not be present if the battery powers the containing chassis as a whole rather than individual components in a chassis.
            @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.
  • This property shall contain an array of links to resources of type StorageController that represent the storage controllers to which this battery provides power during a power loss event, such as battery-backed RAID controllers. This property shall not be present if the battery powers the containing chassis as a whole rather than individual components in a chassis.
            @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.
  • This property shall contain location information of this battery.
For property details, see Location.
LocationIndicatorActive boolean read-write
(null)
An indicator allowing an operator to physically locate this resource.
  • This property shall contain the state of the indicator used to physically identify or locate this resource.
Manufacturer string read-only
(null)
The manufacturer of this battery.
  • This property shall contain the name of the organization responsible for producing the battery. This organization may be the entity from whom the battery is purchased, but this is not necessarily true.
MaxChargeRateAmps number
(A)
read-only
(null)
The maximum charge rate of this battery in amps.
  • This property shall contain the maximum charge rate of this battery in amps.
MaxChargeVoltage number
(Volts)
read-only
(null)
The maximum charge voltage of this battery.
  • This property shall contain the maximum charge voltage of this battery.
MaxDischargeRateAmps number
(A)
read-only
(null)
The maximum discharge rate of this battery in amps.
  • This property shall contain the maximum discharge rate of this battery in amps.
Metrics { object The link to the battery metrics resource associated with this battery.
  • This property shall contain a link to a resource of type BatteryMetrics.
See the BatteryMetrics schema for details on this property.
      @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.
  • This property shall contain the model information as defined by the manufacturer for this battery.
PartNumber string read-only
(null)
The part number for this battery.
  • This property shall contain the part number as defined by the manufacturer for this battery.
ProductionDate string
(date-time)
read-only
(null)
The production or manufacturing date of this battery.
  • This property shall contain the date of production or manufacture for 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.
  • This property shall indicate whether this component can be independently replaced as allowed by the vendor's replacement policy. A value of false indicates the component needs to be replaced by policy, as part of another component. If the LocationType property of this component contains Embedded, this property shall contain false.
SerialNumber string read-only
(null)
The serial number for this battery.
  • This property shall contain the serial number as defined by the manufacturer for this battery.
SparePartNumber string read-only
(null)
The spare part number for this battery.
  • This property shall contain the spare or replacement part number as defined by the manufacturer for this battery.
StateOfHealthPercent { object
(excerpt)
The state of health (percent) of this battery.
  • This property shall contain the state of health, in percent units, of this battery. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value Percent.
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.
  • This property shall contain a URI to the resource that provides the source of the excerpt contained within this copy.
      Reading number read-only
(null)
The sensor value.
  • This property shall contain the sensor value.
}
Status {} object The status and health of the resource and its subordinate or dependent resources.
  • This property shall contain any status or health properties of the resource.
For property details, see Status.
Version string read-only
(null)
The hardware version of this battery.
  • This property shall contain the hardware version of this battery as determined by the vendor or supplier.

6.11.4 Actions

6.11.4.1 Calibrate

Description

This action performs 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.11.4.2 Reset

Description

This action resets 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.
  • This parameter shall contain the type of reset. The service can accept a request without the parameter and shall perform a GracefulRestart.
For the possible property values, see ResetType in Property details.

Request Example

{
    "ResetType": "PowerCycle"
}

6.11.4.3 SelfTest

Description

This action performs a self-test of the battery.

Action URI: {Base URI of target resource}/Actions/Battery.SelfTest

Action parameters

This action takes no parameters.

6.11.5 Property details

6.11.5.1 ChargeState:

The charge state of this battery.

string Description
Charging The battery is charging.
  • This value shall indicate the battery is charging and energy is entering the battery.
Discharging The battery is discharging.
  • This value shall indicate the battery is discharging and energy is leaving the battery.
Idle The battery is idle.
  • This value shall indicate the battery is idle and energy is not entering or leaving the battery. Small amounts of energy may enter or leave the battery while in this state if the battery is regulating itself.

6.11.5.2 ResetType:

The type of reset.

string Description
ForceOff Turn off the unit immediately (non-graceful shutdown).
  • This value shall indicate the resource will transition to a power off state. The transition will start immediately. Upon successful completion, the PowerState property, if supported, shall contain the value Off.
ForceOn Turn on the unit immediately.
  • This value shall indicate the resource will transition to a power on state. The transition will start immediately. Upon successful completion, the PowerState property shall contain the value On.
ForceRestart Shut down immediately and non-gracefully and restart the system.
  • This value shall indicate the resource will transition to a power on state, after transiting through a restart. The transition will start immediately. Upon successful completion, the PowerState property, if supported, shall shall contain the value On.
GracefulRestart Shut down gracefully and restart the system.
  • This value shall indicate the resource will transition to a power on state, after transiting through a restart. The transition will start after first performing tasks to safely shutdown the resource. For example, when shutting down a computer system, the hosted operating system is allowed to safely shutting down processes and close connections. Upon successful completion, the PowerState property, if supported, shall contain the value On.
GracefulShutdown Shut down gracefully and power off.
  • This value shall indicate the resource will transition to a power off state. The transition will start after first performing tasks to safely shutdown the resource. For example, when shutting down a computer system, the hosted operating system is allowed to safely shutdown processes and close connections. Upon successful completion, the PowerState property, if supported, shall contain the value 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.
  • This value shall indicate the resource will generate a diagnostic interrupt.
On Turn on the unit.
  • This value shall indicate the resource will transition to a power on state. Upon successful completion, the PowerState property, if supported, shall contain the value On.
Pause Pause execution on the unit but do not remove power. This is typically a feature of virtual machine hypervisors.
  • This value shall indicate the resource will transition to a paused state. Upon successful completion, the PowerState property, if supported, shall contain the value Paused.
PowerCycle Power cycle the unit. Behaves like a full power removal, followed by a power restore to the resource.
  • This value shall indicate the resource will transition to a power off state, then transition to a power on state. Upon successful completion, the PowerState property, if supported, shall contain the value On.
PushPowerButton Simulate the pressing of the physical power button on this unit.
  • This value shall indicate the resource will behave as if the physical power button is pressed. The behavior of pressing the physical power button may be dependent on the state of the unit and the behavior may be configurable.
Resume Resume execution on the paused unit. This is typically a feature of virtual machine hypervisors.
  • This value shall indicate the resource will transition to a power on state. Upon successful completion, the PowerState property, if supported, shall contain the value On.
Suspend Write the state of the unit to disk before powering off. This allows for the state to be restored when powered back on.
  • This value shall indicate the resource will have any state information written to persistent memory and then transition to a power off state. Upon successful completion, the PowerState property, if supported, shall contain the value Off.

6.11.6 Example response

{
    "@odata.type": "#Battery.v1_2_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.12 BatteryMetrics 1.0.1

Version v1.0
Release 2021.2

6.12.1 Description

The BatteryMetrics schema contains definitions for the metrics of a battery unit.

6.12.2 URIs

/​redfish/​v1/​Chassis/​{ChassisId}/​PowerSubsystem/​Batteries/​{BatteryId}/​Metrics

6.12.3 Properties

Property Type Attributes Notes
CellVoltages [ { array
(excerpt)
The cell voltages (V) for this battery.
  • This property shall contain the cell voltages, in volt units, for this battery. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value Voltage.
This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri.
      CrestFactor (v1.1+) number read-only
(null)
The crest factor for this sensor.
  • This property shall contain the ratio of the peak measurement divided by the RMS measurement and calculated over same N line cycles. A sine wave would have a value of 1.414.
      DataSourceUri string
(URI)
read-only
(null)
The link to the resource that provides the data for this sensor.
  • This property shall contain a URI to the resource that provides the source of the excerpt contained within this copy.
      Reading number read-only
(null)
The sensor value.
  • This property shall contain the sensor value.
      THDPercent (v1.1+) number read-only
(null)
The total harmonic distortion (THD).
  • This property shall contain the total harmonic distortion of the Reading property in percent units.
} ]
ChargePercent {} object The amount of charge available (percent) in this battery.
  • This property shall contain the amount of charge available, in percent units, in this battery. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value Percent.
For more information about this property, see SensorExcerpt in Property Details.
DischargeCycles number read-only
(null)
The number of discharges this battery sustained.
  • This property shall contain the number of discharges this battery sustained.
InputCurrentAmps { object
(excerpt)
The input current (A) for this battery.
  • This property shall contain the input current, in ampere units, for this battery. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value Current.
This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri.
      CrestFactor (v1.1+) number read-only
(null)
The crest factor for this sensor.
  • This property shall contain the ratio of the peak measurement divided by the RMS measurement and calculated over same N line cycles. A sine wave would have a value of 1.414.
      DataSourceUri string
(URI)
read-only
(null)
The link to the resource that provides the data for this sensor.
  • This property shall contain a URI to the resource that provides the source of the excerpt contained within this copy.
      Reading number read-only
(null)
The sensor value.
  • This property shall contain the sensor value.
      THDPercent (v1.1+) number read-only
(null)
The total harmonic distortion (THD).
  • This property shall contain the total harmonic distortion of the Reading property in percent units.
}
InputVoltage { object
(excerpt)
The input voltage (V) for this battery.
  • This property shall contain the input voltage, in volt units, for this battery. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value Voltage.
This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri.
      CrestFactor (v1.1+) number read-only
(null)
The crest factor for this sensor.
  • This property shall contain the ratio of the peak measurement divided by the RMS measurement and calculated over same N line cycles. A sine wave would have a value of 1.414.
      DataSourceUri string
(URI)
read-only
(null)
The link to the resource that provides the data for this sensor.
  • This property shall contain a URI to the resource that provides the source of the excerpt contained within this copy.
      Reading number read-only
(null)
The sensor value.
  • This property shall contain the sensor value.
      THDPercent (v1.1+) number read-only
(null)
The total harmonic distortion (THD).
  • This property shall contain the total harmonic distortion of the Reading property in percent units.
}
OutputCurrentAmps [ { array
(excerpt)
The output currents (A) for this battery.
  • This property shall contain the output currents, in ampere units, for this battery. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value Current. The sensors shall appear in the same array order as the OutputVoltages property.
This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri.
      CrestFactor (v1.1+) number read-only
(null)
The crest factor for this sensor.
  • This property shall contain the ratio of the peak measurement divided by the RMS measurement and calculated over same N line cycles. A sine wave would have a value of 1.414.
      DataSourceUri string
(URI)
read-only
(null)
The link to the resource that provides the data for this sensor.
  • This property shall contain a URI to the resource that provides the source of the excerpt contained within this copy.
      Reading number read-only
(null)
The sensor value.
  • This property shall contain the sensor value.
      THDPercent (v1.1+) number read-only
(null)
The total harmonic distortion (THD).
  • This property shall contain the total harmonic distortion of the Reading property in percent units.
} ]
OutputVoltages [ { array
(excerpt)
The output voltages (V) for this battery.
  • This property shall contain the output voltages, in volt units, for this battery. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value Voltage. The sensors shall appear in the same array order as the OutputCurrentAmps property.
This object is an excerpt of the Sensor resource located at the URI shown in DataSourceUri.
      CrestFactor (v1.1+) number read-only
(null)
The crest factor for this sensor.
  • This property shall contain the ratio of the peak measurement divided by the RMS measurement and calculated over same N line cycles. A sine wave would have a value of 1.414.
      DataSourceUri string
(URI)
read-only
(null)
The link to the resource that provides the data for this sensor.
  • This property shall contain a URI to the resource that provides the source of the excerpt contained within this copy.
      Reading number read-only
(null)
The sensor value.
  • This property shall contain the sensor value.
      THDPercent (v1.1+) number read-only
(null)
The total harmonic distortion (THD).
  • This property shall contain the total harmonic distortion of the Reading property in percent units.
} ]
Status {} object The status and health of the resource and its subordinate or dependent resources.
  • This property shall contain any status or health properties of the resource.
For property details, see Status.
StoredChargeAmpHours {} object The charge (Ah) stored in this battery.
  • This property shall contain the stored charge, in ampere-hours units, for this battery. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value ChargeAh.
For more information about this property, see SensorExcerpt in Property Details.
StoredEnergyWattHours {} object The energy (Wh) stored in this battery.
  • This property shall contain the stored energy, in watt-hour units, for this battery. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value EnergyWh.
For more information about this property, see SensorExcerpt in Property Details.
TemperatureCelsius {} object The temperature (C) for this battery.
  • This property shall contain the temperature, in degrees Celsius units, for this battery. The value of the DataSourceUri property, if present, shall reference a resource of type Sensor with the ReadingType property containing the value Temperature.
For more information about this property, see SensorExcerpt in Property Details.

6.12.4 Property details

6.12.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.
  • This property shall contain a URI to the resource that provides the source of the excerpt contained within this copy.
Reading number read-only
(null)
The sensor value.
  • This property shall contain the sensor value.

6.12.5 Example response

{
    "@odata.type": "#BatteryMetrics.v1_0_1.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.13 Bios 1.2.0

Version v1.2 v1.1 v1.0
Release 2021.1 2019.2 2016.1

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

6.13.2 URIs

/​redfish/​v1/​CompositionService/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​Bios
/​redfish/​v1/​ResourceBlocks/​{ResourceBlockId}/​Systems/​{ComputerSystemId}/​Bios
/​redfish/​v1/​Systems/​{ComputerSystemId}/​Bios

6.13.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.
  • The link to the attribute registry that lists the metadata describing the BIOS attribute settings in this resource.
Attributes { object The list of BIOS attributes specific to the manufacturer or provider.
  • This property shall contain the list of BIOS attributes specific to the manufacturer or provider. BIOS attribute settings appear as additional properties in this object, and can be looked up in the attribute registry by their AttributeName.
      (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.
  • This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.
      ActiveSoftwareImage (v1.1+) { object The link to the software inventory that represents the active BIOS firmware image.
  • This property shall contain a link a resource of type SoftwareInventory that represents the active BIOS firmware image.
See the SoftwareInventory schema for details on this property.
            @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.
  • This property shall contain an array of links to resources of type SoftwareInventory that represent the firmware images that apply to 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.
  • This property shall indicate whether there is a pending request to reset the BIOS attributes to default values. A successful completion of the ResetBios action shall set this property to true. Applying the default attribute values to this resource shall set this property to false. Services may reject modification requests to the settings resource if this property contains true.

6.13.4 Actions

6.13.4.1 ChangePassword

Description

This action changes a 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.
  • This parameter shall contain the new BIOS password.
      OldPassword string required The existing BIOS password.
  • This parameter shall contain the existing BIOS password to change.
      PasswordName string required The name of the BIOS password to change.
  • This parameter shall contain the name of the BIOS password to change. For instance, AdminPassword or UserPassword.

Request Example

{
    "OldPassword": "secret123",
    "NewPassword": "B3tterS3cur1tY!",
    "PasswordName": "Admin"
}

6.13.4.2 ResetBios

Description

This action resets the BIOS attributes to default.

Action URI: {Base URI of target resource}/Actions/Bios.ResetBios

Action parameters

This action takes no parameters.

6.13.5 Example response

{
    "@odata.type": "#Bios.v1_2_0.Bios",
    "Id": "BIOS",
    "Name": "BIOS Configuration Current Settings",
    "AttributeRegistry": "BiosAttributeRegistryP89.v1_0_0",
    "Attributes": {
        "AdminPhone": "",
        "BootMode": "Uefi",
        "EmbeddedSata": "Raid",
        "NicBoot1": "NetworkBoot",
        "NicBoot2": "Disabled",
        "PowerProfile": "MaxPerf",
        "ProcCoreDisable": 0,
        "ProcHyperthreading": "Enabled",
        "ProcTurboMode": "Enabled",
        "UsbControl": "UsbEnabled"
    },
    "@Redfish.Settings": {
        "@odata.type": "#Settings.v1_3_5.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.14 BootOption 1.0.4

Version v1.0
Release 2017.3

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

6.14.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.14.3 Properties

Property Type Attributes Notes
Alias string
(enum)
read-only
(null)
The alias of this boot source.
  • This property shall contain the string alias of this boot source that describes the type of boot.
For the possible property values, see Alias in Property details.
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 shall influence the load option active flag for the boot option.
  • This property shall indicate 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 shall be skipped. In the UEFI context, this property shall influence the load option active flag for the boot option.
BootOptionReference string read-only required
(null)
The unique boot option.
  • This property shall correspond to the boot option or device. For UEFI systems, this string shall match the UEFI boot option variable name, such as Boot####. The BootOrder array of a computer system resource contains this value.
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.
  • This property shall contain a user-readable boot option name, as it should appear in the boot order list in the user interface.
RelatedItem [ { array An array of links to resources or objects associated with this boot option.
  • This property shall contain an array of links to resources or objects that are associated with this boot option.
      @odata.id string
(URI)
read-only The unique identifier for a resource.
  • 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.
} ]
UefiDevicePath string read-only
(null)
The UEFI device path to access this UEFI boot option.
  • This property shall contain the UEFI Specification-defined UEFI device path that identifies and locates the device for this boot option.

6.14.4 Property details

6.14.4.1 Alias:

The alias of this boot source.

string Description
BiosSetup Boot to the BIOS setup utility.
Cd Boot from the CD or DVD.
Diags Boot to the manufacturer's diagnostics program.
Floppy Boot from the floppy disk drive.
Hdd Boot from a hard drive.
None Boot from the normal boot device.
Pxe Boot from the Pre-Boot EXecution (PXE) environment.
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.14.5 Example response

{
    "@odata.type": "#BootOption.v1_0_4.BootOption",
    "Id": "1",
    "Name": "Boot Option",
    "Description": "UEFI Boot Option",
    "BootOptionReference": "Boot0000",
    "DisplayName": "Windows Boot Manager",
    "UefiDevicePath": "PciRoot(0x0)/Pci(0x1,0x0)/Pci(0x0,0x0)/Scsi(0x0,0x0)/HD(2,GPT,B02BF459-8975-4222-A1C4-17915C29E5E5,0x96800,0x31800)/\\EFI\\Microsoft\\Boot\\bootmgfw.efi",
    "Alias": "Hdd",
    "RelatedItem": [
        {
            "@odata.id": "/redfish/v1/Systems/1/SimpleStorage/1"
        }
    ],
    "Oem": {},
    "@odata.id": "/redfish/v1/Systems/1/BootOptions/1"
}

6.15 Cable 1.2.0

Version v1.2 v1.1 v1.0
Release 2021.4 2021.3 2021.2

6.15.1 Description

The Cable schema contains properties that describe a cable connecting endpoints of a chassis, port, or any other cable-compatible endpoint.

6.15.2 URIs

/​redfish/​v1/​Cables/​{CableId}

6.15.3 Properties

Property Type Attributes Notes
Assembly { object The link to the assembly associated with this cable.
  • This property shall contain a link to a resource of type Assembly.
See the Assembly schema for details on this property.
      @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.
  • This property shall track the cable for inventory purposes.
CableClass string
(enum)
read-write
(null)
The identifier for the downstream resource.
  • The property shall contain the cable class for this cable.
For the possible property values, see CableClass in Property details.
CableStatus string
(enum)
read-write The user-reported status of this resource.
  • This property shall contain the user-reported status of this resource.
For the possible property values, see CableStatus in Property details.
CableType string read-write
(null)
The type of this cable.
  • This property shall contain a user-defined type for this cable.
DownstreamConnectorTypes [ ] array (string
(enum))
read-write
  • The connector types this cable supports.
    • The property shall contain an array of connector types this cable supports.
For the possible property values, see DownstreamConnectorTypes in Property details.
DownstreamName string read-write
(null)
The identifier for the downstream resource.
  • This property shall contain any identifier for a downstream resource.
LengthMeters number read-write
(null)
The length of the cable in meters.
  • This property shall contain the length of the cable in meters.
Links { object The links to other resources that are related to this resource.
  • This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.
      DownstreamChassis [ { array An array of links to the downstream chassis connected to this cable.
  • This property shall contain an array of links to resources of type Chassis that represent the physical downstream containers 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.
  • This property shall contain an array of links to resources of type Port that represent the physical downstream connections 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.
  • This property shall contain an array of links to resources that represent the physical downstream connections connected to this cable. Even if the resource is already referenced in another property within Links, such as DownstreamPorts or DownstreamChassis, it shall also be referenced in this property.
            @odata.id string
(URI)
read-only The unique identifier for a resource.
  • 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.
      } ]
      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.
  • This property shall contain an array of links to resources of type Chassis that represent the physical upstream containers 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.
  • This property shall contain an array of links to resources of type Port that represent the physical upstream connections 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.
  • This property shall contain an array of links to resources that represent the physical upstream connections connected to this cable. Even if the resource is already referenced in another property within Links, such as UpstreamPorts or UpstreamChassis, it shall also be referenced in this property.
            @odata.id string
(URI)
read-only The unique identifier for a resource.
  • 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.
      } ]
}
Location {} object The location of the assembly.
  • This property shall contain location information of the associated assembly.
For property details, see Location.
Manufacturer string read-write
(null)
The manufacturer of this cable.
  • This property shall contain the name of the organization responsible for producing the cable. This organization might be the entity from whom the cable is purchased, but this is not necessarily true.
Model string read-write
(null)
The model number of the cable.
  • This property shall contain the name by which the manufacturer generally refers to the cable.
PartNumber string read-write
(null)
The part number for this cable.
  • This property shall contain the part number assigned by the organization that is responsible for producing or manufacturing the cable.
SerialNumber string read-write
(null)
The serial number for this cable.
  • This property shall contain the manufacturer-allocated number that identifies the cable.
SKU string read-write
(null)
The SKU for this cable.
  • This property shall contain the stock-keeping unit (SKU) number for this cable.
Status {} object The status and health of the resource and its subordinate or dependent resources.
  • This property shall contain any status or health properties of the resource.
For property details, see Status.
UpstreamConnectorTypes [ ] array (string
(enum))
read-write
  • The connector types this cable supports.
    • The property shall contain an array of connector types this cable supports.
For the possible property values, see UpstreamConnectorTypes in Property details.
UpstreamName string read-write
(null)
The identifier for the downstream resource.
  • This property shall contain any identifier for an upstream resource.
UserDescription string read-write
(null)
The description of this cable.
  • This property shall contain a user-defined description for this cable.
UserLabel (v1.1+) string read-write A user-assigned label.
  • This property shall contain a user-assigned label used to identify this resource. If a value has not been assigned by a user, the value of this property shall be an empty string.
Vendor string read-write
(null)
The manufacturer of this cable.
  • This property shall contain the name of the company that provides the final product that includes this cable.

6.15.4 Property details

6.15.4.1 CableClass:

The identifier for the downstream resource.

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.15.4.2 CableStatus:

The user-reported status of this resource.

string Description
Degraded The cable is degraded.
  • This value shall indicate the cable is degraded. The State property in Status shall contain the value Enabled and The Health property in Status shall contain the value Warning.
Disabled The cable is disabled.
  • This value shall indicate the cable is disabled. The State property in Status shall contain the value Disabled.
Failed The cable has failed.
  • This value shall indicate the cable has failed. The State property in Status shall contain the value Enabled and The Health property in Status shall contain the value Critical.
Normal The cable is operating normally.
  • This value shall indicate the cable is operating normally. The State property in Status shall contain the value Enabled and The Health property in Status shall contain the value OK.
SetByService The cable status is set by the service.
  • This value shall indicate the status for the cable is not defined by the user. If implemented, the service shall determine the value of the State and Health properties in Status.
Testing The cable is under test.
  • This value shall indicate the cable is under test. The State property in Status shall contain the value InTest.

6.15.4.3 DownstreamConnectorTypes:

string Description
ACPower This cable connects to a 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 a 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 a SFP connector.
SFPPlus This cable connects to a 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.15.4.4 UpstreamConnectorTypes:

string Description
ACPower This cable connects to a 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 a 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 a SFP connector.
SFPPlus This cable connects to a 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.15.5 Example response

{
    "@odata.type": "#Cable.v1_2_0.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.16 Certificate 1.6.0

Version v1.6 v1.5 v1.4 v1.3 v1.2 v1.1 v1.0
Release 2022.1 2021.3 2021.2 2021.1 2020.1 2019.1 2018.3

6.16.1 Description

The Certificate schema describes a certificate that proves the identify of a component, account, or service.

6.16.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/​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/​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}/​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.16.3 Properties

Property Type Attributes Notes
CertificateString string read-only required on create
(null)
The string for the certificate.
  • This property shall contain the certificate, and the format shall follow the requirements specified by the CertificateType property value. If the certificate contains any private keys, they shall be removed from the string in responses. If the service does not know the private key for the certificate and is needed to use the certificate, the client shall provide the private key as part of the string in the POST request.
For more information about this property, see Property details.
CertificateType string
(enum)
read-only required on create
(null)
The format of the certificate.
  • This property shall contain the format type for the certificate.
For the possible property values, see CertificateType in Property details.
CertificateUsageTypes (v1.4+) [ ] array (string
(enum))
read-only
(null)
  • The types or purposes for this certificate.
    • The value of this property shall contain an array describing the types or purposes for this certificate.
For the possible property values, see CertificateUsageTypes in Property details.
Fingerprint (v1.3+) string read-only The fingerprint of the certificate.
  • The value of this property shall be a string containing the ASCII representation of the fingerprint of the certificate. The hash algorithm used to generate this fingerprint shall be specified by the FingerprintHashAlgorithm property.
Pattern: ^([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.
  • The value of this property shall be a string containing the hash algorithm used for generating the Fingerprint property. The value shall be one of the strings in the 'Algorithm Name' field of the 'TPM_ALG_ID Constants' table within the 'Trusted Computing Group Algorithm Registry'.
Issuer { object The issuer of the certificate.
  • This property shall contain an object containing information about the issuer of the certificate.
      AdditionalCommonNames (v1.6+) [ ] array (string, null) read-only Additional common names of the entity.
  • The value of this property shall contain an array of additional common names for the entity, as defined by the RFC5280 'commonName' attribute, in array order as they appear in the certificate. This property shall not be present if only one common name is found. The first common name shall not appear in this property.
      AdditionalOrganizationalUnits (v1.6+) [ ] array (string, null) read-only Additional organizational units of the entity.
  • The value of this property shall contain an array of additional organizational units for the entity, as defined by the RFC5280 'organizationalUnitName' attribute, in array order as they appear in the certificate. This property shall not be present if only one organizational unit is found. The first organizational unit shall not appear in this property.
      City string read-only The city or locality of the organization of the entity.
  • This property shall contain the city or locality of the organization of the entity, as defined by the RFC5280 'localityName' attribute.
      CommonName string read-only The common name of the entity.
  • This property shall contain the common name of the entity, as defined by the RFC5280 'commonName' attribute.
      Country string read-only The country of the organization of the entity.
  • This property shall contain the two-letter ISO code for the country of the organization of the entity, as defined by the RFC5280 'countryName' attribute.
      DisplayString (v1.6+) string read-only
(null)
A human-readable string for this identifier.
  • The value of this property shall contain a display string that represents the entire identifier. The string should be formatted using industry conventions, such as the single-line human-readable string described by RFC2253 and preserving the field order as shown in the certificate.
      DomainComponents (v1.6+) [ ] array (string, null) read-only The domain components of the entity.
  • The value of this property shall contain an array of domain component fields for the entity, as defined by the RFC4519 'domainComponent' attribute, in array order as they appear in the certificate.
      Email string read-only
(null)
The email address of the contact within the organization of the entity.
  • This property shall contain the email address of the contact within the organization of the entity, as defined by the RFC2985 'emailAddress' attribute.
      Organization string read-only The name of the organization of the entity.
  • This property shall contain the name of the organization of the entity, as defined by the RFC5280 'organizationName' attribute.
      OrganizationalUnit string read-only The name of the unit or division of the organization of the entity.
  • This property shall contain the name of the unit or division of the organization of the entity, as defined by the RFC5280 'organizationalUnitName' attribute.
      State string read-only The state, province, or region of the organization of the entity.
  • This property shall contain the state, province, or region of the organization of the entity, as defined by the RFC5280 'stateOrProvinceName' attribute.
}
KeyUsage [ ] array (string
(enum))
read-only
(null)
The usages of a key contained within a certificate.
  • The key usage extension, which defines the purpose of the public keys in this certificate.
    • This property shall contain the key usage extension, which defines the purpose of the public keys in this certificate.
For the possible property values, see KeyUsage in Property details.
Links (v1.4+) { object The links to other resources that are related to this resource.
  • This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.
      Issuer (v1.4+) { object
(null)
A link to the certificate of the CA that issued this certificate.
  • This property shall contain a link to a resources of type Certificate that represents the certificate of the CA that issued this certificate.
            @odata.id string read-write Link to another Certificate resource.
      }
      Oem {} object See the OEM object definition in the Using this guide clause.
      Subjects (v1.4+) [ { array An array of links to certificates that were issued by the CA that is represented by this certificate.
  • This property shall contain an array of links to resources of type Certificate that were issued by the CA that is represented by this certificate.
            @odata.id string read-write Link to another Certificate resource.
      } ]
}
SerialNumber (v1.3+) string read-only The serial number of the certificate.
  • The value of this property shall be a string containing the ASCII representation of the serial number of the certificate, as defined by the RFC5280 'serialNumber' field.
Pattern: ^([0-9A-Fa-f]{2}:){0,}([0-9A-Fa-f]{2})$
SignatureAlgorithm (v1.3+) string read-only The algorithm used for creating the signature of the certificate.
  • The value of this property shall be a string containing the algorithm used for generating the signature of the certificate, as defined by the RFC5280 'signatureAlgorithm' field. The value shall be a string representing the ASN.1 OID of the signature algorithm as defined in, but not limited to, RFC3279, RFC4055, or RFC4491.
SPDM (v1.5+) { object
(null)
SPDM-related information for the certificate.
  • The value of this property shall contain SPDM-related information for the certificate. This property shall only be present for SPDM certificates.
      SlotId (v1.5+) integer read-only
(null)
Slot identifier of the certificate.
  • The value of this property shall contain an integer between 0 and 7, inclusive, that represents the slot identifier for an SPDM-provided certificate.
}
Subject { object The subject of the certificate.
  • This property shall contain an object containing information about the subject of the certificate.
      AdditionalCommonNames (v1.6+) [ ] array (string, null) read-only Additional common names of the entity.
  • The value of this property shall contain an array of additional common names for the entity, as defined by the RFC5280 'commonName' attribute, in array order as they appear in the certificate. This property shall not be present if only one common name is found. The first common name shall not appear in this property.
      AdditionalOrganizationalUnits (v1.6+) [ ] array (string, null) read-only Additional organizational units of the entity.
  • The value of this property shall contain an array of additional organizational units for the entity, as defined by the RFC5280 'organizationalUnitName' attribute, in array order as they appear in the certificate. This property shall not be present if only one organizational unit is found. The first organizational unit shall not appear in this property.
      City string read-only The city or locality of the organization of the entity.
  • This property shall contain the city or locality of the organization of the entity, as defined by the RFC5280 'localityName' attribute.
      CommonName string read-only The common name of the entity.
  • This property shall contain the common name of the entity, as defined by the RFC5280 'commonName' attribute.
      Country string read-only The country of the organization of the entity.
  • This property shall contain the two-letter ISO code for the country of the organization of the entity, as defined by the RFC5280 'countryName' attribute.
      DisplayString (v1.6+) string read-only
(null)
A human-readable string for this identifier.
  • The value of this property shall contain a display string that represents the entire identifier. The string should be formatted using industry conventions, such as the single-line human-readable string described by RFC2253 and preserving the field order as shown in the certificate.
      DomainComponents (v1.6+) [ ] array (string, null) read-only The domain components of the entity.
  • The value of this property shall contain an array of domain component fields for the entity, as defined by the RFC4519 'domainComponent' attribute, in array order as they appear in the certificate.
      Email string read-only
(null)
The email address of the contact within the organization of the entity.
  • This property shall contain the email address of the contact within the organization of the entity, as defined by the RFC2985 'emailAddress' attribute.
      Organization string read-only The name of the organization of the entity.
  • This property shall contain the name of the organization of the entity, as defined by the RFC5280 'organizationName' attribute.
      OrganizationalUnit string read-only The name of the unit or division of the organization of the entity.
  • This property shall contain the name of the unit or division of the organization of the entity, as defined by the RFC5280 'organizationalUnitName' attribute.
      State string read-only The state, province, or region of the organization of the entity.
  • This property shall contain the state, province, or region of the organization of the entity, as defined by the RFC5280 'stateOrProvinceName' attribute.
}
UefiSignatureOwner (v1.2+) string read-only
(null)
The UEFI signature owner for this certificate.
  • The value of this property shall contain the GUID of the UEFI signature owner for this certificate as defined by the UEFI Specification. This property shall only be present for certificates managed by UEFI.
Pattern: ([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})
ValidNotAfter string
(date-time)
read-only The date when the certificate is no longer valid.
  • This property shall contain the date when the certificate validity period ends.
ValidNotBefore string
(date-time)
read-only The date when the certificate becomes valid.
  • This property shall contain the date when the certificate validity period begins.

6.16.4 Actions

6.16.4.1 Rekey (v1.1+)

Description

This action generates a new key-pair for a certificate and produces a certificate signing request.

Action URI: {Base URI of target resource}/Actions/Certificate.Rekey

Action parameters

Parameter Name Type Attributes Notes
      ChallengePassword string optional The challenge password to apply to the certificate for revocation requests.
  • This property shall contain the challenge password to apply to the certificate for revocation requests as defined by the RFC2985 'challengePassword' attribute.
      KeyBitLength integer optional The length of the key, in bits, if needed based on the KeyPairAlgorithm parameter value.
  • This parameter shall contain the length of the key, in bits, if needed based on the KeyPairAlgorithm parameter value.
      KeyCurveId string optional The curve ID to use with the key, if needed based on the KeyPairAlgorithm parameter value.
  • This parameter shall contain the curve ID to use with the key, if needed based on the KeyPairAlgorithm parameter value. The allowable values for this parameter shall be the strings in the 'Name' field of the 'TPM_ECC_CURVE Constants' table within the 'Trusted Computing Group Algorithm Registry'.
      KeyPairAlgorithm string optional The type of key-pair for use with signing algorithms.
  • This parameter shall contain the type of key-pair for use with signing algorithms. The allowable values for this parameter shall be the strings in the 'Algorithm Name' field of the 'TPM_ALG_ID Constants' table within the 'Trusted Computing Group Algorithm Registry'.

Response Payload

{
      Certificate (v1.1+) { object required The link to the certificate being rekeyed.
  • This property shall contain a link to a resource of type Certificate that is replaced after the certificate authority (CA) signs the certificate.
            @odata.id string read-only Link to another Certificate resource.
      }
      CSRString (v1.1+) string read-only required The string for the certificate signing request.
  • This property shall contain the certificate signing request as a PEM-encoded string, containing structures specified by RFC2986. The private key should not be part of the string.
}

Request Example

{
    "KeyPairAlgorithm": "TPM_ALG_RSA",
    "KeyBitLength": 4096
}

Response Example

{
    "CSRString": "-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----",
    "Certificate": {
        "@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates/1"
    }
}

6.16.4.2 Renew (v1.1+)

Description

This action generates a certificate signing request by using the existing information and key-pair of the certificate.

Action URI: {Base URI of target resource}/Actions/Certificate.Renew

Action parameters

Parameter Name Type Attributes Notes
      ChallengePassword string optional The challenge password to apply to the certificate for revocation requests.
  • This property shall contain the challenge password to apply to the certificate for revocation requests as defined by the RFC2985 'challengePassword' attribute.

Response Payload

{
      Certificate (v1.1+) { object required The link to the certificate being renewed.
  • This property shall contain a link to a resource of type Certificate that is replaced after the certificate authority (CA) signs the certificate.
            @odata.id string read-only Link to another Certificate resource.
      }
      CSRString (v1.1+) string read-only required The string for the certificate signing request.
  • This property shall contain the certificate signing request as a PEM-encoded string, containing structures specified by RFC2986. The private key should not be part of the string.
}

Request Example

{
    "ChallengePassword": "p4ssw0rd"
}

Response Example

{
    "CSRString": "-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----",
    "Certificate": {
        "@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates/1"
    }
}

6.16.5 Property details

6.16.5.1 CertificateString:

The string for the certificate.

When a certificate of type PEMchain or PKCS7 is installed, the service may create multiple resources to represent each of the certificates found in the string. If the service divides the request into multiple resources, the service:

To satisfy JSON encoding requirements, newlines in the string shall be replaced with \n. Standard JSON libraries typically manage this conversion automatically.

6.16.5.2 CertificateType:

The format of the certificate.

6.16.5.2.1 PEMchain

When the value of CertificateType is PEMchain, the format represents a series of certificates. The format shall be a concatenation, in order, of the following:

The private key shall be encoded as described in section 10 of RFC7468.

The leaf certificate and CA certificates shall be certificates as defined by RFC5280 and shall be encoded as described in section 5 of RFC7468.

Each certificate in the set of CA certificates shall be the issuer of the preceding certificate. For example, the first CA certificate is the issuer of the leaf certificate, the second CA certificate is the issuer of the first CA certificate, and so on. The last CA certificate typically represents the root CA and is self-signed. The set of certificates should contain all certificates leading to the root CA.

The following example for a PEMchain certificate contains three certificates: the leaf certificate for "*.dmtf.org", the CA certificate "Go Daddy Secure Certificate Authorithy - G2", and the root CA certificate "Go Daddy Root Certificate Authority - G2".

-----BEGIN CERTIFICATE-----
MIIGpzCCBY+gAwIBAgIJAO3nRphCG8xGMA0GCSqGSIb3DQEBCwUAMIG0MQswCQYD
VQQGEwJVUzEQMA4GA1UECBMHQXJpem9uYTETMBEGA1UEBxMKU2NvdHRzZGFsZTEa
MBgGA1UEChMRR29EYWRkeS5jb20sIEluYy4xLTArBgNVBAsTJGh0dHA6Ly9jZXJ0
cy5nb2RhZGR5LmNvbS9yZXBvc2l0b3J5LzEzMDEGA1UEAxMqR28gRGFkZHkgU2Vj
dXJlIENlcnRpZmljYXRlIEF1dGhvcml0eSAtIEcyMB4XDTE5MDYxNTE1MDIyNFoX
DTIxMDgxNDE5MDQ0M1owODEhMB8GA1UECxMYRG9tYWluIENvbnRyb2wgVmFsaWRh
dGVkMRMwEQYDVQQDDAoqLmRtdGYub3JnMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A
MIIBCgKCAQEAvEVrgkWuoz0kAEMqa3mna38MlN41vztntdE3Glm1IB5cHL1igJm0
PKnlvF0ShxBCOXKRMn8Z3HsbfQ4IQRD20meT6LWnMHCHE5+DKhDdzvz6SSlwmOF+
arAqDdBRXRkyvVVvpw2YLGTWc572t2WqhgKOrC7eaT9D/kxJmhVIt4NwNGj4Awl6
5fqNxxqWLDEJw9HYgxXMyv78gZaV66wZmE0MiypSKI0VtlZs8gryHdDG8iWbP0At
n098jcrkOkI5ewDq/jBHXdFfTgJtSkBIR4wpgmM+tL8pgEplyntWM/0xPBphJf6k
LjcoulHeW8r5Fv6II85fnNR7gW5pxnFz1wIDAQABo4IDNTCCAzEwDAYDVR0TAQH/
BAIwADAdBgNVHSUEFjAUBggrBgEFBQcDAQYIKwYBBQUHAwIwDgYDVR0PAQH/BAQD
AgWgMDgGA1UdHwQxMC8wLaAroCmGJ2h0dHA6Ly9jcmwuZ29kYWRkeS5jb20vZ2Rp
ZzJzMS0xMTc1LmNybDBdBgNVHSAEVjBUMEgGC2CGSAGG/W0BBxcBMDkwNwYIKwYB
BQUHAgEWK2h0dHA6Ly9jZXJ0aWZpY2F0ZXMuZ29kYWRkeS5jb20vcmVwb3NpdG9y
eS8wCAYGZ4EMAQIBMHYGCCsGAQUFBwEBBGowaDAkBggrBgEFBQcwAYYYaHR0cDov
L29jc3AuZ29kYWRkeS5jb20vMEAGCCsGAQUFBzAChjRodHRwOi8vY2VydGlmaWNh
dGVzLmdvZGFkZHkuY29tL3JlcG9zaXRvcnkvZ2RpZzIuY3J0MB8GA1UdIwQYMBaA
FEDCvSeOzDSDMKIz1/tss/C0LIDOMB8GA1UdEQQYMBaCCiouZG10Zi5vcmeCCGRt
dGYub3JnMB0GA1UdDgQWBBQZ2f2Fj14M4O81b6l5o+91idrySDCCAX4GCisGAQQB
1nkCBAIEggFuBIIBagFoAHYApLkJkLQYWBSHuxOizGdwCjw1mAT5G9+443fNDsgN
3BAAAAFrW6lKdgAABAMARzBFAiAJcqOn6x917jSYgE1Dot7wcN//5XMbi6ZVO4Ke
D5tEdAIhAK8iYDLb6rHEscWcPOu7XHUj3l/oqtez4KBh4wvCsn3GAHYA7ku9t3XO
YLrhQmkfq+GeZqMPfl+wctiDAMR7iXqo/csAAAFrW6lQOQAABAMARzBFAiEAqohS
sSlGBdXgemmfXuthuox/T8kKNwqmsTwtMNG2J9MCIBQBQTwmO/C7W4g+U/J0B4vU
LKWPGOYrnoOwHLdWpXOqAHYARJRlLrDuzq/EQAfYqP4owNrmgr7YyzG1P9MzlrW2
gagAAAFrW6lSdwAABAMARzBFAiEA44PR+UD/fXG57Edi/WdAiutVuO3xsN2dJKA2
yGl6TVMCIEP4D0A4C/3avvjo+Tc7IAPm98yF4gQhpxyevFFVGw+YMA0GCSqGSIb3
DQEBCwUAA4IBAQCx/1p1gal19B0+jg+0SdtFtSC81pF1Fkp/QQ2/9cvo6eklC3Hl
kvAIzu4+MzB77o+y47WJICX90Flk/xVWXKp3Nq6XoQQgJc9hbzdLHErZqE0t+3bB
4/ZNBpxeE2aOl/8QhKiA0ibYuAJn8acH5dVfk7Yy7Uv1LqyGw/YyRdPtukA4s7NA
8YLhFK5LfMKm/9HAi4Q7XJ6blnFKppemhqSqdarJ48u6qlLUcm64EmhZjwjUaE6f
1ML5qtGn57EZla3sfB7xjZ0KbfYY3IOA1XLP/bVKewjopQve2FR/rZ4KW9wrR0GS
0EyYN7gphrtSoWwCJDk8zRDfzOf1TOevaNLx
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
MIIE0DCCA7igAwIBAgIBBzANBgkqhkiG9w0BAQsFADCBgzELMAkGA1UEBhMCVVMx
EDAOBgNVBAgTB0FyaXpvbmExEzARBgNVBAcTClNjb3R0c2RhbGUxGjAYBgNVBAoT
EUdvRGFkZHkuY29tLCBJbmMuMTEwLwYDVQQDEyhHbyBEYWRkeSBSb290IENlcnRp
ZmljYXRlIEF1dGhvcml0eSAtIEcyMB4XDTExMDUwMzA3MDAwMFoXDTMxMDUwMzA3
MDAwMFowgbQxCzAJBgNVBAYTAlVTMRAwDgYDVQQIEwdBcml6b25hMRMwEQYDVQQH
EwpTY290dHNkYWxlMRowGAYDVQQKExFHb0RhZGR5LmNvbSwgSW5jLjEtMCsGA1UE
CxMkaHR0cDovL2NlcnRzLmdvZGFkZHkuY29tL3JlcG9zaXRvcnkvMTMwMQYDVQQD
EypHbyBEYWRkeSBTZWN1cmUgQ2VydGlmaWNhdGUgQXV0aG9yaXR5IC0gRzIwggEi
MA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC54MsQ1K92vdSTYuswZLiBCGzD
BNliF44v/z5lz4/OYuY8UhzaFkVLVat4a2ODYpDOD2lsmcgaFItMzEUz6ojcnqOv
K/6AYZ15V8TPLvQ/MDxdR/yaFrzDN5ZBUY4RS1T4KL7QjL7wMDge87Am+GZHY23e
cSZHjzhHU9FGHbTj3ADqRay9vHHZqm8A29vNMDp5T19MR/gd71vCxJ1gO7GyQ5HY
pDNO6rPWJ0+tJYqlxvTV0KaudAVkV4i1RFXULSo6Pvi4vekyCgKUZMQWOlDxSq7n
eTOvDCAHf+jfBDnCaQJsY1L6d8EbyHSHyLmTGFBUNUtpTrw700kuH9zB0lL7AgMB
AAGjggEaMIIBFjAPBgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIBBjAdBgNV
HQ4EFgQUQMK9J47MNIMwojPX+2yz8LQsgM4wHwYDVR0jBBgwFoAUOpqFBxBnKLbv
9r0FQW4gwZTaD94wNAYIKwYBBQUHAQEEKDAmMCQGCCsGAQUFBzABhhhodHRwOi8v
b2NzcC5nb2RhZGR5LmNvbS8wNQYDVR0fBC4wLDAqoCigJoYkaHR0cDovL2NybC5n
b2RhZGR5LmNvbS9nZHJvb3QtZzIuY3JsMEYGA1UdIAQ/MD0wOwYEVR0gADAzMDEG
CCsGAQUFBwIBFiVodHRwczovL2NlcnRzLmdvZGFkZHkuY29tL3JlcG9zaXRvcnkv
MA0GCSqGSIb3DQEBCwUAA4IBAQAIfmyTEMg4uJapkEv/oV9PBO9sPpyIBslQj6Zz
91cxG7685C/b+LrTW+C05+Z5Yg4MotdqY3MxtfWoSKQ7CC2iXZDXtHwlTxFWMMS2
RJ17LJ3lXubvDGGqv+QqG+6EnriDfcFDzkSnE3ANkR/0yBOtg2DZ2HKocyQetawi
DsoXiWJYRBuriSUBAA/NxBti21G00w9RKpv0vHP8ds42pM3Z2Czqrpv1KrKQ0U11
GIo/ikGQI31bS/6kA1ibRrLDYGCD+H1QQc7CoZDDu+8CL9IVVO5EFdkKrqeKM+2x
LXY2JtwE65/3YR8V3Idv7kaWKK2hJn0KCacuBKONvPi8BDAB
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
MIIDxTCCAq2gAwIBAgIBADANBgkqhkiG9w0BAQsFADCBgzELMAkGA1UEBhMCVVMx
EDAOBgNVBAgTB0FyaXpvbmExEzARBgNVBAcTClNjb3R0c2RhbGUxGjAYBgNVBAoT
EUdvRGFkZHkuY29tLCBJbmMuMTEwLwYDVQQDEyhHbyBEYWRkeSBSb290IENlcnRp
ZmljYXRlIEF1dGhvcml0eSAtIEcyMB4XDTA5MDkwMTAwMDAwMFoXDTM3MTIzMTIz
NTk1OVowgYMxCzAJBgNVBAYTAlVTMRAwDgYDVQQIEwdBcml6b25hMRMwEQYDVQQH
EwpTY290dHNkYWxlMRowGAYDVQQKExFHb0RhZGR5LmNvbSwgSW5jLjExMC8GA1UE
AxMoR28gRGFkZHkgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkgLSBHMjCCASIw
DQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL9xYgjx+lk09xvJGKP3gElY6SKD
E6bFIEMBO4Tx5oVJnyfq9oQbTqC023CYxzIBsQU+B07u9PpPL1kwIuerGVZr4oAH
/PMWdYA5UXvl+TW2dE6pjYIT5LY/qQOD+qK+ihVqf94Lw7YZFAXK6sOoBJQ7Rnwy
DfMAZiLIjWltNowRGLfTshxgtDj6AozO091GB94KPutdfMh8+7ArU6SSYmlRJQVh
GkSBjCypQ5Yj36w6gZoOKcUcqeldHraenjAKOc7xiID7S13MMuyFYkMlNAJWJwGR
tDtwKj9useiciAF9n9T521NtYJ2/LOdYq7hfRvzOxBsDPAnrSTFcaUaz4EcCAwEA
AaNCMEAwDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAQYwHQYDVR0OBBYE
FDqahQcQZyi27/a9BUFuIMGU2g/eMA0GCSqGSIb3DQEBCwUAA4IBAQCZ21151fmX
WWcDYfF+OwYxdS2hII5PZYe096acvNjpL9DbWu7PdIxztDhC2gV7+AJ1uP2lsdeu
9tfeE8tTEH6KRtGX+rcuKxGrkLAngPnon1rpN5+r5N9ss4UXnT3ZJE95kTXWXwTr
gIOrmgIttRD02JDHBHNA7XIloKmf7J6raBKZV8aPEjoJpL1E/QYVN8Gb5DKj7Tjo
2GTzLH4U/ALqn83/B2gX2yKQOC16jdFU8WnjXzPKej17CuPKf1855eJ1usV2GDPO
LPAvTK33sefOT6jEm0pUBsV/fdUID+Ic/n4XuKxe9tQWskMJDE32p2u0mYRlynqI
4uJEvlz36hz1
-----END CERTIFICATE-----
6.16.5.2.2 PEM

When the value of CertificateType is PEM, the format represents a single certificate and an optional private key. The format shall be an order independent concatenation of the following:

The private key shall be encoded as described in section 10 of RFC7468.

The leaf certificate shall be a certificate as defined by RFC5280 and shall be encoded as described in section 5 of RFC7468.

6.16.5.2.3 PKCS7

When the value of CertificateType is PKCS7, the format represents a PKCS7 bundle and an optional private key. The format shall be an order independent concatenation of the following:

The private key shall be encoded as described in section 10 of RFC7468.

The PKCS7 bundle shall contain one or more certificates as defined by RFC5280 and shall be encoded as described in section 8 of RFC7468.

string Description
PEM A Privacy Enhanced Mail (PEM)-encoded single certificate.
  • This value shall indicate the format of the certificate shall contain a Privacy Enhanced Mail (PEM)-encoded string, containing RFC5280-defined structures, representing a single certificate.
PEMchain (v1.4+) A Privacy Enhanced Mail (PEM)-encoded certificate chain.
  • This value shall indicate the format of the certificate shall contain a Privacy Enhanced Mail (PEM)-encoded string, containing RFC5280-defined structures, representing a certificate chain.
PKCS7 A Privacy Enhanced Mail (PEM)-encoded PKCS7 certificate.
  • The format of the certificate shall contain a Privacy Enhanced Mail (PEM)-encoded string, containing RFC5280-defined and RFC2315-defined structures. The service can discard additional certificates or other data in the structure.

6.16.5.3 CertificateUsageTypes:

string Description
BIOS This certificate is a BIOS certificate like those associated with UEFI.
Device This certificate is a device type certificate like those associated with SPDM and other standards.
Platform This certificate is a platform type certificate like those associated with SPDM and other standards.
SSH This certificate is used for SSH.
User This certificate is a user certificate like those associated with a manager account.
Web This certificate is a web or HTTPS certificate like those used for event destinations.

6.16.5.4 KeyUsage:

The usages of a key contained within a certificate.

string Description
ClientAuthentication TLS WWW client authentication.
CodeSigning Signs downloadable executable code.
CRLSigning Verifies signatures on certificate revocation lists (CRLs).
DataEncipherment Directly enciphers raw user data without an intermediate symmetric cipher.
DecipherOnly Deciphers data while performing a key agreement.
DigitalSignature Verifies digital signatures, other than signatures on certificates and CRLs.
EmailProtection Email protection.
EncipherOnly Enciphers data while performing a key agreement.
KeyAgreement Key agreement.
KeyCertSign Verifies signatures on public key certificates.
KeyEncipherment Enciphers private or secret keys.
NonRepudiation Verifies digital signatures, other than signatures on certificates and CRLs, and provides a non-repudiation service that protects against the signing entity falsely denying some action.
OCSPSigning Signs OCSP responses.
ServerAuthentication TLS WWW server authentication.
Timestamping Binds the hash of an object to a time.

6.16.6 Example response

{
    "@odata.type": "#Certificate.v1_6_0.Certificate",
    "Id": "1",
    "Name": "HTTPS Certificate",
    "CertificateString": "-----BEGIN CERTIFICATE-----\nMIIFsTCC [*truncated*] GXG5zljlu\n-----END CERTIFICATE-----",
    "CertificateType": "PEM",
    "Issuer": {
        "Country": "US",
        "State": "Oregon",
        "City": "Portland",
        "Organization": "Contoso",
        "OrganizationalUnit": "ABC",
        "CommonName": "manager.contoso.org"
    },
    "Subject": {
        "Country": "US",
        "State": "Oregon",
        "City": "Portland",
        "Organization": "Contoso",
        "OrganizationalUnit": "ABC",
        "CommonName": "manager.contoso.org"
    },
    "ValidNotBefore": "2018-09-07T13:22:05Z",
    "ValidNotAfter": "2019-09-07T13:22:05Z",
    "KeyUsage": [
        "KeyEncipherment",
        "ServerAuthentication"
    ],
    "SerialNumber": "5d:7a:d8:df:f6:fc:c1:b3:ca:fe:fb:cc:38:f3:01:64:51:ea:05:cb",
    "Fingerprint": "A6:E9:D2:5C:DC:52:DA:4B:3B:14:97:F3:A4:53:D9:99:A1:0B:56:41",
    "FingerprintHashAlgorithm": "TPM_ALG_SHA1",
    "SignatureAlgorithm": "sha256WithRSAEncryption",
    "Oem": {},
    "@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates/1"
}

6.17 CertificateLocations 1.0.2

Version v1.0
Release 2018.3

6.17.1 Description

The CertificateLocations schema describes a Resource that an administrator can use in order to locate all certificates installed on a given service.

6.17.2 URIs

/​redfish/​v1/​CertificateService/​CertificateLocations

6.17.3 Properties

Property Type Attributes Notes
Links { object The links to other Resources that are related to this Resource.
  • This property shall contain links to Resources that are related to but are not contained by or subordinate to this Resource.
      Certificates [ { array An array of links to the certificates installed on this service.
  • This property shall contain an array of links to Certificate Resources that are installed on this service.
            @odata.id string read-only Link to a Certificate resource. See the Links section and the Certificate schema for details.
      } ]
      Oem {} object See the OEM object definition in the Using this guide clause.
}

6.17.4 Example response

{
    "@odata.type": "#CertificateLocations.v1_0_2.CertificateLocations",
    "Id": "CertificateLocations",
    "Name": "Certificate Locations",
    "Links": {
        "Certificates": [
            {
                "@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates/1"
            }
        ]
    },
    "Oem": {},
    "@odata.id": "/redfish/v1/CertificateService/CertificateLocations"
}

6.18 CertificateService 1.0.4

Version v1.0
Release 2018.3

6.18.1 Description

The CertificateService schema describes a certificate service that represents the actions available to manage certificates and links to the certificates.

6.18.2 URIs

/​redfish/​v1/​CertificateService

6.18.3 Properties

Property Type Attributes Notes
CertificateLocations { object The information about the location of certificates.
  • This property shall contain a link to a resource of type CertificateLocations.
See the CertificateLocations schema for details on this property.
      @odata.id string read-only Link to a CertificateLocations resource. See the Links section and the CertificateLocations schema for details.
}

6.18.4 Actions

6.18.4.1 GenerateCSR

Description

This action makes a certificate signing request.

Action URI: {Base URI of target resource}/Actions/CertificateService.GenerateCSR

Action parameters

Parameter Name Type Attributes Notes
      AlternativeNames [ ] array (string) optional The additional host names of the component to secure.
  • This parameter shall contain an array of additional host names of the component to secure, as defined by the RFC5280 'subjectAltName' attribute.
      CertificateCollection { object required The link to the certificate collection where the certificate is installed after the certificate authority (CA) signs the certificate.
  • This parameter shall contain a link to a resource collection of type CertificateCollection where the certificate is installed after the certificate authority (CA) signs the certificate.
Contains a link to a resource.
            @odata.id string read-only Link to Collection of Certificate. See the Certificate schema for details.
      }
      ChallengePassword string optional The challenge password to apply to the certificate for revocation requests.
  • This property shall contain the challenge password to apply to the certificate for revocation requests as defined by the RFC2985 'challengePassword' attribute.
      City string required The city or locality of the organization making the request.
  • This parameter shall contain the city or locality of the organization making the request, as defined by the RFC5280 'localityName' attribute.
      CommonName string required The fully qualified domain name of the component to secure.
  • This parameter shall contain the fully qualified domain name of the component to secure, as defined by the RFC5280 'commonName' attribute.
      ContactPerson string optional The name of the user making the request.
  • This property shall contain the name of the user making the request, as defined by the RFC5280 'name' attribute.
      Country string required The two-letter country code of the organization making the request.
  • This parameter shall contain the two-letter ISO code for the country of the organization making the request, as defined by the RFC5280 'countryName' attribute.
      Email string optional The email address of the contact within the organization making the request.
  • This parameter shall contain the email address of the contact within the organization making the request, as defined by the RFC2985 'emailAddress' attribute.
      GivenName string optional The given name of the user making the request.
  • This parameter shall contain the given name of the user making the request, as defined by the RFC5280 'givenName' attribute.
      Initials string optional The initials of the user making the request.
  • This parameter shall contain the initials of the user making the request, as defined by the RFC5280 'initials' attribute.
      KeyBitLength integer optional The length of the key, in bits, if needed based on the KeyPairAlgorithm parameter value.
  • This parameter shall contain the length of the key, in bits, if needed based on the KeyPairAlgorithm parameter value.
      KeyCurveId string optional The curve ID to use with the key, if needed based on the KeyPairAlgorithm parameter value.
  • This parameter shall contain the curve ID to use with the key, if needed based on the KeyPairAlgorithm parameter value. The allowable values for this parameter shall be the strings in the 'Name' field of the 'TPM_ECC_CURVE Constants' table within the 'Trusted Computing Group Algorithm Registry'.
      KeyPairAlgorithm string optional The type of key-pair for use with signing algorithms.
  • This parameter shall contain the type of key-pair for use with signing algorithms. The allowable values for this parameter shall be the strings in the 'Algorithm Name' field of the 'TPM_ALG_ID Constants' table within the 'Trusted Computing Group Algorithm Registry'.
      KeyUsage [ ] array (string
(enum))
read-write The usages of a key contained within a certificate.
  • The usage of the key contained in the certificate.
    • This parameter shall contain the usage of the key contained in the certificate. If the client does not provide this value, the service can determine the appropriate key usage settings in the certificate signing request.
For the possible property values, see KeyUsage in Property details.
      Organization string required The name of the organization making the request.
  • This parameter shall contain the name of the organization making the request, as defined by the RFC5280 'organizationName' attribute.
      OrganizationalUnit string required The name of the unit or division of the organization making the request.
  • This parameter shall contain the name of the unit or division of the organization making the request, as defined by the RFC5280 'organizationalUnitName' attribute.
      State string required The state, province, or region of the organization making the request.
  • This parameter shall contain the state, province, or region of the organization making the request, as defined by the RFC5280 'stateOrProvinceName' attribute.
      Surname string optional The surname of the user making the request.
  • This parameter shall contain the surname of the user making the request, as defined by the RFC5280 'surname' attribute.
      UnstructuredName string optional The unstructured name of the subject.
  • This property shall contain the unstructured name of the subject, as defined by the RFC2985 'unstructuredName' attribute.

Response Payload

{
      CertificateCollection { object required The link to the certificate collection where the certificate is installed.
  • This property shall contain a link to a resource collection of type CertificateCollection where the certificate is installed after the certificate authority (CA) has signed the certificate.
Contains a link to a resource.
            @odata.id string read-only Link to Collection of Certificate. See the Certificate schema for details.
      }
      CSRString string read-only required The string for the certificate signing request.
  • This property shall contain the Privacy Enhanced Mail (PEM)-encoded string, which contains RFC2986-specified structures, of the certificate signing request. The private key should not be part of the string.
}

Request Example

{
    "Country": "US",
    "State": "Oregon",
    "City": "Portland",
    "Organization": "Contoso",
    "OrganizationalUnit": "ABC",
    "CommonName": "manager.contoso.org",
    "AlternativeNames": [
        "manager.contoso.com",
        "manager.contoso.us"
    ],
    "Email": "admin@contoso.org",
    "KeyPairAlgorithm": "TPM_ALG_RSA",
    "KeyBitLength": 4096,
    "KeyUsage": [
        "KeyEncipherment",
        "ServerAuthentication"
    ],
    "CertificateCollection": {
        "@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates"
    }
}

Response Example

{
    "CSRString": "-----BEGIN CERTIFICATE REQUEST-----...-----END CERTIFICATE REQUEST-----",
    "CertificateCollection": {
        "@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates"
    }
}

6.18.4.2 ReplaceCertificate

Description

This action replaces a certificate.

Action URI: {Base URI of target resource}/Actions/CertificateService.ReplaceCertificate

Action parameters

Parameter Name Type Attributes Notes
      CertificateString string required The string for the certificate.
  • This parameter shall contain the string of the certificate, and the format shall follow the requirements specified by the CertificateType property value. If the certificate contains any private keys, they shall be removed from the string in responses. If the service does not know the private key for the certificate and it is needed to use the certificate, the client shall provide the private key as part of the string in the POST request.
      CertificateType string
(enum)
required The format of the certificate.
  • This parameter shall contain the format type for the certificate.
For the possible property values, see CertificateType in Property details.
      CertificateUri { object required The link to the certificate that is being replaced.
  • This parameter shall contain a link to a resource of type Certificate that is being replaced.
See the Certificate schema for details on this property.
            @odata.id string read-only Link to a Certificate resource. See the Links section and the Certificate schema for details.
      }

Request Example

{
    "CertificateUri": {
        "@odata.id": "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates/1"
    },
    "CertificateString": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
    "CertificateType": "PEM"
}

6.18.5 Property details

6.18.5.1 CertificateType:

The format of the certificate.

string Description
PEM A Privacy Enhanced Mail (PEM)-encoded single certificate.
  • This value shall indicate the format of the certificate shall contain a Privacy Enhanced Mail (PEM)-encoded string, containing RFC5280-defined structures, representing a single certificate.
PEMchain A Privacy Enhanced Mail (PEM)-encoded certificate chain.
  • This value shall indicate the format of the certificate shall contain a Privacy Enhanced Mail (PEM)-encoded string, containing RFC5280-defined structures, representing a certificate chain.
PKCS7 A Privacy Enhanced Mail (PEM)-encoded PKCS7 certificate.
  • The format of the certificate shall contain a Privacy Enhanced Mail (PEM)-encoded string, containing RFC5280-defined and RFC2315-defined structures. The service can discard additional certificates or other data in the structure.

6.18.5.2 KeyUsage:

The usages of a key contained within a certificate.

string Description
ClientAuthentication TLS WWW client authentication.
CodeSigning Signs downloadable executable code.
CRLSigning Verifies signatures on certificate revocation lists (CRLs).
DataEncipherment Directly enciphers raw user data without an intermediate symmetric cipher.
DecipherOnly Deciphers data while performing a key agreement.
DigitalSignature Verifies digital signatures, other than signatures on certificates and CRLs.
EmailProtection Email protection.
EncipherOnly Enciphers data while performing a key agreement.
KeyAgreement Key agreement.
KeyCertSign Verifies signatures on public key certificates.
KeyEncipherment Enciphers private or secret keys.
NonRepudiation Verifies digital signatures, other than signatures on certificates and CRLs, and provides a non-repudiation service that protects against the signing entity falsely denying some action.
OCSPSigning Signs OCSP responses.
ServerAuthentication TLS WWW server authentication.
Timestamping Binds the hash of an object to a time.

6.18.6 Example response

{
    "@odata.type": "#CertificateService.v1_0_4.CertificateService",
    "Id": "CertificateService",
    "Name": "Certificate Service",
    "Actions": {
        "#CertificateService.GenerateCSR": {
            "target": "/redfish/v1/CertificateService/Actions/CertificateService.GenerateCSR",
            "@Redfish.ActionInfo": "/redfish/v1/CertificateService/GenerateCSRActionInfo"
        },
        "#CertificateService.ReplaceCertificate": {
            "target": "/redfish/v1/CertificateService/Actions/CertificateService.ReplaceCertificate",
            "@Redfish.ActionInfo": "/redfish/v1/CertificateService/ReplaceCertificateActionInfo"
        }
    },
    "CertificateLocations": {
        "@odata.id": "/redfish/v1/CertificateService/CertificateLocations"
    },
    "Oem": {},
    "@odata.id": "/redfish/v1/CertificateService"
}

6.19 Chassis 1.21.0

Version v1.21 v1.20 v1.19 v1.18 v1.17 v1.16 v1.15 v1.14 v1.13 v1.12 v1.11 ...
Release 2022.2 2022.1 2021.4 2021.3 2021.2 2021.1 2020.4 2020.3 2020.2 2020.1 2019.4 ...

6.19.1 Description

The Chassis schema represents the physical components of a system. This resource represents the sheet-metal confined spaces and logical zones such as racks, enclosures, chassis and all other containers. Subsystems, such as sensors, that operate outside of a system's data plane are linked either directly or indirectly through this resource. A subsystem that operates outside of a system's data plane are not accessible to software that runs on the system.

6.19.2 URIs

/​redfish/​v1/​Chassis/​{ChassisId}

6.19.3 Properties

Property Type Attributes Notes
Assembly (v1.6+) { object The link to the assembly associated with this chassis.
  • This property shall contain a link to a resource of type Assembly.
See the Assembly schema for details on this property.
      @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 of this chassis.
  • This property shall contain an identifying string that tracks the chassis for inventory purposes.
Certificates (v1.15+) { object The link to a collection of certificates for device identity and attestation.
  • This property shall contain a link to a resource collection of type CertificateCollection that contains certificates for device identity and attestation.
Contains a link to a resource.
      @odata.id string read-only Link to Collection of Certificate. See the Certificate schema for details.
}
ChassisType string
(enum)
read-only required The type of physical form factor of the chassis.
  • This property shall indicate the physical form factor for the type of chassis.
For the possible property values, see ChassisType in Property details.
Controls (v1.17+) { object The link to the collection of controls located in this chassis.
  • This property shall contain a link to a resource collection of type ControlCollection.
Contains a link to a resource.
      @odata.id string read-only Link to Collection of Control. See the Control schema for details.
}
DepthMm (v1.4+) number
(mm)
read-only
(null)
The depth of the chassis.
  • This property shall represent the depth (length) of the chassis, in millimeters, as specified by the manufacturer.
Drives (v1.14+) { object The link to the collection of drives within this chassis.
  • This property shall contain a link to a resource collection of type DriveCollection.
Contains a link to a resource.
      @odata.id string read-only Link to Collection of Drive. See the Drive schema for details.
}
ElectricalSourceManagerURIs (v1.18+) [ ] array
(URI) (string, null)
read-write The URIs of the management interfaces for the upstream electrical source connections for this chassis.
  • This property shall contain an array of URIs to the management applications or devices that provide monitoring or control of the upstream electrical sources that provide power to this chassis.
ElectricalSourceNames (v1.18+) [ ] array (string, null) read-write The names of the upstream electrical sources, such as circuits or outlets, connected to this chassis.
  • This property shall contain an arrays of strings that identify the upstream electrical sources, such as the names of circuits or outlets, that provide power to this chassis.
EnvironmentalClass (v1.9+) string
(enum)
read-write
(null)
The ASHRAE Environmental Class for this chassis.
  • This property shall contain the ASHRAE Environmental Class for this chassis, as defined by ASHRAE Thermal Guidelines for Data Processing Environments. These classes define respective environmental limits that include temperature, relative humidity, dew point, and maximum allowable elevation.
For the possible property values, see EnvironmentalClass in Property details.
EnvironmentMetrics (v1.15+) { object The link to the environment metrics for this chassis.
  • This property shall contain a link to a resource of type EnvironmentMetrics that specifies the environment metrics for this chassis.
See the EnvironmentMetrics schema for details on this property.
      @odata.id string read-only Link to a EnvironmentMetrics resource. See the Links section and the EnvironmentMetrics schema for details.
}
FabricAdapters (v1.20+) { object The link to the collection of fabric adapters located in this chassis.
  • This property shall contain a link to a resource collection of type FabricAdapterCollection.
Contains a link to a resource.
      @odata.id string read-only Link to Collection of FabricAdapter. See the FabricAdapter schema for details.
}
HeightMm (v1.4+) number
(mm)
read-only
(null)
The height of the chassis.
  • This property shall represent the height of the chassis, in millimeters, as specified by the manufacturer.
HotPluggable (v1.21+) boolean read-only
(null)
An indication of whether this component can be inserted or removed while the equipment is in operation.
  • This property shall indicate whether the component can be inserted or removed while the underlying equipment otherwise remains in its current operational state. Components indicated as hot-pluggable shall allow the component to become operable without altering the operational state of the underlying equipment. Components that cannot be inserted or removed from equipment in operation, or components that cannot become operable without affecting the operational state of that equipment, shall be indicated as not hot-pluggable.
IndicatorLED (deprecated v1.14) string
(enum)
read-write
(null)
The state of the indicator LED, which identifies the chassis.
  • This property shall contain the indicator light state for the indicator light associated with this system.
For the possible property values, see IndicatorLED in Property details. Deprecated in v1.14 and later. This property has been deprecated in favor of the LocationIndicatorActive property.
Links { object The links to other resources that are related to this resource.
  • This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.
      Cables (v1.17+) [ { array An array of links to the cables connected to this chassis.
  • This property shall contain an array of links to resources of type Cable that represent the cables connected to this chassis.
            @odata.id string read-only Link to a Cable resource. See the Links section and the Cable schema for details.
      } ]
      ComputerSystems [ { array An array of links to the computer systems that this chassis directly and wholly contains.
  • This property shall contain an array of links to resources of type ComputerSystem with which this physical container is associated. If a chassis also links to a computer system to which this resource also links, this chassis shall not link to that computer system.
            @odata.id string read-only Link to a ComputerSystem resource. See the Links section and the ComputerSystem schema for details.
      } ]
      ContainedBy { object The link to the chassis that contains this chassis.
  • This property shall contain a link to a resource of type Chassis that represents the chassis that contains this chassis.
            @odata.id string read-write Link to another Chassis resource.
      }
      Contains [ { array An array of links to any other chassis that this chassis has in it.
  • This property shall contain an array of links to resources of type Chassis that represent the chassis instances that this chassis contains.
            @odata.id string read-write Link to another Chassis resource.
      } ]
      CooledBy (deprecated v1.20) [ { array An array of links to resources or objects that cool this chassis. Normally, the link is for either a chassis or a specific set of fans.
  • This property shall contain an array of links to resources or objects that cool this chassis.
Deprecated in v1.20 and later. This property has been deprecated in favor of the Fans link property, and details provided in the ThermalSubsystem resource.
            @odata.id string
(URI)
read-only The unique identifier for a resource.
  • 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.
      } ]
      Drives (v1.2+) [ { array An array of links to the drives located in this chassis.
  • This property shall contain an array of links to resources of type Drive that are in this chassis.
            @odata.id string read-only Link to a Drive resource. See the Links section and the Drive schema for details.
      } ]
      Facility (v1.11+) { object The link to the facility that contains this chassis.
  • This property shall contain a link to the resource of type Facility and shall represent the smallest facility that contains this chassis. This property shall not appear in resources that include a ContainedBy property within the Links property.
See the Facility schema for details on this property.
            @odata.id string read-write Link to a Facility resource. See the Links section and the Facility schema for details.
      }
      Fans (v1.20+) [ { array An array of links to the fans that cool this chassis.
  • This property shall contain an array of links to resources of type Fan that represent the fans that provide cooling to this chassis. This property shall not be present if the ThermalManagedByParent property contains true or if the fans are contained in the ThermalSubsystem resource for this chassis.
            @odata.id string read-only Link to a Fan resource. See the Links section and the Fan schema for details.
      } ]
      ManagedBy [ { array An array of links to the managers responsible for managing this chassis.
  • This property shall contain an array of links to resources of type Manager that manage this chassis.
            @odata.id string read-only Link to a Manager resource. See the Links section and the Manager schema for details.
      } ]
      ManagersInChassis (v1.2+) [ { array An array of links to the managers located in this chassis.
  • This property shall contain an array of links to resources of type Manager that are in this chassis.
            @odata.id string read-only Link to a Manager resource. See the Links section and the Manager schema for details.
      } ]
      Oem {} object See the OEM object definition in the Using this guide clause.
      PCIeDevices (v1.4+, deprecated v1.10 [ { array An array of links to the PCIe devices located in this chassis.
  • This property shall contain an array of li