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

Resource Pools (API)

Release: Juniper Apstra 5.0

date_range 04-Nov-24

arrow_backward

arrow_forward

This reference demonstrates the resource group API usage with parity to the UI. For full API documentation, view the REST Platform API reference under the Apstra GUI.

To list resource group slots in a blueprint, perform an authenticated HTTP GET to https://aos-server/api/blueprints/<blueprint_id>/resource_groups

Both ASN pools and IP pools must be assigned in order for a blueprint to complete the build phase.

Create ASN Pool

An example payload for creating an ASN Pool:

If an ID is not specified, one will be created and returned in the HTTP response.

content_copy zoom_out_map
{
    "id": "RFC6996-Private",
    "display_name": "RFC6996-Private",
    "tags": [ "default" ],
    "ranges": [
        {
            "last": 65534,
            "first": 64512
        }
    ]
}

To create an ASN pool perform an HTTP POST to https://aos-server/api/resources/asn-pools with a JSON payload.

content_copy zoom_out_map
curl 'https://192.168.25.250/api/resources/asn-pools?comment=create'
-H 'AuthToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6
ImFkbWluIiwiY3JlYXRlZF9hdCI6IjIwMTctMDUtMzFUMDA6MjI6MDcuNTIwMTgzWiIsIn
Nlc3Npb24iOiJjOTliOGVlOS05Y2NjLTRjZTAtYTY5NS0wODI3N2ZkYjA0ZDYifQ.FnJMR3
crPoD0-lQRXnpPOJ8TCsRG9Wr-DaddnAIj6ko' - --data-binary '{"display_name"
:"Example","ranges":[{"first":100,"last":200}],"tags":[]}' --compressed
--insecure

List ASN Pools

content_copy zoom_out_map
curl 'https://192.168.25.250/api/resources/asn-pools' -H 'AuthToken:
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbWluIiwiY3JlY
XRlZF9hdCI6IjIwMTctMDUtMzFUMDA6MjI6MDcuNTIwMTgzWiIsInNlc3Npb24iOiJjOTliO
GVlOS05Y2NjLTRjZTAtYTY5NS0wODI3N2ZkYjA0ZDYifQ.FnJMR3crPoD0-lQRXnpPOJ8TCsR
G9Wr-DaddnAIj6ko' --compressed --insecure

content_copy zoom_out_map
{
    "items": [
        {
            "created_at": "2017-05-30T12:56:07.293082Z",
            "display_name": "Private ASN",
            "id": "c23ea447-8f37-419a-9b1c-c48cc55d5b9c",
            "last_modified_at": "2017-05-30T12:56:07.293082Z",
            "ranges": [
                {
                    "first": 65412,
                    "last": 65534,
                    "status": "pool_element_in_use"
                }
            ],
            "status": "in_use",
            "tags": []
        }
    ]
}

Delete ASN Pool

To delete an ASN Pool perform an HTTP DELETE to https://aos-server/resources/asn-pools/{pool_id}

A successful DELETE returns HTTP 200 OK.

content_copy zoom_out_map
curl
'https://192.168.25.250/api/resources/asn-pools/d0312b4a-017e-4478-8b8d-df0417ce8d3b'
-X DELETE -H 'AuthToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2Vybm
FtZSI6ImFkbWluIiwiY3JlYXRlZF9hdCI6IjIwMTctMDUtMzFUMDA6MjI6MDcuNTIwMTgzW
iIsInNlc3Npb24iOiJjOTliOGVlOS05Y2NjLTRjZTAtYTY5NS0wODI3N2ZkYjA0ZDYifQ.FnJ
MR3crPoD0-lQRXnpPOJ8TCsRG9Wr-DaddnAIj6ko' --compressed --insecure

Assign ASN to Blueprint

To assign an IP pool to the blueprint perform an HTTP PUT to https://aos-server/blueprints/<blueprint_id>/resource_groups/ip/<pool_name>

For instance, to post a resource pool to spine_loopback_ips, first obtain the ID of the resource pool, and append it to a list for slot assignation. When updating the IP Pool resource group, specify all pools in the payload at the same time. We cannot add single pools, so PUT them all at once.

Payload:

content_copy zoom_out_map
{"pool_ids": ["pool_id1", "pool_id2", "pool_id3"] }

content_copy zoom_out_map
curl
'https://192.168.25.250/api/blueprints/4c1e69c6-97bd-4c99-9504-7818f138b17f/resource_groups/asn/spine_asns'
-X PUT -H 'AuthToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2Vyb
mFtZSI6ImFkbWluIiwiY3JlYXRlZF9hdCI6IjIwMTctMDUtMzFUMDA6MjI6MDcuNTI
wMTgzWiIsInNlc3Npb24iOiJjOTliOGVlOS05Y2NjLTRjZTAtYTY5NS0wODI3N2ZkYj
A0ZDYifQ.FnJMR3crPoD0-lQRXnpPOJ8TCsRG9Wr-DaddnAIj6ko'  --data-binary
'{"pool_ids":["c23ea447-8f37-419a-9b1c-c48cc55d5b9c"]}' --compressed --insecure

