Skip to main content

Get-ZrSiteStatus

Shows a store's configured WAN site-replication state: its site id, role, mode, epoch, peers, and whether the change feed is enabled.

Syntax​

Get-ZrSiteStatus
[-Store] <string>
[-Managers <string[]>] [-Port <int>] [-Token <string>] [-TimeoutSec <int>]

Description​

Get-ZrSiteStatus reads the site configuration each node of the named store carries and emits a StoreSiteStatus object with the site id, role (Active/Passive), mode (ActivePassive/ActiveActive), epoch, configured peers, and whether the change feed is enabled.

This reports configured state. Runtime, both-direction replication lag federated over the link is a separate live surface and is not part of this output. The cmdlet queries each resolved manager; it needs an active workspace or an explicit -Managers list.

Parameters​

ParameterTypeRequiredDescription
-StorestringYesName of the store whose site state to report. Position 0.
-Managersstring[]NoManagement Service endpoints (host, host:port, or URL) 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​

Show the configured site state for the orders store.

Get-ZrSiteStatus -Store orders