close

keyboard_arrow_left

Table of Contents Expand all

play_arrow Getting Started
- Get Started
- Log in to Apstra GUI
- Reset Apstra GUI Admin Password
play_arrow Blueprints
- Blueprint Summaries and Dashboard
- Freeform Blueprints Introduction
- Blueprint-Wide Search
- Create Blueprint
- Delete Blueprint
play_arrow Blueprint Analytics
- What are Blueprint Analytics
- play_arrow Dashboards
- play_arrow Anomalies
  - Anomalies (Analytics)
- play_arrow Probes
- play_arrow Predefined Reports
- play_arrow Root Causes
  - Root Causes
play_arrow Staged Datacenter Blueprints
- play_arrow Physical
  - play_arrow Build
  - play_arrow Topology
    - Topology (Datacenter)
  - play_arrow Nodes
  - play_arrow Links
    - Links (Datacenter)
    - play_arrow Add Links
    - play_arrow Cabling Map
    - play_arrow Link Speeds
    - play_arrow LAG
    - Update Tags on Link (Datacenter)
    - Change Assigned Link IP Addresses (Datacenter)
    - Update Link Properties
    - Fetch LLDP Data (Datacenter)
    - Delete Link (Datacenter)
  - play_arrow Interfaces
  - play_arrow Racks
  - play_arrow Pods
  - play_arrow Planes
- play_arrow Virtual
  - play_arrow Virtual Networks
  - play_arrow Routing Zones
  - play_arrow Static Routes
    - Static Routes (Virtual)
  - play_arrow Protocol Sessions
    - Protocol Sessions (Virtual)
  - play_arrow Virtual Infrastructure
- play_arrow Policies
  - play_arrow Endpoints
  - play_arrow Security Policies
    - Security Policies
  - play_arrow Interface Policies
    - Interface Policies
  - play_arrow Routing Policies
  - play_arrow Routing Zone Constraints
    - Routing Zone (VRF) Constraints
  - play_arrow Tenants
- play_arrow Data Center Interconnect (DCI)
  - play_arrow Integrated Interconnect
    - Integrated DCI (VXLAN Stitching)
  - play_arrow Over the Top or External Gateways
    - Data Center Interconnect Introduction
    - Data Center Interconnect (DCI) / Remote EVPN Gateways
  - play_arrow Settings
  - Update ESI MAC msb
- play_arrow Catalog
  - play_arrow Logical Devices
    - Export Logical Device
  - play_arrow Interface Maps
    - Import Interface Map
    - Delete Interface Map (Blueprint)
  - play_arrow Property Sets
  - play_arrow Configlets
  - play_arrow AAA Servers
    - AAA Servers (Datacenter Blueprint)
  - play_arrow Tags
- play_arrow Tasks
  - Tasks (Datacenter) Staged
- play_arrow Connectivity Templates
- play_arrow Fabric Settings
  - play_arrow Fabric Policy
  - play_arrow Severity Preferences
    - Update Severity Preferences
play_arrow Staged Freeform Blueprints
- Freeform Introduction
- play_arrow Blueprints
  - Export Freeform Blueprint
- play_arrow Physical
- play_arrow Resource Management
  - Resource Management Introduction (Freeform)
  - play_arrow Blueprint Resources
  - play_arrow Allocation Groups
    - Create Allocation Group (Freeform)
  - play_arrow Local Pools
    - Create Local Pool (Freeform)
    - Create Local Pool Generator (Freeform)
- play_arrow Catalog (Freeform)
  - play_arrow Config Templates
  - play_arrow Device Profiles
    - Import Device Profile (Freeform)
    - Delete Device Profile (Freeform)
  - play_arrow Property Sets
  - play_arrow Tags
- play_arrow Tasks
  - Tasks - Staged (Freeform)
