@virtbase/proxmox-api 4.0.0 → 5.0.1

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/dist/model.d.ts CHANGED
@@ -1479,7 +1479,7 @@ export declare namespace Proxmox {
1479
1479
  * PVE format `address-list`.
1480
1480
  */
1481
1481
  type AddressList = string;
1482
- type ApiEnum = "1984hosting" | "acmedns" | "acmeproxy" | "active24" | "ad" | "ali" | "alviy" | "anx" | "artfiles" | "arvan" | "aurora" | "autodns" | "aws" | "azion" | "azure" | "beget" | "bookmyname" | "bunny" | "cf" | "clouddns" | "cloudns" | "cn" | "conoha" | "constellix" | "cpanel" | "curanet" | "cyon" | "da" | "ddnss" | "desec" | "df" | "dgon" | "dnsexit" | "dnshome" | "dnsimple" | "dnsservices" | "doapi" | "domeneshop" | "dp" | "dpi" | "dreamhost" | "duckdns" | "durabledns" | "dyn" | "dynu" | "dynv6" | "easydns" | "edgecenter" | "edgedns" | "euserv" | "exoscale" | "fornex" | "freedns" | "freemyip" | "gandi_livedns" | "gcloud" | "gcore" | "gd" | "geoscaling" | "googledomains" | "he" | "he_ddns" | "hetzner" | "hetznercloud" | "hexonet" | "hostingde" | "huaweicloud" | "infoblox" | "infomaniak" | "internetbs" | "inwx" | "ionos" | "ionos_cloud" | "ipv64" | "ispconfig" | "jd" | "joker" | "kappernet" | "kas" | "kinghost" | "knot" | "la" | "leaseweb" | "lexicon" | "limacity" | "linode" | "linode_v4" | "loopia" | "lua" | "maradns" | "me" | "miab" | "mijnhost" | "misaka" | "myapi" | "mydevil" | "mydnsjp" | "mythic_beasts" | "namecheap" | "namecom" | "namesilo" | "nanelo" | "nederhost" | "neodigit" | "netcup" | "netlify" | "nic" | "njalla" | "nm" | "nsd" | "nsone" | "nsupdate" | "nw" | "oci" | "omglol" | "one" | "online" | "openprovider" | "openprovider_rest" | "openstack" | "opnsense" | "ovh" | "pdns" | "pleskxml" | "pointhq" | "porkbun" | "rackcorp" | "rackspace" | "rage4" | "rcode0" | "regru" | "scaleway" | "schlundtech" | "selectel" | "selfhost" | "servercow" | "simply" | "spaceship" | "technitium" | "tele3" | "tencent" | "timeweb" | "transip" | "udr" | "ultra" | "unoeuro" | "variomedia" | "veesp" | "vercel" | "vscale" | "vultr" | "websupport" | "west_cn" | "world4you" | "yandex360" | "yc" | "zilore" | "zone" | "zoneedit" | "zonomi";
1482
+ type ApiEnum = "1984hosting" | "acmedns" | "acmeproxy" | "active24" | "ad" | "ali" | "alviy" | "anx" | "artfiles" | "arubabusiness" | "arvan" | "aurora" | "autodns" | "aws" | "azion" | "azure" | "baidu" | "beget" | "bh" | "bhosted" | "bookmyname" | "bunny" | "calrissia" | "cdmon" | "cf" | "clouddns" | "cloudns" | "cn" | "comlaude" | "conoha" | "constellix" | "cpanel" | "cpanel_uapi" | "creoline" | "curanet" | "cyon" | "czechia" | "da" | "ddnss" | "desec" | "df" | "dgon" | "dnsexit" | "dnshome" | "dnsimple" | "dnsmint" | "dnsservices" | "doapi" | "domeneshop" | "dp" | "dpi" | "dreamhost" | "duckdns" | "durabledns" | "dyn" | "dynu" | "dynv6" | "easydns" | "edgecenter" | "edgedns" | "efficientip" | "eurodns" | "euserv" | "exoscale" | "firestorm" | "fornex" | "freedns" | "freemyip" | "gandi_livedns" | "gcloud" | "gcore" | "gd" | "geoscaling" | "glesys" | "gname" | "googledomains" | "he" | "he_ddns" | "hestiacp" | "hetznercloud" | "hexonet" | "hostingde" | "hostinger" | "hostup" | "huaweicloud" | "hw" | "infoblox" | "infoblox_uddi" | "infomaniak" | "internetbs" | "inwx" | "ionos" | "ionos_cloud" | "ipprojects" | "ipv64" | "ispconfig" | "jd" | "joker" | "kappernet" | "kas" | "kinghost" | "knot" | "la" | "laodc" | "leaseweb" | "level27" | "lexicon" | "limacity" | "linode_v4" | "loopia" | "lua" | "maradns" | "me" | "mgwm" | "miab" | "mijnhost" | "misaka" | "muumuu" | "myapi" | "mydevil" | "mydnsjp" | "myloc" | "mythic_beasts" | "namecheap" | "namecom" | "namesilo" | "nanelo" | "nederhost" | "neodigit" | "netcup" | "netlify" | "nexdns" | "nic" | "njalla" | "nm" | "nsd" | "nsone" | "nsupdate" | "nw" | "oci" | "omglol" | "one" | "online" | "openprovider" | "openprovider_rest" | "openstack" | "opnsense" | "opteamax" | "optidata" | "opusdns" | "ovh" | "pdns" | "pleskxml" | "pointhq" | "porkbun" | "poweradmin" | "qc" | "rackcorp" | "rackspace" | "rage4" | "rcode0" | "regru" | "rltx" | "scaleway" | "schlundtech" | "selectel" | "selfhost" | "servercow" | "simply" | "sitehost" | "sotoon" | "spaceship" | "subreg" | "technitium" | "tele3" | "tencent" | "timeweb" | "transip" | "udr" | "ultra" | "unoeuro" | "variomedia" | "veesp" | "vercel" | "virakcloud" | "volcengine" | "vscale" | "vultr" | "websupport" | "wedos" | "west_cn" | "world4you" | "yandex360" | "yc" | "zilore" | "zone" | "zoneedit" | "zonomi";
1483
1483
  type Application = "rbd" | "cephfs" | "rgw";
1484
1484
  type ArmedState = "armed" | "standby" | "disarming" | "disarmed";
1485
1485
  /**
@@ -1917,7 +1917,7 @@ export declare namespace Proxmox {
1917
1917
  */
1918
1918
  "notes-template"?: string;
1919
1919
  /**
1920
- * Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not.
1920
+ * Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. If set to 'none', no notification will be sent.
1921
1921
  * @default auto
1922
1922
  */
1923
1923
  "notification-mode"?: NotificationMode;
@@ -2168,7 +2168,7 @@ export declare namespace Proxmox {
2168
2168
  */
2169
2169
  "notes-template"?: string;
2170
2170
  /**
2171
- * Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not.
2171
+ * Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. If set to 'none', no notification will be sent.
2172
2172
  * @default auto
2173
2173
  */
2174
2174
  "notification-mode"?: NotificationMode;
@@ -2217,12 +2217,12 @@ export declare namespace Proxmox {
2217
2217
  */
2218
2218
  "keep-all"?: boolean | 0 | 1;
2219
2219
  /**
2220
- * Keep backups for the last <N> different days. If there is morethan one backup for a single day, only the latest one is kept.
2220
+ * Keep backups for the last <N> different days. If there is more than one backup for a single day, only the latest one is kept.
2221
2221
  * @minimum 0
2222
2222
  */
2223
2223
  "keep-daily"?: number;
2224
2224
  /**
2225
- * Keep backups for the last <N> different hours. If there is morethan one backup for a single hour, only the latest one is kept.
2225
+ * Keep backups for the last <N> different hours. If there is more than one backup for a single hour, only the latest one is kept.
2226
2226
  * @minimum 0
2227
2227
  */
2228
2228
  "keep-hourly"?: number;
@@ -2232,17 +2232,17 @@ export declare namespace Proxmox {
2232
2232
  */
2233
2233
  "keep-last"?: number;
2234
2234
  /**
2235
- * Keep backups for the last <N> different months. If there is morethan one backup for a single month, only the latest one is kept.
2235
+ * Keep backups for the last <N> different months. If there is more than one backup for a single month, only the latest one is kept.
2236
2236
  * @minimum 0
2237
2237
  */
2238
2238
  "keep-monthly"?: number;
2239
2239
  /**
2240
- * Keep backups for the last <N> different weeks. If there is morethan one backup for a single week, only the latest one is kept.
2240
+ * Keep backups for the last <N> different weeks. If there is more than one backup for a single week, only the latest one is kept.
2241
2241
  * @minimum 0
2242
2242
  */
2243
2243
  "keep-weekly"?: number;
2244
2244
  /**
2245
- * Keep backups for the last <N> different years. If there is morethan one backup for a single year, only the latest one is kept.
2245
+ * Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept.
2246
2246
  * @minimum 0
2247
2247
  */
2248
2248
  "keep-yearly"?: number;
@@ -2442,7 +2442,7 @@ export declare namespace Proxmox {
2442
2442
  */
2443
2443
  "notes-template"?: string;
2444
2444
  /**
2445
- * Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not.
2445
+ * Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. If set to 'none', no notification will be sent.
2446
2446
  * @default auto
2447
2447
  */
2448
2448
  "notification-mode"?: NotificationMode;
@@ -2491,12 +2491,12 @@ export declare namespace Proxmox {
2491
2491
  */
2492
2492
  "keep-all"?: boolean | 0 | 1;
2493
2493
  /**
2494
- * Keep backups for the last <N> different days. If there is morethan one backup for a single day, only the latest one is kept.
2494
+ * Keep backups for the last <N> different days. If there is more than one backup for a single day, only the latest one is kept.
2495
2495
  * @minimum 0
2496
2496
  */
2497
2497
  "keep-daily"?: number;
2498
2498
  /**
2499
- * Keep backups for the last <N> different hours. If there is morethan one backup for a single hour, only the latest one is kept.
2499
+ * Keep backups for the last <N> different hours. If there is more than one backup for a single hour, only the latest one is kept.
2500
2500
  * @minimum 0
2501
2501
  */
2502
2502
  "keep-hourly"?: number;
@@ -2506,17 +2506,17 @@ export declare namespace Proxmox {
2506
2506
  */
2507
2507
  "keep-last"?: number;
2508
2508
  /**
2509
- * Keep backups for the last <N> different months. If there is morethan one backup for a single month, only the latest one is kept.
2509
+ * Keep backups for the last <N> different months. If there is more than one backup for a single month, only the latest one is kept.
2510
2510
  * @minimum 0
2511
2511
  */
2512
2512
  "keep-monthly"?: number;
2513
2513
  /**
2514
- * Keep backups for the last <N> different weeks. If there is morethan one backup for a single week, only the latest one is kept.
2514
+ * Keep backups for the last <N> different weeks. If there is more than one backup for a single week, only the latest one is kept.
2515
2515
  * @minimum 0
2516
2516
  */
2517
2517
  "keep-weekly"?: number;
2518
2518
  /**
2519
- * Keep backups for the last <N> different years. If there is morethan one backup for a single year, only the latest one is kept.
2519
+ * Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept.
2520
2520
  * @minimum 0
2521
2521
  */
2522
2522
  "keep-yearly"?: number;
@@ -2683,7 +2683,7 @@ export declare namespace Proxmox {
2683
2683
  */
2684
2684
  "notes-template"?: string;
2685
2685
  /**
2686
- * Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not.
2686
+ * Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. If set to 'none', no notification will be sent.
2687
2687
  * @default auto
2688
2688
  */
2689
2689
  "notification-mode"?: NotificationMode;
@@ -5802,7 +5802,7 @@ export declare namespace Proxmox {
5802
5802
  /**
5803
5803
  * Show if this entry was created by a user or was built-in
5804
5804
  */
5805
- origin: Origin;
5805
+ origin: "user-created" | "builtin" | "modified-builtin";
5806
5806
  /**
5807
5807
  * Server URL
5808
5808
  */
@@ -5954,7 +5954,7 @@ export declare namespace Proxmox {
5954
5954
  /**
5955
5955
  * Show if this entry was created by a user or was built-in
5956
5956
  */
5957
- origin: Origin;
5957
+ origin: "user-created" | "builtin" | "modified-builtin";
5958
5958
  }
5959
5959
  /**
5960
5960
  * Parameters of `PUT /cluster/notifications/endpoints/sendmail/{name}`.
@@ -6155,7 +6155,7 @@ export declare namespace Proxmox {
6155
6155
  /**
6156
6156
  * Show if this entry was created by a user or was built-in
6157
6157
  */
6158
- origin: Origin;
6158
+ origin: "user-created" | "builtin" | "modified-builtin";
6159
6159
  /**
6160
6160
  * The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections.
6161
6161
  */
@@ -6350,7 +6350,7 @@ export declare namespace Proxmox {
6350
6350
  /**
6351
6351
  * Show if this entry was created by a user or was built-in
6352
6352
  */
6353
- origin: Origin;
6353
+ origin: "user-created" | "builtin" | "modified-builtin";
6354
6354
  /**
6355
6355
  * Secrets to set. These have to be formatted as a property string in the format name=<name>,value=<base64 of value>
6356
6356
  */
@@ -6593,7 +6593,7 @@ export declare namespace Proxmox {
6593
6593
  /**
6594
6594
  * Show if this entry was created by a user or was built-in
6595
6595
  */
6596
- origin: Origin;
6596
+ origin: "user-created" | "builtin" | "modified-builtin";
6597
6597
  /**
6598
6598
  * Targets to notify on match
6599
6599
  */
@@ -6677,7 +6677,7 @@ export declare namespace Proxmox {
6677
6677
  /**
6678
6678
  * Show if this entry was created by a user or was built-in
6679
6679
  */
6680
- origin: Origin;
6680
+ origin: "user-created" | "builtin" | "modified-builtin";
6681
6681
  /**
6682
6682
  * Type of the target.
6683
6683
  */
@@ -9652,7 +9652,7 @@ export declare namespace Proxmox {
9652
9652
  interface ClusterSdnVnetsCreateParams {
9653
9653
  /**
9654
9654
  * Alias name of the VNet.
9655
- * @pattern (?^i:[\(\)-_.\w\d\s]{0,256})
9655
+ * @pattern (?^i:[\w ()*+,\-./:;<=>?@\[\]^]{0,256})
9656
9656
  * @maxLength 256
9657
9657
  */
9658
9658
  alias?: string;
@@ -10064,7 +10064,7 @@ export declare namespace Proxmox {
10064
10064
  interface ClusterSdnVnetsIndex {
10065
10065
  /**
10066
10066
  * Alias name of the VNet.
10067
- * @pattern (?^i:[\(\)-_.\w\d\s]{0,256})
10067
+ * @pattern (?^i:[\w ()*+,\-./:;<=>?@\[\]^]{0,256})
10068
10068
  * @maxLength 256
10069
10069
  */
10070
10070
  alias?: string;
@@ -10082,7 +10082,7 @@ export declare namespace Proxmox {
10082
10082
  pending?: {
10083
10083
  /**
10084
10084
  * Alias name of the VNet.
10085
- * @pattern (?^i:[\(\)-_.\w\d\s]{0,256})
10085
+ * @pattern (?^i:[\w ()*+,\-./:;<=>?@\[\]^]{0,256})
10086
10086
  * @maxLength 256
10087
10087
  */
10088
10088
  alias?: string;
@@ -10227,7 +10227,7 @@ export declare namespace Proxmox {
10227
10227
  interface ClusterSdnVnetsRead {
10228
10228
  /**
10229
10229
  * Alias name of the VNet.
10230
- * @pattern (?^i:[\(\)-_.\w\d\s]{0,256})
10230
+ * @pattern (?^i:[\w ()*+,\-./:;<=>?@\[\]^]{0,256})
10231
10231
  * @maxLength 256
10232
10232
  */
10233
10233
  alias?: string;
@@ -10245,7 +10245,7 @@ export declare namespace Proxmox {
10245
10245
  pending?: {
10246
10246
  /**
10247
10247
  * Alias name of the VNet.
10248
- * @pattern (?^i:[\(\)-_.\w\d\s]{0,256})
10248
+ * @pattern (?^i:[\w ()*+,\-./:;<=>?@\[\]^]{0,256})
10249
10249
  * @maxLength 256
10250
10250
  */
10251
10251
  alias?: string;
@@ -10432,7 +10432,7 @@ export declare namespace Proxmox {
10432
10432
  interface ClusterSdnVnetsUpdateParams {
10433
10433
  /**
10434
10434
  * Alias name of the VNet.
10435
- * @pattern (?^i:[\(\)-_.\w\d\s]{0,256})
10435
+ * @pattern (?^i:[\w ()*+,\-./:;<=>?@\[\]^]{0,256})
10436
10436
  * @maxLength 256
10437
10437
  */
10438
10438
  alias?: string;
@@ -14551,7 +14551,7 @@ export declare namespace Proxmox {
14551
14551
  */
14552
14552
  memory?: number;
14553
14553
  /**
14554
- * Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
14554
+ * Comma-separated list of IP addresses. Sets the addresses of the DNS servers of the container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
14555
14555
  * @format lxc-ip-with-ll-iface-list
14556
14556
  */
14557
14557
  nameserver?: LxcIpWithLlIfaceList;
@@ -14721,7 +14721,7 @@ export declare namespace Proxmox {
14721
14721
  */
14722
14722
  memory?: number;
14723
14723
  /**
14724
- * Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
14724
+ * Comma-separated list of IP addresses. Sets the addresses of the DNS servers of the container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
14725
14725
  * @format lxc-ip-with-ll-iface-list
14726
14726
  */
14727
14727
  nameserver?: LxcIpWithLlIfaceList;
@@ -14913,7 +14913,7 @@ export declare namespace Proxmox {
14913
14913
  */
14914
14914
  memory?: number;
14915
14915
  /**
14916
- * Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
14916
+ * Comma-separated list of IP addresses. Sets the addresses of the DNS servers of the container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.
14917
14917
  * @format lxc-ip-with-ll-iface-list
14918
14918
  */
14919
14919
  nameserver?: LxcIpWithLlIfaceList;
@@ -16586,10 +16586,12 @@ export declare namespace Proxmox {
16586
16586
  cidr6?: CIDRv6;
16587
16587
  /**
16588
16588
  * Comments
16589
+ * @pattern (?s)(?!.*(?:<%|\$\{)).*
16589
16590
  */
16590
16591
  comments?: string;
16591
16592
  /**
16592
16593
  * Comments
16594
+ * @pattern (?s)(?!.*(?:<%|\$\{)).*
16593
16595
  */
16594
16596
  comments6?: string;
16595
16597
  /**
@@ -16759,10 +16761,12 @@ export declare namespace Proxmox {
16759
16761
  cidr6?: CIDRv6;
16760
16762
  /**
16761
16763
  * Comments
16764
+ * @pattern (?s)(?!.*(?:<%|\$\{)).*
16762
16765
  */
16763
16766
  comments?: string;
16764
16767
  /**
16765
16768
  * Comments
16769
+ * @pattern (?s)(?!.*(?:<%|\$\{)).*
16766
16770
  */
16767
16771
  comments6?: string;
16768
16772
  /**
@@ -16992,10 +16996,12 @@ export declare namespace Proxmox {
16992
16996
  cidr6?: CIDRv6;
16993
16997
  /**
16994
16998
  * Comments
16999
+ * @pattern (?s)(?!.*(?:<%|\$\{)).*
16995
17000
  */
16996
17001
  comments?: string;
16997
17002
  /**
16998
17003
  * Comments
17004
+ * @pattern (?s)(?!.*(?:<%|\$\{)).*
16999
17005
  */
17000
17006
  comments6?: string;
17001
17007
  /**
@@ -17515,7 +17521,7 @@ export declare namespace Proxmox {
17515
17521
  /**
17516
17522
  * Trusted Domain Extension (TDX) features by Intel CPUs
17517
17523
  * @format pve-qemu-tdx-fmt
17518
- * @typetext [type=]<tdx-type> ,attestation=<1|0> [,vsock-cid=<integer>] [,vsock-port=<integer>]
17524
+ * @typetext [type=]<tdx-type> [,attestation=<1|0>] [,vsock-cid=<integer>] [,vsock-port=<integer>]
17519
17525
  */
17520
17526
  "intel-tdx"?: PveQemuTdxFmt;
17521
17527
  /**
@@ -17750,7 +17756,7 @@ export declare namespace Proxmox {
17750
17756
  /**
17751
17757
  * Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)
17752
17758
  * @format pve-qm-watchdog
17753
- * @typetext [[model=]<i6300esb|ib700>] [,action=<enum>]
17759
+ * @typetext [[model=]<i6300esb>] [,action=<enum>]
17754
17760
  */
17755
17761
  watchdog?: PveQmWatchdog;
17756
17762
  }
@@ -17933,7 +17939,7 @@ export declare namespace Proxmox {
17933
17939
  /**
17934
17940
  * Trusted Domain Extension (TDX) features by Intel CPUs
17935
17941
  * @format pve-qemu-tdx-fmt
17936
- * @typetext [type=]<tdx-type> ,attestation=<1|0> [,vsock-cid=<integer>] [,vsock-port=<integer>]
17942
+ * @typetext [type=]<tdx-type> [,attestation=<1|0>] [,vsock-cid=<integer>] [,vsock-port=<integer>]
17937
17943
  */
17938
17944
  "intel-tdx"?: PveQemuTdxFmt;
17939
17945
  /**
@@ -18168,7 +18174,7 @@ export declare namespace Proxmox {
18168
18174
  /**
18169
18175
  * Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)
18170
18176
  * @format pve-qm-watchdog
18171
- * @typetext [[model=]<i6300esb|ib700>] [,action=<enum>]
18177
+ * @typetext [[model=]<i6300esb>] [,action=<enum>]
18172
18178
  */
18173
18179
  watchdog?: PveQmWatchdog;
18174
18180
  }
@@ -18795,7 +18801,7 @@ export declare namespace Proxmox {
18795
18801
  /**
18796
18802
  * Trusted Domain Extension (TDX) features by Intel CPUs
18797
18803
  * @format pve-qemu-tdx-fmt
18798
- * @typetext [type=]<tdx-type> ,attestation=<1|0> [,vsock-cid=<integer>] [,vsock-port=<integer>]
18804
+ * @typetext [type=]<tdx-type> [,attestation=<1|0>] [,vsock-cid=<integer>] [,vsock-port=<integer>]
18799
18805
  */
18800
18806
  "intel-tdx"?: PveQemuTdxFmt;
18801
18807
  /**
@@ -19053,7 +19059,7 @@ export declare namespace Proxmox {
19053
19059
  /**
19054
19060
  * Create a virtual hardware watchdog device. Once enabled (by a guest action), the watchdog must be periodically polled by an agent inside the guest or else the watchdog will reset the guest (or execute the respective action specified)
19055
19061
  * @format pve-qm-watchdog
19056
- * @typetext [[model=]<i6300esb|ib700>] [,action=<enum>]
19062
+ * @typetext [[model=]<i6300esb>] [,action=<enum>]
19057
19063
  */
19058
19064
  watchdog?: PveQmWatchdog;
19059
19065
  }
@@ -19761,7 +19767,7 @@ export declare namespace Proxmox {
19761
19767
  */
19762
19768
  type?: "in" | "out" | "forward" | "group";
19763
19769
  }
19764
- type NodesQemuLock = "backup" | "clone" | "create" | "migrate" | "rollback" | "snapshot" | "snapshot-delete" | "suspending" | "suspended";
19770
+ type NodesQemuLock = "backup" | "clone" | "create" | "import" | "migrate" | "rollback" | "snapshot" | "snapshot-delete" | "suspending" | "suspended";
19765
19771
  /**
19766
19772
  * Parameters of `POST /nodes/{node}/qemu/{vmid}/migrate`.
19767
19773
  */
@@ -21782,6 +21788,10 @@ export declare namespace Proxmox {
21782
21788
  * Volume identifier.
21783
21789
  */
21784
21790
  volid: string;
21791
+ /**
21792
+ * Volume type, for volumes of VMs and containers.
21793
+ */
21794
+ vtype?: Vtype;
21785
21795
  }
21786
21796
  /**
21787
21797
  * Parameters of `GET /nodes/{node}/storage/{storage}/content`.
@@ -22783,7 +22793,7 @@ export declare namespace Proxmox {
22783
22793
  */
22784
22794
  "notes-template"?: string;
22785
22795
  /**
22786
- * Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not.
22796
+ * Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. If set to 'none', no notification will be sent.
22787
22797
  * @default auto
22788
22798
  */
22789
22799
  "notification-mode"?: NotificationMode;
@@ -22967,7 +22977,7 @@ export declare namespace Proxmox {
22967
22977
  */
22968
22978
  "notes-template"?: string;
22969
22979
  /**
22970
- * Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not.
22980
+ * Determine which notification system to use. If set to 'legacy-sendmail', vzdump will consider the mailto/mailnotification parameters and send emails to the specified address(es) via the 'sendmail' command. If set to 'notification-system', a notification will be sent via PVE's notification system, and the mailto and mailnotification will be ignored. If set to 'auto' (default setting), an email will be sent if mailto is set, and the notification system will be used if not. If set to 'none', no notification will be sent.
22971
22981
  * @default auto
22972
22982
  */
22973
22983
  "notification-mode"?: NotificationMode;
@@ -23057,7 +23067,7 @@ export declare namespace Proxmox {
23057
23067
  */
23058
23068
  zstd?: number;
23059
23069
  }
23060
- type NotificationMode = "auto" | "legacy-sendmail" | "notification-system";
23070
+ type NotificationMode = "auto" | "legacy-sendmail" | "notification-system" | "none";
23061
23071
  /**
23062
23072
  * NUMA topology.
23063
23073
  * Indexed property: `numa0`, `numa1`, ...
@@ -23069,7 +23079,6 @@ export declare namespace Proxmox {
23069
23079
  * PVE format `on-volume-remove`.
23070
23080
  */
23071
23081
  type OnVolumeRemove = string;
23072
- type Origin = "user-created" | "builtin" | "modified-builtin";
23073
23082
  type OtelCompression = "none" | "gzip";
23074
23083
  type OtelProtocol = "http" | "https";
23075
23084
  /**
@@ -23095,6 +23104,89 @@ export declare namespace Proxmox {
23095
23104
  */
23096
23105
  type PemString = string;
23097
23106
  type PgAutoscaleMode = "on" | "off" | "warn";
23107
+ /**
23108
+ * One item returned by `GET /plugins`.
23109
+ */
23110
+ interface PluginsIndex {
23111
+ subdir: string;
23112
+ }
23113
+ /**
23114
+ * One item returned by `GET /plugins/storage`.
23115
+ */
23116
+ interface PluginsStorageIndex {
23117
+ subdir: string;
23118
+ }
23119
+ /**
23120
+ * One item returned by `GET /plugins/storage/plugin`.
23121
+ */
23122
+ interface PluginsStoragePluginIndex {
23123
+ /**
23124
+ * The content types of the plugin.
23125
+ */
23126
+ content: {
23127
+ /**
23128
+ * The content types enabled by default.
23129
+ */
23130
+ default: string[];
23131
+ /**
23132
+ * The content types the plugin supports.
23133
+ */
23134
+ supported: string[];
23135
+ };
23136
+ /**
23137
+ * The name of the storage type, if the plugin provides one.
23138
+ */
23139
+ "display-name"?: string;
23140
+ /**
23141
+ * Whether the plugin is shipped with Proxmox VE ('builtin') or installed separately ('custom').
23142
+ */
23143
+ origin: "builtin" | "custom";
23144
+ schema: Record<string, any>;
23145
+ /**
23146
+ * The storage type of the plugin.
23147
+ */
23148
+ type: NodesStorageIdentityType;
23149
+ }
23150
+ /**
23151
+ * Parameters of `GET /plugins/storage/plugin`.
23152
+ */
23153
+ interface PluginsStoragePluginIndexParams {
23154
+ /**
23155
+ * Only list plugins of this origin.
23156
+ */
23157
+ origin?: "builtin" | "custom";
23158
+ }
23159
+ /**
23160
+ * Returned by `GET /plugins/storage/plugin/{type}`.
23161
+ */
23162
+ interface PluginsStoragePluginInfo {
23163
+ /**
23164
+ * The content types of the plugin.
23165
+ */
23166
+ content: {
23167
+ /**
23168
+ * The content types enabled by default.
23169
+ */
23170
+ default: string[];
23171
+ /**
23172
+ * The content types the plugin supports.
23173
+ */
23174
+ supported: string[];
23175
+ };
23176
+ /**
23177
+ * The name of the storage type, if the plugin provides one.
23178
+ */
23179
+ "display-name"?: string;
23180
+ /**
23181
+ * Whether the plugin is shipped with Proxmox VE ('builtin') or installed separately ('custom').
23182
+ */
23183
+ origin: "builtin" | "custom";
23184
+ schema: Record<string, any>;
23185
+ /**
23186
+ * The storage type of the plugin.
23187
+ */
23188
+ type: NodesStorageIdentityType;
23189
+ }
23098
23190
  type PolicyForward = "ACCEPT" | "DROP";
23099
23191
  type PolicyIn = "ACCEPT" | "REJECT" | "DROP";
23100
23192
  type PolicyOut = "ACCEPT" | "REJECT" | "DROP";
@@ -23610,12 +23702,12 @@ export declare namespace Proxmox {
23610
23702
  */
23611
23703
  authsupported?: string;
23612
23704
  /**
23613
- * Base volume. This volume is automatically activated.
23705
+ * Volume ID of the base volume (automatically activated).
23614
23706
  * @format pve-volume-id
23615
23707
  */
23616
23708
  base?: PveVolumeId;
23617
23709
  /**
23618
- * ZFS block size
23710
+ * ZFS block size.
23619
23711
  * @format pve-storage-zfs-blocksize
23620
23712
  * @typetext <a power of 2 with optional k or m suffix>
23621
23713
  */
@@ -23627,16 +23719,16 @@ export declare namespace Proxmox {
23627
23719
  */
23628
23720
  bwlimit?: string;
23629
23721
  /**
23630
- * host group for comstar views
23722
+ * Host group for COMSTAR views.
23631
23723
  */
23632
23724
  comstar_hg?: string;
23633
23725
  /**
23634
- * target group for comstar views
23726
+ * Target group for COMSTAR views.
23635
23727
  */
23636
23728
  comstar_tg?: string;
23637
23729
  /**
23638
23730
  * Allowed content types.
23639
- * NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
23731
+ * NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. A storage can instead be restricted to some of their volume types: 'vm-vol' for the disks of VMs, 'vm-state' for the saved states of VMs, and 'ct-vol' for the volumes of Containers.
23640
23732
  * @format pve-storage-content-list
23641
23733
  */
23642
23734
  content?: PveStorageContentList;
@@ -23651,12 +23743,12 @@ export declare namespace Proxmox {
23651
23743
  */
23652
23744
  "create-base-path"?: boolean;
23653
23745
  /**
23654
- * Populate the directory with the default structure.
23746
+ * Populate the base directory with the default structure.
23655
23747
  * @default yes
23656
23748
  */
23657
23749
  "create-subdirs"?: boolean;
23658
23750
  /**
23659
- * Data Pool (for erasure coding only)
23751
+ * Data pool name for erasure-coded images.
23660
23752
  */
23661
23753
  "data-pool"?: string;
23662
23754
  /**
@@ -23668,7 +23760,7 @@ export declare namespace Proxmox {
23668
23760
  */
23669
23761
  disable?: boolean;
23670
23762
  /**
23671
- * CIFS domain.
23763
+ * The name of the user domain (workgroup) to use.
23672
23764
  * @maxLength 256
23673
23765
  */
23674
23766
  domain?: string;
@@ -23677,7 +23769,7 @@ export declare namespace Proxmox {
23677
23769
  */
23678
23770
  "encryption-key"?: string;
23679
23771
  /**
23680
- * NFS export path.
23772
+ * Path exported by the NFS server (e.g., /srv/nfs).
23681
23773
  * @format pve-storage-path
23682
23774
  */
23683
23775
  export?: PveStoragePath;
@@ -23691,12 +23783,12 @@ export declare namespace Proxmox {
23691
23783
  */
23692
23784
  format?: "raw" | "qcow2" | "subvol" | "vmdk";
23693
23785
  /**
23694
- * The Ceph filesystem name.
23786
+ * The name or identifier of the filesystem.
23695
23787
  * @format pve-configid
23696
23788
  */
23697
23789
  "fs-name"?: PveConfigid;
23698
23790
  /**
23699
- * Mount CephFS through FUSE.
23791
+ * Mount the filesystem through FUSE.
23700
23792
  */
23701
23793
  fuse?: boolean;
23702
23794
  /**
@@ -23705,7 +23797,7 @@ export declare namespace Proxmox {
23705
23797
  */
23706
23798
  is_mountpoint?: string;
23707
23799
  /**
23708
- * iscsi provider
23800
+ * The iSCSI target implementation used on the remote machine.
23709
23801
  */
23710
23802
  iscsiprovider?: string;
23711
23803
  /**
@@ -23718,7 +23810,7 @@ export declare namespace Proxmox {
23718
23810
  */
23719
23811
  krbd?: boolean;
23720
23812
  /**
23721
- * target portal group for Linux LIO targets
23813
+ * Target portal group for Linux LIO targets.
23722
23814
  */
23723
23815
  lio_tpg?: string;
23724
23816
  /**
@@ -23742,12 +23834,12 @@ export declare namespace Proxmox {
23742
23834
  */
23743
23835
  monhost?: PveStoragePortalDnsList;
23744
23836
  /**
23745
- * mount point
23837
+ * Path to the directory where the storage is mounted.
23746
23838
  * @format pve-storage-path
23747
23839
  */
23748
23840
  mountpoint?: PveStoragePath;
23749
23841
  /**
23750
- * Namespace.
23842
+ * The namespace used for grouping, isolation, or partitioning purposes.
23751
23843
  */
23752
23844
  namespace?: string;
23753
23845
  /**
@@ -23761,7 +23853,7 @@ export declare namespace Proxmox {
23761
23853
  */
23762
23854
  nodes?: PveNodeList;
23763
23855
  /**
23764
- * disable write caching on the target
23856
+ * Disable write caching on the iSCSI target.
23765
23857
  */
23766
23858
  nowritecache?: boolean;
23767
23859
  /**
@@ -23771,22 +23863,22 @@ export declare namespace Proxmox {
23771
23863
  */
23772
23864
  "on-volume-remove"?: OnVolumeRemove;
23773
23865
  /**
23774
- * NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs')
23866
+ * Comma-separated list of mount options. See 'man nfs', 'man mount.cifs', or 'man mount.ceph' for more information.
23775
23867
  * @format pve-storage-options
23776
23868
  */
23777
23869
  options?: PveStorageOptions;
23778
23870
  /**
23779
- * Password for accessing the share/datastore.
23871
+ * The password used for authentication.
23780
23872
  * @maxLength 256
23781
23873
  */
23782
23874
  password?: string;
23783
23875
  /**
23784
- * File system path.
23876
+ * Path of the storage in the local file system, for example its base directory or mount point.
23785
23877
  * @format pve-storage-path
23786
23878
  */
23787
23879
  path?: PveStoragePath;
23788
23880
  /**
23789
- * Pool.
23881
+ * Name of the pool that stores images.
23790
23882
  */
23791
23883
  pool?: string;
23792
23884
  /**
@@ -23796,7 +23888,7 @@ export declare namespace Proxmox {
23796
23888
  */
23797
23889
  port?: number;
23798
23890
  /**
23799
- * iSCSI portal (IP or DNS name with optional port).
23891
+ * iSCSI portal (IP or hostname, optionally with port).
23800
23892
  * @format pve-storage-portal-dns
23801
23893
  */
23802
23894
  portal?: PveStoragePortalDns;
@@ -23826,12 +23918,12 @@ export declare namespace Proxmox {
23826
23918
  */
23827
23919
  saferemove_throughput?: string;
23828
23920
  /**
23829
- * Server IP or DNS name.
23921
+ * IP address or hostname of the server.
23830
23922
  * @format pve-storage-server
23831
23923
  */
23832
23924
  server?: PveStorageServer;
23833
23925
  /**
23834
- * CIFS share.
23926
+ * The name of the share to use.
23835
23927
  */
23836
23928
  share?: string;
23837
23929
  /**
@@ -23854,7 +23946,7 @@ export declare namespace Proxmox {
23854
23946
  */
23855
23947
  "snapshot-as-volume-chain"?: boolean;
23856
23948
  /**
23857
- * use sparse volumes
23949
+ * Use sparse (thin-provisioned) volumes.
23858
23950
  */
23859
23951
  sparse?: boolean;
23860
23952
  /**
@@ -23873,11 +23965,11 @@ export declare namespace Proxmox {
23873
23965
  */
23874
23966
  tagged_only?: boolean;
23875
23967
  /**
23876
- * iSCSI target.
23968
+ * iSCSI target name (an iSCSI Qualified Name - IQN).
23877
23969
  */
23878
23970
  target?: string;
23879
23971
  /**
23880
- * LVM thin pool LV name.
23972
+ * Name of the LVM thin pool logical volume.
23881
23973
  * @format pve-storage-vgname
23882
23974
  */
23883
23975
  thinpool?: PveStorageVgname;
@@ -23886,11 +23978,11 @@ export declare namespace Proxmox {
23886
23978
  */
23887
23979
  type: NodesStorageIdentityType;
23888
23980
  /**
23889
- * RBD Id.
23981
+ * The username for authentication. For RBD and CephFS, the Ceph client ID without the 'client.' prefix.
23890
23982
  */
23891
23983
  username?: string;
23892
23984
  /**
23893
- * Volume group name.
23985
+ * LVM volume group name.
23894
23986
  * @format pve-storage-vgname
23895
23987
  */
23896
23988
  vgname?: PveStorageVgname;
@@ -23947,7 +24039,7 @@ export declare namespace Proxmox {
23947
24039
  */
23948
24040
  interface StorageUpdateParams {
23949
24041
  /**
23950
- * ZFS block size
24042
+ * ZFS block size.
23951
24043
  * @format pve-storage-zfs-blocksize
23952
24044
  * @typetext <a power of 2 with optional k or m suffix>
23953
24045
  */
@@ -23959,16 +24051,16 @@ export declare namespace Proxmox {
23959
24051
  */
23960
24052
  bwlimit?: string;
23961
24053
  /**
23962
- * host group for comstar views
24054
+ * Host group for COMSTAR views.
23963
24055
  */
23964
24056
  comstar_hg?: string;
23965
24057
  /**
23966
- * target group for comstar views
24058
+ * Target group for COMSTAR views.
23967
24059
  */
23968
24060
  comstar_tg?: string;
23969
24061
  /**
23970
24062
  * Allowed content types.
23971
- * NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
24063
+ * NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. A storage can instead be restricted to some of their volume types: 'vm-vol' for the disks of VMs, 'vm-state' for the saved states of VMs, and 'ct-vol' for the volumes of Containers.
23972
24064
  * @format pve-storage-content-list
23973
24065
  */
23974
24066
  content?: PveStorageContentList;
@@ -23983,12 +24075,12 @@ export declare namespace Proxmox {
23983
24075
  */
23984
24076
  "create-base-path"?: boolean;
23985
24077
  /**
23986
- * Populate the directory with the default structure.
24078
+ * Populate the base directory with the default structure.
23987
24079
  * @default yes
23988
24080
  */
23989
24081
  "create-subdirs"?: boolean;
23990
24082
  /**
23991
- * Data Pool (for erasure coding only)
24083
+ * Data pool name for erasure-coded images.
23992
24084
  */
23993
24085
  "data-pool"?: string;
23994
24086
  /**
@@ -24007,7 +24099,7 @@ export declare namespace Proxmox {
24007
24099
  */
24008
24100
  disable?: boolean;
24009
24101
  /**
24010
- * CIFS domain.
24102
+ * The name of the user domain (workgroup) to use.
24011
24103
  * @maxLength 256
24012
24104
  */
24013
24105
  domain?: string;
@@ -24025,12 +24117,12 @@ export declare namespace Proxmox {
24025
24117
  */
24026
24118
  format?: "raw" | "qcow2" | "subvol" | "vmdk";
24027
24119
  /**
24028
- * The Ceph filesystem name.
24120
+ * The name or identifier of the filesystem.
24029
24121
  * @format pve-configid
24030
24122
  */
24031
24123
  "fs-name"?: PveConfigid;
24032
24124
  /**
24033
- * Mount CephFS through FUSE.
24125
+ * Mount the filesystem through FUSE.
24034
24126
  */
24035
24127
  fuse?: boolean;
24036
24128
  /**
@@ -24048,7 +24140,7 @@ export declare namespace Proxmox {
24048
24140
  */
24049
24141
  krbd?: boolean;
24050
24142
  /**
24051
- * target portal group for Linux LIO targets
24143
+ * Target portal group for Linux LIO targets.
24052
24144
  */
24053
24145
  lio_tpg?: string;
24054
24146
  /**
@@ -24072,12 +24164,12 @@ export declare namespace Proxmox {
24072
24164
  */
24073
24165
  monhost?: PveStoragePortalDnsList;
24074
24166
  /**
24075
- * mount point
24167
+ * Path to the directory where the storage is mounted.
24076
24168
  * @format pve-storage-path
24077
24169
  */
24078
24170
  mountpoint?: PveStoragePath;
24079
24171
  /**
24080
- * Namespace.
24172
+ * The namespace used for grouping, isolation, or partitioning purposes.
24081
24173
  */
24082
24174
  namespace?: string;
24083
24175
  /**
@@ -24091,7 +24183,7 @@ export declare namespace Proxmox {
24091
24183
  */
24092
24184
  nodes?: PveNodeList;
24093
24185
  /**
24094
- * disable write caching on the target
24186
+ * Disable write caching on the iSCSI target.
24095
24187
  */
24096
24188
  nowritecache?: boolean;
24097
24189
  /**
@@ -24101,17 +24193,17 @@ export declare namespace Proxmox {
24101
24193
  */
24102
24194
  "on-volume-remove"?: OnVolumeRemove;
24103
24195
  /**
24104
- * NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs')
24196
+ * Comma-separated list of mount options. See 'man nfs', 'man mount.cifs', or 'man mount.ceph' for more information.
24105
24197
  * @format pve-storage-options
24106
24198
  */
24107
24199
  options?: PveStorageOptions;
24108
24200
  /**
24109
- * Password for accessing the share/datastore.
24201
+ * The password used for authentication.
24110
24202
  * @maxLength 256
24111
24203
  */
24112
24204
  password?: string;
24113
24205
  /**
24114
- * Pool.
24206
+ * Name of the pool that stores images.
24115
24207
  */
24116
24208
  pool?: string;
24117
24209
  /**
@@ -24146,7 +24238,7 @@ export declare namespace Proxmox {
24146
24238
  */
24147
24239
  saferemove_throughput?: string;
24148
24240
  /**
24149
- * Server IP or DNS name.
24241
+ * IP address or hostname of the server.
24150
24242
  * @format pve-storage-server
24151
24243
  */
24152
24244
  server?: PveStorageServer;
@@ -24170,7 +24262,7 @@ export declare namespace Proxmox {
24170
24262
  */
24171
24263
  "snapshot-as-volume-chain"?: boolean;
24172
24264
  /**
24173
- * use sparse volumes
24265
+ * Use sparse (thin-provisioned) volumes.
24174
24266
  */
24175
24267
  sparse?: boolean;
24176
24268
  /**
@@ -24183,7 +24275,7 @@ export declare namespace Proxmox {
24183
24275
  */
24184
24276
  tagged_only?: boolean;
24185
24277
  /**
24186
- * RBD Id.
24278
+ * The username for authentication. For RBD and CephFS, the Ceph client ID without the 'client.' prefix.
24187
24279
  */
24188
24280
  username?: string;
24189
24281
  /**
@@ -24260,168 +24352,589 @@ export declare namespace Proxmox {
24260
24352
  type VlanProtocol = "802.1q" | "802.1ad";
24261
24353
  type Vmtype = "qemu" | "lxc";
24262
24354
  type Volume = "rootfs" | "mp0" | "mp1" | "mp2" | "mp3" | "mp4" | "mp5" | "mp6" | "mp7" | "mp8" | "mp9" | "mp10" | "mp11" | "mp12" | "mp13" | "mp14" | "mp15" | "mp16" | "mp17" | "mp18" | "mp19" | "mp20" | "mp21" | "mp22" | "mp23" | "mp24" | "mp25" | "mp26" | "mp27" | "mp28" | "mp29" | "mp30" | "mp31" | "mp32" | "mp33" | "mp34" | "mp35" | "mp36" | "mp37" | "mp38" | "mp39" | "mp40" | "mp41" | "mp42" | "mp43" | "mp44" | "mp45" | "mp46" | "mp47" | "mp48" | "mp49" | "mp50" | "mp51" | "mp52" | "mp53" | "mp54" | "mp55" | "mp56" | "mp57" | "mp58" | "mp59" | "mp60" | "mp61" | "mp62" | "mp63" | "mp64" | "mp65" | "mp66" | "mp67" | "mp68" | "mp69" | "mp70" | "mp71" | "mp72" | "mp73" | "mp74" | "mp75" | "mp76" | "mp77" | "mp78" | "mp79" | "mp80" | "mp81" | "mp82" | "mp83" | "mp84" | "mp85" | "mp86" | "mp87" | "mp88" | "mp89" | "mp90" | "mp91" | "mp92" | "mp93" | "mp94" | "mp95" | "mp96" | "mp97" | "mp98" | "mp99" | "mp100" | "mp101" | "mp102" | "mp103" | "mp104" | "mp105" | "mp106" | "mp107" | "mp108" | "mp109" | "mp110" | "mp111" | "mp112" | "mp113" | "mp114" | "mp115" | "mp116" | "mp117" | "mp118" | "mp119" | "mp120" | "mp121" | "mp122" | "mp123" | "mp124" | "mp125" | "mp126" | "mp127" | "mp128" | "mp129" | "mp130" | "mp131" | "mp132" | "mp133" | "mp134" | "mp135" | "mp136" | "mp137" | "mp138" | "mp139" | "mp140" | "mp141" | "mp142" | "mp143" | "mp144" | "mp145" | "mp146" | "mp147" | "mp148" | "mp149" | "mp150" | "mp151" | "mp152" | "mp153" | "mp154" | "mp155" | "mp156" | "mp157" | "mp158" | "mp159" | "mp160" | "mp161" | "mp162" | "mp163" | "mp164" | "mp165" | "mp166" | "mp167" | "mp168" | "mp169" | "mp170" | "mp171" | "mp172" | "mp173" | "mp174" | "mp175" | "mp176" | "mp177" | "mp178" | "mp179" | "mp180" | "mp181" | "mp182" | "mp183" | "mp184" | "mp185" | "mp186" | "mp187" | "mp188" | "mp189" | "mp190" | "mp191" | "mp192" | "mp193" | "mp194" | "mp195" | "mp196" | "mp197" | "mp198" | "mp199" | "mp200" | "mp201" | "mp202" | "mp203" | "mp204" | "mp205" | "mp206" | "mp207" | "mp208" | "mp209" | "mp210" | "mp211" | "mp212" | "mp213" | "mp214" | "mp215" | "mp216" | "mp217" | "mp218" | "mp219" | "mp220" | "mp221" | "mp222" | "mp223" | "mp224" | "mp225" | "mp226" | "mp227" | "mp228" | "mp229" | "mp230" | "mp231" | "mp232" | "mp233" | "mp234" | "mp235" | "mp236" | "mp237" | "mp238" | "mp239" | "mp240" | "mp241" | "mp242" | "mp243" | "mp244" | "mp245" | "mp246" | "mp247" | "mp248" | "mp249" | "mp250" | "mp251" | "mp252" | "mp253" | "mp254" | "mp255" | "unused0" | "unused1" | "unused2" | "unused3" | "unused4" | "unused5" | "unused6" | "unused7" | "unused8" | "unused9" | "unused10" | "unused11" | "unused12" | "unused13" | "unused14" | "unused15" | "unused16" | "unused17" | "unused18" | "unused19" | "unused20" | "unused21" | "unused22" | "unused23" | "unused24" | "unused25" | "unused26" | "unused27" | "unused28" | "unused29" | "unused30" | "unused31" | "unused32" | "unused33" | "unused34" | "unused35" | "unused36" | "unused37" | "unused38" | "unused39" | "unused40" | "unused41" | "unused42" | "unused43" | "unused44" | "unused45" | "unused46" | "unused47" | "unused48" | "unused49" | "unused50" | "unused51" | "unused52" | "unused53" | "unused54" | "unused55" | "unused56" | "unused57" | "unused58" | "unused59" | "unused60" | "unused61" | "unused62" | "unused63" | "unused64" | "unused65" | "unused66" | "unused67" | "unused68" | "unused69" | "unused70" | "unused71" | "unused72" | "unused73" | "unused74" | "unused75" | "unused76" | "unused77" | "unused78" | "unused79" | "unused80" | "unused81" | "unused82" | "unused83" | "unused84" | "unused85" | "unused86" | "unused87" | "unused88" | "unused89" | "unused90" | "unused91" | "unused92" | "unused93" | "unused94" | "unused95" | "unused96" | "unused97" | "unused98" | "unused99" | "unused100" | "unused101" | "unused102" | "unused103" | "unused104" | "unused105" | "unused106" | "unused107" | "unused108" | "unused109" | "unused110" | "unused111" | "unused112" | "unused113" | "unused114" | "unused115" | "unused116" | "unused117" | "unused118" | "unused119" | "unused120" | "unused121" | "unused122" | "unused123" | "unused124" | "unused125" | "unused126" | "unused127" | "unused128" | "unused129" | "unused130" | "unused131" | "unused132" | "unused133" | "unused134" | "unused135" | "unused136" | "unused137" | "unused138" | "unused139" | "unused140" | "unused141" | "unused142" | "unused143" | "unused144" | "unused145" | "unused146" | "unused147" | "unused148" | "unused149" | "unused150" | "unused151" | "unused152" | "unused153" | "unused154" | "unused155" | "unused156" | "unused157" | "unused158" | "unused159" | "unused160" | "unused161" | "unused162" | "unused163" | "unused164" | "unused165" | "unused166" | "unused167" | "unused168" | "unused169" | "unused170" | "unused171" | "unused172" | "unused173" | "unused174" | "unused175" | "unused176" | "unused177" | "unused178" | "unused179" | "unused180" | "unused181" | "unused182" | "unused183" | "unused184" | "unused185" | "unused186" | "unused187" | "unused188" | "unused189" | "unused190" | "unused191" | "unused192" | "unused193" | "unused194" | "unused195" | "unused196" | "unused197" | "unused198" | "unused199" | "unused200" | "unused201" | "unused202" | "unused203" | "unused204" | "unused205" | "unused206" | "unused207" | "unused208" | "unused209" | "unused210" | "unused211" | "unused212" | "unused213" | "unused214" | "unused215" | "unused216" | "unused217" | "unused218" | "unused219" | "unused220" | "unused221" | "unused222" | "unused223" | "unused224" | "unused225" | "unused226" | "unused227" | "unused228" | "unused229" | "unused230" | "unused231" | "unused232" | "unused233" | "unused234" | "unused235" | "unused236" | "unused237" | "unused238" | "unused239" | "unused240" | "unused241" | "unused242" | "unused243" | "unused244" | "unused245" | "unused246" | "unused247" | "unused248" | "unused249" | "unused250" | "unused251" | "unused252" | "unused253" | "unused254" | "unused255";
24355
+ type Vtype = "vm-vol" | "vm-state" | "ct-vol";
24263
24356
  interface Api {
24264
- cluster: {
24357
+ access: {
24265
24358
  /**
24266
- * Cluster index.
24359
+ * Directory index.
24267
24360
  *
24268
- * `GET /cluster`
24361
+ * `GET /access`
24269
24362
  *
24270
24363
  * Permissions: any authenticated user
24271
24364
  */
24272
- $get(param?: NoParams, options?: RequestOptions): Promise<Record<string, any>[]>;
24273
- replication: {
24365
+ $get(param?: NoParams, options?: RequestOptions): Promise<AccessIndex[]>;
24366
+ users: {
24274
24367
  /**
24275
- * List replication jobs.
24368
+ * User index.
24276
24369
  *
24277
- * `GET /cluster/replication`
24370
+ * `GET /access/users`
24278
24371
  *
24279
- * Permissions: Will only return replication jobs for which the calling user has VM.Audit permission on /vms/<vmid>.
24372
+ * Permissions: The returned list is restricted to users where you have 'User.Modify' or 'Sys.Audit' permissions on '/access/groups' or on a group the user belongs too. But it always includes the current (authenticated) user.
24280
24373
  */
24281
- $get(param?: NoParams, options?: RequestOptions): Promise<ClusterReplicationIndex[]>;
24374
+ $get(param?: AccessUsersIndexParams, options?: RequestOptions): Promise<AccessUsersIndex[]>;
24282
24375
  /**
24283
- * Create a new replication job
24376
+ * Create new user.
24284
24377
  *
24285
- * `POST /cluster/replication`
24378
+ * `POST /access/users`
24286
24379
  *
24287
- * Permissions: Requires the VM.Replicate permission on /vms/<vmid>.
24380
+ * Permissions: You need 'Realm.AllocateUser' on '/access/realm/<realm>' on the realm of user <userid>, and 'User.Modify' permissions to '/access/groups/<group>' for any group specified (or 'User.Modify' on '/access/groups' if you pass no groups.
24288
24381
  */
24289
- $post(param: ClusterReplicationCreateParams, options?: RequestOptions): Promise<null>;
24290
- $(id: string): {
24291
- /**
24292
- * Read replication job configuration.
24293
- *
24294
- * `GET /cluster/replication/{id}`
24295
- *
24296
- * Permissions: Requires the VM.Audit permission on /vms/<vmid>.
24297
- */
24298
- $get(param?: NoParams, options?: RequestOptions): Promise<ClusterReplicationRead>;
24382
+ $post(param: AccessUsersCreateUserParams, options?: RequestOptions): Promise<null>;
24383
+ $(userid: string): {
24299
24384
  /**
24300
- * Update replication job configuration.
24385
+ * Get user configuration.
24301
24386
  *
24302
- * `PUT /cluster/replication/{id}`
24387
+ * `GET /access/users/{userid}`
24303
24388
  *
24304
- * Permissions: Requires the VM.Replicate permission on /vms/<vmid>.
24389
+ * Permissions: ["userid-group",["User.Modify","Sys.Audit"]]
24305
24390
  */
24306
- $put(param?: ClusterReplicationUpdateParams, options?: RequestOptions): Promise<null>;
24391
+ $get(param?: NoParams, options?: RequestOptions): Promise<AccessUsersReadUser>;
24307
24392
  /**
24308
- * Mark replication job for removal.
24393
+ * Update user configuration.
24309
24394
  *
24310
- * `DELETE /cluster/replication/{id}`
24395
+ * `PUT /access/users/{userid}`
24311
24396
  *
24312
- * Permissions: Requires the VM.Replicate permission on /vms/<vmid>.
24397
+ * Permissions: ["userid-group",["User.Modify"],"groups_param","update"]
24313
24398
  */
24314
- $delete(param?: ClusterReplicationDeleteParams, options?: RequestOptions): Promise<null>;
24315
- };
24316
- };
24317
- metrics: {
24318
- /**
24319
- * Metrics index.
24320
- *
24321
- * `GET /cluster/metrics`
24322
- *
24323
- * Permissions: any authenticated user
24324
- */
24325
- $get(param?: NoParams, options?: RequestOptions): Promise<Record<string, any>[]>;
24326
- server: {
24399
+ $put(param?: AccessUsersUpdateUserParams, options?: RequestOptions): Promise<null>;
24327
24400
  /**
24328
- * List configured metric servers.
24401
+ * Delete user.
24329
24402
  *
24330
- * `GET /cluster/metrics/server`
24403
+ * `DELETE /access/users/{userid}`
24331
24404
  *
24332
- * Permissions: Sys.Audit on /
24405
+ * Permissions: ["userid-param","Realm.AllocateUser"] and ["userid-group",["User.Modify"]]
24333
24406
  */
24334
- $get(param?: NoParams, options?: RequestOptions): Promise<ClusterMetricsServerServerIndex[]>;
24335
- $(id: string): {
24336
- /**
24337
- * Read metric server configuration.
24338
- *
24339
- * `GET /cluster/metrics/server/{id}`
24340
- *
24341
- * Permissions: Sys.Audit on /
24342
- */
24343
- $get(param?: NoParams, options?: RequestOptions): Promise<Record<string, any>>;
24407
+ $delete(param?: NoParams, options?: RequestOptions): Promise<null>;
24408
+ tfa: {
24344
24409
  /**
24345
- * Create a new external metric server config
24410
+ * Get user TFA types (Personal and Realm).
24346
24411
  *
24347
- * `POST /cluster/metrics/server/{id}`
24412
+ * `GET /access/users/{userid}/tfa`
24348
24413
  *
24349
- * Permissions: Sys.Modify on /
24414
+ * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify","Sys.Audit"]]
24350
24415
  */
24351
- $post(param: ClusterMetricsServerCreateParams, options?: RequestOptions): Promise<null>;
24416
+ $get(param?: AccessUsersTfaReadUserTfaTypeParams, options?: RequestOptions): Promise<AccessUsersTfaReadUserTfaType>;
24417
+ };
24418
+ "unlock-tfa": {
24352
24419
  /**
24353
- * Update metric server configuration.
24420
+ * Unlock a user's TFA authentication.
24354
24421
  *
24355
- * `PUT /cluster/metrics/server/{id}`
24422
+ * `PUT /access/users/{userid}/unlock-tfa`
24356
24423
  *
24357
- * Permissions: Sys.Modify on /
24424
+ * Permissions: ["userid-group",["User.Modify"]]
24358
24425
  */
24359
- $put(param: ClusterMetricsServerUpdateParams, options?: RequestOptions): Promise<null>;
24426
+ $put(param?: NoParams, options?: RequestOptions): Promise<boolean | 0 | 1>;
24427
+ };
24428
+ token: {
24360
24429
  /**
24361
- * Remove Metric server.
24430
+ * Get user API tokens.
24362
24431
  *
24363
- * `DELETE /cluster/metrics/server/{id}`
24432
+ * `GET /access/users/{userid}/token`
24364
24433
  *
24365
- * Permissions: Sys.Modify on /
24434
+ * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify"]]
24366
24435
  */
24367
- $delete(param?: NoParams, options?: RequestOptions): Promise<null>;
24436
+ $get(param?: NoParams, options?: RequestOptions): Promise<AccessUsersTokenTokenIndex[]>;
24437
+ $(tokenid: string): {
24438
+ /**
24439
+ * Get specific API token information.
24440
+ *
24441
+ * `GET /access/users/{userid}/token/{tokenid}`
24442
+ *
24443
+ * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify"]]
24444
+ */
24445
+ $get(param?: NoParams, options?: RequestOptions): Promise<AccessUsersTokenReadToken>;
24446
+ /**
24447
+ * Generate a new API token for a specific user. NOTE: returns API token value, which needs to be stored as it cannot be retrieved afterwards!
24448
+ *
24449
+ * `POST /access/users/{userid}/token/{tokenid}`
24450
+ *
24451
+ * Permissions: Creating a token without privilege separation for another user also requires 'Realm.AllocateUser' on '/access/realm/<realm>' of that user and 'Permissions.Modify' on '/'. An API token does not count as its owning user.
24452
+ */
24453
+ $post(param?: AccessUsersTokenGenerateTokenParams, options?: RequestOptions): Promise<AccessUsersTokenGenerateToken>;
24454
+ /**
24455
+ * Update API token for a specific user. NOTE: when 'regenerate' is set, the returned token value needs to be stored as it cannot be retrieved afterwards!
24456
+ *
24457
+ * `PUT /access/users/{userid}/token/{tokenid}`
24458
+ *
24459
+ * Permissions: For a token of another user, regenerating the secret, or any update that leaves privilege separation disabled, also requires 'Realm.AllocateUser' on '/access/realm/<realm>' of that user and 'Permissions.Modify' on '/'. An API token does not count as its owning user.
24460
+ */
24461
+ $put(param?: AccessUsersTokenUpdateTokenInfoParams, options?: RequestOptions): Promise<AccessUsersTokenUpdateTokenInfo>;
24462
+ /**
24463
+ * Remove API token for a specific user.
24464
+ *
24465
+ * `DELETE /access/users/{userid}/token/{tokenid}`
24466
+ *
24467
+ * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify"]]
24468
+ */
24469
+ $delete(param?: NoParams, options?: RequestOptions): Promise<null>;
24470
+ };
24368
24471
  };
24369
24472
  };
24370
- export: {
24371
- /**
24372
- * Retrieve metrics of the cluster.
24373
- *
24374
- * `GET /cluster/metrics/export`
24375
- *
24376
- * Permissions: Sys.Audit on /
24377
- */
24378
- $get(param?: ClusterMetricsExportExportParams, options?: RequestOptions): Promise<ClusterMetricsExportExport>;
24379
- };
24380
24473
  };
24381
- notifications: {
24474
+ groups: {
24382
24475
  /**
24383
- * Index for notification-related API endpoints.
24476
+ * Group index.
24384
24477
  *
24385
- * `GET /cluster/notifications`
24478
+ * `GET /access/groups`
24386
24479
  *
24387
- * Permissions: any authenticated user
24480
+ * Permissions: The returned list is restricted to groups where you have 'User.Modify', 'Sys.Audit' or 'Group.Allocate' permissions on /access/groups/<group>.
24388
24481
  */
24389
- $get(param?: NoParams, options?: RequestOptions): Promise<Record<string, any>[]>;
24390
- "matcher-fields": {
24482
+ $get(param?: NoParams, options?: RequestOptions): Promise<AccessGroupsIndex[]>;
24483
+ /**
24484
+ * Create new group.
24485
+ *
24486
+ * `POST /access/groups`
24487
+ *
24488
+ * Permissions: Group.Allocate on /access/groups
24489
+ */
24490
+ $post(param: AccessGroupsCreateGroupParams, options?: RequestOptions): Promise<null>;
24491
+ $(groupid: string): {
24391
24492
  /**
24392
- * Returns known notification metadata fields
24493
+ * Get group configuration.
24393
24494
  *
24394
- * `GET /cluster/notifications/matcher-fields`
24495
+ * `GET /access/groups/{groupid}`
24395
24496
  *
24396
- * Permissions: Mapping.Modify on /mapping/notifications or Mapping.Audit on /mapping/notifications
24497
+ * Permissions: Sys.Audit or Group.Allocate on /access/groups
24397
24498
  */
24398
- $get(param?: NoParams, options?: RequestOptions): Promise<ClusterNotificationsMatcherFieldsGetMatcherFields[]>;
24399
- };
24400
- "matcher-field-values": {
24499
+ $get(param?: NoParams, options?: RequestOptions): Promise<AccessGroupsReadGroup>;
24401
24500
  /**
24402
- * Returns known notification metadata fields and their known values
24501
+ * Update group data.
24403
24502
  *
24404
- * `GET /cluster/notifications/matcher-field-values`
24503
+ * `PUT /access/groups/{groupid}`
24405
24504
  *
24406
- * Permissions: Mapping.Modify on /mapping/notifications or Mapping.Audit on /mapping/notifications
24505
+ * Permissions: Group.Allocate on /access/groups
24407
24506
  */
24408
- $get(param?: NoParams, options?: RequestOptions): Promise<ClusterNotificationsMatcherFieldValuesGetMatcherFieldValues[]>;
24409
- };
24410
- endpoints: {
24507
+ $put(param?: AccessGroupsUpdateGroupParams, options?: RequestOptions): Promise<null>;
24411
24508
  /**
24412
- * Index for all available endpoint types.
24509
+ * Delete group.
24413
24510
  *
24414
- * `GET /cluster/notifications/endpoints`
24511
+ * `DELETE /access/groups/{groupid}`
24415
24512
  *
24416
- * Permissions: any authenticated user
24513
+ * Permissions: Group.Allocate on /access/groups
24417
24514
  */
24418
- $get(param?: NoParams, options?: RequestOptions): Promise<Record<string, any>[]>;
24419
- sendmail: {
24420
- /**
24421
- * Returns a list of all sendmail endpoints
24422
- *
24423
- * `GET /cluster/notifications/endpoints/sendmail`
24424
- *
24515
+ $delete(param?: NoParams, options?: RequestOptions): Promise<null>;
24516
+ };
24517
+ };
24518
+ roles: {
24519
+ /**
24520
+ * Role index.
24521
+ *
24522
+ * `GET /access/roles`
24523
+ *
24524
+ * Permissions: any authenticated user
24525
+ */
24526
+ $get(param?: NoParams, options?: RequestOptions): Promise<AccessRolesIndex[]>;
24527
+ /**
24528
+ * Create new role.
24529
+ *
24530
+ * `POST /access/roles`
24531
+ *
24532
+ * Permissions: Sys.Modify on /access
24533
+ */
24534
+ $post(param: AccessRolesCreateRoleParams, options?: RequestOptions): Promise<null>;
24535
+ $(roleid: string): {
24536
+ /**
24537
+ * Get role configuration.
24538
+ *
24539
+ * `GET /access/roles/{roleid}`
24540
+ *
24541
+ * Permissions: any authenticated user
24542
+ */
24543
+ $get(param?: NoParams, options?: RequestOptions): Promise<AccessRolesReadRole>;
24544
+ /**
24545
+ * Update an existing role.
24546
+ *
24547
+ * `PUT /access/roles/{roleid}`
24548
+ *
24549
+ * Permissions: Sys.Modify on /access
24550
+ */
24551
+ $put(param?: AccessRolesUpdateRoleParams, options?: RequestOptions): Promise<null>;
24552
+ /**
24553
+ * Delete role.
24554
+ *
24555
+ * `DELETE /access/roles/{roleid}`
24556
+ *
24557
+ * Permissions: Sys.Modify on /access
24558
+ */
24559
+ $delete(param?: NoParams, options?: RequestOptions): Promise<null>;
24560
+ };
24561
+ };
24562
+ acl: {
24563
+ /**
24564
+ * Get Access Control List (ACLs).
24565
+ *
24566
+ * `GET /access/acl`
24567
+ *
24568
+ * Permissions: The returned list is restricted to objects where you have rights to modify permissions.
24569
+ */
24570
+ $get(param?: NoParams, options?: RequestOptions): Promise<AccessAclReadAcl[]>;
24571
+ /**
24572
+ * Update Access Control List (add or remove permissions).
24573
+ *
24574
+ * `PUT /access/acl`
24575
+ *
24576
+ * Permissions: ["perm-modify","{path}"]
24577
+ */
24578
+ $put(param: AccessAclUpdateAclParams, options?: RequestOptions): Promise<null>;
24579
+ };
24580
+ domains: {
24581
+ /**
24582
+ * Authentication domain index.
24583
+ *
24584
+ * `GET /access/domains`
24585
+ *
24586
+ * Permissions: Anyone can access that, because we need that list for the login box (before the user is authenticated).
24587
+ */
24588
+ $get(param?: NoParams, options?: RequestOptions): Promise<AccessDomainsIndex[]>;
24589
+ /**
24590
+ * Add an authentication server.
24591
+ *
24592
+ * `POST /access/domains`
24593
+ *
24594
+ * Permissions: Realm.Allocate on /access/realm
24595
+ */
24596
+ $post(param: AccessDomainsCreateParams, options?: RequestOptions): Promise<null>;
24597
+ $(realm: string): {
24598
+ /**
24599
+ * Get auth server configuration.
24600
+ *
24601
+ * `GET /access/domains/{realm}`
24602
+ *
24603
+ * Permissions: Realm.Allocate or Sys.Audit on /access/realm
24604
+ */
24605
+ $get(param?: NoParams, options?: RequestOptions): Promise<any>;
24606
+ /**
24607
+ * Update authentication server settings.
24608
+ *
24609
+ * `PUT /access/domains/{realm}`
24610
+ *
24611
+ * Permissions: Realm.Allocate on /access/realm
24612
+ */
24613
+ $put(param?: AccessDomainsUpdateParams, options?: RequestOptions): Promise<null>;
24614
+ /**
24615
+ * Delete an authentication server.
24616
+ *
24617
+ * `DELETE /access/domains/{realm}`
24618
+ *
24619
+ * Permissions: Realm.Allocate on /access/realm
24620
+ */
24621
+ $delete(param?: NoParams, options?: RequestOptions): Promise<null>;
24622
+ sync: {
24623
+ /**
24624
+ * Syncs users and/or groups from the configured LDAP to user.cfg. NOTE: Synced groups will have the name 'name-$realm', so make sure those groups do not exist to prevent overwriting.
24625
+ *
24626
+ * `POST /access/domains/{realm}/sync`
24627
+ *
24628
+ * Permissions: 'Realm.AllocateUser' on '/access/realm/<realm>' and 'User.Modify' permissions to '/access/groups/'.
24629
+ */
24630
+ $post(param?: AccessDomainsSyncSyncParams, options?: RequestOptions): Promise<string>;
24631
+ };
24632
+ };
24633
+ };
24634
+ openid: {
24635
+ /**
24636
+ * Directory index.
24637
+ *
24638
+ * `GET /access/openid`
24639
+ *
24640
+ * Permissions: any authenticated user
24641
+ */
24642
+ $get(param?: NoParams, options?: RequestOptions): Promise<AccessOpenidIndex[]>;
24643
+ "auth-url": {
24644
+ /**
24645
+ * Get the OpenId Authorization Url for the specified realm.
24646
+ *
24647
+ * `POST /access/openid/auth-url`
24648
+ *
24649
+ * Permissions: no authentication required
24650
+ */
24651
+ $post(param: AccessOpenidAuthUrlAuthUrlParams, options?: RequestOptions): Promise<string>;
24652
+ };
24653
+ login: {
24654
+ /**
24655
+ * Verify OpenID authorization code and create a ticket.
24656
+ *
24657
+ * `POST /access/openid/login`
24658
+ *
24659
+ * Permissions: no authentication required
24660
+ */
24661
+ $post(param: AccessOpenidLoginLoginParams, options?: RequestOptions): Promise<AccessOpenidLoginLogin>;
24662
+ };
24663
+ };
24664
+ tfa: {
24665
+ /**
24666
+ * List TFA configurations of users.
24667
+ *
24668
+ * `GET /access/tfa`
24669
+ *
24670
+ * Permissions: Returns all or just the logged-in user, depending on privileges.
24671
+ */
24672
+ $get(param?: NoParams, options?: RequestOptions): Promise<AccessTfaListTfa[]>;
24673
+ $(userid: string): {
24674
+ /**
24675
+ * List TFA configurations of users.
24676
+ *
24677
+ * `GET /access/tfa/{userid}`
24678
+ *
24679
+ * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify","Sys.Audit"]]
24680
+ */
24681
+ $get(param?: NoParams, options?: RequestOptions): Promise<AccessTfaListUserTfa[]>;
24682
+ /**
24683
+ * Add a TFA entry for a user.
24684
+ *
24685
+ * `POST /access/tfa/{userid}`
24686
+ *
24687
+ * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify"]]
24688
+ *
24689
+ * Not callable with an API token.
24690
+ */
24691
+ $post(param: AccessTfaAddTfaEntryParams, options?: RequestOptions): Promise<AccessTfaAddTfaEntry>;
24692
+ $(id: string): {
24693
+ /**
24694
+ * Fetch a requested TFA entry if present.
24695
+ *
24696
+ * `GET /access/tfa/{userid}/{id}`
24697
+ *
24698
+ * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify","Sys.Audit"]]
24699
+ */
24700
+ $get(param?: NoParams, options?: RequestOptions): Promise<AccessTfaGetTfaEntry>;
24701
+ /**
24702
+ * Add a TFA entry for a user.
24703
+ *
24704
+ * `PUT /access/tfa/{userid}/{id}`
24705
+ *
24706
+ * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify"]]
24707
+ *
24708
+ * Not callable with an API token.
24709
+ */
24710
+ $put(param?: AccessTfaUpdateTfaEntryParams, options?: RequestOptions): Promise<null>;
24711
+ /**
24712
+ * Delete a TFA entry by ID.
24713
+ *
24714
+ * `DELETE /access/tfa/{userid}/{id}`
24715
+ *
24716
+ * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify"]]
24717
+ *
24718
+ * Not callable with an API token.
24719
+ */
24720
+ $delete(param?: AccessTfaDeleteTfaParams, options?: RequestOptions): Promise<null>;
24721
+ };
24722
+ };
24723
+ };
24724
+ ticket: {
24725
+ /**
24726
+ * Dummy. Useful for formatters which want to provide a login page.
24727
+ *
24728
+ * `GET /access/ticket`
24729
+ *
24730
+ * Permissions: no authentication required
24731
+ */
24732
+ $get(param?: NoParams, options?: RequestOptions): Promise<null>;
24733
+ /**
24734
+ * Create or verify authentication ticket.
24735
+ *
24736
+ * `POST /access/ticket`
24737
+ *
24738
+ * Permissions: You need to pass valid credientials.
24739
+ *
24740
+ * Not callable with an API token.
24741
+ */
24742
+ $post(param: AccessTicketCreateTicketParams, options?: RequestOptions): Promise<AccessTicketCreateTicket>;
24743
+ };
24744
+ vncticket: {
24745
+ /**
24746
+ * verify VNC authentication ticket.
24747
+ *
24748
+ * `POST /access/vncticket`
24749
+ *
24750
+ * Permissions: You need to pass valid credientials.
24751
+ */
24752
+ $post(param: AccessVncticketVerifyVncTicketParams, options?: RequestOptions): Promise<null>;
24753
+ };
24754
+ password: {
24755
+ /**
24756
+ * Change user password.
24757
+ *
24758
+ * `PUT /access/password`
24759
+ *
24760
+ * Permissions: Each user is allowed to change their own password. A user can change the password of another user if they have 'Realm.AllocateUser' (on the realm of user <userid>) and 'User.Modify' permission on /access/groups/<group> on a group where user <userid> is member of. For the PAM realm, a password change does not take effect cluster-wide, but only applies to the local node.
24761
+ *
24762
+ * Not callable with an API token.
24763
+ */
24764
+ $put(param: AccessPasswordChangePasswordParams, options?: RequestOptions): Promise<null>;
24765
+ };
24766
+ permissions: {
24767
+ /**
24768
+ * Retrieve effective permissions of given user/token.
24769
+ *
24770
+ * `GET /access/permissions`
24771
+ *
24772
+ * Permissions: Each user/token is allowed to dump their own permissions (or that of owned tokens). A user can dump the permissions of another user or their tokens if they have 'Sys.Audit' permission on /access.
24773
+ */
24774
+ $get(param?: AccessPermissionsPermissionsParams, options?: RequestOptions): Promise<Record<string, any>>;
24775
+ };
24776
+ };
24777
+ cluster: {
24778
+ /**
24779
+ * Cluster index.
24780
+ *
24781
+ * `GET /cluster`
24782
+ *
24783
+ * Permissions: any authenticated user
24784
+ */
24785
+ $get(param?: NoParams, options?: RequestOptions): Promise<Record<string, any>[]>;
24786
+ replication: {
24787
+ /**
24788
+ * List replication jobs.
24789
+ *
24790
+ * `GET /cluster/replication`
24791
+ *
24792
+ * Permissions: Will only return replication jobs for which the calling user has VM.Audit permission on /vms/<vmid>.
24793
+ */
24794
+ $get(param?: NoParams, options?: RequestOptions): Promise<ClusterReplicationIndex[]>;
24795
+ /**
24796
+ * Create a new replication job
24797
+ *
24798
+ * `POST /cluster/replication`
24799
+ *
24800
+ * Permissions: Requires the VM.Replicate permission on /vms/<vmid>.
24801
+ */
24802
+ $post(param: ClusterReplicationCreateParams, options?: RequestOptions): Promise<null>;
24803
+ $(id: string): {
24804
+ /**
24805
+ * Read replication job configuration.
24806
+ *
24807
+ * `GET /cluster/replication/{id}`
24808
+ *
24809
+ * Permissions: Requires the VM.Audit permission on /vms/<vmid>.
24810
+ */
24811
+ $get(param?: NoParams, options?: RequestOptions): Promise<ClusterReplicationRead>;
24812
+ /**
24813
+ * Update replication job configuration.
24814
+ *
24815
+ * `PUT /cluster/replication/{id}`
24816
+ *
24817
+ * Permissions: Requires the VM.Replicate permission on /vms/<vmid>.
24818
+ */
24819
+ $put(param?: ClusterReplicationUpdateParams, options?: RequestOptions): Promise<null>;
24820
+ /**
24821
+ * Mark replication job for removal.
24822
+ *
24823
+ * `DELETE /cluster/replication/{id}`
24824
+ *
24825
+ * Permissions: Requires the VM.Replicate permission on /vms/<vmid>.
24826
+ */
24827
+ $delete(param?: ClusterReplicationDeleteParams, options?: RequestOptions): Promise<null>;
24828
+ };
24829
+ };
24830
+ metrics: {
24831
+ /**
24832
+ * Metrics index.
24833
+ *
24834
+ * `GET /cluster/metrics`
24835
+ *
24836
+ * Permissions: any authenticated user
24837
+ */
24838
+ $get(param?: NoParams, options?: RequestOptions): Promise<Record<string, any>[]>;
24839
+ server: {
24840
+ /**
24841
+ * List configured metric servers.
24842
+ *
24843
+ * `GET /cluster/metrics/server`
24844
+ *
24845
+ * Permissions: Sys.Audit on /
24846
+ */
24847
+ $get(param?: NoParams, options?: RequestOptions): Promise<ClusterMetricsServerServerIndex[]>;
24848
+ $(id: string): {
24849
+ /**
24850
+ * Read metric server configuration.
24851
+ *
24852
+ * `GET /cluster/metrics/server/{id}`
24853
+ *
24854
+ * Permissions: Sys.Audit on /
24855
+ */
24856
+ $get(param?: NoParams, options?: RequestOptions): Promise<Record<string, any>>;
24857
+ /**
24858
+ * Create a new external metric server config
24859
+ *
24860
+ * `POST /cluster/metrics/server/{id}`
24861
+ *
24862
+ * Permissions: Sys.Modify on /
24863
+ */
24864
+ $post(param: ClusterMetricsServerCreateParams, options?: RequestOptions): Promise<null>;
24865
+ /**
24866
+ * Update metric server configuration.
24867
+ *
24868
+ * `PUT /cluster/metrics/server/{id}`
24869
+ *
24870
+ * Permissions: Sys.Modify on /
24871
+ */
24872
+ $put(param: ClusterMetricsServerUpdateParams, options?: RequestOptions): Promise<null>;
24873
+ /**
24874
+ * Remove Metric server.
24875
+ *
24876
+ * `DELETE /cluster/metrics/server/{id}`
24877
+ *
24878
+ * Permissions: Sys.Modify on /
24879
+ */
24880
+ $delete(param?: NoParams, options?: RequestOptions): Promise<null>;
24881
+ };
24882
+ };
24883
+ export: {
24884
+ /**
24885
+ * Retrieve metrics of the cluster.
24886
+ *
24887
+ * `GET /cluster/metrics/export`
24888
+ *
24889
+ * Permissions: Sys.Audit on /
24890
+ */
24891
+ $get(param?: ClusterMetricsExportExportParams, options?: RequestOptions): Promise<ClusterMetricsExportExport>;
24892
+ };
24893
+ };
24894
+ notifications: {
24895
+ /**
24896
+ * Index for notification-related API endpoints.
24897
+ *
24898
+ * `GET /cluster/notifications`
24899
+ *
24900
+ * Permissions: any authenticated user
24901
+ */
24902
+ $get(param?: NoParams, options?: RequestOptions): Promise<Record<string, any>[]>;
24903
+ "matcher-fields": {
24904
+ /**
24905
+ * Returns known notification metadata fields
24906
+ *
24907
+ * `GET /cluster/notifications/matcher-fields`
24908
+ *
24909
+ * Permissions: Mapping.Modify on /mapping/notifications or Mapping.Audit on /mapping/notifications
24910
+ */
24911
+ $get(param?: NoParams, options?: RequestOptions): Promise<ClusterNotificationsMatcherFieldsGetMatcherFields[]>;
24912
+ };
24913
+ "matcher-field-values": {
24914
+ /**
24915
+ * Returns known notification metadata fields and their known values
24916
+ *
24917
+ * `GET /cluster/notifications/matcher-field-values`
24918
+ *
24919
+ * Permissions: Mapping.Modify on /mapping/notifications or Mapping.Audit on /mapping/notifications
24920
+ */
24921
+ $get(param?: NoParams, options?: RequestOptions): Promise<ClusterNotificationsMatcherFieldValuesGetMatcherFieldValues[]>;
24922
+ };
24923
+ endpoints: {
24924
+ /**
24925
+ * Index for all available endpoint types.
24926
+ *
24927
+ * `GET /cluster/notifications/endpoints`
24928
+ *
24929
+ * Permissions: any authenticated user
24930
+ */
24931
+ $get(param?: NoParams, options?: RequestOptions): Promise<Record<string, any>[]>;
24932
+ sendmail: {
24933
+ /**
24934
+ * Returns a list of all sendmail endpoints
24935
+ *
24936
+ * `GET /cluster/notifications/endpoints/sendmail`
24937
+ *
24425
24938
  * Permissions: Mapping.Modify on /mapping/notifications or Mapping.Audit on /mapping/notifications
24426
24939
  */
24427
24940
  $get(param?: NoParams, options?: RequestOptions): Promise<ClusterNotificationsEndpointsSendmailGetSendmailEndpoints[]>;
@@ -29055,7 +29568,7 @@ export declare namespace Proxmox {
29055
29568
  *
29056
29569
  * `GET /nodes/{node}/storage/{storage}/prunebackups`
29057
29570
  *
29058
- * Permissions: Datastore.Audit or Datastore.AllocateSpace on /storage/{storage}
29571
+ * Permissions: You need the 'Datastore.Allocate' privilege on the storage (or if a VM ID is specified, 'Datastore.AllocateSpace' and 'VM.Backup' for the VM).
29059
29572
  */
29060
29573
  $get(param?: NodesStoragePrunebackupsDryrunParams, options?: RequestOptions): Promise<NodesStoragePrunebackupsDryrun[]>;
29061
29574
  /**
@@ -29771,787 +30284,363 @@ export declare namespace Proxmox {
29771
30284
  * Get a list of all bridges (vnets) that are part of a zone, as well as the ports that are members of that bridge.
29772
30285
  *
29773
30286
  * `GET /nodes/{node}/sdn/zones/{zone}/bridges`
29774
- *
29775
- * Permissions: SDN.Audit on /sdn/zones/{zone}
29776
- */
29777
- $get(param?: NoParams, options?: RequestOptions): Promise<NodesSdnZonesBridgesBridges[]>;
29778
- };
29779
- "ip-vrf": {
29780
- /**
29781
- * Get the IP VRF of an EVPN zone.
29782
- *
29783
- * `GET /nodes/{node}/sdn/zones/{zone}/ip-vrf`
29784
- *
29785
- * Permissions: SDN.Audit on /sdn/zones/{zone}
29786
- */
29787
- $get(param?: NoParams, options?: RequestOptions): Promise<NodesSdnZonesIpVrfIpVrf[]>;
29788
- };
29789
- };
29790
- };
29791
- vnets: {
29792
- $(vnet: string): {
29793
- /**
29794
- *
29795
- * `GET /nodes/{node}/sdn/vnets/{vnet}`
29796
- *
29797
- * Permissions: Require 'SDN.Audit' permissions on '/sdn/zones/<zone>/<vnet>'
29798
- */
29799
- $get(param?: NoParams, options?: RequestOptions): Promise<NodesSdnVnetsDiridx[]>;
29800
- "mac-vrf": {
29801
- /**
29802
- * Get the MAC VRF for a VNet in an EVPN zone.
29803
- *
29804
- * `GET /nodes/{node}/sdn/vnets/{vnet}/mac-vrf`
29805
- *
29806
- * Permissions: Require 'SDN.Audit' permissions on '/sdn/zones/<zone>/<vnet>'
29807
- */
29808
- $get(param?: NoParams, options?: RequestOptions): Promise<NodesSdnVnetsMacVrfMacVrf[]>;
29809
- };
29810
- };
29811
- };
29812
- };
29813
- version: {
29814
- /**
29815
- * API version details
29816
- *
29817
- * `GET /nodes/{node}/version`
29818
- *
29819
- * Permissions: any authenticated user
29820
- */
29821
- $get(param?: NoParams, options?: RequestOptions): Promise<NodesVersionVersion>;
29822
- };
29823
- status: {
29824
- /**
29825
- * Read node status
29826
- *
29827
- * `GET /nodes/{node}/status`
29828
- *
29829
- * Permissions: Sys.Audit on /nodes/{node}
29830
- */
29831
- $get(param?: NoParams, options?: RequestOptions): Promise<NodesStatusStatus>;
29832
- /**
29833
- * Reboot or shutdown a node.
29834
- *
29835
- * `POST /nodes/{node}/status`
29836
- *
29837
- * Permissions: Sys.PowerMgmt on /nodes/{node}
29838
- */
29839
- $post(param: NodesStatusNodeCmdParams, options?: RequestOptions): Promise<null>;
29840
- };
29841
- netstat: {
29842
- /**
29843
- * Read tap/vm network device interface counters
29844
- *
29845
- * `GET /nodes/{node}/netstat`
29846
- *
29847
- * Permissions: Sys.Audit on /nodes/{node}
29848
- */
29849
- $get(param?: NoParams, options?: RequestOptions): Promise<Record<string, any>[]>;
29850
- };
29851
- execute: {
29852
- /**
29853
- * Execute multiple commands in order, root only.
29854
- *
29855
- * `POST /nodes/{node}/execute`
29856
- */
29857
- $post(param: NodesExecuteExecuteParams, options?: RequestOptions): Promise<Record<string, any>[]>;
29858
- };
29859
- wakeonlan: {
29860
- /**
29861
- * Try to wake a node via 'wake on LAN' network packet.
29862
- *
29863
- * `POST /nodes/{node}/wakeonlan`
29864
- *
29865
- * Permissions: Sys.PowerMgmt on /nodes/{node}
29866
- */
29867
- $post(param?: NoParams, options?: RequestOptions): Promise<MacAddr>;
29868
- };
29869
- rrd: {
29870
- /**
29871
- * Read node RRD statistics (returns PNG)
29872
- *
29873
- * `GET /nodes/{node}/rrd`
29874
- *
29875
- * Permissions: Sys.Audit on /nodes/{node}
29876
- */
29877
- $get(param: NodesRrdRrdParams, options?: RequestOptions): Promise<NodesRrdRrd>;
29878
- };
29879
- rrddata: {
29880
- /**
29881
- * Read node RRD statistics
29882
- *
29883
- * `GET /nodes/{node}/rrddata`
29884
- *
29885
- * Permissions: Sys.Audit on /nodes/{node}
29886
- */
29887
- $get(param: NodesRrddataRrddataParams, options?: RequestOptions): Promise<Record<string, any>[]>;
29888
- };
29889
- syslog: {
29890
- /**
29891
- * Read system log
29892
- *
29893
- * `GET /nodes/{node}/syslog`
29894
- *
29895
- * Permissions: Sys.Syslog on /nodes/{node}
29896
- */
29897
- $get(param?: NodesSyslogSyslogParams, options?: RequestOptions): Promise<NodesSyslogSyslog[]>;
29898
- };
29899
- journal: {
29900
- /**
29901
- * Read Journal
29902
- *
29903
- * `GET /nodes/{node}/journal`
29904
- *
29905
- * Permissions: Sys.Syslog on /nodes/{node}
29906
- */
29907
- $get(param?: NodesJournalJournalParams, options?: RequestOptions): Promise<string[]>;
29908
- };
29909
- vncshell: {
29910
- /**
29911
- * Creates a VNC Shell proxy.
29912
- *
29913
- * `POST /nodes/{node}/vncshell`
29914
- *
29915
- * Permissions: Sys.Console on /nodes/{node}
29916
- */
29917
- $post(param?: NodesVncshellVncshellParams, options?: RequestOptions): Promise<NodesVncshellVncshell>;
29918
- };
29919
- termproxy: {
29920
- /**
29921
- * Creates a VNC Shell proxy.
29922
- *
29923
- * `POST /nodes/{node}/termproxy`
29924
- *
29925
- * Permissions: Sys.Console on /nodes/{node}
29926
- */
29927
- $post(param?: NodesTermproxyTermproxyParams, options?: RequestOptions): Promise<NodesTermproxyTermproxy>;
29928
- };
29929
- vncwebsocket: {
29930
- /**
29931
- * Opens a websocket for VNC traffic.
29932
- *
29933
- * `GET /nodes/{node}/vncwebsocket`
29934
- *
29935
- * Permissions: You also need to pass a valid ticket (vncticket).
29936
- */
29937
- $get(param: NodesVncwebsocketVncwebsocketParams, options?: RequestOptions): Promise<NodesVncwebsocketVncwebsocket>;
30287
+ *
30288
+ * Permissions: SDN.Audit on /sdn/zones/{zone}
30289
+ */
30290
+ $get(param?: NoParams, options?: RequestOptions): Promise<NodesSdnZonesBridgesBridges[]>;
30291
+ };
30292
+ "ip-vrf": {
30293
+ /**
30294
+ * Get the IP VRF of an EVPN zone.
30295
+ *
30296
+ * `GET /nodes/{node}/sdn/zones/{zone}/ip-vrf`
30297
+ *
30298
+ * Permissions: SDN.Audit on /sdn/zones/{zone}
30299
+ */
30300
+ $get(param?: NoParams, options?: RequestOptions): Promise<NodesSdnZonesIpVrfIpVrf[]>;
30301
+ };
30302
+ };
30303
+ };
30304
+ vnets: {
30305
+ $(vnet: string): {
30306
+ /**
30307
+ *
30308
+ * `GET /nodes/{node}/sdn/vnets/{vnet}`
30309
+ *
30310
+ * Permissions: Require 'SDN.Audit' permissions on '/sdn/zones/<zone>/<vnet>'
30311
+ */
30312
+ $get(param?: NoParams, options?: RequestOptions): Promise<NodesSdnVnetsDiridx[]>;
30313
+ "mac-vrf": {
30314
+ /**
30315
+ * Get the MAC VRF for a VNet in an EVPN zone.
30316
+ *
30317
+ * `GET /nodes/{node}/sdn/vnets/{vnet}/mac-vrf`
30318
+ *
30319
+ * Permissions: Require 'SDN.Audit' permissions on '/sdn/zones/<zone>/<vnet>'
30320
+ */
30321
+ $get(param?: NoParams, options?: RequestOptions): Promise<NodesSdnVnetsMacVrfMacVrf[]>;
30322
+ };
30323
+ };
30324
+ };
29938
30325
  };
29939
- spiceshell: {
30326
+ version: {
29940
30327
  /**
29941
- * Creates a SPICE shell.
30328
+ * API version details
29942
30329
  *
29943
- * `POST /nodes/{node}/spiceshell`
30330
+ * `GET /nodes/{node}/version`
29944
30331
  *
29945
- * Permissions: Sys.Console on /nodes/{node}
30332
+ * Permissions: any authenticated user
29946
30333
  */
29947
- $post(param?: NodesSpiceshellSpiceshellParams, options?: RequestOptions): Promise<NodesSpiceshellSpiceshell>;
30334
+ $get(param?: NoParams, options?: RequestOptions): Promise<NodesVersionVersion>;
29948
30335
  };
29949
- dns: {
30336
+ status: {
29950
30337
  /**
29951
- * Read DNS settings.
30338
+ * Read node status
29952
30339
  *
29953
- * `GET /nodes/{node}/dns`
30340
+ * `GET /nodes/{node}/status`
29954
30341
  *
29955
30342
  * Permissions: Sys.Audit on /nodes/{node}
29956
30343
  */
29957
- $get(param?: NoParams, options?: RequestOptions): Promise<NodesDnsDns>;
30344
+ $get(param?: NoParams, options?: RequestOptions): Promise<NodesStatusStatus>;
29958
30345
  /**
29959
- * Write DNS settings.
30346
+ * Reboot or shutdown a node.
29960
30347
  *
29961
- * `PUT /nodes/{node}/dns`
30348
+ * `POST /nodes/{node}/status`
29962
30349
  *
29963
- * Permissions: Sys.Modify on /nodes/{node}
30350
+ * Permissions: Sys.PowerMgmt on /nodes/{node}
29964
30351
  */
29965
- $put(param: NodesDnsUpdateDnsParams, options?: RequestOptions): Promise<null>;
30352
+ $post(param: NodesStatusNodeCmdParams, options?: RequestOptions): Promise<null>;
29966
30353
  };
29967
- time: {
30354
+ netstat: {
29968
30355
  /**
29969
- * Read server time and time zone settings.
30356
+ * Read tap/vm network device interface counters
29970
30357
  *
29971
- * `GET /nodes/{node}/time`
30358
+ * `GET /nodes/{node}/netstat`
29972
30359
  *
29973
30360
  * Permissions: Sys.Audit on /nodes/{node}
29974
30361
  */
29975
- $get(param?: NoParams, options?: RequestOptions): Promise<NodesTimeTime>;
29976
- /**
29977
- * Set time zone.
29978
- *
29979
- * `PUT /nodes/{node}/time`
29980
- *
29981
- * Permissions: Sys.Modify on /nodes/{node}
29982
- */
29983
- $put(param: NodesTimeSetTimezoneParams, options?: RequestOptions): Promise<null>;
29984
- };
29985
- aplinfo: {
29986
- /**
29987
- * Get list of appliances.
29988
- *
29989
- * `GET /nodes/{node}/aplinfo`
29990
- *
29991
- * Permissions: any authenticated user
29992
- */
29993
30362
  $get(param?: NoParams, options?: RequestOptions): Promise<Record<string, any>[]>;
29994
- /**
29995
- * Download appliance templates.
29996
- *
29997
- * `POST /nodes/{node}/aplinfo`
29998
- *
29999
- * Permissions: Datastore.AllocateTemplate on /storage/{storage}
30000
- */
30001
- $post(param: NodesAplinfoAplDownloadParams, options?: RequestOptions): Promise<string>;
30002
30363
  };
30003
- "query-oci-repo-tags": {
30364
+ execute: {
30004
30365
  /**
30005
- * List all tags for an OCI repository reference.
30006
- *
30007
- * `GET /nodes/{node}/query-oci-repo-tags`
30366
+ * Execute multiple commands in order, root only.
30008
30367
  *
30009
- * Permissions: Sys.AccessNetwork on /nodes/{node}
30368
+ * `POST /nodes/{node}/execute`
30010
30369
  */
30011
- $get(param: NodesQueryOciRepoTagsQueryOciRepoTagsParams, options?: RequestOptions): Promise<string[]>;
30370
+ $post(param: NodesExecuteExecuteParams, options?: RequestOptions): Promise<Record<string, any>[]>;
30012
30371
  };
30013
- "query-url-metadata": {
30372
+ wakeonlan: {
30014
30373
  /**
30015
- * Query metadata of an URL: file size, file name and mime type.
30374
+ * Try to wake a node via 'wake on LAN' network packet.
30016
30375
  *
30017
- * `GET /nodes/{node}/query-url-metadata`
30376
+ * `POST /nodes/{node}/wakeonlan`
30018
30377
  *
30019
- * Permissions: Sys.Audit, Sys.Modify on / or Sys.AccessNetwork on /nodes/{node}
30378
+ * Permissions: Sys.PowerMgmt on /nodes/{node}
30020
30379
  */
30021
- $get(param: NodesQueryUrlMetadataQueryUrlMetadataParams, options?: RequestOptions): Promise<NodesQueryUrlMetadataQueryUrlMetadata>;
30380
+ $post(param?: NoParams, options?: RequestOptions): Promise<MacAddr>;
30022
30381
  };
30023
- report: {
30382
+ rrd: {
30024
30383
  /**
30025
- * Gather various systems information about a node
30384
+ * Read node RRD statistics (returns PNG)
30026
30385
  *
30027
- * `GET /nodes/{node}/report`
30386
+ * `GET /nodes/{node}/rrd`
30028
30387
  *
30029
30388
  * Permissions: Sys.Audit on /nodes/{node}
30030
30389
  */
30031
- $get(param?: NoParams, options?: RequestOptions): Promise<string>;
30032
- };
30033
- startall: {
30034
- /**
30035
- * Start all VMs and containers located on this node (by default only those with onboot=1).
30036
- *
30037
- * `POST /nodes/{node}/startall`
30038
- *
30039
- * Permissions: The 'VM.PowerMgmt' permission is required on '/' or on '/vms/<ID>' for each ID passed via the 'vms' parameter.
30040
- */
30041
- $post(param?: NodesStartallStartallParams, options?: RequestOptions): Promise<string>;
30042
- };
30043
- stopall: {
30044
- /**
30045
- * Stop all VMs and Containers.
30046
- *
30047
- * `POST /nodes/{node}/stopall`
30048
- *
30049
- * Permissions: The 'VM.PowerMgmt' permission is required on '/' or on '/vms/<ID>' for each ID passed via the 'vms' parameter.
30050
- */
30051
- $post(param?: NodesStopallStopallParams, options?: RequestOptions): Promise<string>;
30052
- };
30053
- suspendall: {
30054
- /**
30055
- * Suspend all VMs.
30056
- *
30057
- * `POST /nodes/{node}/suspendall`
30058
- *
30059
- * Permissions: The 'VM.PowerMgmt' permission is required on '/' or on '/vms/<ID>' for each ID passed via the 'vms' parameter. Additionally, you need 'VM.Config.Disk' on the '/vms/{vmid}' path and 'Datastore.AllocateSpace' for the configured state-storage(s)
30060
- */
30061
- $post(param?: NodesSuspendallSuspendallParams, options?: RequestOptions): Promise<string>;
30062
- };
30063
- migrateall: {
30064
- /**
30065
- * Migrate all VMs and Containers.
30066
- *
30067
- * `POST /nodes/{node}/migrateall`
30068
- *
30069
- * Permissions: The 'VM.Migrate' permission is required on '/' or on '/vms/<ID>' for each ID passed via the 'vms' parameter.
30070
- */
30071
- $post(param: NodesMigrateallMigrateallParams, options?: RequestOptions): Promise<string>;
30390
+ $get(param: NodesRrdRrdParams, options?: RequestOptions): Promise<NodesRrdRrd>;
30072
30391
  };
30073
- hosts: {
30074
- /**
30075
- * Get the content of /etc/hosts.
30076
- *
30077
- * `GET /nodes/{node}/hosts`
30078
- *
30079
- * Permissions: Sys.Audit on /
30080
- */
30081
- $get(param?: NoParams, options?: RequestOptions): Promise<NodesHostsGetEtcHosts>;
30392
+ rrddata: {
30082
30393
  /**
30083
- * Write /etc/hosts.
30394
+ * Read node RRD statistics
30084
30395
  *
30085
- * `POST /nodes/{node}/hosts`
30396
+ * `GET /nodes/{node}/rrddata`
30086
30397
  *
30087
- * Permissions: Sys.Modify on /nodes/{node}
30088
- */
30089
- $post(param: NodesHostsWriteEtcHostsParams, options?: RequestOptions): Promise<null>;
30090
- };
30091
- };
30092
- };
30093
- storage: {
30094
- /**
30095
- * Storage index.
30096
- *
30097
- * `GET /storage`
30098
- *
30099
- * Permissions: Only list entries where you have 'Datastore.Audit' or 'Datastore.AllocateSpace' permissions on '/storage/<storage>'
30100
- */
30101
- $get(param?: StorageIndexParams, options?: RequestOptions): Promise<StorageIndex[]>;
30102
- /**
30103
- * Create a new storage.
30104
- *
30105
- * `POST /storage`
30106
- *
30107
- * Permissions: Datastore.Allocate on /storage
30108
- */
30109
- $post(param: StorageCreateParams, options?: RequestOptions): Promise<StorageCreate>;
30110
- $(storage: string): {
30111
- /**
30112
- * Read storage configuration.
30113
- *
30114
- * `GET /storage/{storage}`
30115
- *
30116
- * Permissions: Datastore.Allocate on /storage/{storage}
30117
- */
30118
- $get(param?: NoParams, options?: RequestOptions): Promise<Record<string, any>>;
30119
- /**
30120
- * Update storage configuration.
30121
- *
30122
- * `PUT /storage/{storage}`
30123
- *
30124
- * Permissions: Datastore.Allocate on /storage
30125
- */
30126
- $put(param?: StorageUpdateParams, options?: RequestOptions): Promise<StorageUpdate>;
30127
- /**
30128
- * Delete storage configuration.
30129
- *
30130
- * `DELETE /storage/{storage}`
30131
- *
30132
- * Permissions: Datastore.Allocate on /storage
30133
- */
30134
- $delete(param?: NoParams, options?: RequestOptions): Promise<null>;
30135
- };
30136
- };
30137
- access: {
30138
- /**
30139
- * Directory index.
30140
- *
30141
- * `GET /access`
30142
- *
30143
- * Permissions: any authenticated user
30144
- */
30145
- $get(param?: NoParams, options?: RequestOptions): Promise<AccessIndex[]>;
30146
- users: {
30147
- /**
30148
- * User index.
30149
- *
30150
- * `GET /access/users`
30151
- *
30152
- * Permissions: The returned list is restricted to users where you have 'User.Modify' or 'Sys.Audit' permissions on '/access/groups' or on a group the user belongs too. But it always includes the current (authenticated) user.
30153
- */
30154
- $get(param?: AccessUsersIndexParams, options?: RequestOptions): Promise<AccessUsersIndex[]>;
30155
- /**
30156
- * Create new user.
30157
- *
30158
- * `POST /access/users`
30159
- *
30160
- * Permissions: You need 'Realm.AllocateUser' on '/access/realm/<realm>' on the realm of user <userid>, and 'User.Modify' permissions to '/access/groups/<group>' for any group specified (or 'User.Modify' on '/access/groups' if you pass no groups.
30161
- */
30162
- $post(param: AccessUsersCreateUserParams, options?: RequestOptions): Promise<null>;
30163
- $(userid: string): {
30398
+ * Permissions: Sys.Audit on /nodes/{node}
30399
+ */
30400
+ $get(param: NodesRrddataRrddataParams, options?: RequestOptions): Promise<Record<string, any>[]>;
30401
+ };
30402
+ syslog: {
30164
30403
  /**
30165
- * Get user configuration.
30404
+ * Read system log
30166
30405
  *
30167
- * `GET /access/users/{userid}`
30406
+ * `GET /nodes/{node}/syslog`
30168
30407
  *
30169
- * Permissions: ["userid-group",["User.Modify","Sys.Audit"]]
30408
+ * Permissions: Sys.Syslog on /nodes/{node}
30170
30409
  */
30171
- $get(param?: NoParams, options?: RequestOptions): Promise<AccessUsersReadUser>;
30410
+ $get(param?: NodesSyslogSyslogParams, options?: RequestOptions): Promise<NodesSyslogSyslog[]>;
30411
+ };
30412
+ journal: {
30172
30413
  /**
30173
- * Update user configuration.
30414
+ * Read Journal
30174
30415
  *
30175
- * `PUT /access/users/{userid}`
30416
+ * `GET /nodes/{node}/journal`
30176
30417
  *
30177
- * Permissions: ["userid-group",["User.Modify"],"groups_param","update"]
30418
+ * Permissions: Sys.Syslog on /nodes/{node}
30178
30419
  */
30179
- $put(param?: AccessUsersUpdateUserParams, options?: RequestOptions): Promise<null>;
30420
+ $get(param?: NodesJournalJournalParams, options?: RequestOptions): Promise<string[]>;
30421
+ };
30422
+ vncshell: {
30180
30423
  /**
30181
- * Delete user.
30424
+ * Creates a VNC Shell proxy.
30182
30425
  *
30183
- * `DELETE /access/users/{userid}`
30426
+ * `POST /nodes/{node}/vncshell`
30184
30427
  *
30185
- * Permissions: ["userid-param","Realm.AllocateUser"] and ["userid-group",["User.Modify"]]
30428
+ * Permissions: Sys.Console on /nodes/{node}
30186
30429
  */
30187
- $delete(param?: NoParams, options?: RequestOptions): Promise<null>;
30188
- tfa: {
30189
- /**
30190
- * Get user TFA types (Personal and Realm).
30191
- *
30192
- * `GET /access/users/{userid}/tfa`
30193
- *
30194
- * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify","Sys.Audit"]]
30195
- */
30196
- $get(param?: AccessUsersTfaReadUserTfaTypeParams, options?: RequestOptions): Promise<AccessUsersTfaReadUserTfaType>;
30197
- };
30198
- "unlock-tfa": {
30199
- /**
30200
- * Unlock a user's TFA authentication.
30201
- *
30202
- * `PUT /access/users/{userid}/unlock-tfa`
30203
- *
30204
- * Permissions: ["userid-group",["User.Modify"]]
30205
- */
30206
- $put(param?: NoParams, options?: RequestOptions): Promise<boolean | 0 | 1>;
30207
- };
30208
- token: {
30209
- /**
30210
- * Get user API tokens.
30211
- *
30212
- * `GET /access/users/{userid}/token`
30213
- *
30214
- * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify"]]
30215
- */
30216
- $get(param?: NoParams, options?: RequestOptions): Promise<AccessUsersTokenTokenIndex[]>;
30217
- $(tokenid: string): {
30218
- /**
30219
- * Get specific API token information.
30220
- *
30221
- * `GET /access/users/{userid}/token/{tokenid}`
30222
- *
30223
- * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify"]]
30224
- */
30225
- $get(param?: NoParams, options?: RequestOptions): Promise<AccessUsersTokenReadToken>;
30226
- /**
30227
- * Generate a new API token for a specific user. NOTE: returns API token value, which needs to be stored as it cannot be retrieved afterwards!
30228
- *
30229
- * `POST /access/users/{userid}/token/{tokenid}`
30230
- *
30231
- * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify"]]
30232
- */
30233
- $post(param?: AccessUsersTokenGenerateTokenParams, options?: RequestOptions): Promise<AccessUsersTokenGenerateToken>;
30234
- /**
30235
- * Update API token for a specific user. NOTE: when 'regenerate' is set, the returned token value needs to be stored as it cannot be retrieved afterwards!
30236
- *
30237
- * `PUT /access/users/{userid}/token/{tokenid}`
30238
- *
30239
- * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify"]]
30240
- */
30241
- $put(param?: AccessUsersTokenUpdateTokenInfoParams, options?: RequestOptions): Promise<AccessUsersTokenUpdateTokenInfo>;
30242
- /**
30243
- * Remove API token for a specific user.
30244
- *
30245
- * `DELETE /access/users/{userid}/token/{tokenid}`
30246
- *
30247
- * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify"]]
30248
- */
30249
- $delete(param?: NoParams, options?: RequestOptions): Promise<null>;
30250
- };
30251
- };
30430
+ $post(param?: NodesVncshellVncshellParams, options?: RequestOptions): Promise<NodesVncshellVncshell>;
30252
30431
  };
30253
- };
30254
- groups: {
30255
- /**
30256
- * Group index.
30257
- *
30258
- * `GET /access/groups`
30259
- *
30260
- * Permissions: The returned list is restricted to groups where you have 'User.Modify', 'Sys.Audit' or 'Group.Allocate' permissions on /access/groups/<group>.
30261
- */
30262
- $get(param?: NoParams, options?: RequestOptions): Promise<AccessGroupsIndex[]>;
30263
- /**
30264
- * Create new group.
30265
- *
30266
- * `POST /access/groups`
30267
- *
30268
- * Permissions: Group.Allocate on /access/groups
30269
- */
30270
- $post(param: AccessGroupsCreateGroupParams, options?: RequestOptions): Promise<null>;
30271
- $(groupid: string): {
30432
+ termproxy: {
30272
30433
  /**
30273
- * Get group configuration.
30434
+ * Creates a VNC Shell proxy.
30274
30435
  *
30275
- * `GET /access/groups/{groupid}`
30436
+ * `POST /nodes/{node}/termproxy`
30276
30437
  *
30277
- * Permissions: Sys.Audit or Group.Allocate on /access/groups
30438
+ * Permissions: Sys.Console on /nodes/{node}
30278
30439
  */
30279
- $get(param?: NoParams, options?: RequestOptions): Promise<AccessGroupsReadGroup>;
30440
+ $post(param?: NodesTermproxyTermproxyParams, options?: RequestOptions): Promise<NodesTermproxyTermproxy>;
30441
+ };
30442
+ vncwebsocket: {
30280
30443
  /**
30281
- * Update group data.
30444
+ * Opens a websocket for VNC traffic.
30282
30445
  *
30283
- * `PUT /access/groups/{groupid}`
30446
+ * `GET /nodes/{node}/vncwebsocket`
30284
30447
  *
30285
- * Permissions: Group.Allocate on /access/groups
30448
+ * Permissions: You also need to pass a valid ticket (vncticket).
30286
30449
  */
30287
- $put(param?: AccessGroupsUpdateGroupParams, options?: RequestOptions): Promise<null>;
30450
+ $get(param: NodesVncwebsocketVncwebsocketParams, options?: RequestOptions): Promise<NodesVncwebsocketVncwebsocket>;
30451
+ };
30452
+ spiceshell: {
30288
30453
  /**
30289
- * Delete group.
30454
+ * Creates a SPICE shell.
30290
30455
  *
30291
- * `DELETE /access/groups/{groupid}`
30456
+ * `POST /nodes/{node}/spiceshell`
30292
30457
  *
30293
- * Permissions: Group.Allocate on /access/groups
30458
+ * Permissions: Sys.Console on /nodes/{node}
30294
30459
  */
30295
- $delete(param?: NoParams, options?: RequestOptions): Promise<null>;
30460
+ $post(param?: NodesSpiceshellSpiceshellParams, options?: RequestOptions): Promise<NodesSpiceshellSpiceshell>;
30296
30461
  };
30297
- };
30298
- roles: {
30299
- /**
30300
- * Role index.
30301
- *
30302
- * `GET /access/roles`
30303
- *
30304
- * Permissions: any authenticated user
30305
- */
30306
- $get(param?: NoParams, options?: RequestOptions): Promise<AccessRolesIndex[]>;
30307
- /**
30308
- * Create new role.
30309
- *
30310
- * `POST /access/roles`
30311
- *
30312
- * Permissions: Sys.Modify on /access
30313
- */
30314
- $post(param: AccessRolesCreateRoleParams, options?: RequestOptions): Promise<null>;
30315
- $(roleid: string): {
30462
+ dns: {
30316
30463
  /**
30317
- * Get role configuration.
30464
+ * Read DNS settings.
30318
30465
  *
30319
- * `GET /access/roles/{roleid}`
30466
+ * `GET /nodes/{node}/dns`
30320
30467
  *
30321
- * Permissions: any authenticated user
30468
+ * Permissions: Sys.Audit on /nodes/{node}
30322
30469
  */
30323
- $get(param?: NoParams, options?: RequestOptions): Promise<AccessRolesReadRole>;
30470
+ $get(param?: NoParams, options?: RequestOptions): Promise<NodesDnsDns>;
30324
30471
  /**
30325
- * Update an existing role.
30472
+ * Write DNS settings.
30326
30473
  *
30327
- * `PUT /access/roles/{roleid}`
30474
+ * `PUT /nodes/{node}/dns`
30328
30475
  *
30329
- * Permissions: Sys.Modify on /access
30476
+ * Permissions: Sys.Modify on /nodes/{node}
30330
30477
  */
30331
- $put(param?: AccessRolesUpdateRoleParams, options?: RequestOptions): Promise<null>;
30478
+ $put(param: NodesDnsUpdateDnsParams, options?: RequestOptions): Promise<null>;
30479
+ };
30480
+ time: {
30332
30481
  /**
30333
- * Delete role.
30482
+ * Read server time and time zone settings.
30334
30483
  *
30335
- * `DELETE /access/roles/{roleid}`
30484
+ * `GET /nodes/{node}/time`
30336
30485
  *
30337
- * Permissions: Sys.Modify on /access
30486
+ * Permissions: Sys.Audit on /nodes/{node}
30338
30487
  */
30339
- $delete(param?: NoParams, options?: RequestOptions): Promise<null>;
30488
+ $get(param?: NoParams, options?: RequestOptions): Promise<NodesTimeTime>;
30489
+ /**
30490
+ * Set time zone.
30491
+ *
30492
+ * `PUT /nodes/{node}/time`
30493
+ *
30494
+ * Permissions: Sys.Modify on /nodes/{node}
30495
+ */
30496
+ $put(param: NodesTimeSetTimezoneParams, options?: RequestOptions): Promise<null>;
30340
30497
  };
30341
- };
30342
- acl: {
30343
- /**
30344
- * Get Access Control List (ACLs).
30345
- *
30346
- * `GET /access/acl`
30347
- *
30348
- * Permissions: The returned list is restricted to objects where you have rights to modify permissions.
30349
- */
30350
- $get(param?: NoParams, options?: RequestOptions): Promise<AccessAclReadAcl[]>;
30351
- /**
30352
- * Update Access Control List (add or remove permissions).
30353
- *
30354
- * `PUT /access/acl`
30355
- *
30356
- * Permissions: ["perm-modify","{path}"]
30357
- */
30358
- $put(param: AccessAclUpdateAclParams, options?: RequestOptions): Promise<null>;
30359
- };
30360
- domains: {
30361
- /**
30362
- * Authentication domain index.
30363
- *
30364
- * `GET /access/domains`
30365
- *
30366
- * Permissions: Anyone can access that, because we need that list for the login box (before the user is authenticated).
30367
- */
30368
- $get(param?: NoParams, options?: RequestOptions): Promise<AccessDomainsIndex[]>;
30369
- /**
30370
- * Add an authentication server.
30371
- *
30372
- * `POST /access/domains`
30373
- *
30374
- * Permissions: Realm.Allocate on /access/realm
30375
- */
30376
- $post(param: AccessDomainsCreateParams, options?: RequestOptions): Promise<null>;
30377
- $(realm: string): {
30498
+ aplinfo: {
30499
+ /**
30500
+ * Get list of appliances.
30501
+ *
30502
+ * `GET /nodes/{node}/aplinfo`
30503
+ *
30504
+ * Permissions: any authenticated user
30505
+ */
30506
+ $get(param?: NoParams, options?: RequestOptions): Promise<Record<string, any>[]>;
30507
+ /**
30508
+ * Download appliance templates.
30509
+ *
30510
+ * `POST /nodes/{node}/aplinfo`
30511
+ *
30512
+ * Permissions: Datastore.AllocateTemplate on /storage/{storage}
30513
+ */
30514
+ $post(param: NodesAplinfoAplDownloadParams, options?: RequestOptions): Promise<string>;
30515
+ };
30516
+ "query-oci-repo-tags": {
30517
+ /**
30518
+ * List all tags for an OCI repository reference.
30519
+ *
30520
+ * `GET /nodes/{node}/query-oci-repo-tags`
30521
+ *
30522
+ * Permissions: Sys.AccessNetwork on /nodes/{node}
30523
+ */
30524
+ $get(param: NodesQueryOciRepoTagsQueryOciRepoTagsParams, options?: RequestOptions): Promise<string[]>;
30525
+ };
30526
+ "query-url-metadata": {
30378
30527
  /**
30379
- * Get auth server configuration.
30528
+ * Query metadata of an URL: file size, file name and mime type.
30380
30529
  *
30381
- * `GET /access/domains/{realm}`
30530
+ * `GET /nodes/{node}/query-url-metadata`
30382
30531
  *
30383
- * Permissions: Realm.Allocate or Sys.Audit on /access/realm
30532
+ * Permissions: Sys.Audit, Sys.Modify on / or Sys.AccessNetwork on /nodes/{node}
30384
30533
  */
30385
- $get(param?: NoParams, options?: RequestOptions): Promise<any>;
30534
+ $get(param: NodesQueryUrlMetadataQueryUrlMetadataParams, options?: RequestOptions): Promise<NodesQueryUrlMetadataQueryUrlMetadata>;
30535
+ };
30536
+ report: {
30386
30537
  /**
30387
- * Update authentication server settings.
30538
+ * Gather various systems information about a node
30388
30539
  *
30389
- * `PUT /access/domains/{realm}`
30540
+ * `GET /nodes/{node}/report`
30390
30541
  *
30391
- * Permissions: Realm.Allocate on /access/realm
30542
+ * Permissions: Sys.Audit on /nodes/{node}
30392
30543
  */
30393
- $put(param?: AccessDomainsUpdateParams, options?: RequestOptions): Promise<null>;
30544
+ $get(param?: NoParams, options?: RequestOptions): Promise<string>;
30545
+ };
30546
+ startall: {
30394
30547
  /**
30395
- * Delete an authentication server.
30548
+ * Start all VMs and containers located on this node (by default only those with onboot=1).
30396
30549
  *
30397
- * `DELETE /access/domains/{realm}`
30550
+ * `POST /nodes/{node}/startall`
30398
30551
  *
30399
- * Permissions: Realm.Allocate on /access/realm
30552
+ * Permissions: The 'VM.PowerMgmt' permission is required on '/' or on '/vms/<ID>' for each ID passed via the 'vms' parameter.
30400
30553
  */
30401
- $delete(param?: NoParams, options?: RequestOptions): Promise<null>;
30402
- sync: {
30403
- /**
30404
- * Syncs users and/or groups from the configured LDAP to user.cfg. NOTE: Synced groups will have the name 'name-$realm', so make sure those groups do not exist to prevent overwriting.
30405
- *
30406
- * `POST /access/domains/{realm}/sync`
30407
- *
30408
- * Permissions: 'Realm.AllocateUser' on '/access/realm/<realm>' and 'User.Modify' permissions to '/access/groups/'.
30409
- */
30410
- $post(param?: AccessDomainsSyncSyncParams, options?: RequestOptions): Promise<string>;
30411
- };
30554
+ $post(param?: NodesStartallStartallParams, options?: RequestOptions): Promise<string>;
30412
30555
  };
30413
- };
30414
- openid: {
30415
- /**
30416
- * Directory index.
30417
- *
30418
- * `GET /access/openid`
30419
- *
30420
- * Permissions: any authenticated user
30421
- */
30422
- $get(param?: NoParams, options?: RequestOptions): Promise<AccessOpenidIndex[]>;
30423
- "auth-url": {
30556
+ stopall: {
30424
30557
  /**
30425
- * Get the OpenId Authorization Url for the specified realm.
30558
+ * Stop all VMs and Containers.
30426
30559
  *
30427
- * `POST /access/openid/auth-url`
30560
+ * `POST /nodes/{node}/stopall`
30428
30561
  *
30429
- * Permissions: no authentication required
30562
+ * Permissions: The 'VM.PowerMgmt' permission is required on '/' or on '/vms/<ID>' for each ID passed via the 'vms' parameter.
30430
30563
  */
30431
- $post(param: AccessOpenidAuthUrlAuthUrlParams, options?: RequestOptions): Promise<string>;
30564
+ $post(param?: NodesStopallStopallParams, options?: RequestOptions): Promise<string>;
30432
30565
  };
30433
- login: {
30566
+ suspendall: {
30434
30567
  /**
30435
- * Verify OpenID authorization code and create a ticket.
30568
+ * Suspend all VMs.
30436
30569
  *
30437
- * `POST /access/openid/login`
30570
+ * `POST /nodes/{node}/suspendall`
30438
30571
  *
30439
- * Permissions: no authentication required
30572
+ * Permissions: The 'VM.PowerMgmt' permission is required on '/' or on '/vms/<ID>' for each ID passed via the 'vms' parameter. Additionally, you need 'VM.Config.Disk' on the '/vms/{vmid}' path and 'Datastore.AllocateSpace' for the configured state-storage(s)
30440
30573
  */
30441
- $post(param: AccessOpenidLoginLoginParams, options?: RequestOptions): Promise<AccessOpenidLoginLogin>;
30574
+ $post(param?: NodesSuspendallSuspendallParams, options?: RequestOptions): Promise<string>;
30442
30575
  };
30443
- };
30444
- tfa: {
30445
- /**
30446
- * List TFA configurations of users.
30447
- *
30448
- * `GET /access/tfa`
30449
- *
30450
- * Permissions: Returns all or just the logged-in user, depending on privileges.
30451
- */
30452
- $get(param?: NoParams, options?: RequestOptions): Promise<AccessTfaListTfa[]>;
30453
- $(userid: string): {
30576
+ migrateall: {
30454
30577
  /**
30455
- * List TFA configurations of users.
30578
+ * Migrate all VMs and Containers.
30456
30579
  *
30457
- * `GET /access/tfa/{userid}`
30580
+ * `POST /nodes/{node}/migrateall`
30458
30581
  *
30459
- * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify","Sys.Audit"]]
30582
+ * Permissions: The 'VM.Migrate' permission is required on '/' or on '/vms/<ID>' for each ID passed via the 'vms' parameter.
30460
30583
  */
30461
- $get(param?: NoParams, options?: RequestOptions): Promise<AccessTfaListUserTfa[]>;
30584
+ $post(param: NodesMigrateallMigrateallParams, options?: RequestOptions): Promise<string>;
30585
+ };
30586
+ hosts: {
30462
30587
  /**
30463
- * Add a TFA entry for a user.
30588
+ * Get the content of /etc/hosts.
30464
30589
  *
30465
- * `POST /access/tfa/{userid}`
30590
+ * `GET /nodes/{node}/hosts`
30466
30591
  *
30467
- * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify"]]
30592
+ * Permissions: Sys.Audit on /
30593
+ */
30594
+ $get(param?: NoParams, options?: RequestOptions): Promise<NodesHostsGetEtcHosts>;
30595
+ /**
30596
+ * Write /etc/hosts.
30468
30597
  *
30469
- * Not callable with an API token.
30598
+ * `POST /nodes/{node}/hosts`
30599
+ *
30600
+ * Permissions: Sys.Modify on /nodes/{node}
30470
30601
  */
30471
- $post(param: AccessTfaAddTfaEntryParams, options?: RequestOptions): Promise<AccessTfaAddTfaEntry>;
30472
- $(id: string): {
30473
- /**
30474
- * Fetch a requested TFA entry if present.
30475
- *
30476
- * `GET /access/tfa/{userid}/{id}`
30477
- *
30478
- * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify","Sys.Audit"]]
30479
- */
30480
- $get(param?: NoParams, options?: RequestOptions): Promise<AccessTfaGetTfaEntry>;
30481
- /**
30482
- * Add a TFA entry for a user.
30483
- *
30484
- * `PUT /access/tfa/{userid}/{id}`
30485
- *
30486
- * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify"]]
30487
- *
30488
- * Not callable with an API token.
30489
- */
30490
- $put(param?: AccessTfaUpdateTfaEntryParams, options?: RequestOptions): Promise<null>;
30491
- /**
30492
- * Delete a TFA entry by ID.
30493
- *
30494
- * `DELETE /access/tfa/{userid}/{id}`
30495
- *
30496
- * Permissions: ["userid-param","self"] or ["userid-group",["User.Modify"]]
30497
- *
30498
- * Not callable with an API token.
30499
- */
30500
- $delete(param?: AccessTfaDeleteTfaParams, options?: RequestOptions): Promise<null>;
30501
- };
30602
+ $post(param: NodesHostsWriteEtcHostsParams, options?: RequestOptions): Promise<null>;
30502
30603
  };
30503
30604
  };
30504
- ticket: {
30505
- /**
30506
- * Dummy. Useful for formatters which want to provide a login page.
30507
- *
30508
- * `GET /access/ticket`
30509
- *
30510
- * Permissions: no authentication required
30511
- */
30512
- $get(param?: NoParams, options?: RequestOptions): Promise<null>;
30513
- /**
30514
- * Create or verify authentication ticket.
30515
- *
30516
- * `POST /access/ticket`
30517
- *
30518
- * Permissions: You need to pass valid credientials.
30519
- *
30520
- * Not callable with an API token.
30521
- */
30522
- $post(param: AccessTicketCreateTicketParams, options?: RequestOptions): Promise<AccessTicketCreateTicket>;
30523
- };
30524
- vncticket: {
30525
- /**
30526
- * verify VNC authentication ticket.
30527
- *
30528
- * `POST /access/vncticket`
30529
- *
30530
- * Permissions: You need to pass valid credientials.
30531
- */
30532
- $post(param: AccessVncticketVerifyVncTicketParams, options?: RequestOptions): Promise<null>;
30533
- };
30534
- password: {
30535
- /**
30536
- * Change user password.
30537
- *
30538
- * `PUT /access/password`
30539
- *
30540
- * Permissions: Each user is allowed to change their own password. A user can change the password of another user if they have 'Realm.AllocateUser' (on the realm of user <userid>) and 'User.Modify' permission on /access/groups/<group> on a group where user <userid> is member of. For the PAM realm, a password change does not take effect cluster-wide, but only applies to the local node.
30541
- *
30542
- * Not callable with an API token.
30543
- */
30544
- $put(param: AccessPasswordChangePasswordParams, options?: RequestOptions): Promise<null>;
30545
- };
30546
- permissions: {
30605
+ };
30606
+ plugins: {
30607
+ /**
30608
+ * Directory index.
30609
+ *
30610
+ * `GET /plugins`
30611
+ *
30612
+ * Permissions: any authenticated user
30613
+ */
30614
+ $get(param?: NoParams, options?: RequestOptions): Promise<PluginsIndex[]>;
30615
+ storage: {
30547
30616
  /**
30548
- * Retrieve effective permissions of given user/token.
30617
+ * Directory index.
30549
30618
  *
30550
- * `GET /access/permissions`
30619
+ * `GET /plugins/storage`
30551
30620
  *
30552
- * Permissions: Each user/token is allowed to dump their own permissions (or that of owned tokens). A user can dump the permissions of another user or their tokens if they have 'Sys.Audit' permission on /access.
30621
+ * Permissions: any authenticated user
30553
30622
  */
30554
- $get(param?: AccessPermissionsPermissionsParams, options?: RequestOptions): Promise<Record<string, any>>;
30623
+ $get(param?: NoParams, options?: RequestOptions): Promise<PluginsStorageIndex[]>;
30624
+ plugin: {
30625
+ /**
30626
+ * List all available storage plugins and their metadata.
30627
+ *
30628
+ * `GET /plugins/storage/plugin`
30629
+ *
30630
+ * Permissions: any authenticated user
30631
+ */
30632
+ $get(param?: PluginsStoragePluginIndexParams, options?: RequestOptions): Promise<PluginsStoragePluginIndex[]>;
30633
+ $(type: string): {
30634
+ /**
30635
+ * Fetch metadata of a storage plugin.
30636
+ *
30637
+ * `GET /plugins/storage/plugin/{type}`
30638
+ *
30639
+ * Permissions: any authenticated user
30640
+ */
30641
+ $get(param?: NoParams, options?: RequestOptions): Promise<PluginsStoragePluginInfo>;
30642
+ };
30643
+ };
30555
30644
  };
30556
30645
  };
30557
30646
  pools: {
@@ -30614,6 +30703,50 @@ export declare namespace Proxmox {
30614
30703
  $delete(param?: NoParams, options?: RequestOptions): Promise<null>;
30615
30704
  };
30616
30705
  };
30706
+ storage: {
30707
+ /**
30708
+ * Storage index.
30709
+ *
30710
+ * `GET /storage`
30711
+ *
30712
+ * Permissions: Only list entries where you have 'Datastore.Audit' or 'Datastore.AllocateSpace' permissions on '/storage/<storage>'
30713
+ */
30714
+ $get(param?: StorageIndexParams, options?: RequestOptions): Promise<StorageIndex[]>;
30715
+ /**
30716
+ * Create a new storage.
30717
+ *
30718
+ * `POST /storage`
30719
+ *
30720
+ * Permissions: Datastore.Allocate on /storage
30721
+ */
30722
+ $post(param: StorageCreateParams, options?: RequestOptions): Promise<StorageCreate>;
30723
+ $(storage: string): {
30724
+ /**
30725
+ * Read storage configuration.
30726
+ *
30727
+ * `GET /storage/{storage}`
30728
+ *
30729
+ * Permissions: Datastore.Allocate on /storage/{storage}
30730
+ */
30731
+ $get(param?: NoParams, options?: RequestOptions): Promise<Record<string, any>>;
30732
+ /**
30733
+ * Update storage configuration.
30734
+ *
30735
+ * `PUT /storage/{storage}`
30736
+ *
30737
+ * Permissions: Datastore.Allocate on /storage
30738
+ */
30739
+ $put(param?: StorageUpdateParams, options?: RequestOptions): Promise<StorageUpdate>;
30740
+ /**
30741
+ * Delete storage configuration.
30742
+ *
30743
+ * `DELETE /storage/{storage}`
30744
+ *
30745
+ * Permissions: Datastore.Allocate on /storage
30746
+ */
30747
+ $delete(param?: NoParams, options?: RequestOptions): Promise<null>;
30748
+ };
30749
+ };
30617
30750
  version: {
30618
30751
  /**
30619
30752
  * API version details, including some parts of the global datacenter config.