From 2539129224ef8cfda120e74bdddcec8d48e8ae65 Mon Sep 17 00:00:00 2001 From: Ralf Grubenmann Date: Fri, 8 Nov 2024 11:29:05 +0100 Subject: [PATCH] chore: update rclone schema --- .../renku_data_services/storage/README.md | 2 +- .../renku_data_services/storage/rclone.py | 6 +- .../storage/rclone_schema.autogenerated.json | 15382 +++++++++------- 3 files changed, 8722 insertions(+), 6668 deletions(-) diff --git a/components/renku_data_services/storage/README.md b/components/renku_data_services/storage/README.md index ed8b5685b..49639e6ec 100644 --- a/components/renku_data_services/storage/README.md +++ b/components/renku_data_services/storage/README.md @@ -2,4 +2,4 @@ Contains APIspec generated schemas for cloud storage functionality. -To create the RClone schema, run `rclone config providers > rclone_schema.autogenerated.json`. +To create the RClone schema, run `rclone config providers|jq -r "sort_by(.Name)" --indent 4 > rclone_schema.autogenerated.json`. diff --git a/components/renku_data_services/storage/rclone.py b/components/renku_data_services/storage/rclone.py index 58fac1171..d8e5bcfc3 100644 --- a/components/renku_data_services/storage/rclone.py +++ b/components/renku_data_services/storage/rclone.py @@ -262,7 +262,7 @@ class RCloneExample(BaseModel): value: str = Field(alias="Value") help: str = Field(alias="Help") - provider: str = Field(alias="Provider") + provider: str | None = Field(alias="Provider", default=None) class RCloneOption(BaseModel): @@ -270,11 +270,11 @@ class RCloneOption(BaseModel): name: str = Field(alias="Name") help: str = Field(alias="Help") - provider: str = Field(alias="Provider") + provider: str | None = Field(alias="Provider", default=None) default: str | int | bool | list[str] | RCloneTriState | None = Field(alias="Default") value: str | int | bool | RCloneTriState | None = Field(alias="Value") examples: list[RCloneExample] | None = Field(default=None, alias="Examples") - short_opt: str = Field(alias="ShortOpt") + short_opt: str | None = Field(alias="ShortOpt", default=None) hide: int = Field(alias="Hide") required: bool = Field(alias="Required") is_password: bool = Field(alias="IsPassword") diff --git a/components/renku_data_services/storage/rclone_schema.autogenerated.json b/components/renku_data_services/storage/rclone_schema.autogenerated.json index 021a63c70..1ae1aec7f 100644 --- a/components/renku_data_services/storage/rclone_schema.autogenerated.json +++ b/components/renku_data_services/storage/rclone_schema.autogenerated.json @@ -6,11 +6,10 @@ "Options": [ { "Name": "remote", + "FieldName": "", "Help": "Remote or path to alias.\n\nCan be \"myremote:path/to/dir\", \"myremote:bucket\", \"myremote:\" or \"/local/path\".", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": true, "IsPassword": false, @@ -21,97 +20,13 @@ "DefaultStr": "", "ValueStr": "", "Type": "string" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "amazon cloud drive", - "Description": "Amazon Drive", - "Prefix": "acd", - "Options": [ - { - "Name": "client_id", - "Help": "OAuth Client Id.\n\nLeave blank normally.", - "Provider": "", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" - }, - { - "Name": "client_secret", - "Help": "OAuth Client Secret.\n\nLeave blank normally.", - "Provider": "", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" - }, - { - "Name": "token", - "Help": "OAuth Access Token as a JSON blob.", - "Provider": "", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" - }, - { - "Name": "auth_url", - "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", - "Provider": "", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" }, { - "Name": "token_url", - "Help": "Token server url.\n\nLeave blank to use the provider defaults.", - "Provider": "", + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -122,78 +37,6 @@ "DefaultStr": "", "ValueStr": "", "Type": "string" - }, - { - "Name": "checkpoint", - "Help": "Checkpoint for internal polling (debug).", - "Provider": "", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 3, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" - }, - { - "Name": "upload_wait_per_gb", - "Help": "Additional time per GiB to wait after a failed complete upload to see if it appears.\n\nSometimes Amazon Drive gives an error when a file has been fully\nuploaded but the file appears anyway after a little while. This\nhappens sometimes for files over 1 GiB in size and nearly every time for\nfiles bigger than 10 GiB. This parameter controls the time rclone waits\nfor the file to appear.\n\nThe default value for this parameter is 3 minutes per GiB, so by\ndefault it will wait 3 minutes for every GiB uploaded to see if the\nfile appears.\n\nYou can disable this feature by setting it to 0. This may cause\nconflict errors as rclone retries the failed upload but the file will\nmost likely appear correctly eventually.\n\nThese values were determined empirically by observing lots of uploads\nof big files for a range of file sizes.\n\nUpload with the \"-v\" flag to see more info about what rclone is doing\nin this situation.", - "Provider": "", - "Default": 180000000000, - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "3m0s", - "ValueStr": "3m0s", - "Type": "Duration" - }, - { - "Name": "templink_threshold", - "Help": "Files \u003e= this size will be downloaded via their tempLink.\n\nFiles this size or more will be downloaded via their \"tempLink\". This\nis to work around a problem with Amazon Drive which blocks downloads\nof files bigger than about 10 GiB. The default for this is 9 GiB which\nshouldn't need to be changed.\n\nTo download files above this threshold, rclone requests a \"tempLink\"\nwhich downloads the file through a temporary URL directly from the\nunderlying S3 storage.", - "Provider": "", - "Default": 9663676416, - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "9Gi", - "ValueStr": "9Gi", - "Type": "SizeSuffix" - }, - { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 50331650, - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "Slash,InvalidUtf8,Dot", - "ValueStr": "Slash,InvalidUtf8,Dot", - "Type": "MultiEncoder" } ], "CommandHelp": null, @@ -208,11 +51,10 @@ "Options": [ { "Name": "account", + "FieldName": "", "Help": "Azure Storage Account Name.\n\nSet this to the Azure Storage Account Name in use.\n\nLeave blank to use SAS URL or Emulator, otherwise it needs to be set.\n\nIf this is blank and if env_auth is set it will be read from the\nenvironment variable `AZURE_STORAGE_ACCOUNT_NAME` if possible.\n", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -226,11 +68,10 @@ }, { "Name": "env_auth", + "FieldName": "", "Help": "Read credentials from runtime (environment variables, CLI or MSI).\n\nSee the [authentication docs](/azureblob#authentication) for full info.", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -244,11 +85,10 @@ }, { "Name": "key", + "FieldName": "", "Help": "Storage Account Shared Key.\n\nLeave blank to use SAS URL or Emulator.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -262,11 +102,10 @@ }, { "Name": "sas_url", + "FieldName": "", "Help": "SAS URL for container level access only.\n\nLeave blank if using account/key or Emulator.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -280,11 +119,10 @@ }, { "Name": "tenant", + "FieldName": "", "Help": "ID of the service principal's tenant. Also called its directory ID.\n\nSet this if using\n- Service principal with client secret\n- Service principal with certificate\n- User with username and password\n", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -298,11 +136,10 @@ }, { "Name": "client_id", + "FieldName": "", "Help": "The ID of the client in use.\n\nSet this if using\n- Service principal with client secret\n- Service principal with certificate\n- User with username and password\n", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -316,11 +153,10 @@ }, { "Name": "client_secret", + "FieldName": "", "Help": "One of the service principal's client secrets\n\nSet this if using\n- Service principal with client secret\n", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -334,11 +170,10 @@ }, { "Name": "client_certificate_path", + "FieldName": "", "Help": "Path to a PEM or PKCS12 certificate file including the private key.\n\nSet this if using\n- Service principal with certificate\n", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -352,11 +187,10 @@ }, { "Name": "client_certificate_password", + "FieldName": "", "Help": "Password for the certificate file (optional).\n\nOptionally set this if using\n- Service principal with certificate\n\nAnd the certificate has a password.\n", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": true, @@ -370,11 +204,10 @@ }, { "Name": "client_send_certificate_chain", + "FieldName": "", "Help": "Send the certificate chain when using certificate auth.\n\nSpecifies whether an authentication request will include an x5c header\nto support subject name / issuer based authentication. When set to\ntrue, authentication requests include the x5c header.\n\nOptionally set this if using\n- Service principal with certificate\n", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -388,11 +221,10 @@ }, { "Name": "username", + "FieldName": "", "Help": "User name (usually an email address)\n\nSet this if using\n- User with username and password\n", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -406,11 +238,10 @@ }, { "Name": "password", + "FieldName": "", "Help": "The user's password\n\nSet this if using\n- User with username and password\n", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": true, @@ -424,11 +255,10 @@ }, { "Name": "service_principal_file", - "Help": "Path to file containing credentials for use with a service principal.\n\nLeave blank normally. Needed only if you want to use a service principal instead of interactive login.\n\n $ az ad sp create-for-rbac --name \"\u003cname\u003e\" \\\n --role \"Storage Blob Data Owner\" \\\n --scopes \"/subscriptions/\u003csubscription\u003e/resourceGroups/\u003cresource-group\u003e/providers/Microsoft.Storage/storageAccounts/\u003cstorage-account\u003e/blobServices/default/containers/\u003ccontainer\u003e\" \\\n \u003e azure-principal.json\n\nSee [\"Create an Azure service principal\"](https://docs.microsoft.com/en-us/cli/azure/create-an-azure-service-principal-azure-cli) and [\"Assign an Azure role for access to blob data\"](https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad-rbac-cli) pages for more details.\n\nIt may be more convenient to put the credentials directly into the\nrclone config file under the `client_id`, `tenant` and `client_secret`\nkeys instead of setting `service_principal_file`.\n", - "Provider": "", + "FieldName": "", + "Help": "Path to file containing credentials for use with a service principal.\n\nLeave blank normally. Needed only if you want to use a service principal instead of interactive login.\n\n $ az ad sp create-for-rbac --name \"\" \\\n --role \"Storage Blob Data Owner\" \\\n --scopes \"/subscriptions//resourceGroups//providers/Microsoft.Storage/storageAccounts//blobServices/default/containers/\" \\\n > azure-principal.json\n\nSee [\"Create an Azure service principal\"](https://docs.microsoft.com/en-us/cli/azure/create-an-azure-service-principal-azure-cli) and [\"Assign an Azure role for access to blob data\"](https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad-rbac-cli) pages for more details.\n\nIt may be more convenient to put the credentials directly into the\nrclone config file under the `client_id`, `tenant` and `client_secret`\nkeys instead of setting `service_principal_file`.\n", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -442,11 +272,10 @@ }, { "Name": "use_msi", + "FieldName": "", "Help": "Use a managed service identity to authenticate (only works in Azure).\n\nWhen true, use a [managed service identity](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/)\nto authenticate to Azure Storage instead of a SAS token or account key.\n\nIf the VM(SS) on which this program is running has a system-assigned identity, it will\nbe used by default. If the resource has no system-assigned but exactly one user-assigned identity,\nthe user-assigned identity will be used by default. If the resource has multiple user-assigned\nidentities, the identity to use must be explicitly specified using exactly one of the msi_object_id,\nmsi_client_id, or msi_mi_res_id parameters.", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -460,11 +289,10 @@ }, { "Name": "msi_object_id", + "FieldName": "", "Help": "Object ID of the user-assigned MSI to use, if any.\n\nLeave blank if msi_client_id or msi_mi_res_id specified.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -478,11 +306,10 @@ }, { "Name": "msi_client_id", + "FieldName": "", "Help": "Object ID of the user-assigned MSI to use, if any.\n\nLeave blank if msi_object_id or msi_mi_res_id specified.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -496,11 +323,10 @@ }, { "Name": "msi_mi_res_id", + "FieldName": "", "Help": "Azure resource ID of the user-assigned MSI to use, if any.\n\nLeave blank if msi_client_id or msi_object_id specified.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -514,11 +340,10 @@ }, { "Name": "use_emulator", + "FieldName": "", "Help": "Uses local storage emulator if provided as 'true'.\n\nLeave blank if using real azure storage endpoint.", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -532,11 +357,10 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for the service.\n\nLeave blank normally.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -550,11 +374,10 @@ }, { "Name": "upload_cutoff", - "Help": "Cutoff for switching to chunked upload (\u003c= 256 MiB) (deprecated).", - "Provider": "", + "FieldName": "", + "Help": "Cutoff for switching to chunked upload (<= 256 MiB) (deprecated).", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -568,11 +391,10 @@ }, { "Name": "chunk_size", + "FieldName": "", "Help": "Upload chunk size.\n\nNote that this is stored in memory and there may be up to\n\"--transfers\" * \"--azureblob-upload-concurrency\" chunks stored at once\nin memory.", - "Provider": "", "Default": 4194304, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -586,11 +408,10 @@ }, { "Name": "upload_concurrency", + "FieldName": "", "Help": "Concurrency for multipart uploads.\n\nThis is the number of chunks of the same file that are uploaded\nconcurrently.\n\nIf you are uploading small numbers of large files over high-speed\nlinks and these uploads do not fully utilize your bandwidth, then\nincreasing this may help to speed up the transfers.\n\nIn tests, upload speed increases almost linearly with upload\nconcurrency. For example to fill a gigabit pipe it may be necessary to\nraise this to 64. Note that this will use more memory.\n\nNote that chunks are stored in memory and there may be up to\n\"--transfers\" * \"--azureblob-upload-concurrency\" chunks stored at once\nin memory.", - "Provider": "", "Default": 16, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -604,11 +425,10 @@ }, { "Name": "list_chunk", + "FieldName": "", "Help": "Size of blob list.\n\nThis sets the number of blobs requested in each listing chunk. Default\nis the maximum, 5000. \"List blobs\" requests are permitted 2 minutes\nper megabyte to complete. If an operation is taking longer than 2\nminutes per megabyte on average, it will time out (\n[source](https://docs.microsoft.com/en-us/rest/api/storageservices/setting-timeouts-for-blob-service-operations#exceptions-to-default-timeout-interval)\n). This can be used to limit the number of blobs items to return, to\navoid the time out.", - "Provider": "", "Default": 5000, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -622,11 +442,10 @@ }, { "Name": "access_tier", - "Help": "Access tier of blob: hot, cool or archive.\n\nArchived blobs can be restored by setting access tier to hot or\ncool. Leave blank if you intend to use default access tier, which is\nset at account level\n\nIf there is no \"access tier\" specified, rclone doesn't apply any tier.\nrclone performs \"Set Tier\" operation on blobs while uploading, if objects\nare not modified, specifying \"access tier\" to new one will have no effect.\nIf blobs are in \"archive tier\" at remote, trying to perform data transfer\noperations from remote will not be allowed. User should first restore by\ntiering blob to \"Hot\" or \"Cool\".", - "Provider": "", + "FieldName": "", + "Help": "Access tier of blob: hot, cool, cold or archive.\n\nArchived blobs can be restored by setting access tier to hot, cool or\ncold. Leave blank if you intend to use default access tier, which is\nset at account level\n\nIf there is no \"access tier\" specified, rclone doesn't apply any tier.\nrclone performs \"Set Tier\" operation on blobs while uploading, if objects\nare not modified, specifying \"access tier\" to new one will have no effect.\nIf blobs are in \"archive tier\" at remote, trying to perform data transfer\noperations from remote will not be allowed. User should first restore by\ntiering blob to \"Hot\", \"Cool\" or \"Cold\".", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -640,11 +459,10 @@ }, { "Name": "archive_tier_delete", + "FieldName": "", "Help": "Delete archive tier blobs before overwriting.\n\nArchive tier blobs cannot be updated. So without this flag, if you\nattempt to update an archive tier blob, then rclone will produce the\nerror:\n\n can't update archive tier blob without --azureblob-archive-tier-delete\n\nWith this flag set then before rclone attempts to overwrite an archive\ntier blob, it will delete the existing blob before uploading its\nreplacement. This has the potential for data loss if the upload fails\n(unlike updating a normal blob) and also may cost more since deleting\narchive tier blobs early may be chargable.\n", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -658,11 +476,10 @@ }, { "Name": "disable_checksum", + "FieldName": "", "Help": "Don't store MD5 checksum with object metadata.\n\nNormally rclone will calculate the MD5 checksum of the input before\nuploading it so it can add it to metadata on the object. This is great\nfor data integrity checking but can cause long delays for large files\nto start uploading.", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -676,12 +493,11 @@ }, { "Name": "memory_pool_flush_time", - "Help": "How often internal memory buffer pools will be flushed.\n\nUploads which requires additional buffers (f.e multipart) will use memory pool for allocations.\nThis option controls how often unused buffers will be removed from the pool.", - "Provider": "", + "FieldName": "", + "Help": "How often internal memory buffer pools will be flushed. (no longer used)", "Default": 60000000000, "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 3, "Required": false, "IsPassword": false, "NoPrefix": false, @@ -694,12 +510,11 @@ }, { "Name": "memory_pool_use_mmap", - "Help": "Whether to use mmap buffers in internal memory pool.", - "Provider": "", + "FieldName": "", + "Help": "Whether to use mmap buffers in internal memory pool. (no longer used)", "Default": false, "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 3, "Required": false, "IsPassword": false, "NoPrefix": false, @@ -712,11 +527,10 @@ }, { "Name": "encoding", + "FieldName": "", "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", "Default": 21078018, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -726,32 +540,28 @@ "Sensitive": false, "DefaultStr": "Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8", "ValueStr": "Slash,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8", - "Type": "MultiEncoder" + "Type": "Encoding" }, { "Name": "public_access", + "FieldName": "", "Help": "Public access level of a container: blob or container.", - "Provider": "", "Default": "", "Value": null, "Examples": [ { "Value": "", - "Help": "The container and its blobs can be accessed only with an authorized request.\nIt's a default value.", - "Provider": "" + "Help": "The container and its blobs can be accessed only with an authorized request.\nIt's a default value." }, { "Value": "blob", - "Help": "Blob data within this container can be read via anonymous request.", - "Provider": "" + "Help": "Blob data within this container can be read via anonymous request." }, { "Value": "container", - "Help": "Allow full public read access for container and blob data.", - "Provider": "" + "Help": "Allow full public read access for container and blob data." } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -765,11 +575,10 @@ }, { "Name": "directory_markers", + "FieldName": "", "Help": "Upload an empty object with a trailing slash when a new directory is created\n\nEmpty folders are unsupported for bucket based remotes, this option\ncreates an empty object ending with \"/\", to persist the folder.\n\nThis object also has the metadata \"hdi_isfolder = true\" to conform to\nthe Microsoft standard.\n ", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -783,11 +592,10 @@ }, { "Name": "no_check_container", + "FieldName": "", "Help": "If set, don't attempt to check the container exists or create it.\n\nThis can be useful when trying to minimise the number of transactions\nrclone does if you know the container exists already.\n", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -801,11 +609,10 @@ }, { "Name": "no_head_object", + "FieldName": "", "Help": "If set, do not do HEAD before GET when getting objects.", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -816,84 +623,94 @@ "DefaultStr": "false", "ValueStr": "false", "Type": "bool" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "b2", - "Description": "Backblaze B2", - "Prefix": "b2", - "Options": [ + }, { - "Name": "account", - "Help": "Account ID or Application Key ID.", - "Provider": "", + "Name": "delete_snapshots", + "FieldName": "", + "Help": "Set to specify how to deal with snapshots on blob deletion.", "Default": "", "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "", + "Help": "By default, the delete operation fails if a blob has snapshots" + }, + { + "Value": "include", + "Help": "Specify 'include' to remove the root blob and all its snapshots" + }, + { + "Value": "only", + "Help": "Specify 'only' to remove only the snapshots but keep the root blob." + } + ], "Hide": 0, - "Required": true, + "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": true, + "Advanced": true, + "Exclusive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "key", - "Help": "Application Key.", - "Provider": "", + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": true, + "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" - }, + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "azurefiles", + "Description": "Microsoft Azure Files", + "Prefix": "azurefiles", + "Options": [ { - "Name": "endpoint", - "Help": "Endpoint for the service.\n\nLeave blank normally.", - "Provider": "", + "Name": "account", + "FieldName": "", + "Help": "Azure Storage Account Name.\n\nSet this to the Azure Storage Account Name in use.\n\nLeave blank to use SAS URL or connection string, otherwise it needs to be set.\n\nIf this is blank and if env_auth is set it will be read from the\nenvironment variable `AZURE_STORAGE_ACCOUNT_NAME` if possible.\n", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, + "Sensitive": true, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "test_mode", - "Help": "A flag string for X-Bz-Test-Mode header for debugging.\n\nThis is for debugging purposes only. Setting it to one of the strings\nbelow will cause b2 to return specific errors:\n\n * \"fail_some_uploads\"\n * \"expire_some_account_authorization_tokens\"\n * \"force_cap_exceeded\"\n\nThese will be set in the \"X-Bz-Test-Mode\" header which is documented\nin the [b2 integrations checklist](https://www.backblaze.com/b2/docs/integration_checklist.html).", - "Provider": "", + "Name": "share_name", + "FieldName": "", + "Help": "Azure Files Share Name.\n\nThis is required and is the name of the share to access.\n", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 2, + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, "DefaultStr": "", @@ -901,17 +718,16 @@ "Type": "string" }, { - "Name": "versions", - "Help": "Include old versions in directory listings.\n\nNote that when using this no file write operations are permitted,\nso you can't upload files or delete them.", - "Provider": "", + "Name": "env_auth", + "FieldName": "", + "Help": "Read credentials from runtime (environment variables, CLI or MSI).\n\nSee the [authentication docs](/azurefiles#authentication) for full info.", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, "DefaultStr": "false", @@ -919,174 +735,147 @@ "Type": "bool" }, { - "Name": "version_at", - "Help": "Show file versions as they were at the specified time.\n\nNote that when using this no file write operations are permitted,\nso you can't upload files or delete them.", - "Provider": "", - "Default": "0001-01-01T00:00:00Z", + "Name": "key", + "FieldName": "", + "Help": "Storage Account Shared Key.\n\nLeave blank to use SAS URL or connection string.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "off", - "ValueStr": "off", - "Type": "Time" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "hard_delete", - "Help": "Permanently delete files on remote removal, otherwise hide files.", - "Provider": "", - "Default": false, + "Name": "sas_url", + "FieldName": "", + "Help": "SAS URL.\n\nLeave blank if using account/key or connection string.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "upload_cutoff", - "Help": "Cutoff for switching to chunked upload.\n\nFiles above this size will be uploaded in chunks of \"--b2-chunk-size\".\n\nThis value should be set no larger than 4.657 GiB (== 5 GB).", - "Provider": "", - "Default": 209715200, + "Name": "connection_string", + "FieldName": "", + "Help": "Azure Files Connection String.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "200Mi", - "ValueStr": "200Mi", - "Type": "SizeSuffix" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "copy_cutoff", - "Help": "Cutoff for switching to multipart copy.\n\nAny files larger than this that need to be server-side copied will be\ncopied in chunks of this size.\n\nThe minimum is 0 and the maximum is 4.6 GiB.", - "Provider": "", - "Default": 4294967296, + "Name": "tenant", + "FieldName": "", + "Help": "ID of the service principal's tenant. Also called its directory ID.\n\nSet this if using\n- Service principal with client secret\n- Service principal with certificate\n- User with username and password\n", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "4Gi", - "ValueStr": "4Gi", - "Type": "SizeSuffix" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "chunk_size", - "Help": "Upload chunk size.\n\nWhen uploading large files, chunk the file into this size.\n\nMust fit in memory. These chunks are buffered in memory and there\nmight a maximum of \"--transfers\" chunks in progress at once.\n\n5,000,000 Bytes is the minimum size.", - "Provider": "", - "Default": 100663296, - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "96Mi", - "ValueStr": "96Mi", - "Type": "SizeSuffix" - }, - { - "Name": "disable_checksum", - "Help": "Disable checksums for large (\u003e upload cutoff) files.\n\nNormally rclone will calculate the SHA1 checksum of the input before\nuploading it so it can add it to metadata on the object. This is great\nfor data integrity checking but can cause long delays for large files\nto start uploading.", - "Provider": "", - "Default": false, + "Name": "client_id", + "FieldName": "", + "Help": "The ID of the client in use.\n\nSet this if using\n- Service principal with client secret\n- Service principal with certificate\n- User with username and password\n", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "download_url", - "Help": "Custom endpoint for downloads.\n\nThis is usually set to a Cloudflare CDN URL as Backblaze offers\nfree egress for data downloaded through the Cloudflare network.\nRclone works with private buckets by sending an \"Authorization\" header.\nIf the custom endpoint rewrites the requests for authentication,\ne.g., in Cloudflare Workers, this header needs to be handled properly.\nLeave blank if you want to use the endpoint provided by Backblaze.\n\nThe URL provided here SHOULD have the protocol and SHOULD NOT have\na trailing slash or specify the /file/bucket subpath as rclone will\nrequest files with \"{download_url}/file/{bucket_name}/{path}\".\n\nExample:\n\u003e https://mysubdomain.mydomain.tld\n(No trailing \"/\", \"file\" or \"bucket\")", - "Provider": "", + "Name": "client_secret", + "FieldName": "", + "Help": "One of the service principal's client secrets\n\nSet this if using\n- Service principal with client secret\n", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, + "Sensitive": true, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "download_auth_duration", - "Help": "Time before the authorization token will expire in s or suffix ms|s|m|h|d.\n\nThe duration before the download authorization token will expire.\nThe minimum value is 1 second. The maximum value is one week.", - "Provider": "", - "Default": 604800000000000, + "Name": "client_certificate_path", + "FieldName": "", + "Help": "Path to a PEM or PKCS12 certificate file including the private key.\n\nSet this if using\n- Service principal with certificate\n", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "1w", - "ValueStr": "1w", - "Type": "Duration" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "memory_pool_flush_time", - "Help": "How often internal memory buffer pools will be flushed.\nUploads which requires additional buffers (f.e multipart) will use memory pool for allocations.\nThis option controls how often unused buffers will be removed from the pool.", - "Provider": "", - "Default": 60000000000, + "Name": "client_certificate_password", + "FieldName": "", + "Help": "Password for the certificate file (optional).\n\nOptionally set this if using\n- Service principal with certificate\n\nAnd the certificate has a password.\n", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, - "IsPassword": false, + "IsPassword": true, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "1m0s", - "ValueStr": "1m0s", - "Type": "Duration" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "memory_pool_use_mmap", - "Help": "Whether to use mmap buffers in internal memory pool.", - "Provider": "", + "Name": "client_send_certificate_chain", + "FieldName": "", + "Help": "Send the certificate chain when using certificate auth.\n\nSpecifies whether an authentication request will include an x5c header\nto support subject name / issuer based authentication. When set to\ntrue, authentication requests include the x5c header.\n\nOptionally set this if using\n- Service principal with certificate\n", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -1099,46 +888,16 @@ "Type": "bool" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 50438146, - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot", - "ValueStr": "Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot", - "Type": "MultiEncoder" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "box", - "Description": "Box", - "Prefix": "box", - "Options": [ - { - "Name": "client_id", - "Help": "OAuth Client Id.\n\nLeave blank normally.", - "Provider": "", + "Name": "username", + "FieldName": "", + "Help": "User name (usually an email address)\n\nSet this if using\n- User with username and password\n", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": true, "DefaultStr": "", @@ -1146,48 +905,45 @@ "Type": "string" }, { - "Name": "client_secret", - "Help": "OAuth Client Secret.\n\nLeave blank normally.", - "Provider": "", + "Name": "password", + "FieldName": "", + "Help": "The user's password\n\nSet this if using\n- User with username and password\n", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, - "IsPassword": false, + "IsPassword": true, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "token", - "Help": "OAuth Access Token as a JSON blob.", - "Provider": "", + "Name": "service_principal_file", + "FieldName": "", + "Help": "Path to file containing credentials for use with a service principal.\n\nLeave blank normally. Needed only if you want to use a service principal instead of interactive login.\n\n $ az ad sp create-for-rbac --name \"\" \\\n --role \"Storage Files Data Owner\" \\\n --scopes \"/subscriptions//resourceGroups//providers/Microsoft.Storage/storageAccounts//blobServices/default/containers/\" \\\n > azure-principal.json\n\nSee [\"Create an Azure service principal\"](https://docs.microsoft.com/en-us/cli/azure/create-an-azure-service-principal-azure-cli) and [\"Assign an Azure role for access to files data\"](https://docs.microsoft.com/en-us/azure/storage/common/storage-auth-aad-rbac-cli) pages for more details.\n\n**NB** this section needs updating for Azure Files - pull requests appreciated!\n\nIt may be more convenient to put the credentials directly into the\nrclone config file under the `client_id`, `tenant` and `client_secret`\nkeys instead of setting `service_principal_file`.\n", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "auth_url", - "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", - "Provider": "", - "Default": "", + "Name": "use_msi", + "FieldName": "", + "Help": "Use a managed service identity to authenticate (only works in Azure).\n\nWhen true, use a [managed service identity](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/)\nto authenticate to Azure Storage instead of a SAS token or account key.\n\nIf the VM(SS) on which this program is running has a system-assigned identity, it will\nbe used by default. If the resource has no system-assigned but exactly one user-assigned identity,\nthe user-assigned identity will be used by default. If the resource has multiple user-assigned\nidentities, the identity to use must be explicitly specified using exactly one of the msi_object_id,\nmsi_client_id, or msi_mi_res_id parameters.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -1195,35 +951,33 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "token_url", - "Help": "Token server url.\n\nLeave blank to use the provider defaults.", - "Provider": "", + "Name": "msi_object_id", + "FieldName": "", + "Help": "Object ID of the user-assigned MSI to use, if any.\n\nLeave blank if msi_client_id or msi_mi_res_id specified.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": false, + "Sensitive": true, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "root_folder_id", - "Help": "Fill in for rclone to use a non root folder as its starting point.", - "Provider": "", - "Default": "0", + "Name": "msi_client_id", + "FieldName": "", + "Help": "Object ID of the user-assigned MSI to use, if any.\n\nLeave blank if msi_object_id or msi_mi_res_id specified.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -1231,40 +985,21 @@ "Advanced": true, "Exclusive": false, "Sensitive": true, - "DefaultStr": "0", - "ValueStr": "0", - "Type": "string" - }, - { - "Name": "box_config_file", - "Help": "Box App config.json location\n\nLeave blank normally.\n\nLeading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.", - "Provider": "", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "access_token", - "Help": "Box App Primary Access Token\n\nLeave blank normally.", - "Provider": "", + "Name": "msi_mi_res_id", + "FieldName": "", + "Help": "Azure resource ID of the user-assigned MSI to use, if any.\n\nLeave blank if msi_client_id or msi_object_id specified.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": true, "DefaultStr": "", @@ -1272,42 +1007,28 @@ "Type": "string" }, { - "Name": "box_sub_type", - "Help": "", - "Provider": "", - "Default": "user", + "Name": "endpoint", + "FieldName": "", + "Help": "Endpoint for the service.\n\nLeave blank normally.", + "Default": "", "Value": null, - "Examples": [ - { - "Value": "user", - "Help": "Rclone should act on behalf of a user.", - "Provider": "" - }, - { - "Value": "enterprise", - "Help": "Rclone should act on behalf of a service account.", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "user", - "ValueStr": "user", + "DefaultStr": "", + "ValueStr": "", "Type": "string" }, { - "Name": "upload_cutoff", - "Help": "Cutoff for switching to multipart upload (\u003e= 50 MiB).", - "Provider": "", - "Default": 52428800, + "Name": "chunk_size", + "FieldName": "", + "Help": "Upload chunk size.\n\nNote that this is stored in memory and there may be up to\n\"--transfers\" * \"--azurefile-upload-concurrency\" chunks stored at once\nin memory.", + "Default": 4194304, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -1315,17 +1036,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "50Mi", - "ValueStr": "50Mi", + "DefaultStr": "4Mi", + "ValueStr": "4Mi", "Type": "SizeSuffix" }, { - "Name": "commit_retries", - "Help": "Max number of times to try committing a multipart file.", - "Provider": "", - "Default": 100, + "Name": "upload_concurrency", + "FieldName": "", + "Help": "Concurrency for multipart uploads.\n\nThis is the number of chunks of the same file that are uploaded\nconcurrently.\n\nIf you are uploading small numbers of large files over high-speed\nlinks and these uploads do not fully utilize your bandwidth, then\nincreasing this may help to speed up the transfers.\n\nNote that chunks are stored in memory and there may be up to\n\"--transfers\" * \"--azurefile-upload-concurrency\" chunks stored at once\nin memory.", + "Default": 16, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -1333,17 +1053,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "100", - "ValueStr": "100", + "DefaultStr": "16", + "ValueStr": "16", "Type": "int" }, { - "Name": "list_chunk", - "Help": "Size of listing chunk 1-1000.", - "Provider": "", - "Default": 1000, + "Name": "max_stream_size", + "FieldName": "", + "Help": "Max size for streamed files.\n\nAzure files needs to know in advance how big the file will be. When\nrclone doesn't know it uses this value instead.\n\nThis will be used when rclone is streaming data, the most common uses are:\n\n- Uploading files with `--vfs-cache-mode off` with `rclone mount`\n- Using `rclone rcat`\n- Copying files with unknown length\n\nYou will need this much free space in the share as the file will be this size temporarily.\n", + "Default": 10737418240, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -1351,17 +1070,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "1000", - "ValueStr": "1000", - "Type": "int" + "DefaultStr": "10Gi", + "ValueStr": "10Gi", + "Type": "SizeSuffix" }, { - "Name": "owned_by", - "Help": "Only show items owned by the login (email address) passed in.", - "Provider": "", - "Default": "", + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 54634382, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -1369,17 +1087,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8,Dot", + "ValueStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,RightPeriod,InvalidUtf8,Dot", + "Type": "Encoding" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 52535298, + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -1387,9 +1104,9 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot", - "ValueStr": "Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot", - "Type": "MultiEncoder" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], "CommandHelp": null, @@ -1398,105 +1115,55 @@ "MetadataInfo": null }, { - "Name": "crypt", - "Description": "Encrypt/Decrypt a remote", - "Prefix": "crypt", + "Name": "b2", + "Description": "Backblaze B2", + "Prefix": "b2", "Options": [ { - "Name": "remote", - "Help": "Remote to encrypt/decrypt.\n\nNormally should contain a ':' and a path, e.g. \"myremote:path/to/dir\",\n\"myremote:bucket\" or maybe \"myremote:\" (not recommended).", - "Provider": "", + "Name": "account", + "FieldName": "", + "Help": "Account ID or Application Key ID.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": true, "IsPassword": false, "NoPrefix": false, "Advanced": false, "Exclusive": false, - "Sensitive": false, + "Sensitive": true, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "filename_encryption", - "Help": "How to encrypt the filenames.", - "Provider": "", - "Default": "standard", + "Name": "key", + "FieldName": "", + "Help": "Application Key.", + "Default": "", "Value": null, - "Examples": [ - { - "Value": "standard", - "Help": "Encrypt the filenames.\nSee the docs for the details.", - "Provider": "" - }, - { - "Value": "obfuscate", - "Help": "Very simple filename obfuscation.", - "Provider": "" - }, - { - "Value": "off", - "Help": "Don't encrypt the file names.\nAdds a \".bin\", or \"suffix\" extension only.", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, - "Required": false, + "Required": true, "IsPassword": false, "NoPrefix": false, "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "standard", - "ValueStr": "standard", + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", "Type": "string" }, { - "Name": "directory_name_encryption", - "Help": "Option to either encrypt directory names or leave them intact.\n\nNB If filename_encryption is \"off\" then this option will do nothing.", - "Provider": "", - "Default": true, + "Name": "endpoint", + "FieldName": "", + "Help": "Endpoint for the service.\n\nLeave blank normally.", + "Default": "", "Value": null, - "Examples": [ - { - "Value": "true", - "Help": "Encrypt directory names.", - "Provider": "" - }, - { - "Value": "false", - "Help": "Don't encrypt directory names, leave them intact.", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "true", - "ValueStr": "true", - "Type": "bool" - }, - { - "Name": "password", - "Help": "Password or pass phrase for encryption.", - "Provider": "", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": true, - "IsPassword": true, - "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, "DefaultStr": "", @@ -1504,17 +1171,16 @@ "Type": "string" }, { - "Name": "password2", - "Help": "Password or pass phrase for salt.\n\nOptional but recommended.\nShould be different to the previous password.", - "Provider": "", + "Name": "test_mode", + "FieldName": "", + "Help": "A flag string for X-Bz-Test-Mode header for debugging.\n\nThis is for debugging purposes only. Setting it to one of the strings\nbelow will cause b2 to return specific errors:\n\n * \"fail_some_uploads\"\n * \"expire_some_account_authorization_tokens\"\n * \"force_cap_exceeded\"\n\nThese will be set in the \"X-Bz-Test-Mode\" header which is documented\nin the [b2 integrations checklist](https://www.backblaze.com/docs/cloud-storage-integration-checklist).", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 2, "Required": false, - "IsPassword": true, + "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, "DefaultStr": "", @@ -1522,12 +1188,11 @@ "Type": "string" }, { - "Name": "server_side_across_configs", - "Help": "Deprecated: use --server-side-across-configs instead.\n\nAllow server-side operations (e.g. copy) to work across different crypt configs.\n\nNormally this option is not what you want, but if you have two crypts\npointing to the same backend you can use it.\n\nThis can be used, for example, to change file name encryption type\nwithout re-uploading all the data. Just make two crypt backends\npointing to two different directories with the single changed\nparameter and use rclone move to move the files between the crypt\nremotes.", - "Provider": "", + "Name": "versions", + "FieldName": "", + "Help": "Include old versions in directory listings.\n\nNote that when using this no file write operations are permitted,\nso you can't upload files or delete them.", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -1540,47 +1205,33 @@ "Type": "bool" }, { - "Name": "show_mapping", - "Help": "For all files listed show how the names encrypt.\n\nIf this flag is set then for each file that the remote is asked to\nlist, it will log (at level INFO) a line stating the decrypted file\nname and the encrypted file name.\n\nThis is so you can work out which encrypted names are which decrypted\nnames just in case you need to do something with the encrypted file\nnames, or for debugging purposes.", - "Provider": "", - "Default": false, + "Name": "version_at", + "FieldName": "", + "Help": "Show file versions as they were at the specified time.\n\nNote that when using this no file write operations are permitted,\nso you can't upload files or delete them.", + "Default": "0001-01-01T00:00:00Z", "Value": null, - "ShortOpt": "", - "Hide": 2, + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "off", + "ValueStr": "off", + "Type": "Time" }, { - "Name": "no_data_encryption", - "Help": "Option to either encrypt file data or leave it unencrypted.", - "Provider": "", + "Name": "hard_delete", + "FieldName": "", + "Help": "Permanently delete files on remote removal, otherwise hide files.", "Default": false, "Value": null, - "Examples": [ - { - "Value": "true", - "Help": "Don't encrypt file data, leave it unencrypted.", - "Provider": "" - }, - { - "Value": "false", - "Help": "Encrypt file data.", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, "DefaultStr": "false", @@ -1588,12 +1239,11 @@ "Type": "bool" }, { - "Name": "pass_bad_blocks", - "Help": "If set this will pass bad blocks through as all 0.\n\nThis should not be set in normal operation, it should only be set if\ntrying to recover an encrypted file with errors and it is desired to\nrecover as much of the file as possible.", - "Provider": "", - "Default": false, + "Name": "upload_cutoff", + "FieldName": "", + "Help": "Cutoff for switching to chunked upload.\n\nFiles above this size will be uploaded in chunks of \"--b2-chunk-size\".\n\nThis value should be set no larger than 4.657 GiB (== 5 GB).", + "Default": 209715200, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -1601,34 +1251,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "200Mi", + "ValueStr": "200Mi", + "Type": "SizeSuffix" }, { - "Name": "filename_encoding", - "Help": "How to encode the encrypted filename to text string.\n\nThis option could help with shortening the encrypted filename. The \nsuitable option would depend on the way your remote count the filename\nlength and if it's case sensitive.", - "Provider": "", - "Default": "base32", + "Name": "copy_cutoff", + "FieldName": "", + "Help": "Cutoff for switching to multipart copy.\n\nAny files larger than this that need to be server-side copied will be\ncopied in chunks of this size.\n\nThe minimum is 0 and the maximum is 4.6 GiB.", + "Default": 4294967296, "Value": null, - "Examples": [ - { - "Value": "base32", - "Help": "Encode using base32. Suitable for all remote.", - "Provider": "" - }, - { - "Value": "base64", - "Help": "Encode using base64. Suitable for case sensitive remote.", - "Provider": "" - }, - { - "Value": "base32768", - "Help": "Encode using base32768. Suitable if your remote counts UTF-16 or\nUnicode codepoint instead of UTF-8 byte length. (Eg. Onedrive, Dropbox)", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -1636,17 +1268,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "base32", - "ValueStr": "base32", - "Type": "string" + "DefaultStr": "4Gi", + "ValueStr": "4Gi", + "Type": "SizeSuffix" }, { - "Name": "suffix", - "Help": "If this is set it will override the default suffix of \".bin\".\n\nSetting suffix to \"none\" will result in an empty suffix. This may be useful \nwhen the path length is critical.", - "Provider": "", - "Default": ".bin", + "Name": "chunk_size", + "FieldName": "", + "Help": "Upload chunk size.\n\nWhen uploading large files, chunk the file into this size.\n\nMust fit in memory. These chunks are buffered in memory and there\nmight a maximum of \"--transfers\" chunks in progress at once.\n\n5,000,000 Bytes is the minimum size.", + "Default": 100663296, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -1654,311 +1285,255 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": ".bin", - "ValueStr": ".bin", - "Type": "string" - } - ], - "CommandHelp": [ - { - "Name": "encode", - "Short": "Encode the given filename(s)", - "Long": "This encodes the filenames given as arguments returning a list of\nstrings of the encoded results.\n\nUsage Example:\n\n rclone backend encode crypt: file1 [file2...]\n rclone rc backend/command command=encode fs=crypt: file1 [file2...]\n", - "Opts": null + "DefaultStr": "96Mi", + "ValueStr": "96Mi", + "Type": "SizeSuffix" }, { - "Name": "decode", - "Short": "Decode the given filename(s)", - "Long": "This decodes the filenames given as arguments returning a list of\nstrings of the decoded results. It will return an error if any of the\ninputs are invalid.\n\nUsage Example:\n\n rclone backend decode crypt: encryptedfile1 [encryptedfile2...]\n rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...]\n", - "Opts": null - } - ], - "Aliases": null, - "Hide": false, - "MetadataInfo": { - "System": null, - "Help": "Any metadata supported by the underlying remote is read and written." - } - }, - { - "Name": "cache", - "Description": "Cache a remote", - "Prefix": "cache", - "Options": [ - { - "Name": "remote", - "Help": "Remote to cache.\n\nNormally should contain a ':' and a path, e.g. \"myremote:path/to/dir\",\n\"myremote:bucket\" or maybe \"myremote:\" (not recommended).", - "Provider": "", - "Default": "", + "Name": "upload_concurrency", + "FieldName": "", + "Help": "Concurrency for multipart uploads.\n\nThis is the number of chunks of the same file that are uploaded\nconcurrently.\n\nNote that chunks are stored in memory and there may be up to\n\"--transfers\" * \"--b2-upload-concurrency\" chunks stored at once\nin memory.", + "Default": 4, "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": true, + "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "4", + "ValueStr": "4", + "Type": "int" }, { - "Name": "plex_url", - "Help": "The URL of the Plex server.", - "Provider": "", - "Default": "", + "Name": "disable_checksum", + "FieldName": "", + "Help": "Disable checksums for large (> upload cutoff) files.\n\nNormally rclone will calculate the SHA1 checksum of the input before\nuploading it so it can add it to metadata on the object. This is great\nfor data integrity checking but can cause long delays for large files\nto start uploading.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "plex_username", - "Help": "The username of the Plex user.", - "Provider": "", + "Name": "download_url", + "FieldName": "", + "Help": "Custom endpoint for downloads.\n\nThis is usually set to a Cloudflare CDN URL as Backblaze offers\nfree egress for data downloaded through the Cloudflare network.\nRclone works with private buckets by sending an \"Authorization\" header.\nIf the custom endpoint rewrites the requests for authentication,\ne.g., in Cloudflare Workers, this header needs to be handled properly.\nLeave blank if you want to use the endpoint provided by Backblaze.\n\nThe URL provided here SHOULD have the protocol and SHOULD NOT have\na trailing slash or specify the /file/bucket subpath as rclone will\nrequest files with \"{download_url}/file/{bucket_name}/{path}\".\n\nExample:\n> https://mysubdomain.mydomain.tld\n(No trailing \"/\", \"file\" or \"bucket\")", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "plex_password", - "Help": "The password of the Plex user.", - "Provider": "", - "Default": "", + "Name": "download_auth_duration", + "FieldName": "", + "Help": "Time before the public link authorization token will expire in s or suffix ms|s|m|h|d.\n\nThis is used in combination with \"rclone link\" for making files\naccessible to the public and sets the duration before the download\nauthorization token will expire.\n\nThe minimum value is 1 second. The maximum value is one week.", + "Default": 604800000000000, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, - "IsPassword": true, + "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "1w", + "ValueStr": "1w", + "Type": "Duration" }, { - "Name": "plex_token", - "Help": "The plex token for authentication - auto set normally.", - "Provider": "", - "Default": "", + "Name": "memory_pool_flush_time", + "FieldName": "", + "Help": "How often internal memory buffer pools will be flushed. (no longer used)", + "Default": 60000000000, "Value": null, - "ShortOpt": "", "Hide": 3, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "1m0s", + "ValueStr": "1m0s", + "Type": "Duration" }, { - "Name": "plex_insecure", - "Help": "Skip all certificate verification when connecting to the Plex server.", - "Provider": "", - "Default": "", + "Name": "memory_pool_use_mmap", + "FieldName": "", + "Help": "Whether to use mmap buffers in internal memory pool. (no longer used)", + "Default": false, "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 3, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "chunk_size", - "Help": "The size of a chunk (partial file data).\n\nUse lower numbers for slower connections. If the chunk size is\nchanged, any downloaded chunks will be invalid and cache-chunk-path\nwill need to be cleared or unexpected EOF errors will occur.", - "Provider": "", - "Default": 5242880, + "Name": "lifecycle", + "FieldName": "", + "Help": "Set the number of days deleted files should be kept when creating a bucket.\n\nOn bucket creation, this parameter is used to create a lifecycle rule\nfor the entire bucket.\n\nIf lifecycle is 0 (the default) it does not create a lifecycle rule so\nthe default B2 behaviour applies. This is to create versions of files\non delete and overwrite and to keep them indefinitely.\n\nIf lifecycle is >0 then it creates a single rule setting the number of\ndays before a file that is deleted or overwritten is deleted\npermanently. This is known as daysFromHidingToDeleting in the b2 docs.\n\nThe minimum value for this parameter is 1 day.\n\nYou can also enable hard_delete in the config also which will mean\ndeletions won't cause versions but overwrites will still cause\nversions to be made.\n\nSee: [rclone backend lifecycle](#lifecycle) for setting lifecycles after bucket creation.\n", + "Default": 0, "Value": null, - "Examples": [ - { - "Value": "1M", - "Help": "1 MiB", - "Provider": "" - }, - { - "Value": "5M", - "Help": "5 MiB", - "Provider": "" - }, - { - "Value": "10M", - "Help": "10 MiB", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "5Mi", - "ValueStr": "5Mi", - "Type": "SizeSuffix" + "DefaultStr": "0", + "ValueStr": "0", + "Type": "int" }, { - "Name": "info_age", - "Help": "How long to cache file structure information (directory listings, file size, times, etc.). \nIf all write operations are done through the cache then you can safely make\nthis value very large as the cache store will also be updated in real time.", - "Provider": "", - "Default": 21600000000000, + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 50438146, "Value": null, - "Examples": [ - { - "Value": "1h", - "Help": "1 hour", - "Provider": "" - }, - { - "Value": "24h", - "Help": "24 hours", - "Provider": "" - }, - { - "Value": "48h", - "Help": "48 hours", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "6h0m0s", - "ValueStr": "6h0m0s", - "Type": "Duration" + "DefaultStr": "Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot", + "ValueStr": "Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot", + "Type": "Encoding" }, { - "Name": "chunk_total_size", - "Help": "The total size that the chunks can take up on the local disk.\n\nIf the cache exceeds this value then it will start to delete the\noldest chunks until it goes under this value.", - "Provider": "", - "Default": 10737418240, + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", "Value": null, - "Examples": [ - { - "Value": "500M", - "Help": "500 MiB", - "Provider": "" - }, - { - "Value": "1G", - "Help": "1 GiB", - "Provider": "" - }, - { - "Value": "10G", - "Help": "10 GiB", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "10Gi", - "ValueStr": "10Gi", - "Type": "SizeSuffix" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": [ + { + "Name": "lifecycle", + "Short": "Read or set the lifecycle for a bucket", + "Long": "This command can be used to read or set the lifecycle for a bucket.\n\nUsage Examples:\n\nTo show the current lifecycle rules:\n\n rclone backend lifecycle b2:bucket\n\nThis will dump something like this showing the lifecycle rules.\n\n [\n {\n \"daysFromHidingToDeleting\": 1,\n \"daysFromUploadingToHiding\": null,\n \"fileNamePrefix\": \"\"\n }\n ]\n\nIf there are no lifecycle rules (the default) then it will just return [].\n\nTo reset the current lifecycle rules:\n\n rclone backend lifecycle b2:bucket -o daysFromHidingToDeleting=30\n rclone backend lifecycle b2:bucket -o daysFromUploadingToHiding=5 -o daysFromHidingToDeleting=1\n\nThis will run and then print the new lifecycle rules as above.\n\nRclone only lets you set lifecycles for the whole bucket with the\nfileNamePrefix = \"\".\n\nYou can't disable versioning with B2. The best you can do is to set\nthe daysFromHidingToDeleting to 1 day. You can enable hard_delete in\nthe config also which will mean deletions won't cause versions but\noverwrites will still cause versions to be made.\n\n rclone backend lifecycle b2:bucket -o daysFromHidingToDeleting=1\n\nSee: https://www.backblaze.com/docs/cloud-storage-lifecycle-rules\n", + "Opts": { + "daysFromHidingToDeleting": "After a file has been hidden for this many days it is deleted. 0 is off.", + "daysFromUploadingToHiding": "This many days after uploading a file is hidden" + } }, { - "Name": "db_path", - "Help": "Directory to store file structure metadata DB.\n\nThe remote name is used as the DB file name.", - "Provider": "", - "Default": "/home/zenon/.cache/rclone/cache-backend", + "Name": "cleanup", + "Short": "Remove unfinished large file uploads.", + "Long": "This command removes unfinished large file uploads of age greater than\nmax-age, which defaults to 24 hours.\n\nNote that you can use --interactive/-i or --dry-run with this command to see what\nit would do.\n\n rclone backend cleanup b2:bucket/path/to/object\n rclone backend cleanup -o max-age=7w b2:bucket/path/to/object\n\nDurations are parsed as per the rest of rclone, 2h, 7d, 7w etc.\n", + "Opts": { + "max-age": "Max age of upload to delete" + } + }, + { + "Name": "cleanup-hidden", + "Short": "Remove old versions of files.", + "Long": "This command removes any old hidden versions of files.\n\nNote that you can use --interactive/-i or --dry-run with this command to see what\nit would do.\n\n rclone backend cleanup-hidden b2:bucket/path/to/dir\n", + "Opts": null + } + ], + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "box", + "Description": "Box", + "Prefix": "box", + "Options": [ + { + "Name": "client_id", + "FieldName": "", + "Help": "OAuth Client Id.\n\nLeave blank normally.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "/home/zenon/.cache/rclone/cache-backend", - "ValueStr": "/home/zenon/.cache/rclone/cache-backend", + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", "Type": "string" }, { - "Name": "chunk_path", - "Help": "Directory to cache chunk files.\n\nPath to where partial file data (chunks) are stored locally. The remote\nname is appended to the final path.\n\nThis config follows the \"--cache-db-path\". If you specify a custom\nlocation for \"--cache-db-path\" and don't specify one for \"--cache-chunk-path\"\nthen \"--cache-chunk-path\" will use the same path as \"--cache-db-path\".", - "Provider": "", - "Default": "/home/zenon/.cache/rclone/cache-backend", + "Name": "client_secret", + "FieldName": "", + "Help": "OAuth Client Secret.\n\nLeave blank normally.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "/home/zenon/.cache/rclone/cache-backend", - "ValueStr": "/home/zenon/.cache/rclone/cache-backend", + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", "Type": "string" }, { - "Name": "db_purge", - "Help": "Clear all the cached data for this remote on start.", - "Provider": "", - "Default": false, + "Name": "token", + "FieldName": "", + "Help": "OAuth Access Token as a JSON blob.", + "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 2, + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "chunk_clean_interval", - "Help": "How often should the cache perform cleanups of the chunk storage.\n\nThe default value should be ok for most people. If you find that the\ncache goes over \"cache-chunk-total-size\" too often then try to lower\nthis value to force it to perform cleanups more often.", - "Provider": "", - "Default": 60000000000, + "Name": "auth_url", + "FieldName": "", + "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -1966,17 +1541,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "1m0s", - "ValueStr": "1m0s", - "Type": "Duration" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "read_retries", - "Help": "How many times to retry a read from a cache storage.\n\nSince reading from a cache stream is independent from downloading file\ndata, readers can get to a point where there's no more data in the\ncache. Most of the times this can indicate a connectivity issue if\ncache isn't able to provide file data anymore.\n\nFor really slow connections, increase this to a point where the stream is\nable to provide data but your experience will be very stuttering.", - "Provider": "", - "Default": 10, + "Name": "token_url", + "FieldName": "", + "Help": "Token server url.\n\nLeave blank to use the provider defaults.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -1984,71 +1558,94 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "10", - "ValueStr": "10", - "Type": "int" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "workers", - "Help": "How many workers should run in parallel to download chunks.\n\nHigher values will mean more parallel processing (better CPU needed)\nand more concurrent requests on the cloud provider. This impacts\nseveral aspects like the cloud provider API limits, more stress on the\nhardware that rclone runs on but it also means that streams will be\nmore fluid and data will be available much more faster to readers.\n\n**Note**: If the optional Plex integration is enabled then this\nsetting will adapt to the type of reading performed and the value\nspecified here will be used as a maximum number of workers to use.", - "Provider": "", - "Default": 4, + "Name": "root_folder_id", + "FieldName": "", + "Help": "Fill in for rclone to use a non root folder as its starting point.", + "Default": "0", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "4", - "ValueStr": "4", - "Type": "int" + "Sensitive": true, + "DefaultStr": "0", + "ValueStr": "0", + "Type": "string" }, { - "Name": "chunk_no_memory", - "Help": "Disable the in-memory cache for storing chunks during streaming.\n\nBy default, cache will keep file data during streaming in RAM as well\nto provide it to readers as fast as possible.\n\nThis transient data is evicted as soon as it is read and the number of\nchunks stored doesn't exceed the number of workers. However, depending\non other settings like \"cache-chunk-size\" and \"cache-workers\" this footprint\ncan increase if there are parallel streams too (multiple files being read\nat the same time).\n\nIf the hardware permits it, use this feature to provide an overall better\nperformance during streaming but it can also be disabled if RAM is not\navailable on the local machine.", - "Provider": "", - "Default": false, + "Name": "box_config_file", + "FieldName": "", + "Help": "Box App config.json location\n\nLeave blank normally.\n\nLeading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "rps", - "Help": "Limits the number of requests per second to the source FS (-1 to disable).\n\nThis setting places a hard limit on the number of requests per second\nthat cache will be doing to the cloud provider remote and try to\nrespect that value by setting waits between reads.\n\nIf you find that you're getting banned or limited on the cloud\nprovider through cache and know that a smaller number of requests per\nsecond will allow you to work with it then you can use this setting\nfor that.\n\nA good balance of all the other settings should make this setting\nuseless but it is available to set for more special cases.\n\n**NOTE**: This will limit the number of requests during streams but\nother API calls to the cloud provider like directory listings will\nstill pass.", - "Provider": "", - "Default": -1, + "Name": "access_token", + "FieldName": "", + "Help": "Box App Primary Access Token\n\nLeave blank normally.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "box_sub_type", + "FieldName": "", + "Help": "", + "Default": "user", + "Value": null, + "Examples": [ + { + "Value": "user", + "Help": "Rclone should act on behalf of a user." + }, + { + "Value": "enterprise", + "Help": "Rclone should act on behalf of a service account." + } + ], + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "-1", - "ValueStr": "-1", - "Type": "int" + "DefaultStr": "user", + "ValueStr": "user", + "Type": "string" }, { - "Name": "writes", - "Help": "Cache file data on writes through the FS.\n\nIf you need to read files immediately after you upload them through\ncache you can enable this flag to have their data stored in the\ncache store at the same time during upload.", - "Provider": "", - "Default": false, + "Name": "upload_cutoff", + "FieldName": "", + "Help": "Cutoff for switching to multipart upload (>= 50 MiB).", + "Default": 52428800, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -2056,17 +1653,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "50Mi", + "ValueStr": "50Mi", + "Type": "SizeSuffix" }, { - "Name": "tmp_upload_path", - "Help": "Directory to keep temporary files until they are uploaded.\n\nThis is the path where cache will use as a temporary storage for new\nfiles that need to be uploaded to the cloud provider.\n\nSpecifying a value will enable this feature. Without it, it is\ncompletely disabled and files will be uploaded directly to the cloud\nprovider", - "Provider": "", - "Default": "", + "Name": "commit_retries", + "FieldName": "", + "Help": "Max number of times to try committing a multipart file.", + "Default": 100, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -2074,17 +1670,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "100", + "ValueStr": "100", + "Type": "int" }, { - "Name": "tmp_wait_time", - "Help": "How long should files be stored in local cache before being uploaded.\n\nThis is the duration that a file must wait in the temporary location\n_cache-tmp-upload-path_ before it is selected for upload.\n\nNote that only one file is uploaded at a time and it can take longer\nto start the upload if a queue formed for this purpose.", - "Provider": "", - "Default": 15000000000, + "Name": "list_chunk", + "FieldName": "", + "Help": "Size of listing chunk 1-1000.", + "Default": 1000, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -2092,17 +1687,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "15s", - "ValueStr": "15s", - "Type": "Duration" + "DefaultStr": "1000", + "ValueStr": "1000", + "Type": "int" }, { - "Name": "db_wait_time", - "Help": "How long to wait for the DB to be available - 0 is unlimited.\n\nOnly one process can have the DB open at any one time, so rclone waits\nfor this duration for the DB to become available before it gives an\nerror.\n\nIf you set it to 0 then it will wait forever.", - "Provider": "", - "Default": 1000000000, + "Name": "owned_by", + "FieldName": "", + "Help": "Only show items owned by the login (email address) passed in.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -2110,35 +1704,78 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "1s", - "ValueStr": "1s", - "Type": "Duration" - } - ], - "CommandHelp": [ + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, { - "Name": "stats", - "Short": "Print stats on the cache backend in JSON format.", - "Long": "", - "Opts": null + "Name": "impersonate", + "FieldName": "", + "Help": "Impersonate this user ID when using a service account.\n\nSetting this flag allows rclone, when using a JWT service account, to\nact on behalf of another user by setting the as-user header.\n\nThe user ID is the Box identifier for a user. User IDs can found for\nany user via the GET /users endpoint, which is only available to\nadmins, or by calling the GET /users/me endpoint with an authenticated\nuser session.\n\nSee: https://developer.box.com/guides/authentication/jwt/as-user/\n", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 52535298, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot", + "ValueStr": "Slash,BackSlash,Del,Ctl,RightSpace,InvalidUtf8,Dot", + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], + "CommandHelp": null, "Aliases": null, "Hide": false, "MetadataInfo": null }, { - "Name": "chunker", - "Description": "Transparently chunk/split large files", - "Prefix": "chunker", + "Name": "cache", + "Description": "Cache a remote", + "Prefix": "cache", "Options": [ { "Name": "remote", - "Help": "Remote to chunk/unchunk.\n\nNormally should contain a ':' and a path, e.g. \"myremote:path/to/dir\",\n\"myremote:bucket\" or maybe \"myremote:\" (not recommended).", - "Provider": "", + "FieldName": "", + "Help": "Remote to cache.\n\nNormally should contain a ':' and a path, e.g. \"myremote:path/to/dir\",\n\"myremote:bucket\" or maybe \"myremote:\" (not recommended).", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": true, "IsPassword": false, @@ -2151,12 +1788,11 @@ "Type": "string" }, { - "Name": "chunk_size", - "Help": "Files larger than chunk size will be split in chunks.", - "Provider": "", - "Default": 2147483648, + "Name": "plex_url", + "FieldName": "", + "Help": "The URL of the Plex server.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -2164,120 +1800,98 @@ "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "2Gi", - "ValueStr": "2Gi", - "Type": "SizeSuffix" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "name_format", - "Help": "String format of chunk file names.\n\nThe two placeholders are: base file name (*) and chunk number (#...).\nThere must be one and only one asterisk and one or more consecutive hash characters.\nIf chunk number has less digits than the number of hashes, it is left-padded by zeros.\nIf there are more digits in the number, they are left as is.\nPossible chunk files are ignored if their name does not match given format.", - "Provider": "", - "Default": "*.rclone_chunk.###", + "Name": "plex_username", + "FieldName": "", + "Help": "The username of the Plex user.", + "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 1, + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "plex_password", + "FieldName": "", + "Help": "The password of the Plex user.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": true, + "NoPrefix": false, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "*.rclone_chunk.###", - "ValueStr": "*.rclone_chunk.###", + "DefaultStr": "", + "ValueStr": "", "Type": "string" }, { - "Name": "start_from", - "Help": "Minimum valid chunk number. Usually 0 or 1.\n\nBy default chunk numbers start from 1.", - "Provider": "", - "Default": 1, + "Name": "plex_token", + "FieldName": "", + "Help": "The plex token for authentication - auto set normally.", + "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 1, + "Hide": 3, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "1", - "ValueStr": "1", - "Type": "int" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "meta_format", - "Help": "Format of the metadata object or \"none\".\n\nBy default \"simplejson\".\nMetadata is a small JSON file named after the composite file.", - "Provider": "", - "Default": "simplejson", + "Name": "plex_insecure", + "FieldName": "", + "Help": "Skip all certificate verification when connecting to the Plex server.", + "Default": "", "Value": null, - "Examples": [ - { - "Value": "none", - "Help": "Do not use metadata files at all.\nRequires hash type \"none\".", - "Provider": "" - }, - { - "Value": "simplejson", - "Help": "Simple JSON supports hash sums and chunk validation.\n\nIt has the following fields: ver, size, nchunks, md5, sha1.", - "Provider": "" - } - ], - "ShortOpt": "", - "Hide": 1, + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "simplejson", - "ValueStr": "simplejson", + "DefaultStr": "", + "ValueStr": "", "Type": "string" }, { - "Name": "hash_type", - "Help": "Choose how chunker handles hash sums.\n\nAll modes but \"none\" require metadata.", - "Provider": "", - "Default": "md5", + "Name": "chunk_size", + "FieldName": "", + "Help": "The size of a chunk (partial file data).\n\nUse lower numbers for slower connections. If the chunk size is\nchanged, any downloaded chunks will be invalid and cache-chunk-path\nwill need to be cleared or unexpected EOF errors will occur.", + "Default": 5242880, "Value": null, "Examples": [ { - "Value": "none", - "Help": "Pass any hash supported by wrapped remote for non-chunked files.\nReturn nothing otherwise.", - "Provider": "" - }, - { - "Value": "md5", - "Help": "MD5 for composite files.", - "Provider": "" - }, - { - "Value": "sha1", - "Help": "SHA1 for composite files.", - "Provider": "" - }, - { - "Value": "md5all", - "Help": "MD5 for all files.", - "Provider": "" - }, - { - "Value": "sha1all", - "Help": "SHA1 for all files.", - "Provider": "" + "Value": "1M", + "Help": "1 MiB" }, { - "Value": "md5quick", - "Help": "Copying a file to chunker will request MD5 from the source.\nFalling back to SHA1 if unsupported.", - "Provider": "" + "Value": "5M", + "Help": "5 MiB" }, { - "Value": "sha1quick", - "Help": "Similar to \"md5quick\" but prefers SHA1 over MD5.", - "Provider": "" + "Value": "10M", + "Help": "10 MiB" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -2285,168 +1899,129 @@ "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "md5", - "ValueStr": "md5", - "Type": "string" + "DefaultStr": "5Mi", + "ValueStr": "5Mi", + "Type": "SizeSuffix" }, { - "Name": "fail_hard", - "Help": "Choose how chunker should handle files with missing or invalid chunks.", - "Provider": "", - "Default": false, + "Name": "info_age", + "FieldName": "", + "Help": "How long to cache file structure information (directory listings, file size, times, etc.). \nIf all write operations are done through the cache then you can safely make\nthis value very large as the cache store will also be updated in real time.", + "Default": 21600000000000, "Value": null, "Examples": [ { - "Value": "true", - "Help": "Report errors and abort current command.", - "Provider": "" + "Value": "1h", + "Help": "1 hour" }, { - "Value": "false", - "Help": "Warn user, skip incomplete file and proceed.", - "Provider": "" + "Value": "24h", + "Help": "24 hours" + }, + { + "Value": "48h", + "Help": "48 hours" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "6h0m0s", + "ValueStr": "6h0m0s", + "Type": "Duration" }, { - "Name": "transactions", - "Help": "Choose how chunker should handle temporary files during transactions.", - "Provider": "", - "Default": "rename", + "Name": "chunk_total_size", + "FieldName": "", + "Help": "The total size that the chunks can take up on the local disk.\n\nIf the cache exceeds this value then it will start to delete the\noldest chunks until it goes under this value.", + "Default": 10737418240, "Value": null, "Examples": [ { - "Value": "rename", - "Help": "Rename temporary files after a successful transaction.", - "Provider": "" + "Value": "500M", + "Help": "500 MiB" }, { - "Value": "norename", - "Help": "Leave temporary file names and write transaction ID to metadata file.\nMetadata is required for no rename transactions (meta format cannot be \"none\").\nIf you are using norename transactions you should be careful not to downgrade Rclone\nas older versions of Rclone don't support this transaction style and will misinterpret\nfiles manipulated by norename transactions.\nThis method is EXPERIMENTAL, don't use on production systems.", - "Provider": "" + "Value": "1G", + "Help": "1 GiB" }, { - "Value": "auto", - "Help": "Rename or norename will be used depending on capabilities of the backend.\nIf meta format is set to \"none\", rename transactions will always be used.\nThis method is EXPERIMENTAL, don't use on production systems.", - "Provider": "" + "Value": "10G", + "Help": "10 GiB" } ], - "ShortOpt": "", - "Hide": 1, + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "rename", - "ValueStr": "rename", - "Type": "string" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "combine", - "Description": "Combine several remotes into one", - "Prefix": "combine", - "Options": [ + "DefaultStr": "10Gi", + "ValueStr": "10Gi", + "Type": "SizeSuffix" + }, { - "Name": "upstreams", - "Help": "Upstreams for combining\n\nThese should be in the form\n\n dir=remote:path dir2=remote2:path\n\nWhere before the = is specified the root directory and after is the remote to\nput there.\n\nEmbedded spaces can be added using quotes\n\n \"dir=remote:path with space\" \"dir2=remote2:path with space\"\n\n", - "Provider": "", - "Default": null, + "Name": "db_path", + "FieldName": "", + "Help": "Directory to store file structure metadata DB.\n\nThe remote name is used as the DB file name.", + "Default": "/home/zenon/.cache/rclone/cache-backend", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": true, + "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "SpaceSepList" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": { - "System": null, - "Help": "Any metadata supported by the underlying remote is read and written." - } - }, - { - "Name": "compress", - "Description": "Compress a remote", - "Prefix": "compress", - "Options": [ + "DefaultStr": "/home/zenon/.cache/rclone/cache-backend", + "ValueStr": "/home/zenon/.cache/rclone/cache-backend", + "Type": "string" + }, { - "Name": "remote", - "Help": "Remote to compress.", - "Provider": "", - "Default": "", + "Name": "chunk_path", + "FieldName": "", + "Help": "Directory to cache chunk files.\n\nPath to where partial file data (chunks) are stored locally. The remote\nname is appended to the final path.\n\nThis config follows the \"--cache-db-path\". If you specify a custom\nlocation for \"--cache-db-path\" and don't specify one for \"--cache-chunk-path\"\nthen \"--cache-chunk-path\" will use the same path as \"--cache-db-path\".", + "Default": "/home/zenon/.cache/rclone/cache-backend", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": true, + "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", + "DefaultStr": "/home/zenon/.cache/rclone/cache-backend", + "ValueStr": "/home/zenon/.cache/rclone/cache-backend", "Type": "string" }, { - "Name": "mode", - "Help": "Compression mode.", - "Provider": "", - "Default": "gzip", + "Name": "db_purge", + "FieldName": "", + "Help": "Clear all the cached data for this remote on start.", + "Default": false, "Value": null, - "Examples": [ - { - "Value": "gzip", - "Help": "Standard gzip compression with fastest parameters.", - "Provider": "" - } - ], - "ShortOpt": "", - "Hide": 0, + "Hide": 2, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "gzip", - "ValueStr": "gzip", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "level", - "Help": "GZIP compression level (-2 to 9).\n\nGenerally -1 (default, equivalent to 5) is recommended.\nLevels 1 to 9 increase compression at the cost of speed. Going past 6 \ngenerally offers very little return.\n\nLevel -2 uses Huffman encoding only. Only use if you know what you\nare doing.\nLevel 0 turns off compression.", - "Provider": "", - "Default": -1, + "Name": "chunk_clean_interval", + "FieldName": "", + "Help": "How often should the cache perform cleanups of the chunk storage.\n\nThe default value should be ok for most people. If you find that the\ncache goes over \"cache-chunk-total-size\" too often then try to lower\nthis value to force it to perform cleanups more often.", + "Default": 60000000000, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -2454,17 +2029,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "-1", - "ValueStr": "-1", - "Type": "int" + "DefaultStr": "1m0s", + "ValueStr": "1m0s", + "Type": "Duration" }, { - "Name": "ram_cache_limit", - "Help": "Some remotes don't allow the upload of files with unknown size.\nIn this case the compressed file will need to be cached to determine\nit's size.\n\nFiles smaller than this limit will be cached in RAM, files larger than \nthis limit will be cached on disk.", - "Provider": "", - "Default": 20971520, + "Name": "read_retries", + "FieldName": "", + "Help": "How many times to retry a read from a cache storage.\n\nSince reading from a cache stream is independent from downloading file\ndata, readers can get to a point where there's no more data in the\ncache. Most of the times this can indicate a connectivity issue if\ncache isn't able to provide file data anymore.\n\nFor really slow connections, increase this to a point where the stream is\nable to provide data but your experience will be very stuttering.", + "Default": 10, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -2472,85 +2046,67 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "20Mi", - "ValueStr": "20Mi", - "Type": "SizeSuffix" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": { - "System": null, - "Help": "Any metadata supported by the underlying remote is read and written." - } - }, - { - "Name": "drive", - "Description": "Google Drive", - "Prefix": "drive", - "Options": [ + "DefaultStr": "10", + "ValueStr": "10", + "Type": "int" + }, { - "Name": "client_id", - "Help": "Google Application Client Id\nSetting your own is recommended.\nSee https://rclone.org/drive/#making-your-own-client-id for how to create your own.\nIf you leave this blank, it will use an internal key which is low performance.", - "Provider": "", - "Default": "", + "Name": "workers", + "FieldName": "", + "Help": "How many workers should run in parallel to download chunks.\n\nHigher values will mean more parallel processing (better CPU needed)\nand more concurrent requests on the cloud provider. This impacts\nseveral aspects like the cloud provider API limits, more stress on the\nhardware that rclone runs on but it also means that streams will be\nmore fluid and data will be available much more faster to readers.\n\n**Note**: If the optional Plex integration is enabled then this\nsetting will adapt to the type of reading performed and the value\nspecified here will be used as a maximum number of workers to use.", + "Default": 4, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "4", + "ValueStr": "4", + "Type": "int" }, { - "Name": "client_secret", - "Help": "OAuth Client Secret.\n\nLeave blank normally.", - "Provider": "", - "Default": "", + "Name": "chunk_no_memory", + "FieldName": "", + "Help": "Disable the in-memory cache for storing chunks during streaming.\n\nBy default, cache will keep file data during streaming in RAM as well\nto provide it to readers as fast as possible.\n\nThis transient data is evicted as soon as it is read and the number of\nchunks stored doesn't exceed the number of workers. However, depending\non other settings like \"cache-chunk-size\" and \"cache-workers\" this footprint\ncan increase if there are parallel streams too (multiple files being read\nat the same time).\n\nIf the hardware permits it, use this feature to provide an overall better\nperformance during streaming but it can also be disabled if RAM is not\navailable on the local machine.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "token", - "Help": "OAuth Access Token as a JSON blob.", - "Provider": "", - "Default": "", + "Name": "rps", + "FieldName": "", + "Help": "Limits the number of requests per second to the source FS (-1 to disable).\n\nThis setting places a hard limit on the number of requests per second\nthat cache will be doing to the cloud provider remote and try to\nrespect that value by setting waits between reads.\n\nIf you find that you're getting banned or limited on the cloud\nprovider through cache and know that a smaller number of requests per\nsecond will allow you to work with it then you can use this setting\nfor that.\n\nA good balance of all the other settings should make this setting\nuseless but it is available to set for more special cases.\n\n**NOTE**: This will limit the number of requests during streams but\nother API calls to the cloud provider like directory listings will\nstill pass.", + "Default": -1, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "-1", + "ValueStr": "-1", + "Type": "int" }, { - "Name": "auth_url", - "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", - "Provider": "", - "Default": "", + "Name": "writes", + "FieldName": "", + "Help": "Cache file data on writes through the FS.\n\nIf you need to read files immediately after you upload them through\ncache you can enable this flag to have their data stored in the\ncache store at the same time during upload.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -2558,17 +2114,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "token_url", - "Help": "Token server url.\n\nLeave blank to use the provider defaults.", - "Provider": "", + "Name": "tmp_upload_path", + "FieldName": "", + "Help": "Directory to keep temporary files until they are uploaded.\n\nThis is the path where cache will use as a temporary storage for new\nfiles that need to be uploaded to the cloud provider.\n\nSpecifying a value will enable this feature. Without it, it is\ncompletely disabled and files will be uploaded directly to the cloud\nprovider", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -2581,201 +2136,232 @@ "Type": "string" }, { - "Name": "scope", - "Help": "Scope that rclone should use when requesting access from drive.", - "Provider": "", - "Default": "", + "Name": "tmp_wait_time", + "FieldName": "", + "Help": "How long should files be stored in local cache before being uploaded.\n\nThis is the duration that a file must wait in the temporary location\n_cache-tmp-upload-path_ before it is selected for upload.\n\nNote that only one file is uploaded at a time and it can take longer\nto start the upload if a queue formed for this purpose.", + "Default": 15000000000, "Value": null, - "Examples": [ - { - "Value": "drive", - "Help": "Full access all files, excluding Application Data Folder.", - "Provider": "" - }, - { - "Value": "drive.readonly", - "Help": "Read-only access to file metadata and file contents.", - "Provider": "" - }, - { - "Value": "drive.file", - "Help": "Access to files created by rclone only.\nThese are visible in the drive website.\nFile authorization is revoked when the user deauthorizes the app.", - "Provider": "" - }, - { - "Value": "drive.appfolder", - "Help": "Allows read and write access to the Application Data folder.\nThis is not visible in the drive website.", - "Provider": "" - }, - { - "Value": "drive.metadata.readonly", - "Help": "Allows read-only access to file metadata but\ndoes not allow any access to read or download file content.", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "15s", + "ValueStr": "15s", + "Type": "Duration" }, { - "Name": "root_folder_id", - "Help": "ID of the root folder.\nLeave blank normally.\n\nFill in to access \"Computers\" folders (see docs), or for rclone to use\na non root folder as its starting point.\n", - "Provider": "", - "Default": "", + "Name": "db_wait_time", + "FieldName": "", + "Help": "How long to wait for the DB to be available - 0 is unlimited.\n\nOnly one process can have the DB open at any one time, so rclone waits\nfor this duration for the DB to become available before it gives an\nerror.\n\nIf you set it to 0 then it will wait forever.", + "Default": 1000000000, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "1s", + "ValueStr": "1s", + "Type": "Duration" }, { - "Name": "service_account_file", - "Help": "Service Account Credentials JSON file path.\n\nLeave blank normally.\nNeeded only if you want use SA instead of interactive login.\n\nLeading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.", - "Provider": "", + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" - }, + } + ], + "CommandHelp": [ { - "Name": "service_account_credentials", - "Help": "Service Account Credentials JSON blob.\n\nLeave blank normally.\nNeeded only if you want use SA instead of interactive login.", - "Provider": "", + "Name": "stats", + "Short": "Print stats on the cache backend in JSON format.", + "Long": "", + "Opts": null + } + ], + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "chunker", + "Description": "Transparently chunk/split large files", + "Prefix": "chunker", + "Options": [ + { + "Name": "remote", + "FieldName": "", + "Help": "Remote to chunk/unchunk.\n\nNormally should contain a ':' and a path, e.g. \"myremote:path/to/dir\",\n\"myremote:bucket\" or maybe \"myremote:\" (not recommended).", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 2, - "Required": false, + "Hide": 0, + "Required": true, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "team_drive", - "Help": "ID of the Shared Drive (Team Drive).", - "Provider": "", - "Default": "", + "Name": "chunk_size", + "FieldName": "", + "Help": "Files larger than chunk size will be split in chunks.", + "Default": 2147483648, "Value": null, - "ShortOpt": "", - "Hide": 2, + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "2Gi", + "ValueStr": "2Gi", + "Type": "SizeSuffix" }, { - "Name": "auth_owner_only", - "Help": "Only consider files owned by the authenticated user.", - "Provider": "", - "Default": false, + "Name": "name_format", + "FieldName": "", + "Help": "String format of chunk file names.\n\nThe two placeholders are: base file name (*) and chunk number (#...).\nThere must be one and only one asterisk and one or more consecutive hash characters.\nIf chunk number has less digits than the number of hashes, it is left-padded by zeros.\nIf there are more digits in the number, they are left as is.\nPossible chunk files are ignored if their name does not match given format.", + "Default": "*.rclone_chunk.###", "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 1, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "*.rclone_chunk.###", + "ValueStr": "*.rclone_chunk.###", + "Type": "string" }, { - "Name": "use_trash", - "Help": "Send files to the trash instead of deleting permanently.\n\nDefaults to true, namely sending files to the trash.\nUse `--drive-use-trash=false` to delete files permanently instead.", - "Provider": "", - "Default": true, + "Name": "start_from", + "FieldName": "", + "Help": "Minimum valid chunk number. Usually 0 or 1.\n\nBy default chunk numbers start from 1.", + "Default": 1, "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 1, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "true", - "ValueStr": "true", - "Type": "bool" + "DefaultStr": "1", + "ValueStr": "1", + "Type": "int" }, { - "Name": "copy_shortcut_content", - "Help": "Server side copy contents of shortcuts instead of the shortcut.\n\nWhen doing server side copies, normally rclone will copy shortcuts as\nshortcuts.\n\nIf this flag is used then rclone will copy the contents of shortcuts\nrather than shortcuts themselves when doing server side copies.", - "Provider": "", - "Default": false, + "Name": "meta_format", + "FieldName": "", + "Help": "Format of the metadata object or \"none\".\n\nBy default \"simplejson\".\nMetadata is a small JSON file named after the composite file.", + "Default": "simplejson", "Value": null, - "ShortOpt": "", - "Hide": 0, + "Examples": [ + { + "Value": "none", + "Help": "Do not use metadata files at all.\nRequires hash type \"none\"." + }, + { + "Value": "simplejson", + "Help": "Simple JSON supports hash sums and chunk validation.\n\nIt has the following fields: ver, size, nchunks, md5, sha1." + } + ], + "Hide": 1, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "simplejson", + "ValueStr": "simplejson", + "Type": "string" }, { - "Name": "skip_gdocs", - "Help": "Skip google documents in all listings.\n\nIf given, gdocs practically become invisible to rclone.", - "Provider": "", - "Default": false, + "Name": "hash_type", + "FieldName": "", + "Help": "Choose how chunker handles hash sums.\n\nAll modes but \"none\" require metadata.", + "Default": "md5", "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "none", + "Help": "Pass any hash supported by wrapped remote for non-chunked files.\nReturn nothing otherwise." + }, + { + "Value": "md5", + "Help": "MD5 for composite files." + }, + { + "Value": "sha1", + "Help": "SHA1 for composite files." + }, + { + "Value": "md5all", + "Help": "MD5 for all files." + }, + { + "Value": "sha1all", + "Help": "SHA1 for all files." + }, + { + "Value": "md5quick", + "Help": "Copying a file to chunker will request MD5 from the source.\nFalling back to SHA1 if unsupported." + }, + { + "Value": "sha1quick", + "Help": "Similar to \"md5quick\" but prefers SHA1 over MD5." + } + ], "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "md5", + "ValueStr": "md5", + "Type": "string" }, { - "Name": "skip_checksum_gphotos", - "Help": "Skip MD5 checksum on Google photos and videos only.\n\nUse this if you get checksum errors when transferring Google photos or\nvideos.\n\nSetting this flag will cause Google photos and videos to return a\nblank MD5 checksum.\n\nGoogle photos are identified by being in the \"photos\" space.\n\nCorrupted checksums are caused by Google modifying the image/video but\nnot updating the checksum.", - "Provider": "", + "Name": "fail_hard", + "FieldName": "", + "Help": "Choose how chunker should handle files with missing or invalid chunks.", "Default": false, "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "true", + "Help": "Report errors and abort current command." + }, + { + "Value": "false", + "Help": "Warn user, skip incomplete file and proceed." + } + ], "Hide": 0, "Required": false, "IsPassword": false, @@ -2788,30 +2374,42 @@ "Type": "bool" }, { - "Name": "shared_with_me", - "Help": "Only show files that are shared with me.\n\nInstructs rclone to operate on your \"Shared with me\" folder (where\nGoogle Drive lets you access the files and folders others have shared\nwith you).\n\nThis works both with the \"list\" (lsd, lsl, etc.) and the \"copy\"\ncommands (copy, sync, etc.), and with all other commands too.", - "Provider": "", - "Default": false, + "Name": "transactions", + "FieldName": "", + "Help": "Choose how chunker should handle temporary files during transactions.", + "Default": "rename", "Value": null, - "ShortOpt": "", - "Hide": 0, + "Examples": [ + { + "Value": "rename", + "Help": "Rename temporary files after a successful transaction." + }, + { + "Value": "norename", + "Help": "Leave temporary file names and write transaction ID to metadata file.\nMetadata is required for no rename transactions (meta format cannot be \"none\").\nIf you are using norename transactions you should be careful not to downgrade Rclone\nas older versions of Rclone don't support this transaction style and will misinterpret\nfiles manipulated by norename transactions.\nThis method is EXPERIMENTAL, don't use on production systems." + }, + { + "Value": "auto", + "Help": "Rename or norename will be used depending on capabilities of the backend.\nIf meta format is set to \"none\", rename transactions will always be used.\nThis method is EXPERIMENTAL, don't use on production systems." + } + ], + "Hide": 1, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "rename", + "ValueStr": "rename", + "Type": "string" }, { - "Name": "trashed_only", - "Help": "Only show files that are in the trash.\n\nThis will show trashed files in their original directory structure.", - "Provider": "", - "Default": false, + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -2819,36 +2417,45 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" - }, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "combine", + "Description": "Combine several remotes into one", + "Prefix": "combine", + "Options": [ { - "Name": "starred_only", - "Help": "Only show files that are starred.", - "Provider": "", - "Default": false, + "Name": "upstreams", + "FieldName": "", + "Help": "Upstreams for combining\n\nThese should be in the form\n\n dir=remote:path dir2=remote2:path\n\nWhere before the = is specified the root directory and after is the remote to\nput there.\n\nEmbedded spaces can be added using quotes\n\n \"dir=remote:path with space\" \"dir2=remote2:path with space\"\n\n", + "Default": null, "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, + "Required": true, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "", + "ValueStr": "", + "Type": "SpaceSepList" }, { - "Name": "formats", - "Help": "Deprecated: See export_formats.", - "Provider": "", + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 2, + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, @@ -2858,50 +2465,67 @@ "DefaultStr": "", "ValueStr": "", "Type": "string" - }, + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": { + "System": null, + "Help": "Any metadata supported by the underlying remote is read and written." + } + }, + { + "Name": "compress", + "Description": "Compress a remote", + "Prefix": "compress", + "Options": [ { - "Name": "export_formats", - "Help": "Comma separated list of preferred formats for downloading Google docs.", - "Provider": "", - "Default": "docx,xlsx,pptx,svg", + "Name": "remote", + "FieldName": "", + "Help": "Remote to compress.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, + "Required": true, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "docx,xlsx,pptx,svg", - "ValueStr": "docx,xlsx,pptx,svg", + "DefaultStr": "", + "ValueStr": "", "Type": "string" }, { - "Name": "import_formats", - "Help": "Comma separated list of preferred formats for uploading Google docs.", - "Provider": "", - "Default": "", + "Name": "mode", + "FieldName": "", + "Help": "Compression mode.", + "Default": "gzip", "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "gzip", + "Help": "Standard gzip compression with fastest parameters." + } + ], "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", + "DefaultStr": "gzip", + "ValueStr": "gzip", "Type": "string" }, { - "Name": "allow_import_name_change", - "Help": "Allow the filetype to change when uploading Google docs.\n\nE.g. file.doc to file.docx. This will confuse sync and reupload every time.", - "Provider": "", - "Default": false, + "Name": "level", + "FieldName": "", + "Help": "GZIP compression level (-2 to 9).\n\nGenerally -1 (default, equivalent to 5) is recommended.\nLevels 1 to 9 increase compression at the cost of speed. Going past 6 \ngenerally offers very little return.\n\nLevel -2 uses Huffman encoding only. Only use if you know what you\nare doing.\nLevel 0 turns off compression.", + "Default": -1, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -2909,143 +2533,173 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "-1", + "ValueStr": "-1", + "Type": "int" }, { - "Name": "use_created_date", - "Help": "Use file created date instead of modified date.\n\nUseful when downloading data and you want the creation date used in\nplace of the last modified date.\n\n**WARNING**: This flag may have some unexpected consequences.\n\nWhen uploading to your drive all files will be overwritten unless they\nhaven't been modified since their creation. And the inverse will occur\nwhile downloading. This side effect can be avoided by using the\n\"--checksum\" flag.\n\nThis feature was implemented to retain photos capture date as recorded\nby google photos. You will first need to check the \"Create a Google\nPhotos folder\" option in your google drive settings. You can then copy\nor move the photos locally and use the date the image was taken\n(created) set as the modification date.", - "Provider": "", - "Default": false, + "Name": "ram_cache_limit", + "FieldName": "", + "Help": "Some remotes don't allow the upload of files with unknown size.\nIn this case the compressed file will need to be cached to determine\nit's size.\n\nFiles smaller than this limit will be cached in RAM, files larger than \nthis limit will be cached on disk.", + "Default": 20971520, "Value": null, - "ShortOpt": "", - "Hide": 2, + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "20Mi", + "ValueStr": "20Mi", + "Type": "SizeSuffix" }, { - "Name": "use_shared_date", - "Help": "Use date file was shared instead of modified date.\n\nNote that, as with \"--drive-use-created-date\", this flag may have\nunexpected consequences when uploading/downloading files.\n\nIf both this flag and \"--drive-use-created-date\" are set, the created\ndate is used.", - "Provider": "", - "Default": false, + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 2, + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" - }, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": { + "System": null, + "Help": "Any metadata supported by the underlying remote is read and written." + } + }, + { + "Name": "crypt", + "Description": "Encrypt/Decrypt a remote", + "Prefix": "crypt", + "Options": [ { - "Name": "list_chunk", - "Help": "Size of listing chunk 100-1000, 0 to disable.", - "Provider": "", - "Default": 1000, + "Name": "remote", + "FieldName": "", + "Help": "Remote to encrypt/decrypt.\n\nNormally should contain a ':' and a path, e.g. \"myremote:path/to/dir\",\n\"myremote:bucket\" or maybe \"myremote:\" (not recommended).", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, + "Required": true, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "1000", - "ValueStr": "1000", - "Type": "int" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "impersonate", - "Help": "Impersonate this user when using a service account.", - "Provider": "", - "Default": "", + "Name": "filename_encryption", + "FieldName": "", + "Help": "How to encrypt the filenames.", + "Default": "standard", "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "standard", + "Help": "Encrypt the filenames.\nSee the docs for the details." + }, + { + "Value": "obfuscate", + "Help": "Very simple filename obfuscation." + }, + { + "Value": "off", + "Help": "Don't encrypt the file names.\nAdds a \".bin\", or \"suffix\" extension only." + } + ], "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", + "Sensitive": false, + "DefaultStr": "standard", + "ValueStr": "standard", "Type": "string" }, { - "Name": "alternate_export", - "Help": "Deprecated: No longer needed.", - "Provider": "", - "Default": false, + "Name": "directory_name_encryption", + "FieldName": "", + "Help": "Option to either encrypt directory names or leave them intact.\n\nNB If filename_encryption is \"off\" then this option will do nothing.", + "Default": true, "Value": null, - "ShortOpt": "", - "Hide": 3, + "Examples": [ + { + "Value": "true", + "Help": "Encrypt directory names." + }, + { + "Value": "false", + "Help": "Don't encrypt directory names, leave them intact." + } + ], + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", + "DefaultStr": "true", + "ValueStr": "true", "Type": "bool" }, { - "Name": "upload_cutoff", - "Help": "Cutoff for switching to chunked upload.", - "Provider": "", - "Default": 8388608, + "Name": "password", + "FieldName": "", + "Help": "Password or pass phrase for encryption.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, - "IsPassword": false, + "Required": true, + "IsPassword": true, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "8Mi", - "ValueStr": "8Mi", - "Type": "SizeSuffix" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "chunk_size", - "Help": "Upload chunk size.\n\nMust a power of 2 \u003e= 256k.\n\nMaking this larger will improve performance, but note that each chunk\nis buffered in memory one per transfer.\n\nReducing this will reduce memory usage but decrease performance.", - "Provider": "", - "Default": 8388608, + "Name": "password2", + "FieldName": "", + "Help": "Password or pass phrase for salt.\n\nOptional but recommended.\nShould be different to the previous password.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, - "IsPassword": false, + "IsPassword": true, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "8Mi", - "ValueStr": "8Mi", - "Type": "SizeSuffix" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "acknowledge_abuse", - "Help": "Set to allow files which return cannotDownloadAbusiveFile to be downloaded.\n\nIf downloading a file returns the error \"This file has been identified\nas malware or spam and cannot be downloaded\" with the error code\n\"cannotDownloadAbusiveFile\" then supply this flag to rclone to\nindicate you acknowledge the risks of downloading the file and rclone\nwill download it anyway.\n\nNote that if you are using service account it will need Manager\npermission (not Content Manager) to for this flag to work. If the SA\ndoes not have the right permission, Google will just ignore the flag.", - "Provider": "", + "Name": "server_side_across_configs", + "FieldName": "", + "Help": "Deprecated: use --server-side-across-configs instead.\n\nAllow server-side operations (e.g. copy) to work across different crypt configs.\n\nNormally this option is not what you want, but if you have two crypts\npointing to the same backend you can use it.\n\nThis can be used, for example, to change file name encryption type\nwithout re-uploading all the data. Just make two crypt backends\npointing to two different directories with the single changed\nparameter and use rclone move to move the files between the crypt\nremotes.", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3058,13 +2712,12 @@ "Type": "bool" }, { - "Name": "keep_revision_forever", - "Help": "Keep new head revision of each file forever.", - "Provider": "", + "Name": "show_mapping", + "FieldName": "", + "Help": "For all files listed show how the names encrypt.\n\nIf this flag is set then for each file that the remote is asked to\nlist, it will log (at level INFO) a line stating the decrypted file\nname and the encrypted file name.\n\nThis is so you can work out which encrypted names are which decrypted\nnames just in case you need to do something with the encrypted file\nnames, or for debugging purposes.", "Default": false, "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 2, "Required": false, "IsPassword": false, "NoPrefix": false, @@ -3076,13 +2729,22 @@ "Type": "bool" }, { - "Name": "size_as_quota", - "Help": "Show sizes as storage quota usage, not actual size.\n\nShow the size of a file as the storage quota used. This is the\ncurrent version plus any older versions that have been set to keep\nforever.\n\n**WARNING**: This flag may have some unexpected consequences.\n\nIt is not recommended to set this flag in your config - the\nrecommended usage is using the flag form --drive-size-as-quota when\ndoing rclone ls/lsl/lsf/lsjson/etc only.\n\nIf you do use this flag for syncing (not recommended) then you will\nneed to use --ignore size also.", - "Provider": "", + "Name": "no_data_encryption", + "FieldName": "", + "Help": "Option to either encrypt file data or leave it unencrypted.", "Default": false, "Value": null, - "ShortOpt": "", - "Hide": 2, + "Examples": [ + { + "Value": "true", + "Help": "Don't encrypt file data, leave it unencrypted." + }, + { + "Value": "false", + "Help": "Encrypt file data." + } + ], + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, @@ -3094,12 +2756,11 @@ "Type": "bool" }, { - "Name": "v2_download_min_size", - "Help": "If Object's are greater, use drive v2 API to download.", - "Provider": "", - "Default": -1, + "Name": "pass_bad_blocks", + "FieldName": "", + "Help": "If set this will pass bad blocks through as all 0.\n\nThis should not be set in normal operation, it should only be set if\ntrying to recover an encrypted file with errors and it is desired to\nrecover as much of the file as possible.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3107,17 +2768,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "off", - "ValueStr": "off", - "Type": "SizeSuffix" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "pacer_min_sleep", - "Help": "Minimum time to sleep between API calls.", - "Provider": "", - "Default": 100000000, + "Name": "strict_names", + "FieldName": "", + "Help": "If set, this will raise an error when crypt comes across a filename that can't be decrypted.\n\n(By default, rclone will just log a NOTICE and continue as normal.)\nThis can happen if encrypted and unencrypted files are stored in the same\ndirectory (which is not recommended.) It may also indicate a more serious\nproblem that should be investigated.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3125,17 +2785,30 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "100ms", - "ValueStr": "100ms", - "Type": "Duration" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "pacer_burst", - "Help": "Number of API calls to allow without sleeping.", - "Provider": "", - "Default": 100, + "Name": "filename_encoding", + "FieldName": "", + "Help": "How to encode the encrypted filename to text string.\n\nThis option could help with shortening the encrypted filename. The \nsuitable option would depend on the way your remote count the filename\nlength and if it's case sensitive.", + "Default": "base32", "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "base32", + "Help": "Encode using base32. Suitable for all remote." + }, + { + "Value": "base64", + "Help": "Encode using base64. Suitable for case sensitive remote." + }, + { + "Value": "base32768", + "Help": "Encode using base32768. Suitable if your remote counts UTF-16 or\nUnicode codepoint instead of UTF-8 byte length. (Eg. Onedrive, Dropbox)" + } + ], "Hide": 0, "Required": false, "IsPassword": false, @@ -3143,17 +2816,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "100", - "ValueStr": "100", - "Type": "int" + "DefaultStr": "base32", + "ValueStr": "base32", + "Type": "string" }, { - "Name": "server_side_across_configs", - "Help": "Deprecated: use --server-side-across-configs instead.\n\nAllow server-side operations (e.g. copy) to work across different drive configs.\n\nThis can be useful if you wish to do a server-side copy between two\ndifferent Google drives. Note that this isn't enabled by default\nbecause it isn't easy to tell if it will work between any two\nconfigurations.", - "Provider": "", - "Default": false, + "Name": "suffix", + "FieldName": "", + "Help": "If this is set it will override the default suffix of \".bin\".\n\nSetting suffix to \"none\" will result in an empty suffix. This may be useful \nwhen the path length is critical.", + "Default": ".bin", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3161,17 +2833,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": ".bin", + "ValueStr": ".bin", + "Type": "string" }, { - "Name": "disable_http2", - "Help": "Disable drive using http2.\n\nThere is currently an unsolved issue with the google drive backend and\nHTTP/2. HTTP/2 is therefore disabled by default for the drive backend\nbut can be re-enabled here. When the issue is solved this flag will\nbe removed.\n\nSee: https://github.com/rclone/rclone/issues/3631\n\n", - "Provider": "", - "Default": true, + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3179,71 +2850,94 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "true", - "ValueStr": "true", - "Type": "bool" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": [ + { + "Name": "encode", + "Short": "Encode the given filename(s)", + "Long": "This encodes the filenames given as arguments returning a list of\nstrings of the encoded results.\n\nUsage Example:\n\n rclone backend encode crypt: file1 [file2...]\n rclone rc backend/command command=encode fs=crypt: file1 [file2...]\n", + "Opts": null }, { - "Name": "stop_on_upload_limit", - "Help": "Make upload limit errors be fatal.\n\nAt the time of writing it is only possible to upload 750 GiB of data to\nGoogle Drive a day (this is an undocumented limit). When this limit is\nreached Google Drive produces a slightly different error message. When\nthis flag is set it causes these errors to be fatal. These will stop\nthe in-progress sync.\n\nNote that this detection is relying on error message strings which\nGoogle don't document so it may break in the future.\n\nSee: https://github.com/rclone/rclone/issues/3857\n", - "Provider": "", - "Default": false, + "Name": "decode", + "Short": "Decode the given filename(s)", + "Long": "This decodes the filenames given as arguments returning a list of\nstrings of the decoded results. It will return an error if any of the\ninputs are invalid.\n\nUsage Example:\n\n rclone backend decode crypt: encryptedfile1 [encryptedfile2...]\n rclone rc backend/command command=decode fs=crypt: encryptedfile1 [encryptedfile2...]\n", + "Opts": null + } + ], + "Aliases": null, + "Hide": false, + "MetadataInfo": { + "System": null, + "Help": "Any metadata supported by the underlying remote is read and written." + } + }, + { + "Name": "drive", + "Description": "Google Drive", + "Prefix": "drive", + "Options": [ + { + "Name": "client_id", + "FieldName": "", + "Help": "Google Application Client Id\nSetting your own is recommended.\nSee https://rclone.org/drive/#making-your-own-client-id for how to create your own.\nIf you leave this blank, it will use an internal key which is low performance.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "stop_on_download_limit", - "Help": "Make download limit errors be fatal.\n\nAt the time of writing it is only possible to download 10 TiB of data from\nGoogle Drive a day (this is an undocumented limit). When this limit is\nreached Google Drive produces a slightly different error message. When\nthis flag is set it causes these errors to be fatal. These will stop\nthe in-progress sync.\n\nNote that this detection is relying on error message strings which\nGoogle don't document so it may break in the future.\n", - "Provider": "", - "Default": false, + "Name": "client_secret", + "FieldName": "", + "Help": "OAuth Client Secret.\n\nLeave blank normally.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "skip_shortcuts", - "Help": "If set skip shortcut files.\n\nNormally rclone dereferences shortcut files making them appear as if\nthey are the original file (see [the shortcuts section](#shortcuts)).\nIf this flag is set then rclone will ignore shortcut files completely.\n", - "Provider": "", - "Default": false, + "Name": "token", + "FieldName": "", + "Help": "OAuth Access Token as a JSON blob.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "skip_dangling_shortcuts", - "Help": "If set skip dangling shortcut files.\n\nIf this is set then rclone will not show any dangling shortcuts in listings.\n", - "Provider": "", - "Default": false, + "Name": "auth_url", + "FieldName": "", + "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3251,156 +2945,77 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "resource_key", - "Help": "Resource key for accessing a link-shared file.\n\nIf you need to access files shared with a link like this\n\n https://drive.google.com/drive/folders/XXX?resourcekey=YYY\u0026usp=sharing\n\nThen you will need to use the first part \"XXX\" as the \"root_folder_id\"\nand the second part \"YYY\" as the \"resource_key\" otherwise you will get\n404 not found errors when trying to access the directory.\n\nSee: https://developers.google.com/drive/api/guides/resource-keys\n\nThis resource key requirement only applies to a subset of old files.\n\nNote also that opening the folder once in the web interface (with the\nuser you've authenticated rclone with) seems to be enough so that the\nresource key is no needed.\n", - "Provider": "", + "Name": "token_url", + "FieldName": "", + "Help": "Token server url.\n\nLeave blank to use the provider defaults.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 16777216, - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "InvalidUtf8", - "ValueStr": "InvalidUtf8", - "Type": "MultiEncoder" - }, - { - "Name": "env_auth", - "Help": "Get IAM credentials from runtime (environment variables or instance meta data if no env vars).\n\nOnly applies if service_account_file and service_account_credentials is blank.", - "Provider": "", - "Default": false, + "Name": "scope", + "FieldName": "", + "Help": "Comma separated list of scopes that rclone should use when requesting access from drive.", + "Default": "", "Value": null, "Examples": [ { - "Value": "false", - "Help": "Enter credentials in the next step.", - "Provider": "" + "Value": "drive", + "Help": "Full access all files, excluding Application Data Folder." }, { - "Value": "true", - "Help": "Get GCP IAM credentials from the environment (env vars or IAM).", - "Provider": "" + "Value": "drive.readonly", + "Help": "Read-only access to file metadata and file contents." + }, + { + "Value": "drive.file", + "Help": "Access to files created by rclone only.\nThese are visible in the drive website.\nFile authorization is revoked when the user deauthorizes the app." + }, + { + "Value": "drive.appfolder", + "Help": "Allows read and write access to the Application Data folder.\nThis is not visible in the drive website." + }, + { + "Value": "drive.metadata.readonly", + "Help": "Allows read-only access to file metadata but\ndoes not allow any access to read or download file content." } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" - } - ], - "CommandHelp": [ - { - "Name": "get", - "Short": "Get command for fetching the drive config parameters", - "Long": "This is a get command which will be used to fetch the various drive config parameters\n\nUsage Examples:\n\n rclone backend get drive: [-o service_account_file] [-o chunk_size]\n rclone rc backend/command command=get fs=drive: [-o service_account_file] [-o chunk_size]\n", - "Opts": { - "chunk_size": "show the current upload chunk size", - "service_account_file": "show the current service account file" - } - }, - { - "Name": "set", - "Short": "Set command for updating the drive config parameters", - "Long": "This is a set command which will be used to update the various drive config parameters\n\nUsage Examples:\n\n rclone backend set drive: [-o service_account_file=sa.json] [-o chunk_size=67108864]\n rclone rc backend/command command=set fs=drive: [-o service_account_file=sa.json] [-o chunk_size=67108864]\n", - "Opts": { - "chunk_size": "update the current upload chunk size", - "service_account_file": "update the current service account file" - } - }, - { - "Name": "shortcut", - "Short": "Create shortcuts from files or directories", - "Long": "This command creates shortcuts from files or directories.\n\nUsage:\n\n rclone backend shortcut drive: source_item destination_shortcut\n rclone backend shortcut drive: source_item -o target=drive2: destination_shortcut\n\nIn the first example this creates a shortcut from the \"source_item\"\nwhich can be a file or a directory to the \"destination_shortcut\". The\n\"source_item\" and the \"destination_shortcut\" should be relative paths\nfrom \"drive:\"\n\nIn the second example this creates a shortcut from the \"source_item\"\nrelative to \"drive:\" to the \"destination_shortcut\" relative to\n\"drive2:\". This may fail with a permission error if the user\nauthenticated with \"drive2:\" can't read files from \"drive:\".\n", - "Opts": { - "target": "optional target remote for the shortcut destination" - } - }, - { - "Name": "drives", - "Short": "List the Shared Drives available to this account", - "Long": "This command lists the Shared Drives (Team Drives) available to this\naccount.\n\nUsage:\n\n rclone backend [-o config] drives drive:\n\nThis will return a JSON list of objects like this\n\n [\n {\n \"id\": \"0ABCDEF-01234567890\",\n \"kind\": \"drive#teamDrive\",\n \"name\": \"My Drive\"\n },\n {\n \"id\": \"0ABCDEFabcdefghijkl\",\n \"kind\": \"drive#teamDrive\",\n \"name\": \"Test Drive\"\n }\n ]\n\nWith the -o config parameter it will output the list in a format\nsuitable for adding to a config file to make aliases for all the\ndrives found and a combined drive.\n\n [My Drive]\n type = alias\n remote = drive,team_drive=0ABCDEF-01234567890,root_folder_id=:\n\n [Test Drive]\n type = alias\n remote = drive,team_drive=0ABCDEFabcdefghijkl,root_folder_id=:\n\n [AllDrives]\n type = combine\n upstreams = \"My Drive=My Drive:\" \"Test Drive=Test Drive:\"\n\nAdding this to the rclone config file will cause those team drives to\nbe accessible with the aliases shown. Any illegal characters will be\nsubstituted with \"_\" and duplicate names will have numbers suffixed.\nIt will also add a remote called AllDrives which shows all the shared\ndrives combined into one directory tree.\n", - "Opts": null - }, - { - "Name": "untrash", - "Short": "Untrash files and directories", - "Long": "This command untrashes all the files and directories in the directory\npassed in recursively.\n\nUsage:\n\nThis takes an optional directory to trash which make this easier to\nuse via the API.\n\n rclone backend untrash drive:directory\n rclone backend --interactive untrash drive:directory subdir\n\nUse the --interactive/-i or --dry-run flag to see what would be restored before restoring it.\n\nResult:\n\n {\n \"Untrashed\": 17,\n \"Errors\": 0\n }\n", - "Opts": null - }, - { - "Name": "copyid", - "Short": "Copy files by ID", - "Long": "This command copies files by ID\n\nUsage:\n\n rclone backend copyid drive: ID path\n rclone backend copyid drive: ID1 path1 ID2 path2\n\nIt copies the drive file with ID given to the path (an rclone path which\nwill be passed internally to rclone copyto). The ID and path pairs can be\nrepeated.\n\nThe path should end with a / to indicate copy the file as named to\nthis directory. If it doesn't end with a / then the last path\ncomponent will be used as the file name.\n\nIf the destination is a drive backend then server-side copying will be\nattempted if possible.\n\nUse the --interactive/-i or --dry-run flag to see what would be copied before copying.\n", - "Opts": null - }, - { - "Name": "exportformats", - "Short": "Dump the export formats for debug purposes", - "Long": "", - "Opts": null + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "importformats", - "Short": "Dump the import formats for debug purposes", - "Long": "", - "Opts": null - } - ], - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "dropbox", - "Description": "Dropbox", - "Prefix": "dropbox", - "Options": [ - { - "Name": "client_id", - "Help": "OAuth Client Id.\n\nLeave blank normally.", - "Provider": "", + "Name": "root_folder_id", + "FieldName": "", + "Help": "ID of the root folder.\nLeave blank normally.\n\nFill in to access \"Computers\" folders (see docs), or for rclone to use\na non root folder as its starting point.\n", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": true, "DefaultStr": "", @@ -3408,31 +3023,29 @@ "Type": "string" }, { - "Name": "client_secret", - "Help": "OAuth Client Secret.\n\nLeave blank normally.", - "Provider": "", + "Name": "service_account_file", + "FieldName": "", + "Help": "Service Account Credentials JSON file path.\n\nLeave blank normally.\nNeeded only if you want use SA instead of interactive login.\n\nLeading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": false, "Exclusive": false, - "Sensitive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "token", - "Help": "OAuth Access Token as a JSON blob.", - "Provider": "", + "Name": "service_account_credentials", + "FieldName": "", + "Help": "Service Account Credentials JSON blob.\n\nLeave blank normally.\nNeeded only if you want use SA instead of interactive login.", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 2, "Required": false, "IsPassword": false, "NoPrefix": false, @@ -3444,30 +3057,28 @@ "Type": "string" }, { - "Name": "auth_url", - "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", - "Provider": "", + "Name": "team_drive", + "FieldName": "", + "Help": "ID of the Shared Drive (Team Drive).", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 2, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": false, + "Sensitive": true, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "token_url", - "Help": "Token server url.\n\nLeave blank to use the provider defaults.", - "Provider": "", - "Default": "", + "Name": "auth_owner_only", + "FieldName": "", + "Help": "Only consider files owned by the authenticated user.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3475,17 +3086,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "chunk_size", - "Help": "Upload chunk size (\u003c 150Mi).\n\nAny files larger than this will be uploaded in chunks of this size.\n\nNote that chunks are buffered in memory (one at a time) so rclone can\ndeal with retries. Setting this larger will increase the speed\nslightly (at most 10% for 128 MiB in tests) at the cost of using more\nmemory. It can be set smaller if you are tight on memory.", - "Provider": "", - "Default": 50331648, + "Name": "use_trash", + "FieldName": "", + "Help": "Send files to the trash instead of deleting permanently.\n\nDefaults to true, namely sending files to the trash.\nUse `--drive-use-trash=false` to delete files permanently instead.", + "Default": true, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3493,35 +3103,33 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "48Mi", - "ValueStr": "48Mi", - "Type": "SizeSuffix" + "DefaultStr": "true", + "ValueStr": "true", + "Type": "bool" }, { - "Name": "impersonate", - "Help": "Impersonate this user when using a business account.\n\nNote that if you want to use impersonate, you should make sure this\nflag is set when running \"rclone config\" as this will cause rclone to\nrequest the \"members.read\" scope which it won't normally. This is\nneeded to lookup a members email address into the internal ID that\ndropbox uses in the API.\n\nUsing the \"members.read\" scope will require a Dropbox Team Admin\nto approve during the OAuth flow.\n\nYou will have to use your own App (setting your own client_id and\nclient_secret) to use this option as currently rclone's default set of\npermissions doesn't include \"members.read\". This can be added once\nv1.55 or later is in use everywhere.\n", - "Provider": "", - "Default": "", + "Name": "copy_shortcut_content", + "FieldName": "", + "Help": "Server side copy contents of shortcuts instead of the shortcut.\n\nWhen doing server side copies, normally rclone will copy shortcuts as\nshortcuts.\n\nIf this flag is used then rclone will copy the contents of shortcuts\nrather than shortcuts themselves when doing server side copies.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "shared_files", - "Help": "Instructs rclone to work on individual shared files.\n\nIn this mode rclone's features are extremely limited - only list (ls, lsl, etc.) \noperations and read operations (e.g. downloading) are supported in this mode.\nAll other operations will be disabled.", - "Provider": "", + "Name": "skip_gdocs", + "FieldName": "", + "Help": "Skip google documents in all listings.\n\nIf given, gdocs practically become invisible to rclone.", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3534,12 +3142,11 @@ "Type": "bool" }, { - "Name": "shared_folders", - "Help": "Instructs rclone to work on shared folders.\n\t\t\t\nWhen this flag is used with no path only the List operation is supported and \nall available shared folders will be listed. If you specify a path the first part \nwill be interpreted as the name of shared folder. Rclone will then try to mount this \nshared to the root namespace. On success shared folder rclone proceeds normally. \nThe shared folder is now pretty much a normal folder and all normal operations \nare supported. \n\nNote that we don't unmount the shared folder afterwards so the \n--dropbox-shared-folders can be omitted after the first use of a particular \nshared folder.", - "Provider": "", + "Name": "show_all_gdocs", + "FieldName": "", + "Help": "Show all Google Docs including non-exportable ones in listings.\n\nIf you try a server side copy on a Google Form without this flag, you\nwill get this error:\n\n No export formats found for \"application/vnd.google-apps.form\"\n\nHowever adding this flag will allow the form to be server side copied.\n\nNote that rclone doesn't add extensions to the Google Docs file names\nin this mode.\n\nDo **not** use this flag when trying to download Google Docs - rclone\nwill fail to download them.\n", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3552,12 +3159,11 @@ "Type": "bool" }, { - "Name": "batch_mode", - "Help": "Upload file batching sync|async|off.\n\nThis sets the batch mode used by rclone.\n\nFor full info see [the main docs](https://rclone.org/dropbox/#batch-mode)\n\nThis has 3 possible values\n\n- off - no batching\n- sync - batch uploads and check completion (default)\n- async - batch upload and don't check completion\n\nRclone will close any outstanding batches when it exits which may make\na delay on quit.\n", - "Provider": "", - "Default": "sync", + "Name": "skip_checksum_gphotos", + "FieldName": "", + "Help": "Skip checksums on Google photos and videos only.\n\nUse this if you get checksum errors when transferring Google photos or\nvideos.\n\nSetting this flag will cause Google photos and videos to return a\nblank checksums.\n\nGoogle photos are identified by being in the \"photos\" space.\n\nCorrupted checksums are caused by Google modifying the image/video but\nnot updating the checksum.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3565,17 +3171,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "sync", - "ValueStr": "sync", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "batch_size", - "Help": "Max number of files in upload batch.\n\nThis sets the batch size of files to upload. It has to be less than 1000.\n\nBy default this is 0 which means rclone which calculate the batch size\ndepending on the setting of batch_mode.\n\n- batch_mode: async - default batch_size is 100\n- batch_mode: sync - default batch_size is the same as --transfers\n- batch_mode: off - not in use\n\nRclone will close any outstanding batches when it exits which may make\na delay on quit.\n\nSetting this is a great idea if you are uploading lots of small files\nas it will make them a lot quicker. You can use --transfers 32 to\nmaximise throughput.\n", - "Provider": "", - "Default": 0, + "Name": "shared_with_me", + "FieldName": "", + "Help": "Only show files that are shared with me.\n\nInstructs rclone to operate on your \"Shared with me\" folder (where\nGoogle Drive lets you access the files and folders others have shared\nwith you).\n\nThis works both with the \"list\" (lsd, lsl, etc.) and the \"copy\"\ncommands (copy, sync, etc.), and with all other commands too.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3583,17 +3188,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "0", - "ValueStr": "0", - "Type": "int" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "batch_timeout", - "Help": "Max time to allow an idle upload batch before uploading.\n\nIf an upload batch is idle for more than this long then it will be\nuploaded.\n\nThe default for this is 0 which means rclone will choose a sensible\ndefault based on the batch_mode in use.\n\n- batch_mode: async - default batch_timeout is 10s\n- batch_mode: sync - default batch_timeout is 500ms\n- batch_mode: off - not in use\n", - "Provider": "", - "Default": 0, + "Name": "trashed_only", + "FieldName": "", + "Help": "Only show files that are in the trash.\n\nThis will show trashed files in their original directory structure.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3601,17 +3205,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "0s", - "ValueStr": "0s", - "Type": "Duration" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "batch_commit_timeout", - "Help": "Max time to wait for a batch to finish committing", - "Provider": "", - "Default": 600000000000, + "Name": "starred_only", + "FieldName": "", + "Help": "Only show files that are starred.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3619,35 +3222,33 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "10m0s", - "ValueStr": "10m0s", - "Type": "Duration" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "pacer_min_sleep", - "Help": "Minimum time to sleep between API calls.", - "Provider": "", - "Default": 10000000, + "Name": "formats", + "FieldName": "", + "Help": "Deprecated: See export_formats.", + "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 2, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "10ms", - "ValueStr": "10ms", - "Type": "Duration" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 52469762, + "Name": "export_formats", + "FieldName": "", + "Help": "Comma separated list of preferred formats for downloading Google docs.", + "Default": "docx,xlsx,pptx,svg", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3655,46 +3256,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot", - "ValueStr": "Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot", - "Type": "MultiEncoder" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "fichier", - "Description": "1Fichier", - "Prefix": "fichier", - "Options": [ - { - "Name": "api_key", - "Help": "Your API Key, get it from https://1fichier.com/console/params.pl.", - "Provider": "", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", + "DefaultStr": "docx,xlsx,pptx,svg", + "ValueStr": "docx,xlsx,pptx,svg", "Type": "string" }, { - "Name": "shared_folder", - "Help": "If you want to download a shared folder, add this parameter.", - "Provider": "", + "Name": "import_formats", + "FieldName": "", + "Help": "Comma separated list of preferred formats for uploading Google docs.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3707,49 +3278,46 @@ "Type": "string" }, { - "Name": "file_password", - "Help": "If you want to download a shared file that is password protected, add this parameter.", - "Provider": "", - "Default": "", + "Name": "allow_import_name_change", + "FieldName": "", + "Help": "Allow the filetype to change when uploading Google docs.\n\nE.g. file.doc to file.docx. This will confuse sync and reupload every time.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, - "IsPassword": true, + "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "folder_password", - "Help": "If you want to list the files in a shared folder that is password protected, add this parameter.", - "Provider": "", - "Default": "", + "Name": "use_created_date", + "FieldName": "", + "Help": "Use file created date instead of modified date.\n\nUseful when downloading data and you want the creation date used in\nplace of the last modified date.\n\n**WARNING**: This flag may have some unexpected consequences.\n\nWhen uploading to your drive all files will be overwritten unless they\nhaven't been modified since their creation. And the inverse will occur\nwhile downloading. This side effect can be avoided by using the\n\"--checksum\" flag.\n\nThis feature was implemented to retain photos capture date as recorded\nby google photos. You will first need to check the \"Create a Google\nPhotos folder\" option in your google drive settings. You can then copy\nor move the photos locally and use the date the image was taken\n(created) set as the modification date.", + "Default": false, "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 2, "Required": false, - "IsPassword": true, + "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "cdn", - "Help": "Set if you wish to use CDN download links.", - "Provider": "", + "Name": "use_shared_date", + "FieldName": "", + "Help": "Use date file was shared instead of modified date.\n\nNote that, as with \"--drive-use-created-date\", this flag may have\nunexpected consequences when uploading/downloading files.\n\nIf both this flag and \"--drive-use-created-date\" are set, the created\ndate is used.", "Default": false, "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 2, "Required": false, "IsPassword": false, "NoPrefix": false, @@ -3761,12 +3329,11 @@ "Type": "bool" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 52666494, + "Name": "list_chunk", + "FieldName": "", + "Help": "Size of listing chunk 100-1000, 0 to disable.", + "Default": 1000, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3774,117 +3341,84 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot", - "ValueStr": "Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot", - "Type": "MultiEncoder" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "filefabric", - "Description": "Enterprise File Fabric", - "Prefix": "filefabric", - "Options": [ + "DefaultStr": "1000", + "ValueStr": "1000", + "Type": "int" + }, { - "Name": "url", - "Help": "URL of the Enterprise File Fabric to connect to.", - "Provider": "", + "Name": "impersonate", + "FieldName": "", + "Help": "Impersonate this user when using a service account.", "Default": "", "Value": null, - "Examples": [ - { - "Value": "https://storagemadeeasy.com", - "Help": "Storage Made Easy US", - "Provider": "" - }, - { - "Value": "https://eu.storagemadeeasy.com", - "Help": "Storage Made Easy EU", - "Provider": "" - }, - { - "Value": "https://yourfabric.smestorage.com", - "Help": "Connect to your Enterprise File Fabric", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, - "Required": true, + "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": false, + "Sensitive": true, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "root_folder_id", - "Help": "ID of the root folder.\n\nLeave blank normally.\n\nFill in to make rclone start with directory of a given ID.\n", - "Provider": "", - "Default": "", + "Name": "alternate_export", + "FieldName": "", + "Help": "Deprecated: No longer needed.", + "Default": false, "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 3, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": false, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "permanent_token", - "Help": "Permanent Authentication Token.\n\nA Permanent Authentication Token can be created in the Enterprise File\nFabric, on the users Dashboard under Security, there is an entry\nyou'll see called \"My Authentication Tokens\". Click the Manage button\nto create one.\n\nThese tokens are normally valid for several years.\n\nFor more info see: https://docs.storagemadeeasy.com/organisationcloud/api-tokens\n", - "Provider": "", - "Default": "", + "Name": "upload_cutoff", + "FieldName": "", + "Help": "Cutoff for switching to chunked upload.", + "Default": 8388608, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "8Mi", + "ValueStr": "8Mi", + "Type": "SizeSuffix" }, { - "Name": "token", - "Help": "Session Token.\n\nThis is a session token which rclone caches in the config file. It is\nusually valid for 1 hour.\n\nDon't set this value - rclone will set it automatically.\n", - "Provider": "", - "Default": "", + "Name": "chunk_size", + "FieldName": "", + "Help": "Upload chunk size.\n\nMust a power of 2 >= 256k.\n\nMaking this larger will improve performance, but note that each chunk\nis buffered in memory one per transfer.\n\nReducing this will reduce memory usage but decrease performance.", + "Default": 8388608, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "8Mi", + "ValueStr": "8Mi", + "Type": "SizeSuffix" }, { - "Name": "token_expiry", - "Help": "Token expiry time.\n\nDon't set this value - rclone will set it automatically.\n", - "Provider": "", - "Default": "", + "Name": "acknowledge_abuse", + "FieldName": "", + "Help": "Set to allow files which return cannotDownloadAbusiveFile to be downloaded.\n\nIf downloading a file returns the error \"This file has been identified\nas malware or spam and cannot be downloaded\" with the error code\n\"cannotDownloadAbusiveFile\" then supply this flag to rclone to\nindicate you acknowledge the risks of downloading the file and rclone\nwill download it anyway.\n\nNote that if you are using service account it will need Manager\npermission (not Content Manager) to for this flag to work. If the SA\ndoes not have the right permission, Google will just ignore the flag.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3892,17 +3426,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "version", - "Help": "Version read from the file fabric.\n\nDon't set this value - rclone will set it automatically.\n", - "Provider": "", - "Default": "", + "Name": "keep_revision_forever", + "FieldName": "", + "Help": "Keep new head revision of each file forever.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -3910,141 +3443,89 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 50429954, + "Name": "size_as_quota", + "FieldName": "", + "Help": "Show sizes as storage quota usage, not actual size.\n\nShow the size of a file as the storage quota used. This is the\ncurrent version plus any older versions that have been set to keep\nforever.\n\n**WARNING**: This flag may have some unexpected consequences.\n\nIt is not recommended to set this flag in your config - the\nrecommended usage is using the flag form --drive-size-as-quota when\ndoing rclone ls/lsl/lsf/lsjson/etc only.\n\nIf you do use this flag for syncing (not recommended) then you will\nneed to use --ignore size also.", + "Default": false, "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 2, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,Del,Ctl,InvalidUtf8,Dot", - "ValueStr": "Slash,Del,Ctl,InvalidUtf8,Dot", - "Type": "MultiEncoder" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "ftp", - "Description": "FTP", - "Prefix": "ftp", - "Options": [ + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, { - "Name": "host", - "Help": "FTP host to connect to.\n\nE.g. \"ftp.example.com\".", - "Provider": "", - "Default": "", + "Name": "v2_download_min_size", + "FieldName": "", + "Help": "If Object's are greater, use drive v2 API to download.", + "Default": -1, "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": true, + "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "off", + "ValueStr": "off", + "Type": "SizeSuffix" }, { - "Name": "user", - "Help": "FTP username.", - "Provider": "", - "Default": "zenon", + "Name": "pacer_min_sleep", + "FieldName": "", + "Help": "Minimum time to sleep between API calls.", + "Default": 100000000, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "zenon", - "ValueStr": "zenon", - "Type": "string" + "Sensitive": false, + "DefaultStr": "100ms", + "ValueStr": "100ms", + "Type": "Duration" }, { - "Name": "port", - "Help": "FTP port number.", - "Provider": "", - "Default": 21, + "Name": "pacer_burst", + "FieldName": "", + "Help": "Number of API calls to allow without sleeping.", + "Default": 100, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "21", - "ValueStr": "21", + "DefaultStr": "100", + "ValueStr": "100", "Type": "int" }, { - "Name": "pass", - "Help": "FTP password.", - "Provider": "", - "Default": "", + "Name": "server_side_across_configs", + "FieldName": "", + "Help": "Deprecated: use --server-side-across-configs instead.\n\nAllow server-side operations (e.g. copy) to work across different drive configs.\n\nThis can be useful if you wish to do a server-side copy between two\ndifferent Google drives. Note that this isn't enabled by default\nbecause it isn't easy to tell if it will work between any two\nconfigurations.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, - "IsPassword": true, + "IsPassword": false, "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" - }, - { - "Name": "tls", - "Help": "Use Implicit FTPS (FTP over TLS).\n\nWhen using implicit FTP over TLS the client connects using TLS\nright from the start which breaks compatibility with\nnon-TLS-aware servers. This is usually served over port 990 rather\nthan port 21. Cannot be used in combination with explicit FTPS.", - "Provider": "", - "Default": false, - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" - }, - { - "Name": "explicit_tls", - "Help": "Use Explicit FTPS (FTP over TLS).\n\nWhen using explicit FTP over TLS the client explicitly requests\nsecurity from the server in order to upgrade a plain text connection\nto an encrypted one. Cannot be used in combination with implicit FTPS.", - "Provider": "", - "Default": false, - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, "DefaultStr": "false", @@ -4052,30 +3533,11 @@ "Type": "bool" }, { - "Name": "concurrency", - "Help": "Maximum number of FTP simultaneous connections, 0 for unlimited.\n\nNote that setting this is very likely to cause deadlocks so it should\nbe used with care.\n\nIf you are doing a sync or copy then make sure concurrency is one more\nthan the sum of `--transfers` and `--checkers`.\n\nIf you use `--check-first` then it just needs to be one more than the\nmaximum of `--checkers` and `--transfers`.\n\nSo for `concurrency 3` you'd use `--checkers 2 --transfers 2\n--check-first` or `--checkers 1 --transfers 1`.\n\n", - "Provider": "", - "Default": 0, - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "0", - "ValueStr": "0", - "Type": "int" - }, - { - "Name": "no_check_certificate", - "Help": "Do not verify the TLS certificate of the server.", - "Provider": "", - "Default": false, + "Name": "disable_http2", + "FieldName": "", + "Help": "Disable drive using http2.\n\nThere is currently an unsolved issue with the google drive backend and\nHTTP/2. HTTP/2 is therefore disabled by default for the drive backend\nbut can be re-enabled here. When the issue is solved this flag will\nbe removed.\n\nSee: https://github.com/rclone/rclone/issues/3631\n\n", + "Default": true, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -4083,17 +3545,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", + "DefaultStr": "true", + "ValueStr": "true", "Type": "bool" }, { - "Name": "disable_epsv", - "Help": "Disable using EPSV even if server advertises support.", - "Provider": "", + "Name": "stop_on_upload_limit", + "FieldName": "", + "Help": "Make upload limit errors be fatal.\n\nAt the time of writing it is only possible to upload 750 GiB of data to\nGoogle Drive a day (this is an undocumented limit). When this limit is\nreached Google Drive produces a slightly different error message. When\nthis flag is set it causes these errors to be fatal. These will stop\nthe in-progress sync.\n\nNote that this detection is relying on error message strings which\nGoogle don't document so it may break in the future.\n\nSee: https://github.com/rclone/rclone/issues/3857\n", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -4106,12 +3567,11 @@ "Type": "bool" }, { - "Name": "disable_mlsd", - "Help": "Disable using MLSD even if server advertises support.", - "Provider": "", + "Name": "stop_on_download_limit", + "FieldName": "", + "Help": "Make download limit errors be fatal.\n\nAt the time of writing it is only possible to download 10 TiB of data from\nGoogle Drive a day (this is an undocumented limit). When this limit is\nreached Google Drive produces a slightly different error message. When\nthis flag is set it causes these errors to be fatal. These will stop\nthe in-progress sync.\n\nNote that this detection is relying on error message strings which\nGoogle don't document so it may break in the future.\n", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -4124,12 +3584,11 @@ "Type": "bool" }, { - "Name": "disable_utf8", - "Help": "Disable using UTF-8 even if server advertises support.", - "Provider": "", + "Name": "skip_shortcuts", + "FieldName": "", + "Help": "If set skip shortcut files.\n\nNormally rclone dereferences shortcut files making them appear as if\nthey are the original file (see [the shortcuts section](#shortcuts)).\nIf this flag is set then rclone will ignore shortcut files completely.\n", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -4142,12 +3601,11 @@ "Type": "bool" }, { - "Name": "writing_mdtm", - "Help": "Use MDTM to set modification time (VsFtpd quirk)", - "Provider": "", + "Name": "skip_dangling_shortcuts", + "FieldName": "", + "Help": "If set skip dangling shortcut files.\n\nIf this is set then rclone will not show any dangling shortcuts in listings.\n", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -4160,30 +3618,28 @@ "Type": "bool" }, { - "Name": "force_list_hidden", - "Help": "Use LIST -a to force listing of hidden files and folders. This will disable the use of MLSD.", - "Provider": "", - "Default": false, + "Name": "resource_key", + "FieldName": "", + "Help": "Resource key for accessing a link-shared file.\n\nIf you need to access files shared with a link like this\n\n https://drive.google.com/drive/folders/XXX?resourcekey=YYY&usp=sharing\n\nThen you will need to use the first part \"XXX\" as the \"root_folder_id\"\nand the second part \"YYY\" as the \"resource_key\" otherwise you will get\n404 not found errors when trying to access the directory.\n\nSee: https://developers.google.com/drive/api/guides/resource-keys\n\nThis resource key requirement only applies to a subset of old files.\n\nNote also that opening the folder once in the web interface (with the\nuser you've authenticated rclone with) seems to be enough so that the\nresource key is not needed.\n", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "idle_timeout", - "Help": "Max time before closing idle connections.\n\nIf no connections have been returned to the connection pool in the time\ngiven, rclone will empty the connection pool.\n\nSet to 0 to keep connections indefinitely.\n", - "Provider": "", - "Default": 60000000000, + "Name": "fast_list_bug_fix", + "FieldName": "", + "Help": "Work around a bug in Google Drive listing.\n\nNormally rclone will work around a bug in Google Drive when using\n--fast-list (ListR) where the search \"(A in parents) or (B in\nparents)\" returns nothing sometimes. See #3114, #4289 and\nhttps://issuetracker.google.com/issues/149522397\n\nRclone detects this by finding no items in more than one directory\nwhen listing and retries them as lists of individual directories.\n\nThis means that if you have a lot of empty directories rclone will end\nup listing them all individually and this can take many more API\ncalls.\n\nThis flag allows the work-around to be disabled. This is **not**\nrecommended in normal use - only if you have a particular case you are\nhaving trouble with like many empty directories.\n", + "Default": true, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -4191,17 +3647,38 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "1m0s", - "ValueStr": "1m0s", - "Type": "Duration" + "DefaultStr": "true", + "ValueStr": "true", + "Type": "bool" }, { - "Name": "close_timeout", - "Help": "Maximum time to wait for a response to close.", - "Provider": "", - "Default": 60000000000, + "Name": "metadata_owner", + "FieldName": "", + "Help": "Control whether owner should be read or written in metadata.\n\nOwner is a standard part of the file metadata so is easy to read. But it\nisn't always desirable to set the owner from the metadata.\n\nNote that you can't set the owner on Shared Drives, and that setting\nownership will generate an email to the new owner (this can't be\ndisabled), and you can't transfer ownership to someone outside your\norganization.\n", + "Default": 1, "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "off", + "Help": "Do not read or write the value" + }, + { + "Value": "read", + "Help": "Read the value only" + }, + { + "Value": "write", + "Help": "Write the value only" + }, + { + "Value": "failok", + "Help": "If writing fails log errors only, don't fail the transfer" + }, + { + "Value": "read,write", + "Help": "Read and Write the value." + } + ], "Hide": 0, "Required": false, "IsPassword": false, @@ -4209,17 +3686,38 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "1m0s", - "ValueStr": "1m0s", - "Type": "Duration" + "DefaultStr": "read", + "ValueStr": "read", + "Type": "Bits" }, { - "Name": "tls_cache_size", - "Help": "Size of TLS session cache for all control and data connections.\n\nTLS cache allows to resume TLS sessions and reuse PSK between connections.\nIncrease if default size is not enough resulting in TLS resumption errors.\nEnabled by default. Use 0 to disable.", - "Provider": "", - "Default": 32, + "Name": "metadata_permissions", + "FieldName": "", + "Help": "Control whether permissions should be read or written in metadata.\n\nReading permissions metadata from files can be done quickly, but it\nisn't always desirable to set the permissions from the metadata.\n\nNote that rclone drops any inherited permissions on Shared Drives and\nany owner permission on My Drives as these are duplicated in the owner\nmetadata.\n", + "Default": 0, "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "off", + "Help": "Do not read or write the value" + }, + { + "Value": "read", + "Help": "Read the value only" + }, + { + "Value": "write", + "Help": "Write the value only" + }, + { + "Value": "failok", + "Help": "If writing fails log errors only, don't fail the transfer" + }, + { + "Value": "read,write", + "Help": "Read and Write the value." + } + ], "Hide": 0, "Required": false, "IsPassword": false, @@ -4227,17 +3725,38 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "32", - "ValueStr": "32", - "Type": "int" + "DefaultStr": "off", + "ValueStr": "off", + "Type": "Bits" }, { - "Name": "disable_tls13", - "Help": "Disable TLS 1.3 (workaround for FTP servers with buggy TLS)", - "Provider": "", - "Default": false, + "Name": "metadata_labels", + "FieldName": "", + "Help": "Control whether labels should be read or written in metadata.\n\nReading labels metadata from files takes an extra API transaction and\nwill slow down listings. It isn't always desirable to set the labels\nfrom the metadata.\n\nThe format of labels is documented in the drive API documentation at\nhttps://developers.google.com/drive/api/reference/rest/v3/Label -\nrclone just provides a JSON dump of this format.\n\nWhen setting labels, the label and fields must already exist - rclone\nwill not create them. This means that if you are transferring labels\nfrom two different accounts you will have to create the labels in\nadvance and use the metadata mapper to translate the IDs between the\ntwo accounts.\n", + "Default": 0, "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "off", + "Help": "Do not read or write the value" + }, + { + "Value": "read", + "Help": "Read the value only" + }, + { + "Value": "write", + "Help": "Write the value only" + }, + { + "Value": "failok", + "Help": "If writing fails log errors only, don't fail the transfer" + }, + { + "Value": "read,write", + "Help": "Read and Write the value." + } + ], "Hide": 0, "Required": false, "IsPassword": false, @@ -4245,17 +3764,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "off", + "ValueStr": "off", + "Type": "Bits" }, { - "Name": "shut_timeout", - "Help": "Maximum time to wait for data connection closing status.", - "Provider": "", - "Default": 60000000000, + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 16777216, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -4263,52 +3781,26 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "1m0s", - "ValueStr": "1m0s", - "Type": "Duration" + "DefaultStr": "InvalidUtf8", + "ValueStr": "InvalidUtf8", + "Type": "Encoding" }, { - "Name": "ask_password", - "Help": "Allow asking for FTP password when needed.\n\nIf this is set and no password is supplied then rclone will ask for a password\n", - "Provider": "", + "Name": "env_auth", + "FieldName": "", + "Help": "Get IAM credentials from runtime (environment variables or instance meta data if no env vars).\n\nOnly applies if service_account_file and service_account_credentials is blank.", "Default": false, "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" - }, - { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 35749890, - "Value": null, "Examples": [ { - "Value": "Asterisk,Ctl,Dot,Slash", - "Help": "ProFTPd can't handle '*' in file names", - "Provider": "" - }, - { - "Value": "BackSlash,Ctl,Del,Dot,RightSpace,Slash,SquareBracket", - "Help": "PureFTPd can't handle '[]' or '*' in file names", - "Provider": "" + "Value": "false", + "Help": "Enter credentials in the next step." }, { - "Value": "Ctl,LeftPeriod,Slash", - "Help": "VsFTPd can't handle file names starting with dot", - "Provider": "" + "Value": "true", + "Help": "Get GCP IAM credentials from the environment (env vars or IAM)." } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -4316,69 +3808,188 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,Del,Ctl,RightSpace,Dot", - "ValueStr": "Slash,Del,Ctl,RightSpace,Dot", - "Type": "MultiEncoder" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "google cloud storage", - "Description": "Google Cloud Storage (this is not Google Drive)", - "Prefix": "gcs", - "Options": [ + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, { - "Name": "client_id", - "Help": "OAuth Client Id.\n\nLeave blank normally.", - "Provider": "", + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" + } + ], + "CommandHelp": [ + { + "Name": "get", + "Short": "Get command for fetching the drive config parameters", + "Long": "This is a get command which will be used to fetch the various drive config parameters\n\nUsage Examples:\n\n rclone backend get drive: [-o service_account_file] [-o chunk_size]\n rclone rc backend/command command=get fs=drive: [-o service_account_file] [-o chunk_size]\n", + "Opts": { + "chunk_size": "show the current upload chunk size", + "service_account_file": "show the current service account file" + } }, { - "Name": "client_secret", - "Help": "OAuth Client Secret.\n\nLeave blank normally.", - "Provider": "", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Name": "set", + "Short": "Set command for updating the drive config parameters", + "Long": "This is a set command which will be used to update the various drive config parameters\n\nUsage Examples:\n\n rclone backend set drive: [-o service_account_file=sa.json] [-o chunk_size=67108864]\n rclone rc backend/command command=set fs=drive: [-o service_account_file=sa.json] [-o chunk_size=67108864]\n", + "Opts": { + "chunk_size": "update the current upload chunk size", + "service_account_file": "update the current service account file" + } }, { - "Name": "token", - "Help": "OAuth Access Token as a JSON blob.", - "Provider": "", - "Default": "", + "Name": "shortcut", + "Short": "Create shortcuts from files or directories", + "Long": "This command creates shortcuts from files or directories.\n\nUsage:\n\n rclone backend shortcut drive: source_item destination_shortcut\n rclone backend shortcut drive: source_item -o target=drive2: destination_shortcut\n\nIn the first example this creates a shortcut from the \"source_item\"\nwhich can be a file or a directory to the \"destination_shortcut\". The\n\"source_item\" and the \"destination_shortcut\" should be relative paths\nfrom \"drive:\"\n\nIn the second example this creates a shortcut from the \"source_item\"\nrelative to \"drive:\" to the \"destination_shortcut\" relative to\n\"drive2:\". This may fail with a permission error if the user\nauthenticated with \"drive2:\" can't read files from \"drive:\".\n", + "Opts": { + "target": "optional target remote for the shortcut destination" + } + }, + { + "Name": "drives", + "Short": "List the Shared Drives available to this account", + "Long": "This command lists the Shared Drives (Team Drives) available to this\naccount.\n\nUsage:\n\n rclone backend [-o config] drives drive:\n\nThis will return a JSON list of objects like this\n\n [\n {\n \"id\": \"0ABCDEF-01234567890\",\n \"kind\": \"drive#teamDrive\",\n \"name\": \"My Drive\"\n },\n {\n \"id\": \"0ABCDEFabcdefghijkl\",\n \"kind\": \"drive#teamDrive\",\n \"name\": \"Test Drive\"\n }\n ]\n\nWith the -o config parameter it will output the list in a format\nsuitable for adding to a config file to make aliases for all the\ndrives found and a combined drive.\n\n [My Drive]\n type = alias\n remote = drive,team_drive=0ABCDEF-01234567890,root_folder_id=:\n\n [Test Drive]\n type = alias\n remote = drive,team_drive=0ABCDEFabcdefghijkl,root_folder_id=:\n\n [AllDrives]\n type = combine\n upstreams = \"My Drive=My Drive:\" \"Test Drive=Test Drive:\"\n\nAdding this to the rclone config file will cause those team drives to\nbe accessible with the aliases shown. Any illegal characters will be\nsubstituted with \"_\" and duplicate names will have numbers suffixed.\nIt will also add a remote called AllDrives which shows all the shared\ndrives combined into one directory tree.\n", + "Opts": null + }, + { + "Name": "untrash", + "Short": "Untrash files and directories", + "Long": "This command untrashes all the files and directories in the directory\npassed in recursively.\n\nUsage:\n\nThis takes an optional directory to trash which make this easier to\nuse via the API.\n\n rclone backend untrash drive:directory\n rclone backend --interactive untrash drive:directory subdir\n\nUse the --interactive/-i or --dry-run flag to see what would be restored before restoring it.\n\nResult:\n\n {\n \"Untrashed\": 17,\n \"Errors\": 0\n }\n", + "Opts": null + }, + { + "Name": "copyid", + "Short": "Copy files by ID", + "Long": "This command copies files by ID\n\nUsage:\n\n rclone backend copyid drive: ID path\n rclone backend copyid drive: ID1 path1 ID2 path2\n\nIt copies the drive file with ID given to the path (an rclone path which\nwill be passed internally to rclone copyto). The ID and path pairs can be\nrepeated.\n\nThe path should end with a / to indicate copy the file as named to\nthis directory. If it doesn't end with a / then the last path\ncomponent will be used as the file name.\n\nIf the destination is a drive backend then server-side copying will be\nattempted if possible.\n\nUse the --interactive/-i or --dry-run flag to see what would be copied before copying.\n", + "Opts": null + }, + { + "Name": "exportformats", + "Short": "Dump the export formats for debug purposes", + "Long": "", + "Opts": null + }, + { + "Name": "importformats", + "Short": "Dump the import formats for debug purposes", + "Long": "", + "Opts": null + }, + { + "Name": "query", + "Short": "List files using Google Drive query language", + "Long": "This command lists files based on a query\n\nUsage:\n\n rclone backend query drive: query\n \nThe query syntax is documented at [Google Drive Search query terms and \noperators](https://developers.google.com/drive/api/guides/ref-search-terms).\n\nFor example:\n\n\trclone backend query drive: \"'0ABc9DEFGHIJKLMNop0QRatUVW3X' in parents and name contains 'foo'\"\n\nIf the query contains literal ' or \\ characters, these need to be escaped with\n\\ characters. \"'\" becomes \"\\'\" and \"\\\" becomes \"\\\\\\\", for example to match a \nfile named \"foo ' \\.txt\":\n\n\trclone backend query drive: \"name = 'foo \\' \\\\\\.txt'\"\n\nThe result is a JSON array of matches, for example:\n\n [\n\t{\n\t\t\"createdTime\": \"2017-06-29T19:58:28.537Z\",\n\t\t\"id\": \"0AxBe_CDEF4zkGHI4d0FjYko2QkD\",\n\t\t\"md5Checksum\": \"68518d16be0c6fbfab918be61d658032\",\n\t\t\"mimeType\": \"text/plain\",\n\t\t\"modifiedTime\": \"2024-02-02T10:40:02.874Z\",\n\t\t\"name\": \"foo ' \\\\.txt\",\n\t\t\"parents\": [\n\t\t\t\"0BxAe_BCDE4zkFGZpcWJGek0xbzC\"\n\t\t],\n\t\t\"resourceKey\": \"0-ABCDEFGHIXJQpIGqBJq3MC\",\n\t\t\"sha1Checksum\": \"8f284fa768bfb4e45d076a579ab3905ab6bfa893\",\n\t\t\"size\": \"311\",\n\t\t\"webViewLink\": \"https://drive.google.com/file/d/0AxBe_CDEF4zkGHI4d0FjYko2QkD/view?usp=drivesdk\\u0026resourcekey=0-ABCDEFGHIXJQpIGqBJq3MC\"\n\t}\n ]", + "Opts": null + } + ], + "Aliases": null, + "Hide": false, + "MetadataInfo": { + "System": { + "btime": { + "Help": "Time of file birth (creation) with mS accuracy. Note that this is only writable on fresh uploads - it can't be written for updates.", + "Type": "RFC 3339", + "Example": "2006-01-02T15:04:05.999Z07:00", + "ReadOnly": false + }, + "content-type": { + "Help": "The MIME type of the file.", + "Type": "string", + "Example": "text/plain", + "ReadOnly": false + }, + "copy-requires-writer-permission": { + "Help": "Whether the options to copy, print, or download this file, should be disabled for readers and commenters.", + "Type": "boolean", + "Example": "true", + "ReadOnly": false + }, + "description": { + "Help": "A short description of the file.", + "Type": "string", + "Example": "Contract for signing", + "ReadOnly": false + }, + "folder-color-rgb": { + "Help": "The color for a folder or a shortcut to a folder as an RGB hex string.", + "Type": "string", + "Example": "881133", + "ReadOnly": false + }, + "labels": { + "Help": "Labels attached to this file in a JSON dump of Googled drive format. Enable with --drive-metadata-labels.", + "Type": "JSON", + "Example": "[]", + "ReadOnly": false + }, + "mtime": { + "Help": "Time of last modification with mS accuracy.", + "Type": "RFC 3339", + "Example": "2006-01-02T15:04:05.999Z07:00", + "ReadOnly": false + }, + "owner": { + "Help": "The owner of the file. Usually an email address. Enable with --drive-metadata-owner.", + "Type": "string", + "Example": "user@example.com", + "ReadOnly": false + }, + "permissions": { + "Help": "Permissions in a JSON dump of Google drive format. On shared drives these will only be present if they aren't inherited. Enable with --drive-metadata-permissions.", + "Type": "JSON", + "Example": "{}", + "ReadOnly": false + }, + "starred": { + "Help": "Whether the user has starred the file.", + "Type": "boolean", + "Example": "false", + "ReadOnly": false + }, + "viewed-by-me": { + "Help": "Whether the file has been viewed by this user.", + "Type": "boolean", + "Example": "true", + "ReadOnly": true + }, + "writers-can-share": { + "Help": "Whether users with only writer permission can modify the file's permissions. Not populated and ignored when setting for items in shared drives.", + "Type": "boolean", + "Example": "false", + "ReadOnly": false + } + }, + "Help": "User metadata is stored in the properties field of the drive object.\n\nMetadata is supported on files and directories.\n" + } + }, + { + "Name": "dropbox", + "Description": "Dropbox", + "Prefix": "dropbox", + "Options": [ + { + "Name": "client_id", + "FieldName": "", + "Help": "OAuth Client Id.\n\nLeave blank normally.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": true, "DefaultStr": "", @@ -4386,107 +3997,101 @@ "Type": "string" }, { - "Name": "auth_url", - "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", - "Provider": "", + "Name": "client_secret", + "FieldName": "", + "Help": "OAuth Client Secret.\n\nLeave blank normally.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, + "Sensitive": true, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "token_url", - "Help": "Token server url.\n\nLeave blank to use the provider defaults.", - "Provider": "", + "Name": "token", + "FieldName": "", + "Help": "OAuth Access Token as a JSON blob.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": false, + "Sensitive": true, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "project_number", - "Help": "Project number.\n\nOptional - needed only for list/create/delete buckets - see your developer console.", - "Provider": "", + "Name": "auth_url", + "FieldName": "", + "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "user_project", - "Help": "User project.\n\nOptional - needed only for requester pays.", - "Provider": "", + "Name": "token_url", + "FieldName": "", + "Help": "Token server url.\n\nLeave blank to use the provider defaults.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "service_account_file", - "Help": "Service Account Credentials JSON file path.\n\nLeave blank normally.\nNeeded only if you want use SA instead of interactive login.\n\nLeading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.", - "Provider": "", - "Default": "", + "Name": "chunk_size", + "FieldName": "", + "Help": "Upload chunk size (< 150Mi).\n\nAny files larger than this will be uploaded in chunks of this size.\n\nNote that chunks are buffered in memory (one at a time) so rclone can\ndeal with retries. Setting this larger will increase the speed\nslightly (at most 10% for 128 MiB in tests) at the cost of using more\nmemory. It can be set smaller if you are tight on memory.", + "Default": 50331648, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "48Mi", + "ValueStr": "48Mi", + "Type": "SizeSuffix" }, { - "Name": "service_account_credentials", - "Help": "Service Account Credentials JSON blob.\n\nLeave blank normally.\nNeeded only if you want use SA instead of interactive login.", - "Provider": "", + "Name": "impersonate", + "FieldName": "", + "Help": "Impersonate this user when using a business account.\n\nNote that if you want to use impersonate, you should make sure this\nflag is set when running \"rclone config\" as this will cause rclone to\nrequest the \"members.read\" scope which it won't normally. This is\nneeded to lookup a members email address into the internal ID that\ndropbox uses in the API.\n\nUsing the \"members.read\" scope will require a Dropbox Team Admin\nto approve during the OAuth flow.\n\nYou will have to use your own App (setting your own client_id and\nclient_secret) to use this option as currently rclone's default set of\npermissions doesn't include \"members.read\". This can be added once\nv1.55 or later is in use everywhere.\n", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 3, + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": true, "DefaultStr": "", @@ -4494,17 +4099,16 @@ "Type": "string" }, { - "Name": "anonymous", - "Help": "Access public buckets and objects without credentials.\n\nSet to 'true' if you just want to download files and don't configure credentials.", - "Provider": "", + "Name": "shared_files", + "FieldName": "", + "Help": "Instructs rclone to work on individual shared files.\n\nIn this mode rclone's features are extremely limited - only list (ls, lsl, etc.) \noperations and read operations (e.g. downloading) are supported in this mode.\nAll other operations will be disabled.", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, "DefaultStr": "false", @@ -4512,94 +4116,67 @@ "Type": "bool" }, { - "Name": "object_acl", - "Help": "Access Control List for new objects.", - "Provider": "", - "Default": "", + "Name": "shared_folders", + "FieldName": "", + "Help": "Instructs rclone to work on shared folders.\n\t\t\t\nWhen this flag is used with no path only the List operation is supported and \nall available shared folders will be listed. If you specify a path the first part \nwill be interpreted as the name of shared folder. Rclone will then try to mount this \nshared to the root namespace. On success shared folder rclone proceeds normally. \nThe shared folder is now pretty much a normal folder and all normal operations \nare supported. \n\nNote that we don't unmount the shared folder afterwards so the \n--dropbox-shared-folders can be omitted after the first use of a particular \nshared folder.\n\nSee also --dropbox-root-namespace for an alternative way to work with shared\nfolders.", + "Default": false, "Value": null, - "Examples": [ - { - "Value": "authenticatedRead", - "Help": "Object owner gets OWNER access.\nAll Authenticated Users get READER access.", - "Provider": "" - }, - { - "Value": "bucketOwnerFullControl", - "Help": "Object owner gets OWNER access.\nProject team owners get OWNER access.", - "Provider": "" - }, - { - "Value": "bucketOwnerRead", - "Help": "Object owner gets OWNER access.\nProject team owners get READER access.", - "Provider": "" - }, - { - "Value": "private", - "Help": "Object owner gets OWNER access.\nDefault if left blank.", - "Provider": "" - }, - { - "Value": "projectPrivate", - "Help": "Object owner gets OWNER access.\nProject team members get access according to their roles.", - "Provider": "" - }, - { - "Value": "publicRead", - "Help": "Object owner gets OWNER access.\nAll Users get READER access.", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "bucket_acl", - "Help": "Access Control List for new buckets.", - "Provider": "", + "Name": "pacer_min_sleep", + "FieldName": "", + "Help": "Minimum time to sleep between API calls.", + "Default": 10000000, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "10ms", + "ValueStr": "10ms", + "Type": "Duration" + }, + { + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 52469762, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot", + "ValueStr": "Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot", + "Type": "Encoding" + }, + { + "Name": "root_namespace", + "FieldName": "", + "Help": "Specify a different Dropbox namespace ID to use as the root for all paths.", "Default": "", "Value": null, - "Examples": [ - { - "Value": "authenticatedRead", - "Help": "Project team owners get OWNER access.\nAll Authenticated Users get READER access.", - "Provider": "" - }, - { - "Value": "private", - "Help": "Project team owners get OWNER access.\nDefault if left blank.", - "Provider": "" - }, - { - "Value": "projectPrivate", - "Help": "Project team members get access according to their roles.", - "Provider": "" - }, - { - "Value": "publicRead", - "Help": "Project team owners get OWNER access.\nAll Users get READER access.", - "Provider": "" - }, - { - "Value": "publicReadWrite", - "Help": "Project team owners get OWNER access.\nAll Users get WRITER access.", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, "DefaultStr": "", @@ -4607,285 +4184,2841 @@ "Type": "string" }, { - "Name": "bucket_policy_only", - "Help": "Access checks should use bucket-level IAM policies.\n\nIf you want to upload objects to a bucket with Bucket Policy Only set\nthen you will need to set this.\n\nWhen it is set, rclone:\n\n- ignores ACLs set on buckets\n- ignores ACLs set on objects\n- creates buckets with Bucket Policy Only set\n\nDocs: https://cloud.google.com/storage/docs/bucket-policy-only\n", - "Provider": "", - "Default": false, + "Name": "batch_mode", + "FieldName": "", + "Help": "Upload file batching sync|async|off.\n\nThis sets the batch mode used by rclone.\n\nFor full info see [the main docs](https://rclone.org/dropbox/#batch-mode)\n\nThis has 3 possible values\n\n- off - no batching\n- sync - batch uploads and check completion (default)\n- async - batch upload and don't check completion\n\nRclone will close any outstanding batches when it exits which may make\na delay on quit.\n", + "Default": "sync", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "sync", + "ValueStr": "sync", + "Type": "string" }, { - "Name": "location", + "Name": "batch_size", + "FieldName": "", + "Help": "Max number of files in upload batch.\n\nThis sets the batch size of files to upload. It has to be less than 1000.\n\nBy default this is 0 which means rclone will calculate the batch size\ndepending on the setting of batch_mode.\n\n- batch_mode: async - default batch_size is 100\n- batch_mode: sync - default batch_size is the same as --transfers\n- batch_mode: off - not in use\n\nRclone will close any outstanding batches when it exits which may make\na delay on quit.\n\nSetting this is a great idea if you are uploading lots of small files\nas it will make them a lot quicker. You can use --transfers 32 to\nmaximise throughput.\n", + "Default": 0, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "0", + "ValueStr": "0", + "Type": "int" + }, + { + "Name": "batch_timeout", + "FieldName": "", + "Help": "Max time to allow an idle upload batch before uploading.\n\nIf an upload batch is idle for more than this long then it will be\nuploaded.\n\nThe default for this is 0 which means rclone will choose a sensible\ndefault based on the batch_mode in use.\n\n- batch_mode: async - default batch_timeout is 10s\n- batch_mode: sync - default batch_timeout is 500ms\n- batch_mode: off - not in use\n", + "Default": 0, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "0s", + "ValueStr": "0s", + "Type": "Duration" + }, + { + "Name": "batch_commit_timeout", + "FieldName": "", + "Help": "Max time to wait for a batch to finish committing", + "Default": 600000000000, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "10m0s", + "ValueStr": "10m0s", + "Type": "Duration" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "fichier", + "Description": "1Fichier", + "Prefix": "fichier", + "Options": [ + { + "Name": "api_key", + "FieldName": "", + "Help": "Your API Key, get it from https://1fichier.com/console/params.pl.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "shared_folder", + "FieldName": "", + "Help": "If you want to download a shared folder, add this parameter.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "file_password", + "FieldName": "", + "Help": "If you want to download a shared file that is password protected, add this parameter.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": true, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "folder_password", + "FieldName": "", + "Help": "If you want to list the files in a shared folder that is password protected, add this parameter.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": true, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "cdn", + "FieldName": "", + "Help": "Set if you wish to use CDN download links.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 52666494, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot", + "ValueStr": "Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot", + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "filefabric", + "Description": "Enterprise File Fabric", + "Prefix": "filefabric", + "Options": [ + { + "Name": "url", + "FieldName": "", + "Help": "URL of the Enterprise File Fabric to connect to.", + "Default": "", + "Value": null, + "Examples": [ + { + "Value": "https://storagemadeeasy.com", + "Help": "Storage Made Easy US" + }, + { + "Value": "https://eu.storagemadeeasy.com", + "Help": "Storage Made Easy EU" + }, + { + "Value": "https://yourfabric.smestorage.com", + "Help": "Connect to your Enterprise File Fabric" + } + ], + "Hide": 0, + "Required": true, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "root_folder_id", + "FieldName": "", + "Help": "ID of the root folder.\n\nLeave blank normally.\n\nFill in to make rclone start with directory of a given ID.\n", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "permanent_token", + "FieldName": "", + "Help": "Permanent Authentication Token.\n\nA Permanent Authentication Token can be created in the Enterprise File\nFabric, on the users Dashboard under Security, there is an entry\nyou'll see called \"My Authentication Tokens\". Click the Manage button\nto create one.\n\nThese tokens are normally valid for several years.\n\nFor more info see: https://docs.storagemadeeasy.com/organisationcloud/api-tokens\n", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "token", + "FieldName": "", + "Help": "Session Token.\n\nThis is a session token which rclone caches in the config file. It is\nusually valid for 1 hour.\n\nDon't set this value - rclone will set it automatically.\n", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "token_expiry", + "FieldName": "", + "Help": "Token expiry time.\n\nDon't set this value - rclone will set it automatically.\n", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "version", + "FieldName": "", + "Help": "Version read from the file fabric.\n\nDon't set this value - rclone will set it automatically.\n", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 50429954, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "Slash,Del,Ctl,InvalidUtf8,Dot", + "ValueStr": "Slash,Del,Ctl,InvalidUtf8,Dot", + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "filescom", + "Description": "Files.com", + "Prefix": "filescom", + "Options": [ + { + "Name": "site", + "FieldName": "", + "Help": "Your site subdomain (e.g. mysite) or custom domain (e.g. myfiles.customdomain.com).", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "username", + "FieldName": "", + "Help": "The username used to authenticate with Files.com.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "password", + "FieldName": "", + "Help": "The password used to authenticate with Files.com.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": true, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "api_key", + "FieldName": "", + "Help": "The API key used to authenticate with Files.com.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 60923906, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "Slash,BackSlash,Del,Ctl,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot", + "ValueStr": "Slash,BackSlash,Del,Ctl,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot", + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "ftp", + "Description": "FTP", + "Prefix": "ftp", + "Options": [ + { + "Name": "host", + "FieldName": "", + "Help": "FTP host to connect to.\n\nE.g. \"ftp.example.com\".", + "Default": "", + "Value": null, + "Hide": 0, + "Required": true, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "user", + "FieldName": "", + "Help": "FTP username.", + "Default": "zenon", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "zenon", + "ValueStr": "zenon", + "Type": "string" + }, + { + "Name": "port", + "FieldName": "", + "Help": "FTP port number.", + "Default": 21, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "21", + "ValueStr": "21", + "Type": "int" + }, + { + "Name": "pass", + "FieldName": "", + "Help": "FTP password.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": true, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "tls", + "FieldName": "", + "Help": "Use Implicit FTPS (FTP over TLS).\n\nWhen using implicit FTP over TLS the client connects using TLS\nright from the start which breaks compatibility with\nnon-TLS-aware servers. This is usually served over port 990 rather\nthan port 21. Cannot be used in combination with explicit FTPS.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "explicit_tls", + "FieldName": "", + "Help": "Use Explicit FTPS (FTP over TLS).\n\nWhen using explicit FTP over TLS the client explicitly requests\nsecurity from the server in order to upgrade a plain text connection\nto an encrypted one. Cannot be used in combination with implicit FTPS.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "concurrency", + "FieldName": "", + "Help": "Maximum number of FTP simultaneous connections, 0 for unlimited.\n\nNote that setting this is very likely to cause deadlocks so it should\nbe used with care.\n\nIf you are doing a sync or copy then make sure concurrency is one more\nthan the sum of `--transfers` and `--checkers`.\n\nIf you use `--check-first` then it just needs to be one more than the\nmaximum of `--checkers` and `--transfers`.\n\nSo for `concurrency 3` you'd use `--checkers 2 --transfers 2\n--check-first` or `--checkers 1 --transfers 1`.\n\n", + "Default": 0, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "0", + "ValueStr": "0", + "Type": "int" + }, + { + "Name": "no_check_certificate", + "FieldName": "", + "Help": "Do not verify the TLS certificate of the server.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "disable_epsv", + "FieldName": "", + "Help": "Disable using EPSV even if server advertises support.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "disable_mlsd", + "FieldName": "", + "Help": "Disable using MLSD even if server advertises support.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "disable_utf8", + "FieldName": "", + "Help": "Disable using UTF-8 even if server advertises support.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "writing_mdtm", + "FieldName": "", + "Help": "Use MDTM to set modification time (VsFtpd quirk)", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "force_list_hidden", + "FieldName": "", + "Help": "Use LIST -a to force listing of hidden files and folders. This will disable the use of MLSD.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "idle_timeout", + "FieldName": "", + "Help": "Max time before closing idle connections.\n\nIf no connections have been returned to the connection pool in the time\ngiven, rclone will empty the connection pool.\n\nSet to 0 to keep connections indefinitely.\n", + "Default": 60000000000, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "1m0s", + "ValueStr": "1m0s", + "Type": "Duration" + }, + { + "Name": "close_timeout", + "FieldName": "", + "Help": "Maximum time to wait for a response to close.", + "Default": 60000000000, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "1m0s", + "ValueStr": "1m0s", + "Type": "Duration" + }, + { + "Name": "tls_cache_size", + "FieldName": "", + "Help": "Size of TLS session cache for all control and data connections.\n\nTLS cache allows to resume TLS sessions and reuse PSK between connections.\nIncrease if default size is not enough resulting in TLS resumption errors.\nEnabled by default. Use 0 to disable.", + "Default": 32, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "32", + "ValueStr": "32", + "Type": "int" + }, + { + "Name": "disable_tls13", + "FieldName": "", + "Help": "Disable TLS 1.3 (workaround for FTP servers with buggy TLS)", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "shut_timeout", + "FieldName": "", + "Help": "Maximum time to wait for data connection closing status.", + "Default": 60000000000, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "1m0s", + "ValueStr": "1m0s", + "Type": "Duration" + }, + { + "Name": "ask_password", + "FieldName": "", + "Help": "Allow asking for FTP password when needed.\n\nIf this is set and no password is supplied then rclone will ask for a password\n", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "socks_proxy", + "FieldName": "", + "Help": "Socks 5 proxy host.\n\t\t\n\t\tSupports the format user:pass@host:port, user@host:port, host:port.\n\t\t\n\t\tExample:\n\t\t\n\t\t\tmyUser:myPass@localhost:9005\n\t\t", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 35749890, + "Value": null, + "Examples": [ + { + "Value": "Asterisk,Ctl,Dot,Slash", + "Help": "ProFTPd can't handle '*' in file names" + }, + { + "Value": "BackSlash,Ctl,Del,Dot,RightSpace,Slash,SquareBracket", + "Help": "PureFTPd can't handle '[]' or '*' in file names" + }, + { + "Value": "Ctl,LeftPeriod,Slash", + "Help": "VsFTPd can't handle file names starting with dot" + } + ], + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "Slash,Del,Ctl,RightSpace,Dot", + "ValueStr": "Slash,Del,Ctl,RightSpace,Dot", + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "gofile", + "Description": "Gofile", + "Prefix": "gofile", + "Options": [ + { + "Name": "access_token", + "FieldName": "", + "Help": "API Access token\n\nYou can get this from the web control panel.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "root_folder_id", + "FieldName": "", + "Help": "ID of the root folder\n\nLeave this blank normally, rclone will fill it in automatically.\n\nIf you want rclone to be restricted to a particular folder you can\nfill it in - see the docs for more info.\n", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "account_id", + "FieldName": "", + "Help": "Account ID\n\nLeave this blank normally, rclone will fill it in automatically.\n", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "list_chunk", + "FieldName": "", + "Help": "Number of items to list in each call", + "Default": 1000, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "1000", + "ValueStr": "1000", + "Type": "int" + }, + { + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 323331982, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftPeriod,RightPeriod,InvalidUtf8,Dot,Exclamation", + "ValueStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftPeriod,RightPeriod,InvalidUtf8,Dot,Exclamation", + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "google cloud storage", + "Description": "Google Cloud Storage (this is not Google Drive)", + "Prefix": "gcs", + "Options": [ + { + "Name": "client_id", + "FieldName": "", + "Help": "OAuth Client Id.\n\nLeave blank normally.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "client_secret", + "FieldName": "", + "Help": "OAuth Client Secret.\n\nLeave blank normally.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "token", + "FieldName": "", + "Help": "OAuth Access Token as a JSON blob.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "auth_url", + "FieldName": "", + "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "token_url", + "FieldName": "", + "Help": "Token server url.\n\nLeave blank to use the provider defaults.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "project_number", + "FieldName": "", + "Help": "Project number.\n\nOptional - needed only for list/create/delete buckets - see your developer console.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "user_project", + "FieldName": "", + "Help": "User project.\n\nOptional - needed only for requester pays.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "service_account_file", + "FieldName": "", + "Help": "Service Account Credentials JSON file path.\n\nLeave blank normally.\nNeeded only if you want use SA instead of interactive login.\n\nLeading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "service_account_credentials", + "FieldName": "", + "Help": "Service Account Credentials JSON blob.\n\nLeave blank normally.\nNeeded only if you want use SA instead of interactive login.", + "Default": "", + "Value": null, + "Hide": 3, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "anonymous", + "FieldName": "", + "Help": "Access public buckets and objects without credentials.\n\nSet to 'true' if you just want to download files and don't configure credentials.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "object_acl", + "FieldName": "", + "Help": "Access Control List for new objects.", + "Default": "", + "Value": null, + "Examples": [ + { + "Value": "authenticatedRead", + "Help": "Object owner gets OWNER access.\nAll Authenticated Users get READER access." + }, + { + "Value": "bucketOwnerFullControl", + "Help": "Object owner gets OWNER access.\nProject team owners get OWNER access." + }, + { + "Value": "bucketOwnerRead", + "Help": "Object owner gets OWNER access.\nProject team owners get READER access." + }, + { + "Value": "private", + "Help": "Object owner gets OWNER access.\nDefault if left blank." + }, + { + "Value": "projectPrivate", + "Help": "Object owner gets OWNER access.\nProject team members get access according to their roles." + }, + { + "Value": "publicRead", + "Help": "Object owner gets OWNER access.\nAll Users get READER access." + } + ], + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "bucket_acl", + "FieldName": "", + "Help": "Access Control List for new buckets.", + "Default": "", + "Value": null, + "Examples": [ + { + "Value": "authenticatedRead", + "Help": "Project team owners get OWNER access.\nAll Authenticated Users get READER access." + }, + { + "Value": "private", + "Help": "Project team owners get OWNER access.\nDefault if left blank." + }, + { + "Value": "projectPrivate", + "Help": "Project team members get access according to their roles." + }, + { + "Value": "publicRead", + "Help": "Project team owners get OWNER access.\nAll Users get READER access." + }, + { + "Value": "publicReadWrite", + "Help": "Project team owners get OWNER access.\nAll Users get WRITER access." + } + ], + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "bucket_policy_only", + "FieldName": "", + "Help": "Access checks should use bucket-level IAM policies.\n\nIf you want to upload objects to a bucket with Bucket Policy Only set\nthen you will need to set this.\n\nWhen it is set, rclone:\n\n- ignores ACLs set on buckets\n- ignores ACLs set on objects\n- creates buckets with Bucket Policy Only set\n\nDocs: https://cloud.google.com/storage/docs/bucket-policy-only\n", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "location", + "FieldName": "", "Help": "Location for the newly created buckets.", - "Provider": "", "Default": "", "Value": null, - "Examples": [ - { - "Value": "", - "Help": "Empty for default location (US)", - "Provider": "" - }, - { - "Value": "asia", - "Help": "Multi-regional location for Asia", - "Provider": "" - }, - { - "Value": "eu", - "Help": "Multi-regional location for Europe", - "Provider": "" - }, - { - "Value": "us", - "Help": "Multi-regional location for United States", - "Provider": "" - }, - { - "Value": "asia-east1", - "Help": "Taiwan", - "Provider": "" - }, - { - "Value": "asia-east2", - "Help": "Hong Kong", - "Provider": "" - }, - { - "Value": "asia-northeast1", - "Help": "Tokyo", - "Provider": "" - }, - { - "Value": "asia-northeast2", - "Help": "Osaka", - "Provider": "" - }, - { - "Value": "asia-northeast3", - "Help": "Seoul", - "Provider": "" - }, - { - "Value": "asia-south1", - "Help": "Mumbai", - "Provider": "" - }, - { - "Value": "asia-south2", - "Help": "Delhi", - "Provider": "" - }, - { - "Value": "asia-southeast1", - "Help": "Singapore", - "Provider": "" - }, - { - "Value": "asia-southeast2", - "Help": "Jakarta", - "Provider": "" - }, - { - "Value": "australia-southeast1", - "Help": "Sydney", - "Provider": "" - }, - { - "Value": "australia-southeast2", - "Help": "Melbourne", - "Provider": "" - }, - { - "Value": "europe-north1", - "Help": "Finland", - "Provider": "" - }, - { - "Value": "europe-west1", - "Help": "Belgium", - "Provider": "" - }, - { - "Value": "europe-west2", - "Help": "London", - "Provider": "" - }, - { - "Value": "europe-west3", - "Help": "Frankfurt", - "Provider": "" - }, - { - "Value": "europe-west4", - "Help": "Netherlands", - "Provider": "" - }, - { - "Value": "europe-west6", - "Help": "Zürich", - "Provider": "" - }, - { - "Value": "europe-central2", - "Help": "Warsaw", - "Provider": "" - }, - { - "Value": "us-central1", - "Help": "Iowa", - "Provider": "" - }, - { - "Value": "us-east1", - "Help": "South Carolina", - "Provider": "" - }, - { - "Value": "us-east4", - "Help": "Northern Virginia", - "Provider": "" - }, - { - "Value": "us-west1", - "Help": "Oregon", - "Provider": "" - }, - { - "Value": "us-west2", - "Help": "California", - "Provider": "" - }, - { - "Value": "us-west3", - "Help": "Salt Lake City", - "Provider": "" - }, - { - "Value": "us-west4", - "Help": "Las Vegas", - "Provider": "" - }, - { - "Value": "northamerica-northeast1", - "Help": "Montréal", - "Provider": "" - }, - { - "Value": "northamerica-northeast2", - "Help": "Toronto", - "Provider": "" - }, - { - "Value": "southamerica-east1", - "Help": "São Paulo", - "Provider": "" - }, - { - "Value": "southamerica-west1", - "Help": "Santiago", - "Provider": "" - }, - { - "Value": "asia1", - "Help": "Dual region: asia-northeast1 and asia-northeast2.", - "Provider": "" - }, - { - "Value": "eur4", - "Help": "Dual region: europe-north1 and europe-west4.", - "Provider": "" - }, - { - "Value": "nam4", - "Help": "Dual region: us-central1 and us-east1.", - "Provider": "" - } - ], - "ShortOpt": "", + "Examples": [ + { + "Value": "", + "Help": "Empty for default location (US)" + }, + { + "Value": "asia", + "Help": "Multi-regional location for Asia" + }, + { + "Value": "eu", + "Help": "Multi-regional location for Europe" + }, + { + "Value": "us", + "Help": "Multi-regional location for United States" + }, + { + "Value": "asia-east1", + "Help": "Taiwan" + }, + { + "Value": "asia-east2", + "Help": "Hong Kong" + }, + { + "Value": "asia-northeast1", + "Help": "Tokyo" + }, + { + "Value": "asia-northeast2", + "Help": "Osaka" + }, + { + "Value": "asia-northeast3", + "Help": "Seoul" + }, + { + "Value": "asia-south1", + "Help": "Mumbai" + }, + { + "Value": "asia-south2", + "Help": "Delhi" + }, + { + "Value": "asia-southeast1", + "Help": "Singapore" + }, + { + "Value": "asia-southeast2", + "Help": "Jakarta" + }, + { + "Value": "australia-southeast1", + "Help": "Sydney" + }, + { + "Value": "australia-southeast2", + "Help": "Melbourne" + }, + { + "Value": "europe-north1", + "Help": "Finland" + }, + { + "Value": "europe-west1", + "Help": "Belgium" + }, + { + "Value": "europe-west2", + "Help": "London" + }, + { + "Value": "europe-west3", + "Help": "Frankfurt" + }, + { + "Value": "europe-west4", + "Help": "Netherlands" + }, + { + "Value": "europe-west6", + "Help": "Zürich" + }, + { + "Value": "europe-central2", + "Help": "Warsaw" + }, + { + "Value": "us-central1", + "Help": "Iowa" + }, + { + "Value": "us-east1", + "Help": "South Carolina" + }, + { + "Value": "us-east4", + "Help": "Northern Virginia" + }, + { + "Value": "us-west1", + "Help": "Oregon" + }, + { + "Value": "us-west2", + "Help": "California" + }, + { + "Value": "us-west3", + "Help": "Salt Lake City" + }, + { + "Value": "us-west4", + "Help": "Las Vegas" + }, + { + "Value": "northamerica-northeast1", + "Help": "Montréal" + }, + { + "Value": "northamerica-northeast2", + "Help": "Toronto" + }, + { + "Value": "southamerica-east1", + "Help": "São Paulo" + }, + { + "Value": "southamerica-west1", + "Help": "Santiago" + }, + { + "Value": "asia1", + "Help": "Dual region: asia-northeast1 and asia-northeast2." + }, + { + "Value": "eur4", + "Help": "Dual region: europe-north1 and europe-west4." + }, + { + "Value": "nam4", + "Help": "Dual region: us-central1 and us-east1." + } + ], + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "storage_class", + "FieldName": "", + "Help": "The storage class to use when storing objects in Google Cloud Storage.", + "Default": "", + "Value": null, + "Examples": [ + { + "Value": "", + "Help": "Default" + }, + { + "Value": "MULTI_REGIONAL", + "Help": "Multi-regional storage class" + }, + { + "Value": "REGIONAL", + "Help": "Regional storage class" + }, + { + "Value": "NEARLINE", + "Help": "Nearline storage class" + }, + { + "Value": "COLDLINE", + "Help": "Coldline storage class" + }, + { + "Value": "ARCHIVE", + "Help": "Archive storage class" + }, + { + "Value": "DURABLE_REDUCED_AVAILABILITY", + "Help": "Durable reduced availability storage class" + } + ], + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "directory_markers", + "FieldName": "", + "Help": "Upload an empty object with a trailing slash when a new directory is created\n\nEmpty folders are unsupported for bucket based remotes, this option creates an empty\nobject ending with \"/\", to persist the folder.\n", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "no_check_bucket", + "FieldName": "", + "Help": "If set, don't attempt to check the bucket exists or create it.\n\nThis can be useful when trying to minimise the number of transactions\nrclone does if you know the bucket exists already.\n", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "decompress", + "FieldName": "", + "Help": "If set this will decompress gzip encoded objects.\n\nIt is possible to upload objects to GCS with \"Content-Encoding: gzip\"\nset. Normally rclone will download these files as compressed objects.\n\nIf this flag is set then rclone will decompress these files with\n\"Content-Encoding: gzip\" as they are received. This means that rclone\ncan't check the size and hash but the file contents will be decompressed.\n", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "endpoint", + "FieldName": "", + "Help": "Endpoint for the service.\n\nLeave blank normally.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 50348034, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "Slash,CrLf,InvalidUtf8,Dot", + "ValueStr": "Slash,CrLf,InvalidUtf8,Dot", + "Type": "Encoding" + }, + { + "Name": "env_auth", + "FieldName": "", + "Help": "Get GCP IAM credentials from runtime (environment variables or instance meta data if no env vars).\n\nOnly applies if service_account_file and service_account_credentials is blank.", + "Default": false, + "Value": null, + "Examples": [ + { + "Value": "false", + "Help": "Enter credentials in the next step." + }, + { + "Value": "true", + "Help": "Get GCP IAM credentials from the environment (env vars or IAM)." + } + ], + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "google photos", + "Description": "Google Photos", + "Prefix": "gphotos", + "Options": [ + { + "Name": "client_id", + "FieldName": "", + "Help": "OAuth Client Id.\n\nLeave blank normally.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "client_secret", + "FieldName": "", + "Help": "OAuth Client Secret.\n\nLeave blank normally.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "token", + "FieldName": "", + "Help": "OAuth Access Token as a JSON blob.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "auth_url", + "FieldName": "", + "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "token_url", + "FieldName": "", + "Help": "Token server url.\n\nLeave blank to use the provider defaults.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "read_only", + "FieldName": "", + "Help": "Set to make the Google Photos backend read only.\n\nIf you choose read only then rclone will only request read only access\nto your photos, otherwise rclone will request full access.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "read_size", + "FieldName": "", + "Help": "Set to read the size of media items.\n\nNormally rclone does not read the size of media items since this takes\nanother transaction. This isn't necessary for syncing. However\nrclone mount needs to know the size of files in advance of reading\nthem, so setting this flag when using rclone mount is recommended if\nyou want to read the media.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "start_year", + "FieldName": "", + "Help": "Year limits the photos to be downloaded to those which are uploaded after the given year.", + "Default": 2000, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "2000", + "ValueStr": "2000", + "Type": "int" + }, + { + "Name": "include_archived", + "FieldName": "", + "Help": "Also view and download archived media.\n\nBy default, rclone does not request archived media. Thus, when syncing,\narchived media is not visible in directory listings or transferred.\n\nNote that media in albums is always visible and synced, no matter\ntheir archive status.\n\nWith this flag, archived media are always visible in directory\nlistings and transferred.\n\nWithout this flag, archived media will not be visible in directory\nlistings and won't be transferred.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 50348034, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "Slash,CrLf,InvalidUtf8,Dot", + "ValueStr": "Slash,CrLf,InvalidUtf8,Dot", + "Type": "Encoding" + }, + { + "Name": "batch_mode", + "FieldName": "", + "Help": "Upload file batching sync|async|off.\n\nThis sets the batch mode used by rclone.\n\nThis has 3 possible values\n\n- off - no batching\n- sync - batch uploads and check completion (default)\n- async - batch upload and don't check completion\n\nRclone will close any outstanding batches when it exits which may make\na delay on quit.\n", + "Default": "sync", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "sync", + "ValueStr": "sync", + "Type": "string" + }, + { + "Name": "batch_size", + "FieldName": "", + "Help": "Max number of files in upload batch.\n\nThis sets the batch size of files to upload. It has to be less than 50.\n\nBy default this is 0 which means rclone will calculate the batch size\ndepending on the setting of batch_mode.\n\n- batch_mode: async - default batch_size is 50\n- batch_mode: sync - default batch_size is the same as --transfers\n- batch_mode: off - not in use\n\nRclone will close any outstanding batches when it exits which may make\na delay on quit.\n\nSetting this is a great idea if you are uploading lots of small files\nas it will make them a lot quicker. You can use --transfers 32 to\nmaximise throughput.\n", + "Default": 0, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "0", + "ValueStr": "0", + "Type": "int" + }, + { + "Name": "batch_timeout", + "FieldName": "", + "Help": "Max time to allow an idle upload batch before uploading.\n\nIf an upload batch is idle for more than this long then it will be\nuploaded.\n\nThe default for this is 0 which means rclone will choose a sensible\ndefault based on the batch_mode in use.\n\n- batch_mode: async - default batch_timeout is 10s\n- batch_mode: sync - default batch_timeout is 1s\n- batch_mode: off - not in use\n", + "Default": 0, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "0s", + "ValueStr": "0s", + "Type": "Duration" + }, + { + "Name": "batch_commit_timeout", + "FieldName": "", + "Help": "Max time to wait for a batch to finish committing", + "Default": 600000000000, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "10m0s", + "ValueStr": "10m0s", + "Type": "Duration" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "hasher", + "Description": "Better checksums for other remotes", + "Prefix": "hasher", + "Options": [ + { + "Name": "remote", + "FieldName": "", + "Help": "Remote to cache checksums for (e.g. myRemote:path).", + "Default": "", + "Value": null, + "Hide": 0, + "Required": true, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "hashes", + "FieldName": "", + "Help": "Comma separated list of supported checksum types.", + "Default": [ + "md5", + "sha1" + ], + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "md5,sha1", + "ValueStr": "md5,sha1", + "Type": "CommaSepList" + }, + { + "Name": "max_age", + "FieldName": "", + "Help": "Maximum time to keep checksums in cache (0 = no cache, off = cache forever).", + "Default": 9223372036854775807, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "off", + "ValueStr": "off", + "Type": "Duration" + }, + { + "Name": "auto_size", + "FieldName": "", + "Help": "Auto-update checksum for files smaller than this size (disabled by default).", + "Default": 0, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "0", + "ValueStr": "0", + "Type": "SizeSuffix" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": [ + { + "Name": "drop", + "Short": "Drop cache", + "Long": "Completely drop checksum cache.\nUsage Example:\n rclone backend drop hasher:\n", + "Opts": null + }, + { + "Name": "dump", + "Short": "Dump the database", + "Long": "Dump cache records covered by the current remote", + "Opts": null + }, + { + "Name": "fulldump", + "Short": "Full dump of the database", + "Long": "Dump all cache records in the database", + "Opts": null + }, + { + "Name": "import", + "Short": "Import a SUM file", + "Long": "Amend hash cache from a SUM file and bind checksums to files by size/time.\nUsage Example:\n rclone backend import hasher:subdir md5 /path/to/sum.md5\n", + "Opts": null + }, + { + "Name": "stickyimport", + "Short": "Perform fast import of a SUM file", + "Long": "Fill hash cache from a SUM file without verifying file fingerprints.\nUsage Example:\n rclone backend stickyimport hasher:subdir md5 remote:path/to/sum.md5\n", + "Opts": null + } + ], + "Aliases": null, + "Hide": false, + "MetadataInfo": { + "System": null, + "Help": "Any metadata supported by the underlying remote is read and written." + } + }, + { + "Name": "hdfs", + "Description": "Hadoop distributed file system", + "Prefix": "hdfs", + "Options": [ + { + "Name": "namenode", + "FieldName": "", + "Help": "Hadoop name nodes and ports.\n\nE.g. \"namenode-1:8020,namenode-2:8020,...\" to connect to host namenodes at port 8020.", + "Default": [], + "Value": null, + "Hide": 0, + "Required": true, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "CommaSepList" + }, + { + "Name": "username", + "FieldName": "", + "Help": "Hadoop user name.", + "Default": "", + "Value": null, + "Examples": [ + { + "Value": "root", + "Help": "Connect to hdfs as root." + } + ], + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "service_principal_name", + "FieldName": "", + "Help": "Kerberos service principal name for the namenode.\n\nEnables KERBEROS authentication. Specifies the Service Principal Name\n(SERVICE/FQDN) for the namenode. E.g. \\\"hdfs/namenode.hadoop.docker\\\"\nfor namenode running as service 'hdfs' with FQDN 'namenode.hadoop.docker'.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "data_transfer_protection", + "FieldName": "", + "Help": "Kerberos data transfer protection: authentication|integrity|privacy.\n\nSpecifies whether or not authentication, data signature integrity\nchecks, and wire encryption are required when communicating with\nthe datanodes. Possible values are 'authentication', 'integrity'\nand 'privacy'. Used only with KERBEROS enabled.", + "Default": "", + "Value": null, + "Examples": [ + { + "Value": "privacy", + "Help": "Ensure authentication, integrity and encryption enabled." + } + ], + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 50430082, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "Slash,Colon,Del,Ctl,InvalidUtf8,Dot", + "ValueStr": "Slash,Colon,Del,Ctl,InvalidUtf8,Dot", + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "hidrive", + "Description": "HiDrive", + "Prefix": "hidrive", + "Options": [ + { + "Name": "client_id", + "FieldName": "", + "Help": "OAuth Client Id.\n\nLeave blank normally.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "client_secret", + "FieldName": "", + "Help": "OAuth Client Secret.\n\nLeave blank normally.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "token", + "FieldName": "", + "Help": "OAuth Access Token as a JSON blob.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "auth_url", + "FieldName": "", + "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "token_url", + "FieldName": "", + "Help": "Token server url.\n\nLeave blank to use the provider defaults.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "scope_access", + "FieldName": "", + "Help": "Access permissions that rclone should use when requesting access from HiDrive.", + "Default": "rw", + "Value": null, + "Examples": [ + { + "Value": "rw", + "Help": "Read and write access to resources." + }, + { + "Value": "ro", + "Help": "Read-only access to resources." + } + ], + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "rw", + "ValueStr": "rw", + "Type": "string" + }, + { + "Name": "scope_role", + "FieldName": "", + "Help": "User-level that rclone should use when requesting access from HiDrive.", + "Default": "user", + "Value": null, + "Examples": [ + { + "Value": "user", + "Help": "User-level access to management permissions.\nThis will be sufficient in most cases." + }, + { + "Value": "admin", + "Help": "Extensive access to management permissions." + }, + { + "Value": "owner", + "Help": "Full access to management permissions." + } + ], + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "user", + "ValueStr": "user", + "Type": "string" + }, + { + "Name": "root_prefix", + "FieldName": "", + "Help": "The root/parent folder for all paths.\n\nFill in to use the specified folder as the parent for all paths given to the remote.\nThis way rclone can use any folder as its starting point.", + "Default": "/", + "Value": null, + "Examples": [ + { + "Value": "/", + "Help": "The topmost directory accessible by rclone.\nThis will be equivalent with \"root\" if rclone uses a regular HiDrive user account." + }, + { + "Value": "root", + "Help": "The topmost directory of the HiDrive user account" + }, + { + "Value": "", + "Help": "This specifies that there is no root-prefix for your paths.\nWhen using this you will always need to specify paths to this remote with a valid parent e.g. \"remote:/path/to/dir\" or \"remote:root/path/to/dir\"." + } + ], + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "/", + "ValueStr": "/", + "Type": "string" + }, + { + "Name": "endpoint", + "FieldName": "", + "Help": "Endpoint for the service.\n\nThis is the URL that API-calls will be made to.", + "Default": "https://api.hidrive.strato.com/2.1", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "https://api.hidrive.strato.com/2.1", + "ValueStr": "https://api.hidrive.strato.com/2.1", + "Type": "string" + }, + { + "Name": "disable_fetching_member_count", + "FieldName": "", + "Help": "Do not fetch number of objects in directories unless it is absolutely necessary.\n\nRequests may be faster if the number of objects in subdirectories is not fetched.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "chunk_size", + "FieldName": "", + "Help": "Chunksize for chunked uploads.\n\nAny files larger than the configured cutoff (or files of unknown size) will be uploaded in chunks of this size.\n\nThe upper limit for this is 2147483647 bytes (about 2.000Gi).\nThat is the maximum amount of bytes a single upload-operation will support.\nSetting this above the upper limit or to a negative value will cause uploads to fail.\n\nSetting this to larger values may increase the upload speed at the cost of using more memory.\nIt can be set to smaller values smaller to save on memory.", + "Default": 50331648, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "48Mi", + "ValueStr": "48Mi", + "Type": "SizeSuffix" + }, + { + "Name": "upload_cutoff", + "FieldName": "", + "Help": "Cutoff/Threshold for chunked uploads.\n\nAny files larger than this will be uploaded in chunks of the configured chunksize.\n\nThe upper limit for this is 2147483647 bytes (about 2.000Gi).\nThat is the maximum amount of bytes a single upload-operation will support.\nSetting this above the upper limit will cause uploads to fail.", + "Default": 100663296, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "96Mi", + "ValueStr": "96Mi", + "Type": "SizeSuffix" + }, + { + "Name": "upload_concurrency", + "FieldName": "", + "Help": "Concurrency for chunked uploads.\n\nThis is the upper limit for how many transfers for the same file are running concurrently.\nSetting this above to a value smaller than 1 will cause uploads to deadlock.\n\nIf you are uploading small numbers of large files over high-speed links\nand these uploads do not fully utilize your bandwidth, then increasing\nthis may help to speed up the transfers.", + "Default": 4, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "4", + "ValueStr": "4", + "Type": "int" + }, + { + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 33554434, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "Slash,Dot", + "ValueStr": "Slash,Dot", + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "http", + "Description": "HTTP", + "Prefix": "http", + "Options": [ + { + "Name": "url", + "FieldName": "", + "Help": "URL of HTTP host to connect to.\n\nE.g. \"https://example.com\", or \"https://user:pass@example.com\" to use a username and password.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": true, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "headers", + "FieldName": "", + "Help": "Set HTTP headers for all transactions.\n\nUse this to set additional HTTP headers for all transactions.\n\nThe input format is comma separated list of key,value pairs. Standard\n[CSV encoding](https://godoc.org/encoding/csv) may be used.\n\nFor example, to set a Cookie use 'Cookie,name=value', or '\"Cookie\",\"name=value\"'.\n\nYou can set multiple headers, e.g. '\"Cookie\",\"name=value\",\"Authorization\",\"xxx\"'.", + "Default": [], + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "CommaSepList" + }, + { + "Name": "no_slash", + "FieldName": "", + "Help": "Set this if the site doesn't end directories with /.\n\nUse this if your target website does not use / on the end of\ndirectories.\n\nA / on the end of a path is how rclone normally tells the difference\nbetween files and directories. If this flag is set, then rclone will\ntreat all files with Content-Type: text/html as directories and read\nURLs from them rather than downloading them.\n\nNote that this may cause rclone to confuse genuine HTML files with\ndirectories.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "no_head", + "FieldName": "", + "Help": "Don't use HEAD requests.\n\nHEAD requests are mainly used to find file sizes in dir listing.\nIf your site is being very slow to load then you can try this option.\nNormally rclone does a HEAD request for each potential file in a\ndirectory listing to:\n\n- find its size\n- check it really exists\n- check to see if it is a directory\n\nIf you set this option, rclone will not do the HEAD request. This will mean\nthat directory listings are much quicker, but rclone won't have the times or\nsizes of any files, and some files that don't exist may be in the listing.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "no_escape", + "FieldName": "", + "Help": "Do not escape URL metacharacters in path names.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": [ + { + "Name": "set", + "Short": "Set command for updating the config parameters.", + "Long": "This set command can be used to update the config parameters\nfor a running http backend.\n\nUsage Examples:\n\n rclone backend set remote: [-o opt_name=opt_value] [-o opt_name2=opt_value2]\n rclone rc backend/command command=set fs=remote: [-o opt_name=opt_value] [-o opt_name2=opt_value2]\n rclone rc backend/command command=set fs=remote: -o url=https://example.com\n\nThe option keys are named as they are in the config file.\n\nThis rebuilds the connection to the http backend when it is called with\nthe new parameters. Only new parameters need be passed as the values\nwill default to those currently in use.\n\nIt doesn't return anything.\n", + "Opts": null + } + ], + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "imagekit", + "Description": "ImageKit.io", + "Prefix": "imagekit", + "Options": [ + { + "Name": "endpoint", + "FieldName": "", + "Help": "You can find your ImageKit.io URL endpoint in your [dashboard](https://imagekit.io/dashboard/developer/api-keys)", + "Default": "", + "Value": null, + "Hide": 0, + "Required": true, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "public_key", + "FieldName": "", + "Help": "You can find your ImageKit.io public key in your [dashboard](https://imagekit.io/dashboard/developer/api-keys)", + "Default": "", + "Value": null, + "Hide": 0, + "Required": true, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "private_key", + "FieldName": "", + "Help": "You can find your ImageKit.io private key in your [dashboard](https://imagekit.io/dashboard/developer/api-keys)", + "Default": "", + "Value": null, + "Hide": 0, + "Required": true, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "only_signed", + "FieldName": "", + "Help": "If you have configured `Restrict unsigned image URLs` in your dashboard settings, set this to true.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "versions", + "FieldName": "", + "Help": "Include old versions in directory listings.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "upload_tags", + "FieldName": "", + "Help": "Tags to add to the uploaded files, e.g. \"tag1,tag2\".", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 117553486, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket", + "ValueStr": "Slash,LtGt,DoubleQuote,Dollar,Question,Hash,Percent,BackSlash,Del,Ctl,InvalidUtf8,Dot,SquareBracket", + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": { + "System": { + "aws-tags": { + "Help": "AI generated tags by AWS Rekognition associated with the image", + "Type": "string", + "Example": "tag1,tag2", + "ReadOnly": true + }, + "btime": { + "Help": "Time of file birth (creation) read from Last-Modified header", + "Type": "RFC 3339", + "Example": "2006-01-02T15:04:05.999999999Z07:00", + "ReadOnly": true + }, + "custom-coordinates": { + "Help": "Custom coordinates of the file", + "Type": "string", + "Example": "0,0,100,100", + "ReadOnly": true + }, + "file-type": { + "Help": "Type of the file", + "Type": "string", + "Example": "image", + "ReadOnly": true + }, + "google-tags": { + "Help": "AI generated tags by Google Cloud Vision associated with the image", + "Type": "string", + "Example": "tag1,tag2", + "ReadOnly": true + }, + "has-alpha": { + "Help": "Whether the image has alpha channel or not", + "Type": "bool", + "Example": "", + "ReadOnly": true + }, + "height": { + "Help": "Height of the image or video in pixels", + "Type": "int", + "Example": "", + "ReadOnly": true + }, + "is-private-file": { + "Help": "Whether the file is private or not", + "Type": "bool", + "Example": "", + "ReadOnly": true + }, + "size": { + "Help": "Size of the object in bytes", + "Type": "int64", + "Example": "", + "ReadOnly": true + }, + "tags": { + "Help": "Tags associated with the file", + "Type": "string", + "Example": "tag1,tag2", + "ReadOnly": true + }, + "width": { + "Help": "Width of the image or video in pixels", + "Type": "int", + "Example": "", + "ReadOnly": true + } + }, + "Help": "Any metadata supported by the underlying remote is read and written." + } + }, + { + "Name": "internetarchive", + "Description": "Internet Archive", + "Prefix": "internetarchive", + "Options": [ + { + "Name": "access_key_id", + "FieldName": "", + "Help": "IAS3 Access Key.\n\nLeave blank for anonymous access.\nYou can find one here: https://archive.org/account/s3.php", + "Default": "", + "Value": null, "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": false, "Exclusive": false, - "Sensitive": false, + "Sensitive": true, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "storage_class", - "Help": "The storage class to use when storing objects in Google Cloud Storage.", - "Provider": "", + "Name": "secret_access_key", + "FieldName": "", + "Help": "IAS3 Secret Key (password).\n\nLeave blank for anonymous access.", "Default": "", "Value": null, - "Examples": [ - { - "Value": "", - "Help": "Default", - "Provider": "" - }, - { - "Value": "MULTI_REGIONAL", - "Help": "Multi-regional storage class", - "Provider": "" - }, - { - "Value": "REGIONAL", - "Help": "Regional storage class", - "Provider": "" - }, - { - "Value": "NEARLINE", - "Help": "Nearline storage class", - "Provider": "" - }, - { - "Value": "COLDLINE", - "Help": "Coldline storage class", - "Provider": "" - }, - { - "Value": "ARCHIVE", - "Help": "Archive storage class", - "Provider": "" - }, - { - "Value": "DURABLE_REDUCED_AVAILABILITY", - "Help": "Durable reduced availability storage class", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": false, "Exclusive": false, - "Sensitive": false, + "Sensitive": true, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "directory_markers", - "Help": "Upload an empty object with a trailing slash when a new directory is created\n\nEmpty folders are unsupported for bucket based remotes, this option creates an empty\nobject ending with \"/\", to persist the folder.\n", - "Provider": "", - "Default": false, + "Name": "endpoint", + "FieldName": "", + "Help": "IAS3 Endpoint.\n\nLeave blank for default value.", + "Default": "https://s3.us.archive.org", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -4893,17 +7026,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "https://s3.us.archive.org", + "ValueStr": "https://s3.us.archive.org", + "Type": "string" }, { - "Name": "no_check_bucket", - "Help": "If set, don't attempt to check the bucket exists or create it.\n\nThis can be useful when trying to minimise the number of transactions\nrclone does if you know the bucket exists already.\n", - "Provider": "", - "Default": false, + "Name": "front_endpoint", + "FieldName": "", + "Help": "Host of InternetArchive Frontend.\n\nLeave blank for default value.", + "Default": "https://archive.org", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -4911,17 +7043,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "https://archive.org", + "ValueStr": "https://archive.org", + "Type": "string" }, { - "Name": "decompress", - "Help": "If set this will decompress gzip encoded objects.\n\nIt is possible to upload objects to GCS with \"Content-Encoding: gzip\"\nset. Normally rclone will download these files as compressed objects.\n\nIf this flag is set then rclone will decompress these files with\n\"Content-Encoding: gzip\" as they are received. This means that rclone\ncan't check the size and hash but the file contents will be decompressed.\n", - "Provider": "", - "Default": false, + "Name": "disable_checksum", + "FieldName": "", + "Help": "Don't ask the server to test against MD5 checksum calculated by rclone.\nNormally rclone will calculate the MD5 checksum of the input before\nuploading it so it can ask the server to check the object against checksum.\nThis is great for data integrity checking but can cause long delays for\nlarge files to start uploading.", + "Default": true, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -4929,17 +7060,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", + "DefaultStr": "true", + "ValueStr": "true", "Type": "bool" }, { - "Name": "endpoint", - "Help": "Endpoint for the service.\n\nLeave blank normally.", - "Provider": "", - "Default": "", + "Name": "wait_archive", + "FieldName": "", + "Help": "Timeout for waiting the server's processing tasks (specifically archive and book_op) to finish.\nOnly enable if you need to be guaranteed to be reflected after write operations.\n0 to disable waiting. No errors to be thrown in case of timeout.", + "Default": 0, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -4947,17 +7077,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "0s", + "ValueStr": "0s", + "Type": "Duration" }, { "Name": "encoding", + "FieldName": "", "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 50348034, + "Default": 50446342, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -4965,58 +7094,132 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,CrLf,InvalidUtf8,Dot", - "ValueStr": "Slash,CrLf,InvalidUtf8,Dot", - "Type": "MultiEncoder" + "DefaultStr": "Slash,LtGt,CrLf,Del,Ctl,InvalidUtf8,Dot", + "ValueStr": "Slash,LtGt,CrLf,Del,Ctl,InvalidUtf8,Dot", + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": { + "System": { + "crc32": { + "Help": "CRC32 calculated by Internet Archive", + "Type": "string", + "Example": "01234567", + "ReadOnly": true + }, + "format": { + "Help": "Name of format identified by Internet Archive", + "Type": "string", + "Example": "Comma-Separated Values", + "ReadOnly": true + }, + "md5": { + "Help": "MD5 hash calculated by Internet Archive", + "Type": "string", + "Example": "01234567012345670123456701234567", + "ReadOnly": true + }, + "mtime": { + "Help": "Time of last modification, managed by Rclone", + "Type": "RFC 3339", + "Example": "2006-01-02T15:04:05.999999999Z", + "ReadOnly": true + }, + "name": { + "Help": "Full file path, without the bucket part", + "Type": "filename", + "Example": "backend/internetarchive/internetarchive.go", + "ReadOnly": true + }, + "old_version": { + "Help": "Whether the file was replaced and moved by keep-old-version flag", + "Type": "boolean", + "Example": "true", + "ReadOnly": true + }, + "rclone-ia-mtime": { + "Help": "Time of last modification, managed by Internet Archive", + "Type": "RFC 3339", + "Example": "2006-01-02T15:04:05.999999999Z", + "ReadOnly": false + }, + "rclone-mtime": { + "Help": "Time of last modification, managed by Rclone", + "Type": "RFC 3339", + "Example": "2006-01-02T15:04:05.999999999Z", + "ReadOnly": false + }, + "rclone-update-track": { + "Help": "Random value used by Rclone for tracking changes inside Internet Archive", + "Type": "string", + "Example": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "ReadOnly": false + }, + "sha1": { + "Help": "SHA1 hash calculated by Internet Archive", + "Type": "string", + "Example": "0123456701234567012345670123456701234567", + "ReadOnly": true + }, + "size": { + "Help": "File size in bytes", + "Type": "decimal number", + "Example": "123456", + "ReadOnly": true + }, + "source": { + "Help": "The source of the file", + "Type": "string", + "Example": "original", + "ReadOnly": true + }, + "summation": { + "Help": "Check https://forum.rclone.org/t/31922 for how it is used", + "Type": "string", + "Example": "md5", + "ReadOnly": true + }, + "viruscheck": { + "Help": "The last time viruscheck process was run for the file (?)", + "Type": "unixtime", + "Example": "1654191352", + "ReadOnly": true + } }, - { - "Name": "env_auth", - "Help": "Get GCP IAM credentials from runtime (environment variables or instance meta data if no env vars).\n\nOnly applies if service_account_file and service_account_credentials is blank.", - "Provider": "", - "Default": false, - "Value": null, - "Examples": [ - { - "Value": "false", - "Help": "Enter credentials in the next step.", - "Provider": "" - }, - { - "Value": "true", - "Help": "Get GCP IAM credentials from the environment (env vars or IAM).", - "Provider": "" - } - ], - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null + "Help": "Metadata fields provided by Internet Archive.\nIf there are multiple values for a key, only the first one is returned.\nThis is a limitation of Rclone, that supports one value per one key.\n\nOwner is able to add custom keys. Metadata feature grabs all the keys including them.\n" + } }, { - "Name": "google photos", - "Description": "Google Photos", - "Prefix": "gphotos", + "Name": "jottacloud", + "Description": "Jottacloud", + "Prefix": "jottacloud", "Options": [ { "Name": "client_id", + "FieldName": "", "Help": "OAuth Client Id.\n\nLeave blank normally.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5030,11 +7233,10 @@ }, { "Name": "client_secret", + "FieldName": "", "Help": "OAuth Client Secret.\n\nLeave blank normally.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5048,11 +7250,10 @@ }, { "Name": "token", + "FieldName": "", "Help": "OAuth Access Token as a JSON blob.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5066,11 +7267,10 @@ }, { "Name": "auth_url", + "FieldName": "", "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5084,11 +7284,10 @@ }, { "Name": "token_url", + "FieldName": "", "Help": "Token server url.\n\nLeave blank to use the provider defaults.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5101,30 +7300,28 @@ "Type": "string" }, { - "Name": "read_only", - "Help": "Set to make the Google Photos backend read only.\n\nIf you choose read only then rclone will only request read only access\nto your photos, otherwise rclone will request full access.", - "Provider": "", - "Default": false, + "Name": "md5_memory_limit", + "FieldName": "", + "Help": "Files bigger than this will be cached on disk to calculate the MD5 if required.", + "Default": 10485760, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "10Mi", + "ValueStr": "10Mi", + "Type": "SizeSuffix" }, { - "Name": "read_size", - "Help": "Set to read the size of media items.\n\nNormally rclone does not read the size of media items since this takes\nanother transaction. This isn't necessary for syncing. However\nrclone mount needs to know the size of files in advance of reading\nthem, so setting this flag when using rclone mount is recommended if\nyou want to read the media.", - "Provider": "", + "Name": "trashed_only", + "FieldName": "", + "Help": "Only show files that are in the trash.\n\nThis will show trashed files in their original directory structure.", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5137,30 +7334,11 @@ "Type": "bool" }, { - "Name": "start_year", - "Help": "Year limits the photos to be downloaded to those which are uploaded after the given year.", - "Provider": "", - "Default": 2000, - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "2000", - "ValueStr": "2000", - "Type": "int" - }, - { - "Name": "include_archived", - "Help": "Also view and download archived media.\n\nBy default, rclone does not request archived media. Thus, when syncing,\narchived media is not visible in directory listings or transferred.\n\nNote that media in albums is always visible and synced, no matter\ntheir archive status.\n\nWith this flag, archived media are always visible in directory\nlistings and transferred.\n\nWithout this flag, archived media will not be visible in directory\nlistings and won't be transferred.", - "Provider": "", + "Name": "hard_delete", + "FieldName": "", + "Help": "Delete files permanently rather than putting them into the trash.", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5173,12 +7351,11 @@ "Type": "bool" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 50348034, + "Name": "upload_resume_limit", + "FieldName": "", + "Help": "Files bigger than this can be resumed if the upload fail's.", + "Default": 10485760, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5186,85 +7363,33 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,CrLf,InvalidUtf8,Dot", - "ValueStr": "Slash,CrLf,InvalidUtf8,Dot", - "Type": "MultiEncoder" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "hasher", - "Description": "Better checksums for other remotes", - "Prefix": "hasher", - "Options": [ - { - "Name": "remote", - "Help": "Remote to cache checksums for (e.g. myRemote:path).", - "Provider": "", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": true, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" - }, - { - "Name": "hashes", - "Help": "Comma separated list of supported checksum types.", - "Provider": "", - "Default": [ - "md5", - "sha1" - ], - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "md5,sha1", - "ValueStr": "md5,sha1", - "Type": "CommaSepList" + "DefaultStr": "10Mi", + "ValueStr": "10Mi", + "Type": "SizeSuffix" }, { - "Name": "max_age", - "Help": "Maximum time to keep checksums in cache (0 = no cache, off = cache forever).", - "Provider": "", - "Default": 9223372036854775807, + "Name": "no_versions", + "FieldName": "", + "Help": "Avoid server side versioning by deleting files and recreating files instead of overwriting them.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "off", - "ValueStr": "off", - "Type": "Duration" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "auto_size", - "Help": "Auto-update checksum for files smaller than this size (disabled by default).", - "Provider": "", - "Default": 0, + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 50431886, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5272,130 +7397,121 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "0", - "ValueStr": "0", - "Type": "SizeSuffix" - } - ], - "CommandHelp": [ - { - "Name": "drop", - "Short": "Drop cache", - "Long": "Completely drop checksum cache.\nUsage Example:\n rclone backend drop hasher:\n", - "Opts": null - }, - { - "Name": "dump", - "Short": "Dump the database", - "Long": "Dump cache records covered by the current remote", - "Opts": null - }, - { - "Name": "fulldump", - "Short": "Full dump of the database", - "Long": "Dump all cache records in the database", - "Opts": null - }, - { - "Name": "import", - "Short": "Import a SUM file", - "Long": "Amend hash cache from a SUM file and bind checksums to files by size/time.\nUsage Example:\n rclone backend import hasher:subdir md5 /path/to/sum.md5\n", - "Opts": null + "DefaultStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot", + "ValueStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot", + "Type": "Encoding" }, { - "Name": "stickyimport", - "Short": "Perform fast import of a SUM file", - "Long": "Fill hash cache from a SUM file without verifying file fingerprints.\nUsage Example:\n rclone backend stickyimport hasher:subdir md5 remote:path/to/sum.md5\n", - "Opts": null - } - ], - "Aliases": null, - "Hide": false, - "MetadataInfo": { - "System": null, - "Help": "Any metadata supported by the underlying remote is read and written." - } - }, - { - "Name": "hdfs", - "Description": "Hadoop distributed file system", - "Prefix": "hdfs", - "Options": [ - { - "Name": "namenode", - "Help": "Hadoop name node and port.\n\nE.g. \"namenode:8020\" to connect to host namenode at port 8020.", - "Provider": "", + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": true, + "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": { + "System": { + "btime": { + "Help": "Time of file birth (creation), read from rclone metadata", + "Type": "RFC 3339", + "Example": "2006-01-02T15:04:05.999999999Z07:00", + "ReadOnly": false + }, + "content-type": { + "Help": "MIME type, also known as media type", + "Type": "string", + "Example": "text/plain", + "ReadOnly": true + }, + "mtime": { + "Help": "Time of last modification, read from rclone metadata", + "Type": "RFC 3339", + "Example": "2006-01-02T15:04:05.999999999Z07:00", + "ReadOnly": false + }, + "utime": { + "Help": "Time of last upload, when current revision was created, generated by backend", + "Type": "RFC 3339", + "Example": "2006-01-02T15:04:05.999999999Z07:00", + "ReadOnly": true + } }, + "Help": "Jottacloud has limited support for metadata, currently an extended set of timestamps." + } + }, + { + "Name": "koofr", + "Description": "Koofr, Digi Storage and other Koofr-compatible storage providers", + "Prefix": "koofr", + "Options": [ { - "Name": "username", - "Help": "Hadoop user name.", - "Provider": "", + "Name": "provider", + "FieldName": "", + "Help": "Choose your storage provider.", "Default": "", "Value": null, "Examples": [ { - "Value": "root", - "Help": "Connect to hdfs as root.", - "Provider": "" + "Value": "koofr", + "Help": "Koofr, https://app.koofr.net/" + }, + { + "Value": "digistorage", + "Help": "Digi Storage, https://storage.rcs-rds.ro/" + }, + { + "Value": "other", + "Help": "Any other Koofr API compatible storage service" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": false, "Exclusive": false, - "Sensitive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "service_principal_name", - "Help": "Kerberos service principal name for the namenode.\n\nEnables KERBEROS authentication. Specifies the Service Principal Name\n(SERVICE/FQDN) for the namenode. E.g. \\\"hdfs/namenode.hadoop.docker\\\"\nfor namenode running as service 'hdfs' with FQDN 'namenode.hadoop.docker'.", - "Provider": "", + "Name": "endpoint", + "FieldName": "", + "Help": "The Koofr API endpoint to use.", + "Provider": "other", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, + "Required": true, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "data_transfer_protection", - "Help": "Kerberos data transfer protection: authentication|integrity|privacy.\n\nSpecifies whether or not authentication, data signature integrity\nchecks, and wire encryption are required when communicating with\nthe datanodes. Possible values are 'authentication', 'integrity'\nand 'privacy'. Used only with KERBEROS enabled.", - "Provider": "", + "Name": "mountid", + "FieldName": "", + "Help": "Mount ID of the mount to use.\n\nIf omitted, the primary mount is used.", "Default": "", "Value": null, - "Examples": [ - { - "Value": "privacy", - "Help": "Ensure authentication, integrity and encryption enabled.", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5408,12 +7524,11 @@ "Type": "string" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 50430082, + "Name": "setmtime", + "FieldName": "", + "Help": "Does the backend support setting modification time.\n\nSet this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend.", + "Default": true, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5421,30 +7536,18 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,Colon,Del,Ctl,InvalidUtf8,Dot", - "ValueStr": "Slash,Colon,Del,Ctl,InvalidUtf8,Dot", - "Type": "MultiEncoder" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "hidrive", - "Description": "HiDrive", - "Prefix": "hidrive", - "Options": [ + "DefaultStr": "true", + "ValueStr": "true", + "Type": "bool" + }, { - "Name": "client_id", - "Help": "OAuth Client Id.\n\nLeave blank normally.", - "Provider": "", + "Name": "user", + "FieldName": "", + "Help": "Your user name.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, + "Required": true, "IsPassword": false, "NoPrefix": false, "Advanced": false, @@ -5455,53 +7558,53 @@ "Type": "string" }, { - "Name": "client_secret", - "Help": "OAuth Client Secret.\n\nLeave blank normally.", - "Provider": "", + "Name": "password", + "FieldName": "", + "Help": "Your password for rclone generate one at https://app.koofr.net/app/admin/preferences/password.", + "Provider": "koofr", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, - "IsPassword": false, + "Required": true, + "IsPassword": true, "NoPrefix": false, "Advanced": false, "Exclusive": false, - "Sensitive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "token", - "Help": "OAuth Access Token as a JSON blob.", - "Provider": "", + "Name": "password", + "FieldName": "", + "Help": "Your password for rclone generate one at https://storage.rcs-rds.ro/app/admin/preferences/password.", + "Provider": "digistorage", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, - "IsPassword": false, + "Required": true, + "IsPassword": true, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "auth_url", - "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", - "Provider": "", + "Name": "password", + "FieldName": "", + "Help": "Your password for rclone (generate one at your service's settings page).", + "Provider": "other", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, - "IsPassword": false, + "Required": true, + "IsPassword": true, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, "DefaultStr": "", @@ -5509,12 +7612,28 @@ "Type": "string" }, { - "Name": "token_url", - "Help": "Token server url.\n\nLeave blank to use the provider defaults.", - "Provider": "", + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 50438146, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot", + "ValueStr": "Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot", + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5525,61 +7644,41 @@ "DefaultStr": "", "ValueStr": "", "Type": "string" - }, + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "linkbox", + "Description": "Linkbox", + "Prefix": "linkbox", + "Options": [ { - "Name": "scope_access", - "Help": "Access permissions that rclone should use when requesting access from HiDrive.", - "Provider": "", - "Default": "rw", + "Name": "token", + "FieldName": "", + "Help": "Token from https://www.linkbox.to/admin/account", + "Default": "", "Value": null, - "Examples": [ - { - "Value": "rw", - "Help": "Read and write access to resources.", - "Provider": "" - }, - { - "Value": "ro", - "Help": "Read-only access to resources.", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, - "Required": false, + "Required": true, "IsPassword": false, "NoPrefix": false, "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "rw", - "ValueStr": "rw", + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", "Type": "string" }, { - "Name": "scope_role", - "Help": "User-level that rclone should use when requesting access from HiDrive.", - "Provider": "", - "Default": "user", + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", "Value": null, - "Examples": [ - { - "Value": "user", - "Help": "User-level access to management permissions.\nThis will be sufficient in most cases.", - "Provider": "" - }, - { - "Value": "admin", - "Help": "Extensive access to management permissions.", - "Provider": "" - }, - { - "Value": "owner", - "Help": "Full access to management permissions.", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5587,34 +7686,33 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "user", - "ValueStr": "user", + "DefaultStr": "", + "ValueStr": "", "Type": "string" - }, + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "local", + "Description": "Local Disk", + "Prefix": "local", + "Options": [ { - "Name": "root_prefix", - "Help": "The root/parent folder for all paths.\n\nFill in to use the specified folder as the parent for all paths given to the remote.\nThis way rclone can use any folder as its starting point.", - "Provider": "", - "Default": "/", + "Name": "nounc", + "FieldName": "", + "Help": "Disable UNC (long path names) conversion on Windows.", + "Default": false, "Value": null, "Examples": [ { - "Value": "/", - "Help": "The topmost directory accessible by rclone.\nThis will be equivalent with \"root\" if rclone uses a regular HiDrive user account.", - "Provider": "" - }, - { - "Value": "root", - "Help": "The topmost directory of the HiDrive user account", - "Provider": "" - }, - { - "Value": "", - "Help": "This specifies that there is no root-prefix for your paths.\nWhen using this you will always need to specify paths to this remote with a valid parent e.g. \"remote:/path/to/dir\" or \"remote:root/path/to/dir\".", - "Provider": "" + "Value": "true", + "Help": "Disables long file names." } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5622,39 +7720,39 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "/", - "ValueStr": "/", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "endpoint", - "Help": "Endpoint for the service.\n\nThis is the URL that API-calls will be made to.", - "Provider": "", - "Default": "https://api.hidrive.strato.com/2.1", + "Name": "copy_links", + "FieldName": "", + "Help": "Follow symlinks and copy the pointed to item.", + "Default": false, "Value": null, - "ShortOpt": "", + "ShortOpt": "L", "Hide": 0, "Required": false, "IsPassword": false, - "NoPrefix": false, + "NoPrefix": true, "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "https://api.hidrive.strato.com/2.1", - "ValueStr": "https://api.hidrive.strato.com/2.1", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "disable_fetching_member_count", - "Help": "Do not fetch number of objects in directories unless it is absolutely necessary.\n\nRequests may be faster if the number of objects in subdirectories is not fetched.", - "Provider": "", + "Name": "links", + "FieldName": "", + "Help": "Translate symlinks to/from regular files with a '.rclonelink' extension.", "Default": false, "Value": null, - "ShortOpt": "", + "ShortOpt": "l", "Hide": 0, "Required": false, "IsPassword": false, - "NoPrefix": false, + "NoPrefix": true, "Advanced": true, "Exclusive": false, "Sensitive": false, @@ -5663,30 +7761,28 @@ "Type": "bool" }, { - "Name": "chunk_size", - "Help": "Chunksize for chunked uploads.\n\nAny files larger than the configured cutoff (or files of unknown size) will be uploaded in chunks of this size.\n\nThe upper limit for this is 2147483647 bytes (about 2.000Gi).\nThat is the maximum amount of bytes a single upload-operation will support.\nSetting this above the upper limit or to a negative value will cause uploads to fail.\n\nSetting this to larger values may increase the upload speed at the cost of using more memory.\nIt can be set to smaller values smaller to save on memory.", - "Provider": "", - "Default": 50331648, + "Name": "skip_links", + "FieldName": "", + "Help": "Don't warn about skipped symlinks.\n\nThis flag disables warning messages on skipped symlinks or junction\npoints, as you explicitly acknowledge that they should be skipped.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, - "NoPrefix": false, + "NoPrefix": true, "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "48Mi", - "ValueStr": "48Mi", - "Type": "SizeSuffix" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "upload_cutoff", - "Help": "Cutoff/Threshold for chunked uploads.\n\nAny files larger than this will be uploaded in chunks of the configured chunksize.\n\nThe upper limit for this is 2147483647 bytes (about 2.000Gi).\nThat is the maximum amount of bytes a single upload-operation will support.\nSetting this above the upper limit will cause uploads to fail.", - "Provider": "", - "Default": 100663296, + "Name": "zero_size_links", + "FieldName": "", + "Help": "Assume the Stat size of links is zero (and read them instead) (deprecated).\n\nRclone used to use the Stat size of links as the link size, but this fails in quite a few places:\n\n- Windows\n- On some virtual filesystems (such ash LucidLink)\n- Android\n\nSo rclone now always reads the link.\n", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5694,17 +7790,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "96Mi", - "ValueStr": "96Mi", - "Type": "SizeSuffix" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "upload_concurrency", - "Help": "Concurrency for chunked uploads.\n\nThis is the upper limit for how many transfers for the same file are running concurrently.\nSetting this above to a value smaller than 1 will cause uploads to deadlock.\n\nIf you are uploading small numbers of large files over high-speed links\nand these uploads do not fully utilize your bandwidth, then increasing\nthis may help to speed up the transfers.", - "Provider": "", - "Default": 4, + "Name": "unicode_normalization", + "FieldName": "", + "Help": "Apply unicode NFC normalization to paths and filenames.\n\nThis flag can be used to normalize file names into unicode NFC form\nthat are read from the local filesystem.\n\nRclone does not normally touch the encoding of file names it reads from\nthe file system.\n\nThis can be useful when using macOS as it normally provides decomposed (NFD)\nunicode which in some language (eg Korean) doesn't display properly on\nsome OSes.\n\nNote that rclone compares filenames with unicode normalization in the sync\nroutine so this flag shouldn't normally be used.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5712,17 +7807,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "4", - "ValueStr": "4", - "Type": "int" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 33554434, + "Name": "no_check_updated", + "FieldName": "", + "Help": "Don't check to see if the files change during upload.\n\nNormally rclone checks the size and modification time of files as they\nare being uploaded and aborts with a message which starts \"can't copy -\nsource file is being updated\" if the file changes during upload.\n\nHowever on some file systems this modification time check may fail (e.g.\n[Glusterfs #2206](https://github.com/rclone/rclone/issues/2206)) so this\ncheck can be disabled with this flag.\n\nIf this flag is set, rclone will use its best efforts to transfer a\nfile which is being updated. If the file is only having things\nappended to it (e.g. a log) then rclone will transfer the log file with\nthe size it had the first time rclone saw it.\n\nIf the file is being modified throughout (not just appended to) then\nthe transfer may fail with a hash check failure.\n\nIn detail, once the file has had stat() called on it for the first\ntime we:\n\n- Only transfer the size that stat gave\n- Only checksum the size that stat gave\n- Don't update the stat info for the file\n\n**NB** do not use this flag on a Windows Volume Shadow (VSS). For some\nunknown reason, files in a VSS sometimes show different sizes from the\ndirectory listing (where the initial stat value comes from on Windows)\nand when stat is called on them directly. Other copy tools always use\nthe direct stat value and setting this flag will disable that.\n", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5730,64 +7824,34 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,Dot", - "ValueStr": "Slash,Dot", - "Type": "MultiEncoder" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "http", - "Description": "HTTP", - "Prefix": "http", - "Options": [ - { - "Name": "url", - "Help": "URL of HTTP host to connect to.\n\nE.g. \"https://example.com\", or \"https://user:pass@example.com\" to use a username and password.", - "Provider": "", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": true, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "headers", - "Help": "Set HTTP headers for all transactions.\n\nUse this to set additional HTTP headers for all transactions.\n\nThe input format is comma separated list of key,value pairs. Standard\n[CSV encoding](https://godoc.org/encoding/csv) may be used.\n\nFor example, to set a Cookie use 'Cookie,name=value', or '\"Cookie\",\"name=value\"'.\n\nYou can set multiple headers, e.g. '\"Cookie\",\"name=value\",\"Authorization\",\"xxx\"'.", - "Provider": "", - "Default": [], + "Name": "one_file_system", + "FieldName": "", + "Help": "Don't cross filesystem boundaries (unix/macOS only).", + "Default": false, "Value": null, - "ShortOpt": "", + "ShortOpt": "x", "Hide": 0, "Required": false, "IsPassword": false, - "NoPrefix": false, + "NoPrefix": true, "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "CommaSepList" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "no_slash", - "Help": "Set this if the site doesn't end directories with /.\n\nUse this if your target website does not use / on the end of\ndirectories.\n\nA / on the end of a path is how rclone normally tells the difference\nbetween files and directories. If this flag is set, then rclone will\ntreat all files with Content-Type: text/html as directories and read\nURLs from them rather than downloading them.\n\nNote that this may cause rclone to confuse genuine HTML files with\ndirectories.", - "Provider": "", + "Name": "case_sensitive", + "FieldName": "", + "Help": "Force the filesystem to report itself as case sensitive.\n\nNormally the local backend declares itself as case insensitive on\nWindows/macOS and case sensitive for everything else. Use this flag\nto override the default choice.", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5800,12 +7864,11 @@ "Type": "bool" }, { - "Name": "no_head", - "Help": "Don't use HEAD requests.\n\nHEAD requests are mainly used to find file sizes in dir listing.\nIf your site is being very slow to load then you can try this option.\nNormally rclone does a HEAD request for each potential file in a\ndirectory listing to:\n\n- find its size\n- check it really exists\n- check to see if it is a directory\n\nIf you set this option, rclone will not do the HEAD request. This will mean\nthat directory listings are much quicker, but rclone won't have the times or\nsizes of any files, and some files that don't exist may be in the listing.", - "Provider": "", + "Name": "case_insensitive", + "FieldName": "", + "Help": "Force the filesystem to report itself as case insensitive.\n\nNormally the local backend declares itself as case insensitive on\nWindows/macOS and case sensitive for everything else. Use this flag\nto override the default choice.", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5816,61 +7879,47 @@ "DefaultStr": "false", "ValueStr": "false", "Type": "bool" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "internetarchive", - "Description": "Internet Archive", - "Prefix": "internetarchive", - "Options": [ + }, { - "Name": "access_key_id", - "Help": "IAS3 Access Key.\n\nLeave blank for anonymous access.\nYou can find one here: https://archive.org/account/s3.php", - "Provider": "", - "Default": "", + "Name": "no_clone", + "FieldName": "", + "Help": "Disable reflink cloning for server-side copies.\n\nNormally, for local-to-local transfers, rclone will \"clone\" the file when\npossible, and fall back to \"copying\" only when cloning is not supported.\n\nCloning creates a shallow copy (or \"reflink\") which initially shares blocks with\nthe original file. Unlike a \"hardlink\", the two files are independent and\nneither will affect the other if subsequently modified.\n\nCloning is usually preferable to copying, as it is much faster and is\ndeduplicated by default (i.e. having two identical files does not consume more\nstorage than having just one.) However, for use cases where data redundancy is\npreferable, --local-no-clone can be used to disable cloning and force \"deep\" copies.\n\nCurrently, cloning is only supported when using APFS on macOS (support for other\nplatforms may be added in the future.)", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "secret_access_key", - "Help": "IAS3 Secret Key (password).\n\nLeave blank for anonymous access.", - "Provider": "", - "Default": "", + "Name": "no_preallocate", + "FieldName": "", + "Help": "Disable preallocation of disk space for transferred files.\n\nPreallocation of disk space helps prevent filesystem fragmentation.\nHowever, some virtual filesystem layers (such as Google Drive File\nStream) may incorrectly set the actual file size equal to the\npreallocated space, causing checksum and file size checks to fail.\nUse this flag to disable preallocation.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "endpoint", - "Help": "IAS3 Endpoint.\n\nLeave blank for default value.", - "Provider": "", - "Default": "https://s3.us.archive.org", + "Name": "no_sparse", + "FieldName": "", + "Help": "Disable sparse files for multi-thread downloads.\n\nOn Windows platforms rclone will make sparse files when doing\nmulti-thread downloads. This avoids long pauses on large files where\nthe OS zeros the file. However sparse files may be undesirable as they\ncause disk fragmentation and can be slow to work with.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5878,17 +7927,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "https://s3.us.archive.org", - "ValueStr": "https://s3.us.archive.org", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "front_endpoint", - "Help": "Host of InternetArchive Frontend.\n\nLeave blank for default value.", - "Provider": "", - "Default": "https://archive.org", + "Name": "no_set_modtime", + "FieldName": "", + "Help": "Disable setting modtime.\n\nNormally rclone updates modification time of files after they are done\nuploading. This can cause permissions issues on Linux platforms when \nthe user rclone is running as does not own the file uploaded, such as\nwhen copying to a CIFS mount owned by another user. If this option is \nenabled, rclone will no longer update the modtime after copying a file.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5896,17 +7944,34 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "https://archive.org", - "ValueStr": "https://archive.org", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "disable_checksum", - "Help": "Don't ask the server to test against MD5 checksum calculated by rclone.\nNormally rclone will calculate the MD5 checksum of the input before\nuploading it so it can ask the server to check the object against checksum.\nThis is great for data integrity checking but can cause long delays for\nlarge files to start uploading.", - "Provider": "", - "Default": true, + "Name": "time_type", + "FieldName": "", + "Help": "Set what kind of time is returned.\n\nNormally rclone does all operations on the mtime or Modification time.\n\nIf you set this flag then rclone will return the Modified time as whatever\nyou set here. So if you use \"rclone lsl --local-time-type ctime\" then\nyou will see ctimes in the listing.\n\nIf the OS doesn't support returning the time_type specified then rclone\nwill silently replace it with the modification time which all OSes support.\n\n- mtime is supported by all OSes\n- atime is supported on all OSes except: plan9, js\n- btime is only supported on: Windows, macOS, freebsd, netbsd\n- ctime is supported on all Oses except: Windows, plan9, js\n\nNote that setting the time will still set the modified time so this is\nonly useful for reading.\n", + "Default": 0, "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "mtime", + "Help": "The last modification time." + }, + { + "Value": "atime", + "Help": "The last access time." + }, + { + "Value": "btime", + "Help": "The creation time." + }, + { + "Value": "ctime", + "Help": "The last status change time." + } + ], "Hide": 0, "Required": false, "IsPassword": false, @@ -5914,17 +7979,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "true", - "ValueStr": "true", - "Type": "bool" + "DefaultStr": "mtime", + "ValueStr": "mtime", + "Type": "mtime|atime|btime|ctime" }, { - "Name": "wait_archive", - "Help": "Timeout for waiting the server's processing tasks (specifically archive and book_op) to finish.\nOnly enable if you need to be guaranteed to be reflected after write operations.\n0 to disable waiting. No errors to be thrown in case of timeout.", - "Provider": "", - "Default": 0, + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 33554434, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5932,17 +7996,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "0s", - "ValueStr": "0s", - "Type": "Duration" + "DefaultStr": "Slash,Dot", + "ValueStr": "Slash,Dot", + "Type": "Encoding" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 50446342, + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -5950,116 +8013,83 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,LtGt,CrLf,Del,Ctl,InvalidUtf8,Dot", - "ValueStr": "Slash,LtGt,CrLf,Del,Ctl,InvalidUtf8,Dot", - "Type": "MultiEncoder" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": [ + { + "Name": "noop", + "Short": "A null operation for testing backend commands", + "Long": "This is a test command which has some options\nyou can try to change the output.", + "Opts": { + "echo": "echo the input arguments", + "error": "return an error based on option value" + } } ], - "CommandHelp": null, "Aliases": null, "Hide": false, "MetadataInfo": { - "System": { - "crc32": { - "Help": "CRC32 calculated by Internet Archive", - "Type": "string", - "Example": "01234567", - "ReadOnly": true - }, - "format": { - "Help": "Name of format identified by Internet Archive", - "Type": "string", - "Example": "Comma-Separated Values", - "ReadOnly": true - }, - "md5": { - "Help": "MD5 hash calculated by Internet Archive", - "Type": "string", - "Example": "01234567012345670123456701234567", - "ReadOnly": true - }, - "mtime": { - "Help": "Time of last modification, managed by Rclone", - "Type": "RFC 3339", - "Example": "2006-01-02T15:04:05.999999999Z", - "ReadOnly": true - }, - "name": { - "Help": "Full file path, without the bucket part", - "Type": "filename", - "Example": "backend/internetarchive/internetarchive.go", - "ReadOnly": true - }, - "old_version": { - "Help": "Whether the file was replaced and moved by keep-old-version flag", - "Type": "boolean", - "Example": "true", - "ReadOnly": true - }, - "rclone-ia-mtime": { - "Help": "Time of last modification, managed by Internet Archive", + "System": { + "atime": { + "Help": "Time of last access", "Type": "RFC 3339", - "Example": "2006-01-02T15:04:05.999999999Z", + "Example": "2006-01-02T15:04:05.999999999Z07:00", "ReadOnly": false }, - "rclone-mtime": { - "Help": "Time of last modification, managed by Rclone", + "btime": { + "Help": "Time of file birth (creation)", "Type": "RFC 3339", - "Example": "2006-01-02T15:04:05.999999999Z", + "Example": "2006-01-02T15:04:05.999999999Z07:00", "ReadOnly": false }, - "rclone-update-track": { - "Help": "Random value used by Rclone for tracking changes inside Internet Archive", - "Type": "string", - "Example": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", + "gid": { + "Help": "Group ID of owner", + "Type": "decimal number", + "Example": "500", "ReadOnly": false }, - "sha1": { - "Help": "SHA1 hash calculated by Internet Archive", - "Type": "string", - "Example": "0123456701234567012345670123456701234567", - "ReadOnly": true - }, - "size": { - "Help": "File size in bytes", - "Type": "decimal number", - "Example": "123456", - "ReadOnly": true + "mode": { + "Help": "File type and mode", + "Type": "octal, unix style", + "Example": "0100664", + "ReadOnly": false }, - "source": { - "Help": "The source of the file", - "Type": "string", - "Example": "original", - "ReadOnly": true + "mtime": { + "Help": "Time of last modification", + "Type": "RFC 3339", + "Example": "2006-01-02T15:04:05.999999999Z07:00", + "ReadOnly": false }, - "summation": { - "Help": "Check https://forum.rclone.org/t/31922 for how it is used", - "Type": "string", - "Example": "md5", - "ReadOnly": true + "rdev": { + "Help": "Device ID (if special file)", + "Type": "hexadecimal", + "Example": "1abc", + "ReadOnly": false }, - "viruscheck": { - "Help": "The last time viruscheck process was run for the file (?)", - "Type": "unixtime", - "Example": "1654191352", - "ReadOnly": true + "uid": { + "Help": "User ID of owner", + "Type": "decimal number", + "Example": "500", + "ReadOnly": false } }, - "Help": "Metadata fields provided by Internet Archive.\nIf there are multiple values for a key, only the first one is returned.\nThis is a limitation of Rclone, that supports one value per one key.\n\nOwner is able to add custom keys. Metadata feature grabs all the keys including them.\n" + "Help": "Depending on which OS is in use the local backend may return only some\nof the system metadata. Setting system metadata is supported on all\nOSes but setting user metadata is only supported on linux, freebsd,\nnetbsd, macOS and Solaris. It is **not** supported on Windows yet\n([see pkg/attrs#47](https://github.com/pkg/xattr/issues/47)).\n\nUser metadata is stored as extended attributes (which may not be\nsupported by all file systems) under the \"user.*\" prefix.\n\nMetadata is supported on files and directories.\n" } }, { - "Name": "jottacloud", - "Description": "Jottacloud", - "Prefix": "jottacloud", + "Name": "mailru", + "Description": "Mail.ru Cloud", + "Prefix": "mailru", "Options": [ { "Name": "client_id", + "FieldName": "", "Help": "OAuth Client Id.\n\nLeave blank normally.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -6073,11 +8103,10 @@ }, { "Name": "client_secret", + "FieldName": "", "Help": "OAuth Client Secret.\n\nLeave blank normally.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -6091,11 +8120,10 @@ }, { "Name": "token", + "FieldName": "", "Help": "OAuth Access Token as a JSON blob.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -6109,11 +8137,10 @@ }, { "Name": "auth_url", + "FieldName": "", "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -6127,11 +8154,10 @@ }, { "Name": "token_url", + "FieldName": "", "Help": "Token server url.\n\nLeave blank to use the provider defaults.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -6144,66 +8170,90 @@ "Type": "string" }, { - "Name": "md5_memory_limit", - "Help": "Files bigger than this will be cached on disk to calculate the MD5 if required.", - "Provider": "", - "Default": 10485760, + "Name": "user", + "FieldName": "", + "Help": "User name (usually email).", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, + "Required": true, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "10Mi", - "ValueStr": "10Mi", - "Type": "SizeSuffix" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "trashed_only", - "Help": "Only show files that are in the trash.\n\nThis will show trashed files in their original directory structure.", - "Provider": "", - "Default": false, + "Name": "pass", + "FieldName": "", + "Help": "Password.\n\nThis must be an app password - rclone will not work with your normal\npassword. See the Configuration section in the docs for how to make an\napp password.\n", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, - "IsPassword": false, + "Required": true, + "IsPassword": true, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "hard_delete", - "Help": "Delete files permanently rather than putting them into the trash.", - "Provider": "", - "Default": false, + "Name": "speedup_enable", + "FieldName": "", + "Help": "Skip full upload if there is another file with same data hash.\n\nThis feature is called \"speedup\" or \"put by hash\". It is especially efficient\nin case of generally available files like popular books, video or audio clips,\nbecause files are searched by hash in all accounts of all mailru users.\nIt is meaningless and ineffective if source file is unique or encrypted.\nPlease note that rclone may need local memory and disk space to calculate\ncontent hash in advance and decide whether full upload is required.\nAlso, if rclone does not know file size in advance (e.g. in case of\nstreaming or partial uploads), it will not even try this optimization.", + "Default": true, "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "true", + "Help": "Enable" + }, + { + "Value": "false", + "Help": "Disable" + } + ], "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", + "DefaultStr": "true", + "ValueStr": "true", "Type": "bool" }, { - "Name": "upload_resume_limit", - "Help": "Files bigger than this can be resumed if the upload fail's.", - "Provider": "", - "Default": 10485760, + "Name": "speedup_file_patterns", + "FieldName": "", + "Help": "Comma separated list of file name patterns eligible for speedup (put by hash).\n\nPatterns are case insensitive and can contain '*' or '?' meta characters.", + "Default": "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf", "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "", + "Help": "Empty list completely disables speedup (put by hash)." + }, + { + "Value": "*", + "Help": "All files will be attempted for speedup." + }, + { + "Value": "*.mkv,*.avi,*.mp4,*.mp3", + "Help": "Only common audio/video files will be tried for put by hash." + }, + { + "Value": "*.zip,*.gz,*.rar,*.pdf", + "Help": "Only common archives or PDF books will be tried for speedup." + } + ], "Hide": 0, "Required": false, "IsPassword": false, @@ -6211,17 +8261,30 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "10Mi", - "ValueStr": "10Mi", - "Type": "SizeSuffix" + "DefaultStr": "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf", + "ValueStr": "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf", + "Type": "string" }, { - "Name": "no_versions", - "Help": "Avoid server side versioning by deleting files and recreating files instead of overwriting them.", - "Provider": "", - "Default": false, + "Name": "speedup_max_disk", + "FieldName": "", + "Help": "This option allows you to disable speedup (put by hash) for large files.\n\nReason is that preliminary hashing can exhaust your RAM or disk space.", + "Default": 3221225472, "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "0", + "Help": "Completely disable speedup (put by hash)." + }, + { + "Value": "1G", + "Help": "Files larger than 1Gb will be uploaded directly." + }, + { + "Value": "3G", + "Help": "Choose this option if you have less than 3Gb free on local disk." + } + ], "Hide": 0, "Required": false, "IsPassword": false, @@ -6229,99 +8292,30 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "3Gi", + "ValueStr": "3Gi", + "Type": "SizeSuffix" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 50431886, - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot", - "ValueStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Del,Ctl,InvalidUtf8,Dot", - "Type": "MultiEncoder" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "koofr", - "Description": "Koofr, Digi Storage and other Koofr-compatible storage providers", - "Prefix": "koofr", - "Options": [ - { - "Name": "provider", - "Help": "Choose your storage provider.", - "Provider": "", - "Default": "", + "Name": "speedup_max_memory", + "FieldName": "", + "Help": "Files larger than the size given below will always be hashed on disk.", + "Default": 33554432, "Value": null, "Examples": [ { - "Value": "koofr", - "Help": "Koofr, https://app.koofr.net/", - "Provider": "" + "Value": "0", + "Help": "Preliminary hashing will always be done in a temporary disk location." }, { - "Value": "digistorage", - "Help": "Digi Storage, https://storage.rcs-rds.ro/", - "Provider": "" + "Value": "32M", + "Help": "Do not dedicate more than 32Mb RAM for preliminary hashing." }, { - "Value": "other", - "Help": "Any other Koofr API compatible storage service", - "Provider": "" + "Value": "256M", + "Help": "You have at most 256Mb RAM free for hash calculations." } ], - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" - }, - { - "Name": "endpoint", - "Help": "The Koofr API endpoint to use.", - "Provider": "other", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": true, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" - }, - { - "Name": "mountid", - "Help": "Mount ID of the mount to use.\n\nIf omitted, the primary mount is used.", - "Provider": "", - "Default": "", - "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -6329,17 +8323,26 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "32Mi", + "ValueStr": "32Mi", + "Type": "SizeSuffix" }, { - "Name": "setmtime", - "Help": "Does the backend support setting modification time.\n\nSet this to false if you use a mount ID that points to a Dropbox or Amazon Drive backend.", - "Provider": "", + "Name": "check_hash", + "FieldName": "", + "Help": "What should copy do if file checksum is mismatched or invalid.", "Default": true, "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "true", + "Help": "Fail with error." + }, + { + "Value": "false", + "Help": "Ignore and continue." + } + ], "Hide": 0, "Required": false, "IsPassword": false, @@ -6352,35 +8355,16 @@ "Type": "bool" }, { - "Name": "user", - "Help": "Your user name.", - "Provider": "", + "Name": "user_agent", + "FieldName": "", + "Help": "HTTP user agent used internally by client.\n\nDefaults to \"rclone/VERSION\" or \"--user-agent\" provided on command line.", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": true, + "Hide": 3, + "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" - }, - { - "Name": "password", - "Help": "Your password for rclone (generate one at https://app.koofr.net/app/admin/preferences/password).", - "Provider": "koofr", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": true, - "IsPassword": true, - "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, "DefaultStr": "", @@ -6388,17 +8372,16 @@ "Type": "string" }, { - "Name": "password", - "Help": "Your password for rclone (generate one at https://storage.rcs-rds.ro/app/admin/preferences/password).", - "Provider": "digistorage", + "Name": "quirks", + "FieldName": "", + "Help": "Comma separated list of internal maintenance flags.\n\nThis option must not be used by an ordinary user. It is intended only to\nfacilitate remote troubleshooting of backend issues. Strict meaning of\nflags is not documented and not guaranteed to persist between releases.\nQuirks will be removed when the backend grows stable.\nSupported quirks: atomicmkdir binlist unknowndirs", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": true, - "IsPassword": true, + "Hide": 3, + "Required": false, + "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, "DefaultStr": "", @@ -6406,30 +8389,28 @@ "Type": "string" }, { - "Name": "password", - "Help": "Your password for rclone (generate one at your service's settings page).", - "Provider": "other", - "Default": "", + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 50440078, "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": true, - "IsPassword": true, + "Required": false, + "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot", + "ValueStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot", + "Type": "Encoding" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 50438146, + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -6437,9 +8418,9 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot", - "ValueStr": "Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot", - "Type": "MultiEncoder" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], "CommandHelp": null, @@ -6448,82 +8429,54 @@ "MetadataInfo": null }, { - "Name": "local", - "Description": "Local Disk", - "Prefix": "local", + "Name": "mega", + "Description": "Mega", + "Prefix": "mega", "Options": [ { - "Name": "nounc", - "Help": "Disable UNC (long path names) conversion on Windows.", - "Provider": "", - "Default": false, + "Name": "user", + "FieldName": "", + "Help": "User name.", + "Default": "", "Value": null, - "Examples": [ - { - "Value": "true", - "Help": "Disables long file names.", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, - "Required": false, + "Required": true, "IsPassword": false, "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" - }, - { - "Name": "copy_links", - "Help": "Follow symlinks and copy the pointed to item.", - "Provider": "", - "Default": false, - "Value": null, - "ShortOpt": "L", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": true, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "links", - "Help": "Translate symlinks to/from regular files with a '.rclonelink' extension.", - "Provider": "", - "Default": false, + "Name": "pass", + "FieldName": "", + "Help": "Password.", + "Default": "", "Value": null, - "ShortOpt": "l", "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": true, - "Advanced": true, + "Required": true, + "IsPassword": true, + "NoPrefix": false, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "skip_links", - "Help": "Don't warn about skipped symlinks.\n\nThis flag disables warning messages on skipped symlinks or junction\npoints, as you explicitly acknowledge that they should be skipped.", - "Provider": "", + "Name": "debug", + "FieldName": "", + "Help": "Output more debug from Mega.\n\nIf this flag is set (along with -vv) it will print further debugging\ninformation from the mega backend.", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, - "NoPrefix": true, + "NoPrefix": false, "Advanced": true, "Exclusive": false, "Sensitive": false, @@ -6532,12 +8485,11 @@ "Type": "bool" }, { - "Name": "zero_size_links", - "Help": "Assume the Stat size of links is zero (and read them instead) (deprecated).\n\nRclone used to use the Stat size of links as the link size, but this fails in quite a few places:\n\n- Windows\n- On some virtual filesystems (such ash LucidLink)\n- Android\n\nSo rclone now always reads the link.\n", - "Provider": "", + "Name": "hard_delete", + "FieldName": "", + "Help": "Delete files permanently rather than putting them into the trash.\n\nNormally the mega backend will put all deletions into the trash rather\nthan permanently deleting them. If you specify this then rclone will\npermanently delete objects instead.", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -6550,12 +8502,11 @@ "Type": "bool" }, { - "Name": "unicode_normalization", - "Help": "Apply unicode NFC normalization to paths and filenames.\n\nThis flag can be used to normalize file names into unicode NFC form\nthat are read from the local filesystem.\n\nRclone does not normally touch the encoding of file names it reads from\nthe file system.\n\nThis can be useful when using macOS as it normally provides decomposed (NFD)\nunicode which in some language (eg Korean) doesn't display properly on\nsome OSes.\n\nNote that rclone compares filenames with unicode normalization in the sync\nroutine so this flag shouldn't normally be used.", - "Provider": "", + "Name": "use_https", + "FieldName": "", + "Help": "Use HTTPS for transfers.\n\nMEGA uses plain text HTTP connections by default.\nSome ISPs throttle HTTP connections, this causes transfers to become very slow.\nEnabling this will force MEGA to use HTTPS for all transfers.\nHTTPS is normally not necessary since all data is already encrypted anyway.\nEnabling it will increase CPU usage and add network overhead.", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -6568,12 +8519,11 @@ "Type": "bool" }, { - "Name": "no_check_updated", - "Help": "Don't check to see if the files change during upload.\n\nNormally rclone checks the size and modification time of files as they\nare being uploaded and aborts with a message which starts \"can't copy -\nsource file is being updated\" if the file changes during upload.\n\nHowever on some file systems this modification time check may fail (e.g.\n[Glusterfs #2206](https://github.com/rclone/rclone/issues/2206)) so this\ncheck can be disabled with this flag.\n\nIf this flag is set, rclone will use its best efforts to transfer a\nfile which is being updated. If the file is only having things\nappended to it (e.g. a log) then rclone will transfer the log file with\nthe size it had the first time rclone saw it.\n\nIf the file is being modified throughout (not just appended to) then\nthe transfer may fail with a hash check failure.\n\nIn detail, once the file has had stat() called on it for the first\ntime we:\n\n- Only transfer the size that stat gave\n- Only checksum the size that stat gave\n- Don't update the stat info for the file\n\n", - "Provider": "", - "Default": false, + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 50331650, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -6581,35 +8531,44 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "Slash,InvalidUtf8,Dot", + "ValueStr": "Slash,InvalidUtf8,Dot", + "Type": "Encoding" }, { - "Name": "one_file_system", - "Help": "Don't cross filesystem boundaries (unix/macOS only).", - "Provider": "", - "Default": false, + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", "Value": null, - "ShortOpt": "x", "Hide": 0, "Required": false, "IsPassword": false, - "NoPrefix": true, + "NoPrefix": false, "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" - }, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "memory", + "Description": "In memory object storage system.", + "Prefix": "memory", + "Options": [ { - "Name": "case_sensitive", - "Help": "Force the filesystem to report itself as case sensitive.\n\nNormally the local backend declares itself as case insensitive on\nWindows/macOS and case sensitive for everything else. Use this flag\nto override the default choice.", - "Provider": "", - "Default": false, + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -6617,17 +8576,37 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" - }, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "netstorage", + "Description": "Akamai NetStorage", + "Prefix": "netstorage", + "Options": [ { - "Name": "case_insensitive", - "Help": "Force the filesystem to report itself as case insensitive.\n\nNormally the local backend declares itself as case insensitive on\nWindows/macOS and case sensitive for everything else. Use this flag\nto override the default choice.", - "Provider": "", - "Default": false, + "Name": "protocol", + "FieldName": "", + "Help": "Select between HTTP or HTTPS protocol.\n\nMost users should choose HTTPS, which is the default.\nHTTP is provided primarily for debugging purposes.", + "Default": "https", "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "http", + "Help": "HTTP protocol" + }, + { + "Value": "https", + "Help": "HTTPS protocol" + } + ], "Hide": 0, "Required": false, "IsPassword": false, @@ -6635,71 +8614,67 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "https", + "ValueStr": "https", + "Type": "string" }, { - "Name": "no_preallocate", - "Help": "Disable preallocation of disk space for transferred files.\n\nPreallocation of disk space helps prevent filesystem fragmentation.\nHowever, some virtual filesystem layers (such as Google Drive File\nStream) may incorrectly set the actual file size equal to the\npreallocated space, causing checksum and file size checks to fail.\nUse this flag to disable preallocation.", - "Provider": "", - "Default": false, + "Name": "host", + "FieldName": "", + "Help": "Domain+path of NetStorage host to connect to.\n\nFormat should be `/`", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, + "Required": true, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, - { - "Name": "no_sparse", - "Help": "Disable sparse files for multi-thread downloads.\n\nOn Windows platforms rclone will make sparse files when doing\nmulti-thread downloads. This avoids long pauses on large files where\nthe OS zeros the file. However sparse files may be undesirable as they\ncause disk fragmentation and can be slow to work with.", - "Provider": "", - "Default": false, + { + "Name": "account", + "FieldName": "", + "Help": "Set the NetStorage account name", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, + "Required": true, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "no_set_modtime", - "Help": "Disable setting modtime.\n\nNormally rclone updates modification time of files after they are done\nuploading. This can cause permissions issues on Linux platforms when \nthe user rclone is running as does not own the file uploaded, such as\nwhen copying to a CIFS mount owned by another user. If this option is \nenabled, rclone will no longer update the modtime after copying a file.", - "Provider": "", - "Default": false, + "Name": "secret", + "FieldName": "", + "Help": "Set the NetStorage account secret/G2O key for authentication.\n\nPlease choose the 'y' option to set your own password then enter your secret.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, - "IsPassword": false, + "Required": true, + "IsPassword": true, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 33554434, + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -6707,84 +8682,40 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,Dot", - "ValueStr": "Slash,Dot", - "Type": "MultiEncoder" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], "CommandHelp": [ { - "Name": "noop", - "Short": "A null operation for testing backend commands", - "Long": "This is a test command which has some options\nyou can try to change the output.", - "Opts": { - "echo": "echo the input arguments", - "error": "return an error based on option value" - } + "Name": "du", + "Short": "Return disk usage information for a specified directory", + "Long": "The usage information returned, includes the targeted directory as well as all\nfiles stored in any sub-directories that may exist.", + "Opts": null + }, + { + "Name": "symlink", + "Short": "You can create a symbolic link in ObjectStore with the symlink action.", + "Long": "The desired path location (including applicable sub-directories) ending in\nthe object that will be the target of the symlink (for example, /links/mylink).\nInclude the file extension for the object, if applicable.\n`rclone backend symlink `", + "Opts": null } ], "Aliases": null, "Hide": false, - "MetadataInfo": { - "System": { - "atime": { - "Help": "Time of last access", - "Type": "RFC 3339", - "Example": "2006-01-02T15:04:05.999999999Z07:00", - "ReadOnly": false - }, - "btime": { - "Help": "Time of file birth (creation)", - "Type": "RFC 3339", - "Example": "2006-01-02T15:04:05.999999999Z07:00", - "ReadOnly": false - }, - "gid": { - "Help": "Group ID of owner", - "Type": "decimal number", - "Example": "500", - "ReadOnly": false - }, - "mode": { - "Help": "File type and mode", - "Type": "octal, unix style", - "Example": "0100664", - "ReadOnly": false - }, - "mtime": { - "Help": "Time of last modification", - "Type": "RFC 3339", - "Example": "2006-01-02T15:04:05.999999999Z07:00", - "ReadOnly": false - }, - "rdev": { - "Help": "Device ID (if special file)", - "Type": "hexadecimal", - "Example": "1abc", - "ReadOnly": false - }, - "uid": { - "Help": "User ID of owner", - "Type": "decimal number", - "Example": "500", - "ReadOnly": false - } - }, - "Help": "Depending on which OS is in use the local backend may return only some\nof the system metadata. Setting system metadata is supported on all\nOSes but setting user metadata is only supported on linux, freebsd,\nnetbsd, macOS and Solaris. It is **not** supported on Windows yet\n([see pkg/attrs#47](https://github.com/pkg/xattr/issues/47)).\n\nUser metadata is stored as extended attributes (which may not be\nsupported by all file systems) under the \"user.*\" prefix.\n" - } + "MetadataInfo": null }, { - "Name": "mailru", - "Description": "Mail.ru Cloud", - "Prefix": "mailru", + "Name": "onedrive", + "Description": "Microsoft OneDrive", + "Prefix": "onedrive", "Options": [ { "Name": "client_id", + "FieldName": "", "Help": "OAuth Client Id.\n\nLeave blank normally.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -6798,11 +8729,10 @@ }, { "Name": "client_secret", + "FieldName": "", "Help": "OAuth Client Secret.\n\nLeave blank normally.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -6816,11 +8746,10 @@ }, { "Name": "token", + "FieldName": "", "Help": "OAuth Access Token as a JSON blob.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -6834,11 +8763,10 @@ }, { "Name": "auth_url", + "FieldName": "", "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -6852,11 +8780,10 @@ }, { "Name": "token_url", + "FieldName": "", "Help": "Token server url.\n\nLeave blank to use the provider defaults.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -6869,170 +8796,46 @@ "Type": "string" }, { - "Name": "user", - "Help": "User name (usually email).", - "Provider": "", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": true, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" - }, - { - "Name": "pass", - "Help": "Password.\n\nThis must be an app password - rclone will not work with your normal\npassword. See the Configuration section in the docs for how to make an\napp password.\n", - "Provider": "", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": true, - "IsPassword": true, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" - }, - { - "Name": "speedup_enable", - "Help": "Skip full upload if there is another file with same data hash.\n\nThis feature is called \"speedup\" or \"put by hash\". It is especially efficient\nin case of generally available files like popular books, video or audio clips,\nbecause files are searched by hash in all accounts of all mailru users.\nIt is meaningless and ineffective if source file is unique or encrypted.\nPlease note that rclone may need local memory and disk space to calculate\ncontent hash in advance and decide whether full upload is required.\nAlso, if rclone does not know file size in advance (e.g. in case of\nstreaming or partial uploads), it will not even try this optimization.", - "Provider": "", - "Default": true, - "Value": null, - "Examples": [ - { - "Value": "true", - "Help": "Enable", - "Provider": "" - }, - { - "Value": "false", - "Help": "Disable", - "Provider": "" - } - ], - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "true", - "ValueStr": "true", - "Type": "bool" - }, - { - "Name": "speedup_file_patterns", - "Help": "Comma separated list of file name patterns eligible for speedup (put by hash).\n\nPatterns are case insensitive and can contain '*' or '?' meta characters.", - "Provider": "", - "Default": "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf", + "Name": "region", + "FieldName": "", + "Help": "Choose national cloud region for OneDrive.", + "Default": "global", "Value": null, "Examples": [ { - "Value": "", - "Help": "Empty list completely disables speedup (put by hash).", - "Provider": "" + "Value": "global", + "Help": "Microsoft Cloud Global" }, { - "Value": "*", - "Help": "All files will be attempted for speedup.", - "Provider": "" + "Value": "us", + "Help": "Microsoft Cloud for US Government" }, { - "Value": "*.mkv,*.avi,*.mp4,*.mp3", - "Help": "Only common audio/video files will be tried for put by hash.", - "Provider": "" + "Value": "de", + "Help": "Microsoft Cloud Germany" }, { - "Value": "*.zip,*.gz,*.rar,*.pdf", - "Help": "Only common archives or PDF books will be tried for speedup.", - "Provider": "" + "Value": "cn", + "Help": "Azure and Office 365 operated by Vnet Group in China" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf", - "ValueStr": "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf", + "DefaultStr": "global", + "ValueStr": "global", "Type": "string" }, { - "Name": "speedup_max_disk", - "Help": "This option allows you to disable speedup (put by hash) for large files.\n\nReason is that preliminary hashing can exhaust your RAM or disk space.", - "Provider": "", - "Default": 3221225472, - "Value": null, - "Examples": [ - { - "Value": "0", - "Help": "Completely disable speedup (put by hash).", - "Provider": "" - }, - { - "Value": "1G", - "Help": "Files larger than 1Gb will be uploaded directly.", - "Provider": "" - }, - { - "Value": "3G", - "Help": "Choose this option if you have less than 3Gb free on local disk.", - "Provider": "" - } - ], - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "3Gi", - "ValueStr": "3Gi", - "Type": "SizeSuffix" - }, - { - "Name": "speedup_max_memory", - "Help": "Files larger than the size given below will always be hashed on disk.", - "Provider": "", - "Default": 33554432, + "Name": "chunk_size", + "FieldName": "", + "Help": "Chunk size to upload files with - must be multiple of 320k (327,680 bytes).\n\nAbove this size files will be chunked - must be multiple of 320k (327,680 bytes) and\nshould not exceed 250M (262,144,000 bytes) else you may encounter \\\"Microsoft.SharePoint.Client.InvalidClientQueryException: The request message is too big.\\\"\nNote that the chunks will be buffered into memory.", + "Default": 10485760, "Value": null, - "Examples": [ - { - "Value": "0", - "Help": "Preliminary hashing will always be done in a temporary disk location.", - "Provider": "" - }, - { - "Value": "32M", - "Help": "Do not dedicate more than 32Mb RAM for preliminary hashing.", - "Provider": "" - }, - { - "Value": "256M", - "Help": "You have at most 256Mb RAM free for hash calculations.", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -7040,48 +8843,34 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "32Mi", - "ValueStr": "32Mi", + "DefaultStr": "10Mi", + "ValueStr": "10Mi", "Type": "SizeSuffix" }, { - "Name": "check_hash", - "Help": "What should copy do if file checksum is mismatched or invalid.", - "Provider": "", - "Default": true, + "Name": "drive_id", + "FieldName": "", + "Help": "The ID of the drive to use.", + "Default": "", "Value": null, - "Examples": [ - { - "Value": "true", - "Help": "Fail with error.", - "Provider": "" - }, - { - "Value": "false", - "Help": "Ignore and continue.", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "true", - "ValueStr": "true", - "Type": "bool" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "user_agent", - "Help": "HTTP user agent used internally by client.\n\nDefaults to \"rclone/VERSION\" or \"--user-agent\" provided on command line.", - "Provider": "", + "Name": "drive_type", + "FieldName": "", + "Help": "The type of the drive (personal | business | documentLibrary).", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 3, + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, @@ -7093,30 +8882,49 @@ "Type": "string" }, { - "Name": "quirks", - "Help": "Comma separated list of internal maintenance flags.\n\nThis option must not be used by an ordinary user. It is intended only to\nfacilitate remote troubleshooting of backend issues. Strict meaning of\nflags is not documented and not guaranteed to persist between releases.\nQuirks will be removed when the backend grows stable.\nSupported quirks: atomicmkdir binlist unknowndirs", - "Provider": "", + "Name": "root_folder_id", + "FieldName": "", + "Help": "ID of the root folder.\n\nThis isn't normally needed, but in special circumstances you might\nknow the folder ID that you wish to access but not be able to get\nthere through a path traversal.\n", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 3, + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": false, + "Sensitive": true, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 50440078, + "Name": "access_scopes", + "FieldName": "", + "Help": "Set scopes to be requested by rclone.\n\nChoose or manually enter a custom space separated list with all scopes, that rclone should request.\n", + "Default": [ + "Files.Read", + "Files.ReadWrite", + "Files.Read.All", + "Files.ReadWrite.All", + "Sites.Read.All", + "offline_access" + ], "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All Sites.Read.All offline_access", + "Help": "Read and write access to all resources" + }, + { + "Value": "Files.Read Files.Read.All Sites.Read.All offline_access", + "Help": "Read only access to all resources" + }, + { + "Value": "Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All offline_access", + "Help": "Read and write access to all resources, without the ability to browse SharePoint sites. \nSame as if disable_site_permission was set to true" + } + ], "Hide": 0, "Required": false, "IsPassword": false, @@ -7124,64 +8932,50 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot", - "ValueStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot", - "Type": "MultiEncoder" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "mega", - "Description": "Mega", - "Prefix": "mega", - "Options": [ + "DefaultStr": "Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All Sites.Read.All offline_access", + "ValueStr": "Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All Sites.Read.All offline_access", + "Type": "SpaceSepList" + }, { - "Name": "user", - "Help": "User name.", - "Provider": "", - "Default": "", + "Name": "disable_site_permission", + "FieldName": "", + "Help": "Disable the request for Sites.Read.All permission.\n\nIf set to true, you will no longer be able to search for a SharePoint site when\nconfiguring drive ID, because rclone will not request Sites.Read.All permission.\nSet it to true if your organization didn't assign Sites.Read.All permission to the\napplication, and your organization disallows users to consent app permission\nrequest on their own.", + "Default": false, "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": true, + "Hide": 3, + "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "pass", - "Help": "Password.", - "Provider": "", - "Default": "", + "Name": "expose_onenote_files", + "FieldName": "", + "Help": "Set to make OneNote files show up in directory listings.\n\nBy default, rclone will hide OneNote files in directory listings because\noperations like \"Open\" and \"Update\" won't work on them. But this\nbehaviour may also prevent you from deleting them. If you want to\ndelete OneNote files or otherwise want them to show up in directory\nlisting, set this option.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": true, - "IsPassword": true, + "Required": false, + "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "debug", - "Help": "Output more debug from Mega.\n\nIf this flag is set (along with -vv) it will print further debugging\ninformation from the mega backend.", - "Provider": "", + "Name": "server_side_across_configs", + "FieldName": "", + "Help": "Deprecated: use --server-side-across-configs instead.\n\nAllow server-side operations (e.g. copy) to work across different onedrive configs.\n\nThis will work if you are copying between two OneDrive *Personal* drives AND the files to\ncopy are already shared between them. Additionally, it should also function for a user who\nhas access permissions both between Onedrive for *business* and *SharePoint* under the *same\ntenant*, and between *SharePoint* and another *SharePoint* under the *same tenant*. In other\ncases, rclone will fall back to normal copy (which will be slightly slower).", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -7194,12 +8988,11 @@ "Type": "bool" }, { - "Name": "hard_delete", - "Help": "Delete files permanently rather than putting them into the trash.\n\nNormally the mega backend will put all deletions into the trash rather\nthan permanently deleting them. If you specify this then rclone will\npermanently delete objects instead.", - "Provider": "", - "Default": false, + "Name": "list_chunk", + "FieldName": "", + "Help": "Size of listing chunk.", + "Default": 1000, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -7207,17 +9000,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "1000", + "ValueStr": "1000", + "Type": "int" }, { - "Name": "use_https", - "Help": "Use HTTPS for transfers.\n\nMEGA uses plain text HTTP connections by default.\nSome ISPs throttle HTTP connections, this causes transfers to become very slow.\nEnabling this will force MEGA to use HTTPS for all transfers.\nHTTPS is normally not necessary since all data is already encrypted anyway.\nEnabling it will increase CPU usage and add network overhead.", - "Provider": "", + "Name": "no_versions", + "FieldName": "", + "Help": "Remove all versions on modifying operations.\n\nOnedrive for business creates versions when rclone uploads new files\noverwriting an existing one and when it sets the modification time.\n\nThese versions take up space out of the quota.\n\nThis flag checks for versions after file upload and setting\nmodification time and removes all but the last version.\n\n**NB** Onedrive personal can't currently delete versions so don't use\nthis flag there.\n", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -7230,12 +9022,11 @@ "Type": "bool" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 50331650, + "Name": "hard_delete", + "FieldName": "", + "Help": "Permanently delete files on removal.\n\nNormally files will get sent to the recycle bin on deletion. Setting\nthis flag causes them to be permanently deleted. Use with care.\n\nOneDrive personal accounts do not support the permanentDelete API,\nit only applies to OneDrive for Business and SharePoint document libraries.\n", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -7243,50 +9034,26 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,InvalidUtf8,Dot", - "ValueStr": "Slash,InvalidUtf8,Dot", - "Type": "MultiEncoder" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "memory", - "Description": "In memory object storage system.", - "Prefix": "memory", - "Options": [], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "netstorage", - "Description": "Akamai NetStorage", - "Prefix": "netstorage", - "Options": [ + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, { - "Name": "protocol", - "Help": "Select between HTTP or HTTPS protocol.\n\nMost users should choose HTTPS, which is the default.\nHTTP is provided primarily for debugging purposes.", - "Provider": "", - "Default": "https", + "Name": "link_scope", + "FieldName": "", + "Help": "Set the scope of the links created by the link command.", + "Default": "anonymous", "Value": null, "Examples": [ { - "Value": "http", - "Help": "HTTP protocol", - "Provider": "" + "Value": "anonymous", + "Help": "Anyone with the link has access, without needing to sign in.\nThis may include people outside of your organization.\nAnonymous link support may be disabled by an administrator." }, { - "Value": "https", - "Help": "HTTPS protocol", - "Provider": "" + "Value": "organization", + "Help": "Anyone signed into your organization (tenant) can use the link to get access.\nOnly available in OneDrive for Business and SharePoint." } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -7294,40 +9061,52 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "https", - "ValueStr": "https", + "DefaultStr": "anonymous", + "ValueStr": "anonymous", "Type": "string" }, { - "Name": "host", - "Help": "Domain+path of NetStorage host to connect to.\n\nFormat should be `\u003cdomain\u003e/\u003cinternal folders\u003e`", - "Provider": "", - "Default": "", + "Name": "link_type", + "FieldName": "", + "Help": "Set the type of the links created by the link command.", + "Default": "view", "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "view", + "Help": "Creates a read-only link to the item." + }, + { + "Value": "edit", + "Help": "Creates a read-write link to the item." + }, + { + "Value": "embed", + "Help": "Creates an embeddable link to the item." + } + ], "Hide": 0, - "Required": true, + "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", + "Sensitive": false, + "DefaultStr": "view", + "ValueStr": "view", "Type": "string" }, { - "Name": "account", - "Help": "Set the NetStorage account name", - "Provider": "", + "Name": "link_password", + "FieldName": "", + "Help": "Set the password for links created by the link command.\n\nAt the time of writing this only works with OneDrive personal paid accounts.\n", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": true, + "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": true, "DefaultStr": "", @@ -7335,108 +9114,127 @@ "Type": "string" }, { - "Name": "secret", - "Help": "Set the NetStorage account secret/G2O key for authentication.\n\nPlease choose the 'y' option to set your own password then enter your secret.", - "Provider": "", - "Default": "", + "Name": "hash_type", + "FieldName": "", + "Help": "Specify the hash in use for the backend.\n\nThis specifies the hash type in use. If set to \"auto\" it will use the\ndefault hash which is QuickXorHash.\n\nBefore rclone 1.62 an SHA1 hash was used by default for Onedrive\nPersonal. For 1.62 and later the default is to use a QuickXorHash for\nall onedrive types. If an SHA1 hash is desired then set this option\naccordingly.\n\nFrom July 2023 QuickXorHash will be the only available hash for\nboth OneDrive for Business and OneDrive Personal.\n\nThis can be set to \"none\" to not use any hashes.\n\nIf the hash requested does not exist on the object, it will be\nreturned as an empty string which is treated as a missing hash by\nrclone.\n", + "Default": "auto", "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "auto", + "Help": "Rclone chooses the best hash" + }, + { + "Value": "quickxor", + "Help": "QuickXor" + }, + { + "Value": "sha1", + "Help": "SHA1" + }, + { + "Value": "sha256", + "Help": "SHA256" + }, + { + "Value": "crc32", + "Help": "CRC32" + }, + { + "Value": "none", + "Help": "None - don't use any hashes" + } + ], "Hide": 0, - "Required": true, - "IsPassword": true, + "Required": false, + "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", + "DefaultStr": "auto", + "ValueStr": "auto", "Type": "string" - } - ], - "CommandHelp": [ - { - "Name": "du", - "Short": "Return disk usage information for a specified directory", - "Long": "The usage information returned, includes the targeted directory as well as all\nfiles stored in any sub-directories that may exist.", - "Opts": null }, { - "Name": "symlink", - "Short": "You can create a symbolic link in ObjectStore with the symlink action.", - "Long": "The desired path location (including applicable sub-directories) ending in\nthe object that will be the target of the symlink (for example, /links/mylink).\nInclude the file extension for the object, if applicable.\n`rclone backend symlink \u003csrc\u003e \u003cpath\u003e`", - "Opts": null - } - ], - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "onedrive", - "Description": "Microsoft OneDrive", - "Prefix": "onedrive", - "Options": [ - { - "Name": "client_id", - "Help": "OAuth Client Id.\n\nLeave blank normally.", - "Provider": "", - "Default": "", + "Name": "av_override", + "FieldName": "", + "Help": "Allows download of files the server thinks has a virus.\n\nThe onedrive/sharepoint server may check files uploaded with an Anti\nVirus checker. If it detects any potential viruses or malware it will\nblock download of the file.\n\nIn this case you will see a message like this\n\n server reports this file is infected with a virus - use --onedrive-av-override to download anyway: Infected (name of virus): 403 Forbidden: \n\nIf you are 100% sure you want to download this file anyway then use\nthe --onedrive-av-override flag, or av_override = true in the config\nfile.\n", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "client_secret", - "Help": "OAuth Client Secret.\n\nLeave blank normally.", - "Provider": "", - "Default": "", + "Name": "delta", + "FieldName": "", + "Help": "If set rclone will use delta listing to implement recursive listings.\n\nIf this flag is set the onedrive backend will advertise `ListR`\nsupport for recursive listings.\n\nSetting this flag speeds up these things greatly:\n\n rclone lsf -R onedrive:\n rclone size onedrive:\n rclone rc vfs/refresh recursive=true\n\n**However** the delta listing API **only** works at the root of the\ndrive. If you use it not at the root then it recurses from the root\nand discards all the data that is not under the directory you asked\nfor. So it will be correct but may not be very efficient.\n\nThis is why this flag is not set as the default.\n\nAs a rule of thumb if nearly all of your data is under rclone's root\ndirectory (the `root/directory` in `onedrive:root/directory`) then\nusing this flag will be be a big performance win. If your data is\nmostly not under the root then using this flag will be a big\nperformance loss.\n\nIt is recommended if you are mounting your onedrive at the root\n(or near the root when using crypt) and using rclone `rc vfs/refresh`.\n", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "token", - "Help": "OAuth Access Token as a JSON blob.", - "Provider": "", - "Default": "", + "Name": "metadata_permissions", + "FieldName": "", + "Help": "Control whether permissions should be read or written in metadata.\n\nReading permissions metadata from files can be done quickly, but it\nisn't always desirable to set the permissions from the metadata.\n", + "Default": 0, "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "off", + "Help": "Do not read or write the value" + }, + { + "Value": "read", + "Help": "Read the value only" + }, + { + "Value": "write", + "Help": "Write the value only" + }, + { + "Value": "read,write", + "Help": "Read and Write the value." + }, + { + "Value": "failok", + "Help": "If writing fails log errors only, don't fail the transfer" + } + ], "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "off", + "ValueStr": "off", + "Type": "Bits" }, { - "Name": "auth_url", - "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", - "Provider": "", - "Default": "", + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 57386894, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -7444,17 +9242,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot", + "ValueStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot", + "Type": "Encoding" }, { - "Name": "token_url", - "Help": "Token server url.\n\nLeave blank to use the provider defaults.", - "Provider": "", + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -7465,90 +9262,181 @@ "DefaultStr": "", "ValueStr": "", "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": { + "System": { + "btime": { + "Help": "Time of file birth (creation) with S accuracy (mS for OneDrive Personal).", + "Type": "RFC 3339", + "Example": "2006-01-02T15:04:05Z", + "ReadOnly": false + }, + "content-type": { + "Help": "The MIME type of the file.", + "Type": "string", + "Example": "text/plain", + "ReadOnly": true + }, + "created-by-display-name": { + "Help": "Display name of the user that created the item.", + "Type": "string", + "Example": "John Doe", + "ReadOnly": true + }, + "created-by-id": { + "Help": "ID of the user that created the item.", + "Type": "string", + "Example": "48d31887-5fad-4d73-a9f5-3c356e68a038", + "ReadOnly": true + }, + "description": { + "Help": "A short description of the file. Max 1024 characters. Only supported for OneDrive Personal.", + "Type": "string", + "Example": "Contract for signing", + "ReadOnly": false + }, + "id": { + "Help": "The unique identifier of the item within OneDrive.", + "Type": "string", + "Example": "01BYE5RZ6QN3ZWBTUFOFD3GSPGOHDJD36K", + "ReadOnly": true + }, + "last-modified-by-display-name": { + "Help": "Display name of the user that last modified the item.", + "Type": "string", + "Example": "John Doe", + "ReadOnly": true + }, + "last-modified-by-id": { + "Help": "ID of the user that last modified the item.", + "Type": "string", + "Example": "48d31887-5fad-4d73-a9f5-3c356e68a038", + "ReadOnly": true + }, + "malware-detected": { + "Help": "Whether OneDrive has detected that the item contains malware.", + "Type": "boolean", + "Example": "true", + "ReadOnly": true + }, + "mtime": { + "Help": "Time of last modification with S accuracy (mS for OneDrive Personal).", + "Type": "RFC 3339", + "Example": "2006-01-02T15:04:05Z", + "ReadOnly": false + }, + "package-type": { + "Help": "If present, indicates that this item is a package instead of a folder or file. Packages are treated like files in some contexts and folders in others.", + "Type": "string", + "Example": "oneNote", + "ReadOnly": true + }, + "permissions": { + "Help": "Permissions in a JSON dump of OneDrive format. Enable with --onedrive-metadata-permissions. Properties: id, grantedTo, grantedToIdentities, invitation, inheritedFrom, link, roles, shareId", + "Type": "JSON", + "Example": "{}", + "ReadOnly": false + }, + "shared-by-id": { + "Help": "ID of the user that shared the item (if shared).", + "Type": "string", + "Example": "48d31887-5fad-4d73-a9f5-3c356e68a038", + "ReadOnly": true + }, + "shared-owner-id": { + "Help": "ID of the owner of the shared item (if shared).", + "Type": "string", + "Example": "48d31887-5fad-4d73-a9f5-3c356e68a038", + "ReadOnly": true + }, + "shared-scope": { + "Help": "If shared, indicates the scope of how the item is shared: anonymous, organization, or users.", + "Type": "string", + "Example": "users", + "ReadOnly": true + }, + "shared-time": { + "Help": "Time when the item was shared, with S accuracy (mS for OneDrive Personal).", + "Type": "RFC 3339", + "Example": "2006-01-02T15:04:05Z", + "ReadOnly": true + }, + "utime": { + "Help": "Time of upload with S accuracy (mS for OneDrive Personal).", + "Type": "RFC 3339", + "Example": "2006-01-02T15:04:05Z", + "ReadOnly": true + } }, + "Help": "OneDrive supports System Metadata (not User Metadata, as of this writing) for\nboth files and directories. Much of the metadata is read-only, and there are some\ndifferences between OneDrive Personal and Business (see table below for\ndetails).\n\nPermissions are also supported, if `--onedrive-metadata-permissions` is set. The\naccepted values for `--onedrive-metadata-permissions` are \"`read`\", \"`write`\",\n\"`read,write`\", and \"`off`\" (the default). \"`write`\" supports adding new permissions,\nupdating the \"role\" of existing permissions, and removing permissions. Updating\nand removing require the Permission ID to be known, so it is recommended to use\n\"`read,write`\" instead of \"`write`\" if you wish to update/remove permissions.\n\nPermissions are read/written in JSON format using the same schema as the\n[OneDrive API](https://learn.microsoft.com/en-us/onedrive/developer/rest-api/resources/permission?view=odsp-graph-online),\nwhich differs slightly between OneDrive Personal and Business.\n\nExample for OneDrive Personal:\n```json\n[\n\t{\n\t\t\"id\": \"1234567890ABC!123\",\n\t\t\"grantedTo\": {\n\t\t\t\"user\": {\n\t\t\t\t\"id\": \"ryan@contoso.com\"\n\t\t\t},\n\t\t\t\"application\": {},\n\t\t\t\"device\": {}\n\t\t},\n\t\t\"invitation\": {\n\t\t\t\"email\": \"ryan@contoso.com\"\n\t\t},\n\t\t\"link\": {\n\t\t\t\"webUrl\": \"https://1drv.ms/t/s!1234567890ABC\"\n\t\t},\n\t\t\"roles\": [\n\t\t\t\"read\"\n\t\t],\n\t\t\"shareId\": \"s!1234567890ABC\"\n\t}\n]\n```\n\nExample for OneDrive Business:\n```json\n[\n\t{\n\t\t\"id\": \"48d31887-5fad-4d73-a9f5-3c356e68a038\",\n\t\t\"grantedToIdentities\": [\n\t\t\t{\n\t\t\t\t\"user\": {\n\t\t\t\t\t\"displayName\": \"ryan@contoso.com\"\n\t\t\t\t},\n\t\t\t\t\"application\": {},\n\t\t\t\t\"device\": {}\n\t\t\t}\n\t\t],\n\t\t\"link\": {\n\t\t\t\"type\": \"view\",\n\t\t\t\"scope\": \"users\",\n\t\t\t\"webUrl\": \"https://contoso.sharepoint.com/:w:/t/design/a577ghg9hgh737613bmbjf839026561fmzhsr85ng9f3hjck2t5s\"\n\t\t},\n\t\t\"roles\": [\n\t\t\t\"read\"\n\t\t],\n\t\t\"shareId\": \"u!LKj1lkdlals90j1nlkascl\"\n\t},\n\t{\n\t\t\"id\": \"5D33DD65C6932946\",\n\t\t\"grantedTo\": {\n\t\t\t\"user\": {\n\t\t\t\t\"displayName\": \"John Doe\",\n\t\t\t\t\"id\": \"efee1b77-fb3b-4f65-99d6-274c11914d12\"\n\t\t\t},\n\t\t\t\"application\": {},\n\t\t\t\"device\": {}\n\t\t},\n\t\t\"roles\": [\n\t\t\t\"owner\"\n\t\t],\n\t\t\"shareId\": \"FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U\"\n\t}\n]\n```\n\nTo write permissions, pass in a \"permissions\" metadata key using this same\nformat. The [`--metadata-mapper`](https://rclone.org/docs/#metadata-mapper) tool can\nbe very helpful for this.\n\nWhen adding permissions, an email address can be provided in the `User.ID` or\n`DisplayName` properties of `grantedTo` or `grantedToIdentities`. Alternatively,\nan ObjectID can be provided in `User.ID`. At least one valid recipient must be\nprovided in order to add a permission for a user. Creating a Public Link is also\nsupported, if `Link.Scope` is set to `\"anonymous\"`.\n\nExample request to add a \"read\" permission with `--metadata-mapper`:\n\n```json\n{\n \"Metadata\": {\n \"permissions\": \"[{\\\"grantedToIdentities\\\":[{\\\"user\\\":{\\\"id\\\":\\\"ryan@contoso.com\\\"}}],\\\"roles\\\":[\\\"read\\\"]}]\"\n }\n}\n```\n\nNote that adding a permission can fail if a conflicting permission already\nexists for the file/folder.\n\nTo update an existing permission, include both the Permission ID and the new\n`roles` to be assigned. `roles` is the only property that can be changed.\n\nTo remove permissions, pass in a blob containing only the permissions you wish\nto keep (which can be empty, to remove all.) Note that the `owner` role will be\nignored, as it cannot be removed.\n\nNote that both reading and writing permissions requires extra API calls, so if\nyou don't need to read or write permissions it is recommended to omit\n`--onedrive-metadata-permissions`.\n\nMetadata and permissions are supported for Folders (directories) as well as\nFiles. Note that setting the `mtime` or `btime` on a Folder requires one extra\nAPI call on OneDrive Business only.\n\nOneDrive does not currently support User Metadata. When writing metadata, only\nwriteable system properties will be written -- any read-only or unrecognized keys\npassed in will be ignored.\n\nTIP: to see the metadata and permissions for any file or folder, run:\n\n```\nrclone lsjson remote:path --stat -M --onedrive-metadata-permissions read\n```" + } + }, + { + "Name": "opendrive", + "Description": "OpenDrive", + "Prefix": "opendrive", + "Options": [ { - "Name": "region", - "Help": "Choose national cloud region for OneDrive.", - "Provider": "", - "Default": "global", + "Name": "username", + "FieldName": "", + "Help": "Username.", + "Default": "", "Value": null, - "Examples": [ - { - "Value": "global", - "Help": "Microsoft Cloud Global", - "Provider": "" - }, - { - "Value": "us", - "Help": "Microsoft Cloud for US Government", - "Provider": "" - }, - { - "Value": "de", - "Help": "Microsoft Cloud Germany", - "Provider": "" - }, - { - "Value": "cn", - "Help": "Azure and Office 365 operated by Vnet Group in China", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, - "Required": false, + "Required": true, "IsPassword": false, "NoPrefix": false, "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "global", - "ValueStr": "global", + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", "Type": "string" }, { - "Name": "chunk_size", - "Help": "Chunk size to upload files with - must be multiple of 320k (327,680 bytes).\n\nAbove this size files will be chunked - must be multiple of 320k (327,680 bytes) and\nshould not exceed 250M (262,144,000 bytes) else you may encounter \\\"Microsoft.SharePoint.Client.InvalidClientQueryException: The request message is too big.\\\"\nNote that the chunks will be buffered into memory.", - "Provider": "", - "Default": 10485760, + "Name": "password", + "FieldName": "", + "Help": "Password.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, - "IsPassword": false, + "Required": true, + "IsPassword": true, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "10Mi", - "ValueStr": "10Mi", - "Type": "SizeSuffix" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "drive_id", - "Help": "The ID of the drive to use.", - "Provider": "", - "Default": "", + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 62007182, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot", + "ValueStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot", + "Type": "Encoding" }, { - "Name": "drive_type", - "Help": "The type of the drive (personal | business | documentLibrary).", - "Provider": "", - "Default": "", + "Name": "chunk_size", + "FieldName": "", + "Help": "Files will be uploaded in chunks this size.\n\nNote that these chunks are buffered in memory so increasing them will\nincrease memory use.", + "Default": 10485760, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -7556,214 +9444,218 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "10Mi", + "ValueStr": "10Mi", + "Type": "SizeSuffix" }, { - "Name": "root_folder_id", - "Help": "ID of the root folder.\n\nThis isn't normally needed, but in special circumstances you might\nknow the folder ID that you wish to access but not be able to get\nthere through a path traversal.\n", - "Provider": "", + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" - }, + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "oracleobjectstorage", + "Description": "Oracle Cloud Infrastructure Object Storage", + "Prefix": "oos", + "Options": [ { - "Name": "access_scopes", - "Help": "Set scopes to be requested by rclone.\n\nChoose or manually enter a custom space separated list with all scopes, that rclone should request.\n", - "Provider": "", - "Default": [ - "Files.Read", - "Files.ReadWrite", - "Files.Read.All", - "Files.ReadWrite.All", - "Sites.Read.All", - "offline_access" - ], + "Name": "provider", + "FieldName": "", + "Help": "Choose your Auth Provider", + "Default": "env_auth", "Value": null, "Examples": [ { - "Value": "Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All Sites.Read.All offline_access", - "Help": "Read and write access to all resources", - "Provider": "" + "Value": "env_auth", + "Help": "automatically pickup the credentials from runtime(env), first one to provide auth wins" }, { - "Value": "Files.Read Files.Read.All Sites.Read.All offline_access", - "Help": "Read only access to all resources", - "Provider": "" + "Value": "user_principal_auth", + "Help": "use an OCI user and an API key for authentication.\nyou’ll need to put in a config file your tenancy OCID, user OCID, region, the path, fingerprint to an API key.\nhttps://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm" }, { - "Value": "Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All offline_access", - "Help": "Read and write access to all resources, without the ability to browse SharePoint sites. \nSame as if disable_site_permission was set to true", - "Provider": "" + "Value": "instance_principal_auth", + "Help": "use instance principals to authorize an instance to make API calls. \neach instance has its own identity, and authenticates using the certificates that are read from instance metadata. \nhttps://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm" + }, + { + "Value": "workload_identity_auth", + "Help": "use workload identity to grant OCI Container Engine for Kubernetes workloads policy-driven access to OCI resources using OCI Identity and Access Management (IAM).\nhttps://docs.oracle.com/en-us/iaas/Content/ContEng/Tasks/contenggrantingworkloadaccesstoresources.htm" + }, + { + "Value": "resource_principal_auth", + "Help": "use resource principals to make API calls" + }, + { + "Value": "no_auth", + "Help": "no credentials needed, this is typically for reading public buckets" } ], - "ShortOpt": "", "Hide": 0, - "Required": false, + "Required": true, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All Sites.Read.All offline_access", - "ValueStr": "Files.Read Files.ReadWrite Files.Read.All Files.ReadWrite.All Sites.Read.All offline_access", - "Type": "SpaceSepList" + "DefaultStr": "env_auth", + "ValueStr": "env_auth", + "Type": "string" }, { - "Name": "disable_site_permission", - "Help": "Disable the request for Sites.Read.All permission.\n\nIf set to true, you will no longer be able to search for a SharePoint site when\nconfiguring drive ID, because rclone will not request Sites.Read.All permission.\nSet it to true if your organization didn't assign Sites.Read.All permission to the\napplication, and your organization disallows users to consent app permission\nrequest on their own.", - "Provider": "", - "Default": false, + "Name": "namespace", + "FieldName": "", + "Help": "Object storage namespace", + "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 3, - "Required": false, + "Hide": 0, + "Required": true, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "expose_onenote_files", - "Help": "Set to make OneNote files show up in directory listings.\n\nBy default, rclone will hide OneNote files in directory listings because\noperations like \"Open\" and \"Update\" won't work on them. But this\nbehaviour may also prevent you from deleting them. If you want to\ndelete OneNote files or otherwise want them to show up in directory\nlisting, set this option.", - "Provider": "", - "Default": false, + "Name": "compartment", + "FieldName": "", + "Help": "Object storage compartment OCID", + "Provider": "!no_auth", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, + "Required": true, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "server_side_across_configs", - "Help": "Deprecated: use --server-side-across-configs instead.\n\nAllow server-side operations (e.g. copy) to work across different onedrive configs.\n\nThis will only work if you are copying between two OneDrive *Personal* drives AND\nthe files to copy are already shared between them. In other cases, rclone will\nfall back to normal copy (which will be slightly slower).", - "Provider": "", - "Default": false, + "Name": "region", + "FieldName": "", + "Help": "Object storage Region", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, + "Required": true, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "list_chunk", - "Help": "Size of listing chunk.", - "Provider": "", - "Default": 1000, + "Name": "endpoint", + "FieldName": "", + "Help": "Endpoint for Object storage API.\n\nLeave blank to use the default endpoint for the region.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "1000", - "ValueStr": "1000", - "Type": "int" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "no_versions", - "Help": "Remove all versions on modifying operations.\n\nOnedrive for business creates versions when rclone uploads new files\noverwriting an existing one and when it sets the modification time.\n\nThese versions take up space out of the quota.\n\nThis flag checks for versions after file upload and setting\nmodification time and removes all but the last version.\n\n**NB** Onedrive personal can't currently delete versions so don't use\nthis flag there.\n", - "Provider": "", - "Default": false, + "Name": "config_file", + "FieldName": "", + "Help": "Path to OCI config file", + "Provider": "user_principal_auth", + "Default": "~/.oci/config", "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "~/.oci/config", + "Help": "oci configuration file location" + } + ], "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "~/.oci/config", + "ValueStr": "~/.oci/config", + "Type": "string" }, { - "Name": "link_scope", - "Help": "Set the scope of the links created by the link command.", - "Provider": "", - "Default": "anonymous", + "Name": "config_profile", + "FieldName": "", + "Help": "Profile name inside the oci config file", + "Provider": "user_principal_auth", + "Default": "Default", "Value": null, "Examples": [ { - "Value": "anonymous", - "Help": "Anyone with the link has access, without needing to sign in.\nThis may include people outside of your organization.\nAnonymous link support may be disabled by an administrator.", - "Provider": "" - }, - { - "Value": "organization", - "Help": "Anyone signed into your organization (tenant) can use the link to get access.\nOnly available in OneDrive for Business and SharePoint.", - "Provider": "" + "Value": "Default", + "Help": "Use the default profile" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "anonymous", - "ValueStr": "anonymous", + "DefaultStr": "Default", + "ValueStr": "Default", "Type": "string" }, { - "Name": "link_type", - "Help": "Set the type of the links created by the link command.", - "Provider": "", - "Default": "view", + "Name": "storage_tier", + "FieldName": "", + "Help": "The storage class to use when storing new objects in storage. https://docs.oracle.com/en-us/iaas/Content/Object/Concepts/understandingstoragetiers.htm", + "Default": "Standard", "Value": null, "Examples": [ { - "Value": "view", - "Help": "Creates a read-only link to the item.", - "Provider": "" + "Value": "Standard", + "Help": "Standard storage tier, this is the default tier" }, { - "Value": "edit", - "Help": "Creates a read-write link to the item.", - "Provider": "" + "Value": "InfrequentAccess", + "Help": "InfrequentAccess storage tier" }, { - "Value": "embed", - "Help": "Creates an embeddable link to the item.", - "Provider": "" + "Value": "Archive", + "Help": "Archive storage tier" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -7771,67 +9663,33 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "view", - "ValueStr": "view", + "DefaultStr": "Standard", + "ValueStr": "Standard", "Type": "string" }, { - "Name": "link_password", - "Help": "Set the password for links created by the link command.\n\nAt the time of writing this only works with OneDrive personal paid accounts.\n", - "Provider": "", - "Default": "", + "Name": "upload_cutoff", + "FieldName": "", + "Help": "Cutoff for switching to chunked upload.\n\nAny files larger than this will be uploaded in chunks of chunk_size.\nThe minimum is 0 and the maximum is 5 GiB.", + "Default": 209715200, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "200Mi", + "ValueStr": "200Mi", + "Type": "SizeSuffix" }, { - "Name": "hash_type", - "Help": "Specify the hash in use for the backend.\n\nThis specifies the hash type in use. If set to \"auto\" it will use the\ndefault hash which is QuickXorHash.\n\nBefore rclone 1.62 an SHA1 hash was used by default for Onedrive\nPersonal. For 1.62 and later the default is to use a QuickXorHash for\nall onedrive types. If an SHA1 hash is desired then set this option\naccordingly.\n\nFrom July 2023 QuickXorHash will be the only available hash for\nboth OneDrive for Business and OneDriver Personal.\n\nThis can be set to \"none\" to not use any hashes.\n\nIf the hash requested does not exist on the object, it will be\nreturned as an empty string which is treated as a missing hash by\nrclone.\n", - "Provider": "", - "Default": "auto", + "Name": "chunk_size", + "FieldName": "", + "Help": "Chunk size to use for uploading.\n\nWhen uploading files larger than upload_cutoff or files with unknown\nsize (e.g. from \"rclone rcat\" or uploaded with \"rclone mount\" they will be uploaded \nas multipart uploads using this chunk size.\n\nNote that \"upload_concurrency\" chunks of this size are buffered\nin memory per transfer.\n\nIf you are transferring large files over high-speed links and you have\nenough memory, then increasing this will speed up the transfers.\n\nRclone will automatically increase the chunk size when uploading a\nlarge file of known size to stay below the 10,000 chunks limit.\n\nFiles of unknown size are uploaded with the configured\nchunk_size. Since the default chunk size is 5 MiB and there can be at\nmost 10,000 chunks, this means that by default the maximum size of\na file you can stream upload is 48 GiB. If you wish to stream upload\nlarger files then you will need to increase chunk_size.\n\nIncreasing the chunk size decreases the accuracy of the progress\nstatistics displayed with \"-P\" flag.\n", + "Default": 5242880, "Value": null, - "Examples": [ - { - "Value": "auto", - "Help": "Rclone chooses the best hash", - "Provider": "" - }, - { - "Value": "quickxor", - "Help": "QuickXor", - "Provider": "" - }, - { - "Value": "sha1", - "Help": "SHA1", - "Provider": "" - }, - { - "Value": "sha256", - "Help": "SHA256", - "Provider": "" - }, - { - "Value": "crc32", - "Help": "CRC32", - "Provider": "" - }, - { - "Value": "none", - "Help": "None - don't use any hashes", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -7839,17 +9697,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "auto", - "ValueStr": "auto", - "Type": "string" + "DefaultStr": "5Mi", + "ValueStr": "5Mi", + "Type": "SizeSuffix" }, { - "Name": "av_override", - "Help": "Allows download of files the server thinks has a virus.\n\nThe onedrive/sharepoint server may check files uploaded with an Anti\nVirus checker. If it detects any potential viruses or malware it will\nblock download of the file.\n\nIn this case you will see a message like this\n\n server reports this file is infected with a virus - use --onedrive-av-override to download anyway: Infected (name of virus): 403 Forbidden: \n\nIf you are 100% sure you want to download this file anyway then use\nthe --onedrive-av-override flag, or av_override = true in the config\nfile.\n", - "Provider": "", - "Default": false, + "Name": "max_upload_parts", + "FieldName": "", + "Help": "Maximum number of parts in a multipart upload.\n\nThis option defines the maximum number of multipart chunks to use\nwhen doing a multipart upload.\n\nOCI has max parts limit of 10,000 chunks.\n\nRclone will automatically increase the chunk size when uploading a\nlarge file of a known size to stay below this number of chunks limit.\n", + "Default": 10000, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -7857,17 +9714,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "10000", + "ValueStr": "10000", + "Type": "int" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 57386894, + "Name": "upload_concurrency", + "FieldName": "", + "Help": "Concurrency for multipart uploads.\n\nThis is the number of chunks of the same file that are uploaded\nconcurrently.\n\nIf you are uploading small numbers of large files over high-speed links\nand these uploads do not fully utilize your bandwidth, then increasing\nthis may help to speed up the transfers.", + "Default": 10, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -7875,64 +9731,67 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot", - "ValueStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8,Dot", - "Type": "MultiEncoder" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "opendrive", - "Description": "OpenDrive", - "Prefix": "opendrive", - "Options": [ + "DefaultStr": "10", + "ValueStr": "10", + "Type": "int" + }, { - "Name": "username", - "Help": "Username.", - "Provider": "", - "Default": "", + "Name": "copy_cutoff", + "FieldName": "", + "Help": "Cutoff for switching to multipart copy.\n\nAny files larger than this that need to be server-side copied will be\ncopied in chunks of this size.\n\nThe minimum is 0 and the maximum is 5 GiB.", + "Default": 4999610368, "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": true, + "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "4.656Gi", + "ValueStr": "4.656Gi", + "Type": "SizeSuffix" }, { - "Name": "password", - "Help": "Password.", - "Provider": "", - "Default": "", + "Name": "copy_timeout", + "FieldName": "", + "Help": "Timeout for copy.\n\nCopy is an asynchronous operation, specify timeout to wait for copy to succeed\n", + "Default": 60000000000, "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": true, - "IsPassword": true, + "Required": false, + "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "1m0s", + "ValueStr": "1m0s", + "Type": "Duration" + }, + { + "Name": "disable_checksum", + "FieldName": "", + "Help": "Don't store MD5 checksum with object metadata.\n\nNormally rclone will calculate the MD5 checksum of the input before\nuploading it so it can add it to metadata on the object. This is great\nfor data integrity checking but can cause long delays for large files\nto start uploading.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { "Name": "encoding", + "FieldName": "", "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 62007182, + "Default": 50331650, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -7940,17 +9799,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot", - "ValueStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot", - "Type": "MultiEncoder" + "DefaultStr": "Slash,InvalidUtf8,Dot", + "ValueStr": "Slash,InvalidUtf8,Dot", + "Type": "Encoding" }, { - "Name": "chunk_size", - "Help": "Files will be uploaded in chunks this size.\n\nNote that these chunks are buffered in memory so increasing them will\nincrease memory use.", - "Provider": "", - "Default": 10485760, + "Name": "leave_parts_on_error", + "FieldName": "", + "Help": "If true avoid calling abort upload on a failure, leaving all successfully uploaded parts for manual recovery.\n\nIt should be set to true for resuming uploads across different sessions.\n\nWARNING: Storing parts of an incomplete multipart upload counts towards space usage on object storage and will add\nadditional costs if not cleaned up.\n", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -7958,114 +9816,61 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "10Mi", - "ValueStr": "10Mi", - "Type": "SizeSuffix" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "oracleobjectstorage", - "Description": "Oracle Cloud Infrastructure Object Storage", - "Prefix": "oos", - "Options": [ - { - "Name": "provider", - "Help": "Choose your Auth Provider", - "Provider": "", - "Default": "env_auth", - "Value": null, - "Examples": [ - { - "Value": "env_auth", - "Help": "automatically pickup the credentials from runtime(env), first one to provide auth wins", - "Provider": "" - }, - { - "Value": "user_principal_auth", - "Help": "use an OCI user and an API key for authentication.\nyou’ll need to put in a config file your tenancy OCID, user OCID, region, the path, fingerprint to an API key.\nhttps://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm", - "Provider": "" - }, - { - "Value": "instance_principal_auth", - "Help": "use instance principals to authorize an instance to make API calls. \neach instance has its own identity, and authenticates using the certificates that are read from instance metadata. \nhttps://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/callingservicesfrominstances.htm", - "Provider": "" - }, - { - "Value": "resource_principal_auth", - "Help": "use resource principals to make API calls", - "Provider": "" - }, - { - "Value": "no_auth", - "Help": "no credentials needed, this is typically for reading public buckets", - "Provider": "" - } - ], - "ShortOpt": "", - "Hide": 0, - "Required": true, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "env_auth", - "ValueStr": "env_auth", - "Type": "string" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "namespace", - "Help": "Object storage namespace", - "Provider": "", - "Default": "", + "Name": "attempt_resume_upload", + "FieldName": "", + "Help": "If true attempt to resume previously started multipart upload for the object.\nThis will be helpful to speed up multipart transfers by resuming uploads from past session.\n\nWARNING: If chunk size differs in resumed session from past incomplete session, then the resumed multipart upload is \naborted and a new multipart upload is started with the new chunk size.\n\nThe flag leave_parts_on_error must be true to resume and optimize to skip parts that were already uploaded successfully.\n", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": true, + "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "compartment", - "Help": "Object storage compartment OCID", - "Provider": "!no_auth", - "Default": "", + "Name": "no_check_bucket", + "FieldName": "", + "Help": "If set, don't attempt to check the bucket exists or create it.\n\nThis can be useful when trying to minimise the number of transactions\nrclone does if you know the bucket exists already.\n\nIt can also be needed if the user you are using does not have bucket\ncreation permissions.\n", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": true, + "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "region", - "Help": "Object storage Region", - "Provider": "", + "Name": "sse_customer_key_file", + "FieldName": "", + "Help": "To use SSE-C, a file containing the base64-encoded string of the AES-256 encryption key associated\nwith the object. Please note only one of sse_customer_key_file|sse_customer_key|sse_kms_key_id is needed.'", "Default": "", "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "", + "Help": "None" + } + ], "Hide": 0, - "Required": true, + "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, "DefaultStr": "", @@ -8073,17 +9878,22 @@ "Type": "string" }, { - "Name": "endpoint", - "Help": "Endpoint for Object storage API.\n\nLeave blank to use the default endpoint for the region.", - "Provider": "", + "Name": "sse_customer_key", + "FieldName": "", + "Help": "To use SSE-C, the optional header that specifies the base64-encoded 256-bit encryption key to use to\nencrypt or decrypt the data. Please note only one of sse_customer_key_file|sse_customer_key|sse_kms_key_id is\nneeded. For more information, see Using Your Own Keys for Server-Side Encryption \n(https://docs.cloud.oracle.com/Content/Object/Tasks/usingyourencryptionkeys.htm)", "Default": "", "Value": null, - "ShortOpt": "", + "Examples": [ + { + "Value": "", + "Help": "None" + } + ], "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, "DefaultStr": "", @@ -8091,79 +9901,67 @@ "Type": "string" }, { - "Name": "config_file", - "Help": "Path to OCI config file", - "Provider": "user_principal_auth", - "Default": "~/.oci/config", + "Name": "sse_customer_key_sha256", + "FieldName": "", + "Help": "If using SSE-C, The optional header that specifies the base64-encoded SHA256 hash of the encryption\nkey. This value is used to check the integrity of the encryption key. see Using Your Own Keys for \nServer-Side Encryption (https://docs.cloud.oracle.com/Content/Object/Tasks/usingyourencryptionkeys.htm).", + "Default": "", "Value": null, "Examples": [ { - "Value": "~/.oci/config", - "Help": "oci configuration file location", - "Provider": "" + "Value": "", + "Help": "None" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "~/.oci/config", - "ValueStr": "~/.oci/config", + "DefaultStr": "", + "ValueStr": "", "Type": "string" }, { - "Name": "config_profile", - "Help": "Profile name inside the oci config file", - "Provider": "user_principal_auth", - "Default": "Default", + "Name": "sse_kms_key_id", + "FieldName": "", + "Help": "if using your own master key in vault, this header specifies the\nOCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a master encryption key used to call\nthe Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.\nPlease note only one of sse_customer_key_file|sse_customer_key|sse_kms_key_id is needed.", + "Default": "", "Value": null, "Examples": [ { - "Value": "Default", - "Help": "Use the default profile", - "Provider": "" + "Value": "", + "Help": "None" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Default", - "ValueStr": "Default", + "DefaultStr": "", + "ValueStr": "", "Type": "string" }, { - "Name": "storage_tier", - "Help": "The storage class to use when storing new objects in storage. https://docs.oracle.com/en-us/iaas/Content/Object/Concepts/understandingstoragetiers.htm", - "Provider": "", - "Default": "Standard", + "Name": "sse_customer_algorithm", + "FieldName": "", + "Help": "If using SSE-C, the optional header that specifies \"AES256\" as the encryption algorithm.\nObject Storage supports \"AES256\" as the encryption algorithm. For more information, see\nUsing Your Own Keys for Server-Side Encryption (https://docs.cloud.oracle.com/Content/Object/Tasks/usingyourencryptionkeys.htm).", + "Default": "", "Value": null, "Examples": [ { - "Value": "Standard", - "Help": "Standard storage tier, this is the default tier", - "Provider": "" - }, - { - "Value": "InfrequentAccess", - "Help": "InfrequentAccess storage tier", - "Provider": "" + "Value": "", + "Help": "None" }, { - "Value": "Archive", - "Help": "Archive storage tier", - "Provider": "" + "Value": "AES256", + "Help": "AES256" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -8171,17 +9969,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Standard", - "ValueStr": "Standard", + "DefaultStr": "", + "ValueStr": "", "Type": "string" }, { - "Name": "upload_cutoff", - "Help": "Cutoff for switching to chunked upload.\n\nAny files larger than this will be uploaded in chunks of chunk_size.\nThe minimum is 0 and the maximum is 5 GiB.", - "Provider": "", - "Default": 209715200, + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -8189,107 +9986,107 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "200Mi", - "ValueStr": "200Mi", - "Type": "SizeSuffix" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": [ + { + "Name": "rename", + "Short": "change the name of an object", + "Long": "This command can be used to rename a object.\n\nUsage Examples:\n\n rclone backend rename oos:bucket relative-object-path-under-bucket object-new-name\n", + "Opts": null }, { - "Name": "chunk_size", - "Help": "Chunk size to use for uploading.\n\nWhen uploading files larger than upload_cutoff or files with unknown\nsize (e.g. from \"rclone rcat\" or uploaded with \"rclone mount\" or google\nphotos or google docs) they will be uploaded as multipart uploads\nusing this chunk size.\n\nNote that \"upload_concurrency\" chunks of this size are buffered\nin memory per transfer.\n\nIf you are transferring large files over high-speed links and you have\nenough memory, then increasing this will speed up the transfers.\n\nRclone will automatically increase the chunk size when uploading a\nlarge file of known size to stay below the 10,000 chunks limit.\n\nFiles of unknown size are uploaded with the configured\nchunk_size. Since the default chunk size is 5 MiB and there can be at\nmost 10,000 chunks, this means that by default the maximum size of\na file you can stream upload is 48 GiB. If you wish to stream upload\nlarger files then you will need to increase chunk_size.\n\nIncreasing the chunk size decreases the accuracy of the progress\nstatistics displayed with \"-P\" flag.\n", - "Provider": "", - "Default": 5242880, - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "5Mi", - "ValueStr": "5Mi", - "Type": "SizeSuffix" + "Name": "list-multipart-uploads", + "Short": "List the unfinished multipart uploads", + "Long": "This command lists the unfinished multipart uploads in JSON format.\n\n rclone backend list-multipart-uploads oos:bucket/path/to/object\n\nIt returns a dictionary of buckets with values as lists of unfinished\nmultipart uploads.\n\nYou can call it with no bucket in which case it lists all bucket, with\na bucket or with a bucket and path.\n\n {\n \"test-bucket\": [\n {\n \"namespace\": \"test-namespace\",\n \"bucket\": \"test-bucket\",\n \"object\": \"600m.bin\",\n \"uploadId\": \"51dd8114-52a4-b2f2-c42f-5291f05eb3c8\",\n \"timeCreated\": \"2022-07-29T06:21:16.595Z\",\n \"storageTier\": \"Standard\"\n }\n ]\n", + "Opts": null }, { - "Name": "upload_concurrency", - "Help": "Concurrency for multipart uploads.\n\nThis is the number of chunks of the same file that are uploaded\nconcurrently.\n\nIf you are uploading small numbers of large files over high-speed links\nand these uploads do not fully utilize your bandwidth, then increasing\nthis may help to speed up the transfers.", - "Provider": "", - "Default": 10, - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "10", - "ValueStr": "10", - "Type": "int" + "Name": "cleanup", + "Short": "Remove unfinished multipart uploads.", + "Long": "This command removes unfinished multipart uploads of age greater than\nmax-age which defaults to 24 hours.\n\nNote that you can use --interactive/-i or --dry-run with this command to see what\nit would do.\n\n rclone backend cleanup oos:bucket/path/to/object\n rclone backend cleanup -o max-age=7w oos:bucket/path/to/object\n\nDurations are parsed as per the rest of rclone, 2h, 7d, 7w etc.\n", + "Opts": { + "max-age": "Max age of upload to delete" + } }, { - "Name": "copy_cutoff", - "Help": "Cutoff for switching to multipart copy.\n\nAny files larger than this that need to be server-side copied will be\ncopied in chunks of this size.\n\nThe minimum is 0 and the maximum is 5 GiB.", - "Provider": "", - "Default": 4999610368, + "Name": "restore", + "Short": "Restore objects from Archive to Standard storage", + "Long": "This command can be used to restore one or more objects from Archive to Standard storage.\n\n\tUsage Examples:\n\n rclone backend restore oos:bucket/path/to/directory -o hours=HOURS\n rclone backend restore oos:bucket -o hours=HOURS\n\nThis flag also obeys the filters. Test first with --interactive/-i or --dry-run flags\n\n\trclone --interactive backend restore --include \"*.txt\" oos:bucket/path -o hours=72\n\nAll the objects shown will be marked for restore, then\n\n\trclone backend restore --include \"*.txt\" oos:bucket/path -o hours=72\n\n\tIt returns a list of status dictionaries with Object Name and Status\n\tkeys. The Status will be \"RESTORED\"\" if it was successful or an error message\n\tif not.\n\n\t[\n\t\t{\n\t\t\t\"Object\": \"test.txt\"\n\t\t\t\"Status\": \"RESTORED\",\n\t\t},\n\t\t{\n\t\t\t\"Object\": \"test/file4.txt\"\n\t\t\t\"Status\": \"RESTORED\",\n\t\t}\n\t]\n", + "Opts": { + "hours": "The number of hours for which this object will be restored. Default is 24 hrs." + } + } + ], + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "pcloud", + "Description": "Pcloud", + "Prefix": "pcloud", + "Options": [ + { + "Name": "client_id", + "FieldName": "", + "Help": "OAuth Client Id.\n\nLeave blank normally.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "4.656Gi", - "ValueStr": "4.656Gi", - "Type": "SizeSuffix" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, - { - "Name": "copy_timeout", - "Help": "Timeout for copy.\n\nCopy is an asynchronous operation, specify timeout to wait for copy to succeed\n", - "Provider": "", - "Default": 60000000000, + { + "Name": "client_secret", + "FieldName": "", + "Help": "OAuth Client Secret.\n\nLeave blank normally.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "1m0s", - "ValueStr": "1m0s", - "Type": "Duration" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "disable_checksum", - "Help": "Don't store MD5 checksum with object metadata.\n\nNormally rclone will calculate the MD5 checksum of the input before\nuploading it so it can add it to metadata on the object. This is great\nfor data integrity checking but can cause long delays for large files\nto start uploading.", - "Provider": "", - "Default": false, + "Name": "token", + "FieldName": "", + "Help": "OAuth Access Token as a JSON blob.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 50331650, + "Name": "auth_url", + "FieldName": "", + "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -8297,17 +10094,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,InvalidUtf8,Dot", - "ValueStr": "Slash,InvalidUtf8,Dot", - "Type": "MultiEncoder" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "leave_parts_on_error", - "Help": "If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery.\n\nIt should be set to true for resuming uploads across different sessions.\n\nWARNING: Storing parts of an incomplete multipart upload counts towards space usage on object storage and will add\nadditional costs if not cleaned up.\n", - "Provider": "", - "Default": false, + "Name": "token_url", + "FieldName": "", + "Help": "Token server url.\n\nLeave blank to use the provider defaults.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -8315,17 +10111,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "no_check_bucket", - "Help": "If set, don't attempt to check the bucket exists or create it.\n\nThis can be useful when trying to minimise the number of transactions\nrclone does if you know the bucket exists already.\n\nIt can also be needed if the user you are using does not have bucket\ncreation permissions.\n", - "Provider": "", - "Default": false, + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 50438146, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -8333,49 +10128,43 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot", + "ValueStr": "Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot", + "Type": "Encoding" }, { - "Name": "sse_customer_key_file", - "Help": "To use SSE-C, a file containing the base64-encoded string of the AES-256 encryption key associated\nwith the object. Please note only one of sse_customer_key_file|sse_customer_key|sse_kms_key_id is needed.'", - "Provider": "", - "Default": "", + "Name": "root_folder_id", + "FieldName": "", + "Help": "Fill in for rclone to use a non root folder as its starting point.", + "Default": "d0", "Value": null, - "Examples": [ - { - "Value": "", - "Help": "None", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", + "Sensitive": true, + "DefaultStr": "d0", + "ValueStr": "d0", "Type": "string" }, { - "Name": "sse_customer_key", - "Help": "To use SSE-C, the optional header that specifies the base64-encoded 256-bit encryption key to use to\nencrypt or decrypt the data. Please note only one of sse_customer_key_file|sse_customer_key|sse_kms_key_id is\nneeded. For more information, see Using Your Own Keys for Server-Side Encryption \n(https://docs.cloud.oracle.com/Content/Object/Tasks/usingyourencryptionkeys.htm)", - "Provider": "", - "Default": "", + "Name": "hostname", + "FieldName": "", + "Help": "Hostname to connect to.\n\nThis is normally set when rclone initially does the oauth connection,\nhowever you will need to set it by hand if you are using remote config\nwith rclone authorize.\n", + "Default": "api.pcloud.com", "Value": null, "Examples": [ { - "Value": "", - "Help": "None", - "Provider": "" + "Value": "api.pcloud.com", + "Help": "Original/US region" + }, + { + "Value": "eapi.pcloud.com", + "Help": "EU region" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -8383,52 +10172,36 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", + "DefaultStr": "api.pcloud.com", + "ValueStr": "api.pcloud.com", "Type": "string" }, { - "Name": "sse_customer_key_sha256", - "Help": "If using SSE-C, The optional header that specifies the base64-encoded SHA256 hash of the encryption\nkey. This value is used to check the integrity of the encryption key. see Using Your Own Keys for \nServer-Side Encryption (https://docs.cloud.oracle.com/Content/Object/Tasks/usingyourencryptionkeys.htm).", - "Provider": "", + "Name": "username", + "FieldName": "", + "Help": "Your pcloud username.\n\t\t\t\nThis is only required when you want to use the cleanup command. Due to a bug\nin the pcloud API the required API does not support OAuth authentication so\nwe have to rely on user password authentication for it.", "Default": "", "Value": null, - "Examples": [ - { - "Value": "", - "Help": "None", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": false, + "Sensitive": true, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "sse_kms_key_id", - "Help": "if using your own master key in vault, this header specifies the\nOCID (https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of a master encryption key used to call\nthe Key Management service to generate a data encryption key or to encrypt or decrypt a data encryption key.\nPlease note only one of sse_customer_key_file|sse_customer_key|sse_kms_key_id is needed.", - "Provider": "", + "Name": "password", + "FieldName": "", + "Help": "Your pcloud password.", "Default": "", "Value": null, - "Examples": [ - { - "Value": "", - "Help": "None", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, - "IsPassword": false, + "IsPassword": true, "NoPrefix": false, "Advanced": true, "Exclusive": false, @@ -8438,24 +10211,11 @@ "Type": "string" }, { - "Name": "sse_customer_algorithm", - "Help": "If using SSE-C, the optional header that specifies \"AES256\" as the encryption algorithm.\nObject Storage supports \"AES256\" as the encryption algorithm. For more information, see\nUsing Your Own Keys for Server-Side Encryption (https://docs.cloud.oracle.com/Content/Object/Tasks/usingyourencryptionkeys.htm).", - "Provider": "", + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", "Default": "", "Value": null, - "Examples": [ - { - "Value": "", - "Help": "None", - "Provider": "" - }, - { - "Value": "AES256", - "Help": "AES256", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -8468,46 +10228,24 @@ "Type": "string" } ], - "CommandHelp": [ - { - "Name": "rename", - "Short": "change the name of an object", - "Long": "This command can be used to rename a object.\n\nUsage Examples:\n\n rclone backend rename oos:bucket relative-object-path-under-bucket object-new-name\n", - "Opts": null - }, - { - "Name": "list-multipart-uploads", - "Short": "List the unfinished multipart uploads", - "Long": "This command lists the unfinished multipart uploads in JSON format.\n\n rclone backend list-multipart-uploads oos:bucket/path/to/object\n\nIt returns a dictionary of buckets with values as lists of unfinished\nmultipart uploads.\n\nYou can call it with no bucket in which case it lists all bucket, with\na bucket or with a bucket and path.\n\n {\n \"test-bucket\": [\n {\n \"namespace\": \"test-namespace\",\n \"bucket\": \"test-bucket\",\n \"object\": \"600m.bin\",\n \"uploadId\": \"51dd8114-52a4-b2f2-c42f-5291f05eb3c8\",\n \"timeCreated\": \"2022-07-29T06:21:16.595Z\",\n \"storageTier\": \"Standard\"\n }\n ]\n", - "Opts": null - }, - { - "Name": "cleanup", - "Short": "Remove unfinished multipart uploads.", - "Long": "This command removes unfinished multipart uploads of age greater than\nmax-age which defaults to 24 hours.\n\nNote that you can use --interactive/-i or --dry-run with this command to see what\nit would do.\n\n rclone backend cleanup oos:bucket/path/to/object\n rclone backend cleanup -o max-age=7w oos:bucket/path/to/object\n\nDurations are parsed as per the rest of rclone, 2h, 7d, 7w etc.\n", - "Opts": { - "max-age": "Max age of upload to delete" - } - } - ], + "CommandHelp": null, "Aliases": null, "Hide": false, "MetadataInfo": null }, { - "Name": "pcloud", - "Description": "Pcloud", - "Prefix": "pcloud", + "Name": "pikpak", + "Description": "PikPak", + "Prefix": "pikpak", "Options": [ { - "Name": "client_id", - "Help": "OAuth Client Id.\n\nLeave blank normally.", - "Provider": "", + "Name": "user", + "FieldName": "", + "Help": "Pikpak username.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, + "Required": true, "IsPassword": false, "NoPrefix": false, "Advanced": false, @@ -8518,17 +10256,33 @@ "Type": "string" }, { - "Name": "client_secret", - "Help": "OAuth Client Secret.\n\nLeave blank normally.", - "Provider": "", + "Name": "pass", + "FieldName": "", + "Help": "Pikpak password.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": true, + "IsPassword": true, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "device_id", + "FieldName": "", + "Help": "Device ID used for authorization.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": true, "DefaultStr": "", @@ -8536,12 +10290,28 @@ "Type": "string" }, { - "Name": "token", - "Help": "OAuth Access Token as a JSON blob.", - "Provider": "", + "Name": "user_agent", + "FieldName": "", + "Help": "HTTP user agent for pikpak.\n\nDefaults to \"Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:129.0) Gecko/20100101 Firefox/129.0\" or \"--pikpak-user-agent\" provided on command line.", + "Default": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:129.0) Gecko/20100101 Firefox/129.0", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:129.0) Gecko/20100101 Firefox/129.0", + "ValueStr": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:129.0) Gecko/20100101 Firefox/129.0", + "Type": "string" + }, + { + "Name": "root_folder_id", + "FieldName": "", + "Help": "ID of the root folder.\nLeave blank normally.\n\nFill in for rclone to use a non root folder as its starting point.\n", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -8554,12 +10324,79 @@ "Type": "string" }, { - "Name": "auth_url", - "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", - "Provider": "", - "Default": "", + "Name": "use_trash", + "FieldName": "", + "Help": "Send files to the trash instead of deleting permanently.\n\nDefaults to true, namely sending files to the trash.\nUse `--pikpak-use-trash=false` to delete files permanently instead.", + "Default": true, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "true", + "ValueStr": "true", + "Type": "bool" + }, + { + "Name": "trashed_only", + "FieldName": "", + "Help": "Only show files that are in the trash.\n\nThis will show trashed files in their original directory structure.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "hash_memory_limit", + "FieldName": "", + "Help": "Files bigger than this will be cached on disk to calculate hash if required.", + "Default": 10485760, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "10Mi", + "ValueStr": "10Mi", + "Type": "SizeSuffix" + }, + { + "Name": "chunk_size", + "FieldName": "", + "Help": "Chunk size for multipart uploads.\n\t\nLarge files will be uploaded in chunks of this size.\n\nNote that this is stored in memory and there may be up to\n\"--transfers\" * \"--pikpak-upload-concurrency\" chunks stored at once\nin memory.\n\nIf you are transferring large files over high-speed links and you have\nenough memory, then increasing this will speed up the transfers.\n\nRclone will automatically increase the chunk size when uploading a\nlarge file of known size to stay below the 10,000 chunks limit.\n\nIncreasing the chunk size decreases the accuracy of the progress\nstatistics displayed with \"-P\" flag.", + "Default": 5242880, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "5Mi", + "ValueStr": "5Mi", + "Type": "SizeSuffix" + }, + { + "Name": "upload_concurrency", + "FieldName": "", + "Help": "Concurrency for multipart uploads.\n\nThis is the number of chunks of the same file that are uploaded\nconcurrently for multipart uploads.\n\nNote that chunks are stored in memory and there may be up to\n\"--transfers\" * \"--pikpak-upload-concurrency\" chunks stored at once\nin memory.\n\nIf you are uploading small numbers of large files over high-speed links\nand these uploads do not fully utilize your bandwidth, then increasing\nthis may help to speed up the transfers.", + "Default": 5, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -8567,17 +10404,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "5", + "ValueStr": "5", + "Type": "int" }, { - "Name": "token_url", - "Help": "Token server url.\n\nLeave blank to use the provider defaults.", - "Provider": "", - "Default": "", + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 56829838, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -8585,17 +10421,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,RightSpace,RightPeriod,InvalidUtf8,Dot", + "ValueStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,RightSpace,RightPeriod,InvalidUtf8,Dot", + "Type": "Encoding" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 50438146, + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -8603,86 +10438,94 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot", - "ValueStr": "Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot", - "Type": "MultiEncoder" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": [ + { + "Name": "addurl", + "Short": "Add offline download task for url", + "Long": "This command adds offline download task for url.\n\nUsage:\n\n rclone backend addurl pikpak:dirpath url\n\nDownloads will be stored in 'dirpath'. If 'dirpath' is invalid, \ndownload will fallback to default 'My Pack' folder.\n", + "Opts": null }, { - "Name": "root_folder_id", - "Help": "Fill in for rclone to use a non root folder as its starting point.", - "Provider": "", - "Default": "d0", + "Name": "decompress", + "Short": "Request decompress of a file/files in a folder", + "Long": "This command requests decompress of file/files in a folder.\n\nUsage:\n\n rclone backend decompress pikpak:dirpath {filename} -o password=password\n rclone backend decompress pikpak:dirpath {filename} -o delete-src-file\n\nAn optional argument 'filename' can be specified for a file located in \n'pikpak:dirpath'. You may want to pass '-o password=password' for a \npassword-protected files. Also, pass '-o delete-src-file' to delete \nsource files after decompression finished.\n\nResult:\n\n {\n \"Decompressed\": 17,\n \"SourceDeleted\": 0,\n \"Errors\": 0\n }\n", + "Opts": null + } + ], + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "pixeldrain", + "Description": "Pixeldrain Filesystem", + "Prefix": "pixeldrain", + "Options": [ + { + "Name": "api_key", + "FieldName": "", + "Help": "API key for your pixeldrain account.\nFound on https://pixeldrain.com/user/api_keys.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": true, - "DefaultStr": "d0", - "ValueStr": "d0", + "DefaultStr": "", + "ValueStr": "", "Type": "string" }, { - "Name": "hostname", - "Help": "Hostname to connect to.\n\nThis is normally set when rclone initially does the oauth connection,\nhowever you will need to set it by hand if you are using remote config\nwith rclone authorize.\n", - "Provider": "", - "Default": "api.pcloud.com", + "Name": "root_folder_id", + "FieldName": "", + "Help": "Root of the filesystem to use.\n\nSet to 'me' to use your personal filesystem. Set to a shared directory ID to use a shared directory.", + "Default": "me", "Value": null, - "Examples": [ - { - "Value": "api.pcloud.com", - "Help": "Original/US region", - "Provider": "" - }, - { - "Value": "eapi.pcloud.com", - "Help": "EU region", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, - "DefaultStr": "api.pcloud.com", - "ValueStr": "api.pcloud.com", + "DefaultStr": "me", + "ValueStr": "me", "Type": "string" }, { - "Name": "username", - "Help": "Your pcloud username.\n\t\t\t\nThis is only required when you want to use the cleanup command. Due to a bug\nin the pcloud API the required API does not support OAuth authentication so\nwe have to rely on user password authentication for it.", - "Provider": "", - "Default": "", + "Name": "api_url", + "FieldName": "", + "Help": "The API endpoint to connect to. In the vast majority of cases it's fine to leave\nthis at default. It is only intended to be changed for testing purposes.", + "Default": "https://pixeldrain.com/api", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, + "Required": true, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", + "Sensitive": false, + "DefaultStr": "https://pixeldrain.com/api", + "ValueStr": "https://pixeldrain.com/api", "Type": "string" }, { - "Name": "password", - "Help": "Your pcloud password.", - "Provider": "", + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, - "IsPassword": true, + "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, @@ -8695,25 +10538,46 @@ "CommandHelp": null, "Aliases": null, "Hide": false, - "MetadataInfo": null + "MetadataInfo": { + "System": { + "btime": { + "Help": "Time of file birth (creation)", + "Type": "RFC 3339", + "Example": "2006-01-02T15:04:05.999999999Z07:00", + "ReadOnly": false + }, + "mode": { + "Help": "File mode", + "Type": "octal, unix style", + "Example": "755", + "ReadOnly": false + }, + "mtime": { + "Help": "Time of last modification", + "Type": "RFC 3339", + "Example": "2006-01-02T15:04:05.999999999Z07:00", + "ReadOnly": false + } + }, + "Help": "Pixeldrain supports file modes and creation times." + } }, { - "Name": "pikpak", - "Description": "PikPak", - "Prefix": "pikpak", + "Name": "premiumizeme", + "Description": "premiumize.me", + "Prefix": "premiumizeme", "Options": [ { "Name": "client_id", + "FieldName": "", "Help": "OAuth Client Id.\n\nLeave blank normally.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": true, "DefaultStr": "", @@ -8722,16 +10586,15 @@ }, { "Name": "client_secret", + "FieldName": "", "Help": "OAuth Client Secret.\n\nLeave blank normally.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": true, "DefaultStr": "", @@ -8740,11 +10603,10 @@ }, { "Name": "token", + "FieldName": "", "Help": "OAuth Access Token as a JSON blob.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -8758,11 +10620,10 @@ }, { "Name": "auth_url", + "FieldName": "", "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -8776,11 +10637,10 @@ }, { "Name": "token_url", + "FieldName": "", "Help": "Token server url.\n\nLeave blank to use the provider defaults.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -8793,53 +10653,16 @@ "Type": "string" }, { - "Name": "user", - "Help": "Pikpak username.", - "Provider": "", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": true, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" - }, - { - "Name": "pass", - "Help": "Pikpak password.", - "Provider": "", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": true, - "IsPassword": true, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" - }, - { - "Name": "root_folder_id", - "Help": "ID of the root folder.\nLeave blank normally.\n\nFill in for rclone to use a non root folder as its starting point.\n", - "Provider": "", + "Name": "api_key", + "FieldName": "", + "Help": "API Key.\n\nThis is not normally used - use oauth instead.\n", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 3, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": true, "DefaultStr": "", @@ -8847,48 +10670,11 @@ "Type": "string" }, { - "Name": "use_trash", - "Help": "Send files to the trash instead of deleting permanently.\n\nDefaults to true, namely sending files to the trash.\nUse `--pikpak-use-trash=false` to delete files permanently instead.", - "Provider": "", - "Default": true, - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "true", - "ValueStr": "true", - "Type": "bool" - }, - { - "Name": "trashed_only", - "Help": "Only show files that are in the trash.\n\nThis will show trashed files in their original directory structure.", - "Provider": "", - "Default": false, - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": true, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" - }, - { - "Name": "hash_memory_limit", - "Help": "Files bigger than this will be cached on disk to calculate hash if required.", - "Provider": "", - "Default": 10485760, + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 50438154, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -8896,17 +10682,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "10Mi", - "ValueStr": "10Mi", - "Type": "SizeSuffix" + "DefaultStr": "Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot", + "ValueStr": "Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot", + "Type": "Encoding" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 56829838, + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -8914,98 +10699,64 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,RightSpace,RightPeriod,InvalidUtf8,Dot", - "ValueStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,RightSpace,RightPeriod,InvalidUtf8,Dot", - "Type": "MultiEncoder" - } - ], - "CommandHelp": [ - { - "Name": "addurl", - "Short": "Add offline download task for url", - "Long": "This command adds offline download task for url.\n\nUsage:\n\n rclone backend addurl pikpak:dirpath url\n\nDownloads will be stored in 'dirpath'. If 'dirpath' is invalid, \ndownload will fallback to default 'My Pack' folder.\n", - "Opts": null - }, - { - "Name": "decompress", - "Short": "Request decompress of a file/files in a folder", - "Long": "This command requests decompress of file/files in a folder.\n\nUsage:\n\n rclone backend decompress pikpak:dirpath {filename} -o password=password\n rclone backend decompress pikpak:dirpath {filename} -o delete-src-file\n\nAn optional argument 'filename' can be specified for a file located in \n'pikpak:dirpath'. You may want to pass '-o password=password' for a \npassword-protected files. Also, pass '-o delete-src-file' to delete \nsource files after decompression finished.\n\nResult:\n\n {\n \"Decompressed\": 17,\n \"SourceDeleted\": 0,\n \"Errors\": 0\n }\n", - "Opts": null + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], + "CommandHelp": null, "Aliases": null, "Hide": false, "MetadataInfo": null }, { - "Name": "premiumizeme", - "Description": "premiumize.me", - "Prefix": "premiumizeme", + "Name": "protondrive", + "Description": "Proton Drive", + "Prefix": "protondrive", "Options": [ { - "Name": "client_id", - "Help": "OAuth Client Id.\n\nLeave blank normally.", - "Provider": "", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" - }, - { - "Name": "client_secret", - "Help": "OAuth Client Secret.\n\nLeave blank normally.", - "Provider": "", + "Name": "username", + "FieldName": "", + "Help": "The username of your proton account", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, + "Required": true, "IsPassword": false, "NoPrefix": false, "Advanced": false, "Exclusive": false, - "Sensitive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "token", - "Help": "OAuth Access Token as a JSON blob.", - "Provider": "", + "Name": "password", + "FieldName": "", + "Help": "The password of your proton account.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, - "Required": false, - "IsPassword": false, + "Required": true, + "IsPassword": true, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": true, + "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "auth_url", - "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", - "Provider": "", + "Name": "mailbox_password", + "FieldName": "", + "Help": "The mailbox password of your two-password proton account.\n\nFor more information regarding the mailbox password, please check the \nfollowing official knowledge base article: \nhttps://proton.me/support/the-difference-between-the-mailbox-password-and-login-password\n", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, - "IsPassword": false, + "IsPassword": true, "NoPrefix": false, "Advanced": true, "Exclusive": false, @@ -9015,17 +10766,16 @@ "Type": "string" }, { - "Name": "token_url", - "Help": "Token server url.\n\nLeave blank to use the provider defaults.", - "Provider": "", + "Name": "2fa", + "FieldName": "", + "Help": "The 2FA code\n\nThe value can also be provided with --protondrive-2fa=000000\n\nThe 2FA code of your proton drive account if the account is set up with \ntwo-factor authentication", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, "Sensitive": false, "DefaultStr": "", @@ -9033,17 +10783,16 @@ "Type": "string" }, { - "Name": "api_key", - "Help": "API Key.\n\nThis is not normally used - use oauth instead.\n", - "Provider": "", + "Name": "client_uid", + "FieldName": "", + "Help": "Client uid key (internal use only)", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 3, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": true, "DefaultStr": "", @@ -9051,95 +10800,62 @@ "Type": "string" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 50438154, + "Name": "client_access_token", + "FieldName": "", + "Help": "Client access token key (internal use only)", + "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 3, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot", - "ValueStr": "Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot", - "Type": "MultiEncoder" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "protondrive", - "Description": "Proton Drive", - "Prefix": "protondrive", - "Options": [ - { - "Name": "username", - "Help": "The username of your proton drive account", - "Provider": "", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": true, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": false, + "Sensitive": true, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "password", - "Help": "The password of your proton drive account.", - "Provider": "", + "Name": "client_refresh_token", + "FieldName": "", + "Help": "Client refresh token key (internal use only)", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": true, - "IsPassword": true, + "Hide": 3, + "Required": false, + "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": false, + "Sensitive": true, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { - "Name": "2fa", - "Help": "The 2FA code\nThe 2FA code of your proton drive account if the account is set up with \ntwo-factor authentication", - "Provider": "", + "Name": "client_salted_key_pass", + "FieldName": "", + "Help": "Client salted key pass key (internal use only)", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 3, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": false, + "Sensitive": true, "DefaultStr": "", "ValueStr": "", "Type": "string" }, { "Name": "encoding", + "FieldName": "", "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", "Default": 52559874, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9149,15 +10865,14 @@ "Sensitive": false, "DefaultStr": "Slash,LeftSpace,RightSpace,InvalidUtf8,Dot", "ValueStr": "Slash,LeftSpace,RightSpace,InvalidUtf8,Dot", - "Type": "MultiEncoder" + "Type": "Encoding" }, { "Name": "original_file_size", + "FieldName": "", "Help": "Return the file size before encryption\n\t\t\t\nThe size of the encrypted file will be different from (bigger than) the \noriginal file size. Unless there is a reason to return the file size \nafter encryption is performed, otherwise, set this option to true, as \nfeatures like Open() which will need to be supplied with original content \nsize, will fail to operate properly", - "Provider": "", "Default": true, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9171,11 +10886,10 @@ }, { "Name": "app_version", + "FieldName": "", "Help": "The app version string \n\nThe app version string indicates the client that is currently performing \nthe API request. This information is required and will be sent with every \nAPI request.", - "Provider": "", "Default": "macos-drive@1.0.0-alpha.1+rclone", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9189,11 +10903,10 @@ }, { "Name": "replace_existing_draft", - "Help": "Create a new revision when filename conflict is detected\n\nWhen a file upload is cancelled or failed before completion, a draft will be \ncreated and the subsequent upload of the same file to the same location will be \nreported as a conflict.\n\nIf the option is set to true, the draft will be replaced and then the upload \noperation will restart. If there are other clients also uploading at the same \nfile location at the same time, the behavior is currently unknown. Need to set \nto true for integration tests.\nIf the option is set to false, an error \"a draft exist - usually this means a \nfile is being uploaded at another client, or, there was a failed upload attempt\" \nwill be returned, and no upload will happen.", - "Provider": "", + "FieldName": "", + "Help": "Create a new revision when filename conflict is detected\n\nWhen a file upload is cancelled or failed before completion, a draft will be \ncreated and the subsequent upload of the same file to the same location will be \nreported as a conflict.\n\nThe value can also be set by --protondrive-replace-existing-draft=true\n\nIf the option is set to true, the draft will be replaced and then the upload \noperation will restart. If there are other clients also uploading at the same \nfile location at the same time, the behavior is currently unknown. Need to set \nto true for integration tests.\nIf the option is set to false, an error \"a draft exist - usually this means a \nfile is being uploaded at another client, or, there was a failed upload attempt\" \nwill be returned, and no upload will happen.", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9207,11 +10920,10 @@ }, { "Name": "enable_caching", - "Help": "Caches the files and folders metadata to reduce API calls\n\nThe files and folders on ProtonDrive are represented as links with keyrings, \nwhich can be cached to improve performance and be friendly to the API server.\n\nThe cache is currently built for the case when the rclone is the only instance \nperforming operations to the mount point. The event system, which is the proton\nAPI system that provides visibility of what has changed on the drive, is yet \nto be implemented, so updates from other clients won’t be reflected in the \ncache. Thus, if there are concurrent clients accessing the same mount point, \nthen we might have a problem with caching the stale data.", - "Provider": "", + "FieldName": "", + "Help": "Caches the files and folders metadata to reduce API calls\n\nNotice: If you are mounting ProtonDrive as a VFS, please disable this feature, \nas the current implementation doesn't update or clear the cache when there are \nexternal changes. \n\nThe files and folders on ProtonDrive are represented as links with keyrings, \nwhich can be cached to improve performance and be friendly to the API server.\n\nThe cache is currently built for the case when the rclone is the only instance \nperforming operations to the mount point. The event system, which is the proton\nAPI system that provides visibility of what has changed on the drive, is yet \nto be implemented, so updates from other clients won’t be reflected in the \ncache. Thus, if there are concurrent clients accessing the same mount point, \nthen we might have a problem with caching the stale data.", "Default": true, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9222,6 +10934,23 @@ "DefaultStr": "true", "ValueStr": "true", "Type": "bool" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], "CommandHelp": null, @@ -9236,11 +10965,10 @@ "Options": [ { "Name": "client_id", + "FieldName": "", "Help": "OAuth Client Id.\n\nLeave blank normally.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9254,11 +10982,10 @@ }, { "Name": "client_secret", + "FieldName": "", "Help": "OAuth Client Secret.\n\nLeave blank normally.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9272,11 +10999,10 @@ }, { "Name": "token", + "FieldName": "", "Help": "OAuth Access Token as a JSON blob.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9290,11 +11016,10 @@ }, { "Name": "auth_url", + "FieldName": "", "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9308,11 +11033,10 @@ }, { "Name": "token_url", + "FieldName": "", "Help": "Token server url.\n\nLeave blank to use the provider defaults.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9326,11 +11050,10 @@ }, { "Name": "encoding", + "FieldName": "", "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", "Default": 50438146, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9340,7 +11063,24 @@ "Sensitive": false, "DefaultStr": "Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot", "ValueStr": "Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot", - "Type": "MultiEncoder" + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], "CommandHelp": null, @@ -9355,23 +11095,20 @@ "Options": [ { "Name": "env_auth", + "FieldName": "", "Help": "Get QingStor credentials from runtime.\n\nOnly applies if access_key_id and secret_access_key is blank.", - "Provider": "", "Default": false, "Value": null, "Examples": [ { "Value": "false", - "Help": "Enter QingStor credentials in the next step.", - "Provider": "" + "Help": "Enter QingStor credentials in the next step." }, { "Value": "true", - "Help": "Get QingStor credentials from the environment (env vars or IAM).", - "Provider": "" + "Help": "Get QingStor credentials from the environment (env vars or IAM)." } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9385,11 +11122,10 @@ }, { "Name": "access_key_id", + "FieldName": "", "Help": "QingStor Access Key ID.\n\nLeave blank for anonymous access or runtime credentials.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9403,11 +11139,10 @@ }, { "Name": "secret_access_key", + "FieldName": "", "Help": "QingStor Secret Access Key (password).\n\nLeave blank for anonymous access or runtime credentials.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9421,11 +11156,10 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Enter an endpoint URL to connection QingStor API.\n\nLeave blank will use the default value \"https://qingstor.com:443\".", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9439,46 +11173,222 @@ }, { "Name": "zone", + "FieldName": "", "Help": "Zone to connect to.\n\nDefault is \"pek3a\".", - "Provider": "", "Default": "", "Value": null, "Examples": [ { "Value": "pek3a", - "Help": "The Beijing (China) Three Zone.\nNeeds location constraint pek3a.", - "Provider": "" + "Help": "The Beijing (China) Three Zone.\nNeeds location constraint pek3a." }, { "Value": "sh1a", - "Help": "The Shanghai (China) First Zone.\nNeeds location constraint sh1a.", - "Provider": "" + "Help": "The Shanghai (China) First Zone.\nNeeds location constraint sh1a." }, { "Value": "gd2a", - "Help": "The Guangdong (China) Second Zone.\nNeeds location constraint gd2a.", - "Provider": "" + "Help": "The Guangdong (China) Second Zone.\nNeeds location constraint gd2a." } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "connection_retries", + "FieldName": "", + "Help": "Number of connection retries.", + "Default": 3, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "3", + "ValueStr": "3", + "Type": "int" + }, + { + "Name": "upload_cutoff", + "FieldName": "", + "Help": "Cutoff for switching to chunked upload.\n\nAny files larger than this will be uploaded in chunks of chunk_size.\nThe minimum is 0 and the maximum is 5 GiB.", + "Default": 209715200, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "200Mi", + "ValueStr": "200Mi", + "Type": "SizeSuffix" + }, + { + "Name": "chunk_size", + "FieldName": "", + "Help": "Chunk size to use for uploading.\n\nWhen uploading files larger than upload_cutoff they will be uploaded\nas multipart uploads using this chunk size.\n\nNote that \"--qingstor-upload-concurrency\" chunks of this size are buffered\nin memory per transfer.\n\nIf you are transferring large files over high-speed links and you have\nenough memory, then increasing this will speed up the transfers.", + "Default": 4194304, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "4Mi", + "ValueStr": "4Mi", + "Type": "SizeSuffix" + }, + { + "Name": "upload_concurrency", + "FieldName": "", + "Help": "Concurrency for multipart uploads.\n\nThis is the number of chunks of the same file that are uploaded\nconcurrently.\n\nNB if you set this to > 1 then the checksums of multipart uploads\nbecome corrupted (the uploads themselves are not corrupted though).\n\nIf you are uploading small numbers of large files over high-speed links\nand these uploads do not fully utilize your bandwidth, then increasing\nthis may help to speed up the transfers.", + "Default": 1, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "1", + "ValueStr": "1", + "Type": "int" + }, + { + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 16842754, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "Slash,Ctl,InvalidUtf8", + "ValueStr": "Slash,Ctl,InvalidUtf8", + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "quatrix", + "Description": "Quatrix by Maytech", + "Prefix": "quatrix", + "Options": [ + { + "Name": "api_key", + "FieldName": "", + "Help": "API key for accessing Quatrix account", + "Default": "", + "Value": null, + "Hide": 0, + "Required": true, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "host", + "FieldName": "", + "Help": "Host name of Quatrix account", + "Default": "", + "Value": null, + "Hide": 0, + "Required": true, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 50438146, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot", + "ValueStr": "Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot", + "Type": "Encoding" + }, + { + "Name": "effective_upload_time", + "FieldName": "", + "Help": "Wanted upload time for one chunk", + "Default": "4s", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", + "DefaultStr": "4s", + "ValueStr": "4s", "Type": "string" }, { - "Name": "connection_retries", - "Help": "Number of connection retries.", - "Provider": "", - "Default": 3, + "Name": "minimal_chunk_size", + "FieldName": "", + "Help": "The minimal size for one chunk", + "Default": 10000000, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9486,17 +11396,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "3", - "ValueStr": "3", - "Type": "int" + "DefaultStr": "9.537Mi", + "ValueStr": "9.537Mi", + "Type": "SizeSuffix" }, { - "Name": "upload_cutoff", - "Help": "Cutoff for switching to chunked upload.\n\nAny files larger than this will be uploaded in chunks of chunk_size.\nThe minimum is 0 and the maximum is 5 GiB.", - "Provider": "", - "Default": 209715200, + "Name": "maximal_summary_chunk_size", + "FieldName": "", + "Help": "The maximal summary for all chunks. It should not be less than 'transfers'*'minimal_chunk_size'", + "Default": 100000000, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9504,17 +11413,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "200Mi", - "ValueStr": "200Mi", + "DefaultStr": "95.367Mi", + "ValueStr": "95.367Mi", "Type": "SizeSuffix" }, { - "Name": "chunk_size", - "Help": "Chunk size to use for uploading.\n\nWhen uploading files larger than upload_cutoff they will be uploaded\nas multipart uploads using this chunk size.\n\nNote that \"--qingstor-upload-concurrency\" chunks of this size are buffered\nin memory per transfer.\n\nIf you are transferring large files over high-speed links and you have\nenough memory, then increasing this will speed up the transfers.", - "Provider": "", - "Default": 4194304, + "Name": "hard_delete", + "FieldName": "", + "Help": "Delete files permanently rather than putting them into the trash", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9522,17 +11430,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "4Mi", - "ValueStr": "4Mi", - "Type": "SizeSuffix" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "upload_concurrency", - "Help": "Concurrency for multipart uploads.\n\nThis is the number of chunks of the same file that are uploaded\nconcurrently.\n\nNB if you set this to \u003e 1 then the checksums of multipart uploads\nbecome corrupted (the uploads themselves are not corrupted though).\n\nIf you are uploading small numbers of large files over high-speed links\nand these uploads do not fully utilize your bandwidth, then increasing\nthis may help to speed up the transfers.", - "Provider": "", - "Default": 1, + "Name": "skip_project_folders", + "FieldName": "", + "Help": "Skip project folders in operations", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9540,17 +11447,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "1", - "ValueStr": "1", - "Type": "int" + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 16842754, + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9558,9 +11464,9 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,Ctl,InvalidUtf8", - "ValueStr": "Slash,Ctl,InvalidUtf8", - "Type": "MultiEncoder" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], "CommandHelp": null, @@ -9570,163 +11476,145 @@ }, { "Name": "s3", - "Description": "Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, China Mobile, Cloudflare, GCS, DigitalOcean, Dreamhost, Huawei OBS, IBM COS, IDrive e2, IONOS Cloud, Leviia, Liara, Lyve Cloud, Minio, Netease, Petabox, RackCorp, Scaleway, SeaweedFS, StackPath, Storj, Synology, Tencent COS, Qiniu and Wasabi", + "Description": "Amazon S3 Compliant Storage Providers including AWS, Alibaba, ArvanCloud, Ceph, ChinaMobile, Cloudflare, DigitalOcean, Dreamhost, GCS, HuaweiOBS, IBMCOS, IDrive, IONOS, LyveCloud, Leviia, Liara, Linode, Magalu, Minio, Netease, Petabox, RackCorp, Rclone, Scaleway, SeaweedFS, StackPath, Storj, Synology, TencentCOS, Wasabi, Qiniu and others", "Prefix": "s3", "Options": [ { "Name": "provider", + "FieldName": "", "Help": "Choose your S3 provider.", - "Provider": "", "Default": "", "Value": null, "Examples": [ { "Value": "AWS", - "Help": "Amazon Web Services (AWS) S3", - "Provider": "" + "Help": "Amazon Web Services (AWS) S3" }, { "Value": "Alibaba", - "Help": "Alibaba Cloud Object Storage System (OSS) formerly Aliyun", - "Provider": "" + "Help": "Alibaba Cloud Object Storage System (OSS) formerly Aliyun" }, { "Value": "ArvanCloud", - "Help": "Arvan Cloud Object Storage (AOS)", - "Provider": "" + "Help": "Arvan Cloud Object Storage (AOS)" }, { "Value": "Ceph", - "Help": "Ceph Object Storage", - "Provider": "" + "Help": "Ceph Object Storage" }, { "Value": "ChinaMobile", - "Help": "China Mobile Ecloud Elastic Object Storage (EOS)", - "Provider": "" + "Help": "China Mobile Ecloud Elastic Object Storage (EOS)" }, { "Value": "Cloudflare", - "Help": "Cloudflare R2 Storage", - "Provider": "" + "Help": "Cloudflare R2 Storage" }, { "Value": "DigitalOcean", - "Help": "DigitalOcean Spaces", - "Provider": "" + "Help": "DigitalOcean Spaces" }, { "Value": "Dreamhost", - "Help": "Dreamhost DreamObjects", - "Provider": "" + "Help": "Dreamhost DreamObjects" }, { "Value": "GCS", - "Help": "Google Cloud Storage", - "Provider": "" + "Help": "Google Cloud Storage" }, { "Value": "HuaweiOBS", - "Help": "Huawei Object Storage Service", - "Provider": "" + "Help": "Huawei Object Storage Service" }, { "Value": "IBMCOS", - "Help": "IBM COS S3", - "Provider": "" + "Help": "IBM COS S3" }, { "Value": "IDrive", - "Help": "IDrive e2", - "Provider": "" + "Help": "IDrive e2" }, { "Value": "IONOS", - "Help": "IONOS Cloud", - "Provider": "" + "Help": "IONOS Cloud" }, { "Value": "LyveCloud", - "Help": "Seagate Lyve Cloud", - "Provider": "" + "Help": "Seagate Lyve Cloud" }, { "Value": "Leviia", - "Help": "Leviia Object Storage", - "Provider": "" + "Help": "Leviia Object Storage" }, { "Value": "Liara", - "Help": "Liara Object Storage", - "Provider": "" + "Help": "Liara Object Storage" + }, + { + "Value": "Linode", + "Help": "Linode Object Storage" + }, + { + "Value": "Magalu", + "Help": "Magalu Object Storage" }, { "Value": "Minio", - "Help": "Minio Object Storage", - "Provider": "" + "Help": "Minio Object Storage" }, { "Value": "Netease", - "Help": "Netease Object Storage (NOS)", - "Provider": "" + "Help": "Netease Object Storage (NOS)" }, { "Value": "Petabox", - "Help": "Petabox Object Storage", - "Provider": "" + "Help": "Petabox Object Storage" }, { "Value": "RackCorp", - "Help": "RackCorp Object Storage", - "Provider": "" + "Help": "RackCorp Object Storage" + }, + { + "Value": "Rclone", + "Help": "Rclone S3 Server" }, { "Value": "Scaleway", - "Help": "Scaleway Object Storage", - "Provider": "" + "Help": "Scaleway Object Storage" }, { "Value": "SeaweedFS", - "Help": "SeaweedFS S3", - "Provider": "" + "Help": "SeaweedFS S3" }, { "Value": "StackPath", - "Help": "StackPath Object Storage", - "Provider": "" + "Help": "StackPath Object Storage" }, { "Value": "Storj", - "Help": "Storj (S3 Compatible Gateway)", - "Provider": "" + "Help": "Storj (S3 Compatible Gateway)" }, { "Value": "Synology", - "Help": "Synology C2 Object Storage", - "Provider": "" + "Help": "Synology C2 Object Storage" }, { "Value": "TencentCOS", - "Help": "Tencent Cloud Object Storage (COS)", - "Provider": "" + "Help": "Tencent Cloud Object Storage (COS)" }, { "Value": "Wasabi", - "Help": "Wasabi Object Storage", - "Provider": "" + "Help": "Wasabi Object Storage" }, { "Value": "Qiniu", - "Help": "Qiniu Object Storage (Kodo)", - "Provider": "" + "Help": "Qiniu Object Storage (Kodo)" }, { "Value": "Other", - "Help": "Any other S3 compatible provider", - "Provider": "" + "Help": "Any other S3 compatible provider" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9740,23 +11628,20 @@ }, { "Name": "env_auth", + "FieldName": "", "Help": "Get AWS credentials from runtime (environment variables or EC2/ECS meta data if no env vars).\n\nOnly applies if access_key_id and secret_access_key is blank.", - "Provider": "", "Default": false, "Value": null, "Examples": [ { "Value": "false", - "Help": "Enter AWS credentials in the next step.", - "Provider": "" + "Help": "Enter AWS credentials in the next step." }, { "Value": "true", - "Help": "Get AWS credentials from the environment (env vars or IAM).", - "Provider": "" + "Help": "Get AWS credentials from the environment (env vars or IAM)." } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9770,11 +11655,10 @@ }, { "Name": "access_key_id", + "FieldName": "", "Help": "AWS Access Key ID.\n\nLeave blank for anonymous access or runtime credentials.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9788,11 +11672,10 @@ }, { "Name": "secret_access_key", + "FieldName": "", "Help": "AWS Secret Access Key (password).\n\nLeave blank for anonymous access or runtime credentials.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9806,6 +11689,7 @@ }, { "Name": "region", + "FieldName": "", "Help": "Region to connect to.", "Provider": "AWS", "Default": "", @@ -9813,131 +11697,109 @@ "Examples": [ { "Value": "us-east-1", - "Help": "The default endpoint - a good choice if you are unsure.\nUS Region, Northern Virginia, or Pacific Northwest.\nLeave location constraint empty.", - "Provider": "" + "Help": "The default endpoint - a good choice if you are unsure.\nUS Region, Northern Virginia, or Pacific Northwest.\nLeave location constraint empty." }, { "Value": "us-east-2", - "Help": "US East (Ohio) Region.\nNeeds location constraint us-east-2.", - "Provider": "" + "Help": "US East (Ohio) Region.\nNeeds location constraint us-east-2." }, { "Value": "us-west-1", - "Help": "US West (Northern California) Region.\nNeeds location constraint us-west-1.", - "Provider": "" + "Help": "US West (Northern California) Region.\nNeeds location constraint us-west-1." }, { "Value": "us-west-2", - "Help": "US West (Oregon) Region.\nNeeds location constraint us-west-2.", - "Provider": "" + "Help": "US West (Oregon) Region.\nNeeds location constraint us-west-2." }, { "Value": "ca-central-1", - "Help": "Canada (Central) Region.\nNeeds location constraint ca-central-1.", - "Provider": "" + "Help": "Canada (Central) Region.\nNeeds location constraint ca-central-1." }, { "Value": "eu-west-1", - "Help": "EU (Ireland) Region.\nNeeds location constraint EU or eu-west-1.", - "Provider": "" + "Help": "EU (Ireland) Region.\nNeeds location constraint EU or eu-west-1." }, { "Value": "eu-west-2", - "Help": "EU (London) Region.\nNeeds location constraint eu-west-2.", - "Provider": "" + "Help": "EU (London) Region.\nNeeds location constraint eu-west-2." }, { "Value": "eu-west-3", - "Help": "EU (Paris) Region.\nNeeds location constraint eu-west-3.", - "Provider": "" + "Help": "EU (Paris) Region.\nNeeds location constraint eu-west-3." }, { "Value": "eu-north-1", - "Help": "EU (Stockholm) Region.\nNeeds location constraint eu-north-1.", - "Provider": "" + "Help": "EU (Stockholm) Region.\nNeeds location constraint eu-north-1." }, { "Value": "eu-south-1", - "Help": "EU (Milan) Region.\nNeeds location constraint eu-south-1.", - "Provider": "" + "Help": "EU (Milan) Region.\nNeeds location constraint eu-south-1." }, { "Value": "eu-central-1", - "Help": "EU (Frankfurt) Region.\nNeeds location constraint eu-central-1.", - "Provider": "" + "Help": "EU (Frankfurt) Region.\nNeeds location constraint eu-central-1." }, { "Value": "ap-southeast-1", - "Help": "Asia Pacific (Singapore) Region.\nNeeds location constraint ap-southeast-1.", - "Provider": "" + "Help": "Asia Pacific (Singapore) Region.\nNeeds location constraint ap-southeast-1." }, { "Value": "ap-southeast-2", - "Help": "Asia Pacific (Sydney) Region.\nNeeds location constraint ap-southeast-2.", - "Provider": "" + "Help": "Asia Pacific (Sydney) Region.\nNeeds location constraint ap-southeast-2." }, { "Value": "ap-northeast-1", - "Help": "Asia Pacific (Tokyo) Region.\nNeeds location constraint ap-northeast-1.", - "Provider": "" + "Help": "Asia Pacific (Tokyo) Region.\nNeeds location constraint ap-northeast-1." }, { "Value": "ap-northeast-2", - "Help": "Asia Pacific (Seoul).\nNeeds location constraint ap-northeast-2.", - "Provider": "" + "Help": "Asia Pacific (Seoul).\nNeeds location constraint ap-northeast-2." }, { "Value": "ap-northeast-3", - "Help": "Asia Pacific (Osaka-Local).\nNeeds location constraint ap-northeast-3.", - "Provider": "" + "Help": "Asia Pacific (Osaka-Local).\nNeeds location constraint ap-northeast-3." }, { "Value": "ap-south-1", - "Help": "Asia Pacific (Mumbai).\nNeeds location constraint ap-south-1.", - "Provider": "" + "Help": "Asia Pacific (Mumbai).\nNeeds location constraint ap-south-1." }, { "Value": "ap-east-1", - "Help": "Asia Pacific (Hong Kong) Region.\nNeeds location constraint ap-east-1.", - "Provider": "" + "Help": "Asia Pacific (Hong Kong) Region.\nNeeds location constraint ap-east-1." }, { "Value": "sa-east-1", - "Help": "South America (Sao Paulo) Region.\nNeeds location constraint sa-east-1.", - "Provider": "" + "Help": "South America (Sao Paulo) Region.\nNeeds location constraint sa-east-1." + }, + { + "Value": "il-central-1", + "Help": "Israel (Tel Aviv) Region.\nNeeds location constraint il-central-1." }, { "Value": "me-south-1", - "Help": "Middle East (Bahrain) Region.\nNeeds location constraint me-south-1.", - "Provider": "" + "Help": "Middle East (Bahrain) Region.\nNeeds location constraint me-south-1." }, { "Value": "af-south-1", - "Help": "Africa (Cape Town) Region.\nNeeds location constraint af-south-1.", - "Provider": "" + "Help": "Africa (Cape Town) Region.\nNeeds location constraint af-south-1." }, { "Value": "cn-north-1", - "Help": "China (Beijing) Region.\nNeeds location constraint cn-north-1.", - "Provider": "" + "Help": "China (Beijing) Region.\nNeeds location constraint cn-north-1." }, { "Value": "cn-northwest-1", - "Help": "China (Ningxia) Region.\nNeeds location constraint cn-northwest-1.", - "Provider": "" + "Help": "China (Ningxia) Region.\nNeeds location constraint cn-northwest-1." }, { "Value": "us-gov-east-1", - "Help": "AWS GovCloud (US-East) Region.\nNeeds location constraint us-gov-east-1.", - "Provider": "" + "Help": "AWS GovCloud (US-East) Region.\nNeeds location constraint us-gov-east-1." }, { "Value": "us-gov-west-1", - "Help": "AWS GovCloud (US) Region.\nNeeds location constraint us-gov-west-1.", - "Provider": "" + "Help": "AWS GovCloud (US) Region.\nNeeds location constraint us-gov-west-1." } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -9951,6 +11813,7 @@ }, { "Name": "region", + "FieldName": "", "Help": "region - the location where your bucket will be created and your data stored.\n", "Provider": "RackCorp", "Default": "", @@ -9958,101 +11821,81 @@ "Examples": [ { "Value": "global", - "Help": "Global CDN (All locations) Region", - "Provider": "" + "Help": "Global CDN (All locations) Region" }, { "Value": "au", - "Help": "Australia (All states)", - "Provider": "" + "Help": "Australia (All states)" }, { "Value": "au-nsw", - "Help": "NSW (Australia) Region", - "Provider": "" + "Help": "NSW (Australia) Region" }, { "Value": "au-qld", - "Help": "QLD (Australia) Region", - "Provider": "" + "Help": "QLD (Australia) Region" }, { "Value": "au-vic", - "Help": "VIC (Australia) Region", - "Provider": "" + "Help": "VIC (Australia) Region" }, { "Value": "au-wa", - "Help": "Perth (Australia) Region", - "Provider": "" + "Help": "Perth (Australia) Region" }, { "Value": "ph", - "Help": "Manila (Philippines) Region", - "Provider": "" + "Help": "Manila (Philippines) Region" }, { "Value": "th", - "Help": "Bangkok (Thailand) Region", - "Provider": "" + "Help": "Bangkok (Thailand) Region" }, { "Value": "hk", - "Help": "HK (Hong Kong) Region", - "Provider": "" + "Help": "HK (Hong Kong) Region" }, { "Value": "mn", - "Help": "Ulaanbaatar (Mongolia) Region", - "Provider": "" + "Help": "Ulaanbaatar (Mongolia) Region" }, { "Value": "kg", - "Help": "Bishkek (Kyrgyzstan) Region", - "Provider": "" + "Help": "Bishkek (Kyrgyzstan) Region" }, { "Value": "id", - "Help": "Jakarta (Indonesia) Region", - "Provider": "" + "Help": "Jakarta (Indonesia) Region" }, { "Value": "jp", - "Help": "Tokyo (Japan) Region", - "Provider": "" + "Help": "Tokyo (Japan) Region" }, { "Value": "sg", - "Help": "SG (Singapore) Region", - "Provider": "" + "Help": "SG (Singapore) Region" }, { "Value": "de", - "Help": "Frankfurt (Germany) Region", - "Provider": "" + "Help": "Frankfurt (Germany) Region" }, { "Value": "us", - "Help": "USA (AnyCast) Region", - "Provider": "" + "Help": "USA (AnyCast) Region" }, { "Value": "us-east-1", - "Help": "New York (USA) Region", - "Provider": "" + "Help": "New York (USA) Region" }, { "Value": "us-west-1", - "Help": "Freemont (USA) Region", - "Provider": "" + "Help": "Freemont (USA) Region" }, { "Value": "nz", - "Help": "Auckland (New Zealand) Region", - "Provider": "" + "Help": "Auckland (New Zealand) Region" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -10066,6 +11909,7 @@ }, { "Name": "region", + "FieldName": "", "Help": "Region to connect to.", "Provider": "Scaleway", "Default": "", @@ -10073,21 +11917,17 @@ "Examples": [ { "Value": "nl-ams", - "Help": "Amsterdam, The Netherlands", - "Provider": "" + "Help": "Amsterdam, The Netherlands" }, { "Value": "fr-par", - "Help": "Paris, France", - "Provider": "" + "Help": "Paris, France" }, { "Value": "pl-waw", - "Help": "Warsaw, Poland", - "Provider": "" + "Help": "Warsaw, Poland" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -10101,6 +11941,7 @@ }, { "Name": "region", + "FieldName": "", "Help": "Region to connect to. - the location where your bucket will be created and your data stored. Need bo be same with your endpoint.\n", "Provider": "HuaweiOBS", "Default": "", @@ -10108,81 +11949,65 @@ "Examples": [ { "Value": "af-south-1", - "Help": "AF-Johannesburg", - "Provider": "" + "Help": "AF-Johannesburg" }, { "Value": "ap-southeast-2", - "Help": "AP-Bangkok", - "Provider": "" + "Help": "AP-Bangkok" }, { "Value": "ap-southeast-3", - "Help": "AP-Singapore", - "Provider": "" + "Help": "AP-Singapore" }, { "Value": "cn-east-3", - "Help": "CN East-Shanghai1", - "Provider": "" + "Help": "CN East-Shanghai1" }, { "Value": "cn-east-2", - "Help": "CN East-Shanghai2", - "Provider": "" + "Help": "CN East-Shanghai2" }, { "Value": "cn-north-1", - "Help": "CN North-Beijing1", - "Provider": "" + "Help": "CN North-Beijing1" }, { "Value": "cn-north-4", - "Help": "CN North-Beijing4", - "Provider": "" + "Help": "CN North-Beijing4" }, { "Value": "cn-south-1", - "Help": "CN South-Guangzhou", - "Provider": "" + "Help": "CN South-Guangzhou" }, { "Value": "ap-southeast-1", - "Help": "CN-Hong Kong", - "Provider": "" + "Help": "CN-Hong Kong" }, { "Value": "sa-argentina-1", - "Help": "LA-Buenos Aires1", - "Provider": "" + "Help": "LA-Buenos Aires1" }, { "Value": "sa-peru-1", - "Help": "LA-Lima1", - "Provider": "" + "Help": "LA-Lima1" }, { "Value": "na-mexico-1", - "Help": "LA-Mexico City1", - "Provider": "" + "Help": "LA-Mexico City1" }, { "Value": "sa-chile-1", - "Help": "LA-Santiago2", - "Provider": "" + "Help": "LA-Santiago2" }, { "Value": "sa-brazil-1", - "Help": "LA-Sao Paulo1", - "Provider": "" + "Help": "LA-Sao Paulo1" }, { "Value": "ru-northwest-2", - "Help": "RU-Moscow2", - "Provider": "" + "Help": "RU-Moscow2" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -10196,6 +12021,7 @@ }, { "Name": "region", + "FieldName": "", "Help": "Region to connect to.", "Provider": "Cloudflare", "Default": "", @@ -10203,11 +12029,9 @@ "Examples": [ { "Value": "auto", - "Help": "R2 buckets are automatically distributed across Cloudflare's data centers for low latency.", - "Provider": "" + "Help": "R2 buckets are automatically distributed across Cloudflare's data centers for low latency." } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -10221,6 +12045,7 @@ }, { "Name": "region", + "FieldName": "", "Help": "Region to connect to.", "Provider": "Qiniu", "Default": "", @@ -10228,41 +12053,33 @@ "Examples": [ { "Value": "cn-east-1", - "Help": "The default endpoint - a good choice if you are unsure.\nEast China Region 1.\nNeeds location constraint cn-east-1.", - "Provider": "" + "Help": "The default endpoint - a good choice if you are unsure.\nEast China Region 1.\nNeeds location constraint cn-east-1." }, { "Value": "cn-east-2", - "Help": "East China Region 2.\nNeeds location constraint cn-east-2.", - "Provider": "" + "Help": "East China Region 2.\nNeeds location constraint cn-east-2." }, { "Value": "cn-north-1", - "Help": "North China Region 1.\nNeeds location constraint cn-north-1.", - "Provider": "" + "Help": "North China Region 1.\nNeeds location constraint cn-north-1." }, { "Value": "cn-south-1", - "Help": "South China Region 1.\nNeeds location constraint cn-south-1.", - "Provider": "" + "Help": "South China Region 1.\nNeeds location constraint cn-south-1." }, { "Value": "us-north-1", - "Help": "North America Region.\nNeeds location constraint us-north-1.", - "Provider": "" + "Help": "North America Region.\nNeeds location constraint us-north-1." }, { "Value": "ap-southeast-1", - "Help": "Southeast Asia Region 1.\nNeeds location constraint ap-southeast-1.", - "Provider": "" + "Help": "Southeast Asia Region 1.\nNeeds location constraint ap-southeast-1." }, { "Value": "ap-northeast-1", - "Help": "Northeast Asia Region 1.\nNeeds location constraint ap-northeast-1.", - "Provider": "" + "Help": "Northeast Asia Region 1.\nNeeds location constraint ap-northeast-1." } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -10276,6 +12093,7 @@ }, { "Name": "region", + "FieldName": "", "Help": "Region where your bucket will be created and your data stored.\n", "Provider": "IONOS", "Default": "", @@ -10283,21 +12101,17 @@ "Examples": [ { "Value": "de", - "Help": "Frankfurt, Germany", - "Provider": "" + "Help": "Frankfurt, Germany" }, { "Value": "eu-central-2", - "Help": "Berlin, Germany", - "Provider": "" + "Help": "Berlin, Germany" }, { "Value": "eu-south-2", - "Help": "Logrono, Spain", - "Provider": "" + "Help": "Logrono, Spain" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -10311,6 +12125,7 @@ }, { "Name": "region", + "FieldName": "", "Help": "Region where your bucket will be created and your data stored.\n", "Provider": "Petabox", "Default": "", @@ -10318,31 +12133,25 @@ "Examples": [ { "Value": "us-east-1", - "Help": "US East (N. Virginia)", - "Provider": "" + "Help": "US East (N. Virginia)" }, { "Value": "eu-central-1", - "Help": "Europe (Frankfurt)", - "Provider": "" + "Help": "Europe (Frankfurt)" }, { "Value": "ap-southeast-1", - "Help": "Asia Pacific (Singapore)", - "Provider": "" + "Help": "Asia Pacific (Singapore)" }, { "Value": "me-south-1", - "Help": "Middle East (Bahrain)", - "Provider": "" + "Help": "Middle East (Bahrain)" }, { "Value": "sa-east-1", - "Help": "South America (São Paulo)", - "Provider": "" + "Help": "South America (São Paulo)" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -10356,6 +12165,7 @@ }, { "Name": "region", + "FieldName": "", "Help": "Region where your data stored.\n", "Provider": "Synology", "Default": "", @@ -10363,31 +12173,25 @@ "Examples": [ { "Value": "eu-001", - "Help": "Europe Region 1", - "Provider": "" + "Help": "Europe Region 1" }, { "Value": "eu-002", - "Help": "Europe Region 2", - "Provider": "" + "Help": "Europe Region 2" }, { "Value": "us-001", - "Help": "US Region 1", - "Provider": "" + "Help": "US Region 1" }, { "Value": "us-002", - "Help": "US Region 2", - "Provider": "" + "Help": "US Region 2" }, { "Value": "tw-001", - "Help": "Asia (Taiwan)", - "Provider": "" + "Help": "Asia (Taiwan)" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -10401,23 +12205,21 @@ }, { "Name": "region", + "FieldName": "", "Help": "Region to connect to.\n\nLeave blank if you are using an S3 clone and you don't have a region.", - "Provider": "!AWS,Alibaba,ArvanCloud,ChinaMobile,Cloudflare,IONOS,Petabox,Liara,Qiniu,RackCorp,Scaleway,Storj,Synology,TencentCOS,HuaweiOBS,IDrive", + "Provider": "!AWS,Alibaba,ArvanCloud,ChinaMobile,Cloudflare,IONOS,Petabox,Liara,Linode,Magalu,Qiniu,RackCorp,Scaleway,Storj,Synology,TencentCOS,HuaweiOBS,IDrive", "Default": "", "Value": null, "Examples": [ { "Value": "", - "Help": "Use this if unsure.\nWill use v4 signatures and an empty region.", - "Provider": "" + "Help": "Use this if unsure.\nWill use v4 signatures and an empty region." }, { "Value": "other-v2-signature", - "Help": "Use this only if v4 signatures don't work.\nE.g. pre Jewel/v10 CEPH.", - "Provider": "" + "Help": "Use this only if v4 signatures don't work.\nE.g. pre Jewel/v10 CEPH." } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -10431,11 +12233,11 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for S3 API.\n\nLeave blank if using AWS to use the default endpoint for the region.", "Provider": "AWS", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -10449,6 +12251,7 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for China Mobile Ecloud Elastic Object Storage (EOS) API.", "Provider": "ChinaMobile", "Default": "", @@ -10456,156 +12259,125 @@ "Examples": [ { "Value": "eos-wuxi-1.cmecloud.cn", - "Help": "The default endpoint - a good choice if you are unsure.\nEast China (Suzhou)", - "Provider": "" + "Help": "The default endpoint - a good choice if you are unsure.\nEast China (Suzhou)" }, { "Value": "eos-jinan-1.cmecloud.cn", - "Help": "East China (Jinan)", - "Provider": "" + "Help": "East China (Jinan)" }, { "Value": "eos-ningbo-1.cmecloud.cn", - "Help": "East China (Hangzhou)", - "Provider": "" + "Help": "East China (Hangzhou)" }, { "Value": "eos-shanghai-1.cmecloud.cn", - "Help": "East China (Shanghai-1)", - "Provider": "" + "Help": "East China (Shanghai-1)" }, { "Value": "eos-zhengzhou-1.cmecloud.cn", - "Help": "Central China (Zhengzhou)", - "Provider": "" + "Help": "Central China (Zhengzhou)" }, { "Value": "eos-hunan-1.cmecloud.cn", - "Help": "Central China (Changsha-1)", - "Provider": "" + "Help": "Central China (Changsha-1)" }, { "Value": "eos-zhuzhou-1.cmecloud.cn", - "Help": "Central China (Changsha-2)", - "Provider": "" + "Help": "Central China (Changsha-2)" }, { "Value": "eos-guangzhou-1.cmecloud.cn", - "Help": "South China (Guangzhou-2)", - "Provider": "" + "Help": "South China (Guangzhou-2)" }, { "Value": "eos-dongguan-1.cmecloud.cn", - "Help": "South China (Guangzhou-3)", - "Provider": "" + "Help": "South China (Guangzhou-3)" }, { "Value": "eos-beijing-1.cmecloud.cn", - "Help": "North China (Beijing-1)", - "Provider": "" + "Help": "North China (Beijing-1)" }, { "Value": "eos-beijing-2.cmecloud.cn", - "Help": "North China (Beijing-2)", - "Provider": "" + "Help": "North China (Beijing-2)" }, { "Value": "eos-beijing-4.cmecloud.cn", - "Help": "North China (Beijing-3)", - "Provider": "" + "Help": "North China (Beijing-3)" }, { "Value": "eos-huhehaote-1.cmecloud.cn", - "Help": "North China (Huhehaote)", - "Provider": "" + "Help": "North China (Huhehaote)" }, { "Value": "eos-chengdu-1.cmecloud.cn", - "Help": "Southwest China (Chengdu)", - "Provider": "" + "Help": "Southwest China (Chengdu)" }, { "Value": "eos-chongqing-1.cmecloud.cn", - "Help": "Southwest China (Chongqing)", - "Provider": "" + "Help": "Southwest China (Chongqing)" }, { "Value": "eos-guiyang-1.cmecloud.cn", - "Help": "Southwest China (Guiyang)", - "Provider": "" + "Help": "Southwest China (Guiyang)" }, { "Value": "eos-xian-1.cmecloud.cn", - "Help": "Nouthwest China (Xian)", - "Provider": "" + "Help": "Nouthwest China (Xian)" }, { "Value": "eos-yunnan.cmecloud.cn", - "Help": "Yunnan China (Kunming)", - "Provider": "" + "Help": "Yunnan China (Kunming)" }, { "Value": "eos-yunnan-2.cmecloud.cn", - "Help": "Yunnan China (Kunming-2)", - "Provider": "" + "Help": "Yunnan China (Kunming-2)" }, { "Value": "eos-tianjin-1.cmecloud.cn", - "Help": "Tianjin China (Tianjin)", - "Provider": "" + "Help": "Tianjin China (Tianjin)" }, { "Value": "eos-jilin-1.cmecloud.cn", - "Help": "Jilin China (Changchun)", - "Provider": "" + "Help": "Jilin China (Changchun)" }, { "Value": "eos-hubei-1.cmecloud.cn", - "Help": "Hubei China (Xiangyan)", - "Provider": "" + "Help": "Hubei China (Xiangyan)" }, { "Value": "eos-jiangxi-1.cmecloud.cn", - "Help": "Jiangxi China (Nanchang)", - "Provider": "" + "Help": "Jiangxi China (Nanchang)" }, { "Value": "eos-gansu-1.cmecloud.cn", - "Help": "Gansu China (Lanzhou)", - "Provider": "" + "Help": "Gansu China (Lanzhou)" }, { "Value": "eos-shanxi-1.cmecloud.cn", - "Help": "Shanxi China (Taiyuan)", - "Provider": "" + "Help": "Shanxi China (Taiyuan)" }, { "Value": "eos-liaoning-1.cmecloud.cn", - "Help": "Liaoning China (Shenyang)", - "Provider": "" + "Help": "Liaoning China (Shenyang)" }, { "Value": "eos-hebei-1.cmecloud.cn", - "Help": "Hebei China (Shijiazhuang)", - "Provider": "" + "Help": "Hebei China (Shijiazhuang)" }, { "Value": "eos-fujian-1.cmecloud.cn", - "Help": "Fujian China (Xiamen)", - "Provider": "" + "Help": "Fujian China (Xiamen)" }, { "Value": "eos-guangxi-1.cmecloud.cn", - "Help": "Guangxi China (Nanning)", - "Provider": "" + "Help": "Guangxi China (Nanning)" }, { "Value": "eos-anhui-1.cmecloud.cn", - "Help": "Anhui China (Huainan)", - "Provider": "" + "Help": "Anhui China (Huainan)" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -10619,6 +12391,7 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for Arvan Cloud Object Storage (AOS) API.", "Provider": "ArvanCloud", "Default": "", @@ -10626,16 +12399,13 @@ "Examples": [ { "Value": "s3.ir-thr-at1.arvanstorage.ir", - "Help": "The default endpoint - a good choice if you are unsure.\nTehran Iran (Simin)", - "Provider": "" + "Help": "The default endpoint - a good choice if you are unsure.\nTehran Iran (Simin)" }, { "Value": "s3.ir-tbz-sh1.arvanstorage.ir", - "Help": "Tabriz Iran (Shahriar)", - "Provider": "" + "Help": "Tabriz Iran (Shahriar)" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -10649,6 +12419,7 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for IBM COS S3 API.\n\nSpecify if using an IBM COS On Premise.", "Provider": "IBMCOS", "Default": "", @@ -10656,316 +12427,253 @@ "Examples": [ { "Value": "s3.us.cloud-object-storage.appdomain.cloud", - "Help": "US Cross Region Endpoint", - "Provider": "" + "Help": "US Cross Region Endpoint" }, { "Value": "s3.dal.us.cloud-object-storage.appdomain.cloud", - "Help": "US Cross Region Dallas Endpoint", - "Provider": "" + "Help": "US Cross Region Dallas Endpoint" }, { "Value": "s3.wdc.us.cloud-object-storage.appdomain.cloud", - "Help": "US Cross Region Washington DC Endpoint", - "Provider": "" + "Help": "US Cross Region Washington DC Endpoint" }, { "Value": "s3.sjc.us.cloud-object-storage.appdomain.cloud", - "Help": "US Cross Region San Jose Endpoint", - "Provider": "" + "Help": "US Cross Region San Jose Endpoint" }, { "Value": "s3.private.us.cloud-object-storage.appdomain.cloud", - "Help": "US Cross Region Private Endpoint", - "Provider": "" + "Help": "US Cross Region Private Endpoint" }, { "Value": "s3.private.dal.us.cloud-object-storage.appdomain.cloud", - "Help": "US Cross Region Dallas Private Endpoint", - "Provider": "" + "Help": "US Cross Region Dallas Private Endpoint" }, { "Value": "s3.private.wdc.us.cloud-object-storage.appdomain.cloud", - "Help": "US Cross Region Washington DC Private Endpoint", - "Provider": "" + "Help": "US Cross Region Washington DC Private Endpoint" }, { "Value": "s3.private.sjc.us.cloud-object-storage.appdomain.cloud", - "Help": "US Cross Region San Jose Private Endpoint", - "Provider": "" + "Help": "US Cross Region San Jose Private Endpoint" }, { "Value": "s3.us-east.cloud-object-storage.appdomain.cloud", - "Help": "US Region East Endpoint", - "Provider": "" + "Help": "US Region East Endpoint" }, { "Value": "s3.private.us-east.cloud-object-storage.appdomain.cloud", - "Help": "US Region East Private Endpoint", - "Provider": "" + "Help": "US Region East Private Endpoint" }, { "Value": "s3.us-south.cloud-object-storage.appdomain.cloud", - "Help": "US Region South Endpoint", - "Provider": "" + "Help": "US Region South Endpoint" }, { "Value": "s3.private.us-south.cloud-object-storage.appdomain.cloud", - "Help": "US Region South Private Endpoint", - "Provider": "" + "Help": "US Region South Private Endpoint" }, { "Value": "s3.eu.cloud-object-storage.appdomain.cloud", - "Help": "EU Cross Region Endpoint", - "Provider": "" + "Help": "EU Cross Region Endpoint" }, { "Value": "s3.fra.eu.cloud-object-storage.appdomain.cloud", - "Help": "EU Cross Region Frankfurt Endpoint", - "Provider": "" + "Help": "EU Cross Region Frankfurt Endpoint" }, { "Value": "s3.mil.eu.cloud-object-storage.appdomain.cloud", - "Help": "EU Cross Region Milan Endpoint", - "Provider": "" + "Help": "EU Cross Region Milan Endpoint" }, { "Value": "s3.ams.eu.cloud-object-storage.appdomain.cloud", - "Help": "EU Cross Region Amsterdam Endpoint", - "Provider": "" + "Help": "EU Cross Region Amsterdam Endpoint" }, { "Value": "s3.private.eu.cloud-object-storage.appdomain.cloud", - "Help": "EU Cross Region Private Endpoint", - "Provider": "" + "Help": "EU Cross Region Private Endpoint" }, { "Value": "s3.private.fra.eu.cloud-object-storage.appdomain.cloud", - "Help": "EU Cross Region Frankfurt Private Endpoint", - "Provider": "" + "Help": "EU Cross Region Frankfurt Private Endpoint" }, { "Value": "s3.private.mil.eu.cloud-object-storage.appdomain.cloud", - "Help": "EU Cross Region Milan Private Endpoint", - "Provider": "" + "Help": "EU Cross Region Milan Private Endpoint" }, { "Value": "s3.private.ams.eu.cloud-object-storage.appdomain.cloud", - "Help": "EU Cross Region Amsterdam Private Endpoint", - "Provider": "" + "Help": "EU Cross Region Amsterdam Private Endpoint" }, { "Value": "s3.eu-gb.cloud-object-storage.appdomain.cloud", - "Help": "Great Britain Endpoint", - "Provider": "" + "Help": "Great Britain Endpoint" }, { "Value": "s3.private.eu-gb.cloud-object-storage.appdomain.cloud", - "Help": "Great Britain Private Endpoint", - "Provider": "" + "Help": "Great Britain Private Endpoint" }, { "Value": "s3.eu-de.cloud-object-storage.appdomain.cloud", - "Help": "EU Region DE Endpoint", - "Provider": "" + "Help": "EU Region DE Endpoint" }, { "Value": "s3.private.eu-de.cloud-object-storage.appdomain.cloud", - "Help": "EU Region DE Private Endpoint", - "Provider": "" + "Help": "EU Region DE Private Endpoint" }, { "Value": "s3.ap.cloud-object-storage.appdomain.cloud", - "Help": "APAC Cross Regional Endpoint", - "Provider": "" + "Help": "APAC Cross Regional Endpoint" }, { "Value": "s3.tok.ap.cloud-object-storage.appdomain.cloud", - "Help": "APAC Cross Regional Tokyo Endpoint", - "Provider": "" + "Help": "APAC Cross Regional Tokyo Endpoint" }, { "Value": "s3.hkg.ap.cloud-object-storage.appdomain.cloud", - "Help": "APAC Cross Regional HongKong Endpoint", - "Provider": "" + "Help": "APAC Cross Regional HongKong Endpoint" }, { "Value": "s3.seo.ap.cloud-object-storage.appdomain.cloud", - "Help": "APAC Cross Regional Seoul Endpoint", - "Provider": "" + "Help": "APAC Cross Regional Seoul Endpoint" }, { "Value": "s3.private.ap.cloud-object-storage.appdomain.cloud", - "Help": "APAC Cross Regional Private Endpoint", - "Provider": "" + "Help": "APAC Cross Regional Private Endpoint" }, { "Value": "s3.private.tok.ap.cloud-object-storage.appdomain.cloud", - "Help": "APAC Cross Regional Tokyo Private Endpoint", - "Provider": "" + "Help": "APAC Cross Regional Tokyo Private Endpoint" }, { "Value": "s3.private.hkg.ap.cloud-object-storage.appdomain.cloud", - "Help": "APAC Cross Regional HongKong Private Endpoint", - "Provider": "" + "Help": "APAC Cross Regional HongKong Private Endpoint" }, { "Value": "s3.private.seo.ap.cloud-object-storage.appdomain.cloud", - "Help": "APAC Cross Regional Seoul Private Endpoint", - "Provider": "" + "Help": "APAC Cross Regional Seoul Private Endpoint" }, { "Value": "s3.jp-tok.cloud-object-storage.appdomain.cloud", - "Help": "APAC Region Japan Endpoint", - "Provider": "" + "Help": "APAC Region Japan Endpoint" }, { "Value": "s3.private.jp-tok.cloud-object-storage.appdomain.cloud", - "Help": "APAC Region Japan Private Endpoint", - "Provider": "" + "Help": "APAC Region Japan Private Endpoint" }, { "Value": "s3.au-syd.cloud-object-storage.appdomain.cloud", - "Help": "APAC Region Australia Endpoint", - "Provider": "" + "Help": "APAC Region Australia Endpoint" }, { "Value": "s3.private.au-syd.cloud-object-storage.appdomain.cloud", - "Help": "APAC Region Australia Private Endpoint", - "Provider": "" + "Help": "APAC Region Australia Private Endpoint" }, { "Value": "s3.ams03.cloud-object-storage.appdomain.cloud", - "Help": "Amsterdam Single Site Endpoint", - "Provider": "" + "Help": "Amsterdam Single Site Endpoint" }, { "Value": "s3.private.ams03.cloud-object-storage.appdomain.cloud", - "Help": "Amsterdam Single Site Private Endpoint", - "Provider": "" + "Help": "Amsterdam Single Site Private Endpoint" }, { "Value": "s3.che01.cloud-object-storage.appdomain.cloud", - "Help": "Chennai Single Site Endpoint", - "Provider": "" + "Help": "Chennai Single Site Endpoint" }, { "Value": "s3.private.che01.cloud-object-storage.appdomain.cloud", - "Help": "Chennai Single Site Private Endpoint", - "Provider": "" + "Help": "Chennai Single Site Private Endpoint" }, { "Value": "s3.mel01.cloud-object-storage.appdomain.cloud", - "Help": "Melbourne Single Site Endpoint", - "Provider": "" + "Help": "Melbourne Single Site Endpoint" }, { "Value": "s3.private.mel01.cloud-object-storage.appdomain.cloud", - "Help": "Melbourne Single Site Private Endpoint", - "Provider": "" + "Help": "Melbourne Single Site Private Endpoint" }, { "Value": "s3.osl01.cloud-object-storage.appdomain.cloud", - "Help": "Oslo Single Site Endpoint", - "Provider": "" + "Help": "Oslo Single Site Endpoint" }, { "Value": "s3.private.osl01.cloud-object-storage.appdomain.cloud", - "Help": "Oslo Single Site Private Endpoint", - "Provider": "" + "Help": "Oslo Single Site Private Endpoint" }, { "Value": "s3.tor01.cloud-object-storage.appdomain.cloud", - "Help": "Toronto Single Site Endpoint", - "Provider": "" + "Help": "Toronto Single Site Endpoint" }, { "Value": "s3.private.tor01.cloud-object-storage.appdomain.cloud", - "Help": "Toronto Single Site Private Endpoint", - "Provider": "" + "Help": "Toronto Single Site Private Endpoint" }, { "Value": "s3.seo01.cloud-object-storage.appdomain.cloud", - "Help": "Seoul Single Site Endpoint", - "Provider": "" + "Help": "Seoul Single Site Endpoint" }, { "Value": "s3.private.seo01.cloud-object-storage.appdomain.cloud", - "Help": "Seoul Single Site Private Endpoint", - "Provider": "" + "Help": "Seoul Single Site Private Endpoint" }, { "Value": "s3.mon01.cloud-object-storage.appdomain.cloud", - "Help": "Montreal Single Site Endpoint", - "Provider": "" + "Help": "Montreal Single Site Endpoint" }, { "Value": "s3.private.mon01.cloud-object-storage.appdomain.cloud", - "Help": "Montreal Single Site Private Endpoint", - "Provider": "" + "Help": "Montreal Single Site Private Endpoint" }, { "Value": "s3.mex01.cloud-object-storage.appdomain.cloud", - "Help": "Mexico Single Site Endpoint", - "Provider": "" + "Help": "Mexico Single Site Endpoint" }, { "Value": "s3.private.mex01.cloud-object-storage.appdomain.cloud", - "Help": "Mexico Single Site Private Endpoint", - "Provider": "" + "Help": "Mexico Single Site Private Endpoint" }, { "Value": "s3.sjc04.cloud-object-storage.appdomain.cloud", - "Help": "San Jose Single Site Endpoint", - "Provider": "" + "Help": "San Jose Single Site Endpoint" }, { "Value": "s3.private.sjc04.cloud-object-storage.appdomain.cloud", - "Help": "San Jose Single Site Private Endpoint", - "Provider": "" + "Help": "San Jose Single Site Private Endpoint" }, { "Value": "s3.mil01.cloud-object-storage.appdomain.cloud", - "Help": "Milan Single Site Endpoint", - "Provider": "" + "Help": "Milan Single Site Endpoint" }, { "Value": "s3.private.mil01.cloud-object-storage.appdomain.cloud", - "Help": "Milan Single Site Private Endpoint", - "Provider": "" + "Help": "Milan Single Site Private Endpoint" }, { "Value": "s3.hkg02.cloud-object-storage.appdomain.cloud", - "Help": "Hong Kong Single Site Endpoint", - "Provider": "" + "Help": "Hong Kong Single Site Endpoint" }, { "Value": "s3.private.hkg02.cloud-object-storage.appdomain.cloud", - "Help": "Hong Kong Single Site Private Endpoint", - "Provider": "" + "Help": "Hong Kong Single Site Private Endpoint" }, { "Value": "s3.par01.cloud-object-storage.appdomain.cloud", - "Help": "Paris Single Site Endpoint", - "Provider": "" + "Help": "Paris Single Site Endpoint" }, { "Value": "s3.private.par01.cloud-object-storage.appdomain.cloud", - "Help": "Paris Single Site Private Endpoint", - "Provider": "" + "Help": "Paris Single Site Private Endpoint" }, { "Value": "s3.sng01.cloud-object-storage.appdomain.cloud", - "Help": "Singapore Single Site Endpoint", - "Provider": "" + "Help": "Singapore Single Site Endpoint" }, { "Value": "s3.private.sng01.cloud-object-storage.appdomain.cloud", - "Help": "Singapore Single Site Private Endpoint", - "Provider": "" + "Help": "Singapore Single Site Private Endpoint" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -10979,6 +12687,7 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for IONOS S3 Object Storage.\n\nSpecify the endpoint from the same region.", "Provider": "IONOS", "Default": "", @@ -10986,21 +12695,17 @@ "Examples": [ { "Value": "s3-eu-central-1.ionoscloud.com", - "Help": "Frankfurt, Germany", - "Provider": "" + "Help": "Frankfurt, Germany" }, { "Value": "s3-eu-central-2.ionoscloud.com", - "Help": "Berlin, Germany", - "Provider": "" + "Help": "Berlin, Germany" }, { "Value": "s3-eu-south-2.ionoscloud.com", - "Help": "Logrono, Spain", - "Provider": "" + "Help": "Logrono, Spain" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -11014,6 +12719,7 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for Petabox S3 Object Storage.\n\nSpecify the endpoint from the same region.", "Provider": "Petabox", "Default": "", @@ -11021,36 +12727,29 @@ "Examples": [ { "Value": "s3.petabox.io", - "Help": "US East (N. Virginia)", - "Provider": "" + "Help": "US East (N. Virginia)" }, { "Value": "s3.us-east-1.petabox.io", - "Help": "US East (N. Virginia)", - "Provider": "" + "Help": "US East (N. Virginia)" }, { "Value": "s3.eu-central-1.petabox.io", - "Help": "Europe (Frankfurt)", - "Provider": "" + "Help": "Europe (Frankfurt)" }, { "Value": "s3.ap-southeast-1.petabox.io", - "Help": "Asia Pacific (Singapore)", - "Provider": "" + "Help": "Asia Pacific (Singapore)" }, { "Value": "s3.me-south-1.petabox.io", - "Help": "Middle East (Bahrain)", - "Provider": "" + "Help": "Middle East (Bahrain)" }, { "Value": "s3.sa-east-1.petabox.io", - "Help": "South America (São Paulo)", - "Provider": "" + "Help": "South America (São Paulo)" } ], - "ShortOpt": "", "Hide": 0, "Required": true, "IsPassword": false, @@ -11064,6 +12763,7 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for Leviia Object Storage API.", "Provider": "Leviia", "Default": "", @@ -11071,11 +12771,9 @@ "Examples": [ { "Value": "s3.leviia.com", - "Help": "The default endpoint\nLeviia", - "Provider": "" + "Help": "The default endpoint\nLeviia" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -11089,6 +12787,7 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for Liara Object Storage API.", "Provider": "Liara", "Default": "", @@ -11096,11 +12795,9 @@ "Examples": [ { "Value": "storage.iran.liara.space", - "Help": "The default endpoint\nIran", - "Provider": "" + "Help": "The default endpoint\nIran" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -11114,6 +12811,95 @@ }, { "Name": "endpoint", + "FieldName": "", + "Help": "Endpoint for Linode Object Storage API.", + "Provider": "Linode", + "Default": "", + "Value": null, + "Examples": [ + { + "Value": "us-southeast-1.linodeobjects.com", + "Help": "Atlanta, GA (USA), us-southeast-1" + }, + { + "Value": "us-ord-1.linodeobjects.com", + "Help": "Chicago, IL (USA), us-ord-1" + }, + { + "Value": "eu-central-1.linodeobjects.com", + "Help": "Frankfurt (Germany), eu-central-1" + }, + { + "Value": "it-mil-1.linodeobjects.com", + "Help": "Milan (Italy), it-mil-1" + }, + { + "Value": "us-east-1.linodeobjects.com", + "Help": "Newark, NJ (USA), us-east-1" + }, + { + "Value": "fr-par-1.linodeobjects.com", + "Help": "Paris (France), fr-par-1" + }, + { + "Value": "us-sea-1.linodeobjects.com", + "Help": "Seattle, WA (USA), us-sea-1" + }, + { + "Value": "ap-south-1.linodeobjects.com", + "Help": "Singapore ap-south-1" + }, + { + "Value": "se-sto-1.linodeobjects.com", + "Help": "Stockholm (Sweden), se-sto-1" + }, + { + "Value": "us-iad-1.linodeobjects.com", + "Help": "Washington, DC, (USA), us-iad-1" + } + ], + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "endpoint", + "FieldName": "", + "Help": "Endpoint for Magalu Object Storage API.", + "Provider": "Magalu", + "Default": "", + "Value": null, + "Examples": [ + { + "Value": "br-se1.magaluobjects.com", + "Help": "São Paulo, SP (BR), br-se1" + }, + { + "Value": "br-ne1.magaluobjects.com", + "Help": "Fortaleza, CE (BR), br-ne1" + } + ], + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for OSS API.", "Provider": "Alibaba", "Default": "", @@ -11121,131 +12907,105 @@ "Examples": [ { "Value": "oss-accelerate.aliyuncs.com", - "Help": "Global Accelerate", - "Provider": "" + "Help": "Global Accelerate" }, { "Value": "oss-accelerate-overseas.aliyuncs.com", - "Help": "Global Accelerate (outside mainland China)", - "Provider": "" + "Help": "Global Accelerate (outside mainland China)" }, { "Value": "oss-cn-hangzhou.aliyuncs.com", - "Help": "East China 1 (Hangzhou)", - "Provider": "" + "Help": "East China 1 (Hangzhou)" }, { "Value": "oss-cn-shanghai.aliyuncs.com", - "Help": "East China 2 (Shanghai)", - "Provider": "" + "Help": "East China 2 (Shanghai)" }, { "Value": "oss-cn-qingdao.aliyuncs.com", - "Help": "North China 1 (Qingdao)", - "Provider": "" + "Help": "North China 1 (Qingdao)" }, { "Value": "oss-cn-beijing.aliyuncs.com", - "Help": "North China 2 (Beijing)", - "Provider": "" + "Help": "North China 2 (Beijing)" }, { "Value": "oss-cn-zhangjiakou.aliyuncs.com", - "Help": "North China 3 (Zhangjiakou)", - "Provider": "" + "Help": "North China 3 (Zhangjiakou)" }, { "Value": "oss-cn-huhehaote.aliyuncs.com", - "Help": "North China 5 (Hohhot)", - "Provider": "" + "Help": "North China 5 (Hohhot)" }, { "Value": "oss-cn-wulanchabu.aliyuncs.com", - "Help": "North China 6 (Ulanqab)", - "Provider": "" + "Help": "North China 6 (Ulanqab)" }, { "Value": "oss-cn-shenzhen.aliyuncs.com", - "Help": "South China 1 (Shenzhen)", - "Provider": "" + "Help": "South China 1 (Shenzhen)" }, { "Value": "oss-cn-heyuan.aliyuncs.com", - "Help": "South China 2 (Heyuan)", - "Provider": "" + "Help": "South China 2 (Heyuan)" }, { "Value": "oss-cn-guangzhou.aliyuncs.com", - "Help": "South China 3 (Guangzhou)", - "Provider": "" + "Help": "South China 3 (Guangzhou)" }, { "Value": "oss-cn-chengdu.aliyuncs.com", - "Help": "West China 1 (Chengdu)", - "Provider": "" + "Help": "West China 1 (Chengdu)" }, { "Value": "oss-cn-hongkong.aliyuncs.com", - "Help": "Hong Kong (Hong Kong)", - "Provider": "" + "Help": "Hong Kong (Hong Kong)" }, { "Value": "oss-us-west-1.aliyuncs.com", - "Help": "US West 1 (Silicon Valley)", - "Provider": "" + "Help": "US West 1 (Silicon Valley)" }, { "Value": "oss-us-east-1.aliyuncs.com", - "Help": "US East 1 (Virginia)", - "Provider": "" + "Help": "US East 1 (Virginia)" }, { "Value": "oss-ap-southeast-1.aliyuncs.com", - "Help": "Southeast Asia Southeast 1 (Singapore)", - "Provider": "" + "Help": "Southeast Asia Southeast 1 (Singapore)" }, { "Value": "oss-ap-southeast-2.aliyuncs.com", - "Help": "Asia Pacific Southeast 2 (Sydney)", - "Provider": "" + "Help": "Asia Pacific Southeast 2 (Sydney)" }, { "Value": "oss-ap-southeast-3.aliyuncs.com", - "Help": "Southeast Asia Southeast 3 (Kuala Lumpur)", - "Provider": "" + "Help": "Southeast Asia Southeast 3 (Kuala Lumpur)" }, { "Value": "oss-ap-southeast-5.aliyuncs.com", - "Help": "Asia Pacific Southeast 5 (Jakarta)", - "Provider": "" + "Help": "Asia Pacific Southeast 5 (Jakarta)" }, { "Value": "oss-ap-northeast-1.aliyuncs.com", - "Help": "Asia Pacific Northeast 1 (Japan)", - "Provider": "" + "Help": "Asia Pacific Northeast 1 (Japan)" }, { "Value": "oss-ap-south-1.aliyuncs.com", - "Help": "Asia Pacific South 1 (Mumbai)", - "Provider": "" + "Help": "Asia Pacific South 1 (Mumbai)" }, { "Value": "oss-eu-central-1.aliyuncs.com", - "Help": "Central Europe 1 (Frankfurt)", - "Provider": "" + "Help": "Central Europe 1 (Frankfurt)" }, { "Value": "oss-eu-west-1.aliyuncs.com", - "Help": "West Europe (London)", - "Provider": "" + "Help": "West Europe (London)" }, { "Value": "oss-me-east-1.aliyuncs.com", - "Help": "Middle East 1 (Dubai)", - "Provider": "" + "Help": "Middle East 1 (Dubai)" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -11259,6 +13019,7 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for OBS API.", "Provider": "HuaweiOBS", "Default": "", @@ -11266,81 +13027,65 @@ "Examples": [ { "Value": "obs.af-south-1.myhuaweicloud.com", - "Help": "AF-Johannesburg", - "Provider": "" + "Help": "AF-Johannesburg" }, { "Value": "obs.ap-southeast-2.myhuaweicloud.com", - "Help": "AP-Bangkok", - "Provider": "" + "Help": "AP-Bangkok" }, { "Value": "obs.ap-southeast-3.myhuaweicloud.com", - "Help": "AP-Singapore", - "Provider": "" + "Help": "AP-Singapore" }, { "Value": "obs.cn-east-3.myhuaweicloud.com", - "Help": "CN East-Shanghai1", - "Provider": "" + "Help": "CN East-Shanghai1" }, { "Value": "obs.cn-east-2.myhuaweicloud.com", - "Help": "CN East-Shanghai2", - "Provider": "" + "Help": "CN East-Shanghai2" }, { "Value": "obs.cn-north-1.myhuaweicloud.com", - "Help": "CN North-Beijing1", - "Provider": "" + "Help": "CN North-Beijing1" }, { "Value": "obs.cn-north-4.myhuaweicloud.com", - "Help": "CN North-Beijing4", - "Provider": "" + "Help": "CN North-Beijing4" }, { "Value": "obs.cn-south-1.myhuaweicloud.com", - "Help": "CN South-Guangzhou", - "Provider": "" + "Help": "CN South-Guangzhou" }, { "Value": "obs.ap-southeast-1.myhuaweicloud.com", - "Help": "CN-Hong Kong", - "Provider": "" + "Help": "CN-Hong Kong" }, { "Value": "obs.sa-argentina-1.myhuaweicloud.com", - "Help": "LA-Buenos Aires1", - "Provider": "" + "Help": "LA-Buenos Aires1" }, { "Value": "obs.sa-peru-1.myhuaweicloud.com", - "Help": "LA-Lima1", - "Provider": "" + "Help": "LA-Lima1" }, { "Value": "obs.na-mexico-1.myhuaweicloud.com", - "Help": "LA-Mexico City1", - "Provider": "" + "Help": "LA-Mexico City1" }, { "Value": "obs.sa-chile-1.myhuaweicloud.com", - "Help": "LA-Santiago2", - "Provider": "" + "Help": "LA-Santiago2" }, { "Value": "obs.sa-brazil-1.myhuaweicloud.com", - "Help": "LA-Sao Paulo1", - "Provider": "" + "Help": "LA-Sao Paulo1" }, { "Value": "obs.ru-northwest-2.myhuaweicloud.com", - "Help": "RU-Moscow2", - "Provider": "" + "Help": "RU-Moscow2" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -11354,6 +13099,7 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for Scaleway Object Storage.", "Provider": "Scaleway", "Default": "", @@ -11361,21 +13107,17 @@ "Examples": [ { "Value": "s3.nl-ams.scw.cloud", - "Help": "Amsterdam Endpoint", - "Provider": "" + "Help": "Amsterdam Endpoint" }, { "Value": "s3.fr-par.scw.cloud", - "Help": "Paris Endpoint", - "Provider": "" + "Help": "Paris Endpoint" }, { "Value": "s3.pl-waw.scw.cloud", - "Help": "Warsaw Endpoint", - "Provider": "" + "Help": "Warsaw Endpoint" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -11389,6 +13131,7 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for StackPath Object Storage.", "Provider": "StackPath", "Default": "", @@ -11396,21 +13139,17 @@ "Examples": [ { "Value": "s3.us-east-2.stackpathstorage.com", - "Help": "US East Endpoint", - "Provider": "" + "Help": "US East Endpoint" }, { "Value": "s3.us-west-1.stackpathstorage.com", - "Help": "US West Endpoint", - "Provider": "" + "Help": "US West Endpoint" }, { "Value": "s3.eu-central-1.stackpathstorage.com", - "Help": "EU Endpoint", - "Provider": "" + "Help": "EU Endpoint" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -11424,6 +13163,7 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for Google Cloud Storage.", "Provider": "GCS", "Default": "", @@ -11431,11 +13171,9 @@ "Examples": [ { "Value": "https://storage.googleapis.com", - "Help": "Google Cloud Storage endpoint", - "Provider": "" + "Help": "Google Cloud Storage endpoint" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -11449,6 +13187,7 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for Storj Gateway.", "Provider": "Storj", "Default": "", @@ -11456,11 +13195,9 @@ "Examples": [ { "Value": "gateway.storjshare.io", - "Help": "Global Hosted Gateway", - "Provider": "" + "Help": "Global Hosted Gateway" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -11474,6 +13211,7 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for Synology C2 Object Storage API.", "Provider": "Synology", "Default": "", @@ -11481,31 +13219,25 @@ "Examples": [ { "Value": "eu-001.s3.synologyc2.net", - "Help": "EU Endpoint 1", - "Provider": "" + "Help": "EU Endpoint 1" }, { "Value": "eu-002.s3.synologyc2.net", - "Help": "EU Endpoint 2", - "Provider": "" + "Help": "EU Endpoint 2" }, { "Value": "us-001.s3.synologyc2.net", - "Help": "US Endpoint 1", - "Provider": "" + "Help": "US Endpoint 1" }, { "Value": "us-002.s3.synologyc2.net", - "Help": "US Endpoint 2", - "Provider": "" + "Help": "US Endpoint 2" }, { "Value": "tw-001.s3.synologyc2.net", - "Help": "TW Endpoint 1", - "Provider": "" + "Help": "TW Endpoint 1" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -11519,6 +13251,7 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for Tencent COS API.", "Provider": "TencentCOS", "Default": "", @@ -11526,101 +13259,81 @@ "Examples": [ { "Value": "cos.ap-beijing.myqcloud.com", - "Help": "Beijing Region", - "Provider": "" + "Help": "Beijing Region" }, { "Value": "cos.ap-nanjing.myqcloud.com", - "Help": "Nanjing Region", - "Provider": "" + "Help": "Nanjing Region" }, { "Value": "cos.ap-shanghai.myqcloud.com", - "Help": "Shanghai Region", - "Provider": "" + "Help": "Shanghai Region" }, { "Value": "cos.ap-guangzhou.myqcloud.com", - "Help": "Guangzhou Region", - "Provider": "" + "Help": "Guangzhou Region" }, { "Value": "cos.ap-nanjing.myqcloud.com", - "Help": "Nanjing Region", - "Provider": "" + "Help": "Nanjing Region" }, { "Value": "cos.ap-chengdu.myqcloud.com", - "Help": "Chengdu Region", - "Provider": "" + "Help": "Chengdu Region" }, { "Value": "cos.ap-chongqing.myqcloud.com", - "Help": "Chongqing Region", - "Provider": "" + "Help": "Chongqing Region" }, { "Value": "cos.ap-hongkong.myqcloud.com", - "Help": "Hong Kong (China) Region", - "Provider": "" + "Help": "Hong Kong (China) Region" }, { "Value": "cos.ap-singapore.myqcloud.com", - "Help": "Singapore Region", - "Provider": "" + "Help": "Singapore Region" }, { "Value": "cos.ap-mumbai.myqcloud.com", - "Help": "Mumbai Region", - "Provider": "" + "Help": "Mumbai Region" }, { "Value": "cos.ap-seoul.myqcloud.com", - "Help": "Seoul Region", - "Provider": "" + "Help": "Seoul Region" }, { "Value": "cos.ap-bangkok.myqcloud.com", - "Help": "Bangkok Region", - "Provider": "" + "Help": "Bangkok Region" }, { "Value": "cos.ap-tokyo.myqcloud.com", - "Help": "Tokyo Region", - "Provider": "" + "Help": "Tokyo Region" }, { "Value": "cos.na-siliconvalley.myqcloud.com", - "Help": "Silicon Valley Region", - "Provider": "" + "Help": "Silicon Valley Region" }, { "Value": "cos.na-ashburn.myqcloud.com", - "Help": "Virginia Region", - "Provider": "" + "Help": "Virginia Region" }, { "Value": "cos.na-toronto.myqcloud.com", - "Help": "Toronto Region", - "Provider": "" + "Help": "Toronto Region" }, { "Value": "cos.eu-frankfurt.myqcloud.com", - "Help": "Frankfurt Region", - "Provider": "" + "Help": "Frankfurt Region" }, { "Value": "cos.eu-moscow.myqcloud.com", - "Help": "Moscow Region", - "Provider": "" + "Help": "Moscow Region" }, { "Value": "cos.accelerate.myqcloud.com", - "Help": "Use Tencent COS Accelerate Endpoint", - "Provider": "" + "Help": "Use Tencent COS Accelerate Endpoint" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -11634,6 +13347,7 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for RackCorp Object Storage.", "Provider": "RackCorp", "Default": "", @@ -11641,101 +13355,81 @@ "Examples": [ { "Value": "s3.rackcorp.com", - "Help": "Global (AnyCast) Endpoint", - "Provider": "" + "Help": "Global (AnyCast) Endpoint" }, { "Value": "au.s3.rackcorp.com", - "Help": "Australia (Anycast) Endpoint", - "Provider": "" + "Help": "Australia (Anycast) Endpoint" }, { "Value": "au-nsw.s3.rackcorp.com", - "Help": "Sydney (Australia) Endpoint", - "Provider": "" + "Help": "Sydney (Australia) Endpoint" }, { "Value": "au-qld.s3.rackcorp.com", - "Help": "Brisbane (Australia) Endpoint", - "Provider": "" + "Help": "Brisbane (Australia) Endpoint" }, { "Value": "au-vic.s3.rackcorp.com", - "Help": "Melbourne (Australia) Endpoint", - "Provider": "" + "Help": "Melbourne (Australia) Endpoint" }, { "Value": "au-wa.s3.rackcorp.com", - "Help": "Perth (Australia) Endpoint", - "Provider": "" + "Help": "Perth (Australia) Endpoint" }, { "Value": "ph.s3.rackcorp.com", - "Help": "Manila (Philippines) Endpoint", - "Provider": "" + "Help": "Manila (Philippines) Endpoint" }, { "Value": "th.s3.rackcorp.com", - "Help": "Bangkok (Thailand) Endpoint", - "Provider": "" + "Help": "Bangkok (Thailand) Endpoint" }, { "Value": "hk.s3.rackcorp.com", - "Help": "HK (Hong Kong) Endpoint", - "Provider": "" + "Help": "HK (Hong Kong) Endpoint" }, { "Value": "mn.s3.rackcorp.com", - "Help": "Ulaanbaatar (Mongolia) Endpoint", - "Provider": "" + "Help": "Ulaanbaatar (Mongolia) Endpoint" }, { "Value": "kg.s3.rackcorp.com", - "Help": "Bishkek (Kyrgyzstan) Endpoint", - "Provider": "" + "Help": "Bishkek (Kyrgyzstan) Endpoint" }, { "Value": "id.s3.rackcorp.com", - "Help": "Jakarta (Indonesia) Endpoint", - "Provider": "" + "Help": "Jakarta (Indonesia) Endpoint" }, { "Value": "jp.s3.rackcorp.com", - "Help": "Tokyo (Japan) Endpoint", - "Provider": "" + "Help": "Tokyo (Japan) Endpoint" }, { "Value": "sg.s3.rackcorp.com", - "Help": "SG (Singapore) Endpoint", - "Provider": "" + "Help": "SG (Singapore) Endpoint" }, { "Value": "de.s3.rackcorp.com", - "Help": "Frankfurt (Germany) Endpoint", - "Provider": "" + "Help": "Frankfurt (Germany) Endpoint" }, { "Value": "us.s3.rackcorp.com", - "Help": "USA (AnyCast) Endpoint", - "Provider": "" + "Help": "USA (AnyCast) Endpoint" }, { "Value": "us-east-1.s3.rackcorp.com", - "Help": "New York (USA) Endpoint", - "Provider": "" + "Help": "New York (USA) Endpoint" }, { "Value": "us-west-1.s3.rackcorp.com", - "Help": "Freemont (USA) Endpoint", - "Provider": "" + "Help": "Freemont (USA) Endpoint" }, { "Value": "nz.s3.rackcorp.com", - "Help": "Auckland (New Zealand) Endpoint", - "Provider": "" + "Help": "Auckland (New Zealand) Endpoint" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -11749,6 +13443,7 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for Qiniu Object Storage.", "Provider": "Qiniu", "Default": "", @@ -11756,41 +13451,33 @@ "Examples": [ { "Value": "s3-cn-east-1.qiniucs.com", - "Help": "East China Endpoint 1", - "Provider": "" + "Help": "East China Endpoint 1" }, { "Value": "s3-cn-east-2.qiniucs.com", - "Help": "East China Endpoint 2", - "Provider": "" + "Help": "East China Endpoint 2" }, { "Value": "s3-cn-north-1.qiniucs.com", - "Help": "North China Endpoint 1", - "Provider": "" + "Help": "North China Endpoint 1" }, { "Value": "s3-cn-south-1.qiniucs.com", - "Help": "South China Endpoint 1", - "Provider": "" + "Help": "South China Endpoint 1" }, { "Value": "s3-us-north-1.qiniucs.com", - "Help": "North America Endpoint 1", - "Provider": "" + "Help": "North America Endpoint 1" }, { "Value": "s3-ap-southeast-1.qiniucs.com", - "Help": "Southeast Asia Endpoint 1", - "Provider": "" + "Help": "Southeast Asia Endpoint 1" }, { "Value": "s3-ap-northeast-1.qiniucs.com", - "Help": "Northeast Asia Endpoint 1", - "Provider": "" + "Help": "Northeast Asia Endpoint 1" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -11804,8 +13491,9 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for S3 API.\n\nRequired when using an S3 clone.", - "Provider": "!AWS,ArvanCloud,IBMCOS,IDrive,IONOS,TencentCOS,HuaweiOBS,Alibaba,ChinaMobile,GCS,Liara,Scaleway,StackPath,Storj,Synology,RackCorp,Qiniu,Petabox", + "Provider": "!AWS,ArvanCloud,IBMCOS,IDrive,IONOS,TencentCOS,HuaweiOBS,Alibaba,ChinaMobile,GCS,Liara,Linode,MagaluCloud,Scaleway,StackPath,Storj,Synology,RackCorp,Qiniu,Petabox", "Default": "", "Value": null, "Examples": [ @@ -11943,9 +13631,18 @@ "Value": "s3.ir-tbz-sh1.arvanstorage.ir", "Help": "ArvanCloud Tabriz Iran (Shahriar) endpoint", "Provider": "ArvanCloud" + }, + { + "Value": "br-se1.magaluobjects.com", + "Help": "Magalu BR Southeast 1 endpoint", + "Provider": "Magalu" + }, + { + "Value": "br-ne1.magaluobjects.com", + "Help": "Magalu BR Northeast 1 endpoint", + "Provider": "Magalu" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -11959,6 +13656,7 @@ }, { "Name": "location_constraint", + "FieldName": "", "Help": "Location constraint - must be set to match the Region.\n\nUsed when creating buckets only.", "Provider": "AWS", "Default": "", @@ -11966,131 +13664,109 @@ "Examples": [ { "Value": "", - "Help": "Empty for US Region, Northern Virginia, or Pacific Northwest", - "Provider": "" + "Help": "Empty for US Region, Northern Virginia, or Pacific Northwest" }, { "Value": "us-east-2", - "Help": "US East (Ohio) Region", - "Provider": "" + "Help": "US East (Ohio) Region" }, { "Value": "us-west-1", - "Help": "US West (Northern California) Region", - "Provider": "" + "Help": "US West (Northern California) Region" }, { "Value": "us-west-2", - "Help": "US West (Oregon) Region", - "Provider": "" + "Help": "US West (Oregon) Region" }, { "Value": "ca-central-1", - "Help": "Canada (Central) Region", - "Provider": "" + "Help": "Canada (Central) Region" }, { "Value": "eu-west-1", - "Help": "EU (Ireland) Region", - "Provider": "" + "Help": "EU (Ireland) Region" }, { "Value": "eu-west-2", - "Help": "EU (London) Region", - "Provider": "" + "Help": "EU (London) Region" }, { "Value": "eu-west-3", - "Help": "EU (Paris) Region", - "Provider": "" + "Help": "EU (Paris) Region" }, { "Value": "eu-north-1", - "Help": "EU (Stockholm) Region", - "Provider": "" + "Help": "EU (Stockholm) Region" }, { "Value": "eu-south-1", - "Help": "EU (Milan) Region", - "Provider": "" + "Help": "EU (Milan) Region" }, { "Value": "EU", - "Help": "EU Region", - "Provider": "" + "Help": "EU Region" }, { "Value": "ap-southeast-1", - "Help": "Asia Pacific (Singapore) Region", - "Provider": "" + "Help": "Asia Pacific (Singapore) Region" }, { "Value": "ap-southeast-2", - "Help": "Asia Pacific (Sydney) Region", - "Provider": "" + "Help": "Asia Pacific (Sydney) Region" }, { "Value": "ap-northeast-1", - "Help": "Asia Pacific (Tokyo) Region", - "Provider": "" + "Help": "Asia Pacific (Tokyo) Region" }, { "Value": "ap-northeast-2", - "Help": "Asia Pacific (Seoul) Region", - "Provider": "" + "Help": "Asia Pacific (Seoul) Region" }, { "Value": "ap-northeast-3", - "Help": "Asia Pacific (Osaka-Local) Region", - "Provider": "" + "Help": "Asia Pacific (Osaka-Local) Region" }, { "Value": "ap-south-1", - "Help": "Asia Pacific (Mumbai) Region", - "Provider": "" + "Help": "Asia Pacific (Mumbai) Region" }, { "Value": "ap-east-1", - "Help": "Asia Pacific (Hong Kong) Region", - "Provider": "" + "Help": "Asia Pacific (Hong Kong) Region" }, { "Value": "sa-east-1", - "Help": "South America (Sao Paulo) Region", - "Provider": "" + "Help": "South America (Sao Paulo) Region" + }, + { + "Value": "il-central-1", + "Help": "Israel (Tel Aviv) Region" }, { "Value": "me-south-1", - "Help": "Middle East (Bahrain) Region", - "Provider": "" + "Help": "Middle East (Bahrain) Region" }, { "Value": "af-south-1", - "Help": "Africa (Cape Town) Region", - "Provider": "" + "Help": "Africa (Cape Town) Region" }, { "Value": "cn-north-1", - "Help": "China (Beijing) Region", - "Provider": "" + "Help": "China (Beijing) Region" }, { "Value": "cn-northwest-1", - "Help": "China (Ningxia) Region", - "Provider": "" + "Help": "China (Ningxia) Region" }, { "Value": "us-gov-east-1", - "Help": "AWS GovCloud (US-East) Region", - "Provider": "" + "Help": "AWS GovCloud (US-East) Region" }, { "Value": "us-gov-west-1", - "Help": "AWS GovCloud (US) Region", - "Provider": "" + "Help": "AWS GovCloud (US) Region" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -12104,6 +13780,7 @@ }, { "Name": "location_constraint", + "FieldName": "", "Help": "Location constraint - must match endpoint.\n\nUsed when creating buckets only.", "Provider": "ChinaMobile", "Default": "", @@ -12111,156 +13788,125 @@ "Examples": [ { "Value": "wuxi1", - "Help": "East China (Suzhou)", - "Provider": "" + "Help": "East China (Suzhou)" }, { "Value": "jinan1", - "Help": "East China (Jinan)", - "Provider": "" + "Help": "East China (Jinan)" }, { "Value": "ningbo1", - "Help": "East China (Hangzhou)", - "Provider": "" + "Help": "East China (Hangzhou)" }, { "Value": "shanghai1", - "Help": "East China (Shanghai-1)", - "Provider": "" + "Help": "East China (Shanghai-1)" }, { "Value": "zhengzhou1", - "Help": "Central China (Zhengzhou)", - "Provider": "" + "Help": "Central China (Zhengzhou)" }, { "Value": "hunan1", - "Help": "Central China (Changsha-1)", - "Provider": "" + "Help": "Central China (Changsha-1)" }, { "Value": "zhuzhou1", - "Help": "Central China (Changsha-2)", - "Provider": "" + "Help": "Central China (Changsha-2)" }, { "Value": "guangzhou1", - "Help": "South China (Guangzhou-2)", - "Provider": "" + "Help": "South China (Guangzhou-2)" }, { "Value": "dongguan1", - "Help": "South China (Guangzhou-3)", - "Provider": "" + "Help": "South China (Guangzhou-3)" }, { "Value": "beijing1", - "Help": "North China (Beijing-1)", - "Provider": "" + "Help": "North China (Beijing-1)" }, { "Value": "beijing2", - "Help": "North China (Beijing-2)", - "Provider": "" + "Help": "North China (Beijing-2)" }, { "Value": "beijing4", - "Help": "North China (Beijing-3)", - "Provider": "" + "Help": "North China (Beijing-3)" }, { "Value": "huhehaote1", - "Help": "North China (Huhehaote)", - "Provider": "" + "Help": "North China (Huhehaote)" }, { "Value": "chengdu1", - "Help": "Southwest China (Chengdu)", - "Provider": "" + "Help": "Southwest China (Chengdu)" }, { "Value": "chongqing1", - "Help": "Southwest China (Chongqing)", - "Provider": "" + "Help": "Southwest China (Chongqing)" }, { "Value": "guiyang1", - "Help": "Southwest China (Guiyang)", - "Provider": "" + "Help": "Southwest China (Guiyang)" }, { "Value": "xian1", - "Help": "Nouthwest China (Xian)", - "Provider": "" + "Help": "Nouthwest China (Xian)" }, { "Value": "yunnan", - "Help": "Yunnan China (Kunming)", - "Provider": "" + "Help": "Yunnan China (Kunming)" }, { "Value": "yunnan2", - "Help": "Yunnan China (Kunming-2)", - "Provider": "" + "Help": "Yunnan China (Kunming-2)" }, { "Value": "tianjin1", - "Help": "Tianjin China (Tianjin)", - "Provider": "" + "Help": "Tianjin China (Tianjin)" }, { "Value": "jilin1", - "Help": "Jilin China (Changchun)", - "Provider": "" + "Help": "Jilin China (Changchun)" }, { "Value": "hubei1", - "Help": "Hubei China (Xiangyan)", - "Provider": "" + "Help": "Hubei China (Xiangyan)" }, { "Value": "jiangxi1", - "Help": "Jiangxi China (Nanchang)", - "Provider": "" + "Help": "Jiangxi China (Nanchang)" }, { "Value": "gansu1", - "Help": "Gansu China (Lanzhou)", - "Provider": "" + "Help": "Gansu China (Lanzhou)" }, { "Value": "shanxi1", - "Help": "Shanxi China (Taiyuan)", - "Provider": "" + "Help": "Shanxi China (Taiyuan)" }, { "Value": "liaoning1", - "Help": "Liaoning China (Shenyang)", - "Provider": "" + "Help": "Liaoning China (Shenyang)" }, { "Value": "hebei1", - "Help": "Hebei China (Shijiazhuang)", - "Provider": "" + "Help": "Hebei China (Shijiazhuang)" }, { "Value": "fujian1", - "Help": "Fujian China (Xiamen)", - "Provider": "" + "Help": "Fujian China (Xiamen)" }, { "Value": "guangxi1", - "Help": "Guangxi China (Nanning)", - "Provider": "" + "Help": "Guangxi China (Nanning)" }, { "Value": "anhui1", - "Help": "Anhui China (Huainan)", - "Provider": "" + "Help": "Anhui China (Huainan)" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -12274,6 +13920,7 @@ }, { "Name": "location_constraint", + "FieldName": "", "Help": "Location constraint - must match endpoint.\n\nUsed when creating buckets only.", "Provider": "ArvanCloud", "Default": "", @@ -12281,16 +13928,13 @@ "Examples": [ { "Value": "ir-thr-at1", - "Help": "Tehran Iran (Simin)", - "Provider": "" + "Help": "Tehran Iran (Simin)" }, { "Value": "ir-tbz-sh1", - "Help": "Tabriz Iran (Shahriar)", - "Provider": "" + "Help": "Tabriz Iran (Shahriar)" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -12304,6 +13948,7 @@ }, { "Name": "location_constraint", + "FieldName": "", "Help": "Location constraint - must match endpoint when using IBM Cloud Public.\n\nFor on-prem COS, do not make a selection from this list, hit enter.", "Provider": "IBMCOS", "Default": "", @@ -12311,166 +13956,133 @@ "Examples": [ { "Value": "us-standard", - "Help": "US Cross Region Standard", - "Provider": "" + "Help": "US Cross Region Standard" }, { "Value": "us-vault", - "Help": "US Cross Region Vault", - "Provider": "" + "Help": "US Cross Region Vault" }, { "Value": "us-cold", - "Help": "US Cross Region Cold", - "Provider": "" + "Help": "US Cross Region Cold" }, { "Value": "us-flex", - "Help": "US Cross Region Flex", - "Provider": "" + "Help": "US Cross Region Flex" }, { "Value": "us-east-standard", - "Help": "US East Region Standard", - "Provider": "" + "Help": "US East Region Standard" }, { "Value": "us-east-vault", - "Help": "US East Region Vault", - "Provider": "" + "Help": "US East Region Vault" }, { "Value": "us-east-cold", - "Help": "US East Region Cold", - "Provider": "" + "Help": "US East Region Cold" }, { "Value": "us-east-flex", - "Help": "US East Region Flex", - "Provider": "" + "Help": "US East Region Flex" }, { "Value": "us-south-standard", - "Help": "US South Region Standard", - "Provider": "" + "Help": "US South Region Standard" }, { "Value": "us-south-vault", - "Help": "US South Region Vault", - "Provider": "" + "Help": "US South Region Vault" }, { "Value": "us-south-cold", - "Help": "US South Region Cold", - "Provider": "" + "Help": "US South Region Cold" }, { "Value": "us-south-flex", - "Help": "US South Region Flex", - "Provider": "" + "Help": "US South Region Flex" }, { "Value": "eu-standard", - "Help": "EU Cross Region Standard", - "Provider": "" + "Help": "EU Cross Region Standard" }, { "Value": "eu-vault", - "Help": "EU Cross Region Vault", - "Provider": "" + "Help": "EU Cross Region Vault" }, { "Value": "eu-cold", - "Help": "EU Cross Region Cold", - "Provider": "" + "Help": "EU Cross Region Cold" }, { "Value": "eu-flex", - "Help": "EU Cross Region Flex", - "Provider": "" + "Help": "EU Cross Region Flex" }, { "Value": "eu-gb-standard", - "Help": "Great Britain Standard", - "Provider": "" + "Help": "Great Britain Standard" }, { "Value": "eu-gb-vault", - "Help": "Great Britain Vault", - "Provider": "" + "Help": "Great Britain Vault" }, { "Value": "eu-gb-cold", - "Help": "Great Britain Cold", - "Provider": "" + "Help": "Great Britain Cold" }, { "Value": "eu-gb-flex", - "Help": "Great Britain Flex", - "Provider": "" + "Help": "Great Britain Flex" }, { "Value": "ap-standard", - "Help": "APAC Standard", - "Provider": "" + "Help": "APAC Standard" }, { "Value": "ap-vault", - "Help": "APAC Vault", - "Provider": "" + "Help": "APAC Vault" }, { "Value": "ap-cold", - "Help": "APAC Cold", - "Provider": "" + "Help": "APAC Cold" }, { "Value": "ap-flex", - "Help": "APAC Flex", - "Provider": "" + "Help": "APAC Flex" }, { "Value": "mel01-standard", - "Help": "Melbourne Standard", - "Provider": "" + "Help": "Melbourne Standard" }, { "Value": "mel01-vault", - "Help": "Melbourne Vault", - "Provider": "" + "Help": "Melbourne Vault" }, { "Value": "mel01-cold", - "Help": "Melbourne Cold", - "Provider": "" + "Help": "Melbourne Cold" }, { "Value": "mel01-flex", - "Help": "Melbourne Flex", - "Provider": "" + "Help": "Melbourne Flex" }, { "Value": "tor01-standard", - "Help": "Toronto Standard", - "Provider": "" + "Help": "Toronto Standard" }, { "Value": "tor01-vault", - "Help": "Toronto Vault", - "Provider": "" + "Help": "Toronto Vault" }, { "Value": "tor01-cold", - "Help": "Toronto Cold", - "Provider": "" + "Help": "Toronto Cold" }, { "Value": "tor01-flex", - "Help": "Toronto Flex", - "Provider": "" + "Help": "Toronto Flex" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -12484,6 +14096,7 @@ }, { "Name": "location_constraint", + "FieldName": "", "Help": "Location constraint - the location where your bucket will be located and your data stored.\n", "Provider": "RackCorp", "Default": "", @@ -12491,101 +14104,81 @@ "Examples": [ { "Value": "global", - "Help": "Global CDN Region", - "Provider": "" + "Help": "Global CDN Region" }, { "Value": "au", - "Help": "Australia (All locations)", - "Provider": "" + "Help": "Australia (All locations)" }, { "Value": "au-nsw", - "Help": "NSW (Australia) Region", - "Provider": "" + "Help": "NSW (Australia) Region" }, { "Value": "au-qld", - "Help": "QLD (Australia) Region", - "Provider": "" + "Help": "QLD (Australia) Region" }, { "Value": "au-vic", - "Help": "VIC (Australia) Region", - "Provider": "" + "Help": "VIC (Australia) Region" }, { "Value": "au-wa", - "Help": "Perth (Australia) Region", - "Provider": "" + "Help": "Perth (Australia) Region" }, { "Value": "ph", - "Help": "Manila (Philippines) Region", - "Provider": "" + "Help": "Manila (Philippines) Region" }, { "Value": "th", - "Help": "Bangkok (Thailand) Region", - "Provider": "" + "Help": "Bangkok (Thailand) Region" }, { "Value": "hk", - "Help": "HK (Hong Kong) Region", - "Provider": "" + "Help": "HK (Hong Kong) Region" }, { "Value": "mn", - "Help": "Ulaanbaatar (Mongolia) Region", - "Provider": "" + "Help": "Ulaanbaatar (Mongolia) Region" }, { "Value": "kg", - "Help": "Bishkek (Kyrgyzstan) Region", - "Provider": "" + "Help": "Bishkek (Kyrgyzstan) Region" }, { "Value": "id", - "Help": "Jakarta (Indonesia) Region", - "Provider": "" + "Help": "Jakarta (Indonesia) Region" }, { "Value": "jp", - "Help": "Tokyo (Japan) Region", - "Provider": "" + "Help": "Tokyo (Japan) Region" }, { "Value": "sg", - "Help": "SG (Singapore) Region", - "Provider": "" + "Help": "SG (Singapore) Region" }, { "Value": "de", - "Help": "Frankfurt (Germany) Region", - "Provider": "" + "Help": "Frankfurt (Germany) Region" }, { "Value": "us", - "Help": "USA (AnyCast) Region", - "Provider": "" + "Help": "USA (AnyCast) Region" }, { "Value": "us-east-1", - "Help": "New York (USA) Region", - "Provider": "" + "Help": "New York (USA) Region" }, { "Value": "us-west-1", - "Help": "Freemont (USA) Region", - "Provider": "" + "Help": "Freemont (USA) Region" }, { "Value": "nz", - "Help": "Auckland (New Zealand) Region", - "Provider": "" + "Help": "Auckland (New Zealand) Region" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -12599,6 +14192,7 @@ }, { "Name": "location_constraint", + "FieldName": "", "Help": "Location constraint - must be set to match the Region.\n\nUsed when creating buckets only.", "Provider": "Qiniu", "Default": "", @@ -12606,41 +14200,33 @@ "Examples": [ { "Value": "cn-east-1", - "Help": "East China Region 1", - "Provider": "" + "Help": "East China Region 1" }, { "Value": "cn-east-2", - "Help": "East China Region 2", - "Provider": "" + "Help": "East China Region 2" }, { "Value": "cn-north-1", - "Help": "North China Region 1", - "Provider": "" + "Help": "North China Region 1" }, { "Value": "cn-south-1", - "Help": "South China Region 1", - "Provider": "" + "Help": "South China Region 1" }, { "Value": "us-north-1", - "Help": "North America Region 1", - "Provider": "" + "Help": "North America Region 1" }, { "Value": "ap-southeast-1", - "Help": "Southeast Asia Region 1", - "Provider": "" + "Help": "Southeast Asia Region 1" }, { "Value": "ap-northeast-1", - "Help": "Northeast Asia Region 1", - "Provider": "" + "Help": "Northeast Asia Region 1" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -12654,11 +14240,11 @@ }, { "Name": "location_constraint", + "FieldName": "", "Help": "Location constraint - must be set to match the Region.\n\nLeave blank if not sure. Used when creating buckets only.", - "Provider": "!AWS,Alibaba,ArvanCloud,HuaweiOBS,ChinaMobile,Cloudflare,IBMCOS,IDrive,IONOS,Leviia,Liara,Qiniu,RackCorp,Scaleway,StackPath,Storj,TencentCOS,Petabox", + "Provider": "!AWS,Alibaba,ArvanCloud,HuaweiOBS,ChinaMobile,Cloudflare,IBMCOS,IDrive,IONOS,Leviia,Liara,Linode,Magalu,Qiniu,RackCorp,Scaleway,StackPath,Storj,TencentCOS,Petabox", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -12672,6 +14258,7 @@ }, { "Name": "acl", + "FieldName": "", "Help": "Canned ACL used when creating buckets and storing or copying objects.\n\nThis ACL is used for creating objects and if bucket_acl isn't set, for creating buckets too.\n\nFor more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl\n\nNote that this ACL is applied when server-side copying objects as S3\ndoesn't copy the ACL from the source but rather writes a fresh one.\n\nIf the acl is an empty string then no X-Amz-Acl: header is added and\nthe default (private) will be used.\n", "Provider": "!Storj,Synology,Cloudflare", "Default": "", @@ -12733,7 +14320,6 @@ "Provider": "IBMCOS" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -12747,33 +14333,28 @@ }, { "Name": "bucket_acl", + "FieldName": "", "Help": "Canned ACL used when creating buckets.\n\nFor more info visit https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl\n\nNote that this ACL is applied when only when creating buckets. If it\nisn't set then \"acl\" is used instead.\n\nIf the \"acl\" and \"bucket_acl\" are empty strings then no X-Amz-Acl:\nheader is added and the default (private) will be used.\n", - "Provider": "", "Default": "", "Value": null, "Examples": [ { "Value": "private", - "Help": "Owner gets FULL_CONTROL.\nNo one else has access rights (default).", - "Provider": "" + "Help": "Owner gets FULL_CONTROL.\nNo one else has access rights (default)." }, { "Value": "public-read", - "Help": "Owner gets FULL_CONTROL.\nThe AllUsers group gets READ access.", - "Provider": "" + "Help": "Owner gets FULL_CONTROL.\nThe AllUsers group gets READ access." }, { "Value": "public-read-write", - "Help": "Owner gets FULL_CONTROL.\nThe AllUsers group gets READ and WRITE access.\nGranting this on a bucket is generally not recommended.", - "Provider": "" + "Help": "Owner gets FULL_CONTROL.\nThe AllUsers group gets READ and WRITE access.\nGranting this on a bucket is generally not recommended." }, { "Value": "authenticated-read", - "Help": "Owner gets FULL_CONTROL.\nThe AuthenticatedUsers group gets READ access.", - "Provider": "" + "Help": "Owner gets FULL_CONTROL.\nThe AuthenticatedUsers group gets READ access." } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -12787,11 +14368,11 @@ }, { "Name": "requester_pays", + "FieldName": "", "Help": "Enables requester pays option when interacting with S3 bucket.", "Provider": "AWS", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -12805,6 +14386,7 @@ }, { "Name": "server_side_encryption", + "FieldName": "", "Help": "The server-side encryption algorithm used when storing this object in S3.", "Provider": "AWS,Ceph,ChinaMobile,Minio", "Default": "", @@ -12812,13 +14394,11 @@ "Examples": [ { "Value": "", - "Help": "None", - "Provider": "" + "Help": "None" }, { "Value": "AES256", - "Help": "AES256", - "Provider": "" + "Help": "AES256" }, { "Value": "aws:kms", @@ -12826,7 +14406,6 @@ "Provider": "!ChinaMobile" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -12840,6 +14419,7 @@ }, { "Name": "sse_customer_algorithm", + "FieldName": "", "Help": "If using SSE-C, the server-side encryption algorithm used when storing this object in S3.", "Provider": "AWS,Ceph,ChinaMobile,Minio", "Default": "", @@ -12847,16 +14427,13 @@ "Examples": [ { "Value": "", - "Help": "None", - "Provider": "" + "Help": "None" }, { "Value": "AES256", - "Help": "AES256", - "Provider": "" + "Help": "AES256" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -12870,6 +14447,7 @@ }, { "Name": "sse_kms_key_id", + "FieldName": "", "Help": "If using KMS ID you must provide the ARN of Key.", "Provider": "AWS,Ceph,Minio", "Default": "", @@ -12877,16 +14455,13 @@ "Examples": [ { "Value": "", - "Help": "None", - "Provider": "" + "Help": "None" }, { "Value": "arn:aws:kms:us-east-1:*", - "Help": "arn:aws:kms:*", - "Provider": "" + "Help": "arn:aws:kms:*" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -12900,6 +14475,7 @@ }, { "Name": "sse_customer_key", + "FieldName": "", "Help": "To use SSE-C you may provide the secret encryption key used to encrypt/decrypt your data.\n\nAlternatively you can provide --sse-customer-key-base64.", "Provider": "AWS,Ceph,ChinaMobile,Minio", "Default": "", @@ -12907,11 +14483,9 @@ "Examples": [ { "Value": "", - "Help": "None", - "Provider": "" + "Help": "None" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -12925,6 +14499,7 @@ }, { "Name": "sse_customer_key_base64", + "FieldName": "", "Help": "If using SSE-C you must provide the secret encryption key encoded in base64 format to encrypt/decrypt your data.\n\nAlternatively you can provide --sse-customer-key.", "Provider": "AWS,Ceph,ChinaMobile,Minio", "Default": "", @@ -12932,11 +14507,9 @@ "Examples": [ { "Value": "", - "Help": "None", - "Provider": "" + "Help": "None" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -12950,6 +14523,7 @@ }, { "Name": "sse_customer_key_md5", + "FieldName": "", "Help": "If using SSE-C you may provide the secret encryption key MD5 checksum (optional).\n\nIf you leave it blank, this is calculated automatically from the sse_customer_key provided.\n", "Provider": "AWS,Ceph,ChinaMobile,Minio", "Default": "", @@ -12957,11 +14531,9 @@ "Examples": [ { "Value": "", - "Help": "None", - "Provider": "" + "Help": "None" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -12975,6 +14547,7 @@ }, { "Name": "storage_class", + "FieldName": "", "Help": "The storage class to use when storing new objects in S3.", "Provider": "AWS", "Default": "", @@ -12982,51 +14555,41 @@ "Examples": [ { "Value": "", - "Help": "Default", - "Provider": "" + "Help": "Default" }, { "Value": "STANDARD", - "Help": "Standard storage class", - "Provider": "" + "Help": "Standard storage class" }, { "Value": "REDUCED_REDUNDANCY", - "Help": "Reduced redundancy storage class", - "Provider": "" + "Help": "Reduced redundancy storage class" }, { "Value": "STANDARD_IA", - "Help": "Standard Infrequent Access storage class", - "Provider": "" + "Help": "Standard Infrequent Access storage class" }, { "Value": "ONEZONE_IA", - "Help": "One Zone Infrequent Access storage class", - "Provider": "" + "Help": "One Zone Infrequent Access storage class" }, { "Value": "GLACIER", - "Help": "Glacier storage class", - "Provider": "" + "Help": "Glacier storage class" }, { "Value": "DEEP_ARCHIVE", - "Help": "Glacier Deep Archive storage class", - "Provider": "" + "Help": "Glacier Deep Archive storage class" }, { "Value": "INTELLIGENT_TIERING", - "Help": "Intelligent-Tiering storage class", - "Provider": "" + "Help": "Intelligent-Tiering storage class" }, { "Value": "GLACIER_IR", - "Help": "Glacier Instant Retrieval storage class", - "Provider": "" + "Help": "Glacier Instant Retrieval storage class" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13040,6 +14603,7 @@ }, { "Name": "storage_class", + "FieldName": "", "Help": "The storage class to use when storing new objects in OSS.", "Provider": "Alibaba", "Default": "", @@ -13047,26 +14611,21 @@ "Examples": [ { "Value": "", - "Help": "Default", - "Provider": "" + "Help": "Default" }, { "Value": "STANDARD", - "Help": "Standard storage class", - "Provider": "" + "Help": "Standard storage class" }, { "Value": "GLACIER", - "Help": "Archive storage mode", - "Provider": "" + "Help": "Archive storage mode" }, { "Value": "STANDARD_IA", - "Help": "Infrequent access storage mode", - "Provider": "" + "Help": "Infrequent access storage mode" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13080,6 +14639,7 @@ }, { "Name": "storage_class", + "FieldName": "", "Help": "The storage class to use when storing new objects in ChinaMobile.", "Provider": "ChinaMobile", "Default": "", @@ -13087,26 +14647,21 @@ "Examples": [ { "Value": "", - "Help": "Default", - "Provider": "" + "Help": "Default" }, { "Value": "STANDARD", - "Help": "Standard storage class", - "Provider": "" + "Help": "Standard storage class" }, { "Value": "GLACIER", - "Help": "Archive storage mode", - "Provider": "" + "Help": "Archive storage mode" }, { "Value": "STANDARD_IA", - "Help": "Infrequent access storage mode", - "Provider": "" + "Help": "Infrequent access storage mode" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13120,6 +14675,7 @@ }, { "Name": "storage_class", + "FieldName": "", "Help": "The storage class to use when storing new objects in Liara", "Provider": "Liara", "Default": "", @@ -13127,11 +14683,9 @@ "Examples": [ { "Value": "STANDARD", - "Help": "Standard storage class", - "Provider": "" + "Help": "Standard storage class" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13145,6 +14699,7 @@ }, { "Name": "storage_class", + "FieldName": "", "Help": "The storage class to use when storing new objects in ArvanCloud.", "Provider": "ArvanCloud", "Default": "", @@ -13152,11 +14707,33 @@ "Examples": [ { "Value": "STANDARD", - "Help": "Standard storage class", - "Provider": "" + "Help": "Standard storage class" + } + ], + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "storage_class", + "FieldName": "", + "Help": "The storage class to use when storing new objects in Magalu.", + "Provider": "Magalu", + "Default": "", + "Value": null, + "Examples": [ + { + "Value": "STANDARD", + "Help": "Standard storage class" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13170,6 +14747,7 @@ }, { "Name": "storage_class", + "FieldName": "", "Help": "The storage class to use when storing new objects in Tencent COS.", "Provider": "TencentCOS", "Default": "", @@ -13177,26 +14755,21 @@ "Examples": [ { "Value": "", - "Help": "Default", - "Provider": "" + "Help": "Default" }, { "Value": "STANDARD", - "Help": "Standard storage class", - "Provider": "" + "Help": "Standard storage class" }, { "Value": "ARCHIVE", - "Help": "Archive storage mode", - "Provider": "" + "Help": "Archive storage mode" }, { "Value": "STANDARD_IA", - "Help": "Infrequent access storage mode", - "Provider": "" + "Help": "Infrequent access storage mode" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13210,6 +14783,7 @@ }, { "Name": "storage_class", + "FieldName": "", "Help": "The storage class to use when storing new objects in S3.", "Provider": "Scaleway", "Default": "", @@ -13217,26 +14791,21 @@ "Examples": [ { "Value": "", - "Help": "Default.", - "Provider": "" + "Help": "Default." }, { "Value": "STANDARD", - "Help": "The Standard class for any upload.\nSuitable for on-demand content like streaming or CDN.\nAvailable in all regions.", - "Provider": "" + "Help": "The Standard class for any upload.\nSuitable for on-demand content like streaming or CDN.\nAvailable in all regions." }, { "Value": "GLACIER", - "Help": "Archived storage.\nPrices are lower, but it needs to be restored first to be accessed.\nAvailable in FR-PAR and NL-AMS regions.", - "Provider": "" + "Help": "Archived storage.\nPrices are lower, but it needs to be restored first to be accessed.\nAvailable in FR-PAR and NL-AMS regions." }, { "Value": "ONEZONE_IA", - "Help": "One Zone - Infrequent Access.\nA good choice for storing secondary backup copies or easily re-creatable data.\nAvailable in the FR-PAR region only.", - "Provider": "" + "Help": "One Zone - Infrequent Access.\nA good choice for storing secondary backup copies or easily re-creatable data.\nAvailable in the FR-PAR region only." } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13250,6 +14819,7 @@ }, { "Name": "storage_class", + "FieldName": "", "Help": "The storage class to use when storing new objects in Qiniu.", "Provider": "Qiniu", "Default": "", @@ -13257,26 +14827,21 @@ "Examples": [ { "Value": "STANDARD", - "Help": "Standard storage class", - "Provider": "" + "Help": "Standard storage class" }, { "Value": "LINE", - "Help": "Infrequent access storage mode", - "Provider": "" + "Help": "Infrequent access storage mode" }, { "Value": "GLACIER", - "Help": "Archive storage mode", - "Provider": "" + "Help": "Archive storage mode" }, { "Value": "DEEP_ARCHIVE", - "Help": "Deep archive storage mode", - "Provider": "" + "Help": "Deep archive storage mode" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13290,11 +14855,10 @@ }, { "Name": "upload_cutoff", + "FieldName": "", "Help": "Cutoff for switching to chunked upload.\n\nAny files larger than this will be uploaded in chunks of chunk_size.\nThe minimum is 0 and the maximum is 5 GiB.", - "Provider": "", "Default": 209715200, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13308,11 +14872,10 @@ }, { "Name": "chunk_size", + "FieldName": "", "Help": "Chunk size to use for uploading.\n\nWhen uploading files larger than upload_cutoff or files with unknown\nsize (e.g. from \"rclone rcat\" or uploaded with \"rclone mount\" or google\nphotos or google docs) they will be uploaded as multipart uploads\nusing this chunk size.\n\nNote that \"--s3-upload-concurrency\" chunks of this size are buffered\nin memory per transfer.\n\nIf you are transferring large files over high-speed links and you have\nenough memory, then increasing this will speed up the transfers.\n\nRclone will automatically increase the chunk size when uploading a\nlarge file of known size to stay below the 10,000 chunks limit.\n\nFiles of unknown size are uploaded with the configured\nchunk_size. Since the default chunk size is 5 MiB and there can be at\nmost 10,000 chunks, this means that by default the maximum size of\na file you can stream upload is 48 GiB. If you wish to stream upload\nlarger files then you will need to increase chunk_size.\n\nIncreasing the chunk size decreases the accuracy of the progress\nstatistics displayed with \"-P\" flag. Rclone treats chunk as sent when\nit's buffered by the AWS SDK, when in fact it may still be uploading.\nA bigger chunk size means a bigger AWS SDK buffer and progress\nreporting more deviating from the truth.\n", - "Provider": "", "Default": 5242880, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13326,11 +14889,10 @@ }, { "Name": "max_upload_parts", + "FieldName": "", "Help": "Maximum number of parts in a multipart upload.\n\nThis option defines the maximum number of multipart chunks to use\nwhen doing a multipart upload.\n\nThis can be useful if a service does not support the AWS S3\nspecification of 10,000 chunks.\n\nRclone will automatically increase the chunk size when uploading a\nlarge file of a known size to stay below this number of chunks limit.\n", - "Provider": "", "Default": 10000, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13344,11 +14906,10 @@ }, { "Name": "copy_cutoff", + "FieldName": "", "Help": "Cutoff for switching to multipart copy.\n\nAny files larger than this that need to be server-side copied will be\ncopied in chunks of this size.\n\nThe minimum is 0 and the maximum is 5 GiB.", - "Provider": "", "Default": 4999610368, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13362,11 +14923,10 @@ }, { "Name": "disable_checksum", + "FieldName": "", "Help": "Don't store MD5 checksum with object metadata.\n\nNormally rclone will calculate the MD5 checksum of the input before\nuploading it so it can add it to metadata on the object. This is great\nfor data integrity checking but can cause long delays for large files\nto start uploading.", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13380,11 +14940,10 @@ }, { "Name": "shared_credentials_file", + "FieldName": "", "Help": "Path to the shared credentials file.\n\nIf env_auth = true then rclone can use a shared credentials file.\n\nIf this variable is empty rclone will look for the\n\"AWS_SHARED_CREDENTIALS_FILE\" env variable. If the env value is empty\nit will default to the current user's home directory.\n\n Linux/OSX: \"$HOME/.aws/credentials\"\n Windows: \"%USERPROFILE%\\.aws\\credentials\"\n", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13398,11 +14957,10 @@ }, { "Name": "profile", + "FieldName": "", "Help": "Profile to use in the shared credentials file.\n\nIf env_auth = true then rclone can use a shared credentials file. This\nvariable controls which profile is used in that file.\n\nIf empty it will default to the environment variable \"AWS_PROFILE\" or\n\"default\" if that environment variable is also not set.\n", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13416,11 +14974,10 @@ }, { "Name": "session_token", + "FieldName": "", "Help": "An AWS session token.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13434,11 +14991,10 @@ }, { "Name": "upload_concurrency", - "Help": "Concurrency for multipart uploads.\n\nThis is the number of chunks of the same file that are uploaded\nconcurrently.\n\nIf you are uploading small numbers of large files over high-speed links\nand these uploads do not fully utilize your bandwidth, then increasing\nthis may help to speed up the transfers.", - "Provider": "", + "FieldName": "", + "Help": "Concurrency for multipart uploads and copies.\n\nThis is the number of chunks of the same file that are uploaded\nconcurrently for multipart uploads and copies.\n\nIf you are uploading small numbers of large files over high-speed links\nand these uploads do not fully utilize your bandwidth, then increasing\nthis may help to speed up the transfers.", "Default": 4, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13452,11 +15008,10 @@ }, { "Name": "force_path_style", - "Help": "If true use path style access if false use virtual hosted style.\n\nIf this is true (the default) then rclone will use path style access,\nif false then rclone will use virtual path style. See [the AWS S3\ndocs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro)\nfor more info.\n\nSome providers (e.g. AWS, Aliyun OSS, Netease COS, or Tencent COS) require this set to\nfalse - rclone will do this automatically based on the provider\nsetting.", - "Provider": "", + "FieldName": "", + "Help": "If true use path style access if false use virtual hosted style.\n\nIf this is true (the default) then rclone will use path style access,\nif false then rclone will use virtual path style. See [the AWS S3\ndocs](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro)\nfor more info.\n\nSome providers (e.g. AWS, Aliyun OSS, Netease COS, or Tencent COS) require this set to\nfalse - rclone will do this automatically based on the provider\nsetting.\n\nNote that if your bucket isn't a valid DNS name, i.e. has '.' or '_' in,\nyou'll need to set this to true.\n", "Default": true, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13470,11 +15025,27 @@ }, { "Name": "v2_auth", + "FieldName": "", "Help": "If true use v2 authentication.\n\nIf this is false (the default) then rclone will use v4 authentication.\nIf it is set then rclone will use v2 authentication.\n\nUse this only if v4 signatures don't work, e.g. pre Jewel/v10 CEPH.", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "use_dual_stack", + "FieldName": "", + "Help": "If true use AWS S3 dual-stack endpoint (IPv6 support).\n\nSee [AWS Docs on Dualstack Endpoints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/dual-stack-endpoints.html)", + "Default": false, + "Value": null, "Hide": 0, "Required": false, "IsPassword": false, @@ -13488,11 +15059,11 @@ }, { "Name": "use_accelerate_endpoint", + "FieldName": "", "Help": "If true use the AWS S3 accelerated endpoint.\n\nSee: [AWS S3 Transfer acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration-examples.html)", "Provider": "AWS", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13506,11 +15077,11 @@ }, { "Name": "leave_parts_on_error", + "FieldName": "", "Help": "If true avoid calling abort upload on a failure, leaving all successfully uploaded parts on S3 for manual recovery.\n\nIt should be set to true for resuming uploads across different sessions.\n\nWARNING: Storing parts of an incomplete multipart upload counts towards space usage on S3 and will add additional costs if not cleaned up.\n", "Provider": "AWS", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13524,11 +15095,10 @@ }, { "Name": "list_chunk", + "FieldName": "", "Help": "Size of listing chunk (response list for each ListObject S3 request).\n\nThis option is also known as \"MaxKeys\", \"max-items\", or \"page-size\" from the AWS S3 specification.\nMost services truncate the response list to 1000 objects even if requested more than that.\nIn AWS S3 this is a global maximum and cannot be changed, see [AWS S3](https://docs.aws.amazon.com/cli/latest/reference/s3/ls.html).\nIn Ceph, this can be increased with the \"rgw list buckets max chunk\" option.\n", - "Provider": "", "Default": 1000, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13542,11 +15112,10 @@ }, { "Name": "list_version", + "FieldName": "", "Help": "Version of ListObjects to use: 1,2 or 0 for auto.\n\nWhen S3 originally launched it only provided the ListObjects call to\nenumerate objects in a bucket.\n\nHowever in May 2016 the ListObjectsV2 call was introduced. This is\nmuch higher performance and should be used if at all possible.\n\nIf set to the default, 0, rclone will guess according to the provider\nset which list objects method to call. If it guesses wrong, then it\nmay be set manually here.\n", - "Provider": "", "Default": 0, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13560,14 +15129,13 @@ }, { "Name": "list_url_encode", + "FieldName": "", "Help": "Whether to url encode listings: true/false/unset\n\nSome providers support URL encoding listings and where this is\navailable this is more reliable when using control characters in file\nnames. If this is set to unset (the default) then rclone will choose\naccording to the provider setting what to apply, but you can override\nrclone's choice here.\n", - "Provider": "", "Default": { "Value": false, "Valid": false }, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13581,11 +15149,10 @@ }, { "Name": "no_check_bucket", + "FieldName": "", "Help": "If set, don't attempt to check the bucket exists or create it.\n\nThis can be useful when trying to minimise the number of transactions\nrclone does if you know the bucket exists already.\n\nIt can also be needed if the user you are using does not have bucket\ncreation permissions. Before v1.52.0 this would have passed silently\ndue to a bug.\n", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13599,11 +15166,10 @@ }, { "Name": "no_head", + "FieldName": "", "Help": "If set, don't HEAD uploaded objects to check integrity.\n\nThis can be useful when trying to minimise the number of transactions\nrclone does.\n\nSetting it means that if rclone receives a 200 OK message after\nuploading an object with PUT then it will assume that it got uploaded\nproperly.\n\nIn particular it will assume:\n\n- the metadata, including modtime, storage class and content type was as uploaded\n- the size was as uploaded\n\nIt reads the following items from the response for a single part PUT:\n\n- the MD5SUM\n- The uploaded date\n\nFor multipart uploads these items aren't read.\n\nIf an source object of unknown length is uploaded then rclone **will** do a\nHEAD request.\n\nSetting this flag increases the chance for undetected upload failures,\nin particular an incorrect size, so it isn't recommended for normal\noperation. In practice the chance of an undetected upload failure is\nvery small even with this flag.\n", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13617,11 +15183,10 @@ }, { "Name": "no_head_object", + "FieldName": "", "Help": "If set, do not do HEAD before GET when getting objects.", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13635,11 +15200,10 @@ }, { "Name": "encoding", + "FieldName": "", "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", "Default": 50331650, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13649,16 +15213,15 @@ "Sensitive": false, "DefaultStr": "Slash,InvalidUtf8,Dot", "ValueStr": "Slash,InvalidUtf8,Dot", - "Type": "MultiEncoder" + "Type": "Encoding" }, { "Name": "memory_pool_flush_time", - "Help": "How often internal memory buffer pools will be flushed.\n\nUploads which requires additional buffers (f.e multipart) will use memory pool for allocations.\nThis option controls how often unused buffers will be removed from the pool.", - "Provider": "", + "FieldName": "", + "Help": "How often internal memory buffer pools will be flushed. (no longer used)", "Default": 60000000000, "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 3, "Required": false, "IsPassword": false, "NoPrefix": false, @@ -13671,12 +15234,11 @@ }, { "Name": "memory_pool_use_mmap", - "Help": "Whether to use mmap buffers in internal memory pool.", - "Provider": "", + "FieldName": "", + "Help": "Whether to use mmap buffers in internal memory pool. (no longer used)", "Default": false, "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 3, "Required": false, "IsPassword": false, "NoPrefix": false, @@ -13689,11 +15251,10 @@ }, { "Name": "disable_http2", + "FieldName": "", "Help": "Disable usage of http2 for S3 backends.\n\nThere is currently an unsolved issue with the s3 (specifically minio) backend\nand HTTP/2. HTTP/2 is enabled by default for the s3 backend but can be\ndisabled here. When the issue is solved this flag will be removed.\n\nSee: https://github.com/rclone/rclone/issues/4673, https://github.com/rclone/rclone/issues/3631\n\n", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13707,11 +15268,10 @@ }, { "Name": "download_url", + "FieldName": "", "Help": "Custom endpoint for downloads.\nThis is usually set to a CloudFront CDN URL as AWS S3 offers\ncheaper egress for data downloaded through the CloudFront network.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13725,11 +15285,10 @@ }, { "Name": "directory_markers", + "FieldName": "", "Help": "Upload an empty object with a trailing slash when a new directory is created\n\nEmpty folders are unsupported for bucket based remotes, this option creates an empty\nobject ending with \"/\", to persist the folder.\n", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13743,14 +15302,33 @@ }, { "Name": "use_multipart_etag", + "FieldName": "", "Help": "Whether to use ETag in multipart uploads for verification\n\nThis should be true, false or left unset to use the default for the provider.\n", - "Provider": "", "Default": { "Value": false, "Valid": false }, "Value": null, - "ShortOpt": "", + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "unset", + "ValueStr": "unset", + "Type": "Tristate" + }, + { + "Name": "use_unsigned_payload", + "FieldName": "", + "Help": "Whether to use an unsigned payload in PutObject\n\nRclone has to avoid the AWS SDK seeking the body when calling\nPutObject. The AWS provider can add checksums in the trailer to avoid\nseeking but other providers can't.\n\nThis should be true, false or left unset to use the default for the provider.\n", + "Default": { + "Value": false, + "Valid": false + }, + "Value": null, "Hide": 0, "Required": false, "IsPassword": false, @@ -13764,11 +15342,10 @@ }, { "Name": "use_presigned_request", - "Help": "Whether to use a presigned request or PutObject for single part uploads\n\nIf this is false rclone will use PutObject from the AWS SDK to upload\nan object.\n\nVersions of rclone \u003c 1.59 use presigned requests to upload a single\npart object and setting this flag to true will re-enable that\nfunctionality. This shouldn't be necessary except in exceptional\ncircumstances or for testing.\n", - "Provider": "", + "FieldName": "", + "Help": "Whether to use a presigned request or PutObject for single part uploads\n\nIf this is false rclone will use PutObject from the AWS SDK to upload\nan object.\n\nVersions of rclone < 1.59 use presigned requests to upload a single\npart object and setting this flag to true will re-enable that\nfunctionality. This shouldn't be necessary except in exceptional\ncircumstances or for testing.\n", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13782,11 +15359,10 @@ }, { "Name": "versions", + "FieldName": "", "Help": "Include old versions in directory listings.", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13800,11 +15376,10 @@ }, { "Name": "version_at", + "FieldName": "", "Help": "Show file versions as they were at the specified time.\n\nThe parameter should be a date, \"2006-01-02\", datetime \"2006-01-02\n15:04:05\" or a duration for that long ago, eg \"100d\" or \"1h\".\n\nNote that when using this no file write operations are permitted,\nso you can't upload files or delete them.\n\nSee [the time option docs](/docs/#time-option) for valid formats.\n", - "Provider": "", "Default": "0001-01-01T00:00:00Z", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13816,13 +15391,29 @@ "ValueStr": "off", "Type": "Time" }, + { + "Name": "version_deleted", + "FieldName": "", + "Help": "Show deleted file markers when using versions.\n\nThis shows deleted file markers in the listing when using versions. These will appear\nas 0 size files. The only operation which can be performed on them is deletion.\n\nDeleting a delete marker will reveal the previous version.\n\nDeleted files will always show with a timestamp.\n", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, { "Name": "decompress", + "FieldName": "", "Help": "If set this will decompress gzip encoded objects.\n\nIt is possible to upload objects to S3 with \"Content-Encoding: gzip\"\nset. Normally rclone will download these files as compressed objects.\n\nIf this flag is set then rclone will decompress these files with\n\"Content-Encoding: gzip\" as they are received. This means that rclone\ncan't check the size and hash but the file contents will be decompressed.\n", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13835,15 +15426,89 @@ "Type": "bool" }, { - "Name": "might_gzip", - "Help": "Set this if the backend might gzip objects.\n\nNormally providers will not alter objects when they are downloaded. If\nan object was not uploaded with `Content-Encoding: gzip` then it won't\nbe set on download.\n\nHowever some providers may gzip objects even if they weren't uploaded\nwith `Content-Encoding: gzip` (eg Cloudflare).\n\nA symptom of this would be receiving errors like\n\n ERROR corrupted on transfer: sizes differ NNN vs MMM\n\nIf you set this flag and rclone downloads an object with\nContent-Encoding: gzip set and chunked transfer encoding, then rclone\nwill decompress the object on the fly.\n\nIf this is set to unset (the default) then rclone will choose\naccording to the provider setting what to apply, but you can override\nrclone's choice here.\n", - "Provider": "", + "Name": "might_gzip", + "FieldName": "", + "Help": "Set this if the backend might gzip objects.\n\nNormally providers will not alter objects when they are downloaded. If\nan object was not uploaded with `Content-Encoding: gzip` then it won't\nbe set on download.\n\nHowever some providers may gzip objects even if they weren't uploaded\nwith `Content-Encoding: gzip` (eg Cloudflare).\n\nA symptom of this would be receiving errors like\n\n ERROR corrupted on transfer: sizes differ NNN vs MMM\n\nIf you set this flag and rclone downloads an object with\nContent-Encoding: gzip set and chunked transfer encoding, then rclone\nwill decompress the object on the fly.\n\nIf this is set to unset (the default) then rclone will choose\naccording to the provider setting what to apply, but you can override\nrclone's choice here.\n", + "Default": { + "Value": false, + "Valid": false + }, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "unset", + "ValueStr": "unset", + "Type": "Tristate" + }, + { + "Name": "use_accept_encoding_gzip", + "FieldName": "", + "Help": "Whether to send `Accept-Encoding: gzip` header.\n\nBy default, rclone will append `Accept-Encoding: gzip` to the request to download\ncompressed objects whenever possible.\n\nHowever some providers such as Google Cloud Storage may alter the HTTP headers, breaking\nthe signature of the request.\n\nA symptom of this would be receiving errors like\n\n\tSignatureDoesNotMatch: The request signature we calculated does not match the signature you provided.\n\nIn this case, you might want to try disabling this option.\n", + "Default": { + "Value": false, + "Valid": false + }, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "unset", + "ValueStr": "unset", + "Type": "Tristate" + }, + { + "Name": "no_system_metadata", + "FieldName": "", + "Help": "Suppress setting and reading of system metadata", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "sts_endpoint", + "FieldName": "", + "Help": "Endpoint for STS (deprecated).\n\nLeave blank if using AWS to use the default endpoint for the region.", + "Provider": "AWS", + "Default": "", + "Value": null, + "Hide": 3, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "use_already_exists", + "FieldName": "", + "Help": "Set if rclone should report BucketAlreadyExists errors on bucket creation.\n\nAt some point during the evolution of the s3 protocol, AWS started\nreturning an `AlreadyOwnedByYou` error when attempting to create a\nbucket that the user already owned, rather than a\n`BucketAlreadyExists` error.\n\nUnfortunately exactly what has been implemented by s3 clones is a\nlittle inconsistent, some return `AlreadyOwnedByYou`, some return\n`BucketAlreadyExists` and some return no error at all.\n\nThis is important to rclone because it ensures the bucket exists by\ncreating it on quite a lot of operations (unless\n`--s3-no-check-bucket` is used).\n\nIf rclone knows the provider can return `AlreadyOwnedByYou` or returns\nno error then it can report `BucketAlreadyExists` errors when the user\nattempts to create a bucket not owned by them. Otherwise rclone\nignores the `BucketAlreadyExists` error which can lead to confusion.\n\nThis should be automatically set correctly for all providers rclone\nknows about - please make a bug report if not.\n", "Default": { "Value": false, "Valid": false }, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13856,15 +15521,14 @@ "Type": "Tristate" }, { - "Name": "use_accept_encoding_gzip", - "Help": "Whether to send `Accept-Encoding: gzip` header.\n\nBy default, rclone will append `Accept-Encoding: gzip` to the request to download\ncompressed objects whenever possible.\n\nHowever some providers such as Google Cloud Storage may alter the HTTP headers, breaking\nthe signature of the request.\n\nA symptom of this would be receiving errors like\n\n\tSignatureDoesNotMatch: The request signature we calculated does not match the signature you provided.\n\nIn this case, you might want to try disabling this option.\n", - "Provider": "", + "Name": "use_multipart_uploads", + "FieldName": "", + "Help": "Set if rclone should use multipart uploads.\n\nYou can change this if you want to disable the use of multipart uploads.\nThis shouldn't be necessary in normal operation.\n\nThis should be automatically set correctly for all providers rclone\nknows about - please make a bug report if not.\n", "Default": { "Value": false, "Valid": false }, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13877,12 +15541,11 @@ "Type": "Tristate" }, { - "Name": "no_system_metadata", - "Help": "Suppress setting and reading of system metadata", - "Provider": "", - "Default": false, + "Name": "sdk_log_mode", + "FieldName": "", + "Help": "Set to debug the SDK\n\nThis can be set to a comma separated list of the following functions:\n\n- `Signing`\n- `Retries`\n- `Request`\n- `RequestWithBody`\n- `Response`\n- `ResponseWithBody`\n- `DeprecatedUsage`\n- `RequestEventMessage`\n- `ResponseEventMessage`\n\nUse `Off` to disable and `All` to set all log levels. You will need to\nuse `-vv` to see the debug level logs.\n", + "Default": 0, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13890,17 +15553,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "Off", + "ValueStr": "Off", + "Type": "Bits" }, { - "Name": "sts_endpoint", - "Help": "Endpoint for STS.\n\nLeave blank if using AWS to use the default endpoint for the region.", - "Provider": "AWS", + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -13916,14 +15578,22 @@ "CommandHelp": [ { "Name": "restore", - "Short": "Restore objects from GLACIER to normal storage", - "Long": "This command can be used to restore one or more objects from GLACIER\nto normal storage.\n\nUsage Examples:\n\n rclone backend restore s3:bucket/path/to/object [-o priority=PRIORITY] [-o lifetime=DAYS]\n rclone backend restore s3:bucket/path/to/directory [-o priority=PRIORITY] [-o lifetime=DAYS]\n rclone backend restore s3:bucket [-o priority=PRIORITY] [-o lifetime=DAYS]\n\nThis flag also obeys the filters. Test first with --interactive/-i or --dry-run flags\n\n rclone --interactive backend restore --include \"*.txt\" s3:bucket/path -o priority=Standard\n\nAll the objects shown will be marked for restore, then\n\n rclone backend restore --include \"*.txt\" s3:bucket/path -o priority=Standard\n\nIt returns a list of status dictionaries with Remote and Status\nkeys. The Status will be OK if it was successful or an error message\nif not.\n\n [\n {\n \"Status\": \"OK\",\n \"Path\": \"test.txt\"\n },\n {\n \"Status\": \"OK\",\n \"Path\": \"test/file4.txt\"\n }\n ]\n\n", + "Short": "Restore objects from GLACIER or INTELLIGENT-TIERING archive tier", + "Long": "This command can be used to restore one or more objects from GLACIER to normal storage \nor from INTELLIGENT-TIERING Archive Access / Deep Archive Access tier to the Frequent Access tier.\n\nUsage Examples:\n\n rclone backend restore s3:bucket/path/to/object -o priority=PRIORITY -o lifetime=DAYS\n rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY -o lifetime=DAYS\n rclone backend restore s3:bucket -o priority=PRIORITY -o lifetime=DAYS\n rclone backend restore s3:bucket/path/to/directory -o priority=PRIORITY\n\nThis flag also obeys the filters. Test first with --interactive/-i or --dry-run flags\n\n rclone --interactive backend restore --include \"*.txt\" s3:bucket/path -o priority=Standard -o lifetime=1\n\nAll the objects shown will be marked for restore, then\n\n rclone backend restore --include \"*.txt\" s3:bucket/path -o priority=Standard -o lifetime=1\n\nIt returns a list of status dictionaries with Remote and Status\nkeys. The Status will be OK if it was successful or an error message\nif not.\n\n [\n {\n \"Status\": \"OK\",\n \"Remote\": \"test.txt\"\n },\n {\n \"Status\": \"OK\",\n \"Remote\": \"test/file4.txt\"\n }\n ]\n\n", "Opts": { "description": "The optional description for the job.", - "lifetime": "Lifetime of the active copy in days", + "lifetime": "Lifetime of the active copy in days, ignored for INTELLIGENT-TIERING storage", "priority": "Priority of restore: Standard|Expedited|Bulk" } }, + { + "Name": "restore-status", + "Short": "Show the restore status for objects being restored from GLACIER or INTELLIGENT-TIERING storage", + "Long": "This command can be used to show the status for objects being restored from GLACIER to normal storage\nor from INTELLIGENT-TIERING Archive Access / Deep Archive Access tier to the Frequent Access tier.\n\nUsage Examples:\n\n rclone backend restore-status s3:bucket/path/to/object\n rclone backend restore-status s3:bucket/path/to/directory\n rclone backend restore-status -o all s3:bucket/path/to/directory\n\nThis command does not obey the filters.\n\nIt returns a list of status dictionaries.\n\n [\n {\n \"Remote\": \"file.txt\",\n \"VersionID\": null,\n \"RestoreStatus\": {\n \"IsRestoreInProgress\": true,\n \"RestoreExpiryDate\": \"2023-09-06T12:29:19+01:00\"\n },\n \"StorageClass\": \"GLACIER\"\n },\n {\n \"Remote\": \"test.pdf\",\n \"VersionID\": null,\n \"RestoreStatus\": {\n \"IsRestoreInProgress\": false,\n \"RestoreExpiryDate\": \"2023-09-06T12:29:19+01:00\"\n },\n \"StorageClass\": \"DEEP_ARCHIVE\"\n },\n {\n \"Remote\": \"test.gz\",\n \"VersionID\": null,\n \"RestoreStatus\": {\n \"IsRestoreInProgress\": true,\n \"RestoreExpiryDate\": \"null\"\n },\n \"StorageClass\": \"INTELLIGENT_TIERING\"\n }\n ]\n", + "Opts": { + "all": "if set then show all objects, not just ones with restore status" + } + }, { "Name": "list-multipart-uploads", "Short": "List the unfinished multipart uploads", @@ -13949,6 +15619,12 @@ "Short": "Set/get versioning support for a bucket.", "Long": "This command sets versioning support if a parameter is\npassed and then returns the current versioning status for the bucket\nsupplied.\n\n rclone backend versioning s3:bucket # read status only\n rclone backend versioning s3:bucket Enabled\n rclone backend versioning s3:bucket Suspended\n\nIt may return \"Enabled\", \"Suspended\" or \"Unversioned\". Note that once versioning\nhas been enabled the status can't be set back to \"Unversioned\".\n", "Opts": null + }, + { + "Name": "set", + "Short": "Set command for updating the config parameters.", + "Long": "This set command can be used to update the config parameters\nfor a running s3 backend.\n\nUsage Examples:\n\n rclone backend set s3: [-o opt_name=opt_value] [-o opt_name2=opt_value2]\n rclone rc backend/command command=set fs=s3: [-o opt_name=opt_value] [-o opt_name2=opt_value2]\n rclone rc backend/command command=set fs=s3: -o session_token=X -o access_key_id=X -o secret_access_key=X\n\nThe option keys are named as they are in the config file.\n\nThis rebuilds the connection to the s3 backend when it is called with\nthe new parameters. Only new parameters need be passed as the values\nwill default to those currently in use.\n\nIt doesn't return anything.\n", + "Opts": null } ], "Aliases": null, @@ -14014,18 +15690,16 @@ "Options": [ { "Name": "url", + "FieldName": "", "Help": "URL of seafile host to connect to.", - "Provider": "", "Default": "", "Value": null, "Examples": [ { "Value": "https://cloud.seafile.com/", - "Help": "Connect to cloud.seafile.com.", - "Provider": "" + "Help": "Connect to cloud.seafile.com." } ], - "ShortOpt": "", "Hide": 0, "Required": true, "IsPassword": false, @@ -14039,11 +15713,10 @@ }, { "Name": "user", + "FieldName": "", "Help": "User name (usually email address).", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": true, "IsPassword": false, @@ -14057,11 +15730,10 @@ }, { "Name": "pass", + "FieldName": "", "Help": "Password.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": true, @@ -14075,11 +15747,10 @@ }, { "Name": "2fa", + "FieldName": "", "Help": "Two-factor authentication ('true' if the account has 2FA enabled).", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14093,11 +15764,10 @@ }, { "Name": "library", + "FieldName": "", "Help": "Name of the library.\n\nLeave blank to access all non-encrypted libraries.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14111,11 +15781,10 @@ }, { "Name": "library_key", + "FieldName": "", "Help": "Library password (for encrypted libraries only).\n\nLeave blank if you pass it through the command line.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": true, @@ -14129,11 +15798,10 @@ }, { "Name": "create_library", + "FieldName": "", "Help": "Should rclone create a library if it doesn't exist.", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14147,11 +15815,10 @@ }, { "Name": "auth_token", + "FieldName": "", "Help": "Authentication token.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 3, "Required": false, "IsPassword": false, @@ -14165,11 +15832,10 @@ }, { "Name": "encoding", + "FieldName": "", "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", "Default": 16850954, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14179,7 +15845,24 @@ "Sensitive": false, "DefaultStr": "Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8", "ValueStr": "Slash,DoubleQuote,BackSlash,Ctl,InvalidUtf8", - "Type": "MultiEncoder" + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], "CommandHelp": null, @@ -14194,11 +15877,10 @@ "Options": [ { "Name": "host", + "FieldName": "", "Help": "SSH host to connect to.\n\nE.g. \"example.com\".", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": true, "IsPassword": false, @@ -14212,11 +15894,10 @@ }, { "Name": "user", + "FieldName": "", "Help": "SSH username.", - "Provider": "", "Default": "zenon", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14230,11 +15911,10 @@ }, { "Name": "port", + "FieldName": "", "Help": "SSH port number.", - "Provider": "", "Default": 22, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14248,11 +15928,10 @@ }, { "Name": "pass", + "FieldName": "", "Help": "SSH password, leave blank to use ssh-agent.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": true, @@ -14266,11 +15945,10 @@ }, { "Name": "key_pem", - "Help": "Raw PEM-encoded private key.\n\nIf specified, will override key_file parameter.", - "Provider": "", + "FieldName": "", + "Help": "Raw PEM-encoded private key.\n\nNote that this should be on a single line with line endings replaced with '\\n', eg\n\n key_pem = -----BEGIN RSA PRIVATE KEY-----\\nMaMbaIXtE\\n0gAMbMbaSsd\\nMbaass\\n-----END RSA PRIVATE KEY-----\n\nThis will generate the single line correctly:\n\n awk '{printf \"%s\\\\n\", $0}' < ~/.ssh/id_rsa\n\nIf specified, it will override the key_file parameter.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14284,11 +15962,10 @@ }, { "Name": "key_file", + "FieldName": "", "Help": "Path to PEM-encoded private key file.\n\nLeave blank or set key-use-agent to use ssh-agent.\n\nLeading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14302,11 +15979,10 @@ }, { "Name": "key_file_pass", + "FieldName": "", "Help": "The passphrase to decrypt the PEM-encoded private key file.\n\nOnly PEM encrypted key files (old OpenSSH format) are supported. Encrypted keys\nin the new OpenSSH format can't be used.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": true, @@ -14320,11 +15996,10 @@ }, { "Name": "pubkey_file", + "FieldName": "", "Help": "Optional path to public key file.\n\nSet this if you have a signed certificate you want to use for authentication.\n\nLeading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14338,18 +16013,16 @@ }, { "Name": "known_hosts_file", + "FieldName": "", "Help": "Optional path to known_hosts file.\n\nSet this value to enable server host key validation.\n\nLeading `~` will be expanded in the file name as will environment variables such as `${RCLONE_CONFIG_DIR}`.", - "Provider": "", "Default": "", "Value": null, "Examples": [ { "Value": "~/.ssh/known_hosts", - "Help": "Use OpenSSH's known_hosts file.", - "Provider": "" + "Help": "Use OpenSSH's known_hosts file." } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14363,11 +16036,10 @@ }, { "Name": "key_use_agent", + "FieldName": "", "Help": "When set forces the usage of the ssh-agent.\n\nWhen key-file is also set, the \".pub\" file of the specified key-file is read and only the associated key is\nrequested from the ssh-agent. This allows to avoid `Too many authentication failures for *username*` errors\nwhen the ssh-agent contains many keys.", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14381,23 +16053,20 @@ }, { "Name": "use_insecure_cipher", + "FieldName": "", "Help": "Enable the use of insecure ciphers and key exchange methods.\n\nThis enables the use of the following insecure ciphers and key exchange methods:\n\n- aes128-cbc\n- aes192-cbc\n- aes256-cbc\n- 3des-cbc\n- diffie-hellman-group-exchange-sha256\n- diffie-hellman-group-exchange-sha1\n\nThose algorithms are insecure and may allow plaintext data to be recovered by an attacker.\n\nThis must be false if you use either ciphers or key_exchange advanced options.\n", - "Provider": "", "Default": false, "Value": null, "Examples": [ { "Value": "false", - "Help": "Use default Cipher list.", - "Provider": "" + "Help": "Use default Cipher list." }, { "Value": "true", - "Help": "Enables the use of the aes128-cbc cipher and diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1 key exchange.", - "Provider": "" + "Help": "Enables the use of the aes128-cbc cipher and diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1 key exchange." } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14411,11 +16080,10 @@ }, { "Name": "disable_hashcheck", + "FieldName": "", "Help": "Disable the execution of SSH commands to determine if remote file hashing is available.\n\nLeave blank or set to false to enable hashing (recommended), set to true to disable hashing.", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14429,11 +16097,10 @@ }, { "Name": "ask_password", + "FieldName": "", "Help": "Allow asking for SFTP password when needed.\n\nIf this is set and no password is supplied then rclone will:\n- ask for a password\n- not contact the ssh agent\n", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14447,11 +16114,10 @@ }, { "Name": "path_override", - "Help": "Override path used by SSH shell commands.\n\nThis allows checksum calculation when SFTP and SSH paths are\ndifferent. This issue affects among others Synology NAS boxes.\n\nE.g. if shared folders can be found in directories representing volumes:\n\n rclone sync /home/local/directory remote:/directory --sftp-path-override /volume2/directory\n\nE.g. if home directory can be found in a shared folder called \"home\":\n\n rclone sync /home/local/directory remote:/home/directory --sftp-path-override /volume1/homes/USER/directory", - "Provider": "", + "FieldName": "", + "Help": "Override path used by SSH shell commands.\n\nThis allows checksum calculation when SFTP and SSH paths are\ndifferent. This issue affects among others Synology NAS boxes.\n\nE.g. if shared folders can be found in directories representing volumes:\n\n rclone sync /home/local/directory remote:/directory --sftp-path-override /volume2/directory\n\nE.g. if home directory can be found in a shared folder called \"home\":\n\n rclone sync /home/local/directory remote:/home/directory --sftp-path-override /volume1/homes/USER/directory\n\t\nTo specify only the path to the SFTP remote's root, and allow rclone to add any relative subpaths automatically (including unwrapping/decrypting remotes as necessary), add the '@' character to the beginning of the path.\n\nE.g. the first example above could be rewritten as:\n\n\trclone sync /home/local/directory remote:/directory --sftp-path-override @/volume2\n\t\nNote that when using this method with Synology \"home\" folders, the full \"/homes/USER\" path should be specified instead of \"/home\".\n\nE.g. the second example above should be rewritten as:\n\n\trclone sync /home/local/directory remote:/homes/USER/directory --sftp-path-override @/volume1", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14465,11 +16131,10 @@ }, { "Name": "set_modtime", + "FieldName": "", "Help": "Set the modified time on the remote if set.", - "Provider": "", "Default": true, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14483,33 +16148,28 @@ }, { "Name": "shell_type", + "FieldName": "", "Help": "The type of SSH shell on remote server, if any.\n\nLeave blank for autodetect.", - "Provider": "", "Default": "", "Value": null, "Examples": [ { "Value": "none", - "Help": "No shell access", - "Provider": "" + "Help": "No shell access" }, { "Value": "unix", - "Help": "Unix shell", - "Provider": "" + "Help": "Unix shell" }, { "Value": "powershell", - "Help": "PowerShell", - "Provider": "" + "Help": "PowerShell" }, { "Value": "cmd", - "Help": "Windows Command Prompt", - "Provider": "" + "Help": "Windows Command Prompt" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14523,11 +16183,10 @@ }, { "Name": "md5sum_command", + "FieldName": "", "Help": "The command used to read md5 hashes.\n\nLeave blank for autodetect.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14541,11 +16200,10 @@ }, { "Name": "sha1sum_command", + "FieldName": "", "Help": "The command used to read sha1 hashes.\n\nLeave blank for autodetect.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14559,11 +16217,10 @@ }, { "Name": "skip_links", + "FieldName": "", "Help": "Set to skip any symlinks and any other non regular files.", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14577,11 +16234,10 @@ }, { "Name": "subsystem", + "FieldName": "", "Help": "Specifies the SSH2 subsystem on the remote host.", - "Provider": "", "Default": "sftp", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14595,11 +16251,10 @@ }, { "Name": "server_command", - "Help": "Specifies the path or command to run a sftp server on the remote host.\n\nThe subsystem option is ignored when server_command is defined.", - "Provider": "", + "FieldName": "", + "Help": "Specifies the path or command to run a sftp server on the remote host.\n\nThe subsystem option is ignored when server_command is defined.\n\nIf adding server_command to the configuration file please note that \nit should not be enclosed in quotes, since that will make rclone fail.\n\nA working example is:\n\n [remote_name]\n type = sftp\n server_command = sudo /usr/libexec/openssh/sftp-server", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14613,11 +16268,10 @@ }, { "Name": "use_fstat", + "FieldName": "", "Help": "If set use fstat instead of stat.\n\nSome servers limit the amount of open files and calling Stat after opening\nthe file will throw an error from the server. Setting this flag will call\nFstat instead of Stat which is called on an already open file handle.\n\nIt has been found that this helps with IBM Sterling SFTP servers which have\n\"extractability\" level set to 1 which means only 1 file can be opened at\nany given time.\n", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14631,11 +16285,10 @@ }, { "Name": "disable_concurrent_reads", + "FieldName": "", "Help": "If set don't use concurrent reads.\n\nNormally concurrent reads are safe to use and not using them will\ndegrade performance, so this option is disabled by default.\n\nSome servers limit the amount number of times a file can be\ndownloaded. Using concurrent reads can trigger this limit, so if you\nhave a server which returns\n\n Failed to copy: file does not exist\n\nThen you may need to enable this flag.\n\nIf concurrent reads are disabled, the use_fstat option is ignored.\n", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14649,11 +16302,10 @@ }, { "Name": "disable_concurrent_writes", + "FieldName": "", "Help": "If set don't use concurrent writes.\n\nNormally rclone uses concurrent writes to upload files. This improves\nthe performance greatly, especially for distant servers.\n\nThis option disables concurrent writes should that be necessary.\n", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14667,11 +16319,10 @@ }, { "Name": "idle_timeout", + "FieldName": "", "Help": "Max time before closing idle connections.\n\nIf no connections have been returned to the connection pool in the time\ngiven, rclone will empty the connection pool.\n\nSet to 0 to keep connections indefinitely.\n", - "Provider": "", "Default": 60000000000, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14685,11 +16336,10 @@ }, { "Name": "chunk_size", + "FieldName": "", "Help": "Upload and download chunk size.\n\nThis controls the maximum size of payload in SFTP protocol packets.\nThe RFC limits this to 32768 bytes (32k), which is the default. However,\na lot of servers support larger sizes, typically limited to a maximum\ntotal package size of 256k, and setting it larger will increase transfer\nspeed dramatically on high latency links. This includes OpenSSH, and,\nfor example, using the value of 255k works well, leaving plenty of room\nfor overhead while still being within a total packet size of 256k.\n\nMake sure to test thoroughly before using a value higher than 32k,\nand only use it if you always connect to the same server or after\nsufficiently broad testing. If you get errors such as\n\"failed to send packet payload: EOF\", lots of \"connection lost\",\nor \"corrupted on transfer\", when copying a larger file, try lowering\nthe value. The server run by [rclone serve sftp](/commands/rclone_serve_sftp)\nsends packets with standard 32k maximum payload so you must not\nset a different chunk_size when downloading files, but it accepts\npackets up to the 256k total size, so for uploads the chunk_size\ncan be set as for the OpenSSH example above.\n", - "Provider": "", "Default": 32768, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14703,11 +16353,10 @@ }, { "Name": "concurrency", + "FieldName": "", "Help": "The maximum number of outstanding requests for one file\n\nThis controls the maximum number of outstanding requests for one file.\nIncreasing it will increase throughput on high latency links at the\ncost of using more memory.\n", - "Provider": "", "Default": 64, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14719,13 +16368,29 @@ "ValueStr": "64", "Type": "int" }, + { + "Name": "connections", + "FieldName": "", + "Help": "Maximum number of SFTP simultaneous connections, 0 for unlimited.\n\nNote that setting this is very likely to cause deadlocks so it should\nbe used with care.\n\nIf you are doing a sync or copy then make sure connections is one more\nthan the sum of `--transfers` and `--checkers`.\n\nIf you use `--check-first` then it just needs to be one more than the\nmaximum of `--checkers` and `--transfers`.\n\nSo for `connections 3` you'd use `--checkers 2 --transfers 2\n--check-first` or `--checkers 1 --transfers 1`.\n\n", + "Default": 0, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "0", + "ValueStr": "0", + "Type": "int" + }, { "Name": "set_env", + "FieldName": "", "Help": "Environment variables to pass to sftp and commands\n\nSet environment variables in the form:\n\n VAR=value\n\nto be passed to the sftp client and to any commands run (eg md5sum).\n\nPass multiple variables space separated, eg\n\n VAR1=value VAR2=value\n\nand pass variables with spaces in quotes, eg\n\n \"VAR3=value with space\" \"VAR4=value with space\" VAR5=nospacehere\n\n", - "Provider": "", "Default": [], "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14739,11 +16404,10 @@ }, { "Name": "ciphers", + "FieldName": "", "Help": "Space separated list of ciphers to be used for session encryption, ordered by preference.\n\nAt least one must match with server configuration. This can be checked for example using ssh -Q cipher.\n\nThis must not be set if use_insecure_cipher is true.\n\nExample:\n\n aes128-ctr aes192-ctr aes256-ctr aes128-gcm@openssh.com aes256-gcm@openssh.com\n", - "Provider": "", "Default": [], "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14757,11 +16421,10 @@ }, { "Name": "key_exchange", + "FieldName": "", "Help": "Space separated list of key exchange algorithms, ordered by preference.\n\nAt least one must match with server configuration. This can be checked for example using ssh -Q kex.\n\nThis must not be set if use_insecure_cipher is true.\n\nExample:\n\n sntrup761x25519-sha512@openssh.com curve25519-sha256 curve25519-sha256@libssh.org ecdh-sha2-nistp256\n", - "Provider": "", "Default": [], "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14775,11 +16438,10 @@ }, { "Name": "macs", + "FieldName": "", "Help": "Space separated list of MACs (message authentication code) algorithms, ordered by preference.\n\nAt least one must match with server configuration. This can be checked for example using ssh -Q mac.\n\nExample:\n\n umac-64-etm@openssh.com umac-128-etm@openssh.com hmac-sha2-256-etm@openssh.com\n", - "Provider": "", "Default": [], "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14793,11 +16455,10 @@ }, { "Name": "host_key_algorithms", + "FieldName": "", "Help": "Space separated list of host key algorithms, ordered by preference.\n\nAt least one must match with server configuration. This can be checked for example using ssh -Q HostKeyAlgorithms.\n\nNote: This can affect the outcome of key negotiation with the server even if server host key validation is not enabled.\n\nExample:\n\n ssh-ed25519 ssh-rsa ssh-dss\n", - "Provider": "", "Default": [], "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14808,6 +16469,74 @@ "DefaultStr": "", "ValueStr": "", "Type": "SpaceSepList" + }, + { + "Name": "ssh", + "FieldName": "", + "Help": "Path and arguments to external ssh binary.\n\nNormally rclone will use its internal ssh library to connect to the\nSFTP server. However it does not implement all possible ssh options so\nit may be desirable to use an external ssh binary.\n\nRclone ignores all the internal config if you use this option and\nexpects you to configure the ssh binary with the user/host/port and\nany other options you need.\n\n**Important** The ssh command must log in without asking for a\npassword so needs to be configured with keys or certificates.\n\nRclone will run the command supplied either with the additional\narguments \"-s sftp\" to access the SFTP subsystem or with commands such\nas \"md5sum /path/to/file\" appended to read checksums.\n\nAny arguments with spaces in should be surrounded by \"double quotes\".\n\nAn example setting might be:\n\n ssh -o ServerAliveInterval=20 user@example.com\n\nNote that when using an external ssh binary rclone makes a new ssh\nconnection for every hash it calculates.\n", + "Default": [], + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "SpaceSepList" + }, + { + "Name": "socks_proxy", + "FieldName": "", + "Help": "Socks 5 proxy host.\n\t\nSupports the format user:pass@host:port, user@host:port, host:port.\n\nExample:\n\n\tmyUser:myPass@localhost:9005\n\t", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "copy_is_hardlink", + "FieldName": "", + "Help": "Set to enable server side copies using hardlinks.\n\nThe SFTP protocol does not define a copy command so normally server\nside copies are not allowed with the sftp backend.\n\nHowever the SFTP protocol does support hardlinking, and if you enable\nthis flag then the sftp backend will support server side copies. These\nwill be implemented by doing a hardlink from the source to the\ndestination.\n\nNot all sftp servers support this.\n\nNote that hardlinking two files together will use no additional space\nas the source and the destination will be the same file.\n\nThis feature may be useful backups made with --copy-dest.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], "CommandHelp": null, @@ -14822,11 +16551,10 @@ "Options": [ { "Name": "client_id", + "FieldName": "", "Help": "OAuth Client Id.\n\nLeave blank normally.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14840,11 +16568,10 @@ }, { "Name": "client_secret", + "FieldName": "", "Help": "OAuth Client Secret.\n\nLeave blank normally.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14858,11 +16585,10 @@ }, { "Name": "token", + "FieldName": "", "Help": "OAuth Access Token as a JSON blob.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14876,11 +16602,10 @@ }, { "Name": "auth_url", + "FieldName": "", "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14894,11 +16619,10 @@ }, { "Name": "token_url", + "FieldName": "", "Help": "Token server url.\n\nLeave blank to use the provider defaults.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14912,11 +16636,10 @@ }, { "Name": "upload_cutoff", + "FieldName": "", "Help": "Cutoff for switching to multipart upload.", - "Provider": "", "Default": 134217728, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14930,38 +16653,32 @@ }, { "Name": "root_folder_id", + "FieldName": "", "Help": "ID of the root folder.\n\nLeave blank to access \"Personal Folders\". You can use one of the\nstandard values here or any folder ID (long hex number ID).", - "Provider": "", "Default": "", "Value": null, "Examples": [ { "Value": "", - "Help": "Access the Personal Folders (default).", - "Provider": "" + "Help": "Access the Personal Folders (default)." }, { "Value": "favorites", - "Help": "Access the Favorites folder.", - "Provider": "" + "Help": "Access the Favorites folder." }, { "Value": "allshared", - "Help": "Access all the shared folders.", - "Provider": "" + "Help": "Access all the shared folders." }, { "Value": "connectors", - "Help": "Access all the individual connectors.", - "Provider": "" + "Help": "Access all the individual connectors." }, { "Value": "top", - "Help": "Access the home, favorites, and shared folders as well as the connectors.", - "Provider": "" + "Help": "Access the home, favorites, and shared folders as well as the connectors." } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14975,11 +16692,10 @@ }, { "Name": "chunk_size", - "Help": "Upload chunk size.\n\nMust a power of 2 \u003e= 256k.\n\nMaking this larger will improve performance, but note that each chunk\nis buffered in memory one per transfer.\n\nReducing this will reduce memory usage but decrease performance.", - "Provider": "", + "FieldName": "", + "Help": "Upload chunk size.\n\nMust a power of 2 >= 256k.\n\nMaking this larger will improve performance, but note that each chunk\nis buffered in memory one per transfer.\n\nReducing this will reduce memory usage but decrease performance.", "Default": 67108864, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -14993,11 +16709,10 @@ }, { "Name": "endpoint", + "FieldName": "", "Help": "Endpoint for API calls.\n\nThis is usually auto discovered as part of the oauth process, but can\nbe set manually to something like: https://XXX.sharefile.com\n", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15011,11 +16726,10 @@ }, { "Name": "encoding", + "FieldName": "", "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", "Default": 57091982, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15025,7 +16739,24 @@ "Sensitive": false, "DefaultStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot", "ValueStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot", - "Type": "MultiEncoder" + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], "CommandHelp": null, @@ -15040,11 +16771,10 @@ "Options": [ { "Name": "api_url", + "FieldName": "", "Help": "Sia daemon API URL, like http://sia.daemon.host:9980.\n\nNote that siad must run with --disable-api-security to open API port for other hosts (not recommended).\nKeep default if Sia daemon runs on localhost.", - "Provider": "", "Default": "http://127.0.0.1:9980", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15058,11 +16788,10 @@ }, { "Name": "api_password", + "FieldName": "", "Help": "Sia Daemon API Password.\n\nCan be found in the apipassword file located in HOME/.sia/ or in the daemon directory.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": true, @@ -15076,11 +16805,10 @@ }, { "Name": "user_agent", + "FieldName": "", "Help": "Siad User Agent\n\nSia daemon requires the 'Sia-Agent' user agent by default for security", - "Provider": "", "Default": "Sia-Agent", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15094,11 +16822,10 @@ }, { "Name": "encoding", + "FieldName": "", "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", "Default": 50436354, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15108,7 +16835,24 @@ "Sensitive": false, "DefaultStr": "Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot", "ValueStr": "Slash,Question,Hash,Percent,Del,Ctl,InvalidUtf8,Dot", - "Type": "MultiEncoder" + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], "CommandHelp": null, @@ -15123,11 +16867,10 @@ "Options": [ { "Name": "host", + "FieldName": "", "Help": "SMB server hostname to connect to.\n\nE.g. \"example.com\".", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": true, "IsPassword": false, @@ -15141,11 +16884,10 @@ }, { "Name": "user", + "FieldName": "", "Help": "SMB username.", - "Provider": "", "Default": "zenon", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15159,11 +16901,10 @@ }, { "Name": "port", + "FieldName": "", "Help": "SMB port number.", - "Provider": "", "Default": 445, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15177,11 +16918,10 @@ }, { "Name": "pass", + "FieldName": "", "Help": "SMB password.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": true, @@ -15195,11 +16935,10 @@ }, { "Name": "domain", + "FieldName": "", "Help": "Domain name for NTLM authentication.", - "Provider": "", "Default": "WORKGROUP", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15213,11 +16952,10 @@ }, { "Name": "spn", + "FieldName": "", "Help": "Service principal name.\n\nRclone presents this name to the server. Some servers use this as further\nauthentication, and it often needs to be set for clusters. For example:\n\n cifs/remotehost:1020\n\nLeave blank if not sure.\n", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15231,11 +16969,10 @@ }, { "Name": "idle_timeout", + "FieldName": "", "Help": "Max time before closing idle connections.\n\nIf no connections have been returned to the connection pool in the time\ngiven, rclone will empty the connection pool.\n\nSet to 0 to keep connections indefinitely.\n", - "Provider": "", "Default": 60000000000, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15249,11 +16986,10 @@ }, { "Name": "hide_special_share", + "FieldName": "", "Help": "Hide special shares (e.g. print$) which users aren't supposed to access.", - "Provider": "", "Default": true, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15267,11 +17003,10 @@ }, { "Name": "case_insensitive", + "FieldName": "", "Help": "Whether the server is configured to be case-insensitive.\n\nAlways true on Windows shares.", - "Provider": "", "Default": true, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15285,11 +17020,10 @@ }, { "Name": "encoding", + "FieldName": "", "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", "Default": 56698766, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15299,171 +17033,53 @@ "Sensitive": false, "DefaultStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot", "ValueStr": "Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,RightSpace,RightPeriod,InvalidUtf8,Dot", - "Type": "MultiEncoder" - } - ], - "CommandHelp": null, - "Aliases": null, - "Hide": false, - "MetadataInfo": null - }, - { - "Name": "storj", - "Description": "Storj Decentralized Cloud Storage", - "Prefix": "storj", - "Options": [ - { - "Name": "provider", - "Help": "Choose an authentication method.", - "Provider": "", - "Default": "existing", - "Value": null, - "Examples": [ - { - "Value": "existing", - "Help": "Use an existing access grant.", - "Provider": "" - }, - { - "Value": "new", - "Help": "Create a new access grant from satellite address, API key, and passphrase.", - "Provider": "" - } - ], - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": false, - "DefaultStr": "existing", - "ValueStr": "existing", - "Type": "string" + "Type": "Encoding" }, { - "Name": "access_grant", - "Help": "Access grant.", - "Provider": "existing", + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" - }, - { - "Name": "satellite_address", - "Help": "Satellite address.\n\nCustom satellite address should match the format: `\u003cnodeid\u003e@\u003caddress\u003e:\u003cport\u003e`.", - "Provider": "new", - "Default": "us1.storj.io", - "Value": null, - "Examples": [ - { - "Value": "us1.storj.io", - "Help": "US1", - "Provider": "" - }, - { - "Value": "eu1.storj.io", - "Help": "EU1", - "Provider": "" - }, - { - "Value": "ap1.storj.io", - "Help": "AP1", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "us1.storj.io", - "ValueStr": "us1.storj.io", - "Type": "string" - }, - { - "Name": "api_key", - "Help": "API key.", - "Provider": "new", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" - }, - { - "Name": "passphrase", - "Help": "Encryption passphrase.\n\nTo access existing objects enter passphrase used for uploading.", - "Provider": "new", - "Default": "", - "Value": null, - "ShortOpt": "", - "Hide": 0, - "Required": false, - "IsPassword": false, - "NoPrefix": false, - "Advanced": false, - "Exclusive": false, - "Sensitive": true, "DefaultStr": "", "ValueStr": "", "Type": "string" } ], "CommandHelp": null, - "Aliases": [ - "tardigrade" - ], + "Aliases": null, "Hide": false, "MetadataInfo": null }, { - "Name": "tardigrade", + "Name": "storj", "Description": "Storj Decentralized Cloud Storage", - "Prefix": "tardigrade", + "Prefix": "storj", "Options": [ { "Name": "provider", + "FieldName": "", "Help": "Choose an authentication method.", - "Provider": "", "Default": "existing", "Value": null, "Examples": [ { "Value": "existing", - "Help": "Use an existing access grant.", - "Provider": "" + "Help": "Use an existing access grant." }, { "Value": "new", - "Help": "Create a new access grant from satellite address, API key, and passphrase.", - "Provider": "" + "Help": "Create a new access grant from satellite address, API key, and passphrase." } ], - "ShortOpt": "", - "Hide": 3, + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, @@ -15476,12 +17092,12 @@ }, { "Name": "access_grant", + "FieldName": "", "Help": "Access grant.", "Provider": "existing", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 3, + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, @@ -15494,29 +17110,26 @@ }, { "Name": "satellite_address", - "Help": "Satellite address.\n\nCustom satellite address should match the format: `\u003cnodeid\u003e@\u003caddress\u003e:\u003cport\u003e`.", + "FieldName": "", + "Help": "Satellite address.\n\nCustom satellite address should match the format: `@
:`.", "Provider": "new", "Default": "us1.storj.io", "Value": null, "Examples": [ { "Value": "us1.storj.io", - "Help": "US1", - "Provider": "" + "Help": "US1" }, { "Value": "eu1.storj.io", - "Help": "EU1", - "Provider": "" + "Help": "EU1" }, { "Value": "ap1.storj.io", - "Help": "AP1", - "Provider": "" + "Help": "AP1" } ], - "ShortOpt": "", - "Hide": 3, + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, @@ -15529,12 +17142,12 @@ }, { "Name": "api_key", + "FieldName": "", "Help": "API key.", "Provider": "new", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 3, + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, @@ -15547,12 +17160,12 @@ }, { "Name": "passphrase", + "FieldName": "", "Help": "Encryption passphrase.\n\nTo access existing objects enter passphrase used for uploading.", "Provider": "new", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 3, + "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, @@ -15562,13 +17175,30 @@ "DefaultStr": "", "ValueStr": "", "Type": "string" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], "CommandHelp": null, "Aliases": [ "tardigrade" ], - "Hide": true, + "Hide": false, "MetadataInfo": null }, { @@ -15578,11 +17208,10 @@ "Options": [ { "Name": "app_id", + "FieldName": "", "Help": "Sugarsync App ID.\n\nLeave blank to use rclone's.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15596,11 +17225,10 @@ }, { "Name": "access_key_id", + "FieldName": "", "Help": "Sugarsync Access Key ID.\n\nLeave blank to use rclone's.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15614,11 +17242,10 @@ }, { "Name": "private_access_key", + "FieldName": "", "Help": "Sugarsync Private Access Key.\n\nLeave blank to use rclone's.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15632,11 +17259,10 @@ }, { "Name": "hard_delete", + "FieldName": "", "Help": "Permanently delete files if true\notherwise put them in the deleted files.", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15650,11 +17276,10 @@ }, { "Name": "refresh_token", + "FieldName": "", "Help": "Sugarsync refresh token.\n\nLeave blank normally, will be auto configured by rclone.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15668,11 +17293,10 @@ }, { "Name": "authorization", + "FieldName": "", "Help": "Sugarsync authorization.\n\nLeave blank normally, will be auto configured by rclone.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15686,11 +17310,10 @@ }, { "Name": "authorization_expiry", + "FieldName": "", "Help": "Sugarsync authorization expiry.\n\nLeave blank normally, will be auto configured by rclone.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15704,11 +17327,10 @@ }, { "Name": "user", + "FieldName": "", "Help": "Sugarsync user.\n\nLeave blank normally, will be auto configured by rclone.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15722,11 +17344,10 @@ }, { "Name": "root_id", + "FieldName": "", "Help": "Sugarsync root id.\n\nLeave blank normally, will be auto configured by rclone.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15740,11 +17361,10 @@ }, { "Name": "deleted_id", + "FieldName": "", "Help": "Sugarsync deleted folder id.\n\nLeave blank normally, will be auto configured by rclone.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15758,11 +17378,10 @@ }, { "Name": "encoding", + "FieldName": "", "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", "Default": 50397186, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15772,7 +17391,24 @@ "Sensitive": false, "DefaultStr": "Slash,Ctl,InvalidUtf8,Dot", "ValueStr": "Slash,Ctl,InvalidUtf8,Dot", - "Type": "MultiEncoder" + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], "CommandHelp": null, @@ -15787,23 +17423,20 @@ "Options": [ { "Name": "env_auth", + "FieldName": "", "Help": "Get swift credentials from environment variables in standard OpenStack form.", - "Provider": "", "Default": false, "Value": null, "Examples": [ { "Value": "false", - "Help": "Enter swift credentials in the next step.", - "Provider": "" + "Help": "Enter swift credentials in the next step." }, { "Value": "true", - "Help": "Get swift credentials from environment vars.\nLeave other fields blank if using this.", - "Provider": "" + "Help": "Get swift credentials from environment vars.\nLeave other fields blank if using this." } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15816,12 +17449,245 @@ "Type": "bool" }, { - "Name": "user", - "Help": "User name to log in (OS_USERNAME).", - "Provider": "", + "Name": "user", + "FieldName": "", + "Help": "User name to log in (OS_USERNAME).", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "key", + "FieldName": "", + "Help": "API key or password (OS_PASSWORD).", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "auth", + "FieldName": "", + "Help": "Authentication URL for server (OS_AUTH_URL).", + "Default": "", + "Value": null, + "Examples": [ + { + "Value": "https://auth.api.rackspacecloud.com/v1.0", + "Help": "Rackspace US" + }, + { + "Value": "https://lon.auth.api.rackspacecloud.com/v1.0", + "Help": "Rackspace UK" + }, + { + "Value": "https://identity.api.rackspacecloud.com/v2.0", + "Help": "Rackspace v2" + }, + { + "Value": "https://auth.storage.memset.com/v1.0", + "Help": "Memset Memstore UK" + }, + { + "Value": "https://auth.storage.memset.com/v2.0", + "Help": "Memset Memstore UK v2" + }, + { + "Value": "https://auth.cloud.ovh.net/v3", + "Help": "OVH" + }, + { + "Value": "https://authenticate.ain.net", + "Help": "Blomp Cloud Storage" + } + ], + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "user_id", + "FieldName": "", + "Help": "User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID).", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "domain", + "FieldName": "", + "Help": "User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME)", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "tenant", + "FieldName": "", + "Help": "Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME).", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "tenant_id", + "FieldName": "", + "Help": "Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID).", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "tenant_domain", + "FieldName": "", + "Help": "Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME).", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "region", + "FieldName": "", + "Help": "Region name - optional (OS_REGION_NAME).", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "storage_url", + "FieldName": "", + "Help": "Storage URL - optional (OS_STORAGE_URL).", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "auth_token", + "FieldName": "", + "Help": "Auth Token from alternate authentication - optional (OS_AUTH_TOKEN).", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "application_credential_id", + "FieldName": "", + "Help": "Application Credential ID (OS_APPLICATION_CREDENTIAL_ID).", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "application_credential_name", + "FieldName": "", + "Help": "Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME).", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15834,12 +17700,11 @@ "Type": "string" }, { - "Name": "key", - "Help": "API key or password (OS_PASSWORD).", - "Provider": "", + "Name": "application_credential_secret", + "FieldName": "", + "Help": "Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET).", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15852,49 +17717,90 @@ "Type": "string" }, { - "Name": "auth", - "Help": "Authentication URL for server (OS_AUTH_URL).", - "Provider": "", - "Default": "", + "Name": "auth_version", + "FieldName": "", + "Help": "AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION).", + "Default": 0, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "0", + "ValueStr": "0", + "Type": "int" + }, + { + "Name": "endpoint_type", + "FieldName": "", + "Help": "Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE).", + "Default": "public", "Value": null, "Examples": [ { - "Value": "https://auth.api.rackspacecloud.com/v1.0", - "Help": "Rackspace US", - "Provider": "" - }, - { - "Value": "https://lon.auth.api.rackspacecloud.com/v1.0", - "Help": "Rackspace UK", - "Provider": "" + "Value": "public", + "Help": "Public (default, choose this if not sure)" }, { - "Value": "https://identity.api.rackspacecloud.com/v2.0", - "Help": "Rackspace v2", - "Provider": "" + "Value": "internal", + "Help": "Internal (use internal service net)" }, { - "Value": "https://auth.storage.memset.com/v1.0", - "Help": "Memset Memstore UK", - "Provider": "" - }, + "Value": "admin", + "Help": "Admin" + } + ], + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "public", + "ValueStr": "public", + "Type": "string" + }, + { + "Name": "leave_parts_on_error", + "FieldName": "", + "Help": "If true avoid calling abort upload on a failure.\n\nIt should be set to true for resuming uploads across different sessions.", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "storage_policy", + "FieldName": "", + "Help": "The storage policy to use when creating a new container.\n\nThis applies the specified storage policy when creating a new\ncontainer. The policy cannot be changed afterwards. The allowed\nconfiguration values and their meaning depend on your Swift storage\nprovider.", + "Default": "", + "Value": null, + "Examples": [ { - "Value": "https://auth.storage.memset.com/v2.0", - "Help": "Memset Memstore UK v2", - "Provider": "" + "Value": "", + "Help": "Default" }, { - "Value": "https://auth.cloud.ovh.net/v3", - "Help": "OVH", - "Provider": "" + "Value": "pcs", + "Help": "OVH Public Cloud Storage" }, { - "Value": "https://authenticate.ain.net", - "Help": "Blomp Cloud Storage", - "Provider": "" + "Value": "pca", + "Help": "OVH Public Cloud Archive" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -15907,139 +17813,190 @@ "Type": "string" }, { - "Name": "user_id", - "Help": "User ID to log in - optional - most swift systems use user and leave this blank (v3 auth) (OS_USER_ID).", - "Provider": "", - "Default": "", + "Name": "fetch_until_empty_page", + "FieldName": "", + "Help": "When paginating, always fetch unless we received an empty page.\n\nConsider using this option if rclone listings show fewer objects\nthan expected, or if repeated syncs copy unchanged objects.\n\nIt is safe to enable this, but rclone may make more API calls than\nnecessary.\n\nThis is one of a pair of workarounds to handle implementations\nof the Swift API that do not implement pagination as expected. See\nalso \"partial_page_fetch_threshold\".", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "domain", - "Help": "User domain - optional (v3 auth) (OS_USER_DOMAIN_NAME)", - "Provider": "", - "Default": "", + "Name": "partial_page_fetch_threshold", + "FieldName": "", + "Help": "When paginating, fetch if the current page is within this percentage of the limit.\n\nConsider using this option if rclone listings show fewer objects\nthan expected, or if repeated syncs copy unchanged objects.\n\nIt is safe to enable this, but rclone may make more API calls than\nnecessary.\n\nThis is one of a pair of workarounds to handle implementations\nof the Swift API that do not implement pagination as expected. See\nalso \"fetch_until_empty_page\".", + "Default": 0, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "0", + "ValueStr": "0", + "Type": "int" }, { - "Name": "tenant", - "Help": "Tenant name - optional for v1 auth, this or tenant_id required otherwise (OS_TENANT_NAME or OS_PROJECT_NAME).", - "Provider": "", - "Default": "", + "Name": "chunk_size", + "FieldName": "", + "Help": "Above this size files will be chunked.\n\nAbove this size files will be chunked into a a `_segments` container\nor a `.file-segments` directory. (See the `use_segments_container` option\nfor more info). Default for this is 5 GiB which is its maximum value, which\nmeans only files above this size will be chunked.\n\nRclone uploads chunked files as dynamic large objects (DLO).\n", + "Default": 5368709120, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "5Gi", + "ValueStr": "5Gi", + "Type": "SizeSuffix" }, { - "Name": "tenant_id", - "Help": "Tenant ID - optional for v1 auth, this or tenant required otherwise (OS_TENANT_ID).", - "Provider": "", - "Default": "", + "Name": "no_chunk", + "FieldName": "", + "Help": "Don't chunk files during streaming upload.\n\nWhen doing streaming uploads (e.g. using `rcat` or `mount` with\n`--vfs-cache-mode off`) setting this flag will cause the swift backend\nto not upload chunked files.\n\nThis will limit the maximum streamed upload size to 5 GiB. This is\nuseful because non chunked files are easier to deal with and have an\nMD5SUM.\n\nRclone will still chunk files bigger than `chunk_size` when doing\nnormal copy operations.", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "tenant_domain", - "Help": "Tenant domain - optional (v3 auth) (OS_PROJECT_DOMAIN_NAME).", - "Provider": "", - "Default": "", + "Name": "no_large_objects", + "FieldName": "", + "Help": "Disable support for static and dynamic large objects\n\nSwift cannot transparently store files bigger than 5 GiB. There are\ntwo schemes for chunking large files, static large objects (SLO) or\ndynamic large objects (DLO), and the API does not allow rclone to\ndetermine whether a file is a static or dynamic large object without\ndoing a HEAD on the object. Since these need to be treated\ndifferently, this means rclone has to issue HEAD requests for objects\nfor example when reading checksums.\n\nWhen `no_large_objects` is set, rclone will assume that there are no\nstatic or dynamic large objects stored. This means it can stop doing\nthe extra HEAD calls which in turn increases performance greatly\nespecially when doing a swift to swift transfer with `--checksum` set.\n\nSetting this option implies `no_chunk` and also that no files will be\nuploaded in chunks, so files bigger than 5 GiB will just fail on\nupload.\n\nIf you set this option and there **are** static or dynamic large objects,\nthen this will give incorrect hashes for them. Downloads will succeed,\nbut other operations such as Remove and Copy will fail.\n", + "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" }, { - "Name": "region", - "Help": "Region name - optional (OS_REGION_NAME).", - "Provider": "", - "Default": "", + "Name": "use_segments_container", + "FieldName": "", + "Help": "Choose destination for large object segments\n\nSwift cannot transparently store files bigger than 5 GiB and rclone\nwill chunk files larger than `chunk_size` (default 5 GiB) in order to\nupload them.\n\nIf this value is `true` the chunks will be stored in an additional\ncontainer named the same as the destination container but with\n`_segments` appended. This means that there won't be any duplicated\ndata in the original container but having another container may not be\nacceptable.\n\nIf this value is `false` the chunks will be stored in a\n`.file-segments` directory in the root of the container. This\ndirectory will be omitted when listing the container. Some\nproviders (eg Blomp) require this mode as creating additional\ncontainers isn't allowed. If it is desired to see the `.file-segments`\ndirectory in the root then this flag must be set to `true`.\n\nIf this value is `unset` (the default), then rclone will choose the value\nto use. It will be `false` unless rclone detects any `auth_url`s that\nit knows need it to be `true`. In this case you'll see a message in\nthe DEBUG log.\n", + "Default": { + "Value": false, + "Valid": false + }, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "", - "ValueStr": "", - "Type": "string" + "DefaultStr": "unset", + "ValueStr": "unset", + "Type": "Tristate" }, { - "Name": "storage_url", - "Help": "Storage URL - optional (OS_STORAGE_URL).", - "Provider": "", + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 16777218, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "Slash,InvalidUtf8", + "ValueStr": "Slash,InvalidUtf8", + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, "DefaultStr": "", "ValueStr": "", "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": null, + "Hide": false, + "MetadataInfo": null + }, + { + "Name": "tardigrade", + "Description": "Storj Decentralized Cloud Storage", + "Prefix": "tardigrade", + "Options": [ + { + "Name": "provider", + "FieldName": "", + "Help": "Choose an authentication method.", + "Default": "existing", + "Value": null, + "Examples": [ + { + "Value": "existing", + "Help": "Use an existing access grant." + }, + { + "Value": "new", + "Help": "Create a new access grant from satellite address, API key, and passphrase." + } + ], + "Hide": 3, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": false, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "existing", + "ValueStr": "existing", + "Type": "string" }, { - "Name": "auth_token", - "Help": "Auth Token from alternate authentication - optional (OS_AUTH_TOKEN).", - "Provider": "", + "Name": "access_grant", + "FieldName": "", + "Help": "Access grant.", + "Provider": "existing", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 3, "Required": false, "IsPassword": false, "NoPrefix": false, @@ -16051,31 +18008,45 @@ "Type": "string" }, { - "Name": "application_credential_id", - "Help": "Application Credential ID (OS_APPLICATION_CREDENTIAL_ID).", - "Provider": "", - "Default": "", + "Name": "satellite_address", + "FieldName": "", + "Help": "Satellite address.\n\nCustom satellite address should match the format: `@
:`.", + "Provider": "new", + "Default": "us1.storj.io", "Value": null, - "ShortOpt": "", - "Hide": 0, + "Examples": [ + { + "Value": "us1.storj.io", + "Help": "US1" + }, + { + "Value": "eu1.storj.io", + "Help": "EU1" + }, + { + "Value": "ap1.storj.io", + "Help": "AP1" + } + ], + "Hide": 3, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": false, "Exclusive": false, - "Sensitive": true, - "DefaultStr": "", - "ValueStr": "", + "Sensitive": false, + "DefaultStr": "us1.storj.io", + "ValueStr": "us1.storj.io", "Type": "string" }, { - "Name": "application_credential_name", - "Help": "Application Credential Name (OS_APPLICATION_CREDENTIAL_NAME).", - "Provider": "", + "Name": "api_key", + "FieldName": "", + "Help": "API key.", + "Provider": "new", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 3, "Required": false, "IsPassword": false, "NoPrefix": false, @@ -16087,13 +18058,13 @@ "Type": "string" }, { - "Name": "application_credential_secret", - "Help": "Application Credential Secret (OS_APPLICATION_CREDENTIAL_SECRET).", - "Provider": "", + "Name": "passphrase", + "FieldName": "", + "Help": "Encryption passphrase.\n\nTo access existing objects enter passphrase used for uploading.", + "Provider": "new", "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 3, "Required": false, "IsPassword": false, "NoPrefix": false, @@ -16105,103 +18076,78 @@ "Type": "string" }, { - "Name": "auth_version", - "Help": "AuthVersion - optional - set to (1,2,3) if your auth URL has no version (ST_AUTH_VERSION).", - "Provider": "", - "Default": 0, + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", "Value": null, - "ShortOpt": "", - "Hide": 0, + "Hide": 3, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": false, + "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "0", - "ValueStr": "0", - "Type": "int" - }, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + } + ], + "CommandHelp": null, + "Aliases": [ + "tardigrade" + ], + "Hide": true, + "MetadataInfo": null + }, + { + "Name": "ulozto", + "Description": "Uloz.to", + "Prefix": "ulozto", + "Options": [ { - "Name": "endpoint_type", - "Help": "Endpoint type to choose from the service catalogue (OS_ENDPOINT_TYPE).", - "Provider": "", - "Default": "public", + "Name": "app_token", + "FieldName": "", + "Help": "The application token identifying the app. An app API key can be either found in the API\ndoc https://uloz.to/upload-resumable-api-beta or obtained from customer service.", + "Default": "", "Value": null, - "Examples": [ - { - "Value": "public", - "Help": "Public (default, choose this if not sure)", - "Provider": "" - }, - { - "Value": "internal", - "Help": "Internal (use internal service net)", - "Provider": "" - }, - { - "Value": "admin", - "Help": "Admin", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "public", - "ValueStr": "public", + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", "Type": "string" }, { - "Name": "leave_parts_on_error", - "Help": "If true avoid calling abort upload on a failure.\n\nIt should be set to true for resuming uploads across different sessions.", - "Provider": "", - "Default": false, + "Name": "username", + "FieldName": "", + "Help": "The username of the principal to operate as.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, - "Advanced": true, + "Advanced": false, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "storage_policy", - "Help": "The storage policy to use when creating a new container.\n\nThis applies the specified storage policy when creating a new\ncontainer. The policy cannot be changed afterwards. The allowed\nconfiguration values and their meaning depend on your Swift storage\nprovider.", - "Provider": "", + "Name": "password", + "FieldName": "", + "Help": "The password for the user.", "Default": "", "Value": null, - "Examples": [ - { - "Value": "", - "Help": "Default", - "Provider": "" - }, - { - "Value": "pcs", - "Help": "OVH Public Cloud Storage", - "Provider": "" - }, - { - "Value": "pca", - "Help": "OVH Public Cloud Archive", - "Provider": "" - } - ], - "ShortOpt": "", "Hide": 0, "Required": false, - "IsPassword": false, + "IsPassword": true, "NoPrefix": false, "Advanced": false, "Exclusive": false, @@ -16211,30 +18157,28 @@ "Type": "string" }, { - "Name": "chunk_size", - "Help": "Above this size files will be chunked into a _segments container.\n\nAbove this size files will be chunked into a _segments container. The\ndefault for this is 5 GiB which is its maximum value.", - "Provider": "", - "Default": 5368709120, + "Name": "root_folder_slug", + "FieldName": "", + "Help": "If set, rclone will use this folder as the root folder for all operations. For example,\nif the slug identifies 'foo/bar/', 'ulozto:baz' is equivalent to 'ulozto:foo/bar/baz' without\nany root slug set.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, "NoPrefix": false, "Advanced": true, "Exclusive": false, - "Sensitive": false, - "DefaultStr": "5Gi", - "ValueStr": "5Gi", - "Type": "SizeSuffix" + "Sensitive": true, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" }, { - "Name": "no_chunk", - "Help": "Don't chunk files during streaming upload.\n\nWhen doing streaming uploads (e.g. using rcat or mount) setting this\nflag will cause the swift backend to not upload chunked files.\n\nThis will limit the maximum upload size to 5 GiB. However non chunked\nfiles are easier to deal with and have an MD5SUM.\n\nRclone will still chunk files bigger than chunk_size when doing normal\ncopy operations.", - "Provider": "", - "Default": false, + "Name": "list_page_size", + "FieldName": "", + "Help": "The size of a single page for list commands. 1-500", + "Default": 500, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16242,17 +18186,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "500", + "ValueStr": "500", + "Type": "int" }, { - "Name": "no_large_objects", - "Help": "Disable support for static and dynamic large objects\n\nSwift cannot transparently store files bigger than 5 GiB. There are\ntwo schemes for doing that, static or dynamic large objects, and the\nAPI does not allow rclone to determine whether a file is a static or\ndynamic large object without doing a HEAD on the object. Since these\nneed to be treated differently, this means rclone has to issue HEAD\nrequests for objects for example when reading checksums.\n\nWhen `no_large_objects` is set, rclone will assume that there are no\nstatic or dynamic large objects stored. This means it can stop doing\nthe extra HEAD calls which in turn increases performance greatly\nespecially when doing a swift to swift transfer with `--checksum` set.\n\nSetting this option implies `no_chunk` and also that no files will be\nuploaded in chunks, so files bigger than 5 GiB will just fail on\nupload.\n\nIf you set this option and there *are* static or dynamic large objects,\nthen this will give incorrect hashes for them. Downloads will succeed,\nbut other operations such as Remove and Copy will fail.\n", - "Provider": "", - "Default": false, + "Name": "encoding", + "FieldName": "", + "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", + "Default": 50438146, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16260,17 +18203,16 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "false", - "ValueStr": "false", - "Type": "bool" + "DefaultStr": "Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot", + "ValueStr": "Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot", + "Type": "Encoding" }, { - "Name": "encoding", - "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", - "Default": 16777218, + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16278,9 +18220,9 @@ "Advanced": true, "Exclusive": false, "Sensitive": false, - "DefaultStr": "Slash,InvalidUtf8", - "ValueStr": "Slash,InvalidUtf8", - "Type": "MultiEncoder" + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], "CommandHelp": null, @@ -16295,11 +18237,10 @@ "Options": [ { "Name": "upstreams", + "FieldName": "", "Help": "List of space separated upstreams.\n\nCan be 'upstreama:test/dir upstreamb:', '\"upstreama:test/space:ro dir\" upstreamb:', etc.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": true, "IsPassword": false, @@ -16313,11 +18254,10 @@ }, { "Name": "action_policy", + "FieldName": "", "Help": "Policy to choose upstream on ACTION category.", - "Provider": "", "Default": "epall", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16331,11 +18271,10 @@ }, { "Name": "create_policy", + "FieldName": "", "Help": "Policy to choose upstream on CREATE category.", - "Provider": "", "Default": "epmfs", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16349,11 +18288,10 @@ }, { "Name": "search_policy", + "FieldName": "", "Help": "Policy to choose upstream on SEARCH category.", - "Provider": "", "Default": "ff", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16367,11 +18305,10 @@ }, { "Name": "cache_time", + "FieldName": "", "Help": "Cache time of usage and free space (in seconds).\n\nThis option is only useful when a path preserving policy is used.", - "Provider": "", "Default": 120, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16385,11 +18322,10 @@ }, { "Name": "min_free_space", + "FieldName": "", "Help": "Minimum viable free space for lfs/eplfs policies.\n\nIf a remote has less than this much free space then it won't be\nconsidered for use in lfs or eplfs policies.", - "Provider": "", "Default": 1073741824, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16400,6 +18336,23 @@ "DefaultStr": "1Gi", "ValueStr": "1Gi", "Type": "SizeSuffix" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], "CommandHelp": null, @@ -16417,11 +18370,10 @@ "Options": [ { "Name": "access_token", + "FieldName": "", "Help": "Your access token.\n\nGet it from https://uptobox.com/my_account.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16435,11 +18387,10 @@ }, { "Name": "private", + "FieldName": "", "Help": "Set to make uploaded files private", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16453,11 +18404,10 @@ }, { "Name": "encoding", + "FieldName": "", "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", "Default": 50561070, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16467,7 +18417,24 @@ "Sensitive": false, "DefaultStr": "Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot", "ValueStr": "Slash,LtGt,DoubleQuote,BackQuote,Del,Ctl,LeftSpace,InvalidUtf8,Dot", - "Type": "MultiEncoder" + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], "CommandHelp": null, @@ -16482,11 +18449,10 @@ "Options": [ { "Name": "url", + "FieldName": "", "Help": "URL of http host to connect to.\n\nE.g. https://example.com.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": true, "IsPassword": false, @@ -16500,43 +18466,40 @@ }, { "Name": "vendor", + "FieldName": "", "Help": "Name of the WebDAV site/service/software you are using.", - "Provider": "", "Default": "", "Value": null, "Examples": [ { "Value": "fastmail", - "Help": "Fastmail Files", - "Provider": "" + "Help": "Fastmail Files" }, { "Value": "nextcloud", - "Help": "Nextcloud", - "Provider": "" + "Help": "Nextcloud" }, { "Value": "owncloud", - "Help": "Owncloud", - "Provider": "" + "Help": "Owncloud" }, { "Value": "sharepoint", - "Help": "Sharepoint Online, authenticated by Microsoft account", - "Provider": "" + "Help": "Sharepoint Online, authenticated by Microsoft account" }, { "Value": "sharepoint-ntlm", - "Help": "Sharepoint with NTLM authentication, usually self-hosted or on-premises", - "Provider": "" + "Help": "Sharepoint with NTLM authentication, usually self-hosted or on-premises" + }, + { + "Value": "rclone", + "Help": "rclone WebDAV server to serve a remote over HTTP via the WebDAV protocol" }, { "Value": "other", - "Help": "Other site/service or software", - "Provider": "" + "Help": "Other site/service or software" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16550,11 +18513,10 @@ }, { "Name": "user", + "FieldName": "", "Help": "User name.\n\nIn case NTLM authentication is used, the username should be in the format 'Domain\\User'.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16568,11 +18530,10 @@ }, { "Name": "pass", + "FieldName": "", "Help": "Password.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": true, @@ -16586,11 +18547,10 @@ }, { "Name": "bearer_token", + "FieldName": "", "Help": "Bearer token instead of user/pass (e.g. a Macaroon).", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16604,11 +18564,10 @@ }, { "Name": "bearer_token_command", + "FieldName": "", "Help": "Command to run to get a bearer token.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16622,11 +18581,10 @@ }, { "Name": "encoding", + "FieldName": "", "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.\n\nDefault encoding is Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,Hash,Percent,BackSlash,Del,Ctl,LeftSpace,LeftTilde,RightSpace,RightPeriod,InvalidUtf8 for sharepoint-ntlm or identity otherwise.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16640,11 +18598,10 @@ }, { "Name": "headers", + "FieldName": "", "Help": "Set HTTP headers for all transactions.\n\nUse this to set additional HTTP headers for all transactions\n\nThe input format is comma separated list of key,value pairs. Standard\n[CSV encoding](https://godoc.org/encoding/csv) may be used.\n\nFor example, to set a Cookie use 'Cookie,name=value', or '\"Cookie\",\"name=value\"'.\n\nYou can set multiple headers, e.g. '\"Cookie\",\"name=value\",\"Authorization\",\"xxx\"'.\n", - "Provider": "", "Default": [], "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16658,11 +18615,10 @@ }, { "Name": "pacer_min_sleep", + "FieldName": "", "Help": "Minimum time to sleep between API calls.", - "Provider": "", "Default": 10000000, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16676,11 +18632,10 @@ }, { "Name": "nextcloud_chunk_size", + "FieldName": "", "Help": "Nextcloud upload chunk size.\n\nWe recommend configuring your NextCloud instance to increase the max chunk size to 1 GB for better upload performances.\nSee https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/big_file_upload_configuration.html#adjust-chunk-size-on-nextcloud-side\n\nSet to 0 to disable chunked uploading.\n", - "Provider": "", "Default": 10485760, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16691,6 +18646,74 @@ "DefaultStr": "10Mi", "ValueStr": "10Mi", "Type": "SizeSuffix" + }, + { + "Name": "owncloud_exclude_shares", + "FieldName": "", + "Help": "Exclude ownCloud shares", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "owncloud_exclude_mounts", + "FieldName": "", + "Help": "Exclude ownCloud mounted storages", + "Default": false, + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "false", + "ValueStr": "false", + "Type": "bool" + }, + { + "Name": "unix_socket", + "FieldName": "", + "Help": "Path to a unix domain socket to dial to, instead of opening a TCP connection directly", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], "CommandHelp": null, @@ -16705,11 +18728,10 @@ "Options": [ { "Name": "client_id", + "FieldName": "", "Help": "OAuth Client Id.\n\nLeave blank normally.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16723,11 +18745,10 @@ }, { "Name": "client_secret", + "FieldName": "", "Help": "OAuth Client Secret.\n\nLeave blank normally.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16741,11 +18762,10 @@ }, { "Name": "token", + "FieldName": "", "Help": "OAuth Access Token as a JSON blob.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16759,11 +18779,10 @@ }, { "Name": "auth_url", + "FieldName": "", "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16777,11 +18796,10 @@ }, { "Name": "token_url", + "FieldName": "", "Help": "Token server url.\n\nLeave blank to use the provider defaults.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16795,11 +18813,10 @@ }, { "Name": "hard_delete", + "FieldName": "", "Help": "Delete files permanently rather than putting them into the trash.", - "Provider": "", "Default": false, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16813,11 +18830,10 @@ }, { "Name": "encoding", + "FieldName": "", "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", "Default": 50429954, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16827,7 +18843,41 @@ "Sensitive": false, "DefaultStr": "Slash,Del,Ctl,InvalidUtf8,Dot", "ValueStr": "Slash,Del,Ctl,InvalidUtf8,Dot", - "Type": "MultiEncoder" + "Type": "Encoding" + }, + { + "Name": "spoof_ua", + "FieldName": "", + "Help": "Set the user agent to match an official version of the yandex disk client. May help with upload performance.", + "Default": true, + "Value": null, + "Hide": 2, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "true", + "ValueStr": "true", + "Type": "bool" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], "CommandHelp": null, @@ -16842,11 +18892,10 @@ "Options": [ { "Name": "client_id", + "FieldName": "", "Help": "OAuth Client Id.\n\nLeave blank normally.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16860,11 +18909,10 @@ }, { "Name": "client_secret", + "FieldName": "", "Help": "OAuth Client Secret.\n\nLeave blank normally.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16878,11 +18926,10 @@ }, { "Name": "token", + "FieldName": "", "Help": "OAuth Access Token as a JSON blob.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16896,11 +18943,10 @@ }, { "Name": "auth_url", + "FieldName": "", "Help": "Auth server URL.\n\nLeave blank to use the provider defaults.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16914,11 +18960,10 @@ }, { "Name": "token_url", + "FieldName": "", "Help": "Token server url.\n\nLeave blank to use the provider defaults.", - "Provider": "", "Default": "", "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16932,43 +18977,36 @@ }, { "Name": "region", + "FieldName": "", "Help": "Zoho region to connect to.\n\nYou'll have to use the region your organization is registered in. If\nnot sure use the same top level domain as you connect to in your\nbrowser.", - "Provider": "", "Default": "", "Value": null, "Examples": [ { "Value": "com", - "Help": "United states / Global", - "Provider": "" + "Help": "United states / Global" }, { "Value": "eu", - "Help": "Europe", - "Provider": "" + "Help": "Europe" }, { "Value": "in", - "Help": "India", - "Provider": "" + "Help": "India" }, { "Value": "jp", - "Help": "Japan", - "Provider": "" + "Help": "Japan" }, { "Value": "com.cn", - "Help": "China", - "Provider": "" + "Help": "China" }, { "Value": "com.au", - "Help": "Australia", - "Provider": "" + "Help": "Australia" } ], - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16982,11 +19020,10 @@ }, { "Name": "encoding", + "FieldName": "", "Help": "The encoding for the backend.\n\nSee the [encoding section in the overview](/overview/#encoding) for more info.", - "Provider": "", "Default": 16875520, "Value": null, - "ShortOpt": "", "Hide": 0, "Required": false, "IsPassword": false, @@ -16996,7 +19033,24 @@ "Sensitive": false, "DefaultStr": "Del,Ctl,InvalidUtf8", "ValueStr": "Del,Ctl,InvalidUtf8", - "Type": "MultiEncoder" + "Type": "Encoding" + }, + { + "Name": "description", + "FieldName": "", + "Help": "Description of the remote.", + "Default": "", + "Value": null, + "Hide": 0, + "Required": false, + "IsPassword": false, + "NoPrefix": false, + "Advanced": true, + "Exclusive": false, + "Sensitive": false, + "DefaultStr": "", + "ValueStr": "", + "Type": "string" } ], "CommandHelp": null,