A successful ASSIGNMENT returns HTTP 200 OK.

Unassign ASN from Blueprint

When removing IP pools from a blueprint, PUT an empty pool_id list to the blueprint with the payload []:

PUT to the HTTP endpoint https://aos-server/api/blueprints/<blueprint_id> /resource_groups/asn/<pool_name>

With the payload:

content_copy zoom_out_map
{ "pool_ids": [] }

content_copy zoom_out_map
curl
'https://192.168.25.250/api/blueprints/4c1e69c6-97bd-4c99-9504-7818f138b17f/resource_groups/asn/spine_asns'
-X PUT -H 'AuthToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFt
ZSI6ImFkbWluIiwiY3JlYXRlZF9hdCI6IjIwMTctMDUtMzFUMDA6MjI6MDcuNTIwMTgzWi
IsInNlc3Npb24iOiJjOTliOGVlOS05Y2NjLTRjZTAtYTY5NS0wODI3N2ZkYjA0ZDYifQ.FnJ
MR3crPoD0-lQRXnpPOJ8TCsRG9Wr-DaddnAIj6ko'  --data-binary '{"pool_ids":[]}'
--compressed --insecure

If the request is successful there will be no response.

List ASN assigned to Blueprint

Available ASN Pool resource groups for assignment can be shown with an HTTP GET to https://aos-server/api/blueprints/<blueprint_id>/resource_groups

content_copy zoom_out_map
curl
'https://192.168.25.250/api/blueprints/4c1e69c6-97bd-4c99-9504-7818f138b17f/resource_groups'
-H 'AuthToken: eyJhbGciOiJIUzI1NwMTctMDUtMzFUMDA6MjI6MDcuNTIwMTgz
WiIsInNlc3Npb24iOiJjOTliOGVlOS05Y2NjLTRjZTAtYTY5NS0wODI3N2ZkYjA0ZD
YifQ.FnJMR3crPoD0-lQRXnpPOJ8TCsRG9Wr-DaddnAIj6ko' --compressed --insecure
| python -m json.tool

content_copy zoom_out_map
{
    "items": [
        {
            "name": "leaf_asns",
            "pool_ids": [
                "c23ea447-8f37-419a-9b1c-c48cc55d5b9c"
            ],
            "type": "asn"
        },
        {
            "name": "spine_asns",
            "pool_ids": [
                "c23ea447-8f37-419a-9b1c-c48cc55d5b9c"
            ],
            "type": "asn"
        },
        {
            "name": "leaf_loopback_ips",
            "pool_ids": [
                "56e8e0dc-babd-4652-92a5-fc37294a7b26"
            ],
            "type": "ip"
        },
        {
            "name": "mlag_domain_svi_subnets",
            "pool_ids": [
                "ed7d8830-c703-4ac0-8252-77e0f272a677"
            ],
            "type": "ip"
        },
        {
            "name": "spine_leaf_link_ips",
            "pool_ids": [
                "ed7d8830-c703-4ac0-8252-77e0f272a677"
            ],
            "type": "ip"
        },
        {
            "name": "spine_loopback_ips",
            "pool_ids": [
                "56e8e0dc-babd-4652-92a5-fc37294a7b26"
            ],
            "type": "ip"
        }
    ]
}

API - IP Pools

Create IP Pool
List IP Pools
Delete IP pool
Assign IP to Blueprint
Remove IP from Blueprint
List IPs Assigned to Blueprint

Create IP Pool

JSON Payload for creating an IP Pool:

content_copy zoom_out_map
{
    "id": "example_ip_pool",
    "display_name": "example_ip_pool",
    "tags": ["default"],
    "subnets": [
        {"network": "10.0.0.0/8"}
    ]
}

The subnets section requires a list of dictionaries with keyword network and value matching a CIDR mask. The subnets cannot overlap with each other in the same pool. That is to say, 192.168.10.0/24 and 192.168.0.0/16 cannot be configured in the same pool.

Tags are optional and are not currently used in Apstra. If ID is specified, it will be saved, otherwise an ID will be returned in the HTTP Response after creating the pool.

An HTTP POST to https://aos-server/api/resources/ip-pools with JSON payload will reply with the ID of the new IP pool.

