Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

UpdateService

Description

This resource shall represent an update service and the properties that affect the service itself for a Redfish implementation.

Fields

FieldTypeDescription
ClientCertificatesCertificateCollectionThis property shall contain a link to a resource collection of type `CertificateCollection` that represents the client identity certificates that are provided to the server referenced by the `ImageURI` parameter in `SimpleUpdate` as part of TLS handshaking.
DescriptionDescription
FirmwareInventorySoftwareInventoryCollectionThis property shall contain a link to a resource collection of type `SoftwareInventoryCollection`. The resource collection should contain the set of software components generally referred to as platform firmware or that does not execute within a host operating system. Software in this collection is generally updated using platform-specific methods or utilities.
HttpPushUristringThis property shall contain a URI at which the update service supports an HTTP or HTTPS `POST` of a software image for the purpose of installing software contained within the image. Access to this URI shall require the same privilege as access to the update service. If the service requires the `Content-Length` header for `POST` requests to this URI, the service should return HTTP `411 Length Required` status code if the client does not include this header in the `POST` request. The value of this property should not contain a URI of a Redfish resource. See the ‘Redfish-defined URIs and relative reference rules’ clause in the Redfish Specification.
HttpPushUriOptionsHttpPushUriOptionsThis property shall contain options and requirements of the service for `HttpPushUri`-provided software updates.
HttpPushUriOptionsBusybooleanThis property shall indicate whether a client uses the `HttpPushUriOptions` properties for software updates. When a client uses any `HttpPushUriOptions` properties for software updates, it should set this property to `true`. When a client no longer uses `HttpPushUriOptions` properties for software updates, it should set this property to `false`. This property can provide multiple clients a way to negotiate ownership of `HttpPushUriOptions` properties. Clients can use this property to determine whether another client uses `HttpPushUriOptions` properties for software updates. This property has no functional requirements for the service.
NameName
OemOemThis property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements.
PublicIdentitySSHKeyKeyThis property shall contain a link to a resource of type `Key` that represents the public key that is used with the `SimpleUpdate` action for the key-based authentication. This property shall not be present if a key-pair is not available.
RemoteServerCertificatesCertificateCollectionThis property shall contain a link to a resource collection of type `CertificateCollection` that represents the server certificates for the server referenced by the `ImageURI` parameter in `SimpleUpdate`. If `VerifyRemoteServerCertificate` is `true`, services shall compare the certificates in this collection with the certificate obtained during handshaking with the image server in order to verify the identity of the image server prior to transferring the image. If the server cannot be verified, the service shall not send the transfer request. If `VerifyRemoteServerCertificate` is `false`, the service shall not perform certificate verification with certificates in this collection. Regardless of the contents of this collection, services may perform additional verification based on other factors, such as the configuration of the `SecurityPolicy` resource.
RemoteServerSSHKeysKeyCollectionThis property shall contain a link to a resource collection of type `KeyCollection` that represents the server SSH keys for the server referenced by the `ImageURI` Parameter in `SimpleUpdate`. If `VerifyRemoteServerSSHKey` is `true`, services shall compare the keys in this collection with the key obtained during handshaking with the image server in order to verify the identity of the image server prior to transferring the image. If the server cannot be verified, the service shall not send the transfer request. If `VerifyRemoteServerSSHKey` is `false`, the service shall not perform key verification with keys in this collection.
ServiceEnabledbooleanThis property shall indicate whether this service is enabled.
SoftwareInventorySoftwareInventoryCollectionThis property shall contain a link to a resource collection of type `SoftwareInventoryCollection`. The resource collection should contain the set of software components executed in the context of a host operating system. This can include device drivers, applications, or offload workloads. Software in this collection is generally updated using operating system-centric methods.
StatusStatusThis property shall contain any status or health properties of the resource.
SupportedUpdateImageFormatsarrayThis property shall contain the image format types supported by the service.
VerifyRemoteServerCertificatebooleanThis property shall indicate whether the service will verify the certificate of the server referenced by the `ImageURI` parameter in `SimpleUpdate` prior to sending the transfer request with the certificates found in the collection referenced by the `RemoteServerCertificates` property. If this property is not supported by the service, it shall be assumed to be `false`. This property should default to `false` in order to maintain compatibility with older clients. Regardless of the value of this property, services may perform additional verification based on other factors, such as the configuration of the `SecurityPolicy` resource.
VerifyRemoteServerSSHKeybooleanThis property shall indicate whether the service will verify the SSH key of the server referenced by the `ImageURI` parameter in `SimpleUpdate` prior to sending the transfer request with the keys found in the collection referenced by the `RemoteServerSSHKeys` property. If this property is not supported by the service, it shall be assumed to be `false`. This property should default to `false` in order to maintain compatibility with older clients.