From 25424e91cc51eba21accc299d8f6165a4e28353d Mon Sep 17 00:00:00 2001 From: masterjanic <68118279+masterjanic@users.noreply.github.com> Date: Mon, 14 Sep 2026 11:15:23 +0000 Subject: [PATCH] feat!: regenerate API model from the current Proxmox schema Regenerated by the schema-drift workflow. --- docs/reference/endpoints/cluster-ceph.md | 31 ++++++++++++- docs/reference/endpoints/index.md | 4 +- docs/reference/endpoints/nodes-ceph.md | 4 +- packages/api/src/model.ts | 58 +++++++++++++++++++++--- 4 files changed, 85 insertions(+), 12 deletions(-) diff --git a/docs/reference/endpoints/cluster-ceph.md b/docs/reference/endpoints/cluster-ceph.md index b5a75d3..466f401 100644 --- a/docs/reference/endpoints/cluster-ceph.md +++ b/docs/reference/endpoints/cluster-ceph.md @@ -7,7 +7,7 @@ editLink: false -8 operations. +10 operations. ### `GET /cluster/ceph` @@ -82,6 +82,33 @@ Returns nothing. | `flag` | `nobackfill` \| `nodeep-scrub` \| `nodown` \| `noin` \| `noout` \| `norebalance` \| `norecover` \| `noscrub` \| … (3 more) | yes | The ceph flag to update | | `value` | boolean | yes | The new value of the flag | +### `GET /cluster/ceph/health-mute` + +```ts +proxmox.cluster.ceph["health-mute"].$get() +``` + +Get the currently muted Ceph health checks. + +Returns an array of `object`. + +### `PUT /cluster/ceph/health-mute/{code}` + +```ts +proxmox.cluster.ceph["health-mute"].$(code).$put() +``` + +Mute or unmute a Ceph health check. A muted check no longer counts towards the cluster status, but stays visible and keeps being evaluated. + +Returns nothing. + +| Parameter | Type | Required | Notes | +| --- | --- | --- | --- | +| `code` | string | yes | The health check to mute, as reported by 'ceph health', for example 'AUTH_INSECURE_CLIENT_KEY_TYPE'. — ≤ 64 chars | +| `sticky` | boolean | | Keep the mute even when the check gets worse. Without this a mute clears itself as soon as the number of affected items grows, which brings the check back to attention. Only used when muting. — default `0` | +| `ttl` | string | | How long the mute lasts, for example '2h', '3d' or '1w'. Without it the mute has no expiry. Only used when muting. | +| `value` | boolean | yes | Whether to mute (true) or unmute (false) the check. | + ### `GET /cluster/ceph/metadata` ```ts @@ -109,7 +136,7 @@ Returns `string`. | Parameter | Type | Required | Notes | | --- | --- | --- | --- | | `dry-run` | boolean | | Log the plan (which daemons would be restarted, in what order) without actually doing anything. — default `0` | -| `force` | boolean | | Proceed past a HEALTH_WARN with non-benign checks like PG_DEGRADED, SLOW_OPS, or MON_DOWN. HEALTH_ERR is always fatal regardless. The operator is responsible for confirming the cluster is stable enough to absorb a rolling restart. — default `0` | +| `force` | boolean | | Proceed past a HEALTH_WARN with non-benign checks like PG_DEGRADED, SLOW_OPS, or MON_DOWN. A blocking HEALTH_ERR is fatal regardless of this flag. Checks that ceph reports as muted, and checks known to be harmless for a rolling restart, never block and are named in the task log. The cluster-wide OSD map flags are only ever evaluated for an OSD restart, since they govern nothing a mon, mgr or mds restart touches. The operator is responsible for confirming the cluster is stable enough to absorb a rolling restart. — default `0` | | `only-outdated` | boolean | | OSDs only: restart only OSDs whose running version differs from the locally-installed ceph-osd binary on their host. Forwarded to each per-node sub-task so the per-host installed version is used (a partial upgrade where one host is on a newer build is handled correctly). — default `0` | | `service-type` | `mon` \| `mgr` \| `mds` \| `osd` | yes | Ceph daemon type to restart cluster-wide. | | `timeout` | number | | Per-daemon timeout (in seconds) for the up-wait phase. Note: for daemons on remote nodes the same timeout also bounds the remote restart task, so the per-daemon budget can be up to 2x this value. Default sized for slow MDS journal replay or MON paxos settle on busy clusters; bump higher if the cluster routinely takes longer to stabilize after a daemon restart. — min 30, max 1800, default `600` | diff --git a/docs/reference/endpoints/index.md b/docs/reference/endpoints/index.md index 76423db..227baa4 100644 --- a/docs/reference/endpoints/index.md +++ b/docs/reference/endpoints/index.md @@ -7,7 +7,7 @@ editLink: false -Every one of the 678 operations the Proxmox VE API exposes, grouped +Every one of the 680 operations the Proxmox VE API exposes, grouped by path, with the call expression for each. | Group | Operations | @@ -29,7 +29,7 @@ by path, with the call expression for each. | [cluster / backup](./cluster-backup) | 6 | | [cluster / backup-info](./cluster-backup-info) | 2 | | [cluster / bulk-action](./cluster-bulk-action) | 6 | -| [cluster / ceph](./cluster-ceph) | 8 | +| [cluster / ceph](./cluster-ceph) | 10 | | [cluster / config](./cluster-config) | 10 | | [cluster / firewall](./cluster-firewall) | 31 | | [cluster / ha](./cluster-ha) | 23 | diff --git a/docs/reference/endpoints/nodes-ceph.md b/docs/reference/endpoints/nodes-ceph.md index 2617da2..1f8644e 100644 --- a/docs/reference/endpoints/nodes-ceph.md +++ b/docs/reference/endpoints/nodes-ceph.md @@ -221,7 +221,7 @@ Returns `string`. | Parameter | Type | Required | Notes | | --- | --- | --- | --- | -| `hotstandby` | boolean | | Determines whether a ceph-mds daemon should poll and replay the log of an active MDS. Faster switch on MDS failure, but needs more idle resources. — default `0` | +| `hotstandby` | boolean | | Determines whether a ceph-mds daemon should poll and replay the log of an active MDS. Faster switch on MDS failure, but needs more idle resources. Deprecated: the setting was removed in Ceph 14.1.1. — default `0` | | `name` | string | | The ID for the mds, when omitted the same as the nodename — ≤ 200 chars, default `"nodename"` | | `node` | string | yes | The cluster node name. — format `pve-node` | @@ -628,7 +628,7 @@ Returns `string`. | Parameter | Type | Required | Notes | | --- | --- | --- | --- | | `dry-run` | boolean | | Log the plan (which OSDs would be restarted, in what order) without actually doing anything. — default `0` | -| `force` | boolean | | Proceed past a HEALTH_WARN with non-benign checks like PG_DEGRADED, SLOW_OPS, or MON_DOWN. HEALTH_ERR is always fatal regardless. The operator is responsible for confirming the cluster is stable enough to absorb a rolling restart. — default `0` | +| `force` | boolean | | Proceed past a HEALTH_WARN with non-benign checks like PG_DEGRADED, SLOW_OPS, or MON_DOWN. A blocking HEALTH_ERR is fatal regardless of this flag. Checks that ceph reports as muted, and checks known to be harmless for a rolling restart, never block and are named in the task log. The cluster-wide OSD map flags are only ever evaluated for an OSD restart, since they govern nothing a mon, mgr or mds restart touches. The operator is responsible for confirming the cluster is stable enough to absorb a rolling restart. — default `0` | | `node` | string | yes | The cluster node name. — format `pve-node` | | `only-outdated` | boolean | | Restart only OSDs whose running version differs from the locally-installed ceph-osd binary. Useful for post-upgrade rolling restarts that should touch only daemons that need it. Refuses if the local binary version cannot be determined. Ignored on resume (the saved plan is used as-is). — default `0` | | `resume` | boolean | | Resume an aborted bulk-restart from the checkpoint stored in Ceph's config-key store. The plan and noout decision from the prior run are honored; 'set-noout' is ignored. When false (default), the endpoint refuses to start if a checkpoint exists for this node, to avoid silently overwriting in-progress work. — default `0` | diff --git a/packages/api/src/model.ts b/packages/api/src/model.ts index 97f251c..4362709 100644 --- a/packages/api/src/model.ts +++ b/packages/api/src/model.ts @@ -17,8 +17,8 @@ // Generated by @virtbase/proxmox-api-generator - do not edit by hand. // Regenerate with `bun run codegen`. // Source: https://pve.proxmox.com/pve-docs/api-viewer/apidoc.js -// SHA-256: 9def8f13611184ee1c7d0399713130dfc4a065701d0d91a69b9c03df929344e9 -// Covers 678 operations. +// SHA-256: 25b2f65d98d9bf2d1ca9624113222dad15bbeb15c6fb125d1c6192d57c13a4d9 +// Covers 680 operations. export namespace Proxmox { export type Accel = "kvm" | "tcg"; @@ -3311,6 +3311,17 @@ export namespace Proxmox { /** Additional, unlisted properties. */ [key: string]: any; } + /** Returned by GET /cluster/ceph/health-mute */ + export interface clusterCephHealthMuteHealthMuteIndex { + /** The muted health check. */ + code: string; + /** Whether the mute survives the check getting worse. */ + sticky: boolean; + /** What the check reports. */ + summary?: string; + /** When the mute expires. Absent if it does not. */ + ttl?: string; + } /** Returned by GET /cluster/ceph/metadata */ export interface clusterCephMetadataMetadata { /** Metadata servers configured in the cluster and their properties, keyed by '@'. */ @@ -14272,7 +14283,7 @@ export namespace Proxmox { */ "dry-run"?: boolean; /** - * Proceed past a HEALTH_WARN with non-benign checks like PG_DEGRADED, SLOW_OPS, or MON_DOWN. HEALTH_ERR is always fatal regardless. The operator is responsible for confirming the cluster is stable enough to absorb a rolling restart. + * Proceed past a HEALTH_WARN with non-benign checks like PG_DEGRADED, SLOW_OPS, or MON_DOWN. A blocking HEALTH_ERR is fatal regardless of this flag. Checks that ceph reports as muted, and checks known to be harmless for a rolling restart, never block and are named in the task log. The cluster-wide OSD map flags are only ever evaluated for an OSD restart, since they govern nothing a mon, mgr or mds restart touches. The operator is responsible for confirming the cluster is stable enough to absorb a rolling restart. * @default 0 * @typetext */ @@ -14389,6 +14400,41 @@ export namespace Proxmox { }): Promise; }; }; + "health-mute": { + /** + * Get the currently muted Ceph health checks. + * GET /cluster/ceph/health-mute + * @allowtoken 1 + * @permissions \{"check":["perm","/",["Sys.Audit","Datastore.Audit"],"any",1]\} + */ + $get(): Promise; + $(code: string): { + /** + * Mute or unmute a Ceph health check. A muted check no longer counts towards the cluster status, but stays visible and keeps being evaluated. + * PUT /cluster/ceph/health-mute/\{code\} + * @allowtoken 1 + * @permissions \{"check":["perm","/",["Sys.Modify"]]\} + */ + $put(param: { + /** + * Keep the mute even when the check gets worse. Without this a mute clears itself as soon as the number of affected items grows, which brings the check back to attention. Only used when muting. + * @default 0 + * @typetext + */ + sticky?: boolean; + /** + * How long the mute lasts, for example '2h', '3d' or '1w'. Without it the mute has no expiry. Only used when muting. + * @pattern \d+[ \t]*(?:s|sec|seconds?|m|min|minutes?|h|hr|hours?|d|days?|w|wk|weeks?|mo|months?|y|yr|years?)(?:[ \t]*\d+[ \t]*(?:s|sec|seconds?|m|min|minutes?|h|hr|hours?|d|days?|w|wk|weeks?|mo|months?|y|yr|years?))*(?!\n) + */ + ttl?: string; + /** + * Whether to mute (true) or unmute (false) the check. + * @typetext + */ + value: boolean; + }): Promise; + }; + }; }; jobs: { /** @@ -25926,7 +25972,7 @@ export namespace Proxmox { */ $post(param?: { /** - * Determines whether a ceph-mds daemon should poll and replay the log of an active MDS. Faster switch on MDS failure, but needs more idle resources. + * Determines whether a ceph-mds daemon should poll and replay the log of an active MDS. Faster switch on MDS failure, but needs more idle resources. Deprecated: the setting was removed in Ceph 14.1.1. * @default 0 * @typetext */ @@ -26374,7 +26420,7 @@ export namespace Proxmox { */ "dry-run"?: boolean; /** - * Proceed past a HEALTH_WARN with non-benign checks like PG_DEGRADED, SLOW_OPS, or MON_DOWN. HEALTH_ERR is always fatal regardless. The operator is responsible for confirming the cluster is stable enough to absorb a rolling restart. + * Proceed past a HEALTH_WARN with non-benign checks like PG_DEGRADED, SLOW_OPS, or MON_DOWN. A blocking HEALTH_ERR is fatal regardless of this flag. Checks that ceph reports as muted, and checks known to be harmless for a rolling restart, never block and are named in the task log. The cluster-wide OSD map flags are only ever evaluated for an OSD restart, since they govern nothing a mon, mgr or mds restart touches. The operator is responsible for confirming the cluster is stable enough to absorb a rolling restart. * @default 0 * @typetext */ @@ -26483,7 +26529,7 @@ export namespace Proxmox { * Create backup. * POST /nodes/\{node\}/vzdump * @allowtoken 1 - * @permissions \{"description":"The user needs 'VM.Backup' permissions on any VM, and 'Datastore.AllocateSpace' on the backup storage (and fleecing storage when fleecing is used). The 'tmpdir', 'dumpdir', 'script' and 'job-id' parameters are restricted to the 'root@pam' user. The 'prune-backups' setting requires 'Datastore.Allocate' on the backup storage. The 'bwlimit', 'performance' and 'ionice' parameters require 'Sys.Modify' on '/'.","user":"all"\} + * @permissions \{"description":"The user needs 'VM.Backup' permissions on any VM, and 'Datastore.AllocateSpace' on the backup storage (and fleecing storage when fleecing is used). The 'tmpdir', 'dumpdir', 'script' and 'job-id' parameters are restricted to the 'root@pam' user. The 'prune-backups' setting requires 'Datastore.Allocate' on the backup storage. The 'bwlimit', 'performance' and 'ionice' parameters require 'Sys.Modify' on '/'. The 'stop' parameter requires 'Sys.Modify' on '/nodes/\{node\}'","user":"all"\} */ $post(param?: { /**