Skip to main content

​
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.

​
Prerequisites

  • You have the SysManager or SysAdmin role in your enterprise. See Manage Roles.
  • ZCLI installed and authenticated. See Get Started With ZCLI 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.
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.
  2. Add the following content to the file and save it (press Esc, then type :wq).
  3. Apply the policy to your project.
  4. Verify that Edge View is now enabled.

​
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.
  2. Start an Edge View session on the node.
  3. Verify that Edge View is active on the node.

​
Terminate a Session

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

​
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

Edge View and Remote Access Overview

Background on the Edge View security model and policy settings.

Configure Edge View with the GUI

Set the Edge View policy and launch remote sessions from the Edge Infrastructure Services console.

Configure Edge View (Advanced Method)

Run the Edge View client script for full diagnostic and SSH access.