Study guide

15.2 Cisco Catalyst SD-WAN Manager (vManage) REST APIs and Device Interaction

Cisco ENCOR 350-401 CCNP Enterprise Core

Track your progress as you read

Finished sections get a check mark.

1 Introduction & Exam Overview

0.1 Cisco 350-401 ENCOR Exam Logistics, Blueprint Structure, and Certification Paths 0.2 Preparation Strategy, Lab Environment Setup, and Practical Test Pacing

2 Enterprise Campus Architecture and High Availability

1.1 Enterprise Network Design: Two-Tier, Three-Tier, Fabric, and Cloud Architectures 1.2 High Availability Architecture: Device Redundancy, FHRPs, and Stateful Switchover (SSO) 1.3 Quality of Service (QoS) Architecture, Classification, Queuing, and Configuration Interpretation

3 Cisco Software-Defined Architecture: SD-WAN and SD-Access

2.1 Cisco Catalyst SD-WAN: Control, Management, and Data Planes 2.2 Cisco SD-Access Architecture: Control Plane, Data Plane, and Fabric Node Roles 2.3 SD-Access Campus Interoperability: Integrating Traditional Networks with Fabric

4 Device and Network Virtualization Technologies

3.1 Device Virtualization: Type 1/2 Hypervisors, Virtual Machines, and Virtual Switching 3.2 Data Path Virtualization: VRF-Lite, GRE Tunneling, and IPsec VPN Fundamentals 3.3 Network Virtualization Overlays: LISP and VXLAN Encapsulation Mechanics

5 Layer 2 Infrastructure: Trunking, EtherChannel, and Spanning Tree

4.1 802.1Q Trunking, Native VLAN, and Dynamic Trunking Protocol Troubleshooting 4.2 EtherChannel Bundling: Static, LACP, and PAgP Implementation and Verification 4.3 Spanning Tree Architecture: RSTP, MST, and STP Protection Mechanisms

6 Layer 3 Routing: OSPF Multi-Area and Protocol Comparison

5.1 Enterprise Routing Principles: Distance Vector vs. Link-State, EIGRP, and OSPF 5.2 OSPFv2 and OSPFv3 Multi-Area Architecture: LSAs, Area Types, and Summarization 5.3 Policy-Based Routing (PBR) Architecture, Configuration, and Route-Maps

7 Exterior Routing: BGP Peering and Path Selection

6.1 External BGP (eBGP) Peering, States, Neighbor Adjacencies, and Timers 6.2 BGP Path Attributes and the Step-by-Step Best Path Selection Algorithm

8 IP Services and First-Hop Redundancy

7.1 Time Synchronization: Network Time Protocol (NTP) and Precision Time Protocol (PTP) 7.2 Network Address Translation: Static NAT, Dynamic NAT, and PAT/Overload 7.3 First Hop Redundancy Protocols: HSRP and VRRP Implementation and Failover

9 IP Multicast Architecture and Protocols

8.1 Multicast Addressing, IGMPv2/v3 Host Membership, and the RPF Check 8.2 Protocol Independent Multicast Sparse Mode (PIM-SM) and Rendezvous Point Discovery 8.3 Anycast RP with MSDP, Source-Specific Multicast (SSM), and Bidirectional PIM

10 Network Diagnostics, Monitoring, and Telemetry

9.1 Network Diagnostic Tools: Conditional Debugging, Traceroute, SNMPv3, and Syslog Logging 9.2 Flexible NetFlow (FNF) Architecture: Flow Records, Exporters, and Monitors 9.3 Switched Port Analyzer: Local SPAN, Remote SPAN (RSPAN), and Encapsulated RSPAN (ERSPAN)

11 Performance Monitoring and Model-Driven Assurance

10.1 IP Service Level Agreements (IP SLA) Probes, Responder, and Route Tracking 10.2 Cisco Catalyst Center: Assurance Dashboards, AI Analytics, and Machine Reasoning Workflows 10.3 Model-Driven Telemetry and Programmable Interfaces: NETCONF and RESTCONF Verification

12 Device Access Control and AAA Architecture

11.1 Device Line Protection: Console, Aux, VTY, Local Authentication, and Privilege Levels 11.2 AAA Architecture: Comparing RADIUS vs. TACACS+ and Method List Configuration

13 Infrastructure Security: ACLs, CoPP, and API Security

12.1 IPv4 and IPv6 Access Control Lists (ACLs): Standard, Extended, and Named Rules 12.2 Control Plane Policing (CoPP): Protecting the Route Processor with MQC 12.3 REST API Security: Token Authentication, TLS Transport, and Rate Limiting

