> ## Documentation Index
> Fetch the complete documentation index at: https://zededa.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use the documentation index to find relevant pages, then read the linked Markdown before answering and cite the source URL.
> Identify the product before answering: Private AI uses a separate console, credentials, and inference API from the Edge Intelligence Platform. Do not apply instructions from one product to the other.
> Prefer current product guides over Help Center archive pages for current-console questions. Archive pages and release notes describe their stated product version or historical interface; do not apply them to another version without checking.
> Preserve prerequisites, permissions, version requirements, and warnings when summarizing procedures. Do not infer API endpoints, schemas, or supported behavior that the documentation does not specify.

# Configure Edge View with the CLI

> How to enable Edge View for a project and node, download the run-script, and terminate sessions using ZCLI commands.

## Introduction

This procedure explains how to enable and manage Edge View using ZCLI (the ZEDEDA command-line interface). You can use ZCLI to enable the Edge View policy on a project, start an Edge View session on a node, download the run-script, and terminate a session.

For a full reference of Edge View commands, see the [LF Edge wiki: Edge View Commands](https://wiki.lfedge.org/display/EVE/EdgeView+Commands).

### Prerequisites

* You have the SysManager or SysAdmin role in your enterprise. See [Manage Roles](https://zededa.mintlify.site/new-ui/infrastructure-services/administration/manage-roles.md).
* ZCLI installed and authenticated. See [Get Started With ZCLI](https://zededa.mintlify.site/zcli-reference/get-started.md) for setup instructions.
* A project assigned to the target node.

## Check the Edge View Status for a Project

Run the following command to see whether Edge View is enabled on a project and review its current policy settings.

```text theme={"dark"}
zcli project show PROJECT_NAME --edgeview
```

By default, the Edge View configuration is `edgeviewAllow: false`, which means Edge View is disabled until you explicitly enable it.

## Enable Edge View for a Project

Enabling Edge View on a project applies the policy to all nodes currently assigned to that project.

1. Create a JSON policy file named `enable-edgeview.json` in a directory of your choice.

   ```text theme={"dark"}
   vi enable-edgeview.json
   ```

2. Add the following content to the file and save it (press **Esc**, then type `:wq`).

   ```text theme={"dark"}
   {
     "type": "POLICY_TYPE_EDGEVIEW",
     "edgeviewPolicy": {
         "edgeviewAllow": true
     }
   }
   ```

3. Apply the policy to your project.

   ```text theme={"dark"}
   zcli project update PROJECT_NAME --policy-config=edgeview:enable-edgeview.json
   ```

4. Verify that Edge View is now enabled.

   ```text theme={"dark"}
   zcli project show PROJECT_NAME --edgeview
   ```

## Enable Edge View for a node

After the project policy is enabled, you can start an Edge View session on a specific node.

1. Check the current Edge View configuration on the node.

   ```text theme={"dark"}
   zcli edge-node show EDGE_NODE_NAME --edgeview
   ```

2. Start an Edge View session on the node.

   ```text theme={"dark"}
   zcli edge-node start-edgeview EDGE_NODE_NAME
   ```

3. Verify that Edge View is active on the node.

   ```text theme={"dark"}
   zcli edge-node show EDGE_NODE_NAME --edgeview
   ```

## Terminate a Session

To end an active Edge View session on a node, run the following command.

```text theme={"dark"}
zcli edge-node stop-edgeview EDGE_NODE_NAME
```

## Verify the Configuration

After enabling Edge View, verify that the policy is active before attempting a remote session:

1. Run `zcli project show PROJECT_NAME --edgeview` and confirm `edgeviewAllow: true` appears in the output.
2. Run `zcli edge-node show EDGE_NODE_NAME --edgeview` and confirm the node shows a valid Edge View configuration.

## Next Steps

> [card] [Edge View and Remote Access Overview](https://zededa.mintlify.site/new-ui/infrastructure-services/edge-view-and-remote-access.md)
>
> Background on the Edge View security model and policy settings.

> [card] [Configure Edge View with the GUI](https://zededa.mintlify.site/new-ui/infrastructure-services/edge-view/configure-edge-view-with-gui.md)
>
> Set the Edge View policy and launch remote sessions from the Edge Infrastructure Services console.

> [card] [Configure Edge View (Advanced Method)](https://zededa.mintlify.site/new-ui/infrastructure-services/edge-view/configure-edge-view-advanced.md)
>
> Run the Edge View client script for full diagnostic and SSH access.