play_arrow Uncommitted Blueprints
- Uncommitted Introduction
- Commit / Revert Changes to Blueprint
play_arrow Active Datacenter Blueprints
- Active (Datacenter Blueprint)
- play_arrow Topology (Active)
- Nodes (Active)
- Links (Active)
- Racks (Active)
- Pods (Active)
- Query
- Anomalies (Service)
play_arrow Time Voyager (Blueprints)
- Time Voyager Introduction
- Roll Back Blueprint Revision
- Keep Blueprint Revision
- Change Number of Saved Blueprint Revisions
- Update Blueprint Revision Description
- Delete Blueprint Revision
play_arrow Devices
- Device Configuration Lifecycle
- What are Managed Devices
- Add Managed Device
- Drain Device Traffic
- Upgrade Device NOS
- Device AAA
- play_arrow Device
- play_arrow Agent
  - What are System Agents
  - Create Onbox Agent
  - Create Offbox Agent
  - Update Agent
  - Uninstall Agent
  - Delete Agent
  - play_arrow Agent Profiles
  - Packages (Devices)
- play_arrow Pristine Config
  - Edit Pristine Config
  - Update Pristine Config from Device
- play_arrow Telemetry
  - Device Telemetry Services
- play_arrow Apstra ZTP
- play_arrow Device Profiles
play_arrow Design
- play_arrow Logical Devices
- play_arrow Interface Maps
- play_arrow Rack Types
- play_arrow Templates
- play_arrow Config Templates (Freeform)
  - Config Templates (Freeform Design)
- play_arrow Configlets (Datacenter)
- play_arrow Property Sets (Datacenter)
- play_arrow TCP/UDP Ports
- play_arrow Tags
play_arrow Resources
- What are Resources
- ASNs
- VNIs
- Integers
- IPv4 Addresses
- IPv6 Addresses
play_arrow Analytics - Telemetry
- Telemetry Services
- Telemetry Service Registry
- Create Telemetry Service Schema
- Telemetry Collection Statistics
- Telemetry Streaming
- Route Anomalies for a Host - Example
- Juniper Telemetry Commands
- Cisco Telemetry Commands
- Arista Telemetry Commands
- Linux Server Telemetry Command
- Debugging Telemetry
play_arrow Analytics - Flow
- play_arrow Apstra Flow Overview
  - Apstra Flow Introduction
  - System Requirements
- play_arrow Dashboards
  - Apstra Flow Dashboards
- play_arrow Supported Flow Records
- play_arrow Flow Enrichment
- play_arrow Monitor Apstra Flow
  - Metrics
- play_arrow Configuration Reference
- play_arrow API
  - API Endpoints Options
- play_arrow Additional Documentation
- play_arrow Knowledge Base
play_arrow Analytics - Exploratory Analytics
- QBA Exporatory Interface
play_arrow External Systems (RBAC Providers)
- play_arrow Providers
- play_arrow Provider Role Mapping
play_arrow Platform
- play_arrow User Management
  - User / Role Management Introduction
  - play_arrow Users
  - play_arrow Roles
- play_arrow Security
- play_arrow External Services
  - Syslog Configuration (Platform)
- play_arrow Streaming
  - Receivers (Platform)
  - Global Statistics (Platform)
- Event Log (Audit Log)
- Licenses
- play_arrow Apstra VM Clusters
- play_arrow Developers
- play_arrow Technical Support
- Check Apstra Versions and Patent Numbers
play_arrow Favorites & User
- Favorites & User
play_arrow Apstra Server Management
- Apstra Server Introduction
- Monitor Apstra Server via CLI
- Restart Apstra Server
- Reset Apstra Server VM Password
- Reinstall Apstra Server
- Apstra Database Overview
- Back up Apstra Database
- Restore Apstra Database
- Reset Apstra Database
- Migrate Apstra Database
- Replace SSL Certificate on Apstra Server with Signed One
- Replace SSL Certificate on Apstra Server with Self-Signed One
- Change Apstra Server Hostname
- FIPS 140-2 Support
play_arrow Apstra CLI Utility
- Install Apstra CLI Utility
- Apstra CLI Commands
play_arrow Guides
- 5-Stage Clos Architecture
- Juniper EVPN Support
- Extensible Telemetry Guide
- Intent-Based Analytics with apstra-cli Utility
- AOSOM-Streaming Guide
play_arrow References
- play_arrow Feature Matrix
  - Apstra 5.0.0 Feature Matrix
