Skip to main content
Use the ZEDEDA CLI (ZCLI) to view events from the command line. This article covers the zcli events show command, with syntax and examples for each way to filter the results. An event is a record of a state change or action in your enterprise, such as an application instance coming online, an edge node changing state, or a user changing a configuration. Each event has a timestamp, a severity, the object it applies to, and a description. This page is the command reference. For an explanation of events and how to view them in the Edge Infrastructure Services console, see Monitoring, Logs, Events, Reports, and Jobs.

​
Before You Start

  • ZCLI is installed and authenticated against your enterprise. See Get Started.
  • You have a role that can read the objects whose events you want to view. [TBD: confirm the minimum role required to view events with ZCLI.]
  • You know the names of the objects you want to filter on. To list them, run zcli edge-node show, zcli edge-app-instance show, zcli project show, zcli volume-instance show, or zcli user show.

​
View Events

​
Syntax

events show is the only events subcommand. Every flag is optional.
zcli events --help does not describe --filter-volume-instance, --filter-severity, --filter-resource, or --filter-event-type, but the syntax line includes them and ZCLI passes them to Edge Infrastructure Services. ZCLI does not check severity, resource, or event type values. It sends them exactly as you type them.

​
View all events

Run the command without filters to view events across your enterprise.
Without --page-num, ZCLI requests every page of results, one after another, and prints them all. In a large enterprise this can take a long time and produce a lot of output. Narrow the results with a filter, a time range, or --page-num.

​
Filter Events by Object

Pass one object filter to view the events for a single application instance, edge node, project, volume, or user. To view the events for an edge node:
To view the events for an application instance:
To view the events for a project:
To view the events for a volume:
To view the events for a user:
ZCLI looks up the edge node by name before it sends the request, so an edge node name that does not exist returns an error. For the other object filters, ZCLI sends the name without checking it.
Use only one object filter per command. ZCLI accepts several object filters together but sends only one object type to Edge Infrastructure Services, so combining them does not narrow the results the way you expect. If you pass more than one, ZCLI uses the last of these in this order: --filter-edge-app-instance, --filter-edge-node, --filter-project, --filter-volume-instance, --filter-user. For example, with --filter-edge-node=MY_NODE --filter-project=MY_PROJECT, ZCLI sends the object type as project.
You can combine one object filter with the severity, resource, event type, page, and time range flags.

​
Filter Events by Severity, Resource, or Type

Use --filter-severity, --filter-resource, and --filter-event-type to narrow the results further. You can use them on their own or together with an object filter. To view events of one type:
To view the events of one severity for an edge node:
[TBD: confirm the accepted values for --filter-severity and --filter-resource, and where to find the list of event types. ZCLI does not define or validate these values.]

​
Filter Events by Time

Use --starts and --ends to limit the results to a time range. Enter each time as YYYY-MM-DD HH:MM:SS and enclose it in quotes because it contains a space. You can pass --starts without --ends, or --ends without --starts. To view the events in a time range:
To view the events for an application instance since a given time:
ZCLI reads --starts and --ends as times in the local time zone of the system that runs ZCLI, then converts them to UTC. In the ZCLI container the local time zone is usually UTC, so enter UTC times unless you set a different time zone for the container.
If a time is not in the expected format, ZCLI prints input datetime in format %Y-%m-%d %H:%M:%S and exits. For example, 2026-10-01 without a time, or 2026-10-01T09:00:00 with a T, is rejected.

​
Page Through Events

Use --limit and --page-num together to read a large set of events one page at a time. To view the first page of 500 events:
To view the second page:
When you pass --page-num, ZCLI returns only that page. When you omit it, ZCLI returns every page, and --limit only sets how many events ZCLI requests per call. --page-num must be a whole number. Any other value, such as --page-num=first, stops ZCLI with a Python error instead of a ZCLI message. A value of 0 is treated as if you had omitted --page-num, so ZCLI returns every page.

​
Read the Output

By default, ZCLI prints one line per event in this order, with no column headings:
The text output does not include the severity, event type, or object of each event. If a filter matches no events, ZCLI prints nothing. To see every field of each event, including severity and event type, use the global --format=json option. Place it before events:

​
Next Steps

Manage Nodes

Create, onboard, view, and manage edge nodes.

Manage Application Instances

Deploy, view, and manage application instances.

Manage Jobs

Run and track operations across many edge nodes or application instances.

Monitoring, Logs, Events, Reports, and Jobs

View and filter events in the Edge Infrastructure Services console.