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×reader 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.
--skip-unknown: Offline commands: leave out what the DDS-XML 1.0 schemas do not define (the elements and attributes of another product's file) and list each omission with its path on standard error. Without it the first such element is an error.
--vendor-forms: Offline commands: read the forms other DDS products write (such as <topic_filter> as an element, qos_profile_ref, <participant_qos>, IDL type names) and list each with its path on standard error. Without it the first such form is an error that names the form DDS-XML 1.0 uses.
--timeout-ms T: Observation window in milliseconds for the live groups. Default: 2000.
-h, --help: Show usage.
-V, --version: Print version and exit.
--config PATH: The base configuration file; its sibling PATH.d/ holds drop-ins. Default: the system configuration directory (/etc/zerodds on Linux, /usr/local/etc/zerodds on macOS).
--set PATH=VALUE: One setting above every file, repeatable; +PATH=VALUE appends to a list.
--check-config: Validate and print the effective configuration with the origin of every value, then exit: 0 valid, 1 invalid value or unknown key, 2 unreadable file, syntax error or include cycle.

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

AUTHORS

ZeroDDS Contributors <release@zerodds.org>

BEZEICHNUNG

zerodds-admin - ZeroDDS-Betriebswerkzeug für laufende Domänen und DDS-XML-Konfigurationen

ÜBERSICHT

zerodds-admin Gruppe Verb [Argumente] [--json] [--timeout-ms T]

BESCHREIBUNG

zerodds-admin ist die Bedienoberfläche für den Betrieb von ZeroDDS. Es hat zwei Familien von Unterbefehlen: Die live-Gruppen treten einer laufenden DDS-Domäne über RTPS bei und berichten, was auf der Leitung ist; die offline-Gruppen laden eine DDS-XML-Deployment-Datei und analysieren sie, ohne das Netz zu berühren.

Jeder Befehl, der Daten ausgibt, akzeptiert --json für maschinenlesbare Ausgabe.

UNTERBEFEHLE

Live (tritt der Domäne über RTPS bei)

domain inspect ID: Prüft die Domäne ID und listet die gefundenen Teilnehmer, jeweils mit ihren Writer- und Reader-Endpunkten (Topic-Name, IDL-Typ, RELIABLE oder BEST_EFFORT, TRANSIENT_LOCAL oder VOLATILE), gruppiert nach Teilnehmer-GUID.
discovery snapshot ID: Prüft die Domäne ID und gibt einen rohen SPDP/SEDP-Schnappschuss aus: die Teilnehmerliste und die Anzahl gefundener Publications und Subscriptions.

Offline (DDS-XML, kein Netz)

config inspect DATEI.xml: Lädt ein DDS-XML-Deployment und stellt eine nach Domain-ID geordnete Topologie dar (Teilnehmer und ihre Writer/Reader, gruppiert nach der aufgelösten Domain-ID).
qos validate DATEI.xml: Prüft, ob das DDS-XML wohlgeformt ist, und parst jede Bibliothek (qos / domain / participant). Endet bei einem Parse-Fehler mit einem Wert ungleich null.
qos check DATEI.xml: Prüft die Request-vs-Offered-Kompatibilität (RxO) der QoS jedes Writer×Reader-Paars, das ein Topic teilt (Kompatibilitätsmatrix aus DDS 1.4 §2.2.3). Inline-QoS und die Vererbung über qos_profile_ref werden beide aufgelöst. Endet mit 1, wenn ein Paar inkompatibel ist.

OPTIONEN

--json: Gibt maschinenlesbares JSON statt Text aus.
--skip-unknown: Offline-Befehle: lässt aus, was die DDS-XML-1.0-Schemas nicht definieren (die Elemente und Attribute der Datei eines anderen Produkts), und listet jede Auslassung mit ihrem Pfad auf der Standardfehlerausgabe. Ohne diese Option ist das erste solche Element ein Fehler.
--vendor-forms: Offline-Befehle: liest die Formen, die andere DDS-Produkte schreiben (etwa <topic_filter> als Element, qos_profile_ref, <participant_qos>, IDL-Typnamen), und listet jede mit ihrem Pfad auf der Standardfehlerausgabe. Ohne diese Option ist die erste solche Form ein Fehler, der die Form nennt, die DDS-XML 1.0 verwendet.
--timeout-ms T: Beobachtungsfenster in Millisekunden für die Live-Gruppen. Standard: 2000.
-h, --help: Zeigt die Aufrufhilfe.
-V, --version: Gibt die Version aus und beendet sich.
--config PFAD: Die Basis-Konfigurationsdatei; das danebenliegende PFAD.d/ enthält Drop-ins. Standard: das System-Konfigurationsverzeichnis (/etc/zerodds unter Linux, /usr/local/etc/zerodds unter macOS).
--set PFAD=WERT: Eine Einstellung über allen Dateien, wiederholbar; +PFAD=WERT hängt an eine Liste an.
--check-config: Prüft die wirksame Konfiguration und gibt sie mit der Herkunft jedes Werts aus, dann Ende: 0 gültig, 1 ungültiger Wert oder unbekannter Schlüssel, 2 nicht lesbare Datei, Syntaxfehler oder Include-Zyklus.

EXIT-STATUS

0: Erfolg / alle QoS-Paare kompatibel.
1: Prüfung fehlgeschlagen (inkompatible QoS, Parse-Fehler) oder Fehler bei der Domänenprüfung.
2: Fehler beim Parsen der Kommandozeile / ungültiger Aufruf.

BEISPIELE

Eine laufende Domäne untersuchen und die Topologie als JSON holen:

zerodds-admin domain inspect 0 --json

Inkompatible QoS in einem Deployment vor dem Ausrollen finden:

zerodds-admin qos check deployment.xml

SIEHE AUCH

zerodds-xmlc(1), zerodds-snitch(1), zerodds-spy(1), zerodds-monitor(1)

AUTOREN