---
title: "load balancer fleet status · RUAL Documentation"
description: "Ask every load balancer what it serves and whether the fleet agrees with itself. Reads only."
canonical: https://docs.rual.nl/block-types/nginx/nginxsite_status
language: en
---

[Cluster](https://docs.rual.nl/cluster)

[Blocks](https://docs.rual.nl/block-types)

[Interfaces](https://docs.rual.nl/interfaces)

[Blueprints](https://docs.rual.nl/blueprints)

[Tutorials](https://docs.rual.nl/tutorials)

[Home automation](https://docs.rual.nl/home-automation)

[Examples](https://docs.rual.nl/examples)

[Reference](https://docs.rual.nl/reference)

[Architecture](https://docs.rual.nl/architecture)

[Troubleshooting](https://docs.rual.nl/troubleshooting)

Other

# load balancer fleet status

This block is part of the [`nginx`](https://docs.rual.nl/block-types/nginx) group and was last modified in core [`v15.0.0`](https://docs.rual.nl/core-versions/150000).

Ask every load balancer what it serves and whether the fleet agrees with itself. Reads only.

- flow `flow`

- Load balancers required `array` Each {name, host, port, user, key_path, known_hosts_path}. Paths only : never key material.

- flow `flow`

- Success `condition` True when the fan-out itself could run.

- Results `array` Per node: name, host, ok, nginx, sites, applied : or output/exit_code when unreachable.

- Fleet in sync `condition` True only when every node answered, nginx is active everywhere, and all report identical state.

- Sites `array` Union of the site names served across the fleet, sorted.

- Reachable count `number` How many nodes answered with parseable status.

- Node count `number` How many nodes were asked.

- Error `value` Why the status could not run at all.

Asks every load balancer in the nodes list for its status (nginx active?, which sites, which applied-state stamp) and reports per node plus a fleet verdict. Reads only : nothing is written or reloaded. in_sync is deliberately strict: true only when every node answered, every nginx is active, and all nodes report the same applied stamp and the same site list. A node that cannot be reached makes the fleet out of sync by definition : 'two of three agree and the third is silent' is exactly the state a dashboard must show, not average away. sites is the union across nodes; per-node lists are in results. This is the read half the management dashboard builds its view on: list sites from here, edit a config, nginxsite_check it everywhere, nginxsite_push it, then read this again to confirm convergence.

| `nginx status` |
| --- |
| `lb status` |
| `fleet status` |

A typical wiring for [load balancer fleet status](https://docs.rual.nl/block-types/nginx/nginxsite_status): a [function trigger](https://docs.rual.nl/block-types/globals/trigger_custom_function) starts the flow; [with values](https://docs.rual.nl/block-types/array/array_of_values) feeds the `nodes` pin; the `flow` out pin feeds [debug](https://docs.rual.nl/block-types/state%2520ui/state_debug).

[![Studio canvas example for the load balancer fleet status block: typical wiring for load balancer fleet status.](https://docs.rual.nl/canvas-examples/nginxsite_status.png)](https://docs.rual.nl/canvas-examples/nginxsite_status.png?v=3)

## Version history

Introduced in [`v15.0.0`](https://docs.rual.nl/core-versions/150000).

- [Back to `nginx`](https://docs.rual.nl/block-types/nginx): Return to the main group to view all sub-groups

- [Back to `Load balancers`](https://docs.rual.nl/block-types/nginx?group=Load%20balancers): Return to the group to view all blocks within this group

Was this page helpful? [Tell us what to improve](https://docs.rual.nl/support) · RUAL Docs is an integral component of the [RUAL ecosystem](https://rual.nl)