panorama_remove_bgp_candidate
Remove owned BGP resources from Panorama candidate config in two phases: plan, then apply via plan ID and hash. Optionally disable global BGP if no unowned peers remain.
Instructions
[DESTRUCTIVE] Two-phase removal of owned BGP resources. mode 'plan' returns a removal plan; mode 'apply' requires the returned plan_id and plan_hash. Pass disable_global to also disable global BGP (fails if unowned peers remain). Candidate configuration only; no commit or push is performed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | Yes | ||
| vsys | No | Virtual system name | vsys1 |
| serial | No | Managed firewall serial number. OPTIONAL — auto-resolved from the template's device assignment when omitted. Only supply it when the template is bound to more than one device. | |
| plan_id | No | ||
| firewall | No | Target firewall name (from firewalls.json). Required when multiple firewalls are configured; optional otherwise. | |
| template | Yes | Panorama template name (one per firewall) | |
| plan_hash | No | ||
| deployment | Yes | Short unique label for this deployment (e.g. 'istanbul-branch-01'). Every created object is prefixed with it, and it must not collide with any existing name — it is the ownership boundary that keeps prod safe. | |
| virtualRouter | No | Virtual router name (Legacy Virtual Router). OPTIONAL — auto-detected from the template's single virtual-router when omitted. Falls back to 'default'/'vr_root' if detection is inconclusive. | |
| disable_global | No | Also disable global BGP (refuses if unowned peers remain) |