Use the ZEDEDA CLI to Manage a Project

Introduction

A project in ZEDEDA Cloud is a logical grouping of edge nodes, edge app policies, attestation policies, and others. These are grouped together so that when an edge node joins a project, the project has all the policies predefined, and the edge nodes can be more easily managed.

When you create an edge node in your enterprise, you are prompted to assign a project to the edge node. Some planning must be done in advance to determine which policies you want your project to contain before you apply it to your edge nodes.

This article explains how to manage projects using the ZEDEDA CLI, including create, show, update, and delete commands, with examples for each action.

Prerequisites

This is a series of articles. You will likely follow them in this order.

1. Projects Overview 
2. Create a Project
3. Configure the Project Policies 
4. Manage a Project
5. Use the ZEDEDA CLI to Manage a Project  - You are here!

Manage Projects

Create a Project

Create a project from the ZCLI.

zcli project create <name> [--title=<title>] [--description=<description>] [--policy-config=<type:config-path>...] [--enable-interface-ordering=<true|false>] [--project-type=<type>] [--tags=<key:value>...] [(--deployment-name=<dname> --deployment-tag=<dtag> [--app-inst-config=<app-inst-config>] [--net-inst-config=<net-inst-config>] [--vol-inst-config=<vol-inst-config>] [--dev-policy-config=<dev-policy-config>] [--deployment-title=<title>] [--edgeview-config=<edgeview-config>])]

zcli project create MY_PROJECT --description=MY_FIRST_DESCRIPTION --enable-interface=true --project-type=deployment --vol-inst-config=MY_VOL_INST
      

View a Project

After you create a project, you can view the configuration details for that project.

zcli project show [[[<name> | --uuid=<uuid>] [--detail] [--edgeview]] | [[--name-pattern=<name-pattern>] [--summary] [--page-size=<page-size>] [--tags=<key:value>...]]]

zcli project show MY_PROJECT --detail
      

Project Name: MY_PROJECT
Project ID: 6e26442f-2c7e-4590-bd80-ca33b7919984
Project Title: MY_PROJECT
Project Description: MY_FIRST_DESCRIPTION
Tags:
Flowlog Transmission: Disabled
App Interface Ordering: Enabled
State: Active
Edge Nodes: 0
Attestation Policy: MY_PROJECT_DFSCPqSaCZkBCXk (Ready)
Attestation type: Accept
Version: 1
Created at:  Sun Mar 30 2025 05:50:39 AM
Created By: user@zededa.com
Last Updated at:  Sun Mar 30 2025 05:50:39 AM
Last Updated By: user@zededa.com

Update a Project

After you create a project, you can update the identity details, project description, policy tags, enable/disable interface ordering, and other options.

zcli project update <name> [--title=<title>] [--description=<description>] [--config=<key:value>...] [--policy-config=<type:config-path...>] [--tags=<key:value>...] [--enable-interface-ordering=<true|false>]

zcli project update MY_PROJECT –-description=MY_SECOND_DESCRIPTION
      

Delete a Project

After you add a project, you can delete it if you no longer need it.

zcli project delete <name> [-f]

zcli project delete MY_PROJECT
      

Manage Project Deployments

View a Project Deployment

After you create a project deployment, you can view the details for that project. 

Use the following command to acquire the deployment-id. 

Note: Make sure to enter the name of the project and not the name of the project-deployment. 

zcli project show-deployment <project-name>

zcli project show-deployment MY_PROJECT
      

Deployment-ID Title   Description  Version
-------------- ---------- -------------- ----------- -------
MY_DEPLOYMENT3-v1 219eb37e-6dfb-42d4-bd9d-e21554c1c2f2 MY_DEPLOYMENT  

Next, you can copy the deployment-id (219eb37e-6dfb-42d4-bd9d-e21554c1c2f2) from the output of the command above, and paste that value into the command below. This will allow you to view the details for the project deployment. 

zcli project show-deployment <project-name> [--deployment-id=<deployment-id>]

zcli project show-deployment MY_PROJECT  –--deployment-id=219eb37e-6dfb-42d4-bd9d-e21554c1c2f2
      

Deployment name: MY_DEPLOYMENT-v1
Deployment id: 219eb37e-6dfb-42d4-bd9d-e21554c1c2f2
Edgeview Policy: test-edgeView-jh53-v1
Edgeview Allow: True, Max Expire(sec): 2592000, Max Instances: 3
Allow Change: True, Dev: True, App: True, Ext: False
JWT Info: url: zedcloud.gmwtus.zededa.net/api/v1/edge-view, sec: 18000, inst: 1, enc: False  

Update a Project Deployment

After you create a project deployment, you can update it by modifying any of the policies in that project deployment.

zcli project update-deployment <project-name> --deployment-id=<deployment-id> [--app-inst-config=<app-inst-config>] [--net-inst-config=<net-inst-config>] [--vol-inst-config=<vol-inst-config>] [--dev-policy-config=<dev-policy-config>] [--deployment-tag=<dtag>] [--deployment-title=<title>] [--edgeview-config=<edgeview-config>]

zcli project update-deployment MY_PROJECT
  --deployment-id=219eb37e-6dfb-42d4-bd9d-e21554c1c2f2 
      

Delete a Project Deployment

After you create a project deployment, you can delete the project deployment.

zcli project delete-deployment <project-name> [--deployment-id=<deployment-id>] [-f]

zcli project delete-deployment MY_PROJECT
  --deployment-id=219eb37e-6dfb-42d4-bd9d-e21554c1c2f2
      

Delete deployment 219eb37e-6dfb-42d4-bd9d-e21554c1c2f2? [Y/N]: Y

Export a Project Deployment

After you create a project deployment, you can export the project deployment with the command below.  

zcli project export-deployment <project-name> --deployment-id=<deployment-id>

zcli project export-deployment MY_PROJECT
  --deployment-id=219eb37e-6dfb-42d4-bd9d-e21554c1c2f2
      

Manage Flowlogs

Flowlogs enable you to collect information about application network flows for the edge network instances in the project. Flowlogs include attributes such as the source and destination IP or port, ACL rules applied, and packet or byte counters. 

Enable project flowlogs

Flowlogs are disabled by default, but you can enable them at the project level with the following command:

zcli project enable-flowlog <name>

zcli project enable-flowlog MY_FLOWLOG
      

Disable Project Flowlogs

After you create a flowlog for a project, you can disable the flowlog using the following command:

zcli project disable-flowlog <name>

zcli project disable-flowlog MY_FLOWLOG
      

Next Steps

This is a series of articles. You will likely follow them in this order.

1. Projects Overview 
2. Create a Project
3. Configure the Project Policies 
4. Manage a Project
5. Use the ZEDEDA CLI to Manage a Project  - You are here!

After you’ve completed the series, you might be interested in the following articles:

• If you’re adding a project while onboarding an edge node, then the next step might be to add edge apps from the Marketplace.
• If you’re adding a project independent of the edge node onboarding workflow, then the next step might likely be to add an edge node.