Skip to content

Topology and cluster collector ​

Generated by scripts/docs/New-CollectorReferencePages.ps1 from the collector definitions. Do not edit by hand.

PropertyValue
Idtopology-cluster
FunctionInvoke-RangerTopologyClusterCollector
Classcore
Coverstopology, cluster
Required targetcluster
Required credentialcluster
Manifest domainsdomains.clusterNode

Access and permissions ​

WinRM (or Arc Run Command) to the cluster nodes with a cluster credential that can read Failover Clustering, CIM and the Solution Update cmdlets. Read-only.

Output ​

Top-level keys of each domain, as seen in the fixture manifest (tests/maproom/Fixtures/synthetic-manifest.json). Collectors can add keys between releases; the manifest schema keeps domain payloads open.

domains.clusterNode ​

cluster, csvSummary, eventSummary, faultDomains, faultDomainSummary, healthSummary, networks, networkSummary, nodes, nodeSummary, quorum, roles, updatePosture

When it is skipped, degraded or failed ​

Skipped when no cluster transport is reachable (connectivity matrix) and the collector is optional; otherwise the run fails because every other collector needs the node list.

The collector status in the manifest is one of success, partial, failed, skipped or not-applicable. Since v2.7.0 the entry also carries degraded, degradationCount and degradations (source and message of every non-fatal read that failed), and a degraded collector adds an informational finding. Debug-level detail is in ranger.log.

Azure Local 12.2609 (latest) coverage ​

ItemManifest pathMicrosoft Learn
Rack aware cluster zonesdomains.clusterNode.rackAwarehttps://learn.microsoft.com/azure/azure-local/concepts/rack-aware-cluster-reference-architecture
SBE / OEM update detaildomains.clusterNode.solutionUpdateDetailhttps://learn.microsoft.com/azure/azure-local/update/solution-builder-extension

Details: Platform evidence for 12.2609.

Released under the MIT License.