Skip to content

Prerequisites ​

This is the canonical prerequisites guide for AzureLocalRanger. It covers required permissions, modules, viewers, network access, and a quick-check script you can run before the first scan.

Required Permissions ​

  • Local administrator on the execution host when you need Ranger to auto-install prerequisites.
  • Read-capable WinRM access to the Azure Local nodes.
  • Active Directory read permissions when the environment is domain-joined.
  • Azure RBAC Reader on the subscription or resource group being scanned.
  • Azure Key Vault secret-read access when passwordRef values use keyvault:// URIs.
  • BMC (Redfish) credential when hardware discovery is enabled; keep it in Key Vault, never in the config file.
  • Elevated (Administrator) session only when running Test-AzureLocalRangerPrerequisites -InstallPrerequisites.

Required Modules and Tools ​

ItemRequiredNotes
PowerShell 7.xYesRanger targets PowerShell 7 and CompatiblePSEditions = Core
Az.Accounts (2.13.0+)YesAzure authentication
Az.Resources (6.0.0+)YesAzure resource inventory
Az.KeyVault (4.0.0+)YesResolves keyvault:// credential references (Azure CLI is the fallback)
Az.ConnectedMachine (0.7.0+)Yes (startup check)Arc Run Command transport when WinRM is blocked
Az.StackHCI (2.0.0+), Az.ResourceGraph (0.13.0+)OptionalCluster-level operations and faster ARM discovery
Az.Storage, Az.AdvisorOptionalAzure Blob publishing; WAF Advisor recommendations
RSAT ActiveDirectoryWhen AD queries are neededRequired for domain-backed identity collection
GroupPolicy toolsOptionalUsed when GPO posture is collected
Azure CLIOptionalFallback when useAzureCliFallback is enabled
ImportExcel (7.8.0+)NoChecked as optional by the startup module check; XLSX output is generated without Excel automation

Viewer and Consumer Tools ​

ItemRequiredNotes
Web browserYesView HTML reports and SVG diagrams
draw.io desktopOptionalRecommended for editing packaged diagram source
Microsoft Word / LibreOffice WriterOptionalView .docx narrative reports
Microsoft Excel / LibreOffice CalcOptionalView .xlsx inventory workbooks
PDF readerOptionalView fixed-layout handoff reports
VS CodeOptionalReview JSON manifests and YAML config files

Network Requirements ​

  • WinRM: TCP 5985 or 5986 to cluster nodes.
  • LDAP or LDAPS: TCP 389 or 636 to at least one domain controller when AD collection is required.
  • HTTPS: TCP 443 to Azure Resource Manager, Azure Arc, Key Vault, and monitoring endpoints.
  • Redfish: TCP 443 to each BMC (for example Dell iDRAC) only when hardware discovery is enabled; a BMC credential is then required.
  • No requirement to reach switches, firewalls, or OpenGear devices from the execution host unless you explicitly opt into those targets.

Quick-Check Script ​

Run this from the repo root or after importing the module:

powershell
$checks = [ordered]@{
  PowerShell7 = $PSVersionTable.PSVersion.Major -ge 7
  AzAccounts  = [bool](Get-Module -ListAvailable -Name Az.Accounts)
  AzResources = [bool](Get-Module -ListAvailable -Name Az.Resources)
  AzureCli    = [bool](Get-Command az -ErrorAction SilentlyContinue)
  WinRM       = [bool](Get-Command Invoke-Command -ErrorAction SilentlyContinue)
  ActiveDirectory = [bool](Get-Module -ListAvailable -Name ActiveDirectory)
}

$checks.GetEnumerator() | ForEach-Object {
  [pscustomobject]@{
    Check  = $_.Key
    Passed = $_.Value
  }
} | Format-Table -AutoSize

Test-AzureLocalRangerPrerequisites

First-Run Path ​

  1. Import the module from source or a published release.
  2. Run Test-AzureLocalRangerPrerequisites.
  3. Generate a config with New-AzureLocalRangerConfig -Path .\ranger.yml.
  4. Fill in the [REQUIRED] values.
  5. Run Invoke-AzureLocalRanger -ConfigPath .\ranger.yml.

Released under the MIT License.