@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/CHANGELOG.md
CHANGED
|
@@ -68,6 +68,17 @@ and republished as `@virtbase/proxmox-api`.
|
|
|
68
68
|
the types. Replaces 63 MB of committed typedoc HTML that documented the PVE 8
|
|
69
69
|
surface.
|
|
70
70
|
|
|
71
|
+
## [3.0.0](https://github.com/virtbase/proxmox-api/compare/2.0.0...3.0.0) (2026-09-17)
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
### ⚠ BREAKING CHANGES
|
|
75
|
+
|
|
76
|
+
* regenerate API model from the current Proxmox schema ([#5](https://github.com/virtbase/proxmox-api/issues/5))
|
|
77
|
+
|
|
78
|
+
### Features
|
|
79
|
+
|
|
80
|
+
* regenerate API model from the current Proxmox schema ([#5](https://github.com/virtbase/proxmox-api/issues/5)) ([99e564e](https://github.com/virtbase/proxmox-api/commit/99e564ee4d8427e7b1303ff115cc913684fd6ac6))
|
|
81
|
+
|
|
71
82
|
## [2.0.0](https://github.com/virtbase/proxmox-api/compare/1.1.1...2.0.0) (2026-09-04)
|
|
72
83
|
|
|
73
84
|
|
package/dist/model.d.ts
CHANGED
|
@@ -1587,6 +1587,17 @@ export declare namespace Proxmox {
|
|
|
1587
1587
|
/** Additional, unlisted properties. */
|
|
1588
1588
|
[key: string]: any;
|
|
1589
1589
|
}
|
|
1590
|
+
/** Returned by GET /cluster/ceph/health-mute */
|
|
1591
|
+
interface clusterCephHealthMuteHealthMuteIndex {
|
|
1592
|
+
/** The muted health check. */
|
|
1593
|
+
code: string;
|
|
1594
|
+
/** Whether the mute survives the check getting worse. */
|
|
1595
|
+
sticky: boolean;
|
|
1596
|
+
/** What the check reports. */
|
|
1597
|
+
summary?: string;
|
|
1598
|
+
/** When the mute expires. Absent if it does not. */
|
|
1599
|
+
ttl?: string;
|
|
1600
|
+
}
|
|
1590
1601
|
/** Returned by GET /cluster/ceph/metadata */
|
|
1591
1602
|
interface clusterCephMetadataMetadata {
|
|
1592
1603
|
/** Metadata servers configured in the cluster and their properties, keyed by '<name>@<host>'. */
|
|
@@ -12548,7 +12559,7 @@ export declare namespace Proxmox {
|
|
|
12548
12559
|
*/
|
|
12549
12560
|
"dry-run"?: boolean;
|
|
12550
12561
|
/**
|
|
12551
|
-
* Proceed past a HEALTH_WARN with non-benign checks like PG_DEGRADED, SLOW_OPS, or MON_DOWN. HEALTH_ERR is
|
|
12562
|
+
* 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.
|
|
12552
12563
|
* @default 0
|
|
12553
12564
|
* @typetext <boolean>
|
|
12554
12565
|
*/
|
|
@@ -12665,6 +12676,41 @@ export declare namespace Proxmox {
|
|
|
12665
12676
|
}): Promise<null>;
|
|
12666
12677
|
};
|
|
12667
12678
|
};
|
|
12679
|
+
"health-mute": {
|
|
12680
|
+
/**
|
|
12681
|
+
* Get the currently muted Ceph health checks.
|
|
12682
|
+
* GET /cluster/ceph/health-mute
|
|
12683
|
+
* @allowtoken 1
|
|
12684
|
+
* @permissions \{"check":["perm","/",["Sys.Audit","Datastore.Audit"],"any",1]\}
|
|
12685
|
+
*/
|
|
12686
|
+
$get(): Promise<clusterCephHealthMuteHealthMuteIndex[]>;
|
|
12687
|
+
$(code: string): {
|
|
12688
|
+
/**
|
|
12689
|
+
* Mute or unmute a Ceph health check. A muted check no longer counts towards the cluster status, but stays visible and keeps being evaluated.
|
|
12690
|
+
* PUT /cluster/ceph/health-mute/\{code\}
|
|
12691
|
+
* @allowtoken 1
|
|
12692
|
+
* @permissions \{"check":["perm","/",["Sys.Modify"]]\}
|
|
12693
|
+
*/
|
|
12694
|
+
$put(param: {
|
|
12695
|
+
/**
|
|
12696
|
+
* 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.
|
|
12697
|
+
* @default 0
|
|
12698
|
+
* @typetext <boolean>
|
|
12699
|
+
*/
|
|
12700
|
+
sticky?: boolean;
|
|
12701
|
+
/**
|
|
12702
|
+
* How long the mute lasts, for example '2h', '3d' or '1w'. Without it the mute has no expiry. Only used when muting.
|
|
12703
|
+
* @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)
|
|
12704
|
+
*/
|
|
12705
|
+
ttl?: string;
|
|
12706
|
+
/**
|
|
12707
|
+
* Whether to mute (true) or unmute (false) the check.
|
|
12708
|
+
* @typetext <boolean>
|
|
12709
|
+
*/
|
|
12710
|
+
value: boolean;
|
|
12711
|
+
}): Promise<null>;
|
|
12712
|
+
};
|
|
12713
|
+
};
|
|
12668
12714
|
};
|
|
12669
12715
|
jobs: {
|
|
12670
12716
|
/**
|
|
@@ -24202,7 +24248,7 @@ export declare namespace Proxmox {
|
|
|
24202
24248
|
*/
|
|
24203
24249
|
$post(param?: {
|
|
24204
24250
|
/**
|
|
24205
|
-
* 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.
|
|
24251
|
+
* 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.
|
|
24206
24252
|
* @default 0
|
|
24207
24253
|
* @typetext <boolean>
|
|
24208
24254
|
*/
|
|
@@ -24650,7 +24696,7 @@ export declare namespace Proxmox {
|
|
|
24650
24696
|
*/
|
|
24651
24697
|
"dry-run"?: boolean;
|
|
24652
24698
|
/**
|
|
24653
|
-
* Proceed past a HEALTH_WARN with non-benign checks like PG_DEGRADED, SLOW_OPS, or MON_DOWN. HEALTH_ERR is
|
|
24699
|
+
* 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.
|
|
24654
24700
|
* @default 0
|
|
24655
24701
|
* @typetext <boolean>
|
|
24656
24702
|
*/
|
|
@@ -24759,7 +24805,7 @@ export declare namespace Proxmox {
|
|
|
24759
24805
|
* Create backup.
|
|
24760
24806
|
* POST /nodes/\{node\}/vzdump
|
|
24761
24807
|
* @allowtoken 1
|
|
24762
|
-
* @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"\}
|
|
24808
|
+
* @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"\}
|
|
24763
24809
|
*/
|
|
24764
24810
|
$post(param?: {
|
|
24765
24811
|
/**
|