loading

Introduction & Configuration

Learn about SBE and select your setup

This guide walks you through installing DataON Solution Builder Extension (SBE) for the first time on Azure Local 23H2. First-time installation requires manual package download from the portal, followed by PowerShell-based installation. After successful installation, you can optionally configure automatic downloads for future updates. The entire process includes cluster validation, health checks, package import, installation execution, and optional setup of the download connector for streamlined maintenance.

Configuration Options
Option 1

Manual file import method (Required for first-time installation)

Works in offline environments
Full control over package versions
Required for initial SBE setup
Compatible with private/pre-release builds

Connect & Discover Updates

Establish connection and discover available updates

Prerequisites
Connect to Your Azure Local

Open a remote PowerShell session to one machine in the system using the deployment user account.

PowerShell Commands
$cred = Get-Credential
Enter-PSSession -ComputerName "{{CLUSTER_NODE}}" -Credential $cred
  • Sign in with the deployment user account created during Active Directory prep.
Confirm Software and Verify System Health

Ensure the system is on Azure Local 2311+ and is healthy before proceeding.

PowerShell Commands
whoami
Get-SolutionUpdateEnvironment
Discover Available Updates

List update candidates and inspect details of the one you plan to install.

PowerShell Commands
Get-SolutionUpdate | Where-Object {$_.State -like "Ready*" -or $_.State -like "Additional*"} | FL DisplayName, Description, ResourceId, State, PackageType
Get-SolutionUpdate | FL DisplayName, Description, ResourceId, State, PackageType
$Update = Get-SolutionUpdate -Id
$Update.ComponentVersions
  • You may see both Solution and SBE (Solution Builder Extension) items.
  • If the expected update isn't Ready, remove filters to see non-ready states.

Download SBE Packages

Required Choose your download method

Select how you want to download the SBE packages. You only need to choose one method.

Manual Import

Download and import SBE packages manually

Required Files

Every SBE package includes three files:

# Generic file pattern (family and version vary by your system)
  1. SBE_Discovery_DataON.xml
  2. SBE_DataON_<family>_<version>.xml
  3. SBE_DataON_<family>_<version>.zip
# Example with latest version (AZL8000i-4.2.2510.810):
  1. SBE_Discovery_DataON.xml
  2. SBE_DataON_AZL8000i_4.2.2510.810.xml
  3. SBE_DataON_AZL8000i_4.2.2510.810.zip
Actual Files for Your Selection

View the exact files available for the selected hardware and version. Access requires portal login with download permissions.

Select a System to View Files

Choose a hardware family and version (or log in) to load the exact files available for download.

File Access Required

Register a cluster to access and download SBE package files.

Import
PowerShell Commands
New-Item C:\ClusterStorage\Infrastructure_1\Shares\SU1_Infrastructure_1\import -ItemType Directory
Add-SolutionUpdate -SourceFolder C:\ClusterStorage\Infrastructure_1\Shares\SU1_Infrastructure_1\import

Check Update Readiness

Verify packages are imported and run health checks

Follow these steps to prepare for SBE installation by downloading packages and running readiness checks.

Step 1: Check Update Availability

First, verify that the SBE update is in 'Ready' state before proceeding with preparation.

PowerShell Commands
Get-SolutionUpdate | Where-Object {$_.PackageType -eq 'SBE'} | ft Version,State,UpdateStateProperties,HealthState
Important: Ensure the State shows 'Ready' before proceeding to the next step. If not Ready, wait for package discovery or import to complete.
Step 2: Start Preparation (PrepareOnly)

Once the update is in 'Ready' state, start the preparation process to download packages and run readiness checks without starting installation.

PowerShell Commands
Get-SolutionUpdate | Where-Object {$_.State -imatch "Ready" -and $_.PackageType -eq "SBE"} | Sort-Object -Property ResourceID -Descending | Select-Object -First 1 | Start-SolutionUpdate -PrepareOnly
Command Options:
  • Recommended (above): Automatically selects the latest Ready SBE package by ResourceID
  • Alternative - Specific Version:
    Get-SolutionUpdate | Where-Object {$_.PackageType -eq 'SBE' -and $_.State -eq 'Ready' -and $_.Sbeversion -eq '<version>' } | Start-SolutionUpdate -PrepareOnly
    Example with version :
    Get-SolutionUpdate | Where-Object {$_.PackageType -eq 'SBE' -and $_.State -eq 'Ready' -and $_.Sbeversion -eq '' } | Start-SolutionUpdate -PrepareOnly
If SBE packages are imported already with Add-SolutionUpdate, PrepareOnly performs health-checks only. For subsequent SBE updates with download connector enabled, PrepareOnly performs downloads and health-checks
Step 3: Monitor Preparation Progress

Check the status of the preparation process.

PowerShell Commands
Get-SolutionUpdate | ft Version,State,UpdateStateProperties,HealthState
States You May See:
  • Downloading
  • HealthChecking
  • ReadyToInstall
  • HealthCheckFailed (troubleshoot if seen)

Start Installation

Begin the update installation process

Begin installation and monitor progress. Machines may reboot; sessions can drop and need re-establishing.

Start the Installation

Execute the installation command to begin the SBE update process.

PowerShell Commands
$InstanceId = Get-SolutionUpdate | Where-Object {$_.State -imatch "Ready" -and $_.PackageType -eq "SBE"} | Sort-Object -Property ResourceID -Descending | Select-Object -First 1 | Start-SolutionUpdate
If you skipped PrepareOnly, Start-SolutionUpdate will download and health-check first. Save $InstanceId for troubleshooting reference.
Resume Commands (if needed):
  • Get-SolutionUpdate -Id $InstanceId | Start-SolutionUpdate
  • Get-SolutionUpdate -Id $InstanceId | Start-SolutionUpdate -IgnoreWarnings - Use this to resume after readiness checks that are in Warning state if acceptable.
Track Installation Progress

Monitor the installation progress using PowerShell commands.

PowerShell Commands
Get-SolutionUpdate | ft Version,State,UpdateStateProperties,HealthState
Installation States:
  • Downloading - Downloading update packages (if not predownloaded)
  • Preparing - Preparing for installation
  • HealthChecking - Running health checks
  • Installing - Installation in progress
  • Installed - Installation completed successfully
Tip: Track progress in Azure portal for better visibility. If monitoring with PowerShell, connect to the last server updated to minimize session drops during reboots.