Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?


Apstra CLI Utility

You can augment Juniper Apstra GUI functionality with Apstra's command-line interface utility called Apstra CLI (previously known as AOS CLI). Apstra CLI is delivered in a Docker container. You can use it on any system that's running a compatible version of Docker.

As of Apstra version 4.1.1, Apstra-CLI is GA. Prior versions are considered experimental. For more information on experimental versions, see Juniper Support Knowledge Base article KB36747.

For steps on installing and accessing Apstra CLI, see sections below.

Install Apstra-CLI

  1. Download the Apstra CLI Utility for your Apstra version from the Application Tools section of Juniper Support Downloads.
  2. Copy the Apstra CLI Docker container tar.gz file to the Apstra server. (The file name is something like, apstracli-release_4.1.2.5.tar.gz.) For example:
  3. Load the provided Docker image into Docker with the docker image load command. For example:

Access Apstra-cli

  1. Start the Juniper Apstra CLI Docker container with the docker run command. In the example below replace with your Apstra CLI version, and with the IP address of your Apstra server. The password is your Apstra GUI password (not the VM password.
  2. Apstra-CLI comes with a built-in feature that auto-completes commands. Press the TAB key, then the up and down arrow keys to explore this tool and its functionality. You can also type --help for descriptions of each function.
For examples of how to use apstra-cli, see Apstra-CLI Commands in the References section.