AzureLocalRanger

Author(s)

• Azure Local Cloud

Tags

AzureLocal AzureStackHCI HCI Arc ArcEnabledInfrastructure PowerShell Documentation Inventory Audit AsBuilt Report Discovery HealthCheck Cluster FailoverClustering Windows WindowsServer Hyper-V StorageSpacesDirect S2D

Functions

Invoke-AzureLocalRanger New-AzureLocalRangerConfig Export-AzureLocalRangerReport Test-AzureLocalRangerPrerequisites Invoke-RangerWizard

PSEditions

Core

Dependencies

This module has no dependencies.

Release Notes

## v1.4.0 — Report Quality

### Added
- **HTML report rebuild (#168)** — Type-aware section rendering: table, kv-grid, and sign-off
 section types. Node Inventory, VM Inventory, Storage Pool Capacity, Physical Disk Inventory,
 Network Adapter Inventory, Event Log Summary, and Security Audit tables. Markdown report
 updated with equivalent type-aware rendering including pipe-delimited tables and sign-off
 placeholder rows.
- **Diagram engine quality (#140)** — SVG diagrams rebuilt with group containers, color-coded
 per-node-kind fills, cubic bezier edges with arrowheads, and dark header bar. draw.io XML
 rebuilt with swim-lane group containers and per-kind node styles. Near-empty diagrams skip
 gracefully and record a skipped artifact.
- **PDF output (#96)** — Cover page prepended to all PDF reports with title, cluster name,
 mode, version, generated date, and confidentiality notice. Plain-text PDF renderer updated
 with type-aware section output.
- **WAF Assessment integration (#94)** — New optional collector queries Azure Advisor
 recommendations and maps to WAF pillars. Rule engine evaluates 23 manifest-path rules from
 config/waf-rules.json without re-collection. WAF Scorecard and Findings tables added to
 management and technical report tiers. New wafAssessment manifest domain.

## v1.3.0 — Operator Experience

### Added
- **Full config parameter coverage (#171)** — every `behavior.*`, `output.*`, and `credentials.azure.*` config key
 is now directly passable as a runtime parameter on `Invoke-AzureLocalRanger`: `-OutputMode`, `-OutputFormats`,
 `-Transport`, `-DegradationMode`, `-RetryCount`, `-TimeoutSeconds`, `-AzureMethod`, `-ClusterName`.
 Parameters take precedence over config file values via `Set-RangerStructuralOverrides`.
- **First Run guide (#174)** — new `operator/first-run.md`: six-step linear guide from install to output, no choices.
- **Wizard guide (#175)** — new `operator/wizard-guide.md`: full `Invoke-RangerWizard` walkthrough with example
 inputs, generated YAML, and common mistakes.
- **Configuration reference (#177)** — new `operator/configuration-reference.md`: every config key with type,
 required/optional, default value, and Key Vault reference syntax.
- **Understanding output guide (#178)** — new `operator/understanding-output.md`: output directory tree,
 role-based reading path, collector status interpretation, drift report usage.
- **Command reference scenarios (#176)** — nine copy-paste scenario examples added to `operator/command-reference.md`
 plus parameter precedence documentation.
- **Discovery domain enhancements (#179)** — all 10 discovery domain pages now include example manifest JSON,
 common findings table, partial status explanation, and domain dependencies.

## v1.2.0 — UX & Transport

### Added
- **Arc Run Command transport (#26)** — `Invoke-AzureLocalRanger` now routes WinRM workloads
 through Azure Arc Run Command (`Invoke-AzConnectedMachineRunCommand`) when cluster nodes
 are unreachable on ports 5985/5986. Transport mode is controlled by `behavior.transport`
 (auto / winrm / arc) and falls back gracefully when `Az.ConnectedMachine` is absent.
- **Disconnected / semi-connected discovery (#30)** — A pre-run connectivity matrix probes
 all transport surfaces (cluster WinRM, Azure management plane, BMC HTTPS) and classifies
 the runner posture as `connected`, `semi-connected`, or `disconnected`. Collectors whose
 transport is unreachable are skipped with `status: skipped` rather than failing mid-run.
 The full matrix is stored in `manifest.run.connectivity` for observability.
- **Spectre.Console TUI progress display (#76)** — A live per-collector progress display
 using PwshSpectreConsole renders during collection when the module is installed and the
 host is interactive. Falls back to `Write-Progress` automatically. Suppressed in CI and
 Unattended mode. Enable with `-ShowProgress` or `output.showProgress: true` in config.
- **Interactive configuration wizard (#75)** — `Invoke-RangerWizard` walks through a
 prompted question sequence (cluster, nodes, Azure IDs, credentials, output, scope) and
 offers to save the config as YAML, launch a run immediately, or both.

## v1.1.2 — Regression Patch

### Fixed
- Schema contract (`Get-RangerManifestSchemaContract`) rewritten as inline hashtable — eliminates
 FileNotFoundException for PSGallery installs where repo-management/ is not present (#160).
- `toolVersion` in manifests now reflects the installed module version dynamically via
 `Get-RangerToolVersion` — no longer hardcoded to '1.1.0' (#161).
- `Invoke-RangerRedfishRequest` now passes `-Label` and `-Target` to `Invoke-RangerRetry` so
 BMC/Redfish retry log entries carry actionable label and URI (#162).
- `$DebugPreference` no longer set to `'Continue'` at debug log level — eliminates thousands of
 MSAL and Az SDK internal debug lines flooding output (#163).
- Null entries filtered from collector message arrays before manifest and report assembly (#164).
- Domain credential probed before cluster credential in `Get-RangerRemoteCredentialCandidates` —
 eliminates redundant WinRM auth retries on domain-joined clusters (#165).

### Added
- 20 Pester unit tests in `tests/maproom/unit/Execution.Tests.ps1` covering all 9 regression
 bugs (#157–#165). Trailhead field validation closed on live tplabs cluster.

## v1.0.0 — PSGallery Launch

### New Features
- **Parameter-first input model** — pass ClusterFqdn, ClusterNodes, SubscriptionId,
 TenantId, and ResourceGroup directly to Invoke-AzureLocalRanger without a config file.
- **Arc-first node inventory** — cluster nodes are auto-resolved from Azure Arc resource
 properties before falling back to direct WinRM scan or static config.
- **Domain auto-detection** — domain FQDN is resolved from Arc, CIM, or credential hints;
 workgroup clusters are handled gracefully with an informational finding.
- **File-based logging** — every run writes a plain-text ranger.log alongside reports.
- **Self-documenting config scaffold** — New-AzureLocalRangerConfig emits YAML with inline
 comments and [REQUIRED] markers on all mandatory fields.
- **Unreachable-node finding** — a warning finding is raised for any configured node that
 does not respond to WinRM during the topology collection pass.
- **Comment-based help** — Get-Help is now fully populated for all four public commands.

### Bug Fixes
- Fixed null-reference crashes in the storage collector when any sub-section
 (tiers, subsystems, resiliency, jobs, csvs, qos, sofs, replica, clusterNetworks)
 throws during a remote session.

### Improvements
- retryCount and timeoutSeconds from config are now applied to every WinRM operation.
- PSGallery manifest metadata, tags, and description updated for discoverability.