content_copy zoom_out_map
curl 'https://192.168.25.250/api/resources/ip-pools' -X
POST -H 'AuthToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmF
tZSI6ImFkbWluIiwiY3JlYXRlZF9hdCI6IjIwMTctMDUtMzFUMDA6MjI6MDcuNTIwMTgzWi
IsInNlc3Npb24iOiJjOTliOGVlOS05Y2NjLTRjZTAtYTY5NS0wODI3N2ZkYjA0ZDYifQ.Fn
JMR3crPoD0-lQRXnpPOJ8TCsRG9Wr-DaddnAIj6ko' --data-binary '{"display_name":
"example_ip_pool","subnets":[{"network":"10.0.0.0/8"},{"network":
"192.168.0.0/16"}],"tags":[]}' --compressed --insecure

content_copy zoom_out_map
{"id": "d0312b4a-017e-4478-8b8d-df0417ce8d3b"}

List IP Pools

Perform an HTTP GET to https://aos-server/api/resources/ip-pools -

content_copy zoom_out_map
jp@ApstraVM ~ $ curl 'https://192.168.25.250/api/resources/ip-pools' -H
'AuthToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImFkbW
luIiwiY3JlYXRlZF9hdCI6IjIwMTctMDUtMzFUMDA6MjI6MDcuNTIwMTgzWiIsInNlc3Npb24
iOiJjOTliOGVlOS05Y2NjLTRjZTAtYTY5NS0wODI3N2ZkYjA0ZDYifQ.FnJMR3crPoD0-lQRXnpP
OJ8TCsRG9Wr-DaddnAIj6ko' --compressed --insecure | python -m json.tool

content_copy zoom_out_map
{
    "items": [
        {
            "created_at": "2017-05-31T03:48:38.562331Z",
            "display_name": "example_ip_pool",
            "id": "d5046aa6-eab2-4990-9816-0a519ce1a8db",
            "last_modified_at": "2017-05-31T03:48:38.562331Z",
            "status": "not_in_use",
            "subnets": [
                {
                    "network": "10.0.0.0/8",
                    "status": "pool_element_available"
                },
                {
                    "network": "192.168.0.0/16",
                    "status": "pool_element_available"
                }
            ],
            "tags": []
        },
        {
            "created_at": "2017-05-30T12:56:50.576598Z",
            "display_name": "L3-CLOS",
            "id": "ed7d8830-c703-4ac0-8252-77e0f272a677",
            "last_modified_at": "2017-05-30T12:56:50.576598Z",
            "status": "in_use",
            "subnets": [
                {
                    "network": "10.16.0.0/16",
                    "status": "pool_element_in_use"
                }
            ],
            "tags": []
        },
        {
            "created_at": "2017-05-30T12:56:24.222906Z",
            "display_name": "Loopbacks",
            "id": "56e8e0dc-babd-4652-92a5-fc37294a7b26",
            "last_modified_at": "2017-05-30T12:56:24.222906Z",
            "status": "in_use",
            "subnets": [
                {
                    "network": "10.254.0.0/16",
                    "status": "pool_element_in_use"
                }
            ],
            "tags": []
        },
        {
            "created_at": "2017-05-31T03:49:15.485164Z",
            "display_name": "example_ip_pool",
            "id": "d0312b4a-017e-4478-8b8d-df0417ce8d3b",
            "last_modified_at": "2017-05-31T03:49:15.485164Z",
            "status": "not_in_use",
            "subnets": [
                {
                    "network": "10.0.0.0/8",
                    "status": "pool_element_available"
                },
                {
                    "network": "192.168.0.0/16",
                    "status": "pool_element_available"
                }
            ],
            "tags": []
        }
    ]
}

Delete IP pool

To delete an IP Pool perform an HTTP DELETE to https://aos-server/resources/ip-pools/{pool_id}

A successful DELETE returns HTTP 200 OK and an empty JSON response {}

content_copy zoom_out_map
curl
'https://192.168.25.250/api/resources/ip-pools/d0312b4a-017e-4478-8b8d-df0417ce8d3b'
-X DELETE -H 'AuthToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZS
I6ImFkbWluIiwiY3JlYXRlZF9hdCI6IjIwMTctMDUtMzFUMDA6MjI6MDcuNTIwMTgzWiIsInNl
c3Npb24iOiJjOTliOGVlOS05Y2NjLTRjZTAtYTY5NS0wODI3N2ZkYjA0ZDYifQ.FnJMR3crPoD0
-lQRXnpPOJ8TCsRG9Wr-DaddnAIj6ko' --compressed --insecure

Assign IP to Blueprint

To assign an IP pool to the blueprint perform an HTTP PUT to https://aos-server/blueprints/ <blueprint_id>/resource_groups/ip/<group_name>

