update static/schema information

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2023-06-07 17:46:30 +02:00
parent e712afa605
commit 4a407cfdb9
9 changed files with 192 additions and 75 deletions

View File

@ -3566,7 +3566,7 @@ const apiSchema = [
}, },
"bwlimit" : { "bwlimit" : {
"default" : 0, "default" : 0,
"description" : "Limit I/O bandwidth (KBytes per second).", "description" : "Limit I/O bandwidth (in KiB/s).",
"minimum" : 0, "minimum" : 0,
"optional" : 1, "optional" : 1,
"type" : "integer", "type" : "integer",
@ -3629,10 +3629,12 @@ const apiSchema = [
}, },
"exclude-path" : { "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.", "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, "optional" : 1,
"type" : "string", "type" : "array",
"typetext" : "<string>" "typetext" : "<array>"
}, },
"id" : { "id" : {
"description" : "The job ID.", "description" : "The job ID.",
@ -3911,7 +3913,7 @@ const apiSchema = [
}, },
"bwlimit" : { "bwlimit" : {
"default" : 0, "default" : 0,
"description" : "Limit I/O bandwidth (KBytes per second).", "description" : "Limit I/O bandwidth (in KiB/s).",
"minimum" : 0, "minimum" : 0,
"optional" : 1, "optional" : 1,
"type" : "integer", "type" : "integer",
@ -3968,10 +3970,12 @@ const apiSchema = [
}, },
"exclude-path" : { "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.", "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, "optional" : 1,
"type" : "string", "type" : "array",
"typetext" : "<string>" "typetext" : "<array>"
}, },
"id" : { "id" : {
"description" : "Job ID (will be autogenerated).", "description" : "Job ID (will be autogenerated).",
@ -7452,6 +7456,14 @@ const apiSchema = [
"type" : "integer", "type" : "integer",
"typetext" : "<integer>" "typetext" : "<integer>"
}, },
"vxlan-port" : {
"description" : "Vxlan tunnel udp port (default 4789).",
"maximum" : 65536,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
"typetext" : "<integer> (1 - 65536)"
},
"zone" : { "zone" : {
"description" : "The SDN zone object identifier.", "description" : "The SDN zone object identifier.",
"format" : "pve-sdn-zone-id", "format" : "pve-sdn-zone-id",
@ -7730,6 +7742,14 @@ const apiSchema = [
"type" : "integer", "type" : "integer",
"typetext" : "<integer>" "typetext" : "<integer>"
}, },
"vxlan-port" : {
"description" : "Vxlan tunnel udp port (default 4789).",
"maximum" : 65536,
"minimum" : 1,
"optional" : 1,
"type" : "integer",
"typetext" : "<integer> (1 - 65536)"
},
"zone" : { "zone" : {
"description" : "The SDN zone object identifier.", "description" : "The SDN zone object identifier.",
"format" : "pve-sdn-zone-id", "format" : "pve-sdn-zone-id",
@ -8892,7 +8912,7 @@ const apiSchema = [
"additionalProperties" : 0, "additionalProperties" : 0,
"properties" : { "properties" : {
"bwlimit" : { "bwlimit" : {
"description" : "Set bandwidth/io limits various operations.", "description" : "Set I/O bandwidth limit for various operations (in KiB/s).",
"format" : { "format" : {
"clone" : { "clone" : {
"description" : "bandwidth limit in KiB/s for cloning disks", "description" : "bandwidth limit in KiB/s for cloning disks",
@ -12338,11 +12358,13 @@ const apiSchema = [
"additionalProperties" : 0, "additionalProperties" : 0,
"properties" : { "properties" : {
"command" : { "command" : {
"description" : "The command as a list of program + arguments", "description" : "The command as a list of program + arguments.",
"format" : "string-alist", "items" : {
"optional" : 1, "description" : "A single part of the program + arguments.",
"type" : "string", "format" : "string"
"typetext" : "<string>" },
"type" : "array",
"typetext" : "<array>"
}, },
"input-data" : { "input-data" : {
"description" : "Data to pass as 'input-data' to the guest. Usually treated as STDIN to 'command'.", "description" : "Data to pass as 'input-data' to the guest. Usually treated as STDIN to 'command'.",
@ -36599,7 +36621,7 @@ const apiSchema = [
}, },
"bwlimit" : { "bwlimit" : {
"default" : 0, "default" : 0,
"description" : "Limit I/O bandwidth (KBytes per second).", "description" : "Limit I/O bandwidth (in KiB/s).",
"minimum" : 0, "minimum" : 0,
"optional" : 1, "optional" : 1,
"type" : "integer" "type" : "integer"
@ -36630,10 +36652,12 @@ const apiSchema = [
}, },
"exclude-path" : { "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.", "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" : {
"optional" : 1,
"type" : "string" "type" : "string"
}, },
"optional" : 1,
"type" : "array"
},
"ionice" : { "ionice" : {
"default" : 7, "default" : 7,
"description" : "Set CFQ ionice priority.", "description" : "Set CFQ ionice priority.",
@ -36850,7 +36874,7 @@ const apiSchema = [
}, },
"bwlimit" : { "bwlimit" : {
"default" : 0, "default" : 0,
"description" : "Limit I/O bandwidth (KBytes per second).", "description" : "Limit I/O bandwidth (in KiB/s).",
"minimum" : 0, "minimum" : 0,
"optional" : 1, "optional" : 1,
"type" : "integer", "type" : "integer",
@ -36884,10 +36908,12 @@ const apiSchema = [
}, },
"exclude-path" : { "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.", "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, "optional" : 1,
"type" : "string", "type" : "array",
"typetext" : "<string>" "typetext" : "<array>"
}, },
"ionice" : { "ionice" : {
"default" : 7, "default" : 7,
@ -37592,7 +37618,7 @@ const apiSchema = [
"properties" : { "properties" : {
"force" : { "force" : {
"default" : 0, "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, "optional" : 1,
"type" : "boolean", "type" : "boolean",
"typetext" : "<boolean>" "typetext" : "<boolean>"
@ -40805,8 +40831,8 @@ const apiSchema = [
"tmpfilename" : { "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.", "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, "optional" : 1,
"type" : "string", "pattern" : "/var/tmp/pveupload-[0-9a-f]+",
"typetext" : "<string>" "type" : "string"
} }
} }
}, },
@ -45321,7 +45347,7 @@ const apiSchema = [
"format" : "pve-command-batch", "format" : "pve-command-batch",
"type" : "string", "type" : "string",
"typetext" : "<string>", "typetext" : "<string>",
"verbose_description" : "JSON encoded array of commands, where each command is an object with the following properties:\n args: <object>\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: <string>\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: <object>\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: <string>\n\t A relative path to an API endpoint on this node.\n\n"
}, },
"node" : { "node" : {
"description" : "The cluster node name.", "description" : "The cluster node name.",
@ -46833,7 +46859,7 @@ const apiSchema = [
"typetext" : "<string>" "typetext" : "<string>"
}, },
"bwlimit" : { "bwlimit" : {
"description" : "Set bandwidth/io limits various operations.", "description" : "Set I/O bandwidth limit for various operations (in KiB/s).",
"format" : { "format" : {
"clone" : { "clone" : {
"description" : "bandwidth limit in KiB/s for cloning disks", "description" : "bandwidth limit in KiB/s for cloning disks",
@ -46901,6 +46927,20 @@ const apiSchema = [
"type" : "string", "type" : "string",
"typetext" : "<string>" "typetext" : "<string>"
}, },
"create-base-path" : {
"default" : "yes",
"description" : "Create the base directory if it doesn't exist.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"create-subdirs" : {
"default" : "yes",
"description" : "Populate the directory with the default structure.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"data-pool" : { "data-pool" : {
"description" : "Data Pool (for erasure coding only)", "description" : "Data Pool (for erasure coding only)",
"optional" : 1, "optional" : 1,
@ -47015,7 +47055,7 @@ const apiSchema = [
}, },
"mkdir" : { "mkdir" : {
"default" : "yes", "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, "optional" : 1,
"type" : "boolean", "type" : "boolean",
"typetext" : "<boolean>" "typetext" : "<boolean>"
@ -47340,7 +47380,7 @@ const apiSchema = [
"typetext" : "<string>" "typetext" : "<string>"
}, },
"bwlimit" : { "bwlimit" : {
"description" : "Set bandwidth/io limits various operations.", "description" : "Set I/O bandwidth limit for various operations (in KiB/s).",
"format" : { "format" : {
"clone" : { "clone" : {
"description" : "bandwidth limit in KiB/s for cloning disks", "description" : "bandwidth limit in KiB/s for cloning disks",
@ -47408,6 +47448,20 @@ const apiSchema = [
"type" : "string", "type" : "string",
"typetext" : "<string>" "typetext" : "<string>"
}, },
"create-base-path" : {
"default" : "yes",
"description" : "Create the base directory if it doesn't exist.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"create-subdirs" : {
"default" : "yes",
"description" : "Populate the directory with the default structure.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"data-pool" : { "data-pool" : {
"description" : "Data Pool (for erasure coding only)", "description" : "Data Pool (for erasure coding only)",
"optional" : 1, "optional" : 1,
@ -47526,7 +47580,7 @@ const apiSchema = [
}, },
"mkdir" : { "mkdir" : {
"default" : "yes", "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, "optional" : 1,
"type" : "boolean", "type" : "boolean",
"typetext" : "<boolean>" "typetext" : "<boolean>"
@ -47929,6 +47983,43 @@ const apiSchema = [
"path" : "/access/users/{userid}/tfa", "path" : "/access/users/{userid}/tfa",
"text" : "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" : "<string>"
}
}
},
"permissions" : {
"check" : [
"userid-group",
[
"User.Modify"
]
]
},
"protected" : 1,
"returns" : {
"type" : "boolean"
}
}
},
"leaf" : 1,
"path" : "/access/users/{userid}/unlock-tfa",
"text" : "unlock-tfa"
},
{ {
"children" : [ "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.", "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" "user" : "all"
}, },
"protected" : 1,
"returns" : { "returns" : {
"items" : { "items" : {
"properties" : { "properties" : {
@ -48601,6 +48693,11 @@ const apiSchema = [
"optional" : 1, "optional" : 1,
"type" : "string" "type" : "string"
}, },
"tfa-locked-until" : {
"description" : "Contains a timestamp until when a user is locked out of 2nd factors.",
"optional" : 1,
"type" : "integer"
},
"tokens" : { "tokens" : {
"items" : { "items" : {
"properties" : { "properties" : {
@ -48632,6 +48729,11 @@ const apiSchema = [
"optional" : 1, "optional" : 1,
"type" : "array" "type" : "array"
}, },
"totp-locked" : {
"description" : "True if the user is currently locked out of TOTP factors.",
"optional" : 1,
"type" : "boolean"
},
"userid" : { "userid" : {
"description" : "Full User ID, in the `name@realm` format.", "description" : "Full User ID, in the `name@realm` format.",
"format" : "pve-userid", "format" : "pve-userid",
@ -50786,6 +50888,16 @@ const apiSchema = [
}, },
"type" : "array" "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" : { "userid" : {
"description" : "User this entry belongs to.", "description" : "User this entry belongs to.",
"type" : "string" "type" : "string"
@ -50795,34 +50907,6 @@ const apiSchema = [
}, },
"type" : "array" "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" : "<string>"
}
}
},
"permissions" : {
"user" : "all"
},
"protected" : 1,
"returns" : {
"properties" : {
"ticket" : {
"type" : "string"
}
},
"type" : "object"
}
} }
}, },
"leaf" : 0, "leaf" : 0,
@ -50855,8 +50939,8 @@ const apiSchema = [
"additionalProperties" : 0, "additionalProperties" : 0,
"properties" : { "properties" : {
"new-format" : { "new-format" : {
"default" : 0, "default" : 1,
"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", "description" : "This parameter is now ignored and assumed to be 1.",
"optional" : 1, "optional" : 1,
"type" : "boolean", "type" : "boolean",
"typetext" : "<boolean>" "typetext" : "<boolean>"
@ -51348,6 +51432,7 @@ const apiSchema = [
}, },
"repoid" : { "repoid" : {
"description" : "The short git revision from which this version was build.", "description" : "The short git revision from which this version was build.",
"pattern" : "[0-9a-fA-F]{8,64}",
"type" : "string" "type" : "string"
}, },
"version" : { "version" : {

View File

@ -1,6 +1,6 @@
`bwlimit`: `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` :: `bwlimit`: `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
Set bandwidth/io limits various operations. Set I/O bandwidth limit for various operations (in KiB/s).
`clone`=`<LIMIT>` ;; `clone`=`<LIMIT>` ;;

View File

@ -118,11 +118,11 @@ Install ceph related packages.
Allow experimental versions. Use with care! Allow experimental versions. Use with care!
`--test-repository` `<boolean>` ('default =' `0`):: `--repository` `<enterprise | no-subscription | test>` ('default =' `enterprise`)::
Use the test, not the main repository. Use with care! Ceph repository to use.
`--version` `<octopus | pacific | quincy>` ('default =' `pacific`):: `--version` `<quincy>` ('default =' `quincy`)::
Ceph version to install. Ceph version to install.

View File

@ -26,7 +26,7 @@ block size
`--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` :: `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
Set bandwidth/io limits various operations. Set I/O bandwidth limit for various operations (in KiB/s).
`--comstar_hg` `<string>` :: `--comstar_hg` `<string>` ::
@ -46,6 +46,14 @@ NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
Overrides for default content type directories. Overrides for default content type directories.
`--create-base-path` `<boolean>` ('default =' `yes`)::
Create the base directory if it doesn't exist.
`--create-subdirs` `<boolean>` ('default =' `yes`)::
Populate the directory with the default structure.
`--data-pool` `<string>` :: `--data-pool` `<string>` ::
Data Pool (for erasure coding only) Data Pool (for erasure coding only)
@ -120,7 +128,7 @@ Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM.
`--mkdir` `<boolean>` ('default =' `yes`):: `--mkdir` `<boolean>` ('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` `<string>` :: `--monhost` `<string>` ::
@ -582,7 +590,7 @@ block size
`--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` :: `--bwlimit` `[clone=<LIMIT>] [,default=<LIMIT>] [,migration=<LIMIT>] [,move=<LIMIT>] [,restore=<LIMIT>]` ::
Set bandwidth/io limits various operations. Set I/O bandwidth limit for various operations (in KiB/s).
`--comstar_hg` `<string>` :: `--comstar_hg` `<string>` ::
@ -602,6 +610,14 @@ NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs.
Overrides for default content type directories. Overrides for default content type directories.
`--create-base-path` `<boolean>` ('default =' `yes`)::
Create the base directory if it doesn't exist.
`--create-subdirs` `<boolean>` ('default =' `yes`)::
Populate the directory with the default structure.
`--data-pool` `<string>` :: `--data-pool` `<string>` ::
Data Pool (for erasure coding only) Data Pool (for erasure coding only)
@ -672,7 +688,7 @@ Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM.
`--mkdir` `<boolean>` ('default =' `yes`):: `--mkdir` `<boolean>` ('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` `<string>` :: `--monhost` `<string>` ::

View File

@ -42,6 +42,6 @@ Update subscription info.
`--force` `<boolean>` ('default =' `0`):: `--force` `<boolean>` ('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.

View File

@ -596,9 +596,9 @@ Create or verify authentication ticket.
User name User name
`--new-format` `<boolean>` ('default =' `0`):: `--new-format` `<boolean>` ('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` `<string>` :: `--otp` `<string>` ::
@ -758,6 +758,22 @@ Full User ID, in the `name@realm` format.
The TFA ID, if none provided, all TFA entries will be deleted. The TFA ID, if none provided, all TFA entries will be deleted.
*pveum user tfa list* `[<userid>]`
List TFA entries.
`<userid>`: `<string>` ::
Full User ID, in the `name@realm` format.
*pveum user tfa unlock* `<userid>`
Unlock a user's TFA authentication.
`<userid>`: `<string>` ::
Full User ID, in the `name@realm` format.
*pveum user token add* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]` *pveum user token add* `<userid> <tokenid>` `[OPTIONS]` `[FORMAT_OPTIONS]`
Generate a new API token for a specific user. NOTE: returns API token Generate a new API token for a specific user. NOTE: returns API token

View File

@ -14,7 +14,7 @@ The (unique) ID of the VM.
`--bwlimit` `<number> (0 - N)` :: `--bwlimit` `<number> (0 - N)` ::
Override i/o bandwidth limit (in KiB/s). Override I/O bandwidth limit (in KiB/s).
`--force` `<boolean>` :: `--force` `<boolean>` ::

View File

@ -14,7 +14,7 @@ Backup all known guest systems on this host.
`--bwlimit` `<integer> (0 - N)` ('default =' `0`):: `--bwlimit` `<integer> (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`):: `--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 specified guest systems (assumes --all)
`--exclude-path` `<string>` :: `--exclude-path` `<array>` ::
Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.

View File

@ -1,6 +1,6 @@
`bwlimit`: `<integer> (0 - N)` ('default =' `0`):: `bwlimit`: `<integer> (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`):: `compress`: `<0 | 1 | gzip | lzo | zstd>` ('default =' `0`)::
@ -10,7 +10,7 @@ Compress dump file.
Store resulting files to specified directory. Store resulting files to specified directory.
`exclude-path`: `<string>` :: `exclude-path`: `<array>` ::
Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.