Skip to main content
Use the ZEDEDA CLI (ZCLI) to view resource usage and manage entitlements from the command line. This article covers two command groups:
  • zcli resource-usage shows which edge nodes were active in an enterprise during a time range, and for how long. You can view the report in the terminal or download it as a JSON or CSV file.
  • zcli entitlement shows the limits that an enterprise is entitled to (edge nodes, users, and third-party integrations) and how much of each it uses. You can also export the entitlements to a file and set new limits.
This page is the command reference. For the console view of entitlements, see Admin Dashboard.

​
Before You Start

  • ZCLI is installed and authenticated against your enterprise. See Get Started.
  • To view resource usage, you have a role that allows you to read usage reports for the enterprise. [TBD: confirm the minimum role required for zcli resource-usage.]
  • To set entitlements, you have the required administrator role. In the console, entitlements are available only to cloud-service and support administrators. See Admin Dashboard. [TBD: confirm the role required for zcli entitlement set and zcli entitlement show.]

​
View Resource Usage

​
Show edge node usage

Show the edge nodes that were active in an enterprise during a time range.
To show edge node usage for September 2026:
To show only the summary for the same period:
To show the second page of 100 edge nodes:
show-device-usage returns one page of results. Unlike most show commands, it does not fetch the remaining pages for you. If the enterprise has more active edge nodes than fit on one page, use --page-num to view each page, or download the full report as described in the next section.
The examples in zcli resource-usage --help use --start-time and --end-time and leave out --enterprise-name. Those examples fail. Use --starts, --ends, and --enterprise-name, as shown on this page.
The output has one row per edge node: After the list, ZCLI prints the totals by tier: the total usage time for each tier and the number of edge nodes in each tier. To see usage times in seconds, add the global --format=json option.

​
Download a usage report

Download the complete report for a time range as a JSON or CSV file. Unlike show-device-usage, this command fetches every page of results and sorts the edge nodes by name.
Example:
ZCLI saves the report in a device-usage-reports directory in the current working directory, which it creates if needed. The file name combines the enterprise name and the time range, for example device-usage-reports/MY_ENTERPRISE-2026-09-01T00:00:00-2026-09-30T23:59:59-usage-report.csv. ZCLI prints the path when the file is written. If a file with the same name exists, ZCLI overwrites it. The CSV file has one row per edge node with the columns DeviceName, DeviceId, EntpId, DeviceTier, TotalUsageTime, and CPUs. TotalUsageTime is in seconds. The edge node rows are followed by the total number of edge nodes, the usage time for each tier, and the number of edge nodes in each tier. If you run ZCLI in a container, copy the report out of the container or write it to a mounted directory. See Get Started.
--file-format accepts only json and csv in lowercase. With any other value, such as JSON or xlsx, ZCLI fetches the report but writes no file and prints no error.

​
Time zone

ZCLI reads --starts and --ends in the local time zone of the system where ZCLI runs, and converts them to UTC before it sends the request. In the ZCLI container, the local time zone is usually UTC. If a value is not in the format YYYY-MM-DD HH:MM:SS, ZCLI prints input datetime in format %Y-%m-%d %H:%M:%S and stops.

​
View Entitlements

​
View the entitlements of one enterprise

Show the current usage and the limits for one enterprise.
Example:
The output shows three pairs of values: current and maximum edge nodes, current and maximum users, and current and maximum third-party integrations.
An enterprise can have separate edge node limits for different edge node sizes. The text output shows only the first edge node entry. To see every edge node size and its limit, add the global --format=json option, or export the entitlements as described in Export entitlements.

​
List entitlements

Run zcli entitlement show without a name to list the entitlements of every enterprise that you can access. The list shows the maximum edge nodes, users, and third-party integrations for each enterprise. To list the entitlements of all enterprises:
To list the entitlements of enterprises whose name contains MY_:

​
Export and Set Entitlements

​
Export entitlements

Save the entitlements of an enterprise to a JSON file.
Example:
ZCLI creates a directory named after the enterprise in the current working directory and writes the entitlements to <name>/entitlement.json. If the directory already exists, ZCLI prints Remove directory <name> and try again and does not export. ZCLI creates the directory before it looks up the enterprise, so if the enterprise name is wrong, an empty directory is left behind. Remove it before you try again.

​
Set entitlements

Change the limits of an enterprise from a JSON configuration file.
ZCLI reads the enterprise’s current entitlements, applies the limits from your file, and sends the result back. Only the following entries in the file are used. Anything else in the file is ignored. The simplest way to build the file is to export the current entitlements, edit the limits, and pass the edited file to set:
  1. Export the current entitlements:
  2. Edit the limits in the exported file.
  3. Set the entitlements from the edited file:
Each size in devices must already exist in the enterprise’s entitlements. If the file contains a size that the enterprise does not have, ZCLI does not add it. Instead, ZCLI stops responding and never sends the request. Press Ctrl+C to stop it. To add a new edge node size, use the Admin Dashboard in the console. See Admin Dashboard.
Keep the following in mind:
  • If you include plugins without pluginTypeEntitlement, ZCLI stops with an Unexpected error executing command 'entitlement' message that names KeyError, and nothing is changed.
  • If you include plugins without pluginTotalLimit, ZCLI sends an empty value for the integration limit.
  • If the file path is wrong or the file is not valid JSON, ZCLI stops with a Python error and nothing is changed.

​
Next Steps

Admin Dashboard

View and edit entitlements across enterprises in the console.

Manage API Tokens and View API Usage

Generate API tokens and view API usage statistics.

Get Started

Install ZCLI, configure access to Edge Infrastructure Services, and sign in.

Overview

All ZCLI command procedures, organized by resource type.