CLI reference


The protect CLI provides a command-line interface for managing and protecting your workloads, zones, images, and more.

Getting started

Select a version to view the specific CLI reference documentation:

Quick reference

To get the version of protect you are running:

protect --version

For a complete list of commands and options, run:

protect --help

Enabling shell autocompletion

Save yourself some keystrokes—enable tab-completion so you don’t have to remember every protect subcommand or flag.

The protect completion command prints out the script required to enable tab-completion for your shell. Once set up, you can hit protect TAB to complete commands and flags.

Bash

# Add the completion script to your current session
source <(protect completion bash)

# To make this persistent across sessions
echo 'source <(protect completion bash)' >>~/.bashrc

Zsh

# Enable completion
protect completion zsh > "${fpath[1]}/_protect"

# Or append it to your ~/.zshrc
echo 'source <(protect completion zsh)' >>~/.zshrc

Make sure compinit is enabled in your .zshrc:

autoload -Uz compinit
compinit

Available commands

The CLI includes commands for:

  • zone Manage the zones on Edera Protect
  • workload Manage the workloads on Edera Protect
  • image Manage the images on Edera Protect
  • network Manage the network on Edera Protect
  • device Manage the devices on Edera Protect
  • host Manage the host of Edera Protect
  • completion Output shell completion code for the specified shell
Last updated on