plan_os_patches
Dry-run the rolling OS security-patch lane on an Ankra-provisioned cluster (Hetzner, OVH, UpCloud, DigitalOcean, Scaleway, AWS or Ankra Cloud): on every node and the bastion it simulates the pending apt upgrades against the package lists the host already has and changes nothing. Ankra's unattended upgrades deliberately hold back the packages whose updates restart networking in place (systemd, udev, netplan, the container runtime, iptables/nftables), so their security fixes only arrive through run_os_patches; this shows what is waiting. Per host: the pending, security and held-back packages, whether a reboot is owed, how old the package lists are, and a stateful_verdict - would_skip names the single-replica workloads with volumes (or the database node pool) that make run_os_patches skip the node unless include_stateful_nodes is true. It also returns the order a run would take (control planes first, one at a time, then the workers, the bastion last), the hosts a run would leave out and why (a node that is not up, a cluster's only control plane), and the cluster's patch policy. A host whose status is not success has an unknown plan, not an empty one. It waits about 40 seconds for the hosts; when completed is false, call get_os_patch_status a minute later for the finished plan.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cluster_id | No | UUID of the cluster. Optional when a cluster is selected. | |
| cluster_name | No | Exact name of the cluster. Optional when a cluster is selected. |