NAPALM/napalm-proxmox
1
0 Fork 0
Code Issues 14 Pull Requests 1 Actions Packages Projects Releases 1 Wiki Activity

feat: shutdown_host and begin_stop_vm through the API #34

Open
christianmanivong wants to merge 1 commits from feat/shutdown-requests into main
pull from: feat/shutdown-requests
merge into: NAPALM:main
Conversation 0 Commits 1 Files Changed 3
+99 -1
christianmanivong commented 2026-10-27 00:07:26 +00:00
Owner
Copy link
Copy source

Summary

shutdown_host() and begin_stop_vm(name) for netOrk's graph workflows, which shut pve-dual down when CI has nothing for build-01 (NetOrk/netork#1636, epic NetOrk/netork#1633). They implement the contracts of NAPALM/napalm-device-types#55.

Changes

  • shutdown_host(): POST /nodes/{node}/status with command=shutdown, next to reboot_host(). A refusal is a RuntimeError.
  • begin_stop_vm(name): POST …/status/shutdown for a VM or container, found by vmid or name. It returns once Proxmox took the request and does not wait for the task. stop_vm waits at most 120 s, and a guest with down=300 can take longer. An unknown guest is a ValueError, a refusal a RuntimeError.
  • The driver does not import the new mixins yet, because napalm_device_types>=4.22.0 does not have them; netOrk asks with hasattr. Mixing them in can come with the next device-types release.
  • CHANGELOG (Unreleased).

Testing

  • tests/test_shutdown_requests.py (7): the request sent, no task waited for, VM and container, by name and by vmid, unknown guest, refusal.
  • Full suite: 350 passed (with device-types from #55 on the path). ruff, format and mypy are clean.
## Summary `shutdown_host()` and `begin_stop_vm(name)` for netOrk's graph workflows, which shut pve-dual down when CI has nothing for build-01 (NetOrk/netork#1636, epic NetOrk/netork#1633). They implement the contracts of NAPALM/napalm-device-types#55. ## Changes - `shutdown_host()`: `POST /nodes/{node}/status` with `command=shutdown`, next to `reboot_host()`. A refusal is a `RuntimeError`. - `begin_stop_vm(name)`: `POST …/status/shutdown` for a VM or container, found by vmid or name. It returns once Proxmox took the request and does not wait for the task. `stop_vm` waits at most 120 s, and a guest with `down=300` can take longer. An unknown guest is a `ValueError`, a refusal a `RuntimeError`. - The driver does not import the new mixins yet, because `napalm_device_types>=4.22.0` does not have them; netOrk asks with `hasattr`. Mixing them in can come with the next device-types release. - CHANGELOG (Unreleased). ## Testing - `tests/test_shutdown_requests.py` (7): the request sent, no task waited for, VM and container, by name and by vmid, unknown guest, refusal. - Full suite: 350 passed (with device-types from #55 on the path). ruff, format and mypy are clean.
christianmanivong added 1 commit 2026-10-27 00:07:26 +00:00
feat: shutdown_host and begin_stop_vm through the API
driver / standard (pull_request) Successful in 14s
Details
driver / lint (pull_request) Successful in 11s
Details
driver / types (pull_request) Successful in 1m2s
Details
driver / test (3.10) (pull_request) Successful in 1m9s
Details
driver / test (3.11) (pull_request) Successful in 1m8s
Details
driver / lowest (pull_request) Successful in 34s
Details
driver / test (3.12) (pull_request) Successful in 1m3s
Details
driver / test (3.13) (pull_request) Successful in 1m0s
Details
driver / build (pull_request) Successful in 26s
Details
driver / security (pull_request) Successful in 1m1s
Details
CI / driver (pull_request) Successful in 3m17s
Details
driver / publish (pull_request) Skipped
Details
16f1b87392 
shutdown_host() posts command=shutdown to the node itself; its guests
stop as on any shutdown. begin_stop_vm(name) asks a guest for its clean
shutdown and returns once Proxmox took it, without waiting for the
task: the caller reads get_vm_status until it stopped. Both raise
RuntimeError when Proxmox refuses; an unknown guest is a ValueError.

The contracts HostShutdownMixin and VmStopRequestMixin of
napalm-device-types (NAPALM/napalm-device-types#55); for netOrk's graph
workflows (NetOrk/netork#1636).
All checks were successful
driver / standard (pull_request) Successful in 14s
Details
driver / lint (pull_request) Successful in 11s
Details
driver / types (pull_request) Successful in 1m2s
Details
driver / test (3.10) (pull_request) Successful in 1m9s
Details
driver / test (3.11) (pull_request) Successful in 1m8s
Details
driver / lowest (pull_request) Successful in 34s
Details
driver / test (3.12) (pull_request) Successful in 1m3s
Details
driver / test (3.13) (pull_request) Successful in 1m0s
Details
driver / build (pull_request) Successful in 26s
Details
driver / security (pull_request) Successful in 1m1s
Details
CI / driver (pull_request) Successful in 3m17s
Details
driver / publish (pull_request) Skipped
Details
You are not authorized to merge this pull request.
This pull request can be merged automatically.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin feat/shutdown-requests:feat/shutdown-requests
git checkout feat/shutdown-requests
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
bug
Something is broken
 enhancement
New feature or request
 tech-debt
Refactoring / cleanup / deferred debt
prio
P0
Road blocker: blocks other work, drop everything
prio
P1
Critical
prio
P2
Important and urgent
prio
P3
Important, not urgent
prio
P4
Neither important nor urgent
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
christianmanivong
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: NAPALM/napalm-proxmox#34