Skip to main content

Get-ZrConnections

Shows each node's view of its peer connections for a store — which peers it sees as connected, disconnected, or suspect. Run it to diagnose transport partitions and asymmetric connectivity between nodes.

Syntax​

Get-ZrConnections
    -StoreName <string>
    [-NodeId <string>]
    [-TimeoutMs <int>]
    [-Continuous] [-IntervalSeconds <int>]
    [-AsJson]
    [-Managers <string[]>] [-Port <int>] [-Token <string>] [-TimeoutSec <int>]

Description​

Get-ZrConnections collects the connections snapshot from every node of the named store and lists each peer with its state as that node sees it. Because the view is per node, you can compare rows across nodes to find an asymmetric partition — where node A reports node B disconnected but B still reports A connected. With -Continuous the table re-renders on an interval until Ctrl-C.

The output is a rendered console table; use -AsJson to emit the raw typed result as indented JSON. The cmdlet requires an active workspace (see New-ZrWorkspace / Use-ZrWorkspace) or an explicit -Managers list.

Parameters​

ParameterTypeRequiredDescription
-StoreNamestringYesName of the store whose connection states to collect.
-NodeIdstringNoRestricts collection to a single node id; when omitted every node in the store is queried.
-TimeoutMsintNoPer-node collection timeout in milliseconds; when omitted the server default is used.
-ContinuousswitchNoRe-renders the table on an interval until Ctrl-C instead of collecting once.
-IntervalSecondsintNoRefresh interval in seconds when -Continuous is set. Default 120.
-AsJsonswitchNoEmits the raw typed diagnostics result as indented JSON instead of the formatted table.
-Managersstring[]NoManagement Service endpoints to target; when omitted the active workspace's managers are used.
-PortintNoManagement Service port for bare-host managers. Default 7801.
-TokenstringNoAdmin bearer token for authenticated control-plane calls.
-TimeoutSecintNoPer-request timeout in seconds. Default 30.

Examples​

List the peer connection state seen by each node of the orders store.

Get-ZrConnections -StoreName orders

Continuously monitor connectivity while investigating a suspected network partition.

Get-ZrConnections -StoreName orders -Continuous -IntervalSeconds 5

Reading the output​

Each row is one peer as seen by the node in the Node column (green on success, red with an (*N) footnote marker on error). The State column is color-coded:

  • Connected (green) — the peer link is healthy.
  • Disconnected (red) — the node has lost the link to that peer.
  • Suspect (yellow) — the peer is under failure suspicion but not yet declared disconnected.
  • None — the node reported no peers.

Compare a peer's state across nodes: consistent Disconnected on both sides is a clean partition, whereas a one-sided report points to an asymmetric transport problem.