Skip to main content

Task 11: SBE Update Import

Implementation Cluster Deployment

DOCUMENT CATEGORY: Implementation Runbook
SCOPE: Azure Local clusters whose hardware vendor ships a Solution Builder Extension (SBE)
PURPOSE: Import the SBE files into the cluster's update service so the update shows as Ready
MASTER REFERENCE: Update Azure Local by using PowerShell

Status: Active

When an update reports AdditionalContentRequired, the SBE installed on the cluster has no download connector for this cluster (for example Dell without support credentials on the cluster). The cluster then needs the three SBE files from your hardware vendor: the discovery manifest, the inventory file and the payload zip. This task imports them. A vendor whose connector and credentials are set on the cluster (Set-SolutionExtensionSecretLocation) shows the update as Ready and needs no import.

The package is the one you downloaded before the deployment: it is on the share that hardware.sbe.source_path names. For the update flow around this step, see Update management and SBE. The steps in order: check for updates, this import when an update says AdditionalContentRequired, start the update, then follow it.


Values from infrastructure.yml​

The values for this task come from infrastructure.yml (schema 5). Every key, with its type, default and example, is in the variables reference.

KeyWhat the script does with it
hardware.sbe.source_pathThe share (or folder) with the downloaded package. When it is empty the script reads hardware.sbe.bundle_path
hardware.sbe.source_usernameThe account that reads the share, when the account running the script cannot
hardware.sbe.source_passwordThe Key Vault reference (keyvault://<vault>/<secret>) of that account's password. It is read into memory for the read and not written anywhere
hardware.sbe.requirementWhen it is not_applicable (with hardware.sbe.not_applicable_reason), the script says there is nothing to import and stops
hardware.sbe.publisher, hardware.sbe.family, hardware.sbe.versionPick the package when more than one is on the share. Set family and version when the script reports that it cannot choose a single package
hardware.modelMatches the package to the hardware model

Execution Options​

PowerShell on a cluster machine​

When to use: You know the SBE files and run the import yourself

  1. Sign in to a machine of the cluster as the deployment user. The share must be readable from that machine.
  2. Copy the three SBE files (SBE_Discovery_<Manufacturer>.xml, SBE_<Manufacturer>_<Family>_<Version>.xml and the matching .zip) into a folder of the infrastructure volume. Learn uses C:\ClusterStorage\Infrastructure_1\Shares\SU1_Infrastructure_1\import.
  3. Check the zip against the PackageHash of the discovery manifest.
  4. Import the files, then read the update state until the update is Ready. Discovery is asynchronous.
$import = 'C:\ClusterStorage\Infrastructure_1\Shares\SU1_Infrastructure_1\import'
New-Item -ItemType Directory -Force -Path $import | Out-Null
Copy-Item -LiteralPath '\\<server>\<share>\<SBE file>' -Destination $import -Force # once per file
Get-FileHash -Algorithm SHA256 -Path "$import\<SBE zip>"
Add-SolutionUpdate -SourceFolder $import
Get-SolutionUpdate | Format-Table DisplayName, PackageType, Version, SbeVersion, State

An update that reports Invalid does not match the hardware model or the family. Import only the SBE family that matches the nodes.

Validation​

  • Get-SolutionUpdate lists the update with state Ready
  • The SBE version and family match the package you imported

Troubleshooting​

IssueCauseResolution
The script says hardware.sbe.source_path is emptyNo share is setDownload the vendor package and set hardware.sbe.source_path
The script cannot read the shareThe account running the script has no read accessSet hardware.sbe.source_username and hardware.sbe.source_password, or run it as an account that can read the share
The script cannot choose a single packageMore than one package is on the shareSet hardware.sbe.family and hardware.sbe.version
The script says a file is missingThe package on the share is incompleteDownload the package again from the vendor: it needs one discovery manifest, the inventory file and the zip
The update state is InvalidThe package does not match the hardware model or familyImport only the SBE family that matches the nodes

PreviousUpNext
Task 10: Enable External StoragePhase 06 IndexPart 5: Operational Foundations

Version Control​

VersionDateAuthorChanges
1.0.02026-11-15Azure Local CloudInitial release