},
"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",
},
"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" : "<string>"
+ "type" : "array",
+ "typetext" : "<array>"
},
"id" : {
"description" : "The job ID.",
},
"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",
},
"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" : "<string>"
+ "type" : "array",
+ "typetext" : "<array>"
},
"id" : {
"description" : "Job ID (will be autogenerated).",
"type" : "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" : {
"description" : "The SDN zone object identifier.",
"format" : "pve-sdn-zone-id",
"type" : "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" : {
"description" : "The SDN zone object identifier.",
"format" : "pve-sdn-zone-id",
"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",
"additionalProperties" : 0,
"properties" : {
"command" : {
- "description" : "The command as a list of program + arguments",
- "format" : "string-alist",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
+ "description" : "The command as a list of program + arguments.",
+ "items" : {
+ "description" : "A single part of the program + arguments.",
+ "format" : "string"
+ },
+ "type" : "array",
+ "typetext" : "<array>"
},
"input-data" : {
"description" : "Data to pass as 'input-data' to the guest. Usually treated as STDIN to 'command'.",
},
"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"
},
"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,
},
"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",
},
"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" : "<string>"
+ "type" : "array",
+ "typetext" : "<array>"
},
"ionice" : {
"default" : 7,
"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" : "<boolean>"
"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" : "<string>"
+ "pattern" : "/var/tmp/pveupload-[0-9a-f]+",
+ "type" : "string"
}
}
},
"format" : "pve-command-batch",
"type" : "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" : {
"description" : "The cluster node name.",
"typetext" : "<string>"
},
"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",
"type" : "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" : {
"description" : "Data Pool (for erasure coding only)",
"optional" : 1,
},
"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" : "<boolean>"
"typetext" : "<string>"
},
"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",
"type" : "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" : {
"description" : "Data Pool (for erasure coding only)",
"optional" : 1,
},
"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" : "<boolean>"
"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" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "userid-group",
+ [
+ "User.Modify"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "returns" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/access/users/{userid}/unlock-tfa",
+ "text" : "unlock-tfa"
+ },
{
"children" : [
{
"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" : {
"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" : {
"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",
},
"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"
},
"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,
"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" : "<boolean>"
},
"repoid" : {
"description" : "The short git revision from which this version was build.",
+ "pattern" : "[0-9a-fA-F]{8,64}",
"type" : "string"
},
"version" : {
projects / pve-docs.git / blobdiff