- play_arrow Devices
- play_arrow Blueprint Analytics
- Configlet Examples (Design)
- Apstra EVPN Support Addendum
- Apstra Server Configuration File
- Graph
- Juniper Apstra Tech Previews

list Table of Contents

English

keyboard_arrow_right

Configure ztp.json with CLI

Release: Juniper Apstra 5.0

date_range 04-Nov-24

arrow_backward

arrow_forward

SSH in to the Apstra ZTP server and configure the ztp.json file.

To lessen the chance of errors, we recommend using the Apstra ZTP GUI Configurator to configure ztp.json, but you have the option of using CLI instead, as described below. You can configure ZTP configuration directly with text editors such as vi or nano.

Configure ztp.json with CLI

Open a terminal and SSH into the Apstra ZTP server.
ssh admin@<apstra-ztp-server-ip> where <apstra-ztp-server-ip> is the IP address of the Apstra ZTP server.

The ZTP configuration file is on the Apstra ZTP VM in the /containers_data/tftp directory.

content_copy zoom_out_map
admin@apstra-ztp:~$ sudo ls -l /containers_data/tftp
total 336
-rwxrwxrwx 1 admin admin   2448 Aug 28 16:39 config_verifier.py
-rwxrwxrwx 1 admin admin    742 Aug 28 16:39 container_init.sh
-rwxr-xr-x 1 admin admin    292 Sep 11 15:17 cumulus_slicer_custom.sh
-rwxrwxrwx 1 admin admin    178 Aug 28 16:39 Dockerfile
-rwxrwxrwx 1 admin admin    107 Aug 28 16:39 eos_custom.sh
-rwxr-xr-x 1 admin admin     75 Sep 11 15:17 eos_slicer_custom.sh
-rwxrwxrwx 1 admin admin   5735 Aug 28 16:39 junos_apstra_ztp_bootstrap.sh
-rwxrwxrwx 1 admin admin   1799 Aug 28 16:39 junos_custom.sh
-rwxr-xr-x 1 admin admin    564 Sep 11 15:17 junos_evo_slicer_custom.sh
-rwxr-xr-x 1 admin admin    517 Sep 11 15:17 junos_slicer_custom.sh
-rwxr-xr-x 1 admin admin    214 Sep 11 15:17 linux_slicer_custom.sh
-rwxrwxrwx 1 admin admin     86 Aug 28 16:39 nxos_custom.sh
-rwxr-xr-x 1 admin admin     78 Sep 11 15:17 nxos_slicer_custom.sh
-rwxrwxrwx 1 admin admin    205 Aug 28 16:39 poap-md5sum
-rw-rw-r-- 1 admin admin  26720 Sep 11 15:17 pxelinux.0
-rwxrwxrwx 1 admin admin   1843 Aug 28 16:39 rsyslog.conf
-rwxrwxrwx 1 admin admin    170 Aug 28 16:39 sonic_custom.sh
-rwxr-xr-x 1 admin admin     88 Sep 11 15:17 sonic_slicer_custom.sh
-rwxrwxrwx 1 admin admin   2640 Sep 11 15:17 ztp.json
-rwxrwxrwx 1 admin admin 115549 Aug 28 16:58 ztp.py
-rwxrwxrwx 1 root  root  115506 Aug 28 16:58 ztp.py.md5

Open the ztp.json file with a text editor, such as vi or nano.
```
admin@apstra-ztp:~$ sudo nano /containers_data/tftp/ztp.json
```

