Command Index

This page lists every ZCLI command group in one table so you can find the right command for a task and jump to the page that documents it. Run zcli with no arguments to list the command groups, and run zcli <command> --help to print the exact syntax for every subcommand in a group. If you have not installed or authenticated ZCLI yet, start with Get Started.

Command Groups

Command	What it manages	Procedures
`api-token`	Generates an API token for the user who is logged in.	Manage API Tokens and View API Usage
`api-usage`	Shows API usage statistics for your enterprise.	Manage API Tokens and View API Usage
`auth-profile`	Manages authentication profiles for signing in to Edge Infrastructure Services.	Manage Authentication Profiles
`brand`	Manages the hardware brands that hardware models belong to.	Manage Hardware Models
`cluster-instance`	Manages cluster instances that run on your nodes.	Manage Kubernetes Cluster Instances
`configure`	Configures how ZCLI connects to Edge Infrastructure Services, including the server address and your credentials.	Get Started
`datastore`	Manages the datastores that hold application images.	Manage Datastores
`datastream`	Manages data streams.	Manage Data Streams
`doc-policy`	Manages the policy documents that users must accept before onboarding to Edge Infrastructure Services.	Manage Policy Documents
`edge-app`	Manages the application definitions that you deploy to your nodes.	Manage Edge Apps
`edge-app-instance`	Manages application instances running on your nodes.	Manage Application Instances
`edge-kubernetes-cluster`	Manages ZEDEDA Edge Kubernetes Service clusters.	Manage ZEDEDA Edge Kubernetes Service Clusters
`edge-kubernetes-cluster-group`	Manages groups of ZEDEDA Edge Kubernetes Service clusters.	Manage ZEDEDA Edge Kubernetes Service Cluster Groups
`edge-node`	Manages nodes, including onboarding, configuration, PCR policies, and EdgeView sessions.	Manage Nodes. For `pcr-policy` subcommands, see Manage a PCR Policy. For EdgeView subcommands, see Configure Edge View With the CLI.
`edge-node-cluster`	Manages node clusters.	Manage Node Clusters
`enterprise`	Manages enterprises, including child enterprises.	Partially covered by Create Child Enterprises and Enable Single Sign-On. Run `zcli enterprise --help` for the full syntax.
`entitlement`	Manages the resource and service counts entitled to an enterprise.	View Resource Usage and Entitlements
`events`	Shows events from your nodes, filtered by application instance, project, node, user, severity, or resource.	View Events
`image`	Manages application images in your datastores.	Manage Images
`job`	Manages asynchronous jobs.	Manage Jobs
`login`	Signs you in to Edge Infrastructure Services and stores a session token.	Get Started
`logout`	Signs you out and discards the stored session token.	Get Started
`model`	Manages the hardware models that nodes are built from.	Manage Hardware Models
`network`	Manages the physical connectivity (Ethernet, Wi-Fi, LTE) that nodes use to reach Edge Infrastructure Services and data centers.	Manage Networks
`network-instance`	Manages virtual networks that connect applications within a node and across groups of nodes.	Manage Virtual Networks
`patch-envelope`	Manages patch envelopes, which deliver artifacts to application instances.	Manage Patch Envelopes
`plugin`	Manages plugins.	Run `zcli plugin --help`.
`project`	Manages projects, which group nodes and the resources deployed to them.	Manage Projects
`realm`	Manages realms for an enterprise.	Enable Single Sign-On covers `realm create`, `show`, `update`, and `delete`. Run `zcli realm --help` for the full syntax.
`resource-usage`	Shows a summary and details of active nodes within a time range.	View Resource Usage and Entitlements
`role`	Manages roles.	Manage Roles
`user`	Manages user accounts and their access to your nodes.	Manage Users
`volume-instance`	Manages volume instances.	Manage Volumes

Reading Command Syntax

When you run zcli <command> --help, ZCLI prints the usage for every subcommand in the group. Read the syntax as follows:

Items within angle brackets are your own specific variables, such as <name>.
Items within square brackets are optional, such as [--title=<title>].
Items that contain a pipe are choices, such as between true or false in [--clear-text=<true|false>].

Get started

Infrastructure

Applications

Monitoring and Usage

Administration and Marketplace

Command Groups

Reading Command Syntax

Next Steps

Get Started

Overview

​Command Groups

​Reading Command Syntax

​Next Steps

Get Started

Overview

Command Groups

Reading Command Syntax

Next Steps