Skip to main content

Get-ZrStoreTlsStatus

Reports a store's transport-TLS state — whether TLS is enabled, the enforcement mode, and how many of its nodes have provisioned a leaf certificate.

Syntax

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

Description

Get-ZrStoreTlsStatus queries the connected managers for the named store's TLS state and reports whether TLS is enabled, the enforcement mode, and how many nodes have provisioned a leaf certificate. Use it to confirm a store is fully provisioned after Enable-ZrStoreTls — a partially provisioned store shows how many nodes still need a leaf and hints to re-run with -Restart.

When the mode is MutualTls, the report notes that mutual TLS is enforced node-to-node while app clients still connect with the CA plus a token and no client certificate. Pass -ShowCertificates to also print each node's leaf certificate (subject, thumbprint, expiry) and the cluster-CA trust anchor thumbprint, so you can verify provisioning without dropping to openssl. Requires an active workspace or an explicit -Managers list.

Parameters

ParameterTypeRequiredDescription
-StorestringYesName of the store whose transport TLS status to report. Position 0.
-ShowCertificatesswitchNoAlso print each node's leaf certificate (subject, thumbprint, expiry) and the cluster-CA trust anchor.
-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

Show whether transport TLS is enabled on the orders store and how many of its nodes hold a certificate.

Get-ZrStoreTlsStatus -Store orders

Include each node's leaf certificate and the trust anchor thumbprint for verification.

Get-ZrStoreTlsStatus -Store orders -ShowCertificates