Skip to main content

Get-ZrStore

Shows Zaris stores and their per-node status, reading aggregated data from the connected managers.

Syntax​

Get-ZrStore
    [-Name <string>]
    [-Managers <string[]>] [-Port <int>] [-Token <string>] [-TimeoutSec <int>]

Description​

Get-ZrStore lists every store on the connected managers, or a single store when -Name is supplied. For each store it renders an overall status, uptime, and a per-node list with each node's running state, address, and role, followed by a running/stopped/other summary.

The output is a rendered console view intended for reading interactively, not a structured pipeline object. The cmdlet requires an active workspace (see New-ZrWorkspace / Use-ZrWorkspace) or an explicit -Managers list.

Parameters​

ParameterTypeRequiredDescription
-NamestringNoName of a single store to show. Position 0. When omitted, all stores on the connected managers are listed.
-Managersstring[]NoManagement Service endpoints (host, host:port, or URL) to query. When omitted, the active workspace/connected managers are used.
-PortintNoManager port for bare-host endpoints or localhost fallback. Default 7801.
-TokenstringNoAdmin bearer token for authenticated calls; falls back to the token from the active workspace.
-TimeoutSecintNoPer-request timeout in seconds. Default 30.

Examples​

List every store on the connected managers.

Get-ZrStore

Show a single store by name.

Get-ZrStore -Name orders

Query specific managers without a persisted session.

Get-ZrStore -Name orders -Managers 10.0.0.11,10.0.0.12

Output​

A rendered per-store view. Each store shows:

  • Store — the store name.
  • Cluster context — the number of managers and how many were reached.
  • Status — Running (all nodes up), Stopped (all down), Partial (mixed), or NoInstances.
  • Uptime — cluster formation time reported by the core, with a fallback to the earliest running node.
  • A Nodes list — each node's name, address, running/stopped bullet, and per-node uptime, ending with a Running: / Stopped: / Other: summary.