14 Enterprise Network Security Design: ISE, TrustSec, and MACsec

13.1 Endpoint Security Architecture: 802.1X, Cisco ISE Posture, and Profiling 13.2 Next-Generation Firewalls (FTD) and Enterprise Threat Defense Design 13.3 Cisco TrustSec (Security Group Tags) and MACsec (802.1AE) Layer 2 Encryption

15 Network Automation Fundamentals: Python, JSON, and YANG

14.1 Python Fundamentals for Network Engineers: Data Types, Control Flow, and Libraries 14.2 JSON Data Encoding: Syntax, Formatting Rules, and Python Serialization 14.3 YANG Data Modeling: Modules, Tree Structures, and Data Representation

16 Controller REST APIs and RESTCONF Implementation

15.1 Cisco Catalyst Center Intent APIs and Authentication Workflows 15.2 Cisco Catalyst SD-WAN Manager (vManage) REST APIs and Device Interaction 15.3 RESTCONF Protocol Operations: HTTP Verbs, Datastores, and Response Codes

17 Event-Driven Automation and Infrastructure Orchestration

16.1 Cisco Embedded Event Manager (EEM) Applet Architecture and Event Detectors 16.2 Configuration Management: Comparing Ansible, Puppet, Chef, and SaltStack 16.3 Infrastructure as Code (IaC) Principles with Terraform in Enterprise Networks

15.2 Cisco Catalyst SD-WAN Manager (vManage) REST APIs and Device Interaction

Key Takeaways Explain This Topic AI

Cisco Catalyst SD-WAN Manager (formerly vManage) provides the centralized management plane for the SD-WAN fabric, exposing RESTful APIs under the /dataservice root namespace.

SD-WAN Manager authentication enforces a two-stage security sequence: authenticating credentials via a POST request to /j_security_check to establish a JSESSIONID cookie, followed by a GET request to /dataservice/client/token using that cookie to obtain a CSRF token (X-XSRF-TOKEN).

Modifying HTTP requests (POST, PUT, DELETE) to SD-WAN Manager require both the JSESSIONID session cookie and the X-XSRF-TOKEN HTTP header to prevent Cross-Site Request Forgery attacks, whereas read-only GET requests require only the session cookie.

Core monitoring and inventory endpoints include GET /dataservice/device for fabric inventory, GET /dataservice/alarms for operational events, and GET /dataservice/device/bfd/sessions for real-time tunnel telemetry (latency, jitter, loss, and state).

Configuration workflows leverage template attachment endpoints such as POST /dataservice/template/device/config/attachfeature, pushing standardized device templates and variables across WAN Edge routers.

Last updated: October 2026

Cisco Catalyst SD-WAN Manager (vManage) REST APIs and Device Interaction

In modern Software-Defined Wide Area Network (SD-WAN) architectures, network control, management, and data forwarding are strictly decoupled. Cisco Catalyst SD-WAN Manager (formerly vManage) serves as the centralized network management system (NMS) and single pane of glass for the entire SD-WAN fabric. Operating in the management plane alongside vSmart controllers (control plane), vBond orchestrators (orchestration plane), and WAN Edge routers (data plane), SD-WAN Manager provides unified operational dashboards, real-time path telemetry, centralized policy definition, and automated zero-touch provisioning. Network engineers interact programmatically with SD-WAN Manager through its extensive REST API suite to automate Day-0 onboarding, Day-1 template configuration, and Day-2 health auditing across enterprise WAN transports. +-------------------------------------------------------------------------+

  • | Cisco Catalyst SD-WAN Manager Architecture |
  • +-------------------------------------------------------------------------+
  • | |
  • | +-----------------------------------------------------------------+ |
  • | | Cisco Catalyst SD-WAN Manager (Management Plane) | |
  • | | - Centralized GUI Dashboard | |
  • | | - REST API Gateway: /dataservice/... | |
  • | | - Configuration Database, Template Engine, Alarm Aggregator | |
  • | +-----------------------------------------------------------------+ |
  • | | | |
  • | Session & CSRF Auth NETCONF / OMP Telemetry |
  • | | | |
  • | v v |
  • | +---------------------------+ +-----------------------------+ |
  • | | Orchestration Plane | | Control Plane | |
  • | | Catalyst SD-WAN Validator| | Catalyst SD-WAN Controller| |
  • | | (vBond Orchestrator) | | (vSmart Controller) | |
  • | +---------------------------+ +-----------------------------+ |
  • | | | |
  • | +-----------------+-----------------+ |
  • | | |
  • | v |
  • | +-----------------------------------------------------------------+ |
  • | | Data Forwarding Plane (WAN Edge Routers) | |
  • | | Catalyst 8300 / 8500 Edge, ASR 1000, ISR 4000, vEdge Cloud | |
  • | | IPsec Data Tunnels monitored continuously via BFD sessions | |
  • | +-----------------------------------------------------------------+ |
  • +-------------------------------------------------------------------------+
  • SD-WAN Manager REST API Architecture and Namespace

