ZEDEDA WiKi

User Tools

Site Tools

Trace: • zcli-how-to
zededa:zcli-how-to

This is an old revision of the document!

Table of Contents

Using ZCLI

A practical guide to ZEDEDA CLI (ZCLI), the command-line way to manage ZEDEDA Cloud.

What ZCLI Is

  • ZCLI is one of three ways to talk to ZEDEDA Cloud. The other two are the GUI and the API.
  • It ships as a Docker container, not a native binary.
  • You need Docker Desktop running before you start it.

Starting ZCLI

docker run -it zededa/zcli:latest

First run pulls the image from ZEDEDA's registry, so it takes a moment. After that you're dropped into a zcli> prompt.

Logging In

Two ways to authenticate: username/password, or a session token.

Option 1: Username and Password

  1. Run zcli configure
  2. Enter the server address (default is zedcontrol.zededa.net)
  3. Answer n to “Login with token?”
  4. Enter your username and password
  5. Run zcli login

Option 2: Session Token

  1. Log in to the ZEDEDA GUI
  2. Open your user profile dropdown, top right, then User Details
  3. Copy the session token from the Session Information section
  4. Run zcli configure
  5. Enter the server address
  6. Answer y to “Login with token?”
  7. Paste the token
  8. Run zcli login

Reading the Command Syntax

  • <name> is a value you supply
  • [–title=<title>] is optional
  • [–clear-text=<true|false>] means pick one of the listed choices

If you leave out something required, ZCLI tells you plainly, e.g. Missing required option –dstype.

Getting Help

  • zcli by itself lists every command group.
  • zcli <command> –help shows syntax for that command.
  • man zcli-<command> opens the full manual page (press q to exit).
Key Action
Space / Page Down scroll down a page
b / Page Up scroll up a page
j / Down Arrow scroll down a line
k / Up Arrow scroll up a line
/ then text search forward

Command Groups You'll Actually Use

Command What it manages
edge-node Create, update, activate, reboot, delete edge nodes
project Resource groups that edge nodes and apps live in
network Networking objects assigned to edge node adapters
network-instance App-facing networking within an edge node
edge-app Application manifests
edge-app-instance Running app instances on edge nodes
datastore Image storage locations
image App images inside datastores
volume-instance Storage volumes
events Device events and user action logs
job Long-running tasks across nodes/instances
user / role / auth-profile Access control

Typical Flow: Bringing Up an Edge Node

The GUI onboarding wizard bundles network and project setup for you. In ZCLI you do those pieces yourself, in order:

  1. Create a project: zcli project create <name> …
  2. Create a network: zcli network create (defines the subnet/DHCP mode the node's adapter will use)
  3. Create the edge node itself:

<code> zcli edge-node create MY_EDGE_NODE –project=MY_PROJECT

zededa/zcli-how-to.1787238356.txt.gz · Last modified: by mc