Struct UpdateService 

pub struct UpdateService<B: Bmc> { /* private fields */ }

Update service.

Provides functions to access firmware and software inventory, and perform update actions.

Implementations

impl<B: Bmc> UpdateService<B>

pub fn raw(&self) -> Arc<UpdateServiceSchema>

Get the raw schema data for this update service.

Returns an Arc to the underlying schema, allowing cheap cloning and sharing of the data.

pub async fn firmware_inventories( &self, ) -> Result<Option<Vec<SoftwareInventory<B>>>, Error<B>>

List all firmware inventory items.

Errors

Returns an error if:

• The update service does not have a firmware inventory collection
• Fetching firmware inventory data fails

pub async fn software_inventories( &self, ) -> Result<Option<Vec<SoftwareInventory<B>>>, Error<B>>

List all software inventory items.

Errors

Returns an error if:

• The update service does not have a software inventory collection
• Fetching software inventory data fails

pub async fn simple_update( &self, image_uri: String, transfer_protocol: Option<TransferProtocolType>, targets: Option<Vec<String>>, username: Option<String>, password: Option<String>, force_update: Option<bool>, stage: Option<bool>, local_image: Option<bool>, exclude_targets: Option<Vec<String>>, ) -> Result<ModificationResponse<()>, Error<B>>

where B::Error: ActionError,

Perform a simple update with the specified image URI.

This action updates software components by downloading and installing a software image from the specified URI.

Arguments

• image_uri - The URI of the software image to install
• transfer_protocol - Optional network protocol to use for retrieving the image
• targets - Optional list of URIs indicating where to apply the update
• username - Optional username for accessing the image URI
• password - Optional password for accessing the image URI
• force_update - Whether to bypass update policies (e.g., allow downgrade)
• stage - Whether to stage the image for later activation instead of immediate installation
• local_image - An indication of whether the service adds the image to the local image store
• exclude_targets - An array of URIs that indicate where not to apply the update image

Errors

Returns an error if:

• The update service does not support the SimpleUpdate action
• The action execution fails

pub async fn start_update(&self) -> Result<ModificationResponse<()>, Error<B>>

where B::Error: ActionError,

Start updates that have been previously invoked with an OperationApplyTime of OnStartUpdateRequest.

Errors

Returns an error if:

• The update service does not support the StartUpdate action
• The action execution fails

pub async fn update( &self, update: &UpdateServiceUpdate, ) -> Result<ModificationResponse<Self>, Error<B>>

Update this service with deprecated generated UpdateServiceUpdate fields.

Use this for standard HttpPushUriOptions, HttpPushUriTargets, and related busy flags before or after an HttpPushUri upload.

Errors

Returns an error if the update request fails.

pub async fn http_push_uri_update_from_reader<U, R>( &self, update_stream: UploadStream<U>, upload_timeout: Duration, ) -> Result<ModificationResponse<R>, Error<B>>

where U: UploadReader, R: Send + Sync + for<'de> Deserialize<'de>,

Upload a raw binary stream using this service’s deprecated HttpPushUri.

The stream is sent as application/octet-stream without multipart UpdateParameters.

Errors

Returns an error if HttpPushUri is absent or the upload fails.

pub async fn http_push_uri_update<U, R>( &self, request: HttpPushUriUpdateRequest<U>, ) -> Result<ModificationResponse<R>, Error<B>>

where U: UploadReader, R: Send + Sync + for<'de> Deserialize<'de>,

Perform a raw binary upload using this service’s deprecated HttpPushUri.

Errors

Returns an error if HttpPushUri is absent or the upload fails.

pub async fn multipart_update_from_reader<U, V, R>( &self, update_parameters: &V, update_stream: DataStream<U>, upload_timeout: Duration, ) -> Result<ModificationResponse<R>, Error<B>>

where U: UploadReader, V: Send + Sync + Serialize, R: Send + Sync + for<'de> Deserialize<'de>,

Upload a named stream using this service’s MultipartHttpPushUri.

Prefer the generated MultipartUpdateParameters type. A generic payload is accepted for platform fields that are not generated.

Errors

Returns an error if MultipartHttpPushUri is absent or the upload fails.

pub async fn multipart_update<U, V, R>( &self, request: MultipartUpdateRequest<'_, U, V>, ) -> Result<ModificationResponse<R>, Error<B>>

where U: UploadReader, V: Send + Sync + Serialize, R: Send + Sync + for<'de> Deserialize<'de>,

Perform a multipart upload using this service’s MultipartHttpPushUri.

Use this method when the request needs optional OEM multipart parts.

Errors

Returns an error if MultipartHttpPushUri is absent or the upload fails.

Trait Implementations

impl<B: Bmc> Resource for UpdateService<B>

fn resource_ref(&self) -> &ResourceSchema

Required function. Must be implemented for Redfish resources.

fn id(&self) -> ResourceIdRef<'_>

Identifier of the resource.

fn name(&self) -> ResourceNameRef<'_>

Name of the resource.

fn description(&self) -> Option<ResourceDescriptionRef<'_>>

Description of the resource.

fn oem_id(&self) -> Option<OemIdentifier<&str>>

OEM identifier if present in the resource.

fn odata_id(&self) -> &ODataId

OData identifier of the resource.