UpdateService

SoftwareInventory 1.12.0⁠


Version	v1.12
Release	2025.2

Description⁠

The SoftwareInventory schema contains an inventory of software components. This can include software components such as BIOS, BMC firmware, firmware for other devices, system drivers, or provider software.

URIs⁠

/redfish/v1/UpdateService/FirmwareInventory/{SoftwareInventoryId}
/redfish/v1/UpdateService/SoftwareInventory/{SoftwareInventoryId}

Properties⁠

Property	Type	Attributes	Notes
Actions {	object		The available actions for this resource.
#SoftwareInventory.Activate (v1.12+) {}	object		This action activates this software inventory instance. For more information, see the Actions section below.
}
Active (v1.12+)	boolean	read-only (null)	This image is active on one or more devices.
AdditionalVersions (v1.7+) {	object		The additional versions of this software.
Bootloader (v1.7+)	string	read-only (null)	The bootloader version contained in this software, such as U-Boot or UEFI.
BootParameters (v1.11+)	string	read-only (null)	The version of the configuration file that contains the initial boot parameters of this software, such as parameters for U-Boot.
FactoryConfiguration (v1.11+)	string	read-only (null)	The version of the configuration that contains the factory default runtime configuration parameters of this software.
Kernel (v1.7+)	string	read-only (null)	The kernel version contained in this software.
Microcode (v1.7+)	string	read-only (null)	The microcode version contained in this software, such as processor microcode.
Oem (v1.7+) {}	object		The OEM extension property. See the Resource schema for details on this property.
OSDistribution (v1.8+)	string	read-only (null)	The operating system name of this software.
}
AssociatedPhysicalContext (v1.10+)	string (enum)	read-only	The area or device to which the software applies. Used to distinguish when different parts of a device have different software components. For the possible property values, see AssociatedPhysicalContext in Property details.
Links (v1.12+) {	object		The links to other resources that are related to this resource.
ActiveTargets (v1.12+) [ {	array		An array of devices where this software image is currently running.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
StagedTargets (v1.12+) [ {	array		An array of devices where this software image is staged and ready to be activated.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
}
LowestSupportedVersion (v1.1+)	string	read-only (null)	The lowest supported version of this software.
Manufacturer (v1.2+)	string	read-only (null)	The manufacturer or producer of this software.
Measurement (v1.4+, deprecated v1.6) {}	object		A DSP0274-defined measurement block. See the SoftwareInventory.v1_13_0 schema for details on this property. Deprecated in v1.6 and later. This property has been deprecated in favor of the `ComponentIntegrity` resource.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
RelatedItem (v1.1+) [ {	array		An array of links to resources or objects that represent devices to which this software inventory applies.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]
ReleaseDate (v1.2+)	string (date-time)	read-only (null)	The release date of this software.
ReleaseType (v1.10+)	string (enum)	read-only (null)	The type of release. For the possible property values, see ReleaseType in Property details.
ResetRequiredOnUpdate (v1.12+)	boolean	read-only (null)	An indication of whether a reset is required to apply an update to this software.
SoftwareId (v1.1+)	string	read-only	The implementation-specific label that identifies this software.
Staged (v1.12+)	boolean	read-only (null)	This image is ready to be activated to one or more devices.
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
UefiDevicePaths (v1.1+) [ ]	array (string, null)	read-only	The list of UEFI device paths of the components associated with this software inventory item.
Updateable	boolean	read-only (null)	An indication of whether the update service can update this software.
Version	string	read-only (null)	The version of this software.
VersionScheme (v1.9+)	string (enum)	read-only (null)	The format of the version. For the possible property values, see VersionScheme in Property details.
WriteProtected (v1.3+)	boolean	read-write (null)	Indicates if the software is write-protected.

Actions⁠

Activate (v1.12+)⁠

Description

This action activates this software inventory instance.

Action URI

{Base URI of target resource}/Actions/SoftwareInventory.Activate

Action parameters

Parameter Name	Type	Attributes	Notes
Targets [ {	array	optional	The target devices to activate this software image. If not specified, the service activates this software image on all applicable devices.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]

Request Example

{
    "Targets": [
        {
            "@odata.id": "/redfish/v1/Managers/1"
        }
    ]
}

Property details⁠

AssociatedPhysicalContext⁠

The area or device to which the software applies. Used to distinguish when different parts of a device have different software components.

string	Description
Accelerator	An accelerator.
ACInput	An AC electrical input or input-related circuit.
ACMaintenanceBypassInput	An AC electrical maintenance bypass input.
ACOutput	An AC electrical output or output-related circuit.
ACStaticBypassInput	An AC electrical static bypass input.
ACUtilityInput	An AC electrical utility input.
ASIC	An ASIC device, such as a networking chip or chipset component.
Back	The back of the chassis.
Backplane	A backplane within the chassis.
Battery	A battery.
Board	A circuit board.
Chassis	The entire chassis.
ComputeBay	A compute bay.
CoolingSubsystem	The entire cooling, or air and liquid, subsystem.
CPU	A processor (CPU).
CPUSubsystem	The entire processor (CPU) subsystem.
DCBus	A DC electrical bus.
Exhaust	The air exhaust point or points or region of the chassis.
ExpansionBay	An expansion bay.
ExpansionSubsystem	A group of expansion bays.
Fan	A fan.
Filter	A filter.
FPGA	An FPGA.
Front	The front of the chassis.
GPU	A graphics processor (GPU).
GPUSubsystem	The entire graphics processor (GPU) subsystem.
Intake	The air intake point or points or region of the chassis.
LiquidInlet	The liquid inlet point of the chassis.
LiquidOutlet	The liquid outlet point of the chassis.
Lower	The lower portion of the chassis.
Manager	A management controller, such as a BMC (baseboard management controller).
Memory	A memory device.
MemorySubsystem	The entire memory subsystem.
Motor	A motor.
NetworkBay	A networking bay.
NetworkingDevice	A networking device.
PowerOutlet	An electrical outlet.
PowerSubsystem	The entire power subsystem.
PowerSupply	A power supply.
PowerSupplyBay	A power supply bay.
Pump	A pump.
Rectifier	A rectifier device.
Reservoir	A reservoir.
Room	The room.
StorageBay	A storage bay.
StorageDevice	A storage device.
StorageSubsystem	A storage subsystem.
Switch	A switch device.
SystemBoard	The system board (PCB).
Transceiver	A transceiver.
Transformer	A transformer.
TrustedModule	A trusted module.
Upper	The upper portion of the chassis.
VoltageRegulator	A voltage regulator device.

ReleaseType⁠

The type of release.

string	Description
Other	The Redfish service does not have enough data to make a determination about this release.
Production	This release is ready for use in production environments.
Prototype	This release is intended for development or internal use.

VersionScheme⁠

The format of the version.

string	Description
DotIntegerNotation	Version formatted as dot-separated integers.
OEM	Version follows OEM-defined format.
SemVer	Version follows Semantic Versioning 2.0 rules.

Example response⁠

{
    "@odata.type": "#SoftwareInventory.v1_13_0.SoftwareInventory",
    "Id": "BMC",
    "Name": "Contoso BMC Firmware",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "Updateable": true,
    "Manufacturer": "Contoso",
    "ReleaseDate": "2017-08-22T12:00:00",
    "Version": "1.45.455b66-rev4",
    "SoftwareId": "1624A9DF-5E13-47FC-874A-DF3AFF143089",
    "LowestSupportedVersion": "1.30.367a12-rev1",
    "UefiDevicePaths": [
        "BMC(0x1,0x0ABCDEF)"
    ],
    "RelatedItem": [
        {
            "@odata.id": "/redfish/v1/Managers/1"
        }
    ],
    "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/BMC"
}

UpdateService 1.16.0⁠


Version	v1.16
Release	2025.2

Description⁠

The UpdateService schema describes the update service and the properties for the service itself with links to collections of firmware and software inventory. The update service also provides methods for updating software and firmware of the resources in a Redfish service.

URIs⁠

/redfish/v1/UpdateService

Properties⁠

Property	Type	Attributes	Notes
Actions {	object		The available actions for this resource.
#UpdateService.Activate (v1.16+) {}	object		This action activates specified software inventory instance. For more information, see the Actions section below.
#UpdateService.GenerateSSHIdentityKeyPair (v1.13+) {}	object		This action generates a new SSH identity key-pair to be used with the `UpdateService` resource. The generated public key is stored in the `Key` resource referenced by the `PublicIdentitySSHKey` property. Any existing key-pair is deleted and replaced by the new key-pair. For more information, see the Actions section below.
#UpdateService.RemoveSSHIdentityKeyPair (v1.13+) {}	object		This action removes the SSH identity key-pair used with the `UpdateService` resource. For more information, see the Actions section below.
#UpdateService.SimpleUpdate {}	object		This action updates software components. For more information, see the Actions section below.
#UpdateService.StartUpdate (v1.7+) {}	object		This action starts updating all images that have been previously invoked using an `OperationApplyTime` value of `OnStartUpdateRequest`. For more information, see the Actions section below.
}
ClientCertificates (v1.10+) {}	object		The link to a collection of client identity certificates provided to the server referenced by the `ImageURI` parameter in `SimpleUpdate`.
FirmwareInventory {}	object		An inventory of firmware.
HttpPushUri (v1.1+, deprecated v1.15)	string (URI)	read-only	The URI used to perform an HTTP or HTTPS push update to the update service. The format of the message is vendor-specific. Deprecated in v1.15 and later. This property has been deprecated in favor of the `MultipartHttpPushUri` property.
HttpPushUriOptions (v1.4+, deprecated v1.15) {	object		The options for `HttpPushUri`-provided software updates. Deprecated in v1.15 and later. This property has been deprecated in favor of the update parameters used with `MultipartHttpPushUri`-provided software updates.
ForceUpdate (v1.11+)	boolean	read-write	An indication of whether the service should bypass update policies when applying the `HttpPushUri`-provided image.
HttpPushUriApplyTime (v1.4+) {	object		The settings for when to apply `HttpPushUri`-provided firmware.
ApplyTime (v1.4+)	string (enum)	read-write	The time when to apply the `HttpPushUri`-provided software update. For the possible property values, see ApplyTime in Property details.
MaintenanceWindowDurationInSeconds (v1.4+)	integer (s)	read-write	The expiry time, in seconds, of the maintenance window.
MaintenanceWindowStartTime (v1.4+)	string (date-time)	read-write	The start time of a maintenance window.
}
}
HttpPushUriOptionsBusy (v1.4+, deprecated v1.15)	boolean	read-write (null)	An indication of whether a client has reserved the `HttpPushUriOptions` properties for software updates. Deprecated in v1.15 and later. This property has been deprecated in favor of `MultipartHttpPushUri`-provided software updates.
HttpPushUriTargets (v1.2+, deprecated v1.15) [ ]	array (URI) (string, null)	read-write	An array of URIs that indicate where to apply the update image. Deprecated in v1.15 and later. This property has been deprecated in favor of the update parameters used with `MultipartHttpPushUri`-provided software updates.
HttpPushUriTargetsBusy (v1.2+, deprecated v1.15)	boolean	read-write (null)	An indication of whether any client has reserved the `HttpPushUriTargets` property. Deprecated in v1.15 and later. This property has been deprecated in favor of `MultipartHttpPushUri`-provided software updates.
MaxImageSizeBytes (v1.5+)	integer (By)	read-only (null)	The maximum size in bytes of the software update image that this service supports.
MultipartHttpPushUri (v1.6+)	string (URI)	read-only	The URI used to perform a Redfish Specification-defined multipart HTTP or HTTPS push update to the update service.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
PublicIdentitySSHKey (v1.13+) {}	object		A link to the public key that is used with the `SimpleUpdate` action for the key-based authentication. The GenerateSSHIdentityKeyPair and RemoveSSHIdentityKeyPair are used to update the key for the `SimpleUpdate` action.
RemoteServerCertificates (v1.9+) {}	object		The link to a collection of server certificates for the server referenced by the `ImageURI` parameter in SimpleUpdate.
RemoteServerSSHKeys (v1.12+) {}	object		The link to a collection of keys that can be used to authenticate the server referenced by the `ImageURI` parameter in `SimpleUpdate`.
ServiceEnabled	boolean	read-write (null)	An indication of whether this service is enabled.
SoftwareInventory {}	object		An inventory of software.
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.
SupportedUpdateImageFormats (v1.13+) [ ]	array (string (enum))	read-only (null)	The image format types supported by the service. For the possible property values, see SupportedUpdateImageFormats in Property details.
UpdateServiceCapabilities (v1.16+) {}	object		A link to the capabilities of the update service.
VerifyRemoteServerCertificate (v1.9+)	boolean	read-write (null)	An indication of whether the service will verify the certificate of the server referenced by the `ImageURI` parameter in `SimpleUpdate` prior to sending the transfer request.
VerifyRemoteServerSSHKey (v1.12+)	boolean	read-write (null)	An indication of whether the service will verify the SSH key of the server referenced by the `ImageURI` parameter in `SimpleUpdate` prior to sending the transfer request.

Actions⁠

Activate (v1.16+)⁠

Description

This action activates specified software inventory instance.

Action URI

{Base URI of target resource}/Actions/UpdateService.Activate

Action parameters

Parameter Name	Type	Attributes	Notes
Targets [ {	array	required	The target software inventory instances to activate on staged devices.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
} ]

Request Example

{
    "Targets": [
        {
            "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/BIOS-v120"
        },
        {
            "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory/BMC-v990"
        }
    ]
}

GenerateSSHIdentityKeyPair (v1.13+)⁠

Description

This action generates a new SSH identity key-pair to be used with the UpdateService resource. The generated public key is stored in the Key resource referenced by the PublicIdentitySSHKey property. Any existing key-pair is deleted and replaced by the new key-pair.

Action URI

{Base URI of target resource}/Actions/UpdateService.GenerateSSHIdentityKeyPair

Action parameters

Parameter Name	Type	Attributes	Notes
Curve	string (enum)	optional	The curve to use with the SSH key if the `KeyType` parameter contains `ECDSA`. For the possible property values, see Curve in Property details.
KeyLength	integer	optional	The length of the SSH key, in bits, if the `KeyType` parameter contains `RSA`.
KeyType	string (enum)	required	The type of SSH key. For the possible property values, see KeyType in Property details.

Request Example

{
    "KeyType": "Ed25519"
}

RemoveSSHIdentityKeyPair (v1.13+)⁠

Description

This action removes the SSH identity key-pair used with the UpdateService resource.

Action URI

{Base URI of target resource}/Actions/UpdateService.RemoveSSHIdentityKeyPair

Action parameters

This action takes no parameters.

Request Example

{}

SimpleUpdate⁠

Description

This action updates software components.

Action URI

{Base URI of target resource}/Actions/UpdateService.SimpleUpdate

Action parameters

Parameter Name	Type	Attributes	Notes
ForceUpdate (v1.11+)	boolean	optional	An indication of whether the service should bypass update policies when applying the provided image. The default is `false`.
ImageURI	string (URI)	required	The URI of the software image to install.
Password (v1.4+)	string	optional	The password to access the URI specified by the `ImageURI` parameter.
Stage (v1.16+)	boolean	optional	An indication of whether the service stages the image on target devices for a client to activate at a later time.
Targets (v1.2+) [ ]	array (URI) (string)	optional	An array of URIs that indicate where to apply the update image.
TransferProtocol	string (enum)	optional	The network protocol that the update service uses to retrieve the software image file located at the URI specified by the `ImageURI` parameter. This parameter is ignored if the URI provided in `ImageURI` contains a scheme. For the possible property values, see TransferProtocol in Property details.
Username (v1.4+)	string	optional	The username to access the URI specified by the `ImageURI` parameter.

Request Example

{
    "ImageURI": "https://images.contoso.org/bmc_0260_2021.bin"
}

StartUpdate (v1.7+)⁠

Description

This action starts updating all images that have been previously invoked using an OperationApplyTime value of OnStartUpdateRequest.

Action URI

{Base URI of target resource}/Actions/UpdateService.StartUpdate

Action parameters

This action takes no parameters.

Property details⁠

ApplyTime⁠

The time when to apply the HttpPushUri-provided software update.

string	Description
AtMaintenanceWindowStart	Apply during an administrator-specified maintenance window.
Immediate	Apply immediately.
InMaintenanceWindowOnReset	Apply after a reset but within an administrator-specified maintenance window.
OnReset	Apply on a reset.
OnStartUpdateRequest (v1.11+)	Apply when the `StartUpdate` action of the update service is invoked.
OnTargetReset (v1.14+)	Apply when the target for the software update is reset. Targets include devices, services, and systems.

Curve⁠

The curve to use with the SSH key if the KeyType parameter contains ECDSA.

string	Description
NISTB233	NIST B-233.
NISTB409	NIST B-409.
NISTK163	NIST K-163.
NISTK233	NIST K-233.
NISTK283	NIST K-283.
NISTK409	NIST K-409.
NISTP192	NIST P-192.
NISTP224	NIST P-224.
NISTP256	NIST P-256.
NISTP384	NIST P-384.
NISTP521	NIST P-521.
NISTT571	NIST T-571.

idRef⁠


@odata.id	string (URI)	read-only	The unique identifier for a resource.

KeyType⁠

The type of SSH key.

string	Description
DSA	DSA.
ECDSA	ECDSA.
Ed25519	Ed25519.
RSA	RSA.

SupportedUpdateImageFormats⁠

The image format types supported by the service.

string	Description
PLDMv1_0	A PLDM for Firmware Update Specification v1.0 image.
PLDMv1_1	A PLDM for Firmware Update Specification v1.1 image.
PLDMv1_2	A PLDM for Firmware Update Specification v1.2 image.
PLDMv1_3	A PLDM for Firmware Update Specification v1.3 image.
UEFICapsule	The image conforms to the capsule format described in the UEFI Specification.
VendorDefined	A vendor-defined image.

TransferProtocol⁠

The network protocol that the update service uses to retrieve the software image file located at the URI specified by the ImageURI parameter. This parameter is ignored if the URI provided in ImageURI contains a scheme.

string	Description
CIFS	Common Internet File System (CIFS).
FTP	File Transfer Protocol (FTP).
HTTP	Hypertext Transfer Protocol (HTTP).
HTTPS	Hypertext Transfer Protocol Secure (HTTPS).
NFS (v1.3+)	Network File System (NFS).
NSF (deprecated v1.3)	Network File System (NFS). Deprecated in v1.3 and later. This value has been deprecated in favor of NFS.
OEM	A manufacturer-defined protocol.
SCP	Secure Copy Protocol (SCP).
SFTP (v1.1+)	SSH File Transfer Protocol (SFTP).
TFTP	Trivial File Transfer Protocol (TFTP).

Example response⁠

{
    "@odata.type": "#UpdateService.v1_17_0.UpdateService",
    "Id": "UpdateService",
    "Name": "Update service",
    "Status": {
        "State": "Enabled",
        "Health": "OK",
        "HealthRollup": "OK"
    },
    "ServiceEnabled": true,
    "HttpPushUri": "/FWUpdate",
    "FirmwareInventory": {
        "@odata.id": "/redfish/v1/UpdateService/FirmwareInventory"
    },
    "SoftwareInventory": {
        "@odata.id": "/redfish/v1/UpdateService/SoftwareInventory"
    },
    "Actions": {
        "#UpdateService.SimpleUpdate": {
            "target": "/redfish/v1/UpdateService/Actions/UpdateService.SimpleUpdate",
            "@Redfish.ActionInfo": "/redfish/v1/UpdateService/SimpleUpdateActionInfo"
        }
    },
    "@odata.id": "/redfish/v1/UpdateService"
}

SoftwareInventory 1.12.0⁠​

Description⁠​

URIs⁠​

Properties⁠​

Actions⁠​

Activate (v1.12+)⁠​

Property details⁠​

AssociatedPhysicalContext⁠​

ReleaseType⁠​

VersionScheme⁠​

Example response⁠​

UpdateService 1.16.0⁠​

Description⁠​

URIs⁠​

Properties⁠​

Actions⁠​

Activate (v1.16+)⁠​

GenerateSSHIdentityKeyPair (v1.13+)⁠​

RemoveSSHIdentityKeyPair (v1.13+)⁠​

SimpleUpdate⁠​

StartUpdate (v1.7+)⁠​

Property details⁠​

ApplyTime⁠​

Curve⁠​

idRef⁠​

KeyType⁠​

SupportedUpdateImageFormats⁠​

TransferProtocol⁠​

Example response⁠​

SoftwareInventory 1.12.0⁠

Description⁠

URIs⁠

Properties⁠

Actions⁠

Activate (v1.12+)⁠

Property details⁠

AssociatedPhysicalContext⁠

ReleaseType⁠

VersionScheme⁠

Example response⁠

UpdateService 1.16.0⁠

Description⁠

URIs⁠

Properties⁠

Actions⁠

Activate (v1.16+)⁠

GenerateSSHIdentityKeyPair (v1.13+)⁠

RemoveSSHIdentityKeyPair (v1.13+)⁠

SimpleUpdate⁠

StartUpdate (v1.7+)⁠

Property details⁠

ApplyTime⁠

Curve⁠

idRef⁠

KeyType⁠

SupportedUpdateImageFormats⁠

TransferProtocol⁠

Example response⁠