I want to...
A scenario-first index into the docs. Pick the row that describes what you are trying to accomplish, and follow the link.
Get oriented
| I want to… | Go to |
|---|---|
| Understand what Config Manager is and which path to start with. | Start Here |
| Know whether to use the Config Manager UI, Nautobot UI, Temporal Web, or an API. | Which Interface Should I Use? |
| Preview Config Manager locally without touching real devices. | Local Development Quick Start |
| Validate Config Manager workflows against simulated Cumulus switches in NVIDIA DSX Air. | DSX Air Simulation User Guide |
| Decide what to inspect after the first install. | First Run Tour |
Bootstrap and provisioning
| I want to… | Go to |
|---|---|
| Bootstrap a freshly racked switch automatically once it has power and a management cable. | New Site Bringup, Network ZTP |
| Understand how ZTP loads firmware, configuration, and user accounts onto a device. | Network ZTP → How It Works, Render Service, Nautobot Bootstrap |
| Know how Config Manager learns that ZTP has finished on a device. | Network ZTP → Provisioning Workflow |
| Re-run ZTP on an existing switch (recover a stuck or drifted device). | Device Reprovision |
| Investigate why a device has not reached the Provisioned status. | New Site Bringup → Monitoring DHCP and ZTP |
Validate cabling
| I want to… | Go to |
|---|---|
| Compare what the switches report over LLDP against the cabling in Nautobot. | Cable Validation |
| Get a per-interface report of cabling mismatches I can hand to DC Ops. | Cable Validation |
Day-2 configuration
| I want to… | Go to |
|---|---|
| Have a device’s intended configuration regenerated automatically when Nautobot changes. | Render Service |
| Push an intended-config change from Nautobot to a single live device. | Configuration Deploy |
| Review the configuration diff and approve (or reject) it before anything reaches the device. | Configuration Deploy → Execution stages |
| Apply a single change to many devices in one orchestrated run, with per-batch approval. | Multi-Deploy, Batch Deploy |
Backup and recovery
| I want to… | Go to |
|---|---|
| Make sure every change Config Manager applies is backed up automatically. | Configuration Backup |
| Take an ad-hoc backup of a device or a site. | Configuration Backup → Running the workflow |
| Restore a device from a previous backup. | Device Reprovision (factory reset + re-ZTP), Configuration Deploy (re-apply a target revision) |
Credentials
| I want to… | Go to |
|---|---|
| Understand how the Config Manager service account is created, rendered onto devices, and used by workflows. | Device Authentication |
| Rotate a user account’s password on every device at a site. | Site Password Rotation |
| Rotate a user account’s password on one device. | Device Password Rotation |
| Understand the pre-work (Vault/OpenBao update, mapping change, and re-render) before running a rotation. | Device Authentication, Site Password Rotation → Prerequisites |
OS and firmware upgrades
| I want to… | Go to |
|---|---|
| Upgrade Cumulus Linux on a switch. | Switch OS Upgrade |
| Upgrade firmware on an NVLink switch. | NVLink Switch Firmware Upgrade |
| Understand the pre-work (firmware target in Nautobot for the role at the site) before an OS upgrade. | Switch OS Upgrade → Prerequisites |
ZTP file management
| I want to… | Go to |
|---|---|
| Upload a firmware image to the ZTP server for a platform / version. | Upload Images to the ZTP Server |
| List what’s currently on the ZTP server and verify a file’s checksum. | Upload Images → Verify the upload |
| Replace or remove an existing image without redeploying. | Upload Images → Upload via the API |
Workflow lifecycle
| I want to… | Go to |
|---|---|
| Approve, reject, retry, or terminate a workflow. | Controlling Running Workflows |
| Reject a workflow at its approval stage. | Controlling Running Workflows → Reject |
| Terminate a workflow that’s already past approval. | Controlling Running Workflows → Terminate |
| Re-run or retry a failed workflow. | Controlling Running Workflows → Retry |
Security and access control
| I want to… | Go to |
|---|---|
| Understand how RBAC gates each workflow and admin endpoint, and query the current RBAC mapping. | Workflow API Reference — the /rbac-config-status endpoint returns the active per-workflow read_roles / execute_roles mapping; per-workflow endpoints document the role each one requires. |
| Configure workflow RBAC at install time (admin roles, default read/execute roles, per-workflow overrides). | TUI Wizard Reference - Workflows |
| Configure or troubleshoot logs, metrics, PodMonitors, and the local observability stack. | Observability |
Hosting and offline operation
| I want to… | Go to |
|---|---|
| Keep operating against a site when the WAN to corp is down. | Hosting Options — on-prem cell hosting models |
| Deploy Config Manager into a site with no internet egress. | Airgapped Install |
| Validate that a serial / provisioning-state endpoint is reachable for ZTP. | Network ZTP → API Reference |