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.
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.
$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.
whoami
Get-SolutionUpdateEnvironment
Discover Available Updates
List update candidates and inspect details of the one you plan to install.
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:
SBE_Discovery_DataON.xmlSBE_DataON_<family>_<version>.xmlSBE_DataON_<family>_<version>.zip
# Example with latest version (AZL8000i-4.2.2510.810):
SBE_Discovery_DataON.xmlSBE_DataON_AZL8000i_4.2.2510.810.xmlSBE_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.
Import
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
Important Notes
- First-time installation always requires manual download
- Automatic download connector setup is covered in the Automatic Update scenario after installation
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.
Get-SolutionUpdate | Where-Object {$_.PackageType -eq 'SBE'} | ft Version,State,UpdateStateProperties,HealthState
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.
Get-SolutionUpdate | Where-Object {$_.State -imatch "Ready" -and $_.PackageType -eq "SBE"} | Sort-Object -Property ResourceID -Descending | Select-Object -First 1 | Start-SolutionUpdate -PrepareOnly
- 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
Step 3: Monitor Preparation Progress
Check the status of the preparation process.
Get-SolutionUpdate | ft Version,State,UpdateStateProperties,HealthState
DownloadingHealthCheckingReadyToInstallHealthCheckFailed(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.
$InstanceId = Get-SolutionUpdate | Where-Object {$_.State -imatch "Ready" -and $_.PackageType -eq "SBE"} | Sort-Object -Property ResourceID -Descending | Select-Object -First 1 | Start-SolutionUpdate
Get-SolutionUpdate -Id $InstanceId | Start-SolutionUpdateGet-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.
Get-SolutionUpdate | ft Version,State,UpdateStateProperties,HealthState
Downloading- Downloading update packages (if not predownloaded)Preparing- Preparing for installationHealthChecking- Running health checksInstalling- Installation in progressInstalled- Installation completed successfully
Setup Automatic Updates
Optional Verify cluster registration and configure automatic download connector for future updates
Complete cluster registration verification, then configure download connector
1. Verify Cluster Registration
Before enabling automatic downloads, ensure your cluster is registered with the DataON portal. This is a prerequisite for the download connector to function.
How to Verify Registration
- Login to the DataON SBE portal with your Microsoft account
- Navigate to: Manage → Clusters
/manage/dashboard - Look for your cluster in the list
- Verify cluster name and node count match your environment
If Your Cluster IS Registered
Your cluster appears in the list with:
- Correct cluster name and node information
- Status shows as "Active" or "Connected"
- All nodes listed with serial numbers
Next Step: Proceed to Section 2 to enable the download connector.
View Your ClustersIf Your Cluster is NOT Registered
You see one of these:
- Cluster does not appear in the list
- "No clusters found" message
- Incorrect or outdated information
Action Required: Complete cluster registration first.
Register Your ClusterAbout the Registration Process
- Collects cluster ID, name, and node serial numbers
- Encrypts and securely sends data to DataON portal
- Creates cluster profile for automatic downloads
- PowerShell access to one cluster node
- Run the provided registration script
- Wait 1-2 minutes for portal sync
Important Notes
- One-time setup: Registration only needs to be done once per cluster
- Updates automatically: Re-running the script updates your cluster information
- Required for automatic downloads: Without registration, you must use manual download method
2. Check Download Connector Status
Once registration is confirmed, check if download connector is already enabled.
Get-SolutionExtensionProperty
- This command shows all solution extension properties including download connector status
- Look for the EnableSBEDownload property in the output
- If property shows true, connector is already enabled - skip to verification step
3. Enable Download Connector
If the status check shows download connector is disabled, run this command to enable it.
Set-SolutionExtensionProperty -PropertyHash @{EnableSBEDownload='true'}
- After enabling, the download connector will handle file downloads automatically
- This setting persists across reboots and applies to all future updates
- No restart required - takes effect immediately
4. Verify Successful Configuration
Confirm both registration and download connector are properly configured.
Get-SolutionExtensionProperty | Select-Object EnableSBEDownload
# Also verify cluster appears in DataON portal at: /manage/dashboard
- EnableSBEDownload should now show: true
- Your cluster should appear in the registered clusters list on DataON portal
- If still false or cluster not visible, verify registration was completed successfully
# Generic file pattern (family and version vary by your system)