The default section includes default key-value pairs. The values defined here are applied to all devices, unless the same key is defined in more specific sections, such as for specific platforms, models, or serial numbers. More specific keys take precedence over less specific keys. See ztp.json Keys for key details.

content_copy zoom_out_map
{
   "defaults": {
      "nxos-image": "http://buildfiles.dc1.apstra.com/apstrktr/switch_images/cisco/nxos.10.2.5.bin",
      "eos-image": "http://buildfiles.dc1.apstra.com/apstrktr/switch_images/arista/EOS-4.27.6M.swi",
      "cumulus-image": "http://buildfiles.dc1.apstra.com/apstrktr/switch_images/cumulus/cl-4.2.1-bcm-amd64.bin",
      "junos-image": "http://10.24.128.10/apstrktr/switch_images/juniper/junos-5e-22.2R3.15.tgz",
      "junos-evo-image": "http://10.24.128.10/apstrktr/switch_images/juniper/junos-evo-install-qfx-ms-fixed-x86-64>
      "sonic-image": "http://buildfiles.dc1.apstra.com/apstrktr/switch_images/sonic/sonic-4.0.5-GA-adv-bcm.bin",
      "license": "http://onie.dc1.apstra.com/lic/cumulus.lic",
      "device-root-password": "admin",
      "device-user": "admin",
      "device-user-password": "admin"
   },

or this one?

content_copy zoom_out_map
{
  "defaults": {
    "nxos-versions": [
      "nxos-version1"
    ],
    "nxos-image": "aos_nxos_image.bin",
    "eos-versions": [
      "eos-version1",
      "eos-version2"
    ],
    "eos-image": "aos_eos_image.bin",
    "junos-versions": [
      "junos-version1",
      "junos-version2"
    ],
    "junos-image": "http://10.85.24.52/juniper/21.2R1-S2.2/jinstall-host-qfx-5e-x86-64-21.2R1-S2.2-secure-signed.tgz",
    "junos-evo-versions": [
      "junos-evo-version1"
    ],
    "junos-evo-image": "http://server_address/path/to/install_package_name.tgz",
    "sonic-versions": [
      "sonic-version1",
      "sonic-version2"
    ],
    "sonic-image": "http://server_address/path/to/sonic_package_name.bin",
    "device-root-password": "admin",
    "device-user": "aosadmin",
    "device-user-password": "aosadmin",
    "custom-config": "",
    "management-subnet-prefixlen": "",
    "management-master-ip": "",
    "management-backup-ip": "",
    "management-ip": "",
    "management-gw-ip": "",
    "dual-routing-engine": false,
    "system-agent-params": {
      "platform": "",
      "agent_type": "onbox",
      "operation_mode": "",
      "profile": "",
      "install_requirements": false,
      "job_on_create": "",
      "force_package_install": false,
      "enable_monitor": false,
      "packages": [],
      "id": ""
    }
  },
  "junos": {
    "nxos-versions": [],
    "nxos-image": "",
    "eos-versions": [],
    "eos-image": "",
    "junos-versions": [
      "21.2R1-S2.2"
    ],
    "junos-image": "http://10.85.24.52/juniper/21.2R1-S2.2/jinstall-host-qfx-5e-x86-64-21.2R1-S2.2-secure-signed.tgz",
    "junos-evo-versions": [],
    "junos-evo-image": "",
    "sonic-versions": [],
    "sonic-image": "",
    "device-root-password": "root123",
    "device-user": "aosadmin",
    "device-user-password": "aosadmin123",
    "custom-config": "",
    "management-subnet-prefixlen": "",
    "management-master-ip": "",
    "management-backup-ip": "",
    "management-ip": "",
    "management-gw-ip": "",
    "dual-routing-engine": false,
    "system-agent-params": {
      "platform": "junos",
      "agent_type": "offbox",
      "install_requirements": false,
      "job_on_create": "install",
      "force_package_install": false,
      "packages": []
    }
  },
  "junos-evo": {
    "nxos-versions": [],
    "nxos-image": "",
    "eos-versions": [],
    "eos-image": "",
    "junos-versions": [],
    "junos-image": "",
"junos-evo-versions": [],
    "junos-evo-image": "",
    "sonic-versions": [],
    "sonic-image": "",
    "device-root-password": "root123",
    "device-user": "",
    "device-user-password": "aosadmin123",
    "custom-config": "",
    "management-subnet-prefixlen": "",
    "management-master-ip": "",
    "management-backup-ip": "",
    "management-ip": "",
    "management-gw-ip": "",
    "dual-routing-engine": false,
    "system-agent-params": {
      "platform": "junos",
      "agent_type": "offbox",
      "operation_mode": "",
      "profile": "",
      "install_requirements": false,
      "job_on_create": "install",
      "force_package_install": false,
      "enable_monitor": false,
      "packages": [],
      "id": ""
    }
  },
  "eos": {
    "nxos-versions": [],
    "nxos-image": "",
    "eos-versions": [],
    "eos-image": "",
    "junos-versions": [],
    "junos-image": "",
    "junos-evo-versions": [],
    "junos-evo-image": "",
    "sonic-versions": [],
    "sonic-image": "",
    "device-root-password": "",
    "device-user": "",
    "device-user-password": "",
    "custom-config": "eos_custom.sh",
    "management-subnet-prefixlen": "",
    "management-master-ip": "",
    "management-backup-ip": "",
    "management-ip": "",
    "management-gw-ip": "",
    "dual-routing-engine": false,
    "system-agent-params": {
      "platform": "",
      "agent_type": "",
      "operation_mode": "",
      "profile": "",
      "install_requirements": false,
      "job_on_create": "",
      "force_package_install": false,
      "enable_monitor": false,
      "packages": [],
      "id": ""
    }
  },
  "nxos": {
    "nxos-versions": [],
    "nxos-image": "",
    "eos-versions": [],
    "eos-image": "",
    "junos-versions": [],
    "junos-image": "",
    "junos-evo-versions": [],
    "junos-evo-image": "",
    "sonic-versions": [],
    "sonic-image": "",
    "device-root-password": "admin123",
    "device-user": "",
    "device-user-password": "",
    "custom-config": "",
    "management-subnet-prefixlen": "",
    "management-master-ip": "",
    "management-backup-ip": "",
    "management-ip": "",
    "management-gw-ip": "",
    "dual-routing-engine": false,
    "system-agent-params": {
      "platform": "",
      "agent_type": "onbox",
      "operation_mode": "",
      "profile": "",
      "install_requirements": false,
      "job_on_create": "",
      "force_package_install": false,
      "enable_monitor": false,
      "packages": [],
      "id": ""
    }
  },
  "JNP10002-60C [QFX10002-60C]": {
    "nxos-versions": [],
    "nxos-image": "",
    "eos-versions": [],
    "eos-image": "",
    "junos-versions": [
      "21.2R1-S1.3"
    ],
    "junos-image": "http://10.85.24.52/juniper/21.2R1-S1.3/junos-vmhost-install-qfx-x86-64-21.2R1-S1.3.tgz",
    "junos-evo-versions": [],
    "junos-evo-image": "",
    "sonic-versions": [],
    "sonic-image": "",
    "device-root-password": "",
    "device-user": "",
    "device-user-password": "",
    "custom-config": "",
    "management-subnet-prefixlen": "",
    "management-master-ip": "",
    "management-backup-ip": "",
    "management-ip": "",
    "management-gw-ip": "",
    "dual-routing-engine": false,
    "system-agent-params": {
      "platform": "",
      "agent_type": "",
      "operation_mode": "",
      "profile": "",
      "install_requirements": false,
      "job_on_create": "",
      "force_package_install": false,
      "enable_monitor": false,
      "packages": [],
      "id": ""
    }
  },
  "QFX10002-36Q": {
    "nxos-versions": [],
    "nxos-image": "",
    "eos-versions": [],
    "eos-image": "",
    "junos-versions": [
      "21.2R1-S2.2"
    ],
    "junos-image": "http://10.85.24.52/juniper/21.2R1-S2.2/jinstall-host-qfx-10-f-x86-64-21.2R1-S2.2-secure-signed.tgz",
    "junos-evo-versions": [],
    "junos-evo-image": "",
    "sonic-versions": [],
    "sonic-image": "",
    "device-root-password": "",
    "device-user": "",
    "device-user-password": "",
    "custom-config": "",
    "management-subnet-prefixlen": "",
    "management-master-ip": "",
    "management-backup-ip": "",
    "management-ip": "",
    "management-gw-ip": "",
    "dual-routing-engine": false,
    "system-agent-params": {
      "platform": "",
      "agent_type": "",
      "operation_mode": "",
      "profile": "",
      "install_requirements": false,
      "job_on_create": "",
      "force_package_install": false,
      "enable_monitor": false,
      "packages": [],
      "id": ""
    }
  }
}

The platform-specific section includes configuration that's applied to each device based on its platform. For information about custom-config files, see Create Vendor-specific Custom Configuration

content_copy zoom_out_map
   "junos": {
      "device-root-password": "root123",
      "custom-config": "junos_slicer_custom.sh"
   },
   "junos-evo": {
      "device-root-password": "root123",
      "custom-config": "junos_evo_slicer_custom.sh"
   },
   "eos": {
      "custom-config": "eos_slicer_custom.sh"
   },
   "nxos": {
      "custom-config": "nxos_slicer_custom.sh"
   },
   "cumulus": {
      "custom-config": "cumulus_slicer_custom.sh"
   },
   "sonic": {
      "custom-config": "sonic_slicer_custom.sh"
   },
   "linux": {
      "custom-config": "linux_slicer_custom.sh"
   }
}

