This topic walks you through the process of downloading and running the Apstra Cloud
Services (ACS) setup validation tool. This tool verifies that you have configured the various
devices and services of your DC fabric correctly.
Before proceeding, ensure that:
Use this tool to check the health and connectivity of your ACS-managed DC fabric. The tool
performs a series of checks to verify the required prerequisites below. Additionally, in
order to ensure an optimal setup process for your DC fabric, the tool verifies that you have
completed the onboarding steps for Juniper Apstra, Apstra Edge, and ACS. The tool performs
the following checks:
-
Juniper Apstra version is 4.1.2 or later
-
Apstra API is reachable from Apstra VM
-
Flowcoll service is configured correctly and up and running
-
Apstra Flow is reachable from Apstra VM
-
Apstra Flow API is reachable from Apstra VM
-
Juniper Apstra VM is reachable
-
Opensearch service is up and running
-
SFlow, SNMP, and collector IP are present in configlet
-
JCloud certificate is present
-
IBA probe is present in blueprint
-
Devices associated with a blueprint can reach Apstra Flow VM
-
Apstra Edge is configured correctly and active
-
Cloud URL (https://dc.ai.juniper.net) is
reachable
To download and run the ACS Setup Validation Tool:
Note: We documented this process using ACS Setup Validation Tool version
0.1.26. The version you download might be a later version.
-
Download the latest tarball file from the Juniper Downloads site.
Note:
To avoid any connectivity issues between the Apstra VM and other VMs or services, we
recommend that you install the ACS Setup Validation Tool on the same VM as the Apstra
controller.
-
Extract the tarball.
tar -xzf acs-setup-validation-tool-0.1.26.tar.gz
-
Navigate to the validation tool directory.
cd acs-setup-validation-tool
-
Enter the environment variables in the sample.env file.
vi sample.env
# IP Address used to ssh into the Apstra AOS VM
AOS_SSH_IP_ADDRESS=<ip-of-apstra-server>
# Username used to ssh into the Apstra AOS VM
AOS_SSH_USERNAME=<aos-username>
# Password used to ssh into the Apstra AOS VM
AOS_SSH_PASSWORD=<aos-password>
# Username used to connect to Apstra AOS API
AOS_API_USERNAME=<aos-ui-username>
# Password used to connect to Apstra AOS API
AOS_API_PASSWORD=<aos-ui-password>
# Version of AOS VM
AOS_VM_VERSION=4.2.1
# IP Address used to ssh into the Apstra Flow VM
FLOW_SSH_IP_ADDRESS=<ip-of-flow-server>
# Username used to ssh into the Apstra Flow VM
FLOW_SSH_USERNAME=<apstra-flow-username>
# Password used to ssh into the Apstra Flow VM
FLOW_SSH_PASSWORD=<apstra-flow-password>
# Username used to connect to opensearch api for Apstra Flow
FLOW_API_USERNAME=<flow-ui-username>
# Password used to connect to opensearch api for Apstra Flow
FLOW_API_PASSWORD=<flow-ui-password>
# Absolute path to docker-compose file for aos-edge docker (default - /home/admin/aos-edge/docker-compose.yml)
# Only enter if Version of AOS VM is less than 5.1.0, or else leave it empty
DOCKER_COMPOSE_PATH=<path-to-docker-compose.yml> (ex. /home/admin/aos-edge/docker-compose.yml)
# Find your organization's ID and API Token.
# - Login to https://dc.ai.juniper.net
# - Go to Organization --> Settings
# - Find your Organization ID.
# - In API Token, select Create Token. Enter a name, click Generate, and copy the Key.
# This is the API Token
ORG_ID=<org-id>
API_TOKEN=<api-token>
# Set to true to see verbose output
DEBUG=false
# Comma separated list of blueprint names
# If empty, skips blueprint specific checks, If all is provided, runs checks for all blueprints)
BLUEPRINTS=all
# Optional. If set to true - preflight tool will collect logs/config files into a tarball for offline debugging
COLLECT_DEBUG_DATA=false
-
Run the tool with the .env file provided (no interaction required).
./precheck.sh --envfile ./sample.env
-
Run the tool interactively. In this mode, you must provide each of the parameters in
sample.env.
Running precheck tool...
Press Ctrl+C to exit
Loaded image: acs-setup-validation-tool:0.1.26
Checking Apstra VM reachability ................................................. ✓ Passed
Checking AOS API reachability ................................................... ✓ Passed
Checking if Apstra VM version is greater than 4.1.2 ............................. ✓ Passed
Checking if the blueprint input is valid ........................................ ✓ Passed
Checking Flow VM reachability from Apstra VM .................................... ✓ Passed
Checking if Apstra API details are present in flowcoll .......................... ✓ Passed
Checking if SNMP details are present in flowcoll ................................ ✓ Passed
Checking if flowcoll service is up and running .................................. ✓ Passed
Checking Gzip compression flag in opensearch .................................... ✓ Passed
Checking if opensearch service is up and running ................................ ✓ Passed
Checking Apstra Flow API reachability from Apstra VM ............................ ✓ Passed
Checking if SFlow, SNMP and collector IP are present in configlet ............... ✓ Passed
Checking if devices associated with a blueprint can reach Apstra Flow VM (60s) .. ✓ Passed
Checking if Jcloud certificate is found ......................................... ✓ Passed
Checking if epterm host is in apstra edge ....................................... ✓ Passed
Checking if registration token is in apstra edge (150s) ......................... ✓ Passed
Checking if the IBA probe is added to the blueprint(s) .......................... ✓ Passed
Checking the IBA probe added has all the relevant details ....................... ✓ Passed
Checking if Juniper Cloud URL and S3 URL are reachable .......................... ✓ Passed
1 run executed in 79.23s (0:01:19)
-
(Optional) Use the
--help command for additional precheck
options.
-
(Optional) Change the default location of the
.precheck.json file
where the tool populates the PASS/FAIL/SKIPPED status results.
./precheck.sh --jsonfile <custom-file-path-to-store-results>
cat .precheck.json
{"timestamp": "2025-01-22T15:47:27.027387+00:00", "test_name": "Checking Apstra VM reachability", "time_taken": 0.6104629039764404, "result": "PASS", "message": "Success.
Apstra VM is reachable."}
{"timestamp": "2025-01-22T15:47:27.248500+00:00", "test_name": "Checking AOS API reachability", "time_taken": 0.21385836601257324, "result": "PASS", "message": "Success.
Apstra API is reachable."}
{"timestamp": "2025-01-22T15:47:49.455211+00:00", "test_name": "Checking if Apstra VM version is greater than 4.1.2", "time_taken": 0.10787129402160645, "result": "PASS",
"message": "Success. Apstra VM version is greater than 4.1.2 and supports flow.Current Apstra VM Version: 4.2.1-164"}
-
(Optional) View the validation tool logs.
-
(Optional) Create a debugging tarball to store logs and config files for offline
debugging support.
If you need help troubleshooting your setup, Juniper uses these files for useful
information about your setup. Juniper redacts sensitive information from the config files
before collection. No sensitive information about your setup is collected.
-
Set the
COLLECT_DEBUG_DATA variable to true in
sample.env.
-
Run the validation tool.
An
acs_setup_validation_debug_<timestamp> tarball is
created.
ls -lrt
total 359828
-rwx------ 1 admin admin 5431 Feb 12 15:49 precheck.sh
-rw------- 1 admin admin 360743936 Feb 12 15:49 acs-setup-validation-tool-0.1.26.tar.gz
-rw------- 1 admin admin 2351 Feb 12 18:59 sample.env
-rw-r--r-- 1 admin admin 7701718 Feb 12 19:02 acs_setup_validation_debug_20250212190244.tar.gz