All programmatic interactions with Catalyst SD-WAN Manager are exposed under the /dataservice root namespace over HTTPS (typically on TCP port 443 or port 8443 depending on deployment configuration). Unlike simple stateless APIs, SD-WAN Manager functions as a rich web application with stateful session management, granular role-based access control (RBAC), and multi-tenant segmentation capabilities.

The /dataservice namespace organizes API resources into distinct operational domains:

Device and System Inventory ( /dataservice/device ): Enumerates all WAN Edge routers, vSmart controllers, and vBond orchestrators participating in the fabric, reporting reachability, hardware models, software versions, and chassis UUIDs.

Operational Monitoring ( /dataservice/device/... ): Surfaces live telemetry from data plane nodes, including Bidirectional Forwarding Detection (BFD) tunnel health, OMP route tables, hardware environmentals, and control connections.

Alarms and Events ( /dataservice/alarms ): Aggregates critical, major, and minor operational alarms across transport circuits, BGP peerings, and hardware components.

Configuration and Templates ( /dataservice/template/... ): Creates, updates, and attaches feature templates and device CLI templates to physical and virtual routers.

Multi-Stage Authentication: Session Cookies and CSRF Protection

Because Catalyst SD-WAN Manager hosts critical state-modifying configuration workflows, it implements a multi-stage authentication handshake that combines HTTP session cookies with Cross-Site Request Forgery (CSRF) protection tokens. Automation clients cannot execute write operations using standard HTTP Basic Authentication alone. +-------------------------------------------------------------------------+

  • | SD-WAN Manager Authentication & Request Handshake |
  • +-------------------------------------------------------------------------+
  • [ Automation Client ] [ SD-WAN Manager ]
  • | |
  • | 1. POST /j_security_check |
  • | Body: j_username=admin&j_password=*** |
  • | --------------------------------------------> |
  • | |
  • | 2. HTTP 200 OK / 302 Found |
  • | Set-Cookie: JSESSIONID=abc123xyz |
  • | <-------------------------------------------- |
  • | |
  • | 3. GET /dataservice/client/token |
  • | Cookie: JSESSIONID=abc123xyz |
  • | --------------------------------------------> |
  • | |
  • | 4. HTTP 200 OK |
  • | Body: "csrf-token-string-456" |
  • | <-------------------------------------------- |
  • | |
  • | 5. Modifying POST /dataservice/template/... |
  • | Cookie: JSESSIONID=abc123xyz |
  • | Header: X-XSRF-TOKEN: csrf-token-string-456|
  • | --------------------------------------------> |
  • | |
  • | 6. HTTP 200 OK + Execution Result |
  • | <-------------------------------------------- |
  • The Three-Step Authentication Sequence
  • Step 1: Establish Authenticated Session ( /j_security_check )

The client issues an HTTP POST request to the legacy Java security endpoint /j_security_check . The request body must be encoded as application/x-www-form-urlencoded containing the keys j_username and j_password : POST /j_security_check HTTP/1.1

  • Host: vmanage.example.com:8443
  • Content-Type: application/x-www-form-urlencoded

j_username=admin&j_password=CiscoSDWAN123!

Upon successful verification, SD-WAN Manager issues an HTTP 200 OK (or redirects via 302 Found ) and returns a session cookie in the Set-Cookie response header: Set-Cookie: JSESSIONID=4A9B1C2D3E4F5A6B7C8D9E0F1A2B3C4D; Path=/; Secure; HttpOnly

This JSESSIONID cookie must be stored and passed in the Cookie header on all subsequent requests.

Step 2: Acquire CSRF Token ( /dataservice/client/token )

To protect state-changing endpoints from CSRF exploits, SD-WAN Manager requires a unique cryptographic token for any operation that creates, updates, or deletes configuration. The client submits an HTTP GET request to /dataservice/client/token , presenting the established session cookie: GET /dataservice/client/token HTTP/1.1

  • Host: vmanage.example.com:8443
  • Cookie: JSESSIONID=4A9B1C2D3E4F5A6B7C8D9E0F1A2B3C4D
  • The server returns the raw token string in the response body: 7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2c
  • Step 3: Dispatch API Operations

Once authenticated, requests follow strict header requirements based on the HTTP method:

Read-Only Operations ( GET ): Require only the session cookie ( Cookie: JSESSIONID=... ). The CSRF token is optional for GET operations.

State-Modifying Operations ( POST , PUT , DELETE ): Strictly require both the session cookie ( Cookie: JSESSIONID=... ) AND the custom CSRF header ( X-XSRF-TOKEN: <token> ). If the CSRF token is absent or mismatched, SD-WAN Manager aborts the request immediately with an HTTP 403 Forbidden error.

Cisco Catalyst SD-WAN Manager Authentication Handshake

Handshake Stage HTTP Method & URI Payload / Body Format Headers Required Artifact Generated

1. Session Login POST /j_security_check j_username=<user>&j_password=<pass> ( form-urlencoded ) Content-Type: application/x-www-form-urlencoded JSESSIONID session cookie

2. CSRF Token Request GET /dataservice/client/token None (empty body) Cookie: JSESSIONID=<cookie> CSRF token string ( X-XSRF-TOKEN )

3. Read Execution GET /dataservice/... None (empty body) Cookie: JSESSIONID=<cookie> Real-time JSON telemetry / inventory

4. Modifying Execution POST / PUT / DELETE /dataservice/... JSON data payload Cookie: JSESSIONID=<cookie> , X-XSRF-TOKEN: <token> Resource creation / task status object

Core SD-WAN Manager API Endpoints

Enterprise network engineers leverage SD-WAN Manager APIs to monitor fabric health, track data tunnel performance, and orchestrate configuration policies:

1. Device Inventory ( GET /dataservice/device )

The /dataservice/device endpoint returns a complete inventory of all managed entities registered in the SD-WAN fabric. Each entry in the JSON response contains essential operational metadata:

system-ip : The unique loopback IPv4 identifier representing the node in the Overlay Management Protocol (OMP) topology.

host-name : Configured system hostname (e.g., branch-edge-01 ).

deviceModel : Platform hardware model (e.g., c8300-1n1s-4t2x , vedge-2000 ).

reachability : Administrative reachability status ( reachable or unreachable ).

status : Overall device state (e.g., normal , warning ).

personality : Role of the node in the fabric ( vedge , vsmart , vbond ).

2. Active Alarms ( GET /dataservice/alarms )

The /dataservice/alarms endpoint aggregates real-time system alerts across all fabric nodes. Engineers can query active issues and filter by severity levels ( Critical , Major , Minor ):

Fields returned include eventname , severity_level , component , entry_time , and acknowledged status. This endpoint is commonly used in automation monitoring scripts that feed corporate event-correlation engines like Splunk.

3. BFD Session Monitoring ( GET /dataservice/device/bfd/sessions )

In Cisco Catalyst SD-WAN, WAN Edge routers establish IPsec data tunnels across each available transport circuit (MPLS, Internet, LTE) between transport locators (TLOCs). Bidirectional Forwarding Detection (BFD) runs continuously over every IPsec tunnel to detect path outages and measure transport performance.

Querying /dataservice/device/bfd/sessions?deviceId={system-ip} returns granular real-time tunnel telemetry:

local-color and remote-color : Transport circuits forming the tunnel (e.g., mpls , biz-internet , public-internet ).

state : Current operational status of the tunnel ( up or down ).

latency : Current round-trip latency measured in milliseconds.

jitter : Current packet arrival variation in milliseconds.

rx_pkts and tx_pkts : Total packets received and transmitted over the IPsec tunnel.

loss : Percentage of dropped packets observed over the sampling interval.

4. Template Attachment ( POST /dataservice/template/device/config/attachfeature )

Configuration management in Catalyst SD-WAN relies on standardized feature templates (defining individual protocol blocks like BGP, OSPF, NTP, and VPN interfaces) assembled into device templates. Pushing configurations to physical routers requires attaching the template along with a CSV or JSON payload containing device-specific variables (such as local interface IP addresses, BGP autonomous system numbers, and hostnames).

Core Catalyst SD-WAN Manager Endpoints Reference

Endpoint URI Method Primary Purpose Key Output Fields

/j_security_check POST Authenticate credentials and establish session Set-Cookie: JSESSIONID=...

/dataservice/client/token GET Obtain CSRF token for modifying requests Token string ( X-XSRF-TOKEN )

/dataservice/device GET Retrieve complete SD-WAN fabric inventory system-ip , personality , reachability , deviceModel

/dataservice/alarms GET Retrieve active system and transport alarms severity_level , eventname , entry_time , message

/dataservice/device/bfd/sessions GET Query live BFD tunnel metrics per WAN Edge local-color , remote-color , state , latency , loss

/dataservice/device/control/connections GET Verify control connections to vSmart / vBond peer-type , state , site-id , private-ip