For instance, to associate a resource pool spine_loopback_ips with a blueprint first obtain the ID of the resource pool, and append it to a list for slot assignation. When updating the IP Pool resource group, specify all pools in the payload at the same time. We cannot add single pools, so PUT them all at once. Instruct Apstra to associate IP pool with ID ‘ed7d8830-c703-4ac0-8252-77e0f272a677’to the blueprint. You may have to GET existing pool IDs prior to adding a new one to avoid deleting existing pools.

Payload:

content_copy zoom_out_map
{"pool_ids": ["pool_id1", "pool_id2", "pool_id3"] }

content_copy zoom_out_map
curl
'https://192.168.25.250/api/blueprints/4c1e69c6-97bd-4c99-9504-7818f138b17f/resource_groups/ip/spine_loopback_ips'
-X PUT -H 'AuthToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImF
kbWluIiwiY3JlYXRlZF9hdCI6IjIwMTctMDUtMzFUMDA6MjI6MDcuNTIwMTgzWiIsInNlc3Npb2
4iOiJjOTliOGVlOS05Y2NjLTRjZTAtYTY5NS0wODI3N2ZkYjA0ZDYifQ.FnJMR3crPoD0-lQRXnp
POJ8TCsRG9Wr-DaddnAIj6ko'  --data-binary '{"pool_ids":["ed7d8830-c703-4ac0-825
2-77e0f272a677"]}' --compressed --insecure

A successful ASSIGNMENT returns an HTTP 200 OK.

Remove IP from Blueprint

To remove IP pools from the blueprint PUT an empty pool_id list to the blueprint with the payload []:

PUT to the HTTP endpoint https://aos-server/api/blueprints/<blueprint_id>/ resource_groups/ip/<allocation_group_name>

With the payload:

content_copy zoom_out_map
{ "pool_ids": [] }

CURL Example

content_copy zoom_out_map
curl
'https://192.168.25.250/api/blueprints/4c1e69c6-97bd-4c99-9504-7818f138b17f/resource_groups/ip/spine_loopback_ips'
-X PUT -H 'AuthToken: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZ
SI6ImFkbWluIiwiY3JlYXRlZF9hdCI6IjIwMTctMDUtMzFUMDA6MjI6MDcuNTIwMTgzWiIsI
nNlc3Npb24iOiJjOTliOGVlOS05Y2NjLTRjZTAtYTY5NS0wODI3N2ZkYjA0ZDYifQ.FnJMR3cr
PoD0-lQRXnpPOJ8TCsRG9Wr-DaddnAIj6ko'  --data-binary '{"pool_ids":[]}'
--compressed --insecure

A successful REMOVAL returns an empty response: {}

List IPs Assigned to Blueprint

content_copy zoom_out_map
curl
'https://192.168.25.250/api/blueprints/4c1e69c6-97bd-4c99-9504-7818f138b17f/resource_groups'
-H 'AuthToken: eyJhbGciOiJIUzI1NwMTctMDUtMzFUMDA6MjI6MDcuNTIwMTgzWiIsInNlc3
Npb24iOiJjOTliOGVlOS05Y2NjLTRjZTAtYTY5NS0wODI3N2ZkYjA0ZDYifQ.FnJMR3crPoD
0-lQRXnpPOJ8TCsRG9Wr-DaddnAIj6ko' --compressed --insecure | python -m json.tool

content_copy zoom_out_map
{
    "items": [
        {
            "name": "leaf_asns",
            "pool_ids": [
                "c23ea447-8f37-419a-9b1c-c48cc55d5b9c"
            ],
            "type": "asn"
        },
        {
            "name": "spine_asns",
            "pool_ids": [
                "c23ea447-8f37-419a-9b1c-c48cc55d5b9c"
            ],
            "type": "asn"
        },
        {
            "name": "leaf_loopback_ips",
            "pool_ids": [
                "56e8e0dc-babd-4652-92a5-fc37294a7b26"
            ],
            "type": "ip"
        },
        {
            "name": "mlag_domain_svi_subnets",
            "pool_ids": [
                "ed7d8830-c703-4ac0-8252-77e0f272a677"
            ],
            "type": "ip"
        },
        {
            "name": "spine_leaf_link_ips",
            "pool_ids": [
                "ed7d8830-c703-4ac0-8252-77e0f272a677"
            ],
            "type": "ip"
        },
        {
            "name": "spine_loopback_ips",
            "pool_ids": [
                "56e8e0dc-babd-4652-92a5-fc37294a7b26"
            ],
            "type": "ip"
        }
    ]
}

arrow_backward PREVIOUS AOS SDK Documentation

NEXT arrow_forward Configlets (API)

Juniper Apstra 5.0.1 / 5.0.0 User Guide

ON THIS PAGE