gnmic-sub 命令

常用示例

说明

gnmic sub (or subscribe) sends a gNMI Subscribe RPC to network devices for streaming telemetry. It supports multiple subscription modes: once (immediate single response), poll (on-demand), and stream (continuous updates). Stream mode supports sample (periodic), on_change (event-driven), and target_defined delivery.

参数

--path _path_

gNMI path to subscribe to.

--mode _mode_

Subscription mode: STREAM, ONCE, POLL (default STREAM).

--stream-mode _mode_

Stream mode: sample, on_change, target_defined (default sample).

--prefix _prefix_

Set a common prefix for all paths.

--target _target_

Set path target in the SubscriptionList prefix field.

--qos _value_

QoS marking for subscription responses (default 20, 0 to disable).

--sample-interval _duration_

Interval for target to send samples (e.g. 1s, 1m30s).

--heartbeat-interval _duration_

Heartbeat interval for on_change or sample modes.

--suppress-redundant

Suppress updates unless value has changed since last update.

--updates-only

Only send updates, not initial state.

--quiet

Do not output subscription responses to stdout.

--format _format_

Output format (json, protojson, prototext, event, flat).

--name _name_

Trigger predefined subscriptions from configuration file.

--output _output_

Select output provider(s) defined in configuration file.

--depth _depth_

Set gNMI extension depth value.

--history-snapshot _time_

Set history snapshot value (nanoseconds or RFC3339 format).

--set-target

Set SubscribeRequest Prefix target to configured target name.