Set OS patch policy
set_os_patch_policyChange an Ankra-provisioned cluster's rolling OS patch policy. mode sets how the cluster gets OS updates: automatic lets the platform start the rolling run_os_patches on its own inside the maintenance window, at most once per cadence_days (one node at a time, drained, stopping on the first failure); advisory means nothing patches it on its own and a person starts the run (the dry run and the package findings still report what is pending); default clears the choice so the cluster's purpose decides: automatic for a cluster a person labelled non-production (only 14 days after the organisation is told), advisory for production and for a label nobody chose. enabled is the older spelling (true is automatic, false advisory). Control planes and the bastion follow the cluster; node_group_modes overrides it per node group (automatic, advisory, or inherit to follow the cluster again), so one node group of a production cluster can be automatic. Automatic hosts keep Ankra's update hold on the packages the run patches; making hosts advisory removes the hold from them so unattended-upgrades patches them again, and is refused while a run is in progress. The window opens on window_days at window_start_hour_utc and stays open window_duration_hours (1-12); a run only starts inside it and may finish after it. include_stateful_nodes lets runs drain nodes carrying single-replica workloads with volumes; security_lag_days (1-90) is how long held-back security updates may stay pending before the cluster reports a security lag. Only the members you pass change; the rest keep their stored values. The defaults are no chosen mode, Monday to Thursday 02:00-06:00 UTC, weekly, stateful nodes skipped, 14 days.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "set_os_patch_policy"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | How the cluster gets OS updates: automatic (the rolling run in the window), advisory (a person starts it), or default (follow the cluster's environment). | |
| enabled | No | The older spelling of mode: true is automatic, false advisory. | |
| cluster_id | No | UUID of the cluster. Optional when a cluster is selected. | |
| window_days | No | The UTC days the window opens on. | |
| cadence_days | No | The minimum number of days between two automatic runs. | |
| cluster_name | No | Exact name of the cluster. Optional when a cluster is selected. | |
| node_group_modes | No | Per node group overrides, by node group name: automatic, advisory, or inherit to follow the cluster. Groups not named keep their override. | |
| security_lag_days | No | Days held-back security updates may stay pending before the cluster reports a security lag. | |
| window_duration_hours | No | How many hours the window stays open. | |
| window_start_hour_utc | No | The UTC hour the window opens. | |
| include_stateful_nodes | No | Let runs drain nodes carrying single-replica workloads with volumes or belonging to a database node pool. |