Onboarding Data Center Switches
“
Specifications:
- Product Name: Apstra Data Center Switch Automation
Solution - Compatibility: Juniper data center switches
- Automation Type: Intent-based networking
- Key Feature: Distributed agent architecture
Product Usage Instructions:
Step 1: System Agents
System agents are essential components for managing devices with
the Apstra automation solution. Ensure you have system agents
installed on all devices before proceeding.
Step 2: Device Configuration Stages
Understand the various device configuration stages outlined in
the user guide to effectively manage and operate your data center
fabric.
Step 3: Onboarding Manually
- Configure the management interface and IP address on the
out-of-band management network. - Click on “Create Onbox Agent(s)” or “Create Offbox Agent(s)” to
initiate the installer. - Enter the required information in the form and click “Create”
to install the agent. - Wait for the installation to complete. The device will appear
in a quarantined state. - Follow additional steps to move the device to the OOS-Ready
state for blueprint assignment.
Step 4: Onboarding with Apstra ZTP
Utilize Apstra ZTP for automatic discovery and onboarding of new
switches or devices reset to factory settings. Check ZTP server
status via the Apstra server GUI for visibility and management.
FAQ:
Q: What is Apstra’s key feature for managing data center
networks?
A: Apstra utilizes intent-based networking to simplify, improve
reliability, and enhance efficiency in operating data center
fabrics.
Q: Can I onboard devices manually with Apstra?
A: Yes, you can manually establish connectivity between switches
and the server by configuring the management interface and using
the Create Agent(s) feature.
Q: Where can I find detailed information on managing devices
with Apstra?
A: Refer to the Managed Devices section of the Juniper Apstra
User Guide for detailed instructions on bringing switches into the
Apstra automation platform.
“`
Day One+
Onboarding Data Center Switches with Apstra – Quick Start
IN THIS GUIDE Step 1: Begin | 1 Step 2: Up and Running | 6 Step 3: Keep Going | 8
Step 1: Begin
IN THIS SECTION System Agents | 2 Device Configuration Stages | 2 Onboarding Manually | 3 Onboarding with Apstra ZTP | 5
This guide walks you through the steps required for getting your Juniper data center switches ready to be deployed with the Apstra automation solution. The main tasks are to install device system agents on devices, then bring those devices under Apstra control, either manually, or automatically with Apstra ZTP. We’ll cover both methods. Once you’ve onboarded your devices, they become Managed Devices, ready to be assigned in one of the Apstra server’s blueprints.
2
NOTE: Before you begin, you must install and configure the Apstra server. For more information, see the Juniper Apstra Quick Start
Apstra automates data center networks of all sizes and complexities. Intent-based networking makes all aspects of operating data center fabrics more simple, reliable, and efficient. A key to achieving such results is how the solution controls each individual device that comprises a managed fabric. The distributed agent architecture is an important component of what makes Apstra a unique and powerful automation solution. Let’s discuss the various elements that comprise the onboarding process.
System Agents
Device system agents manage communication between devices and the Apstra server. They’re responsible for performing configuration on the devices. They also facilitate the transfer of device telemetry, a key component of intent-based analytics (IBA). For all these elements to operate smoothly, Juniper puts supported device models and NOS software through a rigorous system of testing. It’s imperative that you reference the Qualified Device and NOS versions tables when choosing hardware and software versions for your data center fabric. You can install agents directly on a switch in the user space in the NOS (onbox), or you can install them in containers within the Apstra cluster (offbox) and communicate with the device that way. You’ll select one depending on your scenario. Some NOS types don’t support onbox agents. And some network operators don’t want to install agent software directly onto network devices. If you elect to use offbox agents, you must make considerations for cluster capacity to accommodate their location.
Device Configuration Stages
For the Apstra server and managed devices to communicate, Apstra uses an out-of-band management network. For them to be able to communicate, the IP address, user credentials and basic configuration parameters must be in-place. This minimal configuration state is called “pristine configuration.” Once it’s in-place and the switch and server can communicate, you can install a device agent. Apstra then captures the existing device configuration and saves it as a baseline. See a pristine configuration example below.
3
Pristine configuration is the first of several stages that a device can be in when it’s under Apstra management. Devices are placed into various configurations as they are moved in-and-out of operation. To appreciate how the solution operates, it’s essential to understand these stages. Take time to review the terminology and lifecycle details in the Device Configuration Cycle section of the Juniper Apstra User Guide.
Onboarding Manually
The minimum steps needed to manually establish connectivity between the switch and the server are as follows: 1. Configure the management interface and IP address on the out-of-band management network. Include a default
route for the management interface to reach the server. 2. Set user credentials and password needed for the Apstra server to establish connection with the switch. 3. Enable the switch’s API that’s used by the server to configure the device throughout its lifecycle. The exact commands to perform the above steps vary depending on the selected vendor NOS. Refer to the Juniper Apstra User Guide for details for supported vendors. Once the switch can ping the Apstra server, you can use the Device Installer to install the agent. Do this from the Managed Devices view.
4
To initiate the installer, click either Create Onbox Agent(s) or Create Offbox Agent(s) in the upper right.
Enter the required information into the Create Agent(s) form that opens, then click the Create button. A bit of time is required for the server to perform the installation. When it’s done the device appears in the table view in the quarantined state. There are additional steps that move devices in this state to the OOS-Ready state, where they are available to be assigned into a blueprint.
5 NOTE: Use of the Device Installer to bring switches into the Apstra automation platform is shown in detail in the Managed Devices section of the Juniper Apstra User Guide.
Onboarding with Apstra ZTP
Apstra ZTP resides on its own VM, separate from the Apstra server. It automatically discovers new switches and those that have been reset to factory settings (zeroized). Use the Apstra server GUI to check the state of the ZTP server and management of devices. This provides visibility into all aspects of the process, making it easy to onboard any number of devices quickly and with the desired settings and NOS versions, in-place.
The ZTP service provides DHCP for automatic IP addressing, installation of pristine configurations and the installation of the system agents. Apstra ZTP performs these steps: 1. DHCP (optional)
a. The device requests an IP address via DHCP. b. The device receives the assigned IP address and a pointer to the specified OS image. 2. Device Initialization a. The device downloads the customizable ZTP script via TFTP. b. The device executes script preparing it for management. The OS image is checked and is upgraded, if necessary. c. The device admin/root password is set. d. System Agent ID is initialized. 3. Agent Initialization
6 a. The ZTP script leverages APIs to initiate the agent installation. It recognized automatically whether onbox or
offbox is needed.
The Apstra ZTP service is a comprehensive set of tools that you can customize in various ways to adapt to your specific requirements. Once you have downloaded the server image and performed any customizations, it’s ready to simplify bringing switches into the Apstra automation platform.
NOTE: The Apstra ZTP service requires installation and configuration to adapt to your specific environment. You can find step-by-step instructions for installing and onboarding devices, see the Apstra ZTP chapter in the Juniper Apstra User Guide. Now we’ve seen how devices are initialized. Let’s now look at how we move them into an operating network.
Step 2: Up and Running
IN THIS SECTION Managed Devices | 7
7
Managed Devices
You’ve followed the manual steps or you’ve used ZTP to get your devices installed with their management IP addresses and device agents. Plus, your switches are registered with the Apstra server. But they’re not quite ready for deployment. Just after being added, devices are placed into the Out-of-Service Quarantine state. To place them under full control of the system, they need to be acknowledged.
Once you’ve acknowledged your devices, you can drill into numerous aspects of the device’s status. There are additional tools to show the agent state, allow us to work with the Pristine Config and to view device telemetry.
NOTE: Use of the tools in the Managed Devices view is covered in the Managed Devices section of the Juniper Apstra User Guide.
8 ZTP can initiate NOS upgrades, if needed. But what do you do if you need to upgrade the software after the devices are under control of the system? The good news is that the Managed Devices page hosts a tool that can keep your NOS versions fresh and secure. This is critical for the network to operate properly. It’s also a convenient manner to deal with any issues that may be encountered that require you to perform an update. The NOS management tool offers flexibility for image storage location and visibility into installation progress.
NOTE: Upgrading the NOS of a device from the Managed Devices view is described in detail in the Upgrade Device NOS section of the Juniper Apstra User Guide.
Step 3: Keep Going
IN THIS SECTION What’s Next? | 9
9
General Information | 9 Learn with Videos | 10
Now that you have your devices connected and in tip-top condition, you can keep going onto the next stages of automating your data center deployment. Use these links to continue your journey with Apstra data center automation.
What’s Next?
If you want to
Then
Replace the SSL certificate with a secure one
See the Apstra Installation / Configure Apstra Server / Replace SSL Certificate section in the Juniper Apstra Installation and Upgrade Guide
Configure user access with user profiles and roles
See thePlatform / User/Role Managementsection in the Juniper Apstra User Guide
Build your virtual environment with virtual networks and routing zones
See theStaged / Virtualsection in the Juniper Apstra Usr Guide
Learn about Apstra telemetry services and how you can extend See the Devices / Telemetry section in the Juniper Apstra User
them
Guide
Learn how to leverage intent-based analytics (IBA) with apstra- See Intent-Based Analytics with apstra-cli Utility in the Juniper
cli
Apstra User Guide
General Information
If you want to
See all Juniper Apstra documentation
Stay up to date about new and changed features and known and resolved issues in Apstra
Then See the Juniper Apstra documentation page. See the Juniper Apstra Release Notes.
10
Learn with Videos
Our video library continues to grow! We’ve created many videos that demonstrate how to do everything from install your hardware to configure advanced Junos OS network features. Here are some great video and training resources that will help you expand your knowledge of Junos OS.
If you want to
Then
Watch short demos to learn how to use Juniper Apstra to automate and validate the design, deployment, and operation of data center networks, from Day 0 through Day 2+
See the Juniper Apstra Demos and Juniper Apstra Data Center videos on the Juniper Networks Product Innovation YouTube page.
Get short and concise tips and instructions that provide quick answers, clarity, and insight into specific features and functions of Juniper technologies
See Learning with Juniper on Juniper Networks main YouTube page.
View a list of the many free technical trainings we offer at Juniper
See the Getting Started page on the Juniper Learning Portal.
Juniper Networks, the Juniper Networks logo, Juniper, and Junos are registered trademarks of Juniper Networks, Inc. in the United States and other countries. All other trademarks, service marks, registered marks, or registered service marks are the property of their respective owners. Juniper Networks assumes no responsibility for any inaccuracies in this document. Juniper Networks reserves the right to change, modify, transfer, or otherwise revise this publication without notice. Copyright © 2025 Juniper Networks, Inc. All rights reserved.
Documents / Resources
![]() |
Juniper NETWORKS Onboarding Data Center Switches [pdf] User Guide Onboarding Data Center Switches, Data Center Switches, Center Switches, Switches |