Chapter 41: Network Automation and APIs
This chapter follows the topics shown in the Networking chapter menu. Work through each section in order, then use the review questions to check recall and troubleshooting reasoning.
41.1 Network Automation
Network Automation is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Network Automation in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.2 Automation Benefits
Automation Benefits is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Automation Benefits in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.3 Human Error Reduction
Human Error Reduction is a troubleshooting condition. The useful approach is to confirm symptoms, determine scope, identify the relevant layer, compare actual values with the intended design, test one theory at a time, and verify service after the fix.
Example: place Human Error Reduction in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Confirm the symptom and determine whether the problem affects one host, one segment, one site, or many sites.
- Compare actual configuration and measurements with the intended design, baseline, or documentation.
- Change one variable at a time, verify the result, and document both the cause and the final fix.
41.4 Repeatability
Repeatability is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Repeatability in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.5 Configuration Management
Configuration Management is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Configuration Management in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.6 Desired State
Desired State is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Desired State in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.7 Configuration Drift
Configuration Drift is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Configuration Drift in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.8 Templates
Templates is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Templates in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.9 Infrastructure as Code
Infrastructure as Code is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Infrastructure as Code in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
Command or data example
interface: uplink1
enabled: true
description: WAN uplink
41.10 Declarative Configuration
Declarative Configuration is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Declarative Configuration in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.11 Imperative Configuration
Imperative Configuration is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Imperative Configuration in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.12 APIs
APIs is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place APIs in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
Command or data example
GET /api/v1/interfaces
Accept: application/json
41.13 REST APIs
REST APIs is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place REST APIs in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
Command or data example
GET /api/v1/interfaces
Accept: application/json
41.14 GET
GET is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place GET in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.15 POST
POST is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place POST in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.16 PUT
PUT is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place PUT in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.17 PATCH
PAT lets many inside hosts share one or a small number of public IPv4 addresses by tracking transport protocol and port mappings.
Example: place PATCH in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.18 DELETE
DELETE is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place DELETE in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.19 API Endpoints
API Endpoints is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place API Endpoints in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
Command or data example
GET /api/v1/interfaces
Accept: application/json
41.20 API Authentication
API Authentication is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place API Authentication in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
Command or data example
GET /api/v1/interfaces
Accept: application/json
41.21 Tokens
Tokens is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Tokens in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.22 JSON
JSON is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place JSON in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
Command or data example
{
"interface": "uplink1",
"enabled": true,
"description": "WAN uplink"
}
41.23 XML
XML is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place XML in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.24 YAML
YAML is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place YAML in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
Command or data example
interface: uplink1
enabled: true
description: WAN uplink
41.25 Network Controllers
Network Controllers is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Network Controllers in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.26 SDN
SDN is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place SDN in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.27 Control Plane
Control Plane is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Control Plane in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.28 Data Plane
Data Plane is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Data Plane in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.29 Management Plane
Management Plane is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Management Plane in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.30 Northbound APIs
Northbound APIs is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Northbound APIs in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
Command or data example
GET /api/v1/interfaces
Accept: application/json
41.31 Southbound Interfaces
Southbound Interfaces is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Southbound Interfaces in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.32 Overlay Networks
Overlay Networks is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Overlay Networks in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.33 Underlay Networks
Underlay Networks is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Underlay Networks in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.34 Orchestration
Orchestration is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Orchestration in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.35 Version Control
Version Control is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Version Control in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.36 Idempotency
Idempotency is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Idempotency in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.37 Automated Remediation
Automated Remediation is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Automated Remediation in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.38 API Status Codes
API Status Codes is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place API Status Codes in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
Command or data example
GET /api/v1/interfaces
Accept: application/json
41.39 Secrets Management
Secrets Management is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place Secrets Management in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.
41.40 CMDB and Source of Truth
CMDB and Source of Truth is one of the core topics in Network Automation and APIs. Understand what the term represents, where it operates in the network, what information it uses, and what observable behavior confirms that it is working correctly.
Example: place CMDB and Source of Truth in a small office network containing clients, switches, a router, wireless access, DNS/DHCP services, and an internet connection. Identify which device or layer owns the function and what evidence you would inspect to verify it.
What to check
- Identify which OSI/TCP-IP layer and device type are primarily responsible.
- Check configuration, interface or service state, counters, logs, and a simple end-to-end test.
- Verify both normal operation and one realistic failure case so you understand what changes when the feature breaks.