diff --git a/api-viewer/apidata.js b/api-viewer/apidata.js index 7068f24..e28248a 100644 --- a/api-viewer/apidata.js +++ b/api-viewer/apidata.js @@ -3566,7 +3566,7 @@ const apiSchema = [ }, "bwlimit" : { "default" : 0, - "description" : "Limit I/O bandwidth (KBytes per second).", + "description" : "Limit I/O bandwidth (in KiB/s).", "minimum" : 0, "optional" : 1, "type" : "integer", @@ -3629,10 +3629,12 @@ const apiSchema = [ }, "exclude-path" : { "description" : "Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.", - "format" : "string-alist", + "items" : { + "type" : "string" + }, "optional" : 1, - "type" : "string", - "typetext" : "" + "type" : "array", + "typetext" : "" }, "id" : { "description" : "The job ID.", @@ -3911,7 +3913,7 @@ const apiSchema = [ }, "bwlimit" : { "default" : 0, - "description" : "Limit I/O bandwidth (KBytes per second).", + "description" : "Limit I/O bandwidth (in KiB/s).", "minimum" : 0, "optional" : 1, "type" : "integer", @@ -3968,10 +3970,12 @@ const apiSchema = [ }, "exclude-path" : { "description" : "Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.", - "format" : "string-alist", + "items" : { + "type" : "string" + }, "optional" : 1, - "type" : "string", - "typetext" : "" + "type" : "array", + "typetext" : "" }, "id" : { "description" : "Job ID (will be autogenerated).", @@ -7452,6 +7456,14 @@ const apiSchema = [ "type" : "integer", "typetext" : "" }, + "vxlan-port" : { + "description" : "Vxlan tunnel udp port (default 4789).", + "maximum" : 65536, + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - 65536)" + }, "zone" : { "description" : "The SDN zone object identifier.", "format" : "pve-sdn-zone-id", @@ -7730,6 +7742,14 @@ const apiSchema = [ "type" : "integer", "typetext" : "" }, + "vxlan-port" : { + "description" : "Vxlan tunnel udp port (default 4789).", + "maximum" : 65536, + "minimum" : 1, + "optional" : 1, + "type" : "integer", + "typetext" : " (1 - 65536)" + }, "zone" : { "description" : "The SDN zone object identifier.", "format" : "pve-sdn-zone-id", @@ -8892,7 +8912,7 @@ const apiSchema = [ "additionalProperties" : 0, "properties" : { "bwlimit" : { - "description" : "Set bandwidth/io limits various operations.", + "description" : "Set I/O bandwidth limit for various operations (in KiB/s).", "format" : { "clone" : { "description" : "bandwidth limit in KiB/s for cloning disks", @@ -12338,11 +12358,13 @@ const apiSchema = [ "additionalProperties" : 0, "properties" : { "command" : { - "description" : "The command as a list of program + arguments", - "format" : "string-alist", - "optional" : 1, - "type" : "string", - "typetext" : "" + "description" : "The command as a list of program + arguments.", + "items" : { + "description" : "A single part of the program + arguments.", + "format" : "string" + }, + "type" : "array", + "typetext" : "" }, "input-data" : { "description" : "Data to pass as 'input-data' to the guest. Usually treated as STDIN to 'command'.", @@ -36599,7 +36621,7 @@ const apiSchema = [ }, "bwlimit" : { "default" : 0, - "description" : "Limit I/O bandwidth (KBytes per second).", + "description" : "Limit I/O bandwidth (in KiB/s).", "minimum" : 0, "optional" : 1, "type" : "integer" @@ -36630,9 +36652,11 @@ const apiSchema = [ }, "exclude-path" : { "description" : "Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.", - "format" : "string-alist", + "items" : { + "type" : "string" + }, "optional" : 1, - "type" : "string" + "type" : "array" }, "ionice" : { "default" : 7, @@ -36850,7 +36874,7 @@ const apiSchema = [ }, "bwlimit" : { "default" : 0, - "description" : "Limit I/O bandwidth (KBytes per second).", + "description" : "Limit I/O bandwidth (in KiB/s).", "minimum" : 0, "optional" : 1, "type" : "integer", @@ -36884,10 +36908,12 @@ const apiSchema = [ }, "exclude-path" : { "description" : "Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.", - "format" : "string-alist", + "items" : { + "type" : "string" + }, "optional" : 1, - "type" : "string", - "typetext" : "" + "type" : "array", + "typetext" : "" }, "ionice" : { "default" : 7, @@ -37592,7 +37618,7 @@ const apiSchema = [ "properties" : { "force" : { "default" : 0, - "description" : "Always connect to server, even if we have up to date info inside local cache.", + "description" : "Always connect to server, even if local cache is still valid.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -40805,8 +40831,8 @@ const apiSchema = [ "tmpfilename" : { "description" : "The source file name. This parameter is usually set by the REST handler. You can only overwrite it when connecting to the trusted port on localhost.", "optional" : 1, - "type" : "string", - "typetext" : "" + "pattern" : "/var/tmp/pveupload-[0-9a-f]+", + "type" : "string" } } }, @@ -45321,7 +45347,7 @@ const apiSchema = [ "format" : "pve-command-batch", "type" : "string", "typetext" : "", - "verbose_description" : "JSON encoded array of commands, where each command is an object with the following properties:\n args: \n\n\t A set of parameter names and their values.\n\n method: (GET|POST|PUT|DELETE)\n\n\t A method related to the API endpoint (GET, POST etc.).\n\n path: \n\n\t A relative path to an API endpoint on this node.\n\n" + "verbose_description" : "JSON encoded array of commands, where each command is an object with the following properties:\n args: \n\t A set of parameter names and their values.\n\n method: (GET|POST|PUT|DELETE)\n\t A method related to the API endpoint (GET, POST etc.).\n\n path: \n\t A relative path to an API endpoint on this node.\n\n" }, "node" : { "description" : "The cluster node name.", @@ -46833,7 +46859,7 @@ const apiSchema = [ "typetext" : "" }, "bwlimit" : { - "description" : "Set bandwidth/io limits various operations.", + "description" : "Set I/O bandwidth limit for various operations (in KiB/s).", "format" : { "clone" : { "description" : "bandwidth limit in KiB/s for cloning disks", @@ -46901,6 +46927,20 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "create-base-path" : { + "default" : "yes", + "description" : "Create the base directory if it doesn't exist.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "create-subdirs" : { + "default" : "yes", + "description" : "Populate the directory with the default structure.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "data-pool" : { "description" : "Data Pool (for erasure coding only)", "optional" : 1, @@ -47015,7 +47055,7 @@ const apiSchema = [ }, "mkdir" : { "default" : "yes", - "description" : "Create the directory if it doesn't exist.", + "description" : "Create the directory if it doesn't exist and populate it with default sub-dirs. NOTE: Deprecated, use the 'create-base-path' and 'create-subdirs' options instead.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -47340,7 +47380,7 @@ const apiSchema = [ "typetext" : "" }, "bwlimit" : { - "description" : "Set bandwidth/io limits various operations.", + "description" : "Set I/O bandwidth limit for various operations (in KiB/s).", "format" : { "clone" : { "description" : "bandwidth limit in KiB/s for cloning disks", @@ -47408,6 +47448,20 @@ const apiSchema = [ "type" : "string", "typetext" : "" }, + "create-base-path" : { + "default" : "yes", + "description" : "Create the base directory if it doesn't exist.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, + "create-subdirs" : { + "default" : "yes", + "description" : "Populate the directory with the default structure.", + "optional" : 1, + "type" : "boolean", + "typetext" : "" + }, "data-pool" : { "description" : "Data Pool (for erasure coding only)", "optional" : 1, @@ -47526,7 +47580,7 @@ const apiSchema = [ }, "mkdir" : { "default" : "yes", - "description" : "Create the directory if it doesn't exist.", + "description" : "Create the directory if it doesn't exist and populate it with default sub-dirs. NOTE: Deprecated, use the 'create-base-path' and 'create-subdirs' options instead.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -47929,6 +47983,43 @@ const apiSchema = [ "path" : "/access/users/{userid}/tfa", "text" : "tfa" }, + { + "info" : { + "PUT" : { + "allowtoken" : 1, + "description" : "Unlock a user's TFA authentication.", + "method" : "PUT", + "name" : "unlock_tfa", + "parameters" : { + "additionalProperties" : 0, + "properties" : { + "userid" : { + "description" : "Full User ID, in the `name@realm` format.", + "format" : "pve-userid", + "maxLength" : 64, + "type" : "string", + "typetext" : "" + } + } + }, + "permissions" : { + "check" : [ + "userid-group", + [ + "User.Modify" + ] + ] + }, + "protected" : 1, + "returns" : { + "type" : "boolean" + } + } + }, + "leaf" : 1, + "path" : "/access/users/{userid}/unlock-tfa", + "text" : "unlock-tfa" + }, { "children" : [ { @@ -48553,6 +48644,7 @@ const apiSchema = [ "description" : "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.", "user" : "all" }, + "protected" : 1, "returns" : { "items" : { "properties" : { @@ -48601,6 +48693,11 @@ const apiSchema = [ "optional" : 1, "type" : "string" }, + "tfa-locked-until" : { + "description" : "Contains a timestamp until when a user is locked out of 2nd factors.", + "optional" : 1, + "type" : "integer" + }, "tokens" : { "items" : { "properties" : { @@ -48632,6 +48729,11 @@ const apiSchema = [ "optional" : 1, "type" : "array" }, + "totp-locked" : { + "description" : "True if the user is currently locked out of TOTP factors.", + "optional" : 1, + "type" : "boolean" + }, "userid" : { "description" : "Full User ID, in the `name@realm` format.", "format" : "pve-userid", @@ -50786,6 +50888,16 @@ const apiSchema = [ }, "type" : "array" }, + "tfa-locked-until" : { + "description" : "Contains a timestamp until when a user is locked out of 2nd factors.", + "optional" : 1, + "type" : "integer" + }, + "totp-locked" : { + "description" : "True if the user is currently locked out of TOTP factors.", + "optional" : 1, + "type" : "boolean" + }, "userid" : { "description" : "User this entry belongs to.", "type" : "string" @@ -50795,34 +50907,6 @@ const apiSchema = [ }, "type" : "array" } - }, - "POST" : { - "allowtoken" : 0, - "description" : "Finish a u2f challenge.", - "method" : "POST", - "name" : "verify_tfa", - "parameters" : { - "additionalProperties" : 0, - "properties" : { - "response" : { - "description" : "The response to the current authentication challenge.", - "type" : "string", - "typetext" : "" - } - } - }, - "permissions" : { - "user" : "all" - }, - "protected" : 1, - "returns" : { - "properties" : { - "ticket" : { - "type" : "string" - } - }, - "type" : "object" - } } }, "leaf" : 0, @@ -50855,8 +50939,8 @@ const apiSchema = [ "additionalProperties" : 0, "properties" : { "new-format" : { - "default" : 0, - "description" : "With webauthn the format of half-authenticated tickts changed. New clients should pass 1 here and not worry about the old format. The old format is deprecated and will be retired with PVE-8.0", + "default" : 1, + "description" : "This parameter is now ignored and assumed to be 1.", "optional" : 1, "type" : "boolean", "typetext" : "" @@ -51348,6 +51432,7 @@ const apiSchema = [ }, "repoid" : { "description" : "The short git revision from which this version was build.", + "pattern" : "[0-9a-fA-F]{8,64}", "type" : "string" }, "version" : { diff --git a/datacenter.cfg.5-opts.adoc b/datacenter.cfg.5-opts.adoc index ba0f725..59cedf7 100644 --- a/datacenter.cfg.5-opts.adoc +++ b/datacenter.cfg.5-opts.adoc @@ -1,6 +1,6 @@ `bwlimit`: `[clone=] [,default=] [,migration=] [,move=] [,restore=]` :: -Set bandwidth/io limits various operations. +Set I/O bandwidth limit for various operations (in KiB/s). `clone`=`` ;; diff --git a/pveceph.1-synopsis.adoc b/pveceph.1-synopsis.adoc index 28f48f8..2929461 100644 --- a/pveceph.1-synopsis.adoc +++ b/pveceph.1-synopsis.adoc @@ -118,11 +118,11 @@ Install ceph related packages. Allow experimental versions. Use with care! -`--test-repository` `` ('default =' `0`):: +`--repository` `` ('default =' `enterprise`):: -Use the test, not the main repository. Use with care! +Ceph repository to use. -`--version` `` ('default =' `pacific`):: +`--version` `` ('default =' `quincy`):: Ceph version to install. diff --git a/pvesm.1-synopsis.adoc b/pvesm.1-synopsis.adoc index c0cddec..d1d8dc9 100644 --- a/pvesm.1-synopsis.adoc +++ b/pvesm.1-synopsis.adoc @@ -26,7 +26,7 @@ block size `--bwlimit` `[clone=] [,default=] [,migration=] [,move=] [,restore=]` :: -Set bandwidth/io limits various operations. +Set I/O bandwidth limit for various operations (in KiB/s). `--comstar_hg` `` :: @@ -46,6 +46,14 @@ NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. Overrides for default content type directories. +`--create-base-path` `` ('default =' `yes`):: + +Create the base directory if it doesn't exist. + +`--create-subdirs` `` ('default =' `yes`):: + +Populate the directory with the default structure. + `--data-pool` `` :: Data Pool (for erasure coding only) @@ -120,7 +128,7 @@ Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. `--mkdir` `` ('default =' `yes`):: -Create the directory if it doesn't exist. +Create the directory if it doesn't exist and populate it with default sub-dirs. NOTE: Deprecated, use the 'create-base-path' and 'create-subdirs' options instead. `--monhost` `` :: @@ -582,7 +590,7 @@ block size `--bwlimit` `[clone=] [,default=] [,migration=] [,move=] [,restore=]` :: -Set bandwidth/io limits various operations. +Set I/O bandwidth limit for various operations (in KiB/s). `--comstar_hg` `` :: @@ -602,6 +610,14 @@ NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. Overrides for default content type directories. +`--create-base-path` `` ('default =' `yes`):: + +Create the base directory if it doesn't exist. + +`--create-subdirs` `` ('default =' `yes`):: + +Populate the directory with the default structure. + `--data-pool` `` :: Data Pool (for erasure coding only) @@ -672,7 +688,7 @@ Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. `--mkdir` `` ('default =' `yes`):: -Create the directory if it doesn't exist. +Create the directory if it doesn't exist and populate it with default sub-dirs. NOTE: Deprecated, use the 'create-base-path' and 'create-subdirs' options instead. `--monhost` `` :: diff --git a/pvesubscription.1-synopsis.adoc b/pvesubscription.1-synopsis.adoc index 64db530..5984633 100644 --- a/pvesubscription.1-synopsis.adoc +++ b/pvesubscription.1-synopsis.adoc @@ -42,6 +42,6 @@ Update subscription info. `--force` `` ('default =' `0`):: -Always connect to server, even if we have up to date info inside local cache. +Always connect to server, even if local cache is still valid. diff --git a/pveum.1-synopsis.adoc b/pveum.1-synopsis.adoc index 9a354ae..dad42b6 100644 --- a/pveum.1-synopsis.adoc +++ b/pveum.1-synopsis.adoc @@ -596,9 +596,9 @@ Create or verify authentication ticket. User name -`--new-format` `` ('default =' `0`):: +`--new-format` `` ('default =' `1`):: -With webauthn the format of half-authenticated tickts changed. New clients should pass 1 here and not worry about the old format. The old format is deprecated and will be retired with PVE-8.0 +This parameter is now ignored and assumed to be 1. `--otp` `` :: @@ -758,6 +758,22 @@ Full User ID, in the `name@realm` format. The TFA ID, if none provided, all TFA entries will be deleted. +*pveum user tfa list* `[]` + +List TFA entries. + +``: `` :: + +Full User ID, in the `name@realm` format. + +*pveum user tfa unlock* `` + +Unlock a user's TFA authentication. + +``: `` :: + +Full User ID, in the `name@realm` format. + *pveum user token add* ` ` `[OPTIONS]` `[FORMAT_OPTIONS]` Generate a new API token for a specific user. NOTE: returns API token diff --git a/qmrestore.1-synopsis.adoc b/qmrestore.1-synopsis.adoc index e57e4d2..97bb462 100644 --- a/qmrestore.1-synopsis.adoc +++ b/qmrestore.1-synopsis.adoc @@ -14,7 +14,7 @@ The (unique) ID of the VM. `--bwlimit` ` (0 - N)` :: -Override i/o bandwidth limit (in KiB/s). +Override I/O bandwidth limit (in KiB/s). `--force` `` :: diff --git a/vzdump.1-synopsis.adoc b/vzdump.1-synopsis.adoc index 5434a52..29f5d4a 100644 --- a/vzdump.1-synopsis.adoc +++ b/vzdump.1-synopsis.adoc @@ -14,7 +14,7 @@ Backup all known guest systems on this host. `--bwlimit` ` (0 - N)` ('default =' `0`):: -Limit I/O bandwidth (KBytes per second). +Limit I/O bandwidth (in KiB/s). `--compress` `<0 | 1 | gzip | lzo | zstd>` ('default =' `0`):: @@ -28,7 +28,7 @@ Store resulting files to specified directory. Exclude specified guest systems (assumes --all) -`--exclude-path` `` :: +`--exclude-path` `` :: Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. diff --git a/vzdump.conf.5-opts.adoc b/vzdump.conf.5-opts.adoc index 58b5167..1f6cb60 100644 --- a/vzdump.conf.5-opts.adoc +++ b/vzdump.conf.5-opts.adoc @@ -1,6 +1,6 @@ `bwlimit`: ` (0 - N)` ('default =' `0`):: -Limit I/O bandwidth (KBytes per second). +Limit I/O bandwidth (in KiB/s). `compress`: `<0 | 1 | gzip | lzo | zstd>` ('default =' `0`):: @@ -10,7 +10,7 @@ Compress dump file. Store resulting files to specified directory. -`exclude-path`: `` :: +`exclude-path`: `` :: Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.