This is the shipped English man-page reference for zerodds-admin — the same text as man zerodds-admin. The surrounding navigation follows the language switch; the reference body stays English, as man-pages conventionally do.
Dies ist die ausgelieferte englische man-page-Referenz für zerodds-admin — derselbe Text wie man zerodds-admin. Navigation und Seitenrahmen folgen dem Sprach-Umschalter; der Referenz-Body bleibt englisch, wie man-pages es konventionell tun.
NAME
zerodds-admin - ZeroDDS operator CLI for live domains and DDS-XML configs
SYNOPSIS
zerodds-admin group verb [args] [--json] [--timeout-ms T]
DESCRIPTION
zerodds-admin is the operator front-end for ZeroDDS. It has two families of sub-commands: the live groups join a running DDS domain over RTPS and report what is on the wire, and the offline groups load a DDS-XML deployment file and analyze it without touching the network.
Every data-bearing command accepts --json for machine-readable output.
SUBCOMMANDS
Live (joins the domain over RTPS)
- domain inspect ID
-
Probe domain ID and list the discovered participants, each with its writer and reader endpoints (topic name, IDL type, RELIABLE vs BEST_EFFORT, TRANSIENT_LOCAL vs VOLATILE), grouped by participant GUID.
- discovery snapshot ID
-
Probe domain ID and print a raw SPDP/SEDP snapshot: the participant list plus discovered publication / subscription counts.
Offline (DDS-XML, no network)
- config inspect FILE.xml
-
Load a DDS-XML deployment and render a domain-id-centric topology (participants and their writers/readers grouped by resolved domain id).
- qos validate FILE.xml
-
Check DDS-XML well-formedness and parse every library (qos / domain / participant). Exit non-zero on a parse error.
- qos check FILE.xml
-
Validate Request-vs-Offered (RxO) QoS compatibility of every writer~mesreader pair that shares a topic (DDS 1.4 §2.2.3 compatibility matrix). Inline QoS and qos_profile_ref inheritance are both resolved. Exit 1 if any pair is incompatible.
OPTIONS
- --json
-
Emit machine-readable JSON instead of text.
- --timeout-ms T
-
Observation window in milliseconds for the live groups. Default: 2000.
- -h, --help
-
Show usage.
EXIT STATUS
- 0
-
Success / all QoS pairs compatible.
- 1
-
Validation failure (incompatible QoS, parse error) or probe error.
- 2
-
CLI parse error / bad invocation.
EXAMPLES
Inspect a running domain and grab a JSON topology:
zerodds-admin domain inspect 0 --json
Catch incompatible QoS in a deployment before rollout:
zerodds-admin qos check deployment.xml
SEE ALSO
zerodds-xmlc(1), zerodds-snitch(1), zerodds-spy(1), zerodds-monitor(1)
AUTHORS
ZeroDDS Contributors <release@zerodds.org>