Application Policy Infrastructure Controller REST API Configuration Procedures
- APIC REST API Configuration Procedures
- Introduction
- Procedures
- Basic Configuration
- Getting Started
- Adding a Controller
- Deleting a Controller
- Replacing a Controller
- Commissioning a Controller
- Decommissioning a Controller
- Bringing up a Cluster
- Checking the Cluster Status
- Migrating a Controller
- Enabling the Warm Standyby using the RestAPI
- Disabling the Warm Standyby using the RestAPI
- Adding a Standby APIC
- Deleting Warm Standby Nodes
- Promote A Warm Standby
- Disaster Recovery Using the Rest API
- Layer 2 Networking
- Configuring Leaf Switch Physical Ports Using the Interface Configuration
- Configuring Two Port Channels on Multiple Switches Using Node Profiles and Port Profiles
- Configuring Two Port Channels on Multiple Switches Using the Interface Configuration
- Configuring a Single Virtual Port Channel Across Two Switches Using Node Profiles and Port Profiles
- Configuring FEX Connectivity to the ACI Leaf Switch Using Node Profiles and Port Profiles
- Configuring FEX Connectivity to the ACI Leaf Switch Using the Interface Configuration
- Changing an Uplink to a Downlink or a Downlink to an Uplink Using Node Profiles and Port Profiles
- Configuring a Physical Domain
- Creating a Tenant, VRF, and Bridge Domain
- Configuring an Enforced Bridge Domain
- Configuring Flood in Encapsulation
- Deploying an EPG on a Specific Port with the Cisco APIC
- Creating an AEP, Domains, and VLANs to Deploy an EPG on a Specific Port
- Validating Overlapping VLANs
- Deploying an EPG Through an AEP to Multiple Interfaces
- Configuring Intra-EPG Isolation for Bare Metal Servers
- Configuring Intra-EPG Isolation for a VMware VDS or Microsoft Hyper-V Virtual Switch
- Configuring Intra-EPG Isolation for Cisco ACI Virtual Edge
- Configuring a Virtual Port Channel on Selected Port Blocks of Two Switches
- Enabling Reflective Relay
- Configuring FCoE Connectivity
- Configuring FCoE Over a FEX
- Configuring an FCoE vPC
- Undeploying FCoE Connectivity
- Configuring Fibre Channel Connectivity
- Configuring 802.1Q Tunnels With Ports
- Configuring 802.1Q Tunnels With Port Channels
- Configuring 802.1Q Tunnels With Virtual Port Channels
- Mapping EPGs to Q-in-Q Encapsulation-Enabled Interfaces
- Configuring Dynamic Breakout Ports Using Node Profiles and Port Profiles
- Configuring Dynamic Breakout Ports Using the Interface Configuration
- Configuring Proxy ARP
- Configuring a Traffic Storm Control Policy
- Configuring MACsec
- Configuring Fabric Port Tracking
- Configuring Port Channel Dynamic Load Balancing
- Layer 3 Networking
- Layer 4 to Layer 7 Services
- Security
- System Management
- Configuration Examples and TechNotes
- Simplify Outside Network Connections Using Floating L3Outs
Checking the Status of a Cluster
This procedure shows you how to use the APIC REST API to check the status of an APIC cluster while the cluster bootstrap is in progress. The related procedure, Bringing up the Cisco APIC Cluster Using the GUI, is in the Initial Setup chapter of the Cisco APIC Getting Started Guide.
Procedure
Post with information that is similar to the following:
Code Snippet
CopyURL: /api/workflows/v1/cluster/status
Method: GET
For Physical Layer 2 (APIC is directly connected to the ACI fabric)
{
"status": {
"progress": 100,
"state": "Completed",
"description": "Cluster bootstrap and bringup completed."
},
"stages": [{
"name": "Syncing configuration",
"status": {
"progress": 100,
"state": "Completed",
"description": "Configuration sync completed."
},
"nodes": [{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Configuration sync completed."
}
}]
}, {
"name": "Checking management network reachability",
"status": {
"progress": 100,
"state": "Completed",
"description": "Management network reachability verified."
},
"nodes": [{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Management network reachability verified."
}
}]
}, {
"name": "Checking infra network reachabillity",
"status": {
"progress": 100,
"state": "Completed",
"description": "Infra network reachability verified."
},
"nodes": [{
"name": "orionin21-s2-vapic1",
"status": {
"progress": 100,
"state": "Completed",
"description": "Infra network reachability verified."
}
}]
}, {
"name": "Bringing up services",
"status": {
"progress": 100,
"state": "Completed",
"description": "APIC Service bringup completed."
},
"nodes": [{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "APIC Service bringup completed."
}
}]
}, {
"name": "Creating cluster",
"status": {
"progress": 100,
"state": "Completed",
"description": "Cluster is healthy."
},
"nodes": [{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Cluster is healthy."
}
}]
}, {
"name": "Loading UI",
"status": {
"progress": 100,
"state": "Completed",
"description": "UI loaded and ready."
},
"nodes": [{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "UI loaded and ready."
}
}]
}]
}
For Virtual APIC on ESXi (Layer 2, APIC is directly connected to the ACI fabric):
Code Snippet
Copy{
"status": {
"progress": 31,
"state": "In-Progress",
"description": "Configuration sync completed."
},
"stages": [{
"name": "Syncing configuration",
"status": {
"progress": 33,
"state": "In-Progress",
"description": "Configuration sync completed."
},
"nodes": [{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Configuration sync completed."
}
}, {
"name": "<name>",
"status": {
"progress": 0,
"state": "Pending",
"description": ""
}
}, {
"name": "<name>",
"status": {
"progress": 0,
"state": "Pending",
"description": ""
}
}]
}, {
"name": "Checking management network reachability",
"status": {
"progress": 33,
"state": "In-Progress",
"description": "Management network reachability verified."
},
"nodes": [{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Management network reachability verified."
}
}, {
"name": "<name>",
"status": {
"progress": 0,
"state": "Pending",
"description": ""
}
}, {
"name": "<name>",
"status": {
"progress": 0,
"state": "Pending",
"description": ""
}
}]
}, {
"name": "Checking infra network reachabillity",
"status": {
"progress": 33,
"state": "In-Progress",
"description": "Infra network reachability verified."
},
"nodes": [{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Infra network reachability verified."
}
}, {
"name": "<name>",
"status": {
"progress": 0,
"state": "Pending",
"description": ""
}
}, {
"name": "<name>",
"status": {
"progress": 0,
"state": "Pending",
"description": ""
}
}]
}, {
"name": "Bringing up services",
"status": {
"progress": 33,
"state": "In-Progress",
"description": "APIC Service bringup completed."
},
"nodes": [{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "APIC Service bringup completed."
}
}, {
"name": "<name>",
"status": {
"progress": 0,
"state": "Pending",
"description": ""
}
}, {
"name": "<name>",
"status": {
"progress": 0,
"state": "Pending",
"description": ""
}
}]
}, {
"name": "Creating cluster",
"status": {
"progress": 22,
"state": "In-Progress",
"description": "Cluster bringup in progress"
},
"nodes": [{
"name": "<name>",
"status": {
"progress": 66,
"state": "In-Progress",
"description": "Cluster bringup in progress"
}
}, {
"name": "<name>",
"status": {
"progress": 0,
"state": "Pending",
"description": ""
}
}, {
"name": "<name>",
"status": {
"progress": 0,
"state": "Pending",
"description": ""
}
}]
}, {
"name": "Loading UI",
"status": {
"progress": 33,
"state": "In-Progress",
"description": "UI loaded and ready."
},
"nodes": [{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "UI loaded and ready."
}
}, {
"name": "<name>",
"status": {
"progress": 0,
"state": "Pending",
"description": ""
}
}, {
"name": "<name>",
"status": {
"progress": 0,
"state": "Pending",
"description": ""
}
}]
}]
}
For Virtual APIC on ESXi (Layer 3, APIC is remotely attached to the ACI fabric):
Code Snippet
Copy{
"status": {
"progress": 100,
"state": "Completed",
"description": "Cluster bootstrap and bringup completed."
},
"stages": [{
"name": "Syncing configuration",
"status": {
"progress": 100,
"state": "Completed",
"description": "Configuration sync completed."
},
"nodes": [{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Configuration sync completed."
}
}, {
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Configuration sync completed."
}
}, {
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Configuration sync completed."
}
}]
}, {
"name": "Checking management network reachability",
"status": {
"progress": 100,
"state": "Completed",
"description": "Management network reachability verified."
},
"nodes": [{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Management network reachability verified."
}
}, {
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Management network reachability verified."
}
}, {
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Management network reachability verified."
}
}]
}, {
"name": "Checking infra network reachabillity",
"status": {
"progress": 100,
"state": "Completed",
"description": "Infra network reachability verified."
},
"nodes": [{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Infra network reachability verified."
}
}, {
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Infra network reachability verified."
}
}, {
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Infra network reachability verified."
}
}]
}, {
"name": "Bringing up services",
"status": {
"progress": 100,
"state": "Completed",
"description": "APIC Service bringup completed."
},
"nodes": [{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "APIC Service bringup completed."
}
}, {
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "APIC Service bringup completed."
}
}, {
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "APIC Service bringup completed."
}
}]
}, {
"name": "Creating cluster",
"status": {
"progress": 100,
"state": "Completed",
"description": "Cluster is healthy."
},
"nodes": [{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Cluster is healthy."
}
}, {
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Cluster is healthy."
}
}, {
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Cluster bringup in progress"
}
}]
}, {
"name": "Loading UI",
"status": {
"progress": 100,
"state": "Completed",
"description": "UI loaded and ready."
},
"nodes": [{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "UI loaded and ready."
}
}, {
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "UI loaded and ready."
}
}, {
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "UI loaded and ready."
}
}]
}]
}
For Virtual APIC on AWS:
Code Snippet
Copy{
"status": {
"progress": 100,
"state": "Completed",
"description": "Cluster bootstrap and bringup completed."
},
"stages": [
{
"name": "Syncing configuration",
"status": {
"progress": 100,
"state": "Completed",
"description": "Configuration sync completed."
},
"nodes": [
{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Configuration sync completed."
}
},
{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Configuration sync completed."
}
},
{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Configuration sync completed."
}
}
]
},
{
"name": "Checking management network reachability",
"status": {
"progress": 100,
"state": "Completed",
"description": "Management network reachability verified."
},
"nodes": [
{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Management network reachability verified."
}
},
{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Management network reachability verified."
}
},
{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Management network reachability verified."
}
}
]
},
{
"name": "Checking infra network reachabillity",
"status": {
"progress": 100,
"state": "Completed",
"description": "Infra network reachability verified."
},
"nodes": [
{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Infra network reachability verified."
}
},
{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Infra network reachability verified."
}
},
{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Infra network reachability verified."
}
}
]
},
{
"name": "Bringing up services",
"status": {
"progress": 100,
"state": "Completed",
"description": "APIC Service bringup completed."
},
"nodes": [
{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "APIC Service bringup completed."
}
},
{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "APIC Service bringup completed."
}
},
{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "APIC Service bringup completed."
}
}
]
},
{
"name": "Creating cluster",
"status": {
"progress": 100,
"state": "Completed",
"description": "Cluster is healthy."
},
"nodes": [
{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Cluster is healthy."
}
},
{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Cluster is healthy."
}
},
{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "Cluster bringup in progress"
}
}
]
},
{
"name": "Loading UI",
"status": {
"progress": 100,
"state": "Completed",
"description": "UI loaded and ready."
},
"nodes": [
{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "UI loaded and ready."
}
},
{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "UI loaded and ready."
}
},
{
"name": "<name>",
"status": {
"progress": 100,
"state": "Completed",
"description": "UI loaded and ready."
}
}
]
}
]
}