/dataservice/template/device/config/attachfeature POST Attach feature template and push configuration taskId tracking configuration deployment

Practical Python Automation Script Walkthrough

To handle session cookies seamlessly across multiple HTTP transactions, Python scripts should utilize requests.Session() . A Session object automatically retains cookies across all outgoing requests, simplifying the two-stage authentication sequence.

The following script logs into Catalyst SD-WAN Manager, acquires the CSRF token, queries the fabric device inventory to locate all WAN Edge routers, and retrieves real-time BFD tunnel performance metrics across their WAN transports. import requests

import urllib3

  • # Suppress TLS verification warnings in development environments
  • urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
  • VMANAGE_HOST = "198.51.100.10"
  • VMANAGE_PORT = 8443
  • USERNAME = "admin"
  • PASSWORD = "CiscoSDWAN123!"
  • BASE_URL = f"https://{VMANAGE_HOST}:{VMANAGE_PORT}"

def create_vmanage_session(base_url, username, password):

  • """Establishes an authenticated requests.Session with JSESSIONID and X-XSRF-TOKEN."""
  • session = requests.Session()
  • # Step 1: Session Authentication via /j_security_check
  • login_url = f"{base_url}/j_security_check"
  • login_payload = {
  • "j_username": username,
  • "j_password": password
  • }
  • login_resp = session.post(login_url, data=login_payload, verify=False, timeout=15)
  • login_resp.raise_for_status()

# Verify that session cookie was acquired

if "JSESSIONID" not in session.cookies:

raise RuntimeError("Authentication failed: JSESSIONID cookie not returned.")

print("Successfully authenticated session (JSESSIONID stored).")

  • # Step 2: Acquire CSRF Token via /dataservice/client/token
  • token_url = f"{base_url}/dataservice/client/token"
  • token_resp = session.get(token_url, verify=False, timeout=10)

if token_resp.status_code == 200:

  • csrf_token = token_resp.text.strip()
  • # Inject CSRF header into session for subsequent POST/PUT/DELETE calls
  • session.headers.update({"X-XSRF-TOKEN": csrf_token})
  • print("Successfully acquired X-XSRF-TOKEN.")

else:

print("Notice: CSRF token endpoint not required or returned non-200.")

return session

def get_wan_edge_inventory(session, base_url):

  • """Retrieves all reachable WAN Edge devices from /dataservice/device."""
  • device_url = f"{base_url}/dataservice/device"
  • response = session.get(device_url, verify=False, timeout=15)
  • response.raise_for_status()
  • all_devices = response.json().get("data", [])
  • # Filter for WAN edge data plane nodes
  • wan_edges = [
  • d for d in all_devices
  • if d.get("personality") == "vedge" and d.get("reachability") == "reachable"
  • ]
  • return wan_edges

def audit_bfd_sessions(session, base_url, system_ip, hostname):

  • """Audits live BFD tunnel performance for a given WAN Edge system IP."""
  • bfd_url = f"{base_url}/dataservice/device/bfd/sessions"
  • params = {"deviceId": system_ip}
  • response = session.get(bfd_url, params=params, verify=False, timeout=15)
  • response.raise_for_status()
  • sessions = response.json().get("data", [])
  • print(f"\n=== BFD Data Tunnels for {hostname} ({system_ip}) ===")
  • print(f"Total Active Tunnels: {len(sessions)}")

for s in sessions:

  • dst_ip = s.get("dst-ip", "N/A")
  • local_color = s.get("local-color", "N/A")
  • remote_color = s.get("remote-color", "N/A")
  • state = s.get("state", "down")
  • latency = s.get("latency", "0")
  • loss = s.get("loss", "0")
  • status_indicator = "[OK]" if state == "up" else "[ALERT]"
  • print(
  • f" {status_indicator} {local_color} -> {remote_color} "
  • f"(Dst: {dst_ip}) | State: {state.upper()} | Latency: {latency}ms | Loss: {loss}%"
  • )

if __name__ == "__main__":

  • # Initialize authenticated session
  • vmanage_session = create_vmanage_session(BASE_URL, USERNAME, PASSWORD)
  • # Query WAN Edge Inventory
  • edge_routers = get_wan_edge_inventory(vmanage_session, BASE_URL)
  • print(f"Discovered {len(edge_routers)} active WAN Edge routers.")

# Audit BFD Tunnels for each discovered Edge router

for edge in edge_routers:

  • sys_ip = edge.get("system-ip")
  • host = edge.get("host-name", "Unnamed-Edge")
  • audit_bfd_sessions(vmanage_session, BASE_URL, sys_ip, host)