Model-specific parameters include the following:

Serial number parameters include the following:

content_copy zoom_out_map
   "5254003765C9": {
      "device-root-password": "root123",
      "junos-versions": [
         "22.2R3.15"
      ],
      "junos-image": "",
      "system-agent-params": null
   },
   "525400EB0A3C": {
      "device-root-password": "root123",
      "junos-versions": [
         "22.2R3.15"
      ],
      "junos-image": "",
      "system-agent-params": null
   },
   "5254002FFA41": {
      "device-root-password": "root123",
      "junos-versions": [
         "22.2R3.15"
      ],
      "junos-image": "",
      "system-agent-params": null
   },
   "525400C36BF6": {
      "device-root-password": "root123",
      "junos-versions": [
         "22.2R3.15"
      ],
      "junos-image": "",
      "system-agent-params": null
   },
   "525400DE0AE4": {
      "device-root-password": "root123",
      "junos-versions": [
         "22.2R3.15"
      ],
      "junos-image": "",
      "system-agent-params": null
   },
   "525400B813C8": {
      "system-agent-params": null
   },
   "5254007F0AF8": {
      "system-agent-params": null
   },
   "5254008DDCCF": {
      "system-agent-params": null
   },
   "525400602A79": {
      "system-agent-params": null
   },
   "5254004D62B3": {
      "system-agent-params": null
   },

arrow_backward PREVIOUS Configure ztp.json with Configurator

NEXT arrow_forward Show Apstra ZTP Logs

Juniper Apstra 5.0.1 / 5.0.0 User Guide

Configure ztp.json with CLI

Configure ztp.json with CLI

Stay in touch

Helped me install or use the product
Accelerated my deployment

Discuss the product with a co-worker
Make a purchase inquiry

Juniper Apstra 5.0.1 / 5.0.0 User Guide

Configure ztp.json with CLI

Configure ztp.json with CLI

Related Documentation

Stay in touch