@virtbase/proxmox-api 2.0.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +11 -0
- package/dist/model.d.ts +50 -4
- package/dist/model.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/model.ts +52 -6
package/package.json
CHANGED
package/src/model.ts
CHANGED
|
@@ -17,8 +17,8 @@
|
|
|
17
17
|
// Generated by @virtbase/proxmox-api-generator - do not edit by hand.
|
|
18
18
|
// Regenerate with `bun run codegen`.
|
|
19
19
|
// Source: https://pve.proxmox.com/pve-docs/api-viewer/apidoc.js
|
|
20
|
-
// SHA-256:
|
|
21
|
-
// Covers
|
|
20
|
+
// SHA-256: 25b2f65d98d9bf2d1ca9624113222dad15bbeb15c6fb125d1c6192d57c13a4d9
|
|
21
|
+
// Covers 680 operations.
|
|
22
22
|
|
|
23
23
|
export namespace Proxmox {
|
|
24
24
|
export type Accel = "kvm" | "tcg";
|
|
@@ -3311,6 +3311,17 @@ export namespace Proxmox {
|
|
|
3311
3311
|
/** Additional, unlisted properties. */
|
|
3312
3312
|
[key: string]: any;
|
|
3313
3313
|
}
|
|
3314
|
+
/** Returned by GET /cluster/ceph/health-mute */
|
|
3315
|
+
export interface clusterCephHealthMuteHealthMuteIndex {
|
|
3316
|
+
/** The muted health check. */
|
|
3317
|
+
code: string;
|
|
3318
|
+
/** Whether the mute survives the check getting worse. */
|
|
3319
|
+
sticky: boolean;
|
|
3320
|
+
/** What the check reports. */
|
|
3321
|
+
summary?: string;
|
|
3322
|
+
/** When the mute expires. Absent if it does not. */
|
|
3323
|
+
ttl?: string;
|
|
3324
|
+
}
|
|
3314
3325
|
/** Returned by GET /cluster/ceph/metadata */
|
|
3315
3326
|
export interface clusterCephMetadataMetadata {
|
|
3316
3327
|
/** Metadata servers configured in the cluster and their properties, keyed by '<name>@<host>'. */
|
|
@@ -14272,7 +14283,7 @@ export namespace Proxmox {
|
|
|
14272
14283
|
*/
|
|
14273
14284
|
"dry-run"?: boolean;
|
|
14274
14285
|
/**
|
|
14275
|
-
* Proceed past a HEALTH_WARN with non-benign checks like PG_DEGRADED, SLOW_OPS, or MON_DOWN. HEALTH_ERR is
|
|
14286
|
+
* 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.
|
|
14276
14287
|
* @default 0
|
|
14277
14288
|
* @typetext <boolean>
|
|
14278
14289
|
*/
|
|
@@ -14389,6 +14400,41 @@ export namespace Proxmox {
|
|
|
14389
14400
|
}): Promise<null>;
|
|
14390
14401
|
};
|
|
14391
14402
|
};
|
|
14403
|
+
"health-mute": {
|
|
14404
|
+
/**
|
|
14405
|
+
* Get the currently muted Ceph health checks.
|
|
14406
|
+
* GET /cluster/ceph/health-mute
|
|
14407
|
+
* @allowtoken 1
|
|
14408
|
+
* @permissions \{"check":["perm","/",["Sys.Audit","Datastore.Audit"],"any",1]\}
|
|
14409
|
+
*/
|
|
14410
|
+
$get(): Promise<clusterCephHealthMuteHealthMuteIndex[]>;
|
|
14411
|
+
$(code: string): {
|
|
14412
|
+
/**
|
|
14413
|
+
* Mute or unmute a Ceph health check. A muted check no longer counts towards the cluster status, but stays visible and keeps being evaluated.
|
|
14414
|
+
* PUT /cluster/ceph/health-mute/\{code\}
|
|
14415
|
+
* @allowtoken 1
|
|
14416
|
+
* @permissions \{"check":["perm","/",["Sys.Modify"]]\}
|
|
14417
|
+
*/
|
|
14418
|
+
$put(param: {
|
|
14419
|
+
/**
|
|
14420
|
+
* 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.
|
|
14421
|
+
* @default 0
|
|
14422
|
+
* @typetext <boolean>
|
|
14423
|
+
*/
|
|
14424
|
+
sticky?: boolean;
|
|
14425
|
+
/**
|
|
14426
|
+
* How long the mute lasts, for example '2h', '3d' or '1w'. Without it the mute has no expiry. Only used when muting.
|
|
14427
|
+
* @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)
|
|
14428
|
+
*/
|
|
14429
|
+
ttl?: string;
|
|
14430
|
+
/**
|
|
14431
|
+
* Whether to mute (true) or unmute (false) the check.
|
|
14432
|
+
* @typetext <boolean>
|
|
14433
|
+
*/
|
|
14434
|
+
value: boolean;
|
|
14435
|
+
}): Promise<null>;
|
|
14436
|
+
};
|
|
14437
|
+
};
|
|
14392
14438
|
};
|
|
14393
14439
|
jobs: {
|
|
14394
14440
|
/**
|
|
@@ -25926,7 +25972,7 @@ export namespace Proxmox {
|
|
|
25926
25972
|
*/
|
|
25927
25973
|
$post(param?: {
|
|
25928
25974
|
/**
|
|
25929
|
-
* 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.
|
|
25975
|
+
* 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.
|
|
25930
25976
|
* @default 0
|
|
25931
25977
|
* @typetext <boolean>
|
|
25932
25978
|
*/
|
|
@@ -26374,7 +26420,7 @@ export namespace Proxmox {
|
|
|
26374
26420
|
*/
|
|
26375
26421
|
"dry-run"?: boolean;
|
|
26376
26422
|
/**
|
|
26377
|
-
* Proceed past a HEALTH_WARN with non-benign checks like PG_DEGRADED, SLOW_OPS, or MON_DOWN. HEALTH_ERR is
|
|
26423
|
+
* 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.
|
|
26378
26424
|
* @default 0
|
|
26379
26425
|
* @typetext <boolean>
|
|
26380
26426
|
*/
|
|
@@ -26483,7 +26529,7 @@ export namespace Proxmox {
|
|
|
26483
26529
|
* Create backup.
|
|
26484
26530
|
* POST /nodes/\{node\}/vzdump
|
|
26485
26531
|
* @allowtoken 1
|
|
26486
|
-
* @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"\}
|
|
26532
|
+
* @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"\}
|
|
26487
26533
|
*/
|
|
26488
26534
|
$post(param?: {
|
|
26489
26535
|
/**
|